From a11798a9ca43576ab37740fd5d586999f3b4ee1a Mon Sep 17 00:00:00 2001 From: luthebao Date: Tue, 6 Jan 2026 13:17:40 +0700 Subject: [PATCH 1/3] update: remove the working progress --- PROGRESS.md | 68 - README.md | 62 +- STYLE_GUIDE.md | 72 - crawl_docs.py | 126 - docs/Accessibility.md | 35 + docs/Bridge_Sensors.md | 28 +- docs/Filters.md | 21 +- docs/Geom.md | 11 + docs/Media.md | 14 + docs/README.md | 16 +- docs/SpecialTypes.md | 11 +- docs/System.md | 18 + docs/Text.md | 12 +- docs/UI.md | 63 +- html-docs/ArgumentError.html | 331 - html-docs/Array.html | 3642 ------ html-docs/Boolean.html | 424 - html-docs/Class.html | 421 - html-docs/Date.html | 5279 -------- html-docs/DefinitionError.html | 290 - html-docs/Error.html | 689 - html-docs/EvalError.html | 294 - html-docs/Function.html | 610 - html-docs/JSON.html | 651 - html-docs/Math.html | 1860 --- html-docs/Namespace.html | 852 -- html-docs/Number.html | 905 -- html-docs/Object.html | 992 -- html-docs/QName.html | 690 - html-docs/RangeError.html | 353 - html-docs/ReferenceError.html | 331 - html-docs/RegExp.html | 1098 -- html-docs/SecurityError.html | 342 - html-docs/String.html | 2491 ---- html-docs/SyntaxError.html | 304 - html-docs/TimeZone.html | 558 - html-docs/TypeError.html | 358 - html-docs/URIError.html | 302 - html-docs/Vector.html | 2287 ---- html-docs/VerifyError.html | 296 - html-docs/XML.html | 4667 ------- html-docs/XMLList.html | 1673 --- html-docs/air/net/WebSocket.html | 1259 -- html-docs/air/net/package-detail.html | 57 - html-docs/air/security/Digest.html | 1101 -- html-docs/air/security/Encryption.html | 422 - html-docs/air/security/package-detail.html | 60 - html-docs/air/system/License.html | 921 -- html-docs/air/system/package-detail.html | 56 - html-docs/air/update/ApplicationUpdater.html | 2930 ----- .../air/update/ApplicationUpdaterUI.html | 3604 ------ .../air/update/events/DownloadErrorEvent.html | 1135 -- .../events/StatusFileUpdateErrorEvent.html | 794 -- .../update/events/StatusFileUpdateEvent.html | 1058 -- .../update/events/StatusUpdateErrorEvent.html | 832 -- .../air/update/events/StatusUpdateEvent.html | 1108 -- html-docs/air/update/events/UpdateEvent.html | 1003 -- .../air/update/events/package-detail.html | 91 - html-docs/air/update/package-detail.html | 65 - html-docs/air/utils/ZipArchive.html | 1303 -- html-docs/air/utils/ZipEntry.html | 1064 -- html-docs/air/utils/package-detail.html | 61 - html-docs/all-classes.html | 1665 --- html-docs/all-index-A.html | 2703 ---- html-docs/all-index-B.html | 1525 --- html-docs/all-index-C.html | 4980 -------- html-docs/all-index-D.html | 2914 ----- html-docs/all-index-E.html | 1452 --- html-docs/all-index-F.html | 1971 --- html-docs/all-index-G.html | 1970 --- html-docs/all-index-H.html | 1072 -- html-docs/all-index-I.html | 2524 ---- html-docs/all-index-J.html | 217 - html-docs/all-index-K.html | 1083 -- html-docs/all-index-L.html | 1945 --- html-docs/all-index-M.html | 1908 --- html-docs/all-index-N.html | 2178 ---- html-docs/all-index-O.html | 960 -- html-docs/all-index-P.html | 2211 ---- html-docs/all-index-Q.html | 198 - html-docs/all-index-R.html | 2856 ----- html-docs/all-index-S.html | 6432 ---------- html-docs/all-index-Symbols.html | 451 - html-docs/all-index-T.html | 3014 ----- html-docs/all-index-U.html | 1481 --- html-docs/all-index-V.html | 861 -- html-docs/all-index-W.html | 1148 -- html-docs/all-index-X.html | 278 - html-docs/all-index-Y.html | 146 - html-docs/all-index-Z.html | 154 - html-docs/appendices.html | 63 - html-docs/arguments.html | 402 - .../intrinsics/iteration/package-detail.html | 66 - .../avm2/intrinsics/iteration/package.html | 245 - .../intrinsics/memory/package-detail.html | 126 - html-docs/avm2/intrinsics/memory/package.html | 968 -- html-docs/charset-codes.html | 1278 -- html-docs/class-summary.html | 3847 ------ html-docs/compilerErrors.html | 1073 -- html-docs/compilerWarnings.html | 463 - html-docs/conventions.html | 80 - .../flash/accessibility/Accessibility.html | 518 - .../AccessibilityImplementation.html | 1243 -- .../AccessibilityProperties.html | 630 - .../flash/accessibility/ISearchableText.html | 124 - .../accessibility/ISimpleTextSelection.html | 181 - .../flash/accessibility/package-detail.html | 85 - html-docs/flash/concurrent/Condition.html | 738 -- html-docs/flash/concurrent/Mutex.html | 602 - .../flash/concurrent/package-detail.html | 69 - html-docs/flash/crypto/package-detail.html | 55 - html-docs/flash/crypto/package.html | 123 - html-docs/flash/data/EncryptedLocalStore.html | 839 -- html-docs/flash/data/SQLCollationType.html | 303 - html-docs/flash/data/SQLColumnNameStyle.html | 349 - html-docs/flash/data/SQLColumnSchema.html | 529 - html-docs/flash/data/SQLConnection.html | 4713 ------- html-docs/flash/data/SQLIndexSchema.html | 343 - html-docs/flash/data/SQLMode.html | 345 - html-docs/flash/data/SQLResult.html | 630 - html-docs/flash/data/SQLSchema.html | 398 - html-docs/flash/data/SQLSchemaResult.html | 472 - html-docs/flash/data/SQLStatement.html | 1427 --- html-docs/flash/data/SQLTableSchema.html | 358 - .../flash/data/SQLTransactionLockType.html | 340 - html-docs/flash/data/SQLTriggerSchema.html | 336 - html-docs/flash/data/SQLViewSchema.html | 308 - html-docs/flash/data/package-detail.html | 129 - html-docs/flash/desktop/Clipboard.html | 1205 -- html-docs/flash/desktop/ClipboardFormats.html | 425 - .../flash/desktop/ClipboardTransferMode.html | 341 - html-docs/flash/desktop/DockIcon.html | 627 - html-docs/flash/desktop/IFilePromise.html | 388 - html-docs/flash/desktop/Icon.html | 375 - html-docs/flash/desktop/InteractiveIcon.html | 438 - .../flash/desktop/InvokeEventReason.html | 315 - .../flash/desktop/NativeApplication.html | 3475 ----- .../flash/desktop/NativeDragActions.html | 344 - .../flash/desktop/NativeDragManager.html | 643 - .../flash/desktop/NativeDragOptions.html | 351 - html-docs/flash/desktop/NativeProcess.html | 1255 -- .../desktop/NativeProcessStartupInfo.html | 379 - html-docs/flash/desktop/NotificationType.html | 281 - html-docs/flash/desktop/SystemIdleMode.html | 283 - html-docs/flash/desktop/SystemTrayIcon.html | 839 -- html-docs/flash/desktop/Updater.html | 413 - html-docs/flash/desktop/package-detail.html | 138 - html-docs/flash/display/AVM1Movie.html | 674 - .../flash/display/ActionScriptVersion.html | 282 - html-docs/flash/display/Bitmap.html | 1045 -- html-docs/flash/display/BitmapData.html | 5889 --------- .../flash/display/BitmapDataChannel.html | 361 - .../display/BitmapEncodingColorSpace.html | 342 - html-docs/flash/display/BlendMode.html | 745 -- html-docs/flash/display/CapsStyle.html | 423 - html-docs/flash/display/ColorCorrection.html | 305 - .../flash/display/ColorCorrectionSupport.html | 303 - html-docs/flash/display/DisplayObject.html | 5970 --------- .../flash/display/DisplayObjectContainer.html | 3143 ----- html-docs/flash/display/FocusDirection.html | 298 - html-docs/flash/display/FrameLabel.html | 485 - html-docs/flash/display/GradientType.html | 274 - html-docs/flash/display/Graphics.html | 3213 ----- .../flash/display/GraphicsBitmapFill.html | 457 - html-docs/flash/display/GraphicsEndFill.html | 263 - .../flash/display/GraphicsGradientFill.html | 739 -- html-docs/flash/display/GraphicsPath.html | 780 -- .../flash/display/GraphicsPathCommand.html | 482 - .../flash/display/GraphicsPathWinding.html | 290 - .../flash/display/GraphicsShaderFill.html | 366 - .../flash/display/GraphicsSolidFill.html | 321 - html-docs/flash/display/GraphicsStroke.html | 770 -- .../flash/display/GraphicsTrianglePath.html | 438 - html-docs/flash/display/IBitmapDrawable.html | 96 - html-docs/flash/display/IGraphicsData.html | 95 - html-docs/flash/display/IGraphicsFill.html | 93 - html-docs/flash/display/IGraphicsPath.html | 93 - html-docs/flash/display/IGraphicsStroke.html | 91 - .../flash/display/InteractiveObject.html | 7875 ------------ .../flash/display/InterpolationMethod.html | 316 - .../flash/display/JPEGEncoderOptions.html | 285 - .../flash/display/JPEGXREncoderOptions.html | 370 - html-docs/flash/display/JointStyle.html | 427 - html-docs/flash/display/LineScaleMode.html | 357 - html-docs/flash/display/Loader.html | 3718 ------ html-docs/flash/display/LoaderInfo.html | 2100 --- html-docs/flash/display/MorphShape.html | 641 - html-docs/flash/display/MovieClip.html | 2660 ---- html-docs/flash/display/NativeMenu.html | 1908 --- html-docs/flash/display/NativeMenuItem.html | 1286 -- html-docs/flash/display/NativeWindow.html | 5582 -------- .../display/NativeWindowDisplayState.html | 312 - .../display/NativeWindowInitOptions.html | 727 -- .../flash/display/NativeWindowRenderMode.html | 345 - .../flash/display/NativeWindowResize.html | 433 - .../display/NativeWindowSystemChrome.html | 279 - html-docs/flash/display/NativeWindowType.html | 299 - .../flash/display/PNGEncoderOptions.html | 284 - html-docs/flash/display/PixelSnapping.html | 322 - html-docs/flash/display/SWFVersion.html | 570 - html-docs/flash/display/Scene.html | 331 - html-docs/flash/display/Screen.html | 1050 -- html-docs/flash/display/ScreenMode.html | 375 - html-docs/flash/display/Shader.html | 597 - html-docs/flash/display/ShaderData.html | 467 - html-docs/flash/display/ShaderInput.html | 488 - html-docs/flash/display/ShaderJob.html | 837 -- html-docs/flash/display/ShaderParameter.html | 588 - .../flash/display/ShaderParameterType.html | 761 -- html-docs/flash/display/ShaderPrecision.html | 325 - html-docs/flash/display/Shape.html | 818 -- html-docs/flash/display/SimpleButton.html | 1818 --- html-docs/flash/display/SpreadMethod.html | 328 - html-docs/flash/display/Sprite.html | 2471 ---- html-docs/flash/display/Stage.html | 5904 --------- html-docs/flash/display/Stage3D.html | 851 -- html-docs/flash/display/StageAlign.html | 445 - html-docs/flash/display/StageAspectRatio.html | 307 - .../flash/display/StageDisplayState.html | 316 - html-docs/flash/display/StageOrientation.html | 377 - html-docs/flash/display/StageQuality.html | 501 - html-docs/flash/display/StageScaleMode.html | 342 - html-docs/flash/display/TriangleCulling.html | 288 - html-docs/flash/display/package-detail.html | 418 - html-docs/flash/display3D/Context3D.html | 7234 ----------- .../flash/display3D/Context3DBlendFactor.html | 550 - .../flash/display3D/Context3DBufferUsage.html | 285 - .../flash/display3D/Context3DClearMask.html | 340 - .../flash/display3D/Context3DCompareMode.html | 450 - .../flash/display3D/Context3DFillMode.html | 278 - .../flash/display3D/Context3DMipFilter.html | 314 - .../flash/display3D/Context3DProfile.html | 445 - .../flash/display3D/Context3DProgramType.html | 281 - .../flash/display3D/Context3DRenderMode.html | 286 - .../display3D/Context3DStencilAction.html | 458 - .../display3D/Context3DTextureFilter.html | 407 - .../display3D/Context3DTextureFormat.html | 398 - .../display3D/Context3DTriangleFace.html | 338 - .../Context3DVertexBufferFormat.html | 365 - .../flash/display3D/Context3DWrapMode.html | 311 - html-docs/flash/display3D/IndexBuffer3D.html | 417 - html-docs/flash/display3D/Program3D.html | 917 -- html-docs/flash/display3D/VertexBuffer3D.html | 664 - html-docs/flash/display3D/package-detail.html | 137 - .../flash/display3D/textures/CubeTexture.html | 875 -- .../display3D/textures/RectangleTexture.html | 784 -- .../flash/display3D/textures/Texture.html | 1061 -- .../flash/display3D/textures/TextureBase.html | 337 - .../display3D/textures/VideoTexture.html | 449 - .../display3D/textures/package-detail.html | 74 - html-docs/flash/errors/DRMManagerError.html | 371 - html-docs/flash/errors/InvalidSWFError.html | 297 - html-docs/flash/errors/PermissionError.html | 325 - html-docs/flash/errors/SQLError.html | 577 - html-docs/flash/errors/SQLErrorOperation.html | 776 -- .../flash/errors/ScriptTimeoutError.html | 357 - .../flash/errors/StackOverflowError.html | 344 - html-docs/flash/errors/package-detail.html | 99 - .../flash/events/AccelerometerEvent.html | 971 -- html-docs/flash/events/ActivityEvent.html | 890 -- html-docs/flash/events/AsyncErrorEvent.html | 886 -- .../flash/events/AudioOutputChangeEvent.html | 703 -- .../flash/events/BrowserInvokeEvent.html | 1050 -- html-docs/flash/events/ContextMenuEvent.html | 1120 -- html-docs/flash/events/DNSResolverEvent.html | 870 -- .../flash/events/DRMAuthenticateEvent.html | 1243 -- .../DRMAuthenticationCompleteEvent.html | 886 -- .../events/DRMAuthenticationErrorEvent.html | 894 -- .../events/DRMDeviceGroupErrorEvent.html | 847 -- .../flash/events/DRMDeviceGroupEvent.html | 737 -- html-docs/flash/events/DRMErrorEvent.html | 1109 -- .../flash/events/DRMLicenseRequestEvent.html | 794 -- .../events/DRMReturnVoucherCompleteEvent.html | 922 -- .../events/DRMReturnVoucherErrorEvent.html | 935 -- html-docs/flash/events/DRMStatusEvent.html | 1148 -- html-docs/flash/events/DataEvent.html | 1002 -- .../flash/events/DatagramSocketDataEvent.html | 1002 -- .../flash/events/DeviceRotationEvent.html | 1010 -- html-docs/flash/events/ErrorEvent.html | 930 -- html-docs/flash/events/Event.html | 3755 ------ html-docs/flash/events/EventDispatcher.html | 892 -- html-docs/flash/events/EventPhase.html | 306 - html-docs/flash/events/FileListEvent.html | 778 -- html-docs/flash/events/FocusEvent.html | 1339 -- html-docs/flash/events/FullScreenEvent.html | 950 -- html-docs/flash/events/GameInputEvent.html | 806 -- html-docs/flash/events/GeolocationEvent.html | 1144 -- html-docs/flash/events/GestureEvent.html | 1330 -- html-docs/flash/events/GesturePhase.html | 419 - .../HTMLUncaughtScriptExceptionEvent.html | 807 -- html-docs/flash/events/HTTPStatusEvent.html | 1091 -- html-docs/flash/events/IEventDispatcher.html | 515 - html-docs/flash/events/IMEEvent.html | 922 -- html-docs/flash/events/IOErrorEvent.html | 1031 -- html-docs/flash/events/InvokeEvent.html | 1044 -- html-docs/flash/events/KeyboardEvent.html | 1576 --- .../flash/events/LocationChangeEvent.html | 839 -- html-docs/flash/events/MediaEvent.html | 874 -- html-docs/flash/events/MouseEvent.html | 3755 ------ html-docs/flash/events/NativeDragEvent.html | 1522 --- .../flash/events/NativeProcessExitEvent.html | 829 -- .../flash/events/NativeWindowBoundsEvent.html | 1041 -- .../events/NativeWindowDisplayStateEvent.html | 941 -- html-docs/flash/events/NetDataEvent.html | 872 -- html-docs/flash/events/NetMonitorEvent.html | 838 -- html-docs/flash/events/NetStatusEvent.html | 1340 -- .../flash/events/OutputProgressEvent.html | 885 -- html-docs/flash/events/PermissionEvent.html | 780 -- .../flash/events/PressAndTapGestureEvent.html | 1171 -- html-docs/flash/events/ProgressEvent.html | 1187 -- .../flash/events/RemoteNotificationEvent.html | 830 -- html-docs/flash/events/SQLErrorEvent.html | 886 -- html-docs/flash/events/SQLEvent.html | 1506 --- html-docs/flash/events/SQLUpdateEvent.html | 984 -- html-docs/flash/events/SampleDataEvent.html | 951 -- html-docs/flash/events/ScreenMouseEvent.html | 1345 -- .../flash/events/SecurityErrorEvent.html | 941 -- .../events/ServerSocketConnectEvent.html | 839 -- html-docs/flash/events/ShaderEvent.html | 968 -- html-docs/flash/events/SoftKeyboardEvent.html | 974 -- .../flash/events/SoftKeyboardTrigger.html | 273 - .../flash/events/StageOrientationEvent.html | 937 -- .../events/StageVideoAvailabilityEvent.html | 807 -- html-docs/flash/events/StageVideoEvent.html | 846 -- html-docs/flash/events/StatusEvent.html | 926 -- .../events/StorageVolumeChangeEvent.html | 1007 -- html-docs/flash/events/SyncEvent.html | 867 -- html-docs/flash/events/TextEvent.html | 1211 -- html-docs/flash/events/ThrottleEvent.html | 958 -- html-docs/flash/events/ThrottleType.html | 331 - html-docs/flash/events/TimerEvent.html | 914 -- html-docs/flash/events/TouchEvent.html | 3092 ----- html-docs/flash/events/TouchEventIntent.html | 329 - .../flash/events/TransformGestureEvent.html | 1767 --- .../flash/events/UncaughtErrorEvent.html | 1217 -- .../flash/events/UncaughtErrorEvents.html | 429 - html-docs/flash/events/VideoEvent.html | 864 -- html-docs/flash/events/VideoTextureEvent.html | 784 -- .../VsyncStateChangeAvailabilityEvent.html | 832 -- html-docs/flash/events/WebSocketEvent.html | 871 -- html-docs/flash/events/WebViewDrawEvent.html | 915 -- html-docs/flash/events/package-detail.html | 453 - .../flash/external/ExtensionContext.html | 1149 -- html-docs/flash/external/ExtensionInfo.html | 602 - .../flash/external/ExternalInterface.html | 874 -- html-docs/flash/external/HostObject.html | 1057 -- html-docs/flash/external/package-detail.html | 73 - html-docs/flash/filesystem/File.html | 6511 ---------- html-docs/flash/filesystem/FileMode.html | 403 - html-docs/flash/filesystem/FileStream.html | 3206 ----- html-docs/flash/filesystem/StorageVolume.html | 732 -- .../flash/filesystem/StorageVolumeInfo.html | 742 -- .../flash/filesystem/package-detail.html | 74 - html-docs/flash/filters/BevelFilter.html | 973 -- html-docs/flash/filters/BitmapFilter.html | 324 - .../flash/filters/BitmapFilterQuality.html | 380 - html-docs/flash/filters/BitmapFilterType.html | 373 - html-docs/flash/filters/BlurFilter.html | 548 - .../flash/filters/ColorMatrixFilter.html | 516 - .../flash/filters/ConvolutionFilter.html | 953 -- .../flash/filters/DisplacementMapFilter.html | 930 -- .../filters/DisplacementMapFilterMode.html | 359 - html-docs/flash/filters/DropShadowFilter.html | 912 -- html-docs/flash/filters/GlowFilter.html | 798 -- .../flash/filters/GradientBevelFilter.html | 1051 -- .../flash/filters/GradientGlowFilter.html | 1054 -- html-docs/flash/filters/ShaderFilter.html | 622 - html-docs/flash/filters/package-detail.html | 113 - html-docs/flash/geom/ColorTransform.html | 782 -- html-docs/flash/geom/Matrix.html | 2601 ---- html-docs/flash/geom/Matrix3D.html | 2877 ----- html-docs/flash/geom/Orientation3D.html | 358 - .../flash/geom/PerspectiveProjection.html | 523 - html-docs/flash/geom/Point.html | 1356 -- html-docs/flash/geom/Rectangle.html | 2029 --- html-docs/flash/geom/Transform.html | 981 -- html-docs/flash/geom/Utils3D.html | 697 - html-docs/flash/geom/Vector3D.html | 1833 --- html-docs/flash/geom/package-detail.html | 102 - html-docs/flash/globalization/Collator.html | 1399 -- .../flash/globalization/CollatorMode.html | 300 - .../globalization/CurrencyFormatter.html | 2078 --- .../globalization/CurrencyParseResult.html | 325 - .../globalization/DateTimeFormatter.html | 1894 --- .../globalization/DateTimeNameContext.html | 286 - .../globalization/DateTimeNameStyle.html | 318 - .../flash/globalization/DateTimeStyle.html | 373 - .../globalization/LastOperationStatus.html | 739 -- html-docs/flash/globalization/LocaleID.html | 962 -- .../globalization/NationalDigitsType.html | 1106 -- .../flash/globalization/NumberFormatter.html | 1914 --- .../globalization/NumberParseResult.html | 382 - .../flash/globalization/StringTools.html | 763 -- .../flash/globalization/package-detail.html | 111 - html-docs/flash/html/HTMLHistoryItem.html | 321 - html-docs/flash/html/HTMLHost.html | 809 -- html-docs/flash/html/HTMLLoader.html | 2381 ---- html-docs/flash/html/HTMLPDFCapability.html | 370 - html-docs/flash/html/HTMLSWFCapability.html | 299 - .../flash/html/HTMLWindowCreateOptions.html | 521 - html-docs/flash/html/package-detail.html | 82 - html-docs/flash/media/AudioDecoder.html | 398 - html-docs/flash/media/AudioDeviceManager.html | 487 - .../flash/media/AudioOutputChangeReason.html | 275 - html-docs/flash/media/AudioPlaybackMode.html | 332 - html-docs/flash/media/Camera.html | 3321 ----- html-docs/flash/media/CameraPosition.html | 293 - html-docs/flash/media/CameraRoll.html | 971 -- .../flash/media/CameraRollBrowseOptions.html | 378 - html-docs/flash/media/CameraUI.html | 864 -- html-docs/flash/media/H264Level.html | 695 - html-docs/flash/media/H264Profile.html | 276 - .../flash/media/H264VideoStreamSettings.html | 470 - html-docs/flash/media/ID3Info.html | 417 - html-docs/flash/media/MediaPromise.html | 788 -- html-docs/flash/media/MediaType.html | 281 - html-docs/flash/media/Microphone.html | 2231 ---- .../flash/media/MicrophoneEnhancedMode.html | 370 - .../media/MicrophoneEnhancedOptions.html | 393 - html-docs/flash/media/Sound.html | 2280 ---- html-docs/flash/media/SoundChannel.html | 786 -- html-docs/flash/media/SoundCodec.html | 335 - html-docs/flash/media/SoundLoaderContext.html | 473 - html-docs/flash/media/SoundMixer.html | 828 -- html-docs/flash/media/SoundTransform.html | 621 - html-docs/flash/media/StageVideo.html | 940 -- .../flash/media/StageVideoAvailability.html | 276 - .../media/StageVideoAvailabilityReason.html | 364 - html-docs/flash/media/StageWebView.html | 1607 --- html-docs/flash/media/Video.html | 1241 -- html-docs/flash/media/VideoCodec.html | 296 - html-docs/flash/media/VideoStatus.html | 298 - .../flash/media/VideoStreamSettings.html | 707 -- html-docs/flash/media/package-detail.html | 211 - html-docs/flash/media/package.html | 92 - html-docs/flash/net/DatagramSocket.html | 1475 --- html-docs/flash/net/FileFilter.html | 464 - html-docs/flash/net/FileReference.html | 3461 ----- html-docs/flash/net/FileReferenceList.html | 803 -- html-docs/flash/net/GroupSpecifier.html | 1387 -- .../flash/net/IDynamicPropertyOutput.html | 186 - .../flash/net/IDynamicPropertyWriter.html | 179 - html-docs/flash/net/IPVersion.html | 278 - html-docs/flash/net/InterfaceAddress.html | 362 - html-docs/flash/net/LocalConnection.html | 1488 --- html-docs/flash/net/NetConnection.html | 1753 --- html-docs/flash/net/NetGroup.html | 1942 --- html-docs/flash/net/NetGroupInfo.html | 584 - html-docs/flash/net/NetGroupReceiveMode.html | 305 - .../net/NetGroupReplicationStrategy.html | 298 - html-docs/flash/net/NetGroupSendMode.html | 280 - html-docs/flash/net/NetGroupSendResult.html | 312 - html-docs/flash/net/NetMonitor.html | 401 - html-docs/flash/net/NetStream.html | 5642 --------- .../flash/net/NetStreamAppendBytesAction.html | 313 - html-docs/flash/net/NetStreamInfo.html | 1166 -- .../flash/net/NetStreamMulticastInfo.html | 1069 -- html-docs/flash/net/NetStreamPlayOptions.html | 633 - .../flash/net/NetStreamPlayTransitions.html | 567 - html-docs/flash/net/NetworkInfo.html | 632 - html-docs/flash/net/NetworkInterface.html | 506 - html-docs/flash/net/ObjectEncoding.html | 455 - html-docs/flash/net/Responder.html | 267 - html-docs/flash/net/SecureSocket.html | 1742 --- html-docs/flash/net/ServerSocket.html | 1017 -- html-docs/flash/net/SharedObject.html | 2044 --- .../flash/net/SharedObjectFlushStatus.html | 291 - html-docs/flash/net/Socket.html | 3023 ----- html-docs/flash/net/URLLoader.html | 1575 --- html-docs/flash/net/URLLoaderDataFormat.html | 414 - html-docs/flash/net/URLRequest.html | 1451 --- html-docs/flash/net/URLRequestDefaults.html | 691 - html-docs/flash/net/URLRequestHeader.html | 456 - html-docs/flash/net/URLRequestMethod.html | 478 - html-docs/flash/net/URLStream.html | 2276 ---- html-docs/flash/net/URLVariables.html | 410 - html-docs/flash/net/XMLSocket.html | 1070 -- html-docs/flash/net/dns/AAAARecord.html | 307 - html-docs/flash/net/dns/ARecord.html | 307 - html-docs/flash/net/dns/DNSResolver.html | 651 - html-docs/flash/net/dns/MXRecord.html | 345 - html-docs/flash/net/dns/PTRRecord.html | 307 - html-docs/flash/net/dns/ResourceRecord.html | 292 - html-docs/flash/net/dns/SRVRecord.html | 415 - html-docs/flash/net/dns/package-detail.html | 79 - .../flash/net/drm/AuthenticationMethod.html | 281 - html-docs/flash/net/drm/DRMContentData.html | 467 - html-docs/flash/net/drm/DRMDeviceGroup.html | 365 - html-docs/flash/net/drm/DRMManager.html | 1135 -- .../flash/net/drm/DRMPlaybackTimeWindow.html | 327 - html-docs/flash/net/drm/DRMVoucher.html | 562 - .../flash/net/drm/LoadVoucherSetting.html | 305 - .../flash/net/drm/VoucherAccessInfo.html | 393 - html-docs/flash/net/drm/package-detail.html | 91 - html-docs/flash/net/package-detail.html | 297 - html-docs/flash/net/package.html | 655 - .../notifications/NotificationStyle.html | 292 - .../flash/notifications/RemoteNotifier.html | 561 - .../RemoteNotifierSubscribeOptions.html | 283 - .../flash/notifications/package-detail.html | 64 - .../flash/permissions/PermissionManager.html | 459 - .../flash/permissions/PermissionStatus.html | 357 - .../flash/permissions/package-detail.html | 63 - html-docs/flash/printing/PaperSize.html | 774 -- html-docs/flash/printing/PrintJob.html | 2121 ---- html-docs/flash/printing/PrintJobOptions.html | 464 - .../flash/printing/PrintJobOrientation.html | 293 - html-docs/flash/printing/PrintMethod.html | 344 - html-docs/flash/printing/PrintUIOptions.html | 373 - html-docs/flash/printing/package-detail.html | 81 - html-docs/flash/profiler/Telemetry.html | 504 - html-docs/flash/profiler/package-detail.html | 68 - html-docs/flash/profiler/package.html | 103 - .../flash/security/CertificateStatus.html | 525 - .../flash/security/IURIDereferencer.html | 163 - .../security/ReferencesValidationSetting.html | 289 - .../security/RevocationCheckSettings.html | 340 - html-docs/flash/security/SignatureStatus.html | 305 - .../flash/security/SignerTrustSettings.html | 313 - .../flash/security/X500DistinguishedName.html | 453 - html-docs/flash/security/X509Certificate.html | 679 - .../flash/security/XMLSignatureValidator.html | 1705 --- html-docs/flash/security/package-detail.html | 104 - html-docs/flash/sensors/Accelerometer.html | 723 -- html-docs/flash/sensors/DeviceRotation.html | 616 - html-docs/flash/sensors/Geolocation.html | 1083 -- html-docs/flash/sensors/package-detail.html | 64 - html-docs/flash/system/ApplicationDomain.html | 880 -- html-docs/flash/system/Capabilities.html | 2251 ---- html-docs/flash/system/IME.html | 747 -- html-docs/flash/system/IMEConversionMode.html | 523 - .../flash/system/ImageDecodingPolicy.html | 292 - html-docs/flash/system/JPEGLoaderContext.html | 382 - html-docs/flash/system/LoaderContext.html | 853 -- html-docs/flash/system/MessageChannel.html | 1389 -- .../flash/system/MessageChannelState.html | 332 - html-docs/flash/system/Security.html | 1274 -- html-docs/flash/system/SecurityDomain.html | 250 - html-docs/flash/system/SecurityPanel.html | 516 - html-docs/flash/system/System.html | 1419 --- html-docs/flash/system/SystemUpdater.html | 779 -- html-docs/flash/system/SystemUpdaterType.html | 269 - html-docs/flash/system/TouchscreenType.html | 351 - html-docs/flash/system/Worker.html | 1675 --- html-docs/flash/system/WorkerDomain.html | 519 - html-docs/flash/system/WorkerState.html | 330 - html-docs/flash/system/package-detail.html | 151 - html-docs/flash/system/package.html | 294 - html-docs/flash/text/AntiAliasType.html | 296 - html-docs/flash/text/AutoCapitalize.html | 330 - html-docs/flash/text/CSMSettings.html | 377 - html-docs/flash/text/Font.html | 554 - html-docs/flash/text/FontStyle.html | 352 - html-docs/flash/text/FontType.html | 355 - html-docs/flash/text/GridFitType.html | 336 - html-docs/flash/text/ReturnKeyLabel.html | 358 - html-docs/flash/text/SoftKeyboardType.html | 455 - html-docs/flash/text/StageText.html | 2841 ----- .../flash/text/StageTextClearButtonMode.html | 330 - .../flash/text/StageTextContentType.html | 506 - .../flash/text/StageTextInitOptions.html | 290 - html-docs/flash/text/StaticText.html | 694 - html-docs/flash/text/StyleSheet.html | 976 -- html-docs/flash/text/TextColorType.html | 288 - html-docs/flash/text/TextDisplayMode.html | 302 - html-docs/flash/text/TextExtent.html | 338 - html-docs/flash/text/TextField.html | 8972 ------------- html-docs/flash/text/TextFieldAutoSize.html | 355 - html-docs/flash/text/TextFieldType.html | 282 - html-docs/flash/text/TextFormat.html | 1342 -- html-docs/flash/text/TextFormatAlign.html | 422 - html-docs/flash/text/TextInteractionMode.html | 276 - html-docs/flash/text/TextLineMetrics.html | 648 - html-docs/flash/text/TextRenderer.html | 505 - html-docs/flash/text/TextSnapshot.html | 930 -- .../flash/text/engine/BreakOpportunity.html | 358 - html-docs/flash/text/engine/CFFHinting.html | 298 - .../flash/text/engine/ContentElement.html | 787 -- html-docs/flash/text/engine/DigitCase.html | 316 - html-docs/flash/text/engine/DigitWidth.html | 316 - .../flash/text/engine/EastAsianJustifier.html | 550 - .../flash/text/engine/ElementFormat.html | 2301 ---- .../flash/text/engine/FontDescription.html | 1563 --- html-docs/flash/text/engine/FontLookup.html | 292 - html-docs/flash/text/engine/FontMetrics.html | 692 - html-docs/flash/text/engine/FontPosture.html | 283 - html-docs/flash/text/engine/FontWeight.html | 282 - .../flash/text/engine/GraphicElement.html | 551 - html-docs/flash/text/engine/GroupElement.html | 1189 -- .../flash/text/engine/JustificationStyle.html | 320 - html-docs/flash/text/engine/Kerning.html | 314 - .../flash/text/engine/LigatureLevel.html | 380 - .../flash/text/engine/LineJustification.html | 342 - .../flash/text/engine/RenderingMode.html | 297 - .../flash/text/engine/SpaceJustifier.html | 601 - html-docs/flash/text/engine/TabAlignment.html | 352 - html-docs/flash/text/engine/TabStop.html | 519 - html-docs/flash/text/engine/TextBaseline.html | 531 - html-docs/flash/text/engine/TextBlock.html | 2415 ---- html-docs/flash/text/engine/TextElement.html | 567 - .../flash/text/engine/TextJustifier.html | 525 - html-docs/flash/text/engine/TextLine.html | 3599 ------ .../text/engine/TextLineCreationResult.html | 350 - .../text/engine/TextLineMirrorRegion.html | 549 - .../flash/text/engine/TextLineValidity.html | 348 - html-docs/flash/text/engine/TextRotation.html | 391 - .../flash/text/engine/TypographicCase.html | 440 - .../flash/text/engine/package-detail.html | 198 - .../text/ime/CompositionAttributeRange.html | 419 - html-docs/flash/text/ime/IIMEClient.html | 668 - html-docs/flash/text/ime/package-detail.html | 66 - html-docs/flash/text/package-detail.html | 177 - html-docs/flash/ui/ContextMenu.html | 1439 --- .../flash/ui/ContextMenuBuiltInItems.html | 579 - .../flash/ui/ContextMenuClipboardItems.html | 427 - html-docs/flash/ui/ContextMenuItem.html | 943 -- html-docs/flash/ui/GameInput.html | 569 - html-docs/flash/ui/GameInputControl.html | 536 - html-docs/flash/ui/GameInputDevice.html | 863 -- html-docs/flash/ui/KeyLocation.html | 371 - html-docs/flash/ui/Keyboard.html | 10539 ---------------- html-docs/flash/ui/KeyboardType.html | 361 - html-docs/flash/ui/Mouse.html | 695 - html-docs/flash/ui/MouseCursor.html | 371 - html-docs/flash/ui/MouseCursorData.html | 447 - html-docs/flash/ui/Multitouch.html | 621 - html-docs/flash/ui/MultitouchInputMode.html | 377 - html-docs/flash/ui/package-detail.html | 120 - html-docs/flash/utils/ByteArray.html | 3450 ----- .../flash/utils/CompressionAlgorithm.html | 337 - html-docs/flash/utils/Dictionary.html | 297 - html-docs/flash/utils/Endian.html | 314 - html-docs/flash/utils/IDataInput.html | 1295 -- html-docs/flash/utils/IDataOutput.html | 963 -- html-docs/flash/utils/IExternalizable.html | 406 - html-docs/flash/utils/Proxy.html | 495 - html-docs/flash/utils/Timer.html | 847 -- html-docs/flash/utils/package-detail.html | 161 - html-docs/flash/utils/package.html | 1023 -- html-docs/flash/xml/XMLDocument.html | 882 -- html-docs/flash/xml/XMLNode.html | 1368 -- html-docs/flash/xml/XMLNodeType.html | 300 - html-docs/flash/xml/package-detail.html | 67 - html-docs/float.html | 824 -- html-docs/index.html | 72 - html-docs/int.html | 779 -- html-docs/language-elements.html | 61 - html-docs/migration.html | 2443 ---- html-docs/operators.html | 5115 -------- html-docs/package-detail.html | 393 - html-docs/package-summary.html | 179 - html-docs/package.html | 2774 ---- html-docs/runtimeErrors.html | 2892 ----- html-docs/specialTypes.html | 155 - html-docs/statements.html | 2830 ----- html-docs/uint.html | 773 -- html-docs/whatsnew.html | 1352 -- llms.txt | 40 + 658 files changed, 246 insertions(+), 592609 deletions(-) delete mode 100644 PROGRESS.md delete mode 100644 STYLE_GUIDE.md delete mode 100644 crawl_docs.py delete mode 100644 html-docs/ArgumentError.html delete mode 100644 html-docs/Array.html delete mode 100644 html-docs/Boolean.html delete mode 100644 html-docs/Class.html delete mode 100644 html-docs/Date.html delete mode 100644 html-docs/DefinitionError.html delete mode 100644 html-docs/Error.html delete mode 100644 html-docs/EvalError.html delete mode 100644 html-docs/Function.html delete mode 100644 html-docs/JSON.html delete mode 100644 html-docs/Math.html delete mode 100644 html-docs/Namespace.html delete mode 100644 html-docs/Number.html delete mode 100644 html-docs/Object.html delete mode 100644 html-docs/QName.html delete mode 100644 html-docs/RangeError.html delete mode 100644 html-docs/ReferenceError.html delete mode 100644 html-docs/RegExp.html delete mode 100644 html-docs/SecurityError.html delete mode 100644 html-docs/String.html delete mode 100644 html-docs/SyntaxError.html delete mode 100644 html-docs/TimeZone.html delete mode 100644 html-docs/TypeError.html delete mode 100644 html-docs/URIError.html delete mode 100644 html-docs/Vector.html delete mode 100644 html-docs/VerifyError.html delete mode 100644 html-docs/XML.html delete mode 100644 html-docs/XMLList.html delete mode 100644 html-docs/air/net/WebSocket.html delete mode 100644 html-docs/air/net/package-detail.html delete mode 100644 html-docs/air/security/Digest.html delete mode 100644 html-docs/air/security/Encryption.html delete mode 100644 html-docs/air/security/package-detail.html delete mode 100644 html-docs/air/system/License.html delete mode 100644 html-docs/air/system/package-detail.html delete mode 100644 html-docs/air/update/ApplicationUpdater.html delete mode 100644 html-docs/air/update/ApplicationUpdaterUI.html delete mode 100644 html-docs/air/update/events/DownloadErrorEvent.html delete mode 100644 html-docs/air/update/events/StatusFileUpdateErrorEvent.html delete mode 100644 html-docs/air/update/events/StatusFileUpdateEvent.html delete mode 100644 html-docs/air/update/events/StatusUpdateErrorEvent.html delete mode 100644 html-docs/air/update/events/StatusUpdateEvent.html delete mode 100644 html-docs/air/update/events/UpdateEvent.html delete mode 100644 html-docs/air/update/events/package-detail.html delete mode 100644 html-docs/air/update/package-detail.html delete mode 100644 html-docs/air/utils/ZipArchive.html delete mode 100644 html-docs/air/utils/ZipEntry.html delete mode 100644 html-docs/air/utils/package-detail.html delete mode 100644 html-docs/all-classes.html delete mode 100644 html-docs/all-index-A.html delete mode 100644 html-docs/all-index-B.html delete mode 100644 html-docs/all-index-C.html delete mode 100644 html-docs/all-index-D.html delete mode 100644 html-docs/all-index-E.html delete mode 100644 html-docs/all-index-F.html delete mode 100644 html-docs/all-index-G.html delete mode 100644 html-docs/all-index-H.html delete mode 100644 html-docs/all-index-I.html delete mode 100644 html-docs/all-index-J.html delete mode 100644 html-docs/all-index-K.html delete mode 100644 html-docs/all-index-L.html delete mode 100644 html-docs/all-index-M.html delete mode 100644 html-docs/all-index-N.html delete mode 100644 html-docs/all-index-O.html delete mode 100644 html-docs/all-index-P.html delete mode 100644 html-docs/all-index-Q.html delete mode 100644 html-docs/all-index-R.html delete mode 100644 html-docs/all-index-S.html delete mode 100644 html-docs/all-index-Symbols.html delete mode 100644 html-docs/all-index-T.html delete mode 100644 html-docs/all-index-U.html delete mode 100644 html-docs/all-index-V.html delete mode 100644 html-docs/all-index-W.html delete mode 100644 html-docs/all-index-X.html delete mode 100644 html-docs/all-index-Y.html delete mode 100644 html-docs/all-index-Z.html delete mode 100644 html-docs/appendices.html delete mode 100644 html-docs/arguments.html delete mode 100644 html-docs/avm2/intrinsics/iteration/package-detail.html delete mode 100644 html-docs/avm2/intrinsics/iteration/package.html delete mode 100644 html-docs/avm2/intrinsics/memory/package-detail.html delete mode 100644 html-docs/avm2/intrinsics/memory/package.html delete mode 100644 html-docs/charset-codes.html delete mode 100644 html-docs/class-summary.html delete mode 100644 html-docs/compilerErrors.html delete mode 100644 html-docs/compilerWarnings.html delete mode 100644 html-docs/conventions.html delete mode 100644 html-docs/flash/accessibility/Accessibility.html delete mode 100644 html-docs/flash/accessibility/AccessibilityImplementation.html delete mode 100644 html-docs/flash/accessibility/AccessibilityProperties.html delete mode 100644 html-docs/flash/accessibility/ISearchableText.html delete mode 100644 html-docs/flash/accessibility/ISimpleTextSelection.html delete mode 100644 html-docs/flash/accessibility/package-detail.html delete mode 100644 html-docs/flash/concurrent/Condition.html delete mode 100644 html-docs/flash/concurrent/Mutex.html delete mode 100644 html-docs/flash/concurrent/package-detail.html delete mode 100644 html-docs/flash/crypto/package-detail.html delete mode 100644 html-docs/flash/crypto/package.html delete mode 100644 html-docs/flash/data/EncryptedLocalStore.html delete mode 100644 html-docs/flash/data/SQLCollationType.html delete mode 100644 html-docs/flash/data/SQLColumnNameStyle.html delete mode 100644 html-docs/flash/data/SQLColumnSchema.html delete mode 100644 html-docs/flash/data/SQLConnection.html delete mode 100644 html-docs/flash/data/SQLIndexSchema.html delete mode 100644 html-docs/flash/data/SQLMode.html delete mode 100644 html-docs/flash/data/SQLResult.html delete mode 100644 html-docs/flash/data/SQLSchema.html delete mode 100644 html-docs/flash/data/SQLSchemaResult.html delete mode 100644 html-docs/flash/data/SQLStatement.html delete mode 100644 html-docs/flash/data/SQLTableSchema.html delete mode 100644 html-docs/flash/data/SQLTransactionLockType.html delete mode 100644 html-docs/flash/data/SQLTriggerSchema.html delete mode 100644 html-docs/flash/data/SQLViewSchema.html delete mode 100644 html-docs/flash/data/package-detail.html delete mode 100644 html-docs/flash/desktop/Clipboard.html delete mode 100644 html-docs/flash/desktop/ClipboardFormats.html delete mode 100644 html-docs/flash/desktop/ClipboardTransferMode.html delete mode 100644 html-docs/flash/desktop/DockIcon.html delete mode 100644 html-docs/flash/desktop/IFilePromise.html delete mode 100644 html-docs/flash/desktop/Icon.html delete mode 100644 html-docs/flash/desktop/InteractiveIcon.html delete mode 100644 html-docs/flash/desktop/InvokeEventReason.html delete mode 100644 html-docs/flash/desktop/NativeApplication.html delete mode 100644 html-docs/flash/desktop/NativeDragActions.html delete mode 100644 html-docs/flash/desktop/NativeDragManager.html delete mode 100644 html-docs/flash/desktop/NativeDragOptions.html delete mode 100644 html-docs/flash/desktop/NativeProcess.html delete mode 100644 html-docs/flash/desktop/NativeProcessStartupInfo.html delete mode 100644 html-docs/flash/desktop/NotificationType.html delete mode 100644 html-docs/flash/desktop/SystemIdleMode.html delete mode 100644 html-docs/flash/desktop/SystemTrayIcon.html delete mode 100644 html-docs/flash/desktop/Updater.html delete mode 100644 html-docs/flash/desktop/package-detail.html delete mode 100644 html-docs/flash/display/AVM1Movie.html delete mode 100644 html-docs/flash/display/ActionScriptVersion.html delete mode 100644 html-docs/flash/display/Bitmap.html delete mode 100644 html-docs/flash/display/BitmapData.html delete mode 100644 html-docs/flash/display/BitmapDataChannel.html delete mode 100644 html-docs/flash/display/BitmapEncodingColorSpace.html delete mode 100644 html-docs/flash/display/BlendMode.html delete mode 100644 html-docs/flash/display/CapsStyle.html delete mode 100644 html-docs/flash/display/ColorCorrection.html delete mode 100644 html-docs/flash/display/ColorCorrectionSupport.html delete mode 100644 html-docs/flash/display/DisplayObject.html delete mode 100644 html-docs/flash/display/DisplayObjectContainer.html delete mode 100644 html-docs/flash/display/FocusDirection.html delete mode 100644 html-docs/flash/display/FrameLabel.html delete mode 100644 html-docs/flash/display/GradientType.html delete mode 100644 html-docs/flash/display/Graphics.html delete mode 100644 html-docs/flash/display/GraphicsBitmapFill.html delete mode 100644 html-docs/flash/display/GraphicsEndFill.html delete mode 100644 html-docs/flash/display/GraphicsGradientFill.html delete mode 100644 html-docs/flash/display/GraphicsPath.html delete mode 100644 html-docs/flash/display/GraphicsPathCommand.html delete mode 100644 html-docs/flash/display/GraphicsPathWinding.html delete mode 100644 html-docs/flash/display/GraphicsShaderFill.html delete mode 100644 html-docs/flash/display/GraphicsSolidFill.html delete mode 100644 html-docs/flash/display/GraphicsStroke.html delete mode 100644 html-docs/flash/display/GraphicsTrianglePath.html delete mode 100644 html-docs/flash/display/IBitmapDrawable.html delete mode 100644 html-docs/flash/display/IGraphicsData.html delete mode 100644 html-docs/flash/display/IGraphicsFill.html delete mode 100644 html-docs/flash/display/IGraphicsPath.html delete mode 100644 html-docs/flash/display/IGraphicsStroke.html delete mode 100644 html-docs/flash/display/InteractiveObject.html delete mode 100644 html-docs/flash/display/InterpolationMethod.html delete mode 100644 html-docs/flash/display/JPEGEncoderOptions.html delete mode 100644 html-docs/flash/display/JPEGXREncoderOptions.html delete mode 100644 html-docs/flash/display/JointStyle.html delete mode 100644 html-docs/flash/display/LineScaleMode.html delete mode 100644 html-docs/flash/display/Loader.html delete mode 100644 html-docs/flash/display/LoaderInfo.html delete mode 100644 html-docs/flash/display/MorphShape.html delete mode 100644 html-docs/flash/display/MovieClip.html delete mode 100644 html-docs/flash/display/NativeMenu.html delete mode 100644 html-docs/flash/display/NativeMenuItem.html delete mode 100644 html-docs/flash/display/NativeWindow.html delete mode 100644 html-docs/flash/display/NativeWindowDisplayState.html delete mode 100644 html-docs/flash/display/NativeWindowInitOptions.html delete mode 100644 html-docs/flash/display/NativeWindowRenderMode.html delete mode 100644 html-docs/flash/display/NativeWindowResize.html delete mode 100644 html-docs/flash/display/NativeWindowSystemChrome.html delete mode 100644 html-docs/flash/display/NativeWindowType.html delete mode 100644 html-docs/flash/display/PNGEncoderOptions.html delete mode 100644 html-docs/flash/display/PixelSnapping.html delete mode 100644 html-docs/flash/display/SWFVersion.html delete mode 100644 html-docs/flash/display/Scene.html delete mode 100644 html-docs/flash/display/Screen.html delete mode 100644 html-docs/flash/display/ScreenMode.html delete mode 100644 html-docs/flash/display/Shader.html delete mode 100644 html-docs/flash/display/ShaderData.html delete mode 100644 html-docs/flash/display/ShaderInput.html delete mode 100644 html-docs/flash/display/ShaderJob.html delete mode 100644 html-docs/flash/display/ShaderParameter.html delete mode 100644 html-docs/flash/display/ShaderParameterType.html delete mode 100644 html-docs/flash/display/ShaderPrecision.html delete mode 100644 html-docs/flash/display/Shape.html delete mode 100644 html-docs/flash/display/SimpleButton.html delete mode 100644 html-docs/flash/display/SpreadMethod.html delete mode 100644 html-docs/flash/display/Sprite.html delete mode 100644 html-docs/flash/display/Stage.html delete mode 100644 html-docs/flash/display/Stage3D.html delete mode 100644 html-docs/flash/display/StageAlign.html delete mode 100644 html-docs/flash/display/StageAspectRatio.html delete mode 100644 html-docs/flash/display/StageDisplayState.html delete mode 100644 html-docs/flash/display/StageOrientation.html delete mode 100644 html-docs/flash/display/StageQuality.html delete mode 100644 html-docs/flash/display/StageScaleMode.html delete mode 100644 html-docs/flash/display/TriangleCulling.html delete mode 100644 html-docs/flash/display/package-detail.html delete mode 100644 html-docs/flash/display3D/Context3D.html delete mode 100644 html-docs/flash/display3D/Context3DBlendFactor.html delete mode 100644 html-docs/flash/display3D/Context3DBufferUsage.html delete mode 100644 html-docs/flash/display3D/Context3DClearMask.html delete mode 100644 html-docs/flash/display3D/Context3DCompareMode.html delete mode 100644 html-docs/flash/display3D/Context3DFillMode.html delete mode 100644 html-docs/flash/display3D/Context3DMipFilter.html delete mode 100644 html-docs/flash/display3D/Context3DProfile.html delete mode 100644 html-docs/flash/display3D/Context3DProgramType.html delete mode 100644 html-docs/flash/display3D/Context3DRenderMode.html delete mode 100644 html-docs/flash/display3D/Context3DStencilAction.html delete mode 100644 html-docs/flash/display3D/Context3DTextureFilter.html delete mode 100644 html-docs/flash/display3D/Context3DTextureFormat.html delete mode 100644 html-docs/flash/display3D/Context3DTriangleFace.html delete mode 100644 html-docs/flash/display3D/Context3DVertexBufferFormat.html delete mode 100644 html-docs/flash/display3D/Context3DWrapMode.html delete mode 100644 html-docs/flash/display3D/IndexBuffer3D.html delete mode 100644 html-docs/flash/display3D/Program3D.html delete mode 100644 html-docs/flash/display3D/VertexBuffer3D.html delete mode 100644 html-docs/flash/display3D/package-detail.html delete mode 100644 html-docs/flash/display3D/textures/CubeTexture.html delete mode 100644 html-docs/flash/display3D/textures/RectangleTexture.html delete mode 100644 html-docs/flash/display3D/textures/Texture.html delete mode 100644 html-docs/flash/display3D/textures/TextureBase.html delete mode 100644 html-docs/flash/display3D/textures/VideoTexture.html delete mode 100644 html-docs/flash/display3D/textures/package-detail.html delete mode 100644 html-docs/flash/errors/DRMManagerError.html delete mode 100644 html-docs/flash/errors/InvalidSWFError.html delete mode 100644 html-docs/flash/errors/PermissionError.html delete mode 100644 html-docs/flash/errors/SQLError.html delete mode 100644 html-docs/flash/errors/SQLErrorOperation.html delete mode 100644 html-docs/flash/errors/ScriptTimeoutError.html delete mode 100644 html-docs/flash/errors/StackOverflowError.html delete mode 100644 html-docs/flash/errors/package-detail.html delete mode 100644 html-docs/flash/events/AccelerometerEvent.html delete mode 100644 html-docs/flash/events/ActivityEvent.html delete mode 100644 html-docs/flash/events/AsyncErrorEvent.html delete mode 100644 html-docs/flash/events/AudioOutputChangeEvent.html delete mode 100644 html-docs/flash/events/BrowserInvokeEvent.html delete mode 100644 html-docs/flash/events/ContextMenuEvent.html delete mode 100644 html-docs/flash/events/DNSResolverEvent.html delete mode 100644 html-docs/flash/events/DRMAuthenticateEvent.html delete mode 100644 html-docs/flash/events/DRMAuthenticationCompleteEvent.html delete mode 100644 html-docs/flash/events/DRMAuthenticationErrorEvent.html delete mode 100644 html-docs/flash/events/DRMDeviceGroupErrorEvent.html delete mode 100644 html-docs/flash/events/DRMDeviceGroupEvent.html delete mode 100644 html-docs/flash/events/DRMErrorEvent.html delete mode 100644 html-docs/flash/events/DRMLicenseRequestEvent.html delete mode 100644 html-docs/flash/events/DRMReturnVoucherCompleteEvent.html delete mode 100644 html-docs/flash/events/DRMReturnVoucherErrorEvent.html delete mode 100644 html-docs/flash/events/DRMStatusEvent.html delete mode 100644 html-docs/flash/events/DataEvent.html delete mode 100644 html-docs/flash/events/DatagramSocketDataEvent.html delete mode 100644 html-docs/flash/events/DeviceRotationEvent.html delete mode 100644 html-docs/flash/events/ErrorEvent.html delete mode 100644 html-docs/flash/events/Event.html delete mode 100644 html-docs/flash/events/EventDispatcher.html delete mode 100644 html-docs/flash/events/EventPhase.html delete mode 100644 html-docs/flash/events/FileListEvent.html delete mode 100644 html-docs/flash/events/FocusEvent.html delete mode 100644 html-docs/flash/events/FullScreenEvent.html delete mode 100644 html-docs/flash/events/GameInputEvent.html delete mode 100644 html-docs/flash/events/GeolocationEvent.html delete mode 100644 html-docs/flash/events/GestureEvent.html delete mode 100644 html-docs/flash/events/GesturePhase.html delete mode 100644 html-docs/flash/events/HTMLUncaughtScriptExceptionEvent.html delete mode 100644 html-docs/flash/events/HTTPStatusEvent.html delete mode 100644 html-docs/flash/events/IEventDispatcher.html delete mode 100644 html-docs/flash/events/IMEEvent.html delete mode 100644 html-docs/flash/events/IOErrorEvent.html delete mode 100644 html-docs/flash/events/InvokeEvent.html delete mode 100644 html-docs/flash/events/KeyboardEvent.html delete mode 100644 html-docs/flash/events/LocationChangeEvent.html delete mode 100644 html-docs/flash/events/MediaEvent.html delete mode 100644 html-docs/flash/events/MouseEvent.html delete mode 100644 html-docs/flash/events/NativeDragEvent.html delete mode 100644 html-docs/flash/events/NativeProcessExitEvent.html delete mode 100644 html-docs/flash/events/NativeWindowBoundsEvent.html delete mode 100644 html-docs/flash/events/NativeWindowDisplayStateEvent.html delete mode 100644 html-docs/flash/events/NetDataEvent.html delete mode 100644 html-docs/flash/events/NetMonitorEvent.html delete mode 100644 html-docs/flash/events/NetStatusEvent.html delete mode 100644 html-docs/flash/events/OutputProgressEvent.html delete mode 100644 html-docs/flash/events/PermissionEvent.html delete mode 100644 html-docs/flash/events/PressAndTapGestureEvent.html delete mode 100644 html-docs/flash/events/ProgressEvent.html delete mode 100644 html-docs/flash/events/RemoteNotificationEvent.html delete mode 100644 html-docs/flash/events/SQLErrorEvent.html delete mode 100644 html-docs/flash/events/SQLEvent.html delete mode 100644 html-docs/flash/events/SQLUpdateEvent.html delete mode 100644 html-docs/flash/events/SampleDataEvent.html delete mode 100644 html-docs/flash/events/ScreenMouseEvent.html delete mode 100644 html-docs/flash/events/SecurityErrorEvent.html delete mode 100644 html-docs/flash/events/ServerSocketConnectEvent.html delete mode 100644 html-docs/flash/events/ShaderEvent.html delete mode 100644 html-docs/flash/events/SoftKeyboardEvent.html delete mode 100644 html-docs/flash/events/SoftKeyboardTrigger.html delete mode 100644 html-docs/flash/events/StageOrientationEvent.html delete mode 100644 html-docs/flash/events/StageVideoAvailabilityEvent.html delete mode 100644 html-docs/flash/events/StageVideoEvent.html delete mode 100644 html-docs/flash/events/StatusEvent.html delete mode 100644 html-docs/flash/events/StorageVolumeChangeEvent.html delete mode 100644 html-docs/flash/events/SyncEvent.html delete mode 100644 html-docs/flash/events/TextEvent.html delete mode 100644 html-docs/flash/events/ThrottleEvent.html delete mode 100644 html-docs/flash/events/ThrottleType.html delete mode 100644 html-docs/flash/events/TimerEvent.html delete mode 100644 html-docs/flash/events/TouchEvent.html delete mode 100644 html-docs/flash/events/TouchEventIntent.html delete mode 100644 html-docs/flash/events/TransformGestureEvent.html delete mode 100644 html-docs/flash/events/UncaughtErrorEvent.html delete mode 100644 html-docs/flash/events/UncaughtErrorEvents.html delete mode 100644 html-docs/flash/events/VideoEvent.html delete mode 100644 html-docs/flash/events/VideoTextureEvent.html delete mode 100644 html-docs/flash/events/VsyncStateChangeAvailabilityEvent.html delete mode 100644 html-docs/flash/events/WebSocketEvent.html delete mode 100644 html-docs/flash/events/WebViewDrawEvent.html delete mode 100644 html-docs/flash/events/package-detail.html delete mode 100644 html-docs/flash/external/ExtensionContext.html delete mode 100644 html-docs/flash/external/ExtensionInfo.html delete mode 100644 html-docs/flash/external/ExternalInterface.html delete mode 100644 html-docs/flash/external/HostObject.html delete mode 100644 html-docs/flash/external/package-detail.html delete mode 100644 html-docs/flash/filesystem/File.html delete mode 100644 html-docs/flash/filesystem/FileMode.html delete mode 100644 html-docs/flash/filesystem/FileStream.html delete mode 100644 html-docs/flash/filesystem/StorageVolume.html delete mode 100644 html-docs/flash/filesystem/StorageVolumeInfo.html delete mode 100644 html-docs/flash/filesystem/package-detail.html delete mode 100644 html-docs/flash/filters/BevelFilter.html delete mode 100644 html-docs/flash/filters/BitmapFilter.html delete mode 100644 html-docs/flash/filters/BitmapFilterQuality.html delete mode 100644 html-docs/flash/filters/BitmapFilterType.html delete mode 100644 html-docs/flash/filters/BlurFilter.html delete mode 100644 html-docs/flash/filters/ColorMatrixFilter.html delete mode 100644 html-docs/flash/filters/ConvolutionFilter.html delete mode 100644 html-docs/flash/filters/DisplacementMapFilter.html delete mode 100644 html-docs/flash/filters/DisplacementMapFilterMode.html delete mode 100644 html-docs/flash/filters/DropShadowFilter.html delete mode 100644 html-docs/flash/filters/GlowFilter.html delete mode 100644 html-docs/flash/filters/GradientBevelFilter.html delete mode 100644 html-docs/flash/filters/GradientGlowFilter.html delete mode 100644 html-docs/flash/filters/ShaderFilter.html delete mode 100644 html-docs/flash/filters/package-detail.html delete mode 100644 html-docs/flash/geom/ColorTransform.html delete mode 100644 html-docs/flash/geom/Matrix.html delete mode 100644 html-docs/flash/geom/Matrix3D.html delete mode 100644 html-docs/flash/geom/Orientation3D.html delete mode 100644 html-docs/flash/geom/PerspectiveProjection.html delete mode 100644 html-docs/flash/geom/Point.html delete mode 100644 html-docs/flash/geom/Rectangle.html delete mode 100644 html-docs/flash/geom/Transform.html delete mode 100644 html-docs/flash/geom/Utils3D.html delete mode 100644 html-docs/flash/geom/Vector3D.html delete mode 100644 html-docs/flash/geom/package-detail.html delete mode 100644 html-docs/flash/globalization/Collator.html delete mode 100644 html-docs/flash/globalization/CollatorMode.html delete mode 100644 html-docs/flash/globalization/CurrencyFormatter.html delete mode 100644 html-docs/flash/globalization/CurrencyParseResult.html delete mode 100644 html-docs/flash/globalization/DateTimeFormatter.html delete mode 100644 html-docs/flash/globalization/DateTimeNameContext.html delete mode 100644 html-docs/flash/globalization/DateTimeNameStyle.html delete mode 100644 html-docs/flash/globalization/DateTimeStyle.html delete mode 100644 html-docs/flash/globalization/LastOperationStatus.html delete mode 100644 html-docs/flash/globalization/LocaleID.html delete mode 100644 html-docs/flash/globalization/NationalDigitsType.html delete mode 100644 html-docs/flash/globalization/NumberFormatter.html delete mode 100644 html-docs/flash/globalization/NumberParseResult.html delete mode 100644 html-docs/flash/globalization/StringTools.html delete mode 100644 html-docs/flash/globalization/package-detail.html delete mode 100644 html-docs/flash/html/HTMLHistoryItem.html delete mode 100644 html-docs/flash/html/HTMLHost.html delete mode 100644 html-docs/flash/html/HTMLLoader.html delete mode 100644 html-docs/flash/html/HTMLPDFCapability.html delete mode 100644 html-docs/flash/html/HTMLSWFCapability.html delete mode 100644 html-docs/flash/html/HTMLWindowCreateOptions.html delete mode 100644 html-docs/flash/html/package-detail.html delete mode 100644 html-docs/flash/media/AudioDecoder.html delete mode 100644 html-docs/flash/media/AudioDeviceManager.html delete mode 100644 html-docs/flash/media/AudioOutputChangeReason.html delete mode 100644 html-docs/flash/media/AudioPlaybackMode.html delete mode 100644 html-docs/flash/media/Camera.html delete mode 100644 html-docs/flash/media/CameraPosition.html delete mode 100644 html-docs/flash/media/CameraRoll.html delete mode 100644 html-docs/flash/media/CameraRollBrowseOptions.html delete mode 100644 html-docs/flash/media/CameraUI.html delete mode 100644 html-docs/flash/media/H264Level.html delete mode 100644 html-docs/flash/media/H264Profile.html delete mode 100644 html-docs/flash/media/H264VideoStreamSettings.html delete mode 100644 html-docs/flash/media/ID3Info.html delete mode 100644 html-docs/flash/media/MediaPromise.html delete mode 100644 html-docs/flash/media/MediaType.html delete mode 100644 html-docs/flash/media/Microphone.html delete mode 100644 html-docs/flash/media/MicrophoneEnhancedMode.html delete mode 100644 html-docs/flash/media/MicrophoneEnhancedOptions.html delete mode 100644 html-docs/flash/media/Sound.html delete mode 100644 html-docs/flash/media/SoundChannel.html delete mode 100644 html-docs/flash/media/SoundCodec.html delete mode 100644 html-docs/flash/media/SoundLoaderContext.html delete mode 100644 html-docs/flash/media/SoundMixer.html delete mode 100644 html-docs/flash/media/SoundTransform.html delete mode 100644 html-docs/flash/media/StageVideo.html delete mode 100644 html-docs/flash/media/StageVideoAvailability.html delete mode 100644 html-docs/flash/media/StageVideoAvailabilityReason.html delete mode 100644 html-docs/flash/media/StageWebView.html delete mode 100644 html-docs/flash/media/Video.html delete mode 100644 html-docs/flash/media/VideoCodec.html delete mode 100644 html-docs/flash/media/VideoStatus.html delete mode 100644 html-docs/flash/media/VideoStreamSettings.html delete mode 100644 html-docs/flash/media/package-detail.html delete mode 100644 html-docs/flash/media/package.html delete mode 100644 html-docs/flash/net/DatagramSocket.html delete mode 100644 html-docs/flash/net/FileFilter.html delete mode 100644 html-docs/flash/net/FileReference.html delete mode 100644 html-docs/flash/net/FileReferenceList.html delete mode 100644 html-docs/flash/net/GroupSpecifier.html delete mode 100644 html-docs/flash/net/IDynamicPropertyOutput.html delete mode 100644 html-docs/flash/net/IDynamicPropertyWriter.html delete mode 100644 html-docs/flash/net/IPVersion.html delete mode 100644 html-docs/flash/net/InterfaceAddress.html delete mode 100644 html-docs/flash/net/LocalConnection.html delete mode 100644 html-docs/flash/net/NetConnection.html delete mode 100644 html-docs/flash/net/NetGroup.html delete mode 100644 html-docs/flash/net/NetGroupInfo.html delete mode 100644 html-docs/flash/net/NetGroupReceiveMode.html delete mode 100644 html-docs/flash/net/NetGroupReplicationStrategy.html delete mode 100644 html-docs/flash/net/NetGroupSendMode.html delete mode 100644 html-docs/flash/net/NetGroupSendResult.html delete mode 100644 html-docs/flash/net/NetMonitor.html delete mode 100644 html-docs/flash/net/NetStream.html delete mode 100644 html-docs/flash/net/NetStreamAppendBytesAction.html delete mode 100644 html-docs/flash/net/NetStreamInfo.html delete mode 100644 html-docs/flash/net/NetStreamMulticastInfo.html delete mode 100644 html-docs/flash/net/NetStreamPlayOptions.html delete mode 100644 html-docs/flash/net/NetStreamPlayTransitions.html delete mode 100644 html-docs/flash/net/NetworkInfo.html delete mode 100644 html-docs/flash/net/NetworkInterface.html delete mode 100644 html-docs/flash/net/ObjectEncoding.html delete mode 100644 html-docs/flash/net/Responder.html delete mode 100644 html-docs/flash/net/SecureSocket.html delete mode 100644 html-docs/flash/net/ServerSocket.html delete mode 100644 html-docs/flash/net/SharedObject.html delete mode 100644 html-docs/flash/net/SharedObjectFlushStatus.html delete mode 100644 html-docs/flash/net/Socket.html delete mode 100644 html-docs/flash/net/URLLoader.html delete mode 100644 html-docs/flash/net/URLLoaderDataFormat.html delete mode 100644 html-docs/flash/net/URLRequest.html delete mode 100644 html-docs/flash/net/URLRequestDefaults.html delete mode 100644 html-docs/flash/net/URLRequestHeader.html delete mode 100644 html-docs/flash/net/URLRequestMethod.html delete mode 100644 html-docs/flash/net/URLStream.html delete mode 100644 html-docs/flash/net/URLVariables.html delete mode 100644 html-docs/flash/net/XMLSocket.html delete mode 100644 html-docs/flash/net/dns/AAAARecord.html delete mode 100644 html-docs/flash/net/dns/ARecord.html delete mode 100644 html-docs/flash/net/dns/DNSResolver.html delete mode 100644 html-docs/flash/net/dns/MXRecord.html delete mode 100644 html-docs/flash/net/dns/PTRRecord.html delete mode 100644 html-docs/flash/net/dns/ResourceRecord.html delete mode 100644 html-docs/flash/net/dns/SRVRecord.html delete mode 100644 html-docs/flash/net/dns/package-detail.html delete mode 100644 html-docs/flash/net/drm/AuthenticationMethod.html delete mode 100644 html-docs/flash/net/drm/DRMContentData.html delete mode 100644 html-docs/flash/net/drm/DRMDeviceGroup.html delete mode 100644 html-docs/flash/net/drm/DRMManager.html delete mode 100644 html-docs/flash/net/drm/DRMPlaybackTimeWindow.html delete mode 100644 html-docs/flash/net/drm/DRMVoucher.html delete mode 100644 html-docs/flash/net/drm/LoadVoucherSetting.html delete mode 100644 html-docs/flash/net/drm/VoucherAccessInfo.html delete mode 100644 html-docs/flash/net/drm/package-detail.html delete mode 100644 html-docs/flash/net/package-detail.html delete mode 100644 html-docs/flash/net/package.html delete mode 100644 html-docs/flash/notifications/NotificationStyle.html delete mode 100644 html-docs/flash/notifications/RemoteNotifier.html delete mode 100644 html-docs/flash/notifications/RemoteNotifierSubscribeOptions.html delete mode 100644 html-docs/flash/notifications/package-detail.html delete mode 100644 html-docs/flash/permissions/PermissionManager.html delete mode 100644 html-docs/flash/permissions/PermissionStatus.html delete mode 100644 html-docs/flash/permissions/package-detail.html delete mode 100644 html-docs/flash/printing/PaperSize.html delete mode 100644 html-docs/flash/printing/PrintJob.html delete mode 100644 html-docs/flash/printing/PrintJobOptions.html delete mode 100644 html-docs/flash/printing/PrintJobOrientation.html delete mode 100644 html-docs/flash/printing/PrintMethod.html delete mode 100644 html-docs/flash/printing/PrintUIOptions.html delete mode 100644 html-docs/flash/printing/package-detail.html delete mode 100644 html-docs/flash/profiler/Telemetry.html delete mode 100644 html-docs/flash/profiler/package-detail.html delete mode 100644 html-docs/flash/profiler/package.html delete mode 100644 html-docs/flash/security/CertificateStatus.html delete mode 100644 html-docs/flash/security/IURIDereferencer.html delete mode 100644 html-docs/flash/security/ReferencesValidationSetting.html delete mode 100644 html-docs/flash/security/RevocationCheckSettings.html delete mode 100644 html-docs/flash/security/SignatureStatus.html delete mode 100644 html-docs/flash/security/SignerTrustSettings.html delete mode 100644 html-docs/flash/security/X500DistinguishedName.html delete mode 100644 html-docs/flash/security/X509Certificate.html delete mode 100644 html-docs/flash/security/XMLSignatureValidator.html delete mode 100644 html-docs/flash/security/package-detail.html delete mode 100644 html-docs/flash/sensors/Accelerometer.html delete mode 100644 html-docs/flash/sensors/DeviceRotation.html delete mode 100644 html-docs/flash/sensors/Geolocation.html delete mode 100644 html-docs/flash/sensors/package-detail.html delete mode 100644 html-docs/flash/system/ApplicationDomain.html delete mode 100644 html-docs/flash/system/Capabilities.html delete mode 100644 html-docs/flash/system/IME.html delete mode 100644 html-docs/flash/system/IMEConversionMode.html delete mode 100644 html-docs/flash/system/ImageDecodingPolicy.html delete mode 100644 html-docs/flash/system/JPEGLoaderContext.html delete mode 100644 html-docs/flash/system/LoaderContext.html delete mode 100644 html-docs/flash/system/MessageChannel.html delete mode 100644 html-docs/flash/system/MessageChannelState.html delete mode 100644 html-docs/flash/system/Security.html delete mode 100644 html-docs/flash/system/SecurityDomain.html delete mode 100644 html-docs/flash/system/SecurityPanel.html delete mode 100644 html-docs/flash/system/System.html delete mode 100644 html-docs/flash/system/SystemUpdater.html delete mode 100644 html-docs/flash/system/SystemUpdaterType.html delete mode 100644 html-docs/flash/system/TouchscreenType.html delete mode 100644 html-docs/flash/system/Worker.html delete mode 100644 html-docs/flash/system/WorkerDomain.html delete mode 100644 html-docs/flash/system/WorkerState.html delete mode 100644 html-docs/flash/system/package-detail.html delete mode 100644 html-docs/flash/system/package.html delete mode 100644 html-docs/flash/text/AntiAliasType.html delete mode 100644 html-docs/flash/text/AutoCapitalize.html delete mode 100644 html-docs/flash/text/CSMSettings.html delete mode 100644 html-docs/flash/text/Font.html delete mode 100644 html-docs/flash/text/FontStyle.html delete mode 100644 html-docs/flash/text/FontType.html delete mode 100644 html-docs/flash/text/GridFitType.html delete mode 100644 html-docs/flash/text/ReturnKeyLabel.html delete mode 100644 html-docs/flash/text/SoftKeyboardType.html delete mode 100644 html-docs/flash/text/StageText.html delete mode 100644 html-docs/flash/text/StageTextClearButtonMode.html delete mode 100644 html-docs/flash/text/StageTextContentType.html delete mode 100644 html-docs/flash/text/StageTextInitOptions.html delete mode 100644 html-docs/flash/text/StaticText.html delete mode 100644 html-docs/flash/text/StyleSheet.html delete mode 100644 html-docs/flash/text/TextColorType.html delete mode 100644 html-docs/flash/text/TextDisplayMode.html delete mode 100644 html-docs/flash/text/TextExtent.html delete mode 100644 html-docs/flash/text/TextField.html delete mode 100644 html-docs/flash/text/TextFieldAutoSize.html delete mode 100644 html-docs/flash/text/TextFieldType.html delete mode 100644 html-docs/flash/text/TextFormat.html delete mode 100644 html-docs/flash/text/TextFormatAlign.html delete mode 100644 html-docs/flash/text/TextInteractionMode.html delete mode 100644 html-docs/flash/text/TextLineMetrics.html delete mode 100644 html-docs/flash/text/TextRenderer.html delete mode 100644 html-docs/flash/text/TextSnapshot.html delete mode 100644 html-docs/flash/text/engine/BreakOpportunity.html delete mode 100644 html-docs/flash/text/engine/CFFHinting.html delete mode 100644 html-docs/flash/text/engine/ContentElement.html delete mode 100644 html-docs/flash/text/engine/DigitCase.html delete mode 100644 html-docs/flash/text/engine/DigitWidth.html delete mode 100644 html-docs/flash/text/engine/EastAsianJustifier.html delete mode 100644 html-docs/flash/text/engine/ElementFormat.html delete mode 100644 html-docs/flash/text/engine/FontDescription.html delete mode 100644 html-docs/flash/text/engine/FontLookup.html delete mode 100644 html-docs/flash/text/engine/FontMetrics.html delete mode 100644 html-docs/flash/text/engine/FontPosture.html delete mode 100644 html-docs/flash/text/engine/FontWeight.html delete mode 100644 html-docs/flash/text/engine/GraphicElement.html delete mode 100644 html-docs/flash/text/engine/GroupElement.html delete mode 100644 html-docs/flash/text/engine/JustificationStyle.html delete mode 100644 html-docs/flash/text/engine/Kerning.html delete mode 100644 html-docs/flash/text/engine/LigatureLevel.html delete mode 100644 html-docs/flash/text/engine/LineJustification.html delete mode 100644 html-docs/flash/text/engine/RenderingMode.html delete mode 100644 html-docs/flash/text/engine/SpaceJustifier.html delete mode 100644 html-docs/flash/text/engine/TabAlignment.html delete mode 100644 html-docs/flash/text/engine/TabStop.html delete mode 100644 html-docs/flash/text/engine/TextBaseline.html delete mode 100644 html-docs/flash/text/engine/TextBlock.html delete mode 100644 html-docs/flash/text/engine/TextElement.html delete mode 100644 html-docs/flash/text/engine/TextJustifier.html delete mode 100644 html-docs/flash/text/engine/TextLine.html delete mode 100644 html-docs/flash/text/engine/TextLineCreationResult.html delete mode 100644 html-docs/flash/text/engine/TextLineMirrorRegion.html delete mode 100644 html-docs/flash/text/engine/TextLineValidity.html delete mode 100644 html-docs/flash/text/engine/TextRotation.html delete mode 100644 html-docs/flash/text/engine/TypographicCase.html delete mode 100644 html-docs/flash/text/engine/package-detail.html delete mode 100644 html-docs/flash/text/ime/CompositionAttributeRange.html delete mode 100644 html-docs/flash/text/ime/IIMEClient.html delete mode 100644 html-docs/flash/text/ime/package-detail.html delete mode 100644 html-docs/flash/text/package-detail.html delete mode 100644 html-docs/flash/ui/ContextMenu.html delete mode 100644 html-docs/flash/ui/ContextMenuBuiltInItems.html delete mode 100644 html-docs/flash/ui/ContextMenuClipboardItems.html delete mode 100644 html-docs/flash/ui/ContextMenuItem.html delete mode 100644 html-docs/flash/ui/GameInput.html delete mode 100644 html-docs/flash/ui/GameInputControl.html delete mode 100644 html-docs/flash/ui/GameInputDevice.html delete mode 100644 html-docs/flash/ui/KeyLocation.html delete mode 100644 html-docs/flash/ui/Keyboard.html delete mode 100644 html-docs/flash/ui/KeyboardType.html delete mode 100644 html-docs/flash/ui/Mouse.html delete mode 100644 html-docs/flash/ui/MouseCursor.html delete mode 100644 html-docs/flash/ui/MouseCursorData.html delete mode 100644 html-docs/flash/ui/Multitouch.html delete mode 100644 html-docs/flash/ui/MultitouchInputMode.html delete mode 100644 html-docs/flash/ui/package-detail.html delete mode 100644 html-docs/flash/utils/ByteArray.html delete mode 100644 html-docs/flash/utils/CompressionAlgorithm.html delete mode 100644 html-docs/flash/utils/Dictionary.html delete mode 100644 html-docs/flash/utils/Endian.html delete mode 100644 html-docs/flash/utils/IDataInput.html delete mode 100644 html-docs/flash/utils/IDataOutput.html delete mode 100644 html-docs/flash/utils/IExternalizable.html delete mode 100644 html-docs/flash/utils/Proxy.html delete mode 100644 html-docs/flash/utils/Timer.html delete mode 100644 html-docs/flash/utils/package-detail.html delete mode 100644 html-docs/flash/utils/package.html delete mode 100644 html-docs/flash/xml/XMLDocument.html delete mode 100644 html-docs/flash/xml/XMLNode.html delete mode 100644 html-docs/flash/xml/XMLNodeType.html delete mode 100644 html-docs/flash/xml/package-detail.html delete mode 100644 html-docs/float.html delete mode 100644 html-docs/index.html delete mode 100644 html-docs/int.html delete mode 100644 html-docs/language-elements.html delete mode 100644 html-docs/migration.html delete mode 100644 html-docs/operators.html delete mode 100644 html-docs/package-detail.html delete mode 100644 html-docs/package-summary.html delete mode 100644 html-docs/package.html delete mode 100644 html-docs/runtimeErrors.html delete mode 100644 html-docs/specialTypes.html delete mode 100644 html-docs/statements.html delete mode 100644 html-docs/uint.html delete mode 100644 html-docs/whatsnew.html create mode 100644 llms.txt diff --git a/PROGRESS.md b/PROGRESS.md deleted file mode 100644 index 47e6ba3..0000000 --- a/PROGRESS.md +++ /dev/null @@ -1,68 +0,0 @@ -# ActionScript 3.0 Documentation Progress - -This file tracks the status of the manual high-density documentation synthesis for ActionScript 3.0. - -## 📊 Summary Statistics - -- **Target Surface**: Complete ActionScript 3.0 & Adobe AIR API (643 raw files). -- **Consolidated Progress**: 100% Complete! 🎉 -- **Synthesized Sheets**: 41 (Consolidated for LLMs). -- **Claude Skills**: 5 Optimized Skill files. - ---- - -## ✅ Completed Packages - -Verified high-density summaries available in the [/docs](docs/) directory: - -- **Core Language**: [Object.md](docs/Object.md), [Array.md](docs/Array.md), [String.md](docs/String.md), [Math.md](docs/Math.md), [XML.md](docs/XML.md), [NumericTypes.md](docs/NumericTypes.md), [Vector.md](docs/Vector.md), [JSON.md](docs/JSON.md), [Boolean.md](docs/Boolean.md), [Date.md](docs/Date.md), [Function.md](docs/Function.md), [RegExp.md](docs/RegExp.md), [Errors.md](docs/Errors.md), [SpecialTypes.md](docs/SpecialTypes.md), [SpecializedErrors.md](docs/SpecializedErrors.md). -- **Visual & Display**: [Display.md](docs/Display.md) (Sprites, Bitmaps, Graphics), [Geom.md](docs/Geom.md) (Matrices, Points), [Display3D.md](docs/Display3D.md) (Stage3D GPU Rendering), [Filters.md](docs/Filters.md) (Shaders & Blurs). -- **Interactive**: [Events.md](docs/Events.md) (DOM-like event flow), [UI.md](docs/UI.md) (Mouse, Keyboard, GameInput). -- **Media**: [Media.md](docs/Media.md) (Audio/Video). -- **Networking & Data**: [Net.md](docs/Net.md) (Sockets, URLLoader), [Utils.md](docs/Utils.md) (ByteArray, Timers). -- **System & Security**: [System.md](docs/System.md) (Security, Workers), [Concurrent.md](docs/Concurrent.md) (Mutex, Condition), [AdvancedSecurity.md](docs/AdvancedSecurity.md) (XML Signatures, Certificates). -- **Text & Internationalization**: [Text.md](docs/Text.md) (TextField, Styles), [Globalization.md](docs/Globalization.md) (i18n/l10n). -- **Sensors & External**: [Bridge_Sensors.md](docs/Bridge_Sensors.md) (ExternalInterface, GPS). -- **AIR Desktop & Mobile**: [Desktop.md](docs/Desktop.md) (NativeApplication, Clipboard, Drag-Drop, Native Processes), [Printing.md](docs/Printing.md) (PrintJob), [Filesystem.md](docs/Filesystem.md) (File, FileStream), [HTML.md](docs/HTML.md) (WebKit HTMLLoader), [Notifications.md](docs/Notifications.md) (Push Notifications), [Permissions.md](docs/Permissions.md) (Runtime Permissions). -- **AIR Data & Services**: [Database.md](docs/Database.md) (SQLite, EncryptedLocalStore), [Updates.md](docs/Updates.md) (Application Updater), [AIRUtilities.md](docs/AIRUtilities.md) (ZIP, Encryption, WebSocket). -- **Accessibility & Performance**: [Accessibility.md](docs/Accessibility.md) (Screen Readers, MSAA), [Profiler.md](docs/Profiler.md) (Telemetry). - ---- - -## ✅ Completion Status - -**🎉 100% COMPLETE!** All ActionScript 3.0 and Adobe AIR API packages have been synthesized into high-density, LLM-friendly documentation. - -### Final Documentation Phase (January 2026) - -**Phase 1 - Core Types & Special Constructs:** - -- **[Errors.md](docs/Errors.md)**: Complete documentation of all Error classes (Error, ArgumentError, DefinitionError, EvalError, RangeError, ReferenceError, SecurityError, SyntaxError, TypeError, URIError, VerifyError). -- **[SpecialTypes.md](docs/SpecialTypes.md)**: Documentation of special types and language constructs (Class, Namespace, QName, TimeZone, arguments). - -**Phase 2 - Advanced Features & AIR APIs:** - -- **[Concurrent.md](docs/Concurrent.md)**: Multithreading primitives (Mutex, Condition) for Worker coordination. -- **[Desktop.md](docs/Desktop.md)**: AIR desktop integration (NativeApplication, Clipboard, NativeDragManager, NativeProcess, system tray/dock icons). -- **[Globalization.md](docs/Globalization.md)**: Internationalization support (DateTimeFormatter, NumberFormatter, CurrencyFormatter, Collator, locale-aware string operations). -- **[Display3D.md](docs/Display3D.md)**: Stage3D GPU-accelerated 3D rendering (Context3D, shaders, buffers, textures). -- **[Notifications.md](docs/Notifications.md)**: Mobile push notifications (RemoteNotifier, APNs/FCM integration). -- **[Permissions.md](docs/Permissions.md)**: Android runtime permission management (PermissionManager, PermissionStatus). -- **[HTML.md](docs/HTML.md)**: AIR WebKit HTML rendering (HTMLLoader, JavaScript-ActionScript bridge). -- **[SpecializedErrors.md](docs/SpecializedErrors.md)**: Domain-specific errors (SQLError, DRMManagerError, InvalidSWFError, PermissionError). -- **[Updates.md](docs/Updates.md)**: Application update framework (ApplicationUpdater, ApplicationUpdaterUI). -- **[AIRUtilities.md](docs/AIRUtilities.md)**: AIR utility packages (ZipArchive for ZIP files, Encryption/Digest for crypto, WebSocket for real-time communication). -- **[AdvancedSecurity.md](docs/AdvancedSecurity.md)**: Digital signatures and certificate validation (XMLSignatureValidator, RevocationCheckSettings). - ---- - -## 🛠 Generation Process - -Documentation is generated by reading raw source files in `html-docs/` and applying the rules in the [STYLE_GUIDE.md](docs/STYLE_GUIDE.md). - -### Contributors/Agents - -1. Read the [Style Guide](docs/STYLE_GUIDE.md). -2. Select a package from the **Pending** list. -3. Synthesize the content into a new `.md` file in `/docs`. -4. Update this `PROGRESS.md` file. diff --git a/README.md b/README.md index ee38f7f..e06ddb8 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,45 @@ # ActionScript 3.0 Documentation -Complete ActionScript 3.0 API documentation, available in both original HTML and LLM-friendly markdown formats. +This repository contains a complete, high-density reference for ActionScript 3.0 and the Adobe AIR API. The documentation has been manually synthesized into 41 LLM-friendly Markdown files to provide a concise, high-signal resource for developers and AI agents. -## 📚 Documentation Formats +## 🚀 How to Use -### 🚀 Concise Summaries (New & Recommended) +When working in this workspace, refer to the **[/docs](docs/)** folder. -The [/docs](docs/) directory contains manually synthesized, high-density documentation designed specifically for LLM context windows. These files consolidate entire packages into single reference sheets. +- **For AI Agents**: Refer to `llms.txt` in the root for a structural overview of the documentation. +- **For Developers**: Use the [Table of Contents](docs/README.md) to find specific packages or class groups. -**Status**: ~98% Complete. See [PROGRESS.md](PROGRESS.md) for detailed coverage. +## 📖 Content Summary -### Raw Markdown conversion +### Core Language -The `markdown-docs/` directory remains available with 643 raw converted files for deep class-level lookups. +Fundamental types and features including [Object](docs/Object.md), [Array](docs/Array.md), [XML](docs/XML.md), [JSON](docs/JSON.md), and [Error handling](docs/Errors.md). -### Original HTML Documentation +### Graphics & Visuals -The `html-docs/` directory contains the original HTML documentation from [airsdk.dev](https://airsdk.dev/reference/actionscript/3.0/). +Complete coverage of the [Display List](docs/Display.md) (Sprites, Bitmaps), [Stage3D GPU rendering](docs/Display3D.md), [Text rendering](docs/Text.md), and [Visual Filters](docs/Filters.md). -## 🤖 Claude Skills for VSCode Copilot - -The `.claude/skills/` directory contains ActionScript 3.0 programming skills for AI assistants: - -1. **actionscript-basics.md** - Core language features, OOP, classes, functions -2. **actionscript-collections.md** - Arrays, Vectors, Dictionaries, data structures -3. **actionscript-display-graphics.md** - Display list, graphics, bitmaps -4. **actionscript-events.md** - Event system, async patterns, timers -5. **actionscript-api-reference.md** - Quick API reference and navigation guide +### Interactivity & OS -These skills help AI coding assistants understand ActionScript 3.0 patterns and best practices. +Hardware-level access for [Mouse/Keyboard/Touch](docs/UI.md), [Event Handling](docs/Events.md), [Filesystem IO](docs/Filesystem.md), and [SQLite Databases](docs/Database.md). -## 🔧 Tools & Contribution +### System & Networking -### 🤖 AI Agent Synthesis Guide +Low-level access for [Sockets and Networking](docs/Net.md), [Workers and Concurrency](docs/Concurrent.md), [Binary Data/ByteArrays](docs/Utils.md), and [External/Sensor Bridge](docs/Bridge_Sensors.md). -If you are an AI agent continuing this work, please follow the [STYLE_GUIDE.md](STYLE_GUIDE.md) in the `/docs` folder. It contains instructions on how to synthesize high-density package summaries, formatting standards, and content selection rules. +## 📄 Documentation index -## 📖 Key Resources +A comprehensive index and categorized list can be found in **[docs/README.md](docs/README.md)**. -### Original Documentation - -- [All Classes](https://airsdk.dev/reference/actionscript/3.0/all-classes.html) -- [Package Summary](https://airsdk.dev/reference/actionscript/3.0/package-summary.html) - -### Project Tracking +## 🤖 Claude Skills for VSCode Copilot -- [Documentation Progress](PROGRESS.md): Detailed status and pending tasks. -- [AI Style Guide](STYLE_GUIDE.md): Rules for high-density synthesis. +The `.claude/skills/` directory contains ActionScript 3.0 programming skills for AI assistants: -## 🚀 Use Cases +1. **actionscript-basics.md** - Core language features. +2. **actionscript-collections.md** - Data structures. +3. **actionscript-display-graphics.md** - Visual engine. +4. **actionscript-events.md** - Async patterns. +5. **actionscript-api-reference.md** - Navigation guide. -1. **AI-Assisted Coding** - Use Claude skills in VSCode Copilot -2. **Documentation Search** - grep through markdown files -3. **Learning** - Read clean markdown docs -4. **Reference** - Quick API lookups -5. **LLM Context** - Feed docs to language models +--- +*Based on the original Adobe/Harman documentation from airsdk.dev* diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md deleted file mode 100644 index 58baf91..0000000 --- a/STYLE_GUIDE.md +++ /dev/null @@ -1,72 +0,0 @@ -# AI Agent Style Guide: Documentation Synthesis - -This guide defines the standards for generating high-density, LLM-friendly ActionScript 3.0 documentation from raw HTML source files. - -## 🎯 Goal - -Transform verbose, multi-page HTML documentation into concise, single-page markdown summaries that fit within context windows while preserving all critical API signatures and behavioral notes. - -## 🛠 Synthesis Process - -1. **Identify Logical Groups**: Do not create one file per class. Group related classes (e.g., all `flash.filters` in `Filters.md`, all `flash.sensors` in `Bridge_Sensors.md`). -2. **Extract Core Signatures**: Priorities include: - - Constructor parameters and defaults. - - Public properties (noting if read-only). - - Public methods with types: `name(arg:Type):ReturnType`. - - Constants and Enumerations. -3. **Consolidate Events**: List the events dispatched by a class in a dedicated section with their corresponding `flash.events` class type. -4. **Detect Platform Nuances**: Explicitly mark features as **[AIR Only]** or **[Mobile Only]** where applicable. - -## 📝 Formatting Standards - -### 1. Title and Header - -Use the package name or functional area as the H1. - -```markdown -# flash.package.Name Reference -``` - -### 2. Class Sections - -Use H2/H3 for classes. Include a 1-sentence description. - -```markdown -## ClassName -Description of the class's primary purpose. -- `property:Type`: Description (mention if static). -- `method(arg:Type):ReturnType`: Description. -``` - -### 3. Signatures - -Always use exact ActionScript 3.0 type syntax. Use backticks for code. - -- ✅ `addEventListener(type:String, listener:Function):void` -- ❌ `addEventListener - takes a type and a function` - -### 4. Code Examples - -Include brief (5-15 lines) idiomatic examples. Use `actionscript` or `javascript` labels for syntax highlighting. - -```actionscript -var sprite:Sprite = new Sprite(); -sprite.graphics.beginFill(0xFF0000); -sprite.graphics.drawRect(0, 0, 100, 100); -``` - -### 5. Tables for Constants - -Use tables for large groups of constants (like `Keyboard` codes) to save vertical space. - -## 🚫 Avoid - -- **Boilerplate**: Remove "Language version", "Runtime version", "Inheritance", and long "See also" lists unless they contain critical context. -- **Fluff**: Avoid conversational filler. The content should be dense and reference-grade. -- **Complexity**: If a class is rarely used or redundant, omit it or group it under a "Minor Classes" section. - -## 📂 Mapping Instructions - -- Source: `html-docs/package/name/Class.html` -- Output: `docs/FunctionalArea.md` -- Updates: Always update `README.md` statistics and "Status" sections after creating a new summary. diff --git a/crawl_docs.py b/crawl_docs.py deleted file mode 100644 index 92b12f0..0000000 --- a/crawl_docs.py +++ /dev/null @@ -1,126 +0,0 @@ -import os -import requests -from bs4 import BeautifulSoup -from urllib.parse import urljoin, urlparse -from concurrent.futures import ThreadPoolExecutor -import threading -import queue -import time - -BASE_URL = "https://airsdk.dev/reference/actionscript/3.0/" -START_URLS = [ - "https://airsdk.dev/reference/actionscript/3.0/all-classes.html", - "https://airsdk.dev/reference/actionscript/3.0/package-summary.html", - "https://airsdk.dev/reference/actionscript/3.0/class-summary.html", - "https://airsdk.dev/reference/actionscript/3.0/language-elements.html", - "https://airsdk.dev/reference/actionscript/3.0/all-index-Symbols.html", - "https://airsdk.dev/reference/actionscript/3.0/appendices.html", - "https://airsdk.dev/reference/actionscript/3.0/conventions.html", -] -OUTPUT_DIR = "html-docs" -MAX_WORKERS = 15 - -visited = set() -visited_lock = threading.Lock() -url_queue = queue.Queue() - -for url in START_URLS: - url_queue.put(url) - - -def download_page(url): - try: - response = requests.get(url, timeout=15) - response.raise_for_status() - return response.text - except Exception as e: - print(f"Error downloading {url}: {e}") - return None - - -def save_page(url, content): - parsed_url = urlparse(url) - rel_path = parsed_url.path.replace("/reference/actionscript/3.0/", "") - if not rel_path or rel_path == "3.0/": - rel_path = "index.html" - elif rel_path.endswith("/"): - rel_path += "index.html" - - file_path = os.path.join(OUTPUT_DIR, rel_path) - os.makedirs(os.path.dirname(file_path), exist_ok=True) - - with open(file_path, "w", encoding="utf-8") as f: - f.write(content) - - -def worker(): - while True: - try: - url = url_queue.get(timeout=10) - except queue.Empty: - return - - with visited_lock: - if url in visited: - url_queue.task_done() - continue - visited.add(url) - - # Check if file already exists to skip re-downloading - parsed_url = urlparse(url) - rel_path = parsed_url.path.replace("/reference/actionscript/3.0/", "") - if not rel_path or rel_path == "3.0/": - rel_path = "index.html" - elif rel_path.endswith("/"): - rel_path += "index.html" - file_path = os.path.join(OUTPUT_DIR, rel_path) - - if os.path.exists(file_path): - # Still need to parse it for links if it was just downloaded but not visited in this session - # However, for simplicity, we'll just download if not in visited. - # If it exists, we skip downloading but still parse for links. - try: - with open(file_path, "r", encoding="utf-8") as f: - content = f.read() - except: - content = None - else: - print(f"Crawling ({len(visited)}): {url}") - content = download_page(url) - if content: - save_page(url, content) - - if content: - soup = BeautifulSoup(content, "html.parser") - for link in soup.find_all("a", href=True): - href = link["href"] - href = href.split("#")[0] - if not href: - continue - - full_url = urljoin(url, href) - - if full_url.startswith(BASE_URL): - with visited_lock: - if full_url not in visited: - url_queue.put(full_url) - - url_queue.task_done() - - -def crawl(): - if not os.path.exists(OUTPUT_DIR): - os.makedirs(OUTPUT_DIR) - - with ThreadPoolExecutor(max_workers=MAX_WORKERS) as executor: - for _ in range(MAX_WORKERS): - executor.submit(worker) - - url_queue.join() - print("Crawling complete.") - - -if __name__ == "__main__": - start_time = time.time() - crawl() - print(f"Finished in {time.time() - start_time:.2f} seconds") diff --git a/docs/Accessibility.md b/docs/Accessibility.md index 0ea1849..c16d880 100644 --- a/docs/Accessibility.md +++ b/docs/Accessibility.md @@ -11,16 +11,19 @@ Screen reader and assistive technology support for visually impaired users. Static class for managing communication with screen readers and querying accessibility support. ### Static Properties + - `active:Boolean`: (Read-only) Returns `true` if a screen reader is currently active and communicating with the application. ### Static Methods #### updateProperties():void + Forces the runtime to update accessibility information and notify the screen reader of changes. Call this after dynamically changing accessible properties (via `AccessibilityProperties`) to ensure screen readers receive updates immediately. **Example**: + ```actionscript var button:Sprite = new Sprite(); button.accessibilityProperties = new AccessibilityProperties(); @@ -30,6 +33,7 @@ Accessibility.updateProperties(); // Notify screen reader ``` ### Checking Support + Use `Capabilities.hasAccessibility` to determine if the OS supports accessibility aids: ```actionscript @@ -51,9 +55,11 @@ if (Capabilities.hasAccessibility) { Defines accessible properties for a `DisplayObject`. Assign an instance to `DisplayObject.accessibilityProperties` to make an object accessible to screen readers. ### Constructor + - `new AccessibilityProperties()`: Creates an AccessibilityProperties object. ### Properties + - `name:String`: The accessible name of the object (read by screen readers). Equivalent to an `alt` attribute in HTML. - `description:String`: A detailed description of the object. Provides additional context beyond the name. - `shortcut:String`: Keyboard shortcut for the object (e.g., "Ctrl+S"). Screen readers announce this to users. @@ -62,6 +68,7 @@ Defines accessible properties for a `DisplayObject`. Assign an instance to `Disp - `noAutoLabeling:Boolean`: If `true`, prevents automatic label assignment from adjacent text. By default, Flash may associate nearby text as a label. ### Example: Accessible Button + ```actionscript var button:Sprite = new Sprite(); button.graphics.beginFill(0x0000FF); @@ -77,6 +84,7 @@ Accessibility.updateProperties(); ``` ### Example: Hiding Decorative Elements + ```actionscript var decorativeImage:Bitmap = new Bitmap(bitmapData); var props:AccessibilityProperties = new AccessibilityProperties(); @@ -95,6 +103,7 @@ Base class for custom accessibility implementations. Extend this class to provid **Note**: Most applications do not need to implement this class. Use `AccessibilityProperties` for standard accessibility needs. ### Properties + - `errno:uint`: Error code for the most recent accessibility operation. - `stub:Boolean`: If `true`, indicates this is a placeholder implementation with no real functionality. @@ -103,33 +112,43 @@ Base class for custom accessibility implementations. Extend this class to provid Override these methods to provide custom accessibility behavior: #### get_accRole(childID:uint):uint + Returns the MSAA role constant for the object or child. #### get_accName(childID:uint):String + Returns the accessible name for the object or child. #### get_accValue(childID:uint):String + Returns the accessible value for the object or child (e.g., slider position, text field content). #### get_accState(childID:uint):uint + Returns the MSAA state flags for the object or child (e.g., focused, checked, unavailable). #### get_accDefaultAction(childID:uint):String + Returns the default action description (e.g., "Press" for a button). #### accDoDefaultAction(childID:uint):void + Performs the default action for the object or child (e.g., click a button, toggle a checkbox). #### get_accFocus():uint + Returns the childID of the currently focused child, or 0 if the parent is focused. #### get_accSelection():Array + Returns an array of childIDs for selected children. #### isLabeledBy(labelBounds:Rectangle):Boolean + Called by the runtime to determine if a text object labels this object. ### Example: Custom Slider Accessibility + ```actionscript package { import flash.accessibility.AccessibilityImplementation; @@ -174,6 +193,7 @@ package { Interface for objects that support text search by screen readers. Implement this to allow screen readers to search within your custom text components. ### Methods + - `searchText(text:String):int`: Searches for `text` in the object. Returns the index of the match, or -1 if not found. **Note**: Very rarely used. Most applications use `TextField` which already supports searchable text. @@ -185,10 +205,12 @@ Interface for objects that support text search by screen readers. Implement this Interface for objects that support basic text selection by screen readers. Implement this for custom text components. ### Properties + - `selectionAnchorIndex:int`: The character index where the selection starts. - `selectionActiveIndex:int`: The character index where the selection ends. ### Methods + - `setSelection(anchorIndex:int, activeIndex:int):void`: Sets the text selection range. **Note**: Most applications use `TextField` which already implements this interface. @@ -198,6 +220,7 @@ Interface for objects that support basic text selection by screen readers. Imple ## Best Practices ### 1. Always Provide Names + Every interactive element should have an accessible name: ```actionscript @@ -213,6 +236,7 @@ var button:Sprite = createButton(); ``` ### 2. Hide Decorative Elements + Mark non-functional, decorative elements as silent: ```actionscript @@ -223,6 +247,7 @@ backgroundImage.accessibilityProperties = props; ``` ### 3. Use Descriptions for Complex Objects + For objects that need more explanation: ```actionscript @@ -234,6 +259,7 @@ Accessibility.updateProperties(); ``` ### 4. Update After Dynamic Changes + Call `Accessibility.updateProperties()` after changing accessible properties: ```actionscript @@ -244,12 +270,14 @@ function updateButtonLabel(newLabel:String):void { ``` ### 5. Test with Actual Screen Readers + - **Windows**: JAWS, NVDA, Narrator - **macOS**: VoiceOver Enable the screen reader and navigate your app using only the keyboard to ensure all functionality is accessible. ### 6. Support Keyboard Navigation + Accessibility depends on keyboard support. Ensure all interactive elements are reachable via Tab key: ```actionscript @@ -258,6 +286,7 @@ button.tabIndex = 1; ``` ### 7. Provide Focus Indicators + Visual focus indicators help all users, not just screen reader users: ```actionscript @@ -312,19 +341,23 @@ Common MSAA state flags for `get_accState()`: ## Platform Notes ### Windows + - Supports MSAA (Microsoft Active Accessibility) for JAWS, NVDA, and Narrator. - AIR 2+ supports JAWS 11 or higher. - Flash Player supports most Windows screen readers. ### macOS + - Supports VoiceOver via the macOS accessibility APIs. - Flash Player and AIR integrate with VoiceOver automatically if accessibility properties are set. ### Mobile & TV + - **Not supported** on mobile browsers, AIR for iOS, AIR for Android, or AIR for TV. - Mobile platforms have their own native accessibility APIs that Flash/AIR does not integrate with. ### Linux + - Limited support. Flash Player may work with Orca screen reader, but support is not guaranteed. --- @@ -332,6 +365,7 @@ Common MSAA state flags for `get_accState()`: ## Common Use Cases ### Accessible Form + ```actionscript // Text input field var nameField:TextField = new TextField(); @@ -354,6 +388,7 @@ Accessibility.updateProperties(); ``` ### Accessible Navigation Menu + ```actionscript for (var i:int = 0; i < menuItems.length; i++) { var item:Sprite = menuItems[i]; diff --git a/docs/Bridge_Sensors.md b/docs/Bridge_Sensors.md index d605f57..4ee81a7 100644 --- a/docs/Bridge_Sensors.md +++ b/docs/Bridge_Sensors.md @@ -1,7 +1,9 @@ # ActionScript 3.0 External API & Sensors Reference ## flash.external.ExternalInterface + The primary bridge between ActionScript and the container (Web Browser/JavaScript or AIR Host). + - `available`: (Static) `true` if the container supports ExternalInterface. - `objectID`: (Static) The `id` (IE) or `name` (NPAPI) attribute of the SWF in HTML. - `marshallExceptions`: (Static) Set to `true` to pass errors between AS and JS. @@ -13,43 +15,51 @@ The primary bridge between ActionScript and the container (Web Browser/JavaScrip --- ## flash.sensors.Accelerometer + Provides access to the device's motion sensor (Mobile only). + - `isSupported`: (Static) Check if hardware is available. - `muted`: Read-only. `true` if the user denied permission. - `setRequestedUpdateInterval(interval:Number)`: Update rate in milliseconds. - **Event**: `AccelerometerEvent.UPDATE` - - `accelerationX` / `accelerationY` / `accelerationZ`: G-force values. - - `timestamp`: Time since app start. + - `accelerationX` / `accelerationY` / `accelerationZ`: G-force values. + - `timestamp`: Time since app start. --- ## flash.sensors.Geolocation + Provides GPS and network-based location data (Mobile only). + - `isSupported`: (Static) Check if hardware is available. - `muted`: Read-only. `true` if the user denied permission. - `permissionStatus`: `PermissionStatus.GRANTED`, `DENIED`, or `UNKNOWN`. - `desiredAccuracy`: (iOS) Accuracy constants like `LOCATION_ACCURACY_BEST`, `KILOMETER`, etc. - `setRequestedUpdateInterval(interval:Number)`: Update rate in milliseconds. - **Event**: `GeolocationEvent.UPDATE` - - `latitude` / `longitude`: Coordinates in WGS-84. - - `altitude`: Meters above sea level. - - `horizontalAccuracy` / `verticalAccuracy`: Meters. - - `speed`: Meters per second. - - `heading`: Degrees relative to true north. + - `latitude` / `longitude`: Coordinates in WGS-84. + - `altitude`: Meters above sea level. + - `horizontalAccuracy` / `verticalAccuracy`: Meters. + - `speed`: Meters per second. + - `heading`: Degrees relative to true north. --- ## flash.sensors.DeviceRotation (AIR) + Determines the physical orientation of the device. + - `isSupported`: (Static) Check if hardware is available. - **Event**: `DeviceRotationEvent.UPDATE` - - `roll`, `pitch`, `yaw`: Rotation in degrees. + - `roll`, `pitch`, `yaw`: Rotation in degrees. --- ## flash.external.ExtensionContext (AIR ANE) + Used for communicating with Native Extensions (ANE). + - `createExtensionContext(extensionID:String, contextType:String)`: (Static) Initialization. - `call(functionName:String, ...args)`: Call native code. - `dispose()`: Clean up native resources. -- **Event**: `StatusEvent.STATUS` (Used for native-to-AS updates). \ No newline at end of file +- **Event**: `StatusEvent.STATUS` (Used for native-to-AS updates). diff --git a/docs/Filters.md b/docs/Filters.md index 8fd89e4..b5c1a5d 100644 --- a/docs/Filters.md +++ b/docs/Filters.md @@ -1,10 +1,13 @@ # ActionScript 3.0 Visual Filters API Reference ## flash.filters.BitmapFilter + Base class for all filters. Filters are applied to the `filters` property of a `DisplayObject`. ### Usage Note + To update filters on an object, you must retrieve the array, modify it, and re-assign it: + ```actionscript var myFilters:Array = myDisplayObject.filters; myFilters.push(new BlurFilter()); @@ -14,12 +17,16 @@ myDisplayObject.filters = myFilters; --- ## flash.filters.BlurFilter + Softens details of an image. + - `blurX` / `blurY`: Horizontal and vertical blur amount (0-255). - `quality`: Number of iterations (1=low, 2=medium, 3=high/Gaussian). ## flash.filters.DropShadowFilter + Adds a shadow to the object. + - `distance`: Offset distance in pixels. - `angle`: Shadow angle (0-360 degrees). - `color`: Hex color. @@ -30,12 +37,17 @@ Adds a shadow to the object. - `knockout`: If `true`, hides the object and only shows the shadow. ## flash.filters.GlowFilter + Applies a glow effect (essentially a DropShadow with distance/angle at 0). + - `color`, `alpha`, `blurX`, `blurY`, `strength`, `quality`, `inner`, `knockout`. ## flash.filters.ColorMatrixFilter + Applies a 4x5 matrix transformation to every pixel (RGBA). + - `matrix`: An array of 20 numbers. + ``` redResult = (a[0]*R) + (a[1]*G) + (a[2]*B) + (a[3]*A) + a[4] greenResult = (a[5]*R) + (a[6]*G) + (a[7]*B) + (a[8]*A) + a[9] @@ -43,7 +55,9 @@ Applies a 4x5 matrix transformation to every pixel (RGBA). ``` ## flash.filters.ConvolutionFilter + Applies a matrix convolution (neighboring pixel math). Used for sharpening, edge detection, blurring, etc. + - `matrixX` / `matrixY`: Matrix dimensions. - `matrix`: Array of values (e.g., 3x3 = 9 values). - `divisor`: Value that divides the sum of the matrix multiplication. @@ -51,7 +65,9 @@ Applies a matrix convolution (neighboring pixel math). Used for sharpening, edge - `preserveAlpha`: If `false`, applies filter to alpha channel too. ## flash.filters.DisplacementMapFilter + Distorts the object using another `BitmapData` (displacement map). + - `mapBitmap`: The source map. - `mapPoint`: Offset for the map. - `componentX` / `componentY`: Which channel (R, G, B, A) in the map affects X/Y displacement. @@ -59,13 +75,16 @@ Distorts the object using another `BitmapData` (displacement map). - `mode`: How to handle out-of-bounds pixels (`wrap`, `clamp`, `ignore`, `color`). ## flash.filters.BevelFilter + Applies a bevel effect to an object. + - `distance`, `angle`, `highlightColor`, `highlightAlpha`, `shadowColor`, `shadowAlpha`, `blurX`, `blurY`, `strength`, `quality`, `type`, `knockout`. --- ## Performance Considerations + - Filters force `cacheAsBitmap = true`. - Large objects with filters (especially high quality) significantly impact CPU/GPU. - Objects larger than 8191x8191 pixels (or 16MP total) will have filters disabled by the runtime. -- Power-of-two blur values (2, 4, 8, 16...) are optimized and render faster. \ No newline at end of file +- Power-of-two blur values (2, 4, 8, 16...) are optimized and render faster. diff --git a/docs/Geom.md b/docs/Geom.md index 1f647ac..cd62e76 100644 --- a/docs/Geom.md +++ b/docs/Geom.md @@ -5,7 +5,9 @@ The `flash.geom` package provides classes for geometric math, coordinate systems ## Basic Geometry ### Point + Represents a location in a 2D coordinate system (x, y). + - **Properties**: - `x, y: Number` — Coordinates. - `length: Number` (Read-only) — Distance from (0,0) to this point. @@ -21,7 +23,9 @@ Represents a location in a 2D coordinate system (x, y). - `polar(len: Number, angle: Number): Point` — Creates a point from polar coordinates (angle in radians). ### Rectangle + Represents a rectangular area (x, y, width, height). + - **Properties**: - `x, y, width, height: Number`. - `left, right, top, bottom: Number` — Derived boundary values. @@ -40,7 +44,9 @@ Represents a rectangular area (x, y, width, height). ## Transformations ### Matrix + A 3x3 affine transformation matrix for 2D. + - **Components**: `a` (scaleX/cos), `b` (skewY/sin), `c` (skewX/-sin), `d` (scaleY/cos), `tx` (translateX), `ty` (translateY). - **Methods**: - `translate(tx: Number, ty: Number)`: Moves the object. @@ -52,14 +58,18 @@ A 3x3 affine transformation matrix for 2D. - `createBox(...)`, `createGradientBox(...)`: Convenience setup. ### ColorTransform + Adjusts color values (Red, Green, Blue, Alpha) of a display object. + - **Properties**: - `redMultiplier, greenMultiplier, blueMultiplier, alphaMultiplier: Number` (0 to 1). - `redOffset, greenOffset, blueOffset, alphaOffset: Number` (-255 to 255). - `color: uint` — Hex RGB value (sets offsets to 0 and multipliers to 0, except for specific hex bits). ### Transform + Connects a `Matrix` or `ColorTransform` to a `DisplayObject`. + - **Usage**: `mySprite.transform.matrix = myMatrix;` - **Properties**: - `matrix: Matrix` — 2D transformation. @@ -71,6 +81,7 @@ Connects a `Matrix` or `ColorTransform` to a `DisplayObject`. --- ## Example: Rotation around a custom point + ```actionscript var m:Matrix = sprite.transform.matrix; m.translate(-pivotX, -pivotY); // Move point to origin diff --git a/docs/Media.md b/docs/Media.md index 2eba3b0..d5d7d1d 100644 --- a/docs/Media.md +++ b/docs/Media.md @@ -5,7 +5,9 @@ Core multimedia support for audio and video playback and capture. ## Audio ### Sound + The primary class for loading and playing audio (MP3). + - **Methods**: - `load(stream: URLRequest, context: SoundLoaderContext = null): void`: Loads external MP3. - `play(startTime: Number = 0, loops: int = 0, sndTransform: SoundTransform = null): SoundChannel`: Starts playback. @@ -17,7 +19,9 @@ The primary class for loading and playing audio (MP3). - **Properties**: `bytesLoaded`, `bytesTotal`, `isBuffering`, `length` (ms), `url`, `id3` (`ID3Info`). ### SoundChannel + Returned by `Sound.play()`. Controls an active sound instance. + - **Methods**: `stop(): void` - **Properties**: - `position: Number`: Current playback position (ms). @@ -26,14 +30,18 @@ Returned by `Sound.play()`. Controls an active sound instance. - **Events**: `Event.SOUND_COMPLETE`: Dispatched when the sound finishes. ### SoundTransform + Controls volume and multi-channel routing. + - **Properties**: - `volume: Number`: (0 to 1). - `pan: Number`: (-1 left, 1 right). - `leftToLeft`, `leftToRight`, `rightToLeft`, `rightToRight`: Fine-grained channel routing. ### SoundMixer + Static class for global audio control. + - **Methods**: - `stopAll(): void`: Stops every sound currently playing. - `computeSpectrum(outputArray: ByteArray, FFTMode: Boolean = false, stretchFactor: int = 0): void`: Takes a snapshot of current frequencies/waveforms. @@ -47,7 +55,9 @@ Static class for global audio control. ## Video & Camera ### Video + A display object (`DisplayObject`) that renders video from a `NetStream` or `Camera`. + - **Methods**: - `attachNetStream(netStream: NetStream): void`: Connects to a network stream. - `attachCamera(camera: Camera): void`: Connects to a local camera. @@ -58,7 +68,9 @@ A display object (`DisplayObject`) that renders video from a `NetStream` or `Cam - `videoWidth / videoHeight: int`: Intrinsic dimensions of the source. ### Camera + Static access to local camera hardware. + - **Static Methods**: - `getCamera(name: String = null): Camera`: Returns the camera instance. - **Methods**: @@ -74,7 +86,9 @@ Static access to local camera hardware. --- ## Microphone + Static access to audio input hardware. + - **Static Methods**: - `getMicrophone(index: int = -1): Microphone`: Basic microphone. - `getEnhancedMicrophone(index: int = -1): Microphone`: Microphone with Acoustic Echo Cancellation (AEC). diff --git a/docs/README.md b/docs/README.md index 686f0e4..067dfbf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -178,32 +178,28 @@ Digital signatures, certificates, and cryptography. ## Usage Tips ### For Learning + Start with **Core Language** documents to understand ActionScript 3.0 fundamentals, then move to specific areas based on your project needs. ### For Reference + Use your editor's search or `grep` to quickly find specific classes and methods across all documents. ### For AI/LLM Context + Each document is optimized for AI context windows with high-density information and minimal boilerplate. Feed relevant documents to your AI assistant for ActionScript 3.0 coding help. --- ## Related Resources -- [PROGRESS.md](../PROGRESS.md) - Documentation project progress and statistics -- [STYLE_GUIDE.md](../STYLE_GUIDE.md) - Documentation synthesis guidelines -- [README.md](../README.md) - Project overview and getting started +- [README.md](../README.md) - Project overview and usage guide --- -## Contributing - -To add or update documentation: +## 🛠 Project Status -1. Follow the [STYLE_GUIDE.md](../STYLE_GUIDE.md) for formatting standards -2. Extract content from `html-docs/` source files -3. Update this table of contents -4. Update [PROGRESS.md](../PROGRESS.md) with completion status +All 41 primary documentation packages have been 100% synthesized. The project is now in a maintenance-only state. --- diff --git a/docs/SpecialTypes.md b/docs/SpecialTypes.md index 84b7131..b08731c 100644 --- a/docs/SpecialTypes.md +++ b/docs/SpecialTypes.md @@ -42,6 +42,7 @@ The `Namespace` class contains methods and properties for defining and working w **Constructor**: `Namespace(prefix:String = "", uri:String = "")` **Properties**: + - `prefix: String`: The namespace prefix. - `uri: String`: The Uniform Resource Identifier (URI) of the namespace. @@ -87,6 +88,7 @@ obj.internalMethod(); // Accessible with namespace ``` **Built-in Namespaces**: + - `public`: Standard public access. - `private`: Accessible only within the defining class. - `protected`: Accessible within the class and subclasses. @@ -98,11 +100,13 @@ obj.internalMethod(); // Accessible with namespace The `QName` (Qualified Name) class represents a qualified name of a property: a namespace and a local name. -**Constructor**: +**Constructor**: + - `QName(uri:Namespace, localName:String)` - `QName(uri:String, localName:String)` **Properties**: + - `localName: String`: The local name part. - `uri: String`: The namespace URI. @@ -138,19 +142,23 @@ The `TimeZone` class provides information about time zones for use in date calcu **Note**: Available only in Adobe AIR applications. Information varies by operating system. **Static Properties**: + - `availableTimeZoneNames: Vector.` (read-only): List of available time zone names from the OS. - `default: TimeZone` (read-only): The default time zone for the system. **Static Methods**: + - `getTimeZone(name:String): TimeZone`: Creates a TimeZone object for the specified time zone name. **Instance Properties**: + - `displayName: String` (read-only): Human-readable name of the time zone. - `id: String` (read-only): Unique identifier for the time zone. - `rawOffset: int` (read-only): Offset from UTC in milliseconds (without DST). - `useDaylightTime: Boolean` (read-only): Whether the time zone uses daylight saving time. **Instance Methods**: + - `getOffset(date:Date): int`: Returns the time zone offset in milliseconds for a specific date. **Example**: @@ -180,6 +188,7 @@ trace("Offset: " + (offset / 3600000) + " hours"); // Offset in hours The `arguments` object is an implicit local variable available within all function bodies. It contains an array of all arguments passed to the function. **Properties**: + - `length: uint`: Number of arguments passed to the function. - `callee: Function`: Reference to the currently executing function. - `[index]`: Access individual arguments by index (0-based). diff --git a/docs/System.md b/docs/System.md index ce702d6..71626b5 100644 --- a/docs/System.md +++ b/docs/System.md @@ -3,9 +3,11 @@ High-level system, security, and runtime management. ## System + The `System` class contains properties and methods for managing memory, garbage collection, and runtime lifecycle. ### Properties + - `freeMemory: Number`: Memory (in bytes) allocated but not in use. - `totalMemory: uint`: Total memory (in bytes) currently in use by the runtime. - `privateMemory: Number`: Memory (in bytes) used by the application (AIR). @@ -13,6 +15,7 @@ The `System` class contains properties and methods for managing memory, garbage - `ime: IME`: Reference to the system's Input Method Editor. ### Methods + - `gc(): void`: Forces the garbage collection process (available in debugger or AIR). - `exit(code: uint): void`: Closes the application. - `setClipboard(string: String): void`: Copies a string to the system clipboard. @@ -23,9 +26,11 @@ The `System` class contains properties and methods for managing memory, garbage --- ## Capabilities + Static properties describing the client system and runtime. ### Key Properties + - `os: String`: Operating system name. - `version: String`: Runtime version (e.g., "WIN 32,0,0,465"). - `manufacturer: String`: Client manufacturer. @@ -41,9 +46,11 @@ Static properties describing the client system and runtime. --- ## Security + Manages cross-domain communication and security sandboxes. ### Sandbox Types (Constants) + - `REMOTE`: Domain-based rules (web). - `LOCAL_WITH_FILE`: Local file, no network. - `LOCAL_WITH_NETWORK`: Local file, network access but no local file access. @@ -51,6 +58,7 @@ Manages cross-domain communication and security sandboxes. - `APPLICATION`: AIR application sandbox (full access to its own package). ### Properties & Methods + - `sandboxType: String`: Current security sandbox. - `allowDomain(...domains): void`: Grants SWFs in specified domains access to the current SWF. - `allowInsecureDomain(...domains): void`: Grants HTTP SWFs access to the current HTTPS SWF. @@ -60,14 +68,17 @@ Manages cross-domain communication and security sandboxes. --- ## ApplicationDomain + Containers for groups of class definitions. Allows versioning and definition sharing. ### Properties + - `currentDomain: ApplicationDomain`: (Static) The current domain. - `parentDomain: ApplicationDomain`: The parent domain in the hierarchy. - `domainMemory: ByteArray`: Global memory for specialized operations. ### Methods + - `getDefinition(name: String): Object`: Retrieves a public definition (Class, Function, etc.) by name. - `hasDefinition(name: String): Boolean`: Checks if a definition exists. - `getQualifiedDefinitionNames(): Vector.`: Lists all class names in the domain. @@ -75,9 +86,11 @@ Containers for groups of class definitions. Allows versioning and definition sha --- ## Worker & Concurrency (AIR 3.4+) + Enables multi-threaded execution through Workers. ### Worker + - `isSupported: Boolean`: (Static) Whether Workers are available. - `current: Worker`: (Static) The worker running the current code. - `isPrimordial: Boolean`: Whether this is the main worker. @@ -88,21 +101,25 @@ Enables multi-threaded execution through Workers. - `createMessageChannel(receiver: Worker): MessageChannel`: Creates a communication link. ### MessageChannel + - `send(message: *): void`: Queues a message for the receiver. - `receive(blockUntilMessage: Boolean = false): *`: Retrieves a message. - `messageAvailable: Boolean`: Whether messages are in the queue. - `Event.CHANNEL_MESSAGE`: Dispatched when a message arrives. ### WorkerDomain + - `current: WorkerDomain`: (Static) Manager for all workers in the security domain. - `createWorker(swf: ByteArray): Worker`: Spawns a new worker from SWF bytes. --- ## LoaderContext + Configures how content is treated when loaded via `Loader.load()`. ### Properties + - `applicationDomain: ApplicationDomain`: The domain to load classes into. - `checkPolicyFile: Boolean`: Whether to look for a policy file on the server. - `securityDomain: SecurityDomain`: (Flash Player only) The security sandbox to place the loaded content in. @@ -111,4 +128,5 @@ Configures how content is treated when loaded via `Loader.load()`. --- ## Functions + - `fscommand(command: String, args: String): void`: Sends a message to the program hosting Flash Player (e.g., browser or projector). diff --git a/docs/Text.md b/docs/Text.md index 146f4db..3056dc1 100644 --- a/docs/Text.md +++ b/docs/Text.md @@ -1,9 +1,11 @@ # ActionScript 3.0 Text Rendering API Reference ## flash.text.TextField + The core class for all text display (Labels) and user input (Inputs). Inherits from `InteractiveObject`. ### Text Content & Alignment + - `text`: Raw text string. - `htmlText`: Text with HTML tags (supports a subset like ``, ``, ``, `

`, ``, ``, ``). - `autoSize`: Automatically resize the field. Use `TextFieldAutoSize` constants: `LEFT`, `RIGHT`, `CENTER`, `NONE`. @@ -11,6 +13,7 @@ The core class for all text display (Labels) and user input (Inputs). Inherits f - `multiline`: If `true`, field supports multiple lines. ### Input & Interaction + - `type`: Either `TextFieldType.DYNAMIC` (default) or `TextFieldType.INPUT`. - `selectable`: Whether user can select text. - `restrict`: Restricts characters user can enter (e.g., `"0-9"`). @@ -19,6 +22,7 @@ The core class for all text display (Labels) and user input (Inputs). Inherits f - `useRichTextClipboard`: Preserves formatting when copying/pasting. ### Formatting & Styles + - `defaultTextFormat`: The `TextFormat` applied to any NEW text inserted. - `setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1)`: Applies formatting to a range or the whole field (existing text). - `getTextFormat(beginIndex:int = -1, endIndex:int = -1)`: Returns the format for a range. @@ -27,6 +31,7 @@ The core class for all text display (Labels) and user input (Inputs). Inherits f - `sharpness`, `thickness`, `antiAliasType`: Rendering quality settings. ### Scrolling & Metrics + - `scrollV` / `scrollH`: Current vertical/horizontal scroll position (1-based). - `maxScrollV` / `maxScrollH`: Maximum scroll values. - `textWidth` / `textHeight`: Dimensions of the text content itself (independent of field size). @@ -34,6 +39,7 @@ The core class for all text display (Labels) and user input (Inputs). Inherits f - `getLineMetrics(lineIndex:int)`: Returns `TextLineMetrics` (ascent, descent, leading, etc.). ### Events + - `Event.CHANGE`: Dispatched when user changes input text. - `TextEvent.TEXT_INPUT`: Dispatched before text is committed to the field. Can be cancelled. - `TextEvent.LINK`: Dispatched when user clicks an `` link. @@ -42,6 +48,7 @@ The core class for all text display (Labels) and user input (Inputs). Inherits f --- ## flash.text.TextFormat + Defines character and paragraph formatting. - `font`: Font name string (e.g., `"Arial"`, `"_sans"`). @@ -60,6 +67,7 @@ Defines character and paragraph formatting. --- ## flash.text.StyleSheet + Handles CSS styles for `htmlText`. - `parseCSS(CSSText:String)`: Parses a CSS string. @@ -70,6 +78,7 @@ Handles CSS styles for `htmlText`. --- ## flash.text.Font + Manages embedded fonts. - `static enumerateFonts(enumerateDeviceFonts:Boolean = false)`: Returns list of available `Font` objects. @@ -81,8 +90,9 @@ Manages embedded fonts. --- ## Utility Classes + - `TextFieldAutoSize`: `CENTER`, `LEFT`, `NONE`, `RIGHT`. - `TextFieldType`: `DYNAMIC`, `INPUT`. - `TextFormatAlign`: `CENTER`, `JUSTIFY`, `LEFT`, `RIGHT`. - `AntiAliasType`: `NORMAL`, `ADVANCED`. -- `GridFitType`: `NONE`, `PIXEL`, `SUBPIXEL`. \ No newline at end of file +- `GridFitType`: `NONE`, `PIXEL`, `SUBPIXEL`. diff --git a/docs/UI.md b/docs/UI.md index f04f18a..5dc3dc3 100644 --- a/docs/UI.md +++ b/docs/UI.md @@ -1,7 +1,9 @@ # ActionScript 3.0 User Interface & Input API Reference ## flash.ui.Mouse + Static class for controlling the mouse cursor appearance. + - `hide()` / `show()`: Toggles cursor visibility. - `cursor`: The current cursor name (e.g., `MouseCursor.AUTO`, `MouseCursor.BUTTON`, `MouseCursor.HAND`). - `registerCursor(name:String, data:MouseCursorData)`: Registers a custom cursor using a `Vector.` for animation. @@ -9,7 +11,9 @@ Static class for controlling the mouse cursor appearance. --- ## flash.ui.Keyboard + Static class containing constants for key codes and hardware status. + - `capsLock` / `numLock`: Read-only status of the keys. - `physicalKeyboardType`: `KeyboardType.ALPHANUMERIC`, `KeyboardType.KEYPAD`, etc. - **Common Constants**: `A` ... `Z`, `NUMBER_0` ... `NUMBER_9`, `F1` ... `F15`, `UP`, `DOWN`, `LEFT`, `RIGHT`, `SPACE`, `ENTER`, `SHIFT`, `CONTROL`, `ALTERNATE` (Option), `COMMAND`, `BACKSPACE`, `ESCAPE`. @@ -17,57 +21,64 @@ Static class containing constants for key codes and hardware status. --- ## flash.ui.ContextMenu & ContextMenuItem + Used to customize the right-click menu. + - **ContextMenu**: - - `customItems`: Array of `ContextMenuItem` objects. - - `hideBuiltInItems()`: Hides default items like "Print" or "Zoom". - - `clipboardMenu`: If `true`, enables standard copy/paste items. + - `customItems`: Array of `ContextMenuItem` objects. + - `hideBuiltInItems()`: Hides default items like "Print" or "Zoom". + - `clipboardMenu`: If `true`, enables standard copy/paste items. - **ContextMenuItem**: - - `label`: Internal name. - - `caption`: User-visible text. - - `separatorBefore`: If `true`, adds a line above the item. - - `enabled` / `visible`: Control state. - - `ContextMenuEvent.MENU_ITEM_SELECT`: Dispatched when item is clicked. + - `label`: Internal name. + - `caption`: User-visible text. + - `separatorBefore`: If `true`, adds a line above the item. + - `enabled` / `visible`: Control state. + - `ContextMenuEvent.MENU_ITEM_SELECT`: Dispatched when item is clicked. --- ## flash.ui.Multitouch + Static class for managing touch and gesture input. + - `inputMode`: Set to `MultitouchInputMode` constants: - - `NONE`: Handled as mouse events. - - `TOUCH_POINT`: Basic touch events (individual points). - - `GESTURE`: Complex gestures like pinch/zoom. + - `NONE`: Handled as mouse events. + - `TOUCH_POINT`: Basic touch events (individual points). + - `GESTURE`: Complex gestures like pinch/zoom. - `supportsTouchEvents` / `supportsGestureEvents`: Hardware capability checks. - `maxTouchPoints`: Max simultaneous touches supported. --- ## flash.ui.GameInput + Entry point for game controllers (Joysticks, Gamepads). + - `isSupported`: Capability check. - `numDevices`: Number of connected controllers. - `getDeviceAt(index:int)`: Returns a `GameInputDevice`. - **GameInputDevice**: - - `enabled`: Must be set to `true` to receive input. - - `id`, `name`: Hardware identifiers. - - `numControls`: Number of buttons/axes. - - `getControlAt(index:int)`: Returns a `GameInputControl`. + - `enabled`: Must be set to `true` to receive input. + - `id`, `name`: Hardware identifiers. + - `numControls`: Number of buttons/axes. + - `getControlAt(index:int)`: Returns a `GameInputControl`. - **GameInputControl**: - - `id`: Button/Axis ID. - - `value`: Current value (Number). - - `minValue`, `maxValue`: Range of values. - - `Event.CHANGE`: Dispatched when the control state changes. + - `id`: Button/Axis ID. + - `value`: Current value (Number). + - `minValue`, `maxValue`: Range of values. + - `Event.CHANGE`: Dispatched when the control state changes. --- ## Key Input Events (flash.events) + - `KeyboardEvent.KEY_DOWN` / `KeyboardEvent.KEY_UP`: - - `keyCode`: Numeric code. - - `charCode`: Character code. - - `shiftKey`, `ctrlKey`, `altKey`: Modifier status. + - `keyCode`: Numeric code. + - `charCode`: Character code. + - `shiftKey`, `ctrlKey`, `altKey`: Modifier status. - `TouchEvent.TOUCH_BEGIN` / `TOUCH_END` / `TOUCH_MOVE`: - - `touchPointID`: Unique ID for each finger. - - `isPrimaryTouchPoint`: Whether it's the first finger down. + - `touchPointID`: Unique ID for each finger. + - `isPrimaryTouchPoint`: Whether it's the first finger down. - `TransformGestureEvent.GESTURE_ZOOM` / `GESTURE_ROTATE` / `GESTURE_PAN`: - - `scaleX` / `scaleY`, `rotation`, `offsetX` / `offsetY`. - - `phase`: `GesturePhase.BEGIN`, `UPDATE`, `END`. \ No newline at end of file + - `scaleX` / `scaleY`, `rotation`, `offsetX` / `offsetY`. + - `phase`: `GesturePhase.BEGIN`, `UPDATE`, `END`. diff --git a/html-docs/ArgumentError.html b/html-docs/ArgumentError.html deleted file mode 100644 index 19506eb..0000000 --- a/html-docs/ArgumentError.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - - - -ArgumentError (ActionScript 3.0) - - - - - - - - - - - - - - - - -

- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class ArgumentError
InheritanceArgumentError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The ArgumentError class represents an error that occurs when the arguments - - supplied in a function do not match the arguments defined for - - that function. This error occurs, for example, when a function is called with - - the wrong number of arguments, an argument of the incorrect type, or an invalid argument. - - - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ArgumentError(message:String = "")
-
- - Creates an ArgumentError object.
-		ArgumentError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
ArgumentError()constructor
-
-public function ArgumentError(message:String = "") -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates an ArgumentError object. - -

Parameters - - - - -
message:String (default = "") — A string associated with the error. - - - -
-
- -
Examples
-
examples\ArgumentErrorExample
-
The following example shows how an ArgumentError error is - generated and handled within a try..catch statement. The - println() function takes one argument, a single string, but because two strings are supplied, - the error is thrown. - Typically, the compiler might catch such an error, but the this[] syntax in the try - statement bypasses the compiler's syntax checking for the function. -
-
-package {
-    import flash.display.Sprite;
-	
-	public class ArgumentErrorExample extends Sprite {
-		public function ArgumentErrorExample() {
-				println("Hello World");
-				
-				try {
-					this["println"]("Hello", "World");
-				}
-				catch(e:ArgumentError) {
-					trace(e);
-				}
-		}
-		
-		public function println(str:String):void {
-			trace(str);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/Array.html b/html-docs/Array.html deleted file mode 100644 index 894ec9d..0000000 --- a/html-docs/Array.html +++ /dev/null @@ -1,3642 +0,0 @@ - - - - - - - - -Array (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class Array
InheritanceArray Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

-

- - The Array class lets you access and manipulate arrays. Array indices are zero-based, which means that the first element in the array is [0], the second element is [1], and so on. To create an Array object, you use the new Array() constructor . Array() can also be - - invoked as a function. In addition, you can use the array access ([]) operator to initialize an array or access the elements of an array. - -

You can store a wide variety of data types in an array element, including numbers, strings, objects, and even other arrays. You can create a multidimensional array by creating an indexed array and assigning to each of its elements a different indexed array. Such an array is considered multidimensional because it can be used to represent data in a table.

- -

Arrays are sparse arrays, meaning there might be an element at index 0 and another at index 5, but nothing in the index positions between those two elements. In such a case, the elements in positions 1 through 4 are undefined, which indicates the absence of an element, not necessarily the presence of an element with the value undefined.

- - - -

Array assignment is by reference rather than by value. When you assign one array variable to another array variable, both refer to the same array:

- - 
-
- var oneArray:Array = new Array("a", "b", "c");
-
- var twoArray:Array = oneArray; // Both array variables refer to the same array.
-
- twoArray[0] = "z";             
-
- trace(oneArray);               // Output: z,b,c.
-
-
- -

Do not use the Array class to create associative arrays (also called hashes), which are data - - structures that contain named elements instead of numbered elements. To create associative arrays, use the Object class. - - Although ActionScript permits you to create associative arrays using the Array class, you cannot use any of the Array class methods or properties with associative arrays.

- -

You can extend the Array class and override or add methods. However, you must specify the subclass as dynamic - - or you will lose the ability to store data in an array.

- - -

-

-View the examples. -

-

-See also -

-
-[] (array access) -
-Object class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  length : uint -
- - A non-negative integer specifying the number of elements in the array.
-		Array
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Array(numElements:int = 0)
-
- - Lets you create an array of the specified number of elements.
-		Array
   -
-Array(... values)
-
- - Lets you create an array that contains the specified elements.
-		Array
   -
-concat(... args):Array -
-
- - Concatenates the elements specified in the parameters with the elements in an array and creates a new array.
-		Array
   -
-every(callback:Function, thisObject:* = null):Boolean -
-
- - Executes a test function on each item in the array until an item is reached that returns false for the - - specified function.
-		Array
   -
-filter(callback:Function, thisObject:* = null):Array -
-
- - Executes a test function on each item in the array and constructs a new array for all items that return true for the specified function.
-		Array
   -
-forEach(callback:Function, thisObject:* = null):void -
-
- - Executes a function on each item in the array.
-		Array
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-includes(item:*):Boolean -
-
- - Checks whether the array includes the item that is passed in.
-		Array
   -
-indexOf(searchElement:*, fromIndex:int = 0):int -
-
- - Searches for an item in an array by using strict equality (===) and returns the index - - position of the item.
-		Array
   -
-insertAt(index:int, element:*):void -
-
- - Insert a single element into an array.
-		Array
   -
-isEmpty():Boolean -
-
- - Checks whether the array is empty.
-		Array
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-join(sep:*):String -
-
- - Converts the elements in an array to strings, inserts the specified separator between the - - elements, concatenates them, and returns the resulting string.
-		Array
   -
-lastIndexOf(searchElement:*, fromIndex:int = 0x7fffffff):int -
-
- - Searches for an item in an array, working backward from the last item, and returns the index position of the matching item using strict equality (===).
-		Array
   -
-map(callback:Function, thisObject:* = null):Array -
-
- - Executes a function on each item in an array, and constructs a new array of items corresponding to the results of the function on - - each item in the original array.
-		Array
   -
-pop():* -
-
- - Removes the last element from an array and returns the value of that element.
-		Array
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-push(... args):uint -
-
- - Adds one or more elements to the end of an array and returns the new length of the array.
-		Array
   -
-removeAt(index:int):* -
-
- - Remove a single element from an array.
-		Array
   -
-reverse():Array -
-
- - Reverses the array in place.
-		Array
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-shift():* -
-
- - Removes the first element from an array and returns that element.
-		Array
   -
-slice(startIndex:int = 0, endIndex:int = 16777215):Array -
-
- - Returns a new array that consists of a range of elements from the original array, without modifying the original array.
-		Array
   -
-some(callback:Function, thisObject:* = null):Boolean -
-
- - Executes a test function on each item in the array until an item is reached that returns true.
-		Array
   -
-sort(... args):Array -
-
- - Sorts the elements in an array.
-		Array
   -
-sortOn(fieldName:Object, options:Object = null):Array -
-
- - Sorts the elements in an array according to one or more fields in the array.
-		Array
   -
-splice(startIndex:int, deleteCount:uint, ... values):Array -
-
- - Adds elements to and removes elements from an array.
-		Array
   -
-toLocaleString():String -
-
- - Returns a string that represents the elements in the specified array.
-		Array
   -
-toString():String -
-
- - Returns a string that represents the elements in the specified array.
-		Array
   -
-unshift(... args):uint -
-
- - Adds one or more elements to the beginning of an array and returns the new length of the array.
-		Array
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  CASEINSENSITIVE : uint = 1
[static] - - Specifies case-insensitive sorting for the Array class sorting methods.
-		Array
  DESCENDING : uint = 2
[static] - - Specifies descending sorting for the Array class sorting methods.
-		Array
  NUMERIC : uint = 16
[static] - - Specifies numeric (instead of character-string) sorting for the Array class sorting methods.
-		Array
  RETURNINDEXEDARRAY : uint = 8
[static] - - Specifies that a sort returns an array that consists of array indices.
-		Array
  UNIQUESORT : uint = 4
[static] - - Specifies the unique sorting requirement for the Array class sorting methods.
-		Array
-
- -
- -
Property detail
- - - - - -
lengthproperty
-
-length:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - A non-negative integer specifying the number of elements in the array. This property is automatically updated when new elements are added to the array. When you assign a value to an array element (for example, my_array[index] = value), if index is a number, and index+1 is greater than the length property, the length property is updated to index+1. - -

Note: If you assign a value to the length property that is shorter than the existing length, the array will be truncated.

- - - Implementation -
-    public function get length():uint -
-    public function set length(value:uint):void -
-
-Example -
The following code creates an Array object names with the string element Bill. - It then uses the push() method to add another string element Kyle. The length of the array, as - determined by the length property, was one element before the use of push() and is two - elements after push() is called. Another string, Jeff, - is added to make the length of names three elements. The shift() method is then called twice - to remove Bill and Kyle, making the final array of length one. -
-
-
-var names:Array = new Array("Bill");
-names.push("Kyle");
-trace(names.length); // 2
-
-names.push("Jeff");
-trace(names.length); // 3
-
-names.shift();
-names.shift();
-trace(names.length); // 1
-
-

-
- -
Constructor detail
- - - - - -
Array()constructor
-
-public function Array(numElements:int = 0) -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Lets you create an array of the specified number of elements. - - If you don't specify any parameters, an array containing 0 elements is created. - - If you specify a number of elements, an array is created with numElements number of elements. - -

Note: This class shows two constructor method entries because the constructor accepts - - variable types of arguments. The constructor behaves differently depending on the type and number of - - arguments passed, as detailed in each entry. ActionScript 3.0 does not support method or constructor overloading.

- - - - - Parameters - - - - -
numElements:int (default = 0) — An integer that specifies the number of elements in the array. - - - -
-
-Throws - - - - -
RangeError — The argument is a number that is not an integer greater than or equal to 0. - -
-

-See also -

-
-[] array access -
-Array.length -
-
-Example -
The following example creates the Array object myArr with no arguments - and an initial length of 0: -
-
-package {
-    import flash.display.Sprite;
-
-	public class Array_Array extends Sprite {
-
-		public function Array_Array() {
-			var myArr:Array = new Array();
-			trace(myArr.length); // 0
-		}
-	}
-}
-
-

The following example creates an Array object with 5 initial elements, with a length of 5, and populates - the first element with the string "one", and adds the string element "six" to the end - of the array by using the push() method: -
-
-package {
-    import flash.display.Sprite;
-
-	public class Array_Array_2 extends Sprite {
-
-		public function Array_Array_2() {
-			var myArr:Array = new Array(5);
-			trace(myArr.length); // 5
-			myArr[0] = "one";
-			myArr.push("six");
-			trace(myArr);	     // one,,,,,six
-			trace(myArr.length); // 6
-		}
-	}
-}
-
-

-
- - - - - -
Array()constructor 
-
-public function Array(... values) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Lets you create an array that contains the specified elements. - - You can specify values of any type. - - The first element in an array always has an index (or position) of 0. - -

Note: This class shows two constructor entries because the constructor accepts - - variable types of arguments. The constructor behaves differently depending on the type and number of - - arguments passed, as detailed in each entry. ActionScript 3.0 does not support method or constructor overloading.

- - Parameters - - - - -
... values — A comma-separated list of one or more arbitrary values. - -

Note: If only a single numeric parameter is passed to the Array constructor, - - it is assumed to specify the array's length property.

- -
-
-Throws - - - - -
RangeError — The argument is a number that is not an integer greater than or equal to 0. - -
-

-See also -

-
-[] array access -
-Array.length -
-
-Example -
The following example creates a new Array object with an initial length of 3, - populates the array with the string elements one, two, and three, - and then converts the elements to a string. -
-
-package {
-    import flash.display.Sprite;
-
-	public class Array_Array_3 extends Sprite {
-
-		public function Array_Array_3() {
-			var myArr:Array = new Array("one", "two", "three");
-			trace(myArr.length); // 3
-			trace(myArr); 	     // one,two,three
-		}
-	}
-}
-
-

-
- -
Method detail
- - - - - -
concat()method
-
-AS3 function concat(... args):Array -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Concatenates the elements specified in the parameters with the elements in an array and creates a new array. - - If the parameters specify an array, the elements of that array are concatenated. If you don't - - pass any parameters, the new array is a duplicate (shallow clone) of the original array. - - -

Parameters - - - - -
... args — A value of any data type (such as numbers, elements, or strings) to be concatenated in a new array. - - -
-

-Returns - - - - -
Array — - An array that contains the elements from this array followed by elements from - - the parameters. - - - - -
-
-Example -
The following code creates four Array objects: -
    -
  • The numbers array, which contains the numbers 1, 2, and 3.
    • -
  • The letters array, which contains the letters a, b, and c.
    • -
  • The numbersAndLetters array, which calls the concat() method to produce the array [1,2,3,a,b,c].
    • -
  • The lettersAndNumbers array, which calls the concat() method to produce the array [a,b,c,1,2,3].
    • -
-
-
-
-var numbers:Array = new Array(1, 2, 3);
-var letters:Array = new Array("a", "b", "c");
-var numbersAndLetters:Array = numbers.concat(letters);
-var lettersAndNumbers:Array = letters.concat(numbers);
-
-trace(numbers);       // 1,2,3
-trace(letters); 	  // a,b,c
-trace(numbersAndLetters); // 1,2,3,a,b,c
-trace(lettersAndNumbers); // a,b,c,1,2,3
-
-

-
- - - - - -
every()method 
-
-AS3 function every(callback:Function, thisObject:* = null):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Executes a test function on each item in the array until an item is reached that returns false for the - - specified function. You use this method to determine whether all items in an array meet a criterion, such as having values - - less than a particular number. - - -

For this method, the second parameter, thisObject, must be null if the - - first parameter, callback, is a method closure. Suppose you create a function in a movie clip - - called me:

- - 
-
-     function myFunction(obj:Object):void {
-
-        //your code here
-
-     }
-
-
- -

Suppose you then use the every() method on an array called myArray:

- - 
-
-     myArray.every(myFunction, me);
-
-
- -

Because myFunction is a member of the Timeline class, which cannot be overridden - - by me, the Flash runtime will throw an exception. - - You can avoid this runtime error by assigning the function to a variable, as follows:

- - 
-
-     var myFunction:Function = function(obj:Object):void {
-
-         //your code here
-
-     };
-
-     myArray.every(myFunction, me);
-
-
- - -

Parameters - - - - - - - - - - -
callback:Function — The function to run on each item in the array. This function can contain a simple comparison (for example, item < 20) or a more complex operation, and is invoked with three arguments; the - - value of an item, the index of an item, and the Array object: - - 
function callback(item:*, index:int, array:Array):Boolean;
- - -
 
thisObject:* (default = null) — An object to use as this for the function. - -
-

-Returns - - - - -
Boolean — - A Boolean value of true if all items in the array return true for the specified function; otherwise, false. - - - - -
-

-See also -

-
-Array.some() -
-
-Example -
The following example tests two arrays to determine whether every item in each array is a number. It also outputs the results of the test, showing that isNumeric is true for the first array and false for the second: -
-
-package {
-    import flash.display.Sprite;
-	public class Array_every extends Sprite {
-		public function Array_every() {
-			var arr1:Array = new Array(1, 2, 4);
-			var res1:Boolean = arr1.every(isNumeric);
-			trace("isNumeric:", res1); // true
- 
-			var arr2:Array = new Array(1, 2, "ham");
-			var res2:Boolean = arr2.every(isNumeric);
-			trace("isNumeric:", res2); // false
-		}
-		private function isNumeric(element:*, index:int, arr:Array):Boolean {
-			return (element is Number);
-		}
-	}
-}
-
-

-
- - - - - -
filter()method 
-
-AS3 function filter(callback:Function, thisObject:* = null):Array -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Executes a test function on each item in the array and constructs a new array for all items that return true for the specified function. If an item returns false, it is not included in the new array. - - - -

For this method, the second parameter, thisObject, must be null if the - - first parameter, callback, is a method closure. Suppose you create a function in a movie clip - - called me:

- - 
-
-     function myFunction(obj:Object):void {
-
-        //your code here
-
-     }
-
-
- -

Suppose you then use the filter() method on an array called myArray:

- - 
 
-
-     myArray.filter(myFunction, me);
-
-
- -

Because myFunction is a member of the Timeline class, which cannot be overridden - - by me, the Flash runtime will throw an exception. - - You can avoid this runtime error by assigning the function to a variable, as follows:

- - 
-
-     var myFunction:Function = function(obj:Object):void {
-
-         //your code here
-
-         };
-
-     myArray.filter(myFunction, me);
-
-
- - -

Parameters - - - - - - - - - - -
callback:Function — The function to run on each item in the array. This function can contain a simple comparison (for example, item < 20) or a more complex operation, and is invoked with three arguments; the - - value of an item, the index of an item, and the Array object: - - 
    function callback(item:*, index:int, array:Array):Boolean;
- - -
 
thisObject:* (default = null) — An object to use as this for the function. - -
-

-Returns - - - - -
Array — - A new array that contains all items from the original array that returned true. - - - - -
-

-See also -

-
-Array.map() -
-
-Example -
The following example creates an array of all employees who are managers: -
-
-package {
-    import flash.display.Sprite;
-	public class Array_filter extends Sprite {
-		public function Array_filter() {
-			var employees:Array = new Array();
-			employees.push({name:"Employee 1", manager:false});
-			employees.push({name:"Employee 2", manager:true});
-			employees.push({name:"Employee 3", manager:false});
-			trace("Employees:");
-			employees.forEach(traceEmployee);
-			
-			var managers:Array = employees.filter(isManager);
-			trace("Managers:");
-			managers.forEach(traceEmployee);
-		}
-		private function isManager(element:*, index:int, arr:Array):Boolean {
-			return (element.manager == true);
-		}
-		private function traceEmployee(element:*, index:int, arr:Array):void {
-			trace("\t" + element.name + ((element.manager) ? " (manager)" : ""));
-		}
-	}
-}
-
-

-
- - - - - -
forEach()method 
-
-AS3 function forEach(callback:Function, thisObject:* = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Executes a function on each item in the array. - - - -

For this method, the second parameter, thisObject, must be null if the - - first parameter, callback, is a method closure. Suppose you create a function in a movie clip - - called me:

- - 
-
-     function myFunction(obj:Object):void {
-
-        //your code here
-
-     }
-
-
- -

Suppose you then use the forEach() method on an array called myArray:

- - 
-
-     myArray.forEach(myFunction, me);
-
-
- -

Because myFunction is a member of the Timeline class, which cannot be overridden - - by me, the Flash runtime will throw an exception. - - You can avoid this runtime error by assigning the function to a variable, as follows:

- - 
-
-     var myFunction:Function = function(obj:Object):void {
-
-         //your code here
-
-         };
-
-     myArray.forEach(myFunction, me);
-
-
- -

Parameters - - - - - - - - - - -
callback:Function — The function to run on each item in the array. This function can contain a simple command - - (for example, a trace() statement) or a more complex operation, and is invoked with three arguments; the - - value of an item, the index of an item, and the Array object: - - 
    function callback(item:*, index:int, array:Array):void;
- - -
 
thisObject:* (default = null) — An object to use as this for the function. - - -
-
-Example -
The following example runs the trace() statement in the traceEmployee() function on each item in the array: -
-
-package {
-    import flash.display.Sprite;
-	public class Array_forEach extends Sprite {
-		public function Array_forEach() {
-			var employees:Array = new Array();
-			employees.push({name:"Employee 1", manager:false});
-			employees.push({name:"Employee 2", manager:true});
-			employees.push({name:"Employee 3", manager:false});
-			trace(employees);
-			employees.forEach(traceEmployee);
-		}
-		private function traceEmployee(element:*, index:int, arr:Array):void {
-			trace(element.name + " (" + element.manager + ")");
-		}
-	}
-}
-
-

The following example also runs the trace() statement in a slightly altered traceEmployee() function on each item in the array: -
-
-package {
-    import flash.display.Sprite;
-	public class Array_forEach_2 extends Sprite {
-		public function Array_forEach_2() {
-			var employeeXML:XML = <employees>
-					<employee name="Steven" manager="false" />
-					<employee name="Bruce" manager="true" />
-					<employee name="Rob" manager="false" />
-				</employees>;
-			var employeesList:XMLList = employeeXML.employee;
-			var employeesArray:Array = new Array();
-			for each (var tempXML:XML in employeesList) {
-				employeesArray.push(tempXML);
-			}
-			employeesArray.sortOn("@name");
-			employeesArray.forEach(traceEmployee);
-		}
-		private function traceEmployee(element:*, index:Number, arr:Array):void {
-			trace(element.@name + ((element.@manager == "true") ? " (manager)" : ""));
-		}
-	}
-}
-
-

-
- - - - - -
includes()method 
-
-AS3 function includes(item:*):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Checks whether the array includes the item that is passed in. - - Each element is checked in turn to see if it matches the item that is passed in, - - using the standard comparison operator (i.e. similar to if (array[i] == item)). - - -

Parameters - - - - -
item:* — The item to be checked if it is in the array. - - -
-

-Returns - - - - -
Boolean — - True if the item is found in this array. - - - - - -
-
- - - - - -
indexOf()method 
-
-AS3 function indexOf(searchElement:*, fromIndex:int = 0):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Searches for an item in an array by using strict equality (===) and returns the index - - position of the item. - -

Parameters - - - - - - - - - - -
searchElement:* — The item to find in the array. - - -
 
fromIndex:int (default = 0) — The location in the array from which to start searching for the item. - -
-

-Returns - - - - -
int — - A zero-based index position of the item in the array. If the searchElement argument - - is not found, the return value is -1. - - - - -
-

-See also -

-
-Array.lastIndexOf() -
-=== (strict equality) -
-
-Example -
The following example displays the position of the specified array: -
-
-package {
-    import flash.display.Sprite;
-	public class Array_indexOf extends Sprite {
-		public function Array_indexOf() {
-			var arr:Array = new Array(123,45,6789);
-			arr.push("123-45-6789");
-			arr.push("987-65-4321");
-			
-			var index:int = arr.indexOf("123");
-			trace(index); // -1
-			
-			var index2:int = arr.indexOf(123);
-			trace(index2); // 0
-		}
-	}
-}
-
-

-
- - - - - -
insertAt()method 
-
-AS3 function insertAt(index:int, element:*):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 19 - -
-

- - Insert a single element into an array. This method modifies the array without making a copy. - - -

Parameters - - - - - - - - - - -
index:int — An integer that specifies the position in the array where the element is to be inserted. - - You can use a negative integer to specify a position relative to the end of the array - - (for example, -1 is the last element of the array). - - -
 
element:*
-
- - - - - -
isEmpty()method 
-
-AS3 function isEmpty():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Checks whether the array is empty. - - An alternative to calling a comparison array.length == 0. - - -

-Returns - - - - -
Boolean — - True if the array has no elements. - - - - - -
-
- - - - - -
join()method 
-
-AS3 function join(sep:*):String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Converts the elements in an array to strings, inserts the specified separator between the - - elements, concatenates them, and returns the resulting string. A nested array is always - - separated by a comma (,), not by the separator passed to the join() method. - - -

Parameters - - - - -
sep:* — A character or string that separates array elements in - - the returned string. If you omit this parameter, a comma is used as the default - - separator. - - -
-

-Returns - - - - -
String — - A string consisting of the elements of an array - - converted to strings and separated by the specified parameter. - - - - - -
-

-See also -

-
-String.split() -
-
-Example -
The following code creates an Array object myArr with elements one, - two, and three and then a string containing one and two and three - using the join() method. -
-
-
-var myArr:Array = new Array("one", "two", "three");
-var myStr:String = myArr.join(" and ");
-trace(myArr); // one,two,three
-trace(myStr); // one and two and three
-
-

The following code creates an Array object specialChars with elements (, - ), -, and a blank space and then creates a string containing (888) 867-5309. - Then, using a for loop, it removes each type of special character listed in specialChars to - produce a string (myStr) that contains only the digits of the phone number remaining: 888675309. - Note that other characters, such as +, could have been added to specialChars and then this - routine would work with international phone number formats. -
-
-
-var phoneString:String = "(888) 867-5309";
-
-var specialChars:Array = new Array("(", ")", "-", " ");
-var myStr:String = phoneString;
-
-var ln:uint = specialChars.length;
-for(var i:uint; i < ln; i++) {
-    myStr = myStr.split(specialChars[i]).join("");
-}
-
-var phoneNumber:Number = new Number(myStr);
-
-trace(phoneString); // (888) 867-5309
-trace(phoneNumber); // 8888675309
-
-

-
- - - - - -
lastIndexOf()method 
-
-AS3 function lastIndexOf(searchElement:*, fromIndex:int = 0x7fffffff):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Searches for an item in an array, working backward from the last item, and returns the index position of the matching item using strict equality (===). - -

Parameters - - - - - - - - - - -
searchElement:* — The item to find in the array. - - -
 
fromIndex:int (default = 0x7fffffff) — The location in the array from which to start searching for the item. The default is the maximum - - value allowed for an index. If you do not specify fromIndex, the search starts at the last item - - in the array. - -
-

-Returns - - - - -
int — - A zero-based index position of the item in the array. If the searchElement argument is - - not found, the return value is -1. - - - - -
-

-See also -

-
-Array.indexOf() -
-=== (strict equality) -
-
-Example -
The following example displays the position of the specified array: -
-
-package {
-    import flash.display.Sprite;
-	public class Array_lastIndexOf extends Sprite {
-		public function Array_lastIndexOf() {
-			var arr:Array = new Array(123,45,6789,123,984,323,123,32);
-			
-			var index:int = arr.indexOf(123);
-			trace(index); // 0
-			
-			var index2:int = arr.lastIndexOf(123);
-			trace(index2); // 6
-		}
-	}
-}
-
-

-
- - - - - -
map()method 
-
-AS3 function map(callback:Function, thisObject:* = null):Array -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Executes a function on each item in an array, and constructs a new array of items corresponding to the results of the function on - - each item in the original array. - - - -

For this method, the second parameter, thisObject, must be null if the - - first parameter, callback, is a method closure. Suppose you create a function in a movie clip - - called me:

- - 
-
-     function myFunction(obj:Object):void {
-
-        //your code here
-
-     }
-
-
- -

Suppose you then use the map() method on an array called myArray:

- - 
-
-     myArray.map(myFunction, me);
-
-
- -

Because myFunction is a member of the Timeline class, which cannot be overridden - - by me, the Flash runtime will throw an exception. - - You can avoid this runtime error by assigning the function to a variable, as follows:

- - 
-
-     var myFunction:Function = function(obj:Object):void {
-
-         //your code here
-
-         };
-
-     myArray.map(myFunction, me);
-
-
- -

Parameters - - - - - - - - - - -
callback:Function — The function to run on each item in the array. This function can contain a simple command (such as changing the case of an array of strings) or a more complex operation, and is invoked with three arguments; the - - value of an item, the index of an item, and the Array object: - - 
    function callback(item:*, index:int, array:Array):String;
- - -
 
thisObject:* (default = null) — An object to use as this for the function. - -
-

-Returns - - - - -
Array — - A new array that contains the results of the function on each item in the original array. - - - - -
-

-See also -

-
-Array.filter() -
-
-Example -
The following example changes all items in the array to use uppercase letters: -
-
-package {
-    import flash.display.Sprite;
-	public class Array_map extends Sprite {
-		public function Array_map() {
-			var arr:Array = new Array("one", "two", "Three");
-			trace(arr); // one,two,Three
-
-			var upperArr:Array = arr.map(toUpper);
-			trace(upperArr); // ONE,TWO,THREE
-		}
-		private function toUpper(element:*, index:int, arr:Array):String {
-			return String(element).toUpperCase();
-		}
-	}
-}
-
-

-
- - - - - -
pop()method 
-
-AS3 function pop():* -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Removes the last element from an array and returns the value of that element. - - -

-Returns - - - - -
* — The value of the last element (of any data type) in the specified array. - - - -
-

-See also -

-
-Array.push() -
-Array.shift() -
-Array.unshift() -
-
-Example -
The following code creates an Array object letters with elements a, - b, and c. The last element (c) is then removed from the array using the - pop() method and assigned to the String object letter. -
-
-
-var letters:Array = new Array("a", "b", "c");
-trace(letters); // a,b,c
-var letter:String = letters.pop();
-trace(letters); // a,b
-trace(letter);     // c
-
-

-
- - - - - -
push()method 
-
-AS3 function push(... args):uint -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Adds one or more elements to the end of an array and returns the new length of the array. - - -

Parameters - - - - -
... args — One or more values to append to the array. - -
-

-Returns - - - - -
uint — - An integer representing the length of the new array. - - - - - -
-

-See also -

-
-Array.pop() -
-Array.shift() -
-Array.unshift() -
-
-Example -
The following code creates an empty Array object letters and then populates the array - with the elements a, b, and c - using the push() method. -
-
-
-var letters:Array = new Array();
-
-letters.push("a");
-letters.push("b");
-letters.push("c");
-
-trace(letters.toString()); // a,b,c
-
-

The following code creates an Array object letters, which is initially - populated with the element a. The push() method - is then used once to add the elements b and c to the end of the array, - which is three elements after the push. -
-
-
-var letters:Array = new Array("a");
-var count:uint = letters.push("b", "c");
-
-trace(letters); // a,b,c
-trace(count);   // 3
-
-

-
- - - - - -
removeAt()method 
-
-AS3 function removeAt(index:int):* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 19 - -
-

- - Remove a single element from an array. This method modifies the array without making a copy. - - -

Parameters - - - - -
index:int — An integer that specifies the index of the element in the array that is to be deleted. - - You can use a negative integer to specify a position relative to the end of the array - - (for example, -1 is the last element of the array). - - -
-

-Returns - - - - -
* — The element that was removed from the original array. - - - -
-
- - - - - -
reverse()method 
-
-AS3 function reverse():Array -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Reverses the array in place. - - -

-Returns - - - - -
Array — - The new array. - - - -
-
-Example -
The following code creates an Array object letters with elements a, - b, and c. The order of the array elements is then reversed using the - reverse() method to produce the array [c,b,a]. -
-
-
-var letters:Array = new Array("a", "b", "c");
-trace(letters); // a,b,c
-letters.reverse();
-trace(letters); // c,b,a
-
-

-
- - - - - -
shift()method 
-
-AS3 function shift():* -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Removes the first element from an array and returns that element. The remaining array elements are moved - - from their original position, i, to i-1. - - -

-Returns - - - - -
* — The first element (of any data type) in an array. - - - -
-

-See also -

-
-Array.pop() -
-Array.push() -
-Array.unshift() -
-
-Example -
The following code creates the Array object letters with elements a, - b, and c. The shift() method is then used to remove the first - element (a) from letters and assign it to the string firstLetter. -
-
-
-var letters:Array = new Array("a", "b", "c");
-var firstLetter:String = letters.shift();
-trace(letters);     // b,c
-trace(firstLetter); // a
-
-

-
- - - - - -
slice()method 
-
-AS3 function slice(startIndex:int = 0, endIndex:int = 16777215):Array -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a new array that consists of a range of elements from the original array, without modifying the original array. - - The returned array includes the startIndex element and all elements up to, but not including, the endIndex element. - - -

If you don't pass any parameters, the new array is a duplicate (shallow clone) of the original array.

- - - Parameters - - - - - - - - - - -
startIndex:int (default = 0) — A number specifying the index of the starting point - - for the slice. If startIndex is a negative number, the starting - - point begins at the end of the array, where -1 is the last element. - - -
 
endIndex:int (default = 16777215) — A number specifying the index of the ending point for - - the slice. If you omit this parameter, the slice includes all elements from the - - starting point to the end of the array. If endIndex is a negative - - number, the ending point is specified from the end of the array, where -1 is the - - last element. - - -
-

-Returns - - - - -
Array — - An array that consists of a range of elements from the original array. - - - - -
-
-Example -
The following code creates an Array object letters with elements - [a,b,c,d,e,f]. The array someLetters is then created by calling the - slice() method on elements one (b) through three (d), - resulting in an array with elements b and c. -
-
-
-var letters:Array = new Array("a", "b", "c", "d", "e", "f");
-var someLetters:Array = letters.slice(1,3);
-
-trace(letters);     // a,b,c,d,e,f
-trace(someLetters); // b,c
-
-

The following code creates an Array object letters with elements - [a,b,c,d,e,f].The array someLetters is then created by calling the - slice() method on element two (c), resulting in an array with elements - [c,d,e,f]. -
-
-
-var letters:Array = new Array("a", "b", "c", "d", "e", "f");
-var someLetters:Array = letters.slice(2);
-
-trace(letters);     // a,b,c,d,e,f
-trace(someLetters); // c,d,e,f
-
-

The following code creates an Array object letters with elements - [a,b,c,d,e,f]. The array someLetters is then created by calling the - slice() method on the second to last element from the end (e), resulting - in an array with elements e and f. -
-
-
-var letters:Array = new Array("a", "b", "c", "d", "e", "f");
-var someLetters:Array = letters.slice(-2);
-
-trace(letters);     // a,b,c,d,e,f
-trace(someLetters); // e,f
-
-

-
- - - - - -
some()method 
-
-AS3 function some(callback:Function, thisObject:* = null):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Executes a test function on each item in the array until an item is reached that returns true. Use this method to determine whether any items in an array meet a criterion, such as having a value less than a particular number. - - - -

For this method, the second parameter, thisObject, must be null if the - - first parameter, callback, is a method closure. Suppose you create a function in a movie clip - - called me:

- - 
-
-     function myFunction(obj:Object):void {
-
-        //your code here
-
-     }
-
-
- -

Suppose you then use the some() method on an array called myArray:

- - 
-
-     myArray.some(myFunction, me);
-
-
- -

Because myFunction is a member of the Timeline class, which cannot be overridden - - by me, the Flash runtime will throw an exception. - - You can avoid this runtime error by assigning the function to a variable, as follows:

- - 
-
-     var myFunction:Function = function(obj:Object):void {
-
-         //your code here
-
-         };
-
-     myArray.some(myFunction, me);
-
-
- -

Parameters - - - - - - - - - - -
callback:Function — The function to run on each item in the array. This function can contain a simple comparison (for example - - item < 20) or a more complex operation, and is invoked with three arguments; the - - value of an item, the index of an item, and the Array object: - - 
    function callback(item:*, index:int, array:Array):Boolean;
- - -
 
thisObject:* (default = null) — An object to use as this for the function. - -
-

-Returns - - - - -
Boolean — - A Boolean value of true if any items in the array return true for the specified function; otherwise false. - - - - -
-

-See also -

-
-every() -
-
-Example -
The following example displays which values are undefined: -
-
-package {
-    import flash.display.Sprite;
-	public class Array_some extends Sprite {
-		public function Array_some() {
-			var arr:Array = new Array();
-			arr[0] = "one";
-			arr[1] = "two";
-			arr[3] = "four";
-			var isUndef:Boolean = arr.some(isUndefined);
-			if (isUndef) {
-				trace("array contains undefined values: " + arr);
-			} else {
-				trace("array contains no undefined values.");
-			}
-		}
-		private function isUndefined(element:*, index:int, arr:Array):Boolean {
-			return (element == undefined);
-		}
-	}
-}
-
-

-
- - - - - -
sort()method 
-
-AS3 function sort(... args):Array -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Sorts the elements in an array. This method sorts according to Unicode values. (ASCII is a subset of Unicode.) - -

By default, Array.sort() works in the following way:

- -
    - -
  • Sorting is case-sensitive (Z precedes a).
    • - -
  • Sorting is ascending (a precedes b).
    • - -
  • The array is modified to reflect the sort order; multiple elements that have identical sort fields are placed consecutively in the sorted array in no particular order.
    • - -
  • All elements, regardless of data type, are sorted as if they were strings, so 100 precedes 99, because "1" is a lower string value than "9".
    • - -
- -

- - To sort an array by using settings that deviate from the default settings, - - you can either use one of the sorting options described in the sortOptions portion of the ...args parameter description, or you can create your own custom function to do the sorting. - - If you create a custom function, you call the sort() method, and use the name - - of your custom function as the first argument (compareFunction) - -

- - - Parameters - - - - -
... args — The arguments specifying a comparison function and one or more values that determine the behavior of the sort. - -

This method uses the syntax and argument order Array.sort(compareFunction, sortOptions) with the arguments defined as follows:

- -
  • compareFunction - A comparison function used to determine the sorting order of elements in an array. This argument is optional. A comparison function should take two arguments to compare. Given the elements A and B, the result of compareFunction can have a negative, 0, or positive value: - -
      - -
    • A negative return value specifies that A appears before B in the sorted sequence.
      • - -
    • A return value of 0 specifies that A and B have the same sort order.
      • - -
    • A positive return value specifies that A appears after B in the sorted sequence.
      • - -
    - -
    • - -
  • sortOptions - One or more numbers or defined constants, separated by the | (bitwise OR) operator, that change the behavior of the sort from the default. This argument is optional. The following values are acceptable for sortOptions: - -
      - -
    • 1 or Array.CASEINSENSITIVE
      • - -
    • 2 or Array.DESCENDING
      • - -
    • 4 or Array.UNIQUESORT
      • - -
    • 8 or Array.RETURNINDEXEDARRAY
      • - -
    • 16 or Array.NUMERIC
      • - -
    - - For more information, see the Array.sortOn() method.
    • - -
- - -
-

-Returns - - - - -
Array — - The return value depends on whether you pass any arguments, as described in - - the following list: - -
    - -
  • If you specify a value of 4 or Array.UNIQUESORT for the sortOptions argument - - of the ...args parameter and two or more elements being sorted have identical sort fields, - - Flash returns a value of 0 and does not modify the array.
    • - -
  • If you specify a value of 8 or Array.RETURNINDEXEDARRAY for - - the sortOptions argument of the ...args parameter, Flash returns a sorted numeric - - array of the indices that reflects the results of the sort and does not modify the array.
    • - -
  • Otherwise, Flash returns nothing and modifies the array to reflect the sort order.
    • - -
- - - - -
-

-See also -

-
-| (bitwise OR) -
-Array.sortOn() -
-
-Example -
The following code creates the Array object vegetables with elements - [spinach, green pepper, cilantro, onion, avocado]. The array is then sorted by - the sort() method, which is called with no parameters. The result is vegetables sorted in - alphabetical order ([avocado, cilantro, green pepper, onion, spinach]). -
-
-
-var vegetables:Array = new Array("spinach",
-    			 "green pepper",
-				 "cilantro",
-				 "onion",
-				 "avocado");
-
-trace(vegetables); // spinach,green pepper,cilantro,onion,avocado
-vegetables.sort();
-trace(vegetables); // avocado,cilantro,green pepper,onion,spinach
-
-

The following code creates the Array object vegetables with elements - [spinach, green pepper, Cilantro, Onion, and Avocado]. The array is then sorted by - the sort() method, which is called with no parameters the first time; the result is - [Avocado,Cilantro,Onion,green pepper,spinach]. Then sort() is called on - vegetables again with the CASEINSENSITIVE constant as a parameter. - The result is vegetables sorted in alphabetical order - ([Avocado, Cilantro, green pepper, Onion, spinach]). -
-
-
-var vegetables:Array = new Array("spinach",
-    			 "green pepper",
-				 "Cilantro",
-				 "Onion",
-				 "Avocado");
-
-vegetables.sort();
-trace(vegetables); // Avocado,Cilantro,Onion,green pepper,spinach
-vegetables.sort(Array.CASEINSENSITIVE);
-trace(vegetables); // Avocado,Cilantro,green pepper,Onion,spinach
-
-

The following code creates the empty Array object vegetables, which is then - populated through five calls to push(). Each time push() is - called, a new Vegetable object is created by a call to the Vegetable() - constructor, which accepts a String (name) and Number (price) object. - Calling push() five times with the values shown results in the following - array: [lettuce:1.49, spinach:1.89, asparagus:3.99, celery:1.29, squash:1.44]. The - sort() method is then used to sort the array, resulting in the array - [asparagus:3.99, celery:1.29, lettuce:1.49, spinach:1.89, squash:1.44]. -
-
-var vegetables:Array = new Array();
-vegetables.push(new Vegetable("lettuce", 1.49));
-vegetables.push(new Vegetable("spinach", 1.89));
-vegetables.push(new Vegetable("asparagus", 3.99));
-vegetables.push(new Vegetable("celery", 1.29));
-vegetables.push(new Vegetable("squash", 1.44));
-
-trace(vegetables);
-// lettuce:1.49, spinach:1.89, asparagus:3.99, celery:1.29, squash:1.44
-
-vegetables.sort();
-
-trace(vegetables);
-// asparagus:3.99, celery:1.29, lettuce:1.49, spinach:1.89, squash:1.44
-
-//The following code defines the Vegetable class
-class Vegetable {
-    private var name:String;
-	private var price:Number;
-
-	public function Vegetable(name:String, price:Number) {
-		this.name = name;
-		this.price = price;
-	}
-
-	public function toString():String {
-		return " " + name + ":" + price;
-	}
-}
-
-

The following example is exactly the same as the previous one, except - that the sort() method is used with a custom sort function - (sortOnPrice), which sorts according to price instead of alphabetically. Note that the - new function getPrice() extracts the price. -
-
-
-var vegetables:Array = new Array();
-vegetables.push(new Vegetable("lettuce", 1.49));
-vegetables.push(new Vegetable("spinach", 1.89));
-vegetables.push(new Vegetable("asparagus", 3.99));
-vegetables.push(new Vegetable("celery", 1.29));
-vegetables.push(new Vegetable("squash", 1.44));
-
-trace(vegetables);
-// lettuce:1.49, spinach:1.89, asparagus:3.99, celery:1.29, squash:1.44
-
-vegetables.sort(sortOnPrice);
-
-trace(vegetables);
-// celery:1.29, squash:1.44, lettuce:1.49, spinach:1.89, asparagus:3.99
-
-function sortOnPrice(a:Vegetable, b:Vegetable):Number {
-    var aPrice:Number = a.getPrice();
-	var bPrice:Number = b.getPrice();
-
-	if(aPrice > bPrice) {
-		return 1;
-	} else if(aPrice < bPrice) {
-		return -1;
-	} else  {
-        //aPrice == bPrice
-        return 0;
-	}
-}
-
-// The following code defines the Vegetable class and should be in a separate package.
-class Vegetable {
-	private var name:String;
-	private var price:Number;
-
-	public function Vegetable(name:String, price:Number) {
-		this.name = name;
-		this.price = price;
-	}
-
-	public function getPrice():Number {
-		return price;
-	}
-
-	public function toString():String {
-		return " " + name + ":" + price;
-	}
-}
-
-

The following code creates the Array object numbers with elements - [3,5,100,34,10]. A call to sort() without any parameters sorts - alphabetically, producing the undesired result [10,100,3,34,5]. To properly - sort numeric values, you must pass the constant NUMERIC to the sort() - method, which sorts numbers as follows: [3,5,10,34,100]. - -

Note: The default behavior of the sort() function - is to handle each entity as a string. - If you use the Array.NUMERIC argument, the Flash runtime attempts to convert - any non-numeric values to integers for sorting purposes. If it fails, the runtime throws an error. - For example, the runtime can successfully convert a String value of "6" - to an integer, but will throw an error if it encounters a String value of "six".

-
-
-
-var numbers:Array = new Array(3,5,100,34,10);
-
-trace(numbers); // 3,5,100,34,10
-numbers.sort();
-trace(numbers); // 10,100,3,34,5
-numbers.sort(Array.NUMERIC);
-trace(numbers); // 3,5,10,34,100
-
-

-
- - - - - -
sortOn()method 
-
-AS3 function sortOn(fieldName:Object, options:Object = null):Array -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Sorts the elements in an array according to one or more fields in the array. - - The array should have the following characteristics: - -

    - -
  • The array is an indexed array, not an associative array.
    • - -
  • Each element of the array holds an object with one or more properties.
    • - -
  • All of the objects have at least one property in common, the values of which can be used - - to sort the array. Such a property is called a field.
    • - -
- -

If you pass multiple fieldName parameters, the first field represents the primary sort field, the second represents the next sort field, and so on. Flash sorts according to Unicode values. (ASCII is a subset of Unicode.) If either of the elements being compared does not contain the field that is specified in the fieldName parameter, the field is assumed to be set to undefined, and the elements are placed consecutively in the sorted array in no particular order.

- -

By default, Array.sortOn() works in the following way:

- -
    - -
  • Sorting is case-sensitive (Z precedes a).
    • - -
  • Sorting is ascending (a precedes b).
    • - -
  • The array is modified to reflect the sort order; multiple elements that have identical sort fields are placed consecutively in the sorted array in no particular order.
    • - -
  • Numeric fields are sorted as if they were strings, so 100 precedes 99, because "1" is a lower string value than "9".
    • - -
- -

Flash Player 7 added the options parameter, which you can use to override the default sort behavior. To sort a simple array (for example, an array with only one field), or to specify a sort order that the options parameter doesn't support, use Array.sort().

- -

To pass multiple flags, separate them with the bitwise OR (|) operator:

- - 
-
-     my_array.sortOn(someFieldName, Array.DESCENDING | Array.NUMERIC);
-
-
- -

Flash Player 8 added the ability to specify a different sorting option for each field when you sort by more than one field. In Flash Player 8 and later, the options parameter accepts an array of sort options such that each sort option corresponds to a sort field in the fieldName parameter. The following example sorts the primary sort field, a, using a descending sort; the secondary sort field, b, using a numeric sort; and the tertiary sort field, c, using a case-insensitive sort:

- - 
-
-     Array.sortOn (["a", "b", "c"], [Array.DESCENDING, Array.NUMERIC, Array.CASEINSENSITIVE]);
-
-
- -

Note: The fieldName and options arrays must have the same number of elements; otherwise, the options array is ignored. Also, the Array.UNIQUESORT and Array.RETURNINDEXEDARRAY options can be used only as the first element in the array; otherwise, they are ignored.

- - - Parameters - - - - - - - - - - -
fieldName:Object — A string that identifies a field to be used as the sort value, or an - - array in which the first element represents the primary sort field, the second represents - - the secondary sort field, and so on. - - -
 
options:Object (default = null) — One or more numbers or names of defined constants, separated by the bitwise OR (|) operator, that change the sorting behavior. The following values are acceptable for the options parameter: - -
    - -
  • Array.CASEINSENSITIVE or 1
    • - -
  • Array.DESCENDING or 2
    • - -
  • Array.UNIQUESORT or 4
    • - -
  • Array.RETURNINDEXEDARRAY or 8
    • - -
  • Array.NUMERIC or 16
    • - -
- -

Code hinting is enabled if you use the string form of the flag (for example, DESCENDING) rather than the numeric form (2).

- - - -
-

-Returns - - - - -
Array — - The return value depends on whether you pass any parameters: - -
    - -
  • If you specify a value of 4 or Array.UNIQUESORT for the options parameter, and two or more elements being sorted have identical sort fields, a value of 0 is returned and the array is not modified.
    • - -
  • If you specify a value of 8 or Array.RETURNINDEXEDARRAY for the options parameter, an array is returned that reflects the results of the sort and the array is not modified.
    • - -
  • Otherwise, nothing is returned and the array is modified to reflect the sort order.
    • - -
- - - - - -
-

-See also -

-
-| (bitwise OR) -
-Array.sort() -
-
-Example -
The following code creates an empty Array object vegetables and the array - is then populated using five calls to push(). Each time push() is - called, a new Vegetable object is created by calling the Vegetable() - constructor, which accepts a String (name) and Number (price) object. - Calling push() five times with the values shown results in the following - array: [lettuce:1.49, spinach:1.89, asparagus:3.99, celery:1.29, squash:1.44]. The - sortOn() method is then used with the name parameter to produce the following array: - [asparagus:3.99, celery:1.29, lettuce:1.49, spinach:1.89, squash:1.44]. The - sortOn() method is then called again with the price parameter, and the - NUMERIC and DESCENDING constants to produce an array sorted by numbers in descending order: - [asparagus:3.99, spinach:1.89, lettuce:1.49, squash:1.44, celery:1.29]. -
-
-
-var vegetables:Array = new Array();
-vegetables.push(new Vegetable("lettuce", 1.49));
-vegetables.push(new Vegetable("spinach", 1.89));
-vegetables.push(new Vegetable("asparagus", 3.99));
-vegetables.push(new Vegetable("celery", 1.29));
-vegetables.push(new Vegetable("squash", 1.44));
-
-trace(vegetables);
-// lettuce:1.49, spinach:1.89, asparagus:3.99, celery:1.29, squash:1.44
-
-vegetables.sortOn("name");
-trace(vegetables);
-// asparagus:3.99, celery:1.29, lettuce:1.49, spinach:1.89, squash:1.44
-
-vegetables.sortOn("price", Array.NUMERIC | Array.DESCENDING);
-trace(vegetables);
-// asparagus:3.99, spinach:1.89, lettuce:1.49, squash:1.44, celery:1.29
-
-class Vegetable {
-    public var name:String;
-	public var price:Number;
-
-	public function Vegetable(name:String, price:Number) {
-		this.name = name;
-		this.price = price;
-	}
-
-	public function toString():String {
-		return " " + name + ":" + price;
-	}
-}
-
-

The following code creates an empty Array object records and the - array is then populated using three calls to push(). Each time push() is - called, the strings name and city and a zip number are - added to records. Three for loops are used to print the array elements. The - first for loop prints the elements in the order in which they were added. The second for - loop is run after records has been sorted by name and then city using the - sortOn() method. The third for loop produces different output because - records is re-sorted by city then by name. -
-
-
-
-var records:Array = new Array();
-records.push({name:"john", city:"omaha", zip:68144});
-records.push({name:"john", city:"kansas city", zip:72345});
-records.push({name:"bob", city:"omaha", zip:94010});
-
-for(var i:uint = 0; i < records.length; i++) {
-    trace(records[i].name + ", " + records[i].city);
-}
-// Results:
-// john, omaha
-// john, kansas city
-// bob, omaha
-
-trace("records.sortOn('name', 'city');");
-records.sortOn(["name", "city"]);
-for(var i:uint = 0; i < records.length; i++) {
-	trace(records[i].name + ", " + records[i].city);
-}
-// Results:
-// bob, omaha
-// john, kansas city
-// john, omaha
-
-trace("records.sortOn('city', 'name');");
-records.sortOn(["city", "name"]);
-for(var i:uint = 0; i < records.length; i++) {
-	trace(records[i].name + ", " + records[i].city);
-}
-// Results:
-// john, kansas city
-// bob, omaha
-// john, omaha
-
-

The following code creates an empty Array object users and the - array is then populated using four calls to push(). Each time push() is - called, a User object is created with the User() constructor and a name - string and age uint are added to users. The resulting array set is - [Bob:3,barb:35,abcd:3,catchy:4]. - -

The array is then sorted in the following ways: -

    -
  1. By name only, producing the array [Bob:3,abcd:3,barb:35,catchy:4]
    2. -
  2. By name and using the CASEINSENSITIVE constant, - producing the array [abcd:3,barb:35,Bob:3,catchy:4]
    3. -
  3. By name and using the CASEINSENSITIVE and DESCENDING constants, - producing the array [catchy:4,Bob:3,barb:35,abcd:3]
    4. -
  4. By age only, producing the array [abcd:3,Bob:3,barb:35,catchy:4]
    5. -
  5. By age and using the NUMERIC constant, - producing the array [Bob:3,abcd:3,catchy:4,barb:35]
    6. -
  6. By age and using the DESCENDING and NUMERIC constants, - producing the array [barb:35,catchy:4,Bob:3,abcd:3]
    7. -
-

- -

An array called indices is then created and assigned the results of a sort - by age and using the NUMERIC and RETURNINDEXEDARRAY constants, - resulting in the array [Bob:3,abcd:3,catchy:4,barb:35], which is then printed out - using a for loop.

-
-
-
-class User {
-	public var name:String;
-	public var age:Number;
-	public function User(name:String, age:uint) {
-		this.name = name;
-		this.age = age;
-	}
-
-	public function toString():String {
-		return this.name + ":" + this.age;
-	}
-}
-
-var users:Array = new Array();
-users.push(new User("Bob", 3));
-users.push(new User("barb", 35));
-users.push(new User("abcd", 3));
-users.push(new User("catchy", 4));
-
-trace(users); // Bob:3,barb:35,abcd:3,catchy:4
-
-users.sortOn("name");
-trace(users); // Bob:3,abcd:3,barb:35,catchy:4
-
-users.sortOn("name", Array.CASEINSENSITIVE);
-trace(users); // abcd:3,barb:35,Bob:3,catchy:4
-
-users.sortOn("name", Array.CASEINSENSITIVE | Array.DESCENDING);
-trace(users); // catchy:4,Bob:3,barb:35,abcd:3
-
-users.sortOn("age");
-trace(users); // abcd:3,Bob:3,barb:35,catchy:4
-
-users.sortOn("age", Array.NUMERIC);
-trace(users); // Bob:3,abcd:3,catchy:4,barb:35
-
-users.sortOn("age", Array.DESCENDING | Array.NUMERIC);
-trace(users); // barb:35,catchy:4,Bob:3,abcd:3
-
-var indices:Array = users.sortOn("age", Array.NUMERIC | Array.RETURNINDEXEDARRAY);
-var index:uint;
-for(var i:uint = 0; i < indices.length; i++) {
-	index = indices[i];
-	trace(users[index].name, ": " + users[index].age);
-}
-
-// Results:
-// Bob : 3
-// abcd : 3
-// catchy : 4
-// barb : 35
-
-

-
- - - - - -
splice()method 
-
-AS3 function splice(startIndex:int, deleteCount:uint, ... values):Array -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Adds elements to and removes elements from an array. This method modifies the array without - - making a copy. - -

Note: To override this method in a subclass of Array, use ...args for the parameters, - - as this example shows:

- - 
-
-     public override function splice(...args) {
-
-       // your statements here
-
-     }
-
-
- - Parameters - - - - - - - - - - - - - - - - -
startIndex:int — An integer that specifies the index of the element in the array where the insertion or - - deletion begins. You can use a negative integer to specify a position relative to the end of the array - - (for example, -1 is the last element of the array). - -
 
deleteCount:uint — An integer that specifies the number of elements to be deleted. This number includes the - - element specified in the startIndex parameter. If you do not specify a value for the - - deleteCount parameter, the method deletes all of the values from the startIndex - - element to the last element in the array. If the value is 0, no elements are deleted. - -
 
... values — An optional list of one or more comma-separated values - - to insert into the array at the position specified in the startIndex parameter. - - If an inserted value is of type Array, the array is kept intact and inserted as a single element. - - For example, if you splice an existing array of length three with another array of length three, - - the resulting array will have only four elements. One of the elements, however, will be an array of length three. - - -
-

-Returns - - - - -
Array — - An array containing the elements that were removed from the original array. - - - - - -
-
-Example -
The following code creates the Array object vegetables with the elements - [spinach, green pepper, cilantro, onion, avocado]. The splice() - method is then called with the parameters 2 and 2, which assigns - cilantro and onion to the spliced array. The - vegetables array then contains [spinach,green pepper,avocado]. The - splice() method is called a second time using the parameters 1, 0, - and the spliced array to assign - [cilantro,onion] as the second element in vegetables. -
-
-
-var vegetables:Array = new Array("spinach",
-    			 "green pepper",
-				 "cilantro",
-				 "onion",
-				 "avocado");
-
-var spliced:Array = vegetables.splice(2, 2);
-trace(vegetables); // spinach,green pepper,avocado
-trace(spliced);    // cilantro,onion
-
-vegetables.splice(1, 0, spliced);
-trace(vegetables); // spinach,cilantro,onion,green pepper,avocado
-
-

Notice that cilantro and onion trace out as if vegetables - has 5 elements, even though it actually has four (and the second element is another array containing - two elements). To add cilantro and onion individually, you would use: -
-
- 
-var vegetables:Array = new Array("spinach",
-                 "green pepper",
-                 "cilantro",
-                 "onion",
-                 "avocado");
- 
- var spliced:Array = vegetables.splice(2, 2);
- trace(vegetables); // spinach,green pepper,avocado
- trace(spliced);    // cilantro,onion
- 
- vegetables.splice(1, 0, "cilantro", "onion");
- trace(vegetables); // spinach,cilantro,onion,green pepper,avocado
-
-

-
- - - - - -
toLocaleString()method 
-
-public override function toLocaleString():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a string that represents the elements in the specified array. Every element in the array, starting with index 0 and ending with the highest index, is converted to a concatenated string and separated by commas. In the ActionScript 3.0 implementation, this method returns the same value as the Array.toString() method. - - - -

-Returns - - - - -
String — - A string of array elements. - - - -
-

-See also -

-
-Array.toString() -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a string that represents the elements in the specified array. Every element in the array, starting with index 0 and ending with the highest index, is converted to a concatenated string and separated by commas. To specify a custom separator, use the Array.join() method. - - - -

-Returns - - - - -
String — - A string of array elements. - - - - - -
-

-See also -

-
-String.split() -
-Array.join() -
-
-Example -
The following code creates an Array, converts the values to strings, and stores them in - the vegnums variable of the String data type. - -
-
-
-var vegetables:Array = new Array();
-vegetables.push(1);
-vegetables.push(2);
-vegetables.push(3);
-vegetables.push(4);
-vegetables.push(5);
-var vegnums:String = vegetables.toString();
-trace(vegnums+",6");
-// 1,2,3,4,5,6
-
-

-
- - - - - -
unshift()method 
-
-AS3 function unshift(... args):uint -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Adds one or more elements to the beginning of an array and returns the new length of the array. The other - - elements in the array are moved from their original position, i, to i+1. - - -

Parameters - - - - -
... args — One or more numbers, elements, or variables to be inserted at the beginning of the array. - - -
-

-Returns - - - - -
uint — - An integer representing the new length of the array. - - - - - -
-

-See also -

-
-Array.pop() -
-Array.push() -
-Array.shift() -
-
-Example -
The following code creates the empty Array object names. - The strings Bill and Jeff are added by the push() method, - and then the strings Alfred and Kyle are added to the beginning of - names by two calls to the unshift() method. -
-
-
-var names:Array = new Array();
-names.push("Bill");
-names.push("Jeff");
-
-trace(names); // Bill,Jeff
-
-names.unshift("Alfred");
-names.unshift("Kyle");
-
-trace(names); // Kyle,Alfred,Bill,Jeff
-
-

-
- -
Constant detail
- - - - - -
CASEINSENSITIVEconstant
-
-public static const CASEINSENSITIVE:uint = 1 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies case-insensitive sorting for the Array class sorting methods. You can use this constant - - for the options parameter in the sort() or sortOn() method. - -

The value of this constant is 1.

- -

-See also -

-
-Array.sort() -
-Array.sortOn() -
-
- - - - - -
DESCENDINGconstant 
-
-public static const DESCENDING:uint = 2 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies descending sorting for the Array class sorting methods. - - You can use this constant for the options parameter in the sort() - - or sortOn() method. - -

The value of this constant is 2.

- - -

-See also -

-
-Array.sort() -
-Array.sortOn() -
-
- - - - - -
NUMERICconstant 
-
-public static const NUMERIC:uint = 16 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies numeric (instead of character-string) sorting for the Array class sorting methods. - - Including this constant in the options - - parameter causes the sort() and sortOn() methods - - to sort numbers as numeric values, not as strings of numeric characters. - - Without the NUMERIC constant, sorting treats each array element as a - - character string and produces the results in Unicode order. - - -

For example, given the array of values [2005, 7, 35], if the NUMERIC - - constant is not included in the options parameter, the - - sorted array is [2005, 35, 7], but if the NUMERIC constant is included, - - the sorted array is [7, 35, 2005].

- - - -

This constant applies only to numbers in the array; it does - - not apply to strings that contain numeric data such as ["23", "5"].

- - - -

The value of this constant is 16.

- - -

-See also -

-
-Array.sort() -
-Array.sortOn() -
-
- - - - - -
RETURNINDEXEDARRAYconstant 
-
-public static const RETURNINDEXEDARRAY:uint = 8 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies that a sort returns an array that consists of array indices. You can use this constant - - for the options parameter in the sort() or sortOn() - - method, so you have access to multiple views of the array elements while the original array is unmodified. - -

The value of this constant is 8.

- - -

-See also -

-
-Array.sort() -
-Array.sortOn() -
-
- - - - - -
UNIQUESORTconstant 
-
-public static const UNIQUESORT:uint = 4 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies the unique sorting requirement for the Array class sorting methods. - - You can use this constant for the options parameter in the sort() or sortOn() - - method. The unique sorting option terminates the sort if any two elements - - or fields being sorted have identical values. - -

The value of this constant is 4.

- - -

-See also -

-
-Array.sort() -
-Array.sortOn() -
-
- -
Examples
-
examples\ArrayExample
-
The following example creates a new Array object myArr with no arguments - and an initial length of 0: -
-
-package {
-    import flash.display.Sprite;
-
-	public class ArrayExample extends Sprite {
-		public function ArrayExample() {
-			var myArr:Array = new Array();
-			trace(myArr.length); // 0
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/Boolean.html b/html-docs/Boolean.html deleted file mode 100644 index 84f4b22..0000000 --- a/html-docs/Boolean.html +++ /dev/null @@ -1,424 +0,0 @@ - - - - - - - - -Boolean (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class Boolean
InheritanceBoolean Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- -A Boolean object is a data type that can have one of two values, either true or false, - -used for logical operations. Use the Boolean - -class to retrieve the primitive data type or string representation of a Boolean object. - - - -

To create a Boolean object, you can use the constructor or the global function, or assign a literal value. - -It doesn't matter which technique you use; in ActionScript 3.0, all three techniques are equivalent. (This is - -different from JavaScript, where a Boolean object is distinct from the Boolean primitive type.)

- - - -

The following lines of code are equivalent:

- -
-
-var flag:Boolean = true;
-
-var flag:Boolean = new Boolean(true);
-
-var flag:Boolean = Boolean(true);
-
-
- - - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Boolean(expression:Object = false)
-
- - Creates a Boolean object with the specified value.
-		Boolean
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns the string representation ("true" or - - "false") of the Boolean object.
-		Boolean
   -
-valueOf():Boolean -
-
- - Returns true if the value of the specified Boolean - - object is true; false otherwise.
-		Boolean
-
- -
- -
Constructor detail
- - - - - -
Boolean()constructor
-
-public function Boolean(expression:Object = false) -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates a Boolean object with the specified value. If you omit the expression - - parameter, the Boolean object is initialized with a value of false. If you - - specify a value for the expression parameter, the method evaluates it and returns the result - - as a Boolean value according to the rules in the global Boolean() function. - - -

Parameters - - - - -
expression:Object (default = false) — Any expression. - - -
-

-See also -

-
-Boolean() global function -
-
-Example -

-
- -
Method detail
- - - - - -
toString()method
-
-AS3 function toString():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the string representation ("true" or - - "false") of the Boolean object. The output is not localized, and is "true" or - - "false" regardless of the system language. - - -

-Returns - - - - -
String — - The string "true" or "false". - - - - -
-
-Example -

-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():Boolean -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns true if the value of the specified Boolean - - object is true; false otherwise. - - -

-Returns - - - - -
Boolean — - A Boolean value. - - - - -
-
-Example -

-
- -
Examples
-
examples\BooleanExample
-
The following example toggles and displays each corresponding value for the Boolean object: -
-
- package {
-    import flash.display.Sprite;
-
-    public class BooleanExample extends Sprite {
-        private var flag:Boolean;
-
-        public function BooleanExample() {
-            trace(flag);    // false
-            toggle();
-            trace(flag);    // true
-            toggle();
-            trace(flag);    // false
-        }
-        
-        private function toggle():void{
-            flag = !flag;
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/Class.html b/html-docs/Class.html deleted file mode 100644 index 411ceae..0000000 --- a/html-docs/Class.html +++ /dev/null @@ -1,421 +0,0 @@ - - - - - - - - -Class (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class Class
InheritanceClass Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - A Class object is created for each class definition in a program. Every Class object is an instance - - of the Class class. The Class object contains the static properties and methods of the class. The - - class object creates instances of the class when invoked using the new operator. - - -

Some methods, such as flash.net.getClassByAlias(), return an object of type Class. - - Other methods may have a parameter of type Class, such as flash.net.registerClassAlias().

- -

The class name is the reference to the Class object, as this example shows:

- - 
 
-
- class Foo {
-
- }
-
-
- -

The class Foo{} statement is the class definition that creates the Class object Foo. Additionally, - - the statement new Foo() will create a new instance of class Foo, and the result will be of type Foo.

- -

Use the class statement to declare your classes. Class objects are useful for advanced - - techniques, such as assigning classes to an existing instance object at runtime, as shown in the "Examples" - - section below.

- -

Any static properties and methods of a class live on the class's Class object. Class, itself, declares - - prototype.

- - - -

Generally, you do not need to declare or create variables of type Class manually. However, in the following - - code, a class is assigned as a public Class property circleClass, and you can refer to this Class property - - as a property of the main Library class:

- - 
-
- package {
-
-  import flash.display.Sprite;
-
-  public class Library extends Sprite {
-
-      
-
-      public var circleClass:Class = Circle;
-
-      public function Library() {
-
-      }
-
-  }
-
- }
-
-  
-
- import flash.display.Shape;
-
- class Circle extends Shape {
-
-  public function Circle(color:uint = 0xFFCC00, radius:Number = 10) {
-
-      graphics.beginFill(color);
-
-      graphics.drawCircle(radius, radius, radius);
-
-  }
-
- }
-
-
- - - -

Another SWF file can load the resulting Library.swf file and then instantiate objects of type Circle. The - - following example shows one way to get access to a child SWF file's assets. (Other techniques include using - - flash.utils.getDefnitionByName() or importing stub definitions of the child SWF file.)

- - - - 
-
- package {
-
-  import flash.display.Sprite;
-
-  import flash.display.Shape;
-
-  import flash.display.Loader;
-
-  import flash.net.URLRequest;
-
-  import flash.events.Event;
-
-  public class LibaryLoader extends Sprite {
-
-      public function LibaryLoader() {
-
-          var ldr:Loader = new Loader();
-
-          var urlReq:URLRequest = new URLRequest("Library.swf");
-
-          ldr.load(urlReq);
-
-          ldr.contentLoaderInfo.addEventListener(Event.COMPLETE, loaded);
-
-      }
-
-      private function loaded(event:Event):void {
-
-          var library:Object = event.target.content;
-
-          var circle:Shape = new library.circleClass();
-
-          addChild(circle);
-
-      }
-
-  }
-
- }
-
-
- -

In ActionScript 3.0, you can create embedded classes for external assets (such as images, sounds, or fonts) that are - - compiled into SWF files. In earlier versions of ActionScript, you associated those assets using a linkage ID with the - - MovieClip.attachMovie() method. In ActionScript 3.0, each embedded asset is represented by a unique embedded - - asset class. Therefore, you can use the new operator to instantiate the asset's associated class and call - - methods and properties on that asset.

- -

For example, if you are using an MXML compiler to generate SWF files, you would create an embedded - - class as follows:

- - 
-
-     [Embed(source="bratwurst.jpg")]
-
-     public var imgClass:Class;
-
-
- -

And, to instantiate it, you write the following:

- - 
-
-     var myImg:Bitmap = new imgClass();
-
-
- - - -

-

-View the examples. -

-

-See also -

-
-Object.prototype -
-new operator -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Examples
-
examples\Class.1
-
The following example shows how to use Class objects to defer until runtime - the decision about which class to instantiate using the following steps: -
    -
  1. Declare two classes as ClassA and ClassB.
    2. -
  2. Declare a variable of type Class named classToConstruct and one of type - Boolean chooseClassA, which is set to true in this case, - but your code could use a custom test expression to set the value of that variable.
    3. -
-
-
-package {
-	import flash.display.Sprite;
-	
-	public class ClassExample extends Sprite {
-		public function ClassExample() {
-			var classToConstruct:Class;			
-			var classInstance:Object;
-
-			classToConstruct = ClassA;
-			classInstance = new classToConstruct();
-			trace(classInstance);	// [object ClassA]
-
-			classToConstruct = ClassB;
-			classInstance = new classToConstruct();
-			trace(classInstance);	// [object ClassB]
-		}
-	}
-}
-
-class ClassA {
-}
-	
-class ClassB {
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/Date.html b/html-docs/Date.html deleted file mode 100644 index 66cff07..0000000 --- a/html-docs/Date.html +++ /dev/null @@ -1,5279 +0,0 @@ - - - - - - - - -Date (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final dynamic class Date
InheritanceDate Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

-

- - The Date class represents date and time information. An instance of the Date class represents a particular point - - in time for which the properties such as month, day, hours, and seconds can be queried or modified. The Date - - class lets you retrieve date and time values relative to universal time (Greenwich mean time, now called universal - - time or UTC) or relative to local time, which is determined by the local time zone setting on the operating system - - that is running Flash Player. The methods of the Date class are not static but apply only to the individual Date - - object specified when the method is called. The Date.UTC() and Date.parse() methods are - - exceptions; they are static methods. - -

The Date class handles daylight saving time differently, depending on the operating system and - - runtime version. Flash Player 6 and later versions handle daylight saving time on the following operating - - systems in these ways:

- -
    - -
  • Windows - the Date object automatically adjusts its output for daylight saving time. The Date object detects - - whether daylight saving time is employed in the current locale, and if so, it detects the standard-to-daylight - - saving time transition date and times. However, the transition dates currently in effect are applied to dates in - - the past and the future, so the daylight saving time bias might calculate incorrectly for dates in the past when - - the locale had different transition dates.
    • - -
  • Mac OS X - the Date object automatically adjusts its output for daylight saving time. The time zone information - - database in Mac OS X is used to determine whether any date or time in the present or past should have a daylight - - saving time bias applied.
    • - -
  • Mac OS 9 - the operating system provides only enough information to determine whether the current date and - - time should have a daylight saving time bias applied. Accordingly, the date object assumes that the current - - daylight saving time bias applies to all dates and times in the past or future.
    • - -
- -

Flash Player 5 handles daylight saving time on the following operating systems as follows:

- -
    - -
  • Windows - the U.S. rules for daylight saving time are always applied, which leads to incorrect transitions - - in Europe and other areas that employ daylight saving time but have different transition times than the U.S. Flash - - correctly detects whether daylight saving time is used in the current locale.
    • - -
- -

To use the Date class, construct a Date instance using the new operator.

- -

ActionScript 3.0 adds several new accessor properties that can be used in place of many Date class methods - - that access or modify Date instances. ActionScript 3.0 also includes several new variations of the - - toString() method that are included for ECMA-262 3rd Edition compliance, including: - - Date.toLocaleString(), Date.toTimeString(), Date.toLocaleTimeString(), - - Date.toDateString(), and Date.toLocaleDateString().

- -

To compute relative time or time elapsed, see the getTimer() method in the flash.utils package.

- - -

-

-View the examples. -

-

-See also -

-
-flash.utils.getTimer() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  date : Number -
- - The day of the month (an integer from 1 to 31) specified by a Date object - - according to local time.
-		Date
  dateUTC : Number -
- - The day of the month (an integer from 1 to 31) of a Date object - - according to universal time (UTC).
-		Date
  day : Number -
[read-only] - - The day of the week (0 for Sunday, 1 for Monday, and so on) specified by this - - Date according to local time.
-		Date
  dayUTC : Number -
[read-only] - - The day of the week (0 for Sunday, 1 for Monday, and so on) of this Date - - according to universal time (UTC).
-		Date
  fullYear : Number -
- - The full year (a four-digit number, such as 2000) of a Date object - - according to local time.
-		Date
  fullYearUTC : Number -
- - The four-digit year of a Date object according to universal time (UTC).
-		Date
  hours : Number -
- - The hour (an integer from 0 to 23) of the day portion of a Date object - - according to local time.
-		Date
  hoursUTC : Number -
- - The hour (an integer from 0 to 23) of the day of a Date object - - according to universal time (UTC).
-		Date
  localTimeZone : TimeZone -
[static] - - The TimeZone object to use as the "local" value.
-		Date
  milliseconds : Number -
- - The milliseconds (an integer from 0 to 999) portion of a Date object - - according to local time.
-		Date
  millisecondsUTC : Number -
- - The milliseconds (an integer from 0 to 999) portion of a Date object - - according to universal time (UTC).
-		Date
  minutes : Number -
- - The minutes (an integer from 0 to 59) portion of a Date object - - according to local time.
-		Date
  minutesUTC : Number -
- - The minutes (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC).
-		Date
  month : Number -
- - The month (0 for January, 1 for February, and so on) portion of a - - Date object according to local time.
-		Date
  monthUTC : Number -
- - The month (0 [January] to 11 [December]) portion of a Date object - - according to universal time (UTC).
-		Date
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  seconds : Number -
- - The seconds (an integer from 0 to 59) portion of a Date object - - according to local time.
-		Date
  secondsUTC : Number -
- - The seconds (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC).
-		Date
  time : Number -
- - The number of milliseconds since midnight January 1, 1970, universal time, - - for a Date object.
-		Date
  timezoneOffset : Number -
[read-only] - - The difference, in minutes, between universal time (UTC) and the computer's local time.
-		Date
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Date(yearOrTimevalue:Object, month:Number, date:Number = 1, hour:Number = 0, minute:Number = 0, second:Number = 0, millisecond:Number = 0)
-
- - Constructs a new Date object that holds the specified date and time.
-		Date
   -
-getDate():Number -
-
- - Returns the day of the month (an integer from 1 to 31) specified by a Date object - - according to local time.
-		Date
   -
-getDay():Number -
-
- - Returns the day of the week (0 for Sunday, 1 for Monday, and so on) specified by this - - Date according to local time.
-		Date
   -
-getFullYear():Number -
-
- - Returns the full year (a four-digit number, such as 2000) of a Date object - - according to local time.
-		Date
   -
-getHours():Number -
-
- - Returns the hour (an integer from 0 to 23) of the day portion of a Date object - - according to local time.
-		Date
   -
-getMilliseconds():Number -
-
- - Returns the milliseconds (an integer from 0 to 999) portion of a Date object - - according to local time.
-		Date
   -
-getMinutes():Number -
-
- - Returns the minutes (an integer from 0 to 59) portion of a Date object - - according to local time.
-		Date
   -
-getMonth():Number -
-
- - Returns the month (0 for January, 1 for February, and so on) portion of this - - Date according to local time.
-		Date
   -
-getSeconds():Number -
-
- - Returns the seconds (an integer from 0 to 59) portion of a Date object - - according to local time.
-		Date
   -
-getTime():Number -
-
- - Returns the number of milliseconds since midnight January 1, 1970, universal time, - - for a Date object.
-		Date
   -
-getTimezoneOffset():Number -
-
- - Returns the difference, in minutes, between universal - - time (UTC) and the computer's local time.
-		Date
   -
-getUTCDate():Number -
-
- - Returns the day of the month (an integer from 1 to 31) of a Date object, - - according to universal time (UTC).
-		Date
   -
-getUTCDay():Number -
-
- - Returns the day of the week (0 for Sunday, 1 for Monday, and so on) of this Date - - according to universal time (UTC).
-		Date
   -
-getUTCFullYear():Number -
-
- - Returns the four-digit year of a Date object according to universal time (UTC).
-		Date
   -
-getUTCHours():Number -
-
- - Returns the hour (an integer from 0 to 23) of the day of a Date object - - according to universal time (UTC).
-		Date
   -
-getUTCMilliseconds():Number -
-
- - Returns the milliseconds (an integer from 0 to 999) portion of a Date object - - according to universal time (UTC).
-		Date
   -
-getUTCMinutes():Number -
-
- - Returns the minutes (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC).
-		Date
   -
-getUTCMonth():Number -
-
- - Returns the month (0 [January] to 11 [December]) portion of a Date object - - according to universal time (UTC).
-		Date
   -
-getUTCSeconds():Number -
-
- - Returns the seconds (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC).
-		Date
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-parse(date:String):Number -
-
[static] - - Converts a string representing a date into a number equaling the number of milliseconds - - elapsed since January 1, 1970, UTC.
-		Date
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-setDate(day:Number):Number -
-
- - Sets the day of the month, according to local time, and returns the new time in - - milliseconds.
-		Date
   -
-setFullYear(year:Number, month:Number, day:Number):Number -
-
- - Sets the year, according to local time, and returns the new time in milliseconds.
-		Date
   -
-setHours(hour:Number, minute:Number, second:Number, millisecond:Number):Number -
-
- - Sets the hour, according to local time, and returns the new time in milliseconds.
-		Date
   -
-setMilliseconds(millisecond:Number):Number -
-
- - Sets the milliseconds, according to local time, and returns the new time in - - milliseconds.
-		Date
   -
-setMinutes(minute:Number, second:Number, millisecond:Number):Number -
-
- - Sets the minutes, according to local time, and returns the new time in milliseconds.
-		Date
   -
-setMonth(month:Number, day:Number):Number -
-
- - Sets the month and optionally the day of the month, according to local time, and - - returns the new time in milliseconds.
-		Date
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setSeconds(second:Number, millisecond:Number):Number -
-
- - Sets the seconds, according to local time, and returns the new time in milliseconds.
-		Date
   -
-setTime(millisecond:Number):Number -
-
- - Sets the date in milliseconds since midnight on January 1, 1970, and returns the new - - time in milliseconds.
-		Date
   -
-setUTCDate(day:Number):Number -
-
- - Sets the day of the month, in universal time (UTC), and returns the new time in - - milliseconds.
-		Date
   -
-setUTCFullYear(year:Number, month:Number, day:Number):Number -
-
- - Sets the year, in universal time (UTC), and returns the new time in milliseconds.
-		Date
   -
-setUTCHours(hour:Number, minute:Number, second:Number, millisecond:Number):Number -
-
- - Sets the hour, in universal time (UTC), and returns the new time in milliseconds.
-		Date
   -
-setUTCMilliseconds(millisecond:Number):Number -
-
- - Sets the milliseconds, in universal time (UTC), and returns the new time in milliseconds.
-		Date
   -
-setUTCMinutes(minute:Number, second:Number, millisecond:Number):Number -
-
- - Sets the minutes, in universal time (UTC), and returns the new time in milliseconds.
-		Date
   -
-setUTCMonth(month:Number, day:Number):Number -
-
- - Sets the month, and optionally the day, in universal time(UTC) and returns the new - - time in milliseconds.
-		Date
   -
-setUTCSeconds(second:Number, millisecond:Number):Number -
-
- - Sets the seconds, and optionally the milliseconds, in universal time (UTC) and - - returns the new time in milliseconds.
-		Date
   -
-toDateString():String -
-
- - Returns a string representation of the day and date only, and does not include the time or timezone.
-		Date
   -
-toJSON(k:String):* -
-
- - Provides an overridable method for customizing the JSON encoding of values in an Date object.
-		Date
   -
-toLocaleDateString():String -
-
- - Returns a String representation of the day and date only, and does not include the time or timezone.
-		Date
   -
-toLocaleString():String -
-
- - Returns a String representation of the day, date, time, given in local time.
-		Date
   -
-toLocaleTimeString():String -
-
- - Returns a String representation of the time only, and does not include the day, date, year, or timezone.
-		Date
   -
-toString():String -
-
- - Returns a String representation of the day, date, time, and timezone.
-		Date
   -
-toTimeString():String -
-
- - Returns a String representation of the time and timezone only, and does not include the day and date.
-		Date
   -
-toUTCString():String -
-
- - Returns a String representation of the day, date, and time in universal time (UTC).
-		Date
   -
-UTC(year:Number, month:Number, date:Number = 1, hour:Number = 0, minute:Number = 0, second:Number = 0, millisecond:Number = 0):Number -
-
[static] - - Returns the number of milliseconds between midnight on January 1, 1970, universal time, - - and the time specified in the parameters.
-		Date
   -
-valueOf():Number -
-
- - Returns the number of milliseconds since midnight January 1, 1970, universal time, - - for a Date object.
-		Date
-
- -
- -
Property detail
- - - - - -
dateproperty
-
-date:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The day of the month (an integer from 1 to 31) specified by a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

Implementation -
-    AS3 function get date():Number -
-    AS3 function set date(value:Number):void -
-

-See also -

-
-getDate() -
-setDate() -
-
- - - - - -
dateUTCproperty 
-
-dateUTC:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - The day of the month (an integer from 1 to 31) of a Date object - - according to universal time (UTC). - - -

Implementation -
-    AS3 function get dateUTC():Number -
-    AS3 function set dateUTC(value:Number):void -
-

-See also -

-
-getUTCDate() -
-setUTCDate() -
-
- - - - - -
dayproperty 
-
-day:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The day of the week (0 for Sunday, 1 for Monday, and so on) specified by this - - Date according to local time. Local time is determined by the operating - - system on which the Flash runtimes are running. - - -

Implementation -
-    AS3 function get day():Number -
-

-See also -

-
-getDay() -
-
- - - - - -
dayUTCproperty 
-
-dayUTC:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The day of the week (0 for Sunday, 1 for Monday, and so on) of this Date - - according to universal time (UTC). - - -

Implementation -
-    AS3 function get dayUTC():Number -
-

-See also -

-
-getUTCDay() -
-
- - - - - -
fullYearproperty 
-
-fullYear:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The full year (a four-digit number, such as 2000) of a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

Implementation -
-    AS3 function get fullYear():Number -
-    AS3 function set fullYear(value:Number):void -
-

-See also -

-
-getFullYear() -
-setFullYear() -
-
- - - - - -
fullYearUTCproperty 
-
-fullYearUTC:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - The four-digit year of a Date object according to universal time (UTC). - - -

Implementation -
-    AS3 function get fullYearUTC():Number -
-    AS3 function set fullYearUTC(value:Number):void -
-

-See also -

-
-getUTCFullYear() -
-setUTCFullYear() -
-
- - - - - -
hoursproperty 
-
-hours:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The hour (an integer from 0 to 23) of the day portion of a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

Implementation -
-    AS3 function get hours():Number -
-    AS3 function set hours(value:Number):void -
-

-See also -

-
-getHours() -
-setHours() -
-
- - - - - -
hoursUTCproperty 
-
-hoursUTC:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The hour (an integer from 0 to 23) of the day of a Date object - - according to universal time (UTC). - - -

Implementation -
-    AS3 function get hoursUTC():Number -
-    AS3 function set hoursUTC(value:Number):void -
-

-See also -

-
-getUTCHours() -
-setUTCHours() -
-
- - - - - -
localTimeZoneproperty 
-
-localTimeZone:TimeZone  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 50.0 - -
-

- - The TimeZone object to use as the "local" value. By default (when null) the local time zone - - as set up in the operating system is used, when converting between "UTC" and "local" times. - - This property can be used to set the "local" time zone to any of the time zones supported by - - the operating system. For example even if the user is located in France, this property could - - be set to the New York time zone in order to provide information based on local times there. - - -

Implementation -
-    AS3 static function get localTimeZone():TimeZone -
-    AS3 function set localTimeZone(value:TimeZone):void -
-

-See also -

-
-TimeZone -
-
- - - - - -
millisecondsproperty 
-
-milliseconds:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The milliseconds (an integer from 0 to 999) portion of a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

Implementation -
-    AS3 function get milliseconds():Number -
-    AS3 function set milliseconds(value:Number):void -
-

-See also -

-
-getMilliseconds() -
-setMilliseconds() -
-
- - - - - -
millisecondsUTCproperty 
-
-millisecondsUTC:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The milliseconds (an integer from 0 to 999) portion of a Date object - - according to universal time (UTC). - - -

Implementation -
-    AS3 function get millisecondsUTC():Number -
-    AS3 function set millisecondsUTC(value:Number):void -
-

-See also -

-
-getUTCMilliseconds() -
-setUTCMilliseconds() -
-
- - - - - -
minutesproperty 
-
-minutes:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The minutes (an integer from 0 to 59) portion of a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

Implementation -
-    AS3 function get minutes():Number -
-    AS3 function set minutes(value:Number):void -
-

-See also -

-
-getMinutes() -
-setMinutes() -
-
- - - - - -
minutesUTCproperty 
-
-minutesUTC:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The minutes (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC). - - -

Implementation -
-    AS3 function get minutesUTC():Number -
-    AS3 function set minutesUTC(value:Number):void -
-

-See also -

-
-getUTCMinutes() -
-setUTCMinutes() -
-
- - - - - -
monthproperty 
-
-month:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The month (0 for January, 1 for February, and so on) portion of a - - Date object according to local time. Local time is determined by the operating system - - on which the Flash runtimes are running. - - -

Implementation -
-    AS3 function get month():Number -
-    AS3 function set month(value:Number):void -
-

-See also -

-
-getMonth() -
-setMonth() -
-
- - - - - -
monthUTCproperty 
-
-monthUTC:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The month (0 [January] to 11 [December]) portion of a Date object - - according to universal time (UTC). - - -

Implementation -
-    AS3 function get monthUTC():Number -
-    AS3 function set monthUTC(value:Number):void -
-

-See also -

-
-getUTCMonth() -
-setUTCMonth() -
-
- - - - - -
secondsproperty 
-
-seconds:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The seconds (an integer from 0 to 59) portion of a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

Implementation -
-    AS3 function get seconds():Number -
-    AS3 function set seconds(value:Number):void -
-

-See also -

-
-getSeconds() -
-setSeconds() -
-
- - - - - -
secondsUTCproperty 
-
-secondsUTC:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The seconds (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC). - - -

Implementation -
-    AS3 function get secondsUTC():Number -
-    AS3 function set secondsUTC(value:Number):void -
-

-See also -

-
-getUTCSeconds() -
-setUTCSeconds() -
-
- - - - - -
timeproperty 
-
-time:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The number of milliseconds since midnight January 1, 1970, universal time, - - for a Date object. Use this method to represent a specific instant in time - - when comparing two or more Date objects. - - -

Implementation -
-    AS3 function get time():Number -
-    AS3 function set time(value:Number):void -
-

-See also -

-
-getTime() -
-setTime() -
-
- - - - - -
timezoneOffsetproperty 
-
-timezoneOffset:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - The difference, in minutes, between universal time (UTC) and the computer's local time. - - Specifically, this value is the number of minutes you need to add to the computer's local - - time to equal UTC. If your computer's time is set later than UTC, the value will be negative. - -

Implementation -
-    AS3 function get timezoneOffset():Number -
-

-See also -

-
-getTimezoneOffset() -
-
- -
Constructor detail
- - - - - -
Date()constructor
-
-public function Date(yearOrTimevalue:Object, month:Number, date:Number = 1, hour:Number = 0, minute:Number = 0, second:Number = 0, millisecond:Number = 0) -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Constructs a new Date object that holds the specified date and time. - - - -

The Date() constructor takes up to seven parameters (year, month, - - ..., millisecond) to specify a date and time to the millisecond. The date that - - the newly constructed Date object contains depends on the number, and data type, of arguments passed.

- -
    - -
  • If you pass no arguments, the Date object is assigned the current date and time.
    • - -
  • If you pass one argument of data type Number, the Date object is assigned a time value based on the number of milliseconds since January 1, 1970 0:00:000 GMT, as specified by the lone argument.
    • - -
  • If you pass one argument of data type String, and the string contains a valid date, the Date object contains a time value based on that date.
    • - -
  • If you pass two or more arguments, the Date object is assigned a time value based on the argument values passed, which represent the date's year, month, date, hour, minute, second, and milliseconds.
    • - -
- -

If you pass a string to the Date class constructor, the date can be in a variety of formats, but must at least include the month, date, and year. For example, Feb 1 2005 is valid, but Feb 2005 is not. The following list indicates some of the valid formats:

- -
    - -
  • Day Month Date Hours:Minutes:Seconds GMT Year (for instance, "Tue Feb 1 00:00:00 GMT-0800 2005", which matches toString())
    • - -
  • Day Month Date Year Hours:Minutes:Seconds AM/PM (for instance, "Tue Feb 1 2005 12:00:00 AM", which matches toLocaleString())
    • - -
  • Day Month Date Year (for instance, "Tue Feb 1 2005", which matches toDateString())
    • - -
  • Month/Day/Year (for instance, "02/01/2005")
    • - -
  • Month/Year (for instance, "02/2005")
    • - -
- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
yearOrTimevalue:Object — If other parameters are specified, this number represents a - - year (such as 1965); otherwise, it represents a time value. If the number represents a year, a - - value of 0 to 99 indicates 1900 through 1999; otherwise all four digits of the year must be - - specified. If the number represents a time value (no other parameters are specified), it is the - - number of milliseconds before or after 0:00:00 GMT January 1, 1970; a negative values represents - - a time before 0:00:00 GMT January 1, 1970, and a positive value represents a time after. - - -
 
month:Number — An integer from 0 (January) to 11 (December). - - -
 
date:Number (default = 1) — An integer from 1 to 31. - - -
 
hour:Number (default = 0) — An integer from 0 (midnight) to 23 (11 p.m.). - - -
 
minute:Number (default = 0) — An integer from 0 to 59. - - -
 
second:Number (default = 0) — An integer from 0 to 59. - - -
 
millisecond:Number (default = 0) — An integer from 0 to 999 of milliseconds. - - - -
-

-See also -

-
-getMonth() -
-getDate() -
-getFullYear() -
-
- -
Method detail
- - - - - -
getDate()method
-
-AS3 function getDate():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the day of the month (an integer from 1 to 31) specified by a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

-Returns - - - - -
Number — - The day of the month (1 - 31) a Date object represents. - - - - - -
-

-See also -

-
-getMonth() -
-getFullYear() -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). - The getDate() method is then called, which retrieves the day of the month. -
-
-package {
-    import flash.display.Sprite;
-
-	public class DateExample extends Sprite {
-
-		public function DateExample() {
-			var someBirthday:Date = new Date(1974, 10, 30, 1, 20);
-			trace(someBirthday); 	       // Sat Nov 30 01:20:00 GMT-0800 1974
-			trace(someBirthday.getDate()); // 30
-		}
-	}
-}
-
-

-
- - - - - -
getDay()method 
-
-AS3 function getDay():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the day of the week (0 for Sunday, 1 for Monday, and so on) specified by this - - Date according to local time. Local time is determined by the operating - - system on which the Flash runtimes are running. - - -

-Returns - - - - -
Number — - A numeric version of the day of the week (0 - 6) a Date object - - represents. - - - - - -
-
-Example -
The following example creates a new Array object weekDayLabels, with elements - [Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday] and a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). - The getDay() method is then called twice, which first shows the day of the month - as 6 and then shows the day of the week using weekDayLabels. -
-
-
-var weekDayLabels:Array = new Array("Sunday",
-    			    "Monday",
-				    "Tuesday",
-				    "Wednesday",
-				    "Thursday",
-				    "Friday",
-				    "Saturday");
-
-var someBirthday:Date = new Date(1974, 10, 30, 1, 20);
-trace(someBirthday); 	     		     // Sat Nov 30 01:20:00 GMT-0800 1974
-trace(someBirthday.getDay());   	     // 6
-trace(weekDayLabels[someBirthday.getDay()]); // Saturday
-
-

-
- - - - - -
getFullYear()method 
-
-AS3 function getFullYear():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the full year (a four-digit number, such as 2000) of a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

-Returns - - - - -
Number — - The full year a Date object represents. - - - - - -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). - The getFullYear() method is then called, which retrieves the four-digit year. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 1, 20);
-trace(someBirthday);           // Sat Nov 30 01:20:00 GMT-0800 1974
-trace(someBirthday.getFullYear()); // 1974
-
-

-
- - - - - -
getHours()method 
-
-AS3 function getHours():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the hour (an integer from 0 to 23) of the day portion of a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

-Returns - - - - -
Number — - The hour (0 - 23) of the day a Date object represents. - - - - - -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). - The getHours() and getMinutes() methods are then called, which - retrieves the hours and the minutes in 24-hour format. Finally, a string localTime - is created and assigned to the result of a call to the function getUSClockTime(), which, in turn calls - getHours() and getMinutes() again, resulting in the time 03:05 PM. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 15, 5);
-
-trace(someBirthday); // Sat Nov 30 15:20:00 GMT-0800 1974
-trace(someBirthday.getHours() + ":" + someBirthday.getMinutes()); // 15:5
-
-var localTime:String = getUSClockTime(someBirthday.getHours(), someBirthday.getMinutes());
-trace(localTime);    // 03:05 PM
-
-function getUSClockTime(hrs:uint, mins:uint):String {
-    var modifier:String = "PM";
-	var minLabel:String = doubleDigitFormat(mins);
-
-	if(hrs > 12) {
-		hrs = hrs-12;
-	} else if(hrs == 0) {
-		modifier = "AM";
-		hrs = 12;
-	} else if(hrs < 12) {
-		modifier = "AM";
-	}
-
-	return (doubleDigitFormat(hrs) + ":" + minLabel + " " + modifier);
-}
-
-function doubleDigitFormat(num:uint):String {
-	if(num < 10) {
-		return ("0" + num);
-	}
-	return num as String;
-}
-
-

-
- - - - - -
getMilliseconds()method 
-
-AS3 function getMilliseconds():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the milliseconds (an integer from 0 to 999) portion of a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

-Returns - - - - -
Number — - The milliseconds portion of a Date object. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The getMilliseconds() method is then called, which retrieves the milliseconds of the - Date object now at the time it was created. -
-
-
-var now:Date = new Date();
-trace(now.getMilliseconds());
-
-

-
- - - - - -
getMinutes()method 
-
-AS3 function getMinutes():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the minutes (an integer from 0 to 59) portion of a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

-Returns - - - - -
Number — - The minutes portion of a Date object. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The getMinutes() method is then called, which retrieves the minutes of the - Date object now at the time it was created. -
-
-
-var now:Date = new Date();
-trace(now);
-trace(now.getMinutes());
-
-

-
- - - - - -
getMonth()method 
-
-AS3 function getMonth():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the month (0 for January, 1 for February, and so on) portion of this - - Date according to local time. Local time is determined by the operating system - - on which the Flash runtimes are running. - - -

-Returns - - - - -
Number — - The month (0 - 11) portion of a Date object. - - - - - -
-
-Example -
The following example creates a new Array object monthLabels, with elements - January through December and a new Date object now with no parameters. - The getMonth() method is then called twice, which first returns the month number and - then the month name of the month the Date object now was created. -
-
-
-var monthLabels:Array = new Array("January",
-    			  "February",
-				  "March",
-				  "April",
-				  "May",
-				  "June",
-				  "July",
-				  "August",
-				  "September",
-				  "October",
-				  "November",
-				  "December");
-
-var now:Date = new Date();
-trace(now.getMonth());
-trace(monthLabels[now.getMonth()]);
-
-

-
- - - - - -
getSeconds()method 
-
-AS3 function getSeconds():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the seconds (an integer from 0 to 59) portion of a Date object - - according to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - - -

-Returns - - - - -
Number — - The seconds (0 to 59) portion of a Date object. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The getSeconds() method is then called, which retrieves the seconds of the - Date object now at the time it was created. -
-
-
-var now:Date = new Date();
-trace(now.getSeconds());
-
-

-
- - - - - -
getTime()method 
-
-AS3 function getTime():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the number of milliseconds since midnight January 1, 1970, universal time, - - for a Date object. Use this method to represent a specific instant in time - - when comparing two or more Date objects. - - -

-Returns - - - - -
Number — - The number of milliseconds since Jan 1, 1970 that a Date object represents. - - - - -
-
-Example -
The following example creates a new Date object mlk with parameters - year (1929), month (0 = January), and - day (15). The getTime() method is then called, which - retrieves the milliseconds since midnight January 1, 1970, which is negative since the year is - set to 1929. -
-
-
-var mlk:Date = new Date(1929, 0, 15);
-trace(mlk);           // Tue Jan 15 00:00:00 GMT-0800 1929
-trace(mlk.getTime()); // -1292601600000
-
-

The following example creates a new Date object now with no parameters - and then uses the following DateMath (created below) class methods to add time to the original Date - object now from the time it was created: -
    -
  • addSeconds(): adds 30 seconds to now.
    • -
  • addMinutes(): adds 30 minutes to now.
    • -
  • addHours(): adds 6 hours to the Date object now.
    • -
  • addDays(): adds 30 days to the Date object now.
    • -
  • addWeeks(): adds 4 weeks to now.
    • -
- -
-
-
-var now:Date = new Date();
-trace(now);
-trace(DateMath.addSeconds(now, 30));
-trace(DateMath.addMinutes(now, 30));
-trace(DateMath.addHours(now, 6));
-trace(DateMath.addDays(now, 30));
-trace(DateMath.addWeeks(now, 4));
-
-class DateMath {
-	public static function addWeeks(date:Date, weeks:Number):Date {
-		return addDays(date, weeks*7);
-	}
-
-	public static function addDays(date:Date, days:Number):Date {
-		return addHours(date, days*24);
-	}
-
-	public static function addHours(date:Date, hrs:Number):Date {
-		return addMinutes(date, hrs*60);
-	}
-
-	public static function addMinutes(date:Date, mins:Number):Date {
-		return addSeconds(date, mins*60);
-	}
-
-	public static function addSeconds(date:Date, secs:Number):Date {
-		var mSecs:Number = secs * 1000;
-		var sum:Number = mSecs + date.getTime();
-		return new Date(sum);
-	}
-}
-
-
Note: it's important to use getTime when performing Date arithmetic because it will continue - to work during leap years and doesn't require a bunch of if logic like following pseudo-code: - 
-  function addMonths(num:Number):void {
-  	currentMonth = currentMonth + num;
-  	if(currentMonth > 12) {
-  		currentYear++;
-  		currentMonth = currentMonth - 12;
-  	}
-  }
-
-
-
-

-
- - - - - -
getTimezoneOffset()method 
-
-AS3 function getTimezoneOffset():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the difference, in minutes, between universal - - time (UTC) and the computer's local time. - - -

-Returns - - - - -
Number — - The minutes you need to add to the computer's local time value to equal UTC. If - - your computer's time is set later than UTC, the return value will be negative. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The getTimezoneOffset() method is then called, which retrieves the difference (in minutes) of the - time now was created and Universal Time. The time zone offset is then converted to hours by - dividing the result by 60. -
-
-
-var date:Date = new Date();
-trace(date.getTimezoneOffset() / 60);
-
-

-
- - - - - -
getUTCDate()method 
-
-AS3 function getUTCDate():Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the day of the month (an integer from 1 to 31) of a Date object, - - according to universal time (UTC). - - -

-Returns - - - - -
Number — - The UTC day of the month (1 to 31) that a Date object represents. - - - - - -
-

-See also -

-
-getDate() -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). - The getUTCDate() method is then called, which retrieves the day of the month, according to the UTC. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 1, 20);
-trace(someBirthday);       	  // Sat Nov 30 01:20:00 GMT-0800 1974
-trace(someBirthday.getUTCDate()); // 30
-
-

-
- - - - - -
getUTCDay()method 
-
-AS3 function getUTCDay():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the day of the week (0 for Sunday, 1 for Monday, and so on) of this Date - - according to universal time (UTC). - - -

-Returns - - - - -
Number — - The UTC day of the week (0 to 6) that a Date object represents. - - - - - -
-

-See also -

-
-getDay() -
-
-Example -
The following example creates a new Array object weekDayLabels, with elements - [Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday] and a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). - The getUTCDay() method is then called twice, which first shows the day of the month - as 6 and then shows the day of the week using weekDayLabels, according to the UTC. -
-
-
-var weekDayLabels:Array = new Array("Sunday",
-    			    "Monday",
-				    "Tuesday",
-				    "Wednesday",
-				    "Thursday",
-				    "Friday",
-				    "Saturday");
-
-var someBirthday:Date = new Date(1974, 10, 30, 1, 20);
-trace(someBirthday);  		 // Sat Nov 30 01:20:00 GMT-0800 1974
-trace(someBirthday.getUTCDay()); // 6
-trace(weekDayLabels[someBirthday.getUTCDay()]); // Saturday
-
-

-
- - - - - -
getUTCFullYear()method 
-
-AS3 function getUTCFullYear():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the four-digit year of a Date object according to universal time (UTC). - - -

-Returns - - - - -
Number — - The UTC four-digit year a Date object represents. - - - - - -
-

-See also -

-
-getFullYear() -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). - The getUTCFullYear() method is then called, which retrieves the four-digit year, according to the UTC. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 1, 20);
-trace(someBirthday);                 // Sat Nov 30 01:20:00 GMT-0800 1974
-trace(someBirthday.getUTCFullYear()); // 1974
-
-

-
- - - - - -
getUTCHours()method 
-
-AS3 function getUTCHours():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the hour (an integer from 0 to 23) of the day of a Date object - - according to universal time (UTC). - - -

-Returns - - - - -
Number — - The UTC hour of the day (0 to 23) a Date object represents. - - - - - -
-

-See also -

-
-getHours() -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). - The getHours() and getMinutes() methods are then called, which retrieves - the hours and the minutes in 24-hour format. Finally, a string localTime is created and - assigned to the result of a call to the function getUSClockTime(), which, in turn calls - getHours() and getMinutes() again, resulting in the time 03:05 PM. - Lastly, a String variable utcTime is created in the same manner as localTime, - and in this case, the result is the same. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 15, 5);
-
-trace(someBirthday); // Sat Nov 30 15:20:00 GMT-0800 1974
-trace(someBirthday.getHours() + ":" + someBirthday.getMinutes()); // 15:5
-
-var localTime:String = getUSClockTime(someBirthday.getHours(), someBirthday.getMinutes());
-trace(localTime);    // 03:05 PM
-
-var utcTime:String = getUSClockTime(someBirthday.getUTCHours(), someBirthday.getUTCMinutes());
-trace(utcTime);      // 11:05 PM
-
-function getUSClockTime(hrs:uint, mins:uint):String {
-    var modifier:String = "PM";
-	var minLabel:String = doubleDigitFormat(mins);
-
-	if(hrs > 12) {
-		hrs = hrs-12;
-	} else if(hrs == 0) {
-		modifier = "AM";
-		hrs = 12;
-	} else if(hrs < 12) {
-		modifier = "AM";
-	}
-
-	return (doubleDigitFormat(hrs) + ":" + minLabel + " " + modifier);
-}
-
-function doubleDigitFormat(num:uint):String {
-	if(num < 10) {
-		return ("0" + num);
-	}
-	return num;
-}
-
-

-
- - - - - -
getUTCMilliseconds()method 
-
-AS3 function getUTCMilliseconds():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the milliseconds (an integer from 0 to 999) portion of a Date object - - according to universal time (UTC). - - -

-Returns - - - - -
Number — - The UTC milliseconds portion of a Date object. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The getUTCMilliseconds() method is then called, which retrieves the milliseconds of the - Date object now at the time it was created, according to the UTC -
-
-
-var now:Date = new Date();
-trace(now.getUTCMilliseconds());
-
-

-
- - - - - -
getUTCMinutes()method 
-
-AS3 function getUTCMinutes():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the minutes (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC). - - -

-Returns - - - - -
Number — - The UTC minutes portion of a Date object. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The getUTCMinutes() method is then called, which retrieves the minutes of the - Date object now at the time it was created, according to the UTC -
-
-
-var now:Date = new Date();
-trace(now.getUTCMinutes());
-
-

-
- - - - - -
getUTCMonth()method 
-
-AS3 function getUTCMonth():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the month (0 [January] to 11 [December]) portion of a Date object - - according to universal time (UTC). - - -

-Returns - - - - -
Number — - The UTC month portion of a Date object. - - - - - -
-

-See also -

-
-getMonth() -
-
-Example -
The following example creates a new Array object monthLabels, with elements - January through December and a new Date object now with no parameters. - The getUTCMonth() method is then called twice, which first returns the month number and - then the month name of the month the Date object now was created, according to the UTC -
-
-
-var monthLabels:Array = new Array("January",
-    			  "February",
-				  "March",
-				  "April",
-				  "May",
-				  "June",
-				  "July",
-				  "August",
-				  "September",
-				  "October",
-				  "November",
-				  "December");
-
-var now:Date = new Date();
-trace(now.getMonth());
-trace(now.getUTCMonth());
-trace(monthLabels[now.getUTCMonth()]);
-
-

-
- - - - - -
getUTCSeconds()method 
-
-AS3 function getUTCSeconds():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the seconds (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC). - - -

-Returns - - - - -
Number — - The UTC seconds portion of a Date object. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The getUTCSeconds() method is then called, which retrieves the seconds of the - Date object now at the time it was created, according to the UTC -
-
-
-var now:Date = new Date();
-trace(now.getUTCSeconds());
-
-

-
- - - - - -
parse()method 
-
-public static function parse(date:String):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Converts a string representing a date into a number equaling the number of milliseconds - - elapsed since January 1, 1970, UTC. - - -

Parameters - - - - -
date:String — A string representation of a date, which conforms to the format for the output of - - Date.toString(). The date format for the output of Date.toString() is: - - 
-
-     Day Mon DD HH:MM:SS TZD YYYY
-
-
- -

For example:

- - 
-
-     Wed Apr 12 15:30:17 GMT-0700 2006
-
-
- -

The Time Zone Designation (TZD) is always in the form GMT-HHMM or UTC-HHMM indicating the - - hour and minute offset relative to Greenwich Mean Time (GMT), which is now also called universal time (UTC). - - The year month and day terms can be separated by a forward slash (/) or by spaces, but never by a - - dash (-). Other supported formats include the following (you can include partial representations of these - - formats; that is, just the month, day, and year):

- - 
-
-     MM/DD/YYYY HH:MM:SS TZD
-
-     HH:MM:SS TZD Day Mon/DD/YYYY 
-
-     Mon DD YYYY HH:MM:SS TZD
-
-     Day Mon DD HH:MM:SS TZD YYYY
-
-     Day DD Mon HH:MM:SS TZD YYYY
-
-     Mon/DD/YYYY HH:MM:SS TZD
-
-     YYYY/MM/DD HH:MM:SS TZD
-
-
- - -
-

-Returns - - - - -
Number — - A number representing the milliseconds elapsed since January 1, 1970, UTC. - - - - - -
-

-See also -

-
-Date.toString() -
-
-Example -
The following example assigns a date string to dateParsed for November 30, 1974. - The Date.parse() method is then called, which converts the date into milliseconds since January 1, 1970. -
-
-var dateParsed:String = "Sat Nov 30 1974";
-
-var milliseconds:Number = Date.parse(dateParsed);
-trace(milliseconds); // 155030400000
-
-

-
- - - - - -
setDate()method 
-
-AS3 function setDate(day:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the day of the month, according to local time, and returns the new time in - - milliseconds. Local time is determined by the operating system on which the Flash runtimes are - - running. - - -

Parameters - - - - -
day:Number — An integer from 1 to 31. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). The - method getDate() is then called, which retrieves the day of the month. Next - setDate() is called with the day parameter set to 20 and - then getDate() is called again, which retrieves the newly set day of month. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 1, 20);
-trace(someBirthday);            // Sat Nov 30 01:20:00 GMT-0800 1974
-trace(someBirthday.getDate()); // 30
-
-someBirthday.setDate(20);
-trace(someBirthday.getDate()); // 20
-
-

-
- - - - - -
setFullYear()method 
-
-AS3 function setFullYear(year:Number, month:Number, day:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the year, according to local time, and returns the new time in milliseconds. If - - the month and day parameters are specified, - - they are set to local time. Local time is determined by the operating system on which - - the Flash runtimes are running. - -

- - Calling this method does not modify the other fields of the Date but - - Date.getUTCDay() and Date.getDay() can report a new value - - if the day of the week changes as a result of calling this method. - -

- - - Parameters - - - - - - - - - - - - - - - - -
year:Number — A four-digit number specifying a year. Two-digit numbers do not represent - - four-digit years; for example, 99 is not the year 1999, but the year 99. - - -
 
month:Number — An integer from 0 (January) to 11 (December). - - -
 
day:Number — A number from 1 to 31. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-

-See also -

-
-getUTCDay() -
-getDay() -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). The - method getFullYear() is then called, which retrieves the four-digit year. - Next setFullYear() is called with the year parameter set to - 2000 and then getFullYear() is called again, which retrieves the newly set year. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 1, 20);
-trace(someBirthday);           // Sat Nov 30 01:20:00 GMT-0800 1974
-trace(someBirthday.getFullYear()); // 1974
-
-someBirthday.setFullYear(2000);
-trace(someBirthday.getFullYear()); // 2000
-
-

-
- - - - - -
setHours()method 
-
-AS3 function setHours(hour:Number, minute:Number, second:Number, millisecond:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the hour, according to local time, and returns the new time in milliseconds. - - Local time is determined by the operating system on which the Flash runtimes are running. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
hour:Number — An integer from 0 (midnight) to 23 (11 p.m.). - -
 
minute:Number — An integer from 0 to 59. - -
 
second:Number — An integer from 0 to 59. - -
 
millisecond:Number — An integer from 0 to 999. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). The methods - getHours() and - getMinutes() are then called, which retrieves the hours and minutes. Next setHours() - is called with the hour parameter set to 12 and then getHours() and - getMinutes() are called again, which retrieves the newly set hours and minutes. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 15, 20);
-
-trace(someBirthday); // Sat Nov 30 15:20:00 GMT-0800 1974
-trace(someBirthday.getHours() + ":" + someBirthday.getMinutes()); // 15:20
-
-someBirthday.setHours(12);
-trace(someBirthday.getHours() + ":" + someBirthday.getMinutes()); // 12:20
-
-

-
- - - - - -
setMilliseconds()method 
-
-AS3 function setMilliseconds(millisecond:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the milliseconds, according to local time, and returns the new time in - - milliseconds. Local time is determined by the operating system on which the Flash runtimes are - - running. - - -

Parameters - - - - -
millisecond:Number — An integer from 0 to 999. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The method getMilliseconds() is then called, which retrieves the milliseconds when - now was created. Then another new Date object before with an additional - call to setMilliseconds() with the millisecond parameter set to 4 and - getMilliseconds() is called again, which retrieves the newly set milliseconds. -
-
-
-var now:Date = new Date();
-trace(now);
-trace(now.getMilliseconds());
-
-var before:Date = new Date(now.setMilliseconds(4));
-trace(before);
-trace(before.getMilliseconds());
-
-

-
- - - - - -
setMinutes()method 
-
-AS3 function setMinutes(minute:Number, second:Number, millisecond:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the minutes, according to local time, and returns the new time in milliseconds. - - Local time is determined by the operating system on which the Flash runtimes are running. - - -

Parameters - - - - - - - - - - - - - - - - -
minute:Number — An integer from 0 to 59. - -
 
second:Number — An integer from 0 to 59. - -
 
millisecond:Number — An integer from 0 to 999. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The method getMinutes() is then called, which retrieves the minutes when - now was created. Then another new Date object before with an additional - call to setMinutes() with the minute parameter set to 0 and - getMinutes() is called again, which retrieves the newly set minutes. -
-
-
-var now:Date = new Date();
-trace(now);
-trace(now.getMinutes());
-
-var before:Date = new Date(now.setMinutes(0));
-trace(before);
-trace(before.getMinutes());
-
-

-
- - - - - -
setMonth()method 
-
-AS3 function setMonth(month:Number, day:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the month and optionally the day of the month, according to local time, and - - returns the new time in milliseconds. Local time is determined by the operating - - system on which the Flash runtimes are running. - - -

Parameters - - - - - - - - - - -
month:Number — An integer from 0 (January) to 11 (December). - - -
 
day:Number — An integer from 1 to 31. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - -
-
-Example -
The following example creates a new Array object monthLabels, with elements - January through December and a new month object now with no parameters. - The method getMonth() is then called, which retrieves the month in which - now was created. Next setMonth() is called with the month parameter set to - 0 and then getMonth() is called again, which retrieves the newly set month.. -
-
-
-var monthLabels:Array = new Array("January",
-    			  "February",
-				  "March",
-				  "April",
-				  "May",
-				  "June",
-				  "July",
-				  "August",
-				  "September",
-				  "October",
-				  "November",
-				  "December");
-
-var now:Date = new Date();
-trace(now.getMonth());
-trace(monthLabels[now.getMonth()]);
-
-now.setMonth(0);
-trace(now.getMonth()); 		    // 0
-trace(monthLabels[now.getMonth()]); // January
-
-

-
- - - - - -
setSeconds()method 
-
-AS3 function setSeconds(second:Number, millisecond:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the seconds, according to local time, and returns the new time in milliseconds. - - Local time is determined by the operating system on which the Flash runtimes are running. - - -

Parameters - - - - - - - - - - -
second:Number — An integer from 0 to 59. - -
 
millisecond:Number — An integer from 0 to 999. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The method getseconds() is then called, which retrieves the seconds when - now was created. Then the setSeconds() is called with the second - parameter set to 0 and - getSeconds() is called again, which retrieves the newly set seconds. -
-
-
-var now:Date = new Date();
-trace(now.getSeconds());
-
-now.setSeconds(0);
-trace(now.getSeconds()); // 0
-
-

-
- - - - - -
setTime()method 
-
-AS3 function setTime(millisecond:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the date in milliseconds since midnight on January 1, 1970, and returns the new - - time in milliseconds. - - -

Parameters - - - - -
millisecond:Number — An integer value where 0 is midnight on January 1, universal time (UTC). - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The setTime() method is then called, with the millisecond parameter set - to -1292601600000, which sets the time to Tue Jan 15 00:00:00 GMT-0800 1929. -
-
-
-var now:Date = new Date();
-trace(now);
-
-now.setTime(-1292601600000);
-trace(now); // Tue Jan 15 00:00:00 GMT-0800 1929
-
-

-
- - - - - -
setUTCDate()method 
-
-AS3 function setUTCDate(day:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the day of the month, in universal time (UTC), and returns the new time in - - milliseconds. Calling this method does not modify the other fields of a Date - - object, but the Date.getUTCDay() and Date.getDay() methods can report - - a new value if the day of the week changes as a result of calling this method. - - -

Parameters - - - - -
day:Number — A number; an integer from 1 to 31. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-

-See also -

-
-getUTCDay() -
-getDay() -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). The method - getUTCDate() is called and correctly returns the day of the month. Next setUTCDate() - is called with the day parameter set to 1 and a trace() statement - confirms the date was correctly set. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 1, 20);
-trace(someBirthday); // Sat Nov 30 01:20:00 GMT-0800 1974
-trace(someBirthday.getUTCDate()); // 30
-
-someBirthday.setUTCDate(1);
-trace(someBirthday); // Fri Nov 1 01:20:00 GMT-0800 1974
-
-

-
- - - - - -
setUTCFullYear()method 
-
-AS3 function setUTCFullYear(year:Number, month:Number, day:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the year, in universal time (UTC), and returns the new time in milliseconds. - -

- - Optionally, this method can also set the month and day of the month. Calling - - this method does not modify the other fields, but the Date.getUTCDay() and - - Date.getDay() methods can report a new value if the day of the week changes as a - - result of calling this method. - -

- - - Parameters - - - - - - - - - - - - - - - - -
year:Number — An integer that represents the year specified as a full four-digit year, - - such as 2000. - - -
 
month:Number — An integer from 0 (January) to 11 (December). - - -
 
day:Number — An integer from 1 to 31. - - -
-

-Returns - - - - -
Number — - An integer. - - - - - -
-

-See also -

-
-getUTCDay() -
-getDay() -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). The method - getUTCFullYear() is called and correctly returns the four-digit year. Next setUTCFullYear() - is called with the year parameter set to 1975 and a trace() statement - confirms the year was correctly set. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 1, 20);
-trace(someBirthday); // Sat Nov 30 01:20:00 GMT-0800 1974
-trace(someBirthday.getUTCFullYear()); // 1974
-
-someBirthday.setUTCFullYear(1975);
-trace(someBirthday); // Thu Nov 30 01:20:00 GMT-0800 1975
-
-

-
- - - - - -
setUTCHours()method 
-
-AS3 function setUTCHours(hour:Number, minute:Number, second:Number, millisecond:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Sets the hour, in universal time (UTC), and returns the new time in milliseconds. - - Optionally, the minutes, seconds, and milliseconds can be specified. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
hour:Number — An integer from 0 (midnight) to 23 (11 p.m.). - - -
 
minute:Number — An integer from 0 to 59. - - -
 
second:Number — An integer from 0 to 59. - - -
 
millisecond:Number — An integer from 0 to 999. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20). The methods - getHours(), getMinutes(), getUTCHours(), and getUTCMinutes() - are then called, which retrieves the hours and minutes. Next setUTCHours() is called with the - hour parameter set to 12 and then the methods getHours(), - getMinutes(), getUTCHours(), and getUTCMinutes() are re-called and - correctly display the updated hour. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 15, 20);
-
-trace(someBirthday); // Sat Nov 30 15:20:00 GMT-0800 1974
-trace(someBirthday.getHours() + ":" + someBirthday.getMinutes());     // 15:20
-trace(someBirthday.getUTCHours() + ":" + someBirthday.getUTCMinutes()); // 23:20
-
-someBirthday.setUTCHours(12);
-trace(someBirthday.getHours() + ":" + someBirthday.getMinutes()); 	// 4:20
-trace(someBirthday.getUTCHours() + ":" + someBirthday.getUTCMinutes()); // 12:20
-
-

-
- - - - - -
setUTCMilliseconds()method 
-
-AS3 function setUTCMilliseconds(millisecond:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the milliseconds, in universal time (UTC), and returns the new time in milliseconds. - - -

Parameters - - - - -
millisecond:Number — An integer from 0 to 999. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The method getUTCMilliseconds() is then called, which retrieves the UTCMilliseconds when - now was created. Then another new Date object before with an additional - call to setUTCMilliseconds() with the millisecond parameter set to 4 and - getUTCMilliseconds() is called again, which retrieves the newly set milliseconds. -
-
-
-
-var now:Date = new Date();
-trace(now);
-trace(now.getUTCMilliseconds());
-
-var before:Date = new Date(now.setUTCMilliseconds(4));
-trace(before);
-trace(before.getUTCMilliseconds());
-
-

-
- - - - - -
setUTCMinutes()method 
-
-AS3 function setUTCMinutes(minute:Number, second:Number, millisecond:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the minutes, in universal time (UTC), and returns the new time in milliseconds. - - Optionally, you can specify the seconds and milliseconds. - - -

Parameters - - - - - - - - - - - - - - - - -
minute:Number — An integer from 0 to 59. - - -
 
second:Number — An integer from 0 to 59. - - -
 
millisecond:Number — An integer from 0 to 999. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The method getUTCMinutes() is then called, which retrieves the UTCMinutes when - now was created. Then another new Date object before with an additional - call to setUTCMinutes() with the minute parameter set to 0 and - getUTCMinutes() is called again, which retrieves the newly set minutes. -
-
-
-var now:Date = new Date();
-trace(now);
-trace(now.getUTCMinutes());
-
-var before:Date = new Date(now.setUTCMinutes(0));
-trace(before);
-trace(before.getUTCMinutes());
-
-

-
- - - - - -
setUTCMonth()method 
-
-AS3 function setUTCMonth(month:Number, day:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the month, and optionally the day, in universal time(UTC) and returns the new - - time in milliseconds. Calling this method does not modify the other fields, but the - - Date.getUTCDay() and Date.getDay() methods might report a new - - value if the day of the week changes as a result of calling this method. - - -

Parameters - - - - - - - - - - -
month:Number — An integer from 0 (January) to 11 (December). - - -
 
day:Number — An integer from 1 to 31. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-

-See also -

-
-getDay() -
-
-Example -
The following example creates a new Array object UTCMonthLabels, with elements - January through December and a new UTCMonth object now with no parameters. - The method getUTCMonth() is then called, which retrieves the UTCMonth in which - now was created. Next setUTCMonth() is called with the month parameter set to - 0 and then getUTCMonth() is called again, which retrieves the newly set month.. -
-
-
-var UTCMonthLabels:Array = new Array("January",
-    			  "February",
-				  "March",
-				  "April",
-				  "May",
-				  "June",
-				  "July",
-				  "August",
-				  "September",
-				  "October",
-				  "November",
-				  "December");
-
-var now:Date = new Date();
-trace(now.getUTCMonth());
-trace(UTCMonthLabels[now.getUTCMonth()]);
-
-now.setUTCUTCMonth(0);
-trace(now.getUTCMonth()); 		     // 0
-trace(UTCMonthLabels[now.getUTCMonth()]); // January
-
-

-
- - - - - -
setUTCSeconds()method 
-
-AS3 function setUTCSeconds(second:Number, millisecond:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the seconds, and optionally the milliseconds, in universal time (UTC) and - - returns the new time in milliseconds. - - -

Parameters - - - - - - - - - - -
second:Number — An integer from 0 to 59. - - -
 
millisecond:Number — An integer from 0 to 999. - - -
-

-Returns - - - - -
Number — - The new time, in milliseconds. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters. - The method getUTCSeconds() is then called, which retrieves the seconds when - now was created. Then the setUTCSeconds() is called with the second - parameter set to 0 and getUTCSeconds() is called again, which retrieves the - newly set seconds. -
-
-
-var now:Date = new Date();
-trace(now.getUTCSeconds());
-
-now.setUTCSeconds(0);
-trace(now.getUTCSeconds()); // 0
-
-

-
- - - - - -
toDateString()method 
-
-AS3 function toDateString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a string representation of the day and date only, and does not include the time or timezone. - - Contrast with the following methods: - -

    - -
  • Date.toTimeString(), which returns only the time and timezone
    • - -
  • Date.toString(), which returns not only the day and date, but also the time and timezone.
    • - -
- - -

-Returns - - - - -
String — - The string representation of day and date only. - - - - - -
-

-See also -

-
-toString() -
-
-Example -
The following example creates a new Date object now with no parameters - and then the following methods are called within a trace() statement -
    -
  • toString: displays all parameters for now at the time now was created.
    • -
  • toDateString(): displays the day, month, and year parameters - for the time now was created.
    • -
-
-
-
-var now:Date = new Date();
-trace(now);
-trace(now.toDateString());
-
-

-
- - - - - -
toJSON()method 
-
-AS3 function toJSON(k:String):* -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Provides an overridable method for customizing the JSON encoding of values in an Date object. - - -

The JSON.stringify() method looks for a toJSON() method on each object that it traverses. If the - - toJSON() method is found, JSON.stringify() calls it for each value it encounters, passing in the key - - that is paired with the value.

- -

Date provides a default implementation of toJSON() that returns the output of Date.toString(). - - Clients that wish to export Date objects to JSON in any other format can provide their own implementations. - - You can do this by redefining the toJSON() method on the class prototype.

- -

The toJSON() method can return a value of any type. If it returns an object, stringify() recurses into that object. - - If toJSON() returns a string, stringify() does not recurse and continues its traversal.

- - - Parameters - - - - -
k:String — The key of a key/value pair that JSON.stringify() has encountered in its traversal of this object - - -
-

-Returns - - - - -
* — The object's value of Date.toString(). - -
-

-See also -

-
-Object -
Object.prototype
-
- - - - - -
toLocaleDateString()method 
-
-AS3 function toLocaleDateString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a String representation of the day and date only, and does not include the time or timezone. - - This method returns the same value as Date.toDateString. - - Contrast with the following methods: - -

    - -
  • Date.toTimeString(), which returns only the time and timezone
    • - -
  • Date.toString(), which returns not only the day and date, but also the - - time and timezone.
    • - -
- - -

-Returns - - - - -
String — - The String representation of day and date only. - - - - -
-

-See also -

-
-toDateString() -
-toTimeString() -
-toString() -
-
- - - - - -
toLocaleString()method 
-
-AS3 function toLocaleString():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a String representation of the day, date, time, given in local time. - - Contrast with the Date.toString() method, which returns the same information (plus the timezone) - - with the year listed at the end of the string. - - -

-Returns - - - - -
String — - A string representation of a Date object in the local timezone. - - - - - - -
-
- - - - - -
toLocaleTimeString()method 
-
-AS3 function toLocaleTimeString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a String representation of the time only, and does not include the day, date, year, or timezone. - - Contrast with the Date.toTimeString() method, which returns the time and timezone. - - -

-Returns - - - - -
String — - The string representation of time and timezone only. - - - - - -
-

-See also -

-
-toTimeString() -
-
- - - - - -
toString()method 
-
-AS3 function toString():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a String representation of the day, date, time, and timezone. - - The date format for the output is: - - 

-
-     Day Mon Date HH:MM:SS TZD YYYY
-
-
- -

For example:

- - 
-
-     Wed Apr 12 15:30:17 GMT-0700 2006
-
-
- - -

-Returns - - - - -
String — - The string representation of a Date object. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters - and then toString is called within a trace() statement, which - displays all parameters for now at the time now was created. -
-
-
-
-var now:Date = new Date();
-trace(now);
-
-

-
- - - - - -
toTimeString()method 
-
-AS3 function toTimeString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a String representation of the time and timezone only, and does not include the day and date. - - Contrast with the Date.toDateString() method, which returns only the day and date. - - -

-Returns - - - - -
String — - The string representation of time and timezone only. - - - - - -
-

-See also -

-
-toDateString() -
-
- - - - - -
toUTCString()method 
-
-AS3 function toUTCString():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a String representation of the day, date, and time in universal time (UTC). - - For example, the date February 1, 2005 is returned as Tue Feb 1 00:00:00 2005 UTC. - - -

-Returns - - - - -
String — - The string representation of a Date object in UTC time. - - - - - -
-

-See also -

-
-toString() -
-
- - - - - -
UTC()method 
-
-public static function UTC(year:Number, month:Number, date:Number = 1, hour:Number = 0, minute:Number = 0, second:Number = 0, millisecond:Number = 0):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the number of milliseconds between midnight on January 1, 1970, universal time, - - and the time specified in the parameters. This method uses universal time, whereas the - - Date constructor uses local time. - -

This method is useful if you want to pass a UTC date to the Date class constructor. - - Because the Date class constructor accepts the millisecond offset as an argument, you - - can use the Date.UTC() method to convert your UTC date into the corresponding millisecond - - offset, and send that offset as an argument to the Date class constructor:

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
year:Number — A four-digit integer that represents the year (for example, 2000). - - -
 
month:Number — An integer from 0 (January) to 11 (December). - - -
 
date:Number (default = 1) — An integer from 1 to 31. - - -
 
hour:Number (default = 0) — An integer from 0 (midnight) to 23 (11 p.m.). - - -
 
minute:Number (default = 0) — An integer from 0 to 59. - - -
 
second:Number (default = 0) — An integer from 0 to 59. - - -
 
millisecond:Number (default = 0) — An integer from 0 to 999. - - -
-

-Returns - - - - -
Number — - The number of milliseconds since January 1, 1970 and the specified date and time. - - - - - -
-
-Example -
The following example creates a new Date object someBirthday with parameters - year (1974), month (10 = November), day - (30), hour (1) and minute (20) using local - time. Then a call to UTC() within a setTime() method resets the same parameters - to universal time. -
-
-
-var someBirthday:Date = new Date(1974, 10, 30, 15, 20);
-trace(someBirthday.toString());
-
-someBirthday.setTime(Date.UTC(1974, 10, 30, 15, 20));
-trace(someBirthday.toString());
-
-

-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the number of milliseconds since midnight January 1, 1970, universal time, - - for a Date object. - - -

-Returns - - - - -
Number — - The number of milliseconds since January 1, 1970 that a Date object represents. - - - - - -
-
-Example -
The following example creates a new Date object now with no parameters - The getTime() method is then called, which retrieves the number of milliseconds between - the time now was created and midnight on - January 1, 1970, and then valueOf() is called, which retrieves the same thing. -
-
-
-
-var now:Date = new Date();
-trace(now.getTime());
-trace(now.valueOf());
-
-

-
- -
Examples
-
examples\DateExample
-
The following example shows various uses of the Date() constructor to assign the - following variables: -
    -
  • myDate1 calls Date() with no parameters, which sets myDate1 to the - current date and time (according to your current system's date and time).
    • -
  • myDate2 calls Date() with the year (2000), month - (0 = January), and day (1) parameters passed to it.
    • -
  • myDate3 calls Date() with the year (65 = 1965), - month (2 = March), the day (6), the hour - (9), the minute (30), the second (15) - and the millisecond-+ (0) passed as parameters.
    • -
  • myDate4 calls Date() with the time value representing the number of milliseconds - before (since the value is negative) 0:00:00 GMT January 1, 1970.
    • -
-
-
-
-package {
-	import flash.display.Sprite;
-	
-	public class DateExample extends Sprite{
-		public function DateExample() {
-			var myDate1:Date = new Date();
-			trace(myDate1); // [NOW]
-
-			var myDate2:Date = new Date(2000, 0, 1);
-			trace(myDate2); // Sat Jan 1 00:00:00 GMT-0800 2000
-
-			var myDate3:Date = new Date(65, 2, 6, 9, 30, 15, 0);
-			trace(myDate3); // Sat Mar 6 09:30:15 GMT-0800 1965
-
-			var myDate4:Date = new Date(-14159025000);
-			trace(myDate4); // Sun Jul 20 19:56:15 GMT-0700 1969
-		}		
-	}	
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/DefinitionError.html b/html-docs/DefinitionError.html deleted file mode 100644 index 1b190b9..0000000 --- a/html-docs/DefinitionError.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - - - - -DefinitionError (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class DefinitionError
InheritanceDefinitionError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The DefinitionError class represents an error that occurs when user code - - attempts to define an identifier that is already defined. This error commonly - - occurs in redefining classes, interfaces, - - and functions. - - - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DefinitionError(message:String = "")
-
- - Creates a new DefinitionError object.
-		DefinitionError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
DefinitionError()constructor
-
-public function DefinitionError(message:String = "") -

- - - - -
Runtime version: AIR 1.0
-

- - Creates a new DefinitionError object. - - - -

Parameters - - - - -
message:String (default = "")
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/Error.html b/html-docs/Error.html deleted file mode 100644 index b010482..0000000 --- a/html-docs/Error.html +++ /dev/null @@ -1,689 +0,0 @@ - - - - - - - - -Error (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
PackageTop Level
Classpublic dynamic class Error
InheritanceError Inheritance Object
SubclassesArgumentError, DefinitionError, DRMManagerError, EvalError, InvalidSWFError, PermissionError, RangeError, ReferenceError, ScriptTimeoutError, SecurityError, SQLError, StackOverflowError, SyntaxError, TypeError, URIError, VerifyError
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The Error class contains information about an error that occurred in a script. In developing ActionScript 3.0 applications, - - when you run your compiled code in the debugger version of a Flash runtime, a dialog box displays exceptions of type Error, - - or of a subclass, to help you troubleshoot the code. - - You create an Error object by using the Error constructor function. - - Typically, you throw a new Error object from within a try - - code block that is caught by a catch code block. - -

You can also create a subclass of the Error class and throw instances of that subclass.

- - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  errorID : int -
[read-only] - - Contains the reference number associated with the specific error message.
-		Error
  message : String -
- - Contains the message associated with the Error object.
-		Error
  name : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Error(message:String = "", id:int = 0)
-
- - Creates a new Error object.
-		Error
   -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
errorIDproperty
-
-errorID:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Contains the reference number associated with the specific error message. For a custom Error object, - - this number is the value from the id parameter supplied in the constructor. - -

Implementation -
-    public function get errorID():int -
-
- - - - - -
messageproperty 
-
-public var message:String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Contains the message associated with the Error object. By default, the value of this property - - is "Error". You can specify a message property when you create an - - Error object by passing the error string to the Error constructor function. - - - -

-See also -

-
-statements.html#throw -
-statements.html#try..catch..finally -
-
- - - - - -
nameproperty 
-
-public var name:String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Contains the name of the Error object. By default, the value of this property is "Error". - - -

-See also -

-
-statements.html#throw -
-statements.html#try..catch..finally -
-
- -
Constructor detail
- - - - - -
Error()constructor
-
-public function Error(message:String = "", id:int = 0) -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new Error object. If message is specified, its value is assigned - - to the object's Error.message property. - - - -

Parameters - - - - - - - - - - -
message:String (default = "") — A string associated with the Error object; this parameter - - is optional. - -
 
id:int (default = 0) — A reference number to associate with the specific error message. - - -
-

-See also -

-
-statements.html#throw -
-statements.html#try..catch..finally -
-
-Example -
The following example creates a new Error object err and then, using the - Error() constructor, assigns the string "New Error Message" to - err. -
-
-
-var err:Error = new Error();
-trace(err.toString());    // Error
-
-err = new Error("New Error Message");
-trace(err.toString());	// Error: New Error Message
-
-

-
- -
Method detail
- - - - - -
getStackTrace()method
-
-public function getStackTrace():String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns the call stack for an error at the time of the error's - - construction as a string. As shown in the following example, the first line of the return value is the - - string representation of the exception object, followed by the stack trace elements: - - - - 

-
-	 TypeError: Error #1009: Cannot access a property or method of a null object reference
-
-	     at com.xyz::OrderEntry/retrieveData()[/src/com/xyz/OrderEntry.as:995]
-
-	     at com.xyz::OrderEntry/init()[/src/com/xyz/OrderEntry.as:200]
-
-	     at com.xyz::OrderEntry()[/src/com/xyz/OrderEntry.as:148]
-
-
- - -

The preceding listing shows the value of this method when called in a - - debugger version of Flash Player or code running in the AIR Debug Launcher - - (ADL). When code runs in a release version of Flash Player or AIR, the - - stack trace is provided without the file path and line number information, - - as in the following example:

- - - - 
-
-	 TypeError: Error #1009: Cannot access a property or method of a null object reference
-
-	     at com.xyz::OrderEntry/retrieveData()
-
-	     at com.xyz::OrderEntry/init()
-
-	     at com.xyz::OrderEntry()
-
-
- - -

For Flash Player 11.4 and earlier and AIR 3.4 and earlier, stack traces - - are only available when code is running in the debugger version of Flash - - Player or the AIR Debug Launcher (ADL). In non-debugger versions of those runtimes, calling this - - method returns null.

- - -

-Returns - - - - -
String — - A string representation of the call stack. - - - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined. - - -

-Returns - - - - -
String — - The error message. - - - - - -
-

-See also -

-
-Error.message -
-statements.html#throw -
-statements.html#try..catch..finally -
-
-Example -
The following example creates a new Error object err and then, using the - Error() constructor, assigns the string "New Error Message" to - err. Finally, the message property is set to "Another New Error Message", - which overwrites "New Error Message". - -
-
-
-var err:Error = new Error();
-trace(err.toString());    // Error
-
-err = new Error("New Error Message");
-trace(err.toString());	// Error: New Error Message
-
-err.message = "Another New Error Message";
-trace(err.toString());	// Error: Another New Error Message
-
-

-
- -
Examples
-
examples\ErrorExample
-
The following example uses the ErrorExample class to show - how a custom error can be generated. This is accomplished with the following - steps: -
    -
  1. A local variable nullArray of Array type is declared, but notice - that a new Array object is never created.
    2. -
  2. The constructor attempts to load a value into the uninitialized array by using - the push() method within an error handling code segment that catches a - custom error by using the CustomError class, which extends Error.
    3. -
  3. When the CustomError is thrown, the constructor catches it and then outputs an - error message by using the trace() statement.
    4. -
-
-
-package
-{
-	import flash.display.Sprite;
-	public class ErrorExample extends Sprite 
-	{
-		private var nullArray:Array;
-		public function ErrorExample() 
-		{
-			try 
-			{
-				nullArray.push("item");
-			}
-			catch(e:Error) 
-			{
-				throw new CustomError("nullArray is null");
-			}
-		}
-	}
-}
-
-class CustomError extends Error 
-{
-	public function CustomError(message:String) 
-	{
-		super(message);
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/EvalError.html b/html-docs/EvalError.html deleted file mode 100644 index 8945066..0000000 --- a/html-docs/EvalError.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - -EvalError (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class EvalError
InheritanceEvalError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The EvalError class represents an error that occurs when user code - - calls the eval() function or attempts to use the new - - operator with the Function object. Calling eval() and - - calling new with the Function object are not supported. - - - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-EvalError(message:String = "")
-
- - Creates a new EvalError object.
-		EvalError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
EvalError()constructor
-
-public function EvalError(message:String = "") -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new EvalError object. - -

Parameters - - - - -
message:String (default = "") — A string associated with the error. - - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/Function.html b/html-docs/Function.html deleted file mode 100644 index 697ec83..0000000 --- a/html-docs/Function.html +++ /dev/null @@ -1,610 +0,0 @@ - - - - - - - - -Function (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class Function
InheritanceFunction Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - A function is the basic unit of code that can be invoked in ActionScript. - - Both user-defined and built-in functions in ActionScript are represented by Function objects, - - which are instances of the Function class. - -

Methods of a class are slightly different than Function objects. Unlike an ordinary function object, a method is tightly linked to its associated class object. Therefore, a method or property has a definition that is shared among all instances of the same class. Methods can be extracted from an instance and treated as "bound" methods (retaining the link to the original instance). For a bound method, the this keyword points to the original object that implemented the method. For a function, this points to the associated object at the time the function is invoked.

- - - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  declaration : String -
[read-only] - - Returns a string representing the function declaration from the source code.
-		Function
  length : int -
[read-only] - - Returns the length of the argument list for this method.
-		Function
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-apply(thisArg:*, argArray:*):* -
-
- - Specifies the value of thisObject to be used within any function that ActionScript calls.
-		Function
   -
-call(thisArg:*, ... args):* -
-
- - Invokes the function represented by a Function object.
-		Function
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
declarationproperty
-
-declaration:String  [read-only]

- - Returns a string representing the function declaration from the source code. - -

This can be used to find out naming and parameter details, and also determine what kind of function - - the object is (anonymous function vs member function, etc).

- - Implementation -
-    AS3 function get declaration():String -
-
- - - - - -
lengthproperty 
-
-length:int  [read-only]

- - Returns the length of the argument list for this method. - -

This can be used to find out how many parameters are expected when calling this function, - - excluding the thisArg value.

- - Implementation -
-    public function get length():int -
-
- -
Method detail
- - - - - -
apply()method
-
-AS3 function apply(thisArg:*, argArray:*):* -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Specifies the value of thisObject to be used within any function that ActionScript calls. - - This method also specifies the parameters to be passed to any called function. Because apply() - - is a method of the Function class, it is also a method of every Function object in ActionScript. - -

The parameters are specified as an Array object, unlike Function.call(), which specifies - - parameters as a comma-delimited list. This is often useful when the number of parameters to be passed is not - - known until the script actually executes.

- -

Returns the value that the called function specifies as the return value.

- - - - - Parameters - - - - - - - - - - -
thisArg:* — The object to which the function is applied. - - -
 
argArray:* — An array whose elements are passed to the function as parameters. - - -
-

-Returns - - - - -
* — Any value that the called function specifies. - - - -
-

-See also -

-
-Function.call() -
-
- - - - - -
call()method 
-
-AS3 function call(thisArg:*, ... args):* -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Invokes the function represented by a Function object. Every function in ActionScript - - is represented by a Function object, so all functions support this method. - -

In almost all cases, the function call (()) operator can be used instead of this method. - - The function call operator produces code that is concise and readable. This method is primarily useful - - when the thisObject parameter of the function invocation needs to be explicitly controlled. - - Normally, if a function is invoked as a method of an object within the body of the function, thisObject - - is set to myObject, as shown in the following example:

- - 
-
-  myObject.myMethod(1, 2, 3);
-
-
- -

In some situations, you might want thisObject to point somewhere else; - - for example, if a function must be invoked as a method of an object, but is not actually stored as a method - - of that object:

- - 
-
-  myObject.myMethod.call(myOtherObject, 1, 2, 3); 
-
-
- -

You can pass the value null for the thisObject parameter to invoke a function as a - - regular function and not as a method of an object. For example, the following function invocations are equivalent:

- - 
-
-  Math.sin(Math.PI / 4)
-
-  Math.sin.call(null, Math.PI / 4)
-
-
- - -

Returns the value that the called function specifies as the return value.

- - - Parameters - - - - - - - - - - -
thisArg:* — An object that specifies the value of thisObject within the function body. - - -
 
... args — The parameter or parameters to be passed to the function. You can specify zero or more parameters. - - -
-

-Returns - - - - -
*
-

-See also -

-
-Function.apply() -
-
- -
Examples
-
examples\FunctionExample
-
The following example uses the FunctionExample, - SimpleCollection, EventBroadcaster, and EventListener classes - to show various uses of functions in ActionScript. This is accomplished with the following steps: -
    -
  1. The constructor for FunctionExample creates a local variable named - simpleColl, which is populated with an array of integers ranging from 1 to - 8.
    2. -
  2. The simpleColl object is printed using trace().
    3. -
  3. An EventListener object, listener, is added to simpleColl.
    4. -
  4. When the insert() and remove() functions are called, the listener responds - to their events.
    5. -
  5. A second SimpleCollection object is created named greaterThanFourColl.
    6. -
  6. The greaterThanFourColl object is assigned the result of simpleColl.select() - with the argument 4 and an anonymous function. The SimpleCollection object's select method is an - internal iterator that uses the anonymous function parameter as a block.
    7. -
-
-
-package {
-	import flash.display.Sprite;
-	
-	public class FunctionExample extends Sprite {
-		public function FunctionExample() {
-			var simpleColl:SimpleCollection;
-			simpleColl = new SimpleCollection(0, 1, 2, 3, 4, 5, 6, 7, 8);
-			trace(simpleColl);		// 0, 1, 2, 3, 4, 5, 6, 7, 8
-
-			var listener:EventListener = new EventListener();
-			simpleColl.addListener(listener);
-			simpleColl.insert(9);		// itemInsertedHandler: 9
-			simpleColl.remove(8);		// itemRemovedHandler: 8
-			trace(simpleColl);		// 0, 1, 2, 3, 4, 5, 6, 7, 9
-
-			var greaterThanFourColl:SimpleCollection;
-			greaterThanFourColl = simpleColl.select(4, function(item:int, value:int){ return item > value });
-			trace(greaterThanFourColl);	// 5, 6, 7, 9
-		}
-	}
-}
-	
-import flash.display.Sprite;
-	
-class EventBroadcaster {
-	private var listeners:Array;
-
-	public function EventBroadcaster() {
-		listeners = new Array();
-	}
-		
-	public function addListener(obj:Object):void {
-		removeListener(obj);
-		listeners.push(obj);
-	}
-		
-	public function removeListener(obj:Object):void {
-		for(var i:uint = 0; i < listeners.length; i++) {
-			if(listeners[i] == obj) {
-				listeners.splice(i, 1);
-			}
-		}
-	}
-	
-	public function broadcastEvent(evnt:String, ...args):void {
-		for(var i:uint = 0; i < listeners.length; i++) {
-			listeners[i][evnt].apply(listeners[i], args);
-		}
-	}	
-}
-	
-class SimpleCollection extends EventBroadcaster {
-	private var arr:Array;
-		public function SimpleCollection(... args) {
-		arr = (args.length == 1 && !isNaN(args[0])) ? new Array(args[0]) : args;
-	}
-		
-	public function insert(obj:Object):void {
-		remove(obj);
-		arr.push(obj);
-		broadcastEvent("itemInsertedHandler", obj);
-	}
-		
-	public function remove(obj:Object):void {
-		for(var i:uint = 0; i < arr.length; i++) {
-			if(arr[i] == obj) {
-				var obj:Object = arr.splice(i, 1)[0];
-				broadcastEvent("itemRemovedHandler", obj);
-			}
-		}
-	}
-
-	public function select(val:int, fn:Function):SimpleCollection {
-		var col:SimpleCollection = new SimpleCollection();
-		for(var i:uint = 0; i < arr.length; i++) {
-			if(fn.call(this, arr[i], val)) {
-				col.insert(arr[i]);
-			}
-		}
-		return col;
-	}
-		
-	public function toString():String {
-		var str:String = new String();
-		for(var i:uint = 0; i < arr.length - 1; i++) {
-			str += arr[i] + ", ";
-		}
-		str += arr[arr.length - 1];
-		return str;
-	}
-}
-
-class EventListener {
-	public function EventListener() {
-	}
-	
-	public function itemInsertedHandler(obj:Object):void {
-		trace("itemInsertedHandler: " + obj);
-	}
-	
-	public function itemRemovedHandler(obj:Object):void {
-		trace("itemRemovedHandler: " + obj);		
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Sat Jan 11 2025, 8:30 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/JSON.html b/html-docs/JSON.html deleted file mode 100644 index 4c1059b..0000000 --- a/html-docs/JSON.html +++ /dev/null @@ -1,651 +0,0 @@ - - - - - - - - -JSON (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class JSON
InheritanceJSON Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 - -
-

-

- - The JSON class lets applications import and export data using JavaScript Object Notation (JSON) format. JSON is an industry-standard data interchange - - format that is described at http://www.json.org. - - -

As a rule, the ActionScript JSON class adheres to the ECMA-262 specification. The following exceptions occur where ActionScript - - provides greater flexibility than ECMAScript:

- - -
    - -

  • Unlike ECMAScript, the ActionScript JSON class encodes the following primitives data types as well as the objects that wrap them:

    - - - - - - - - - - - - -
    Primitive typeWrapper class
    stringString
    numberNumber
    booleanBoolean
    - -
    • - -

  • parse() method: When the argument passed to the reviver parameter is not a function, ActionScript - - throws a TypeError with error ID kJSONInvalidReviver. It also posts a localized error message.

    - -
    • - -

  • stringify() method: When the argument passed to the replacer parameter is neither an array or a function, ActionScript - - throws a TypeError with error ID kJSONInvalidReplacer. It also posts a localized error message.

    - -
    • - -

  • stringify() method: When the argument passed to the space parameter is not a String or a Number, it is converted to a - - String. This string serves as the gap in the output. ECMA-262 requires the gap to be an empty string.

    - -
    • - -

  • stringify() method: When the code encounters a cyclic structure, it throws a TypeError with error ID kJSONCyclicStructure. - - It also posts a localized error message.

    - -
    • - -
  • - -

    ECMA-262 specifies that JSON stringification enumerates the "own properties" of an object, meaning the object's dynamic properties. Because ActionScript classes can also - - declare fixed properties, the ActionScript stringify() method enumerates both dynamic properties and public non-transient properties on ActionScript objects. - - These properties include properties accessed by getters as well as properties accessed directly.

    - -
    • - -
- - -

For most ActionScript classes, the ActionScript JSON.stringify() method generates a default encoding. ActionScript classes can change this - - encoding by defining a toJSON() method in the class or its prototype. For a few ActionScript classes, the default JSON - - encoding is inappropriate. These classes provide a trivial, overridable implementation of toJSON() that returns the value described in the - - following table. You can override or redefine the toJSON() methods on these classes if you require a specific behavior. - - The following table describes these exceptions:

- - - - - - - - - - - - - -
ClassComments
ByteArrayOverridable toJSON() method returns the string "ByteArray".
DictionaryOverridable toJSON() method returns the string "Dictionary".
DateOverridable toJSON() method returns Date.toString(). This exception guarantees that the ActionScript Date constructor can - - parse the JSON string.
XMLOverridable toJSON() method returns the string "XML".
- - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-parse(text:String, reviver:Function = null):Object -
-
[static] - - Accepts a JSON-formatted String and returns an ActionScript Object that represents that value.
-		JSON
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-stringify(value:Object, replacer:* = null, space:* = null):String -
-
[static] - - Returns a String, in JSON format, that represents an ActionScript value.
-		JSON
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Method detail
- - - - - -
parse()method
-
-public static function parse(text:String, reviver:Function = null):Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Accepts a JSON-formatted String and returns an ActionScript Object that represents that value. JSON objects, - - arrays, strings, numbers, Booleans, and null map to corresponding ActionScript values, as shown below: - -

- - - - - - - - - - - - - - - -
JSON typeActionScript type
arrayArray
stringString
numberNumber
booleanBoolean
nullnull
- -

- - -

The reviver parameter is a function that takes two parameters: a key and a value. You can use this - - function to transform or filter each key/value pair as it is parsed. If you supply a reviver function, your transformed - - or filtered value for each pair, rather than the default parsing, is returned in the parse() function output. If - - the reviver function returns undefined for any pair, the property is deleted from the final result. - -

- - -

When the argument passed to the reviver parameter is not a function, ActionScript - - throws a TypeError with error ID kJSONInvalidReviver. It also posts a localized error message.

- - -

If the parse() function encounters duplicate keys within an object, the duplicate key - - encountered last provides the value for all preceding occurrences of that key. - -

- - - Parameters - - - - - - - - - - -
text:String — The JSON string to be parsed - -
 
reviver:Function (default = null) — (Optional) A function that transforms each key/value pair that is parsed - - -
-

-Returns - - - - -
Object
-
- - - - - -
stringify()method 
-
-public static function stringify(value:Object, replacer:* = null, space:* = null):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Returns a String, in JSON format, that represents an ActionScript value. The stringify method can take three parameters. - - -

The value parameter is required. This parameter is an ActionScript value. Typically, it is an Object or Array, - - but it can also be a String, Boolean, Number, or null. - -

- - -

The optional replacer parameter can be either a function or an array of strings or numbers. If it is a function, - - the function takes two parameters: a key and a value. You can use this - - function to transform or filter each key/value pair as it is parsed. If you supply a replacer function, your transformed - - or filtered value for each pair, rather than the default parsing, is returned in the parse() function output. If - - the replacer function returns undefined for any pair, the property is deleted from the final result. If replacer - - is an array, it is used as a filter for designating which properties are included in the output. - -

- - -

When the argument passed to the replacer parameter is neither an array or a function, ActionScript - - throws a TypeError with error ID kJSONInvalidReplacer. It also posts a localized error message.

- - -

The optional space parameter is a String or Number that allows white space to be injected into the returned string to improve human readability. - - Entries in generated JSON objects and JSON arrays are separated by a gap derived from the space parameter. This gap is - - always 0 to 10 characters wide. If space is a string, then the derived gap is the first ten characters of that string. If space - - is a non-negative number x, then the gap is x space characters, to a maximum of ten spaces. - - When the argument passed to the space parameter is not a String a Number, it is converted to a - - String for use as the gap in the output. Execution then proceeds.

- -

When the stringify() method encounters a cyclic structure, it throws a TypeError with error ID kJSONCyclicStructure. It also posts a localized error message.

- - - - Parameters - - - - - - - - - - - - - - - - -
value:Object — The ActionScript value to be converted into a JSON string - -
 
replacer:* (default = null) — (Optional) A function or an array that transforms or filters key/value pairs in the stringify output - -
 
space:* (default = null) — (Optional) A string or number that controls added white space in the returned String - - -
-

-Returns - - - - -
String
-
- -
Examples
-
examples\JSONExample
-
The following example uses the JSONExample class - to show a JSON round-trip in ActionScript. This is accomplished with the following steps: -
    -
  1. The constructor for JSONExample assigns a string to the super-class's text - member and initializes an internal counter.
    2. -
  2. In addition, the class defines an array that can contain JSONExample objects that have been exported to JSON.
    3. -
  3. JSONExample also defines a toJSON() method and a revive() method. The - toJSON() method is called by JSON.stringify() to serialize JSONExample objects to JSON. The - revive() method can be called from JSON.parse() methods to restore the full JSONExample - object. This restoration is achieved by using a given ID to retrieve the original object from the revivable - objects array.
    4. -
  4. The script that uses the class definition creates an object that contains two TextField objects and one JSONExample object. - It also creates a revivable objects array for storing TextField objects that have been exported to JSON.
    5. -
  5. The replacer function of JSON.stringify() filters TextField objects out of the JSON string. In - place of each removed object, replacer provides a marker with an ID that can be used later to retrieve the object. - JSONExample objects, on the other hand, pass through according to their native JSON encoding. -
    6. -
  6. The reviver function of the parse() method recreates the original object by retrieving all - referenced TextField and JSONExample objects. -
    7. -
-
-
- 
- package {
-	import flash.text.TextField;
-	public class JSONExample extends TextField
-	{
-		static var nextId = 10000;
-		static var revivable_objects:Array = [];
-	    	public var id;
-
-		public function JSONExample(s:String){
-			super.text = s;
-			id = ++nextId;
-		}
-		public function toJSON(k):*
-		{
-			// To be called internally by the JSON.stringify() method.
-			// Save the original object internally.
-			// Write out only a generated ID and the text value.
-			revivable_objects[id] = this;
-			return {"classJSONExample":{"reviveId":id,"contents":this.text}};
-		}
-		public static function revive(id:int):JSONExample
-		{
-			// For explicit use in the JSON.parse() method.
-			// Revives the object using the ID obtained from the JSON string.
-			return revivable_objects[id];
-		}
-	}
-}
-
-import flash.text.TextField;
-
-var lastId = 20000;
-var tf1:TextField = new TextField();
-tf1.text = "Lorem ipsum";
-var tf2:TextField = new TextField();
-tf2.text = "Laughing cows";
-var nt:JSONExample = new JSONExample("It was the best of times; it was the worst of times.");
-
-var obj:Object = {a:tf1, b:nt, c:tf2};
-var revivable_objects:Array = new Array();
-
-var json_out = JSON.stringify(obj, function(k,v){
-		if (v is JSONExample)
-		{
-			// Send JSONExample objects to the JSON output.
-			// Note that stringify() calls JSONExample.toJSON() to serialize this object.
-			return v;
-		}
-		if (v is TextField)
-		{
-			// Remove TextField objects from the JSON output.
-			// Save the original object for reviving later.
-			// Return a new object containing an identification marker
-			// and the original object's revival ID.
-			revivable_objects[++lastId] = v;
-			return {"classTextField":{"reviveId":lastId}};
-		}
-		return v;
-	}
-);
-			   
-trace("json_out: " + json_out);
-
-var json_in = JSON.parse(json_out, function(k,v) {
-		if ("classTextField" in v) { // special marker tag from stringify() replacer code
-			// Retrieve the original object based on the ID stored in the stringify() replacer function.
-			var id = v["classTextField"].reviveId;
-			return revivable_objects[id];
-		} else if ("classJSONExample" in v){
-			// Retrieve the original object based on the ID generated in JSONExample.toJSON().
-			return JSONExample.revive(v["classJSONExample"].reviveId);
-		}
-		return v;
-	}
-);
-
-if (json_in.a)
-{
-	if (json_in.a.hasOwnProperty("text"))
-		{
-			trace("json_in.a: " + json_in.a.text);
-		}
-}
-if (json_in.b)
-{
-	if (json_in.b.hasOwnProperty("text"))
-		{
-			trace("json_in.b: " + json_in.b.text);
-		}
-}
-
-if (json_in.c)
-{
-	if (json_in.c.hasOwnProperty("text"))
-		{
-			trace("json_in.c: " + json_in.c.text);
-		}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/Math.html b/html-docs/Math.html deleted file mode 100644 index bf7d58f..0000000 --- a/html-docs/Math.html +++ /dev/null @@ -1,1860 +0,0 @@ - - - - - - - - -Math (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class Math
InheritanceMath Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

-

- - The Math class contains methods and constants that represent common mathematical - - functions and values. - -

Use the methods and properties of this class to access and manipulate mathematical constants and functions. - - All the properties and methods of the Math class are static and must be called using the syntax - - Math.method(parameter) or Math.constant. - - In ActionScript, constants are defined with the maximum precision of double-precision IEEE-754 floating-point numbers.

- -

Several Math class methods use the measure of an angle in radians as a parameter. You can use the following equation - - to calculate radian values before calling the method and then provide the calculated value as the parameter, or you can - - provide the entire right side of the equation (with the angle's measure in degrees in place of degrees) as - - the radian parameter.

- -

To calculate a radian value, use the following formula:

- - 
-
- radians = degrees * Math.PI/180
-
-
- -

To calculate degrees from radians, use the following formula:

- - 
-
- degrees = radians * 180/Math.PI
-
-
- -

The following is an example of passing the equation as a parameter to calculate the sine of a 45° angle:

- -

Math.sin(45 * Math.PI/180) is the same as Math.sin(.7854)

- -

Note: The Math functions acos, asin, atan, atan2, cos, exp, log, pow, sin, and sqrt may - - result in slightly different values depending on the algorithms - - used by the CPU or operating system. Flash runtimes call on the CPU (or operating system if the CPU doesn't support - - floating point calculations) when performing the calculations for the listed functions, and results have shown - - slight variations depending upon the CPU or operating system in use. - -

- - - - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-abs(val:Number):Number -
-
[static] - - Computes and returns an absolute value for the number specified by the - - parameter val.
-		Math
   -
-acos(val:Number):Number -
-
[static] - - Computes and returns the arc cosine of the number specified in the - - parameter val, in radians.
-		Math
   -
-asin(val:Number):Number -
-
[static] - - Computes and returns the arc sine for the number specified in the - - parameter val, in radians.
-		Math
   -
-atan(val:Number):Number -
-
[static] - - Computes and returns the value, in radians, of the angle whose tangent is - - specified in the parameter val.
-		Math
   -
-atan2(y:Number, x:Number):Number -
-
[static] - - Computes and returns the angle of the point y/x in - - radians, when measured counterclockwise from a circle's x axis - - (where 0,0 represents the center of the circle).
-		Math
   -
-ceil(val:Number):Number -
-
[static] - - Returns the ceiling of the specified number or expression.
-		Math
   -
-cos(angleRadians:Number):Number -
-
[static] - - Computes and returns the cosine of the specified angle in radians.
-		Math
   -
-exp(val:Number):Number -
-
[static] - - Returns the value of the base of the natural logarithm (e), to the - - power of the exponent specified in the parameter x.
-		Math
   -
-floor(val:Number):Number -
-
[static] - - Returns the floor of the number or expression specified in the parameter - - val.
-		Math
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-log(val:Number):Number -
-
[static] - - Returns the natural logarithm of the parameter val.
-		Math
   -
-max(val1:Number, val2:Number, ... rest):Number -
-
[static] - - Evaluates val1 and val2 (or more values) and returns the largest value.
-		Math
   -
-min(val1:Number, val2:Number, ... rest):Number -
-
[static] - - Evaluates val1 and val2 (or more values) and returns the smallest value.
-		Math
   -
-pow(base:Number, pow:Number):Number -
-
[static] - - Computes and returns base to the power of pow.
-		Math
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-random():Number -
-
[static] - - Returns a pseudo-random number n, where 0 <= n < 1.
-		Math
   -
-round(val:Number):Number -
-
[static] - - Rounds the value of the parameter val up or down to the nearest - - integer and returns the value.
-		Math
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-sin(angleRadians:Number):Number -
-
[static] - - Computes and returns the sine of the specified angle in radians.
-		Math
   -
-sqrt(val:Number):Number -
-
[static] - - Computes and returns the square root of the specified number.
-		Math
   -
-tan(angleRadians:Number):Number -
-
[static] - - Computes and returns the tangent of the specified angle.
-		Math
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  E : Number = 2.71828182845905
[static] - - A mathematical constant for the base of natural logarithms, expressed as e.
-		Math
  LN10 : Number = 2.302585092994046
[static] - - A mathematical constant for the natural logarithm of 10, expressed as loge10, - - with an approximate value of 2.302585092994046.
-		Math
  LN2 : Number = 0.6931471805599453
[static] - - A mathematical constant for the natural logarithm of 2, expressed as loge2, - - with an approximate value of 0.6931471805599453.
-		Math
  LOG10E : Number = 0.4342944819032518
[static] - - A mathematical constant for the base-10 logarithm of the constant e (Math.E), - - expressed as log10e, with an approximate value of 0.4342944819032518.
-		Math
  LOG2E : Number = 1.442695040888963387
[static] - - A mathematical constant for the base-2 logarithm of the constant e, expressed - - as log2e, with an approximate value of 1.442695040888963387.
-		Math
  PI : Number = 3.141592653589793
[static] - - A mathematical constant for the ratio of the circumference of a circle to its diameter, - - expressed as pi, with a value of 3.141592653589793.
-		Math
  SQRT1_2 : Number = 0.7071067811865476
[static] - - A mathematical constant for the square root of one-half, with an approximate - - value of 0.7071067811865476.
-		Math
  SQRT2 : Number = 1.4142135623730951
[static] - - A mathematical constant for the square root of 2, with an approximate - - value of 1.4142135623730951.
-		Math
-
- -
- -
Method detail
- - - - - -
abs()method
-
-public static function abs(val:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Computes and returns an absolute value for the number specified by the - - parameter val. - - -

Parameters - - - - -
val:Number — The number whose absolute value is returned. - -
-

-Returns - - - - -
Number — - The absolute value of the specified parameter. - - - - -
-
- - - - - -
acos()method 
-
-public static function acos(val:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Computes and returns the arc cosine of the number specified in the - - parameter val, in radians. - - -

Parameters - - - - -
val:Number — A number from -1.0 to 1.0. - - -
-

-Returns - - - - -
Number — - The arc cosine of the parameter val. - - - - -
-
- - - - - -
asin()method 
-
-public static function asin(val:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Computes and returns the arc sine for the number specified in the - - parameter val, in radians. - - -

Parameters - - - - -
val:Number — A number from -1.0 to 1.0. - - -
-

-Returns - - - - -
Number — - A number between negative pi divided by 2 and positive pi - - divided by 2. - - - - -
-
- - - - - -
atan()method 
-
-public static function atan(val:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Computes and returns the value, in radians, of the angle whose tangent is - - specified in the parameter val. The return value is between - - negative pi divided by 2 and positive pi divided by 2. - - -

Parameters - - - - -
val:Number — A number that represents the tangent of an angle. - - -
-

-Returns - - - - -
Number — - A number between negative pi divided by 2 and positive - - pi divided by 2. - - - - -
-
- - - - - -
atan2()method 
-
-public static function atan2(y:Number, x:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Computes and returns the angle of the point y/x in - - radians, when measured counterclockwise from a circle's x axis - - (where 0,0 represents the center of the circle). The return value is between - - positive pi and negative pi. Note that the first parameter to atan2 is always the y coordinate. - - -

Parameters - - - - - - - - - - -
y:Number — The y coordinate of the point. - -
 
x:Number — The x coordinate of the point. - - -
-

-Returns - - - - -
Number — - A number. - - - - -
-

-See also -

-
-Math.acos() -
-Math.asin() -
-Math.atan() -
-Math.cos() -
-Math.sin() -
-Math.tan() -
-
- - - - - -
ceil()method 
-
-public static function ceil(val:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Returns the ceiling of the specified number or expression. The ceiling of a - - number is the closest integer that is greater than or equal to the number. - - -

Parameters - - - - -
val:Number — A number or expression. - -
-

-Returns - - - - -
Number — - An integer that is both closest to, and greater than or equal to, the parameter - - val. - - - - - -
-

-See also -

-
-Math.floor() -
-Math.round() -
-
- - - - - -
cos()method 
-
-public static function cos(angleRadians:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Computes and returns the cosine of the specified angle in radians. To - - calculate a radian, see the overview of the Math class. - - - - -

Parameters - - - - -
angleRadians:Number — A number that represents an angle measured in radians. - -
-

-Returns - - - - -
Number — - A number from -1.0 to 1.0. - - - - -
-

-See also -

-
-Math.acos() -
-Math.asin() -
-Math.atan() -
-Math.atan2() -
-Math.sin() -
-Math.tan() -
-
- - - - - -
exp()method 
-
-public static function exp(val:Number):Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the value of the base of the natural logarithm (e), to the - - power of the exponent specified in the parameter x. The - - constant Math.E can provide the value of e. - - -

Parameters - - - - -
val:Number — The exponent; a number or expression. - -
-

-Returns - - - - -
Number — - e to the power of the parameter val. - - - - -
-

-See also -

-
-Math.E -
-
- - - - - -
floor()method 
-
-public static function floor(val:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Returns the floor of the number or expression specified in the parameter - - val. The floor is the closest integer that is less than or equal - - to the specified number or expression. - - -

Parameters - - - - -
val:Number — A number or expression. - -
-

-Returns - - - - -
Number — - The integer that is both closest to, and less than or equal to, the parameter - - val. - - - - -
-
- - - - - -
log()method 
-
-public static function log(val:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Returns the natural logarithm of the parameter val. - - -

Parameters - - - - -
val:Number — A number or expression with a value greater than 0. - -
-

-Returns - - - - -
Number — - The natural logarithm of parameter val. - - - - -
-
- - - - - -
max()method 
-
-public static function max(val1:Number, val2:Number, ... rest):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Evaluates val1 and val2 (or more values) and returns the largest value. - - -

Parameters - - - - - - - - - - - - - - - - -
val1:Number — A number or expression. - -
 
val2:Number — A number or expression. - -
 
... rest — A number or expression. Math.max() can accept multiple arguments. - -
-

-Returns - - - - -
Number — - The largest of the parameters val1 and val2 (or more values). - - - - -
-

-See also -

-
-Math.min() -
-
- - - - - -
min()method 
-
-public static function min(val1:Number, val2:Number, ... rest):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Evaluates val1 and val2 (or more values) and returns the smallest value. - - -

Parameters - - - - - - - - - - - - - - - - -
val1:Number — A number or expression. - -
 
val2:Number — A number or expression. - -
 
... rest — A number or expression. Math.min() can accept multiple arguments. - -
-

-Returns - - - - -
Number — - The smallest of the parameters val1 and val2 (or more values). - - - - -
-

-See also -

-
-Math.max() -
-
- - - - - -
pow()method 
-
-public static function pow(base:Number, pow:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Computes and returns base to the power of pow. - - -

Parameters - - - - - - - - - - -
base:Number — A number to be raised by the power of the parameter pow. - -
 
pow:Number — A number specifying the power that the parameter base is raised by. - -
-

-Returns - - - - -
Number — - The value of base raised to the power of pow. - - - - -
-
- - - - - -
random()method 
-
-public static function random():Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Returns a pseudo-random number n, where 0 <= n < 1. The number returned is calculated in an undisclosed manner, and is "pseudo-random" because the calculation inevitably contains some element of non-randomness. - - -

-Returns - - - - -
Number — - A pseudo-random number. - - - - -
-

-See also -

-
flash.crypto.generateRandomBytes()
-
- - - - - -
round()method 
-
-public static function round(val:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Rounds the value of the parameter val up or down to the nearest - - integer and returns the value. If val is equidistant - - from its two nearest integers (that is, if the number ends in .5), the value - - is rounded up to the next higher integer. - - -

Parameters - - - - -
val:Number — The number to round. - -
-

-Returns - - - - -
Number — - The parameter val rounded to the nearest whole number. - - - - -
-

-See also -

-
-Math.ceil() -
-Math.floor() -
-
- - - - - -
sin()method 
-
-public static function sin(angleRadians:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Computes and returns the sine of the specified angle in radians. To - - calculate a radian, see the overview of the Math class. - - - - -

Parameters - - - - -
angleRadians:Number — A number that represents an angle measured in radians. - -
-

-Returns - - - - -
Number — - A number; the sine of the specified angle (between -1.0 and 1.0). - - - - -
-

-See also -

-
-Math.acos() -
-Math.asin() -
-Math.atan() -
-Math.atan2() -
-Math.cos() -
-Math.tan() -
-
- - - - - -
sqrt()method 
-
-public static function sqrt(val:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Computes and returns the square root of the specified number. - - -

Parameters - - - - -
val:Number — A number or expression greater than or equal to 0. - -
-

-Returns - - - - -
Number — - If the parameter val is greater than or equal to zero, a number; otherwise NaN (not a number). - - - - -
-
- - - - - -
tan()method 
-
-public static function tan(angleRadians:Number):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Computes and returns the tangent of the specified angle. To calculate a - - radian, see the overview of the Math class. - - - -

Parameters - - - - -
angleRadians:Number — A number that represents an angle measured in radians. - -
-

-Returns - - - - -
Number — - The tangent of the parameter angleRadians. - - - - -
-

-See also -

-
-Math.acos() -
-Math.asin() -
-Math.atan() -
-Math.atan2() -
-Math.cos() -
-Math.sin() -
-
- -
Constant detail
- - - - - -
Econstant
-
-public static const E:Number = 2.71828182845905 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - A mathematical constant for the base of natural logarithms, expressed as e. - - The approximate value of e is 2.71828182845905. - - -

- - - - - -
LN10constant 
-
-public static const LN10:Number = 2.302585092994046 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - A mathematical constant for the natural logarithm of 10, expressed as loge10, - - with an approximate value of 2.302585092994046. - - -

- - - - - -
LN2constant 
-
-public static const LN2:Number = 0.6931471805599453 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - A mathematical constant for the natural logarithm of 2, expressed as loge2, - - with an approximate value of 0.6931471805599453. - - -

- - - - - -
LOG10Econstant 
-
-public static const LOG10E:Number = 0.4342944819032518 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - A mathematical constant for the base-10 logarithm of the constant e (Math.E), - - expressed as log10e, with an approximate value of 0.4342944819032518. - -

The Math.log() method computes the natural logarithm of a number. Multiply the - - result of Math.log() by Math.LOG10E to obtain the base-10 logarithm.

- - -
- - - - - -
LOG2Econstant 
-
-public static const LOG2E:Number = 1.442695040888963387 -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A mathematical constant for the base-2 logarithm of the constant e, expressed - - as log2e, with an approximate value of 1.442695040888963387. - - -

The Math.log method computes the natural logarithm of a number. Multiply the - - result of Math.log() by Math.LOG2E to obtain the base-2 logarithm.

- - -
- - - - - -
PIconstant 
-
-public static const PI:Number = 3.141592653589793 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - A mathematical constant for the ratio of the circumference of a circle to its diameter, - - expressed as pi, with a value of 3.141592653589793. - - -

- - - - - -
SQRT1_2constant 
-
-public static const SQRT1_2:Number = 0.7071067811865476 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - A mathematical constant for the square root of one-half, with an approximate - - value of 0.7071067811865476. - - -

- - - - - -
SQRT2constant 
-
-public static const SQRT2:Number = 1.4142135623730951 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - A mathematical constant for the square root of 2, with an approximate - - value of 1.4142135623730951. - - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/Namespace.html b/html-docs/Namespace.html deleted file mode 100644 index 8241a36..0000000 --- a/html-docs/Namespace.html +++ /dev/null @@ -1,852 +0,0 @@ - - - - - - - - -Namespace (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class Namespace
InheritanceNamespace Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - -The Namespace class contains methods and properties for defining and working with namespaces. - -There are three scenarios for using namespaces: - - -
    - -
  • Namespaces of XML objects Namespaces associate a namespace prefix with a Uniform Resource Identifier (URI) - -that identifies the namespace. The prefix is a string used to reference the namespace within an - -XML object. If the prefix is undefined, when the XML is converted to a string, a prefix is - -automatically generated. - -
    • - - - -
  • Namespace to differentiate methods Namespaces can differentiate methods with the same name to perform different tasks. - -If two methods have the same name but separate namespaces, they can perform different tasks. - -
    • - - - -
  • Namespaces for access control - -Namespaces can be used to control access to a group of - -properties and methods in a class. If you place the - -properties and methods into a private - -namespace, they are - -inaccessible to any code that does not have access to - -that namespace. You can grant access to the group of - -properties and methods by passing the namespace to - -other classes, methods or functions. - -
    • - -
- - - -

This class shows two forms of the constructor method because each form accepts - -different parameters.

- - -

This class (along with the XML, XMLList, and QName classes) implements - -powerful XML-handling standards defined in ECMAScript for XML - -(E4X) specification (ECMA-357 edition 2).

- - - -

-

-View the examples. -

-

-See also -

-
-XML -
-XMLList -
-QName -
-ECMAScript for XML (E4X) specification (ECMA-357 edition 2) -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  prefix : String -
- - The prefix of the namespace.
-		Namespace
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  uri : String -
- - The Uniform Resource Identifier (URI) of the namespace.
-		Namespace
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Namespace(uriValue:*)
-
- - Creates a Namespace object.
-		Namespace
   -
-Namespace(prefixValue:*, uriValue:*)
-
- - Creates a Namespace object according to the values of the prefixValue and uriValue parameters.
-		Namespace
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Equivalent to the Namespace.uri property.
-		Namespace
   -
-valueOf():String -
-
- - Returns the URI value of the specified object.
-		Namespace
-
- -
- -
Property detail
- - - - - -
prefixproperty
-
-prefix:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The prefix of the namespace. - - - -

Implementation -
-    public function get prefix():String -
-    public function set prefix(value:String):void -
-
- - - - - -
uriproperty 
-
-uri:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The Uniform Resource Identifier (URI) of the namespace. - - - -

Implementation -
-    public function get uri():String -
-    public function set uri(value:String):void -
-
- -
Constructor detail
- - - - - -
Namespace()constructor
-
-public function Namespace(uriValue:*) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Creates a Namespace object. - - The values assigned to the uri and prefix properties - - of the new Namespace object depend on the type of value passed for the uriValue parameter: - -

    - -
  • If no value is passed, the prefix and uri properties are set to an empty string.
    • - -
  • If the value is a Namespace object, a copy of the object is created.
    • - -
  • If the value is a QName object, the uri property is set to the uri property of the QName object.
    • - -
- -

Note: This class shows two constructor entries because each form accepts - - different parameters. The constructor behaves differently depending on the type and number of - - parameters passed, as detailed in each entry. ActionScript 3.0 does not support method or constructor overloading.

- - - - Parameters - - - - -
uriValue:* — The Uniform Resource Identifier (URI) of the namespace. - - - - -
-
- - - - - -
Namespace()constructor 
-
-public function Namespace(prefixValue:*, uriValue:*) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Creates a Namespace object according to the values of the prefixValue and uriValue parameters. - - This constructor requires both parameters. - -

The value of the prefixValue parameter is assigned to the prefix - - property as follows:

- -
    - -
  • If undefined is passed, prefix is set to undefined.
    • - -
  • If the value is a valid XML name, as determined by the isXMLName() function, it is converted to a string and assigned to the prefix property.
    • - -
  • If the value is not a valid XML name, the prefix property is set to undefined.
    • - -
- - -

The value of the uriValue parameter is assigned to the uri - - property as follows:

- -
    - -
  • If a QName object is passed, the uri property is set to the value of the QName object's uri property.
    • - -
  • Otherwise, the uriValue parameter is converted to a string and assigned to the uri property.
    • - -
- -

Note: This class shows two constructor method entries because each form accepts - - different parameters. The constructor behaves differently depending on the type and number of - - arguments passed, as detailed in each entry. ActionScript 3.0 does not support method or constructor overloading.

- - - - Parameters - - - - - - - - - - -
prefixValue:* — The prefix to use for the namespace. - - -
 
uriValue:* — The Uniform Resource Identifier (URI) of the namespace. - - - - -
-
- -
Method detail
- - - - - -
toString()method
-
-AS3 function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Equivalent to the Namespace.uri property. - - - -

-Returns - - - - -
String — - The Uniform Resource Identifier (URI) of the namespace, as a string. - - - - - - -
-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns the URI value of the specified object. - - - -

-Returns - - - - -
String — - The Uniform Resource Identifier (URI) of the namespace, as a string. - - - - - - -
-
- -
Examples
-
examples\NamespaceExample
-
The following example shows how to work with namespaces defined in XML objects. - This is accomplished with the following steps: -
    -
  1. The example defines three Namespace objects, each with a unique URI that defines a namespace.
    2. -
  2. The example defines an XML variable named myXML and assigns it to the return value of - getRSS(). The getRSS() method defines an XML object that contains several namespaces - and returns that XML object.
    3. -
  3. The example declares and evaluates an Array variable by calling the parseRSS() method with - myXML passed to it. In parseRSS(), the default XML namespace is defined as - rss and the example defines an XMLList variable by assigning the list of item - objects in myXML. An array is created and populated with various nodes within - myXML.item. The array is then returned.
    4. -
  4. The elements in the array are printed using a for loop and three calls to - trace().
    5. -
-
-
-package {
-	import flash.display.Sprite;
-
-	public class NamespaceExample extends Sprite {
-		private var rss:Namespace = new Namespace("http://purl.org/rss/1.0/");
-		private var rdf:Namespace = new Namespace("http://www.w3.org/1999/02/22-rdf-syntax-ns#");
-		private var dc:Namespace  = new Namespace("http://purl.org/dc/elements/1.1/");
-
-		public function NamespaceExample() {
-			var myXML:XML = getRSS();
-			var rssItems:Array = parseRSS(myXML);
-			
-			var len:uint = rssItems.length;
-			for (var i:uint; i < len; i++) {
-				trace(rssItems[i].title);
-				trace(rssItems[i].creator);
-				trace(rssItems[i].date);
-				// Adobe Flash Developer Center
-				// Adobe
-				// 2005-08-08
-				// Flex Developer Center
-				// Adobe
-				// 2005-10-16				
-			}
-		}
-		
-		private function parseRSS(rssXML:XML):Array {
-			default xml namespace = rss;
-
-			var items:XMLList = rssXML.item;
-
-			var arr:Array = new Array();			
-			var len:uint = items.length();
-			for (var i:uint; i < len; i++) {
-				arr.push({title:items[i].title, creator:items[i].dc::creator, date:items[i].dc::date});
-			}
-			
-			return arr;
-		}
-
-		private function getRSS():XML {
-			var myXML:XML =  <rdf:RDF
-			  xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-			  xmlns="http://purl.org/rss/1.0/"
-			  xmlns:dc="http://purl.org/dc/elements/1.1/"
-			>
-			  <channel rdf:about="http://www.xml.com/cs/xml/query/q/19">
-			    <title>Test RSS</title>
-			    <link>http://www.adobe.com/</link>
-			    <description>This is a test RSS document.</description>
-			    <language>en-us</language>
-			    <items>
-			      <rdf:Seq>
-				<rdf:li rdf:resource="http://www.adobe.com/devnet/flash/"/>
-				<rdf:li rdf:resource="http://www.adobe.com/devnet/flex/"/>
-			      </rdf:Seq>
-			    </items>
-			  </channel>
-			  <item rdf:about="http://www.adobe.com/devnet/flash/">
-			    <title>Adobe Flash Developer Center</title>
-			    <link>http://www.adobe.com/devnet/flash/</link>
-			    <description>Welcome to the Flash Developer Center</description>
-			    <dc:creator>Adobe</dc:creator>
-			    <dc:date>2005-08-08</dc:date>    
-			  </item>
-			  <item rdf:about="http://www.adobe.com/devnet/flex/">
-			    <title>Flex Developer Center</title>
-			    <link>http://www.adobe.com/devnet/flex/</link>
-			    <description>Welcome to the Flex Developer Center</description>
-			    <dc:creator>Adobe</dc:creator>
-			    <dc:date>2005-10-16</dc:date>    
-			  </item>
-			</rdf:RDF>;
-			
-			return myXML;
-		}
-	}
-}
-
-
-
examples\Namespace_2_Example
-
The following example shows how namespaces can be used to differentiate methods that have - the same name but perform different tasks. In this example, three methods named hello() - reside in separate namespaces; each returns a different string when called. -
-
-package {
-
-    import flash.display.Sprite;
-
-	public class Namespace_2_Example extends Sprite {	
-		public function Namespace_2_Example() {
-			var vocab:MultilingualVocabulary = new MultilingualVocabulary();
-
-			trace(vocab.hello());	// hello
-			
-			var languages:Array = vocab.getLanguages();
-			
-			for (var i:uint; i < languages.length; i++) {
-				var ns:Namespace = languages[i];
-				if (ns != null) {
-					trace(ns.toString() + ": " + vocab.ns::hello());
-					// hello
-					// MultilingualVocabulary:Hawaiian: aloha
-					// MultilingualVocabulary:French: bon jour
-				}
-			}
-		}
-	}	
-}
-
-class MultilingualVocabulary {
-	public namespace French;
-	public namespace Hawaiian;
-	private var languages:Array;
-
-	public function MultilingualVocabulary() {
-		languages = new Array(Hawaiian, French);
-	}
-		
-	public function hello():String { 
-		return "hello";
-	}
-
-	Hawaiian function hello():String {
-		return "aloha";
-	}
-
-	French function hello():String { 
-		return "bon jour";
-	}
-		
-	public function getLanguages():Array {
-		return languages;
-	}
-}
-
-
-
examples\Namespace_3_Example
-
The following example uses namespace names to select an appropriate - variable value. It shows how you can store a namespace value in a variable and use - that variable to refer to objects within that namespace. -

The example defines namespaces and colors that correspond to mouse - states for a rectangular button. Each time the button is drawn, the example applies - the appropriate color (out is red; over is yellow; down is white) by referencing the bgcolor - variable for the corresponding namespace (out, over, down).

-
-
-package {
-    import flash.display.Sprite;
-  
-	public class Namespace_3_Example extends Sprite {     
-		public function Namespace_3_Example() {
-			addChild(new StateButton("Press Me."));
-		}
-	}
-}
-
-import flash.display.Sprite;
-import flash.text.TextField;
-import flash.events.Event;
-import flash.events.MouseEvent;
-
-class StateButton extends Sprite{
-	private namespace out;
-	private namespace over;
-	private namespace down;
-	private var label:TextField;
-	private var labelTxt:String;
-	private var ns:Namespace;
-	out var bgColor:Number = 0xFF0000;
-	over var bgColor:Number = 0xFFFF00;
-	down var bgColor:Number = 0xFFFFFF;
-      
-	public function StateButton(str:String) {
-		buttonMode = true;
-		labelTxt = str;
-		ns = out;
-		draw();
-		addLabel();
-		addListeners();
-	}
-
-	private function addLabel():void {
-		label = new TextField();
-		label.text = labelTxt;
-		label.width = 50;
-		label.height = 20;
-		label.mouseEnabled = false;
-		addChild(label);
-	}
-      
-	private function addListeners():void {
-		addEventListener(MouseEvent.MOUSE_UP, mouseOverHandler);
-		addEventListener(MouseEvent.MOUSE_OUT, mouseOutHandler);
-		addEventListener(MouseEvent.MOUSE_OVER, mouseOverHandler);
-		addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
-	}
- 
-	private function mouseOutHandler(e:Event):void {
-		ns = out;
-		draw();
-	}
- 
-	private function mouseOverHandler(e:Event):void {
-		ns = over;
-		draw();
-	}
- 
-	private function mouseDownHandler(e:Event):void {
-		ns = down;
-		draw();
-	}
- 
-	private function draw():void {
-		this.graphics.clear();
-		this.graphics.beginFill(ns::bgColor);
-		this.graphics.drawRect(0, 0, 60, 20);
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/Number.html b/html-docs/Number.html deleted file mode 100644 index 845e5f3..0000000 --- a/html-docs/Number.html +++ /dev/null @@ -1,905 +0,0 @@ - - - - - - - - -Number (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class Number
InheritanceNumber Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

-

- - A data type representing an IEEE-754 double-precision floating-point number. You can manipulate primitive numeric - - values by using the methods and properties associated with the Number class. This class is identical to the - - JavaScript Number class. - -

The properties of the Number class are static, which means you do not need an object to use them, so you - - do not need to use the constructor.

- -

The Number data type adheres to the double-precision IEEE-754 standard.

- -

The Number data type is useful when you need to use floating-point values. - - Flash runtimes handle int and uint data types more efficiently than Number, but Number is - - useful in situations where the range of values required exceeds the valid range - - of the int and uint data types. The Number class can be used to - - represent integer values well beyond the valid range of the int and uint data types. - - The Number data type can use up to 53 bits to represent integer values, compared to - - the 32 bits available to int and uint. The default value of a variable typed as Number is NaN (Not a Number).

- - - -

-

-View the examples. -

-

-See also -

-
-int -
-uint -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Number(num:Object)
-
- - Creates a Number object with the specified value.
-		Number
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-toExponential(fractionDigits:uint):String -
-
- - Returns a string representation of the number in exponential notation.
-		Number
   -
-toFixed(fractionDigits:uint):String -
-
- - Returns a string representation of the number in fixed-point notation.
-		Number
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toPrecision(precision:uint):String -
-
- - Returns a string representation of the number either in exponential notation or in - - fixed-point notation.
-		Number
   -
-toString(radix:Number = 10):String -
-
- - Returns the string representation of the specified Number object (myNumber).
-		Number
   -
-valueOf():Number -
-
- - Returns the primitive value type of the specified Number object.
-		Number
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  MAX_VALUE : Number -
[static] - - The largest representable number (double-precision IEEE-754).
-		Number
  MIN_VALUE : Number -
[static] - - The smallest (closest to zero, not most negative) representable IEEE-754 number that does not compare equal to zero.
-		Number
  NaN : Number -
[static] - - The IEEE-754 value representing Not a Number (NaN).
-		Number
  NEGATIVE_INFINITY : Number -
[static] - - Specifies the IEEE-754 value representing negative infinity.
-		Number
  POSITIVE_INFINITY : Number -
[static] - - Specifies the IEEE-754 value representing positive infinity.
-		Number
-
- -
- -
Constructor detail
- - - - - -
Number()constructor
-
-public function Number(num:Object) -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Creates a Number object with the specified value. This constructor has the same effect - - as the Number() public native function that converts an object of a different type - - to a primitive numeric value. - - -

Parameters - - - - -
num:Object — The numeric value of the Number instance being created or a value - - to be converted to a Number. The default value is 0 if num is - - not specified. Using the constructor without specifying a num parameter is not - - the same as declaring a variable of type Number with no value assigned (such as var myNumber:Number), which - - defaults to NaN. A number with no value assigned is undefined and the equivalent of - - new Number(undefined). - - -
-

-See also -

-
-Number.toString() -
-Number.valueOf() -
-
- -
Method detail
- - - - - -
toExponential()method
-
-AS3 function toExponential(fractionDigits:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a string representation of the number in exponential notation. The string contains - - one digit before the decimal point and up to 20 digits after the decimal point, as - - specified by the fractionDigits parameter. - -

Parameters - - - - -
fractionDigits:uint — An integer between 0 and 20, inclusive, that represents the desired number of decimal places. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the fractionDigits argument is outside the range 0 to 20. - -
-
-Example -
The following example shows how toExponential(2) returns a string in - exponential notation. -
-
-
-var num:Number = 315003;
-trace(num.toExponential(2)); // 3.15e+5
-
-

-
- - - - - -
toFixed()method 
-
-AS3 function toFixed(fractionDigits:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a string representation of the number in fixed-point notation. - - Fixed-point notation means that the string will contain a specific number of digits - - after the decimal point, as specified in the fractionDigits parameter. - - The valid range for the fractionDigits parameter is from 0 to 20. - - Specifying a value outside this range throws an exception. - - -

Parameters - - - - -
fractionDigits:uint — An integer between 0 and 20, inclusive, that represents the desired number of decimal places. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the fractionDigits argument is outside the range 0 to 20. - -
-
-Example -
The following example shows how toFixed(3) returns a string that rounds - to three decimal places. -
-
-
-var num:Number = 7.31343;
-trace(num.toFixed(3)); // 7.313
-
-

The following example shows how toFixed(2) returns a string that adds - trailing zeroes. -
-
-
-var num:Number = 4;
-trace(num.toFixed(2)); // 4.00
-
-

-
- - - - - -
toPrecision()method 
-
-AS3 function toPrecision(precision:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a string representation of the number either in exponential notation or in - - fixed-point notation. The string will contain the number of digits specified in the - - precision parameter. - -

Parameters - - - - -
precision:uint — An integer between 1 and 21, inclusive, that represents the desired number of digits to represent in the resulting string. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the precision argument is outside the range 1 to 21. - -
-
-Example -
The following example shows how toPrecision(3) returns a string with - only three digits. The string is in fixed-point notation because exponential notation is not required. -
-
-
-var num:Number = 31.570;
-trace(num.toPrecision(3)); // 31.6
-
-

The following example shows how toPrecision(3) returns a string with - only three digits. The string is in exponential notation because the resulting number does not - contain enough digits for fixed-point notation. -
-
-
-var num:Number = 4000;
-trace(num.toPrecision(3)); // 4.00e+3
-
-

-
- - - - - -
toString()method 
-
-AS3 function toString(radix:Number = 10):String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Returns the string representation of the specified Number object (myNumber). - - If the value of the Number object is a decimal number without a leading zero (such as .4), - - Number.toString() adds a leading zero (0.4). - - - -

Parameters - - - - -
radix:Number (default = 10) — Specifies the numeric base (from 2 to 36) to use for the number-to-string - - conversion. If you do not specify the radix parameter, the default value - - is 10. - - -
-

-Returns - - - - -
String — - The numeric representation of the Number object as a string. - - - - -
-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Returns the primitive value type of the specified Number object. - - -

-Returns - - - - -
Number — - The primitive type value of the Number object. - - - - -
-
- -
Constant detail
- - - - - -
MAX_VALUEconstant
-
-public static const MAX_VALUE:Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - The largest representable number (double-precision IEEE-754). This number is - - approximately 1.79e+308. - - -

- - - - - -
MIN_VALUEconstant 
-
-public static const MIN_VALUE:Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - The smallest (closest to zero, not most negative) representable IEEE-754 number that does not compare equal to zero. On most platforms this number is approximately 5e-324, but it can be larger on systems that do not support denormalized numbers. For example, on iOS this constant's value is 2.225e-308. - - - -

Note: The absolute smallest representable number overall is -Number.MAX_VALUE.

- - -
- - - - - -
NaNconstant 
-
-public static const NaN:Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - The IEEE-754 value representing Not a Number (NaN). - - -

-See also -

-
-isNaN() global function -
-
- - - - - -
NEGATIVE_INFINITYconstant 
-
-public static const NEGATIVE_INFINITY:Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Specifies the IEEE-754 value representing negative infinity. The value of this property - - is the same as that of the constant -Infinity. - -

- - Negative infinity is a special numeric value that is returned when a mathematical - - operation or function returns a negative value larger than can be - - represented. - -

- - -
- - - - - -
POSITIVE_INFINITYconstant 
-
-public static const POSITIVE_INFINITY:Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Specifies the IEEE-754 value representing positive infinity. The value of this property - - is the same as that of the constant Infinity. - -

- - Positive infinity is a special numeric value that is returned when a mathematical - - operation or function returns a value larger than can be represented. - -

- - -
- -
Examples
-
examples\NumberExample
-
The following example shows how a number with six digits after the decimal place - is truncated (with rounding) to a number with two digits after the decimal point. -
-
-
-package {
-    import flash.display.Sprite;
-
-	public class NumberExample extends Sprite {
-		public function NumberExample() {
-			var num:Number = new Number(10.456345);
-			var str:String = num.toFixed(2);
-			trace(num); // 10.456345
-			trace(str); // 10.46
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/Object.html b/html-docs/Object.html deleted file mode 100644 index f5a58a1..0000000 --- a/html-docs/Object.html +++ /dev/null @@ -1,992 +0,0 @@ - - - - - - - - -Object (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class Object
SubclassesAccessibility, AccessibilityImplementation, AccessibilityProperties, ActionScriptVersion, AntiAliasType, ApplicationDomain, arguments, Array, AudioDecoder, AudioOutputChangeReason, AudioPlaybackMode, AuthenticationMethod, AutoCapitalize, BitmapData, BitmapDataChannel, BitmapEncodingColorSpace, BitmapFilter, BitmapFilterQuality, BitmapFilterType, BlendMode, Boolean, BreakOpportunity, ByteArray, CameraPosition, CameraRollBrowseOptions, Capabilities, CapsStyle, CertificateStatus, CFFHinting, Class, Clipboard, ClipboardFormats, ClipboardTransferMode, Collator, CollatorMode, ColorCorrection, ColorCorrectionSupport, ColorTransform, CompositionAttributeRange, CompressionAlgorithm, Condition, ContentElement, Context3DBlendFactor, Context3DBufferUsage, Context3DClearMask, Context3DCompareMode, Context3DFillMode, Context3DMipFilter, Context3DProfile, Context3DProgramType, Context3DRenderMode, Context3DStencilAction, Context3DTextureFilter, Context3DTextureFormat, Context3DTriangleFace, Context3DVertexBufferFormat, Context3DWrapMode, ContextMenuBuiltInItems, ContextMenuClipboardItems, CSMSettings, CurrencyFormatter, CurrencyParseResult, Date, DateTimeFormatter, DateTimeNameContext, DateTimeNameStyle, DateTimeStyle, Dictionary, Digest, DigitCase, DigitWidth, DisplacementMapFilterMode, DRMContentData, DRMDeviceGroup, DRMPlaybackTimeWindow, DRMVoucher, ElementFormat, EncryptedLocalStore, Encryption, Endian, Error, Event, EventDispatcher, EventPhase, ExtensionInfo, ExternalInterface, FileFilter, FileMode, float, FocusDirection, Font, FontDescription, FontLookup, FontMetrics, FontPosture, FontStyle, FontType, FontWeight, Function, GameInputDevice, GesturePhase, GradientType, Graphics, GraphicsBitmapFill, GraphicsEndFill, GraphicsGradientFill, GraphicsPath, GraphicsPathCommand, GraphicsPathWinding, GraphicsShaderFill, GraphicsSolidFill, GraphicsStroke, GraphicsTrianglePath, GridFitType, GroupSpecifier, H264Level, H264Profile, HTMLHistoryItem, HTMLHost, HTMLPDFCapability, HTMLSWFCapability, HTMLWindowCreateOptions, ID3Info, ImageDecodingPolicy, IMEConversionMode, IndexBuffer3D, int, InterfaceAddress, InterpolationMethod, InvokeEventReason, IPVersion, JointStyle, JPEGEncoderOptions, JPEGXREncoderOptions, JSON, JustificationStyle, Kerning, Keyboard, KeyboardType, KeyLocation, LastOperationStatus, LigatureLevel, LineJustification, LineScaleMode, LoaderContext, LoadVoucherSetting, LocaleID, Math, Matrix, Matrix3D, MediaType, MessageChannelState, MicrophoneEnhancedMode, MicrophoneEnhancedOptions, Mouse, MouseCursor, MouseCursorData, Multitouch, MultitouchInputMode, Mutex, Namespace, NationalDigitsType, NativeDragActions, NativeDragManager, NativeDragOptions, NativeProcessStartupInfo, NativeWindowDisplayState, NativeWindowInitOptions, NativeWindowRenderMode, NativeWindowResize, NativeWindowSystemChrome, NativeWindowType, NetGroupInfo, NetGroupReceiveMode, NetGroupReplicationStrategy, NetGroupSendMode, NetGroupSendResult, NetStreamAppendBytesAction, NetStreamInfo, NetStreamMulticastInfo, NetStreamPlayTransitions, NetworkInterface, NotificationStyle, NotificationType, Number, NumberFormatter, NumberParseResult, Object, ObjectEncoding, Orientation3D, PaperSize, PermissionStatus, PerspectiveProjection, PixelSnapping, PNGEncoderOptions, Point, PrintJobOptions, PrintJobOrientation, PrintMethod, PrintUIOptions, Program3D, Proxy, QName, Rectangle, ReferencesValidationSetting, RegExp, RemoteNotifierSubscribeOptions, RenderingMode, ResourceRecord, Responder, ReturnKeyLabel, RevocationCheckSettings, Scene, ScreenMode, Security, SecurityDomain, SecurityPanel, Shader, ShaderData, ShaderInput, ShaderParameter, ShaderParameterType, ShaderPrecision, SharedObjectFlushStatus, SignatureStatus, SignerTrustSettings, SoftKeyboardTrigger, SoftKeyboardType, SoundCodec, SoundLoaderContext, SoundMixer, SoundTransform, SpreadMethod, SQLCollationType, SQLColumnNameStyle, SQLColumnSchema, SQLErrorOperation, SQLMode, SQLResult, SQLSchema, SQLSchemaResult, SQLTransactionLockType, StageAlign, StageAspectRatio, StageDisplayState, StageOrientation, StageQuality, StageScaleMode, StageTextClearButtonMode, StageTextContentType, StageTextInitOptions, StageVideoAvailability, StageVideoAvailabilityReason, StorageVolume, String, StringTools, SWFVersion, System, SystemIdleMode, SystemUpdaterType, TabAlignment, TabStop, Telemetry, TextBaseline, TextBlock, TextColorType, TextDisplayMode, TextExtent, TextFieldAutoSize, TextFieldType, TextFormat, TextFormatAlign, TextInteractionMode, TextJustifier, TextLineCreationResult, TextLineMetrics, TextLineMirrorRegion, TextLineValidity, TextRenderer, TextRotation, TextSnapshot, ThrottleType, TimeZone, TouchEventIntent, TouchscreenType, Transform, TriangleCulling, TypographicCase, uint, Updater, URLLoaderDataFormat, URLRequest, URLRequestDefaults, URLRequestHeader, URLRequestMethod, URLVariables, Utils3D, Vector, Vector3D, VertexBuffer3D, VideoCodec, VideoStatus, VideoStreamSettings, VoucherAccessInfo, WorkerDomain, WorkerState, X500DistinguishedName, X509Certificate, XML, XMLList, XMLNode, XMLNodeType, ZipEntry
-

- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The Object class is at the root of the ActionScript - - runtime class hierarchy. Objects are created by constructors using the - - new operator syntax, and can have properties assigned to them dynamically. - - Objects can also be created by - - assigning an object literal, as in: - - - - 
var obj:Object = {a:"foo", b:"bar"}
- - - -

All classes that don't declare an explicit base class extend the built-in Object class.

- - - -

All runtime classes in the Adobe Integrated Runtime extend the runtime.Object class.

- - - -

You can use the Object class to create associative arrays. At its core, an associative array is an instance of the Object class, and each key-value pair is represented by a property and its value. Another reason to declare an associative array using the Object data type is that you can then use an object literal to populate your associative array (but only at the time you declare it). The following example creates an associative array using an object literal, accesses items using both the dot operator and the array access operator, and then adds a new key-value pair by creating a new property:

- - - - 
-
- var myAssocArray:Object = {fname:"John", lname:"Public"};
-
- trace(myAssocArray.fname);     // John
-
- trace(myAssocArray["lname"]);  // Public
-
- myAssocArray.initial = "Q";
-
- trace(myAssocArray.initial);   // Q
- - - -

ActionScript 3.0 has two types of inheritance: class inheritance and prototype inheritance:

- -
    - -
  • Class inheritance - is the primary inheritance mechanism and supports inheritance of fixed properties. A fixed property is a variable, constant or method declared as part of a class definition. Every class definition is now represented by a special class object that stores information about the class.
    • - -
  • Prototype inheritance - is the only inheritance mechanism in previous versions of ActionScript and serves as an alternate form of inheritance in ActionScript 3.0. Each class has an associated prototype object, and the properties of the prototype object are shared by all instances of the class. When a class instance is created, it has a reference to its class's prototype object, which serves as a link between the instance and its associated class prototype object. At run time, when a property is not found on a class instance, the delegate, which is the class prototype object, is checked for that property. If the prototype object does not contain the property, the process continues with the prototype object's delegate checking in consecutively higher levels in the hierarchy until the Flash runtime finds the property.
    • - -
- - - -

Both class inheritance and prototype inheritance can exist simultaneously, as shown in the following example:

- - - - 
-
- class A {
-
-     var x = 1
-
-     prototype.px = 2
-
- }
-
- dynamic class B extends A {
-
-     var y = 3
-
-     prototype.py = 4
-
- }
-
-  
-
- var b = new B()
-
- b.x // 1 via class inheritance
-
- b.px // 2 via prototype inheritance from A.prototype
-
- b.y // 3
-
- b.py // 4 via prototype inheritance from B.prototype
-
-  
-
- B.prototype.px = 5
-
- b.px // now 5 because B.prototype hides A.prototype
-
-  
-
- b.px = 6
-
- b.px // now 6 because b hides B.prototype
- - - -

Using functions instead of classes, you can construct custom prototype inheritance trees. With classes, the prototype inheritance tree mirrors the class inheritance tree. However, since the prototype objects are dynamic, you can add and delete prototype-based properties at run time.

- - -

-

-View the examples. -

-

-See also -

-
-prototype -
-
-
-
- -
-
Public Properties
- - - - - - - - - - -
 PropertyDefined by
  constructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  prototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Object()
-
- - Creates an Object object and stores a reference to the object's constructor method in the object's constructor property.
-		Object
   -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
constructorproperty
-
-public var constructor:Object -

- - - - -
Runtime version: AIR 1.0 - -
-

- - A reference to the class object or constructor function for a given object instance. - - If an object is an instance of a class, the constructor - - property holds a reference to the class object. - - If an object is created with a constructor function, the constructor - - property holds a reference to the constructor function. - - Do not confuse a constructor function with a constructor method of a class. - - A constructor function is a Function object used to create objects, and is an - - alternative to using the class keyword for defining classes. - - -

If you use the class keyword to define a class, the class's prototype object - - is assigned a property named constructor that holds a reference to the class object. - - An instance of the class inherits this property from the prototype object. For example, - - the following code creates a new class, A, and a class instance named myA:

- - 
-
-	 dynamic class A {}
-
-	 trace(A.prototype.constructor);      // [class A]
-
-	 trace(A.prototype.constructor == A); // true
-
-	 var myA:A = new A();
-
-	 trace(myA.constructor == A);         // true
- - - -

Advanced users may choose to use the function keyword instead of the class - - keyword to define a Function object that can be used as a template for creating objects. Such a - - function is called a constructor function because you can use it in conjunction with the new - - operator to create objects. - - If you use the function keyword to create a constructor function, its prototype object is assigned - - a property named constructor that holds a reference to the constructor function. - - If you then use the constructor function to create an object, the object inherits the - - constructor property from the constructor function's prototype object. For example, - - the following code creates a new constructor function, f, and an object named myF:

- - 
-
-	 function f() {}
-
-	 trace(f.prototype.constructor);      // function Function() {}
-
-	 trace(f.prototype.constructor == f); // true
-
-	 var myF = new f();
-
-	 trace(myF.constructor == f);         // true
- - -

Note: The constructor property is writable, which means that user code can change - - its value with an assignment statement. Changing the value of the constructor property is not - - recommended, but if you write code that depends on the value of the constructor property, you should - - ensure that the value is not reset. The value can be changed only when the property is accessed through the prototype - - object (for example, className.prototype.constructor).

- -

If you access the constructor property and compile in strict mode, you will get an error at compile - - time because the constructor property depends on the protoype object, which is a runtime entity. - - If you use standard mode or if the class description specifies "dynamic", the code runs without generating - - an error.

- -

-See also -

-
-Class -
-Function -
-prototype -
-
- - - - - -
prototypeproperty 
-
-public static var prototype:Object -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - A reference to the prototype object of a class or function object. The prototype property - - is automatically created and attached to any class or function object that you create. This property is - - static in that it is specific to the class or function that you create. For example, if you create a - - class, the value of the prototype property is shared by all instances of the class and is - - accessible only as a class property. Instances of your class cannot directly access - - the prototype property. - - - -

A class's prototype object is a special instance of that class that provides a mechanism for sharing state across all instances of a class. At run time, when a property is not found on a class instance, the delegate, which is the class prototype object, is checked for that property. If the prototype object does not contain the property, the process continues with the prototype object's delegate checking in consecutively higher levels in the hierarchy until - - the Flash runtime finds the property.

- - - -

Note: In ActionScript 3.0, prototype inheritance is not the primary mechanism for inheritance. Class inheritance, which drives the inheritance of fixed properties in class definitions, is the primary inheritance mechanism in ActionScript 3.0.

- - - -
- -
Constructor detail
- - - - - -
Object()constructor
-
-public function Object() -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates an Object object and stores a reference to the object's constructor method in the object's constructor property. - - -

- -
Method detail
- - - - - -
hasOwnProperty()method
-
-AS3 function hasOwnProperty(name:String):Boolean -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether an object has a specified property defined. This method returns true if the target object has - - a property that matches the string specified by the name parameter, and false otherwise. - - The following types of properties cause this method to return true for objects that are instances of a class (as opposed to class objects): - -

    - -
  • Fixed instance properties—variables, constants, or methods defined by the object's class that are not static;
    • - -
  • Inherited fixed instance properties—variables, constants, or methods inherited by the object's class;
    • - -
  • Dynamic properties—properties added to an object after it is instantiated (outside of its class definition). To add dynamic properties, the object's defining class must be declared with the dynamic keyword.
    • - -
- -

The following types of properties cause this method to return false for objects that are instances of a class:

- -
    - -
  • Static properties—variables, constants, or methods defined with the static keyword in an object's defining class or any of its superclasses;
    • - -
  • Prototype properties—properties defined on a prototype object that is part of the object's prototype chain. In ActionScript 3.0, the prototype chain is not used for class inheritance, but still exists as an alternative form of inheritance. For example, an instance of the Array class can access the valueOf() method because it exists on Object.prototype, which is part of the prototype chain for the Array class. Although you can use valueOf() on an instance of Array, the return value of hasOwnProperty("valueOf") for that instance is false.
    • - -
- - - -

ActionScript 3.0 also has class objects, which are direct representations of class definitions. - - When called on class objects, the hasOwnProperty() method returns true only if a property - - is a static property defined on that class object. For example, if you create a subclass of Array named - - CustomArray, and define a static property in CustomArray named foo, a call to - - CustomArray.hasOwnProperty("foo") returns true. - - For the static property DESCENDING defined in the Array class, however, a call to - - CustomArray.hasOwnProperty("DESCENDING") returns false.

- - - -

Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the override keyword. For example, A subclass of Object implements function hasOwnProperty():Boolean instead of using an override of the base class.

- - - Parameters - - - - -
name:String — The property of the object. - -
-

-Returns - - - - -
Boolean — - If the target object has the property specified by the name - - parameter this value is true, otherwise false. - - - - - -
-
- - - - - -
isPrototypeOf()method 
-
-AS3 function isPrototypeOf(theClass:Object):Boolean -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter. This method returns true if the object is in the prototype chain of the - - object specified by the theClass parameter. The method returns false - - if the target object is absent from the prototype chain of the theClass object, - - and also if the theClass parameter is not an object. - - -

Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the override keyword. For example, A subclass of Object implements function isPrototypeOf():Boolean instead of using an override of the base class.

- - -

Parameters - - - - -
theClass:Object — The class to which the specified object may refer. - - - -
-

-Returns - - - - -
Boolean — - If the object is in the prototype chain of the object - - specified by the theClass parameter this value is true, otherwise false. - - - - - -
-
- - - - - -
propertyIsEnumerable()method 
-
-AS3 function propertyIsEnumerable(name:String):Boolean -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether the specified property exists and is enumerable. If true, then the property exists and - - can be enumerated in a for..in loop. The property must exist on the target object because this method does not - - check the target object's prototype chain. - - - -

Properties that you create are enumerable, but built-in properties are generally not enumerable.

- - - -

Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the override keyword. For example, A subclass of Object implements function propertyIsEnumerable():Boolean instead of using an override of the base class.

- - - Parameters - - - - -
name:String — The property of the object. - -
-

-Returns - - - - -
Boolean — - If the property specified by the name parameter is enumerable this value is true, otherwise false. - - - - - -
-
- - - - - -
setPropertyIsEnumerable()method 
-
-public function setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Sets the availability of a dynamic property for loop operations. The property must exist on the target object because this method does not check the target object's prototype chain. - -

Parameters - - - - - - - - - - -
name:String — The property of the object. - -
 
isEnum:Boolean (default = true) — If set to false, the dynamic property does not show up in for..in loops, and the method propertyIsEnumerable() returns false. - -
-

-See also -

-
-propertyIsEnumerable() -
-
- - - - - -
toLocaleString()method 
-
-public function toLocaleString():String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns the string representation of this object, formatted according to locale-specific conventions. - - - -

The default implementation of this method does not perform locale-specific formatting and returns the - - same string as toString(). Subclasses should provided their own locale-aware implementation when appropriate.

- - - -

Note: Methods of the Object class are dynamically created on Object's prototype. - - To redefine this method in a subclass of Object, do not use the override keyword. For example, - - a subclass of Object implements function toLocaleString():String instead of using an override of the base class.

- - -

-Returns - - - - -
String — - A string representation of this object formatted according to local conventions. - - - - - -
-

-See also -

-
-Object.toString() -
-
- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns the string representation of the specified object. - - -

Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the override keyword. For example, a subclass of Object implements function toString():String instead of using an override of the base class.

- - -

-Returns - - - - -
String — - A string representation of the object. - - - - -
-
- - - - - -
valueOf()method 
-
-public function valueOf():Object -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns the primitive value of the specified object. If this object - - does not have a primitive value, the object itself is returned. - - - -

Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the override keyword. For example, A subclass of Object implements function valueOf():Object instead of using an override of the base class.

- - -

-Returns - - - - -
Object — - The primitive value of this object or the object itself. - - - - -
-

-See also -

-
-Object.toString() -
-
- -
Examples
-
examples\ObjectExample
-
The following example uses the classes ObjectExample and Circle - to demonstrate the dynamic nature of the Object class, and how value objects can be transformed into - Shape objects and then added to the stage at the specified x/y coordinates. - -

The example creates the value objects firstInitObj and secondInitObj. The custom - class Circle accepts the value object and loops over it while setting its matching internal - properties to those defined in the value object.

-
-
-package {
-    import flash.display.Sprite;
-
-	public class ObjectExample extends Sprite {
-		public function ObjectExample() {
-			var firstInitObj:Object = new Object();
-			firstInitObj.bgColor = 0xFF0000;
-			firstInitObj.radius = 25;
-			firstInitObj.xCenter = 25;
-			firstInitObj.yCenter = 25;
-						
-			var firstCircle:Circle = new Circle(firstInitObj);
-			addChild(firstCircle);
-			firstCircle.x = 50;
-			firstCircle.y = 50;
-
-			var secondInitObj:Object = {bgColor:0xCCCCCC, radius:50, xCenter:50, yCenter:50};
-
-			var secondCircle:Circle = new Circle(secondInitObj);			
-			addChild(secondCircle);
-			secondCircle.x = 100;
-			secondCircle.y = 100;
-		}
-		
-	}
-}
-
-import flash.display.Shape;
-	
-class Circle extends Shape {
-	public var bgColor:Number = 0xFFFFFF;
-	public var radius:Number = 0;
-	public var xCenter:Number = 0;
-	public var yCenter:Number = 0;
-		
-	public function Circle(initObj:Object) {
-		for(var i:String in initObj) {
-			this[i] = initObj[i];
-		}
-		draw();
-	}
-		
-	public function draw():void {
-		graphics.beginFill(bgColor);
-		graphics.drawCircle(xCenter, yCenter, radius);
-		graphics.endFill();
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Mar 21 2024, 10:06 AM GMT
Creative Commons License
-
- - - diff --git a/html-docs/QName.html b/html-docs/QName.html deleted file mode 100644 index afbe3ab..0000000 --- a/html-docs/QName.html +++ /dev/null @@ -1,690 +0,0 @@ - - - - - - - - -QName (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class QName
InheritanceQName Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - -QName objects represent qualified names of XML elements and attributes. Each - -QName object has a local name and a namespace Uniform Resource Identifier (URI). - -When the value of the namespace URI is null, the QName object matches any namespace. - -Use the QName constructor to create a new QName object that is either a copy of another QName - -object or a new QName object with a uri from a Namespace object and a - -localName from a QName object. - - - - -

Methods specific to E4X can use QName objects interchangeably with strings. - -E4X methods are in the QName, Namespace, XML, and XMLList classes. - -These E4X methods, which take a string, can also take a QName object. - -This interchangeability is how namespace support works with, for example, - -the XML.child() method.

- - - -

The QName class (along with the XML, XMLList, and Namespace classes) implements - -powerful XML-handling standards defined in ECMAScript for XML - -(E4X) specification (ECMA-357 edition 2).

- - - -

A qualified identifier evaluates to a QName object. If the QName object of an XML element is - -specified without identifying a namespace, the uri - -property of the associated QName object is set to the global default namespace. If the QName object of an XML - -attribute is specified without identifying a namespace, the uri property is set to - -an empty string.

- - -

-

-View the examples. -

-

-See also -

-
-XML -
-XMLList -
-Namespace -
-ECMAScript for XML (E4X) specification (ECMA-357 edition 2) -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  localName : String -
[read-only] - - The local name of the QName object.
-		QName
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  uri : String -
[read-only] - - The Uniform Resource Identifier (URI) of the QName object.
-		QName
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-QName(uri:Namespace, localName:QName)
-
- - Creates a QName object with a URI from a Namespace object and a localName from a QName object.
-		QName
   -
-QName(qname:QName)
-
- - Creates a QName object that is a copy of another QName object.
-		QName
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string composed of the URI, and the local name for the - - QName object, separated by "::".
-		QName
   -
-valueOf():QName -
-
- - Returns the QName object.
-		QName
-
- -
- -
Property detail
- - - - - -
localNameproperty
-
-localName:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The local name of the QName object. - - -

Implementation -
-    public function get localName():String -
-
- - - - - -
uriproperty 
-
-uri:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The Uniform Resource Identifier (URI) of the QName object. - - -

Implementation -
-    public function get uri():String -
-
- -
Constructor detail
- - - - - -
QName()constructor
-
-public function QName(uri:Namespace, localName:QName) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Creates a QName object with a URI from a Namespace object and a localName from a QName object. - - If either parameter is not the expected data type, the parameter is converted to a string and - - assigned to the corresponding property of the new QName object. - - For example, if both parameters are strings, a new QName object is returned with a uri property set - - to the first parameter and a localName property set to the second parameter. - - In other words, the following permutations, along with many others, are valid forms of the constructor: - -

-
-QName (uri:Namespace, localName:String);
-
-QName (uri:String, localName: QName);
-
-QName (uri:String, localName: String);
-
-
- -

If you pass null for the uri parameter, - - the uri property of the new QName object is set to null. - -

- -

Note: This class shows two constructor entries because each form accepts - - different parameters. The constructor behaves differently depending on the type and number of - - parameters passed, as detailed in each entry. ActionScript 3.0 does not support method or constructor overloading.

- - - Parameters - - - - - - - - - - -
uri:Namespace — A Namespace object from which to copy the uri value. A parameter of any other type is converted to a string. - -
 
localName:QName — A QName object from which to copy the localName value. A parameter of any other type is converted to a string. - - -
-
- - - - - -
QName()constructor 
-
-public function QName(qname:QName) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Creates a QName object that is a copy of another QName object. If the parameter passed - - to the constructor is a QName object, a copy of the QName object is created. If the parameter - - is not a QName object, the parameter is converted to a string and assigned to the - - localName property of the new QName instance. - - If the parameter is undefined or unspecified, a new QName object - - is created with the localName property set to the empty string. - -

Note: This class shows two constructor entries because each form accepts - - different parameters. The constructor behaves differently depending on the type and number of - - parameters passed, as detailed in each entry. ActionScript 3.0 does not support method or constructor overloading.

- - - - - Parameters - - - - -
qname:QName — The QName object to be copied. Objects of any other type are - - converted to a string that is assigned to the localName property - - of the new QName object. - - -
-
- -
Method detail
- - - - - -
toString()method
-
-AS3 function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns a string composed of the URI, and the local name for the - - QName object, separated by "::". - - - -

The format depends on the uri property of the QName object:

- - 
If uri == "" 
-
-		toString returns localName
-
-	else if uri == null
-
-		toString returns *::localName 
-
-	else
-
-		toString returns uri::localName
- - - - -

-Returns - - - - -
String — - The qualified name, as a string. - - - - -
-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():QName -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns the QName object. - - -

-Returns - - - - -
QName — - The primitive value of a QName instance. - - - - -
-
- -
Examples
-
examples\QNameExample
-
The following example shows how to create a QName instance and use it to select XML elements. - Two ways of creating a QName are shown: -
    -
  1. Creating a Namespace instance and then using it as input to the QName constructor. - This approach is best if you want to use the Namespace.prefix property for other - purposes later.
    2. -
  2. Creating a QName instance using a simple string value for the uri - parameter in the QName constructor.
    3. -
-

- This code does the following things: -

-
    -
  1. Defines an XML variable named rssXML.
    2. -
  2. Creates a new Namespace object with the prefix dc.
    3. -
  3. Creates a new QName object using the Namespace object and the local name creator.
    4. -
  4. Calls the showDescendants() method, which uses the XML.descendants() method to get an XMLList instance - containing all the descendant elements whose qualified name matches the given QName instance.
    5. -
  5. Displays the qualified name and the text value of each element in the list using a for each loop.
    6. -
  6. Creates another QName object using a string value for the uri parameter and the local name date.
    7. -
  7. Calls the showDescendants() method again to display the name and text value of the descendant elements.
    8. -
-
-
-package
-{
-	import flash.display.Sprite;
-	
-	public class QNameExample extends Sprite
-	{
-		public function QNameExample()
-		{
-            var rssXML:XML =  <rdf:RDF
-              xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
-              xmlns="http://purl.org/rss/1.0/"
-              xmlns:dc="http://purl.org/dc/elements/1.1/">
-              <channel rdf:about="http://www.xml.com/cs/xml/query/q/19">
-                <title>Test RSS</title>
-                <link>http://www.adobe.com/</link>
-                <description>This is a test RSS document.</description>
-                <language>en-us</language>
-                <items>
-                  <rdf:Seq>
-                <rdf:li rdf:resource="http://www.adobe.com/devnet/flash/"/>
-                <rdf:li rdf:resource="http://www.adobe.com/devnet/flex/"/>
-                  </rdf:Seq>
-                </items>
-              </channel>
-              <item rdf:about="http://www.adobe.com/devnet/flash/">
-                <title>Flash Developer Center</title>
-                <link>http://www.adobe.com/devnet/flash/</link>
-                <description>Welcome to the Flash Developer Center</description>
-                <dc:creator>Adobe</dc:creator>
-                <dc:date>2005-08-08</dc:date>    
-              </item>
-              <item rdf:about="http://www.adobe.com/devnet/flex/">
-                <title>Flex Developer Center</title>
-                <link>http://www.adobe.com/devnet/flex/</link>
-                <description>Welcome to the Flex Developer Center</description>
-                <dc:creator>Adobe</dc:creator>
-                <dc:date>2005-10-16</dc:date>    
-              </item>
-            </rdf:RDF>;
-            
-            var dcNamespace:Namespace = new Namespace("dc", "http://purl.org/dc/elements/1.1/");
-            var creatorQName:QName = new QName(dcNamespace, "creator");
-            trace(creatorQName.uri); // http://purl.org/dc/elements/1.1/
-            trace(creatorQName.localName); // creator
-            
-            showDescendants(rssXML, creatorQName);
-            
-            var dateQName:QName = new QName("http://purl.org/dc/elements/1.1/", "date");
-            trace(dateQName.uri); // http://purl.org/dc/elements/1.1/
-            trace(dateQName.localName); // date
-            
-            showDescendants(rssXML, dateQName);
-		}
-		
-        public function showDescendants(xmlData:XML, qualifiedName:QName):void
-        {
-            var decendantList:XMLList = xmlData.descendants(qualifiedName);
-            
-            for each (var element:XML in decendantList)
-            {
-            	trace(element.name()); // the fully qualified name, 
-            	                       // like "http://purl.org/dc/elements/1.1/::creator"
-            	trace(element); // the simple text value of each element, like "Adobe"
-	        }            	
-        }
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/RangeError.html b/html-docs/RangeError.html deleted file mode 100644 index ced74e0..0000000 --- a/html-docs/RangeError.html +++ /dev/null @@ -1,353 +0,0 @@ - - - - - - - - -RangeError (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class RangeError
InheritanceRangeError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - A RangeError exception is thrown when a numeric value is outside the acceptable range. When working with arrays, - - referring to an index position of an array item that does not exist will throw a RangeError exception. - - Using Number.toExponential(), Number.toPrecision(), and Number.toFixed() methods - - will throw a RangeError exception in cases - - where the arguments are outside the acceptable range of numbers. You can extend Number.toExponential(), - - Number.toPrecision(), and Number.toFixed() to avoid throwing a RangeError. - -

Other situations that cause this exception to be thrown include the following: - -

    - -
  • Any Flash runtime API that expects a depth number is invoked with an invalid depth - - number.
    • - -
  • Any Flash runtime API that expects a frame number is invoked with an invalid frame - - number.
    • - -
  • Any Flash runtime API that expects a layer number is invoked with an invalid layer - - number.
    • - -
- -

- -

-

-View the examples. -

-

-See also -

-
-Number.toExponential() -
-Number.toPrecision() -
-Number.toFixed() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-RangeError(message:String = "")
-
- - Creates a new RangeError object.
-		RangeError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
RangeError()constructor
-
-public function RangeError(message:String = "") -

- - - - -
Runtime version: AIR 1.0
-

- - Creates a new RangeError object. - -

Parameters - - - - -
message:String (default = "") — Contains the message associated with the RangeError object. - - - -
-
- -
Examples
-
examples\RangeErrorExample
-
The following example shows how a RangeError exception can - be generated and handled within a try..catch statement. -
-
-package {
-    import flash.display.Sprite;
-
-	public class RangeErrorExample extends Sprite {
-
-		public function RangeErrorExample() {
-			var child:Sprite = new Sprite();
-			try {
-				addChildAt(child, 1);
-			}
-			catch(e:RangeError) {
-				trace(e);
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/ReferenceError.html b/html-docs/ReferenceError.html deleted file mode 100644 index 81efdcf..0000000 --- a/html-docs/ReferenceError.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - - - -ReferenceError (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class ReferenceError
InheritanceReferenceError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - A ReferenceError exception is thrown when a reference to an undefined property is - - attempted on a sealed (nondynamic) object. References to undefined variables will - - result in ReferenceError exceptions to inform you of potential bugs and help you troubleshoot - - application code. - -

However, you can refer to undefined properties of a dynamic class without causing a ReferenceError exception - - to be thrown. For more information, see the dynamic keyword.

- - -

-

-View the examples. -

-

-See also -

-
-dynamic keyword -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ReferenceError(message:String = "")
-
- - Creates a new ReferenceError object.
-		ReferenceError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
ReferenceError()constructor
-
-public function ReferenceError(message:String = "") -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new ReferenceError object. - -

Parameters - - - - -
message:String (default = "") — Contains the message associated with the ReferenceError object. - - - -
-
- -
Examples
-
examples\ReferenceErrorExample
-
The following example shows how a ReferenceError exception can - be generated and handled within a try..catch statement. -
-
-package {
-    import flash.display.Sprite;
-
-	public class ReferenceErrorExample extends Sprite {
-
-		public function ReferenceErrorExample() {
-			try {
-				this["someMember"] = true;
-			}
-			catch(e:ReferenceError) {
-				trace(e);
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/RegExp.html b/html-docs/RegExp.html deleted file mode 100644 index baef17f..0000000 --- a/html-docs/RegExp.html +++ /dev/null @@ -1,1098 +0,0 @@ - - - - - - - - -RegExp (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class RegExp
InheritanceRegExp Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - - The RegExp class lets you work with regular expressions, which are patterns that you can use - - to perform searches in strings and to replace text in strings. - - - -

You can create a new RegExp object by using the new RegExp() constructor or by - - assigning a RegExp literal to a variable:

- - - - 
 var pattern1:RegExp = new RegExp("test-\\d", "i");
-
-     var pattern2:RegExp = /test-\d/i;
-
-
- - - -

For more information, see "Using Regular Expressions" in the ActionScript 3.0 Developer's Guide.

- - - -

-

-View the examples. -

-

-See also -

-
-String.match() -
-String.replace() -
-String.search() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  dotall : Boolean -
[read-only] - - Specifies whether the dot character (.) in a regular expression pattern matches - - new-line characters.
-		RegExp
  extended : Boolean -
[read-only] - - Specifies whether to use extended mode for the regular expression.
-		RegExp
  global : Boolean -
[read-only] - - Specifies whether to use global matching for the regular expression.
-		RegExp
  ignoreCase : Boolean -
[read-only] - - Specifies whether the regular expression ignores case sensitivity.
-		RegExp
  lastIndex : Number -
- - Specifies the index position in the string at which to start the next search.
-		RegExp
  multiline : Boolean -
[read-only] - - Specifies whether the m (multiline) flag is set.
-		RegExp
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  source : String -
[read-only] - - Specifies the pattern portion of the regular expression.
-		RegExp
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-RegExp(re:String, flags:String)
-
- - Lets you construct a regular expression from two strings.
-		RegExp
   -
-exec(str:String):Object -
-
- - Performs a search for the regular expression on the given string str.
-		RegExp
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-test(str:String):Boolean -
-
- - Tests for the match of the regular expression in the given string str.
-		RegExp
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
dotallproperty
-
-dotall:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies whether the dot character (.) in a regular expression pattern matches - - new-line characters. Use the s flag when constructing - - a regular expression to set dotall = true. - - -

Implementation -
-    public function get dotall():Boolean -
-
-Example -
The following example shows the effect of the s (dotall) - flag on a regular expression: -
-
-var str:String = "<p>Hello\n"
-    	+ "again</p>"
-		+ "<p>Hello</p>";
-
-var pattern:RegExp = /<p>.*?<\/p>/;
-trace(pattern.dotall) // false
-trace(pattern.exec(str)); // <p>Hello</p>
-
-pattern = /<p>.*?<\/p>/s;
-trace(pattern.dotall) // true
-trace(pattern.exec(str)); 
-
-
-

-
- - - - - -
extendedproperty 
-
-extended:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies whether to use extended mode for the regular expression. - - When a RegExp object is in extended mode, white space characters in the constructor - - string are ignored. This is done to allow more readable constructors. - - -

Use the x flag when constructing a regular expression to set - - extended = true.

- - - Implementation -
-    public function get extended():Boolean -
-
-Example -
The following example shows different ways to construct the same regular - expression. In each, the regular expression is to match a phone number pattern of - xxx-xxx-xxxx or (xxx) xxx-xxxx or (xxx)xxx-xxxx. - The second regular expression uses the x flag, causing the white spaces in - the string to be ignored. -
-
-var rePhonePattern1:RegExp = /\d{3}-\d{3}-\d{4}|\(\d{3}\)\s?\d{3}-\d{4}/; 
-var str:String = "The phone number is (415)555-1212.";
-
-trace(rePhonePattern1.extended) // false
-trace(rePhonePattern1.exec(str)); // (415)555-1212
-
-var rePhonePattern2:RegExp = / \d{3}-\d{3}-\d{4}  |   \( \d{3} \) \ ? \d{3}-\d{4}  /x; 
-trace(rePhonePattern2.extended) // true
-trace(rePhonePattern2.exec(str)); // (415)555-1212
-
-

-
- - - - - -
globalproperty 
-
-global:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies whether to use global matching for the regular expression. When - - global == true, the lastIndex property is set after a match is - - found. The next time a match is requested, the regular expression engine starts from - - the lastIndex position in the string. Use the g flag when - - constructing a regular expression to set global to true. - - -

Implementation -
-    public function get global():Boolean -
-
-Example -
The following example shows the effect setting the g - (global) flag on the exec() method: -
-
-var pattern:RegExp = /foo\d/; 
-var str:String = "foo1 foo2";
-trace(pattern.global); // false
-trace(pattern.exec(str)); // foo1
-trace(pattern.lastIndex); // 0
-trace(pattern.exec(str)); // foo1
-
-pattern = /foo\d/g;
-trace(pattern.global); // true
-trace(pattern.exec(str)); // foo1
-trace(pattern.lastIndex); // 4
-trace(pattern.exec(str)); // foo2
-
-

-
- - - - - -
ignoreCaseproperty 
-
-ignoreCase:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies whether the regular expression ignores case sensitivity. Use the - - i flag when constructing a regular expression to set - - ignoreCase = true. - - -

Implementation -
-    public function get ignoreCase():Boolean -
-
-Example -
The following example shows the effect of setting the i - (ignoreCase) flag: -
-
-var pattern:RegExp = /bob/; 
-var str:String = "Bob bob";
-trace(pattern.ignoreCase); // false
-trace(pattern.exec(str)); // bob
-
-pattern = /bob/i;
-trace(pattern.ignoreCase); // true
-trace(pattern.exec(str)); // Bob
-
-

-
- - - - - -
lastIndexproperty 
-
-lastIndex:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies the index position in the string at which to start the next search. This property - - affects the exec() and test() methods of the RegExp class. - - However, the match(), replace(), and search() methods - - of the String class ignore the lastIndex property and start all searches from - - the beginning of the string. - - - -

When the exec() or test() method finds a match and the g - - (global) flag is set to true for the regular expression, the method - - automatically sets the lastIndex property to the index position of the character - - after the last character in the matching substring of the last match. If the - - g (global) flag is set to false, the method does not - - set the lastIndexproperty.

- - - -

You can set the lastIndex property to adjust the starting position - - in the string for regular expression matching.

- - - Implementation -
-    public function get lastIndex():Number -
-    public function set lastIndex(value:Number):void -
-
-Example -
The following example shows the effect of setting the lastIndex - property, and it shows how it is updated after a call to the exec() method on a - regular expression in which the g (global) flag is set: -
-
-var pattern:RegExp = /\w\d/g; 
-var str:String = "a1 b2 c3 d4";
-pattern.lastIndex = 2; 
-trace(pattern.exec(str)); // b2
-trace(pattern.lastIndex); // 5
-trace(pattern.exec(str)); // c3
-trace(pattern.lastIndex); // 8
-trace(pattern.exec(str)); // d4
-trace(pattern.lastIndex); // 11
-trace(pattern.exec(str)); // null
-
-

-
- - - - - -
multilineproperty 
-
-multiline:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies whether the m (multiline) flag is set. If it is set, - - the caret (^) and dollar sign ($) in a regular expression - - match before and after new lines. - - Use the m flag when constructing a regular expression to set - - multiline = true. - - -

Implementation -
-    public function get multiline():Boolean -
-
-Example -
The following example shows the effect setting the m (multiline) flag: -
-
-var pattern:RegExp = /^bob/; 
-var str:String = "foo\n"
-    			+ "bob";
-trace(pattern.multiline); // false
-trace(pattern.exec(str)); // null
-
-pattern = /^bob/m;
-trace(pattern.multiline); // true
-trace(pattern.exec(str)); // bob
-
-

-
- - - - - -
sourceproperty 
-
-source:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies the pattern portion of the regular expression. - - - -

Implementation -
-    public function get source():String -
-
-Example -
The following code outputs the source parameter for two regular expressions: -
-
-var re1:RegExp = /aabb/gi;
-trace (re1.source); // aabb
-
-var re2:RegExp = new RegExp("x+y*", "i");
-trace(re2.source); // x+y*
-
-

-
- -
Constructor detail
- - - - - -
RegExp()constructor
-
-public function RegExp(re:String, flags:String) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Lets you construct a regular expression from two strings. One string defines the pattern of the - - regular expression, and the other defines the flags used in the regular expression. - - -

Parameters - - - - - - - - - - -
re:String — The pattern of the regular expression (also known as the constructor string). This is the - - main part of the regular expression (the part that goes within the "/" characters). - - - -

Notes:

- - - -
    - - - -
  • Do not include the starting and trailing "/" characters; use these only when defining a regular expression - - literal without using the constructor. For example, the following two regular expressions are equivalent: - - - - 
     var re1:RegExp = new RegExp("bob", "i"); 
-
-        var re2:RegExp = /bob/i;
    - - -
    • - - - -
  • In a regular expression that is defined with the RegExp() constructor method, to use a - - metasequence that begins with the backslash (\) character, such as \d (which matches any digit), - - type the backslash character twice. For example, the following two regular expressions are equivalent: - - - - 
     var re1:RegExp = new RegExp("\\d+", ""); 
-
-        var re2:RegExp = /\d/;
    - - - -

    In the first expression, you must type the backlash character twice in this case, because the first parameter of the RegExp() - - constructor method is a string, and in a string literal you must type a backslash character twice to have it - - recognized as a single backslash character.

    - - -
    • - - - -
- - - -
 
flags:String — The modifiers of the regular expression. These can include the following: - - -
    - - -
  • g — When using the replace() method of the String class, - - specify this modifier to replace all matches, rather than only the first one. - - This modifier corresponds to the global property of the RegExp instance.
    • - -
  • i — The regular expression is evaluated without case - - sensitivity. This modifier corresponds to the ignoreCase property of the RegExp instance.
    • - -
  • s — The dot (.) character matches new-line characters. Note - - This modifier corresponds to the dotall property of the RegExp instance.
    • - -
  • m — The caret (^) character and dollar sign ($) match - - before and after new-line characters. This modifier corresponds to the - - multiline property of the RegExp instance.
    • - -
  • x — White space characters in the re string are ignored, - - so that you can write more readable constructors. This modifier corresponds to the - - extended property of the RegExp instance.
    • - - -
- - -

All other characters in the flags string are ignored.

- - -
-
- -
Method detail
- - - - - -
exec()method
-
-AS3 function exec(str:String):Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Performs a search for the regular expression on the given string str. - - -

If the g (global) flag is not set for the regular - - expression, then the search starts - - at the beginning of the string (at index position 0); the search ignores - - the lastIndex property of the regular expression.

- - -

If the g (global) flag is set for the regular - - expression, then the search starts - - at the index position specified by the lastIndex property of the regular expression. - - If the search matches a substring, the lastIndex property changes to match the position - - of the end of the match.

- - - Parameters - - - - -
str:String — The string to search. - - -
-

-Returns - - - - -
Object — - If there is no match, null; otherwise, an object with the following properties: - - - -
    - - -
  • An array, in which element 0 contains the complete matching substring, and - - other elements of the array (1 through n) contain substrings that match parenthetical groups - - in the regular expression
    • - - -
  • index — The character position of the matched substring within - - the string
    • - - -
  • input — The string (str)
    • - - -
- - - - - - - -
-

-See also -

-
-String.match() -
-String.search() -
-
-Example -

-
- - - - - -
test()method 
-
-AS3 function test(str:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Tests for the match of the regular expression in the given string str. - - -

If the g (global) flag is not set for the regular expression, - - then the search starts at the beginning of the string (at index position 0); the search ignores - - the lastIndex property of the regular expression.

- - -

If the g (global) flag is set for the regular expression, then the search starts - - at the index position specified by the lastIndex property of the regular expression. - - If the search matches a substring, the lastIndex property changes to match the - - position of the end of the match.

- - - Parameters - - - - -
str:String — The string to test. - - - -
-

-Returns - - - - -
Boolean — - If there is a match, true; otherwise, false. - - - - -
-
-Example -
The following example shows the use of the test() method on a regular - expression in which the g (global) flag is set: -
-
-var re1:RegExp = /\w/g;
-var str:String = "a b c";
-trace (re1.lastIndex); // 0
-trace (re1.test(str)); // true
-trace (re1.lastIndex); // 1
-trace (re1.test(str)); // true
-trace (re1.lastIndex); // 3
-trace (re1.test(str)); // true
-trace (re1.lastIndex); // 5
-trace (re1.test(str)); // false
-
-

-
- -
Examples
-
examples\RegExpExample
-
The following example shows how you can use regular expressions to parse - strings and return a new string or a Boolean value, based on the string passed in. The - informalizeGreeting() method simply replaces the word Hello with Hi, - regardless of case. It also strips out the surname in the name in the string - (assuming that name matches the specified pattern). In the validateEmail() and - validatePhoneNumber() methods, the string passed is checked to see if its pattern matches a valid - email address or a specific phone number pattern, and the methods return Boolean values based on the results. -
-
-package {
-    import flash.display.Sprite;
-
-	public class RegExpExample extends Sprite {		
-		public function RegExpExample() {			
-			var formalGreeting:String = "Hello, John Smith.";
-			trace(informalizeGreeting(formalGreeting));	// Hi, John.
-
-			var validEmail:String = "name@domain.com";
-			trace(validateEmail(validEmail));	    // true
-			
-			var invalidEmail:String = "foo";
-			trace(validateEmail(invalidEmail));  // false
-			
-			var validPhoneNumber:String = "415-555-1212";
-			trace(validatePhoneNumber(validPhoneNumber));    // true
-			
-			var invalidPhoneNumber:String = "312-867-530999";
-			trace(validatePhoneNumber(invalidPhoneNumber));  // false
-		}
-		private function informalizeGreeting(str:String):String {
-			var pattern:RegExp = new RegExp("hello, (\\w+) \\w+", "i");
-			return str.replace(pattern, "Hi, $1");
-		}
-		private function validateEmail(str:String):Boolean {
-			var pattern:RegExp = /(\w|[_.\-])+@((\w|-)+\.)+\w{2,4}+/;
-			var result:Object = pattern.exec(str);
-			if(result == null) {
-				return false;
-			}
-			return true;
-		}
-		private function validatePhoneNumber(str:String):Boolean {
-			var pattern:RegExp = /^\d{3}-\d{3}-\d{4}$/;
-			var result:Object = pattern.exec(str);
-			if(result == null) {
-				return false;
-			}
-			return true;
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/SecurityError.html b/html-docs/SecurityError.html deleted file mode 100644 index 8cee784..0000000 --- a/html-docs/SecurityError.html +++ /dev/null @@ -1,342 +0,0 @@ - - - - - - - - -SecurityError (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class SecurityError
InheritanceSecurityError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The SecurityError exception is thrown when some type of security violation - - takes place. - -

- - Examples of security errors:

- -
    - -
  • An unauthorized property access or method call is made across a security sandbox - - boundary.
    • - -
  • An attempt was made to access a URL not permitted by the security sandbox.
    • - -
  • A socket connection was attempted to an unauthorized port number, e.g. a port above - - 65535.
    • - -
  • An attempt was made to access the user's camera or microphone, and the request to - - access the device was denied by the user.
    • - -
- - - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SecurityError(message:String = "")
-
- - Creates a new SecurityError object.
-		SecurityError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
SecurityError()constructor
-
-public function SecurityError(message:String = "") -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new SecurityError object. - - - -

Parameters - - - - -
message:String (default = "")
-
- -
Examples
-
examples\SecurityErrorExample
-
The following example shows how a SecurityError error can - be generated and handled within a try...catch statement by attempting - to connect to a port number that is one larger than the maximum allowed. -
-
-package {
-    import flash.display.Sprite;
-	import flash.net.Socket;
-
-	public class SecurityErrorExample extends Sprite {
-
-		public function SecurityErrorExample() {
-			try {
-				var host:String = "www.[yourDomain].com";
-				var socket:Socket = new Socket();
-				socket.connect(host, 65536);
-			}
-			catch(e:SecurityError) {
-				trace(e);
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/String.html b/html-docs/String.html deleted file mode 100644 index b656334..0000000 --- a/html-docs/String.html +++ /dev/null @@ -1,2491 +0,0 @@ - - - - - - - - -String (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class String
InheritanceString Inheritance Object
-

- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The String class is a data type that represents a string of characters. The String class - - provides methods and properties that let you manipulate primitive string value types. - - You can convert the value of any object into a String data type object using the String() - - function. - -

- - Because all string indexes are zero-based, the index of the last character - - for any string x is x.length - 1. - -

- - You can call any of the methods of the String class whether you use the constructor method - - new String() to create a new string variable or simply assign a string literal value. - - Unlike previous versions of ActionScript, it makes no difference whether you use the constructor, - - the global function, or simply assign a string literal value. The following lines of code are equivalent: - -

- - 
-
- var str:String = new String("foo");
-
- var str:String = "foo";
-
- var str:String = String("foo");
- -

When setting a string variable to undefined, the Flash runtimes coerce undefined - - to null. So, the statement:

- - 
-
- var s:String = undefined;
- - sets the value to null instead of undefined. Use the String() - - function if you need to use undefined. - -

- - From AIR SDK version 50 (when using the ActionScript compiler from the 'normal' AIR SDK, rather than Flex or Animate), - - a "verbatim string" mechanism was added. In a normal string literal, a backslash is used as - - an escape character, so for example "\n" is used for a newline character. This behaviour can be removed if - - the string literal is preceeded by the @ character. Hence "sometimes\never" would result in - - a string split across two lines with "sometimes" and "ever", whereas @"sometimes\never" would retain the - - value as written here. This is particularly useful for strings containing file paths on Windows. - -

- - -

-

-View the examples. -

-

-See also -

-
-String() global function -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  length : int -
[read-only] - - An integer specifying the number of characters in the specified String object.
-		String
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-String(val:String)
-
- - Creates a new String object initialized to the specified string.
-		String
   -
-charAt(index:Number = 0):String -
-
- - Returns the character in the position specified by the index parameter.
-		String
   -
-charCodeAt(index:Number = 0):Number -
-
- - Returns the numeric Unicode character code of the character at the specified - - index.
-		String
   -
-concat(... args):String -
-
- - Appends the supplied arguments to the end of the String object, converting them to strings if - - necessary, and returns the resulting string.
-		String
   -
-endsWith(other:String):Boolean -
-
- - Checks whether this String object ends with the string that is passed in.
-		String
   -
-fromCharCode(... charCodes):String -
-
[static] - - Returns a string comprising the characters represented by the Unicode character codes - - in the parameters.
-		String
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-indexOf(val:String, startIndex:Number = 0):int -
-
- - Searches the string and returns the position of the first occurrence of val - - found at or after startIndex within the calling string.
-		String
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-lastIndexOf(val:String, startIndex:Number = 0x7FFFFFFF):int -
-
- - Searches the string from right to left and returns the index of the last occurrence - - of val found before startIndex.
-		String
   -
-localeCompare(other:String, ... values):int -
-
- - Compares the sort order of two or more strings and returns the result of the comparison as an integer.
-		String
   -
-match(pattern:*):Array -
-
- - Matches the specifed pattern against the - - string.
-		String
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-replace(pattern:*, repl:Object):String -
-
- - Matches the specifed pattern against the string and returns a new string - - in which the first match of pattern is replaced with the content specified by repl.
-		String
   -
-search(pattern:*):int -
-
- - Searches for the specifed pattern and returns the index of - - the first matching substring.
-		String
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-slice(startIndex:Number = 0, endIndex:Number = 0x7fffffff):String -
-
- - Returns a string that includes the startIndex character - - and all characters up to, but not including, the endIndex character.
-		String
   -
-split(delimiter:*, limit:Number = 0x7fffffff):Array -
-
- - Splits a String object into an array of substrings - - by dividing it wherever the specified delimiter parameter - - occurs.
-		String
   -
-startsWith(other:String):Boolean -
-
- - Checks whether this String object starts with the string that is passed in.
-		String
   -
-substr(startIndex:Number = 0, len:Number = 0x7fffffff):String -
-
- - Returns a substring consisting of the characters that start at the specified - - startIndex and with a length specified by len.
-		String
   -
-substring(startIndex:Number = 0, endIndex:Number = 0x7fffffff):String -
-
- - Returns a string consisting of the character specified by startIndex - - and all characters up to endIndex - 1.
-		String
   -
-toLocaleLowerCase():String -
-
- - Returns a copy of this string, with all uppercase characters converted - - to lowercase.
-		String
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toLocaleUpperCase():String -
-
- - Returns a copy of this string, with all lowercase characters converted - - to uppercase.
-		String
   -
-toLowerCase():String -
-
- - Returns a copy of this string, with all uppercase characters converted - - to lowercase.
-		String
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-toUpperCase():String -
-
- - Returns a copy of this string, with all lowercase characters converted - - to uppercase.
-		String
   -
-valueOf():String -
-
- - Returns the primitive value of a String instance.
-		String
-
- -
- -
Property detail
- - - - - -
lengthproperty
-
-length:int  [read-only]

- - - - -
Runtime version: AIR 1.0
-

- - An integer specifying the number of characters in the specified String object. - -

- - Because all string indexes are zero-based, the index of the last character for any - - string x is x.length - 1. - -

- - - Implementation -
-    public function get length():int -
-
- -
Constructor detail
- - - - - -
String()constructor
-
-public function String(val:String) -

- - - - -
Runtime version: AIR 1.0
-

- - Creates a new String object initialized to the specified string. - - - -

- - Note: Because string literals use less overhead than String - - objects and are generally easier to use, you should use string literals instead of the - - String class unless you have a good reason to use a String object rather than a string literal. - -

- - - Parameters - - - - -
val:String — The initial value of the new String object. - - -
-
- -
Method detail
- - - - - -
charAt()method
-
-AS3 function charAt(index:Number = 0):String -

- - - - -
Runtime version: AIR 1.0
-

- - Returns the character in the position specified by the index parameter. - - If index is not a number from 0 to string.length - 1, an - - empty string is returned. - -

- - This method is similar to String.charCodeAt() except that the returned - - value is a character, not a 16-bit integer character code. - -

- - - Parameters - - - - -
index:Number (default = 0) — An integer specifying the position of a character in the string. The first - - character is indicated by 0, and the last character is indicated by - - my_str.length - 1. - - -
-

-Returns - - - - -
String — - The character at the specified index. Or an empty string if the - - specified index is outside the range of this string's indices. - - - - -
-

-See also -

-
-charCodeAt() -
-
- - - - - -
charCodeAt()method 
-
-AS3 function charCodeAt(index:Number = 0):Number -

- - - - -
Runtime version: AIR 1.0
-

- - Returns the numeric Unicode character code of the character at the specified - - index. If index is not a number from 0 to - - string.length - 1, NaN is returned. - -

- - This method is similar to String.charAt() except that the returned - - value is a 16-bit integer character code, not the actual character. - -

- - - Parameters - - - - -
index:Number (default = 0) — An integer that specifies the position of a character in the string. The - - first character is indicated by 0, and the last character is indicated by - - my_str.length - 1. - - -
-

-Returns - - - - -
Number — - The Unicode character code of the character at the specified index. Or - - NaN if the index is outside the range of this string's indices. - -

Unicode values are defined in the Unicode Character Database - - specification.

- - - - - -
-

-See also -

-
-charAt() -
-
- - - - - -
concat()method 
-
-AS3 function concat(... args):String -

- - - - -
Runtime version: AIR 1.0
-

- - Appends the supplied arguments to the end of the String object, converting them to strings if - - necessary, and returns the resulting string. The original value of the source String object - - remains unchanged. - - -

Parameters - - - - -
... args — Zero or more values to be concatenated. - - -
-

-Returns - - - - -
String — - A new string consisting of this string concatenated - - with the specified parameters. - - - - -
-
- - - - - -
endsWith()method 
-
-AS3 function endsWith(other:String):Boolean -

- - - - -
Runtime version: AIR 51.0
-

- - Checks whether this String object ends with the string that is passed in. - - - This is a case-sensitive comparison, where the characters in this string are compared - - against the characters in the string that is passed in, and if all of those characters - - are found at the end of this string, the function returns true. - - -

Parameters - - - - -
other:String — The other string that is checked to see if it forms the end of this String. - - -
-

-Returns - - - - -
Boolean — - True if this String object ends with the passed-in String parameter. - - - - -
-
- - - - - -
fromCharCode()method 
-
-AS3 static function fromCharCode(... charCodes):String -

- - - - -
Runtime version: AIR 1.0
-

- - Returns a string comprising the characters represented by the Unicode character codes - - in the parameters. - - -

Parameters - - - - -
... charCodes — A series of decimal integers that represent Unicode values. - -

Unicode values are defined in the Unicode Character Database - - specification.

- - - -
-

-Returns - - - - -
String — - The string value of the specified Unicode character codes. - - - - -
-
- - - - - -
indexOf()method 
-
-AS3 function indexOf(val:String, startIndex:Number = 0):int -

- - - - -
Runtime version: AIR 1.0
-

- - Searches the string and returns the position of the first occurrence of val - - found at or after startIndex within the calling string. This index is zero-based, - - meaning that the first character in a string is considered to be at index 0--not index 1. If - - val is not found, the method returns -1. - - -

Parameters - - - - - - - - - - -
val:String — The substring for which to search. - - -
 
startIndex:Number (default = 0) — An optional integer specifying the starting index of the search. - - -
-

-Returns - - - - -
int — - The index of the first occurrence of the specified substring or -1. - - - - -
-

-See also -

-
-lastIndexOf() -
-
- - - - - -
lastIndexOf()method 
-
-AS3 function lastIndexOf(val:String, startIndex:Number = 0x7FFFFFFF):int -

- - - - -
Runtime version: AIR 1.0
-

- - Searches the string from right to left and returns the index of the last occurrence - - of val found before startIndex. The index is zero-based, - - meaning that the first character is at index 0, and the last is at string.length - - - 1. If val is not found, the method returns -1. - - -

Parameters - - - - - - - - - - -
val:String — The string for which to search. - - -
 
startIndex:Number (default = 0x7FFFFFFF) — An optional integer specifying the starting index from which to - - search for val. The default is the maximum value allowed for an index. - - If startIndex is not specified, the search starts at the last item in the string. - - -
-

-Returns - - - - -
int — - The position of the last occurrence of the specified substring or -1 if not found. - - - - -
-

-See also -

-
-indexOf() -
-
- - - - - -
localeCompare()method 
-
-AS3 function localeCompare(other:String, ... values):int -

- - - - -
Runtime version: AIR 1.0
-

- - Compares the sort order of two or more strings and returns the result of the comparison as an integer. While this - - method is intended to handle the comparison in a locale-specific way, the ActionScript 3.0 implementation - - does not produce a different result from other string comparisons such as the equality (==) or - - inequality (!=) operators. - - If the strings are equivalent, the return value is 0. - - If the original string value precedes the string value specified by other, - - the return value is a negative integer, the absolute value of which represents - - the number of characters that separates the two string values. - - If the original string value comes after other, - - the return value is a positive integer, the absolute value of which represents - - the number of characters that separates the two string values. - - -

Parameters - - - - - - - - - - -
other:String — A string value to compare. - -
 
... values — Optional set of more strings to compare. - -
-

-Returns - - - - -
int — - The value 0 if the strings are equal. Otherwise, a negative integer if the original - - string precedes the string argument and a positive integer if the string argument precedes - - the original string. In both cases the absolute value of the number represents the difference - - between the two strings. - - - - - -
-
- - - - - -
match()method 
-
-AS3 function match(pattern:*):Array -

- - - - -
Runtime version: AIR 1.0
-

- - Matches the specifed pattern against the - - string. - - -

Parameters - - - - -
pattern:* — The pattern to match, which can be any type of object, but is typically - - either a string or a regular expression. If the pattern is not a regular expression - - or a string, then the method converts it to a string before executing. - - - -
-

-Returns - - - - -
Array — - An array of strings consisting of all substrings in - - the string that match the specified pattern. - - - -

If pattern is a regular expression, in order to return an array with - - more than one matching substring, the g (global) flag must be set - - in the regular expression:

- - - -
    - - - -
  • If the g (global) flag is not set, - - the return array will contain no more than one match, and the lastIndex - - property of the regular expression remains unchanged.
    • - - - -
  • If the g (global) flag is set, the method starts the search at - - the beginning of the string (index position 0). If a matching substring is an empty string (which - - can occur with a regular expression such as /x*/), the method adds that - - empty string to the array of matches, and then continues searching at the next index position. - - The lastIndex property of the regular expression is set to 0 after the - - method completes.
    • - - - -
- - -

When the pattern parameter is a regular expression with the - - g (global) flag set, if no match is found the method returns - - an empty Array. If the pattern parameter is a String or a - - non-global regular expression and no match is found, the method returns - - null. If you pass no value (or an undefined value) as the - - pattern parameter, the method returns null.

- - - - - - -
-

-See also -

-
-RegExp -
-
- - - - - -
replace()method 
-
-AS3 function replace(pattern:*, repl:Object):String -

- - - - -
Runtime version: AIR 1.0
-

- - Matches the specifed pattern against the string and returns a new string - - in which the first match of pattern is replaced with the content specified by repl. - - The pattern parameter can be a string or a regular expression. The repl parameter - - can be a string or a function; if it is a function, the string returned - - by the function is inserted in place of the match. The original string is not modified. - - - -

In the following example, only the first instance of "sh" (case-sensitive) - - is replaced:

- - - 
-
-    var myPattern:RegExp = /sh/;  
-
-    var str:String = "She sells seashells by the seashore.";
-
-    trace(str.replace(myPattern, "sch"));  
-
-       // She sells seaschells by the seashore.
- - - -

In the following example, all instances of "sh" (case-sensitive) - - are replaced because the g (global) flag is set in the regular expression:

- - - 
-
-    var myPattern:RegExp = /sh/g;  
-
-    var str:String = "She sells seashells by the seashore.";
-
-    trace(str.replace(myPattern, "sch"));  
-
-       // She sells seaschells by the seaschore.
- - - -

In the following example, all instance of "sh" - - are replaced because the g (global) flag is set in the regular expression - - and the matches are not case-sensitive because the i (ignoreCase) flag is set:

- - - 
-
-    var myPattern:RegExp = /sh/gi;  
-
-    var str:String = "She sells seashells by the seashore.";
-
-    trace(str.replace(myPattern, "sch"));  
-
-       // sche sells seaschells by the seaschore.
- - - - Parameters - - - - - - - - - - -
pattern:* — The pattern to match, which can be any type of object, but it is typically - - either a string or a regular expression. If you specify a pattern parameter - - that is any object other than a string or a regular expression, the toString() method is - - applied to the parameter and the replace() method executes using the resulting string - - as the pattern. - - -
 
repl:Object — Typically, the string that is inserted in place of the matching content. However, you can - - also specify a function as this parameter. If you specify a function, the string returned - - by the function is inserted in place of the matching content. - - - -

When you specify a string as the repl parameter and specify a regular expression - - as the pattern parameter, you can use the following special $ replacement codes - - in the repl string:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
$ Code - - Replacement Text - -
$$ - - $ - -
$& - - The matched substring. - -
$` - - The portion of the string that precedes the matched substring. - - Note that this code uses the straight left single quote character (`), - - not the straight single quote character (') or the left curly single quote - - character (‘). - -
$' - - The portion of string that follows the matched substring. - - Note that this code uses the straight single quote character ('). - -
$n - - The nth captured parenthetical group match, where n is a single - - digit 1-9 and $n is not followed by a decimal digit. - -
$nn - - The nnth captured parenthetical group match, where nn is a two-digit - - decimal number (01-99). If the nnth capture is undefined, the replacement text - - is an empty string. - -
- - - -

For example, the following shows the use of the $2 and $1 - - replacement codes, which represent the first and second capturing group matched:

- - - - 
var str:String = "flip-flop";
-
-    var pattern:RegExp = /(\w+)-(\w+)/g;
-
-    trace(str.replace(pattern, "$2-$1")); // flop-flip
- - - -

When you specify a function as the repl, the replace() method - - passes the following parameters to the function: - -

- - - -
    - - - -
  • - - The matching portion of the string. - -
    • - - - -
  • - - Any captured parenthetical group matches are provided as the next arguments. The number of arguments passed - - this way will vary depending on the number of parenthetical matches. You can determine the - - number of parenthetical matches by checking arguments.length - 3 within the function - - code. - -
    • - - - -
  • - - The index position in the string where the match begins. - -
    • - - - -
  • - - The complete string. - -
    • - - - -
- - - -

For example, consider the following:

- - - - 
-
-    var str1:String = "abc12 def34";
-
-    var pattern:RegExp = /([a-z]+)([0-9]+)/;
-
-    var str2:String = str1.replace(pattern, replFN);
-
-    trace (str2);   // 12abc 34def
-
-    
-
-    function replFN():String {
-
-      return arguments[2] + arguments[1];
-
-    }
- - - - - -

The call to the replace() method uses a function as the repl - - parameter. The regular expression (/([a-z]([0-9]/g) is matched twice. The - - first time, the pattern matches the substring "abc12", and the following list - - of arguments is passed to the function: - -

- - - - 
-
-    {"abc12", "abc", "12", 0, "abc12 def34"}
- - - - - -

The second time, the pattern matches the substring "def23", and the - - following list of arguments is passed to the function: - -

- - - 
-
-    {"def34", "def", "34", 6, "abc123 def34"}
- - - - - -
-

-Returns - - - - -
String — - The resulting string. Note that the source string remains unchanged. - - - - - -
-

-See also -

-
-RegExp -
-
- - - - - -
search()method 
-
-AS3 function search(pattern:*):int -

- - - - -
Runtime version: AIR 1.0
-

- - Searches for the specifed pattern and returns the index of - - the first matching substring. If there is no matching substring, the method returns - - -1. - - - -

Parameters - - - - -
pattern:* — The pattern to match, which can be any type of object but is typically - - either a string or a regular expression.. If the pattern is not a regular expression - - or a string, then the method converts it to a string before executing. - - Note that if you specify a regular expression, the method ignores the global flag ("g") of the - - regular expression, and it ignores the lastIndex property of the regular - - expression (and leaves it unmodified). If you pass an undefined value (or no value), - - the method returns -1. - - - -
-

-Returns - - - - -
int — - The index of the first matching substring, or -1 if - - there is no match. Note that the string is zero-indexed; the first character of - - the string is at index 0, the last is at string.length - 1. - - - - - -
-

-See also -

-
-RegExp -
-
- - - - - -
slice()method 
-
-AS3 function slice(startIndex:Number = 0, endIndex:Number = 0x7fffffff):String -

- - - - -
Runtime version: AIR 1.0
-

- - Returns a string that includes the startIndex character - - and all characters up to, but not including, the endIndex character. The original String object is not modified. - - If the endIndex parameter is not specified, then the end of the - - substring is the end of the string. If the character indexed by startIndex is the same as or to the right of the - - character indexed by endIndex, the method returns an empty string. - - - - - - -

Parameters - - - - - - - - - - -
startIndex:Number (default = 0) — The zero-based index of the starting point for the slice. If - - startIndex is a negative number, the slice is created from right-to-left, where - - -1 is the last character. - - -
 
endIndex:Number (default = 0x7fffffff) — An integer that is one greater than the index of the ending point for - - the slice. The character indexed by the endIndex parameter is not included in the extracted - - string. - - If endIndex is a negative number, the ending point is determined by - - counting back from the end of the string, where -1 is the last character. - - The default is the maximum value allowed for an index. If this parameter is omitted, String.length is used. - - -
-

-Returns - - - - -
String — - A substring based on the specified indices. - - - - -
-

-See also -

-
-substr() -
-substring() -
-
- - - - - -
split()method 
-
-AS3 function split(delimiter:*, limit:Number = 0x7fffffff):Array -

- - - - -
Runtime version: AIR 1.0
-

- - Splits a String object into an array of substrings - - by dividing it wherever the specified delimiter parameter - - occurs. - - - -

If the delimiter parameter is a regular expression, only - - the first match at a given position of the string is considered, - - even if backtracking could find a nonempty substring match at that - - position. For example:

- - - - 
-
-     var str:String = "ab";
-
-     var results:Array = str.split(/a*?/); // results == ["","b"]
-
-     
-
-     results = str.split(/a*/); // results == ["","b"].)
- - - - - -

If the delimiter parameter is a regular expression - - containing grouping parentheses, then each time the - - delimiter is matched, the results (including any - - undefined results) of the grouping parentheses are spliced into the - - output array. For example

- - - - 
-
-     var str:String = "Thi5 is a tricky-66 example.";
-
-     var re:RegExp = /(\d+)/;
-
-     var results:Array = str.split(re);
-
-         // results == ["Thi","5"," is a tricky-","66"," example."]
- - - - - -

If the limit parameter is specified, then - - the returned array will have no more than the specified - - number of elements.

- -

If the delimiter is an empty string, an empty - - regular expression, or a regular expression that can match an empty - - string, each single character in the string - - is output as an element in the array.

- - - -

If the delimiter parameter is undefined, the entire - - string is placed into the first element of the returned - - array.

- - - Parameters - - - - - - - - - - -
delimiter:* — The pattern that specifies where to split this string. This can be any type of - - object but is typically either a string or a regular expression. If the delimiter - - is not a regular expression or string, then the method converts it to a string before executing. - - -
 
limit:Number (default = 0x7fffffff) — The maximum number of items to place into the array. - - The default is the maximum value allowed. - - - - -
-

-Returns - - - - -
Array — - An array of substrings. - - - - - - -
-

-See also -

-
-Array.join() -
-RegExp -
-
- - - - - -
startsWith()method 
-
-AS3 function startsWith(other:String):Boolean -

- - - - -
Runtime version: AIR 51.0
-

- - Checks whether this String object starts with the string that is passed in. - - - This is a case-sensitive comparison, where the characters in this string are compared - - against the characters in the string that is passed in, and if all of those characters - - are found at the start of this string, the function returns true. - - -

Parameters - - - - -
other:String — The other string that is checked to see if it forms the start of this String. - - -
-

-Returns - - - - -
Boolean — - True if this String object starts with the passed-in String parameter. - - - - -
-
- - - - - -
substr()method 
-
-AS3 function substr(startIndex:Number = 0, len:Number = 0x7fffffff):String -

- - - - -
Runtime version: AIR 1.0
-

- - Returns a substring consisting of the characters that start at the specified - - startIndex and with a length specified by len. The original - - string is unmodified. - - - -

Parameters - - - - - - - - - - -
startIndex:Number (default = 0) — An integer that specified the index of the first character to be - - used to create the substring. If startIndex is a negative number, the - - starting index is determined from the end of the string, where -1 is the - - last character. - - -
 
len:Number (default = 0x7fffffff) — The number of characters in the substring being created. - - The default value is the maximum value allowed. If len - - is not specified, the substring includes all the characters from startIndex - - to the end of the string. - - -
-

-Returns - - - - -
String — - A substring based on the specified parameters. - - - - -
-
- - - - - -
substring()method 
-
-AS3 function substring(startIndex:Number = 0, endIndex:Number = 0x7fffffff):String -

- - - - -
Runtime version: AIR 1.0
-

- - Returns a string consisting of the character specified by startIndex - - and all characters up to endIndex - 1. If endIndex is not - - specified, String.length is used. If the value of startIndex - - equals the value of endIndex, the method returns an empty string. - - If the value of startIndex is greater than the value of - - endIndex, the parameters are automatically swapped before the function - - executes. The original string is unmodified. - - - -

Parameters - - - - - - - - - - -
startIndex:Number (default = 0) — An integer specifying the index of the first character used to create - - the substring. Valid values for startIndex are 0 through - - String.length. If startIndex is a negative value, 0 - - is used. - - -
 
endIndex:Number (default = 0x7fffffff) — An integer that is one greater than the index of the last character in the - - extracted substring. Valid values for endIndex are 0 through - - String.length. The character at endIndex is not included in - - the substring. The default is the maximum value allowed for an index. - - If this parameter is omitted, String.length is used. If - - this parameter is a negative value, 0 is used. - - -
-

-Returns - - - - -
String — - A substring based on the specified parameters. - - - - -
-
- - - - - -
toLocaleLowerCase()method 
-
-AS3 function toLocaleLowerCase():String -

- - - - -
Runtime version: AIR 1.0
-

- - Returns a copy of this string, with all uppercase characters converted - - to lowercase. The original string is unmodified. While this - - method is intended to handle the conversion in a locale-specific way, the ActionScript 3.0 implementation - - does not produce a different result from the toLowerCase() method. - - -

-Returns - - - - -
String — - A copy of this string with all uppercase characters converted - - to lowercase. - - - - - -
-

-See also -

-
-toLowerCase() -
-
- - - - - -
toLocaleUpperCase()method 
-
-AS3 function toLocaleUpperCase():String -

- - - - -
Runtime version: AIR 1.0
-

- - Returns a copy of this string, with all lowercase characters converted - - to uppercase. The original string is unmodified. While this - - method is intended to handle the conversion in a locale-specific way, the ActionScript 3.0 implementation - - does not produce a different result from the toUpperCase() method. - - - -

-Returns - - - - -
String — - A copy of this string with all lowercase characters converted - - to uppercase. - - - - -
-

-See also -

-
-toUpperCase() -
-
- - - - - -
toLowerCase()method 
-
-AS3 function toLowerCase():String -

- - - - -
Runtime version: AIR 1.0
-

- - Returns a copy of this string, with all uppercase characters converted - - to lowercase. The original string is unmodified. - - - -

This method converts all characters (not simply A-Z) for which Unicode lowercase - - equivalents exist:

- - - - 
-
-     var str:String = " JOSÉ BARÇA";
-
-     trace(str.toLowerCase()); // josé barça
- - - -

These case mappings are defined in the Unicode Character Database - - specification.

- - - -

-Returns - - - - -
String — - A copy of this string with all uppercase characters converted - - to lowercase. - - - - -
-

-See also -

-
-toUpperCase() -
-
- - - - - -
toUpperCase()method 
-
-AS3 function toUpperCase():String -

- - - - -
Runtime version: AIR 1.0
-

- - Returns a copy of this string, with all lowercase characters converted - - to uppercase. The original string is unmodified. - - -

This method converts all characters (not simply a-z) for which Unicode uppercase - - equivalents exist:

- - - - 
-
-     var str:String = "José Barça";
-
-     trace(str.toUpperCase()); // JOSÉ BARÇA
- - -

These case mappings are defined in the Unicode Character Database - - specification.

- - - -

-Returns - - - - -
String — - A copy of this string with all lowercase characters converted - - to uppercase. - - - - - -
-

-See also -

-
-toLowerCase() -
-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns the primitive value of a String instance. This method is designed to - - convert a String object into a primitive string value. Because Flash runtimes - - automatically call valueOf() when necessary, - - you rarely need to call this method explicitly. - - - -

-Returns - - - - -
String — - The value of the string. - - - - -
-
- -
Examples
-
examples\StringExample
-
The following example uses the StringExample and - StringHelper classes to show how various methods of the String class are used. - This is accomplished using the following steps: -
    -
  1. The constructor for StringExample declares several local String instances, - which are initialized with various strings and a new StringHelper object.
    2. -
  2. The StringHelper class has the following methods: -
      -
    • replace(): calls the split() and join() methods of - String to remove a substring of the string passed in with a new one.
      • -
    • trim(): calls both trimBack() and trimFront() using the - strings passed in and returns the updated string.
      • -
    • trimFront():recursively removes all characters that match the char - parameter, starting from the front of the string and working toward the end, until the first character in - the string does not match char and returns the updated string.
      • -
    • trimBack(): recursively removes all characters that match the char - parameter, starting from the end of the string and working backward, until the last character in - the string does not match char and returns the updated string.
      • -
    • stringToCharacter(): returns the first character of the string passed to it.
      • -
    -
    3. -
  3. Three strings are then produced using the declared string variables with a call to the - replace() method used to produce the second string and trim() to produce the - third string.
    4. -
-
-
-package {
-    import flash.display.Sprite;
-
-    public class StringExample extends Sprite {
-        public function StringExample() {
-            var companyStr:String = new String("     Company X");
-            var productStr:String = "Product Z Basic     ";
-            var emptyStr:String = " ";
-            var strHelper:StringHelper = new StringHelper();
-
-            var companyProductStr:String = companyStr + emptyStr + productStr;
-            trace("'" + companyProductStr + "'");    // '     Company X Product Z Basic     '
-
-            companyProductStr = strHelper.replace(companyProductStr, "Basic", "Professional");
-            trace("'" + companyProductStr + "'");    // '     Company X Product Z Professional     '
-
-            companyProductStr = strHelper.trim(companyProductStr, emptyStr);
-            trace("'" + companyProductStr + "'");    // 'Company X Product Z Professional'
-        }
-    }
-}
-
-class StringHelper {
-    public function StringHelper() {
-    }
-
-    public function replace(str:String, oldSubStr:String, newSubStr:String):String {
-        return str.split(oldSubStr).join(newSubStr);
-    }
-
-    public function trim(str:String, char:String):String {
-        return trimBack(trimFront(str, char), char);
-    }
-
-    public function trimFront(str:String, char:String):String {
-        char = stringToCharacter(char);
-        if (str.charAt(0) == char) {
-            str = trimFront(str.substring(1), char);
-        }
-        return str;
-    }
-
-    public function trimBack(str:String, char:String):String {
-        char = stringToCharacter(char);
-        if (str.charAt(str.length - 1) == char) {
-            str = trimBack(str.substring(0, str.length - 1), char);
-        }
-        return str;
-    }
-
-    public function stringToCharacter(str:String):String {
-        if (str.length == 1) {
-            return str;
-        }
-        return str.slice(0, 1);
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/SyntaxError.html b/html-docs/SyntaxError.html deleted file mode 100644 index 1996b6d..0000000 --- a/html-docs/SyntaxError.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - -SyntaxError (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class SyntaxError
InheritanceSyntaxError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - A SyntaxError exception is thrown when a parsing error occurs, for one of the following reasons:. - -
    - -
  • An invalid regular expression is parsed by the RegExp class.
    • - -
  • Invalid XML content is parsed by the XML class.
    • - -
- - - -

-

-See also -

-
-RegExp class -
-XML class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SyntaxError(message:String = "")
-
- - Creates a new SyntaxError object.
-		SyntaxError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
SyntaxError()constructor
-
-public function SyntaxError(message:String = "") -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new SyntaxError object. - -

Parameters - - - - -
message:String (default = "") — Contains the message associated with the SyntaxError object. - - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/TimeZone.html b/html-docs/TimeZone.html deleted file mode 100644 index 1b3ae3e..0000000 --- a/html-docs/TimeZone.html +++ /dev/null @@ -1,558 +0,0 @@ - - - - - - - - -TimeZone (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic class TimeZone
InheritanceTimeZone Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

-

- - The TimeZone class provides information about timezones that can be used in date calculations - - and to find out about different locations and their time zone offsets. The information available - - will vary according to the operating system being used as the time zone objects are created based - - on APIs that are made available by the device OS. - - -

To list available time zones, use the TimeZone.availableTimeZoneNames property which will - - be initialized on first use by the operating system. Strings that are available here can then be - - used to create a TimeZone object using the TimeZone.getTimeZone method.

- - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  availableTimeZoneNames : Vector.<String>
[static][read-only] - - Retrieves a list of the available time zone names that can be used on this operating system.
-		TimeZone
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  daylightSavingsOffset : int -
[read-only] - - The offset between this time zone and UTC during daylight savings, in milliseconds.
-		TimeZone
  displayName : String -
[read-only] - - The display name of this time zone.
-		TimeZone
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rawOffset : int -
[read-only] - - The standard offset between this time zone and UTC, in milliseconds.
-		TimeZone
  usesDaylightSavings : Boolean -
[read-only] - - Whether this time zone has a daylight savings change.
-		TimeZone
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-getOffset(date:Date):int -
-
- - The time offset between this timezone and UTC, for a particular (UTC) date.
-		TimeZone
   -
-getTimeZone(timeZoneName:String):TimeZone -
-
[static] - - Obtains a TimeZone object using a string that is found in the list of availableTimeZoneNames.
-		TimeZone
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
availableTimeZoneNamesproperty
-
-availableTimeZoneNames:Vector.<String>  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - Retrieves a list of the available time zone names that can be used on this operating system. - - -

Implementation -
-    public static function get availableTimeZoneNames():Vector.<String> -
-
- - - - - -
daylightSavingsOffsetproperty 
-
-daylightSavingsOffset:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - The offset between this time zone and UTC during daylight savings, in milliseconds. - -

Note: if this time zone does not use daylight savings, this value will be the same - - as the value of rawOffset.

- - - Implementation -
-    public function get daylightSavingsOffset():int -
-
- - - - - -
displayNameproperty 
-
-displayName:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - The display name of this time zone. - - -

Implementation -
-    public function get displayName():String -
-
- - - - - -
rawOffsetproperty 
-
-rawOffset:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - The standard offset between this time zone and UTC, in milliseconds. - - -

Implementation -
-    public function get rawOffset():int -
-
- - - - - -
usesDaylightSavingsproperty 
-
-usesDaylightSavings:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - Whether this time zone has a daylight savings change. - - -

Implementation -
-    public function get usesDaylightSavings():Boolean -
-
- -
Method detail
- - - - - -
getOffset()method
-
-public function getOffset(date:Date):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - The time offset between this timezone and UTC, for a particular (UTC) date. - -

Note: for any date in UTC format, there should be exactly one match for the - - offset value. Reversing this process does not always work, for example some local - - times do not exist due to clocks changing forward, and some local times happen twice - - due to the clocks changing backwards. Hence to find the correct offset, the input - - date must be in UTC format.

- - - Parameters - - - - -
date:Date — The date/time information at which to check the time offset - -
-

-Returns - - - - -
int — - The offset, in milliseconds, between GMT and local time at the given date. - - - - -
-
- - - - - -
getTimeZone()method 
-
-public static function getTimeZone(timeZoneName:String):TimeZone -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - Obtains a TimeZone object using a string that is found in the list of availableTimeZoneNames. - - Pass in a null string to get the TimeZone object representing the current location of the device. - - -

Parameters - - - - -
timeZoneName:String — The name of the time zone to retrieve, or null for the current device time zone. - -
-

-Returns - - - - -
TimeZone — - The TimeZone object corresponding to the requested time zone - - - - -
-
-Throws - - - - -
ArgumentError — If the requested timeZoneName is not a valid name (and isn't null) - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/TypeError.html b/html-docs/TypeError.html deleted file mode 100644 index d6232a9..0000000 --- a/html-docs/TypeError.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - -TypeError (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class TypeError
InheritanceTypeError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - A TypeError exception is thrown when the actual type of an operand is different - - from the expected type. - -

- - In addition, this exception is thrown when: - -

    - -
  • An actual parameter to a function or method could not be coerced to the formal - - parameter type.
    • - -
  • A value is assigned to a variable and cannot be coerced to the variable's type.
    • - -
  • The right side of the is or instanceof operator is not a valid type.
    • - -
  • The super keyword is used illegally.
    • - -
  • A property lookup results in more than one binding, and is therefore ambiguous.
    • - -
  • A method is invoked on an incompatible object. For example, a TypeError - - exception is thrown if a RegExp class method is "grafted" onto a generic object - - and then invoked.
    • - -
- -

- - -

-

-View the examples. -

-

-See also -

-
-is operator -
-instanceof operator -
-super statement -
-RegExp class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TypeError(message:String = "")
-
- - Creates a new TypeError object.
-		TypeError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
TypeError()constructor
-
-public function TypeError(message:String = "") -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new TypeError object. - -

Parameters - - - - -
message:String (default = "") — Contains the message associated with the TypeError object. - - - -
-
- -
Examples
-
examples\TypeErrorExample
-
The following example shows how a TypeError exception can - be generated and handled within a try..catch statement. -
-
-package {
-    import flash.display.DisplayObject;
-	import flash.display.Sprite;
-
-	public class TypeErrorExample extends Sprite {
-		public function TypeErrorExample() {
-			try {
-				var child:Object = new Object();
-				addChild(DisplayObject(child));
-			}
-			catch(e:TypeError) {
-				trace(e);
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/URIError.html b/html-docs/URIError.html deleted file mode 100644 index aebde12..0000000 --- a/html-docs/URIError.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - - - - -URIError (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class URIError
InheritanceURIError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - A URIError exception is thrown when one of the global URI handling functions is used - - in a way that is incompatible with its definition. This exception is thrown when an invalid - - URI is specified to a function that expects a valid URI, such as the Socket.connect() - - method. - - - - - -

-

-See also -

-
-flash.net.Socket.connect() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-URIError(message:String = "")
-
- - Creates a new URIError object.
-		URIError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
URIError()constructor
-
-public function URIError(message:String = "") -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new URIError object. - -

Parameters - - - - -
message:String (default = "") — Contains the message associated with the URIError object. - - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/Vector.html b/html-docs/Vector.html deleted file mode 100644 index 7312211..0000000 --- a/html-docs/Vector.html +++ /dev/null @@ -1,2287 +0,0 @@ - - - - - - - - -Vector (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class Vector
InheritanceVector Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

-

- The Vector class lets you access and manipulate a vector — an array whose elements - all have the same data type. The data type of a Vector's elements is - known as the Vector's base type. The base type can be any class, - including built in classes and custom classes. The base type is specified when - declaring a Vector variable as well as when creating an instance by calling - the class constructor. - -

As with an Array, you can use the array access operator ([]) to - set or retrieve the value of a Vector element. Several Vector methods also - provide mechanisms for setting and retrieving element values. These include - push(), pop(), shift(), unshift(), - and others. The properties - and methods of a Vector object are similar — in most cases identical — to - the properties and methods of an Array. In most cases where you would use - an Array in which all the elements have the same data type, a Vector instance - is preferable. However, Vector instances are dense arrays, meaning it must have a value - (or null) in each index. Array instances - don't have this same restriction.

- -

The Vector's base type is specified using postfix - type parameter syntax. Type parameter syntax is a sequence consisting of - a dot (.), left angle bracket (<), class name, - then a right angle bracket (>), as shown in this example:

- -

In the first line of the example, the variable v is declared as a - Vector.<String> instance. In other words, it represents a Vector (an array) - that can only hold String instances and from which only String instances can be retrieved. - The second line constructs an instance of the same Vector type (that is, a - Vector whose elements are all String objects) and assigns it to v.

- - 
- var v:Vector.<String>;
- v = new Vector.<String>();
-
-

Use brackets to define a vector's base type when calling - the Vector constructor function. The string included in the brackets is a sequence consisting of - a left angle bracket (<), the base class name, then a right angle bracket (>), - as shown in this example:

- - 
- var v = new air.Vector["<String>"]();
-
-

To add items to a Vector, you can use the push() - method. For example, the following code adds content to a Vector of String objects:

- - 
- var v = new air.Vector["<String>"]();
- v.push("a", "b", "c");
-
-

In this API reference for AIR HTML developers, - properties that are defined as Vector types are listed using - Vector.<T> syntax. In this syntax, T represents - the data type of the elements in the Vector. For example, the - NativeProcessStartupInfo class includes an arguments - property. The API reference lists this property as having the type - Vector.<String>, meaning that the property is a Vector - containing String objects. Other references to Vector objects in this - documentation also uses this syntax, which is used in ActionScript 3.0.

- -

A variable declared with the Vector.<T> data type can only store - a Vector instance that is constructed with the same base type - T. For example, a Vector that's constructed by calling - new Vector.<String>() can't be assigned to a variable - that's declared with the Vector.<int> data type. The base types must match exactly. - For example, the following code doesn't compile because the object's base type isn't - the same as the variable's declared base type (even though Sprite is a subclass of - DisplayObject):

- - 
- // This code doesn't compile even though Sprite is a DisplayObject subclass
- var v:Vector.<DisplayObject> = new Vector.<Sprite>();
-
- -

To convert a Vector with base type T to a Vector of a superclass of - T, use the Vector() global function.

- -

In addition to the data type restriction, the Vector class has other restrictions - that distinguish it from the Array class:

- -
    -
  • A Vector is a dense array. Unlike an Array, which may have values in indices - 0 and 7 even if there are no values in positions 1 through 6, a Vector must have - a value (or null) in each index.
    • -
  • A Vector can optionally be fixed-length, meaning the number of elements - it contains can't change.
    • -
  • Access to a Vector's elements is bounds-checked. You can never read a value - from an index greater than the final element (length - 1). You - can never set a value with an index more than one beyond the current final - index (in other words, you can only set a value at an existing index or - at index [length]).
    • -
- -

As a result of its restrictions, a Vector has three primary benefits over - an Array instance whose elements are all instances of a single class:

-
    -
  • Performance: array element access and iteration are much faster when - using a Vector instance than they are when using an Array.
    • -
  • Type safety: in strict mode the compiler can identify data type errors. Examples - of data type errors include assigning a value of the incorrect data type to a Vector - or expecting the wrong data type when reading a value from a Vector. - Note, however, that when using the - push() method or unshift() method to add values to a Vector, the - arguments' data types are not checked at compile time. Instead, they are checked at run time.
    • -
  • Reliability: runtime range checking (or fixed-length checking) increases reliability - significantly over Arrays.
    • -
-

-

-See also -

-
-[] array access -
-Vector() global function -
-Array class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fixed : Boolean -
- Indicates whether the length property of the Vector can - be changed.
-		Vector
  length : uint -
- The range of valid indices available in the Vector.
-		Vector
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Vector(length:uint = 0, fixed:Boolean = false)
-
- Creates a Vector with the specified base type.
-		Vector
   -
-concat(... args):Vector.<T>
-
- Concatenates the Vectors specified in the parameters list with the elements - in this Vector and creates a new Vector.
-		Vector
   -
-every(callback:Function, thisObject:Object = null):Boolean -
-
- Executes a test function on each item in the Vector until an item is - reached that returns false for the specified function.
-		Vector
   -
-filter(callback:Function, thisObject:Object = null):Vector.<T>
-
- Executes a test function on each item in the Vector and returns - a new Vector containing all items that return true for the - specified function.
-		Vector
   -
-forEach(callback:Function, thisObject:Object = null):void -
-
- Executes a function on each item in the Vector.
-		Vector
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-includes(item:*):Boolean -
-
- Checks whether the vector includes the item that is passed in.
-		Vector
   -
-indexOf(searchElement:T, fromIndex:int = 0):int -
-
- Searches for an item in the Vector and returns the index position of the item.
-		Vector
   -
-insertAt(index:int, element:T):void -
-
- Insert a single element into the Vector.
-		Vector
   -
-isEmpty():Boolean -
-
- Checks whether the vector is empty.
-		Vector
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-join(sep:String = ","):String -
-
- Converts the elements in the Vector to strings, inserts the specified separator between the - elements, concatenates them, and returns the resulting string.
-		Vector
   -
-lastIndexOf(searchElement:T, fromIndex:int = 0x7fffffff):int -
-
- Searches for an item in the Vector, working backward from the specified - index position, and returns the index position of the matching item.
-		Vector
   -
-map(callback:Function, thisObject:Object = null):Vector.<T>
-
- Executes a function on each item in the Vector, and returns a new Vector - of items corresponding to the results of calling the function on - each item in this Vector.
-		Vector
   -
-pop():T
-
- Removes the last element from the Vector and returns that element.
-		Vector
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-push(... args):uint -
-
- Adds one or more elements to the end of the Vector and returns - the new length of the Vector.
-		Vector
   -
-removeAt(index:int):T
-
- Remove a single element from the Vector.
-		Vector
   -
-reverse():Vector.<T>
-
- Reverses the order of the elements in the Vector.
-		Vector
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-shift():T
-
- Removes the first element from the Vector and returns that element.
-		Vector
   -
-slice(startIndex:int = 0, endIndex:int = 16777215):Vector.<T>
-
- Returns a new Vector that consists of a range of elements from - the original Vector, without modifying the original Vector.
-		Vector
   -
-some(callback:Function, thisObject:Object = null):Boolean -
-
- Executes a test function on each item in the Vector until an - item is reached that returns true.
-		Vector
   -
-sort(sortBehavior:*):Vector.<T>
-
- Sorts the elements in the Vector object, and also returns a sorted Vector object.
-		Vector
   -
-splice(startIndex:int, deleteCount:uint = 4294967295, ... items):Vector.<T>
-
- Adds elements to and removes elements from the Vector.
-		Vector
   -
-toLocaleString():String -
-
- Returns a string that represents the elements in the specified Vector.
-		Vector
   -
-toString():String -
-
- Returns a string that represents the elements in the Vector.
-		Vector
   -
-unshift(... args):uint -
-
- Adds one or more elements to the beginning of the Vector and returns - the new length of the Vector.
-		Vector
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
fixedproperty
-
-fixed:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates whether the length property of the Vector can - be changed. If the value is true, the length - property can't be changed. This means the following operations are not - allowed when fixed is true: - -

    -
  • setting the length property directly
    • -
  • assigning a value to index position length
    • -
  • calling a method that changes the length property, including: -
      -
    • pop()
      • -
    • push()
      • -
    • shift()
      • -
    • unshift()
      • -
    • splice() (if the splice() call changes - the length of the Vector).
      • -
    -
    • -
- -

Implementation -
-    public function get fixed():Boolean -
-    public function set fixed(value:Boolean):void -
-
- - - - - -
lengthproperty 
-
-length:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The range of valid indices available in the Vector. - A Vector instance has index positions up to but not including - the length value. - -

Every Vector element always has a value that is either an - instance of the base type or null. When the - length property is set to a value - that's larger than its previous value, additional elements are - created and populated with the default value appropriate to - the base type (null for reference types).

- -

When the length property is set to a value - that's smaller than its previous value, all the elements - at index positions greater than or equal to the new length - value are removed from the Vector.

- - Implementation -
-    public function get length():uint -
-    public function set length(value:uint):void -
-
-Throws -
- - - - - - - - - - -
RangeError — If this property is changed - while fixed is true. - -
 
RangeError — If this property is set to a value larger - than the maximum allowable index (232). - -
-
- -
Constructor detail
- - - - - -
Vector()constructor
-
-public function Vector(length:uint = 0, fixed:Boolean = false) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a Vector with the specified base type. - -

When calling the Vector.<T>() constructor, specify the - base type using type parameter syntax. Type parameter syntax is a - sequence consisting of a dot (.), left angle bracket - (<), class name, then a right angle bracket - (>), as shown in this example:

- - 
-     var v:Vector.<String> = new Vector.<String>();
-
- -

When calling the Vector() constructor, use brackets - to specify the base type as a string using type parameter syntax. Type parameter syntax is a - a string consisting of a left angle bracket (<), class name, then - a right angle bracket (>), as shown in this example:

- - 
-     var v = new air.Vector["<String>"]();
-
- -

To create a Vector instance from an Array or another Vector (such as one with a different base type), - use the Vector() global function.

- -

To create a pre-populated Vector instance, use the following syntax instead of using the parameters specified below:

- 
-     // var v:Vector.<T> = new <T>[E0, ..., En-1 ,];
-     // For example: 
-     var v:Vector.<int> = new <int>[0,1,2,];
-
-

The following information applies to this syntax: -

    -
  • It is supported in Flash Professional CS5 and later, Flash Builder 4 and later, and Flex 4 and later.
    • -
  • The trailing comma is optional.
    • -
  • Empty items in the array are not supported; a statement such as var v:Vector.<int> = new <int>[0,,2,] - throws a compiler error.
    • -
  • You can't specify a default length for the Vector instance. Instead, the length is the same as the number of elements - in the initialization list.
    • -
  • You can't specify whether the Vector instance has a fixed length. Instead, use the fixed property.
    • -
  • Data loss or errors can occur if items passed as values don't match the specified type. For example:
    • - - 
    -     var v:Vector.<int> = new <int>[4.2]; // compiler error when running in strict mode
-     trace(v[0]); //returns 4 when not running in strict mode
-
    -

- -

Parameters - - - - - - - - - - -
length:uint (default = 0) — The initial length (number of elements) of the Vector. If - this parameter is greater than zero, the specified number of Vector elements - are created and populated with the default value appropriate to - the base type (null for reference types). - -
 
fixed:Boolean (default = false) — Whether the Vector's length is fixed (true) or - can be changed (false). This value can also be set using - the fixed property. -
-

-See also -

-
-fixed -
-Vector() global function -
-
- -
Method detail
- - - - - -
concat()method
-
-AS3 function concat(... args):Vector.<T> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Concatenates the Vectors specified in the parameters list with the elements - in this Vector and creates a new Vector. The Vectors in the parameters list - must have the same base type, or subtype, as this Vector. - If you do not pass any parameters, - the returned Vector is a duplicate (shallow clone) of the original Vector. - -

Parameters - - - - -
... args — Zero or more Vectors of the base type, or subtype, of this Vector. -
-

-Returns - - - - -
Vector.<T> — A Vector with the same base type as this Vector that contains - the elements from this Vector followed by elements from the Vectors - in the parameters list. - -
-
-Throws - - - - -
TypeError — If any argument is not a Vector of the base type, - or cannot be converted to a Vector of the base type. - -
-
- - - - - -
every()method 
-
-AS3 function every(callback:Function, thisObject:Object = null):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Executes a test function on each item in the Vector until an item is - reached that returns false for the specified function. - You use this method to determine whether all items in a Vector meet - a criterion, such as having values less than a particular number. -

For this method, the second parameter, - thisObject, must be null if the - first parameter, callback, is a method closure. That is - the most common way of using this method.

- -

However, suppose you create a function on a frame on the main timeline using Flash Professional, - but you want it to be called in a different this context:

- - 
-    function myFunction(item:T, index:int, vector:Vector.<T>):Boolean {
-       // your code here
-    }
-
- -

Suppose you then use the every() - method on a Vector called myVector:

- - 
-    myVector.every(myFunction, someObject);
-
- -

Because myFunction is a member of the - main class of the SWF file, it cannot be executed in a different this context. Flash - runtimes throw an exception when this code runs. You can avoid this runtime error - by assigning the function to a variable, as follows:

- - 
-    var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):Boolean {
-        //your code here
-    };
-    myVector.every(myFunction, someObject);
-
- - Parameters - - - - - - - - - - -
callback:Function — The function to run on each item in the Vector. - This function is invoked - with three arguments: the current item from the Vector, the index of the item, - and the Vector object: - 
function callback(item:T, index:int, vector:Vector.<T>):Boolean {
-       // your code here
-    }
-
-

The callback function should return a Boolean value.

-
 
thisObject:Object (default = null) — The object that the identifer this in the - callback function refers to when the function is called. - -
-

-Returns - - - - -
Boolean — - A Boolean value of true if the specified function returns - true when called on all items in the Vector; otherwise, false. - - -
-

-See also -

-
-Vector.some() -
-
- - - - - -
filter()method 
-
-AS3 function filter(callback:Function, thisObject:Object = null):Vector.<T> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Executes a test function on each item in the Vector and returns - a new Vector containing all items that return true for the - specified function. If an item returns false, - it is not included in the result Vector. The base type of the return - Vector matches the base type of the Vector on which the method is called. - -

For this method, the second parameter, - thisObject, must be null if the - first parameter, callback, is a method closure. That is - the most common way of using this method.

- -

However, suppose you create a function on a frame on the main timeline using Flash Professional, - but you want it to be called in a different this context:

- - 
-     function myFunction(item:T, index:int, vector:Vector.<T>):Boolean {
-        // your code here
-     }
-
- -

Suppose you then use the filter() - method on a Vector called myVector:

- - 
-     var result:Vector.<T> = myVector.filter(myFunction, someObject);
-
- -

Because myFunction is a member of the - main class of the SWF file, it cannot be executed in a different this context. Flash - runtimes throw an exception when this code runs. You can avoid this runtime error - by assigning the function to a variable, as follows:

- - 
-     var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):Boolean {
-         //your code here
-     };
-     myVector.filter(myFunction, someObject);
-
- - Parameters - - - - - - - - - - -
callback:Function — The function to run on each item in the Vector. - This function is invoked - with three arguments: the current item from the Vector, the index of the item, - and the Vector object: - 
function callback(item:T, index:int, vector:Vector.<T>):Boolean;
-
 
thisObject:Object (default = null) — The object that the identifer this in the - callback function refers to when the function is called. - -
-

-Returns - - - - -
Vector.<T> — A new Vector that contains all items from the original Vector - for which the callback function returned true. -
-

-See also -

-
-Vector.map() -
-
- - - - - -
forEach()method 
-
-AS3 function forEach(callback:Function, thisObject:Object = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Executes a function on each item in the Vector. - -

For this method, the second parameter, - thisObject, must be null if the - first parameter, callback, is a method closure. That is - the most common way of using this method.

- -

However, suppose you create a function on a frame on the main timeline using Flash Professional, - but you want it to be called in a different this context:

- - 
-     function myFunction(item:T, index:int, vector:Vector.<T>):void {
-        // your code here
-     }
-
- -

Suppose you then use the forEach() - method on a Vector called myVector:

- - 
-     myVector.forEach(myFunction, someObject);
-
- -

Because myFunction is a member of the - main class of the SWF file, it cannot be executed in a different this context. Flash - runtimes throw an exception when this code runs. You can avoid this runtime error - by assigning the function to a variable, as follows:

- - 
-     var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):void {
-         //your code here
-     };
-     myVector.forEach(myFunction, someObject);
-
- - Parameters - - - - - - - - - - -
callback:Function — The function to run on each item in the Vector. - This function is invoked - with three arguments: the current item from the Vector, the index of the item, - and the Vector object: - 
function callback(item:T, index:int, vector:Vector.<T>):void;
-

Any return value from the function call is discarded.

-
 
thisObject:Object (default = null) — The object that the identifer this in the - callback function refers to when the function is called. -
-
- - - - - -
includes()method 
-
-AS3 function includes(item:*):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51.0 -
-

- Checks whether the vector includes the item that is passed in. - Each element is checked in turn to see if it matches the item that is passed in, - using the standard comparison operator (i.e. similar to if (vector[i] == item)). -

Parameters - - - - -
item:* — The item to be checked if it is in the vector. -
-

-Returns - - - - -
Boolean — - True if the item is found in this vector. - - -
-
- - - - - -
indexOf()method 
-
-AS3 function indexOf(searchElement:T, fromIndex:int = 0):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Searches for an item in the Vector and returns the index position of the item. - The item is compared to the Vector elements using strict equality (===). - -

Parameters - - - - - - - - - - -
searchElement:T — The item to find in the Vector. -
 
fromIndex:int (default = 0) — The location in the Vector from which to start searching - for the item. If this parameter is negative, it is treated as length - + fromIndex, meaning the search starts -fromIndex items - from the end and searches from that position forward to the end of the Vector. - -
-

-Returns - - - - -
int — - A zero-based index position of the item in the Vector. - If the searchElement argument is not found, - the return value is -1. - - -
-

-See also -

-
-Vector.lastIndexOf() -
-=== (strict equality) -
-
- - - - - -
insertAt()method 
-
-AS3 function insertAt(index:int, element:T):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 19 -
-

- Insert a single element into the Vector. This method modifies - the Vector without making a copy. -

Parameters - - - - - - - - - - -
index:int — An integer that specifies the position in the Vector - where the element is to be inserted. You can use a - negative integer to specify a position relative to the end of the Vector - (for example, -1 for the last element of the Vector). - -
 
element:T
-
-Throws - - - - -
RangeError — If this method is called while fixed is true. - -
-
- - - - - -
isEmpty()method 
-
-AS3 function isEmpty():Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51.0 -
-

- Checks whether the vector is empty. - An alternative to calling a comparison vector.length == 0. -

-Returns - - - - -
Boolean — - True if the vector has no elements. - - -
-
- - - - - -
join()method 
-
-AS3 function join(sep:String = ","):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Converts the elements in the Vector to strings, inserts the specified separator between the - elements, concatenates them, and returns the resulting string. A nested Vector is always - separated by a comma (,), not by the separator passed to the join() method. -

Parameters - - - - -
sep:String (default = ",") — A character or string that separates Vector elements in - the returned string. If you omit this parameter, a comma is used as the default - separator. -
-

-Returns - - - - -
String — - A string consisting of the elements of the Vector - converted to strings and separated by the specified string. - - - -
-

-See also -

-
-String.split() -
-
- - - - - -
lastIndexOf()method 
-
-AS3 function lastIndexOf(searchElement:T, fromIndex:int = 0x7fffffff):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Searches for an item in the Vector, working backward from the specified - index position, and returns the index position of the matching item. The - item is compared to the Vector elements using strict equality (===). - -

Parameters - - - - - - - - - - -
searchElement:T — The item to find in the Vector. -
 
fromIndex:int (default = 0x7fffffff) — The location in the Vector from which to start searching - for the item. The default is the maximum allowable index value, meaning - that the search starts at the last item in the Vector. -

If this parameter is negative, it is treated as - length + fromIndex, meaning the search starts - -fromIndex items from the end and searches from that - position backward to index 0.

- -
-

-Returns - - - - -
int — - A zero-based index position of the item in the Vector. - If the searchElement argument is not found, - the return value is -1. - - -
-

-See also -

-
-Vector.indexOf() -
-=== (strict equality) -
-
- - - - - -
map()method 
-
-AS3 function map(callback:Function, thisObject:Object = null):Vector.<T> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Executes a function on each item in the Vector, and returns a new Vector - of items corresponding to the results of calling the function on - each item in this Vector. The result Vector has the same base - type and length as the original Vector. - The element at index i in the result Vector is the result of - the call on the element at index i in the original Vector. - -

For this method, the second parameter, - thisObject, must be null if the - first parameter, callback, is a method closure. That is - the most common way of using this method.

- -

However, suppose you create a function on a frame on the main timeline, using Flash Professional - but you want it to be called in a different this context:

- - 
-     function myFunction(item:Object, index:int, vector:Vector.<T>):T {
-        // your code here
-     }
-
- -

Suppose you then use the map() - method on a Vector called myVector:

- - 
-     myVector.map(myFunction, someObject);
-
- -

Because myFunction is a member of the - main class of the SWF file, it cannot be executed in a different this context. Flash - runtimes throw an exception when this code runs. You can avoid this runtime error - by assigning the function to a variable, as follows:

- - 
-     var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):void {
-         //your code here
-     };
-     myVector.map(myFunction, someObject);
-
- - Parameters - - - - - - - - - - -
callback:Function — The function to run on each item in the Vector. - This function is invoked - with three arguments: the current item from the Vector, the index of the item, - and the Vector object: - 
function callback(item:T, index:int, vector:Vector.<T>):T;
-
 
thisObject:Object (default = null) — The object that the identifer this in the - callback function refers to when the function is called. - -
-

-Returns - - - - -
Vector.<T> — A new Vector that contains the results of calling the function - on each item in this Vector. The result Vector has the same base type - and length as the original. -
-

-See also -

-
-Vector.filter() -
-
- - - - - -
pop()method 
-
-AS3 function pop():T -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Removes the last element from the Vector and returns that element. The - length property of the Vector is decreased by one when - this function is called. -

-Returns - - - - -
T — The value of the last element in the specified Vector. - -
-
-Throws - - - - -
RangeError — If this method is called while fixed is true. -
-

-See also -

-
-Vector.push() -
-Vector.shift() -
-Vector.unshift() -
-
- - - - - -
push()method 
-
-AS3 function push(... args):uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Adds one or more elements to the end of the Vector and returns - the new length of the Vector. - -

Because this function can accept - multiple arguments, the data type of the arguments is not - checked at compile time even in strict mode. However, if an - argument is passed that is not an instance of the base type, - an exception occurs at run time.

- Parameters - - - - -
... args — One or more values to append to the Vector. - -
-

-Returns - - - - -
uint — - The length of the Vector after the new elements are added. - - - -
-
-Throws - - - - - - - - - - -
TypeError — If any argument is not an instance of the - base type T of the Vector. - -
 
RangeError — If this method is called while fixed is true. -
-

-See also -

-
-Vector.pop() -
-Vector.shift() -
-Vector.unshift() -
-
- - - - - -
removeAt()method 
-
-AS3 function removeAt(index:int):T -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 19 -
-

- Remove a single element from the Vector. This method modifies - the Vector without making a copy. - -

Parameters - - - - -
index:int — An integer that specifies the index of the element - in the Vector that is to be deleted. You can use a - negative integer to specify a position relative to the end of the Vector - (for example, -1 for the last element of the Vector). - -
-

-Returns - - - - -
T — The element that was removed from the original Vector. - -
-
-Throws - - - - - - - - - - -
RangeError — If the index - argument specifies an index to be deleted that's outside the Vector's bounds. - -
 
RangeError — If this method is called while fixed is true. -
-
- - - - - -
reverse()method 
-
-AS3 function reverse():Vector.<T> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Reverses the order of the elements in the Vector. This method - alters the Vector on which it is called. -

-Returns - - - - -
Vector.<T> — The Vector with the elements in reverse order. - -
-
- - - - - -
shift()method 
-
-AS3 function shift():T -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Removes the first element from the Vector and returns that element. - The remaining Vector elements are moved from their original position, - i, to i - 1. -

-Returns - - - - -
T — The first element in the Vector. - -
-
-Throws - - - - -
RangeError — If fixed is true. -
-

-See also -

-
-Vector.pop() -
-Vector.push() -
-Vector.unshift() -
-
- - - - - -
slice()method 
-
-AS3 function slice(startIndex:int = 0, endIndex:int = 16777215):Vector.<T> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a new Vector that consists of a range of elements from - the original Vector, without modifying the original Vector. The - returned Vector includes the startIndex element and - all elements up to, but not including, the endIndex element. - -

If you don't pass any parameters, the new Vector is a duplicate (shallow clone) of the original Vector. - If you pass a value of 0 for both parameters, a new, empty Vector is created of the same type - as the original Vector.

- Parameters - - - - - - - - - - -
startIndex:int (default = 0) — A number specifying the index of the starting point - for the slice. If startIndex is a negative number, the starting - point begins at the end of the Vector, where -1 is the last element. -
 
endIndex:int (default = 16777215) — A number specifying the index of the ending point for - the slice. If you omit this parameter, the slice includes all elements from the - starting point to the end of the Vector. If endIndex is a negative - number, the ending point is specified from the end of the Vector, where -1 is the - last element. -
-

-Returns - - - - -
Vector.<T> — a Vector that consists of a range of elements from the original Vector. - -
-
- - - - - -
some()method 
-
-AS3 function some(callback:Function, thisObject:Object = null):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Executes a test function on each item in the Vector until an - item is reached that returns true. Use this method - to determine whether any items in a Vector meet a criterion, such as - having a value less than a particular number. - -

For this method, the second parameter, - thisObject, must be null if the - first parameter, callback, is a method closure. That is - the most common way of using this method.

- -

However, suppose you create a function on a frame on the main timeline, - but you want it to be called in a different this context:

- - 
-     function myFunction(item:Object, index:int, vector:Vector.<T>):Boolean {
-        // your code here
-     }
-
- -

Suppose you then use the some() - method on a Vector called myVector:

- - 
-     myVector.some(myFunction, someObject);
-
- -

Because myFunction is a member of the - main class of the SWF file, it cannot be executed in a different this context. Flash - runtimes throw an exception when this code runs. You can avoid this runtime error - by assigning the function to a variable, as follows:

- - 
-     var myFunction:Function = function(item:T, index:int, vector:Vector.<T>):Boolean {
-         //your code here
-     };
-     myVector.some(myFunction, someObject);
-
- - Parameters - - - - - - - - - - -
callback:Function — The function to run on each item in the Vector. - This function is invoked - with three arguments: the current item from the Vector, the index of the item, - and the Vector object: - 
function callback(item:T, index:int, vector:Vector.<T>):Boolean
-

The callback function should return a Boolean value.

-
 
thisObject:Object (default = null) — The object that the identifer this in the - callback function refers to when the function is called. - -
-

-Returns - - - - -
Boolean — - A Boolean value of true if any items in the Vector return - true for the specified function; otherwise, false. - - -
-

-See also -

-
-every() -
-
- - - - - -
sort()method 
-
-AS3 function sort(sortBehavior:*):Vector.<T> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Sorts the elements in the Vector object, and also returns a sorted Vector object. This method sorts according to the parameter - sortBehavior, which is either a function that - compares two values, or a set of sorting options. -

The method takes one parameter. The parameter is one of the following:

-
    -
  • a function that takes two arguments of the base type (T) of the Vector and returns a Number: - - 
    function compare(x:T, y:T):Number {}
    - - -

    The logic of the function is that, given two - elements x and y, the function returns one of the - following three values:

    - -
      -
    • a negative number, if x should appear before y - in the sorted sequence
      • -
    • 0, if x equals y
      • -
    • a positive number, if x should appear after y - in the sorted sequence
      • -
    -

    -
    • -
  • a number which is a bitwise OR of the following values: -
      -
    • 1 or Array.CASEINSENSITIVE
      • -
    • 2 or Array.DESCENDING
      • -
    • 4 or Array.UNIQUESORT
      • -
    • 8 or Array.RETURNINDEXEDARRAY
      • -
    • 16 or Array.NUMERIC
      • -
    -

    If the value is 0, the sort works in the following way: -

      -
    • Sorting is case-sensitive (Z precedes a).
      • -
    • Sorting is ascending (a precedes b).
      • -
    • The array is modified to reflect the sort order; multiple elements that have identical sort fields are placed consecutively in the sorted array in no particular order.
      • -
    • All elements, regardless of data type, are sorted as if they were strings, so 100 precedes 99, because "1" is a lower string value than "9".
      • -
    -

    -
    • -
- Parameters - - - - -
sortBehavior:* — A Function or a Number value that determines the behavior - of the sort. A Function parameter specifies a comparison method. - A Number value specifies the sorting options. - - - -
-

-Returns - - - - -
Vector.<T> — A Vector object, with elements in the new order. -
-

-See also -

-
-Array.sort() -
-
- - - - - -
splice()method 
-
-AS3 function splice(startIndex:int, deleteCount:uint = 4294967295, ... items):Vector.<T> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Adds elements to and removes elements from the Vector. This method modifies - the Vector without making a copy. - -

Note: To override this method in a subclass of Vector, - use ...args for the parameters, as this example shows:

- - 
-     public override function splice(...args) {
-       // your statements here
-     }
-
- Parameters - - - - - - - - - - - - - - - - -
startIndex:int — An integer that specifies the index of the element - in the Vector where the insertion or deletion begins. You can use a - negative integer to specify a position relative to the end of the Vector - (for example, -1 for the last element of the Vector). - -
 
deleteCount:uint (default = 4294967295) — An integer that specifies the number of elements - to be deleted. This number includes the element specified in the - startIndex parameter. - If the value is 0, no elements are deleted. - -
 
... items — An optional list of one or more comma-separated values - to insert into the Vector at the position specified in the startIndex parameter. -
-

-Returns - - - - -
Vector.<T> — a Vector containing the elements that were removed from the original Vector. - -
-
-Throws - - - - - - - - - - -
RangeError — If the startIndex and deleteCount - arguments specify an index to be deleted that's outside the Vector's bounds. - -
 
RangeError — If this method is called while fixed is true and the - splice() operation changes the length of the Vector. - -
-
- - - - - -
toLocaleString()method 
-
-public function toLocaleString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a string that represents the elements in the specified Vector. - Every element in the Vector, starting with index 0 and ending with the - highest index, is converted to a concatenated string and separated by - commas. In the ActionScript 3.0 implementation, this method returns - the same value as the Vector.toString() method. -

-Returns - - - - -
String — - A string of Vector elements. - - - -
-

-See also -

-
-Vector.toString() -
-
- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a string that represents the elements in the Vector. Every element in the - Vector, starting with index 0 and ending with the highest index, is converted to a - concatenated string and separated by commas. To specify a custom separator, - use the Vector.join() method. -

-Returns - - - - -
String — - A string of Vector elements. - - - -
-

-See also -

-
-String.split() -
-Vector.join() -
-
- - - - - -
unshift()method 
-
-AS3 function unshift(... args):uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Adds one or more elements to the beginning of the Vector and returns - the new length of the Vector. The other elements in the Vector are moved - from their original position, i, to i + the number of new elements. -

Because this function can accept - multiple arguments, the data type of the arguments is not - checked at compile time even in strict mode. However, if an - argument is passed that is not an instance of the base type, - an exception occurs at run time.

- - Parameters - - - - -
... args — One or more instances of the base type of the Vector - to be inserted at the beginning of the Vector. -
-

-Returns - - - - -
uint — - An integer representing the new length of the Vector. - - - -
-
-Throws - - - - - - - - - - -
TypeError — If any argument is not an instance of the - base type T of the Vector. -
 
RangeError — If this method is called while fixed is true. -
-

-See also -

-
-Vector.pop() -
-Vector.push() -
-Vector.shift() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/VerifyError.html b/html-docs/VerifyError.html deleted file mode 100644 index 1f71f66..0000000 --- a/html-docs/VerifyError.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - -VerifyError (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic dynamic class VerifyError
InheritanceVerifyError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The VerifyError class represents an error that occurs when a malformed - - or corrupted SWF file is encountered. - - - -

-

-See also -

-
-Loader class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-VerifyError(message:String = "")
-
- - Creates a new VerifyError object.
-		VerifyError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
VerifyError()constructor
-
-public function VerifyError(message:String = "") -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new VerifyError object. - -

Parameters - - - - -
message:String (default = "") — Contains the message associated with the VerifyError object. - - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/XML.html b/html-docs/XML.html deleted file mode 100644 index 01f9ed7..0000000 --- a/html-docs/XML.html +++ /dev/null @@ -1,4667 +0,0 @@ - - - - - - - - -XML (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final dynamic class XML
InheritanceXML Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - The XML class contains methods and properties for working with XML objects. The XML class - - (along with the XMLList, Namespace, and QName classes) implements the - - powerful XML-handling standards defined in ECMAScript for XML - - (E4X) specification (ECMA-357 edition 2). - - - -

Use the toXMLString() method to return a string representation of the XML object - - regardless of whether the XML object has simple content or complex content.

- - -

Note: The XML class (along with related classes) from ActionScript 2.0 has been - - renamed XMLDocument and moved into the flash.xml package. - - It is included in ActionScript 3.0 for backward compatibility.

- - - - -

-

-View the examples. -

-

-See also -

-
-Namespace -
-QName -
-XMLList -
-XML.toXMLString() -
-ECMAScript for XML (E4X) specification (ECMA-357 edition 2) -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  ignoreComments : Boolean -
[static] - - Determines whether XML comments are ignored - - when XML objects parse the source XML data.
-		XML
  ignoreProcessingInstructions : Boolean -
[static] - - Determines whether XML - - processing instructions are ignored when XML objects parse the source XML data.
-		XML
  ignoreWhitespace : Boolean -
[static] - - Determines whether white space characters - - at the beginning and end of text nodes are ignored during parsing.
-		XML
  prettyIndent : int -
[static] - - Determines the amount of indentation applied by - - the toString() and toXMLString() methods when - - the XML.prettyPrinting property is set to true.
-		XML
  prettyPrinting : Boolean -
[static] - - Determines whether the toString() - - and toXMLString() methods normalize white space characters between some tags.
-		XML
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-XML(value:Object)
-
- - Creates a new XML object.
-		XML
   -
-addNamespace(ns:Object):XML -
-
- - Adds a namespace to the set of in-scope namespaces for the XML object.
-		XML
   -
-appendChild(child:Object):XML -
-
- - Appends the given child to the end of the XML object's properties.
-		XML
   -
-attribute(attributeName:*):XMLList -
-
- - Returns the XML value of the attribute that has the name matching the attributeName - - parameter.
-		XML
   -
-attributes():XMLList -
-
- - Returns a list of attribute values for the given XML object.
-		XML
   -
-child(propertyName:Object):XMLList -
-
- - Lists the children of an XML object.
-		XML
   -
-childIndex():int -
-
- - Identifies the zero-indexed position of this XML object within the context of its parent.
-		XML
   -
-children():XMLList -
-
- - Lists the children of the XML object in the sequence in which they appear.
-		XML
   -
-comments():XMLList -
-
- - Lists the properties of the XML object that contain XML comments.
-		XML
   -
-contains(value:XML):Boolean -
-
- - Compares the XML object against the given value parameter.
-		XML
   -
-copy():XML -
-
- - Returns a copy of the given XML object.
-		XML
   -
-defaultSettings():Object -
-
[static] - - Returns an object with the following properties set to the default values: ignoreComments, - - ignoreProcessingInstructions, ignoreWhitespace, prettyIndent, and - - prettyPrinting.
-		XML
   -
-descendants(name:Object = *):XMLList -
-
- - Returns all descendants (children, grandchildren, great-grandchildren, and so on) of the - - XML object that have the given name parameter.
-		XML
   -
-elements(name:Object = *):XMLList -
-
- - Lists the elements of an XML object.
-		XML
   -
-hasComplexContent():Boolean -
-
- - Checks to see whether the XML object contains complex content.
-		XML
   -
-hasOwnProperty(p:String):Boolean -
-
- - Checks to see whether the object has the property specified by the p parameter.
-		XML
   -
-hasSimpleContent():Boolean -
-
- - Checks to see whether the XML object contains simple content.
-		XML
   -
-inScopeNamespaces():Array -
-
- - Lists the namespaces for the XML object, based on the object's parent.
-		XML
   -
-insertChildAfter(child1:Object, child2:Object):* -
-
- - Inserts the given child2 parameter after the child1 parameter in this XML object and returns the - - resulting object.
-		XML
   -
-insertChildBefore(child1:Object, child2:Object):* -
-
- - Inserts the given child2 parameter before the child1 parameter - - in this XML object and returns the resulting object.
-		XML
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-length():int -
-
- - For XML objects, this method always returns the integer 1.
-		XML
   -
-localName():Object -
-
- - Gives the local name portion of the qualified name of the XML object.
-		XML
   -
-name():Object -
-
- - Gives the qualified name for the XML object.
-		XML
   -
-namespace(prefix:String = null):* -
-
- - If no parameter is provided, gives the namespace associated with the qualified name of - - this XML object.
-		XML
   -
-namespaceDeclarations():Array -
-
- - Lists namespace declarations associated with the XML object in the context of its parent.
-		XML
   -
-nodeKind():String -
-
- - Specifies the type of node: text, comment, processing-instruction, - - attribute, or element.
-		XML
   -
-normalize():XML -
-
- - For the XML object and all descendant XML objects, merges adjacent text nodes and - - eliminates empty text nodes.
-		XML
   -
-parent():* -
-
- - Returns the parent of the XML object.
-		XML
   -
-prependChild(value:Object):XML -
-
- - Inserts a copy of the provided child object into the XML element before any existing XML - - properties for that element.
-		XML
   -
-processingInstructions(name:String = "*"):XMLList -
-
- - If a name parameter is provided, lists all the children of the XML object - - that contain processing instructions with that name.
-		XML
   -
-propertyIsEnumerable(p:String):Boolean -
-
- - Checks whether the property p is in the set of properties that can be iterated in a - - for..in statement applied to the XML object.
-		XML
   -
-removeNamespace(ns:Namespace):XML -
-
- - Removes the given namespace for this object and all descendants.
-		XML
   -
-replace(propertyName:Object, value:XML):XML -
-
- - Replaces the properties specified by the propertyName parameter - - with the given value parameter.
-		XML
   -
-setChildren(value:Object):XML -
-
- - Replaces the child properties of the XML object with the specified set of XML properties, - - provided in the value parameter.
-		XML
   -
-setLocalName(name:String):void -
-
- - Changes the local name of the XML object to the given name parameter.
-		XML
   -
-setName(name:String):void -
-
- - Sets the name of the XML object to the given qualified name or attribute name.
-		XML
   -
-setNamespace(ns:Namespace):void -
-
- - Sets the namespace associated with the XML object.
-		XML
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setSettings(... rest):void -
-
[static] - - Sets values for the following XML properties: ignoreComments, - - ignoreProcessingInstructions, ignoreWhitespace, - - prettyIndent, and prettyPrinting.
-		XML
   -
-settings():Object -
-
[static] - - Retrieves the following properties: ignoreComments, - - ignoreProcessingInstructions, ignoreWhitespace, - - prettyIndent, and prettyPrinting.
-		XML
   -
-text():XMLList -
-
- - Returns an XMLList object of all XML properties of the XML object that represent XML text nodes.
-		XML
   -
-toJSON(k:String):* -
-
- - Provides an overridable method for customizing the JSON encoding of values in an XML object.
-		XML
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string representation of the XML object.
-		XML
   -
-toXMLString():String -
-
- - Returns a string representation of the XML object.
-		XML
   -
-valueOf():XML -
-
- - Returns the XML object.
-		XML
-
- -
- -
Property detail
- - - - - -
ignoreCommentsproperty
-
-ignoreComments:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Determines whether XML comments are ignored - - when XML objects parse the source XML data. By default, the comments are ignored - - (true). To include XML comments, set this property to false. - - The ignoreComments property is used only during the XML parsing, not during - - the call to any method such as myXMLObject.child(*).toXMLString(). - - If the source XML includes comment nodes, they are kept or discarded during the XML parsing. - - -

Implementation -
-    public static function get ignoreComments():Boolean -
-    public function set ignoreComments(value:Boolean):void -
-

-See also -

-
-XML.child() -
-XML.toXMLString() -
-
-Example -
This example shows the effect of setting XML.ignoreComments - to false and to true: -
-
-XML.ignoreComments = false;
-var xml1:XML = 
-    	<foo>
-			<!-- comment -->
-		</foo>;
-trace(xml1.toXMLString()); // <foo><!-- comment --></foo>
-
-XML.ignoreComments = true;
-var xml2:XML = 
-		<foo>
-			<!-- example -->
-		</foo>;
-trace(xml2.toXMLString()); // <foo/>
-
-

-
- - - - - -
ignoreProcessingInstructionsproperty 
-
-ignoreProcessingInstructions:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Determines whether XML - - processing instructions are ignored when XML objects parse the source XML data. - - By default, the processing instructions are ignored (true). To include XML - - processing instructions, set this property to false. The - - ignoreProcessingInstructions property is used only during the XML parsing, - - not during the call to any method such as myXMLObject.child(*).toXMLString(). - - If the source XML includes processing instructions nodes, they are kept or discarded during - - the XML parsing. - - -

Implementation -
-    public static function get ignoreProcessingInstructions():Boolean -
-    public function set ignoreProcessingInstructions(value:Boolean):void -
-

-See also -

-
-XML.child() -
-XML.toXMLString() -
-
-Example -
This example shows the effect of setting XML.ignoreProcessingInstructions - to false and to true: -
-
-XML.ignoreProcessingInstructions = false;
-var xml1:XML = 
-    	<foo>
-			<?exampleInstruction ?>
-		</foo>;
-trace(xml1.toXMLString()); // <foo><?exampleInstruction ?></foo>
-
-XML.ignoreProcessingInstructions = true;
-var xml2:XML = 
-		<foo>
-			<?exampleInstruction ?>
-		</foo>;
-trace(xml2.toXMLString()); // <foo/>
-
-

-
- - - - - -
ignoreWhitespaceproperty 
-
-ignoreWhitespace:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Determines whether white space characters - - at the beginning and end of text nodes are ignored during parsing. By default, - - white space is ignored (true). If a text node is 100% white space and the - - ignoreWhitespace property is set to true, then the node is not created. - - To show white space in a text node, set the ignoreWhitespace property to - - false. - - -

When you create an XML object, it caches the current value of the ignoreWhitespace - - property. Changing the ignoreWhitespace does not change the behavior of existing XML - - objects.

- - - - Implementation -
-    public static function get ignoreWhitespace():Boolean -
-    public function set ignoreWhitespace(value:Boolean):void -
-
-Example -
This example shows the effect of setting XML.ignoreWhitespace - to false and to true: -
-
-XML.ignoreWhitespace = false;
-var xml1:XML = <foo>    </foo>;
-trace(xml1.children().length()); // 1
-
-XML.ignoreWhitespace = true;
-var xml2:XML = <foo>    </foo>;
-trace(xml2.children().length()); // 0
-
-

-
- - - - - -
prettyIndentproperty 
-
-prettyIndent:int  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Determines the amount of indentation applied by - - the toString() and toXMLString() methods when - - the XML.prettyPrinting property is set to true. - - Indentation is applied with the space character, not the tab character. - - - - The default value is 2. - - -

Implementation -
-    public static function get prettyIndent():int -
-    public function set prettyIndent(value:int):void -
-

-See also -

-
-prettyPrinting -
-toString() -
-toXMLString() -
-
-Example -
This example shows the effect of setting the XML.prettyIndent - static property: -
-
-var xml:XML = <foo><bar/></foo>;
-XML.prettyIndent = 0;
-trace(xml.toXMLString());
-
-XML.prettyIndent = 1;
-trace(xml.toXMLString());
-
-XML.prettyIndent = 2;
-trace(xml.toXMLString());
-
-

-
- - - - - -
prettyPrintingproperty 
-
-prettyPrinting:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Determines whether the toString() - - and toXMLString() methods normalize white space characters between some tags. - - The default value is true. - - -

Implementation -
-    public static function get prettyPrinting():Boolean -
-    public function set prettyPrinting(value:Boolean):void -
-

-See also -

-
-prettyIndent -
-toString() -
-toXMLString() -
-
-Example -
This example shows the effect of setting XML.prettyPrinting - static property: -
-
-var xml:XML = <foo><bar/></foo>;
-XML.prettyPrinting = false;
-trace(xml.toXMLString());
-
-XML.prettyPrinting = true;
-trace(xml.toXMLString());
-
-

-
- -
Constructor detail
- - - - - -
XML()constructor
-
-public function XML(value:Object) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Creates a new XML object. You must use the constructor to create an - - XML object before you call any of the methods of the XML class. - - -

Use the toXMLString() method to return a string representation of the XML object - - regardless of whether the XML object has simple content or complex content.

- - - - Parameters - - - - -
value:Object — Any object that can be converted to XML with the top-level - - XML() function. - - - -
-

-See also -

-
-XML() global function -
-XML.toXMLString() -
-
-Example -
The following example shows how you can load a remote XML document in ActionScript 3.0 using the URLLoader class in Flash Professional. - Example provided by - ActionScriptExamples.com. -
-
-//
-// Requires:
-//   - TextArea control UI component in the Flash Professional Library.
-//
-import fl.controls.TextArea;
- 
-var xml:XML;
- 
-var urlRequest:URLRequest = new URLRequest("http://www.helpexamples.com/flash/xml/menu.xml");
- 
-var urlLoader:URLLoader = new URLLoader();
-urlLoader.addEventListener(Event.COMPLETE, urlLoader_complete);
-urlLoader.load(urlRequest);
- 
-var textArea:TextArea = new TextArea();
-textArea.move(5, 5);
-textArea.setSize(stage.stageWidth - 10, stage.stageHeight - 10);
-addChild(textArea);
- 
-function urlLoader_complete(evt:Event):void {
-    xml = new XML(evt.currentTarget.data);
-    textArea.text = xml.toXMLString();
-}
-
-

Here's another variation using all ActionScript. - Example provided by - ActionScriptExamples.com. -
-
-var xml:XML;
-var textArea:TextField = new TextField();
-textArea.width = 300;
- 
-var urlRequest:URLRequest = new URLRequest("http://www.helpexamples.com/flash/xml/menu.xml");
-var urlLoader:URLLoader = new URLLoader();
-urlLoader.dataFormat = URLLoaderDataFormat.TEXT;
-urlLoader.addEventListener(Event.COMPLETE, urlLoader_complete);
-urlLoader.load(urlRequest);
- 
-function urlLoader_complete(evt:Event):void {
-    xml = new XML(evt.target.data);
-    textArea.text = xml.toXMLString();
-    addChild(textArea);
-}
-
-

-
- -
Method detail
- - - - - -
addNamespace()method
-
-AS3 function addNamespace(ns:Object):XML -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Adds a namespace to the set of in-scope namespaces for the XML object. If the namespace already - - exists in the in-scope namespaces for the XML object (with a prefix matching that of the given - - parameter), then the prefix of the existing namespace is set to undefined. If the input parameter - - is a Namespace object, it's used directly. If it's a QName object, the input parameter's - - URI is used to create a new namespace; otherwise, it's converted to a String and a namespace is created from - - the String. - - -

Parameters - - - - -
ns:Object — The namespace to add to the XML object. - - -
-

-Returns - - - - -
XML — - The new XML object, with the namespace added. - - - - -
-
-Example -
This example uses a namespace defined in one XML object and applies it - to another XML object: -
-
-var xml1:XML = <ns:foo xmlns:ns="www.example.com/ns" />;
-var nsNamespace:Namespace = xml1.namespace();
-
-var xml2:XML = <bar />;
-xml2.addNamespace(nsNamespace);
-trace(xml2.toXMLString()); // <bar xmlns:ns="www.example.com/ns"/>
-
-

-
- - - - - -
appendChild()method 
-
-AS3 function appendChild(child:Object):XML -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Appends the given child to the end of the XML object's properties. - - The appendChild() method takes an XML object, an XMLList object, or - - any other data type that is then converted to a String. - - -

Use the delete (XML) operator to remove XML nodes.

- - - - Parameters - - - - -
child:Object — The XML object to append. - - -
-

-Returns - - - - -
XML — - The resulting XML object. - - - - -
-

-See also -

-
-delete (XML) operator -
-
-Example -
This example appends a new element to the end of the child list of an XML object: -
-
-var xml:XML = 
-    	<body>
-			<p>hello</p>
-		</body>;
-		
-xml.appendChild(<p>world</p>);	
-trace(xml.p[0].toXMLString()); // <p>hello</p>
-trace(xml.p[1].toXMLString()); // <p>world</p>
-
-

-
- - - - - -
attribute()method 
-
-AS3 function attribute(attributeName:*):XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns the XML value of the attribute that has the name matching the attributeName - - parameter. Attributes are found within XML elements. - - In the following example, the element has an attribute named "gender" - - with the value "boy": <first gender="boy">John</first>. - - - -

The attributeName parameter can be any data type; however, - - String is the most common data type to use. When passing any object other than a QName object, - - the attributeName parameter uses the toString() method - - to convert the parameter to a string.

- - - -

If you need a qualified name reference, you can pass in a QName object. A QName object - - defines a namespace and the local name, which you can use to define the qualified name of an - - attribute. Therefore calling attribute(qname) is not the same as calling - - attribute(qname.toString()).

- - - - Parameters - - - - -
attributeName:* — The name of the attribute. - - -
-

-Returns - - - - -
XMLList — - An XMLList object or an empty XMLList object. Returns an empty XMLList object - - when an attribute value has not been defined. - - - - -
-

-See also -

-
-XML.attributes() -
-QName -
-Namespace -
-XML.elements() -
-attribute identifier (@) operator -
-
-Example -
This example shows a QName object passed into the attribute() method. The - localName property is attr and the namespace property - is ns. -
-
- var xml:XML = <ns:node xmlns:ns = "http://uri" ns:attr = '7' />       
- var qn:QName = new QName("http://uri", "attr");
- trace (xml.attribute(qn)); // 7
-
-

To return an attribute with a name that matches an ActionScript reserved word, - use the attribute() method instead of the attribute identifier (@) - operator, as in the following example: -
-
- var xml:XML = <example class="first" />
- trace(xml.attribute("class"));
-
-

-
- - - - - -
attributes()method 
-
-AS3 function attributes():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns a list of attribute values for the given XML object. Use the name() - - method with the attributes() method to return the name of an attribute. - - Use of xml.attributes() is equivalent to xml.@*. - - - -

-Returns - - - - -
XMLList — - The list of attribute values. - - - - - -
-

-See also -

-
-XML.attribute() -
-XML.name() -
-@ operator -
-
-Example -
The following example returns the name of the attribute: - -
-
-var xml:XML=<example id='123' color='blue'/>
-trace(xml.attributes()[1].name()); //color
-
-

This example returns the names of all the attributes: -
-
- 
-var xml:XML = <example id='123' color='blue'/>
-var attNamesList:XMLList = xml.@*;
-
-trace (attNamesList is XMLList); // true
-trace (attNamesList.length()); // 2
-
-for (var i:int = 0; i < attNamesList.length(); i++)
-{ 
-    trace (typeof (attNamesList[i])); // xml
-    trace (attNamesList[i].nodeKind()); // attribute
-    trace (attNamesList[i].name()); // id and color
-}
-
-

-
- - - - - -
child()method 
-
-AS3 function child(propertyName:Object):XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Lists the children of an XML object. An XML child is an XML element, text node, comment, - - or processing instruction. - - - -

Use the propertyName parameter to list the - - contents of a specific XML child. For example, to return the contents of a child named - - <first>, call child("first") on the XML object. You can generate the same result - - by using the child's index number. The index number identifies the child's position in the - - list of other XML children. For example, child(0) returns the first child - - in a list.

- - - -

Use an asterisk (*) to output all the children in an XML document. - - For example, doc.child("*").

- - - -

Use the length() method with the asterisk (*) parameter of the - - child() method to output the total number of children. For example, - - numChildren = doc.child("*").length().

- - - - Parameters - - - - -
propertyName:Object — The element name or integer of the XML child. - - - -
-

-Returns - - - - -
XMLList — - An XMLList object of child nodes that match the input parameter. - - - - - -
-

-See also -

-
-XML.elements() -
-XMLList class -
-XML.length() -
-
-Example -
This example shows the use of the child() method to identify child - elements with a specified name: -
-
-var xml:XML = 
-    	<foo>
-			<bar>text1</bar>
-			<bar>text2</bar>
-		</foo>;
-trace(xml.child("bar").length());  // 2
-trace(xml.child("bar")[0].toXMLString()); // <bar>text1</bar>
-trace(xml.child("bar")[1].toXMLString()); // <bar>text2</bar>
-
-

-
- - - - - -
childIndex()method 
-
-AS3 function childIndex():int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Identifies the zero-indexed position of this XML object within the context of its parent. - - -

-Returns - - - - -
int — - The position of the object. Returns -1 as well as positive integers. - - - - -
-
-Example -
This example shows the use of the childIndex() method: -
-
-var xml:XML = 
-    		<foo>
-				<bar />
-				text
-				<bob />
-			</foo>;
-trace(xml.bar.childIndex()); // 0
-trace(xml.bob.childIndex()); // 2
-
-

-
- - - - - -
children()method 
-
-AS3 function children():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Lists the children of the XML object in the sequence in which they appear. An XML child - - is an XML element, text node, comment, or processing instruction. - - -

-Returns - - - - -
XMLList — - An XMLList object of the XML object's children. - - - - -
-
-Example -
This example shows the use of the children() method: -
-
-XML.ignoreComments = false;
-XML.ignoreProcessingInstructions = false;
-var xml:XML = 
-    	<foo id="22">
-			<bar>44</bar>
-			text
-			<!-- comment -->
-			<?instruction ?>
-		</foo>;
-trace(xml.children().length()); // 4
-trace(xml.children()[0].toXMLString()); // <bar>44</bar>
-trace(xml.children()[1].toXMLString()); // text
-trace(xml.children()[2].toXMLString()); // <!-- comment -->
-trace(xml.children()[3].toXMLString()); // <?instruction ?>
-
-

-
- - - - - -
comments()method 
-
-AS3 function comments():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Lists the properties of the XML object that contain XML comments. - - -

-Returns - - - - -
XMLList — - An XMLList object of the properties that contain comments. - - - - -
-
-Example -
This example shows the use of the comments() method: -
-
-XML.ignoreComments = false;
-var xml:XML = 
-    	<foo>
-			<!-- example -->
-			<!-- example2 -->
-		</foo>;
-trace(xml.comments().length()); // 2
-trace(xml.comments()[1].toXMLString()); // <!-- example2 -->
-
-

-
- - - - - -
contains()method 
-
-AS3 function contains(value:XML):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Compares the XML object against the given value parameter. - - -

Parameters - - - - -
value:XML — A value to compare against the current XML object. - - -
-

-Returns - - - - -
Boolean — - If the XML object matches the value parameter, then true; otherwise false. - - - - -
-
-Example -
This example shows the use of the contains() method: -
-
-var xml:XML = 
-    	<order>
-			<item>Rice</item>
-			<item>Kung Pao Shrimp</item>
-		</order>;
-trace(xml.item[0].contains(<item>Rice</item>)); // true
-trace(xml.item[1].contains(<item>Kung Pao Shrimp</item>)); // true
-trace(xml.item[1].contains(<item>MSG</item>)); // false
-
-

-
- - - - - -
copy()method 
-
-AS3 function copy():XML -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns a copy of the given XML object. The copy is a duplicate of the entire tree of nodes. - - The copied XML object has no parent and returns null if you attempt to call the - - parent() method. - - -

-Returns - - - - -
XML — - The copy of the object. - - - - -
-
-Example -
This example shows that the copy() method creates a new instance of an XML object. - When you modify the copy, the original remains unchanged: -
-
-var xml1:XML = <foo />;
-var xml2:XML = xml1.copy();
-xml2.appendChild(<bar />);
-trace(xml1.bar.length()); // 0
-trace(xml2.bar.length()); // 1
-
-

-
- - - - - -
defaultSettings()method 
-
-AS3 static function defaultSettings():Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns an object with the following properties set to the default values: ignoreComments, - - ignoreProcessingInstructions, ignoreWhitespace, prettyIndent, and - - prettyPrinting. The default values are as follows: - - -

    - -
  • ignoreComments = true
    • - -
  • ignoreProcessingInstructions = true
    • - -
  • ignoreWhitespace = true
    • - -
  • prettyIndent = 2
    • - -
  • prettyPrinting = true
    • - -
- - -

Note: You do not apply this method to an instance of the XML class; you apply it to - - XML, as in the following code: var df:Object = XML.defaultSettings().

- - -

-Returns - - - - -
Object — - An object with properties set to the default settings. - - - - -
-

-See also -

-
-XML.ignoreComments -
-XML.ignoreProcessingInstructions -
-XML.ignoreWhitespace -
-XML.prettyIndent -
-XML.prettyPrinting -
-XML.setSettings() -
-XML.settings() -
-
-Example -
The following example shows: how to apply some custom settings (for including comments and processing - instructions) prior to setting an XML object; how to then revert back to the default settings before setting another XML - object; and then how to set the custom settings again (for setting any more XML objects): -
-
-XML.ignoreComments = false;
-XML.ignoreProcessingInstructions = false;
-var customSettings:Object = XML.settings();
-
-var xml1:XML = 
-    	<foo>
-			<!-- comment -->
-			<?instruction ?>
-		</foo>;
-trace(xml1.toXMLString());
-//	<foo>
-//		<!-- comment -->
-// 		<?instruction ?>
-//	</foo>
-
-XML.setSettings(XML.defaultSettings());
-var xml2:XML = 
-		<foo>
-			<!-- comment -->
-			<?instruction ?>
-		</foo>;
-trace(xml2.toXMLString());
-
-

-
- - - - - -
descendants()method 
-
-AS3 function descendants(name:Object = *):XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns all descendants (children, grandchildren, great-grandchildren, and so on) of the - - XML object that have the given name parameter. The name parameter - - is optional. The name parameter can be a QName object, a String data type - - or any other data type that is then converted to a String data type. - - - -

To return all descendants, use the "*" parameter. If no parameter is passed, - - the string "*" is passed and returns all descendants of the XML object.

- - - - Parameters - - - - -
name:Object (default = *) — The name of the element to match. - - -
-

-Returns - - - - -
XMLList — - An XMLList object of matching descendants. If there are no descendants, returns an - - empty XMLList object. - - - - - -
-

-See also -

-
-descendant accessor (..) operator -
-
-Example -
To return descendants with names that match ActionScript reserved words, use the - descendants() method instead of the descendant (..) operator, as in the - following example: -
-
-var xml:XML = 
-  <enrollees>
-    <student id="239">
-    	<class name="Algebra" />
-		<class name="Spanish 2"/>
-    </student>
-    <student id="206">
-		<class name="Trigonometry" />
-		<class name="Spanish 2" />
-    </student>
-  </enrollees>
-trace(xml.descendants("class"));
-
-

The following example shows that the descendants() method returns an XMLList object - that contains all descendant objects, including children, grandchildren, and so on: -
-
-XML.ignoreComments = false;
-var xml:XML = 
-    	<body>
-			<!-- comment -->
-			text1
-			<a>
-				<b>text2</b>
-			</a>
-		</body>;
-trace(xml.descendants("*").length()); // 5
-trace(xml.descendants("*")[0]); // // <!-- comment -->
-trace(xml.descendants("*")[1].toXMLString()); // text1
-trace(xml.descendants("a").toXMLString()); // <a><b>text2</b></a>
-trace(xml.descendants("b").toXMLString()); // <b>text2</b>
-
-

-
- - - - - -
elements()method 
-
-AS3 function elements(name:Object = *):XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Lists the elements of an XML object. An element consists of a start and an end tag; - - for example <first></first>. The name parameter - - is optional. The name parameter can be a QName object, a String data type, - - or any other data type that is then converted to a String data type. Use the name parameter to list a specific element. For example, - - the element "first" returns "John" in this example: - - <first>John</first>. - - - -

To list all elements, use the asterisk (*) as the - - parameter. The asterisk is also the default parameter.

- - - -

Use the length() method with the asterisk parameter to output the total - - number of elements. For example, numElement = addressbook.elements("*").length().

- - - - Parameters - - - - -
name:Object (default = *) — The name of the element. An element's name is surrounded by angle brackets. - - For example, "first" is the name in this example: - - <first></first>. - - - -
-

-Returns - - - - -
XMLList — - An XMLList object of the element's content. The element's content falls between the start and - - end tags. If you use the asterisk (*) to call all elements, both the - - element's tags and content are returned. - - - - - -
-

-See also -

-
-XML.child() -
-XMLList class -
-XML.length() -
-XML.attribute() -
-XML dot (.) operator -
-
-Example -
The following example shows that the elements() method returns a - list of elements only - — not comments, text properties, or processing instructions: -
-
-var xml:XML = 
-    	<foo>
-			<!-- comment -->
-			<?instruction ?>
-			text
-			<a>1</a>
-			<b>2</b>
-		</foo>;
-trace(xml.elements("*").length()); // 2
-trace(xml.elements("*")[0].toXMLString()); // <a>1</a>
-trace(xml.elements("b").length()); // 1
-trace(xml.elements("b")[0].toXMLString()); // <b>2</b>
-
-

To return elements with names that match ActionScript reserved words, - use the elements() method instead of the XML dot (.) operator, - as in the following example: -
-
-var xml:XML =
- <student id="206">
-    <class name="Trigonometry" />
-	<class name="Spanish 2" />
- </student>
-trace(xml.elements("class"));
-
-

-
- - - - - -
hasComplexContent()method 
-
-AS3 function hasComplexContent():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Checks to see whether the XML object contains complex content. An XML object contains complex content if - - it has child elements. XML objects that representing attributes, comments, processing instructions, - - and text nodes do not have complex content. However, an object that contains these can - - still be considered to contain complex content (if the object has child elements). - - -

-Returns - - - - -
Boolean — - If the XML object contains complex content, true; otherwise false. - - - - -
-

-See also -

-
-XML.hasSimpleContent() -
-
-Example -
The following example shows an XML object with one property named a that has - simple content and one property named a that has complex content: -
-
-var xml:XML = 
-    	<foo>
-			<a>
-				text
-			</a>
-			<a>
-				<b/>
-			</a>
-		</foo>;
-trace(xml.a[0].hasComplexContent()); // false
-trace(xml.a[1].hasComplexContent()); // true
-
-trace(xml.a[0].hasSimpleContent()); // true
-trace(xml.a[1].hasSimpleContent()); // false
-
-

-
- - - - - -
hasOwnProperty()method 
-
-AS3 function hasOwnProperty(p:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Checks to see whether the object has the property specified by the p parameter. - - -

Parameters - - - - -
p:String — The property to match. - - -
-

-Returns - - - - -
Boolean — - If the property exists, true; otherwise false. - - - - -
-
-Example -
The following example uses the hasOwnProperty() method to ensure - that a property (b) exists prior to evaluating an expression (b == "11") that uses the - property: -
-
-var xml:XML = 
-    	<foo>
-			<a />
-			<a>
-				<b>10</b>
-			</a>
-			<a>
-				<b>11</b>
-			</a>
-		</foo>;
-trace(xml.a.(hasOwnProperty("b") && b == "11")); 
-
-
If the last line in this example were the following, Flash Player would throw an exception since - the first element named a does not have a property named b: -

- 

trace(xml.a.(b == "11"));
-

-
-
-

The following example uses the hasOwnProperty() method to ensure - that a property (item) exists prior to evaluating an expression - (item.contains("toothbrush")) that uses the - property: -
-
-var xml:XML = 
-    	<orders>
-			<order id='1'>
-				<item>toothbrush</item>
-				<item>toothpaste</item>
-			</order>
-			<order>
-				<returnItem>shoe polish</returnItem>
-			</order>
-		</orders>;
-trace(xml.order.(hasOwnProperty("item") && item.contains("toothbrush")));
-
-

-
- - - - - -
hasSimpleContent()method 
-
-AS3 function hasSimpleContent():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Checks to see whether the XML object contains simple content. An XML object contains simple content - - if it represents a text node, an attribute node, or an XML element that has no child elements. - - XML objects that represent comments and processing instructions do not contain simple - - content. - - -

-Returns - - - - -
Boolean — - If the XML object contains simple content, true; otherwise false. - - - - -
-

-See also -

-
-XML.hasComplexContent() -
-
-Example -
The following example shows an XML object with one property named a that has - simple content and one property named a that has complex content: -
-
-var xml:XML = 
-    	<foo>
-			<a>
-				text
-			</a>
-			<a>
-				<b/>
-			</a>
-		</foo>;
-trace(xml.a[0].hasComplexContent()); // false
-trace(xml.a[1].hasComplexContent()); // true
-
-trace(xml.a[0].hasSimpleContent()); // true
-trace(xml.a[1].hasSimpleContent()); // false
-
-

-
- - - - - -
inScopeNamespaces()method 
-
-AS3 function inScopeNamespaces():Array -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Lists the namespaces for the XML object, based on the object's parent. - - -

-Returns - - - - -
Array — - An array of Namespace objects. - - - - -
-
- - - - - -
insertChildAfter()method 
-
-AS3 function insertChildAfter(child1:Object, child2:Object):* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Inserts the given child2 parameter after the child1 parameter in this XML object and returns the - - resulting object. If the child1 parameter is null, the method - - inserts the contents of child2 before all children of the XML object - - (in other words, after none). If child1 is provided, but it does not - - exist in the XML object, the XML object is not modified and undefined is - - returned. - - - -

If you call this method on an XML child that is not an element (text, attributes, comments, pi, and so on) - - undefined is returned.

- - -

Use the delete (XML) operator to remove XML nodes.

- - - Parameters - - - - - - - - - - -
child1:Object — The object in the source object that you insert before child2. - -
 
child2:Object — The object to insert. - - -
-

-Returns - - - - -
* — The resulting XML object or undefined. - - -
-

-See also -

-
-XML.insertChildBefore() -
-delete (XML) operator -
-
-Example -
The following example appends an element to the end of the child elements of an XML object: -
-
-var xml:XML = 
-    	<menu>
-			<item>burger</item>
-			<item>soda</item>
-		</menu>;
-xml.insertChildAfter(xml.item[0], <saleItem>fries</saleItem>);
-trace(xml);
-
-
The trace() output is the following: - 
 <menu>
-  	<item>burger</item>
-  	<saleItem>fries</saleItem>
-  	<item>soda</item>
-  </menu>
-
-
-

-
- - - - - -
insertChildBefore()method 
-
-AS3 function insertChildBefore(child1:Object, child2:Object):* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Inserts the given child2 parameter before the child1 parameter - - in this XML object and returns the resulting object. If the child1 parameter - - is null, the method inserts the contents of - - child2 after all children of the XML object (in other words, before - - none). If child1 is provided, but it does not exist in the XML object, - - the XML object is not modified and undefined is returned. - - - -

If you call this method on an XML child that is not an element (text, attributes, - - comments, pi, and so on) undefined is returned.

- - -

Use the delete (XML) operator to remove XML nodes.

- - - Parameters - - - - - - - - - - -
child1:Object — The object in the source object that you insert after child2. - -
 
child2:Object — The object to insert. - - -
-

-Returns - - - - -
* — The resulting XML object or undefined. - - - -
-

-See also -

-
-XML.insertChildAfter() -
-delete (XML) operator -
-
-Example -
The following example appends an element to the end of the child elements of an XML object: -
-
-var xml:XML = 
-    	<menu>
-			<item>burger</item>
-			<item>soda</item>
-		</menu>;
-xml.insertChildBefore(xml.item[0], <saleItem>fries</saleItem>);
-trace(xml);
-
-
The trace() output is the following: - 
-  <menu>
-  	<saleItem>fries</saleItem>
-  	<item>burger</item>
-  	<item>soda</item>
-  </menu>
-
-
-

-
- - - - - -
length()method 
-
-AS3 function length():int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - For XML objects, this method always returns the integer 1. - - The length() method of the XMLList class returns a value of 1 for - - an XMLList object that contains only one value. - - -

-Returns - - - - -
int — - Always returns 1 for any XML object. - - - - -
-
- - - - - -
localName()method 
-
-AS3 function localName():Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Gives the local name portion of the qualified name of the XML object. - - -

-Returns - - - - -
Object — - The local name as either a String or null. - - - - -
-
-Example -
The following example illustrates the use of the localName() method: -
-
-var xml:XML = 
-    	<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
-			soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
-
-						<soap:Body xmlns:wx = "http://example.com/weather">
-				<wx:forecast>
-					<wx:city>Quito</wx:city>
-				</wx:forecast>
-			</soap:Body>
-		</soap:Envelope>;
-		
-trace(xml.localName()); // Envelope
-
-

-
- - - - - -
name()method 
-
-AS3 function name():Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Gives the qualified name for the XML object. - - -

-Returns - - - - -
Object — - The qualified name is either a QName or null. - - - - - -
-

-See also -

-
-XML.attributes() -
-attribute identifier -
-
-Example -
The following example illustrates the use of the name() method to get the qualified - name of an XML object: -
-
-var xml:XML = 
-    	<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
-			soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
-
-						<soap:Body xmlns:wx = "http://example.com/weather">
-				<wx:forecast>
-					<wx:city>Quito</wx:city>
-				</wx:forecast>
-			</soap:Body>
-		</soap:Envelope>;
-		
-trace(xml.name().localName); // Envelope
-trace(xml.name().uri); // "http://www.w3.org/2001/12/soap-envelope"
-
-

The following example illustrates the use of the name() method called on an XML property, - on a text element, and on an attribute: -
-
-var xml:XML = 
-    	<foo x="15" y="22">
-			text
-		</foo>;
-		
-trace(xml.name().localName); // foo
-trace(xml.name().uri == ""); // true
-trace(xml.children()[0]); // text
-trace(xml.children()[0].name()); // null
-trace(xml.attributes()[0]); // 15
-trace(xml.attributes()[0].name()); // x
-
-

-
- - - - - -
namespace()method 
-
-AS3 function namespace(prefix:String = null):* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - If no parameter is provided, gives the namespace associated with the qualified name of - - this XML object. If a prefix parameter is specified, the method returns the namespace - - that matches the prefix parameter and that is in scope for the XML object. If there is no - - such namespace, the method returns undefined. - - -

Parameters - - - - -
prefix:String (default = null) — The prefix you want to match. - - -
-

-Returns - - - - -
* — Returns null, undefined, or a namespace. - - -
-
-Example -
The following example uses the namespace() method - to get the namespace of an XML object and assign it to a Namespace object named soap - which is then used in identifying a property of the xml object - (xml.soap::Body[0]): -
-
-var xml:XML = 
-    	<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
-			soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
-
-						<soap:Body xmlns:wx = "http://example.com/weather">
-				<wx:forecast>
-					<wx:city>Quito</wx:city>
-				</wx:forecast>
-			</soap:Body>
-		</soap:Envelope>;
-		
-var soap:Namespace = xml.namespace();
-trace(soap.prefix); // soap
-trace(soap.uri); // http://www.w3.org/2001/12/soap-envelope
-
-var body:XML = xml.soap::Body[0];
-trace(body.namespace().prefix); // soap
-trace(xml.namespace().uri); // http://www.w3.org/2001/12/soap-envelope
-trace(body.namespace("wx").uri); // "http://example.com/weather"
-
-

The following example uses the namespace() method to get the - default namespace for a node, as well as the namespace for a specific prefix ("dc"): -
-
-var xml:XML = 
-    	<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 
-			xmlns:dc="http://purl.org/dc/elements/1.1/" 
-			xmlns="http://purl.org/rss/1.0/">
-				<!-- ... -->
-		</rdf:RDF>;
-					
-trace(xml.namespace()); // http://www.w3.org/1999/02/22-rdf-syntax-ns#
-trace(xml.namespace("dc")); // http://purl.org/dc/elements/1.1/
-trace(xml.namespace("foo")); // undefined
-
-

-
- - - - - -
namespaceDeclarations()method 
-
-AS3 function namespaceDeclarations():Array -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Lists namespace declarations associated with the XML object in the context of its parent. - - -

-Returns - - - - -
Array — - An array of Namespace objects. - - - - -
-

-See also -

-
-XML.namespace() -
-
-Example -
The following example outputs the namespace declarations of an - XML object: -
-
-var xml:XML = 
-    	<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 
-			xmlns:dc="http://purl.org/dc/elements/1.1/" 
-			xmlns="http://purl.org/rss/1.0/">
-
-			<!-- ... -->
-			
-		</rdf:RDF>;
-					
-for (var i:uint = 0; i < xml.namespaceDeclarations().length; i++) {
-	var ns:Namespace = xml.namespaceDeclarations()[i]; 
-	var prefix:String = ns.prefix;
-	if (prefix == "") {
-		prefix = "(default)";
-	}
-	trace(prefix + ":" , ns.uri);
-}
-
-
The trace() output is the following: - 
rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns#
- dc: http://purl.org/dc/elements/1.1/
- (default): http://purl.org/rss/1.0/
-
-
-

-
- - - - - -
nodeKind()method 
-
-AS3 function nodeKind():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies the type of node: text, comment, processing-instruction, - - attribute, or element. - - - -

-Returns - - - - -
String — - The node type used. - - - - -
-

-See also -

-
-attribute identifier -
-
-Example -
This example traces all five node types: -
-
-XML.ignoreComments = false;
-XML.ignoreProcessingInstructions = false;
-
-var xml:XML = 
-    <example id="10">
-    	<!-- this is a comment -->
-    	<?test this is a pi ?>
-    	and some text
-	</example>;
-
-trace(xml.nodeKind()); // element
-trace(xml.children()[0].nodeKind()); // comment
-trace(xml.children()[1].nodeKind()); // processing-instruction
-trace(xml.children()[2].nodeKind()); // text
-trace(xml.@id[0].nodeKind()); // attribute
-
-

-
- - - - - -
normalize()method 
-
-AS3 function normalize():XML -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - For the XML object and all descendant XML objects, merges adjacent text nodes and - - eliminates empty text nodes. - - -

-Returns - - - - -
XML — - The resulting normalized XML object. - - - - -
-
-Example -
The following example shows the effect of calling the normalize() method: -
-
-var xml:XML = <body></body>;
-xml.appendChild("hello");
-xml.appendChild(" world");
-trace(xml.children().length()); // 2
-xml.normalize();
-trace(xml.children().length()); // 1
-
-

-
- - - - - -
parent()method 
-
-AS3 function parent():* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns the parent of the XML object. If the XML object has no parent, the method returns - - undefined. - - -

-Returns - - - - -
* — Either an XML reference of the parent node, or undefined - - if the XML object has no parent. - - -
-
-Example -
The following example uses the parent() method to identify the parent element - of a specific element in an XML structure: -
-
-var xml:XML = 
-    <body>
-		<p id="p1">Hello</p>
-		<p id="p2">Test:
-			<ul>
-				<li>1</li>
-				<li>2</li>
-			</ul>
-		</p>
-	</body>;
-var node:XML = xml.p.ul.(li.contains("1"))[0]; // == <ul> ... </ul>
-trace(node.parent().@id); // p2
-
-

-
- - - - - -
prependChild()method 
-
-AS3 function prependChild(value:Object):XML -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Inserts a copy of the provided child object into the XML element before any existing XML - - properties for that element. - - -

Use the delete (XML) operator to remove XML nodes.

- - - Parameters - - - - -
value:Object — The object to insert. - - -
-

-Returns - - - - -
XML — - The resulting XML object. - - - - -
-

-See also -

-
-delete (XML) operator -
-
-Example -
The following example uses the prependChild() method to add an element to the - begining of a child list of an XML object: -
-
-var xml:XML = 
-    	<body>
-			<p>hello</p>
-		</body>;
-		
-xml.prependChild(<p>world</p>);	
-trace(xml.p[0].toXMLString()); // <p>world</p>
-trace(xml.p[1].toXMLString()); // <p>hello</p>
-
-

-
- - - - - -
processingInstructions()method 
-
-AS3 function processingInstructions(name:String = "*"):XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - If a name parameter is provided, lists all the children of the XML object - - that contain processing instructions with that name. With no parameters, the method - - lists all the children of the XML object that contain any processing instructions. - - -

Parameters - - - - -
name:String (default = "*") — The name of the processing instructions to match. - - -
-

-Returns - - - - -
XMLList — - A list of matching child objects. - - - - -
-
-Example -
The following example uses the processingInstructions() method to get an - array of processing instructions for an XML object: -
-
-XML.ignoreProcessingInstructions = false;
-var xml:XML =
-    <body>
-			foo
-			<?xml-stylesheet href="headlines.css" type="text/css" ?>
-			<?instructionX ?>
-			
-	</body>;
-
-trace(xml.processingInstructions().length()); // 2
-trace(xml.processingInstructions()[0].name()); // xml-stylesheet
-
-

-
- - - - - -
propertyIsEnumerable()method 
-
-AS3 function propertyIsEnumerable(p:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Checks whether the property p is in the set of properties that can be iterated in a - - for..in statement applied to the XML object. Returns true only - - if toString(p) == "0". - - -

Parameters - - - - -
p:String — The property that you want to check. - - -
-

-Returns - - - - -
Boolean — - If the property can be iterated in a for..in statement, true; - - otherwise, false. - - - - -
-
-Example -
The following example shows that, for an XML object, the - propertyNameIsEnumerable() method returns a value of - true only for the value 0; whereas for an - XMLList object, the return value is true for each valid index - value for the XMLList object: -
-
-var xml:XML = 
-    	<body>
- 			<p>Hello</p>
-   			<p>World</p>
-		</body>;
-
-trace(xml.propertyIsEnumerable(0)); // true
-trace(xml.propertyIsEnumerable(1)); // false
-
-for (var propertyName:String in xml) {
-	trace(xml[propertyName]);
-}
-
-var list:XMLList = xml.p;
-trace(list.propertyIsEnumerable(0)); // true
-trace(list.propertyIsEnumerable(1)); // true
-trace(list.propertyIsEnumerable(2)); // false
-
-for (var propertyName:String in list) { 
-	trace(list[propertyName]);
-}
-
-

-
- - - - - -
removeNamespace()method 
-
-AS3 function removeNamespace(ns:Namespace):XML -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Removes the given namespace for this object and all descendants. The removeNamespaces() - - method does not remove a namespace if it is referenced by the object's qualified name or the - - qualified name of the object's attributes. - - -

Parameters - - - - -
ns:Namespace — The namespace to remove. - - -
-

-Returns - - - - -
XML — - A copy of the resulting XML object. - - - - -
-
-Example -
The following example shows how to remove a namespace declaration - from an XML object: -
-
-var xml:XML = 
-    <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 
-		xmlns:dc="http://purl.org/dc/elements/1.1/" 
-		xmlns="http://purl.org/rss/1.0/">
-	
-		<!-- ... -->
-		
-	</rdf:RDF>;
-
-trace(xml.namespaceDeclarations().length); // 3
-trace(xml.namespaceDeclarations()[0] is String); // 
-var dc:Namespace = xml.namespace("dc");
-xml.removeNamespace(dc);
-trace(xml.namespaceDeclarations().length); // 2
-
-

-
- - - - - -
replace()method 
-
-AS3 function replace(propertyName:Object, value:XML):XML -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Replaces the properties specified by the propertyName parameter - - with the given value parameter. - - If no properties match propertyName, the XML object is left unmodified. - - - -

Parameters - - - - - - - - - - -
propertyName:Object — Can be a - - numeric value, an unqualified name for a set of XML elements, a qualified name for a set of - - XML elements, or the asterisk wildcard ("*"). - - Use an unqualified name to identify XML elements in the default namespace. - - - -
 
value:XML — The replacement value. This can be an XML object, an XMLList object, or any value - - that can be converted with toString(). - - -
-

-Returns - - - - -
XML — - The resulting XML object, with the matching properties replaced. - - - - -
-
-Example -
The following example illustrates calling the replace() method - with an integer as the first parameter: -
-
-var xml:XML = 
-    <body>
-		<p>Hello</p>
-		<p>World</p>
-		<hr/>
-	</body>;
-
-xml.replace(1, <p>Bob</p>);
-trace(xml);
-
-
This results in the following trace() output: - 

- <body>
- 	<p>Hello</p>
- 	<p>Bob</p>
- 	<hr/>
- </body>
-
-
-
-

The following example calls replace() method - with a string as the first parameter: -
-
-var xml:XML = 
-    <body>
-		<p>Hello</p>
-		<p>World</p>
-		<hr/>
-	</body>;
-
-xml.replace("p", <p>Hi</p>); 
-trace(xml);
-
-
This results in the following trace() output: - - 

- <body>
- 	<p>Hi</p>
- 	<hr/>
- </body>;
-
-
-
-

The following example illustrates calling the replace() method - with a QName as the first parameter: -
-
-var xml:XML = 
-    <ns:body xmlns:ns = "myNS">
-		<ns:p>Hello</ns:p>
-		<ns:p>World</ns:p>
-		<hr/>
-	</ns:body>;
-
-var qname:QName = new QName("myNS", "p");
-xml.replace(qname, <p>Bob</p>);
-trace(xml);
-
-
-
This results in the following trace() output: - - 

- <ns:body xmlns:ns = "myNS">
- 	<p>Bob</p>
- 	<hr/>
- </ns:body>
-
-
-
-

The following example illustrates calling the replace() method - with the string "" as the first parameter: -
-
-var xml:XML = 
-    <body>
-		<p>Hello</p>
-		<p>World</p>
-		<hr/>
-	</body>;
-
-xml.replace("*", <img src = "hello.jpg"/>);
-trace(xml);
-
-
This results in the following trace() output: - - 

- <body>
- 	<img src="hello.jpg"/>
- </body>
-
-
-
-

-
- - - - - -
setChildren()method 
-
-AS3 function setChildren(value:Object):XML -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Replaces the child properties of the XML object with the specified set of XML properties, - - provided in the value parameter. - - -

Parameters - - - - -
value:Object — The replacement XML properties. Can be a single XML object or an XMLList object. - - -
-

-Returns - - - - -
XML — - The resulting XML object. - - - - -
-
-Example -
The following example illustrates calling the setChildren() method, first - using an XML object as the parameter, and then using an XMLList object as the parameter: -
-
-var xml:XML = 
-    <body>
-		<p>Hello</p>
-		<p>World</p>
-	</body>;
-
-var list:XMLList = xml.p;
-
-xml.setChildren(<p>hello</p>);
-trace(xml);
-
-//	<body>
-//		<p>hello</p>
-//	</body>
-
-xml.setChildren(list);
-trace(xml);
-
-//	<body>
-//		<p>Hello</p>
-//		<p>World</p>
-//	</body>
-
-

-
- - - - - -
setLocalName()method 
-
-AS3 function setLocalName(name:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Changes the local name of the XML object to the given name parameter. - - -

Parameters - - - - -
name:String — The replacement name for the local name. - - -
-
-Example -
The following example uses the setLocalName() method - to change the local name of an XML element: -
-
-var xml:XML = 
-    <ns:item xmlns:ns="http://example.com">
-		toothbrush
-	</ns:item>;
-	
-xml.setLocalName("orderItem");
-trace(xml.toXMLString()); // <ns:orderItem xmlns:ns="http://example.com">toothbrush</ns:orderItem>
-
-

-
- - - - - -
setName()method 
-
-AS3 function setName(name:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Sets the name of the XML object to the given qualified name or attribute name. - - -

Parameters - - - - -
name:String — The new name for the object. - - -
-
-Example -
The following example uses the setName() method - to change the name of an XML element: -
-
-var xml:XML = 
-    <item>
-		toothbrush
-	</item>;
-	
-xml.setName("orderItem");
-trace(xml.toXMLString()); // <orderItem>toothbrush</orderItem>
-
-

-
- - - - - -
setNamespace()method 
-
-AS3 function setNamespace(ns:Namespace):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Sets the namespace associated with the XML object. - - -

Parameters - - - - -
ns:Namespace — The new namespace. - - -
-
-Example -
The following example uses the soap namespace defined in one XML object - and applies it to the namespace of another XML object (xml2): -
-
-var xml1:XML = 
-    	<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
-			soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
-			<!-- ... -->
-		</soap:Envelope>;
-var ns:Namespace = xml1.namespace("soap");
-
-var xml2:XML = 
-	<Envelope>
-		<Body/>
-	</Envelope>;
-	
-xml2.setNamespace(ns);
-
-trace(xml2);
-
-
-

-
- - - - - -
setSettings()method 
-
-AS3 static function setSettings(... rest):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Sets values for the following XML properties: ignoreComments, - - ignoreProcessingInstructions, ignoreWhitespace, - - prettyIndent, and prettyPrinting. - - - - The following are the default settings, which are applied if no setObj parameter - - is provided: - - -

    - -
  • XML.ignoreComments = true
    • - -
  • XML.ignoreProcessingInstructions = true
    • - -
  • XML.ignoreWhitespace = true
    • - -
  • XML.prettyIndent = 2
    • - -
  • XML.prettyPrinting = true
    • - -
- - -

Note: You do not apply this method to an instance of the XML class; you apply it to - - XML, as in the following code: XML.setSettings().

- - - Parameters - - - - -
... rest — An object with each of the following properties: - - - -
    - -
  • ignoreComments
    • - -
  • ignoreProcessingInstructions
    • - -
  • ignoreWhitespace
    • - -
  • prettyIndent
    • - -
  • prettyPrinting
    • - -
- - -
-

-See also -

-
-ignoreComments -
-ignoreProcessingInstructions -
-ignoreWhitespace -
-prettyIndent -
-prettyPrinting -
-defaultSettings() -
-settings() -
-
-Example -
The following example shows: how to apply some custom settings (for including comments and processing - instructions) prior to setting an XML object; how to then revert back to the default settings before setting another XML - object; and then how to set the custom settings again (for setting any more XML objects): -
-
-XML.ignoreComments = false;
-XML.ignoreProcessingInstructions = false;
-var customSettings:Object = XML.settings();
-
-var xml1:XML = 
-    	<foo>
-			<!-- comment -->
-			<?instruction ?>
-		</foo>;
-trace(xml1.toXMLString());
-//	<foo>
-//		<!-- comment -->
-// 		<?instruction ?>
-//	</foo>
-
-XML.setSettings(XML.defaultSettings());
-var xml2:XML = 
-		<foo>
-			<!-- comment -->
-			<?instruction ?>
-		</foo>;
-trace(xml2.toXMLString());
-
-

-
- - - - - -
settings()method 
-
-AS3 static function settings():Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Retrieves the following properties: ignoreComments, - - ignoreProcessingInstructions, ignoreWhitespace, - - prettyIndent, and prettyPrinting. - - -

-Returns - - - - -
Object — - An object with the following XML properties: - -
    - -
  • ignoreComments
    • - -
  • ignoreProcessingInstructions
    • - -
  • ignoreWhitespace
    • - -
  • prettyIndent
    • - -
  • prettyPrinting
    • - -
- - - - -
-

-See also -

-
-XML.ignoreComments -
-XML.ignoreProcessingInstructions -
-XML.ignoreWhitespace -
-XML.prettyIndent -
-XML.prettyPrinting -
-XML.defaultSettings() -
-XML.setSettings() -
-
-Example -
The following example shows: how to apply some custom settings (for including comments and processing - instructions) prior to setting an XML object; how to then revert back to the default settings before setting another XML - object; and then how to set the custom settings again (for setting any more XML objects): -
-
-XML.ignoreComments = false;
-XML.ignoreProcessingInstructions = false;
-var customSettings:Object = XML.settings();
-
-var xml1:XML = 
-    	<foo>
-			<!-- comment -->
-			<?instruction ?>
-		</foo>;
-trace(xml1.toXMLString());
-//	<foo>
-//		<!-- comment -->
-// 		<?instruction ?>
-//	</foo>
-
-XML.setSettings(XML.defaultSettings());
-var xml2:XML = 
-		<foo>
-			<!-- comment -->
-			<?instruction ?>
-		</foo>;
-trace(xml2.toXMLString());
-
-

-
- - - - - -
text()method 
-
-AS3 function text():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns an XMLList object of all XML properties of the XML object that represent XML text nodes. - - - -

-Returns - - - - -
XMLList — - The list of properties. - - - - -
-
-Example -
The following example uses the text() method to get the text nodes of - an XML object: -
-
-var xml:XML =
-    	<body>
-			text1
-			<hr/>
-			text2
-		</body>;
-trace(xml.text()[0]); // text1
-trace(xml.text()[1]); // text2
-
-

-
- - - - - -
toJSON()method 
-
-AS3 function toJSON(k:String):* -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Provides an overridable method for customizing the JSON encoding of values in an XML object. - - -

The JSON.stringify() method looks for a toJSON() method on each object that it traverses. If the - - toJSON() method is found, JSON.stringify() calls it for each value it encounters, passing in the key - - that is paired with the value.

- -

XML provides a default implementation of toJSON() that simply returns the name of the class. Clients that wish - - to export XML objects to JSON must provide their own implementation. You can do this by redefining the toJSON() - - method on the class prototype.

- -

The toJSON() method can return a value of any type. If it returns an object, stringify() recurses into that object. - - If toJSON() returns a string, stringify() does not recurse and continues its traversal.

- - - Parameters - - - - -
k:String — The key of a key/value pair that JSON.stringify() has encountered in its traversal of this object - - -
-

-Returns - - - - -
* — The class name string. - -
-

-See also -

-
-Object -
Object.prototype
-
- - - - - -
toString()method 
-
-AS3 function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns a string representation of the XML object. The rules for this conversion depend on whether - - the XML object has simple content or complex content: - - -

    - -
  • If the XML object has simple content, toString() returns the String contents of the - - XML object with the following stripped out: the start tag, attributes, namespace declarations, and - - end tag.
    • - -
- - - -
    - -
  • If the XML object has complex content, toString() returns an XML encoded String - - representing the entire XML object, including the start tag, attributes, namespace declarations, - - and end tag.
    • - -
- - - -

To return the entire XML object every time, use toXMLString().

- - - -

-Returns - - - - -
String — - The string representation of the XML object. - - - - -
-

-See also -

-
-XML.hasSimpleContent() -
-XML.hasComplexContent() -
-XML.toXMLString() -
-
-Example -
The following example shows what the toString() method returns when the - XML object has simple content: -
-
-var test:XML = <type name="Joe">example</type>;
-trace(test.toString()); //example
-
-

The following example shows what the toString() method returns when the - XML object has complex content: -
-
-var test:XML = 
-<type name="Joe">
-    <base name="Bob"></base>
-	example
-</type>;
-trace(test.toString());
-  // <type name="Joe">
-  // <base name="Bob"/>
-  // example
-  // </type>
-
-

-
- - - - - -
toXMLString()method 
-
-AS3 function toXMLString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns a string representation of the XML object. Unlike the toString() method, - - the toXMLString() method always returns the start tag, attributes, - - and end tag of the XML object, regardless of whether the XML object has simple content or complex - - content. (The toString() method strips out these items for XML objects that contain - - simple content.) - - - -

-Returns - - - - -
String — - The string representation of the XML object. - - - - - -
-

-See also -

-
-XML.toString() -
-
-Example -
The following example shows the difference between using the toString() method - (which is applied to all parameters of a trace() method, by default) and using the - toXMLString() method: -
-
-var xml:XML =
-    	<p>hello</p>;
-trace(xml); // hello
-trace(xml.toXMLString()); // <p>hello</p>
-
-

-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():XML -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns the XML object. - - -

-Returns - - - - -
XML — - The primitive value of an XML instance. - - - - -
-
-Example -
The following example shows that the value returned by the valueOf() method - is the same as the source XML object: -
-
-var xml:XML = <p>hello</p>;
-trace(xml.valueOf() === xml); // true
-
-

-
- -
Examples
-
examples\XMLExample
-
The following example first creates an XML variable and adds nodes to it. - Then XML properties are used to find and print XML nodes. Notice that the "at" - (@) symbol is used in several of the trace() calls to locate information - by attribute name. -
-
-package {
-    import flash.display.Sprite;
-
-	public class XmlExample extends Sprite {		
-		public function XmlExample() {
-			var employees:XML =
-				<employees>
-					<employee ssn="123-123-1234">
-						<name first="John" last="Doe"/>
-						<address>
-							<street>11 Main St.</street>
-							<city>San Francisco</city>
-							<state>CA</state>
-							<zip>98765</zip>
-						</address>
-					</employee>
-					<employee ssn="789-789-7890">
-						<name first="Mary" last="Roe"/>
-						<address>
-							<street>99 Broad St.</street>
-							<city>Newton</city>
-							<state>MA</state>
-							<zip>01234</zip>
-						</address>
-					</employee>
-				</employees>;
-
-			trace(employees.employee[0].address.zip);   // 98765
-
-			trace(employees.employee[1].@ssn);          // 789-789-7890
-
-			trace(employees.employee.name);             // <name first="John" last="Doe"/>
-														// <name first="Mary" last="Roe"/>
-
-			trace(employees..zip[0]);                   // 98765
-
-			trace(employees..@ssn[1]);                  // 789-789-7890
-
-			trace(employees..name);                     // <name first="John" last="Doe"/>
-														// <name first="Mary" last="Roe"/>
-
-			trace(employees.employee[0].address.*);     // <street>11 Main St.</street>	
-														// <city>San Francisco</city>
-														// <state>CA</state>
-														// <zip>98765</zip>
-			var node:String = "zip";
-    		trace(employees.employee[0].address[node]); // 98765
-    		
-    		var attribute:String = "ssn";
-    		trace(employees.employee[1].@[attribute]);  // 789-789-7890
-    		
-			for each (var num:XML in employees..@ssn) {
-				trace(num);                             // 123-123-1234
-    		}                                           // 789-789-7890
-    		
-			var ssnToFind:String = "789-789-7890";
-			trace(employees.employee.(@ssn == ssnToFind).toXMLString());
-														// <employee ssn="789-789-7890">
-														// <name first="Mary" last="Roe"/>
-														// <address>
-														// <street>99 Broad St.</street>
-														// <city>Newton</city>
-														// <state>MA</state>
-														// <zip>01234</zip>
-														// </address>
-														// </employee>
-    	}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/XMLList.html b/html-docs/XMLList.html deleted file mode 100644 index 2d6b459..0000000 --- a/html-docs/XMLList.html +++ /dev/null @@ -1,1673 +0,0 @@ - - - - - - - - -XMLList (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final dynamic class XMLList
InheritanceXMLList Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - The XMLList class contains methods for working with one or more XML elements. An XMLList object - - can represent one or more XML objects or elements (including multiple nodes or attributes), so - - you can call methods on the elements as a group or on the individual elements in the collection. - -

If an XMLList object has only one XML element, you can use the XML class methods on the - - XMLList object directly. In the following example, example.two is an XMLList - - object of length 1, so you can call any XML method on it.

- - 
-
- var example2 = <example><two>2</two></example>;
- -

If you attempt to use XML class methods with an XMLList object containing more than one XML - - object, an exception is thrown; instead, iterate over the XMLList collection (using a - - for each..in statement, for example) and apply the methods to each XML object in - - the collection.

- - -

-

-View the examples. -

-

-See also -

-
-XML -
-for each..in -
-Namespace -
-QName -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-XMLList(value:Object)
-
- - Creates a new XMLList object.
-		XMLList
   -
-attribute(attributeName:*):XMLList -
-
- - Calls the attribute() method of each XML object and returns an XMLList object - - of the results.
-		XMLList
   -
-attributes():XMLList -
-
- - Calls the attributes() method of each XML object and - - returns an XMLList object of attributes for each XML object.
-		XMLList
   -
-child(propertyName:Object):XMLList -
-
- - Calls the child() method of each XML object and returns an XMLList object that - - contains the results in order.
-		XMLList
   -
-children():XMLList -
-
- - Calls the children() method of each XML object and - - returns an XMLList object that contains the results.
-		XMLList
   -
-comments():XMLList -
-
- - Calls the comments() method of each XML object and returns - - an XMLList of comments.
-		XMLList
   -
-contains(value:XML):Boolean -
-
- - Checks whether the XMLList object contains an XML object that is equal to the given - - value parameter.
-		XMLList
   -
-copy():XMLList -
-
- - Returns a copy of the given XMLList object.
-		XMLList
   -
-descendants(name:Object = *):XMLList -
-
- - Returns all descendants (children, grandchildren, great-grandchildren, and so on) of the XML object - - that have the given name parameter.
-		XMLList
   -
-elements(name:Object = *):XMLList -
-
- - Calls the elements() method of each XML object.
-		XMLList
   -
-hasComplexContent():Boolean -
-
- - Checks whether the XMLList object contains complex content.
-		XMLList
   -
-hasOwnProperty(p:String):Boolean -
-
- - Checks for the property specified by p.
-		XMLList
   -
-hasSimpleContent():Boolean -
-
- - Checks whether the XMLList object contains simple content.
-		XMLList
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-length():int -
-
- - Returns the number of properties in the XMLList object.
-		XMLList
   -
-normalize():XMLList -
-
- - Merges adjacent text nodes and eliminates empty text nodes for each - - of the following: all text nodes in the XMLList, all the XML objects - - contained in the XMLList, and the descendants of all the XML objects in - - the XMLList.
-		XMLList
   -
-parent():Object -
-
- - Returns the parent of the XMLList object if all items in the XMLList object have the same parent.
-		XMLList
   -
-processingInstructions(name:String = "*"):XMLList -
-
- - If a name parameter is provided, lists all the children of the XMLList object that - - contain processing instructions with that name.
-		XMLList
   -
-propertyIsEnumerable(p:String):Boolean -
-
- - Checks whether the property p is in the set of properties that can be iterated in a for..in statement - - applied to the XMLList object.
-		XMLList
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-text():XMLList -
-
- - Calls the text() method of each XML - - object and returns an XMLList object that contains the results.
-		XMLList
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string representation of all the XML objects in an XMLList object.
-		XMLList
   -
-toXMLString():String -
-
- - Returns a string representation of all the XML objects in an XMLList object.
-		XMLList
   -
-valueOf():XMLList -
-
- - Returns the XMLList object.
-		XMLList
-
- -
- -
Constructor detail
- - - - - -
XMLList()constructor
-
-public function XMLList(value:Object) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Creates a new XMLList object. - - -

Parameters - - - - -
value:Object — Any object that can be converted to an XMLList object by using the top-level XMLList() function. - - -
-

-See also -

-
-top-level XMLList() function -
-
- -
Method detail
- - - - - -
attribute()method
-
-AS3 function attribute(attributeName:*):XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Calls the attribute() method of each XML object and returns an XMLList object - - of the results. The results match the given attributeName parameter. If there is no - - match, the attribute() method returns an empty XMLList object. - - - -

Parameters - - - - -
attributeName:* — The name of the attribute that you want to include in an XMLList object. - - -
-

-Returns - - - - -
XMLList — - An XMLList object of matching XML objects or an empty XMLList object. - - - - -
-

-See also -

-
-XML.attribute() -
-XML.attributes() -
-
- - - - - -
attributes()method 
-
-AS3 function attributes():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Calls the attributes() method of each XML object and - - returns an XMLList object of attributes for each XML object. - - -

-Returns - - - - -
XMLList — - An XMLList object of attributes for each XML object. - - - - -
-

-See also -

-
-XML.attribute() -
-XML.attributes() -
-
- - - - - -
child()method 
-
-AS3 function child(propertyName:Object):XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Calls the child() method of each XML object and returns an XMLList object that - - contains the results in order. - - -

Parameters - - - - -
propertyName:Object — The element name or integer of the XML child. - - -
-

-Returns - - - - -
XMLList — - An XMLList object of child nodes that match the input parameter. - - - - -
-

-See also -

-
-XML.child() -
-
- - - - - -
children()method 
-
-AS3 function children():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Calls the children() method of each XML object and - - returns an XMLList object that contains the results. - - -

-Returns - - - - -
XMLList — - An XMLList object of the children in the XML objects. - - - - -
-

-See also -

-
-XML.children() -
-
- - - - - -
comments()method 
-
-AS3 function comments():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Calls the comments() method of each XML object and returns - - an XMLList of comments. - - -

-Returns - - - - -
XMLList — - An XMLList of the comments in the XML objects. - - - - -
-

-See also -

-
-XML.comments() -
-
- - - - - -
contains()method 
-
-AS3 function contains(value:XML):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Checks whether the XMLList object contains an XML object that is equal to the given - - value parameter. - - -

Parameters - - - - -
value:XML — An XML object to compare against the current XMLList object. - - -
-

-Returns - - - - -
Boolean — - If the XMLList contains the XML object declared in the value parameter, - - then true; otherwise false. - - - - -
-
- - - - - -
copy()method 
-
-AS3 function copy():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns a copy of the given XMLList object. The copy is a duplicate of the entire tree of nodes. - - The copied XML object has no parent and returns null if you attempt to call the parent() method. - - -

-Returns - - - - -
XMLList — - The copy of the XMLList object. - - - - -
-
- - - - - -
descendants()method 
-
-AS3 function descendants(name:Object = *):XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns all descendants (children, grandchildren, great-grandchildren, and so on) of the XML object - - that have the given name parameter. The name parameter can be a - - QName object, a String data type, or any other data type that is then converted to a String - - data type. - - - -

To return all descendants, use - - the asterisk (*) parameter. If no parameter is passed, - - the string "*" is passed and returns all descendants of the XML object.

- - - Parameters - - - - -
name:Object (default = *) — The name of the element to match. - - -
-

-Returns - - - - -
XMLList — - An XMLList object of the matching descendants (children, grandchildren, and so on) of the XML objects - - in the original list. If there are no descendants, returns an empty XMLList object. - - - - - -
-

-See also -

-
-XML.descendants() -
-
- - - - - -
elements()method 
-
-AS3 function elements(name:Object = *):XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Calls the elements() method of each XML object. The name parameter is - - passed to the descendants() method. If no parameter is passed, the string "*" is passed to the - - descendants() method. - - -

Parameters - - - - -
name:Object (default = *) — The name of the elements to match. - - -
-

-Returns - - - - -
XMLList — - An XMLList object of the matching child elements of the XML objects. - - - - -
-

-See also -

-
-XML.elements() -
-
- - - - - -
hasComplexContent()method 
-
-AS3 function hasComplexContent():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Checks whether the XMLList object contains complex content. An XMLList object is - - considered to contain complex content if it is not empty and either of the following conditions is true: - - -

    - -
  • The XMLList object contains a single XML item with complex content.
    • - -
  • The XMLList object contains elements.
    • - -
- - -

-Returns - - - - -
Boolean — - If the XMLList object contains complex content, then true; otherwise false. - - - - -
-

-See also -

-
-hasSimpleContent() -
-XML.hasComplexContent() -
-XML.hasSimpleContent() -
-
- - - - - -
hasOwnProperty()method 
-
-AS3 function hasOwnProperty(p:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Checks for the property specified by p. - - -

Parameters - - - - -
p:String — The property to match. - - -
-

-Returns - - - - -
Boolean — - If the parameter exists, then true; otherwise false. - - - - -
-
- - - - - -
hasSimpleContent()method 
-
-AS3 function hasSimpleContent():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Checks whether the XMLList object contains simple content. An XMLList object is - - considered to contain simple content if one or more of the following - - conditions is true: - -

    - -
  • The XMLList object is empty
    • - -
  • The XMLList object contains a single XML item with simple content
    • - -
  • The XMLList object contains no elements
    • - -
- - -

-Returns - - - - -
Boolean — - If the XMLList contains simple content, then true; otherwise false. - - - - -
-

-See also -

-
-hasComplexContent() -
-XML.hasComplexContent() -
-XML.hasSimpleContent() -
-
- - - - - -
length()method 
-
-AS3 function length():int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns the number of properties in the XMLList object. - - -

-Returns - - - - -
int — - The number of properties in the XMLList object. - - - - - -
-
- - - - - -
normalize()method 
-
-AS3 function normalize():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Merges adjacent text nodes and eliminates empty text nodes for each - - of the following: all text nodes in the XMLList, all the XML objects - - contained in the XMLList, and the descendants of all the XML objects in - - the XMLList. - - -

-Returns - - - - -
XMLList — - The normalized XMLList object. - - - - -
-
- - - - - -
parent()method 
-
-AS3 function parent():Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns the parent of the XMLList object if all items in the XMLList object have the same parent. - - If the XMLList object has no parent or different parents, the method returns undefined. - - -

-Returns - - - - -
Object — - Returns the parent XML object. - - - - -
-
- - - - - -
processingInstructions()method 
-
-AS3 function processingInstructions(name:String = "*"):XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - If a name parameter is provided, lists all the children of the XMLList object that - - contain processing instructions with that name. With no parameters, the method lists all the - - children of the XMLList object that contain any processing instructions. - - -

Parameters - - - - -
name:String (default = "*") — The name of the processing instructions to match. - - -
-

-Returns - - - - -
XMLList — - An XMLList object that contains the processing instructions for each XML object. - - - - -
-

-See also -

-
-XML.processingInstructions() -
-
- - - - - -
propertyIsEnumerable()method 
-
-AS3 function propertyIsEnumerable(p:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Checks whether the property p is in the set of properties that can be iterated in a for..in statement - - applied to the XMLList object. This is true only if toNumber(p) is greater than or equal to 0 - - and less than the length of the XMLList object. - - -

Parameters - - - - -
p:String — The index of a property to check. - - -
-

-Returns - - - - -
Boolean — - If the property can be iterated in a for..in statement, then true; otherwise false. - - - - -
-
- - - - - -
text()method 
-
-AS3 function text():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Calls the text() method of each XML - - object and returns an XMLList object that contains the results. - - -

-Returns - - - - -
XMLList — - An XMLList object of all XML properties of the XMLList object that represent XML text nodes. - - - - -
-

-See also -

-
-XML.text() -
-
- - - - - -
toString()method 
-
-AS3 function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns a string representation of all the XML objects in an XMLList object. The rules for - - this conversion depend on whether the XML object has simple content or complex content: - - -

    - -
  • If the XML object has simple content, toString() returns the string contents of the - - XML object with the following stripped out: the start tag, attributes, namespace declarations, and - - end tag.
    • - -
- - - -
    - -
  • If the XML object has complex content, toString() returns an XML encoded string - - representing the entire XML object, including the start tag, attributes, namespace declarations, - - and end tag.
    • - -
- - - -

To return the entire XML object every time, use the toXMLString() method.

- - - -

-Returns - - - - -
String — - The string representation of the XML object. - - - - -
-

-See also -

-
-hasComplexContent() -
-hasSimpleContent() -
-toXMLString() -
-
-Example -
The following example shows what the toString() method returns when the - XML object has simple content: -
-
-var test:XML = <type name="Joe">example</type>;
-trace(test.toString()); //example
-
-

The following example shows what the toString() method returns when the - XML object has complex content: -
-
-var test:XML = 
-<type name="Joe">
-    <base name="Bob"></base>
-	example
-</type>;
-trace(test.toString());
-  // <type name="Joe">
-  // <base name="Bob"/>
-  // example
-  // </type>
-
-

-
- - - - - -
toXMLString()method 
-
-AS3 function toXMLString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns a string representation of all the XML objects in an XMLList object. - - Unlike the toString() method, the toXMLString() - - method always returns the start tag, attributes, - - and end tag of the XML object, regardless of whether the XML object has simple content - - or complex content. (The toString() method strips out these items for XML - - objects that contain simple content.) - - - -

-Returns - - - - -
String — - The string representation of the XML object. - - - - - -
-

-See also -

-
-toString() -
-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():XMLList -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns the XMLList object. - - -

-Returns - - - - -
XMLList — - Returns the current XMLList object. - - - - -
-
- -
Examples
-
examples\XMLListExample
-
The following example creates an XML property named books and adds several - items with book publisher and name tags to a node named books. - Then the showBooksByPublisher() method is called, - which takes the XMLList and returns each item matching the publisher, "Addison-Wesley." -
-
-package {
-    import flash.display.Sprite;
-
-	public class XMLListExample extends Sprite {
-		private var books:XML;
-
-		public function XMLListExample() {
-			books =	<books>
-						<book publisher="Addison-Wesley" name="Design Patterns" />
-						<book publisher="Addison-Wesley" name="The Pragmatic Programmer" />
-						<book publisher="Addison-Wesley" name="Test Driven Development" />
-						<book publisher="Addison-Wesley" name="Refactoring to Patterns" />
-						<book publisher="O'Reilly Media" name="The Cathedral & the Bazaar" />
-						<book publisher="O'Reilly Media" name="Unit Test Frameworks" />
-					</books>;
-
-			showBooksByPublisher("Addison-Wesley");
-		}
-
-		private function showBooksByPublisher(name:String):void {
-			var results:XMLList = books.book.(@publisher == name);
-			showList(results);
-		}
-
-		private function showList(list:XMLList):void {
-			var item:XML;
-			for each(item in list) {
-				trace("item: " + item.toXMLString());
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/air/net/WebSocket.html b/html-docs/air/net/WebSocket.html deleted file mode 100644 index 2131dbd..0000000 --- a/html-docs/air/net/WebSocket.html +++ /dev/null @@ -1,1259 +0,0 @@ - - - - - - - - -air.net.WebSocket (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.net
Classpublic class WebSocket
InheritanceWebSocket Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

-

- - The WebSocket class is a utility that encapsulates a normal Socket object - - and implements the WebSocket protocol (RFC 6455). - - -

This can be used in conjunction with - - a ServerSocket object to allow web pages to connect to and communicate with - - an AIR application - once a connection is received, create a new WebSocket instance - - and call startServer() to handle the protocol handshake.

- - -

To initiate an outgoing WebSocket connection to a server, use the connect() - - method, passing in the URL string in format "ws://some.example.com/ws/demo" - - ('wss' can be used for secure WebSocket over TLS connections). An optional set of protocols - - can be passed in, that will be passed to the server, and the chosen protocol can then be accessed - - via the protocol property.

- - -

If a PING message is received by a WebSocket object, it will automatically response - - with the appropriate PONG message. It is up to the developer to implement any - - outgoing PING messages (or unsolicited PONGs) should those be desired.

- - -

Note: messages are limited to 4GB in size, due to the restrictions of the ByteArray class.

- - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
  closeReason : int -
[read-only] - - Retrieves the 'close' reason code, after the WebSocket has been closed.
-		WebSocket
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  protocol : String -
- - The protocol for the WebSocket connection (for the Sec-WebSocket-Protocol field).
-		WebSocket
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-WebSocket()
-
- - Constructor for a WebSocket object.
-		WebSocket
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-close(reasonCode:uint = 1000):void -
-
- - Closes the WebSocket.
-		WebSocket
   -
-connect(url:String, protocols:Vector.<String> = null):void -
-
- - Initiates a connection as a WebSocket client.
-		WebSocket
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-sendMessage(opcode:uint, data:*):void -
-
- - Sends a message via the WebSocket protocol.
-		WebSocket
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-startServer(s:Socket):void -
-
- - Takes over an existing connection in order to act as a socket server.
-		WebSocket
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-certificateError -
-		 - - Dispatched if there is a certificate error when trying to open a WebSocket connection.WebSocket
   -
-close -
-		 - - Dispatched when the WebSocket is closed by the other party.WebSocket
   -
-connect -
-		 - - Dispatched when a client WebSocket is connected (following successful handshake).WebSocket
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-ioError -
-		 - - Dispatched if there is a connection error when trying to open a WebSocket connection.WebSocket
   -
-securityError -
-		 - - Dispatched if there is a security error when trying to open a WebSocket connection.WebSocket
   -
-websocketData -
-		 - - Dispatched when the WebSocket receives a message.WebSocket
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  fmtBINARY : uint = 2
[static] - - Code for a BINARY websocket message.
-		WebSocket
  fmtCLOSE : uint = 8
[static] - - Code for a CLOSE websocket message.
-		WebSocket
  fmtPING : uint = 9
[static] - - Code for a PING websocket message.
-		WebSocket
  fmtPONG : uint = 10
[static] - - Code for a PONG websocket message.
-		WebSocket
  fmtTEXT : uint = 1
[static] - - Code for a TEXT websocket message.
-		WebSocket
-
- -
- -
Property detail
- - - - - -
closeReasonproperty
-
-closeReason:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Retrieves the 'close' reason code, after the WebSocket has been closed. - - -

Implementation -
-    public function get closeReason():int -
-
- - - - - -
protocolproperty 
-
-protocol:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - The protocol for the WebSocket connection (for the Sec-WebSocket-Protocol field). - -

For a server WebSocket, this can be used to specify the protocol to send back to the client. For a client WebSocket, - - this field will be populated with the value that the server had specified during handshaking. Following handshaking, - - the protocol value becomes read-only.

- - - Implementation -
-    public function get protocol():String -
-    public function set protocol(value:String):void -
-
- -
Constructor detail
- - - - - -
WebSocket()constructor
-
-public function WebSocket() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Constructor for a WebSocket object. Once created, the object can - - either be used as a server (via startServer()) or as a client - - (via connect()). - - -

- -
Method detail
- - - - - -
close()method
-
-public function close(reasonCode:uint = 1000):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Closes the WebSocket. - -

Note that if this method is used, no Event.CLOSE event is dispatched.

- - - Parameters - - - - -
reasonCode:uint (default = 1000) — The code to use in the 'close' WebSocket message, defaulting to 1000 ("normal closure"). - - -
-
- - - - - -
connect()method 
-
-public function connect(url:String, protocols:Vector.<String> = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Initiates a connection as a WebSocket client. - -

This will connect to the host provided in the url, either via a normal Socket or using - - a SecureSocket if a 'wss' protocol is requested. It will then initiate an HTTP protocol - - handshake to upgrade the connection to use WebSockets. If the upgrade fails, the socket will be closed - - and a Event.CLOSE event will be dispatched.

- - - Parameters - - - - - - - - - - -
url:String — The target WebSocket URL, for example "ws://localhost:4200/testing". - -
 
protocols:Vector.<String> (default = null) — An optional array of protocol strings that will be passed to the server. - - -
-
-Throws - - - - -
ArgumentError — When there is already a socket connection open, or if the url is an invalid protocol. - - -
-
- - - - - -
sendMessage()method 
-
-public function sendMessage(opcode:uint, data:*):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Sends a message via the WebSocket protocol. - - -

Parameters - - - - - - - - - - -
opcode:uint — The message type to send (text, binary, ping, pong etc). - -
 
data:* — The data to send (either a String or a ByteArray). - - -
-
-Throws - - - - -
ArgumentError — When the data is null or an invalid object type, or is too long. - - -
-
- - - - - -
startServer()method 
-
-public function startServer(s:Socket):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Takes over an existing connection in order to act as a socket server. - -

Calling this method will set up the WebSocket object to - - listen out for an HTTP request to upgrade the connection to the WebSocket - - protocol.

- -

If the data that's received is not an HTTP upgrade request, the socket - - will be closed and a Event.CLOSE event will trigger.

- - - Parameters - - - - -
s:Socket — The Socket object to adopt for the WebSocket server. - - -
-
-Throws - - - - -
ArgumentError — If the provided socket argument is null. - - -
-
-
Event detail
- - - - - -
certificateErrorevent 
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.CERTIFICATE_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Dispatched if there is a certificate error when trying to open a WebSocket connection. - - -

- - The SecurityErrorEvent.CERTIFICATE_ERROR constant is used when the runtime detects a problem with a server's security certificate. This event - - is then dispatched, giving the application the chance to handle this and determine whether to allow the connection or to block it (which is the default - - behaviour). To allow it, call preventDefault() on the error object. Note that not handling this error type will result in the default operating system - - behaviour - typically, a message will be displayed to the end user to allow them to choose the action. - - -

This event has the following properties:

- - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelabletrue; default behavior is to close the connection, use preventDefault() to allow it.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- - -
- - - - - -
closeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLOSE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Dispatched when the WebSocket is closed by the other party. - - The reason for the closure can be obtained from the closeReason property. - - -

- The Event.CLOSE constant defines the value of the type property of a close event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection has been closed.
- -
- - - - - -
connectevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CONNECT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Dispatched when a client WebSocket is connected (following successful handshake). - - -

- The Event.CONNECT constant defines the value of the type property of a connect event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Socket or XMLSocket object that has established a network connection.
- -
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Dispatched if there is a connection error when trying to open a WebSocket connection. - - -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Dispatched if there is a security error when trying to open a WebSocket connection. - - -

- - The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- - - -
- - - - - -
websocketDataevent  
-
-Event object type: flash.events.WebSocketEvent -
-WebSocketEvent.type property = flash.events.WebSocketEvent.DATA -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Dispatched when the WebSocket receives a message. - - -

- - The WebSocketEvent.DATA constant is used when a complete message has been received by a WebSocket object. - - The event type and (if any) the message data is then provided by the event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe network object reporting the security error.
formatThe format of the WebSocket message ('TEXT', 'BINARY' etc).
dataThe message data as a ByteArray.
stringDataThe message data as a string, for 'TEXT' messages.
- - -
- -
Constant detail
- - - - - -
fmtBINARYconstant
-
-public static const fmtBINARY:uint = 2 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Code for a BINARY websocket message. - -

- - - - - -
fmtCLOSEconstant 
-
-public static const fmtCLOSE:uint = 8 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Code for a CLOSE websocket message. - -

- - - - - -
fmtPINGconstant 
-
-public static const fmtPING:uint = 9 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Code for a PING websocket message. - -

- - - - - -
fmtPONGconstant 
-
-public static const fmtPONG:uint = 10 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Code for a PONG websocket message. - -

- - - - - -
fmtTEXTconstant 
-
-public static const fmtTEXT:uint = 1 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Code for a TEXT websocket message. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Sat Jan 11 2025, 8:30 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/air/net/package-detail.html b/html-docs/air/net/package-detail.html deleted file mode 100644 index 01150ec..0000000 --- a/html-docs/air/net/package-detail.html +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - - -air.net Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

This package includes classes used for network detection. The classes in this package are not defined in the runtime. This package is only available to content running in the AIR runtime. In a SWF-based application, you must include the ServiceMonitor.swc file in the compiler to access these classes. In an HTML-based application, you must load the ServiceMonitor.swf file (via a script tag) to access these classes.

-
-
- -
Classes
- - - - - - - -
 ClassDescription
 WebSocket - The WebSocket class is a utility that encapsulates a normal Socket object - and implements the WebSocket protocol (RFC 6455).
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
-
- - - diff --git a/html-docs/air/security/Digest.html b/html-docs/air/security/Digest.html deleted file mode 100644 index a765c8e..0000000 --- a/html-docs/air/security/Digest.html +++ /dev/null @@ -1,1101 +0,0 @@ - - - - - - - - -air.security.Digest (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageair.security
Classpublic class Digest
InheritanceDigest Inheritance Object
ImplementsIDataOutput
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

-

- The Digest class is used to generate a digest, or hash, of some data. - It can be used to generate a fixed-length, one-way hash value based on - arbitrary-sized data, to create a checksum and to attempt to quickly detect - changes in data for validation purposes. -

This class is similar to the Java java.security.MessageDigest implementation, - and can be used in two ways:

-
    -
  1. By creating an instance of the Digest class with a particular algorith, and then feeding - data into the object using repeated calls to one of the IDataOutput methods, and finally then - calling the digest method in order to calculate the hash value.
    2. -
  2. By calling the static hash method with a ByteArray to perform the whole - operation in a single call.
    3. -
- -

The supported algorithms are "SHA-1", "SHA-256", and "MD5". -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  endian : String -
- The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN - constant from the Endian class.
-		Digest
  objectEncoding : uint -
- Used to determine whether the AMF3 or AMF0 format is used when writing binary data using the - writeObject() method.
-		Digest
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Digest(algorithm:String)
-
- Creates a Digest object using the requested algorithm -
-		Digest
   -
-digest():ByteArray -
-
- Generates the digest for data that has been passed into this object -
-		Digest
   -
-hash(algorithm:String, data:ByteArray):ByteArray -
-
[static] - A utility function for creating the digest of some data in a single function call.
-		Digest
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-reset():void -
-
- Resets the object for re-use by removing all earlier data -
-		Digest
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
   -
-writeBoolean(value:Boolean):void -
-
- Writes a Boolean value.
-		Digest
   -
-writeByte(value:int):void -
-
- Writes a byte.
-		Digest
   -
-writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- Writes a sequence of bytes from the - specified byte array, bytes, - starting at the byte specified by offset - (using a zero-based index) - with a length specified by length, - into the data to be used for the digest.
-		Digest
   -
-writeDouble(value:Number):void -
-
- Writes an IEEE 754 double-precision (64-bit) floating point number.
-		Digest
   -
-writeFloat(value:Number):void -
-
- Writes an IEEE 754 single-precision (32-bit) floating point number.
-		Digest
   -
-writeInt(value:int):void -
-
- Writes a 32-bit signed integer.
-		Digest
   -
-writeMultiByte(value:String, charSet:String):void -
-
- Writes a multibyte string to the file stream, byte stream, or byte array, using the specified character set.
-		Digest
   -
-writeObject(object:*):void -
-
- Writes an object to the file stream, byte stream, or byte array, in AMF serialized - format.
-		Digest
   -
-writeShort(value:int):void -
-
- Writes a 16-bit integer.
-		Digest
   -
-writeUnsignedInt(value:uint):void -
-
- Writes a 32-bit unsigned integer.
-		Digest
   -
-writeUTF(value:String):void -
-
- Writes a UTF-8 string to the file stream, byte stream, or byte array.
-		Digest
   -
-writeUTFBytes(value:String):void -
-
- Writes a UTF-8 string.
-		Digest
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  MD5 : String = "MD5"
[static] - Definition for the MD5 algorithm -
-		Digest
  SHA1 : String = "SHA-1"
[static] - Definition for the SHA-1 algorithm -
-		Digest
  SHA256 : String = "SHA-256"
[static] - Definition for the SHA-256 algorithm -
-		Digest
  SHA512 : String = "SHA-512"
[static] - Definition for the SHA-512 algorithm -
-		Digest
-
- -
- -
Property detail
- - - - - -
endianproperty
-
-endian:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN - constant from the Endian class. -

Implementation -
-    public function get endian():String -
-    public function set endian(value:String):void -
-

-See also -

-
-Endian class -
-
- - - - - -
objectEncodingproperty 
-
-objectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Used to determine whether the AMF3 or AMF0 format is used when writing binary data using the - writeObject() method. The value is a constant from the ObjectEncoding class. -

Implementation -
-    public function get objectEncoding():uint -
-    public function set objectEncoding(value:uint):void -
-

-See also -

-
IDataInput.readObject()
-writeObject() -
-ObjectEncoding class -
-
- -
Constructor detail
- - - - - -
Digest()constructor
-
-public function Digest(algorithm:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Creates a Digest object using the requested algorithm -

Parameters - - - - -
algorithm:String — The message digest algorithm to use - SHA-1, SHA-256, SHA-512 or MD5 -
-
- -
Method detail
- - - - - -
digest()method
-
-public function digest():ByteArray -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Generates the digest for data that has been passed into this object -

-Returns - - - - -
ByteArray — - The digest value (as a ByteArray) - - - -
-
- - - - - -
hash()method 
-
-public static function hash(algorithm:String, data:ByteArray):ByteArray -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- A utility function for creating the digest of some data in a single function call. - -

Parameters - - - - - - - - - - -
algorithm:String — The message digest algorithm to use - SHA-1, SHA-256, SHA-512 or MD5 - -
 
data:ByteArray — A ByteArray object containing the data to perform the digest operation on. - -
-

-Returns - - - - -
ByteArray — - The digest value (as a ByteArray) - - - -
-
- - - - - -
reset()method 
-
-public function reset():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Resets the object for re-use by removing all earlier data -

- - - - - -
writeBoolean()method 
-
-public function writeBoolean(value:Boolean):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes a Boolean value. A single byte is written according to the value parameter, - either 1 if true or 0 if false. -

Parameters - - - - -
value:Boolean — A Boolean value determining which byte is written. If the parameter is true, - 1 is written; if false, 0 is written. -
-
- - - - - -
writeByte()method 
-
-public function writeByte(value:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes a byte. - The low 8 bits of the - parameter are used; the high 24 bits are ignored. -

Parameters - - - - -
value:int — A byte value as an integer. -
-
- - - - - -
writeBytes()method 
-
-public function writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes a sequence of bytes from the - specified byte array, bytes, - starting at the byte specified by offset - (using a zero-based index) - with a length specified by length, - into the data to be used for the digest. -

If the length parameter is omitted, the default - length of 0 is used and the entire buffer starting at - offset is written. - If the offset parameter is also omitted, the entire buffer is - written.

-

If the offset or length parameter - is out of range, they are clamped to the beginning and end - of the bytes array.

- Parameters - - - - - - - - - - - - - - - - -
bytes:ByteArray — The byte array to write. -
 
offset:uint (default = 0) — A zero-based index specifying the position into the array to begin writing. -
 
length:uint (default = 0) — An unsigned integer specifying how far into the buffer to write. -
-
- - - - - -
writeDouble()method 
-
-public function writeDouble(value:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes an IEEE 754 double-precision (64-bit) floating point number. -

Parameters - - - - -
value:Number — A double-precision (64-bit) floating point number. -
-
- - - - - -
writeFloat()method 
-
-public function writeFloat(value:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes an IEEE 754 single-precision (32-bit) floating point number. -

Parameters - - - - -
value:Number — A single-precision (32-bit) floating point number. -
-
- - - - - -
writeInt()method 
-
-public function writeInt(value:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes a 32-bit signed integer. -

Parameters - - - - -
value:int — A byte value as a signed integer. -
-
- - - - - -
writeMultiByte()method 
-
-public function writeMultiByte(value:String, charSet:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes a multibyte string to the file stream, byte stream, or byte array, using the specified character set. -

Parameters - - - - - - - - - - -
value:String — The string value to be written. -
 
charSet:String — The string denoting the character set to use. Possible character set strings - include "shift-jis", "cn-gb", "iso-8859-1", and others. - For a complete list, see Supported Character Sets. -
-
- - - - - -
writeObject()method 
-
-public function writeObject(object:*):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes an object to the file stream, byte stream, or byte array, in AMF serialized - format. -

Parameters - - - - -
object:* — The object to be serialized. -
-

-See also -

-
-objectEncoding -
-flash.net.registerClassAlias() -
-
- - - - - -
writeShort()method 
-
-public function writeShort(value:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes a 16-bit integer. The low 16 bits of the parameter are used; - the high 16 bits are ignored. -

Parameters - - - - -
value:int — A byte value as an integer. -
-
- - - - - -
writeUnsignedInt()method 
-
-public function writeUnsignedInt(value:uint):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes a 32-bit unsigned integer. -

Parameters - - - - -
value:uint — A byte value as an unsigned integer. -
-
- - - - - -
writeUTF()method 
-
-public function writeUTF(value:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes a UTF-8 string to the file stream, byte stream, or byte array. The length of the UTF-8 string in bytes - is written first, as a 16-bit integer, followed by the bytes representing the - characters of the string. -

Parameters - - - - -
value:String — The string value to be written. -
-
-Throws - - - - -
RangeError — If the length is larger than - 65535. -
-
- - - - - -
writeUTFBytes()method 
-
-public function writeUTFBytes(value:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50 -
-

- Writes a UTF-8 string. Similar to writeUTF(), - but does not prefix the string with a 16-bit length word. -

Parameters - - - - -
value:String — The string value to be written. -
-
- -
Constant detail
- - - - - -
MD5constant
-
-public static const MD5:String = "MD5"

- Definition for the MD5 algorithm -

- - - - - -
SHA1constant 
-
-public static const SHA1:String = "SHA-1"

- Definition for the SHA-1 algorithm -

- - - - - -
SHA256constant 
-
-public static const SHA256:String = "SHA-256"

- Definition for the SHA-256 algorithm -

- - - - - -
SHA512constant 
-
-public static const SHA512:String = "SHA-512"

- Definition for the SHA-512 algorithm -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/air/security/Encryption.html b/html-docs/air/security/Encryption.html deleted file mode 100644 index 4bbee31..0000000 --- a/html-docs/air/security/Encryption.html +++ /dev/null @@ -1,422 +0,0 @@ - - - - - - - - -air.security.Encryption (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.security
Classpublic class Encryption
InheritanceEncryption Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51 -
-

-

- The Encryption class is used to encrypt and decrypt ByteArray objects - using industry-standard AES-CBC algorithms. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-decrypt(data:ByteArray, key:ByteArray, iv:ByteArray):ByteArray -
-
[static] - A utility function for decrypting an arbitrary amount of data.
-		Encryption
   -
-encrypt(data:ByteArray, key:ByteArray, iv:ByteArray):ByteArray -
-
[static] - A utility function for encrypting an arbitrary amount of data.
-		Encryption
   -
-getRandomBytes(size:uint):ByteArray -
-
[static] - A utility function for generating random data.
-		Encryption
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Method detail
- - - - - -
decrypt()method
-
-public static function decrypt(data:ByteArray, key:ByteArray, iv:ByteArray):ByteArray -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51 -
-

- A utility function for decrypting an arbitrary amount of data. -

The decryption uses AES CBC encryption with a key that can be - 16, 24 or 32 bytes long (128, 192 or 256 bits). The IV must be - 16 bytes long and the data must be a multiple of 16 bytes.

- -

Note that to decrypt properly, the same key and IV should be used - as when the data was encrypted.

- - Parameters - - - - - - - - - - - - - - - - -
data:ByteArray — A ByteArray object containing the data to decrypt. - -
 
key:ByteArray — A ByteArray object containing the key that was used in the encryption. - -
 
iv:ByteArray — A ByteArray object containing the initialization vector to use. - -
-

-Returns - - - - -
ByteArray — - The decrypted data. - - - -
-
-Throws - - - - -
ArgumentError — If any of the parameters do not meet their required constraints. - -
-
- - - - - -
encrypt()method 
-
-public static function encrypt(data:ByteArray, key:ByteArray, iv:ByteArray):ByteArray -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51 -
-

- A utility function for encrypting an arbitrary amount of data. -

The encryption uses AES CBC encryption with a key that can be - 16, 24 or 32 bytes long (128, 192 or 256 bits). The IV must be - 16 bytes long and the data must be a multiple of 16 bytes.

- - Parameters - - - - - - - - - - - - - - - - -
data:ByteArray — A ByteArray object containing the data to encrypt. - -
 
key:ByteArray — A ByteArray object containing the key to use in the encryption. - -
 
iv:ByteArray — A ByteArray object containing the initialization vector to use. - -
-

-Returns - - - - -
ByteArray — - The encrypted data. - - - -
-
-Throws - - - - -
ArgumentError — If any of the parameters do not meet their required constraints. - -
-
- - - - - -
getRandomBytes()method 
-
-public static function getRandomBytes(size:uint):ByteArray -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51 -
-

- A utility function for generating random data. -

Parameters - - - - -
size:uint — Number of bytes to generate. - -
-

-Returns - - - - -
ByteArray — - A ByteArray object containing random data. - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/air/security/package-detail.html b/html-docs/air/security/package-detail.html deleted file mode 100644 index 7faef42..0000000 --- a/html-docs/air/security/package-detail.html +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - -air.security Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Classes
- - - - - - - - - - -
 ClassDescription
 Digest - The Digest class is used to generate a digest, or hash, of some data.
 Encryption - The Encryption class is used to encrypt and decrypt ByteArray objects - using industry-standard AES-CBC algorithms.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
-
- - - diff --git a/html-docs/air/system/License.html b/html-docs/air/system/License.html deleted file mode 100644 index f14e20d..0000000 --- a/html-docs/air/system/License.html +++ /dev/null @@ -1,921 +0,0 @@ - - - - - - - - -air.system.License (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.system
Classpublic class License
InheritanceLicense Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 51 - -
-

-

- - The License class is used to provide information about the AIR SDK license, - - for a running application. This may include details that will be used by the - - runtime to determine whether or not certain features will be supported. - -

Note that this initially just loads in the information from a local file. If there is no local - - file then it is assumed this is a 'free tier' license. - - For some properties, such as the number of seats available to this developer ID, it is - - necessary to check the details online via the HARMAN servers. For this, you would need to - - first call checkDetailsOnline, and wait for the complete event - - before then checking the values. Default zero/null values will be returned until the - - relevant information has been successfully retrieved.

- -

The goal is for an application running via ADL to be able to check the status of the local - - license, or for an installed application to be able to find out the relevant details. In order - - to prevent mis-use, if someone tried to take anyone else's developer ID and find out the details - - for this, this should not be possible due to the security checks that are implemented within - - this functionality.

- - - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  creationDate : Date -
[read-only] - - Date of creation of the license file (as embedded in the adt.lic file) - -
-		License
  developerID : String -
[read-only] - - Developer ID for this license - -
-		License
  expiryDate : Date -
[read-only] - - Expiry date of a license that was loaded from a file.
-		License
  isValid : Boolean -
[read-only] - - Validity of the license.
-		License
  level : String -
[read-only] - - Level of the license (enterprise/professional/basic/free) - -
-		License
  numberOfSeats : uint -
[read-only] - - Number of developer seats for this licensee (only available after the - - details have been checked online).
-		License
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-License()
-
- - Default constructor - do not call this directly, instead use one of the static methods - - such as load or loadFromFile.
-		License
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-checkDetailsOnline():Boolean -
-
- - Checks the license details online against the HARMAN licensing server.
-		License
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-load():License -
-
[static] - - Load data from the default location for this application or user.
-		License
   -
-loadFromFile(license:File):License -
-
[static] - - Load data from a specific adt.lic file rather than pick up the application license.
-		License
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-complete -
-		 - - Dispatched when the online license check has completed successfully.License
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-ioError -
-		 - - Dispatched when an input/output error occurs that causes the - - License.checkDetailsOneline() operation to fail.License
   -
-securityError -
-		 - - Dispatched if a call to License.checkDetailsOnline() - - attempts to load data from a server outside the security sandbox.License
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  BASIC : String = "basic"
[static] - - Definition for a Basic license level - -
-		License
  ENTERPRISE : String = "enterprise"
[static] - - Definition for an Enterprise license level - -
-		License
  FREE : String = "free"
[static] - - Definition for a Free Tier license level - -
-		License
  PROFESSIONAL : String = "professional"
[static] - - Definition for a Professional license level - -
-		License
-
- -
- -
Property detail
- - - - - -
creationDateproperty
-
-creationDate:Date  [read-only]

- - Date of creation of the license file (as embedded in the adt.lic file) - -

Implementation -
-    public function get creationDate():Date -
-
- - - - - -
developerIDproperty 
-
-developerID:String  [read-only]

- - Developer ID for this license - -

Implementation -
-    public function get developerID():String -
-
- - - - - -
expiryDateproperty 
-
-expiryDate:Date  [read-only]

- - Expiry date of a license that was loaded from a file. - -

Once the license has been checked online, this would give the developer's - - license expiry.

- - Implementation -
-    public function get expiryDate():Date -
-
- - - - - -
isValidproperty 
-
-isValid:Boolean  [read-only]

- - Validity of the license. If the license is not valid, there is no - - developer ID, and the license level is assumed to be 'free'. - -

Implementation -
-    public function get isValid():Boolean -
-
- - - - - -
levelproperty 
-
-level:String  [read-only]

- - Level of the license (enterprise/professional/basic/free) - -

Implementation -
-    public function get level():String -
-
- - - - - -
numberOfSeatsproperty 
-
-numberOfSeats:uint  [read-only]

- - Number of developer seats for this licensee (only available after the - - details have been checked online). - -

Implementation -
-    public function get numberOfSeats():uint -
-
- -
Constructor detail
- - - - - -
License()constructor
-
-public function License() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Default constructor - do not call this directly, instead use one of the static methods - - such as load or loadFromFile. - - - -

- -
Method detail
- - - - - -
checkDetailsOnline()method
-
-public function checkDetailsOnline():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Checks the license details online against the HARMAN licensing server. - -

When the license check is successfully completed, a complete event - - will be dispatched. Errors will be indicated by ioError or securityError.

- -

Note that there must be a valid license file in place before this function can be called: if this - - is called when there is no valid developerID property, the function will return false.

- - -

-Returns - - - - -
Boolean
-
- - - - - -
load()method 
-
-public static function load():License

- - Load data from the default location for this application or user. - -

If the app is running via ADL, this looks for the user's developer license file - - (adt.lic), normally in the user's home folder. If the app is a deployed application - - then the license will be read from the generated license.txt file that should be - - within the installation folder.

- -

-Returns - - - - -
License
-
- - - - - -
loadFromFile()method 
-
-public static function loadFromFile(license:File):License

- - Load data from a specific adt.lic file rather than pick up the application license. - -

Parameters - - - - -
license:File
-

-Returns - - - - -
License
-
-
Event detail
- - - - - -
completeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Dispatched when the online license check has completed successfully. - -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Dispatched when an input/output error occurs that causes the - - License.checkDetailsOneline() operation to fail. - -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Dispatched if a call to License.checkDetailsOnline() - - attempts to load data from a server outside the security sandbox. - -

- - The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- - - -
- -
Constant detail
- - - - - -
BASICconstant
-
-public static const BASIC:String = "basic"

- - Definition for a Basic license level - -

- - - - - -
ENTERPRISEconstant 
-
-public static const ENTERPRISE:String = "enterprise"

- - Definition for an Enterprise license level - -

- - - - - -
FREEconstant 
-
-public static const FREE:String = "free"

- - Definition for a Free Tier license level - -

- - - - - -
PROFESSIONALconstant 
-
-public static const PROFESSIONAL:String = "professional"

- - Definition for a Professional license level - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Mar 21 2024, 10:06 AM GMT
Creative Commons License
-
- - - diff --git a/html-docs/air/system/package-detail.html b/html-docs/air/system/package-detail.html deleted file mode 100644 index 1638af3..0000000 --- a/html-docs/air/system/package-detail.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - - - - -air.system Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Classes
- - - - - - - -
 ClassDescription
 License - The License class is used to provide information about the AIR SDK license, - for a running application.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
-
- - - diff --git a/html-docs/air/update/ApplicationUpdater.html b/html-docs/air/update/ApplicationUpdater.html deleted file mode 100644 index 0bdecf4..0000000 --- a/html-docs/air/update/ApplicationUpdater.html +++ /dev/null @@ -1,2930 +0,0 @@ - - - - - - - - -air.update.ApplicationUpdater (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.update
Classpublic class ApplicationUpdater
InheritanceApplicationUpdater Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

-

- - The ApplicationUpdater class defines the basic functionality of the update framework for - - Adobe® AIR® applications, without providing any default user interface. - - (The ApplicationUpdaterUI class includes update functionality and a default user interface.) - - - -

This class is included in the applicationupdater_ui.swc file, - - included in the Adobe AIR SDK. The applicationupdater_ui.swc file is in the - - frameworks/libs/air directory of the AIR SDK.

- - -

Adobe® Flex™ Builder™ loads this class automatically - - when you create a project for Adobe AIR. You should include the SWC file when compiling - - the application using the Adobe® Flex™ SDK.

- - - -

To use this class in JavaScript code, load the applicationupdater_ui.swf - - file. This file is provided in the frameworks/libs/air directory of the AIR SDK. The following - - code loads the SWF file:

- - - - 
<script src="applicationupdater.swf" type="application/x-shockwave-flash">
- - - -

Managing updates of applications can be complicated. The AIR update framework provides - - APIs to assist developers in providing good update capabilities - - in AIR applications. The functionality in the AIR update framework - - assists developers in the following:

- - - -
  • - -

    Periodically checking for updates based on an interval - - or at the request of the user

    - -
    • - -
  • - -

    Downloading AIR files (updates) from a web source

    - -
    • - -
  • - -

    Alerting the user on the first run of the newly installed - - version

    - -
    • - -
  • - -

    Confirming that the user wants to check for updates

    - -
    • - -
  • - -

    Displaying information on the new update version to the user

    - -
    • - -
  • - -

    Displaying download progress and error information to the - - user

    - -
- - - -

The AIR update framework lets you store information about the - - update version of an AIR application in simple XML configuration - - files. For most applications, setting up these configuration files - - and including some basic code provides good update functionality - - to the end user.

- - - -

Use the AIRUpdater class if you want to define your own user interface - - for use with the AIR update framework.

- - -

The update process includes a sequence of states. The currentState - - property of the updater object reflects the current state of the updater:

- - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - currentState value - - - - Description - -
"UNINITIALIZED"The updater has not been initialized.
"INITIALIZING"The updater is initializing.
"READY"The updater has been initialized
"BEFORE_CHECKING"The updater has not yet checked for the update descriptor file.
"CHECKING"The updater is checking for an update descriptor file.
"AVAILABLE"The update descriptor file is available.
"DOWNLOADING"The updater is downloading the AIR file.
"DOWNLOADED"The updater has downloaded the AIR file.
"INSTALLING"The updater is installing the AIR file.
"PENDING_INSTALLING"The updater has initialized and there are pending updates.

- - - -

When testing an application using the AIR Debug Launcher (ADL) application, attempting to update the application - - results in an IllegalOperationError exception.

- - -

The AIR update framework is only supported in the desktop profile. It is not supported - - for extended desktop applications (applications installed with a native installer), - - and it is not supported on the mobile profile (iPhone applications written with - - ActionScript 3.0). Check the Updater.isSupported property at runtime - - to see if the update framework is supported.

- - -

For details on using the AIR update framework, see the "Updating AIR Applications" - - chapter of Building Adobe AIR Applications.

- - - -

-

-See also -

-
-ApplicationUpdaterUI -
-flash.desktop.Updater -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  configurationFile : File -
- - The location of the configuration file that sets the values for delay and - - updateURL properties.
-		ApplicationUpdater
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentState : String -
[read-only] - - The internal state of the updater.
-		ApplicationUpdater
  currentVersion : String -
[read-only] - - The current version of the application.
-		ApplicationUpdater
  delay : Number -
- - The interval, in days, between periodic checks of new updates.
-		ApplicationUpdater
  isFirstRun : Boolean -
[read-only] - - Whether this is the first run after a successful update (true) or not - - (false).
-		ApplicationUpdater
  isNewerVersionFunction : Function -
- - A function that the updater should use to perform version comparisons.
-		ApplicationUpdater
  previousApplicationStorageDirectory : File -
[read-only] - - The previous location of the application storage directory, if it changed - - after an update.
-		ApplicationUpdater
  previousVersion : String -
[read-only] - - The previous version of the application.
-		ApplicationUpdater
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  updateDescriptor : XML -
[read-only] - - The content of the update descriptor file downloaded from the update URL.
-		ApplicationUpdater
  updateURL : String -
- - The location of the update descriptor file.
-		ApplicationUpdater
  wasPendingUpdate : Boolean -
[read-only] - - Whether there was a postponed update, even if it failed - - to install (true); false otherwise.
-		ApplicationUpdater
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ApplicationUpdater()
-
- - The constructor function.
-		ApplicationUpdater
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-cancelUpdate():void -
-
- - Cancels the update process.
-		ApplicationUpdater
   -
-checkForUpdate():void -
-
- - Asynchronously downloads and interprets - - the update descriptor file.
-		ApplicationUpdater
   -
-checkNow():void -
-
- - Starts the update process.
-		ApplicationUpdater
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-downloadUpdate():void -
-
- - Asynchronously downloads the update file.
-		ApplicationUpdater
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-initialize():void -
-
- - Initializes the updater.
-		ApplicationUpdater
   -
-installFromAIRFile(file:File):void -
-
- - Starts the update process using a local AIR file.
-		ApplicationUpdater
   -
-installUpdate():void -
-
- - Installs the update file.
-		ApplicationUpdater
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-beforeInstall -
-		 - - Dispatched just before installing the update, after the installUpdate() method - - was called.ApplicationUpdater
   -
-checkForUpdate -
-		 - - Dispatched before the update process begins, just before the - - updater tries to download the update descriptor file.ApplicationUpdater
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-downloadComplete -
-		 - - Dispatched when the download of the update file is complete.ApplicationUpdater
   -
-downloadError -
-		 - - Dispatched if there is an error while connecting or downloading - - the update file.ApplicationUpdater
   -
-downloadStart -
-		 - - Dispatched after a call to the downloadUpdate() method - - and the connection to the server is established.ApplicationUpdater
   -
-error -
-		 - - Dispatched when an error occurred either during initialization - - or during the update process (if something unexpected happens).ApplicationUpdater
   -
-fileUpdateError -
-		 - - Dispatched when an error occurs validating the file passed - - as the airFile parameter in a call to the installFromAIRFile() method.ApplicationUpdater
   -
-fileUpdateStatus -
-		 - - Dispatched after the updater successfully validates the - - file in the call to the installFromAIRFile() method.ApplicationUpdater
   -
-initialized -
-		 - - Dispatched after the initialization is complete.ApplicationUpdater
   -
-progress -
-		 - - Dispatched as the update file is downloaded.ApplicationUpdater
   -
-updateError -
-		 - - Dispatched if an error occurs while trying to download or parse the update descriptor file.ApplicationUpdater
   -
-updateStatus -
-		 - - Dispatched after the updater successfully downloads and - - interprets the update descriptor file.ApplicationUpdater
-
- -
- -
Property detail
- - - - - -
configurationFileproperty
-
-configurationFile:File  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The location of the configuration file that sets the values for delay and - - updateURL properties. If this property points to a non-existent file, calling - - the initialize() method results in an Error being thrown. - - -

Here is a sample configuration file:

- - - 
 <?xml version="1.0" encoding="utf-8"?> 
-
- 		<configuration xmlns="http://ns.adobe.com/air/framework/update/configuration/1.0" >
-
- 		  <url>app:/server/update.xml</url>
-
- 		  <delay>1</delay>
-
-		</configuration>
- - -

Instead of loading a configuration file, you can use ActionScript - - JavaScript code to set the delay and updateURL - - properties.

- - - Implementation -
-    public function get configurationFile():File -
-    public function set configurationFile(value:File):void -
-

-See also -

-
-delay -
-updateURL -
-
- - - - - -
currentStateproperty 
-
-currentState:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The internal state of the updater. The property can be set to the following values: - - - -

  • - -

    "UNINITIALIZED"—The updater has not been initialized.

    - -
  • - -

    "INITIALIZING"—The updater is initializing.

    - -
  • - -

    "READY"—The updater has been initialized

    - -
  • - -

    "BEFORE_CHECKING"—The updater has not yet - - checked for the update descriptor file.

    - -
  • - -

    "CHECKING"—The updater is checking for an - - update descriptor file.

    - -
  • - -

    "AVAILABLE"—The update descriptor file is - - available.

    - -
  • - -

    "DOWNLOADING"—The updater is downloading - - the AIR file.

    - -
  • - -

    "DOWNLOADED"—The updater has downloaded - - the AIR file.

    - -
  • - -

    "INSTALLING"—The updater is installing the - - AIR file.

    - -
  • - -

    "PENDING_INSTALLING"—The updater has initialized - - and there are pending updates.

    - -

- - - Implementation -
-    public function get currentState():String -
-
- - - - - -
currentVersionproperty 
-
-currentVersion:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The current version of the application. This property is set during - - a call to the initialize() method. It is set to - - the version from the application descriptor file. - - -

Implementation -
-    public function get currentVersion():String -
-
- - - - - -
delayproperty 
-
-delay:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The interval, in days, between periodic checks of new updates. - - - -

A value of 0 (the default value) indicates - - that the timer is not active, so no periodic check is done. This - - can be set either via this property or via the configuration file. - - When the value is set using both methods, the value set using the - - property is used.

- - -

The default value is 0.

-Implementation -
-    public function get delay():Number -
-    public function set delay(value:Number):void -
-
- - - - - -
isFirstRunproperty 
-
-isFirstRun:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Whether this is the first run after a successful update (true) or not - - (false). The updater sets this value during the call to the initialize() - - method. The developer should check that isFirstRun is set to true if - - there is a need to migrate data from one version to another. - - -

Implementation -
-    public function get isFirstRun():Boolean -
-

-See also -

-
-wasPendingUpdate -
-
- - - - - -
isNewerVersionFunctionproperty 
-
-isNewerVersionFunction:Function  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - A function that the updater should use to perform version comparisons. - - By default, the update framework does a - - version comparison to detect whether the version from the - - remote site is newer than the version of the installed application. - - However, sometimes the default comparison does not match the developer's - - versioning scheme. Set this property to provide a new function that - - does the comparison. - - -

The default comparision function accepts - - versions like x.y.z, where x, y, and z can contain letters - - and digits. There are some special conditions that the default comparision function - - recognizes. If the test function finds "alpha", "beta", - - or "rc" in the version strings, - - the order is alpha < beta < rc.

- - - - Implementation -
-    public function get isNewerVersionFunction():Function -
-    public function set isNewerVersionFunction(value:Function):void -
-
-Example -
The following code defines a custom function, customFn, for the appUpdate updater object. - The example function is intentionally simple. Your custom function should return a Boolean value based on the rules of your - versioning scheme. -
-
-appUpdate.isNewerVersionFunction = customFn; 
-
-function customFn (currentVersion:String, updateVersion:String):Boolean 
-{
-    return updateVersion > currentVersion;
-}
-
-

-
- - - - - -
previousApplicationStorageDirectoryproperty 
-
-previousApplicationStorageDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The previous location of the application storage directory, if it changed - - after an update. The application storage directory location changes after - - an upgrade with a certificate migration. If there is no certificate - - migration, the application storage directory does not change when the - - user updates the application. and this property is set to null. - - This property is set during a call to the initialize() method. - - -

A developer can sign new version of AIR application with a new certificate - - if the developer uses the -migrate option when packaging the AIR - - file with ADT. If a new version of an AIR application uses a new signing certificate, - - the local storage directory of the application changes when the user installs - - the new version. Use this property to transfer data from the old application - - storage directory to the new application storage directory - - (File.applicationStorageDirectory). For more information, - - see "Signing an AIR file to change the application certificate" in the - - "Creating an AIR application using the command line tools" chapter of the - - Adobe AIR developer's guide.

- - - Implementation -
-    public function get previousApplicationStorageDirectory():File -
-
- - - - - -
previousVersionproperty 
-
-previousVersion:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The previous version of the application. This property is set during - - a call to the initialize() method. Returns the previous version of - - the application before the upgrade (set only if isfirstRun is true); - - otherwise it is set to null. - - -

Implementation -
-    public function get previousVersion():String -
-
- - - - - -
updateDescriptorproperty 
-
-updateDescriptor:XML  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The content of the update descriptor file downloaded from the update URL. This property is - - non-null only the updater object dispatches an updateStatus event. - - -

Implementation -
-    public function get updateDescriptor():XML -
-
- - - - - -
updateURLproperty 
-
-updateURL:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The location of the update descriptor file. Any location - - valid for a URLRequest path is accepted. This is the only mandatory - - setting required by the updater. You can set the update URL either via this - - property or via the configuration file. When the value is set using - - both methods, the updater uses the value set using this property. - - -

Implementation -
-    public function get updateURL():String -
-    public function set updateURL(value:String):void -
-
- - - - - -
wasPendingUpdateproperty 
-
-wasPendingUpdate:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Whether there was a postponed update, even if it failed - - to install (true); false otherwise. - - The updater sets this property during a call to the initialize() method. - - Use the wasPendingUpdate and isFirstRun properties - - to check if an update failed to install (in which case wasPendingUpdate - - is set to true and isFirstRun is set to false). - - -

Implementation -
-    public function get wasPendingUpdate():Boolean -
-

-See also -

-
-isFirstRun -
-
- -
Constructor detail
- - - - - -
ApplicationUpdater()constructor
-
-public function ApplicationUpdater() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The constructor function. - - -

- -
Method detail
- - - - - -
cancelUpdate()method
-
-public function cancelUpdate():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Cancels the update process. Calling this method cancels any - - pending downloads, deleting any incomplete downloaded files, and - - restarts the periodic check timer. - - - -

The update process can be canceled at any time except when the state - - machine is in "UNINITIALIZED" or "INITIALIZING" state. It does nothing - - when it is called in one of the "UNINITIALIZED" or "INITIALIZING" - - states.

- - -
- - - - - -
checkForUpdate()method 
-
-public function checkForUpdate():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Asynchronously downloads and interprets - - the update descriptor file. Calling this method advances the updater - - state to "CHECKING". Call this method only if the checkForUpdate event - - was cancelled. - - - -

This method only executes when the updater is in the "BEFORE_CHECKING" - - state.

- - - -
-Events - - - - - - - - - - -
updateStatus — The updater has successfully downloaded and interpreted the update descriptor file.
 
updateError — An error occured while trying to download or parse the update descriptor file.
-
- - - - - -
checkNow()method 
-
-public function checkNow():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Starts the update process. Calling - - this method does not stop the periodic timer; however, the method detects - - that an update process is running and will skip the current iteration. - - - -

This method only executes if the current state is "READY".

- - - -

This method can result in the updater object dispatching the following event:

- - - -
-Events - - - - -
checkForUpdate — Dispatched just before the update process begins.
-
- - - - - -
downloadUpdate()method 
-
-public function downloadUpdate():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Asynchronously downloads the update file. Calling this method - - advances the state machine to "DOWNLOADING". This method needs to be called - - only if the StatusUpdateEvent.UPDATE_STATUS event was cancelled when - - the available property of the event was true. - - -

This method only executes if the current state is "AVAILABLE".

- - -
-Events - - - - - - - - - - - - - - - - -
downloadStart — Dispatched after the connection to the server is established.
 
progress:ProgressEvent — Dispatched after the initialization is complete.
 
downloadError — Dispatched if there is an error while connecting or downloading the update file. - - It is also dispatched for invalid HTTP statuses (such as 404 - File not found).
-
- - - - - -
initialize()method 
-
-public function initialize():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Initializes the updater. Calling this method - - does the following: - - - -

  1. - -

    It initializes the update framework, - - silently (and synchronously) installing any pending updates. You - - should call this method during application startup, since it may - - restart the application.

    - -
  2. - - - -

    It checks if there is a postponed update and installs it.

    - -
  3. - -

    If something went wrong with a prior update, it clears the - - update file and version information from the storage area.

    - -
  4. - -

    If the periodic timer delay has expired, it starts the update process; otherwise - - it starts the periodic timer. However, when testing an application using - - the AIR Debug Launcher (ADL) application, attempting to update the - - application results in a IllegalOperationError exception.

    - -
    5. - -

- - - -
-Events - - - - - - - - - - -
initialized — The initialization is complete.
 
error:ErrorEvent — There is an error during initialization.
-
- - - - - -
installFromAIRFile()method 
-
-public function installFromAIRFile(file:File):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Starts the update process using a local AIR file. - - - -

Calling this - - method has no effect if an update process is running (if the state - - is not "DOWNLOADED").

- - - -

This function is useful - - for an application that has the customUpdateUI element - - set to true in the application descriptor file.

- - - -

When testing an application using the AIR Debug Launcher (ADL) application, - - calling this method results in an IllegalOperationError exception.

- - - - Parameters - - - - -
file:File — The local AIR file to install. - - - -
-
-Events - - - - - - - - - - -
fileUpdateStatus — Dispatched after the updater successfully - - validates the AIR file.
 
updateError — Dispatched if an error occurs while trying - - parse the update descriptor file.
-
- - - - - -
installUpdate()method 
-
-public function installUpdate():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Installs the update file. Calling the method - - advances the state machine to "INSTALLING" and needs to be called - - only if the downLoadComplete event was cancelled. - - - -

Call this method when the updater is in the "DOWNLOADED" state. Calling - - it in any other state will do nothing.

- - - -

When testing an application using the AIR Debug Launcher (ADL) application, - - calling this method results in an IllegalOperationError exception.

- - - -
-Events - - - - -
beforeInstall — Dispatched just before installing the update. Sometimes it is useful - - to prevent the installation of the update at this time, because the user could lose all current work when - - the runtime exits the application to install the update.
-
-
Event detail
- - - - - -
beforeInstallevent 
-
-Event object type: air.update.events.UpdateEvent -
-UpdateEvent.type property = air.update.events.UpdateEvent.BEFORE_INSTALL -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched just before installing the update, after the installUpdate() method - - was called. Sometimes, it is useful to prevent the installation - - of the update at this time, because the user could lose all current work when - - the runtime exits the application to install the update. - - - -

Calling this event's preventDefault() method - - postpones the installation until the next restart. If you call - - the preventDefault() method, no additional update - - process can be started during this application session (via a call - - to the installUpdate() method or because of the periodic check).

- - - -

The default behavior for ApplicationUpdater library is to download - - the update descriptor file. You can call the preventDefault() method - - to cancel this behavior.

- - -

- - The UpdateEvent.BEFORE_INSTALL constant defines the value of the - - type property of the event object for a beforeInstall event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
checkForUpdateevent  
-
-Event object type: air.update.events.UpdateEvent -
-UpdateEvent.type property = air.update.events.UpdateEvent.CHECK_FOR_UPDATE -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched before the update process begins, just before the - - updater tries to download the update descriptor file. - - The updater can dispatch this event as a result of directly - - calling the checkNow() method or because the periodic - - check timer expired. - - -

- - The UpdateEvent.CHECK_FOR_UPDATE constant defines the value of the - - type property of the event object for a checkForUpdate event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
downloadCompleteevent  
-
-Event object type: air.update.events.UpdateEvent -
-UpdateEvent.type property = air.update.events.UpdateEvent.DOWNLOAD_COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched when the download of the update file is complete. - - -

Usually this event is used to display a message asking if - - the user wants to proceed with the installation of the update.

- - - -

The default behavior for the the ApplicationUpdater library is - - to automatically call the installUpdate() method.

- - -

- - The UpdateEvent.DOWNLOAD_COMPLETE constant defines the value of the - - type property of the event object for a downloadComplete event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
downloadErrorevent  
-
-Event object type: air.update.events.DownloadErrorEvent -
-DownloadErrorEvent.type property = air.update.events.DownloadErrorEvent.DOWNLOAD_ERROR -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched if there is an error while connecting or downloading - - the update file. It is also dispatched for invalid HTTP statuses - - (such as 404 - File not found). - - - -

When this event is dispatched the periodic timer is automatically - - restarted (if the delay is greater than 0).

- - - -

- - The DownloadErrorEvent.DOWNLOAD_ERROR constant defines the value of the - - type property of the event object for a downloadError event. - - -

The errorID property of a DownloadErrorEvent object is - - an integer defining error information (see the following - - table). An additional subErrorID property may contain - - more error information.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
errorID Error codeDescription
16800Occurs during validating the downloaded - - update file. The subErrorID property may contain additional - - information.
16801Invalid Adobe AIR file (missing application.xml).
16802Invalid Adobe AIR file (missing MIME type).
16803Invalid Adobe AIR file (format).
16804Invalid Adobe AIR file (invalid flags).
16805Invalid Adobe AIR file (unknown compression).
16806Invalid Adobe AIR file (invalid filename).
16807Invalid Adobe AIR file (corrupt).
16808Configuration file does not exist.
16809The updateURL property - - is not set.
16810Reserved.
16811Invalid configuration file (unknown configuration - - version).
16812Invalid configuration file (URL missing).
16813Invalid configuration file (delay format).
16814Invalid configuration file (invalid defaultUI - - values).
16815Invalid update descriptor (unknown descriptor - - version).
16816Invalid update descriptor (missing update - - version).
16817Invalid update descriptor (invalid description).
16818IO error while saving data to disk. The subErrorID property - - may provide more information.
16819Security error while downloading. The subErrorID property - - may provide more information.
16820Invalid HTTP status code. The subErrorID property - - may contain the invalid status code.
16821Reserved.
16822I/O error while downloading. The subErrorID property - - may provide more information.
16823End-of-file error while saving data to disk. - - The subErrorID property may provide more information.
16824Invalid update descriptor. The subErrorID property may - - provide more information.
16825The update file contains an application - - with a different application ID.
16826The update file does not contain a newer - - version of the application.
16827The version contained in the update file - - does not match the version from the update descriptor.
16828Cannot update application, usually because - - the application is running in the AIR Debug Launcher (ADL).
16829Missing update file at install time.
- - -
- - - - - -
downloadStartevent  
-
-Event object type: air.update.events.UpdateEvent -
-UpdateEvent.type property = air.update.events.UpdateEvent.DOWNLOAD_START -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched after a call to the downloadUpdate() method - - and the connection to the server is established. When using ApplicationUpdater - - library, you may want the event handler for this event to display - - a progress bar to report the download progress to the user. - - -

- - The UpdateEvent.DOWNLOAD_START constant defines the value of the - - type property of the event object for a downloadStart event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
errorevent  
-
-Event object type: flash.events.ErrorEvent -
-ErrorEvent.type property = flash.events.ErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched when an error occurred either during initialization - - or during the update process (if something unexpected happens). - - -

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -
- - - - - -
fileUpdateErrorevent  
-
-Event object type: air.update.events.StatusFileUpdateErrorEvent -
-StatusFileUpdateErrorEvent.type property = air.update.events.StatusFileUpdateErrorEvent.FILE_UPDATE_ERROR -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched when an error occurs validating the file passed - - as the airFile parameter in a call to the installFromAIRFile() method. - - -

- - The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the - - type property of the event object for a statusUpdateError event. - - -

- - - - - -
fileUpdateStatusevent  
-
-Event object type: air.update.events.StatusFileUpdateEvent -
-StatusFileUpdateEvent.type property = air.update.events.StatusFileUpdateEvent.FILE_UPDATE_STATUS -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched after the updater successfully validates the - - file in the call to the installFromAIRFile() method. - - - -

- - The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the - - type property of the event object for a updateStatus event. - - -

This event has the following properties:

- - -

- - - - - - - - - - - - - - -
PropertyValue
availableIndicates if if there is a different version - - available than one of the current application (true); false otherwise (same version).
pathThe nativePath property of - - the update File object specified by the airFile parameter - - in a call to the installFromAIRFile() method.
versionIndicates the version of the new update.

- - -
- - - - - -
initializedevent  
-
-Event object type: air.update.events.UpdateEvent -
-UpdateEvent.type property = air.update.events.UpdateEvent.INITIALIZED -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched after the initialization is complete. - - -

- - The UpdateEvent.INITIALIZED constant defines the value of the - - type property of the event object for a initialized event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched as the update file is downloaded. - - -

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -
- - - - - -
updateErrorevent  
-
-Event object type: air.update.events.StatusUpdateErrorEvent -
-StatusUpdateErrorEvent.type property = air.update.events.StatusUpdateErrorEvent.UPDATE_ERROR -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched if an error occurs while trying to download or parse the update descriptor file. - - -

When the updater dispatches this event, the periodic timer - - is automatically restarted (if the delay setting is greater than - - 0). The application should consider hiding any error dialog boxes - - when the updater dispatches a new checkForUpdate event.

- - -

- - The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the - - type property of the event object for a statusUpdateError event. - - -

- - - - - -
updateStatusevent  
-
-Event object type: air.update.events.StatusUpdateEvent -
-StatusUpdateEvent.type property = air.update.events.StatusUpdateEvent.UPDATE_STATUS -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched after the updater successfully downloads and - - interprets the update descriptor file. - - - -

The default behavior is to start downloading the update if the - - available of the available property of the StatusUpdateEvent object - - is set to true. The default behavior can be prevented - - only when using the ApplicationUpdater class, not when using the - - ApplicationUpdatorUI class..

- - - -

- - The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the - - type property of the event object for a updateStatus event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
availableSet to true if - - the update descriptor file specifies a version that is different - - than that of the current application; false otherwise - - (the version is the same).
versionThe string representing the new available version.
detailsAn array defining the details string - - for each of the supported languages. If there is no localized description, - - this is defined as an array in which the first element is an empty - - string ("") and the second element is the details - - string. When there are localized descriptions, each element in the - - array is an array itself with two elements. The first element is - - the locale code, and the second is the description. For example, - - the following array has sub-arrays for two languages (U.S. English - - and French): ["en-US", "Hello World"], ["fr", "Bonjour monde"]. - - The languages are listed in the same order as in the update descriptor. The - - text for the details property is specified in the update descriptor file.
versionLabel(AIR 2.5+) The version label from the application descriptor of - - the update. The version label should be displayed to users instead of - - version. If no version label is specified, this property is an empty string.
- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/air/update/ApplicationUpdaterUI.html b/html-docs/air/update/ApplicationUpdaterUI.html deleted file mode 100644 index 501415c..0000000 --- a/html-docs/air/update/ApplicationUpdaterUI.html +++ /dev/null @@ -1,3604 +0,0 @@ - - - - - - - - -air.update.ApplicationUpdaterUI (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.update
Classpublic class ApplicationUpdaterUI
InheritanceApplicationUpdaterUI Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

-

- - The ApplicationUpdaterUI class defines the basic functionality of the update framework for - - Adobe® AIR® applications, and it provides a default user interface. - - (The ApplicationUpdater class defines update functionality without implementing - - a default user interface.) - - -

This class is included in the applicationupdater_ui.swc file, - - included in the Adobe AIR SDK. The applicationupdater_ui.swc file is in the - - frameworks/libs/air directory of the AIR SDK. The version in the frameworks/libs/air - - directory in the AIR 2 SDK is for Flex 4 development. If you use Flex 3, use the version - - in the frameworks/libs/air/flex3 subdirectory.

- - -

Adobe® Flex™ Builder™ loads this class automatically - - when you create a project for Adobe AIR. You should include the SWC file when compiling - - the application using the Adobe® Flex™ SDK.

- - - -

To use this class in JavaScript code, load the applicationupdater_ui.swf - - file. This file is provided in the frameworks/libs/air directory of the AIR SDK. The following - - code loads the SWF file:

- - - - 
<script src="applicationupdater_ui.swf" type="application/x-shockwave-flash">
- - - -

Managing updates of applications can be complicated. The AIR update framework provides - - APIs to assist developers in providing good update capabilities - - in AIR applications. The functionality in the AIR update framework - - assists developers in the following:

- - - -
  • - -

    Periodically checking for updates based on an interval - - or at the request of the user

    - -
    • - -
  • - -

    Downloading AIR files (updates) from a web source

    - -
    • - -
  • - -

    Alerting the user on the first run of the newly installed - - version

    - -
    • - -
  • - -

    Confirming that the user wants to check for updates

    - -
    • - -
  • - -

    Displaying information on the new update version to the user

    - -
    • - -
  • - -

    Displaying download progress and error information to the - - user

    - -
- - - -

The AIR update framework lets you store information about the - - update version of an AIR application in simple XML configuration - - files. For most applications, setting up these configuration files - - and including some basic code provides good update functionality - - to the end user.

- - - -

The AIRUpdateUI class implements a default user interface that - - your application can use. It provides the user with basic information - - and options related to application updates.

- - - -

The update process goes through a sequence of states:

- - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - State - - - - Description - -
UninitializedThe updater has not been initialized.
InitializingThe updater is initializing.
ReadyThe updater has been initialized
Before checkingThe updater has not yet checked for the update descriptor file.
CheckingThe updater is checking for an update descriptor file.
AvailableThe update descriptor file is available.
DownloadingThe updater is downloading the AIR file.
DownloadedThe updater has downloaded the AIR file.
InstallingThe updater is installing the AIR file.
Pending installThe updater has initialized and there are pending updates.

- - -

When testing an application using the AIR Debug Launcher (ADL) application, attempting to update the application - - results in an IllegalOperationError exception.

- - -

The AIR update framework is only supported in the desktop profile. It is not supported - - for extended desktop applications (applications installed with a native installer), - - and it is not supported on the mobile profile (iPhone applications written with - - ActionScript 3.0). Check the Updater.isSupported property at runtime - - to see if the update framework is supported.

- - -

For details on using the AIR update framework, see the "Updating AIR Applications" - - chapter of Building Adobe AIR Applications.

- - - - - -

-

-See also -

-
-ApplicationUpdater -
-flash.desktop.Updater -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  configurationFile : File -
- - The location of the configuration file that sets the values for delay and - - updateURL properties.
-		ApplicationUpdaterUI
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentVersion : String -
[read-only] - - The current version of the application.
-		ApplicationUpdaterUI
  delay : Number -
- - The interval, in days, between periodic checks of new updates.
-		ApplicationUpdaterUI
  isCheckForUpdateVisible : Boolean -
- - Enables the visibility of the Check for - - Update, No Update, and Update Error dialog boxes.
-		ApplicationUpdaterUI
  isDownloadProgressVisible : Boolean -
- - - Enables the visibility of the Download Update - - dialog box.
-		ApplicationUpdaterUI
  isDownloadUpdateVisible : Boolean -
- - Enables the visibility of the Download Update - - dialog box.
-		ApplicationUpdaterUI
  isFileUpdateVisible : Boolean -
- - - Enables the visibility of the File Update, - - File No Update, and File Error dialog boxes.
-		ApplicationUpdaterUI
  isFirstRun : Boolean -
[read-only] - - Whether this is the first run after a successful update (true) or not - - (false).
-		ApplicationUpdaterUI
  isInstallUpdateVisible : Boolean -
- - Enables the visibility of the Install Update - - dialog box.
-		ApplicationUpdaterUI
  isNewerVersionFunction : Function -
- - A function that the updater should use to perform version comparisons.
-		ApplicationUpdaterUI
  isUnexpectedErrorVisible : Boolean -
- - Enables the visibility of the Unexpected - - Error dialog box.
-		ApplicationUpdaterUI
  isUpdateInProgress : Boolean -
[read-only] - - A Boolean property, which is true if - - an update is running, false otherwise.
-		ApplicationUpdaterUI
  localeChain : Array -
- - An array defining the locale chain used - - by the user interface.
-		ApplicationUpdaterUI
  previousApplicationStorageDirectory : File -
[read-only] - - The previous location of the application storage directory, if it changed - - after an update.
-		ApplicationUpdaterUI
  previousVersion : String -
[read-only] - - The previous version of the application.
-		ApplicationUpdaterUI
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  updateDescriptor : XML -
[read-only] - - The content of the update descriptor file downloaded from the update URL.
-		ApplicationUpdaterUI
  updateURL : String -
- - The location of the update descriptor file.
-		ApplicationUpdaterUI
  wasPendingUpdate : Boolean -
[read-only] - - Whether there was a postponed update, even if it failed - - to install (true); false otherwise.
-		ApplicationUpdaterUI
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ApplicationUpdaterUI()
-
- - The constructor function.
-		ApplicationUpdaterUI
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-addResources(lang:String, res:Object):void -
-
- - Dynamically adds a new resource bundle for the specified language.
-		ApplicationUpdaterUI
   -
-cancelUpdate():void -
-
- - Cancels the update process.
-		ApplicationUpdaterUI
   -
-checkNow():void -
-
- - Starts the update process.
-		ApplicationUpdaterUI
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-initialize():void -
-
- - Initializes the updater.
-		ApplicationUpdaterUI
   -
-installFromAIRFile(file:File):void -
-
- - Starts the update process using a local AIR file.
-		ApplicationUpdaterUI
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-beforeInstall -
-		 - - Dispatched just before installing the update, after the installUpdate() method - - was called.ApplicationUpdaterUI
   -
-checkForUpdate -
-		 - - Dispatched before the update process begins, just before the - - updater tries to download the update descriptor file.ApplicationUpdaterUI
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-downloadComplete -
-		 - - - - Dispatched when the download of the update file is complete.ApplicationUpdaterUI
   -
-downloadError -
-		 - - Dispatched if there is an error while connecting or downloading - - the update file.ApplicationUpdaterUI
   -
-downloadStart -
-		 - - - - Dispatched after a call to the downloadUpdate() method - - and the connection to the server is established.ApplicationUpdaterUI
   -
-error -
-		 - - Dispatched when an error occurred either during initialization - - or during the update process (if something unexpected happens).ApplicationUpdaterUI
   -
-fileUpdateError -
-		 - - Dispatched when an error occurs validating the file passed - - as the airFile parameter in a call to the installFromAIRFile() method.ApplicationUpdaterUI
   -
-fileUpdateStatus -
-		 - - - - Dispatched after the updater successfully validates the - - file in the call to the installFromAIRFile() method.ApplicationUpdaterUI
   -
-initialized -
-		 - - - - Dispatched after the initialization is complete.ApplicationUpdaterUI
   -
-progress -
-		 - - Dispatched as the update file is downloaded.ApplicationUpdaterUI
   -
-updateError -
-		 - - - - Dispatched if an error occurs while trying to download or parse the update descriptor file.ApplicationUpdaterUI
   -
-updateStatus -
-		 - - - - Dispatched after the updater successfully downloads and - - interprets the update descriptor file.ApplicationUpdaterUI
-
- -
- -
Property detail
- - - - - -
configurationFileproperty
-
-configurationFile:File  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The location of the configuration file that sets the values for delay and - - updateURL properties. It also has settings for determining whether the application - - displays various confirmation dialog boxes during the update process. - - If this property points to a non-existent file, calling the initialize() method - - results in an Error being thrown. - - -

Here is a sample configuration file:

- - - 
 <?xml version="1.0" encoding="utf-8"?> 
-
- 		<configuration xmlns="http://ns.adobe.com/air/framework/update/configuration/1.0" >
-
- 		  <url>app:/server/update.xml</url>
-
- 		  <delay>1</delay>
-
-		   <defaultUI>
-
-		      <dialog name="checkForUpdate" visible="true" />
-
-		       <dialog name="downloadUpdate" visible="false" />
-
-		       <dialog name="downloadProgress" visible="true" />
-
-		       <dialog name="installUpdate" visible="true" />    
-
-		   </defaultUI>
-
-		</configuration>
- - -

Instead of loading a configuration file, you can use ActionScript - - JavaScript code to set the following properties of the ApplicationUpdaterUI - - object: delay, isCheckForUpdateVisible, isDownloadProgressVisible, - - isDownloadUpdateVisible, isFileUpdateVisible, isInstallUpdateVisible, - - and updateURL properties.

- - - Implementation -
-    public function get configurationFile():File -
-    public function set configurationFile(value:File):void -
-

-See also -

-
-delay -
-updateURL -
-
- - - - - -
currentVersionproperty 
-
-currentVersion:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The current version of the application. This property is set during - - a call to the initialize() method. It is set to - - the version from the application descriptor file. - - -

Implementation -
-    public function get currentVersion():String -
-
- - - - - -
delayproperty 
-
-delay:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The interval, in days, between periodic checks of new updates. - - - -

A value of 0 (the default value) indicates - - that the timer is not active, so no periodic check is done. The delay - - can be set either via this property or via the configuration file. - - When the value is set using both methods, the value set using this - - property is used.

- - -

The default value is 0.

-Implementation -
-    public function get delay():Number -
-    public function set delay(value:Number):void -
-

-See also -

-
-configurationFile -
-
- - - - - -
isCheckForUpdateVisibleproperty 
-
-isCheckForUpdateVisible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Enables the visibility of the Check for - - Update, No Update, and Update Error dialog boxes. When set to true, - - the updater displays these dialog boxes as part of the - - update process. This can also be set in the update configuration - - file. A value set using this property overrides the setting in the - - update configuration file. - - -

Implementation -
-    public function get isCheckForUpdateVisible():Boolean -
-    public function set isCheckForUpdateVisible(value:Boolean):void -
-
- - - - - -
isDownloadProgressVisibleproperty 
-
-isDownloadProgressVisible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - - Enables the visibility of the Download Update - - dialog box. When set to true, the updater - - displays this dialog box as part of the update process. This can - - also be set in the update configuration file. A value set using - - this property overrides the setting in the update configuration file. - - -

Implementation -
-    public function get isDownloadProgressVisible():Boolean -
-    public function set isDownloadProgressVisible(value:Boolean):void -
-
- - - - - -
isDownloadUpdateVisibleproperty 
-
-isDownloadUpdateVisible:Boolean  [read-write]

- - - - -
Runtime version: AIR 1.5 - -
-

- - Enables the visibility of the Download Update - - dialog box. When set to true, the updater - - displays these dialog boxes as part of the update process. This - - can also be set in the update configuration file. A value set using - - this property overrides the setting in the update configuration file. - - -

Implementation -
-    public function get isDownloadUpdateVisible():Boolean -
-    public function set isDownloadUpdateVisible(value:Boolean):void -
-
- - - - - -
isFileUpdateVisibleproperty 
-
-isFileUpdateVisible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - - Enables the visibility of the File Update, - - File No Update, and File Error dialog boxes. When set to true, - - the updater displays these dialog boxes as part of the - - update process. This can also be set in the update configuration - - file. A value set using this property overrides the setting in the - - update configuration file. - - -

Implementation -
-    public function get isFileUpdateVisible():Boolean -
-    public function set isFileUpdateVisible(value:Boolean):void -
-
- - - - - -
isFirstRunproperty 
-
-isFirstRun:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Whether this is the first run after a successful update (true) or not - - (false). The updater sets this value during the call to the initialize() - - method. The developer should check that isFirstRun is set to true if - - there is a need to migrate data from one version to another. - - -

Implementation -
-    public function get isFirstRun():Boolean -
-

-See also -

-
-wasPendingUpdate -
-
- - - - - -
isInstallUpdateVisibleproperty 
-
-isInstallUpdateVisible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Enables the visibility of the Install Update - - dialog box. When set to true, the updater - - displays this dialog box as part of the update process. This can - - also be set in the update configuration file. A value set using - - this property overrides the setting in the update configuration file. - - -

Implementation -
-    public function get isInstallUpdateVisible():Boolean -
-    public function set isInstallUpdateVisible(value:Boolean):void -
-
- - - - - -
isNewerVersionFunctionproperty 
-
-isNewerVersionFunction:Function  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - A function that the updater should use to perform version comparisons. - - By default, the update framework does a - - version comparison to detect whether the version from the - - remote site is newer than the version of the installed application. - - However, sometimes the default comparison does not match the developer's - - versioning scheme. Set this property to provide a new function that - - does the comparison. - - -

The default comparision function accepts - - versions like x.y.z, where x, y, and z can contain letters - - and digits. There are some special conditions that the default comparision function - - recognizes. If the test function finds "alpha", "beta", - - or "rc" in the version strings, - - the order is alpha < beta < rc.

- - - Implementation -
-    public function get isNewerVersionFunction():Function -
-    public function set isNewerVersionFunction(value:Function):void -
-
-Example -
The following code defines a custom function, customFn, for the appUpdate updater object. - The example function is intentionally simple. Your custom function should return a Boolean value based on the rules of your - versioning scheme. -
-
-appUpdate.isNewerVersionFunction = customFn; 
-
-function customFn (currentVersion:String, updateVersion:String):Boolean 
-{
-    return updateVersion > currentVersion;
-}
-
-

-
- - - - - -
isUnexpectedErrorVisibleproperty 
-
-isUnexpectedErrorVisible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Enables the visibility of the Unexpected - - Error dialog box. When set to true, the Application - - Updater displays this dialog box as part of the update process. - - This can also be set in the update configuration file. A value set - - using this property overrides the setting in the update configuration - - file. - - -

Implementation -
-    public function get isUnexpectedErrorVisible():Boolean -
-    public function set isUnexpectedErrorVisible(value:Boolean):void -
-
- - - - - -
isUpdateInProgressproperty 
-
-isUpdateInProgress:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - A Boolean property, which is true if - - an update is running, false otherwise. - - -

Implementation -
-    public function get isUpdateInProgress():Boolean -
-
- - - - - -
localeChainproperty 
-
-localeChain:Array  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - An array defining the locale chain used - - by the user interface. Typically, only JavaScript (HTML) developers - - use this property. - - -

Flex developers can use the ResourceManager to handle the locale chain.

- - -

By default, in an HTML-based application, the languages are sorted between those languages in - - the Capabilities.languages array and the ten languages supported by the - - user interface. If no match is found, the user interface uses the English language.

- - - -

This JavaScript example uses the AIR HTML localization framework, included in the AIR SDK. It sorts - - the languages against the list of languages, and then it sets English as the default fallback language:

- - - 
 appUpdater.addResources("ro_RO", {titleCheck: "Titlu", msgCheck: "Mesaj", btnCheck: "Buton"});
-
-		appUpdater.addResources("hu", {titleCheck: "Cím", msgCheck: "Üzenet"}); 
-
-		var languages = ["ro", "hu"];
-
-		languages = languages.concat(air.Capabilities.languages);
-
-		var sortedLanguages = air.Localizer.sortLanguagesByPreference(languages, air.Capabilities.language, "en-US");  
-
-		sortedLanguages.push("en-US");
-
-		appUpdater.localeChain = sortedLanguages;
- - - Implementation -
-    public function get localeChain():Array -
-    public function set localeChain(value:Array):void -
-

-See also -

-
-addResources() -
-
- - - - - -
previousApplicationStorageDirectoryproperty 
-
-previousApplicationStorageDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The previous location of the application storage directory, if it changed - - after an update. The application storage directory location changes after - - an upgrade with a certificate migration. If there is no certificate - - migration, the application storage directory does not change when the - - user updates the application. and this property is set to null. - - This property is set during a call to the initialize() method. - - -

A developer can sign new version of AIR application with a new certificate - - if the developer uses the -migrate option when packaging the AIR - - file with ADT. If a new version of an AIR application uses a new signing certificate, - - the local storage directory of the application changes when the user installs - - the new version. Use this property to transfer data from the old application - - storage directory to the new application storage directory - - (File.applicationStorageDirectory). For more information, - - see "Signing an AIR file to change the application certificate" in the - - "Creating an AIR application using the command line tools" chapter of the - - Adobe AIR developer's guide.

- - - Implementation -
-    public function get previousApplicationStorageDirectory():File -
-
- - - - - -
previousVersionproperty 
-
-previousVersion:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The previous version of the application. This property is set during - - a call to the initialize() method. Returns the previous version of - - the application before the upgrade (set only if isfirstRun is true); - - otherwise it is set to null. - - -

Implementation -
-    public function get previousVersion():String -
-
- - - - - -
updateDescriptorproperty 
-
-updateDescriptor:XML  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The content of the update descriptor file downloaded from the update URL. This property is - - non-null only after the updater object dispatches an updateStatus event. - - -

Implementation -
-    public function get updateDescriptor():XML -
-
- - - - - -
updateURLproperty 
-
-updateURL:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The location of the update descriptor file. Any location - - valid for a URLRequest path is accepted. This is the only mandatory - - setting required by the updater. You can set the update URL either via this - - property or via the configuration file. When the value is set using - - both methods, the updater uses the value set using this property. - - -

Implementation -
-    public function get updateURL():String -
-    public function set updateURL(value:String):void -
-

-See also -

-
-configurationFile -
-
- - - - - -
wasPendingUpdateproperty 
-
-wasPendingUpdate:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Whether there was a postponed update, even if it failed - - to install (true); false otherwise. - - The updater sets this property during a call to the initialize() method. - - Use the wasPendingUpdate and isFirstRun properties - - to check if an update failed to install (in which case wasPendingUpdate - - is set to true and isFirstRun is set to false). - - -

Implementation -
-    public function get wasPendingUpdate():Boolean -
-

-See also -

-
-isFirstRun -
-
- -
Constructor detail
- - - - - -
ApplicationUpdaterUI()constructor
-
-public function ApplicationUpdaterUI() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The constructor function. - - -

- -
Method detail
- - - - - -
addResources()method
-
-public function addResources(lang:String, res:Object):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dynamically adds a new resource bundle for the specified language. - - JavaScript developers use this method to dynamically add a new language for the - - dialog boxes that the application updater UI displays. (Flex developers - - can directly add a new language to the "ApplicationUpdaterDialogs" - - resource bundle.) - - - -

Parameters - - - - - - - - - - -
lang:String — The language code (such as "ro" for Romanian). - - - -
 
res:Object — The object contains the keys and values for the translation. The keys are the ones from - - the language property file. The following table lists the possible keys (property names). - - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key English value Dialog Box Description
appWidth 530 All Width of the dialog box.
titleWindow Updating: All Displayed in the native window title bar before - - the application name.
titleCheck Check for updates Check For Updates Dialog box title.
msgCheck Allow the application to check for updates? Check For Updates Dialog box message.
btnCheck Check for Updates Check For Updates Check for Updates button label.
btnCancel Cancel All dialog boxes with a Cancel button Cancel button label.
titleCheckNoUpdates No updates available CheckForUpdates - No updates available Dialog box title.
msgCheckNoUpdates There are no updates available for the application. Check For Updates - No updates available Dialog box message.
btnClose Close All dialog boxes with Close button Close button label.
titleCheckError Update error Check For Updates - Connection Error Dialog box title.
msgCheckError There was an error checking for updates. - - Error# {0} Check For Updates - Connection Error Dialog box message. {0} will be replaced - - with the error ID.
titleUpdate Update available Update Available Dialog box title.
msgUpdate An updated version of the application is - - available for download. Update Available Dialog box message.
lblApplication Application: Update Available Label displayed before the application name.
lblInstalledVersion Installed Version: Update Available Label displayed before the installed version.
lblAvailableVersion Update Version: Update Available Label displayed before the update version.
btnDownload Download now Update Available Download Now button label.
btnDownloadLater Download later Update Available Download Later button label.
lnkReleaseNotes Release notes All with release notes link The "Release notes" link name.
titleProgress Download progress... Download Progress Dialog box title.
msgProgress Downloading update Download Progress Dialog box message.
titleDownloadError Download failed Download Error Dialog box title.
msgDownloadError There was an error downloading the update. - - Error# {0} Download Error Dialog box message. {0} - - will be replaced with the error ID.
titleInstall Install update Install Update Dialog box title.
msgInstall The update for the application is downloaded - - and ready to be installed. Install Update Dialog box message.
btnInstall Install now Install Update "Install" button label
btnInstallLater Postpone until restart Install Update "Postpone until restart" button label
titleFileUpdate Update available File - Update Available Dialog box title.
msgFileUpdate The file contains an updated version of - - the application. Install? File - Update Available Dialog box message.
lblFile File: File - Update Available Label displayed before the file name
titleFileNoUpdate No update available File - No updates available Dialog box title.
msgFileNoUpdate The file doesn't contain a newer version - - of the application. File - No updates available Dialog box message.
titleFileError File error File - Error Dialog box title.
msgFileError An error occurred validating the update - - file. Error# {0} File - Error Dialog box message. {0} - - will be replaced with the error ID.
titleUnexpectedError Unexpected error Unexpected Error Dialog box title.
msgUnexpectedError An unexpected error occurred. Error# {0} Unexpected Error Dialog box message. {0} - - will be replaced with the error ID.
- - - -

- - -
-

-See also -

-
-localeChain -
-
- - - - - -
cancelUpdate()method 
-
-public function cancelUpdate():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Cancels the update process. Calling this method cancels any - - pending downloads, deleting any incomplete downloaded files, and - - restarts the periodic check timer. - - - -

The update process can be canceled at any time except when the state - - machine is in "uninitialized" or "initializing" state. It does nothing - - when it is called in one of the "uninitialized" or "initializing" - - states.

- - -
- - - - - -
checkNow()method 
-
-public function checkNow():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Starts the update process. Calling - - this method does not stop the periodic timer; however, the method detects - - that an update process is running and will skip the current iteration. - - - -

This method only executes if the current state is "Ready".

- - - -

This method can result in the updater object dispatching the following event:

- - - -
-Events - - - - -
checkForUpdate — Dispatched just before the update process begins.
-
- - - - - -
initialize()method 
-
-public function initialize():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Initializes the updater. Calling this method - - does the following: - - - -

  1. - -

    It initializes the update framework, - - silently (and synchronously) installing any pending updates. You - - should call this method during application startup, since it may - - restart the application.

    - -
  2. - - - -

    It checks if there is a postponed update and installs it.

    - -
  3. - -

    If something went wrong with a prior update, it clears the - - update file and version information from the storage area.

    - -
  4. - -

    If the periodic timer delay has expired, it starts the update process; otherwise - - it starts the periodic timer. However, when testing an application using - - the AIR Debug Launcher (ADL) application, attempting to update the - - application results in a IllegalOperationError exception.

    - -
    5. - -

- - - -
-Events - - - - - - - - - - -
initialized — The initialization is complete.
 
error:ErrorEvent — There is an error during initialization.
-
- - - - - -
installFromAIRFile()method 
-
-public function installFromAIRFile(file:File):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Starts the update process using a local AIR file. - - - -

Calling this - - method has no effect if an update process is running (if the state - - is not "Downloaded").

- - - -

This function is useful - - for an application that has the customUpdateUI element - - set to true in the application descriptor file.

- - - -

When testing an application using the AIR Debug Launcher (ADL) application, - - calling this method results in an IllegalOperationError exception.

- - - - Parameters - - - - -
file:File — The local AIR file to install. - - - -
-
-Events - - - - - - - - - - -
fileUpdateStatus — Dispatched after the updater successfully - - validates the AIR file.
 
updateError — Dispatched if an error occurs while trying - - parse the update descriptor file.
-
-
Event detail
- - - - - -
beforeInstallevent 
-
-Event object type: air.update.events.UpdateEvent -
-UpdateEvent.type property = air.update.events.UpdateEvent.BEFORE_INSTALL -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched just before installing the update, after the installUpdate() method - - was called. Sometimes, it is useful to prevent the installation - - of the update at this time, because the user could lose all current work when - - the runtime exits the application to install the update. - - - -

Calling this event's preventDefault() method - - postpones the installation until the next restart. If you call - - the preventDefault() method, no additional update - - process can be started during this application session (via a call - - to the installUpdate() method or because of the periodic check).

- - -

- - The UpdateEvent.BEFORE_INSTALL constant defines the value of the - - type property of the event object for a beforeInstall event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
checkForUpdateevent  
-
-Event object type: air.update.events.UpdateEvent -
-UpdateEvent.type property = air.update.events.UpdateEvent.CHECK_FOR_UPDATE -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched before the update process begins, just before the - - updater tries to download the update descriptor file. - - The updater can dispatch this event as a result of directly - - calling the checkNow() method or because the periodic - - check timer expired. - - -

- - The UpdateEvent.CHECK_FOR_UPDATE constant defines the value of the - - type property of the event object for a checkForUpdate event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
downloadCompleteevent  
-
-Event object type: air.update.events.UpdateEvent -
-UpdateEvent.type property = air.update.events.UpdateEvent.DOWNLOAD_COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - - - Dispatched when the download of the update file is complete. - - -

- - The UpdateEvent.DOWNLOAD_COMPLETE constant defines the value of the - - type property of the event object for a downloadComplete event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
downloadErrorevent  
-
-Event object type: air.update.events.DownloadErrorEvent -
-DownloadErrorEvent.type property = air.update.events.DownloadErrorEvent.DOWNLOAD_ERROR -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched if there is an error while connecting or downloading - - the update file. It is also dispatched for invalid HTTP statuses - - (such as 404 - File not found). - - - -

When this event is dispatched the periodic timer is automatically - - restarted (if the delay is greater than 0).

- - - - -

- - The DownloadErrorEvent.DOWNLOAD_ERROR constant defines the value of the - - type property of the event object for a downloadError event. - - -

The errorID property of a DownloadErrorEvent object is - - an integer defining error information (see the following - - table). An additional subErrorID property may contain - - more error information.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
errorID Error codeDescription
16800Occurs during validating the downloaded - - update file. The subErrorID property may contain additional - - information.
16801Invalid Adobe AIR file (missing application.xml).
16802Invalid Adobe AIR file (missing MIME type).
16803Invalid Adobe AIR file (format).
16804Invalid Adobe AIR file (invalid flags).
16805Invalid Adobe AIR file (unknown compression).
16806Invalid Adobe AIR file (invalid filename).
16807Invalid Adobe AIR file (corrupt).
16808Configuration file does not exist.
16809The updateURL property - - is not set.
16810Reserved.
16811Invalid configuration file (unknown configuration - - version).
16812Invalid configuration file (URL missing).
16813Invalid configuration file (delay format).
16814Invalid configuration file (invalid defaultUI - - values).
16815Invalid update descriptor (unknown descriptor - - version).
16816Invalid update descriptor (missing update - - version).
16817Invalid update descriptor (invalid description).
16818IO error while saving data to disk. The subErrorID property - - may provide more information.
16819Security error while downloading. The subErrorID property - - may provide more information.
16820Invalid HTTP status code. The subErrorID property - - may contain the invalid status code.
16821Reserved.
16822I/O error while downloading. The subErrorID property - - may provide more information.
16823End-of-file error while saving data to disk. - - The subErrorID property may provide more information.
16824Invalid update descriptor. The subErrorID property may - - provide more information.
16825The update file contains an application - - with a different application ID.
16826The update file does not contain a newer - - version of the application.
16827The version contained in the update file - - does not match the version from the update descriptor.
16828Cannot update application, usually because - - the application is running in the AIR Debug Launcher (ADL).
16829Missing update file at install time.
- - -
- - - - - -
downloadStartevent  
-
-Event object type: air.update.events.UpdateEvent -
-UpdateEvent.type property = air.update.events.UpdateEvent.DOWNLOAD_START -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - - - Dispatched after a call to the downloadUpdate() method - - and the connection to the server is established. When using ApplicationUpdater - - library, you may want the event handler for this event to display - - a progress bar to report the download progress to the user. - - -

- - The UpdateEvent.DOWNLOAD_START constant defines the value of the - - type property of the event object for a downloadStart event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
errorevent  
-
-Event object type: flash.events.ErrorEvent -
-ErrorEvent.type property = flash.events.ErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched when an error occurred either during initialization - - or during the update process (if something unexpected happens). - - -

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -
- - - - - -
fileUpdateErrorevent  
-
-Event object type: air.update.events.StatusFileUpdateErrorEvent -
-StatusFileUpdateErrorEvent.type property = air.update.events.StatusFileUpdateErrorEvent.FILE_UPDATE_ERROR -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched when an error occurs validating the file passed - - as the airFile parameter in a call to the installFromAIRFile() method. - - -

- - The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the - - type property of the event object for a statusUpdateError event. - - -

- - - - - -
fileUpdateStatusevent  
-
-Event object type: air.update.events.StatusFileUpdateEvent -
-StatusFileUpdateEvent.type property = air.update.events.StatusFileUpdateEvent.FILE_UPDATE_STATUS -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - - - Dispatched after the updater successfully validates the - - file in the call to the installFromAIRFile() method. - - - - -

- - The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the - - type property of the event object for a updateStatus event. - - -

This event has the following properties:

- - -

- - - - - - - - - - - - - - -
PropertyValue
availableIndicates if if there is a different version - - available than one of the current application (true); false otherwise (same version).
pathThe nativePath property of - - the update File object specified by the airFile parameter - - in a call to the installFromAIRFile() method.
versionIndicates the version of the new update.

- - -
- - - - - -
initializedevent  
-
-Event object type: air.update.events.UpdateEvent -
-UpdateEvent.type property = air.update.events.UpdateEvent.INITIALIZED -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - - - Dispatched after the initialization is complete. - - -

This event has the following read-only properties:

- -
  • - -

    isFirstRun (Boolean) true if - - this is the first run after a successful update; false otherwise.

    - -
  • - -

    previousVersion (String) The previous version - - of the application before the upgrade (set only if isfirstRun is true).

    - -
  • - -

    currentVersion (String) The version from - - the application descriptor file of the currently installed version.

    - -
    • - -
- - -

- - The UpdateEvent.INITIALIZED constant defines the value of the - - type property of the event object for a initialized event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Dispatched as the update file is downloaded. - - -

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -
- - - - - -
updateErrorevent  
-
-Event object type: air.update.events.StatusUpdateErrorEvent -
-StatusUpdateErrorEvent.type property = air.update.events.StatusUpdateErrorEvent.UPDATE_ERROR -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - - - Dispatched if an error occurs while trying to download or parse the update descriptor file. - - -

When the updater dispatches this event, the periodic timer - - is automatically restarted (if the delay setting is greater than - - 0). The application should consider hiding any error dialog boxes - - when the updater dispatches a new checkForUpdate event.

- - -

- - The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the - - type property of the event object for a statusUpdateError event. - - -

- - - - - -
updateStatusevent  
-
-Event object type: air.update.events.StatusUpdateEvent -
-StatusUpdateEvent.type property = air.update.events.StatusUpdateEvent.UPDATE_STATUS -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - - - Dispatched after the updater successfully downloads and - - interprets the update descriptor file. - - -

- - The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the - - type property of the event object for a updateStatus event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
availableSet to true if - - the update descriptor file specifies a version that is different - - than that of the current application; false otherwise - - (the version is the same).
versionThe string representing the new available version.
detailsAn array defining the details string - - for each of the supported languages. If there is no localized description, - - this is defined as an array in which the first element is an empty - - string ("") and the second element is the details - - string. When there are localized descriptions, each element in the - - array is an array itself with two elements. The first element is - - the locale code, and the second is the description. For example, - - the following array has sub-arrays for two languages (U.S. English - - and French): ["en-US", "Hello World"], ["fr", "Bonjour monde"]. - - The languages are listed in the same order as in the update descriptor. The - - text for the details property is specified in the update descriptor file.
versionLabel(AIR 2.5+) The version label from the application descriptor of - - the update. The version label should be displayed to users instead of - - version. If no version label is specified, this property is an empty string.
- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/air/update/events/DownloadErrorEvent.html b/html-docs/air/update/events/DownloadErrorEvent.html deleted file mode 100644 index 6d7fc1c..0000000 --- a/html-docs/air/update/events/DownloadErrorEvent.html +++ /dev/null @@ -1,1135 +0,0 @@ - - - - - - - - -air.update.events.DownloadErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.update.events
Classpublic class DownloadErrorEvent
InheritanceDownloadErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Runtime version: AIR 1.5 - -
-

-

- - A DownloadErrorEvent object is dispatched by an ApplicationUpdater or ApplicationUpdaterUI - - object when an error happens while downloading the update file. - - -

-

-See also -

-
-air.update.ApplicationUpdater -
-air.update.ApplicationUpdaterUI -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  subErrorID : int = 0
- - Provides information in addition to the errorId property.
-		DownloadErrorEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DownloadErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0, subErrorID:int = 0)
-
- - The constructor function.
-		DownloadErrorEvent
   -
-clone():Event -
-
- - Creates a copy of the object and sets the value of each property to match that of the original.
-		DownloadErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string that contains all the properties of the object.
-		DownloadErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
  DOWNLOAD_ERROR : String = "downloadError"
[static] - - The DownloadErrorEvent.DOWNLOAD_ERROR constant defines the value of the - - type property of the event object for a downloadError event.
-		DownloadErrorEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
subErrorIDproperty
-
-public var subErrorID:int = 0 -

- - - - -
Runtime version: AIR 1.5 - -
-

- - Provides information in addition to the errorId property. - - -

- -
Constructor detail
- - - - - -
DownloadErrorEvent()constructor
-
-public function DownloadErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0, subErrorID:int = 0) -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The constructor function. Do not call this function. The update framework calls it to create the event object. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of error event: ErrorEvent.ERROR. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. - -
 
text:String (default = "") — Text to be displayed as an error message. Event listeners can access this information through the text property. - -
 
id:int (default = 0) — A reference number to associate with the specific error. - -
 
subErrorID:int (default = 0) — Provides details about the error event, in addition to the errorID. - - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event

- - Creates a copy of the object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event
-
- - - - - -
toString()method 
-
-public override function toString():String

- - Returns a string that contains all the properties of the object. - -

-Returns - - - - -
String
-
- -
Constant detail
- - - - - -
DOWNLOAD_ERRORconstant
-
-public static const DOWNLOAD_ERROR:String = "downloadError" -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The DownloadErrorEvent.DOWNLOAD_ERROR constant defines the value of the - - type property of the event object for a downloadError event. - - -

The errorID property of a DownloadErrorEvent object is - - an integer defining error information (see the following - - table). An additional subErrorID property may contain - - more error information.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
errorID Error codeDescription
16800Occurs during validating the downloaded - - update file. The subErrorID property may contain additional - - information.
16801Invalid Adobe AIR file (missing application.xml).
16802Invalid Adobe AIR file (missing MIME type).
16803Invalid Adobe AIR file (format).
16804Invalid Adobe AIR file (invalid flags).
16805Invalid Adobe AIR file (unknown compression).
16806Invalid Adobe AIR file (invalid filename).
16807Invalid Adobe AIR file (corrupt).
16808Configuration file does not exist.
16809The updateURL property - - is not set.
16810Reserved.
16811Invalid configuration file (unknown configuration - - version).
16812Invalid configuration file (URL missing).
16813Invalid configuration file (delay format).
16814Invalid configuration file (invalid defaultUI - - values).
16815Invalid update descriptor (unknown descriptor - - version).
16816Invalid update descriptor (missing update - - version).
16817Invalid update descriptor (invalid description).
16818IO error while saving data to disk. The subErrorID property - - may provide more information.
16819Security error while downloading. The subErrorID property - - may provide more information.
16820Invalid HTTP status code. The subErrorID property - - may contain the invalid status code.
16821Reserved.
16822I/O error while downloading. The subErrorID property - - may provide more information.
16823End-of-file error while saving data to disk. - - The subErrorID property may provide more information.
16824Invalid update descriptor. The subErrorID property may - - provide more information.
16825The update file contains an application - - with a different application ID.
16826The update file does not contain a newer - - version of the application.
16827The version contained in the update file - - does not match the version from the update descriptor.
16828Cannot update application, usually because - - the application is running in the AIR Debug Launcher (ADL).
16829Missing update file at install time.
- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/air/update/events/StatusFileUpdateErrorEvent.html b/html-docs/air/update/events/StatusFileUpdateErrorEvent.html deleted file mode 100644 index 51c087d..0000000 --- a/html-docs/air/update/events/StatusFileUpdateErrorEvent.html +++ /dev/null @@ -1,794 +0,0 @@ - - - - - - - - -air.update.events.StatusFileUpdateErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.update.events
Classpublic class StatusFileUpdateErrorEvent
InheritanceStatusFileUpdateErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Runtime version: AIR 1.5 - -
-

-

- - A StatusUpdateFileErrorEvent is dispatched when a call to the checkForUpdate() method of a ApplicationUpdater object encounters an error - - while downloading or parsing the update descriptor file. - - -

-

-See also -

-
-air.update.ApplicationUpdater -
-air.update.ApplicationUpdaterUI -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StatusFileUpdateErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0)
-
- - The constructor function.
-		StatusFileUpdateErrorEvent
   -
-clone():Event -
-
- - Creates a copy of the object and sets the value of each property to match that of the original.
-		StatusFileUpdateErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string that contains all the properties of the object.
-		StatusFileUpdateErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
  FILE_UPDATE_ERROR : String = "fileUpdateError"
[static] - - The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the - - type property of the event object for a statusUpdateError event.
-		StatusFileUpdateErrorEvent
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Constructor detail
- - - - - -
StatusFileUpdateErrorEvent()constructor
-
-public function StatusFileUpdateErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0) -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The constructor function. Do not call this function. The update framework calls it to create the event object. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of error event: ErrorEvent.ERROR. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. - -
 
text:String (default = "") — Text to be displayed as an error message. Event listeners can access this information through the text property. - -
 
id:int (default = 0) — A reference number to associate with the specific error. - - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event

- - Creates a copy of the object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event
-
- - - - - -
toString()method 
-
-public override function toString():String

- - Returns a string that contains all the properties of the object. - -

-Returns - - - - -
String
-
- -
Constant detail
- - - - - -
FILE_UPDATE_ERRORconstant
-
-public static const FILE_UPDATE_ERROR:String = "fileUpdateError" -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the - - type property of the event object for a statusUpdateError event. - - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/air/update/events/StatusFileUpdateEvent.html b/html-docs/air/update/events/StatusFileUpdateEvent.html deleted file mode 100644 index 6fa77d3..0000000 --- a/html-docs/air/update/events/StatusFileUpdateEvent.html +++ /dev/null @@ -1,1058 +0,0 @@ - - - - - - - - -air.update.events.StatusFileUpdateEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.update.events
Classpublic class StatusFileUpdateEvent
InheritanceStatusFileUpdateEvent Inheritance UpdateEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

-

- - Dispatched after the updater successfully validates the - - file in the call to the installFromAIRFile() method. - - - -

The default behavior is to install the update if the available - - of the available property of the StatusFileUpdateEvent object is - - set to true. The default behavior can be prevented only when using - - the ApplicationUpdater class.

- - -

-

-See also -

-
-air.update.ApplicationUpdater -
-air.update.ApplicationUpdaterUI -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  available : Boolean = false
- - Indicates if if there is a different version available than one of the current application - - (true); false otherwise (same version).
-		StatusFileUpdateEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  path : String = "null"
- - The nativePath property of - - the update File object specified by the airFile parameter - - in a call to the installFromAIRFile() method.
-		StatusFileUpdateEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
  version : String = ""
- - The version string of the update.
-		StatusFileUpdateEvent
  versionLabel : String = ""
- - The version label string of the update.
-		StatusFileUpdateEvent
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StatusFileUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false, version:String = "", path:String = "")
-
- - The constructor function.
-		StatusFileUpdateEvent
   -
-clone():Event -
-
- - Creates a copy of the object and sets the value of each property to match that of the original.
-		StatusFileUpdateEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string that contains all the properties of the object.
-		StatusFileUpdateEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBEFORE_INSTALL : String = "beforeInstall"
[static] - - The UpdateEvent.BEFORE_INSTALL constant defines the value of the - - type property of the event object for a beforeInstall event.
-		UpdateEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCHECK_FOR_UPDATE : String = "checkForUpdate"
[static] - - The UpdateEvent.CHECK_FOR_UPDATE constant defines the value of the - - type property of the event object for a checkForUpdate event.
-		UpdateEvent
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedDOWNLOAD_COMPLETE : String = "downloadComplete"
[static] - - The UpdateEvent.DOWNLOAD_COMPLETE constant defines the value of the - - type property of the event object for a downloadComplete event.
-		UpdateEvent
 InheritedDOWNLOAD_START : String = "downloadStart"
[static] - - The UpdateEvent.DOWNLOAD_START constant defines the value of the - - type property of the event object for a downloadStart event.
-		UpdateEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
  FILE_UPDATE_STATUS : String = "fileUpdateStatus"
[static] - - The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the - - type property of the event object for a updateStatus event.
-		StatusFileUpdateEvent
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedINITIALIZED : String = "initialized"
[static] - - The UpdateEvent.INITIALIZED constant defines the value of the - - type property of the event object for a initialized event.
-		UpdateEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
availableproperty
-
-public var available:Boolean = false -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Indicates if if there is a different version available than one of the current application - - (true); false otherwise (same version). - - -

- - - - - -
pathproperty 
-
-public var path:String = "null" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The nativePath property of - - the update File object specified by the airFile parameter - - in a call to the installFromAIRFile() method. - - -

- - - - - -
versionproperty 
-
-public var version:String = "" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The version string of the update. - - -

In AIR 2.5 and later, the version string is specified in the versionNumber - - element of the application descriptor file. In earlier versions of AIR, the version string - - is specified in the version element.

- - - -
- - - - - -
versionLabelproperty 
-
-public var versionLabel:String = "" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - The version label string of the update. - - - -

- -
Constructor detail
- - - - - -
StatusFileUpdateEvent()constructor
-
-public function StatusFileUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false, version:String = "", path:String = "") -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The constructor function. Do not call this function. The update framework calls it to create the event object. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of error event: ErrorEvent.ERROR. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. - -
 
available:Boolean (default = false) — Text to be displayed as an error message. Event listeners can access this information through the text property. - -
 
version:String (default = "") — A reference number to associate with the specific error. - - -
 
path:String (default = "")
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Creates a copy of the object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Returns a string that contains all the properties of the object. - -

-Returns - - - - -
String
-
- -
Constant detail
- - - - - -
FILE_UPDATE_STATUSconstant
-
-public static const FILE_UPDATE_STATUS:String = "fileUpdateStatus" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the - - type property of the event object for a updateStatus event. - - -

This event has the following properties:

- - -

- - - - - - - - - - - - - - -
PropertyValue
availableIndicates if if there is a different version - - available than one of the current application (true); false otherwise (same version).
pathThe nativePath property of - - the update File object specified by the airFile parameter - - in a call to the installFromAIRFile() method.
versionIndicates the version of the new update.

- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/air/update/events/StatusUpdateErrorEvent.html b/html-docs/air/update/events/StatusUpdateErrorEvent.html deleted file mode 100644 index 0c08306..0000000 --- a/html-docs/air/update/events/StatusUpdateErrorEvent.html +++ /dev/null @@ -1,832 +0,0 @@ - - - - - - - - -air.update.events.StatusUpdateErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.update.events
Classpublic class StatusUpdateErrorEvent
InheritanceStatusUpdateErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Runtime version: AIR 1.5 - -
-

-

- - A StatusUpdateErrorEvent is dispatched when a call to the checkForUpdate() method - - of an ApplicationUpdater object encounters an error while downloading or parsing the update descriptor file. - - -

-

-See also -

-
-air.update.ApplicationUpdater -
-air.update.ApplicationUpdaterUI -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  subErrorID : int = 0
- - Provides information in addition to the errorId property.
-		StatusUpdateErrorEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StatusUpdateErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0, subErrorID:int = 0)
-
- - The constructor function.
-		StatusUpdateErrorEvent
   -
-clone():Event -
-
- - Creates a copy of the object and sets the value of each property to match that of the original.
-		StatusUpdateErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string that contains all the properties of the object.
-		StatusUpdateErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
  UPDATE_ERROR : String = "updateError"
[static] - - The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the - - type property of the event object for a statusUpdateError event.
-		StatusUpdateErrorEvent
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
subErrorIDproperty
-
-public var subErrorID:int = 0 -

- - - - -
Runtime version: AIR 1.5 - -
-

- - Provides information in addition to the errorId property. - - -

- -
Constructor detail
- - - - - -
StatusUpdateErrorEvent()constructor
-
-public function StatusUpdateErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0, subErrorID:int = 0) -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The constructor function. Do not call this function. The update framework calls it to create the event object. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of error event: ErrorEvent.ERROR. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. - -
 
text:String (default = "") — Text to be displayed as an error message. Event listeners can access this information through the text property. - -
 
id:int (default = 0) — A reference number to associate with the specific error. - -
 
subErrorID:int (default = 0) — Provides details about the error event, in addition to the errorID. - - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event

- - Creates a copy of the object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event
-
- - - - - -
toString()method 
-
-public override function toString():String

- - Returns a string that contains all the properties of the object. - -

-Returns - - - - -
String
-
- -
Constant detail
- - - - - -
UPDATE_ERRORconstant
-
-public static const UPDATE_ERROR:String = "updateError" -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the - - type property of the event object for a statusUpdateError event. - - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/air/update/events/StatusUpdateEvent.html b/html-docs/air/update/events/StatusUpdateEvent.html deleted file mode 100644 index dd490ce..0000000 --- a/html-docs/air/update/events/StatusUpdateEvent.html +++ /dev/null @@ -1,1108 +0,0 @@ - - - - - - - - -air.update.events.StatusUpdateEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.update.events
Classpublic class StatusUpdateEvent
InheritanceStatusUpdateEvent Inheritance UpdateEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

-

- - An updater object dispatches a StatusUpdateEvent object after the updater successfully - - downloads and interprets the update descriptor file. - - - -

The default behavior is to start downloading the update if the - - available property of the StatusUpdateEvent object - - is set to true. The default behavior can be prevented - - only when using the ApplicationUpdater class.

- - -

-

-See also -

-
-air.update.ApplicationUpdater -
-air.update.ApplicationUpdaterUI -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  available : Boolean = false
- - Indicates if an update is available.
-		StatusUpdateEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  details : Array -
- - An array defining the details string - - for each of the supported languages.
-		StatusUpdateEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
  version : String = ""
- - The version string of the update.
-		StatusUpdateEvent
  versionLabel : String = ""
- - The version label string of the update.
-		StatusUpdateEvent
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StatusUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false, version:String = "", details:Array = null, versionLabel:String = "")
-
- - The constructor function.
-		StatusUpdateEvent
   -
-clone():Event -
-
- - Creates a copy of the object and sets the value of each property to match that of the original.
-		StatusUpdateEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string that contains all the properties of the object.
-		StatusUpdateEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBEFORE_INSTALL : String = "beforeInstall"
[static] - - The UpdateEvent.BEFORE_INSTALL constant defines the value of the - - type property of the event object for a beforeInstall event.
-		UpdateEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCHECK_FOR_UPDATE : String = "checkForUpdate"
[static] - - The UpdateEvent.CHECK_FOR_UPDATE constant defines the value of the - - type property of the event object for a checkForUpdate event.
-		UpdateEvent
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedDOWNLOAD_COMPLETE : String = "downloadComplete"
[static] - - The UpdateEvent.DOWNLOAD_COMPLETE constant defines the value of the - - type property of the event object for a downloadComplete event.
-		UpdateEvent
 InheritedDOWNLOAD_START : String = "downloadStart"
[static] - - The UpdateEvent.DOWNLOAD_START constant defines the value of the - - type property of the event object for a downloadStart event.
-		UpdateEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedINITIALIZED : String = "initialized"
[static] - - The UpdateEvent.INITIALIZED constant defines the value of the - - type property of the event object for a initialized event.
-		UpdateEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
  UPDATE_STATUS : String = "updateStatus"
[static] - - The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the - - type property of the event object for a updateStatus event.
-		StatusUpdateEvent
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
availableproperty
-
-public var available:Boolean = false -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Indicates if an update is available. This property is true if - - the update descriptor file specifies a version that is different - - than that of the current application; it is false otherwise - - (the version is the same). - - -

- - - - - -
detailsproperty 
-
-public var details:Array -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - An array defining the details string - - for each of the supported languages. If there is no localized description, - - this is defined as an array in which the first element is an empty - - string ("") and the second element is the details - - string. When there are localized descriptions, each element in the - - array is an array itself with two elements. The first element is - - the locale code, and the second is the description. For example, - - the following array has sub-arrays for two languages (U.S. English - - and French): ["en-US", "Hello World"], ["fr", "Bonjour monde"]. - - The languages are listed in the same order as in the update descriptor. - - -

- - - - - -
versionproperty 
-
-public var version:String = "" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The version string of the update. - - -

In AIR 2.5 and later, the version string is specified in the versionNumber - - element of the application descriptor file. In earlier versions of AIR, the version string - - is specified in the version element.

- - - -
- - - - - -
versionLabelproperty 
-
-public var versionLabel:String = "" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - The version label string of the update. - - - -

- -
Constructor detail
- - - - - -
StatusUpdateEvent()constructor
-
-public function StatusUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false, version:String = "", details:Array = null, versionLabel:String = "") -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The constructor function. Do not call this function. The update framework calls it to create the event object. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of error event: ErrorEvent.ERROR. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. - -
 
available:Boolean (default = false) — Text to be displayed as an error message. Event listeners can access this information through the text property. - -
 
version:String (default = "") — A reference number to associate with the specific error. - -
 
details:Array (default = null) — the version string of the update. - -
 
versionLabel:String (default = "") — an array containing the description of update. The elements of the array alternate between local codes and a localized version of the description. - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Creates a copy of the object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Returns a string that contains all the properties of the object. - -

-Returns - - - - -
String
-
- -
Constant detail
- - - - - -
UPDATE_STATUSconstant
-
-public static const UPDATE_STATUS:String = "updateStatus" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the - - type property of the event object for a updateStatus event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
availableSet to true if - - the update descriptor file specifies a version that is different - - than that of the current application; false otherwise - - (the version is the same).
versionThe string representing the new available version.
detailsAn array defining the details string - - for each of the supported languages. If there is no localized description, - - this is defined as an array in which the first element is an empty - - string ("") and the second element is the details - - string. When there are localized descriptions, each element in the - - array is an array itself with two elements. The first element is - - the locale code, and the second is the description. For example, - - the following array has sub-arrays for two languages (U.S. English - - and French): ["en-US", "Hello World"], ["fr", "Bonjour monde"]. - - The languages are listed in the same order as in the update descriptor. The - - text for the details property is specified in the update descriptor file.
versionLabel(AIR 2.5+) The version label from the application descriptor of - - the update. The version label should be displayed to users instead of - - version. If no version label is specified, this property is an empty string.
- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/air/update/events/UpdateEvent.html b/html-docs/air/update/events/UpdateEvent.html deleted file mode 100644 index f0f8585..0000000 --- a/html-docs/air/update/events/UpdateEvent.html +++ /dev/null @@ -1,1003 +0,0 @@ - - - - - - - - -air.update.events.UpdateEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageair.update.events
Classpublic class UpdateEvent
InheritanceUpdateEvent Inheritance Event Inheritance Object
SubclassesStatusFileUpdateEvent, StatusUpdateEvent
-

- - - - -
Runtime version: AIR 1.5 - -
-

-

- - A UpdateEvent is dispatched by a ApplicationUpdater object during the update process. - - -

-

-See also -

-
-air.update.ApplicationUpdater -
-air.update.ApplicationUpdaterUI -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-UpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
-
- - The constructor function.
-		UpdateEvent
   -
-clone():Event -
-
- - Creates a copy of the object and sets the value of each property to match that of the original.
-		UpdateEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string that contains all the properties of the object.
-		UpdateEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  BEFORE_INSTALL : String = "beforeInstall"
[static] - - The UpdateEvent.BEFORE_INSTALL constant defines the value of the - - type property of the event object for a beforeInstall event.
-		UpdateEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
  CHECK_FOR_UPDATE : String = "checkForUpdate"
[static] - - The UpdateEvent.CHECK_FOR_UPDATE constant defines the value of the - - type property of the event object for a checkForUpdate event.
-		UpdateEvent
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
  DOWNLOAD_COMPLETE : String = "downloadComplete"
[static] - - The UpdateEvent.DOWNLOAD_COMPLETE constant defines the value of the - - type property of the event object for a downloadComplete event.
-		UpdateEvent
  DOWNLOAD_START : String = "downloadStart"
[static] - - The UpdateEvent.DOWNLOAD_START constant defines the value of the - - type property of the event object for a downloadStart event.
-		UpdateEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
  INITIALIZED : String = "initialized"
[static] - - The UpdateEvent.INITIALIZED constant defines the value of the - - type property of the event object for a initialized event.
-		UpdateEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Constructor detail
- - - - - -
UpdateEvent()constructor
-
-public function UpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The constructor function. Do not call this function. The update framework calls it to create the event object. - - -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of error event: ErrorEvent.ERROR. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event

- - Creates a copy of the object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event
-
- - - - - -
toString()method 
-
-public override function toString():String

- - Returns a string that contains all the properties of the object. - -

-Returns - - - - -
String
-
- -
Constant detail
- - - - - -
BEFORE_INSTALLconstant
-
-public static const BEFORE_INSTALL:String = "beforeInstall" -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The UpdateEvent.BEFORE_INSTALL constant defines the value of the - - type property of the event object for a beforeInstall event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
CHECK_FOR_UPDATEconstant 
-
-public static const CHECK_FOR_UPDATE:String = "checkForUpdate" -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The UpdateEvent.CHECK_FOR_UPDATE constant defines the value of the - - type property of the event object for a checkForUpdate event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
DOWNLOAD_COMPLETEconstant 
-
-public static const DOWNLOAD_COMPLETE:String = "downloadComplete" -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The UpdateEvent.DOWNLOAD_COMPLETE constant defines the value of the - - type property of the event object for a downloadComplete event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
DOWNLOAD_STARTconstant 
-
-public static const DOWNLOAD_START:String = "downloadStart" -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The UpdateEvent.DOWNLOAD_START constant defines the value of the - - type property of the event object for a downloadStart event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
- - - - - -
INITIALIZEDconstant 
-
-public static const INITIALIZED:String = "initialized" -

- - - - -
Runtime version: AIR 1.5 - -
-

- - The UpdateEvent.INITIALIZED constant defines the value of the - - type property of the event object for a initialized event. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe updater object.
- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/air/update/events/package-detail.html b/html-docs/air/update/events/package-detail.html deleted file mode 100644 index a3c884e..0000000 --- a/html-docs/air/update/events/package-detail.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - -air.update.events Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The air.update.events package contains classes that define events used by the AIR application update framework. This package is only available to content running in the AIR runtime.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 DownloadErrorEvent - - A DownloadErrorEvent object is dispatched by an ApplicationUpdater or ApplicationUpdaterUI - - object when an error happens while downloading the update file.
 StatusFileUpdateErrorEvent - - A StatusUpdateFileErrorEvent is dispatched when a call to the checkForUpdate() method of a ApplicationUpdater object encounters an error - - while downloading or parsing the update descriptor file.
 StatusFileUpdateEvent - - Dispatched after the updater successfully validates the - - file in the call to the installFromAIRFile() method.
 StatusUpdateErrorEvent - - A StatusUpdateErrorEvent is dispatched when a call to the checkForUpdate() method - - of an ApplicationUpdater object encounters an error while downloading or parsing the update descriptor file.
 StatusUpdateEvent - - An updater object dispatches a StatusUpdateEvent object after the updater successfully - - downloads and interprets the update descriptor file.
 UpdateEvent - - A UpdateEvent is dispatched by a ApplicationUpdater object during the update process.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
-
- - diff --git a/html-docs/air/update/package-detail.html b/html-docs/air/update/package-detail.html deleted file mode 100644 index efadc8b..0000000 --- a/html-docs/air/update/package-detail.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - -air.update Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The air.update package contains classes for updating AIR applications. This package is only available to content running in the AIR runtime. It is included in the applicationupdater.swc and applicationupdater_ui.swc files (for SWF-based application developers) and applicationupdater.swf and applicationupdater_ui.swf files (for HTML-based AIR application developers).

-
-
- -
Classes
- - - - - - - - - - -
 ClassDescription
 ApplicationUpdater - - The ApplicationUpdater class defines the basic functionality of the update framework for - - Adobe® AIR® applications, without providing any default user interface.
 ApplicationUpdaterUI - - The ApplicationUpdaterUI class defines the basic functionality of the update framework for - - Adobe® AIR® applications, and it provides a default user interface.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
-
- - diff --git a/html-docs/air/utils/ZipArchive.html b/html-docs/air/utils/ZipArchive.html deleted file mode 100644 index c93f775..0000000 --- a/html-docs/air/utils/ZipArchive.html +++ /dev/null @@ -1,1303 +0,0 @@ - - - - - - - - -air.utils.ZipArchive (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.utils
Classpublic class ZipArchive
InheritanceZipArchive Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 51 - -
-

-

- - The ZipArchive class is used to represent a zipped-up set of files in memory. - - -

It can be created by loading a .zip file, or can be saved out to a .zip file. - - The entries can be modified and accessed via the ZipEntry class.

- - - -

Support is only provided for normal (32-bit) zip files without encryption, and - - with either 'store' or 'deflate' options.

- - - -

For example: - - 

-
- var fZip : File = File.documentsDirectory.resolvePath("myZip.zip");
-
- var zip : ZipArchive = ZipArchive.load(fZip);
-
- for (var i : uint = 0; i < zip.entries.length; i++)
-
-     trace( zip.entries[i].toString() );
-
-
- - or - - 
-
- var fZip : File = File.documentsDirectory.resolvePath("myZip.zip");
-
- var zip : ZipArchive = new ZipArchive();
-
- zip.entries.push( new ZipEntry("file_one.txt", bytes) );
-
- zip.save(fZip);
-
-
- -

- - -

-

-See also -

-
-ZipEntry class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  entries : Vector.<ZipEntry>
[read-only] - - The entries within this zip archive.
-		ZipArchive
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ZipArchive()
-
- - Creates a new, empty zip archive to which new entries can be added.
-		ZipArchive
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-addFilesAsync(folder:File, recurse:Boolean = true, compress:Boolean = true, includeFolderEntries:Boolean = false, followLinks:Boolean = false):void -
-
- - Modifies an existing ZipArchive object by adding all files within a folder.
-		ZipArchive
   -
-createFromFolder(folder:File, recurse:Boolean = true, compress:Boolean = true, includeFolderEntries:Boolean = false, followLinks:Boolean = false):ZipArchive -
-
[static] - - Creates a new ZipArchive object by zipping up all files within a folder.
-		ZipArchive
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-extractFiles(folder:File):uint -
-
- - Extracts all of the entries from this zip archive onto the file system within the given folder.
-		ZipArchive
   -
-extractFilesAsync(folder:File):void -
-
- - Extracts all of the entries from this zip archive onto the file system within the given folder.
-		ZipArchive
   -
-findEntry(entry:String):ZipEntry -
-
- - Find an entry in the archive using its name.
-		ZipArchive
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-load(file:File):ZipArchive -
-
[static] - - Creates a new ZipArchive object by loading in data from a file.
-		ZipArchive
   -
-loadFromByteArray(data:ByteArray):ZipArchive -
-
[static] - - Creates a new ZipArchive object by loading in data from a byte array.
-		ZipArchive
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-removeEntry(entry:String):Boolean -
-
- - Remove an entry from the archive using its name.
-		ZipArchive
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-save(file:File):uint -
-
- - Saves a ZipArchive object to a file.
-		ZipArchive
   -
-saveToByteArray(bytes:ByteArray):uint -
-
- - Saves a ZipArchive object to a byte array.
-		ZipArchive
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-complete -
-		 - - Dispatched when an asynchronous zip/unzip operation has completed.ZipArchive
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-progress -
-		 - - Dispatched during an asynchronous zip/unzip operation.ZipArchive
-
- -
- -
Property detail
- - - - - -
entriesproperty
-
-entries:Vector.<ZipEntry>  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - The entries within this zip archive. - - -

Implementation -
-    public function get entries():Vector.<ZipEntry> -
-
- -
Constructor detail
- - - - - -
ZipArchive()constructor
-
-public function ZipArchive() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Creates a new, empty zip archive to which new entries can be added. - - -

- -
Method detail
- - - - - -
addFilesAsync()method
-
-public function addFilesAsync(folder:File, recurse:Boolean = true, compress:Boolean = true, includeFolderEntries:Boolean = false, followLinks:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Modifies an existing ZipArchive object by adding all files within a folder. - - -

This may be performed on a new, empty ZipArchive object, or on one that already - - has a number of entries. Any duplicate entries (in terms of the names) will be overwritten with - - new entries discovered from this operation.

- - -

This operation is asynchronous and is performed mostly in a separate thread, with ProgressEvent - - events being dispatched whilst the operation is progressing and a Event.COMPLETE event being dispatched - - once it has finished. During this time, the ZipArchive object cannot be accessed or updated.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
folder:File — The folder to use to search for all files to add to the zip archive. - - -
 
recurse:Boolean (default = true) — Whether or not to recurse into any subfolders that are found. - - -
 
compress:Boolean (default = true) — Whether or not to compress the files (if false, files are just stored). - - -
 
includeFolderEntries:Boolean (default = false) — Whether or not to include entries in the archive for each folder. - - This can be used to ensure empty folders are generated when unzipping: otherwise, folders are - - only created if they contain a file that is in the archive. - - -
 
followLinks:Boolean (default = false) — Whether or not to follow a symbolic link and include the contents of the target - - file. By default, links are stored as links, but this can cause problems when unzipping on a Windows - - platform where a link turns into a file that just has contents being the relative path to the target - - file. If this is set to true, then any links are stored as the contents of the file that is linked to. - - -
-
-Throws - - - - -
Error — The folder does not exist or another file error occurs within this operation. - - -
-
- - - - - -
createFromFolder()method 
-
-public static function createFromFolder(folder:File, recurse:Boolean = true, compress:Boolean = true, includeFolderEntries:Boolean = false, followLinks:Boolean = false):ZipArchive -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Creates a new ZipArchive object by zipping up all files within a folder. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
folder:File — The folder to use to search for all files to add to the zip archive. - - -
 
recurse:Boolean (default = true) — Whether or not to recurse into any subfolders that are found. - - -
 
compress:Boolean (default = true) — Whether or not to compress the files (if false, files are just stored). - - -
 
includeFolderEntries:Boolean (default = false) — Whether or not to include entries in the archive for each folder. - - This can be used to ensure empty folders are generated when unzipping: otherwise, folders are - - only created if they contain a file that is in the archive. - - -
 
followLinks:Boolean (default = false) — Whether or not to follow a symbolic link and include the contents of the target - - file. By default, links are stored as links, but this can cause problems when unzipping on a Windows - - platform where a link turns into a file that just has contents being the relative path to the target - - file. If this is set to true, then any links are stored as the contents of the file that is linked to. - - -
-

-Returns - - - - -
ZipArchive — - The ZipArchive object with entries populated from the given folder. - - - - -
-
-Throws - - - - -
Error — The folder does not exist or another file error occurs within this operation. - - -
-
- - - - - -
extractFiles()method 
-
-public function extractFiles(folder:File):uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Extracts all of the entries from this zip archive onto the file system within the given folder. - - -

Parameters - - - - -
folder:File — The folder into which to create the unzipped files. - - -
-

-Returns - - - - -
uint — - The number of files extracted. - - - - -
-
-Throws - - - - -
Error — The folder does not exist or another file error occurs within this operation. - - -
-
- - - - - -
extractFilesAsync()method 
-
-public function extractFilesAsync(folder:File):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Extracts all of the entries from this zip archive onto the file system within the given folder. - - -

This operation is asynchronous and is performed mostly in a separate thread, with ProgressEvent - - events being dispatched whilst the operation is progressing and a Event.COMPLETE event being dispatched - - once it has finished. During this time, the ZipArchive object cannot be accessed or updated.

- - - Parameters - - - - -
folder:File — The folder into which to create the unzipped files. - - -
-
-Throws - - - - -
Error — The folder does not exist or another file error occurs within this operation. - - -
-
- - - - - -
findEntry()method 
-
-public function findEntry(entry:String):ZipEntry -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Find an entry in the archive using its name. - - -

Parameters - - - - -
entry:String — Relative path/filename for the entry to find. - - -
-

-Returns - - - - -
ZipEntry — - The ZipEntry object for this path, or null if no such entry was found. - - - - -
-
- - - - - -
load()method 
-
-public static function load(file:File):ZipArchive -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Creates a new ZipArchive object by loading in data from a file. - - -

Parameters - - - - -
file:File — The File object to open and read the zip information from. - - -
-

-Returns - - - - -
ZipArchive — - The ZipArchive object with entries populated from the zip file central directory. - - - - -
-
-Throws - - - - -
Error — The file does not exist or cannot be opened for reading; - - or if the file is not a valid Zip archive. - - -
-
- - - - - -
loadFromByteArray()method 
-
-public static function loadFromByteArray(data:ByteArray):ZipArchive -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Creates a new ZipArchive object by loading in data from a byte array. - - -

Parameters - - - - -
data:ByteArray — The ByteArray object that contains a valid zip archive. - - -
-

-Returns - - - - -
ZipArchive — - The ZipArchive object with entries populated from the zip central directory. - - - - -
-
-Throws - - - - -
Error — If the data is not a valid Zip archive. - - -
-
- - - - - -
removeEntry()method 
-
-public function removeEntry(entry:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Remove an entry from the archive using its name. - - -

Parameters - - - - -
entry:String — Relative path/filename for the entry to remove. - - -
-

-Returns - - - - -
Boolean — - True if the entry was found and removed, false if no such entry was found. - - - - -
-
- - - - - -
save()method 
-
-public function save(file:File):uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Saves a ZipArchive object to a file. - - -

Parameters - - - - -
file:File — The File object to save the zip archive to. Any existing file - - will be overwritten. - - -
-

-Returns - - - - -
uint — - The final size of the zip archive file. - - - - -
-
-Throws - - - - -
Error — The file cannot be opened for writing. - - -
-
- - - - - -
saveToByteArray()method 
-
-public function saveToByteArray(bytes:ByteArray):uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Saves a ZipArchive object to a byte array. - - -

Parameters - - - - -
bytes:ByteArray — The ByteArray object into which to write the zip archive data. - - Data will be written from the current position into the ByteArray which will be expanded - - as required to ensure it fits the zip archive content. - - -
-

-Returns - - - - -
uint — - The number of bytes of the zip archive that were written to the byte array. - - - - -
-
-
Event detail
- - - - - -
completeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Dispatched when an asynchronous zip/unzip operation has completed. - -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Dispatched during an asynchronous zip/unzip operation. - -

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -

-See also -

-
-ZipArchive.addFilesAsync() -
-ZipArchive.extractFilesAsync() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Sat Jan 11 2025, 8:30 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/air/utils/ZipEntry.html b/html-docs/air/utils/ZipEntry.html deleted file mode 100644 index c2aae42..0000000 --- a/html-docs/air/utils/ZipEntry.html +++ /dev/null @@ -1,1064 +0,0 @@ - - - - - - - - -air.utils.ZipEntry (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageair.utils
Classpublic class ZipEntry
InheritanceZipEntry Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 51 - -
-

-

- - The ZipEntry class is used to represent a single file within a zip archive. - - -

ZipEntry objects can be created from File or ByteArray objects, - - and contain settings that determine how they are then stored within a ZipArchive.

- - -

Since a ZipEntry object can be associated with multiple ZipArchive objects, - - care needs to be taken if the contents are changed. Generally it would be better practice to use - - different instances in different archives, so a clone() method is provided to create a - - new ZipEntry object as a copy of an existing one.

- - - -

Each entry in a zip archive is identified by a name which can include a series of folders, - - each folder name is separated using a forward-slash (/) character. Entries can either - - be stored, or compressed using the 'deflate' mechanism. The entry data is provided as a ByteArray - - object which is always uncompressed when in memory - i.e. the compression mechanism is only applied when - - the zip entry is being written into a zip archive. When reading a zip file, the data is only uncompressed - - when it is read (i.e. when the data property is first accessed).

- - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  compress : Boolean -
- - Whether or not the data will be compressed when it is stored into an archive.
-		ZipEntry
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  data : ByteArray -
- - The (raw/uncompressed) data contained within this zip entry.
-		ZipEntry
  flags : uint -
- - The external attribute flags for this zip entry.
-		ZipEntry
  modified : Date -
- - The 'last modified' date/time for this entry, which will determine the file - - time set on an entry if it is unzipped to a file.
-		ZipEntry
  name : String -
- - The name of the entry (including folder structure where required) - - -
-		ZipEntry
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ZipEntry(name:String, compress:Boolean = true)
-
- - Creates a new zip entry, with optional parameters to set the name and storage type.
-		ZipEntry
   -
-clone():ZipEntry -
-
- - Clones a zip entry to create a new object with the same settings/data, - - but with these efficiently copied so that the new object is independent.
-		ZipEntry
   -
-createFromFile(file:File, compress:Boolean):ZipEntry -
-
[static] - - Creates a zip entry based on a file from the file system.
-		ZipEntry
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  DIRECTORY : uint = 0x40000000
[static] - - Flag value for a directory entry - -
-		ZipEntry
  FILE : uint = 0x80000000
[static] - - Flag value for a file entry - -
-		ZipEntry
  GROUP_EXECUTE : uint = 0x00080000
[static] - - Flag value for group-execute permission - -
-		ZipEntry
  GROUP_READ : uint = 0x00200000
[static] - - Flag value for group-read permission - -
-		ZipEntry
  GROUP_WRITE : uint = 0x00100000
[static] - - Flag value for group-write permission - -
-		ZipEntry
  LINK : uint = 0x20000000
[static] - - Flag value for a symbolic link entry - -
-		ZipEntry
  OTHER_EXECUTE : uint = 0x00010000
[static] - - Flag value for other-execute permission - -
-		ZipEntry
  OTHER_READ : uint = 0x00040000
[static] - - Flag value for other-read permission - -
-		ZipEntry
  OTHER_WRITE : uint = 0x00020000
[static] - - Flag value for other-write permission - -
-		ZipEntry
  OWNER_EXECUTE : uint = 0x00400000
[static] - - Flag value for owner-execute permission - -
-		ZipEntry
  OWNER_READ : uint = 0x01000000
[static] - - Flag value for owner-read permission - -
-		ZipEntry
  OWNER_WRITE : uint = 0x00800000
[static] - - Flag value for owner-write permission - -
-		ZipEntry
-
- -
- -
Property detail
- - - - - -
compressproperty
-
-compress:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Whether or not the data will be compressed when it is stored into an archive. - -

Note that this doesn't give the status of the data when accessed via - - ActionScript: the byte array that you can access and manipulate via the - - data property is always the normal, uncompressed data. This flag - - just determines whether this data is compressed during the creation of a - - ZipArchive object when this is saved to a file/stream.

- - - Implementation -
-    public function get compress():Boolean -
-    public function set compress(value:Boolean):void -
-
- - - - - -
dataproperty 
-
-data:ByteArray  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - The (raw/uncompressed) data contained within this zip entry. - - -

Implementation -
-    public function get data():ByteArray -
-    public function set data(value:ByteArray):void -
-
- - - - - -
flagsproperty 
-
-flags:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - The external attribute flags for this zip entry. - -

These can be used to set file types and permissions, especially in order - - to create a symbolic link on operating systems that support this.

- - - Implementation -
-    public function get flags():uint -
-    public function set flags(value:uint):void -
-
- - - - - -
modifiedproperty 
-
-modified:Date  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - The 'last modified' date/time for this entry, which will determine the file - - time set on an entry if it is unzipped to a file. - -

This can be left as a null value, which would result in the operating system - - setting the last modified time as the point at which the file is created during - - an unzip operation. Or if set, this should result in the file modification date - - being set to this value once the file is unzipped.

- - - Implementation -
-    public function get modified():Date -
-    public function set modified(value:Date):void -
-
- - - - - -
nameproperty 
-
-name:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - The name of the entry (including folder structure where required) - - -

Implementation -
-    public function get name():String -
-    public function set name(value:String):void -
-
- -
Constructor detail
- - - - - -
ZipEntry()constructor
-
-public function ZipEntry(name:String, compress:Boolean = true) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Creates a new zip entry, with optional parameters to set the name and storage type. - - -

Parameters - - - - - - - - - - -
name:String
 
compress:Boolean (default = true)
-
- -
Method detail
- - - - - -
clone()method
-
-public function clone():ZipEntry -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Clones a zip entry to create a new object with the same settings/data, - - but with these efficiently copied so that the new object is independent. - - -

-Returns - - - - -
ZipEntry — - A new ZipEntry object with identical settings and data. - - - - -
-
- - - - - -
createFromFile()method 
-
-public static function createFromFile(file:File, compress:Boolean):ZipEntry -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Creates a zip entry based on a file from the file system. - - -

Parameters - - - - - - - - - - -
file:File
 
compress:Boolean
-

-Returns - - - - -
ZipEntry
-
- -
Constant detail
- - - - - -
DIRECTORYconstant
-
-public static const DIRECTORY:uint = 0x40000000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for a directory entry - -

- - - - - -
FILEconstant 
-
-public static const FILE:uint = 0x80000000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for a file entry - -

- - - - - -
GROUP_EXECUTEconstant 
-
-public static const GROUP_EXECUTE:uint = 0x00080000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for group-execute permission - -

- - - - - -
GROUP_READconstant 
-
-public static const GROUP_READ:uint = 0x00200000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for group-read permission - -

- - - - - -
GROUP_WRITEconstant 
-
-public static const GROUP_WRITE:uint = 0x00100000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for group-write permission - -

- - - - - -
LINKconstant 
-
-public static const LINK:uint = 0x20000000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for a symbolic link entry - -

- - - - - -
OTHER_EXECUTEconstant 
-
-public static const OTHER_EXECUTE:uint = 0x00010000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for other-execute permission - -

- - - - - -
OTHER_READconstant 
-
-public static const OTHER_READ:uint = 0x00040000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for other-read permission - -

- - - - - -
OTHER_WRITEconstant 
-
-public static const OTHER_WRITE:uint = 0x00020000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for other-write permission - -

- - - - - -
OWNER_EXECUTEconstant 
-
-public static const OWNER_EXECUTE:uint = 0x00400000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for owner-execute permission - -

- - - - - -
OWNER_READconstant 
-
-public static const OWNER_READ:uint = 0x01000000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for owner-read permission - -

- - - - - -
OWNER_WRITEconstant 
-
-public static const OWNER_WRITE:uint = 0x00800000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Flag value for owner-write permission - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Mar 21 2024, 10:06 AM GMT
Creative Commons License
-
- - - diff --git a/html-docs/air/utils/package-detail.html b/html-docs/air/utils/package-detail.html deleted file mode 100644 index db35e46..0000000 --- a/html-docs/air/utils/package-detail.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - -air.utils Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Classes
- - - - - - - - - - -
 ClassDescription
 ZipArchive - - The ZipArchive class is used to represent a zipped-up set of files in memory.
 ZipEntry - - The ZipEntry class is used to represent a single file within a zip archive.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
-
- - - diff --git a/html-docs/all-classes.html b/html-docs/all-classes.html deleted file mode 100644 index 1f9cfe5..0000000 --- a/html-docs/all-classes.html +++ /dev/null @@ -1,1665 +0,0 @@ - - - - - -All Classes - ActionScript 3.0 Language Reference - - - - - -

-All Classes -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AAAARecord
Accelerometer
AccelerometerEvent
Accessibility
AccessibilityImplementation
AccessibilityProperties
ActionScriptVersion
ActivityEvent
AntiAliasType
ApplicationDomain
ApplicationUpdater
ApplicationUpdaterUI
ARecord
ArgumentError
arguments
Array
AsyncErrorEvent
AudioDecoder
AudioDeviceManager
AudioOutputChangeEvent
AudioOutputChangeReason
AudioPlaybackMode
AuthenticationMethod
AutoCapitalize
AVM1Movie
BevelFilter
Bitmap
BitmapData
BitmapDataChannel
BitmapEncodingColorSpace
BitmapFilter
BitmapFilterQuality
BitmapFilterType
BlendMode
BlurFilter
Boolean
BreakOpportunity
BrowserInvokeEvent
ByteArray
Camera
CameraPosition
CameraRoll
CameraRollBrowseOptions
CameraUI
Capabilities
CapsStyle
CertificateStatus
CFFHinting
Class
Clipboard
ClipboardFormats
ClipboardTransferMode
Collator
CollatorMode
ColorCorrection
ColorCorrectionSupport
ColorMatrixFilter
ColorTransform
CompositionAttributeRange
CompressionAlgorithm
Condition
ContentElement
Context3D
Context3DBlendFactor
Context3DBufferUsage
Context3DClearMask
Context3DCompareMode
Context3DFillMode
Context3DMipFilter
Context3DProfile
Context3DProgramType
Context3DRenderMode
Context3DStencilAction
Context3DTextureFilter
Context3DTextureFormat
Context3DTriangleFace
Context3DVertexBufferFormat
Context3DWrapMode
ContextMenu
ContextMenuBuiltInItems
ContextMenuClipboardItems
ContextMenuEvent
ContextMenuItem
ConvolutionFilter
CSMSettings
CubeTexture
CurrencyFormatter
CurrencyParseResult
DataEvent
DatagramSocket
DatagramSocketDataEvent
Date
DateTimeFormatter
DateTimeNameContext
DateTimeNameStyle
DateTimeStyle
DefinitionError
DeviceRotation
DeviceRotationEvent
Dictionary
Digest
DigitCase
DigitWidth
DisplacementMapFilter
DisplacementMapFilterMode
DisplayObject
DisplayObjectContainer
DNSResolver
DNSResolverEvent
DockIcon
DownloadErrorEvent
DRMAuthenticateEvent
DRMAuthenticationCompleteEvent
DRMAuthenticationErrorEvent
DRMContentData
DRMDeviceGroup
DRMDeviceGroupErrorEvent
DRMDeviceGroupEvent
DRMErrorEvent
DRMLicenseRequestEvent
DRMManager
DRMManagerError
DRMPlaybackTimeWindow
DRMReturnVoucherCompleteEvent
DRMReturnVoucherErrorEvent
DRMStatusEvent
DRMVoucher
DropShadowFilter
EastAsianJustifier
ElementFormat
EncryptedLocalStore
Encryption
Endian
Error
ErrorEvent
EvalError
Event
EventDispatcher
EventPhase
ExtensionContext
ExtensionInfo
ExternalInterface
File
FileFilter
FileListEvent
FileMode
FileReference
FileReferenceList
FileStream
float
FocusDirection
FocusEvent
Font
FontDescription
FontLookup
FontMetrics
FontPosture
FontStyle
FontType
FontWeight
FrameLabel
FullScreenEvent
Function
GameInput
GameInputControl
GameInputDevice
GameInputEvent
Geolocation
GeolocationEvent
GestureEvent
GesturePhase
GlowFilter
GradientBevelFilter
GradientGlowFilter
GradientType
GraphicElement
Graphics
GraphicsBitmapFill
GraphicsEndFill
GraphicsGradientFill
GraphicsPath
GraphicsPathCommand
GraphicsPathWinding
GraphicsShaderFill
GraphicsSolidFill
GraphicsStroke
GraphicsTrianglePath
GridFitType
GroupElement
GroupSpecifier
H264Level
H264Profile
H264VideoStreamSettings
HostObject
HTMLHistoryItem
HTMLHost
HTMLLoader
HTMLPDFCapability
HTMLSWFCapability
HTMLUncaughtScriptExceptionEvent
HTMLWindowCreateOptions
HTTPStatusEvent
IBitmapDrawable
Icon
ID3Info
IDataInput
IDataOutput
IDynamicPropertyOutput
IDynamicPropertyWriter
IEventDispatcher
IExternalizable
IFilePromise
IGraphicsData
IGraphicsFill
IGraphicsPath
IGraphicsStroke
IIMEClient
ImageDecodingPolicy
IME
IMEConversionMode
IMEEvent
IndexBuffer3D
int
InteractiveIcon
InteractiveObject
InterfaceAddress
InterpolationMethod
InvalidSWFError
InvokeEvent
InvokeEventReason
IOErrorEvent
IPVersion
ISearchableText
ISimpleTextSelection
IURIDereferencer
JointStyle
JPEGEncoderOptions
JPEGLoaderContext
JPEGXREncoderOptions
JSON
JustificationStyle
Kerning
Keyboard
KeyboardEvent
KeyboardType
KeyLocation
LastOperationStatus
License
LigatureLevel
LineJustification
LineScaleMode
Loader
LoaderContext
LoaderInfo
LoadVoucherSetting
LocalConnection
LocaleID
LocationChangeEvent
Math
Matrix
Matrix3D
MediaEvent
MediaPromise
MediaType
MessageChannel
MessageChannelState
Microphone
MicrophoneEnhancedMode
MicrophoneEnhancedOptions
MorphShape
Mouse
MouseCursor
MouseCursorData
MouseEvent
MovieClip
Multitouch
MultitouchInputMode
Mutex
MXRecord
Namespace
NationalDigitsType
NativeApplication
NativeDragActions
NativeDragEvent
NativeDragManager
NativeDragOptions
NativeMenu
NativeMenuItem
NativeProcess
NativeProcessExitEvent
NativeProcessStartupInfo
NativeWindow
NativeWindowBoundsEvent
NativeWindowDisplayState
NativeWindowDisplayStateEvent
NativeWindowInitOptions
NativeWindowRenderMode
NativeWindowResize
NativeWindowSystemChrome
NativeWindowType
NetConnection
NetDataEvent
NetGroup
NetGroupInfo
NetGroupReceiveMode
NetGroupReplicationStrategy
NetGroupSendMode
NetGroupSendResult
NetMonitor
NetMonitorEvent
NetStatusEvent
NetStream
NetStreamAppendBytesAction
NetStreamInfo
NetStreamMulticastInfo
NetStreamPlayOptions
NetStreamPlayTransitions
NetworkInfo
NetworkInterface
NotificationStyle
NotificationType
Number
NumberFormatter
NumberParseResult
Object
ObjectEncoding
Orientation3D
OutputProgressEvent
PaperSize
PermissionError
PermissionEvent
PermissionManager
PermissionStatus
PerspectiveProjection
PixelSnapping
PNGEncoderOptions
Point
PressAndTapGestureEvent
PrintJob
PrintJobOptions
PrintJobOrientation
PrintMethod
PrintUIOptions
Program3D
ProgressEvent
Proxy
PTRRecord
QName
RangeError
Rectangle
RectangleTexture
ReferenceError
ReferencesValidationSetting
RegExp
RemoteNotificationEvent
RemoteNotifier
RemoteNotifierSubscribeOptions
RenderingMode
ResourceRecord
Responder
ReturnKeyLabel
RevocationCheckSettings
SampleDataEvent
Scene
Screen
ScreenMode
ScreenMouseEvent
ScriptTimeoutError
SecureSocket
Security
SecurityDomain
SecurityError
SecurityErrorEvent
SecurityPanel
ServerSocket
ServerSocketConnectEvent
Shader
ShaderData
ShaderEvent
ShaderFilter
ShaderInput
ShaderJob
ShaderParameter
ShaderParameterType
ShaderPrecision
Shape
SharedObject
SharedObjectFlushStatus
SignatureStatus
SignerTrustSettings
SimpleButton
Socket
SoftKeyboardEvent
SoftKeyboardTrigger
SoftKeyboardType
Sound
SoundChannel
SoundCodec
SoundLoaderContext
SoundMixer
SoundTransform
SpaceJustifier
SpreadMethod
Sprite
SQLCollationType
SQLColumnNameStyle
SQLColumnSchema
SQLConnection
SQLError
SQLErrorEvent
SQLErrorOperation
SQLEvent
SQLIndexSchema
SQLMode
SQLResult
SQLSchema
SQLSchemaResult
SQLStatement
SQLTableSchema
SQLTransactionLockType
SQLTriggerSchema
SQLUpdateEvent
SQLViewSchema
SRVRecord
StackOverflowError
Stage
Stage3D
StageAlign
StageAspectRatio
StageDisplayState
StageOrientation
StageOrientationEvent
StageQuality
StageScaleMode
StageText
StageTextClearButtonMode
StageTextContentType
StageTextInitOptions
StageVideo
StageVideoAvailability
StageVideoAvailabilityEvent
StageVideoAvailabilityReason
StageVideoEvent
StageWebView
StaticText
StatusEvent
StatusFileUpdateErrorEvent
StatusFileUpdateEvent
StatusUpdateErrorEvent
StatusUpdateEvent
StorageVolume
StorageVolumeChangeEvent
StorageVolumeInfo
String
StringTools
StyleSheet
SWFVersion
SyncEvent
SyntaxError
System
SystemIdleMode
SystemTrayIcon
SystemUpdater
SystemUpdaterType
TabAlignment
TabStop
Telemetry
TextBaseline
TextBlock
TextColorType
TextDisplayMode
TextElement
TextEvent
TextExtent
TextField
TextFieldAutoSize
TextFieldType
TextFormat
TextFormatAlign
TextInteractionMode
TextJustifier
TextLine
TextLineCreationResult
TextLineMetrics
TextLineMirrorRegion
TextLineValidity
TextRenderer
TextRotation
TextSnapshot
Texture
TextureBase
ThrottleEvent
ThrottleType
Timer
TimerEvent
TimeZone
TouchEvent
TouchEventIntent
TouchscreenType
Transform
TransformGestureEvent
TriangleCulling
TypeError
TypographicCase
uint
UncaughtErrorEvent
UncaughtErrorEvents
UpdateEvent
Updater
URIError
URLLoader
URLLoaderDataFormat
URLRequest
URLRequestDefaults
URLRequestHeader
URLRequestMethod
URLStream
URLVariables
Utils3D
Vector
Vector3D
VerifyError
VertexBuffer3D
Video
VideoCodec
VideoEvent
VideoStatus
VideoStreamSettings
VideoTexture
VideoTextureEvent
VoucherAccessInfo
VsyncStateChangeAvailabilityEvent
WebSocket
WebSocketEvent
WebViewDrawEvent
Worker
WorkerDomain
WorkerState
X500DistinguishedName
X509Certificate
XML
XMLDocument
XMLList
XMLNode
XMLNodeType
XMLSignatureValidator
XMLSocket
ZipArchive
ZipEntry
- - diff --git a/html-docs/all-index-A.html b/html-docs/all-index-A.html deleted file mode 100644 index 12e54d6..0000000 --- a/html-docs/all-index-A.html +++ /dev/null @@ -1,2703 +0,0 @@ - - - - - -A Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
a — Property in class flash.geom.Matrix
- - The value that affects the positioning of pixels - - along the x axis when scaling or rotating an image.
A — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the A key (65).
A4 — Constant static property in class flash.printing.PaperSize
- A4 - -
A5 — Constant static property in class flash.printing.PaperSize
- A5 - -
A6 — Constant static property in class flash.printing.PaperSize
- A6 - -
AAAARecord — Class in package flash.net.dns
- The AAAARecord class represents a Domain Name System (DNS) AAAA resource record containing an IPv6 address.
AAAARecord() — Constructor in class flash.net.dns.AAAARecord
- Creates an AAAA resource record.
abs(val:Number) — Static method in class Math
- - Computes and returns an absolute value for the number specified by the - - parameter val.
accDoDefaultAction(childID:uint) — Method in class flash.accessibility.AccessibilityImplementation
- An IAccessible method that performs the default action associated with the component - that this AccessibilityImplementation represents or of one of its child elements.
ACCELERATED — Constant static property in class flash.media.VideoStatus
- Indicates hardware-accelerated (GPU) video decoding.
accelerationX — Property in class flash.events.AccelerometerEvent
- Acceleration along the x-axis, measured in Gs.
accelerationY — Property in class flash.events.AccelerometerEvent
- Acceleration along the y-axis, measured in Gs.
accelerationZ — Property in class flash.events.AccelerometerEvent
- Acceleration along the z-axis, measured in Gs.
Accelerometer — Class in package flash.sensors
- The Accelerometer class dispatches events based on activity detected by the device's motion sensor.
Accelerometer() — Constructor in class flash.sensors.Accelerometer
- Creates a new Accelerometer instance.
AccelerometerEvent — Class in package flash.events
-The Accelerometer class dispatches AccelerometerEvent objects when acceleration updates are obtained from the Accelerometer sensor installed on the device.
AccelerometerEvent(type:String, bubbles:Boolean, cancelable:Boolean, timestamp:Number, accelerationX:Number, accelerationY:Number, accelerationZ:Number) — Constructor in class flash.events.AccelerometerEvent
- Creates an AccelerometerEvent object that contains information about acceleration along three dimensional axis.
acceptDragDrop(target:flash.display:InteractiveObject) — Static method in class flash.desktop.NativeDragManager
- Informs the NativeDragManager object that the specified target interactive object can accept a drop - corresponding to the current drag event.
Accessibility — Final class in package flash.accessibility
- The Accessibility class manages communication with screen readers.
accessibilityImplementation — Property in class flash.display.InteractiveObject
- - The current accessibility implementation (AccessibilityImplementation) - - for this InteractiveObject instance.
AccessibilityImplementation — Class in package flash.accessibility
- - The AccessibilityImplementation class is the base class in Flash Player - that allows for the implementation of accessibility in components.
AccessibilityImplementation() — Constructor in class flash.accessibility.AccessibilityImplementation
- Static constructor.
accessibilityProperties — Property in class flash.display.DisplayObject
- - The current accessibility options for this display object.
AccessibilityProperties — Class in package flash.accessibility
- The AccessibilityProperties class lets you control the presentation of Flash objects to accessibility - aids, such as screen readers.
AccessibilityProperties() — Constructor in class flash.accessibility.AccessibilityProperties
- Creates a new AccessibilityProperties object.
accLocation(childID:uint) — Method in class flash.accessibility.AccessibilityImplementation
- MSAA method for returning a DisplayObject or Rectangle - specifying the bounding box of a child element in the AccessibilityImplementation.
accSelect(operation:uint, childID:uint) — Method in class flash.accessibility.AccessibilityImplementation
- IAccessible method for altering the selection in the component - that this AccessibilityImplementation represents.
acos(val:Number) — Static method in class Math
- - Computes and returns the arc cosine of the number specified in the - - parameter val, in radians.
ACTIONSCRIPT2 — Constant static property in class flash.display.ActionScriptVersion
- ActionScript language version 2.0 and earlier.
ACTIONSCRIPT3 — Constant static property in class flash.display.ActionScriptVersion
- ActionScript language version 3.0.
actionScriptData — Property in class flash.external.ExtensionContext
- - The ActionScript object, if any, associated with this context.
actionScriptVersion — Property in class flash.display.LoaderInfo
- The ActionScript version of the loaded SWF file.
ActionScriptVersion — Final class in package flash.display
- The ActionScriptVersion class is an enumeration of constant values that - indicate the language version of a loaded SWF file.
activate — Event in class flash.desktop.NativeApplication
- - Dispatched when this application becomes the active desktop application.
activate(window:flash.display:NativeWindow) — Method in class flash.desktop.NativeApplication
- - Activates this application.
activate — Event in class flash.display.NativeWindow
- - Dispatched by this NativeWindow object after the window has been activated.
activate() — Method in class flash.display.NativeWindow
- - Activates this window.
activate — Event in class flash.events.EventDispatcher
- [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.
ACTIVATE — Constant static property in class flash.events.Event
- The ACTIVATE constant defines the value of the type property of an activate event object.
activating — Property in class flash.events.ActivityEvent
- Indicates whether the device is activating (true) or deactivating - (false).
active — Static property in class flash.accessibility.Accessibility
- Indicates whether a screen reader is active and the application is - communicating with it.
active — Property in class flash.display.NativeWindow
- - Indicates whether this window is the active application window.
active — Property in class flash.net.NetworkInterface
- Reports whether this interface is active.
active — Static property in class flash.printing.PrintJob
- Indicates whether a print job is currently active.
activeWindow — Property in class flash.desktop.NativeApplication
- - The active application window.
activity — Event in class flash.media.Camera
- - Dispatched when a camera begins or ends a session.
activity — Event in class flash.media.Microphone
- Dispatched when a microphone starts or stops recording due to detected silence.
ACTIVITY — Constant static property in class flash.events.ActivityEvent
- The ActivityEvent.ACTIVITY constant defines the value of the type property of an activity event object.
ActivityEvent — Class in package flash.events
-A Camera or Microphone object dispatches an ActivityEvent object whenever a camera or microphone reports that it has -become active or inactive.
ActivityEvent(type:String, bubbles:Boolean, cancelable:Boolean, activating:Boolean) — Constructor in class flash.events.ActivityEvent
- Creates an event object that contains information about activity events.
activityLevel — Property in class flash.media.Camera
- - The amount of motion the camera is detecting.
activityLevel — Property in class flash.media.Microphone
- The amount of sound the microphone is detecting.
actualLocaleIDName — Property in class flash.globalization.Collator
- The name of the actual locale ID used by this Collator object.
actualLocaleIDName — Property in class flash.globalization.CurrencyFormatter
- The name of the actual locale ID used by this CurrencyFormatter object.
actualLocaleIDName — Property in class flash.globalization.DateTimeFormatter
- The name of the actual locale ID used by this DateTimeFormatter object.
actualLocaleIDName — Property in class flash.globalization.NumberFormatter
- The name of the actual locale ID used by this NumberFormatter object.
actualLocaleIDName — Property in class flash.globalization.StringTools
- The name of the actual locale ID used by this StringTools object.
add(v:flash.geom:Point) — Method in class flash.geom.Point
- Adds the coordinates of another point to the coordinates of this point to create a new point.
add(a:flash.geom:Vector3D) — Method in class flash.geom.Vector3D
- Adds the value of the x, y, and z elements of the current Vector3D object - to the values of the x, y, and z elements of another Vector3D object.
ADD — Constant static property in class flash.display.BlendMode
-Adds the values of the constituent colors of the display object to the colors of its background, applying a -ceiling of 0xFF.
addBinaryChainBuildingCertificate(certificate:flash.utils:ByteArray, trusted:Boolean) — Method in class flash.net.SecureSocket
- - Adds an X.509 certificate to the local certificate chain that your system uses for validating the server certificate.
addBitmapData(bitmapData:flash.display:BitmapData) — Method in class flash.media.CameraRoll
- Adds an image to the device camera roll.
addBootstrapPeer(peerID:String) — Method in class flash.net.GroupSpecifier
- Causes the associated NetStream or NetGroup to make an initial neighbor connection to the - specified peerID.
addCallback(functionName:String, closure:Function) — Static method in class flash.external.ExternalInterface
- Registers an ActionScript method as callable from the container.
addCertificate(cert:flash.utils:ByteArray, trusted:Boolean) — Method in class flash.security.XMLSignatureValidator
- Adds an x509 certificate for chain building.
addChild(child:flash.display:DisplayObject) — Method in class flash.display.DisplayObjectContainer
- Adds a child DisplayObject instance to this DisplayObjectContainer instance.
addChild(child:flash.display:DisplayObject) — Method in class flash.display.Stage
- Adds a child DisplayObject instance to this DisplayObjectContainer instance.
addChildAt(child:flash.display:DisplayObject, index:int) — Method in class flash.display.DisplayObjectContainer
- Adds a child DisplayObject instance to this DisplayObjectContainer - instance.
addChildAt(child:flash.display:DisplayObject, index:int) — Method in class flash.display.Stage
- Adds a child DisplayObject instance to this DisplayObjectContainer - instance.
added — Event in class flash.display.DisplayObject
- - Dispatched when a display object is added to the display list.
ADDED — Constant static property in class flash.events.Event
- The Event.ADDED constant defines the value of the type property of - an added event object.
addedToStage — Event in class flash.display.DisplayObject
- - 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.
ADDED_TO_STAGE — Constant static property in class flash.events.Event
- The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
addEventListener(type:String, listener:Function, useCapture:Boolean, priority:int, useWeakReference:Boolean) — Method in class flash.data.SQLConnection
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
addEventListener(type:String, listener:Function, useCapture:Boolean, priority:int, useWeakReference:Boolean) — Method in class flash.desktop.NativeApplication
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
addEventListener(type:String, listener:Function, useCapture:Boolean, priority:int, useWeakReference:Boolean) — Method in class flash.display.Stage
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
addEventListener(type:String, listener:Function, useCapture:Boolean, priority:int, useWeakReference:Boolean) — Method in class flash.events.EventDispatcher
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
addEventListener(type:String, listener:Function, useCapture:Boolean, priority:int, useWeakReference:Boolean) — Method in interface flash.events.IEventDispatcher
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
addEventListener(type:String, listener:Function, useCapture:Boolean, priority:int, useWeakReference:Boolean) — Method in class flash.net.URLLoader
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
addEventListener(type:String, listener:Function, useCapture:Boolean, priority:int, useWeakReference:Boolean) — Method in class flash.system.MessageChannel
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
addEventListener(type:String, listener:Function, useCapture:Boolean, priority:int, useWeakReference:Boolean) — Method in class flash.system.Worker
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
addFilesAsync(folder:flash.filesystem:File, recurse:Boolean, compress:Boolean, includeFolderEntries:Boolean, followLinks:Boolean) — Method in class air.utils.ZipArchive
- - Modifies an existing ZipArchive object by adding all files within a folder.
addHaveObjects(startIndex:Number, endIndex:Number) — Method in class flash.net.NetGroup
- Adds objects from startIndex through endIndex, to the set of objects this node - advertises to neighbors as objects for which it fulfills requests.
addHeader(operation:String, mustUnderstand:Boolean, param:Object) — Method in class flash.net.NetConnection
- Adds a context header to the Action Message Format (AMF) packet structure.
addIPMulticastAddress(address:String, port, source:String) — Method in class flash.net.GroupSpecifier
- Causes the associated NetStream or NetGroup to join the specified IP multicast group and listen - to the specified UDP port.
addItem(item:flash.display:NativeMenuItem) — Method in class flash.display.NativeMenu
- - Adds a menu item at the bottom of the menu.
addItemAt(item:flash.display:NativeMenuItem, index:int) — Method in class flash.display.NativeMenu
- - Inserts a menu item at the specified position.
addItemAt(item:flash.display:NativeMenuItem, index:int) — Method in class flash.ui.ContextMenu
- Adds a menu item at the bottom of the menu.
addMemberHint(peerID:String) — Method in class flash.net.NetGroup
- Manually adds a record specifying that peerID is a member of the group.
addNamespace(ns:Object) — Method in class XML
- - Adds a namespace to the set of in-scope namespaces for the XML object.
addNeighbor(peerID:String) — Method in class flash.net.NetGroup
- Manually adds a neighbor by immediately connecting directly to the specified peerID, which must already be - in this group.
addPage(sprite:flash.display:Sprite, printArea:flash.geom:Rectangle, options:flash.printing:PrintJobOptions, frameNum:int) — Method in class flash.printing.PrintJob
- Sends the specified Sprite object as a single page to the print spooler.
addResources(lang:String, res:Object) — Method in class air.update.ApplicationUpdaterUI
- - Dynamically adds a new resource bundle for the specified language.
address — Property in class flash.net.InterfaceAddress
- The Internet Protocol (IP) address.
address — Property in class flash.net.dns.AAAARecord
- The IPv6 address.
address — Property in class flash.net.dns.ARecord
- The IPv4 address.
ADDRESS — Constant static property in class flash.text.StageTextContentType
- -

Content is an address

- - - -
addresses — Property in class flash.net.NetworkInterface
- The list of the addresses bound to this network interface.
addSubmenu(submenu:flash.display:NativeMenu, label:String) — Method in class flash.display.NativeMenu
- - Adds a submenu to the menu by inserting a new menu item.
addSubmenuAt(submenu:flash.display:NativeMenu, index:int, label:String) — Method in class flash.display.NativeMenu
- - Adds a submenu to the menu by inserting a new menu item at the - - specified position.
addToDeviceGroup(deviceGroup:flash.net.drm:DRMDeviceGroup, forceRefresh:Boolean) — Method in class flash.net.drm.DRMManager
- adds the currently running device to a device group.
ADD_TO_DEVICE_GROUP_COMPLETE — Constant static property in class flash.events.DRMDeviceGroupEvent
ADD_TO_DEVICE_GROUP_ERROR — Constant static property in class flash.events.DRMDeviceGroupErrorEvent
addToOutput(v:flash.geom:Point, output:flash.geom:Point) — Method in class flash.geom.Point
- Adds the coordinates of another point to the coordinates of this point to create a new point.
addToOutput(a:flash.geom:Vector3D, output:flash.geom:Vector3D) — Method in class flash.geom.Vector3D
- Adds the value of the x, y, and z elements of the current Vector3D object - to the values of the x, y, and z elements of another Vector3D object.
addWantObjects(startIndex:Number, endIndex:Number) — Method in class flash.net.NetGroup
- Adds objects from startIndex through endIndex, to the set of objects to retrieve.
ADVANCED — Constant static property in class flash.text.AntiAliasType
- Sets anti-aliasing to advanced anti-aliasing.
afterBounds — Property in class flash.events.NativeWindowBoundsEvent
- The bounds of the window after the change.
afterDisplayState — Property in class flash.events.NativeWindowDisplayStateEvent
- The display state of the NativeWindow after the change.
afterOrientation — Property in class flash.events.StageOrientationEvent
- The orientation of the stage after the change.
air.net — Package
The air.net package contains classes for network detection. This package is only available to content running in the AIR runtime. It is included in the ServiceMonitor.swc file (for SWF-based application developers) and ServiceMonitor.swf file (for HTML-based AIR application developers).
air.security — Package
air.system — Package
air.update — Package
The air.update package contains classes for updating AIR applications.
air.update.events — Package
The air.update.events package contains classes that define events used by the AIR application update framework.
air.utils — Package
album — Property in class flash.media.ID3Info
- The name of the album; corresponds to the ID3 2.0 tag TALB.
ALERT — Constant static property in class flash.notifications.NotificationStyle
- A notification style to display an alert box upon receiving a notification.
align — Property in class flash.display.Stage
- A value from the StageAlign class that specifies the alignment of the stage in - Flash Player or the browser.
align — Property in class flash.text.TextFormat
- Indicates the alignment of the paragraph.
alignment — Property in class flash.text.engine.TabStop
- Specifies the tab alignment for this tab stop.
alignmentBaseline — Property in class flash.text.engine.ElementFormat
- Specifies the type of baseline in the containing element to which to align the dominant baselines of elements having - this format.
ALL — Constant static property in class flash.display3D.Context3DClearMask
- Clear all buffers.
ALL — Constant static property in class flash.events.GesturePhase
- A single value that encompasses all phases of simple gestures like two-finger-tap or swipe.
ALL — Constant static property in class flash.text.AutoCapitalize
- Capitalize every character.
ALL — Constant static property in class flash.text.engine.BreakOpportunity
- Treats all characters in the ContentElement object as line break opportunities, meaning that a line break will occur - afer each character.
ALL_BUT_LAST — Constant static property in class flash.text.engine.LineJustification
- Justify all but the last line.
ALL_BUT_MANDATORY_BREAK — Constant static property in class flash.text.engine.LineJustification
- Justify all but the last line and lines ending in mandatory breaks.
ALL_INCLUDING_LAST — Constant static property in class flash.text.engine.LineJustification
- Justify all lines.
allowCodeImport — Property in class flash.system.LoaderContext
- Specifies whether you can use a Loader object to import content with executable code, - such as a SWF file, into the caller's security sandbox.
allowCopy — Property in class flash.desktop.NativeDragOptions
- A drop target is allowed to copy the dragged data.
allowDomain(... rest) — Method in class flash.net.LocalConnection
- Specifies one or more domains that can send LocalConnection calls to this LocalConnection instance.
allowDomain(... rest) — Static method in class flash.system.Security
- Lets SWF files in the identified domains access objects and variables - in the SWF file that contains the allowDomain() call.
allowedActions — Property in class flash.events.NativeDragEvent
- The NativeDragOptions object specifying the actions that are allowed by the - display object that initiated this drag operation.
allowedDomains — Property in class flash.text.TextField
- - Feature to allow applications to specify approved domains from which AIR will load images.
allowInsecureDomain(... rest) — Method in class flash.net.LocalConnection
- Specifies one or more domains that can send LocalConnection calls to this LocalConnection object.
allowInsecureDomain(... rest) — Static method in class flash.system.Security
- Lets SWF files and HTML files in the identified domains access objects - and variables in the calling SWF file, which is hosted by means of the HTTPS protocol.
allowLink — Property in class flash.desktop.NativeDragOptions
- A drop target is allowed to create a link to the dragged data.
allowLoadBytesCodeExecution — Property in class flash.system.LoaderContext
- Legacy property, replaced by allowCodeImport, but still supported for compatibility.
allowMove — Property in class flash.desktop.NativeDragOptions
- A drop target is allowed to move the dragged data.
allowNull — Property in class flash.data.SQLColumnSchema
- Indicates whether NULL values are allowed in this column.
ALLOW_SERVER — Constant static property in class flash.net.drm.LoadVoucherSetting
- Loads the voucher from the local cache, if possible; downloads the voucher from a media rights server - only if a locally cached copy does not exist.
allowsFullScreen — Property in class flash.display.Stage
- Specifies whether this stage allows the use of the full screen mode -
allowsFullScreenInteractive — Property in class flash.display.Stage
- Specifies whether this stage allows the use of the full screen with text input mode -
alpha — Property in class flash.display.DisplayObject
- - Indicates the alpha transparency value of the object specified.
alpha — Property in class flash.display.GraphicsSolidFill
- Indicates the alpha transparency value of the fill.
alpha — Property in class flash.filters.ConvolutionFilter
- The alpha transparency value of the substitute color.
alpha — Property in class flash.filters.DisplacementMapFilter
- Specifies the alpha transparency value to use for out-of-bounds displacements.
alpha — Property in class flash.filters.DropShadowFilter
- The alpha transparency value for the shadow color.
alpha — Property in class flash.filters.GlowFilter
- The alpha transparency value for the color.
alpha — Property in class flash.text.engine.ElementFormat
- Specifies the transparency of the line elements affected by this obect.
ALPHA — Constant static property in class flash.display.BitmapDataChannel
- The alpha channel.
ALPHA — Constant static property in class flash.display.BlendMode
-Applies the alpha value of each pixel of the display object to the background.
alphaMultiplier — Property in class flash.geom.ColorTransform
- A decimal value that is multiplied with the alpha transparency channel value.
ALPHANUMERIC — Constant static property in class flash.ui.KeyboardType
- A standard keyboard with a full set of numbers and letters.
ALPHANUMERIC_FULL — Constant static property in class flash.system.IMEConversionMode
- The string "ALPHANUMERIC_FULL", for use with the - IME.conversionMode property.
ALPHANUMERIC_HALF — Constant static property in class flash.system.IMEConversionMode
- The string "ALPHANUMERIC_HALF", for use with the - IME.conversionMode property.
alphaOffset — Property in class flash.geom.ColorTransform
- A number from -255 to 255 that is added to the alpha transparency channel value after it has - been multiplied by the alphaMultiplier value.
alphas — Property in class flash.display.GraphicsGradientFill
- An array of alpha values for the corresponding colors in the colors array.
alphas — Property in class flash.filters.GradientBevelFilter
- An array of alpha transparency values for the corresponding colors in the - colors array.
alphas — Property in class flash.filters.GradientGlowFilter
- An array of alpha transparency values for the corresponding colors in - the colors array.
ALTERNATE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Alternate (Option) key (18).
altitude — Property in class flash.events.GeolocationEvent
- The altitude in meters.
altKey — Property in class flash.events.GestureEvent
- Indicates whether the Alt key is active (true) or inactive (false).
altKey — Property in class flash.events.KeyboardEvent
- - Indicates whether the Alt key is active (true) or inactive (false) on Windows; - - indicates whether the Option key is active on Mac OS.
altKey — Property in class flash.events.MouseEvent
- - Indicates whether the Alt key is active (true) or inactive (false).
altKey — Property in class flash.events.TouchEvent
- Indicates whether the Alt key is active (true) or inactive (false).
ALWAYS — Constant static property in class flash.display.PixelSnapping
- A constant value used in the pixelSnapping property of a Bitmap object - to specify that the bitmap image is always snapped to the nearest - pixel, independent of any transformation.
ALWAYS — Constant static property in class flash.display3D.Context3DCompareMode
- The comparison always evaluates as true.
ALWAYS — Constant static property in class flash.text.StageTextClearButtonMode
- StageText clearButton is always shown -
alwaysInFront — Property in class flash.display.NativeWindow
- - Specifies whether this window will always be in front of other windows (including - - those of other applications).
ALWAYS_REQUIRED — Constant static property in class flash.security.RevocationCheckSettings
- Always check certificate revocation.
alwaysShowSelection — Property in class flash.text.TextField
- - When set to true and the text field is not in focus, Flash Player highlights the - - selection in the text field in gray.
AMBIENT — Constant static property in class flash.media.AudioPlaybackMode
- A mode for playing ambient sound.
AMF0 — Constant static property in class flash.net.ObjectEncoding
- - Specifies that objects are serialized using the Action Message Format for ActionScript 1.0 and 2.0.
AMF3 — Constant static property in class flash.net.ObjectEncoding
- - Specifies that objects are serialized using the Action Message Format for ActionScript 3.0.
analyze — Event in class flash.data.SQLConnection
- Dispatched when an analyze() operation - completes successfully.
analyze(resourceName:String, responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Gathers statistics about database indices and - stores them in the database.
ANALYZE — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.analyze() method was called.
ANALYZE — Constant static property in class flash.events.SQLEvent
- The SQLEvent.ANALYZE constant defines the value of the - type property of an analyze event object.
angle — Property in class flash.filters.BevelFilter
- The angle of the bevel.
angle — Property in class flash.filters.DropShadowFilter
- The angle of the shadow.
angle — Property in class flash.filters.GradientBevelFilter
- The angle, in degrees.
angle — Property in class flash.filters.GradientGlowFilter
- The angle, in degrees.
angleBetween(a:flash.geom:Vector3D, b:flash.geom:Vector3D) — Static method in class flash.geom.Vector3D
- Returns the angle in radians between two vectors.
ANISOTROPIC16X — Constant static property in class flash.display3D.Context3DTextureFilter
- Use anisotropic filter with radio 16 when upsampling textures - -
ANISOTROPIC2X — Constant static property in class flash.display3D.Context3DTextureFilter
- Use anisotropic filter with radio 2 when upsampling textures - -
ANISOTROPIC4X — Constant static property in class flash.display3D.Context3DTextureFilter
- Use anisotropic filter with radio 4 when upsampling textures - -
ANISOTROPIC8X — Constant static property in class flash.display3D.Context3DTextureFilter
- Use anisotropic filter with radio 8 when upsampling textures - -
ANONYMOUS — Constant static property in class flash.net.drm.AuthenticationMethod
- Indicates that no authentication is required.
antiAliasType — Property in class flash.text.TextField
- - The type of anti-aliasing used for this text field.
AntiAliasType — Final class in package flash.text
-The AntiAliasType class provides values for anti-aliasing in the flash.text.TextField class.
ANY — Constant static property in class flash.display.StageAspectRatio
- Specifies a device orientation that supports both portrait and landscape UI.
ANY — Constant static property in class flash.text.engine.BreakOpportunity
- Treats any character in the ContentElement object as a line break opportunity.
append(lhs:flash.geom:Matrix3D) — Method in class flash.geom.Matrix3D
- Appends the matrix by multiplying another Matrix3D object by the current Matrix3D object.
APPEND — Constant static property in class flash.filesystem.FileMode
- Used for a file to be opened in write mode, with all written data appended to the end of the file.
APPEND — Constant static property in class flash.net.NetStreamPlayTransitions
- - Adds the stream to a playlist and begins playback with the first stream.
APPEND_AND_WAIT — Constant static property in class flash.net.NetStreamPlayTransitions
- - Builds a playlist without starting to play it from the first stream.
appendBytes(bytes:flash.utils:ByteArray) — Method in class flash.net.NetStream
- Passes a ByteArray into a NetStream for playout.
appendBytesAction(netStreamAppendBytesAction:String) — Method in class flash.net.NetStream
- Indicates a timescale discontinuity, flushes the FIFO, and tells the byte parser to expect a file header or the beginning of an FLV tag.
appendChild(child:Object) — Method in class XML
- - Appends the given child to the end of the XML object's properties.
appendChild(node:flash.xml:XMLNode) — Method in class flash.xml.XMLNode
- - Appends the specified node to the XML object's child list.
appendRotation(degrees:Number, axis:flash.geom:Vector3D, pivotPoint:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Appends an incremental rotation to a Matrix3D object.
appendScale(xScale:Number, yScale:Number, zScale:Number) — Method in class flash.geom.Matrix3D
- Appends an incremental scale change along the x, y, and z axes - to a Matrix3D object.
appendText(newText:String) — Method in class flash.text.TextField
- - Appends the string specified by the newText parameter to the end of the text - - of the text field.
appendTranslation(x:Number, y:Number, z:Number) — Method in class flash.geom.Matrix3D
- Appends an incremental translation, a repositioning along the x, y, and z axes, - to a Matrix3D object.
APPLICATION — Constant static property in class flash.system.Security
- The file is running in an AIR application, and it was installed with the package (the AIR file) for that - application.
applicationDescriptor — Property in class flash.desktop.NativeApplication
- - The contents of the application descriptor file for this AIR application.
applicationDirectory — Static property in class flash.filesystem.File
- - The folder containing the application's installed files.
applicationDomain — Property in class flash.display.LoaderInfo
- When an external SWF file is loaded, all ActionScript 3.0 definitions contained in the loaded - class are stored in the applicationDomain property.
applicationDomain — Property in class flash.system.LoaderContext
- Specifies the application domain to use for the Loader.load() or - Loader.loadBytes() method.
ApplicationDomain — Final class in package flash.system
- The ApplicationDomain class is a container for discrete groups of class definitions.
ApplicationDomain(parentDomain:flash.system:ApplicationDomain) — Constructor in class flash.system.ApplicationDomain
- Creates a new application domain.
applicationID — Property in class flash.desktop.NativeApplication
- - The application ID of this application.
applicationRemovableStorageDirectory — Static property in class flash.filesystem.File
- - The application's private storage directory on an external and removable device, if present.
applicationStorageDirectory — Static property in class flash.filesystem.File
- - The application's private storage directory.
ApplicationUpdater — Class in package air.update
- - The ApplicationUpdater class defines the basic functionality of the update framework for - - Adobe® AIR® applications, without providing any default user interface.
ApplicationUpdater() — Constructor in class air.update.ApplicationUpdater
- - The constructor function.
ApplicationUpdaterUI — Class in package air.update
- - The ApplicationUpdaterUI class defines the basic functionality of the update framework for - - Adobe® AIR® applications, and it provides a default user interface.
ApplicationUpdaterUI() — Constructor in class air.update.ApplicationUpdaterUI
- - The constructor function.
apply(thisArg, argArray) — Method in class Function
- - Specifies the value of thisObject to be used within any function that ActionScript calls.
applyFilter(sourceBitmapData:flash.display:BitmapData, sourceRect:flash.geom:Rectangle, destPoint:flash.geom:Point, filter:flash.filters:BitmapFilter) — Method in class flash.display.BitmapData
- - Takes a source image and a filter object and generates the - - filtered image.
applyNonLinearFontScaling — Property in class flash.text.engine.TextBlock
- Specifies that you want to enhance screen appearance at the expense of what-you-see-is-what-you-get (WYSIWYG) print fidelity.
ARABIC_INDIC — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Arabic-Indic digit set.
ARecord — Class in package flash.net.dns
- The ARecord class represents a Domain Name System (DNS) A resource record containing an IPv4 address.
ARecord() — Constructor in class flash.net.dns.ARecord
- Creates an A resource record.
areInaccessibleObjectsUnderPoint(point:flash.geom:Point) — Method in class flash.display.DisplayObjectContainer
- Indicates whether the security restrictions - would cause any display objects to be omitted from the list returned by calling - the DisplayObjectContainer.getObjectsUnderPoint() method - with the specified point point.
areSoundsInaccessible() — Static method in class flash.media.SoundMixer
- Determines whether any sounds are not accessible due to security restrictions.
ArgumentError — Dynamic class in Top Level
- - The ArgumentError class represents an error that occurs when the arguments - - supplied in a function do not match the arguments defined for - - that function.
ArgumentError(message:String) — Constructor in class ArgumentError
- - Creates an ArgumentError object.
arguments — Class in Top Level
- - An arguments object is used to store and access a function's arguments.
arguments — Property in class flash.desktop.NativeProcessStartupInfo
- The command line arguments that will be passed to the process on startup.
arguments — Property in class flash.events.BrowserInvokeEvent
- An array of arguments (strings) to pass to the application.
arguments — Property in class flash.events.InvokeEvent
- The array of string arguments passed during this invocation.
Array — Dynamic class in Top Level
- - The Array class lets you access and manipulate arrays.
Array(... rest) — Package function in Top Level
- - Creates a new array.
Array(numElements:int) — Constructor in class Array
- - Lets you create an array of the specified number of elements.
Array(... rest) — Constructor in class Array
- - Lets you create an array that contains the specified elements.
ARROW — Constant static property in class flash.ui.MouseCursor
- Used to specify that the arrow cursor should be used.
artist — Property in class flash.media.ID3Info
- The name of the artist; corresponds to the ID3 2.0 tag TPE1.
as — Operator
Evaluates whether an expression specified by the first operand is a member of the data type specified by the second operand.
AS3 — Statement
Defines methods and properties of the core ActionScript classes that are fixed properties instead of prototype properties.
ascent — Property in class flash.text.TextExtent
ascent — Property in class flash.text.TextLineMetrics
- The ascent value of the text is the length from the baseline to the top of the line height in pixels.
ascent — Property in class flash.text.engine.TextLine
- Specifies the number of pixels from the baseline to the top of the tallest characters in the line.
ASCENT — Constant static property in class flash.text.engine.TextBaseline
- Specifies an ascent baseline.
asin(val:Number) — Static method in class Math
- - Computes and returns the arc sine for the number specified in the - - parameter val, in radians.
assignFocus(objectToFocus:flash.display:InteractiveObject, direction:String) — Method in class flash.display.Stage
- Sets keyboard focus to the interactive object specified by objectToFocus, with - the focus direction specified by the direction parameter.
assignFocus(direction:String) — Method in class flash.media.StageWebView
- - Assigns focus to the content within this StageWebView object.
assignFocus() — Method in class flash.text.StageText
- - Assigns focus to the StageText object.
asyncError — Event in class flash.net.LocalConnection
- Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code.
asyncError — Event in class flash.net.NetConnection
- Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code.
asyncError — Event in class flash.net.NetStream
- Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code.
asyncError — Event in class flash.net.SharedObject
- Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code.
ASYNC_ERROR — Constant static property in class flash.events.AsyncErrorEvent
- The AsyncErrorEvent.ASYNC_ERROR constant defines the value of the - type property of an asyncError event object.
AsyncErrorEvent — Class in package flash.events
- An object dispatches an AsyncErrorEvent when an exception is thrown from native - asynchronous code, which could be from, for example, LocalConnection, NetConnection, - SharedObject, or NetStream.
AsyncErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, text:String, error:Error) — Constructor in class flash.events.AsyncErrorEvent
- Creates an AsyncErrorEvent object that contains information about asyncError events.
atan(val:Number) — Static method in class Math
- - Computes and returns the value, in radians, of the angle whose tangent is - - specified in the parameter val.
atan2(y:Number, x:Number) — Static method in class Math
- - Computes and returns the angle of the point y/x in - - radians, when measured counterclockwise from a circle's x axis - - (where 0,0 represents the center of the circle).
atomCount — Property in class flash.text.engine.TextLine
- The number of atoms in the line, which is the number of indivisible elements, including spaces and graphic - elements.
atomicCompareAndSwapIntAt(byteIndex:int, expectedValue:int, newValue:int) — Method in class flash.utils.ByteArray
- - Atomic compare and swap of integer values in adjacent bytes in this byte array.
atomicCompareAndSwapLength(expectedLength:int, newLength:int) — Method in class flash.utils.ByteArray
- - Atomic compare and change the length of this byte array.
attach — Event in class flash.data.SQLConnection
- Dispatched when an attach() method call's operation - completes successfully.
attach(name:String, reference:Object, responder:flash.net:Responder, encryptionKey:flash.utils:ByteArray) — Method in class flash.data.SQLConnection
- Adds another database to the SQLConnection instance, giving the new database - the specified name.
attach(connection:flash.net:NetConnection) — Method in class flash.net.NetStream
- Attaches a stream to a new NetConnection object.
ATTACH — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.attach() method was called.
ATTACH — Constant static property in class flash.events.SQLEvent
- The SQLEvent.ATTACH constant defines the value of the - type property of an attach event object.
attachAudio(microphone:flash.media:Microphone) — Method in class flash.net.NetStream
- Attaches an audio stream to a NetStream object from a Microphone - object passed as the source.
attachCamera(theCamera:flash.media:Camera) — Method in class flash.display3D.textures.VideoTexture
- Specifies a video stream from a camera to be rendered within the texture of the VideoTexture object.
attachCamera(theCamera:flash.media:Camera) — Method in class flash.media.StageVideo
- Specifies a video stream from a camera to be displayed - within the boundaries of the StageVideo object in the application, leveraging the GPU for rendering.
attachCamera(camera:flash.media:Camera) — Method in class flash.media.Video
- Specifies a video stream from a camera to be displayed - within the boundaries of the Video object in the application.
attachCamera(theCamera:flash.media:Camera, snapshotMilliseconds:int) — Method in class flash.net.NetStream
- Starts capturing video from a camera, or stops capturing if - theCamera is set to null.
attachNetStream(netStream:flash.net:NetStream) — Method in class flash.display3D.textures.VideoTexture
- Specifies a video stream to be rendered within the texture of the VideoTexture object.
attachNetStream(netStream:flash.net:NetStream) — Method in class flash.media.StageVideo
- Specifies a video stream to be displayed within the boundaries of the StageVideo object in the application.
attachNetStream(netStream:flash.net:NetStream) — Method in class flash.media.Video
- Specifies a video stream to be displayed within the boundaries of the Video object - in the application.
AT_TARGET — Constant static property in class flash.events.EventPhase
- The target phase, which is the second phase of the event flow.
attribute(attributeName) — Method in class XML
- - Returns the XML value of the attribute that has the name matching the attributeName - - parameter.
attribute(attributeName) — Method in class XMLList
- - Calls the attribute() method of each XML object and returns an XMLList object - - of the results.
attributes() — Method in class XML
- - Returns a list of attribute values for the given XML object.
attributes() — Method in class XMLList
- - Calls the attributes() method of each XML object and - - returns an XMLList object of attributes for each XML object.
attributes — Property in class flash.xml.XMLNode
- An object containing all of the attributes of the specified XMLNode instance.
AUDIO — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for selecting the audio mode.
audioBufferByteLength — Property in class flash.net.NetStreamInfo
- Provides the NetStream audio buffer size in bytes.
audioBufferLength — Property in class flash.net.NetStreamInfo
- Provides NetStream audio buffer size in seconds.
audioByteCount — Property in class flash.net.NetStreamInfo
- Specifies the total number of audio bytes that have arrived in the queue, regardless of how many have been played or flushed.
audioBytesPerSecond — Property in class flash.net.NetStreamInfo
- Specifies the rate at which the NetStream audio buffer is filled in bytes per second.
AudioDecoder — Final class in package flash.media
- The AudioDecoder class enumerates the types of multichannel audio that a - system can support.
audioDeviceManager — Static property in class flash.media.AudioDeviceManager
- The singleton instance of the AudioDeviceManager object.
AudioDeviceManager — Final class in package flash.media
- - Use the AudioDeviceManager class to get audio device information of the system, and - select a device for audio playback.
audioLossRate — Property in class flash.net.NetStreamInfo
- Specifies the audio loss for the NetStream session.
audioOutputChange — Event in class flash.media.AudioDeviceManager
- Dispatched when audio output device is changed for the following reasons: - (1) User selection - - User selects through Flash Player Settings UI - Content setting AudioDeviceManager.selectedDeviceIndex - (2) Device change - - Audio device is added/removed from the system.
AUDIO_OUTPUT_CHANGE — Constant static property in class flash.events.AudioOutputChangeEvent
- Defines the value of the type property of a AudioOutputchangeEvent event object.
AudioOutputChangeEvent — Class in package flash.events
-

This event fires when user selects a different audio output device from Flash Player's settings - UI, or an audio device gets added to / removed from the system.

- -
AudioOutputChangeEvent(type:String, bubbles:Boolean, cancelable:Boolean, reason:String) — Constructor in class flash.events.AudioOutputChangeEvent
-

Constructor.

-
AudioOutputChangeReason — Final class in package flash.media
- This class defines an enumeration that indicates the reason for AudioOutputChangeEvent.
audioPlaybackMode — Static property in class flash.media.SoundMixer
- Specifies the audio playback mode of all Sound objects.
AudioPlaybackMode — Final class in package flash.media
- The AudioPlaybackMode class defines constants for the audioPlaybackMode property of the - SoundMixer class.
audioReliable — Property in class flash.net.NetStream
- For RTMFP connections, specifies whether audio is sent with full reliability.
audioSampleAccess — Property in class flash.net.NetStream
- For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the audio stream.
authenticate — Property in class flash.html.HTMLLoader
authenticate — Property in class flash.net.URLRequest
- Specifies whether authentication requests should be handled (true - or not (false) for this request.
authenticate — Static property in class flash.net.URLRequestDefaults
- The default setting for the authenticate property of URLRequest objects.
authenticate(serverURL:String, domain:String, username:String, password:String) — Method in class flash.net.drm.DRMManager
- Authenticates a user.
authenticationComplete — Event in class flash.net.drm.DRMManager
- The DRMManager dispatches a DRMAuthenticationCompleteEvent object when the user is authenticated - by the media rights server after a call to the authenticate() method.
AUTHENTICATION_COMPLETE — Constant static property in class flash.events.DRMAuthenticationCompleteEvent
- The string constant to use for the authentication complete event - in the type parameter when adding and removing event listeners.
authenticationError — Event in class flash.net.drm.DRMManager
- The DRMManager dispatches a DRMAuthenticationErrorEvent object when the user is not authenticated - by the media rights server after a call to the authenticate() method.
AUTHENTICATION_ERROR — Constant static property in class flash.events.DRMAuthenticationErrorEvent
- The string constant to use for the authentication error event - in the type parameter when adding and removing event listeners.
authenticationMethod — Property in class flash.net.drm.DRMContentData
- The type of authentication required to obtain a voucher for the associated content.
authenticationMethod — Property in class flash.net.drm.DRMDeviceGroup
- The type of authentication required to register to this device group.
authenticationMethod — Property in class flash.net.drm.VoucherAccessInfo
- The type of authentication required to obtain a voucher for the associated content.
AuthenticationMethod — Final class in package flash.net.drm
- The AuthenticationMethod class provides string constants enumerating the - different types of authentication used by the authenticationMethod - property of the DRMContentData class.
authenticationType — Property in class flash.events.DRMAuthenticateEvent
- Indicates whether the supplied credentials are for authenticating against Flash Media Rights Management Server (FMRMS) - or a proxy server.
AUTHENTICATION_TYPE_DRM — Constant static property in class flash.events.DRMAuthenticateEvent
- The DRMAuthenticateEvent.AUTHENTICATION_TYPE_DRM constant defines the value of the - authenticationType property of a DRMAuthenticateEvent object.
AUTHENTICATION_TYPE_PROXY — Constant static property in class flash.events.DRMAuthenticateEvent
- The DRMAuthenticateEvent.AUTHENTICATION_TYPE_PROXY constant defines the value of the - authenticationType property of a DRMAuthenticateEvent object.
authorizations() — Method in class flash.net.GroupSpecifier
- Returns a string that represents passwords for IP multicast publishing and for posting.
AUTO — Constant static property in class flash.display.NativeWindowRenderMode
- A typical window.
AUTO — Constant static property in class flash.display.PixelSnapping
- A constant value used in the pixelSnapping property of a Bitmap object - to specify that the bitmap image is snapped to the nearest pixel if it is drawn with no rotation - or skew and it is drawn at a scale factor of 99.9% to 100.1%.
AUTO — Constant static property in class flash.display3D.Context3DRenderMode
- Automatically choose rendering engine.
AUTO — Constant static property in class flash.printing.PrintMethod
- Automatic selection of the best method of printing.
AUTO — Constant static property in class flash.text.engine.BreakOpportunity
- Bases line break opportunities on Unicode character properties.
AUTO — Constant static property in class flash.text.engine.Kerning
- Used to indicate that kerning is enabled except where inappropriate in Asian typography.
AUTO — Constant static property in class flash.text.engine.TextRotation
- Specifies a 90 degree counter clockwise rotation for full width and wide glyphs only, - as determined by the Unicode properties of the glyph.
AUTO — Constant static property in class flash.ui.MouseCursor
- Used to specify that the cursor should be selected automatically based on the object under the mouse.
autoCapitalize — Property in class flash.text.StageText
- - Controls how a device applies auto capitalization to user input.
AutoCapitalize — Final class in package flash.text
-The AutoCapitalize class defines constants for the -autoCapitalize property of the StageText class.
autoCompact — Property in class flash.data.SQLConnection
- Indicates whether autocompacting was enabled when the current database - was originally created (the value that was specified for the autoCompact - parameter in the open() or openAsync() call that created the - database).
autoCorrect — Property in class flash.text.StageText
- - Indicates whether a device auto-corrects user input for spelling or - - punctuation mistakes.
autoExit — Property in class flash.desktop.NativeApplication
- - Specifies whether the application should automatically terminate when - - all windows have been closed.
autoIncrement — Property in class flash.data.SQLColumnSchema
- Indicates whether this is an auto-increment column.
autoOrients — Property in class flash.display.Stage
- Specifies whether the stage automatically changes orientation when the device orientation changes.
autoSize — Property in class flash.text.TextField
- - Controls automatic sizing and alignment of text fields.
availability — Property in class flash.events.StageVideoAvailabilityEvent
-

Reports the current availability of stage video using a constant of the flash.media.StageVideoAvailability class.

-
available — Property in class air.update.events.StatusFileUpdateEvent
- - Indicates if if there is a different version available than one of the current application - - (true); false otherwise (same version).
available — Property in class air.update.events.StatusUpdateEvent
- - Indicates if an update is available.
available — Property in class flash.events.VsyncStateChangeAvailabilityEvent
- Indicate that vsync state of Stage is changeable.
available — Static property in class flash.external.ExternalInterface
- Indicates whether this player is in a container that offers an external interface.
available — Static property in class flash.external.HostObject
- Indicates whether this player is in a container that offers a high-bandwidth interface.
AVAILABLE — Constant static property in class flash.media.StageVideoAvailability
- Stage video is currently available.
availableTimeZoneNames — Static property in class TimeZone
- - Retrieves a list of the available time zone names that can be used on this operating system.
avHardwareDisable — Static property in class flash.system.Capabilities
- Specifies whether access to the user's camera and microphone has - been administratively prohibited (true) or allowed (false).
AVM1Movie — Class in package flash.display
- AVM1Movie is a simple class that represents AVM1 movie clips, which use ActionScript 1.0 or 2.0.
avm2.intrinsics.iteration — Package
The amv2.intrinsics.iteration package includes the low-level/intrinsic iteration APIs that are part of the ASC2 compiler.
avm2.intrinsics.memory — Package
The amv2.intrinsics.memory package includes the low-level/intrinsic memory access APIs that are part of the ASC2 compiler.
AXIS_ANGLE — Constant static property in class flash.geom.Orientation3D
- The axis angle orientation uses a combination of an axis and an angle to determine the orientation.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/all-index-B.html b/html-docs/all-index-B.html deleted file mode 100644 index 1ef3637..0000000 --- a/html-docs/all-index-B.html +++ /dev/null @@ -1,1525 +0,0 @@ - - - - - -B Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
b — Property in class flash.geom.Matrix
- - The value that affects the positioning of pixels - - along the y axis when rotating or skewing an image.
B — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the B key (66).
BACK — Constant static property in class flash.display3D.Context3DTriangleFace
- -
BACK — Constant static property in class flash.media.CameraPosition
- The Camera.position property returns this for a back camera.
BACK — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for returning to the previous page in the application.
backBufferHeight — Property in class flash.display3D.Context3D
- - Specifies the height of the back buffer, which can be changed by a successful call to the configureBackBuffer() method.
backBufferLength — Property in class flash.net.NetStream
- The number of seconds of previously displayed data that currently cached for rewinding and playback.
backBufferTime — Property in class flash.net.NetStream
- Specifies how much previously displayed data Flash Player tries to cache for rewinding and playback, in seconds.
backBufferWidth — Property in class flash.display3D.Context3D
- - Specifies the width of the back buffer, which can be changed by a successful call to the configureBackBuffer() method.
background — Property in class flash.text.TextField
- - Specifies whether the text field has a background fill.
backgroundColor — Property in class flash.text.TextField
- - The color of the text field background.
BACKQUOTE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the ` key (192).
BACKSLASH — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the \ key (220).
BACKSPACE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Backspace key (8).
BADGE — Constant static property in class flash.notifications.NotificationStyle
- A notification style that updates the icon of the application with a number/image - upon receiving a notification.
BALINESE — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Balinese digit set.
bandwidth — Property in class flash.media.Camera
- - The maximum amount of bandwidth the current outgoing video feed can use, in bytes.
bandwidth — Property in class flash.media.VideoStreamSettings
- Retrieve the maximum amount of bandwidth that the current outgoing video feed can use, in bytes per second.
BASELINE — Constant static property in class flash.display3D.Context3DProfile
- Use the default feature support profile.
BASELINE — Constant static property in class flash.media.H264Profile
- Constant for H.264/AVC baseline profile.
BASELINE_CONSTRAINED — Constant static property in class flash.display3D.Context3DProfile
- Use a constrained feature support profile to target older GPUs -

This profile is primarily targeted at devices that only support PS_2.0 level shaders - like the Intel GMA 9xx series.

BASELINE_EXTENDED — Constant static property in class flash.display3D.Context3DProfile
- Use an extended feature support profile to target newer GPUs which support larger textures -

This profile increases the maximum 2D Texture and RectangleTexture size to 4096x4096

-
baselineFontDescription — Property in class flash.text.engine.TextBlock
- The font used to determine the baselines for all the lines created from the block, independent of their content.
baselineFontSize — Property in class flash.text.engine.TextBlock
- The font size used to calculate the baselines for the lines created from the block.
baselineShift — Property in class flash.text.engine.ElementFormat
- Indicates the baseline shift for the element in pixels.
baselineZero — Property in class flash.text.engine.TextBlock
- Specifies which baseline is at y=0 for lines created from this block.
BASIC — Constant static property in class air.system.License
- - Definition for a Basic license level - -
beforeBounds — Property in class flash.events.NativeWindowBoundsEvent
- The bounds of the window before the change.
beforeDisplayState — Property in class flash.events.NativeWindowDisplayStateEvent
- The display state of the NativeWindow before the change.
beforeInstall — Event in class air.update.ApplicationUpdater
- - Dispatched just before installing the update, after the installUpdate() method - - was called.
beforeInstall — Event in class air.update.ApplicationUpdaterUI
- - Dispatched just before installing the update, after the installUpdate() method - - was called.
BEFORE_INSTALL — Constant static property in class air.update.events.UpdateEvent
- - The UpdateEvent.BEFORE_INSTALL constant defines the value of the - - type property of the event object for a beforeInstall event.
beforeOrientation — Property in class flash.events.StageOrientationEvent
- The orientation of the stage before the change.
begin — Event in class flash.data.SQLConnection
- Dispatched when a begin() method call's operation - completes successfully.
begin(option:String, responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Begins a transaction within which all SQL statements executed against - the connection's database or databases are grouped.
BEGIN — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.begin() method was called.
BEGIN — Constant static property in class flash.events.GesturePhase
- The beginning of a new gesture (such as touching a finger to a touch enabled screen).
BEGIN — Constant static property in class flash.events.SQLEvent
- The SQLEvent.BEGIN constant defines the value of the - type property of a begin event object.
beginBitmapFill(bitmap:flash.display:BitmapData, matrix:flash.geom:Matrix, repeat:Boolean, smooth:Boolean) — Method in class flash.display.Graphics
- Fills a drawing area with a bitmap image.
beginFill(color:uint, alpha:Number) — Method in class flash.display.Graphics
- Specifies a simple one-color fill that subsequent calls to other - Graphics methods (such as lineTo() or drawCircle()) use when drawing.
beginGradientFill(type:String, colors:Array, alphas:Array, ratios:Array, matrix:flash.geom:Matrix, spreadMethod:String, interpolationMethod:String, focalPointRatio:Number) — Method in class flash.display.Graphics
- Specifies a gradient fill used by subsequent calls to other - Graphics methods (such as lineTo() or drawCircle()) for the object.
beginShaderFill(shader:flash.display:Shader, matrix:flash.geom:Matrix) — Method in class flash.display.Graphics
- Specifies a shader fill used by subsequent calls to other Graphics methods - (such as lineTo() or drawCircle()) for the object.
BENGALI — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Bengali digit set.
BEST — Constant static property in class flash.display.StageQuality
- Specifies very high rendering quality.
BEST_EFFORT — Constant static property in class flash.security.RevocationCheckSettings
- Check certificate revocation, if revocation information is available and the revocation status - can be obtained.
BEVEL — Constant static property in class flash.display.JointStyle
- - Specifies beveled joints in the joints parameter of the - flash.display.Graphics.lineStyle() method.
BevelFilter — Final class in package flash.filters
- The BevelFilter class lets you add a bevel effect to display objects.
BevelFilter(distance:Number, angle:Number, highlightColor:uint, highlightAlpha:Number, shadowColor:uint, shadowAlpha:Number, blurX:Number, blurY:Number, strength:Number, quality:int, type:String, knockout:Boolean) — Constructor in class flash.filters.BevelFilter
- Initializes a new BevelFilter instance with the specified parameters.
BGRA — Constant static property in class flash.display3D.Context3DTextureFormat
- -
BGRA_PACKED — Constant static property in class flash.display3D.Context3DTextureFormat
- 16 bit, bgra packed as 4:4:4:4 - -
BGR_PACKED — Constant static property in class flash.display3D.Context3DTextureFormat
- 16 bit, bgr packed as 5:6:5 - -
bias — Property in class flash.filters.ConvolutionFilter
- The amount of bias to add to the result of the matrix transformation.
bidiLevel — Property in class flash.text.engine.TextBlock
- Specifies the bidirectional paragraph embedding level of the text block.
BIG_ENDIAN — Constant static property in class flash.utils.Endian
- Indicates the most significant byte of the multibyte number appears first in the sequence of bytes.
BINARY — Constant static property in class flash.data.SQLCollationType
- Indicates that the column is defined to use the BINARY collation sequence.
BINARY — Constant static property in class flash.net.URLLoaderDataFormat
- Specifies that downloaded data is received as raw binary data.
bind(localPort:int, localAddress:String) — Method in class flash.net.DatagramSocket
- - Binds this socket to the specified local address and port.
bind(localPort:int, localAddress:String) — Method in class flash.net.ServerSocket
- Binds this socket to the specified local address and port.
Bitmap — Class in package flash.display
- The Bitmap class represents display objects that represent bitmap images.
Bitmap(bitmapData:flash.display:BitmapData, pixelSnapping:String, smoothing:Boolean) — Constructor in class flash.display.Bitmap
- Initializes a Bitmap object to refer to the specified BitmapData object.
BITMAP — Constant static property in class flash.printing.PrintMethod
- The bitmap method of printing.
bitmapData — Property in class flash.display.Bitmap
- The BitmapData object being referenced.
bitmapData — Property in class flash.display.GraphicsBitmapFill
- A transparent or opaque bitmap image.
bitmapData — Property in class flash.events.ShaderEvent
- The BitmapData object that was passed to the ShaderJob.start() method.
bitmapData — Property in class flash.events.WebViewDrawEvent
- The BitmapData object containing the bitmap contents rendered from the StageWebView object.
BitmapData — Class in package flash.display
- - The BitmapData class lets you work with the data (pixels) of a Bitmap object - - bitmap image.
BitmapData(width:int, height:int, transparent:Boolean, fillColor:uint) — Constructor in class flash.display.BitmapData
- - Creates a BitmapData object with a specified width and height.
BitmapDataChannel — Final class in package flash.display
-The BitmapDataChannel class is an enumeration of constant values that indicate which channel to -use: red, blue, green, or alpha transparency.
BitmapEncodingColorSpace — Final class in package flash.display
- The BitmapEncodingColorSpace class defines the constants that specify how color channels are sampled - by the flash.display.BitmapData.encode() method when specifying the compressor as - flash.display.JPEGXREncoderOptions.
BitmapFilter — Class in package flash.filters
- The BitmapFilter class is the base class for all image filter effects.
BitmapFilterQuality — Final class in package flash.filters
-The BitmapFilterQuality class contains values to set the rendering quality of a BitmapFilter object.
BitmapFilterType — Final class in package flash.filters
-The BitmapFilterType class contains values to set the type of a BitmapFilter.
BITMAP_FORMAT — Constant static property in class flash.desktop.ClipboardFormats
- Image data (AIR only).
bitmaps — Property in class flash.desktop.DockIcon
bitmaps — Property in class flash.desktop.Icon
- The icon image as an array of BitmapData objects of different sizes.
bitmaps — Property in class flash.desktop.InteractiveIcon
- The icon image as an array of BitmapData objects of different sizes.
bitmaps — Property in class flash.desktop.SystemTrayIcon
- The icon image as an array of BitmapData objects of different sizes.
blendMode — Property in class flash.display.DisplayObject
- A value from the BlendMode class that specifies which blend mode to use.
BlendMode — Final class in package flash.display
-A class that provides constant values for visual blend mode effects.
blendShader — Property in class flash.display.DisplayObject
- Sets a shader that is used for blending the foreground and background.
blockIndent — Property in class flash.text.TextFormat
- Indicates the block indentation in pixels.
BLUE — Constant static property in class flash.display.BitmapDataChannel
- The blue channel.
BLUE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the blue function key button.
blueMultiplier — Property in class flash.geom.ColorTransform
- A decimal value that is multiplied with the blue channel value.
blueOffset — Property in class flash.geom.ColorTransform
- A number from -255 to 255 that is added to the blue channel value after it has - been multiplied by the blueMultiplier value.
BlurFilter — Final class in package flash.filters
- The BlurFilter class lets you apply a blur visual effect to display objects.
BlurFilter(blurX:Number, blurY:Number, quality:int) — Constructor in class flash.filters.BlurFilter
- Initializes the filter with the specified parameters.
blurX — Property in class flash.filters.BevelFilter
- The amount of horizontal blur, in pixels.
blurX — Property in class flash.filters.BlurFilter
- The amount of horizontal blur.
blurX — Property in class flash.filters.DropShadowFilter
- The amount of horizontal blur.
blurX — Property in class flash.filters.GlowFilter
- The amount of horizontal blur.
blurX — Property in class flash.filters.GradientBevelFilter
- The amount of horizontal blur.
blurX — Property in class flash.filters.GradientGlowFilter
- The amount of horizontal blur.
blurY — Property in class flash.filters.BevelFilter
- The amount of vertical blur, in pixels.
blurY — Property in class flash.filters.BlurFilter
- The amount of vertical blur.
blurY — Property in class flash.filters.DropShadowFilter
- The amount of vertical blur.
blurY — Property in class flash.filters.GlowFilter
- The amount of vertical blur.
blurY — Property in class flash.filters.GradientBevelFilter
- The amount of vertical blur.
blurY — Property in class flash.filters.GradientGlowFilter
- The amount of vertical blur.
bold — Property in class flash.text.TextFormat
- Specifies whether the text is boldface.
BOLD — Constant static property in class flash.text.FontStyle
- Defines the bold style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method.
BOLD — Constant static property in class flash.text.engine.FontWeight
- Used to indicate bold font weight.
BOLD_ITALIC — Constant static property in class flash.text.FontStyle
- Defines the combined bold and italic style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method.
BOOL — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - bool value, equivalent to a single Boolean instance - in ActionScript.
BOOL2 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - bool2 value, equivalent to an Array of two Boolean instances - in ActionScript.
BOOL3 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - bool3 value, equivalent to an Array of three Boolean instances - in ActionScript.
BOOL4 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - bool4 value, equivalent to an Array of four Boolean instances - in ActionScript.
Boolean — Final class in Top Level
- -A Boolean object is a data type that can have one of two values, either true or false, - -used for logical operations.
Boolean(expression) — Package function in Top Level
- - Converts the expression parameter to a Boolean value and returns the value.
Boolean(expression:Object) — Constructor in class Boolean
- - Creates a Boolean object with the specified value.
border — Property in class flash.text.TextField
- - Specifies whether the text field has a border.
borderColor — Property in class flash.text.TextField
- - The color of the text field border.
bottom — Property in class flash.geom.Rectangle
- - The sum of the y and - - height properties.
BOTTOM — Constant static property in class flash.display.FocusDirection
- Indicates that focus should be given to the object at the end of the reading order.
BOTTOM — Constant static property in class flash.display.NativeWindowResize
-The bottom edge of the window.
BOTTOM — Constant static property in class flash.display.StageAlign
-Specifies that the Stage is aligned at the bottom.
bottomExtension — Property in class flash.filters.ShaderFilter
- The growth in pixels on the bottom side of the target object.
BOTTOM_LEFT — Constant static property in class flash.display.NativeWindowResize
-The bottom-left corner of the window.
BOTTOM_LEFT — Constant static property in class flash.display.StageAlign
-Specifies that the Stage is aligned in the bottom-left corner.
bottomRight — Property in class flash.geom.Rectangle
- - The location of the Rectangle object's bottom-right corner, determined by the values of the right and - - bottom properties.
BOTTOM_RIGHT — Constant static property in class flash.display.NativeWindowResize
-The bottom-right corner of the window.
BOTTOM_RIGHT — Constant static property in class flash.display.StageAlign
-Specifies that the Stage is aligned in the bottom-right corner.
bottomScrollV — Property in class flash.text.TextField
- - An integer (1-based index) that indicates the bottommost line that is currently visible in - - the specified text field.
bounce(priority:String) — Method in class flash.desktop.DockIcon
- Notifies the user that an event has occurred that may require attention.
bound — Property in class flash.net.DatagramSocket
- - Indicates whether this socket object is currently bound to a local address - - and port.
bound — Property in class flash.net.ServerSocket
- Indicates whether the socket is bound to a local address and port.
bounds — Property in class flash.display.NativeWindow
- - The size and location of this window.
bounds — Property in class flash.display.Screen
- - The bounds of this screen.
bounds — Property in class flash.text.engine.TextLineMirrorRegion
- The bounds of the mirror region, relative to the text line.
break — Statement
Appears within a loop (for, for..in, for each..in, do..while, or while) or within a block of statements associated with a particular case within a switch statement.
breakOpportunity — Property in class flash.text.engine.ElementFormat
- The line break opportunity applied to this text.
BreakOpportunity — Final class in package flash.text.engine
-The BreakOpportunity class is an enumeration of constant values that you can use to set the breakOpportunity property -of the ElementFormat class.
broadcast(bytes:flash.utils:ByteArray, offset:uint, length:uint, address:String, port:int) — Static method in class flash.net.DatagramSocket
- - Broadcast a message on the local network.
broadcast — Property in class flash.net.InterfaceAddress
- The broadcast address of the local network segment.
browse(typeFilter:Array) — Method in class flash.net.FileReference
- Displays a file-browsing dialog box that lets the - user select a file to upload.
browse(typeFilter:Array) — Method in class flash.net.FileReferenceList
- Displays a file-browsing dialog box that lets the - user select one or more local files to upload.
browseForDirectory(title:String) — Method in class flash.filesystem.File
- - Displays a directory chooser dialog box, in which the user can select a directory.
browseForImage(value:flash.media:CameraRollBrowseOptions) — Method in class flash.media.CameraRoll
- Opens an image browser dialog to allow the user to select an existing image from the device camera roll.
browseForOpen(title:String, typeFilter:Array) — Method in class flash.filesystem.File
- - Displays the Open File dialog box, in which the user can select a file to open.
browseForOpenMultiple(title:String, typeFilter:Array) — Method in class flash.filesystem.File
- - Displays the Open File dialog box, in which the user can select one or more files to open.
browseForSave(title:String) — Method in class flash.filesystem.File
- - Displays the Save File dialog box, in which the user can select a file destination.
browserInvoke — Event in class flash.desktop.NativeApplication
- - Dispatched when an application is invoked by a SWF file running in the user's browser.
BROWSER_INVOKE — Constant static property in class flash.events.BrowserInvokeEvent
- The BrowserInvokeEvent.BROWSER_INVOKE constant defines the value of the type - property of a BrowserInvokeEvent object.
BrowserInvokeEvent — Class in package flash.events
- The NativeApplication object of an AIR application dispatches a browserInvoke event when the - application is invoked as the result of a SWF file in the browser using the browser - invocation feature.
BrowserInvokeEvent(type:String, bubbles:Boolean, cancelable:Boolean, arguments:Array, sandboxType:String, securityDomain:String, isHTTPS:Boolean, isUserEvent:Boolean) — Constructor in class flash.events.BrowserInvokeEvent
- The constructor function for the BrowserInvokeEvent class.
browserZoomChange — Event in class flash.display.Stage
- Dispatched when the browserZoomFactor property of the Stage object is changed.
BROWSER_ZOOM_CHANGE — Constant static property in class flash.events.Event
- The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
browserZoomFactor — Property in class flash.display.Stage
- Specifies the browser zoom factor.
bubbles — Property in class flash.events.Event
- Indicates whether an event is a bubbling event.
BUBBLING_PHASE — Constant static property in class flash.events.EventPhase
- The bubbling phase, which is the third phase of the event flow.
bufferLength — Property in class flash.net.NetStream
- The number of seconds of data currently in the buffer.
BUFFER_OVERFLOW_ERROR — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that given buffer is not enough to hold the result.
bufferTime — Property in class flash.media.SoundLoaderContext
- The number of milliseconds to preload a streaming sound into a buffer - before the sound starts to stream.
bufferTime — Static property in class flash.media.SoundMixer
- The number of seconds to preload an embedded streaming sound into a buffer before it starts - to stream.
bufferTime — Property in class flash.net.NetStream
- Specifies how long to buffer messages before starting to display the stream.
bufferTimeMax — Property in class flash.net.NetStream
- Specifies a maximum buffer length for live streaming content, in seconds.
builtInItems — Property in class flash.ui.ContextMenu
- An instance of the ContextMenuBuiltInItems class with the following properties: - forwardAndBack, loop, - play, print, quality, - rewind, save, and zoom.
bullet — Property in class flash.text.TextFormat
- Indicates that the text is part of a bulleted list.
BUTTON — Constant static property in class flash.ui.MouseCursor
- Used to specify that the button pressing hand cursor should be used.
buttonDown — Property in class flash.events.MouseEvent
- - Indicates whether the primary mouse button is pressed (true) or not (false).
buttonMode — Property in class flash.display.Sprite
- Specifies the button mode of this sprite.
byteArray — Property in class flash.events.ShaderEvent
- - The ByteArray object that was passed to the ShaderJob.start() method.
ByteArray — Class in package flash.utils
- - The ByteArray class provides methods and properties to optimize reading, writing, - - and working with binary data.
ByteArray() — Constructor in class flash.utils.ByteArray
- - Creates a ByteArray instance representing a packed array of bytes, so that you can use the methods and properties in this class to optimize your data storage and stream.
byteCode — Property in class flash.display.Shader
- The raw shader bytecode for this Shader instance.
byteCount — Property in class flash.net.NetStreamInfo
- Specifies the total number of bytes that have arrived into the queue, regardless of how many have been played or flushed.
bytes — Property in class flash.display.LoaderInfo
- The bytes associated with a LoaderInfo object.
BYTES_4 — Constant static property in class flash.display3D.Context3DVertexBufferFormat
- -
bytesAvailable — Property in class flash.filesystem.FileStream
- - Returns the number of bytes of data available for reading - - in the input buffer.
bytesAvailable — Property in class flash.net.Socket
- - The number of bytes of data available for reading in the input buffer.
bytesAvailable — Property in class flash.net.URLStream
- - Returns the number of bytes of data available for reading - - in the input buffer.
bytesAvailable — Property in class flash.utils.ByteArray
- - The number of bytes of data available for reading - - from the current position in the byte array to the - - end of the array.
bytesAvailable — Property in interface flash.utils.IDataInput
- - Returns the number of bytes of data available for reading - - in the input buffer.
bytesLoaded — Property in class flash.display.LoaderInfo
- The number of bytes that are loaded for the media.
bytesLoaded — Property in class flash.events.ProgressEvent
- The number of items or bytes loaded when the listener processes the event.
bytesLoaded — Property in class flash.media.Sound
- Returns the currently available number of bytes in this sound object.
bytesLoaded — Property in class flash.net.NetStream
- The number of bytes of data that have been loaded into the application.
bytesLoaded — Property in class flash.net.URLLoader
- - Indicates the number of bytes that have been loaded thus far - - during the load operation.
bytesPending — Property in class flash.events.OutputProgressEvent
- The number of bytes not yet written when the listener processes the event.
bytesPending — Property in class flash.net.Socket
- - Indicates the number of bytes remaining in the write buffer.
bytesPushedFromPeers — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media bytes that were proactively pushed from peers and received by the local node.
bytesPushedToPeers — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media bytes that the local node has proactively pushed to peers.
bytesReceivedFromIPMulticast — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media bytes that the local node has received from IP Multicast.
bytesReceivedFromServer — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media bytes that the local node has received from the server.
bytesRequestedByPeers — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media bytes that the local node has sent to peers in response to requests from those peers for specific fragments.
bytesRequestedFromPeers — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media bytes that the local node requested and received from peers.
bytesTotal — Property in class flash.display.LoaderInfo
- The number of compressed bytes in the entire media file.
bytesTotal — Property in class flash.events.OutputProgressEvent
- The total number of bytes written so far, plus the number of pending bytes to be written.
bytesTotal — Property in class flash.events.ProgressEvent
- The total number of items or bytes that will be loaded if the loading process succeeds.
bytesTotal — Property in class flash.media.Sound
- Returns the total number of bytes in this sound object.
bytesTotal — Property in class flash.net.NetStream
- The total size in bytes of the file being loaded into the application.
bytesTotal — Property in class flash.net.URLLoader
- - Indicates the total number of bytes in the downloaded data.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/all-index-C.html b/html-docs/all-index-C.html deleted file mode 100644 index ac2ab89..0000000 --- a/html-docs/all-index-C.html +++ /dev/null @@ -1,4980 +0,0 @@ - - - - - -C Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
c — Property in class flash.geom.Matrix
- - The value that affects the positioning of pixels - - along the x axis when rotating or skewing an image.
C — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the C key (67).
cacheAsBitmap — Property in class flash.display.DisplayObject
- - If set to true, Flash runtimes cache an internal bitmap representation of the - - display object.
cacheAsBitmapMatrix — Property in class flash.display.DisplayObject
- - If non-null, this Matrix object defines how a display object is rendered when - - cacheAsBitmap is set to true.
cacheDirectory — Static property in class flash.filesystem.File
- - The application's cache directory.
cacheResponse — Property in class flash.html.HTMLLoader
cacheResponse — Property in class flash.net.URLRequest
- Specifies whether successful response data should be cached for this request.
cacheResponse — Static property in class flash.net.URLRequestDefaults
- The default setting for the cacheResponse property of URLRequest objects.
cacheSize — Property in class flash.data.SQLConnection
- Provides access to the cache size for this connection, which represents the maximum number - of database disk pages that are held in memory at one time.
call(thisArg, ... rest) — Method in class Function
- - Invokes the function represented by a Function object.
call(functionName:String, ... rest) — Method in class flash.external.ExtensionContext
- - Calls the native function specified by functionName.
call(functionName:String, ... rest) — Static method in class flash.external.ExternalInterface
- Calls a function exposed by the SWF container, passing zero or - more arguments.
__call(methName:String, args:Array) — Method in class flash.external.HostObject
- The universal method invoke method receives the property name - and returns the result of the method call.
call(command:String, responder:flash.net:Responder, ... rest) — Method in class flash.net.NetConnection
- Calls a command or method on Flash Media Server or on an application server running Flash Remoting.
callee — Property in class arguments
- - A reference to the currently executing function.
callProperty(name, ... rest) — Method in class flash.utils.Proxy
Camera — Final class in package flash.media
- - Use the Camera class to capture video from the client system or device camera.
CAMERA — Constant static property in class flash.system.SecurityPanel
- When passed to Security.showSettings(), displays the - Camera panel in Flash Player Settings.
CameraPosition — Final class in package flash.media
- The CameraPosition class defines constants for the position property of the - Camera class.
CameraRoll — Class in package flash.media
-The CameraRoll class allows you to access image data in the system media library or "camera roll." - -

AIR profile support: This feature is supported -on mobile devices, but it is not supported on desktop operating systems or AIR for TV devices.

CameraRoll() — Constructor in class flash.media.CameraRoll
- Creates a CameraRoll object.
CameraRollBrowseOptions — Class in package flash.media
- The CameraRollBrowseOptions class defines the initialization options that may be used - when using the Camera Roll API to launch the Image Picker.
CameraRollBrowseOptions() — Constructor in class flash.media.CameraRollBrowseOptions
- Creates a new CameraRollBrowseOptions object.
CameraUI — Class in package flash.media
- The CameraUI class allows you to capture a still image or video using the default camera application on a device.
CameraUI() — Constructor in class flash.media.CameraUI
- Creates a CameraUI object.
cancel — Event in class flash.data.SQLConnection
- Dispatched when a cancel() method call's operation completes - successfully.
cancel(responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Aborts all SQL statements that are currently executing on databases connected to the SQLConnection - instance.
cancel() — Method in class flash.data.SQLStatement
- Cancels execution of this statement.
cancel() — Method in class flash.display.ShaderJob
- Cancels the currently running shader operation.
cancel — Event in class flash.filesystem.File
- - Dispatched when a pending asynchronous operation is canceled.
cancel() — Method in class flash.filesystem.File
- - Cancels any pending asynchronous operation.
cancel — Event in class flash.media.CameraRoll
- Dispatched when a user cancels a browse-for-image operation without selecting an image.
cancel — Event in class flash.media.CameraUI
- The cancel event is dispatched when the user closes the Camera UI without - saving a picture or video.
cancel — Event in class flash.net.FileReference
- Dispatched when a file upload or download is canceled through the file-browsing dialog - box by the user.
cancel() — Method in class flash.net.FileReference
- Cancels any ongoing upload or download operation on this FileReference object.
cancel — Event in class flash.net.FileReferenceList
- Dispatched when the user dismisses the file-browsing dialog box.
cancel — Event in class flash.system.SystemUpdater
- Dispatched when an update of the player itself is cancelled by the user.
cancel() — Method in class flash.system.SystemUpdater
- Cancels an active update.
CANCEL — Constant static property in class flash.events.Event
- The Event.CANCEL constant defines the value of the type property of a cancel event object.
CANCEL — Constant static property in class flash.events.SQLEvent
- The SQLEvent.CANCEL constant defines the value of the - type property of a cancel event object.
cancelable — Property in class flash.events.Event
- Indicates whether the behavior associated with the event can be prevented.
cancelLoad() — Method in class flash.html.HTMLLoader
cancelUpdate() — Method in class air.update.ApplicationUpdater
- - Cancels the update process.
cancelUpdate() — Method in class air.update.ApplicationUpdaterUI
- - Cancels the update process.
canonicalize() — Method in class flash.filesystem.File
- - Canonicalizes the File path.
Capabilities — Final class in package flash.system
- The Capabilities class provides properties that - describe the system and runtime that are hosting the application.
caps — Property in class flash.display.GraphicsStroke
- Specifies the type of caps at the end - of lines.
CAPS — Constant static property in class flash.text.engine.TypographicCase
- Specifies that spacing is adjusted for uppercase characters on output.
CAPS_AND_SMALL_CAPS — Constant static property in class flash.text.engine.TypographicCase
- Specifies that all lowercase characters use small-caps glyphs on output.
capsLock — Static property in class flash.ui.Keyboard
- - Specifies whether the Caps Lock key is activated (true) or not (false).
CAPS_LOCK — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Caps Lock key (20).
CapsStyle — Final class in package flash.display
- The CapsStyle class is an enumeration of constant values that specify the caps style to use in drawing lines.
caption — Property in class flash.ui.ContextMenuItem
- Specifies the menu item caption (text) displayed in the context menu.
CAPTURING_PHASE — Constant static property in class flash.events.EventPhase
- The capturing phase, which is the first phase of the event flow.
caretIndex — Property in class flash.text.TextField
- - The index of the insertion point (caret) position.
case — Statement
Defines a jump target for the switch statement.
CASEINSENSITIVE — Constant static property in class Array
- - Specifies case-insensitive sorting for the Array class sorting methods.
casi32(addr, expectedVal, newVal) — Package function in avm2.intrinsics.memory
- - A compare-and-swap operation for domainMemory.
ceil(val:Number) — Static method in class Math
- - Returns the ceiling of the specified number or expression.
CENTER — Constant static property in class flash.text.TextFieldAutoSize
- Specifies that the text is to be treated as center-justified text.
CENTER — Constant static property in class flash.text.TextFormatAlign
- Constant; centers the text in the text field.
CENTER — Constant static property in class flash.text.engine.TabAlignment
- Positions the center of the tabbed text at the tab stop.
certificateError — Event in class air.net.WebSocket
- - Dispatched if there is a certificate error when trying to open a WebSocket connection.
certificateError — Event in class flash.net.SecureSocket
- - Dispatched if a call to SecureSocket.connect() - - attempts to connect to a server with an invalid certificate - - (for example, self-signed or untrusted, or with an invalid date).
certificateError — Event in class flash.net.URLLoader
- - Dispatched if a call to URLLoader.load() - - attempts to load data from a server with an invalid certificate - - (for example, self-signed or untrusted, or with an invalid date).
certificateError — Event in class flash.net.URLStream
- - Dispatched if a call to URLStream.load() - - attempts to load data from a server with an invalid certificate - - (for example, self-signed or untrusted, or with an invalid date).
CERTIFICATE_ERROR — Constant static property in class flash.events.SecurityErrorEvent
- - The SecurityErrorEvent.CERTIFICATE_ERROR constant is used when the runtime detects a problem with a server's security certificate.
CertificateStatus — Final class in package flash.security
- The CertificateStatus class defines constants used to report the - results of certificate validation processing by a SecureSocket object.
CFF — Constant static property in class flash.text.engine.RenderingMode
- Sets rendering mode to CFF (Compact Font Format).
cffHinting — Property in class flash.text.engine.FontDescription
- - The type of CFF hinting used for this text.
CFFHinting — Final class in package flash.text.engine
-The CFFHinting class defines values for cff hinting in the FontDescription class.
CHAM — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Cham digit set.
change — Event in class flash.text.StageText
- - Dispatched after text content changes.
change — Event in class flash.text.TextField
- - Dispatched after a control value is modified, unlike - - the textInput event, which is dispatched before the value is modified.
change — Event in class flash.ui.GameInputControl
- Dispatched when a control value changes.
CHANGE — Constant static property in class flash.events.Event
- The Event.CHANGE constant defines the value of the type property of a change event object.
changeList — Property in class flash.events.SyncEvent
- An array of objects; each object contains properties that describe the changed members of a remote shared object.
CHANNEL_DOWN — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the channel down button.
channelMessage — Event in class flash.system.MessageChannel
- - Dispatched each time the sending worker calls this MessageChannel - - object's send() method, indicating that a new message object - - is available in the MessageChannel instance's queue.
CHANNEL_MESSAGE — Constant static property in class flash.events.Event
- The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
channels — Property in class flash.display.ShaderInput
- The number of channels that a shader input expects.
channelState — Event in class flash.system.MessageChannel
- - Dispatched when the value of the message channel's state - - property changes.
CHANNEL_STATE — Constant static property in class flash.events.Event
- The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
CHANNEL_UP — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the channel up button.
charAt(index:Number) — Method in class String
- - Returns the character in the position specified by the index parameter.
charCode — Property in class flash.events.KeyboardEvent
- - Contains the character code value of the key pressed or released.
charCodeAt(index:Number) — Method in class String
- - Returns the numeric Unicode character code of the character at the specified - - index.
CharCodeStrings — Constant static property in class flash.ui.Keyboard
- - An array containing all the defined key name constants.
charCount — Property in class flash.text.TextSnapshot
- The number of characters in a TextSnapshot object.
checkDetailsOnline() — Method in class air.system.License
- - Checks the license details online against the HARMAN licensing server.
checked — Property in class flash.display.NativeMenuItem
- - Controls whether this menu item displays a checkmark.
checkForUpdate — Event in class air.update.ApplicationUpdater
- - Dispatched before the update process begins, just before the - - updater tries to download the update descriptor file.
checkForUpdate() — Method in class air.update.ApplicationUpdater
- - Asynchronously downloads and interprets - - the update descriptor file.
checkForUpdate — Event in class air.update.ApplicationUpdaterUI
- - Dispatched before the update process begins, just before the - - updater tries to download the update descriptor file.
CHECK_FOR_UPDATE — Constant static property in class air.update.events.UpdateEvent
- - The UpdateEvent.CHECK_FOR_UPDATE constant defines the value of the - - type property of the event object for a checkForUpdate event.
checkNow() — Method in class air.update.ApplicationUpdater
- - Starts the update process.
checkNow() — Method in class air.update.ApplicationUpdaterUI
- - Starts the update process.
checkPolicyFile — Property in class flash.media.SoundLoaderContext
- Specifies whether the application should try to download a URL policy file from the - loaded sound's server before beginning to load the sound.
checkPolicyFile — Property in class flash.net.NetStream
- Specifies whether the application tries to download a cross-domain policy file from the - loaded video file's server before beginning to load the video file.
checkPolicyFile — Property in class flash.system.LoaderContext
- Specifies whether the application should attempt to download a URL policy file from the - loaded object's server before beginning to load the object itself.
child(propertyName:Object) — Method in class XML
- - Lists the children of an XML object.
child(propertyName:Object) — Method in class XMLList
- - Calls the child() method of each XML object and returns an XMLList object that - - contains the results in order.
childAllowsParent — Property in class flash.display.LoaderInfo
- Expresses the trust relationship from content (child) to the Loader (parent).
childIndex() — Method in class XML
- - Identifies the zero-indexed position of this XML object within the context of its parent.
childNodes — Property in class flash.xml.XMLNode
- An array of the specified XMLNode object's children.
children() — Method in class XML
- - Lists the children of the XML object in the sequence in which they appear.
children() — Method in class XMLList
- - Calls the children() method of each XML object and - - returns an XMLList object that contains the results.
childSandboxBridge — Property in class flash.display.LoaderInfo
- A object that can be set by the loaded content's code to expose properties and methods that can be accessed - by code in the Loader object's sandbox.
CHINESE — Constant static property in class flash.system.IMEConversionMode
- The string "CHINESE", for use with the - IME.conversionMode property.
CHOUKEI3GOU — Constant static property in class flash.printing.PaperSize
- Japanese choukei 3 gou (envelope) - -
CHOUKEI4GOU — Constant static property in class flash.printing.PaperSize
- Japanese choukei 4 gou (envelope) - -
clamp — Property in class flash.filters.ConvolutionFilter
- Indicates whether the image should be clamped.
CLAMP — Constant static property in class flash.display3D.Context3DWrapMode
- Clamp texture coordinates outside the 0..1 range.
CLAMP — Constant static property in class flash.filters.DisplacementMapFilterMode
- Clamps the displacement value to the edge of the source image.
CLAMP_U_REPEAT_V — Constant static property in class flash.display3D.Context3DWrapMode
- Clamp in U axis but Repeat in V axis.
class — Statement
Defines a class, which lets you instantiate objects that share methods and properties that you define.
Class — Dynamic class in Top Level
- - A Class object is created for each class definition in a program.
clear() — Method in class flash.desktop.Clipboard
- Deletes all data representations from this Clipboard object.
clear() — Method in class flash.desktop.NativeApplication
- - Invokes an internal delete command on the focused display object.
clear() — Method in class flash.display.Graphics
- Clears the graphics that were drawn to this Graphics object, and resets fill and - line style settings.
clear — Event in class flash.display.InteractiveObject
- - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.
clear(red:Number, green:Number, blue:Number, alpha:Number, depth:Number, stencil:uint, mask:uint) — Method in class flash.display3D.Context3D
- - Clears the color, depth, and stencil buffers associated with this Context3D object and - - fills them with the specified values.
clear() — Method in class flash.media.Video
- Clears the image currently displayed in the Video object (not the video stream).
clear() — Method in class flash.net.SharedObject
- For local shared objects, purges all of the data and deletes the shared object from the disk.
clear() — Method in class flash.text.StyleSheet
- Removes all styles from the style sheet object.
clear — Property in class flash.ui.ContextMenuClipboardItems
- Enables or disables the 'Delete' or 'Clear' item on the clipboard menu.
clear() — Method in class flash.utils.ByteArray
- - Clears the contents of the byte array and resets the length - - and position properties to 0.
CLEAR — Constant static property in class flash.events.Event
- The Event.CLEAR constant defines the value of the type property - of a clear event object.
clearButtonMode — Property in class flash.text.StageText
- - The mode of clearButton for the current StageText Object.
clearData(format:String) — Method in class flash.desktop.Clipboard
- Deletes the data representation for the specified format.
clearInterval(id) — Package function in flash.utils
- Cancels a specified setInterval() call.
clearParameters() — Method in class flash.data.SQLStatement
- Clears all current parameter settings.
clearTimeout(id) — Package function in flash.utils
- Cancels a specified setTimeout() call.
click — Event in class flash.desktop.SystemTrayIcon
- Dispatched by this SystemTrayIcon object on mouse click.
click — Event in class flash.display.InteractiveObject
- - Dispatched when a user presses and releases the main button of the user's - - pointing device over the same InteractiveObject.
CLICK — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a click event object.
CLICK — Constant static property in class flash.events.ScreenMouseEvent
- The ScreenMouseEvent.CLICK constant defines the value of the type - property of a click event object.
clickCount — Property in class flash.events.MouseEvent
- - Indicates whether or not the mouse down event is part of a multi-click sequence.
client — Property in class flash.net.LocalConnection
- Indicates the object on which callback methods are invoked.
client — Property in class flash.net.NetConnection
- Indicates the object on which callback methods are invoked.
client — Property in class flash.net.NetStream
- Specifies the object on which callback methods are invoked to handle streaming or F4V/FLV - file data.
client — Property in class flash.net.SharedObject
- Indicates the object on which - callback methods are invoked.
clipboard — Property in class flash.events.NativeDragEvent
- The Clipboard object containing the data in this drag operation.
Clipboard — Class in package flash.desktop
- The Clipboard class provides a container for transferring data and objects through the clipboard.
Clipboard() — Constructor in class flash.desktop.Clipboard
- Creates an empty Clipboard object.
ClipboardFormats — Class in package flash.desktop
-The ClipboardFormats class defines constants for the names of the standard data formats used with the Clipboard class.
clipboardItems — Property in class flash.ui.ContextMenu
- An instance of the ContextMenuClipboardItems class with the following properties: - cut, copy, paste, delete, selectAll.
clipboardMenu — Property in class flash.ui.ContextMenu
- Specifies whether or not the clipboard menu should be used.
ClipboardTransferMode — Class in package flash.desktop
- The ClipboardTransferMode class defines constants for the modes used as values of the transferMode - parameter of the Clipboard.getData() method.
clone() — Method in class air.update.events.DownloadErrorEvent
- - Creates a copy of the object and sets the value of each property to match that of the original.
clone() — Method in class air.update.events.StatusFileUpdateErrorEvent
- - Creates a copy of the object and sets the value of each property to match that of the original.
clone() — Method in class air.update.events.StatusFileUpdateEvent
- - Creates a copy of the object and sets the value of each property to match that of the original.
clone() — Method in class air.update.events.StatusUpdateErrorEvent
- - Creates a copy of the object and sets the value of each property to match that of the original.
clone() — Method in class air.update.events.StatusUpdateEvent
- - Creates a copy of the object and sets the value of each property to match that of the original.
clone() — Method in class air.update.events.UpdateEvent
- - Creates a copy of the object and sets the value of each property to match that of the original.
clone() — Method in class air.utils.ZipEntry
- - Clones a zip entry to create a new object with the same settings/data, - - but with these efficiently copied so that the new object is independent.
clone() — Method in class flash.display.BitmapData
- - Returns a new BitmapData object that is a clone of the original instance - - with an exact copy of the contained bitmap.
clone() — Method in class flash.display.NativeMenu
- - - Creates a copy of the menu and all items.
clone() — Method in class flash.display.NativeMenuItem
- - Creates a copy of the NativeMenuItem object.
clone() — Method in class flash.events.AccelerometerEvent
- Creates a copy of an AccelerometerEvent object and sets the value of each property to match that of - the original.
clone() — Method in class flash.events.ActivityEvent
- Creates a copy of an ActivityEvent object and sets the value of each property to match that of - the original.
clone() — Method in class flash.events.AsyncErrorEvent
- Creates a copy of the AsyncErrorEvent object and sets the value of each property to match - that of the original.
clone() — Method in class flash.events.BrowserInvokeEvent
- Creates a new copy of this event.
clone() — Method in class flash.events.ContextMenuEvent
- Creates a copy of the ContextMenuEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.DataEvent
- - Creates a copy of the DataEvent object and sets the value of each property to match that of the - - original.
clone() — Method in class flash.events.DatagramSocketDataEvent
- Creates a copy of the DatagramSocketDataEvent object and sets each property's value to match that of the original.
clone() — Method in class flash.events.DeviceRotationEvent
- Creates a copy of an DeviceRotationEvent object and sets the value of each property to match that of - the original.
clone() — Method in class flash.events.DNSResolverEvent
- Creates a copy of the DNSResolverEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.DRMAuthenticateEvent
- Creates a copy of the DRMAuthenticateEvent object and sets the value of each property to match - that of the original.
clone() — Method in class flash.events.DRMAuthenticationCompleteEvent
- Duplicates an instance of an Event subclass.
clone() — Method in class flash.events.DRMAuthenticationErrorEvent
- Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.DRMDeviceGroupErrorEvent
clone() — Method in class flash.events.DRMDeviceGroupEvent
clone() — Method in class flash.events.DRMErrorEvent
- Creates a copy of the DRMErrorEvent object and sets the value of each property to match - that of the original.
clone() — Method in class flash.events.DRMLicenseRequestEvent
- Duplicates an instance of an Event subclass.
clone() — Method in class flash.events.DRMReturnVoucherCompleteEvent
- Duplicates an instance of an Event subclass.
clone() — Method in class flash.events.DRMReturnVoucherErrorEvent
- Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.DRMStatusEvent
- Creates a copy of the DRMStatusEvent object and sets the value of each property to match - that of the original.
clone() — Method in class flash.events.ErrorEvent
- Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.Event
- Duplicates an instance of an Event subclass.
clone() — Method in class flash.events.FocusEvent
- Creates a copy of the FocusEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.FullScreenEvent
- Creates a copy of a FullScreenEvent object and sets the value of each property to match that of - the original.
clone() — Method in class flash.events.GeolocationEvent
- Creates a copy of the GeolocationEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.GestureEvent
- Creates a copy of the GestureEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.HTMLUncaughtScriptExceptionEvent
- - Creates a copy of the HTMLUncaughtScriptExceptionEvent object and sets - the value of each property to match that of the original.
clone() — Method in class flash.events.HTTPStatusEvent
- Creates a copy of the HTTPStatusEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.IMEEvent
- Creates a copy of the IMEEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.InvokeEvent
- Creates a new copy of this event.
clone() — Method in class flash.events.IOErrorEvent
- Creates a copy of the IOErrorEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.KeyboardEvent
- - Creates a copy of the KeyboardEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.LocationChangeEvent
-
clone() — Method in class flash.events.MediaEvent
- Creates a copy of an MediaEvent object and sets the value of each property to match that of - the original.
clone() — Method in class flash.events.MouseEvent
- - Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.NativeDragEvent
- Creates a copy of this NativeDragEvent object.
clone() — Method in class flash.events.NativeProcessExitEvent
- Creates a copy of the NativeProcessExitEvent object and sets each property's value to match that of the original.
clone() — Method in class flash.events.NativeWindowBoundsEvent
- Creates a copy of the NativeWindowBoundsEvent object and sets the value of each property - to match that of the original.
clone() — Method in class flash.events.NativeWindowDisplayStateEvent
- Creates a copy of the NativeWindowDisplayStateEvent object and sets the - value of each property to match that of the original.
clone() — Method in class flash.events.NetDataEvent
- Creates a copy of an NetDataEvent object and sets the value of each property to match that of - the original.
clone() — Method in class flash.events.NetMonitorEvent
- Creates a copy of an NetMonitorEvent object and sets the value of each property to match that of - the original.
clone() — Method in class flash.events.NetStatusEvent
- Creates a copy of the NetStatusEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.OutputProgressEvent
- Creates a copy of the OutputProgressEvent object and sets each property's value to match that of the original.
clone() — Method in class flash.events.PermissionEvent
- Creates a copy of an PermissionEvent object and sets the value of each property to match that of - the original.
clone() — Method in class flash.events.PressAndTapGestureEvent
- Creates a copy of the PressAndTapGestureEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.ProgressEvent
- Creates a copy of the ProgressEvent object and sets each property's value to match that of the original.
clone() — Method in class flash.events.SampleDataEvent
- Creates a copy of the SampleDataEvent object and sets each property's value to match that of the original.
clone() — Method in class flash.events.ScreenMouseEvent
- Creates a copy of the ScreenMouseEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.SecurityErrorEvent
- - Creates a copy of the SecurityErrorEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.ServerSocketConnectEvent
- Creates a copy of the ServerSocketConnectEvent object and sets each property's value to match that of the original.
clone() — Method in class flash.events.ShaderEvent
- Creates a copy of the ShaderEvent object and sets the value of each property - to match that of the original.
clone() — Method in class flash.events.SoftKeyboardEvent
- Creates a copy of a SoftKeyboardEvent object and sets the value of each property to match that of - the original.
clone() — Method in class flash.events.SQLErrorEvent
- Creates a copy of the SQLErrorEvent object and sets the value of each property - to match that of the original.
clone() — Method in class flash.events.SQLEvent
- Creates a copy of the SQLEvent object and sets the value of each property to match - that of the original.
clone() — Method in class flash.events.SQLUpdateEvent
- Creates a copy of the SQLUpdateEvent object and sets the value of each property to - match that of the original.
clone() — Method in class flash.events.StageOrientationEvent
- Creates a copy of the StageOrientationEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.StatusEvent
- Creates a copy of the StatusEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.StorageVolumeChangeEvent
- Duplicates an instance of an Event subclass.
clone() — Method in class flash.events.SyncEvent
- Creates a copy of the SyncEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.TextEvent
- Creates a copy of the TextEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.ThrottleEvent
- Creates a copy of the ThrottleEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.TimerEvent
- Creates a copy of the TimerEvent object and sets each property's value to match that of the original.
clone() — Method in class flash.events.TouchEvent
- Creates a copy of the TouchEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.TransformGestureEvent
- Creates a copy of the TransformGestureEvent object and sets the value of each property to match that of the original.
clone() — Method in class flash.events.UncaughtErrorEvent
- Creates a copy of the UncaughtErrorEvent object and sets the value of - each property to match that of the original.
clone() — Method in class flash.events.VsyncStateChangeAvailabilityEvent
- Creates a copy of an VsyncStateChangeAvailabilityEvent object and sets the value of each property to match that of - the original.
clone() — Method in class flash.events.WebViewDrawEvent
- Creates a copy of the WebViewDrawEvent object and sets each property's value to match that of the original.
clone() — Method in class flash.filesystem.File
- - Returns a copy of this File object.
clone() — Method in class flash.filters.BevelFilter
- Returns a copy of this filter object.
clone() — Method in class flash.filters.BitmapFilter
- Returns a BitmapFilter object that is an exact copy of the original - BitmapFilter object.
clone() — Method in class flash.filters.BlurFilter
- Returns a copy of this filter object.
clone() — Method in class flash.filters.ColorMatrixFilter
- Returns a copy of this filter object.
clone() — Method in class flash.filters.ConvolutionFilter
- Returns a copy of this filter object.
clone() — Method in class flash.filters.DisplacementMapFilter
- Returns a copy of this filter object.
clone() — Method in class flash.filters.DropShadowFilter
- Returns a copy of this filter object.
clone() — Method in class flash.filters.GlowFilter
- Returns a copy of this filter object.
clone() — Method in class flash.filters.GradientBevelFilter
- Returns a copy of this filter object.
clone() — Method in class flash.filters.GradientGlowFilter
- Returns a copy of this filter object.
clone() — Method in class flash.geom.Matrix
- - Returns a new Matrix object that is a clone of this - - matrix, with an exact copy of the contained object.
clone() — Method in class flash.geom.Matrix3D
- Returns a new Matrix3D object that is an exact copy of the current Matrix3D object.
clone() — Method in class flash.geom.Point
- Creates a copy of this Point object.
clone() — Method in class flash.geom.Rectangle
- - Returns a new Rectangle object with the same values for the x, y, - - width, and height properties as the original Rectangle object.
clone() — Method in class flash.geom.Vector3D
- Returns a new Vector3D object that is an exact copy of the current Vector3D object.
clone() — Method in class flash.text.engine.EastAsianJustifier
- Constructs a cloned copy of the EastAsianJustifier.
clone() — Method in class flash.text.engine.ElementFormat
- Constructs an unlocked, cloned copy of the ElementFormat.
clone() — Method in class flash.text.engine.FontDescription
- - Constructs an unlocked, cloned copy of the FontDescription.
clone() — Method in class flash.text.engine.SpaceJustifier
- Constructs a cloned copy of the SpaceJustifier.
clone() — Method in class flash.text.engine.TextJustifier
- Constructs a cloned copy of the TextJustifier.
clone() — Method in class flash.ui.ContextMenu
- Creates a copy of the specified ContextMenu object.
clone() — Method in class flash.ui.ContextMenuItem
- - Creates a copy of the NativeMenuItem object.
cloneNode(deep:Boolean) — Method in class flash.xml.XMLNode
- - Constructs and returns a new XML node of the same type, name, value, and attributes as the - specified XML object.
CLONE_ONLY — Constant static property in class flash.desktop.ClipboardTransferMode
- The Clipboard object should only return a copy.
CLONE_PREFERRED — Constant static property in class flash.desktop.ClipboardTransferMode
- The Clipboard object should return a copy if available and a reference if not.
close — Event in class air.net.WebSocket
- - Dispatched when the WebSocket is closed by the other party.
close(reasonCode:uint) — Method in class air.net.WebSocket
- - Closes the WebSocket.
close — Event in class flash.data.SQLConnection
- Dispatched when a close() method call's operation - completes successfully.
close(responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Closes the current database connection.
close() — Method in interface flash.desktop.IFilePromise
- Called by the AIR runtime when it has finished reading all data.
close() — Method in class flash.display.Loader
- - Cancels a load() method operation that is currently in progress for the Loader instance.
close — Event in class flash.display.NativeWindow
- - Dispatched by this NativeWindow object after the window has been closed.
close() — Method in class flash.display.NativeWindow
- - Closes this window.
close — Event in class flash.filesystem.FileStream
- Indicates that the stream has been - closed by an explicit call to the close() method.
close() — Method in class flash.filesystem.FileStream
- Closes the FileStream object.
close — Event in class flash.media.MediaPromise
- A MediaPromise object dispatches a close event when the underlying data stream has closed.
close() — Method in class flash.media.MediaPromise
- Closes the data source.
close() — Method in class flash.media.Sound
- Closes the stream, causing any download of data to cease.
close — Event in class flash.net.DatagramSocket
- - Dispatched when the operating system closes this socket.
close() — Method in class flash.net.DatagramSocket
- - Closes the socket.
close() — Method in class flash.net.LocalConnection
- Closes (disconnects) a LocalConnection object.
close() — Method in class flash.net.NetConnection
- Closes the connection that was opened locally or to the server and dispatches - a netStatus event - with a code property of NetConnection.Connect.Closed.
close() — Method in class flash.net.NetGroup
- Disconnect from the group and close this NetGroup.
close() — Method in class flash.net.NetStream
- Stops playing all data on the stream, sets the time property to 0, - and makes the stream available for another use.
close — Event in class flash.net.SecureSocket
- - Dispatched when the server closes the socket connection.
close — Event in class flash.net.ServerSocket
- Dispatched when the operating system closes this socket.
close() — Method in class flash.net.ServerSocket
- Closes the socket and stops listening for connections.
close() — Method in class flash.net.SharedObject
- Closes the connection between a remote shared object and the server.
close — Event in class flash.net.Socket
- - Dispatched when the server closes the socket connection.
close() — Method in class flash.net.Socket
- - Closes the socket.
close() — Method in class flash.net.URLLoader
- - Closes the load operation in progress.
close() — Method in class flash.net.URLStream
- - Immediately closes the stream and - - cancels the download operation.
close — Event in class flash.net.XMLSocket
- Dispatched when the server closes the socket connection.
close() — Method in class flash.net.XMLSocket
- Closes the connection specified by the XMLSocket object.
close() — Method in class flash.system.MessageChannel
- - Instructs the current MessageChannel to close once all messages have - - been received.
CLOSE — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.close() method was called.
CLOSE — Constant static property in class flash.events.Event
- The Event.CLOSE constant defines the value of the type property of a close event object.
CLOSE — Constant static property in class flash.events.SQLEvent
- The SQLEvent.CLOSE constant defines the value of the - type property of a close event object.
closed — Property in class flash.display.NativeWindow
- - Indicates whether this window has been closed.
CLOSED — Constant static property in class flash.system.MessageChannelState
- - This state indicates that the message channel has been closed and - - doesn't have any more messages to deliver.
closeInput() — Method in class flash.desktop.NativeProcess
- Closes the input stream on this process.
closeReason — Property in class air.net.WebSocket
- - Retrieves the 'close' reason code, after the WebSocket has been closed.
closing — Event in class flash.display.NativeWindow
- - Dispatched by this NativeWindow object immediately before the window is to be closed.
CLOSING — Constant static property in class flash.events.Event
- The Event.CLOSING constant defines the value of the - type property of a closing event object.
CLOSING — Constant static property in class flash.system.MessageChannelState
- - This state indicates that the message channel has been instructed to - - close and is in the process of delivering the remaining messages on - - the channel.
code — Property in class flash.events.StatusEvent
- A description of the object's status.
codec — Property in class flash.media.H264VideoStreamSettings
- Video codec used for compression.
codec — Property in class flash.media.Microphone
- The codec to use for compressing audio.
codec — Property in class flash.media.VideoStreamSettings
- Video codec used for compression.
codecInfo — Constant property in class flash.events.StageVideoEvent
codecInfo — Constant property in class flash.events.VideoEvent
CODE_SIGNING — Constant static property in class flash.security.SignerTrustSettings
- The certificate is trusted for code signing.
Collator — Final class in package flash.globalization
- The Collator class provides locale-sensitive string comparison capabilities.
Collator(requestedLocaleIDName:String, initialMode:String) — Constructor in class flash.globalization.Collator
- Constructs a new Collator object to provide string comparisons according to the conventions of a specified locale.
CollatorMode — Final class in package flash.globalization
- The CollatorMode class enumerates constant values that govern the behavior of string comparisons - performed by a Collator object.
color — Property in class flash.display.GraphicsSolidFill
- The color of the fill.
color — Property in class flash.display.Stage
- The SWF background color.
color — Property in class flash.filters.ConvolutionFilter
- The hexadecimal color to substitute for pixels that are off the source image.
color — Property in class flash.filters.DisplacementMapFilter
- Specifies what color to use for out-of-bounds displacements.
color — Property in class flash.filters.DropShadowFilter
- The color of the shadow.
color — Property in class flash.filters.GlowFilter
- The color of the glow.
color — Property in class flash.geom.ColorTransform
- The RGB color value for a ColorTransform object.
color — Property in class flash.text.StageText
- - Specifies text color.
color — Property in class flash.text.TextFormat
- Indicates the color of the text.
color — Property in class flash.text.engine.ElementFormat
- Indicates the color of the text.
COLOR — Constant static property in class flash.display3D.Context3DClearMask
- Clear only the color buffer.
COLOR — Constant static property in class flash.filters.DisplacementMapFilterMode
- If the displacement value is outside the image, substitutes the values in - the color and alpha properties.
colorCorrection — Property in class flash.display.Stage
- Controls Flash runtime color correction for displays.
ColorCorrection — Final class in package flash.display
-The ColorCorrection class provides values for the flash.display.Stage.colorCorrection property.
colorCorrectionSupport — Property in class flash.display.Stage
- Specifies whether the Flash runtime is running on an operating system that supports - color correction and whether the color profile of the main (primary) - monitor can be read and understood by the Flash runtime.
ColorCorrectionSupport — Final class in package flash.display
-The ColorCorrectionSupport class provides values for the flash.display.Stage.colorCorrectionSupport property.
colorDepth — Property in class flash.display.Screen
- - The color depth of this screen (expressed in number of bits).
colorDepth — Property in class flash.display.ScreenMode
- The color depth of the ScreenMode in number of bits.
ColorMatrixFilter — Final class in package flash.filters
-The ColorMatrixFilter class lets you apply a 4 x 5 matrix transformation on the RGBA color and alpha values -of every pixel in the input image to produce a result with a new set of RGBA color and alpha values.
ColorMatrixFilter(matrix:Array) — Constructor in class flash.filters.ColorMatrixFilter
- Initializes a new ColorMatrixFilter instance with the specified parameters.
colors — Property in class flash.display.GraphicsGradientFill
- An array of RGB hexadecimal color values to use in the gradient.
colors — Property in class flash.filters.GradientBevelFilter
- An array of RGB hexadecimal color values to use in the gradient.
colors — Property in class flash.filters.GradientGlowFilter
- An array of colors that defines a gradient.
colorSpace — Property in class flash.display.JPEGXREncoderOptions
- Specifies how color channels are sampled.
colorSpace — Property in class flash.events.StageVideoEvent
- The color space used by the video being displayed in the StageVideo object.
colorSpace — Property in class flash.events.VideoTextureEvent
- The color space used by the video being displayed in the VideoTexture object.
COLORSPACE_4_2_0 — Constant static property in class flash.display.BitmapEncodingColorSpace
- Specifies a subsampling scheme of 4:2:0.
COLORSPACE_4_2_2 — Constant static property in class flash.display.BitmapEncodingColorSpace
- Specifies a subsampling scheme of 4:2:2.
COLORSPACE_4_4_4 — Constant static property in class flash.display.BitmapEncodingColorSpace
- Specifies a subsampling scheme of 4:4:4.
COLORSPACE_AUTO — Constant static property in class flash.display.BitmapEncodingColorSpace
- Specifies a subsampling scheme of auto.
colorSpaces — Property in class flash.media.StageVideo
- Returns the names of available color spaces for this video surface.
colorTransform(rect:flash.geom:Rectangle, colorTransform:flash.geom:ColorTransform) — Method in class flash.display.BitmapData
- - Adjusts the color values in a specified area of a bitmap image by using a - - ColorTransform object.
colorTransform — Property in class flash.geom.Transform
- A ColorTransform object containing values that universally adjust the colors in - the display object.
ColorTransform — Class in package flash.geom
- The ColorTransform class lets you adjust the color values in a display object.
ColorTransform(redMultiplier:Number, greenMultiplier:Number, blueMultiplier:Number, alphaMultiplier:Number, redOffset:Number, greenOffset:Number, blueOffset:Number, alphaOffset:Number) — Constructor in class flash.geom.ColorTransform
- Creates a ColorTransform object for a display object with the specified - color channel values and alpha values.
columnNameStyle — Property in class flash.data.SQLConnection
- Indicates how column names are reported in the - result of a SELECT statement.
columns — Property in class flash.data.SQLTableSchema
- An array of SQLColumnSchema instances containing schema information for this table's columns.
COMMA — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the , key (188).
COMMAND — Constant static property in class flash.ui.Keyboard
- - Constant associated with the Mac command key (15).
commandKey — Property in class flash.events.GestureEvent
- Indicates whether the command key is activated (Mac only).
commandKey — Property in class flash.events.KeyboardEvent
- - Indicates whether the Command key is active (true) or inactive (false).
commandKey — Property in class flash.events.MouseEvent
- - Indicates whether the command key is activated (Mac only.) - - - -

The value of property commandKey - - will have the same value as property ctrlKey on the Mac.

commandKey — Property in class flash.events.TouchEvent
- Indicates whether the command key is activated (Mac only).
commands — Property in class flash.display.GraphicsPath
- The Vector of drawing commands as integers representing the path.
comment — Property in class flash.media.ID3Info
- A comment about the recording; corresponds to the ID3 2.0 tag COMM.
comments() — Method in class XML
- - Lists the properties of the XML object that contain XML comments.
comments() — Method in class XMLList
- - Calls the comments() method of each XML object and returns - - an XMLList of comments.
commit — Event in class flash.data.SQLConnection
- Dispatched when a commit() method call's operation - completes successfully.
commit(responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Commits an existing transaction, causing any actions performed by the transaction's - statements to be permanently applied to the database.
COMMIT — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.commit() method was called.
COMMIT — Constant static property in class flash.events.SQLEvent
- The SQLEvent.COMMIT constant defines the value of the - type property of a commit event object.
COMMON — Constant static property in class flash.text.engine.LigatureLevel
- Used to specify common ligatures.
commonName — Property in class flash.security.X500DistinguishedName
- Returns the DN CommonName attribute.
compact — Event in class flash.data.SQLConnection
- Dispatched when a compact() method call's operation - completes successfully.
compact(responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Reclaims all unused space in the database.
COMPACT — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.compact() method was called.
COMPACT — Constant static property in class flash.events.SQLEvent
- The SQLEvent.COMPACT constant defines the value of the - type property of a compact event object.
compare(otherBitmapData:flash.display:BitmapData) — Method in class flash.display.BitmapData
- - - Compares two BitmapData objects.
compare(string1:String, string2:String) — Method in class flash.globalization.Collator
- Compares two strings and returns an integer value indicating whether the first string is - less than, equal to, or greater than the second string.
complete — Event in class air.system.License
- - Dispatched when the online license check has completed successfully.
complete — Event in class air.utils.ZipArchive
- - Dispatched when an asynchronous zip/unzip operation has completed.
complete — Property in class flash.data.SQLResult
- Indicates whether all the resulting data from a statement execution has been returned.
complete — Event in class flash.display.LoaderInfo
- Dispatched when data has loaded successfully.
complete — Event in class flash.display.ShaderJob
- Dispatched when a ShaderJob that executes asynchronously finishes processing - the data using the shader.
complete — Event in class flash.filesystem.File
- - Dispatched when an asynchronous operation is complete.
complete — Event in class flash.filesystem.FileStream
- Signals that the end of the stream has been reached.
complete — Event in class flash.filesystem.StorageVolumeInfo
- - Dispatched when an asynchronous request to list the current storage volumes has completed.
complete — Event in class flash.media.CameraRoll
- Signals that an addBitmapData() operation completed successfully.
complete — Event in class flash.media.CameraUI
- The complete event is dispatched when the user either captures a still picture or - video in the Camera UI.
complete — Event in class flash.media.MediaPromise
- A MediaPromise object dispatches a complete event when all data has been read.
complete — Event in class flash.media.Sound
- Dispatched when data has loaded successfully.
complete — Event in class flash.media.StageWebView
- - Signals that the last load operation requested by loadString() or - - loadURL() method has completed.
complete — Event in class flash.net.FileReference
- Dispatched when download is complete or when upload generates an HTTP status code of 200.
complete — Event in class flash.net.URLLoader
- - Dispatched after all the received data is decoded and - - placed in the data property of the URLLoader object.
complete — Event in class flash.net.URLStream
- - Dispatched when data has loaded successfully.
complete — Event in class flash.security.XMLSignatureValidator
- Dispatched when verification is complete.
complete — Event in class flash.system.SystemUpdater
- Dispatched when the update completes.
complete — Event in class flash.text.StageText
- - Dispatched after setting a non-null stage and non-empty viewPort.
COMPLETE — Constant static property in class flash.events.Event
- The Event.COMPLETE constant defines the value of the type property of a complete event object.
COMPLETE — Constant static property in class flash.events.MediaEvent
- A constant for the complete MediaEvent.
COMPLETE — Constant static property in class flash.events.ShaderEvent
- Defines the value of the type property of a complete event object.
COMPLETE — Constant static property in class flash.text.engine.TextLineCreationResult
- Indicates no line was created because all text in the block had already been broken.
componentX — Property in class flash.filters.DisplacementMapFilter
- Describes which color channel to use in the map image to displace the x result.
componentY — Property in class flash.filters.DisplacementMapFilter
- Describes which color channel to use in the map image to displace the y result.
composeTrailingIdeographicSpaces — Property in class flash.text.engine.EastAsianJustifier
- Specifies whether ideographic spaces at the ends of lines should be composed or dropped during justification.
compositionAbandoned() — Static method in class flash.system.IME
- Causes the runtime to abandon any composition that is in progress.
CompositionAttributeRange — Final class in package flash.text.ime
-The CompositionAttributeRange class represents a range of composition attributes for use with IME (input method editor) events.
CompositionAttributeRange(relativeStart:int, relativeEnd:int, selected:Boolean, converted:Boolean) — Constructor in class flash.text.ime.CompositionAttributeRange
- Creates a CompositionAttributeRange object.
compositionEndIndex — Property in interface flash.text.ime.IIMEClient
- The zero-based character index value of the end of the current edit session text (such as - all text in the inline session that is not confirmed to the document).
compositionSelectionChanged(start:int, end:int) — Static method in class flash.system.IME
- Call this method when the selection within the composition has been updated, either interactively or - programmatically.
compositionStartIndex — Property in interface flash.text.ime.IIMEClient
- The zero-based character index value of the start of the current edit session text (such as - all text in the inline session that is not confirmed to the document).
compress — Property in class air.utils.ZipEntry
- - Whether or not the data will be compressed when it is stored into an archive.
compress(algorithm:String) — Method in class flash.utils.ByteArray
- - Compresses the byte array.
COMPRESSED — Constant static property in class flash.display3D.Context3DTextureFormat
- -
COMPRESSED_ALPHA — Constant static property in class flash.display3D.Context3DTextureFormat
- -
CompressionAlgorithm — Final class in package flash.utils
- - The CompressionAlgorithm class defines string constants for the names of compress and uncompress options.
computeSpectrum(outputArray:flash.utils:ByteArray, FFTMode:Boolean, stretchFactor:int) — Static method in class flash.media.SoundMixer
- Takes a snapshot of the current sound wave and places it into the specified ByteArray object.
concat(... rest) — Method in class Array
- - Concatenates the elements specified in the parameters with the elements in an array and creates a new array.
concat(... rest) — Method in class String
- - Appends the supplied arguments to the end of the String object, converting them to strings if - - necessary, and returns the resulting string.
concat(... rest) — Method in class Vector
- Concatenates the Vectors specified in the parameters list with the elements - in this Vector and creates a new Vector.
concat(second:flash.geom:ColorTransform) — Method in class flash.geom.ColorTransform
Concatenates the ColorTranform object specified by the second parameter - with the current ColorTransform object and sets the - current object as the result, which is an additive combination of the two color transformations.
concat(m:flash.geom:Matrix) — Method in class flash.geom.Matrix
- - Concatenates a matrix with the current matrix, effectively combining the - - geometric effects of the two.
concatenatedColorTransform — Property in class flash.geom.Transform
- A ColorTransform object representing the combined color transformations applied to the display object - and all of its parent objects, back to the root level.
concatenatedMatrix — Property in class flash.geom.Transform
- A Matrix object representing the combined transformation matrixes of the - display object and all of its parent objects, back to the root level.
condenseWhite — Property in class flash.text.TextField
- - A Boolean value that specifies whether extra white space (spaces, line breaks, and so on) - - in a text field with HTML text is removed.
Condition — Final class in package flash.concurrent
- - A Condition object is a tool for sharing a resource between workers with the - - additional capability of pausing execution until a particular condition is - - satisfied.
Condition(mutex:flash.concurrent:Mutex) — Constructor in class flash.concurrent.Condition
- - Creates a new Condition instance.
configurationFile — Property in class air.update.ApplicationUpdater
- - The location of the configuration file that sets the values for delay and - - updateURL properties.
configurationFile — Property in class air.update.ApplicationUpdaterUI
- - The location of the configuration file that sets the values for delay and - - updateURL properties.
configureBackBuffer(width:int, height:int, antiAlias:int, enableDepthAndStencil:Boolean, wantsBestResolution:Boolean, wantsBestResolutionOnBrowserZoom:Boolean) — Method in class flash.display3D.Context3D
- - Sets the viewport dimensions and other attributes of the rendering buffer.
confirmComposition(text:String, preserveSelection:Boolean) — Method in interface flash.text.ime.IIMEClient
- Use this callback to end the inline editing session and confirm the text.
connect — Event in class air.net.WebSocket
- - Dispatched when a client WebSocket is connected (following successful handshake).
connect(url:String, protocols) — Method in class air.net.WebSocket
- - Initiates a connection as a WebSocket client.
connect(remoteAddress:String, remotePort:int) — Method in class flash.net.DatagramSocket
- - Connects the socket to a specified remote address and port.
connect(connectionName:String) — Method in class flash.net.LocalConnection
- Prepares a LocalConnection object to receive commands that are sent from a send() command - (from the sending LocalConnection object).
connect(command:String, ... rest) — Method in class flash.net.NetConnection
- Creates a two-way connection to an application on Flash Media Server or to Flash Remoting, or creates a two-way network - endpoint for RTMFP peer-to-peer group communication.
connect — Event in class flash.net.SecureSocket
- - Dispatched when a network connection has been established.
connect(host:String, port:int) — Method in class flash.net.SecureSocket
- - Connects the socket to the specified host and port using SSL or TLS.
connect — Event in class flash.net.ServerSocket
- Dispatched when a remote socket seeks to connect to this server socket.
connect(myConnection:flash.net:NetConnection, params:String) — Method in class flash.net.SharedObject
- Connects to a remote shared object on a server through a specified NetConnection object.
connect — Event in class flash.net.Socket
- - Dispatched when a network connection has been established.
connect(host:String, port:int) — Method in class flash.net.Socket
- - Connects the socket to the specified host and port.
connect — Event in class flash.net.XMLSocket
- Dispatched after a successful call to the XMLSocket.connect() method.
connect(host:String, port:int) — Method in class flash.net.XMLSocket
- Establishes a connection to the specified Internet host using the specified TCP port.
CONNECT — Constant static property in class flash.events.Event
- The Event.CONNECT constant defines the value of the type property of a connect event object.
CONNECT — Constant static property in class flash.events.ServerSocketConnectEvent
- Defines the value of the type property of a ServerSocketConnectEvent event object.
connected — Property in class flash.data.SQLConnection
- Indicates whether the SQLConnection instance has an open connection - to a database file.
connected — Property in class flash.net.DatagramSocket
- - Indicates whether this socket object is currently connected to a remote address - - and port.
connected — Property in class flash.net.NetConnection
- Indicates whether the application is connected to a server through - a persistent RTMP connection (true) or not (false).
connected — Property in class flash.net.Socket
- - Indicates whether this Socket object is currently connected.
connected — Property in class flash.net.URLStream
- - Indicates whether this URLStream object is - - currently connected.
connected — Property in class flash.net.XMLSocket
- Indicates whether this XMLSocket object is currently connected.
connected — Static property in class flash.profiler.Telemetry
- Indicates whether Telemetry is connected to a server -
connectedProxyType — Property in class flash.net.NetConnection
- The proxy type used to make a successful connection to Flash Media Server.
CONNECT_TO_FMS — Constant static property in class flash.net.NetStream
- A static object used as a parameter to - the constructor for a NetStream instance.
const — Statement
Specifies a constant, which is a variable that can be assigned a value only once.
__construct(args:Array) — Method in class flash.external.HostObject
- The universal constructor method initizalizes a new instance of the - current class.
constructor — Property in class Object
- - A reference to the class object or constructor function for a given object instance.
constructor — Property in class flash.display.Stage
CONTACT — Constant static property in class flash.text.SoftKeyboardType
-

A keypad designed for entering a person's name or phone number.

contains(value:XML) — Method in class XML
- - Compares the XML object against the given value parameter.
contains(value:XML) — Method in class XMLList
- - Checks whether the XMLList object contains an XML object that is equal to the given - - value parameter.
contains(child:flash.display:DisplayObject) — Method in class flash.display.DisplayObjectContainer
- Determines whether the specified display object is a child of the DisplayObjectContainer instance or - the instance itself.
contains(x:Number, y:Number) — Method in class flash.geom.Rectangle
- - Determines whether the specified point is contained within the rectangular region defined - - by this Rectangle object.
containsDebugInfo — Static property in class flash.system.System
- - Property to check whether any loaded SWF has contained debug information.
containsItem(item:flash.display:NativeMenuItem) — Method in class flash.display.NativeMenu
- - Reports whether this menu contains the specified menu item.
containsItem(item:flash.display:NativeMenuItem) — Method in class flash.ui.ContextMenu
- Reports whether this menu contains the specified menu item.
containsPoint(point:flash.geom:Point) — Method in class flash.geom.Rectangle
- - Determines whether the specified point is contained within the rectangular region defined - - by this Rectangle object.
containsRect(rect:flash.geom:Rectangle) — Method in class flash.geom.Rectangle
- - Determines whether the Rectangle object specified by the rect parameter is contained - - within this Rectangle object.
content — Property in class flash.display.Loader
- - Contains the root display object of the SWF file or image (JPG, PNG, or GIF) - - file that was loaded by using the load() or loadBytes() methods.
content — Property in class flash.display.LoaderInfo
- The loaded object associated with this LoaderInfo object.
content — Property in class flash.text.engine.TextBlock
- Holds the contents of the text block.
contentData — Property in class flash.events.DRMErrorEvent
- The DRMContentData for the media file.
contentData — Property in class flash.events.DRMStatusEvent
- A DRMContentData object containing the information necessary - to obtain a voucher for viewing the DRM-protected content.
ContentElement — Class in package flash.text.engine
- The ContentElement class serves as a base class for the element types that can appear in a GroupElement, namely a GraphicElement, - another GroupElement, or a TextElement.
ContentElement(elementFormat:flash.text.engine:ElementFormat, eventMirror:flash.events:EventDispatcher, textRotation:String) — Constructor in class flash.text.engine.ContentElement
- Calling the new ContentElement() constructor throws an - ArgumentError exception.
contentHeight — Property in class flash.html.HTMLLoader
contentLoaderInfo — Property in class flash.display.Loader
- - Returns a LoaderInfo object corresponding to the object being loaded.
contentsScaleFactor — Property in class flash.display.Screen
- - The scale factor of the screen - - -
contentsScaleFactor — Property in class flash.display.Stage
- Specifies the effective pixel scaling factor of the stage.
CONTENT_TRIGGERED — Constant static property in class flash.events.SoftKeyboardTrigger
- Indicates that ActionScript invoked the event.
contentType — Property in class flash.display.LoaderInfo
- The MIME type of the loaded file.
contentType — Property in class flash.net.URLRequest
- The MIME content type of the content in the the data property.
contentType — Property in class flash.text.StageText
- - Provides a hint to the operating system as to the type of content for the text input field.
contentWidth — Property in class flash.html.HTMLLoader
context3D — Property in class flash.display.Stage3D
- The Context3D object associated with this Stage3D instance.
Context3D — Final class in package flash.display3D
- - The Context3D class provides a context for rendering geometrically defined graphics.
Context3DBlendFactor — Final class in package flash.display3D
- Defines the values to use for specifying the source and destination blend factors.
Context3DBufferUsage — Final class in package flash.display3D
- Defines the values to use for specifying the buffer usage type.
Context3DClearMask — Final class in package flash.display3D
- Defines the values to use for specifying Context3D clear masks.
Context3DCompareMode — Final class in package flash.display3D
- Defines the values to use for specifying 3D buffer comparisons in the setDepthTest() and setStencilAction() methods - of a Context3D instance.
context3DCreate — Event in class flash.display.Stage3D
- Dispatched when a rendering context is created.
CONTEXT3D_CREATE — Constant static property in class flash.events.Event
- The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
Context3DFillMode — Final class in package flash.display3D
- Defines the values to use for specifying 3D render fill mode in the setFillMode() methods - of a Context3D instance.
Context3DMipFilter — Final class in package flash.display3D
- Defines the values to use for sampler mipmap filter mode - -
Context3DProfile — Final class in package flash.display3D
- Defines the values to use for specifying the Context3D profile.
Context3DProgramType — Final class in package flash.display3D
- Defines the values to use for specifying whether a shader program is - a fragment or a vertex program.
Context3DRenderMode — Final class in package flash.display3D
- Defines the values to use for specifying the Context3D render mode.
Context3DStencilAction — Final class in package flash.display3D
- Defines the values to use for specifying stencil actions.
Context3DTextureFilter — Final class in package flash.display3D
- Defines the values to use for sampler filter mode.
Context3DTextureFormat — Final class in package flash.display3D
- Defines the values to use for specifying a texture format.
Context3DTriangleFace — Final class in package flash.display3D
- Constants to specify the orientation of a triangle relative to the view point.
Context3DVertexBufferFormat — Final class in package flash.display3D
- Defines the values to use for specifying vertex buffers.
Context3DWrapMode — Final class in package flash.display3D
- Defines the values to use for sampler wrap mode - -
contextMenu — Event in class flash.display.InteractiveObject
- - Dispatched when a user gesture triggers the context menu associated with this interactive - - object in an AIR application.
contextMenu — Property in class flash.display.InteractiveObject
- - Specifies the context menu associated with this object.
ContextMenu — Final class in package flash.ui
- The ContextMenu class provides control over the items displayed in context menus.
ContextMenu() — Constructor in class flash.ui.ContextMenu
- Creates a ContextMenu object.
CONTEXT_MENU — Constant static property in class flash.events.MouseEvent
- - The MouseEvent.CONTEXT_MENU constant defines the value of the - - type property of a contextMenu event object.
ContextMenuBuiltInItems — Final class in package flash.ui
-The ContextMenuBuiltInItems class describes the items that are built in to a context menu.
ContextMenuBuiltInItems() — Constructor in class flash.ui.ContextMenuBuiltInItems
-Creates a new ContextMenuBuiltInItems object so that you can set the properties for Flash Player to display or hide each menu item.
ContextMenuClipboardItems — Final class in package flash.ui
- The ContextMenuClipboardItems class lets you enable or disable the commands in the clipboard context menu.
ContextMenuClipboardItems() — Constructor in class flash.ui.ContextMenuClipboardItems
- Creates a new ContextMenuClipboardItems object.
ContextMenuEvent — Class in package flash.events
- An InteractiveObject dispatches a ContextMenuEvent object when the user opens or interacts with - the context menu.
ContextMenuEvent(type:String, bubbles:Boolean, cancelable:Boolean, mouseTarget:flash.display:InteractiveObject, contextMenuOwner:flash.display:InteractiveObject) — Constructor in class flash.events.ContextMenuEvent
- Creates an Event object that contains specific information about menu events.
ContextMenuItem — Final class in package flash.ui
- The ContextMenuItem class represents an item in the context - menu.
ContextMenuItem(caption:String, separatorBefore:Boolean, enabled:Boolean, visible:Boolean) — Constructor in class flash.ui.ContextMenuItem
- Creates a new ContextMenuItem object that can be added to the ContextMenu.customItems - array.
contextMenuOwner — Property in class flash.events.ContextMenuEvent
- The display list object to which the menu is attached.
continue — Statement
Jumps past all remaining statements in the innermost loop and starts the next iteration of the loop as if control had passed through to the end of the loop normally.
CONTROL — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Control key (17).
controlKey — Property in class flash.events.GestureEvent
- Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
controlKey — Property in class flash.events.KeyboardEvent
- - Indicates whether the Control key is active (true) or inactive (false).
controlKey — Property in class flash.events.MouseEvent
- - Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
controlKey — Property in class flash.events.TouchEvent
- Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
conversionMode — Static property in class flash.system.IME
- The conversion mode of the current IME.
convertColorProfile(source:flash.display:Screen, destination:flash.display:Screen) — Method in class flash.display.BitmapData
- - Create a copy of the image data, converting between color profiles based on the provided - - Screen objects.
converted — Property in class flash.text.ime.CompositionAttributeRange
- A property defining the current clause has been processed by the IME - and the clause is waiting to be accepted or confirmed by the user.
convertPeerIDToGroupAddress(peerID:String) — Method in class flash.net.NetGroup
- Converts a peerID to a group address suitable for use with the sendToNearest() method.
ConvolutionFilter — Class in package flash.filters
-The ConvolutionFilter class applies a matrix convolution filter effect.
ConvolutionFilter(matrixX:Number, matrixY:Number, matrix:Array, divisor:Number, bias:Number, preserveAlpha:Boolean, clamp:Boolean, color:uint, alpha:Number) — Constructor in class flash.filters.ConvolutionFilter
- Initializes a ConvolutionFilter instance with the specified parameters.
copies — Property in class flash.printing.PrintJob
- The number of copies that the print system prints of any pages subsequently added to the - print job.
copy() — Method in class XML
- - Returns a copy of the given XML object.
copy() — Method in class XMLList
- - Returns a copy of the given XMLList object.
copy() — Method in class flash.desktop.NativeApplication
- - Invokes an internal copy command on the focused display object.
copy — Event in class flash.display.InteractiveObject
- - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - - or selects 'Copy' from the text context menu.
copy — Property in class flash.ui.ContextMenuClipboardItems
- Enables or disables the 'Copy' item on the clipboard menu.
COPY — Constant static property in class flash.desktop.NativeDragActions
- Defines the string to use for the copy action.
COPY — Constant static property in class flash.events.Event
- Defines the value of the type property of a copy event object.
copyChannel(sourceBitmapData:flash.display:BitmapData, sourceRect:flash.geom:Rectangle, destPoint:flash.geom:Point, sourceChannel:uint, destChannel:uint) — Method in class flash.display.BitmapData
- - Transfers data from one channel of another BitmapData object or the current - - BitmapData object into a channel of the current BitmapData object.
copyColumnFrom(column:uint, vector3D:flash.geom:Vector3D) — Method in class flash.geom.Matrix
- - Copies a Vector3D object into specific column of the calling Matrix3D object.
copyColumnFrom(column:uint, vector3D:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Copies a Vector3D object into specific column of the calling Matrix3D object.
copyColumnTo(column:uint, vector3D:flash.geom:Vector3D) — Method in class flash.geom.Matrix
- - Copies specific column of the calling Matrix object into the Vector3D object.
copyColumnTo(column:uint, vector3D:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Copies specific column of the calling Matrix3D object into the Vector3D object.
copyConcatenatedColorTransformToOutput(output:flash.geom:ColorTransform) — Method in class flash.geom.Transform
- A ColorTransform object representing the combined color transformations applied to the display object - and all of its parent objects, back to the root level.
copyConcatenatedMatrixToOutput(output:flash.geom:Matrix) — Method in class flash.geom.Transform
- A Matrix object representing the combined transformation matrixes of the - display object and all of its parent objects, back to the root level.
copyFrom(sourceGraphics:flash.display:Graphics) — Method in class flash.display.Graphics
- Copies all of drawing commands from the source Graphics object into the - calling Graphics object.
copyFrom(sourceMatrix:flash.geom:Matrix) — Method in class flash.geom.Matrix
- - Copies all of the matrix data from the source Point object into the - - calling Matrix object.
copyFrom(sourceMatrix3D:flash.geom:Matrix3D) — Method in class flash.geom.Matrix3D
- Copies all of the matrix data from the source Matrix3D object into the - calling Matrix3D object.
copyFrom(sourcePoint:flash.geom:Point) — Method in class flash.geom.Point
- Copies all of the point data from the source Point object into the - calling Point object.
copyFrom(sourceRect:flash.geom:Rectangle) — Method in class flash.geom.Rectangle
- - Copies all of rectangle data from the source Rectangle object into the - - calling Rectangle object.
copyFrom(sourceVector3D:flash.geom:Vector3D) — Method in class flash.geom.Vector3D
- Copies all of vector data from the source Vector3D object into the - calling Vector3D object.
copyPerspectiveProjectionToOutput(output:flash.geom:PerspectiveProjection) — Method in class flash.geom.Transform
- Provides access to the PerspectiveProjection object of a three-dimensional display - object.
copyPixelBoundsToOutput(output:flash.geom:Rectangle) — Method in class flash.geom.Transform
- Provides access to the Rectangle object that defines the bounding rectangle of the display object on the stage.
copyPixels(sourceBitmapData:flash.display:BitmapData, sourceRect:flash.geom:Rectangle, destPoint:flash.geom:Point, alphaBitmapData:flash.display:BitmapData, alphaPoint:flash.geom:Point, mergeAlpha:Boolean) — Method in class flash.display.BitmapData
- - Provides a fast routine to perform pixel manipulation - - between images with no stretching, rotation, or color effects.
copyPixelsToByteArray(rect:flash.geom:Rectangle, data:flash.utils:ByteArray) — Method in class flash.display.BitmapData
- - Fills a byte array from a rectangular region of pixel data.
copyRawDataFrom(vector, index:uint, transpose:Boolean) — Method in class flash.geom.Matrix3D
- Copies all of the vector data from the source vector object into the - calling Matrix3D object.
copyRawDataTo(vector, index:uint, transpose:Boolean) — Method in class flash.geom.Matrix3D
- Copies all of the matrix data from the calling Matrix3D object into the - provided vector.
copyright — Property in class flash.external.ExtensionInfo
- - The extension copyright information, as provided in the extension's XML descriptor file.
copyRowFrom(row:uint, vector3D:flash.geom:Vector3D) — Method in class flash.geom.Matrix
- - Copies a Vector3D object into specific row of the calling Matrix object.
copyRowFrom(row:uint, vector3D:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Copies a Vector3D object into specific row of the calling Matrix3D object.
copyRowTo(row:uint, vector3D:flash.geom:Vector3D) — Method in class flash.geom.Matrix
- - Copies specific row of the calling Matrix object into the Vector3D object.
copyRowTo(row:uint, vector3D:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Copies specific row of the calling Matrix3D object into the Vector3D object.
copyTo(newLocation:flash.net:FileReference, overwrite:Boolean) — Method in class flash.filesystem.File
- - Copies the file or directory at the location specified by this File object to - - the location specified by the newLocation parameter.
copyToAsync(newLocation:flash.net:FileReference, overwrite:Boolean) — Method in class flash.filesystem.File
- - Begins copying the file or directory at the location specified by this File object to - - the location specified by the destination parameter.
copyToByteArray(rect:flash.geom:Rectangle, destination:flash.utils:ByteArray) — Method in class flash.media.Camera
- - Fills a byte array from a rectangular region of pixel data - - -

Writes an unsigned integer (a 32-bit unmultiplied pixel value) - - for each pixel into the byte array.

copyToMatrix3D(dest:flash.geom:Matrix3D) — Method in class flash.geom.Matrix3D
copyToVector(rect:flash.geom:Rectangle, destination) — Method in class flash.media.Camera
- - Fills a vector from a rectangular region of pixel data.
cos(angleRadians:Number) — Static method in class Math
- - Computes and returns the cosine of the specified angle in radians.
countryName — Property in class flash.security.X500DistinguishedName
- Returns the DN CountryName attribute.
CPU — Constant static property in class flash.display.NativeWindowRenderMode
- A cpu mode window.
cpuAddressSize — Static property in class flash.system.Capabilities
- Specifies whether the Flash Player or AIR application running on the system is 32-bit or 64-bit.
cpuArchitecture — Static property in class flash.system.Capabilities
- Specifies the current CPU architecture.
create(className:String, ... rest) — Static method in class flash.external.HostObject
- Generic creation function for a new host object with a varying number of - creation arguments.
CREATE — Constant static property in class flash.data.SQLMode
- Indicates that the connection is opened for updates, and a database - file is created if the specified file doesn't exist.
createBox(scaleX:Number, scaleY:Number, rotation:Number, tx:Number, ty:Number) — Method in class flash.geom.Matrix
- - Includes parameters for scaling, - - rotation, and translation.
createCubeTexture(size:int, format:String, optimizeForRenderToTexture:Boolean, streamingLevels:int) — Method in class flash.display3D.Context3D
- - Creates a CubeTexture object.
createDirectory() — Method in class flash.filesystem.File
- - Creates the specified directory and any necessary parent directories.
createElement(name:String) — Method in class flash.xml.XMLDocument
- Creates a new XMLNode object with the name specified in the parameter.
createExtensionContext(extensionID:String, contextType:String) — Static method in class flash.external.ExtensionContext
- - Creates an ExtensionContext instance for the given extension identifier and context type.
createFromBase64(base64:String) — Static method in class flash.utils.ByteArray
- - Creates a new ByteArray object from a base64-encoded string.
createFromByteArray(fontName:String, fontData:flash.utils:ByteArray, fontWeight:String, fontPosture:String) — Static method in class flash.text.engine.FontDescription
- - Creates a FontDescription object using font data loaded dynamically from a file.
createFromFile(file:flash.filesystem:File, compress:Boolean) — Static method in class air.utils.ZipEntry
- - Creates a zip entry based on a file from the file system.
createFromFolder(folder:flash.filesystem:File, recurse:Boolean, compress:Boolean, includeFolderEntries:Boolean, followLinks:Boolean) — Static method in class air.utils.ZipArchive
- - Creates a new ZipArchive object by zipping up all files within a folder.
createFromHexString(hex:String) — Static method in class flash.utils.ByteArray
- - Creates a new ByteArray object from a hex-encoded string.
createGradientBox(width:Number, height:Number, rotation:Number, tx:Number, ty:Number) — Method in class flash.geom.Matrix
- - Creates the specific style of matrix expected by the beginGradientFill() and - - lineGradientStyle() methods of the Graphics class.
createIndexBuffer(numIndices:int, bufferUsage:String) — Method in class flash.display3D.Context3D
- - Creates an IndexBuffer3D object.
createMessageChannel(receiver:flash.system:Worker) — Method in class flash.system.Worker
- Creates a new MessageChannel instance to send messages from the worker on - which the method is called to another receiver worker.
createProgram() — Method in class flash.display3D.Context3D
- - Creates a Program3D object.
createRectangleTexture(width:int, height:int, format:String, optimizeForRenderToTexture:Boolean) — Method in class flash.display3D.Context3D
- - Creates a Rectangle Texture object.
createRootWindow(visible:Boolean, windowInitOptions:flash.display:NativeWindowInitOptions, scrollBarsVisible:Boolean, bounds:flash.geom:Rectangle) — Static method in class flash.html.HTMLLoader
createTempDirectory() — Static method in class flash.filesystem.File
- - Returns a reference to a new temporary directory.
createTempFile() — Static method in class flash.filesystem.File
- - Returns a reference to a new temporary file.
createTextLine(previousLine:flash.text.engine:TextLine, width:Number, lineOffset:Number, fitSomething:Boolean) — Method in class flash.text.engine.TextBlock
- Instructs the text block to create a line of text from its content, beginning at the point - specified by the previousLine parameter and breaking at the point specified by the - width parameter.
createTextNode(text:String) — Method in class flash.xml.XMLDocument
- Creates a new XML text node with the specified text.
createTexture(width:int, height:int, format:String, optimizeForRenderToTexture:Boolean, streamingLevels:int) — Method in class flash.display3D.Context3D
- - Creates a Texture object.
createVertexBuffer(numVertices:int, data32PerVertex:int, bufferUsage:String) — Method in class flash.display3D.Context3D
- - Creates a VertexBuffer3D object.
createVertexBufferForInstances(numVertices:int, data32PerVertex:int, instancesPerElement:int, bufferUsage:String) — Method in class flash.display3D.Context3D
- - Creates a VertexBuffer3D object for instances data.
createVideoTexture() — Method in class flash.display3D.Context3D
- - Creates a VideoTexture object.
createWindow(windowCreateOptions:flash.html:HTMLWindowCreateOptions) — Method in class flash.html.HTMLHost
- The function called when JavaScript code in the HTMLLoader object calls the - window.open() method.
createWorker(swf:flash.utils:ByteArray, giveAppPrivileges:Boolean) — Method in class flash.system.WorkerDomain
- Creates a new Worker instance from the bytes of a swf.
creationDate — Property in class air.system.License
- - Date of creation of the license file (as embedded in the adt.lic file) - -
creationDate — Property in class flash.net.FileReference
- The creation date of the file on the local disk.
creator — Property in class flash.net.FileReference
- The Macintosh creator type of the file, which is only used in Mac OS versions - prior to Mac OS X.
CRITICAL — Constant static property in class flash.desktop.NotificationType
- Specifies that a notification alert is critical in nature and the user should attend to it promptly.
crossProduct(a:flash.geom:Vector3D) — Method in class flash.geom.Vector3D
- Returns a new Vector3D object that is perpendicular (at a right angle) to the current - Vector3D and another Vector3D object.
crossProductToOutput(a:flash.geom:Vector3D, output:flash.geom:Vector3D) — Method in class flash.geom.Vector3D
- Returns a new Vector3D object that is perpendicular (at a right angle) to the current - Vector3D and another Vector3D object.
CRT — Constant static property in class flash.text.TextDisplayMode
- Forces Flash Player to display grayscale anti-aliasing.
CSMSettings — Final class in package flash.text
- The CSMSettings class contains properties for use with the - TextRenderer.setAdvancedAntiAliasingTable() method - to provide continuous stroke modulation (CSM).
CSMSettings(fontSize:Number, insideCutoff:Number, outsideCutoff:Number) — Constructor in class flash.text.CSMSettings
- Creates a new CSMSettings object which stores stroke values for custom anti-aliasing settings.
ctrlKey — Property in class flash.events.GestureEvent
- On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
ctrlKey — Property in class flash.events.KeyboardEvent
- - On Windows and Linux, indicates whether the Ctrl key is active (true) or inactive (false); - - On Mac OS, indicates whether either the Ctrl key or the Command key is active.
ctrlKey — Property in class flash.events.MouseEvent
- - On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
ctrlKey — Property in class flash.events.TouchEvent
- On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
CubeTexture — Final class in package flash.display3D.textures
- - The CubeTexture class represents a cube texture uploaded to a rendering context.
cubicCurveTo(controlX1:Number, controlY1:Number, controlX2:Number, controlY2:Number, anchorX:Number, anchorY:Number) — Method in class flash.display.Graphics
- Draws a cubic Bezier curve from the current drawing position to the specified anchor point.
cubicCurveTo(controlX1:Number, controlY1:Number, controlX2:Number, controlY2:Number, anchorX:Number, anchorY:Number) — Method in class flash.display.GraphicsPath
- Adds a new "cubicCurveTo" command to the commands vector and - new coordinates to the data vector.
CUBIC_CURVE_TO — Constant static property in class flash.display.GraphicsPathCommand
- Specifies a drawing command that draws a curve from the current drawing position to the x- and y-coordinates - specified in the data vector, using a 2 control points.
culling — Property in class flash.display.GraphicsTrianglePath
- Specifies whether to render triangles that face in a given direction.
CurrencyFormatter — Final class in package flash.globalization
- The CurrencyFormatter class provides locale-sensitive formatting and parsing of currency values.
CurrencyFormatter(requestedLocaleIDName:String) — Constructor in class flash.globalization.CurrencyFormatter
- Constructs a new CurrencyFormatter object to format numbers representing currency amounts according to - the conventions of a given locale.
currencyISOCode — Property in class flash.globalization.CurrencyFormatter
- The three letter ISO 4217 currency code for the actual locale being used.
CurrencyParseResult — Final class in package flash.globalization
- A data structure that represents a currency amount and currency symbol or string that were extracted by parsing a currency value.
CurrencyParseResult(value:Number, symbol:String) — Constructor in class flash.globalization.CurrencyParseResult
- Constructs a currency parse result object.
currencyString — Property in class flash.globalization.CurrencyParseResult
- The portion of the input string that corresponds to the currency symbol or currency string.
currencySymbol — Property in class flash.globalization.CurrencyFormatter
- The currency symbol or string for the actual locale being used.
current — Static property in class flash.system.Worker
- Provides access to the worker that contains the current code -
current — Static property in class flash.system.WorkerDomain
- The WorkerDomain instance in which the code is currently running.
currentBytesPerSecond — Property in class flash.net.NetStreamInfo
- Specifies the rate at which the NetStream buffer is filled in bytes per second.
currentCount — Property in class flash.utils.Timer
- The total number of times the timer has fired since it started - at zero.
currentDirectory — Property in class flash.events.InvokeEvent
- The directory that should be used to resolve any relative paths in the arguments - array.
currentDomain — Static property in class flash.system.ApplicationDomain
- Gets the current application domain in which your code is executing.
currentDomain — Static property in class flash.system.SecurityDomain
- Gets the current security domain.
currentFPS — Property in class flash.media.Camera
- - The rate at which the camera is capturing data, in frames per second.
currentFPS — Property in class flash.net.NetStream
- The number of frames per second being displayed.
currentFrame — Property in class flash.display.MovieClip
- Specifies the number of the frame in which the playhead is located in the timeline of - the MovieClip instance.
currentFrameLabel — Property in class flash.display.MovieClip
- The label at the current frame in the timeline of the MovieClip instance.
currentLabel — Property in class flash.display.MovieClip
- The current label in which the playhead is located in the timeline of the MovieClip instance.
currentLabels — Property in class flash.display.MovieClip
- Returns an array of FrameLabel objects from the current scene.
currentScene — Property in class flash.display.MovieClip
- The current scene in which the playhead is located in the timeline of the MovieClip instance.
currentState — Property in class air.update.ApplicationUpdater
- - The internal state of the updater.
currentTarget — Property in class flash.events.Event
- The object that is actively processing the Event object with an event listener.
currentVersion — Property in class air.update.ApplicationUpdater
- - The current version of the application.
currentVersion — Property in class air.update.ApplicationUpdaterUI
- - The current version of the application.
currentVolumes — Property in class flash.filesystem.StorageVolumeInfo
- - Returns a vector of the currently known StorageVolume objects.
cursor — Static property in class flash.ui.Mouse
- The name of the native cursor.
curveTo(controlX:Number, controlY:Number, anchorX:Number, anchorY:Number) — Method in class flash.display.Graphics
- Draws a quadratic Bezier curve using the current line style from the current drawing position - to (anchorX, anchorY) and using the control point that (controlX, - controlY) specifies.
curveTo(controlX:Number, controlY:Number, anchorX:Number, anchorY:Number) — Method in class flash.display.GraphicsPath
- Adds a new "curveTo" command to the commands vector and - new coordinates to the data vector.
CURVE_TO — Constant static property in class flash.display.GraphicsPathCommand
- Specifies a drawing command that draws a curve from the current drawing position to the x- and y-coordinates - specified in the data vector, using a control point.
CUSTOM — Constant static property in class flash.globalization.DateTimeStyle
- Specifies that a custom pattern string is used to specify the date or time style.
customItems — Property in class flash.ui.ContextMenu
- An array of ContextMenuItem objects.
cut() — Method in class flash.desktop.NativeApplication
- - Invokes an internal cut command on the focused display object.
cut — Event in class flash.display.InteractiveObject
- - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - - or selects 'Cut' from the text context menu.
cut — Property in class flash.ui.ContextMenuClipboardItems
- Enables or disables the 'Cut' item on the clipboard menu.
CUT — Constant static property in class flash.events.Event
- Defines the value of the type property of a cut event object.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/all-index-D.html b/html-docs/all-index-D.html deleted file mode 100644 index 6d5fefe..0000000 --- a/html-docs/all-index-D.html +++ /dev/null @@ -1,2914 +0,0 @@ - - - - - -D Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
d — Property in class flash.geom.Matrix
- - The value that affects the positioning of pixels - - along the y axis when scaling or rotating an image.
D — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the D key (68).
DARK_COLOR — Constant static property in class flash.text.TextColorType
- Used in the colorType parameter in the setAdvancedAntiAliasingTable() method.
DARKEN — Constant static property in class flash.display.BlendMode
-Selects the darker of the constituent colors of the display object and the colors of the background (the -colors with the smaller values).
data — Property in class air.utils.ZipEntry
- - The (raw/uncompressed) data contained within this zip entry.
data — Property in class flash.data.SQLResult
- The data returned as a result of the statement execution, specifically when - a SQL SELECT statement is executed.
data — Property in class flash.display.GraphicsPath
- The Vector of Numbers containing the parameters used with the drawing commands.
data — Property in class flash.display.NativeMenuItem
- - An arbitrary data object associated with this menu item.
data — Property in class flash.display.Shader
- Provides access to parameters, input images, and metadata for the Shader instance.
data — Property in class flash.events.DataEvent
- - The raw data loaded into Flash Player or Adobe AIR.
data — Property in class flash.events.DatagramSocketDataEvent
- The datagram packet data.
data — Property in class flash.events.MediaEvent
- The MediaPromise object for the available media file.
data — Property in class flash.events.RemoteNotificationEvent
- Contains a JSON-format notification payload.
data — Property in class flash.events.SampleDataEvent
- The data in the audio stream.
data — Property in class flash.events.WebSocketEvent
- - Retrieves the raw data from the WebSocket message.
data — Event in class flash.net.DatagramSocket
- - Dispatched when this socket receives a packet of data.
data — Property in class flash.net.FileReference
- The ByteArray object representing the data from the loaded file after a successful call to the load() method.
data — Property in class flash.net.SharedObject
- The collection of attributes assigned to the data property of the object; these attributes can - be shared and stored.
data — Property in class flash.net.URLLoader
- - The data received from the load operation.
data — Property in class flash.net.URLRequest
- An object containing data to be transmitted with the URL request.
data — Event in class flash.net.XMLSocket
- Dispatched after raw data is sent or received.
data — Property in class flash.ui.MouseCursorData
- A Vector of BitmapData objects containing the cursor image or images.
DATA — Constant static property in class flash.events.DataEvent
- - Defines the value of the type property of a data event object.
DATA — Constant static property in class flash.events.DatagramSocketDataEvent
- Defines the value of the type property of a data event object.
DATA — Constant static property in class flash.events.WebSocketEvent
- - The WebSocketEvent.DATA constant is used when a complete message has been received by a WebSocket object.
database — Property in class flash.data.SQLSchema
- The name of the database to which this schema object belongs.
dataBufferByteLength — Property in class flash.net.NetStreamInfo
- Provides the NetStream data buffer size in bytes.
dataBufferLength — Property in class flash.net.NetStreamInfo
- Provides NetStream data buffer size in seconds.
dataByteCount — Property in class flash.net.NetStreamInfo
- Specifies the total number of bytes of data messages that have arrived in the queue, regardless of how many have been played or flushed.
dataBytesPerSecond — Property in class flash.net.NetStreamInfo
- Specifies the rate at which the NetStream data buffer is filled in bytes per second.
DataEvent — Class in package flash.events
- -An object dispatches a DataEvent object when raw data has completed loading.
DataEvent(type:String, bubbles:Boolean, cancelable:Boolean, data:String) — Constructor in class flash.events.DataEvent
- - Creates an event object that contains information about data events.
dataFormat — Property in class flash.net.URLLoader
- - Controls whether the downloaded data is received as - - text (URLLoaderDataFormat.TEXT), raw binary data - - (URLLoaderDataFormat.BINARY), or URL-encoded variables - - (URLLoaderDataFormat.VARIABLES).
DatagramSocket — Class in package flash.net
- - The DatagramSocket class enables code to send and receive - - Universal Datagram Protocol (UDP) packets.
DatagramSocket() — Constructor in class flash.net.DatagramSocket
- - Creates a DatagramSocket object.
DatagramSocketDataEvent — Class in package flash.events
- A DatagramSocketDataEvent object is dispatched when Datagram socket has received data.
DatagramSocketDataEvent(type:String, bubbles:Boolean, cancelable:Boolean, srcAddress:String, srcPort:int, dstAddress:String, dstPort:int, data:flash.utils:ByteArray) — Constructor in class flash.events.DatagramSocketDataEvent
- Creates an Event object that contains information about datagram events.
dataReliable — Property in class flash.net.NetStream
- For RTMFP connections, specifies whether NetStream.send() calls are sent with full reliability.
dataType — Property in class flash.data.SQLColumnSchema
- Gets the data type of the column as a string.
date — Property in class Date
- - The day of the month (an integer from 1 to 31) specified by a Date object - - according to local time.
Date — Final dynamic class in Top Level
- - The Date class represents date and time information.
Date(yearOrTimevalue:Object, month:Number, date:Number, hour:Number, minute:Number, second:Number, millisecond:Number) — Constructor in class Date
- - Constructs a new Date object that holds the specified date and time.
DateTimeFormatter — Final class in package flash.globalization
- The DateTimeFormatter class provides locale-sensitive formatting for Date objects and access to localized - date field names.
DateTimeFormatter(requestedLocaleIDName:String, dateStyle:String, timeStyle:String) — Constructor in class flash.globalization.DateTimeFormatter
- Constructs a new DateTimeFormatter object to format dates and times according to the conventions of the - specified locale and the provided date and time formatting styles.
DateTimeNameContext — Final class in package flash.globalization
- The DateTimeNameContext class enumerates constant values representing the formatting context in which a month name - or weekday name is used.
DateTimeNameStyle — Final class in package flash.globalization
- The DateTimeNameStyle class enumerates constants that control the length of the month names and weekday names - that are used when formatting dates.
DateTimeStyle — Final class in package flash.globalization
- Enumerates constants that determine a locale-specific date and time formatting pattern.
dateUTC — Property in class Date
- - The day of the month (an integer from 1 to 31) of a Date object - - according to universal time (UTC).
day — Property in class Date
- - The day of the week (0 for Sunday, 1 for Monday, and so on) specified by this - - Date according to local time.
daylightSavingsOffset — Property in class TimeZone
- - The offset between this time zone and UTC during daylight savings, in milliseconds.
dayUTC — Property in class Date
- - The day of the week (0 for Sunday, 1 for Monday, and so on) of this Date - - according to universal time (UTC).
deactivate — Event in class flash.desktop.NativeApplication
- - Dispatched when the desktop focus is switched to a different application.
deactivate — Event in class flash.display.NativeWindow
- - Dispatched by this NativeWindow object after the window has been deactivated.
deactivate — Event in class flash.events.EventDispatcher
- [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.
DEACTIVATE — Constant static property in class flash.events.Event
- The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
deanalyze — Event in class flash.data.SQLConnection
- Dispatched when a deanalyze() method call's operation - completes successfully.
deanalyze(responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Removes all statistical information created by a call to the - analyze() method.
DEANALYZE — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.deanalyze() method was called.
DEANALYZE — Constant static property in class flash.events.SQLEvent
- The SQLEvent.DEANALYZE constant defines the value of the - type property of a deanalyze event object.
deblocking — Property in class flash.media.Video
- Indicates the type of filter applied to decoded video as part of post-processing.
deblockingFilter — Property in class flash.system.JPEGLoaderContext
- Specifies the strength of the deblocking filter.
DECIMAL — Constant static property in class flash.text.SoftKeyboardType
-

A keyboard optimized for entering numbers along with a decimal.

- -
DECIMAL — Constant static property in class flash.text.engine.TabAlignment
- Positions the alignment token of the tabbed text at the tab stop.
decimalAlignmentToken — Property in class flash.text.engine.TabStop
- Specifies the alignment token to use when you set the alignment property to TabAlignment.DECIMAL.
decimalSeparator — Property in class flash.globalization.CurrencyFormatter
- The decimal separator character used for formatting or parsing currency amounts that have a decimal part.
decimalSeparator — Property in class flash.globalization.NumberFormatter
- The decimal separator character used for formatting or parsing numbers that have a decimal part.
declaration — Property in class Function
- - Returns a string representing the function declaration from the source code.
decode(data:flash.utils:ByteArray) — Static method in class flash.display.BitmapData
- - Decompresses encoded image data (PNG/GIF89a/JPEG) into a new BitmapData object using data - - provided in a ByteArray.
decode(source:String) — Method in class flash.net.URLVariables
- Converts the variable string to properties of the specified URLVariables object.
decodeURI(uri) — Package function in Top Level
- - Decodes an encoded URI into a string.
decodeURIComponent(uri) — Package function in Top Level
- - Decodes an encoded URI component into a string.
decompose(orientationStyle:String) — Method in class flash.geom.Matrix3D
- Returns the transformation matrix's translation, rotation, and scale settings as - a Vector of three Vector3D objects.
decomposeToOutput(orientationStyle:String, output) — Method in class flash.geom.Matrix3D
- Returns the transformation matrix's translation, rotation, and scale settings as - a Vector of three Vector3D objects.
decrementBy(a:flash.geom:Vector3D) — Method in class flash.geom.Vector3D
- Decrements the value of the x, y, and z elements of the current Vector3D object - by the values of the x, y, and z elements of specified Vector3D object.
DECREMENT_SATURATE — Constant static property in class flash.display3D.Context3DStencilAction
- Decrement the stencil buffer value, clamping at 0, the minimum value.
DECREMENT_WRAP — Constant static property in class flash.display3D.Context3DStencilAction
- Decrement the stencil buffer value.
decrypt(data:flash.utils:ByteArray, key:flash.utils:ByteArray, iv:flash.utils:ByteArray) — Static method in class air.security.Encryption
- - A utility function for decrypting an arbitrary amount of data.
decryptBlob(data:Class, key:String) — Static method in class flash.system.System
- - Decrypts a built-in BinaryData blob into a byte array object.
default — Statement
Defines the default case for a switch statement.
DEFAULT — Constant static property in class flash.data.SQLColumnNameStyle
- Indicates that column names returned from a SELECT statement - use the default format.
DEFAULT — Constant static property in class flash.display.ColorCorrection
-Uses the host's default color correction.
DEFAULT — Constant static property in class flash.display.StageOrientation
- Specifies that the stage is currently in the default orientation of the device (right-side up).
DEFAULT — Constant static property in class flash.globalization.LocaleID
- Indicates that the user's default linguistic preferences should be used, as specified in the user's operating system settings.
DEFAULT — Constant static property in class flash.net.ObjectEncoding
- - Specifies the default (latest) format for the current runtime (either Flash - - Player or AIR).
DEFAULT — Constant static property in class flash.system.SecurityPanel
- When passed to Security.showSettings(), displays the panel - that was open the last time the user closed the Flash Player Settings.
DEFAULT — Constant static property in class flash.text.ReturnKeyLabel
- Use the default label.
DEFAULT — Constant static property in class flash.text.SoftKeyboardType
-

Default keyboard for the current input method.

- -
DEFAULT — Constant static property in class flash.text.TextDisplayMode
- Allows Flash Player to choose LCD or CRT mode.
DEFAULT — Constant static property in class flash.text.engine.DigitCase
- Used to specify default digit case.
DEFAULT — Constant static property in class flash.text.engine.DigitWidth
- Used to specify default digit width.
DEFAULT — Constant static property in class flash.text.engine.TypographicCase
- Specifies default typographic case.
defaultCollationType — Property in class flash.data.SQLColumnSchema
- Indicates the default collation sequence that is defined for this column.
defaultObjectEncoding — Static property in class flash.net.NetConnection
- The default object encoding for NetConnection objects.
defaultObjectEncoding — Static property in class flash.net.SharedObject
- The default object encoding (AMF version) for all local shared objects created in the SWF file.
defaultObjectEncoding — Static property in class flash.utils.ByteArray
- - Denotes the default object encoding for the ByteArray class to use for a new ByteArray instance.
DEFAULT_OFF — Constant static property in class flash.display.ColorCorrectionSupport
-Color correction is supported, but off by default.
DEFAULT_ON — Constant static property in class flash.display.ColorCorrectionSupport
-Color correction is supported, and on by default.
defaultSettings() — Static method in class XML
- - Returns an object with the following properties set to the default values: ignoreComments, - - ignoreProcessingInstructions, ignoreWhitespace, prettyIndent, and - - prettyPrinting.
defaultTextFormat — Property in class flash.text.TextField
- - Specifies the format applied to newly inserted text, such as text entered by a user or text inserted with the - - replaceSelectedText() method.
default xml namespace — Statement
- The default xml namespace directive sets the default namespace - to use for XML objects. -
DEFERRED — Constant static property in class flash.data.SQLTransactionLockType
- Specifies the deferred locking transaction option.
DefinitionError — Dynamic class in Top Level
- - The DefinitionError class represents an error that occurs when user code - - attempts to define an identifier that is already defined.
DefinitionError(message:String) — Constructor in class DefinitionError
- - Creates a new DefinitionError object.
deflate() — Method in class flash.utils.ByteArray
- - Compresses the byte array using the deflate compression algorithm.
DEFLATE — Constant static property in class flash.utils.CompressionAlgorithm
- - Defines the string to use for the deflate compression algorithm.
delay — Property in class air.update.ApplicationUpdater
- - The interval, in days, between periodic checks of new updates.
delay — Property in class air.update.ApplicationUpdaterUI
- - The interval, in days, between periodic checks of new updates.
delay — Property in class flash.utils.Timer
- The delay, in milliseconds, between timer - events.
delete — Operator
Destroys the object property specified by reference; the result is true if the property does not exist after the operation completes, and false otherwise.
delete — Event in class flash.data.SQLConnection
- Dispatched when data in any table in any of the connected databases changes as a result - of a SQL DELETE command.
DELETE — Constant static property in class flash.events.SQLUpdateEvent
- The SQLUpdateEvent.DELETE constant defines the value of the - type property of a SQLConnection delete event.
DELETE — Constant static property in class flash.net.URLRequestMethod
- Specifies that the URLRequest object is a DELETE.
DELETE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Delete key (46).
deleteDirectory(deleteDirectoryContents:Boolean) — Method in class flash.filesystem.File
- - Deletes the directory.
deleteDirectoryAsync(deleteDirectoryContents:Boolean) — Method in class flash.filesystem.File
- - Deletes the directory asynchronously.
deleteFile() — Method in class flash.filesystem.File
- - Deletes the file.
deleteFileAsync() — Method in class flash.filesystem.File
- - Deletes the file asynchronously.
deleteProperty(name) — Method in class flash.utils.Proxy
delete (XML) — Operator
Deletes the XML elements or attributes specified by reference.
delta — Property in class flash.events.MouseEvent
- - Indicates how many lines should be scrolled for each unit the user rotates the - - mouse wheel.
deltaTransformPoint(point:flash.geom:Point) — Method in class flash.geom.Matrix
- - Given a point in the pretransform coordinate space, returns the coordinates of - - that point after the transformation occurs.
deltaTransformPointToOutput(point:flash.geom:Point, output:flash.geom:Point) — Method in class flash.geom.Matrix
- - Given a point in the pretransform coordinate space, returns the coordinates of - - that point after the transformation occurs.
deltaTransformVector(v:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Uses the transformation matrix without its translation elements - to transform a Vector3D object from one space coordinate to another.
deltaTransformVectorToOutput(v:flash.geom:Vector3D, output:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Uses the transformation matrix to transform a Vector3D object from one space coordinate - to another.
DENIED — Constant static property in class flash.permissions.PermissionStatus
- Specifies that the permission has been denied.
denyRequestedObject(requestID:int) — Method in class flash.net.NetGroup
- Denies a request received in a NetStatusEvent - NetGroup.Replication.Request for an object previously advertised with - addHaveObjects().
depth — Property in class flash.media.StageVideo
- The depth level of a StageVideo object relative to other StageVideo objects.
DEPTH — Constant static property in class flash.display3D.Context3DClearMask
- Clear only the depth buffer.
dereference(uri:String) — Method in interface flash.security.IURIDereferencer
- Resolves and dereferences the specified URI.
descendants(name:Object) — Method in class XML
- - Returns all descendants (children, grandchildren, great-grandchildren, and so on) of the - - XML object that have the given name parameter.
descendants(name:Object) — Method in class XMLList
- - Returns all descendants (children, grandchildren, great-grandchildren, and so on) of the XML object - - that have the given name parameter.
DESCENDING — Constant static property in class Array
- - Specifies descending sorting for the Array class sorting methods.
descent — Property in class flash.text.TextExtent
descent — Property in class flash.text.TextLineMetrics
- The descent value of the text is the length from the baseline to the bottom depth of the line in pixels.
descent — Property in class flash.text.engine.TextLine
- Specifies the number of pixels from the baseline to the bottom of the lowest-descending characters in the line.
DESCENT — Constant static property in class flash.text.engine.TextBaseline
- Specifies a descent baseline.
describeType(value) — Package function in flash.utils
- Produces an XML object that describes the ActionScript object named as the parameter of - the method.
description — Property in class flash.accessibility.AccessibilityProperties
- Provides a description for this display object in the accessible presentation.
description — Property in class flash.external.ExtensionInfo
- - The extension description, as provided in the extension's XML descriptor file.
description — Property in class flash.net.FileFilter
- The description string for the filter.
desiredAccuracy — Property in class flash.sensors.Geolocation
- This property determines the accuracy of the geolocation data on iOS.
desktopDirectory — Static property in class flash.filesystem.File
- - The user's desktop directory.
DESTINATION_ALPHA — Constant static property in class flash.display3D.Context3DBlendFactor
- The blend factor is (Da,Da,Da,Da), where Da is - the alpha component of the fragment color computed by the pixel program.
DESTINATION_COLOR — Constant static property in class flash.display3D.Context3DBlendFactor
- The blend factor is (Dr,Dg,Db,Da), where Dr/g/b/a is - the corresponding component of the current color in the color buffer.
detach — Event in class flash.data.SQLConnection
- Dispatched when a detach() method call's operation - completes successfully.
detach(name:String, responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Detaches an additional database previously attached to the SQLConnection instance using - the attach() method.
DETACH — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.detach() method was called.
DETACH — Constant static property in class flash.events.SQLEvent
- The SQLEvent.DETACH constant defines the value of the - type property of a detach event object.
detail — Property in class flash.events.DRMStatusEvent
- A string explaining the context of the status event.
detailArguments — Property in class flash.errors.SQLError
- An array of String values that can be used to construct a locale specific - detail error message.
detailID — Property in class flash.errors.SQLError
- A reference number associated with the specific detail message.
details — Property in class air.update.events.StatusUpdateEvent
- - An array defining the details string - - for each of the supported languages.
details — Property in class flash.errors.SQLError
- Details of the current error.
determinant — Property in class flash.geom.Matrix3D
- A Number that determines whether a matrix is invertible.
determinePreferredLocales(want, have, keyword:String) — Static method in class flash.globalization.LocaleID
- Returns a list of acceptable locales based on a list of desired locales and a list of the locales that are currently available.
DEVANAGARI — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Devanagari digit set.
developerID — Property in class air.system.License
- - Developer ID for this license - -
device — Property in class flash.events.GameInputEvent
- Returns a reference to the device that was added or removed.
device — Property in class flash.ui.GameInputControl
- Returns the GameInputDevice object that contains this control.
DEVICE — Constant static property in class flash.text.FontType
- Indicates that this is a device font.
DEVICE — Constant static property in class flash.text.engine.FontLookup
- Used to indicate device font lookup.
deviceAdded — Event in class flash.ui.GameInput
- Dispatched when a game input device is connected to your platform, - or when an already connected device is switched on.
DEVICE_ADDED — Constant static property in class flash.events.GameInputEvent
- Indicates that a compatible device has been connected or turned on.
DEVICE_CHANGE — Constant static property in class flash.media.AudioOutputChangeReason
- Audio Output is changed because system device has been added or removed.
deviceGroup — Property in class flash.events.DRMDeviceGroupErrorEvent
deviceGroup — Property in class flash.events.DRMDeviceGroupEvent
deviceGroup — Property in class flash.net.drm.VoucherAccessInfo
deviceNames — Property in class flash.media.AudioDeviceManager
- An array of strings containing the names of all available audio output devices.
deviceOrientation — Property in class flash.display.Stage
- The physical orientation of the device.
deviceRemoved — Event in class flash.ui.GameInput
- Dispatched when a game input device is removed from your platform, - or when a connected device is switched off.
DEVICE_REMOVED — Constant static property in class flash.events.GameInputEvent
- Indicates that one of the enumerated devices has been disconnected or - turned off.
DeviceRotation — Class in package flash.sensors
- The DeviceRotation class dispatches events based on activity detected by the device's acceletometer, - gyroscope sensors.
DeviceRotation() — Constructor in class flash.sensors.DeviceRotation
- Creates a new DeviceRotation instance.
DeviceRotationEvent — Class in package flash.events
-The DeviceRotation class dispatches DeviceRotationEvent and returns roll, yaw, pitch and quaternion data when DeviceRotation updates are obtained from the combined readings from -Accelerometer and Gyroscope sensors' readings installed on the device.
DeviceRotationEvent(type:String, bubbles:Boolean, cancelable:Boolean, timestamp:Number, roll:Number, pitch:Number, yaw:Number, quaternion:Array) — Constructor in class flash.events.DeviceRotationEvent
- Creates an DeviceRotationEvent object that contains information about roll, yaw, pitch along the three dimensional axis.
deviceUnusable — Event in class flash.ui.GameInput
- Dispatched when a game input device is connected but is not usable.
DEVICE_UNUSABLE — Constant static property in class flash.events.GameInputEvent
- Dispatched when a game input device is connected but is not usable.
Dictionary — Dynamic class in package flash.utils
- - The Dictionary class lets you create a dynamic collection of properties, which uses strict equality - - (===) for key comparison.
Dictionary(weakKeys:Boolean) — Constructor in class flash.utils.Dictionary
- - Creates a new Dictionary object.
DIFFERENCE — Constant static property in class flash.display.BlendMode
-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.
digest() — Method in class air.security.Digest
- - Generates the digest for data that has been passed into this object - - -
digest — Property in class flash.net.URLRequest
- A string that uniquely identifies the signed Adobe platform component to be stored - to (or retrieved from) the Flash Player cache.
Digest — Class in package air.security
- - The Digest class is used to generate a digest, or hash, of some data.
Digest(algorithm:String) — Constructor in class air.security.Digest
- - Creates a Digest object using the requested algorithm - - -
digestStatus — Property in class flash.security.XMLSignatureValidator
- The validity status of the cryptographic signature computed over the - signature SignedInfo element.
digitCase — Property in class flash.text.engine.ElementFormat
- The digit case used for this text.
DigitCase — Final class in package flash.text.engine
-The DigitCase class is an enumeration of constant values used in setting the digitCase property -of the ElementFormat class.
digitsType — Property in class flash.globalization.CurrencyFormatter
- Defines the set of digit characters used when formatting currency amounts.
digitsType — Property in class flash.globalization.NumberFormatter
- Defines the set of digit characters to be used when formatting numbers.
digitWidth — Property in class flash.text.engine.ElementFormat
- The digit width used for this text.
DigitWidth — Final class in package flash.text.engine
-The DigitWidth class is an enumeration of constant values used in setting the digitWidth property -of the ElementFormat class.
DIRECT — Constant static property in class flash.display.NativeWindowRenderMode
- A direct mode window.
DIRECT_CONNECTIONS — Constant static property in class flash.net.NetStream
- Creates a peer-to-peer publisher connection.
direction — Property in class flash.events.FocusEvent
- Specifies direction of focus for a focusIn event.
DIRECTORY — Constant static property in class air.utils.ZipEntry
- - Flag value for a directory entry - -
directoryListing — Event in class flash.filesystem.File
- - Dispatched when a directory list is available as a result of a call to the getDirectoryListingAsync() - - method.
DIRECTORY_LISTING — Constant static property in class flash.events.FileListEvent
- The FileListEvent.DIRECTORY_LISTING constant defines the value of the - type property of the event object for a directoryListing event.
disableNetworkChanges — Property in class flash.net.NetworkInfo
- - Disables the network change detection within AIR.
disablePageRange — Property in class flash.printing.PrintUIOptions
- Specifies whether the page range in the print dialog is disabled (true) or - the user can edit it (false).
dispatchEvent(event:flash.events:Event) — Method in class flash.desktop.NativeApplication
- Dispatches an event into the event flow.
dispatchEvent(event:flash.events:Event) — Method in class flash.display.Stage
- Dispatches an event into the event flow.
dispatchEvent(event:flash.events:Event) — Method in class flash.events.EventDispatcher
- Dispatches an event into the event flow.
dispatchEvent(event:flash.events:Event) — Method in interface flash.events.IEventDispatcher
- Dispatches an event into the event flow.
DisplacementMapFilter — Final class in package flash.filters
-The DisplacementMapFilter class uses the pixel values from the specified BitmapData object -(called the displacement map image) to perform a displacement of an object.
DisplacementMapFilter(mapBitmap:flash.display:BitmapData, mapPoint:flash.geom:Point, componentX:uint, componentY:uint, scaleX:Number, scaleY:Number, mode:String, color:uint, alpha:Number) — Constructor in class flash.filters.DisplacementMapFilter
- Initializes a DisplacementMapFilter instance with the specified parameters.
DisplacementMapFilterMode — Final class in package flash.filters
-The DisplacementMapFilterMode class provides values for the mode property -of the DisplacementMapFilter class.
display(stage:flash.display:Stage, stageX:Number, stageY:Number) — Method in class flash.display.NativeMenu
- - Pops up this menu at the specified location.
display(stage:flash.display:Stage, stageX:Number, stageY:Number) — Method in class flash.ui.ContextMenu
- Pops up this menu at the specified location.
DISPLAY — Constant static property in class flash.system.SecurityPanel
- When passed to Security.showSettings(), displays the - Display panel in Flash Player Settings.
displayAsPassword — Property in class flash.text.StageText
- - Indicates whether the text field is a password text field.
displayAsPassword — Property in class flash.text.TextField
- - Specifies whether the text field is a password text field.
displaying — Event in class flash.display.NativeMenu
- - Dispatched by this NativeMenu object immediately before the - - menu is displayed.
displaying — Event in class flash.display.NativeMenuItem
- - Dispatched by this NativeMenuItem object immediately before the - - menu containing the item is displayed.
DISPLAYING — Constant static property in class flash.events.Event
- The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
displayMode — Static property in class flash.text.TextRenderer
- Controls the rendering of advanced anti-aliased text.
displayName — Property in class TimeZone
- - The display name of this time zone.
displayName — Property in class flash.net.NetworkInterface
- The display name of this network interface.
displayName — Property in class flash.net.drm.VoucherAccessInfo
A user-friendly string that you can use to refer to the specified - VoucherAccessInfo object in the user interface.
DisplayObject — Class in package flash.display
- The DisplayObject class is the base class for all objects that can be placed on - the display list.
DisplayObjectContainer — Class in package flash.display
-The DisplayObjectContainer class is the base class for all objects that can serve as display object containers on -the display list.
DisplayObjectContainer() — Constructor in class flash.display.DisplayObjectContainer
- Calling the new DisplayObjectContainer() constructor throws an - ArgumentError exception.
displayState — Property in class flash.display.NativeWindow
- - The display state of this window.
displayState — Property in class flash.display.Stage
- A value from the StageDisplayState class that specifies which display state to use.
displayStateChange — Event in class flash.display.NativeWindow
- - Dispatched by this NativeWindow object after the window's displayState property has changed.
DISPLAY_STATE_CHANGE — Constant static property in class flash.events.NativeWindowDisplayStateEvent
- Defines the value of the type property of a displayStateChange event object.
displayStateChanging — Event in class flash.display.NativeWindow
- - Dispatched by this NativeWindow object immediately before the window changes its display state.
DISPLAY_STATE_CHANGING — Constant static property in class flash.events.NativeWindowDisplayStateEvent
- Defines the value of the type property of a displayStateChanging event object.
dispose() — Method in class flash.display.BitmapData
- - Frees memory that is used to store the BitmapData object.
dispose(recreate:Boolean) — Method in class flash.display3D.Context3D
- - Frees all resources and internal storage associated with this Context3D.
dispose() — Method in class flash.display3D.IndexBuffer3D
- Free all native GPU resources associated with this object.
dispose() — Method in class flash.display3D.Program3D
- Frees all resources associated with this object.
dispose() — Method in class flash.display3D.VertexBuffer3D
- - Frees all resources associated with this object.
dispose() — Method in class flash.display3D.textures.TextureBase
- Frees all GPU resources associated with this texture.
dispose() — Method in class flash.external.ExtensionContext
- - Disposes of this ExtensionContext instance.
dispose() — Method in class flash.media.StageWebView
- - Disposes of this StageWebView object.
dispose() — Method in class flash.net.NetStream
- Releases all the resources held by the NetStream object.
dispose() — Method in class flash.text.StageText
- - Disposes of the StageText object.
disposeXML(node:XML) — Static method in class flash.system.System
- - Makes the specified XML object immediately available for garbage collection.
distance — Property in class flash.filters.BevelFilter
- The offset distance of the bevel.
distance — Property in class flash.filters.DropShadowFilter
- The offset distance for the shadow, in pixels.
distance — Property in class flash.filters.GradientBevelFilter
- The offset distance.
distance — Property in class flash.filters.GradientGlowFilter
- The offset distance of the glow.
distance(pt1:flash.geom:Point, pt2:flash.geom:Point) — Static method in class flash.geom.Point
- Returns the distance between pt1 and pt2.
distance(pt1:flash.geom:Vector3D, pt2:flash.geom:Vector3D) — Static method in class flash.geom.Vector3D
- Returns the distance between two Vector3D objects.
divisor — Property in class flash.filters.ConvolutionFilter
- The divisor used during matrix transformation.
DNSResolver — Class in package flash.net.dns
- The DNSResolver class lets you lookup Domain Name System (DNS) resource records.
DNSResolver() — Constructor in class flash.net.dns.DNSResolver
- Creates a DNSResolver object.
DNSResolverEvent — Class in package flash.events
- The DNSResolverEvent class represents the results of a Domain Name System (DNS) lookup operation.
DNSResolverEvent(type:String, bubbles:Boolean, cancelable:Boolean, host:String, resourceRecords:Array) — Constructor in class flash.events.DNSResolverEvent
- Creates an DNSResolverEvent object that contains the results of a DNS lookup operation.
DOB — Constant static property in class flash.text.StageTextContentType
- -

Content is a date of birth

- - - -
DockIcon — Class in package flash.desktop
- The DockIcon class represents the Mac OS X®-style dock icon.
doConversion() — Static method in class flash.system.IME
- Instructs the IME to select the first candidate for the current composition string.
docTypeDecl — Property in class flash.xml.XMLDocument
- Specifies information about the XML document's DOCTYPE declaration.
documentsDirectory — Static property in class flash.filesystem.File
- - The user's documents directory.
doDrag(dragInitiator:flash.display:InteractiveObject, clipboard:flash.desktop:Clipboard, dragImage:flash.display:BitmapData, offset:flash.geom:Point, allowedActions:flash.desktop:NativeDragOptions) — Static method in class flash.desktop.NativeDragManager
- Starts a drag-and-drop operation.
DOLBY_DIGITAL — Constant static property in class flash.media.AudioDecoder
- Dolby Digital Audio, which is also known as AC-3.
DOLBY_DIGITAL_PLUS — Constant static property in class flash.media.AudioDecoder
- Dolby Digital Plus Audio, which is also known as Enhanced AC-3 and Enhanced Dolby Digital.
domain — Property in class flash.events.DRMAuthenticationCompleteEvent
- The content domain of the media rights server.
domain — Property in class flash.events.DRMAuthenticationErrorEvent
- The content domain of the media rights server.
domain — Property in class flash.net.LocalConnection
- A string representing the domain of the location of the current file.
domain — Property in class flash.net.drm.DRMContentData
- The content domain of the media rights server to which the user must be authenticated - to obtain the voucher for the associated content.
domain — Property in class flash.net.drm.DRMDeviceGroup
- The content domain of the device group registration server to which the user must be - authenticated before registering to this device group.
domain — Property in class flash.net.drm.VoucherAccessInfo
- The content domain of the media rights server to which the user must be authenticated - to obtain the voucher for the associated content.
domainMemory — Property in class flash.system.ApplicationDomain
- Gets and sets the object on which domain-global memory operations will operate within this ApplicationDomain.
dominantBaseline — Property in class flash.text.engine.ElementFormat
- Specifies the type of baseline to use as the dominant baseline.
DONE — Constant static property in class flash.text.ReturnKeyLabel
- Use the label, "Done".
dotall — Property in class RegExp
- - Specifies whether the dot character (.) in a regular expression pattern matches - - new-line characters.
dotProduct(a:flash.geom:Vector3D) — Method in class flash.geom.Vector3D
- If the current Vector3D object and the one specified as the parameter are unit vertices, this - method returns the cosine of the angle between the two vertices.
doubleClick — Event in class flash.display.InteractiveObject
- - 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.
DOUBLE_CLICK — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a doubleClick event object.
doubleClickEnabled — Property in class flash.display.InteractiveObject
- - Specifies whether the object receives doubleClick events.
do..while — Statement
Similar to a while loop, except that the statements are executed once before the initial evaluation of the condition.
DOWN — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Down Arrow key (40).
download(request:flash.net:URLRequest, defaultFileName:String) — Method in class flash.net.FileReference
- Opens a dialog box that lets the user download a file from a remote server.
downloadComplete — Event in class air.update.ApplicationUpdater
- - Dispatched when the download of the update file is complete.
downloadComplete — Event in class air.update.ApplicationUpdaterUI
- - - - Dispatched when the download of the update file is complete.
DOWNLOAD_COMPLETE — Constant static property in class air.update.events.UpdateEvent
- - The UpdateEvent.DOWNLOAD_COMPLETE constant defines the value of the - - type property of the event object for a downloadComplete event.
downloaded — Property in class flash.filesystem.File
- - Indicates whether the referenced file or directory was downloaded (from the internet) or not.
downloadError — Event in class air.update.ApplicationUpdater
- - Dispatched if there is an error while connecting or downloading - - the update file.
downloadError — Event in class air.update.ApplicationUpdaterUI
- - Dispatched if there is an error while connecting or downloading - - the update file.
DOWNLOAD_ERROR — Constant static property in class air.update.events.DownloadErrorEvent
- - The DownloadErrorEvent.DOWNLOAD_ERROR constant defines the value of the - - type property of the event object for a downloadError event.
DownloadErrorEvent — Class in package air.update.events
- - A DownloadErrorEvent object is dispatched by an ApplicationUpdater or ApplicationUpdaterUI - - object when an error happens while downloading the update file.
DownloadErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, text:String, id:int, subErrorID:int) — Constructor in class air.update.events.DownloadErrorEvent
- - The constructor function.
downloadStart — Event in class air.update.ApplicationUpdater
- - Dispatched after a call to the downloadUpdate() method - - and the connection to the server is established.
downloadStart — Event in class air.update.ApplicationUpdaterUI
- - - - Dispatched after a call to the downloadUpdate() method - - and the connection to the server is established.
DOWNLOAD_START — Constant static property in class air.update.events.UpdateEvent
- - The UpdateEvent.DOWNLOAD_START constant defines the value of the - - type property of the event object for a downloadStart event.
downloadUpdate() — Method in class air.update.ApplicationUpdater
- - Asynchronously downloads the update file.
downState — Property in class flash.display.SimpleButton
- Specifies a display object that is used as the visual - object for the button "Down" state —the state that the button is in when the user - selects the hitTestState object.
D_PAD — Constant static property in class flash.ui.KeyLocation
- Indicates the key activation originated on a directional pad of input device.
dragInitiator — Static property in class flash.desktop.NativeDragManager
- The interactive object passed to the NativeDragManager.doDrag() call that initiated the drag operation.
draw(source:flash.display:IBitmapDrawable, matrix:flash.geom:Matrix, colorTransform:flash.geom:ColorTransform, blendMode:String, clipRect:flash.geom:Rectangle, smoothing:Boolean) — Method in class flash.display.BitmapData
- - Draws the source display object onto the bitmap image, using the - - Flash runtime vector renderer.
drawCircle(x:Number, y:Number, radius:Number) — Method in class flash.display.Graphics
- Draws a circle.
drawEllipse(x:Number, y:Number, width:Number, height:Number) — Method in class flash.display.Graphics
- Draws an ellipse.
drawGraphicsData(graphicsData) — Method in class flash.display.Graphics
- Submits a series of IGraphicsData instances for drawing.
drawPath(commands, data, winding:String) — Method in class flash.display.Graphics
- Submits a series of commands for drawing.
drawRect(x:Number, y:Number, width:Number, height:Number) — Method in class flash.display.Graphics
- Draws a rectangle.
drawRoundRect(x:Number, y:Number, width:Number, height:Number, ellipseWidth:Number, ellipseHeight:Number) — Method in class flash.display.Graphics
- Draws a rounded rectangle.
drawToBitmapData(destination:flash.display:BitmapData, srcRect:flash.geom:Rectangle, destPoint:flash.geom:Point) — Method in class flash.display3D.Context3D
- - Draws the current render buffer to a bitmap.
drawToBitmapData(destination:flash.display:BitmapData) — Method in class flash.media.Camera
- - Copies the last frame to a bitmap.
drawTriangles(vertices, indices, uvtData, culling:String) — Method in class flash.display.Graphics
- Renders a set of triangles, typically to distort bitmaps and give them a three-dimensional appearance.
drawTriangles(indexBuffer:flash.display3D:IndexBuffer3D, firstIndex:int, numTriangles:int) — Method in class flash.display3D.Context3D
- - Render the specified triangles using the current buffers and state of this Context3D object.
drawTrianglesInstanced(indexBuffer:flash.display3D:IndexBuffer3D, numInstances:int, firstIndex:int, numTriangles:int) — Method in class flash.display3D.Context3D
- - Render the specified instanced triangles using the current buffers and state of this Context3D object.
drawViewPortAsync(target:Object) — Method in class flash.media.StageWebView
- - Draws the StageWebView's view port to a bitmap or image.
drawViewPortToBitmapData(bitmap:flash.display:BitmapData) — Method in class flash.media.StageWebView
- - Draws the StageWebView's view port to a bitmap.
drawViewPortToBitmapData(bitmap:flash.display:BitmapData) — Method in class flash.text.StageText
- - Draws the StageText's view port to a bitmap.
drawWithQuality(source:flash.display:IBitmapDrawable, matrix:flash.geom:Matrix, colorTransform:flash.geom:ColorTransform, blendMode:String, clipRect:flash.geom:Rectangle, smoothing:Boolean, quality:String) — Method in class flash.display.BitmapData
- - Draws the source display object onto the bitmap image, using the - - Flash runtime vector renderer.
drive — Property in class flash.filesystem.StorageVolume
- The volume drive letter on Windows.
driver — Constant property in class flash.events.StageVideoAvailabilityEvent
driverInfo — Property in class flash.display3D.Context3D
- - The type of graphics library driver used by this rendering context.
DRIVER_TOO_OLD — Constant static property in class flash.media.StageVideoAvailabilityReason
- Stage video is not currently available, the driver is too old or black listed -
DRM — Constant static property in class flash.system.SystemUpdaterType
- Updates the DRM module.
drmAuthenticate — Event in class flash.net.NetStream
- Dispatched when a NetStream object tries to play a digital rights management (DRM) encrypted - content that requires a user credential for authentication before playing.
DRM_AUTHENTICATE — Constant static property in class flash.events.DRMAuthenticateEvent
- The DRMAuthenticateEvent.DRM_AUTHENTICATE constant defines the value of the - type property of a DRMAuthenticateEvent object.
DRMAuthenticateEvent — Class in package flash.events
- A NetStream object dispatchs a DRMAuthenticateEvent object when attempting to play digital rights management (DRM) encrypted - content that requires a user credential for authentication.
DRMAuthenticateEvent(type:String, bubbles:Boolean, cancelable:Boolean, header:String, userPrompt:String, passPrompt:String, urlPrompt:String, authenticationType:String, netstream:flash.net:NetStream) — Constructor in class flash.events.DRMAuthenticateEvent
- Creates an Event object that contains specific information about DRM authentication events.
DRMAuthenticationCompleteEvent — Class in package flash.events
- The DRMManager dispatches a DRMAuthenticationCompleteEvent object when a call to the authenticate() - method of the DRMManager object succeeds.
DRMAuthenticationCompleteEvent(type:String, bubbles:Boolean, cancelable:Boolean, inServerURL:String, inDomain:String, inToken:flash.utils:ByteArray) — Constructor in class flash.events.DRMAuthenticationCompleteEvent
- Creates a new instance of a DRMAuthenticationCompleteEvent object.
DRMAuthenticationErrorEvent — Class in package flash.events
- The DRMManager dispatches a DRMAuthenticationErrorEvent object when a call to the authenticate() - method of the DRMManager object fails.
DRMAuthenticationErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, inDetail:String, inErrorID:int, inSubErrorID:int, inServerURL:String, inDomain:String) — Constructor in class flash.events.DRMAuthenticationErrorEvent
- Creates a new instance of a DRMAuthenticationErrorEvent object.
DRMContentData — Class in package flash.net.drm
- The DRMContentData class provides the information required to - obtain the voucher necessary to view DRM-protected content.
DRMContentData(rawData:flash.utils:ByteArray) — Constructor in class flash.net.drm.DRMContentData
- Constructor.
DRMDeviceGroup — Final class in package flash.net.drm
- A device group signifies a group of playback devices that shares protected-content playback rights.
DRMDeviceGroupErrorEvent — Class in package flash.events
-

Issued by the DRMManager when any error occurs during any device group related calls.

-

It is the application's responsibility to explicitly handle the error events.These events include cases - where the user inputs valid credentials, but the voucher protecting the encrypted content restricts the access - to the content.

DRMDeviceGroupErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, errorDetail:String, errorCode:int, subErrorID:int, deviceGroup:flash.net.drm:DRMDeviceGroup, systemUpdateNeeded:Boolean, drmUpdateNeeded:Boolean) — Constructor in class flash.events.DRMDeviceGroupErrorEvent
DRMDeviceGroupEvent — Class in package flash.events
-

Issued by the DRMManager when a device group related call successfully completes.

DRMDeviceGroupEvent(type:String, bubbles:Boolean, cancelable:Boolean, deviceGroup:flash.net.drm:DRMDeviceGroup) — Constructor in class flash.events.DRMDeviceGroupEvent
drmError — Event in class flash.net.NetStream
- Dispatched when a NetStream object, trying to play a digital rights management (DRM) encrypted - file, encounters a DRM-related error.
drmError — Event in class flash.net.drm.DRMManager
- The DRMManager dispatches a DRMErrorEvent object when a requested voucher - cannot be obtained from the media rights server.
DRM_ERROR — Constant static property in class flash.events.DRMErrorEvent
- The DRMErrorEvent.DRM_ERROR constant defines the value of the - type property of a drmError event object.
DRMErrorEvent — Class in package flash.events
- The DRMErrorEvent class provides information about errors that occur when playing digital rights management (DRM) - encrypted files.
DRMErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, inErrorDetail:String, inErrorCode:int, insubErrorID:int, inMetadata:flash.net.drm:DRMContentData, inSystemUpdateNeeded:Boolean, inDrmUpdateNeeded:Boolean) — Constructor in class flash.events.DRMErrorEvent
- Creates an Event object that contains specific information about DRM error events.
DRMLicenseRequestEvent — Class in package flash.events
- The DRMManager dispatches a DRMLicenseRequestEvent object before each call to the loadVoucher() - or loadPreviewVoucher() methods of the DRMManager object succeeds.
DRMLicenseRequestEvent(type:String, bubbles:Boolean, cancelable:Boolean, inServerURL:String) — Constructor in class flash.events.DRMLicenseRequestEvent
- Creates a new instance of a DRMLicenseRequestEvent object.
DRM_LOAD_DEVICEID_ERROR — Constant static property in class flash.events.DRMErrorEvent
DRMManager — Class in package flash.net.drm
- The DRMManager manages the retrieval and storage of the vouchers needed to view - DRM-protected content.
DRMManagerError — Class in package flash.errors
- The DRMManager dispatches a DRMManagerError event to report errors.
DRMManagerError(message:String, id:int, subErrorID:int) — Constructor in class flash.errors.DRMManagerError
- Creates a new instance of the DRMManagerError class.
DRMPlaybackTimeWindow — Class in package flash.net.drm
- The DRMPlaybackTimeWindow class represents the period of time during which a - DRM voucher is valid.
DRMReturnVoucherCompleteEvent — Class in package flash.events
- The DRMManager dispatches a DRMVoucherReturnCompleteEvent object when a call to the returnVoucher() - method of the DRMManager object succeeds.
DRMReturnVoucherCompleteEvent(type:String, bubbles:Boolean, cancelable:Boolean, inServerURL:String, inLicenseID:String, inPolicyID:String, inNumberOfVouchersReturned:int) — Constructor in class flash.events.DRMReturnVoucherCompleteEvent
- Creates a new instance of a DRMReturnVoucherCompleteEvent object.
DRMReturnVoucherErrorEvent — Class in package flash.events
- The DRMManager dispatches a DRMReturnVoucherErrorEvent object when a call to the returnVoucher() - method of the DRMManager object fails.
DRMReturnVoucherErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, inDetail:String, inErrorID:int, inSubErrorID:int, inServerURL:String, inLicenseID:String, inPolicyID:String) — Constructor in class flash.events.DRMReturnVoucherErrorEvent
- Creates a new instance of a DRMReturnVoucherErrorEvent object.
drmStatus — Event in class flash.net.NetStream
- Dispatched when the digital rights management (DRM) encrypted content - begins playing (when the user is authenticated and authorized to play the content).
drmStatus — Event in class flash.net.drm.DRMManager
- The DRMManager dispatches a DRMStatusEvent object when a requested voucher - is obtained from the media rights server.
DRM_STATUS — Constant static property in class flash.events.DRMStatusEvent
- The DRMStatusEvent.DRM_STATUS constant defines the value of the - type property of a drmStatus event object.
DRMStatusEvent — Class in package flash.events
- A NetStream object dispatches a DRMStatusEvent object when the content protected using - digital rights management (DRM) begins playing successfully (when the voucher is - verified, and when the user is authenticated and authorized to view the content).
DRMStatusEvent(type:String, bubbles:Boolean, cancelable:Boolean, inMetadata:flash.net.drm:DRMContentData, inVoucher:flash.net.drm:DRMVoucher, inLocal:Boolean) — Constructor in class flash.events.DRMStatusEvent
- Creates an Event object that contains specific information about DRM status events.
drmUpdateNeeded — Property in class flash.events.DRMDeviceGroupErrorEvent
drmUpdateNeeded — Property in class flash.events.DRMErrorEvent
- Indicates whether a DRM update is needed to play the DRM-protected content.
DRMVoucher — Class in package flash.net.drm
- The DRMVoucher class is a handle to the license token that allows a user to view DRM-protected content.
dropAction — Static property in class flash.desktop.NativeDragManager
- The drag action specified by the drop target.
dropAction — Property in class flash.events.NativeDragEvent
- The current action.
droppedFrames — Property in class flash.net.NetStreamInfo
- Returns the number of video frames dropped in the current NetStream playback session.
DropShadowFilter — Final class in package flash.filters
-The DropShadowFilter class lets you add a drop shadow to display objects.
DropShadowFilter(distance:Number, angle:Number, color:uint, alpha:Number, blurX:Number, blurY:Number, strength:Number, quality:int, inner:Boolean, knockout:Boolean, hideObject:Boolean) — Constructor in class flash.filters.DropShadowFilter
- Creates a new DropShadowFilter instance with the specified parameters.
dropTarget — Property in class flash.display.Sprite
- Specifies the display object over which the sprite is being dragged, or on - which the sprite was dropped.
dstAddress — Property in class flash.events.DatagramSocketDataEvent
- The IP address of the DatagramSocket object that dispatched this event.
dstPort — Property in class flash.events.DatagramSocketDataEvent
- The port of the DatagramSocket object that dispatched this event.
DTS — Constant static property in class flash.media.AudioDecoder
- DTS Audio, which is also known as DTS Coherent Acoustics, DTS Digital Surround, and DTS core.
DTS_EXPRESS — Constant static property in class flash.media.AudioDecoder
- DTS Express Audio, which is also known as DTS Low Bit Rate (LBR).
DTS_HD_HIGH_RESOLUTION_AUDIO — Constant static property in class flash.media.AudioDecoder
- DTS-HD High Resolution Audio, which is also known as DTS-HD HR.
DTS_HD_MASTER_AUDIO — Constant static property in class flash.media.AudioDecoder
- DTS-HD Master Audio, which is also known as DTS-HD MA.
dump() — Method in class flash.text.engine.TextBlock
- Dumps the underlying contents of the TextBlock as an XML string.
dump() — Method in class flash.text.engine.TextLine
- Dumps the underlying contents of the TextLine as an XML string.
DVR — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging DVR application mode.
dynamic — Statement
Specifies that instances of a class may possess dynamic properties added at runtime.
DYNAMIC — Constant static property in class flash.text.TextFieldType
- Used to specify a dynamic TextField.
DYNAMIC_DRAW — Constant static property in class flash.display3D.Context3DBufferUsage
- Indicates the buffer will be used for drawing and be updated frequently - -
dynamicPropertyWriter — Static property in class flash.net.ObjectEncoding
- - Allows greater control over the serialization of dynamic properties of dynamic objects.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/all-index-E.html b/html-docs/all-index-E.html deleted file mode 100644 index 70742d7..0000000 --- a/html-docs/all-index-E.html +++ /dev/null @@ -1,1452 +0,0 @@ - - - - - -E Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
E — Constant static property in class Math
- - A mathematical constant for the base of natural logarithms, expressed as e.
E — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the E key (69).
EastAsianJustifier — Final class in package flash.text.engine
- The EastAsianJustifier class has properties to control the justification options for text lines whose - content is primarily East Asian text.
EastAsianJustifier(locale:String, lineJustification:String, justificationStyle:String) — Constructor in class flash.text.engine.EastAsianJustifier
- Creates an EastAsianJustifier object.
echoPath — Property in class flash.media.MicrophoneEnhancedOptions
- Specifies the echo path (in milliseconds) used for acoustic echo cancellation.
editable — Property in class flash.text.StageText
- - Indicates whether the user can edit the text field.
element — Property in class flash.text.engine.TextLineMirrorRegion
- The ContentElement object from which the mirror region was derived.
elementCount — Property in class flash.text.engine.GroupElement
- The number of elements in the group.
elementFormat — Property in class flash.text.engine.ContentElement
- The ElementFormat object used for the element.
ElementFormat — Final class in package flash.text.engine
- The ElementFormat class represents formatting information which can be applied to a ContentElement.
ElementFormat(fontDescription:flash.text.engine:FontDescription, fontSize:Number, color:uint, alpha:Number, textRotation:String, dominantBaseline:String, alignmentBaseline:String, baselineShift:Number, kerning:String, trackingRight:Number, trackingLeft:Number, locale:String, breakOpportunity:String, digitCase:String, digitWidth:String, ligatureLevel:String, typographicCase:String) — Constructor in class flash.text.engine.ElementFormat
- Creates an ElementFormat object.
elementHeight — Property in class flash.text.engine.GraphicElement
- The height in pixels to reserve for the graphic in the line.
ELEMENT_NODE — Constant static property in class flash.xml.XMLNodeType
- Specifies that the node is an element.
elements(name:Object) — Method in class XML
- - Lists the elements of an XML object.
elements(name:Object) — Method in class XMLList
- - Calls the elements() method of each XML object.
elementWidth — Property in class flash.text.engine.GraphicElement
- The width in pixels to reserve for the graphic in the line.
else — Statement
Specifies the statements to run if the condition in the if statement returns false.
EMAIL — Constant static property in class flash.text.SoftKeyboardType
-

A keyboard optimized for specifying email addresses.

EMAIL_ADDRESS — Constant static property in class flash.text.StageTextContentType
- -

Content is an email address

- - - -
EMBEDDED — Constant static property in class flash.text.FontType
- Indicates that this is an embedded font.
EMBEDDED_CFF — Constant static property in class flash.text.FontType
- Indicates that this is an embedded CFF font.
EMBEDDED_CFF — Constant static property in class flash.text.engine.FontLookup
- Used to indicate embedded CFF (Compact Font Format) font lookup.
embedFonts — Property in class flash.text.TextField
- - Specifies whether to render by using embedded font outlines.
emBox — Property in class flash.text.engine.FontMetrics
- The emBox value represents the design space of the font and is used to place Chinese, - Korean, or Japanese glyphs relative to the Roman baseline.
EMERGENCY — Constant static property in class flash.text.engine.TextLineCreationResult
- Indicates the line was created with an emergency break because no break opportunity - was available in the specified width.
enabled — Property in class flash.display.MovieClip
- A Boolean value that indicates whether a movie clip is enabled.
enabled — Property in class flash.display.NativeMenuItem
- - Controls whether this menu item is enabled.
enabled — Property in class flash.display.SimpleButton
- A Boolean value that specifies whether a button is enabled.
enabled — Static property in class flash.system.IME
- Indicates whether the system IME is enabled (true) or disabled (false).
enabled — Property in class flash.ui.GameInputDevice
- Enables or disables this device.
enableErrorChecking — Property in class flash.display3D.Context3D
- - Specifies whether errors encountered by the renderer are reported to the application.
enableVAD — Property in class flash.media.Microphone
- Enable Speex voice activity detection.
encode(rect:flash.geom:Rectangle, compressor:Object, byteArray:flash.utils:ByteArray) — Method in class flash.display.BitmapData
- - Compresses this BitmapData object using the selected compressor algorithm - - and returns a new ByteArray object.
encodeBootstrapPeerIDSpec(peerID:String) — Static method in class flash.net.GroupSpecifier
- Encodes and returns a string that represents a bootstrap peerID.
encoded — Property in class flash.security.X509Certificate
- Provides the whole certificate in encoded form.
encodeIPMulticastAddressSpec(address:String, port, source:String) — Static method in class flash.net.GroupSpecifier
- Encodes and returns a string that represents an IP multicast socket address.
encodePostingAuthorization(password:String) — Static method in class flash.net.GroupSpecifier
- Encodes and returns a string that represents a posting password.
encodePublishAuthorization(password:String) — Static method in class flash.net.GroupSpecifier
- Encodes and returns a string that represents a multicast publishing password.
encodeQuality — Property in class flash.media.Microphone
- The encoded speech quality when using the Speex codec.
encodeURI(uri) — Package function in Top Level
- - Encodes a string into a valid URI (Uniform Resource Identifier).
encodeURIComponent(uri) — Package function in Top Level
- - Encodes a string into a valid URI component.
encrypt(data:flash.utils:ByteArray, key:flash.utils:ByteArray, iv:flash.utils:ByteArray) — Static method in class air.security.Encryption
- - A utility function for encrypting an arbitrary amount of data.
EncryptedLocalStore — Class in package flash.data
- - The EncryptedLocalStore class (ELS) provides an encrypted local storage mechanism - - that can be used as a small cache for an application's private data.
Encryption — Class in package air.security
- - The Encryption class is used to encrypt and decrypt ByteArray objects - - using industry-standard AES-CBC algorithms.
END — Constant static property in class flash.events.GesturePhase
- The completion of a gesture (such as lifting a finger off a touch enabled screen).
END — Constant static property in class flash.text.TextFormatAlign
- Constant; aligns text to the end edge of a line.
END — Constant static property in class flash.text.engine.TabAlignment
- Positions the end of the tabbed text at the tab stop.
END — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the End key (35).
endDate — Property in class flash.net.drm.DRMPlaybackTimeWindow
- The end date for the period of time during which a DRM voucher is valid - (the playback window).
endFill() — Method in class flash.display.Graphics
- Applies a fill to the lines and curves that were added since the last call to the - beginFill(), beginGradientFill(), or - beginBitmapFill() method.
endian — Property in class air.security.Digest
- - The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN - - constant from the Endian class.
endian — Property in class flash.filesystem.FileStream
- - The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN constant - - from the Endian class.
endian — Property in class flash.net.Socket
- - Indicates the byte order for the data.
endian — Property in class flash.net.URLStream
- - Indicates the byte order for the data.
endian — Property in class flash.utils.ByteArray
- - Changes or reads the byte order for the data; either Endian.BIG_ENDIAN or - - Endian.LITTLE_ENDIAN.
endian — Property in interface flash.utils.IDataInput
- - The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN constant - - from the Endian class.
endian — Property in interface flash.utils.IDataOutput
- - The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN - - constant from the Endian class.
Endian — Final class in package flash.utils
- The Endian class contains values that denote the byte order used to represent multibyte - numbers.
endIndex — Property in class flash.globalization.NumberParseResult
- The index of the character after the last character of the numeric portion of the input string.
END_SEQUENCE — Constant static property in class flash.net.NetStreamAppendBytesAction
- Indicates that the media stream data is complete.
endsWith(other:String) — Method in class String
- - Checks whether this String object ends with the string that is passed in.
ENHANCED — Constant static property in class flash.display3D.Context3DProfile
- Use enhanced profile to target GPUs which support AGAL4.
enhancedOptions — Property in class flash.media.Microphone
- Controls enhanced microphone options.
ENTER — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Enter key (13).
enterFrame — Event in class flash.display.DisplayObject
- - [broadcast event] Dispatched when the playhead is entering a new - - frame.
ENTER_FRAME — Constant static property in class flash.events.Event
- The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
ENTERPRISE — Constant static property in class air.system.License
- - Definition for an Enterprise license level - -
entries — Property in class air.utils.ZipArchive
- - The entries within this zip archive.
enumerateFonts(enumerateDeviceFonts:Boolean) — Static method in class flash.text.Font
- - Specifies whether to provide a list of the currently available embedded fonts.
ENV_10 — Constant static property in class flash.printing.PaperSize
- Legal envelope - -
ENV_B5 — Constant static property in class flash.printing.PaperSize
- B5 envelope - -
ENV_C5 — Constant static property in class flash.printing.PaperSize
- C5 envelope - -
ENV_DL — Constant static property in class flash.printing.PaperSize
- DL envelope - -
ENV_MONARCH — Constant static property in class flash.printing.PaperSize
- Monarch envelope - -
ENV_PERSONAL — Constant static property in class flash.printing.PaperSize
- Personal envelope - -
EQUAL — Constant static property in class flash.display3D.Context3DCompareMode
- Equal (==).
EQUAL — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the = key (187).
equals(toCompare:flash.geom:Point) — Method in class flash.geom.Point
- Determines whether two points are equal.
equals(toCompare:flash.geom:Rectangle) — Method in class flash.geom.Rectangle
- - Determines whether the object specified in the toCompare parameter is - - equal to this Rectangle object.
equals(toCompare:flash.geom:Vector3D, allFour:Boolean) — Method in class flash.geom.Vector3D
- Determines whether two Vector3D objects are equal by comparing the x, y, and z - elements of the current Vector3D object with a specified Vector3D object.
equals(string1:String, string2:String) — Method in class flash.globalization.Collator
- Compares two strings and returns a Boolean value indicating whether the strings are equal.
ERASE — Constant static property in class flash.display.BlendMode
-Erases the background based on the alpha value of the display object.
ERASER — Constant static property in class flash.events.TouchEventIntent
- The touch event is generated by an eraser tool, the eraser end of an active stylus, or the like.
errno — Property in class flash.accessibility.AccessibilityImplementation
- Indicates an error code.
error — Event in class air.update.ApplicationUpdater
- - Dispatched when an error occurred either during initialization - - or during the update process (if something unexpected happens).
error — Event in class air.update.ApplicationUpdaterUI
- - Dispatched when an error occurred either during initialization - - or during the update process (if something unexpected happens).
error — Event in class flash.data.SQLConnection
- Dispatched when any of the SQLConnection object's asynchronous operations results - in an error.
error — Event in class flash.data.SQLStatement
- Dispatched when an error occurs during an operation.
error — Event in class flash.display.Stage3D
- Dispatched when a request for a rendering context fails.
error — Event in class flash.display3D.textures.CubeTexture
- - Dispatched by the CubeTexture object when an asynchronous texture upload - - operation fails in some way.
error — Event in class flash.display3D.textures.RectangleTexture
- - Dispatched by the RectangleTexture object when an asynchronous texture upload - - operation fails in some way.
error — Event in class flash.display3D.textures.Texture
- - Dispatched by the Texture object when an asynchronous texture upload - - operation fails in some way.
error — Property in class flash.events.AsyncErrorEvent
- The exception that was thrown.
error — Property in class flash.events.SQLErrorEvent
- A SQLError object containing detailed information about the cause of the error.
error — Property in class flash.events.UncaughtErrorEvent
- The error object associated with the uncaught error.
error — Event in class flash.media.CameraRoll
- The error event is dispatched when an error occurs.
error — Event in class flash.media.CameraUI
- The error event is dispatched when the default camera cannot be opened.
error — Event in class flash.media.StageWebView
- - Signals that an error has occurred.
error — Event in class flash.net.dns.DNSResolver
- Dispatched when an error occurred during a DNS lookup.
error — Event in class flash.security.XMLSignatureValidator
- Dispatched if verification cannot complete because of errors.
error(errString:String) — Static method in class flash.system.System
- - Output a string to the console via 'stderr'.
Error — Dynamic class in Top Level
- - The Error class contains information about an error that occurred in a script.
Error(message:String, id:int) — Constructor in class Error
- - Creates a new Error object.
ERROR — Constant static property in class flash.events.ErrorEvent
- Defines the value of the type property of an error event object.
ERROR — Constant static property in class flash.events.SQLErrorEvent
- The SQLErrorEvent.ERROR constant defines the value of the - type property of an error event dispatched when a call - to a method of a SQLConnection or SQLStatement instance completes - with an error.
ERROR — Constant static property in class flash.net.NetGroupSendResult
- Indicates an error occurred (such as no permission) when using a Directed Routing method.
ERROR_CANNOT_LOAD_READER — Constant static property in class flash.html.HTMLPDFCapability
- An error was returned by the OS when trying to load the Adobe Reader or Acrobat - application or one of its necessary libraries.
ERROR_CODE_UNKNOWN — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that the return error code is not known.
ErrorEvent — Class in package flash.events
-An object dispatches an ErrorEvent object when an error causes an asynchronous operation -to fail.
ErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, text:String, id:int) — Constructor in class flash.events.ErrorEvent
- Creates an Event object that contains information about error events.
errorID — Property in class Error
- - Contains the reference number associated with the specific error message.
errorID — Property in class flash.events.ErrorEvent
- Contains the reference number associated with the specific error.
ERROR_INSTALLED_PLAYER_NOT_FOUND — Constant static property in class flash.html.HTMLSWFCapability
- No version of Adobe Flash Player is detected.
ERROR_INSTALLED_PLAYER_TOO_OLD — Constant static property in class flash.html.HTMLSWFCapability
- Adobe Flash Player is detected, but the version is too old.
ERROR_INSTALLED_READER_NOT_FOUND — Constant static property in class flash.html.HTMLPDFCapability
- No version of Adobe Reader is detected.
ERROR_INSTALLED_READER_TOO_OLD — Constant static property in class flash.html.HTMLPDFCapability
- Adobe Reader is detected, but the version is too old.
ERROR_PREFERRED_READER_TOO_OLD — Constant static property in class flash.html.HTMLPDFCapability
- A sufficient version (8.1 or later) of Adobe Reader or Acrobat is detected, but the the version - of Adobe Reader that is set up to handle PDF content is older than Adobe Reader or Acrobat 8.1.
escape(str) — Package function in Top Level
- - Converts the parameter to a string and encodes it in a URL-encoded format, - - where most nonalphanumeric characters are replaced with % hexadecimal sequences.
ESCAPE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Escape key (27).
escapeMultiByte(value) — Package function in flash.utils
- Returns an escaped copy of the input string encoded as either UTF-8 or system code page, depending on the value of System.useCodePage.
estimatedMemberCount — Property in class flash.net.NetGroup
- Specifies the estimated number of members of the group, based on local neighbor density and - assuming an even distribution of group addresses.
EULER_ANGLES — Constant static property in class flash.geom.Orientation3D
- Euler angles, the default orientation for decompose() and recompose() methods, - defines the orientation with three separate angles of rotation for each axis.
EUROPEAN — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Latin-1 (European) digit set.
EvalError — Dynamic class in Top Level
- - The EvalError class represents an error that occurs when user code - - calls the eval() function or attempts to use the new - - operator with the Function object.
EvalError(message:String) — Constructor in class EvalError
- - Creates a new EvalError object.
EVEN_ODD — Constant static property in class flash.display.GraphicsPathWinding
-Establishes the even-odd winding type.
Event — Class in package flash.events
- The Event class is used as the base class for the creation of Event objects, - which are passed as parameters to event listeners when an event occurs.
Event(type:String, bubbles:Boolean, cancelable:Boolean) — Constructor in class flash.events.Event
- Creates an Event object to pass as a parameter to event listeners.
EventDispatcher — Class in package flash.events
-The EventDispatcher class is the base class for all runtime classes that dispatch events.
EventDispatcher(target:flash.events:IEventDispatcher) — Constructor in class flash.events.EventDispatcher
- Aggregates an instance of the EventDispatcher class.
eventListener(e:flash.events:Event) — Static method in class flash.external.HostObject
- Register this method as an event listener to have the host application - process a Flex event.
eventMirror — Property in class flash.text.engine.ContentElement
- The EventDispatcher object that receives copies of every - event dispatched to valid text lines based on this content element.
eventPhase — Property in class flash.events.Event
- The current phase in the event flow.
EventPhase — Final class in package flash.events
- The EventPhase class provides values for the eventPhase property of the Event class.
every(callback:Function, thisObject) — Method in class Array
- - Executes a test function on each item in the array until an item is reached that returns false for the - - specified function.
every(callback:Function, thisObject:Object) — Method in class Vector
- Executes a test function on each item in the Vector until an item is - reached that returns false for the specified function.
EXACT — Constant static property in class flash.net.NetGroupReceiveMode
- Specifies that this node accepts local messages from neighbors only if the address the neighbor uses - matches this node's address exactly.
EXACT_FIT — Constant static property in class flash.display.StageScaleMode
-Specifies that the entire application be visible in the specified area without trying to preserve -the original aspect ratio.
exactSettings — Static property in class flash.system.Security
- Determines how Flash Player or AIR chooses the domain to use for certain - content settings, including settings for camera and microphone - permissions, storage quotas, and storage of persistent shared objects.
exceptionValue — Property in class flash.events.HTMLUncaughtScriptExceptionEvent
- The result of evaluating the expression in the throw statement that resulted in the - uncaught exception.
exchange — Property in class flash.net.dns.MXRecord
- The host name of a mail exchange service.
EXCLUSIVE — Constant static property in class flash.data.SQLTransactionLockType
- Specifies the exclusive locking transaction option.
exec(str:String) — Method in class RegExp
- - Performs a search for the regular expression on the given string str.
executable — Property in class flash.desktop.NativeProcessStartupInfo
- The File object that references an executable on the host operating system.
execute(prefetch:int, responder:flash.net:Responder) — Method in class flash.data.SQLStatement
- Executes the SQL in the text property against the database that - is connected to the SQLConnection object in the sqlConnection - property.
EXECUTE — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that either the SQLStatement.execute() method - or the SQLStatement.next() method was called.
executeInBackground — Property in class flash.desktop.NativeApplication
- - Specifies whether the application will run in background or not.
executing — Property in class flash.data.SQLStatement
- Indicates whether the statement is currently executing.
EXECUTIVE — Constant static property in class flash.printing.PaperSize
- Executive size - -
exists — Property in class flash.filesystem.File
- - Indicates whether the referenced file or directory exists.
exit(errorCode:int) — Method in class flash.desktop.NativeApplication
- - Terminates this application.
exit — Event in class flash.desktop.NativeProcess
- Signals the native process has exited.
exit(force:Boolean) — Method in class flash.desktop.NativeProcess
- Attempts to exit the native process.
exit(code:uint) — Static method in class flash.system.System
- - Closes Flash Player.
EXIT — Constant static property in class flash.events.NativeProcessExitEvent
- Defines the value of the type property of a exit event object.
EXIT — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for exiting the current application mode.
exitCode — Property in class flash.events.NativeProcessExitEvent
- The exit code that the native process returned to the host operating system when exiting.
exitFrame — Event in class flash.display.DisplayObject
- - [broadcast event] Dispatched when the playhead is exiting the current frame.
EXIT_FRAME — Constant static property in class flash.events.Event
- The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
exiting — Event in class flash.desktop.NativeApplication
- - Dispatched when the application exit sequence is started.
EXITING — Constant static property in class flash.events.Event
- The Event.EXITING constant defines the value of the type property of an exiting event object.
EXOTIC — Constant static property in class flash.text.engine.LigatureLevel
- Used to specify exotic ligatures.
exp(val:Number) — Static method in class Math
- - Returns the value of the base of the natural logarithm (e), to the - - power of the exponent specified in the parameter x.
EXPIRED — Constant static property in class flash.security.CertificateStatus
- The certificate is outside its valid period.
expiryDate — Property in class air.system.License
- - Expiry date of a license that was loaded from a file.
extended — Property in class RegExp
- - Specifies whether to use extended mode for the regular expression.
EXTENDED_ARABIC_INDIC — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Extended Arabic-Indic digit set.
extends — Statement
Defines a class that is a subclass of another class.
extension — Property in class flash.net.FileFilter
- A list of file extensions.
extension — Property in class flash.net.FileReference
- The filename extension.
ExtensionContext — Final class in package flash.external

The ExtensionContext class also provides a static method getExtensionDirectory() for - - accessing the directory in which the extension is installed on the device.

extensionID — Property in class flash.external.ExtensionInfo
- - Returns the identifier for this extension.
ExtensionInfo — Final class in package flash.external
- - The ExtensionInfo class provides details about a particular AIR Native Extension.
extensions — Static property in class flash.external.HostObject
- Retrieve a list of the package names of all registered object model extensions.
ExternalInterface — Final class in package flash.external
- The ExternalInterface class is an application programming interface - that enables straightforward communication between ActionScript and the SWF - container– for example, an HTML page with JavaScript or a desktop application - that uses Flash Player to display a SWF file.
extract(target:flash.utils:ByteArray, length:Number, startPosition:Number) — Method in class flash.media.Sound
- Extracts raw sound data from a Sound object.
extractFiles(folder:flash.filesystem:File) — Method in class air.utils.ZipArchive
- - Extracts all of the entries from this zip archive onto the file system within the given folder.
extractFilesAsync(folder:flash.filesystem:File) — Method in class air.utils.ZipArchive
- - Extracts all of the entries from this zip archive onto the file system within the given folder.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/all-index-F.html b/html-docs/all-index-F.html deleted file mode 100644 index 83752c6..0000000 --- a/html-docs/all-index-F.html +++ /dev/null @@ -1,1971 +0,0 @@ - - - - - -F Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
F — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F key (70).
F1 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F1 key (112).
F10 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F10 key (121).
F11 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F11 key (122).
F12 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F12 key (123).
F13 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F13 key (124).
F14 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F14 key (125).
F15 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F15 key (126).
F2 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F2 key (113).
F24 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F24 key (135).
F3 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F3 key (114).
F4 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F4 key (115).
F5 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F5 key (116).
F6 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F6 key (117).
F7 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F7 key (118).
F8 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F8 key (119).
F9 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the F9 key (120).
false — Statement
A Boolean value representing false.
farID — Property in class flash.net.NetConnection
- The identifier of the Flash Media Server instance to which this Flash Player or Adobe AIR instance is connected.
farID — Property in class flash.net.NetStream
- For RTMFP connections, the identifier of the far end that is connected to this NetStream instance.
farNonce — Property in class flash.net.NetConnection
- A value chosen substantially by Flash Media Server, unique to this connection.
farNonce — Property in class flash.net.NetStream
- For RTMFP and RTMPE connections, a value chosen substantially by the other end of this stream, unique to this connection.
FAST — Constant static property in class flash.display.ShaderPrecision
- Represents fast precision mode.
fastCompression — Property in class flash.display.PNGEncoderOptions
- Chooses compression speed over file size.
FAST_FORWARD — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging fast-forward transport mode.
fieldOfView — Property in class flash.geom.PerspectiveProjection
- Specifies an angle, as a degree between 0 and 180, for the field of view in three - dimensions.
file — Property in class flash.media.MediaPromise
- The File instance representing the media object, if one exists.
File — Class in package flash.filesystem
- - A File object represents a path to a file or directory.
File(path:String) — Constructor in class flash.filesystem.File
- - The constructor function for the File class.
FILE — Constant static property in class air.utils.ZipEntry
- - Flag value for a file entry - -
FileFilter — Final class in package flash.net
- The FileFilter class is used to indicate what files on the user's system are shown - in the file-browsing dialog box that is displayed when the FileReference.browse() - method, the FileReferenceList.browse() method is called or a - browse method of a File, FileReference, or FileReferenceList object is called.
FileFilter(description:String, extension:String, macType:String) — Constructor in class flash.net.FileFilter
- Creates a new FileFilter instance.
fileList — Property in class flash.net.FileReferenceList
- An array of FileReference objects.
FileListEvent — Class in package flash.events
- A File object dispatches a FileListEvent object when a call to the getDirectoryListingAsync() method - of a File object successfully enumerates a set of files and directories or when a user selects files after a - call to the browseForOpenMultiple() method.
FileListEvent(type:String, bubbles:Boolean, cancelable:Boolean, files:Array) — Constructor in class flash.events.FileListEvent
- The constructor function for a FileListEvent object.
FILE_LIST_FORMAT — Constant static property in class flash.desktop.ClipboardFormats
- An array of files (AIR only).
FileMode — Class in package flash.filesystem
- The FileMode class defines string constants used in the fileMode parameter of - the open() and openAsync() methods of the FileStream class.
FILE_PROMISE_LIST_FORMAT — Constant static property in class flash.desktop.ClipboardFormats
- File promise list (AIR only).
FileReference — Class in package flash.net
- The FileReference class provides a means to upload and - download files between a user's computer and a server.
FileReference() — Constructor in class flash.net.FileReference
- Creates a new FileReference object.
FileReferenceList — Class in package flash.net
- The FileReferenceList class provides a means to let users select one or more files for uploading.
FileReferenceList() — Constructor in class flash.net.FileReferenceList
- Creates a new FileReferenceList object.
files — Property in class flash.events.FileListEvent
- An array of File objects representing the files and directories found or selected.
FileStream — Class in package flash.filesystem
- A FileStream object is used to read and write files.
FileStream() — Constructor in class flash.filesystem.FileStream
- Creates a FileStream object.
fileSystemType — Property in class flash.filesystem.StorageVolume
- The type of file system on the storage volume (such as "FAT", "NTFS", - "HFS", or "UFS").
fileUpdateError — Event in class air.update.ApplicationUpdater
- - Dispatched when an error occurs validating the file passed - - as the airFile parameter in a call to the installFromAIRFile() method.
fileUpdateError — Event in class air.update.ApplicationUpdaterUI
- - Dispatched when an error occurs validating the file passed - - as the airFile parameter in a call to the installFromAIRFile() method.
FILE_UPDATE_ERROR — Constant static property in class air.update.events.StatusFileUpdateErrorEvent
- - The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the - - type property of the event object for a statusUpdateError event.
fileUpdateStatus — Event in class air.update.ApplicationUpdater
- - Dispatched after the updater successfully validates the - - file in the call to the installFromAIRFile() method.
fileUpdateStatus — Event in class air.update.ApplicationUpdaterUI
- - - - Dispatched after the updater successfully validates the - - file in the call to the installFromAIRFile() method.
FILE_UPDATE_STATUS — Constant static property in class air.update.events.StatusFileUpdateEvent
- - The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the - - type property of the event object for a updateStatus event.
fill — Property in class flash.display.GraphicsStroke
- Specifies the instance containing data for filling a stroke.
fillRect(rect:flash.geom:Rectangle, color:uint) — Method in class flash.display.BitmapData
- - Fills a rectangular area of pixels with a specified ARGB color.
filter(callback:Function, thisObject) — Method in class Array
- - Executes a test function on each item in the array and constructs a new array for all items that return true for the specified function.
filter(callback:Function, thisObject:Object) — Method in class Vector
- Executes a test function on each item in the Vector and returns - a new Vector containing all items that return true for the - specified function.
filters — Property in class flash.display.DisplayObject
- An indexed array that contains each filter object currently associated with the display object.
final — Statement
Specifies that a method cannot be overridden or that a class cannot be extended.
findEntry(entry:String) — Method in class air.utils.ZipArchive
- - Find an entry in the archive using its name.
findInterfaces() — Method in class flash.net.NetworkInfo
- - Returns the list of network interfaces associated with this - - machine.
findNextAtomBoundary(afterCharIndex:int) — Method in class flash.text.engine.TextBlock
- Finds the index of the next atom boundary from the specified character index, not including the character at the specified index.
findNextWordBoundary(afterCharIndex:int) — Method in class flash.text.engine.TextBlock
- Finds the index of the next word boundary from the specified character index, not including the character at the specified index.
findPreviousAtomBoundary(beforeCharIndex:int) — Method in class flash.text.engine.TextBlock
- Finds the index of the previous atom boundary to the specified character index, not including the character at the specified index.
findPreviousWordBoundary(beforeCharIndex:int) — Method in class flash.text.engine.TextBlock
- Finds the index of the previous word boundary to the specified character index, not including the character at the specified index.
findText(beginIndex:int, textToFind:String, caseSensitive:Boolean) — Method in class flash.text.TextSnapshot
- Searches the specified TextSnapshot object and returns the position of the first - occurrence of textToFind found at or after beginIndex.
FINGER — Constant static property in class flash.system.TouchscreenType
- A touchscreen designed to respond to finger touches.
firstChild — Property in class flash.xml.XMLNode
- Evaluates the specified XMLDocument object and references the first child in the parent node's child list.
firstInvalidLine — Property in class flash.text.engine.TextBlock
- Identifies the first line in the text block in which TextLine.validity is not equal to - TextLineValidity.VALID.
firstLine — Property in class flash.text.engine.TextBlock
- The first TextLine in the TextBlock, if any.
firstPage — Property in class flash.printing.PrintJob
- The page number of the first page of the range entered by the user in the operating system's - Print dialog.
fixed — Property in class Vector
- Indicates whether the length property of the Vector can - be changed.
flags — Property in class air.utils.ZipEntry
- - The external attribute flags for this zip entry.
FLASH1 — Constant static property in class flash.display.SWFVersion
- SWF file format version 1.0.
FLASH10 — Constant static property in class flash.display.SWFVersion
- SWF file format version 10.0.
FLASH11 — Constant static property in class flash.display.SWFVersion
- SWF file format version 11.0.
FLASH12 — Constant static property in class flash.display.SWFVersion
- SWF file format version 12.0.
FLASH2 — Constant static property in class flash.display.SWFVersion
- SWF file format version 2.0.
FLASH3 — Constant static property in class flash.display.SWFVersion
- SWF file format version 3.0.
FLASH4 — Constant static property in class flash.display.SWFVersion
- SWF file format version 4.0.
FLASH5 — Constant static property in class flash.display.SWFVersion
- SWF file format version 5.0.
FLASH6 — Constant static property in class flash.display.SWFVersion
- SWF file format version 6.0.
FLASH7 — Constant static property in class flash.display.SWFVersion
- SWF file format version 7.0.
FLASH8 — Constant static property in class flash.display.SWFVersion
- SWF file format version 8.0.
FLASH9 — Constant static property in class flash.display.SWFVersion
- SWF file format version 9.0.
flash.accessibility — Package
The flash.accessibility package contains classes for supporting accessibility in Flash content and applications.
flash.concurrent — Package
flash.crypto — Package
flash.data — Package
The flash.data package contains classes used for working with Adobe AIR local SQL databases.
flash.desktop — Package
The flash.desktop package contains classes used for copy-and-paste and drag-and-drop operations, as well as the Icon class, used to define system icons used by a file.
flash.display — Package
The flash.display package contains the core classes that the Flash Player uses to build visual displays.
flash.display3D — Package
The flash.display3D package contains the classes that the Flash Player uses to render geometrically defined graphics.
flash.display3D.textures — Package
The flash.display3D.textures package contains classes for textures.
flash.errors — Package
The flash.errors package contains a set of commonly used error classes.
flash.events — Package
The flash.events package supports the new DOM event model and includes the EventDispatcher base class.
flash.external — Package
The flash.external package contains the ExternalInterface class which can be used to communicate with the Flash Player's container.
flash.filesystem — Package
The flash.filesystem package contains classes used in accessing the filesystem. This package is only available to content running in the AIR runtime.
flash.filters — Package
The flash.filters package contains classes for bitmap filter effects.
flash.geom — Package
The flash.geom package contains geometry classes, such as points, rectangles and transformation matrixes, to support the BitmapData class and the bitmap caching feature.
flash.globalization — Package
flash.html — Package
The flash.html package contains classes used for including HTML content in an AIR application. This package is only available to content running in the AIR runtime.
flash.media — Package
The flash.media package contains classes for working with multimedia assets such as sound and video.
flash.net — Package
The flash.net package contains classes for sending and receiving from the network, such as URL downloading and Flash Remoting.
flash.net.dns — Package
flash.net.drm — Package
flash.notifications — Package
flash.permissions — Package
flash.printing — Package
The flash.printing package contains classes for printing Flash-based content.
flash.profiler — Package
The flash.profiler package contains functions used for debugging and profiling ActionScript code.
flash_proxy — Statement
Defines methods of the Proxy class.
flash.security — Package
The flash.security package includes classes for validating XML signatures. This package is only available to content running in the AIR runtime.
flash.sensors — Package
flash.system — Package
The flash.system package contains classes for accessing system-level functionality, such as security, multilanguage content, etc.
flash.text — Package
The flash.text package contains classes for working with text fields, text formatting, text metrics, style sheets, and layout.
flash.text.engine — Package
The FTE provides low-level support for sophisticated control of text metrics, formatting, and bi-directional text. While it can be used to create and manage simple text elements, the FTE is primarily designed as a foundation for developers to create text-handling components.
flash.text.ime — Package
flash.ui — Package
The flash.ui package contains user interface classes, such as classes for interacting with the mouse and keyboard.
flash.utils — Package
The flash.utils package contains utility classes, such as data structures like ByteArray.
flash.xml — Package
The flash.xml package contains Flash Player's legacy XML support, and other Flash Player-specific XML functionality.
float — Final class in Top Level
- - A data type representing an IEEE-754 single-precision floating-point number.
float(num:Object) — Constructor in class float
- - Creates a float object with the specified value.
FLOAT — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - float value, equivalent to a single Number instance - in ActionScript.
FLOAT_1 — Constant static property in class flash.display3D.Context3DVertexBufferFormat
- -
FLOAT2 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - float2 value, equivalent to an Array of two Number instances - in ActionScript.
FLOAT_2 — Constant static property in class flash.display3D.Context3DVertexBufferFormat
- -
FLOAT3 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - float3 value, equivalent to an Array of three Number instances - in ActionScript.
FLOAT_3 — Constant static property in class flash.display3D.Context3DVertexBufferFormat
- -
FLOAT4 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - float4 value, equivalent to an Array of four Number instances - in ActionScript.
FLOAT_4 — Constant static property in class flash.display3D.Context3DVertexBufferFormat
- -
floodFill(x:int, y:int, color:uint) — Method in class flash.display.BitmapData
- - Performs a flood fill operation on an image starting - - at an (x, y) coordinate and filling with a certain color.
floor(val:Number) — Static method in class Math
- - Returns the floor of the number or expression specified in the parameter - - val.
flush(minDiskSpace:int) — Method in class flash.net.SharedObject
- Immediately writes a locally persistent shared object to a local file.
flush() — Method in class flash.net.Socket
- - Flushes any accumulated data in the socket's output buffer.
FLUSHED — Constant static property in class flash.net.SharedObjectFlushStatus
- Indicates that the flush completed successfully.
fmtBINARY — Constant static property in class air.net.WebSocket
- - Code for a BINARY websocket message.
fmtCLOSE — Constant static property in class air.net.WebSocket
- - Code for a CLOSE websocket message.
fmtPING — Constant static property in class air.net.WebSocket
- - Code for a PING websocket message.
fmtPONG — Constant static property in class air.net.WebSocket
- - Code for a PONG websocket message.
fmtTEXT — Constant static property in class air.net.WebSocket
- - Code for a TEXT websocket message.
focalLength — Property in class flash.geom.PerspectiveProjection
- The distance between the eye or the viewpoint's origin (0,0,0) and the display object located - in the z axis.
focalPointRatio — Property in class flash.display.GraphicsGradientFill
- A number that controls the - location of the focal point of the gradient.
focus — Property in class flash.display.Stage
- The interactive object with keyboard focus; or null if focus is not set - or if the focused object belongs to a security sandbox to which the calling object does not - have access.
FocusDirection — Final class in package flash.display
- The FocusDirection class enumerates values to be used for the - direction parameter of the assignFocus() method - of a Stage object and for the direction property of a FocusEvent object.
FocusEvent — Class in package flash.events
- An object dispatches a FocusEvent object when the user changes the focus from one object - in the display list to another.
FocusEvent(type:String, bubbles:Boolean, cancelable:Boolean, relatedObject:flash.display:InteractiveObject, shiftKey:Boolean, keyCode:uint, direction:String) — Constructor in class flash.events.FocusEvent
- Creates an Event object with specific information relevant to focus events.
focusIn — Event in class flash.display.InteractiveObject
- - Dispatched after a display object gains focus.
focusIn — Event in class flash.media.StageWebView
- - Dispatched when this StageWebView object receives focus.
focusIn — Event in class flash.text.StageText
- - Dispatched when the user is editing text, and the control has keyboard focus.
FOCUS_IN — Constant static property in class flash.events.FocusEvent
- Defines the value of the type property of a focusIn event object.
focusOut — Event in class flash.display.InteractiveObject
- - Dispatched after a display object loses focus.
focusOut — Event in class flash.media.StageWebView
- - Dispatched when the StageWebView relinquishes focus.
focusOut — Event in class flash.text.StageText
- - Dispatched when the user is no longer editing text, and the control no longer has - - keyboard focus.
FOCUS_OUT — Constant static property in class flash.events.FocusEvent
- Defines the value of the type property of a focusOut event object.
focusRect — Property in class flash.display.InteractiveObject
- - Specifies whether this object displays a focus rectangle.
FOLIO — Constant static property in class flash.printing.PaperSize
- Folio size - -
followRedirects — Property in class flash.net.URLRequest
- Specifies whether redirects are to be followed (true) - or not (false).
followRedirects — Static property in class flash.net.URLRequestDefaults
- The default setting for the followRedirects property of URLRequest objects.
font — Property in class flash.text.TextFormat
- The name of the font for text in this text format, as a string.
Font — Class in package flash.text
- - The Font class is used to manage embedded fonts in SWF files.
fontDescription — Property in class flash.text.engine.ElementFormat
- An object whose properties describe a font.
FontDescription — Final class in package flash.text.engine
- - The FontDescription class represents the information necessary to describe a font.
FontDescription(fontName:String, fontWeight:String, fontPosture:String, fontLookup:String, renderingMode:String, cffHinting:String) — Constructor in class flash.text.engine.FontDescription
- - Creates a FontDescription object.
fontFamily — Property in class flash.text.StageText
- - Indicates the name of the current font family.
fontLookup — Property in class flash.text.engine.FontDescription
- - Specifies how the font should be looked up.
FontLookup — Final class in package flash.text.engine
-The FontLookup class is an enumeration of constant values used with FontDescription.fontLookup.
FontMetrics — Final class in package flash.text.engine
- The FontMetrics class contains measurement and offset information about a font.
FontMetrics(emBox:flash.geom:Rectangle, strikethroughOffset:Number, strikethroughThickness:Number, underlineOffset:Number, underlineThickness:Number, subscriptOffset:Number, subscriptScale:Number, superscriptOffset:Number, superscriptScale:Number, lineGap:Number) — Constructor in class flash.text.engine.FontMetrics
- Creates a FontMetrics object.
fontName — Property in class flash.text.Font
- - The name of an embedded font.
fontName — Property in class flash.text.engine.FontDescription
- - The name of the font to use, or a comma-separated list of font names.
fontPosture — Property in class flash.text.StageText
- - Specifies the font posture, using constants defined in the FontPosture class.
fontPosture — Property in class flash.text.engine.FontDescription
- - Specifies the font posture.
FontPosture — Final class in package flash.text.engine
-The FontPosture class is an enumeration of constant values used with FontDescription.fontPosture to -set text to italic or normal.
fontSize — Property in class flash.text.CSMSettings
- The size, in pixels, for which the settings apply.
fontSize — Property in class flash.text.StageText
- - The size in pixels for the current font family.
fontSize — Property in class flash.text.engine.ElementFormat
- The size of text in pixels.
fontStyle — Property in class flash.text.Font
- - The style of the font.
FontStyle — Final class in package flash.text
-The FontStyle class provides values for the TextRenderer class.
fontType — Property in class flash.text.Font
- - The type of the font.
FontType — Final class in package flash.text
- The FontType class contains the enumerated constants "embedded" - and "device" for the fontType property of the Font class.
fontWeight — Property in class flash.text.StageText
- - Specifies the font weight, using constants defined in the FontWeight class.
fontWeight — Property in class flash.text.engine.FontDescription
- - Specifies the font weight.
FontWeight — Final class in package flash.text.engine
-The FontWeight class is an enumeration of constant values used with FontDescription.fontWeight.
for — Statement
Evaluates the init (initialize) expression once and then starts a looping sequence.
FORCE_REFRESH — Constant static property in class flash.net.drm.LoadVoucherSetting
- Downloads the voucher from the media rights server only.
forceSimple — Property in class flash.accessibility.AccessibilityProperties
- If true, causes Flash Player to exclude child objects within this - display object from the accessible presentation.
forEach(callback:Function, thisObject) — Method in class Array
- - Executes a function on each item in the array.
forEach(callback:Function, thisObject:Object) — Method in class Vector
- Executes a function on each item in the Vector.
for each..in — Statement
Iterates over the items of a collection and executes statement for each item.
for..in — Statement
Iterates over the dynamic properties of an object or elements in an array and executes statement for each property or element.
format — Property in class flash.events.WebSocketEvent
- - Retrieves the format of the WebSocket message.
format(value:Number, withCurrencySymbol:Boolean) — Method in class flash.globalization.CurrencyFormatter
- Creates a string representing a currency amount formatted according to the current properties of this CurrencyFormatter object, - including the locale, currency symbol, and currency ISO code.
format(dateTime:Date) — Method in class flash.globalization.DateTimeFormatter
- Formats a display string for a Date object that is interpreted as being in the user's local time - (using the local time components of the Date object such as: date, day, fullYear, hours, minutes, month, and seconds).
FORMAT — Constant static property in class flash.globalization.DateTimeNameContext
- Indicates that the date element name is used within a date format.
formatInt(value:int) — Method in class flash.globalization.NumberFormatter
- Formats an int value.
formatNumber(value:Number) — Method in class flash.globalization.NumberFormatter
- Formats a Number value.
formats — Property in class flash.desktop.Clipboard
- An array of strings containing the names of the data formats available - in this Clipboard object.
formattingWithCurrencySymbolIsSafe(requestedISOCode:String) — Method in class flash.globalization.CurrencyFormatter
- Determines whether the currently specified currency symbol can be used when formatting currency amounts.
formatToString(className:String, ... rest) — Method in class flash.events.Event
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
formatUint(value:uint) — Method in class flash.globalization.NumberFormatter
- Formats a uint value.
formatUTC(dateTime:Date) — Method in class flash.globalization.DateTimeFormatter
- Formats a display string for a Date object that is interpreted as being in UTC time - (using the UTC components of the Date object such as: dateUTC, dayUTC, fullYearUTC, hoursUTC, minutesUTC, monthUTC, - and secondsUTC), according to the dateStyle, timeStyle or date time pattern.
forwardAndBack — Property in class flash.ui.ContextMenuBuiltInItems
-Lets the user move forward or backward one frame in a SWF file at run time (does not -appear for a single-frame SWF file).
fps — Property in class flash.media.Camera
- - The maximum rate at which the camera can capture data, in frames per second.
fps — Property in class flash.media.VideoStreamSettings
- The maximum frame rate at which the video frames are encoded, in frames per second.
fps — Property in class flash.net.SharedObject
- Specifies the number of times per second that a client's changes to a - shared object are sent to the server.
fractionalDigits — Property in class flash.globalization.CurrencyFormatter
- The maximum number of digits that can appear after the decimal separator.
fractionalDigits — Property in class flash.globalization.NumberFormatter
- The maximum number of digits that can appear after the decimal separator.
FRAGMENT — Constant static property in class flash.display3D.Context3DProgramType
- A fragment (or pixel) program.
fragmentsPushedFromPeers — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media fragment messages that were proactively pushed from peers and received by the local node.
fragmentsPushedToPeers — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media fragment messages that the local node has proactively pushed to peers.
fragmentsReceivedFromIPMulticast — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media fragment messages that the local node has received from IP Multicast.
fragmentsReceivedFromServer — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media fragment messages that the local node has received from the server.
fragmentsRequestedByPeers — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media fragment messages that the local node has sent to peers in response to requests from those peers for specific fragments.
fragmentsRequestedFromPeers — Property in class flash.net.NetStreamMulticastInfo
- Specifies the number of media fragment messages that the local node requested and received from peers.
frame — Property in class flash.display.FrameLabel
- The frame number containing the label.
frameConstructed — Event in class flash.display.DisplayObject
- [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.
FRAME_CONSTRUCTED — Constant static property in class flash.events.Event
- The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
frameLabel — Event in class flash.display.FrameLabel
- Dispatched when the playhead enter a new frame, and the frame has - a FrameLabel object defined with a listener registered for the event.
FrameLabel — Final class in package flash.display
- - The FrameLabel object contains properties that specify a frame number and the - corresponding label name.
FrameLabel(name:String, frame:int) — Constructor in class flash.display.FrameLabel
- Constructor.
FRAME_LABEL — Constant static property in class flash.events.Event
- The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
frameRate — Property in class flash.display.LoaderInfo
- The nominal frame rate, in frames per second, of the loaded SWF file.
frameRate — Property in class flash.display.Stage
- Gets and sets the frame rate of the stage.
frameRate — Property in class flash.ui.MouseCursorData
- The frame rate for animating the cursor.
framesLoaded — Property in class flash.display.MovieClip
- The number of frames that are loaded from a streaming SWF file.
framesPerPacket — Property in class flash.media.Microphone
- Number of Speex speech frames transmitted in a packet (message).
FREE — Constant static property in class air.system.License
- - Definition for a Free Tier license level - -
freeMemory — Static property in class flash.system.System
- - The amount of memory (in bytes) that is allocated to - - Adobe® Flash® Player or - - Adobe® AIR® and that is not in use.
fromCharCode(... rest) — Static method in class String
- - Returns a string comprising the characters represented by the Unicode character codes - - in the parameters.
FRONT — Constant static property in class flash.display3D.Context3DTriangleFace
- -
FRONT — Constant static property in class flash.media.CameraPosition
- The Camera.position property returns this for a front camera.
FRONT_AND_BACK — Constant static property in class flash.display3D.Context3DTriangleFace
- -
fscommand(command, args) — Package function in flash.system
- Lets the SWF file communicate with either Flash Player or the program hosting Flash Player, - such as a web browser.
FULL — Constant static property in class flash.display.ShaderPrecision
- Represents full precision mode.
FULL — Constant static property in class flash.filters.BitmapFilterType
- Defines the setting that applies a filter to the entire area of an object.
FULL — Constant static property in class flash.globalization.DateTimeNameStyle
- Specifies the full form or full name style for month names and weekday names.
FULL_DUPLEX — Constant static property in class flash.media.MicrophoneEnhancedMode
- Use this mode to allow both parties to talk at the same time.
fullscreen — Property in class flash.html.HTMLWindowCreateOptions
- Specifies whether the window should be full screen.
fullScreen — Event in class flash.display.Stage
- Dispatched when the Stage object enters, or leaves, full-screen mode.
fullScreen — Property in class flash.events.FullScreenEvent
- Indicates whether the Stage object is in full-screen mode (true) or not (false).
FULL_SCREEN — Constant static property in class flash.display.StageDisplayState
-Specifies that the Stage is in full-screen mode.
FULLSCREEN — Constant static property in class flash.events.Event
- The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
FULL_SCREEN — Constant static property in class flash.events.FullScreenEvent
- The FullScreenEvent.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
FullScreenEvent — Class in package flash.events
-The Stage object dispatches a FullScreenEvent object whenever the Stage enters or leaves full-screen display mode.
FullScreenEvent(type:String, bubbles:Boolean, cancelable:Boolean, fullScreen:Boolean, interactive:Boolean) — Constructor in class flash.events.FullScreenEvent
- Creates an event object that contains information about fullScreen events.
fullScreenHeight — Property in class flash.display.Stage
- Returns the height of the monitor that will be used when going to full screen size, if that state - is entered immediately.
FULL_SCREEN_INTERACTIVE — Constant static property in class flash.display.StageDisplayState
-Specifies that the Stage is in full-screen mode with keyboard interactivity enabled.
FULL_SCREEN_INTERACTIVE_ACCEPTED — Constant static property in class flash.events.FullScreenEvent
- The FULL_SCREEN_INTERACTIVE_ACCEPTED:String constant defines the value of the type property of a fullScreenInteractiveAccepted event object.
fullScreenSourceRect — Property in class flash.display.Stage
- Sets the Flash runtime to scale a specific region of the stage to full-screen mode.
fullScreenWidth — Property in class flash.display.Stage
- Returns the width of the monitor that will be used when going to full screen size, if that state - is entered immediately.
FULL_WIDTH — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Fullwidth digit set.
fullYear — Property in class Date
- - The full year (a four-digit number, such as 2000) of a Date object - - according to local time.
fullYearUTC — Property in class Date
- - The four-digit year of a Date object according to universal time (UTC).
function — Statement
Comprises a set of statements that you define to perform a certain task.
Function — Final class in Top Level
- - A function is the basic unit of code that can be invoked in ActionScript.
FUNCTION — Constant static property in class flash.ui.Keyboard
- - Constant associated with the Mac function key (14).
functionKey — Property in class flash.events.KeyboardEvent
- - Indicates whether the Function key is active (true) or inactive (false).
functions — Property in class flash.external.ExtensionContext
- - Returns a list of the functions that are available to be called within this native extension context.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/all-index-G.html b/html-docs/all-index-G.html deleted file mode 100644 index 5fe4f0b..0000000 --- a/html-docs/all-index-G.html +++ /dev/null @@ -1,1970 +0,0 @@ - - - - - -G Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
G — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the G key (71).
gain — Property in class flash.media.Microphone
- The microphone gain—that is, the amount by which the microphone multiplies the signal before - transmitting it.
GameInput — Final class in package flash.ui
- The GameInput class is the entry point into the GameInput - API.
GameInputControl — Dynamic class in package flash.ui
- The GameInputControl class represents a control on an input device.
GameInputDevice — Final class in package flash.ui
- The GameInputDevice class represents a single input device - commonly used for gaming.
GameInputEvent — Final class in package flash.events
- The GameInputEvent class represents an event that is - dispatched when a game input device has either been added or removed - from the application platform.
GameInputEvent(type:String, bubbles:Boolean, cancelable:Boolean, device:flash.ui:GameInputDevice) — Constructor in class flash.events.GameInputEvent
-
gc() — Static method in class flash.system.System
- - Forces the garbage collection process.
generalClipboard — Static property in class flash.desktop.Clipboard
- The operating system clipboard.
generateFilterRect(sourceRect:flash.geom:Rectangle, filter:flash.filters:BitmapFilter) — Method in class flash.display.BitmapData
- - Determines the destination rectangle that the applyFilter() method call affects, given a - - BitmapData object, a source rectangle, and a filter object.
generateRandomBytes(numberRandomBytes) — Package function in flash.crypto
- Generates a sequence of random bytes.
genre — Property in class flash.media.ID3Info
- The genre of the song; corresponds to the ID3 2.0 tag TCON.
Geolocation — Class in package flash.sensors
- The Geolocation class dispatches events in response to the device's location sensor.
Geolocation() — Constructor in class flash.sensors.Geolocation
- Creates a new Geolocation instance.
GeolocationEvent — Class in package flash.events
-A Geolocation object dispatches GeolocationEvent objects when it receives updates from the location sensor installed on the device.
GeolocationEvent(type:String, bubbles:Boolean, cancelable:Boolean, latitude:Number, longitude:Number, altitude:Number, hAccuracy:Number, vAccuracy:Number, speed:Number, heading:Number, timestamp:Number) — Constructor in class flash.events.GeolocationEvent
- Creates a GeolocationEvent object that contains information about the - location of the device.
GESTURE — Constant static property in class flash.ui.MultitouchInputMode
- Specifies that TransformGestureEvent, PressAndTapGestureEvent, and GestureEvent events are dispatched for the related user interaction supported by the current environment, - and other touch events (such as a simple tap) are interpreted as mouse events.
gestureDirectionalTap — Event in class flash.display.InteractiveObject
- Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - Some devices might also interpret this contact as a combination of several touch events, as well.
GESTURE_DIRECTIONAL_TAP — Constant static property in class flash.events.TransformGestureEvent
- Defines the value of the type property of a GESTURE_DIRECTIONAL_TAP touch event object.
GestureEvent — Class in package flash.events
- The GestureEvent class lets you handle multi-touch events on devices that detect complex user contact with - the device (such as pressing two fingers on a touch screen at the same time).
GestureEvent(type:String, bubbles:Boolean, cancelable:Boolean, phase:String, localX:Number, localY:Number, ctrlKey:Boolean, altKey:Boolean, shiftKey:Boolean, commandKey:Boolean, controlKey:Boolean) — Constructor in class flash.events.GestureEvent
- Creates an Event object that contains information about multi-touch events - (such as pressing two fingers on a touch screen at the same time).
gestureLongPress — Event in class flash.display.InteractiveObject
- 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).
gesturePan — Event in class flash.display.InteractiveObject
- 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).
GESTURE_PAN — Constant static property in class flash.events.TransformGestureEvent
- Defines the value of the type property of a GESTURE_PAN touch event object.
GesturePhase — Final class in package flash.events
- The GesturePhase class is an enumeration class of constant values for use with the GestureEvent, PressAndTapGestureEvent, and TransformGestureEvent - classes.
GESTURE_PRESS_AND_TAP — Constant static property in class flash.events.PressAndTapGestureEvent
- Defines the value of the type property of a GESTURE_PRESS_AND_TAP touch event object.
gestureRotate — Event in class flash.display.InteractiveObject
- 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).
GESTURE_ROTATE — Constant static property in class flash.events.TransformGestureEvent
- Defines the value of the type property of a GESTURE_ROTATE touch event object.
gestureSwipe — Event in class flash.display.InteractiveObject
- 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).
GESTURE_SWIPE — Constant static property in class flash.events.TransformGestureEvent
- Defines the value of the type property of a GESTURE_SWIPE touch event object.
gestureTap — Event in class flash.display.InteractiveObject
- 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).
GESTURE_TWO_FINGER_TAP — Constant static property in class flash.events.GestureEvent
- Defines the value of the type property of a GESTURE_TWO_FINGER_TAP gesture event object.
gestureZoom — Event in class flash.display.InteractiveObject
- 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).
GESTURE_ZOOM — Constant static property in class flash.events.TransformGestureEvent
- Defines the value of the type property of a GESTURE_ZOOM touch event object.
get — Statement
Defines a getter, which is a method that can be read like a property.
__get(propName:String) — Method in class flash.external.HostObject
- The universal getter method receives the property name - and returns whatever the property value is.
GET — Constant static property in class flash.net.URLRequestMethod
- Specifies that the URLRequest object is a GET.
get_accDefaultAction(childID:uint) — Method in class flash.accessibility.AccessibilityImplementation
- MSAA method for returning the default action of the component - that this AccessibilityImplementation represents or of one of its child elements.
get_accFocus() — Method in class flash.accessibility.AccessibilityImplementation
- MSAA method for returning the unsigned integer ID of the child element, if any, - that has child focus within the component.
get_accName(childID:uint) — Method in class flash.accessibility.AccessibilityImplementation
- MSAA method for returning the name for the component - that this AccessibilityImplementation represents or for one of its child elements.
get_accRole(childID:uint) — Method in class flash.accessibility.AccessibilityImplementation
- MSAA method for returning the system role for the component - that this AccessibilityImplementation represents or for one of its child elements.
get_accSelection() — Method in class flash.accessibility.AccessibilityImplementation
- MSAA method for returning an array containing the IDs of all child elements that are selected.
get_accState(childID:uint) — Method in class flash.accessibility.AccessibilityImplementation
- IAccessible method for returning the current runtime state of the component that this - AccessibilityImplementation represents or of one of its child elements.
get_accValue(childID:uint) — Method in class flash.accessibility.AccessibilityImplementation
- MSAA method for returning the runtime value of the component that this - AccessibilityImplementation represents or of one of its child elements.
getAtomBidiLevel(atomIndex:int) — Method in class flash.text.engine.TextLine
- Gets the bidirectional level of the atom at the specified index.
getAtomBounds(atomIndex:int) — Method in class flash.text.engine.TextLine
- Gets the bounds of the atom at the specified index relative to the text line.
getAtomCenter(atomIndex:int) — Method in class flash.text.engine.TextLine
- Gets the center of the atom as measured along the baseline at the specified index.
getAtomGraphic(atomIndex:int) — Method in class flash.text.engine.TextLine
- Gets the graphic of the atom at the specified index, or null if the atom is a character.
getAtomIndexAtCharIndex(charIndex:int) — Method in class flash.text.engine.TextLine
- Returns the index of the atom containing the character specified by the charIndex parameter, - or -1 if the character does not contribute to any atom in the line.
getAtomIndexAtPoint(stageX:Number, stageY:Number) — Method in class flash.text.engine.TextLine
- Returns the index of the atom at the point specified by the x - and y parameters, or -1 if no atom exists at that point.
getAtomTextBlockBeginIndex(atomIndex:int) — Method in class flash.text.engine.TextLine
- Gets the text block begin index of the atom at the specified index.
getAtomTextBlockEndIndex(atomIndex:int) — Method in class flash.text.engine.TextLine
- Gets the text block end index of the atom at the specified index.
getAtomTextRotation(atomIndex:int) — Method in class flash.text.engine.TextLine
- Gets the rotation of the atom at the specified index.
getAtomWordBoundaryOnLeft(atomIndex:int) — Method in class flash.text.engine.TextLine
- Indicates whether a word boundary occurs to the left of the atom at the specified index.
getAvailableLocaleIDNames() — Static method in class flash.globalization.Collator
- Lists all of the locale ID names supported by this class.
getAvailableLocaleIDNames() — Static method in class flash.globalization.CurrencyFormatter
- Lists all of the locale ID names supported by this class.
getAvailableLocaleIDNames() — Static method in class flash.globalization.DateTimeFormatter
- Lists all of the locale ID names supported by this class.
getAvailableLocaleIDNames() — Static method in class flash.globalization.NumberFormatter
- Lists all of the locale ID names supported by this class.
getAvailableLocaleIDNames() — Static method in class flash.globalization.StringTools
- Lists all of the locale ID names supported by this class.
getBaselinePosition(baseline:String) — Method in class flash.text.engine.TextLine
- Gets the position of the specified baseline, relative to TextBlock.baselineZero.
getBounds(targetCoordinateSpace:flash.display:DisplayObject) — Method in class flash.display.DisplayObject
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
getCachedSamples(data:flash.utils:ByteArray, append:Boolean) — Method in class flash.ui.GameInputDevice
- Writes cached sample values to the ByteArray.
getCamera(name:String) — Static method in class flash.media.Camera
- - Returns a reference to a Camera object for capturing video.
getCharBoundaries(charIndex:int) — Method in class flash.text.TextField
- Returns a rectangle that is the bounding box of the character.
getCharIndexAtPoint(x:Number, y:Number) — Method in class flash.text.TextField
- Returns the zero-based index value of the character at the point specified by the x - and y parameters.
getChildAt(index:int) — Method in class flash.display.DisplayObjectContainer
- Returns the child display object instance that exists at the specified index.
getChildByName(name:String) — Method in class flash.display.DisplayObjectContainer
- Returns the child display object that exists with the specified name.
getChildIDArray() — Method in class flash.accessibility.AccessibilityImplementation
- Returns an array containing the unsigned integer IDs of all child elements - in the AccessibilityImplementation.
getChildIndex(child:flash.display:DisplayObject) — Method in class flash.display.DisplayObjectContainer
- Returns the index position of a child DisplayObject instance.
getClassByAlias(aliasName) — Package function in flash.net
- - Looks up a class that previously had an alias registered through a call to the registerClassAlias() - - method.
getClassObject(className:String) — Static method in class flash.external.HostObject
- Return the host object that is a class object for the given class name.
getColorBoundsRect(mask:uint, color:uint, findColor:Boolean) — Method in class flash.display.BitmapData
- - Determines a rectangular region that either fully encloses all pixels of a specified color within the - - bitmap image (if the findColor parameter is set to true) or fully encloses - - all pixels that do not include the specified color (if the findColor parameter is set - - to false).
getControlAt(i:int) — Method in class flash.ui.GameInputDevice
- Retrieves a specific control from a device.
getData(format:String, transferMode:String) — Method in class flash.desktop.Clipboard
- Gets the clipboard data if data in the specified format is present.
getDate() — Method in class Date
- - Returns the day of the month (an integer from 1 to 31) specified by a Date object - - according to local time.
getDateStyle() — Method in class flash.globalization.DateTimeFormatter
- Gets the date style for this instance of the DateTimeFormatter.
getDateTimePattern() — Method in class flash.globalization.DateTimeFormatter
- Returns the pattern string used by this DateTimeFormatter object to format dates and times.
getDay() — Method in class Date
- - Returns the day of the week (0 for Sunday, 1 for Monday, and so on) specified by this - - Date according to local time.
getDefaultApplication(extension:String) — Method in class flash.desktop.NativeApplication
- - Gets the default application for opening files with the specified extension.
getDefinition(name:String) — Method in class flash.system.ApplicationDomain
- Gets a public definition from the specified application domain.
getDefinitionByName(name) — Package function in flash.utils
- Returns a reference to the class object of the class specified by the name parameter.
getDescendants(name) — Method in class flash.utils.Proxy
getDeviceAt(index:int) — Static method in class flash.ui.GameInput
- Gets the input device at the specified index location in the list - of connected input devices.
getDirectoryListing() — Method in class flash.filesystem.File
- Returns an array of File objects corresponding to files and directories in the directory represented by this - File object.
getDirectoryListingAsync() — Method in class flash.filesystem.File
- Asynchronously retrieves an array of File objects corresponding to the contents of the directory represented - by this File object.
getDRMManager() — Static method in class flash.net.drm.DRMManager
- Returns an instance of the singleton DRMManager object.
getElementAt(index:int) — Method in class flash.text.engine.GroupElement
- Retrieves an element from within the group.
getElementAtCharIndex(charIndex:int) — Method in class flash.text.engine.GroupElement
- Returns the element containing the character specified by the charIndex parameter.
getElementIndex(element:flash.text.engine:ContentElement) — Method in class flash.text.engine.GroupElement
- Returns the index of the element specified by the element parameter.
getEnhancedMicrophone(index:int) — Static method in class flash.media.Microphone
- Returns a reference to an enhanced Microphone object that can - perform acoustic echo cancellation.
getExtensionDirectory(extensionID:String) — Static method in class flash.external.ExtensionContext
- - Returns the directory in which the extension is installed on the device.
getExtensionInfo(extensionID:String) — Static method in class flash.external.ExtensionContext
- - Gets information about an extension from the ID.
getFirstCharInParagraph(charIndex:int) — Method in class flash.text.TextField
- Given a character index, returns the index of the first character in the same paragraph.
getFirstWeekday() — Method in class flash.globalization.DateTimeFormatter
- Returns an integer corresponding to the first day of the week for this locale and calendar system.
getFontMetrics() — Method in class flash.text.engine.ElementFormat
-

Returns a FontMetrics object with properties which describe the emBox, strikethrough position, - strikethrough thickness, underline position, and underline thickness for the font specified by - fontDescription and fontSize.

-
getFullYear() — Method in class Date
- - Returns the full year (a four-digit number, such as 2000) of a Date object - - according to local time.
getHistoryAt(position:uint) — Method in class flash.html.HTMLLoader
getHours() — Method in class Date
- - Returns the hour (an integer from 0 to 23) of the day portion of a Date object - - according to local time.
getImageReference(id:String) — Method in class flash.text.TextField
- Returns a DisplayObject reference for the given id, for an image or SWF file - that has been added to an HTML-formatted text field by using an <img> tag.
getItem(name:String) — Static method in class flash.data.EncryptedLocalStore
- The data corresponding to the specified name.
getItemAt(index:int) — Method in class flash.display.NativeMenu
- Gets the menu item at the specified index.
getItemAt(index:int) — Method in class flash.ui.ContextMenu
- Gets the menu item at the specified index.
getItemByName(name:String) — Method in class flash.display.NativeMenu
- Gets the menu item with the specified name.
getItemIndex(item:flash.display:NativeMenuItem) — Method in class flash.display.NativeMenu
- Gets the position of the specified item.
getItemIndex(item:flash.display:NativeMenuItem) — Method in class flash.ui.ContextMenu
- Gets the position of the specified item.
getJustifierForLocale(locale:String) — Static method in class flash.text.engine.TextJustifier
- Constructs a default TextJustifier subclass appropriate to the specified locale.
getKeysAndValues() — Method in class flash.globalization.LocaleID
- Returns an object containing all of the key and value pairs from the LocaleID object.
getLanguage() — Method in class flash.globalization.LocaleID
- Returns the language code specified by the locale ID name.
getLineIndexAtPoint(x:Number, y:Number) — Method in class flash.text.TextField
- Returns the zero-based index value of the line at the point specified by the x - and y parameters.
getLineIndexOfChar(charIndex:int) — Method in class flash.text.TextField
- Returns the zero-based index value of the line containing the character specified - by the charIndex parameter.
getLineLength(lineIndex:int) — Method in class flash.text.TextField
- Returns the number of characters in a specific text line.
getLineMetrics(lineIndex:int) — Method in class flash.text.TextField
- Returns metrics information about a given text line.
getLineOffset(lineIndex:int) — Method in class flash.text.TextField
- Returns the character index of the first character in the line that - the lineIndex parameter specifies.
getLineText(lineIndex:int) — Method in class flash.text.TextField
- Returns the text of the line specified by the lineIndex parameter.
getLoaderInfoByDefinition(object:Object) — Static method in class flash.display.LoaderInfo
- Returns the LoaderInfo object associated with a SWF file defined as an object.
getLocal(name:String, localPath:String, secure:Boolean) — Static method in class flash.net.SharedObject
- Returns a reference to a locally persistent shared object that is only available to the current client.
getMicrophone(index:int) — Static method in class flash.media.Microphone
- - Returns a reference to a Microphone object for capturing audio.
getMilliseconds() — Method in class Date
- - Returns the milliseconds (an integer from 0 to 999) portion of a Date object - - according to local time.
getMinutes() — Method in class Date
- - Returns the minutes (an integer from 0 to 59) portion of a Date object - - according to local time.
getMirrorRegion(mirror:flash.events:EventDispatcher) — Method in class flash.text.engine.TextLine
- Returns the first TextLineMirrorRegion on the line whose mirror property matches - that specified by the mirror parameter, or null if no match exists.
getMonth() — Method in class Date
- - Returns the month (0 for January, 1 for February, and so on) portion of this - - Date according to local time.
getMonthNames(nameStyle:String, context:String) — Method in class flash.globalization.DateTimeFormatter
- Retrieves a list of localized strings containing the month names for the current calendar system.
getNamespaceForPrefix(prefix:String) — Method in class flash.xml.XMLNode
- Returns the namespace URI that is associated with the specified prefix for the node.
getObjectsUnderPoint(point:flash.geom:Point) — Method in class flash.display.DisplayObjectContainer
- Returns an array of objects that lie under the specified point and are children - (or grandchildren, and so on) of this DisplayObjectContainer instance.
getOffset(date:Date) — Method in class TimeZone
- - The time offset between this timezone and UTC, for a particular (UTC) date.
getParagraphLength(charIndex:int) — Method in class flash.text.TextField
- Given a character index, returns the length of the paragraph containing the given character.
getPixel(x:int, y:int) — Method in class flash.display.BitmapData
- - Returns an integer that represents an RGB pixel value from a BitmapData object at - - a specific point (x, y).
getPixel32(x:int, y:int) — Method in class flash.display.BitmapData
- - Returns an ARGB color value that contains alpha channel data and RGB - - data.
getPixels(rect:flash.geom:Rectangle) — Method in class flash.display.BitmapData
- - Generates a byte array from a rectangular region of pixel data.
getPrefixForNamespace(ns:String) — Method in class flash.xml.XMLNode
- Returns the prefix that is associated with the specified namespace URI for the node.
getProperty(name) — Method in class flash.utils.Proxy
getQualifiedClassName(value) — Package function in flash.utils
- Returns the fully qualified class name of an object.
getQualifiedClassName(value) — Static method in class flash.external.HostObject
- Return the fully qualified class name of the given value.
getQualifiedDefinitionNames() — Method in class flash.system.ApplicationDomain
- Gets all fully-qualified names of public definitions from the specified application domain.
getQualifiedSuperclassName(value) — Package function in flash.utils
- Returns the fully qualified class name of the base class of the object specified by the value - parameter.
getRandomBytes(size:uint) — Static method in class air.security.Encryption
- A utility function for generating random data.
getRect(targetCoordinateSpace:flash.display:DisplayObject) — Method in class flash.display.DisplayObject
- 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.
getRegion() — Method in class flash.globalization.LocaleID
- Returns the region code specified by the locale ID name.
getRelativeMatrix3D(relativeTo:flash.display:DisplayObject) — Method in class flash.geom.Transform
- Returns a Matrix3D object, which can transform the space of a specified - display object in relation to the current display object's space.
getRelativeMatrix3DToOutput(relativeTo:flash.display:DisplayObject, output:flash.geom:Matrix3D) — Method in class flash.geom.Transform
- Returns a Matrix3D object, which can transform the space of a specified - display object in relation to the current display object's space.
getRelativePath(ref:flash.net:FileReference, useDotDot:Boolean) — Method in class flash.filesystem.File
- Finds the relative path between two File paths.
getRemote(name:String, remotePath:String, persistence:Object, secure:Boolean) — Static method in class flash.net.SharedObject
- Returns a reference to a shared object on Flash Media Server that multiple - clients can access.
getResult() — Method in class flash.data.SQLStatement
- Provides access to a SQLResult object containing the results of the statement - execution, including any result rows from a SELECT statement, and other - information about the statement execution for all executed statements.
getRoot(name:String) — Static method in class flash.external.HostObject
- Return the host object that is a root object for the given extension.
getRootDirectories() — Static method in class flash.filesystem.File
- Returns an array of File objects, listing the file system root directories.
getSamples(buffer:flash.utils:ByteArray, append:Boolean) — Method in class flash.events.TouchEvent
- Updates the specified ByteArray object with the high-frequency data points for a multi-point touch event.
getSchemaResult() — Method in class flash.data.SQLConnection
- Provides access to the result of a call to the loadSchema() method.
getScreensForRectangle(rect:flash.geom:Rectangle) — Static method in class flash.display.Screen
- - Returns the (possibly empty) set of screens that intersect - - the provided rectangle.
getScript() — Method in class flash.globalization.LocaleID
- Returns the script code specified by the locale ID name.
getSeconds() — Method in class Date
- - Returns the seconds (an integer from 0 to 59) portion of a Date object - - according to local time.
getSelected(beginIndex:int, endIndex:int) — Method in class flash.text.TextSnapshot
- Returns a Boolean value that specifies whether a TextSnapshot object contains selected text in - the specified range.
getSelectedText(includeLineEndings:Boolean) — Method in class flash.text.TextSnapshot
- Returns a string that contains all the characters specified by the corresponding - setSelected() method.
get_selectionActiveIndex() — Method in class flash.accessibility.AccessibilityImplementation
get_selectionAnchorIndex() — Method in class flash.accessibility.AccessibilityImplementation
getSharedProperty(key:String) — Method in class flash.system.Worker
- Retrieves a value stored in this worker with a named key.
getStackTrace() — Method in class Error
- - Returns the call stack for an error at the time of the error's - - construction as a string.
getStorageVolumes() — Method in class flash.filesystem.StorageVolumeInfo
- - Returns vector of StorageVolume objects corresponding to the currently mounted storage volumes.
getStorageVolumesAsync() — Method in class flash.filesystem.StorageVolumeInfo
- - Triggers an asynchronous request to find the currently mounted storage volumes.
getStyle(styleName:String) — Method in class flash.text.StyleSheet
- Returns a copy of the style object associated with the style named styleName.
getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean) — Method in class flash.text.TextSnapshot
- Returns a string that contains all the characters specified by the beginIndex - and endIndex parameters.
getTextBounds(startIndex:int, endIndex:int) — Method in interface flash.text.ime.IIMEClient
- The IME uses this method to query the bounding box of the text currently edited with the IME client.
getTextFormat(beginIndex:int, endIndex:int) — Method in class flash.text.TextField
- Returns a TextFormat object that contains formatting information for the range of text that the - beginIndex and endIndex parameters specify.
getTextInRange(startIndex:int, endIndex:int) — Method in interface flash.text.ime.IIMEClient
- Gets the specified range of text from the component.
getTextLineAtCharIndex(charIndex:int) — Method in class flash.text.engine.TextBlock
- Returns the TextLine containing the character specified by the charIndex parameter.
getTextRunInfo(beginIndex:int, endIndex:int) — Method in class flash.text.TextSnapshot
- Returns an array of objects that contains information about a run of text.
getTime() — Method in class Date
- - Returns the number of milliseconds since midnight January 1, 1970, universal time, - - for a Date object.
getTimer() — Package function in flash.utils
- Used to compute relative time.
getTimeStyle() — Method in class flash.globalization.DateTimeFormatter
- Gets the time style for this instance of the DateTimeFormatter.
getTimeZone(timeZoneName:String) — Static method in class TimeZone
- - Obtains a TimeZone object using a string that is found in the list of availableTimeZoneNames.
getTimezoneOffset() — Method in class Date
- - Returns the difference, in minutes, between universal - - time (UTC) and the computer's local time.
getUTCDate() — Method in class Date
- - Returns the day of the month (an integer from 1 to 31) of a Date object, - - according to universal time (UTC).
getUTCDay() — Method in class Date
- - Returns the day of the week (0 for Sunday, 1 for Monday, and so on) of this Date - - according to universal time (UTC).
getUTCFullYear() — Method in class Date
- - Returns the four-digit year of a Date object according to universal time (UTC).
getUTCHours() — Method in class Date
- - Returns the hour (an integer from 0 to 23) of the day of a Date object - - according to universal time (UTC).
getUTCMilliseconds() — Method in class Date
- - Returns the milliseconds (an integer from 0 to 999) portion of a Date object - - according to universal time (UTC).
getUTCMinutes() — Method in class Date
- - Returns the minutes (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC).
getUTCMonth() — Method in class Date
- - Returns the month (0 [January] to 11 [December]) portion of a Date object - - according to universal time (UTC).
getUTCSeconds() — Method in class Date
- - Returns the seconds (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC).
getVariant() — Method in class flash.globalization.LocaleID
- Returns the language variant code specified by the locale ID name.
getVector(rect:flash.geom:Rectangle) — Method in class flash.display.BitmapData
- - Generates a vector array from a rectangular region of pixel data.
getVoucherAccessInfo() — Method in class flash.net.drm.DRMContentData
- Retrieves an array of VoucherAccessInfo objects.
getWeekdayNames(nameStyle:String, context:String) — Method in class flash.globalization.DateTimeFormatter
- Retrieves a list of localized strings containing the names of weekdays for the current calendar system.
global — Property in class RegExp
- - Specifies whether to use global matching for the regular expression.
globalToLocal(point:flash.geom:Point) — Method in class flash.display.DisplayObject
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
globalToLocal3D(point:flash.geom:Point) — Method in class flash.display.DisplayObject
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
globalToScreen(globalPoint:flash.geom:Point) — Method in class flash.display.NativeWindow
- - Converts a point in pixel coordinates relative to the origin of the window stage - - (a global point in terms of the display list), to a point on the virtual desktop.
GlowFilter — Final class in package flash.filters
- The GlowFilter class lets you apply a glow effect to display objects.
GlowFilter(color:uint, alpha:Number, blurX:Number, blurY:Number, strength:Number, quality:int, inner:Boolean, knockout:Boolean) — Constructor in class flash.filters.GlowFilter
- Initializes a new GlowFilter instance with the specified parameters.
GO — Constant static property in class flash.text.ReturnKeyLabel
- Use the label, "Go".
gotoAndPlay(frame:Object, scene:String) — Method in class flash.display.MovieClip
- Starts playing the SWF file at the specified frame.
gotoAndStop(frame:Object, scene:String) — Method in class flash.display.MovieClip
- Brings the playhead to the specified frame of the movie clip and stops it there.
GPU — Constant static property in class flash.display.NativeWindowRenderMode
- A gpu mode window.
GradientBevelFilter — Final class in package flash.filters
-The GradientBevelFilter class lets you apply a gradient bevel effect to -display objects.
GradientBevelFilter(distance:Number, angle:Number, colors:Array, alphas:Array, ratios:Array, blurX:Number, blurY:Number, strength:Number, quality:int, type:String, knockout:Boolean) — Constructor in class flash.filters.GradientBevelFilter
- Initializes the filter with the specified parameters.
GradientGlowFilter — Final class in package flash.filters
- The GradientGlowFilter class lets you apply a gradient glow effect to display objects.
GradientGlowFilter(distance:Number, angle:Number, colors:Array, alphas:Array, ratios:Array, blurX:Number, blurY:Number, strength:Number, quality:int, type:String, knockout:Boolean) — Constructor in class flash.filters.GradientGlowFilter
- Initializes the filter with the specified parameters.
GradientType — Final class in package flash.display
-The GradientType class provides values for the type parameter in the -beginGradientFill() and lineGradientStyle() methods of the flash.display.Graphics class.
GRANTED — Constant static property in class flash.permissions.PermissionStatus
- Specifies that the permission has been granted.
graphic — Property in class flash.text.engine.GraphicElement
- The DisplayObject to be used as a graphic for the GraphicElement.
GraphicElement — Final class in package flash.text.engine
- The GraphicElement class represents a graphic element in a TextBlock or GroupElement object.
GraphicElement(graphic:flash.display:DisplayObject, elementWidth:Number, elementHeight:Number, elementFormat:flash.text.engine:ElementFormat, eventMirror:flash.events:EventDispatcher, textRotation:String) — Constructor in class flash.text.engine.GraphicElement
- Creates a new GraphicElement instance.
GRAPHIC_ELEMENT — Constant static property in class flash.text.engine.ContentElement
- Indicates the presence of a graphic element in the text.
graphics — Property in class flash.display.Shape
- Specifies the Graphics object belonging to this Shape object, where vector - drawing commands can occur.
graphics — Property in class flash.display.Sprite
- Specifies the Graphics object that belongs to this sprite where vector - drawing commands can occur.
Graphics — Final class in package flash.display
- The Graphics class contains a set of methods that you can use to create a vector shape.
GraphicsBitmapFill — Final class in package flash.display
- Defines a bitmap fill.
GraphicsBitmapFill(bitmapData:flash.display:BitmapData, matrix:flash.geom:Matrix, repeat:Boolean, smooth:Boolean) — Constructor in class flash.display.GraphicsBitmapFill
- Creates a new GraphicsBitmapFill object.
GraphicsEndFill — Final class in package flash.display
- Indicates the end of a graphics fill.
GraphicsEndFill() — Constructor in class flash.display.GraphicsEndFill
- Creates an object to use with the Graphics.drawGraphicsData() method to end - the fill, explicitly.
GraphicsGradientFill — Final class in package flash.display
- Defines a gradient fill.
GraphicsGradientFill(type:String, colors:Array, alphas:Array, ratios:Array, matrix, spreadMethod, interpolationMethod:String, focalPointRatio:Number) — Constructor in class flash.display.GraphicsGradientFill
- Creates a new GraphicsGradientFill object.
GraphicsPath — Final class in package flash.display
- A collection of drawing commands and the coordinate parameters for those commands.
GraphicsPath(commands, data, winding:String) — Constructor in class flash.display.GraphicsPath
- Creates a new GraphicsPath object.
GraphicsPathCommand — Final class in package flash.display
- Defines the values to use for specifying path-drawing commands.
GraphicsPathWinding — Final class in package flash.display
-The GraphicsPathWinding class provides values for the flash.display.GraphicsPath.winding property -and the flash.display.Graphics.drawPath() method -to determine the direction to draw a path.
GraphicsShaderFill — Final class in package flash.display
- Defines a shader fill.
GraphicsShaderFill(shader:flash.display:Shader, matrix:flash.geom:Matrix) — Constructor in class flash.display.GraphicsShaderFill
- Creates a new GraphicsShaderFill object.
GraphicsSolidFill — Final class in package flash.display
- Defines a solid fill.
GraphicsSolidFill(color:uint, alpha:Number) — Constructor in class flash.display.GraphicsSolidFill
- Creates a new GraphicsSolidFill object.
GraphicsStroke — Final class in package flash.display
- Defines a line style or stroke.
GraphicsStroke(thickness:Number, pixelHinting:Boolean, scaleMode:String, caps:String, joints:String, miterLimit:Number, fill:flash.display:IGraphicsFill) — Constructor in class flash.display.GraphicsStroke
- Creates a new GraphicsStroke object.
GraphicsTrianglePath — Final class in package flash.display
- Defines an ordered set of triangles that can be rendered using - either (u,v) fill coordinates or a normal fill.
GraphicsTrianglePath(vertices, indices, uvtData, culling:String) — Constructor in class flash.display.GraphicsTrianglePath
- Creates a new GraphicsTrianglePath object.
GREATER — Constant static property in class flash.display3D.Context3DCompareMode
- Greater than (>).
GREATER_EQUAL — Constant static property in class flash.display3D.Context3DCompareMode
- Greater than or equal (>=).
GREEN — Constant static property in class flash.display.BitmapDataChannel
- The green channel.
GREEN — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the green function key button.
greenMultiplier — Property in class flash.geom.ColorTransform
- A decimal value that is multiplied with the green channel value.
greenOffset — Property in class flash.geom.ColorTransform
- A number from -255 to 255 that is added to the green channel value after it has - been multiplied by the greenMultiplier value.
gridFitType — Property in class flash.text.TextField
- The type of grid fitting used for this text field.
GridFitType — Final class in package flash.text
-The GridFitType class defines values for grid fitting in the TextField class.
groupElement — Property in class flash.text.engine.ContentElement
- The GroupElement object that contains this element, or - null if it is not in a group.
GroupElement — Final class in package flash.text.engine
- A GroupElement object groups a collection of TextElement, GraphicElement, or other GroupElement objects - that you can assign as a unit to the content property of a TextBlock object.
GroupElement(elements, elementFormat:flash.text.engine:ElementFormat, eventMirror:flash.events:EventDispatcher, textRotation:String) — Constructor in class flash.text.engine.GroupElement
- Creates a new GroupElement instance.
groupElements(beginIndex:int, endIndex:int) — Method in class flash.text.engine.GroupElement
- Replaces the range of elements that the beginIndex and endIndex - parameters specify with a new GroupElement containing those elements.
GROUP_EXECUTE — Constant static property in class air.utils.ZipEntry
- - Flag value for group-execute permission - -
groupingPattern — Property in class flash.globalization.CurrencyFormatter
- Describes the placement of grouping separators within the formatted currency amount string.
groupingPattern — Property in class flash.globalization.NumberFormatter
- Describes the placement of grouping separators within the formatted number string.
groupingSeparator — Property in class flash.globalization.CurrencyFormatter
- The character or string used for the grouping separator.
groupingSeparator — Property in class flash.globalization.NumberFormatter
- The character or string used for the grouping separator.
GROUP_READ — Constant static property in class air.utils.ZipEntry
- - Flag value for group-read permission - -
GroupSpecifier — Class in package flash.net
- The GroupSpecifier class is used to construct the opaque groupspec strings - that can be passed to NetStream and NetGroup constructors.
GroupSpecifier(name:String) — Constructor in class flash.net.GroupSpecifier
- Creates a new GroupSpecifier object.
groupspecWithAuthorizations() — Method in class flash.net.GroupSpecifier
- Returns the opaque groupspec string, including authorizations, that can be passed to NetStream and NetGroup constructors.
groupspecWithoutAuthorizations() — Method in class flash.net.GroupSpecifier
- Returns the opaque groupspec string, without authorizations, that can be passed to NetStream and NetGroup constructors.
GROUP_WRITE — Constant static property in class air.utils.ZipEntry
- - Flag value for group-write permission - -
GUIDE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging the program guide.
GUJARATI — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Gujarati digit set.
GURMUKHI — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Gurmukhi digit set.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/all-index-H.html b/html-docs/all-index-H.html deleted file mode 100644 index d7d67db..0000000 --- a/html-docs/all-index-H.html +++ /dev/null @@ -1,1072 +0,0 @@ - - - - - -H Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
H — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the H key (72).
H264AVC — Constant static property in class flash.media.VideoCodec
- Constant value indicating that H.264/AVC codec is used for compressing video.
H264Level — Final class in package flash.media
- The H264Level class is an enumeration of constant values used in setting the - level of H264VideoStreamSettings class.
H264Profile — Final class in package flash.media
- The H264Profile class is an enumeration of constant values used in setting the profile - of H264VideoStreamSettings class.
H264VideoStreamSettings — Class in package flash.media
- The H264VideoStreamSettings class enables specifying video compression settings for each NetStream.
H264VideoStreamSettings() — Constructor in class flash.media.H264VideoStreamSettings
- Creates a setting object that specifies to use H.264/AVC codec for video compression.
HALF_DUPLEX — Constant static property in class flash.media.MicrophoneEnhancedMode
- Use this mode for older and lower-quality speakers and microphones.
HAND — Constant static property in class flash.ui.MouseCursor
- Used to specify that the dragging hand cursor should be used.
HARDLIGHT — Constant static property in class flash.display.BlendMode
-Adjusts the color of each pixel based on the darkness of the display object.
hardwareAddress — Property in class flash.net.NetworkInterface
- The hardware address of this network interface.
hasAccessibility — Static property in class flash.system.Capabilities
- Specifies whether the system supports - (true) or does not support (false) communication - with accessibility aids.
hasAudio — Static property in class flash.system.Capabilities
- Specifies whether the system has audio - capabilities.
hasAudioEncoder — Static property in class flash.system.Capabilities
- Specifies whether the system can (true) or cannot (false) - encode an audio stream, such as that coming from a microphone.
hasChildNodes() — Method in class flash.xml.XMLNode
- Indicates whether the specified XMLNode object has child nodes.
hasComplexContent() — Method in class XML
- - Checks to see whether the XML object contains complex content.
hasComplexContent() — Method in class XMLList
- - Checks whether the XMLList object contains complex content.
hasDefinition(name:String) — Method in class flash.system.ApplicationDomain
- Checks to see if a public definition exists within the specified application domain.
hasEmbeddedVideo — Static property in class flash.system.Capabilities
- Specifies whether the system supports - (true) or does not support (false) - embedded video.
hasEventListener(type:String) — Method in class flash.display.Stage
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
hasEventListener(type:String) — Method in class flash.events.EventDispatcher
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
hasEventListener(type:String) — Method in interface flash.events.IEventDispatcher
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
hasFocusableContent — Property in class flash.html.HTMLLoader
hasFormat(format:String) — Method in class flash.desktop.Clipboard
- Checks whether data in the specified format exists in this Clipboard object.
hasGlyphs(str:String) — Method in class flash.text.Font
- - Specifies whether a provided string can be displayed using the currently assigned font.
hasGraphicElement — Property in class flash.text.engine.TextLine
- Indicates whether the text line contains any graphic elements.
hash(algorithm:String, data:flash.utils:ByteArray) — Static method in class air.security.Digest
- - A utility function for creating the digest of some data in a single function call.
hasIME — Static property in class flash.system.Capabilities
- Specifies whether the system does (true) - or does not (false) have an input method editor (IME) installed.
hasMP3 — Static property in class flash.system.Capabilities
- Specifies whether the system does (true) - or does not (false) have an MP3 decoder.
hasMultiChannelAudio(type:String) — Static method in class flash.system.Capabilities
- Specifies whether the system supports multichannel audio of a specific - type.
hasnext(obj, idx) — Package function in avm2.intrinsics.iteration
- - Determine whether the given object has any more properties.
hasOwnProperty(name:String) — Method in class Object
- - Indicates whether an object has a specified property defined.
hasOwnProperty(p:String) — Method in class XML
- - Checks to see whether the object has the property specified by the p parameter.
hasOwnProperty(p:String) — Method in class XMLList
- - Checks for the property specified by p.
hasPrinting — Static property in class flash.system.Capabilities
- Specifies whether the system does (true) - or does not (false) support printing.
hasProperty(name) — Method in class flash.utils.Proxy
hasScreenBroadcast — Static property in class flash.system.Capabilities
- Specifies whether the system does (true) or does not (false) - support the development of screen broadcast applications to be run through Flash Media - Server.
hasScreenPlayback — Static property in class flash.system.Capabilities
- Specifies whether the system does (true) or does not - (false) support the playback of screen broadcast applications - that are being run through Flash Media Server.
hasSimpleContent() — Method in class XML
- - Checks to see whether the XML object contains simple content.
hasSimpleContent() — Method in class XMLList
- - Checks whether the XMLList object contains simple content.
hasStreamingAudio — Static property in class flash.system.Capabilities
- Specifies whether the system can (true) or cannot (false) - play streaming audio.
hasStreamingVideo — Static property in class flash.system.Capabilities
- Specifies whether the system can (true) or cannot - (false) play streaming video.
hasTabs — Property in class flash.text.engine.TextLine
- Indicates whether the text line contains any tabs.
hasTLS — Static property in class flash.system.Capabilities
- Specifies whether the system supports native SSL sockets through NetConnection - (true) or does not (false).
hasVideoEncoder — Static property in class flash.system.Capabilities
- Specifies whether the system can (true) or cannot - (false) encode a video stream, such as that coming - from a web camera.
hasVirtualKeyboard — Static property in class flash.ui.Keyboard
- - Indicates whether the computer or device provides a virtual keyboard.
HEAD — Constant static property in class flash.net.URLRequestMethod
- Specifies that the URLRequest object is a HEAD.
header — Property in class flash.events.DRMAuthenticateEvent
- The encrypted content file header provided by the server.
heading — Property in class flash.events.GeolocationEvent
- The direction of movement (with respect to true north) in integer degrees.
HEADSET — Constant static property in class flash.media.MicrophoneEnhancedMode
- Use this mode when both parties are using headsets.
height — Property in class flash.desktop.DockIcon
- The current display height of the icon in pixels.
height — Property in class flash.desktop.InteractiveIcon
- The current display height of the icon in pixels.
height — Property in class flash.desktop.SystemTrayIcon
- The current display height of the icon in pixels.
height — Property in class flash.display.BitmapData
- - The height of the bitmap image in pixels.
height — Property in class flash.display.DisplayObject
- - Indicates the height of the display object, in pixels.
height — Property in class flash.display.LoaderInfo
- The nominal height of the loaded file.
height — Property in class flash.display.NativeWindow
- - The height of this window in pixels.
height — Property in class flash.display.ScreenMode
- The screen height of the ScreenMode in pixels.
height — Property in class flash.display.ShaderInput
- The height of the shader input.
height — Property in class flash.display.ShaderJob
- The height of the result data in the target if it is - a ByteArray or Vector.<Number> instance.
height — Property in class flash.display.Stage
- - Indicates the height of the display object, in pixels.
height — Property in class flash.geom.Rectangle
- - The height of the rectangle, in pixels.
height — Property in class flash.html.HTMLLoader
height — Property in class flash.html.HTMLWindowCreateOptions
- Specifies the desired initial height of the new window.
height — Property in class flash.media.Camera
- - The current capture height, in pixels.
height — Property in class flash.media.CameraRollBrowseOptions
- Specifies the height of the CameraRoll image picker.
height — Property in class flash.media.VideoStreamSettings
- The current encoded height, in pixels.
height — Property in class flash.text.TextExtent
height — Property in class flash.text.TextLineMetrics
- The height value of the text of the selected lines (not necessarily the complete text) in pixels.
HELP — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging the help application or context-sensitive help.
hide() — Static method in class flash.ui.Mouse
- Hides the pointer.
hideBuiltInItems() — Method in class flash.ui.ContextMenu
- Hides all built-in menu items (except Settings) in the specified ContextMenu object.
hideObject — Property in class flash.filters.DropShadowFilter
- Indicates whether or not the object is hidden.
HIGH — Constant static property in class flash.display.StageQuality
- Specifies high rendering quality.
HIGH — Constant static property in class flash.filters.BitmapFilterQuality
- Defines the high quality filter setting.
HIGH_16X16 — Constant static property in class flash.display.StageQuality
- Specifies very high rendering quality.
HIGH_16X16_LINEAR — Constant static property in class flash.display.StageQuality
- Specifies very high rendering quality.
HIGH_8X8 — Constant static property in class flash.display.StageQuality
- Specifies very high rendering quality.
HIGH_8X8_LINEAR — Constant static property in class flash.display.StageQuality
- Specifies very high rendering quality.
highlightAlpha — Property in class flash.filters.BevelFilter
- The alpha transparency value of the highlight color.
highlightColor — Property in class flash.filters.BevelFilter
- The highlight color of the bevel.
histogram(hRect:flash.geom:Rectangle) — Method in class flash.display.BitmapData
- - Computes a 256-value binary number histogram of a BitmapData object.
historyBack() — Method in class flash.html.HTMLLoader
historyBack() — Method in class flash.media.StageWebView
- - Navigates to the previous page in the browsing history.
historyForward() — Method in class flash.html.HTMLLoader
historyForward() — Method in class flash.media.StageWebView
- - Navigates to the next page in the browsing history.
historyGo(steps:int) — Method in class flash.html.HTMLLoader
historyLength — Property in class flash.html.HTMLLoader
historyPosition — Property in class flash.html.HTMLLoader
hitArea — Property in class flash.display.Sprite
- Designates another sprite to serve as the hit area for a sprite.
hitTest(firstPoint:flash.geom:Point, firstAlphaThreshold:uint, secondObject:Object, secondBitmapDataPoint:flash.geom:Point, secondAlphaThreshold:uint) — Method in class flash.display.BitmapData
- - Performs pixel-level hit detection between one bitmap image - - and a point, rectangle, or other bitmap image.
hitTestObject(obj:flash.display:DisplayObject) — Method in class flash.display.DisplayObject
- - Evaluates the bounding box of the display object to see if it overlaps or intersects with the - - bounding box of the obj display object.
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean) — Method in class flash.display.DisplayObject
- - Evaluates the display object to see if it overlaps or intersects with the - - point specified by the x and y parameters.
hitTestState — Property in class flash.display.SimpleButton
- Specifies a display object that is used as the hit testing object for the button.
hitTestTextNearPos(x:Number, y:Number, maxDistance:Number) — Method in class flash.text.TextSnapshot
- Lets you determine which character within a TextSnapshot object is on or near the specified - x, y coordinates of the movie clip containing the text in the TextSnapshot object.
HOME — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Home key (36).
HORIZONTAL — Constant static property in class flash.display.LineScaleMode
- With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line scales only horizontally.
horizontalAccuracy — Property in class flash.events.GeolocationEvent
- The horizontal accuracy in meters.
HORIZONTAL_STEM — Constant static property in class flash.text.engine.CFFHinting
- Fits strong horizontal stems to the pixel grid for improved readability.
host — Property in class flash.events.DNSResolverEvent
- The query string, such as a host name, IP address, or service locator used in the call to - the lookup() method of the DNSResolver class for which this event is a response.
HostObject — Dynamic class in package flash.external
- The HostObject is the base class of all host objects.
hotSpot — Property in class flash.ui.MouseCursorData
- The hot spot of the cursor in pixels.
hours — Property in class Date
- - The hour (an integer from 0 to 23) of the day portion of a Date object - - according to local time.
hoursUTC — Property in class Date
- - The hour (an integer from 0 to 23) of the day of a Date object - - according to universal time (UTC).
HTML_BOUNDS_CHANGE — Constant static property in class flash.events.Event
- The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
HTML_DOM_INITIALIZE — Constant static property in class flash.events.Event
- The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
HTML_FORMAT — Constant static property in class flash.desktop.ClipboardFormats
- HTML data.
HTMLHistoryItem — Class in package flash.html
- An HTMLHistoryItem object describes a location in the navigation history of - an HTMLLoader object.
htmlHost — Property in class flash.html.HTMLLoader
HTMLHost — Class in package flash.html
- An HTMLHost object defines behaviors of an HTMLLoader object for user interface elements that - can be controlled by setting various properties or by calling various methods of the window - object of the HTML page.
HTMLHost(defaultBehaviors:Boolean) — Constructor in class flash.html.HTMLHost
- Creates an HTMLHost object.
htmlLoader — Property in class flash.html.HTMLHost
- The HTMLLoader object to which this HostControl object applies.
HTMLLoader — Class in package flash.html
HTMLLoader() — Constructor in class flash.html.HTMLLoader
htmlParagraphBehavior — Property in class flash.text.TextField
- - A Boolean value that determines whether <p> paragraph breaks should - - behave like HTML paragraphs.
HTMLPDFCapability — Final class in package flash.html
- The HTMLPDFCapability class contains possible values of the pdfCapability property of - an HTMLLoader object.
HTML_RENDER — Constant static property in class flash.events.Event
- The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
HTMLSWFCapability — Final class in package flash.html
- The HTMLSWFCapability class contains possible values of the swfCapability property of - an HTMLLoader object.
htmlText — Property in class flash.text.TextField
- - Contains the HTML representation of the text field contents.
HTMLUncaughtScriptExceptionEvent — Class in package flash.events
- An HTMLLoader object dispatches an HTMLUncaughtScriptExceptionEvent object whenever a JavaScript exception - is thrown and not handled with a catch statement.
HTMLUncaughtScriptExceptionEvent(exceptionValue) — Constructor in class flash.events.HTMLUncaughtScriptExceptionEvent
- Creates an HTMLUncaughtScriptExceptionEvent object to pass as a parameter to event listeners.
HTMLWindowCreateOptions — Class in package flash.html
- This class defines the options that can be specified when JavaScript running - in an HTMLLoader object tries to create a new HTML window by calling the - window.open() method.
httpIdleTimeout — Property in class flash.net.NetConnection
- The time, in milliseconds, to wait for an HTTP response.
httpResponseStatus — Event in class flash.net.FileReference
- Dispatched if a call to the upload() or uploadUnencoded() - method attempts to access data over HTTP and Adobe AIR is able to detect and return - the status code for the request.
httpResponseStatus — Event in class flash.net.URLLoader
- - Dispatched if a call to the load() method attempts to access data over HTTP, - - and Adobe AIR is able to detect and return the status code for the request.
httpResponseStatus — Event in class flash.net.URLStream
- - Dispatched if a call to the URLStream.load() method attempts to access data over HTTP - - and Adobe AIR is able to detect and return the status code for the request.
HTTP_RESPONSE_STATUS — Constant static property in class flash.events.HTTPStatusEvent
- Unlike the httpStatus event, the httpResponseStatus event is - delivered before any response data.
httpStatus — Event in class flash.display.LoaderInfo
- Dispatched when a network request is made over HTTP and an HTTP status code can be detected.
httpStatus — Event in class flash.net.FileReference
- Dispatched when an upload fails and an HTTP status code is available - to describe the failure.
httpStatus — Event in class flash.net.URLLoader
- - Dispatched if a call to URLLoader.load() - - attempts to access data over HTTP.
httpStatus — Event in class flash.net.URLStream
- - Dispatched if a call to URLStream.load() - - attempts to access data over HTTP, and Flash Player or Adobe AIR - - is able to detect and return the status code for the request.
HTTP_STATUS — Constant static property in class flash.events.HTTPStatusEvent
- The HTTPStatusEvent.HTTP_STATUS constant defines the value of the - type property of a httpStatus event object.
HTTPStatusEvent — Class in package flash.events
-The application dispatches HTTPStatusEvent objects when a network request returns an HTTP -status code.
HTTPStatusEvent(type:String, bubbles:Boolean, cancelable:Boolean, status:int, redirected:Boolean) — Constructor in class flash.events.HTTPStatusEvent
- Creates an Event object that contains specific information about HTTP status events.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/all-index-I.html b/html-docs/all-index-I.html deleted file mode 100644 index 22af3a9..0000000 --- a/html-docs/all-index-I.html +++ /dev/null @@ -1,2524 +0,0 @@ - - - - - -I Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
I — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the I key (73).
IBEAM — Constant static property in class flash.ui.MouseCursor
- Used to specify that the I-beam cursor should be used.
IBitmapDrawable — Interface in package flash.display
- The IBitmapDrawable interface is implemented by objects that can be passed as the source - parameter of the draw() method of the BitmapData class.
icon — Property in class flash.desktop.NativeApplication
- - The application icon.
icon — Property in class flash.filesystem.File
- - An Icon object containing the icons defined for the file.
Icon — Class in package flash.desktop
- The Icon class represents an operating system icon.
id — Property in class flash.ui.GameInputControl
- Returns the id of this control.
id — Property in class flash.ui.GameInputDevice
- Returns the ID of this device.
id3 — Event in class flash.media.Sound
- Dispatched by a Sound object when ID3 data is available for an MP3 sound.
id3 — Property in class flash.media.Sound
- Provides access to the metadata that is part of an MP3 file.
ID3 — Constant static property in class flash.events.Event
- The Event.ID3 constant defines the value of the type property of an id3 event object.
ID3Info — Final dynamic class in package flash.media
- The ID3Info class contains properties that reflect ID3 metadata.
IDataInput — Interface in package flash.utils
- -The IDataInput interface provides a set of methods for reading binary data.
IDataOutput — Interface in package flash.utils
- -The IDataOutput interface provides a set of methods for writing binary data.
identity() — Method in class flash.geom.Matrix
- - Sets each matrix property to a value that causes a null transformation.
identity() — Method in class flash.geom.Matrix3D
- Converts the current matrix to an identity or unit matrix.
identityStatus — Property in class flash.security.XMLSignatureValidator
- The validity status of the signing certificate.
IDEOGRAPHIC_BOTTOM — Constant static property in class flash.text.engine.TextBaseline
- Specifies an ideographic bottom baseline.
IDEOGRAPHIC_CENTER — Constant static property in class flash.text.engine.TextBaseline
- Specifies an ideographic center baseline.
IDEOGRAPHIC_TOP — Constant static property in class flash.text.engine.TextBaseline
- Specifies an ideographic top baseline.
idleThreshold — Property in class flash.desktop.NativeApplication
- - The number of seconds that must elapse without user input - - before a userIdle event is dispatched.
idleTimeout — Property in class flash.html.HTMLLoader
idleTimeout — Property in class flash.net.URLRequest
- Specifies the idle timeout value (in milliseconds) for this request.
idleTimeout — Static property in class flash.net.URLRequestDefaults
- The default setting for the idleTimeout property of URLRequest objects and HTMLLoader objects.
idMap — Property in class flash.xml.XMLDocument
- An Object containing the nodes of the XML that have an id attribute assigned.
IDynamicPropertyOutput — Interface in package flash.net
- - This interface controls the serialization of dynamic properties of dynamic objects.
IDynamicPropertyWriter — Interface in package flash.net
- - This interface is used with the IDynamicPropertyOutput interface to control - - the serialization of dynamic properties of dynamic objects.
IEventDispatcher — Interface in package flash.events
-The IEventDispatcher interface defines methods for adding or removing event listeners, checks -whether specific types of event listeners are registered, and dispatches events.
IExternalizable — Interface in package flash.utils
- - The IExternalizable interface provides control over serialization of a class as it is encoded - - into a data stream.
if — Statement
Evaluates a condition to determine the next statement to execute.
IFilePromise — Interface in package flash.desktop
- The IFilePromise interface defines the interface used by the AIR runtime to read data for a file promise.
IGNORE — Constant static property in class flash.filters.DisplacementMapFilterMode
- If the displacement value is out of range, ignores the displacement and uses the source pixel.
ignoreCase — Property in class RegExp
- - Specifies whether the regular expression ignores case sensitivity.
ignoreCase — Property in class flash.globalization.Collator
- When this property is set to true, identical strings and strings that differ only in the case of the letters - are evaluated as equal.
ignoreCharacterWidth — Property in class flash.globalization.Collator
- When this property is true, full-width and half-width forms of some Chinese and Japanese characters are evaluated as equal.
ignoreComments — Static property in class XML
- - Determines whether XML comments are ignored - - when XML objects parse the source XML data.
ignoreDiacritics — Property in class flash.globalization.Collator
- When this property is set to true, strings that use the same base characters but - different accents or other diacritic marks are evaluated as equal.
ignoreKanaType — Property in class flash.globalization.Collator
- When this property is set to true, strings that differ only by the type of kana character being used are - treated as equal.
ignoreProcessingInstructions — Static property in class XML
- - Determines whether XML - - processing instructions are ignored when XML objects parse the source XML data.
ignoreResourceLimits — Property in class flash.display3D.Context3D
- - Specifies whether to ignore all 'soft' resource limits associated with a profile.
ignoreSymbols — Property in class flash.globalization.Collator
- When this property is set to is true, symbol characters such as spaces, currency symbols, math symbols, - and other types of symbols are ignored when sorting or matching.
ignoreWhite — Property in class flash.xml.XMLDocument
- When set to true, text nodes that contain only white space are discarded during the parsing process.
ignoreWhitespace — Static property in class XML
- - Determines whether white space characters - - at the beginning and end of text nodes are ignored during parsing.
IGraphicsData — Interface in package flash.display
- This interface is used to define objects that can be used as parameters in the flash.display.Graphics - methods, including fills, strokes, and paths.
IGraphicsFill — Interface in package flash.display
- This interface is used to define objects that can be used as fill parameters in the flash.display.Graphics - methods and drawing classes.
IGraphicsPath — Interface in package flash.display
- This interface is used to define objects that can be used as path parameters in the flash.display.Graphics - methods and drawing classes.
IGraphicsStroke — Interface in package flash.display
- This interface is used to define objects that can be used as stroke parameters in the flash.display.Graphics - methods and drawing classes.
IIMEClient — Interface in package flash.text.ime
-Interface for IME (input method editor) clients.
ILLEGAL_ARGUMENT_ERROR — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that an argument passed to a method was illegal.
IMAGE — Constant static property in class flash.media.MediaType
- A single image.
imageDecodingPolicy — Property in class flash.system.LoaderContext
- Specifies whether to decode bitmap image data when it is used or when it is loaded.
ImageDecodingPolicy — Final class in package flash.system
- The ImageDecodingPolicy class provides values for imageDecodingPolicy in the LoaderContext class.
ime — Static property in class flash.system.System
- - The currently installed system IME.
IME — Final class in package flash.system
- The IME class lets you directly manipulate the operating system's input method - editor (IME) in the Flash runtime application that is running on a client computer.
imeClient — Property in class flash.events.IMEEvent
- Specifies an object that implements the IMEClient interface.
imeComposition — Event in class flash.system.IME
- Dispatched when a user has completed an - input method editor (IME) composition - and the reading string is available.
IME_COMPOSITION — Constant static property in class flash.events.IMEEvent
- Defines the value of the type property of an imeComposition event object.
IMEConversionMode — Final class in package flash.system
- This class contains constants for use with the IME.conversionMode - property.
IMEEvent — Class in package flash.events
- An IMEEvent object is dispatched when the user enters text using an input method editor - (IME).
IMEEvent(type:String, bubbles:Boolean, cancelable:Boolean, text:String, imeClient:flash.text.ime:IIMEClient) — Constructor in class flash.events.IMEEvent
- Creates an Event object with specific information relevant to IME events.
imeStartComposition — Event in class flash.display.InteractiveObject
- - This event is dispatched to any client app that supports inline input with an IME - - - -
imeStartComposition — Event in interface flash.text.ime.IIMEClient
- Dispatched when the user begins to use an IME (input method editor).
IME_START_COMPOSITION — Constant static property in class flash.events.IMEEvent
- To handle IME text input, the receiver must set the imeClient field of the event to an object - that implements the IIMEClient interface.
IMMEDIATE — Constant static property in class flash.data.SQLTransactionLockType
- Specifies the immediate locking transaction option.
implements — Statement
Specifies that a class implements one or more interfaces.
import — Statement
Makes externally defined classes and packages available to your code.
in — Operator
Evaluates whether a property is part of a specific object.
inAppDescriptor — Property in class flash.external.ExtensionInfo
- - A Boolean value indicating whether the extension was present in the Application Descriptor - - file or whether it was loaded and registered dynamically.
inBufferSeek — Property in class flash.net.NetStream
- Specifies whether displayed data is cached for smart seeking (TRUE), or not (FALSE).
include — Statement
Includes the contents of the specified file, as if the commands in the file are part of the calling script.
includes(item) — Method in class Array
- - Checks whether the array includes the item that is passed in.
includes(item) — Method in class Vector
- Checks whether the vector includes the item that is passed in.
incrementBy(a:flash.geom:Vector3D) — Method in class flash.geom.Vector3D
- Increments the value of the x, y, and z elements of the current Vector3D object - by the values of the x, y, and z elements of a specified Vector3D object.
INCREMENT_SATURATE — Constant static property in class flash.display3D.Context3DStencilAction
- Increment the stencil buffer value, clamping at 255, the maximum value.
INCREMENT_WRAP — Constant static property in class flash.display3D.Context3DStencilAction
- Increment the stencil buffer value.
indent — Property in class flash.text.TextFormat
- Indicates the indentation from the left - margin to the first character in the paragraph.
index — Property in class flash.display.ShaderInput
- The zero-based index of the input in the shader, indicating the order - of the input definitions in the shader.
index — Property in class flash.display.ShaderParameter
- The zero-based index of the parameter.
index — Property in class flash.media.Camera
- - A zero-based index that specifies the position of the camera in - - the Camera.names array, which lists all available cameras.
index — Property in class flash.media.Microphone
- The index of the microphone, as reflected in the array returned by - Microphone.names.
IndexBuffer3D — Final class in package flash.display3D
- IndexBuffer3D is used to represent lists of vertex indices comprising graphic elements retained - by the graphics subsystem.
indexOf(searchElement, fromIndex:int) — Method in class Array
- - Searches for an item in an array by using strict equality (===) and returns the index - - position of the item.
indexOf(val:String, startIndex:Number) — Method in class String
- - Searches the string and returns the position of the first occurrence of val - - found at or after startIndex within the calling string.
indexOf(searchElement, fromIndex:int) — Method in class Vector
- Searches for an item in the Vector and returns the index position of the item.
INDEX_OUT_OF_BOUNDS_ERROR — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that an iterator went out of range or an invalid parameter was specified for month, day, or time.
indices — Property in class flash.data.SQLSchemaResult
- An array of SQLIndexSchema instances requested in a call - to SQLConnection.loadSchema().
indices — Property in class flash.display.GraphicsTrianglePath
- A Vector of integers or indexes, where every three indexes define a triangle.
Infinity — Package constant property in Top Level
- - A special value representing positive Infinity.
-Infinity — Package constant property in Top Level
- - A special value representing negative Infinity.
inflate(dx:Number, dy:Number) — Method in class flash.geom.Rectangle
- - Increases the size of the Rectangle object by the specified amounts, in pixels.
inflate() — Method in class flash.utils.ByteArray
- - Decompresses the byte array using the deflate compression algorithm.
inflatePoint(point:flash.geom:Point) — Method in class flash.geom.Rectangle
- - Increases the size of the Rectangle object.
info — Property in class flash.events.NetDataEvent
- A data object describing the message.
info — Property in class flash.events.NetStatusEvent
- An object with properties that describe the object's status or error condition.
info — Property in class flash.net.NetGroup
- Returns a NetGroupInfo object whose properties provide Quality of Service - statistics about this NetGroup's RTMFP peer-to-peer data transport.
info — Property in class flash.net.NetStream
- Returns a NetStreamInfo object whose properties contain statistics about the quality of service.
INFO — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the info button.
INFORMATIONAL — Constant static property in class flash.desktop.NotificationType
- Specifies that a notification alert is informational in nature and the user can safely ignore it.
init — Event in class flash.display.LoaderInfo
- Dispatched when the properties and methods of a loaded SWF file are - accessible and ready for use.
INIT — Constant static property in class flash.events.Event
- The Event.INIT constant defines the value of the type property of an init event object.
initialize() — Method in class air.update.ApplicationUpdater
- - Initializes the updater.
initialize() — Method in class air.update.ApplicationUpdaterUI
- - Initializes the updater.
initialized — Event in class air.update.ApplicationUpdater
- - Dispatched after the initialization is complete.
initialized — Event in class air.update.ApplicationUpdaterUI
- - - - Dispatched after the initialization is complete.
INITIALIZED — Constant static property in class air.update.events.UpdateEvent
- - The UpdateEvent.INITIALIZED constant defines the value of the - - type property of the event object for a initialized event.
inner — Property in class flash.filters.DropShadowFilter
- Indicates whether or not the shadow is an inner shadow.
inner — Property in class flash.filters.GlowFilter
- Specifies whether the glow is an inner glow.
INNER — Constant static property in class flash.filters.BitmapFilterType
- Defines the setting that applies a filter to the inner area of an object.
input — Property in class flash.display.ShaderInput
- - The input data that is used when the shader executes.
input() — Static method in class flash.system.System
- - Request a string input from the user via the console.
INPUT — Constant static property in class flash.text.TextFieldType
- Used to specify an input TextField.
INPUT — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for cycling inputs.
inputMode — Static property in class flash.ui.Multitouch
- Identifies the multi-touch mode for touch and gesture event handling.
inScopeNamespaces() — Method in class XML
- - Lists the namespaces for the XML object, based on the object's parent.
insert — Event in class flash.data.SQLConnection
- Dispatched when data in any table in any of the connected databases changes as a result - of a SQL INSERT command.
INSERT — Constant static property in class flash.events.SQLUpdateEvent
- The SQLUpdateEvent.INSERT constant defines the value of the - type property of a SQLConnection insert event.
INSERT — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Insert key (45).
insertAt(index:int, element) — Method in class Array
- - Insert a single element into an array.
insertAt(index:int, element) — Method in class Vector
- Insert a single element into the Vector.
insertBefore(node:flash.xml:XMLNode, before:flash.xml:XMLNode) — Method in class flash.xml.XMLNode
- Inserts a new child node into the XML object's child list, before the - beforeNode node.
insertChildAfter(child1:Object, child2:Object) — Method in class XML
- - Inserts the given child2 parameter after the child1 parameter in this XML object and returns the - - resulting object.
insertChildBefore(child1:Object, child2:Object) — Method in class XML
- - Inserts the given child2 parameter before the child1 parameter - - in this XML object and returns the resulting object.
insideCutoff — Property in class flash.text.CSMSettings
- The inside cutoff value, above which densities are set to a maximum density - value (such as 255).
installFromAIRFile(file:flash.filesystem:File) — Method in class air.update.ApplicationUpdater
- - Starts the update process using a local AIR file.
installFromAIRFile(file:flash.filesystem:File) — Method in class air.update.ApplicationUpdaterUI
- - Starts the update process using a local AIR file.
installUpdate() — Method in class air.update.ApplicationUpdater
- - Installs the update file.
instanceof — Operator
Evaluates whether an expression's prototype chain includes the prototype object for function.
INSUFFICIENT_WIDTH — Constant static property in class flash.text.engine.TextLineCreationResult
- Indicates no line was created because no text could fit in the specified width - and fitSomething was not specified in the call to createTextLine().
int — Final class in Top Level
- - The int class lets you work with the data type representing a 32-bit signed integer.
int(value) — Package function in Top Level
- - Converts a given numeric value to an integer value.
int(num:Object) — Constructor in class int
- - Constructor; creates a new int object.
INT — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as an - int value, equivalent to a single int or uint instance - in ActionScript.
INT2 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as an - int2 value, equivalent to an Array of two int or uint - instances in ActionScript.
INT3 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as an - int3 value, equivalent to an Array of three int or uint - instances in ActionScript.
INT4 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as an - int4 value, equivalent to an Array of four int or uint - instances in ActionScript.
interactive — Property in class flash.events.FullScreenEvent
- Indicates whether the Stage object is in full-screen interactive mode (true) or not (false).
InteractiveIcon — Class in package flash.desktop
- The InteractiveIcon class is the base class for the operating - system icons associated with applications.
InteractiveObject — Class in package flash.display
- - 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.
InteractiveObject() — Constructor in class flash.display.InteractiveObject
- - Calling the new InteractiveObject() constructor - - throws an ArgumentError exception.
interface — Statement
Defines an interface.
InterfaceAddress — Class in package flash.net
- The InterfaceAddress class reports the properties of a network interface address.
internal — Statement
Specifies that a class, variable, constant or function is available to any caller within the same package.
interpolate(thisMat:flash.geom:Matrix3D, toMat:flash.geom:Matrix3D, percent:Number) — Static method in class flash.geom.Matrix3D
- Interpolates the translation, rotation, and scale transformation of one matrix toward those of the - target matrix.
interpolate(pt1:flash.geom:Point, pt2:flash.geom:Point, f:Number) — Static method in class flash.geom.Point
- Determines a point between two specified points.
interpolateTo(toMat:flash.geom:Matrix3D, percent:Number) — Method in class flash.geom.Matrix3D
- Interpolates this matrix towards the translation, rotation, and scale transformations of the target matrix.
interpolateToOutput(thisMat:flash.geom:Matrix3D, toMat:flash.geom:Matrix3D, percent:Number, output:flash.geom:Matrix3D) — Static method in class flash.geom.Matrix3D
- Interpolates the translation, rotation, and scale transformation of one matrix toward those of the - target matrix.
interpolateToOutput(pt1:flash.geom:Point, pt2:flash.geom:Point, f:Number, output:flash.geom:Point) — Static method in class flash.geom.Point
- Determines a point between two specified points.
interpolationMethod — Property in class flash.display.GraphicsGradientFill
- A value from the InterpolationMethod class that - specifies which value to use.
InterpolationMethod — Final class in package flash.display
-The InterpolationMethod class provides values for the interpolationMethod -parameter in the Graphics.beginGradientFill() and -Graphics.lineGradientStyle() methods.
intersection(toIntersect:flash.geom:Rectangle) — Method in class flash.geom.Rectangle
- - If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle - - object, returns the area of intersection as a Rectangle object.
intersectionToOutput(toIntersect:flash.geom:Rectangle, output:flash.geom:Rectangle) — Method in class flash.geom.Rectangle
- - If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle - - object, returns the area of intersection as a Rectangle object.
intersects(toIntersect:flash.geom:Rectangle) — Method in class flash.geom.Rectangle
- - Determines whether the object specified in the toIntersect parameter intersects - - with this Rectangle object.
inTransaction — Property in class flash.data.SQLConnection
- Indicates whether this connection is currently involved in a transaction.
INVALID — Constant static property in class flash.security.CertificateStatus
- An invalid certificate.
INVALID — Constant static property in class flash.security.SignatureStatus
- Invalid status.
INVALID — Constant static property in class flash.text.engine.TextLineValidity
- Specifies that the line is invalid.
invalidate() — Method in class flash.display.Stage
- Calling the invalidate() method signals Flash runtimes to alert display objects - on the next opportunity it has to render the display list (for example, when the playhead - advances to a new frame).
INVALID_ATTR_VALUE — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that a given attribute value is out of the expected range.
INVALID_CHAIN — Constant static property in class flash.security.CertificateStatus
- A root or intermediate certificate in this certificate's chain is invalid.
INVALID_CHAR_FOUND — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that invalid Unicode value was found.
InvalidSWFError — Dynamic class in package flash.errors
- - The Flash runtimes throw this exception when they encounter a corrupted SWF file.
InvalidSWFError(message:String, id:int) — Constructor in class flash.errors.InvalidSWFError
- - Creates a new InvalidSWFError object.
invert() — Method in class flash.geom.Matrix
- - Performs the opposite transformation - - of the original matrix.
invert() — Method in class flash.geom.Matrix3D
- Inverts the current matrix.
INVERT — Constant static property in class flash.display.BlendMode
-Inverts the background.
INVERT — Constant static property in class flash.display3D.Context3DStencilAction
- Invert the stencil buffer value, bitwise.
invoke — Event in class flash.desktop.NativeApplication
- - Dispatched when an application is invoked.
INVOKE — Constant static property in class flash.events.InvokeEvent
- The InvokeEvent.INVOKE constant defines the value of the type - property of an InvokeEvent object.
InvokeEvent — Class in package flash.events
- The NativeApplication object of an AIR application dispatches an invoke event when the - application is invoked.
InvokeEvent(type:String, bubbles:Boolean, cancelable:Boolean, dir:flash.filesystem:File, argv:Array, reason:String) — Constructor in class flash.events.InvokeEvent
- The constructor function for the InvokeEvent class.
InvokeEventReason — Final class in package flash.desktop
- The InvokeEventReason class enumerates values returned by the - reason property of an InvokeEvent object.
ioError — Event in class air.net.WebSocket
- - Dispatched if there is a connection error when trying to open a WebSocket connection.
ioError — Event in class air.system.License
- - Dispatched when an input/output error occurs that causes the - - License.checkDetailsOneline() operation to fail.
ioError — Event in class flash.display.LoaderInfo
- Dispatched when an input or output error occurs that causes a load operation to fail.
ioError — Event in class flash.filesystem.File
- - Dispatched when an error occurs during an asynchronous file operation.
ioError — Event in class flash.filesystem.FileStream
- Indicates that an error occurred during an asynchronous file I/O operation.
ioError — Event in class flash.media.MediaPromise
- A MediaPromise object dispatches an ioError event when an error is encountered while reading - the underlying data stream.
ioError — Event in class flash.media.Sound
- Dispatched when an input/output error occurs that causes a load operation to fail.
ioError — Event in class flash.net.DatagramSocket
- - Dispatched when this socket receives an I/O error.
ioError — Event in class flash.net.FileReference
- Dispatched when the upload or download fails.
ioError — Event in class flash.net.NetConnection
- Dispatched when an input or output error occurs that causes a network operation to fail.
ioError — Event in class flash.net.NetStream
- Dispatched when an input or output error occurs that causes a network operation to fail.
ioError — Event in class flash.net.SecureSocket
- - Dispatched when an input or output error occurs that causes a send or receive operation to fail.
ioError — Event in class flash.net.Socket
- - Dispatched when an input/output error occurs that causes a send or load operation to fail.
ioError — Event in class flash.net.URLLoader
- - Dispatched if a call to URLLoader.load() - - results in a fatal error that terminates the download.
ioError — Event in class flash.net.URLStream
- - Dispatched when an input/output error occurs that causes a load operation to fail.
ioError — Event in class flash.net.XMLSocket
- Dispatched when an input/output error occurs that causes a send or receive operation to fail.
ioError — Event in class flash.system.SystemUpdater
- Dispatched when an I/O error occurs.
IO_ERROR — Constant static property in class flash.events.IOErrorEvent
- Defines the value of the type property of an ioError event object.
IOErrorEvent — Class in package flash.events
-An IOErrorEvent object is dispatched when an error causes input or output operations to fail.
IOErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, text:String, id:int) — Constructor in class flash.events.IOErrorEvent
- Creates an Event object that contains specific information about ioError events.
ipMulticastMemberUpdatesEnabled — Property in class flash.net.GroupSpecifier
- Specifies whether information about group membership can be exchanged on IP multicast - sockets.
IPV4 — Constant static property in class flash.net.IPVersion
- An Internet Protocol version 4 (IPv4) address.
IPV6 — Constant static property in class flash.net.IPVersion
- An Internet Protocol version 6 (IPv6) address.
ipVersion — Property in class flash.net.InterfaceAddress
- The IP address type (IPv4 or IPv6).
IPVersion — Final class in package flash.net
- The IPVersion class defines constants representing the different families of IP addresses.
is — Operator
Evaluates whether an object is compatible with a specific data type, class, or interface.
isAccessible() — Static method in class flash.ui.Keyboard
- - Specifies whether the last key pressed is accessible by other SWF files.
isActive — Property in class flash.desktop.NativeApplication
- - Is the application currently active (having operating system focus).
isAnonymous — Property in class flash.events.DRMStatusEvent
- Indicates whether the content, protected with digital rights management (DRM) encryption, is available - without requiring a user to provide authentication credentials.
isAsync — Property in interface flash.desktop.IFilePromise
- Indicates whether asynchronous data transfer is supported.
isAsync — Property in class flash.media.MediaPromise
- Reports whether the underlying data source is asynchronous or synchronous.
isAttribute(name) — Method in class flash.utils.Proxy
isAvailableOffline — Property in class flash.events.DRMStatusEvent
- Indicates whether the content, protected with digital rights management (DRM) encryption, is available - offline.
isBuffering — Property in class flash.media.Sound
- Returns the buffering state of external MP3 files.
isCheckForUpdateVisible — Property in class air.update.ApplicationUpdaterUI
- - Enables the visibility of the Check for - - Update, No Update, and Update Error dialog boxes.
isColor — Property in class flash.printing.PrintJob
- Indicates whether the currently selected printer at the current print settings prints - using color (true) or grayscale (false).
isCompiledAOT — Property in class flash.desktop.NativeApplication
- - Specifies whether the application is compiled or interpreted for the desired platform.
isDebugger — Static property in class flash.system.Capabilities
- Specifies whether the system is a special debugging version - (true) or an officially released version (false).
isDefaultPrevented() — Method in class flash.events.Event
- Checks whether the preventDefault() method has been called on the event.
isDeviceFontCompatible(fontName:String, fontWeight:String, fontPosture:String) — Static method in class flash.text.engine.FontDescription
- - Returns true if a usable device font is available with the specified fontName, fontWeight, and fontPosture.
isDirectory — Property in class flash.filesystem.File
- - Indicates whether the reference is to a directory.
isDownloadProgressVisible — Property in class air.update.ApplicationUpdaterUI
- - - Enables the visibility of the Download Update - - dialog box.
isDownloadUpdateVisible — Property in class air.update.ApplicationUpdaterUI
- - Enables the visibility of the Download Update - - dialog box.
isDragging — Static property in class flash.desktop.NativeDragManager
- Reports whether a drag operation is currently in progress.
isDynamic — Property in class flash.external.ExtensionInfo
- - A Boolean value indicating whether the extension is a 'dynamically loaded' ANE or not.
ISearchableText — Interface in package flash.accessibility
- The ISearchableText interface can be implemented by objects that - contain text which should be searchable on the web.
isEmbeddedInAcrobat — Static property in class flash.system.Capabilities
- Specifies whether the Flash runtime is embedded in a PDF file that is open in Acrobat 9.0 or higher - (true) or not (false).
isEmpty() — Method in class Array
- - Checks whether the array is empty.
isEmpty() — Method in class Vector
- Checks whether the vector is empty.
isEmpty() — Method in class flash.geom.Rectangle
- - Determines whether or not this Rectangle object is empty.
isExtensionAvailable(packageName:String) — Static method in class flash.external.HostObject
- Check for the availability of a certain object model extension.
isFileUpdateVisible — Property in class air.update.ApplicationUpdaterUI
- - - Enables the visibility of the File Update, - - File No Update, and File Error dialog boxes.
isFinite(num) — Package function in Top Level
- - Returns true if the value is a finite number, - - or false if the value is Infinity or -Infinity.
isFirstRun — Property in class air.update.ApplicationUpdater
- - Whether this is the first run after a successful update (true) or not - - (false).
isFirstRun — Property in class air.update.ApplicationUpdaterUI
- - Whether this is the first run after a successful update (true) or not - - (false).
isFocusInaccessible() — Method in class flash.display.Stage
- Determines whether the Stage.focus property returns null for - security reasons.
isFontCompatible(fontName:String, fontStyle:String) — Static method in class flash.text.TextField
- - Returns true if an embedded font is available with the specified fontName and fontStyle - - where Font.fontType is flash.text.FontType.EMBEDDED.
isFontCompatible(fontName:String, fontWeight:String, fontPosture:String) — Static method in class flash.text.engine.FontDescription
- - Returns true if an embedded font is available with the specified fontName, fontWeight, and fontPosture - - where Font.fontType is flash.text.FontType.EMBEDDED_CFF.
isHidden — Property in class flash.filesystem.File
- - Indicates whether the referenced file or directory is "hidden." - - The value is true if the referenced file or directory is hidden, false otherwise.
isHistoryBackEnabled — Property in class flash.media.StageWebView
- - Reports whether there is a previous page in the browsing history.
isHistoryForwardEnabled — Property in class flash.media.StageWebView
- - Reports whether there is a next page in the browsing history.
isHTTPS — Property in class flash.events.BrowserInvokeEvent
- Whether the content in the browser uses the HTTPS - URL scheme (true) or not (false).
ISimpleTextSelection — Interface in package flash.accessibility
- - The ISimpleTextSelection class can be used to add support for - the MSAA ISimpleTextSelection interface to an AccessibilityImplementation.
isInstallUpdateVisible — Property in class air.update.ApplicationUpdaterUI
- - Enables the visibility of the Install Update - - dialog box.
isLabeledBy(labelBounds:flash.geom:Rectangle) — Method in class flash.accessibility.AccessibilityImplementation
- - Returns true or false to indicate whether a text object having - a bounding box specified by a x, y, width, and height - should be considered a label for the component that this AccessibilityImplementation represents.
isLive — Property in class flash.net.NetStreamInfo
- Whether the media being played is recorded or live.
isLoaded — Property in class flash.external.ExtensionInfo
- - A Boolean value indicating whether the extension has been loaded or not.
isLocal — Property in class flash.events.DRMStatusEvent
- Indicates whether the voucher is cached in the local voucher store.
isMouseTargetInaccessible — Property in class flash.events.ContextMenuEvent
- Indicates whether the mouseTarget property was set to null for security - reasons.
isNaN(num) — Package function in Top Level
- - Returns true if the value is NaN(not a number).
isNewerVersionFunction — Property in class air.update.ApplicationUpdater
- - A function that the updater should use to perform version comparisons.
isNewerVersionFunction — Property in class air.update.ApplicationUpdaterUI
- - A function that the updater should use to perform version comparisons.
isPackage — Property in class flash.filesystem.File
- - Indicates whether the referenced directory is a package.
isPerUser — Property in class flash.net.LocalConnection
- Indicates whether the LocalConnection object is scoped to the current user (true) - or is globally accessible to all users on the computer (false).
isPlaying — Property in class flash.display.MovieClip
- A Boolean value that indicates whether a movie clip is curently playing.
isPost — Property in class flash.html.HTMLHistoryItem
- Indicates whether the HTML page includes POST data.
isPrimaryTouchPoint — Property in class flash.events.TouchEvent
- Indicates whether the first point of contact is mapped to mouse events.
isPrimordial — Property in class flash.system.Worker
- Indicates whether this worker is the primordial worker.
isPrototypeOf(theClass:Object) — Method in class Object
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
isRelatedObjectInaccessible — Property in class flash.events.FocusEvent
- If true, the relatedObject property is set to null for - reasons related to security sandboxes.
isRelatedObjectInaccessible — Property in class flash.events.MouseEvent
- - If true, the relatedObject property is set to null for - - reasons related to security sandboxes.
isRelatedObjectInaccessible — Property in class flash.events.TouchEvent
- If true, the relatedObject property is set to null for - reasons related to security sandboxes.
isRemovable — Property in class flash.filesystem.StorageVolume
- Whether the operating system considers the storage volume to be removable (true) - or not (false).
isRightToLeft() — Method in class flash.globalization.LocaleID
- Specifies whtehr the text direction for the specified locale is right to left.
isSeparator — Property in class flash.display.NativeMenuItem
- - Reports whether this item is a menu separator line.
isSetAsDefaultApplication(extension:String) — Method in class flash.desktop.NativeApplication
- - Specifies whether this application is currently the default application - - for opening files with the specified extension.
issuer — Property in class flash.security.X509Certificate
- Provides the issuer's Distinguished Name (DN).
issuerUniqueID — Property in class flash.security.X509Certificate
- Provides the issuer's unique identifier.
isSupported — Static property in class flash.concurrent.Condition
- - Indicates whether the Condition class is supported for the current platform.
isSupported — Static property in class flash.concurrent.Mutex
- - Indicates whether the use of the Mutex class is supported for the current platform.
isSupported — Static property in class flash.data.EncryptedLocalStore
- - The isSupported property is set to true if the - - EncryptedLocalStore class is supported on the current platform, otherwise it is - - set to false.
isSupported — Static property in class flash.data.SQLConnection
- Indicates whether SQLConnection class is supported on the current platform or not.
isSupported — Static property in class flash.desktop.NativeDragManager
- The isSupported property is set to true if the - NativeDragManager class is supported on the current platform, otherwise it is - set to false.
isSupported — Static property in class flash.desktop.NativeProcess
- Indicates if running native processes is supported in the current profile.
isSupported — Static property in class flash.desktop.Updater
- The isSupported property is set to true if the Updater class is - available on the current platform, otherwise it is set to false.
isSupported — Static property in class flash.display.NativeMenu
- - Indicates whether any form of native menu is supported on the client system.
isSupported — Static property in class flash.display.NativeWindow
- - Indicates whether native windows are supported on the client system.
isSupported — Static property in class flash.filesystem.StorageVolumeInfo
- - The isSupported property is set to true if the - - StorageVolumeInfo class is supported on the current platform, otherwise it is - - set to false.
isSupported — Static property in class flash.html.HTMLLoader
isSupported — Static property in class flash.media.AudioDeviceManager
- Whether AudioDeviceManager is enabled.
isSupported — Static property in class flash.media.Camera
- - The isSupported property is set to true if the - - Camera class is supported on the current platform, otherwise it is - - set to false.
isSupported — Static property in class flash.media.CameraUI
- Reports whether the CameraUI class is supported on the current device.
isSupported — Static property in class flash.media.Microphone
- The isSupported property is set to true if the - Microphone class is supported on the current platform, otherwise it is - set to false.
isSupported — Static property in class flash.media.StageWebView
- - Reports whether the StageWebView class is supported on the current device.
isSupported — Static property in class flash.net.DatagramSocket
- - Indicates whether or not DatagramSocket features are supported in the run-time environment.
isSupported — Static property in class flash.net.LocalConnection
- The isSupported property is set to true if the - LocalConnection class is supported on the current platform, otherwise it is - set to false.
isSupported — Static property in class flash.net.NetworkInfo
- - Indicates whether access to network interface information is supported on the client system.
isSupported — Static property in class flash.net.SecureSocket
- - Indicates whether secure sockets are supported on the current system.
isSupported — Static property in class flash.net.ServerSocket
- Indicates whether or not ServerSocket features are supported in the run-time environment.
isSupported — Static property in class flash.net.dns.DNSResolver
- Indicates whether DNS lookups are supported on the client system.
isSupported — Static property in class flash.net.drm.DRMManager
- The isSupported property is set to true if the - DRMManager class is supported on the current platform, otherwise it is - set to false.
isSupported — Static property in class flash.printing.PrintJob
- Indicates whether the PrintJob class is supported on the current platform (true) - or not (false).
isSupported — Static property in class flash.security.XMLSignatureValidator
- The isSupported property is set to true if the - XMLSignatureValidator class is supported on the current platform, otherwise it is - set to false.
isSupported — Static property in class flash.sensors.Accelerometer
- The isSupported property is set to true if the accelerometer sensor is - available on the device, otherwise it is set to false.
isSupported — Static property in class flash.sensors.DeviceRotation
- The isSupported property is set to true if the accelerometer and gyroscope sensors - are available on the device, otherwise it is set to false.
isSupported — Static property in class flash.sensors.Geolocation
- Whether a location sensor is available on the device (true); otherwise false.
isSupported — Static property in class flash.system.IME
- The isSupported property is set to true if the IME class is - available on the current platform, otherwise it is set to false.
isSupported — Static property in class flash.system.Worker
- Indicates whether the current runtime context supports the use of Worker - objects for concurrent code execution.
isSupported — Static property in class flash.system.WorkerDomain
- Indicates whether the current runtime context supports the WorkerDomain - and Worker objects for concurrent code execution.
isSupported — Static property in class flash.ui.ContextMenu
- The isSupported property is set to true if the - ContextMenu class is supported on the current platform, otherwise it is - set to false.
isSupported — Static property in class flash.ui.GameInput
- Indicates whether the current platform supports the GameInput API.
isSymbolicLink — Property in class flash.filesystem.File
- - Indicates whether the reference is a symbolic link.
isToolButtonDown(index:int) — Method in class flash.events.TouchEvent
- Reports that the hardware button at the specified index is pressed.
isTouchPointCanceled — Property in class flash.events.TouchEvent
- Reports that this touch input sequence was canceled by the operating system.
isUnexpectedErrorVisible — Property in class air.update.ApplicationUpdaterUI
- - Enables the visibility of the Unexpected - - Error dialog box.
isUpdateInProgress — Property in class air.update.ApplicationUpdaterUI
- - A Boolean property, which is true if - - an update is running, false otherwise.
isURLInaccessible — Property in class flash.display.LoaderInfo
- Indicates if the LoaderInfo.url property has been - truncated.
isURLInaccessible — Property in class flash.media.Sound
- Indicates if the Sound.url property has been - truncated.
isUserEvent — Property in class flash.events.BrowserInvokeEvent
- Whether the browser invocation resulted in a user event (such as - a mouse click).
isValid — Property in class air.system.License
- - Validity of the license.
isValid(obj:flash.external:HostObject) — Static method in class flash.external.HostObject
- Check whether this HostObject wrapper object still is connected to its host - counterpart.
isVoiceDetected — Property in class flash.media.MicrophoneEnhancedOptions
- Indicates whether the Microphone input detected a voice.
isWritable — Property in class flash.filesystem.StorageVolume
- Whether a volume is writable (true) or not (false).
isXMLName(str) — Package function in Top Level
- - Determines whether the specified string is a valid name for an XML element or attribute.
italic — Property in class flash.text.TextFormat
- Indicates whether text in this text format is italicized.
ITALIC — Constant static property in class flash.text.FontStyle
- Defines the italic style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method.
ITALIC — Constant static property in class flash.text.engine.FontPosture
- Used to indicate italic font posture.
itemClass — Property in class flash.data.SQLStatement
- Indicates a class (data type) that is used for each - row returned as a result of the statement's execution.
items — Property in class flash.display.NativeMenu
- - The array of NativeMenuItem objects in this menu.
items — Property in class flash.ui.ContextMenu
- The array of custom items in this menu.
IURIDereferencer — Interface in package flash.security
- IURIDereferencer defines an interface for objects that resolve - URIs in an XML signature.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/all-index-J.html b/html-docs/all-index-J.html deleted file mode 100644 index 341532d..0000000 --- a/html-docs/all-index-J.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - -J Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
J — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the J key (74).
JAPANESE_HIRAGANA — Constant static property in class flash.system.IMEConversionMode
- The string "JAPANESE_HIRAGANA", for use with the - IME.conversionMode property.
JAPANESE_KATAKANA_FULL — Constant static property in class flash.system.IMEConversionMode
- The string "JAPANESE_KATAKANA_FULL", for use with the - IME.conversionMode property.
JAPANESE_KATAKANA_HALF — Constant static property in class flash.system.IMEConversionMode
- The string "JAPANESE_KATAKANA_HALF", for use with the - IME.conversionMode property.
JIS_B5 — Constant static property in class flash.printing.PaperSize
- Japanese B5 - -
jobName — Property in class flash.printing.PrintJob
- The name or title of the print job.
join(sep) — Method in class Array
- - Converts the elements in an array to strings, inserts the specified separator between the - - elements, concatenates them, and returns the resulting string.
join(sep:String) — Method in class Vector
- Converts the elements in the Vector to strings, inserts the specified separator between the - elements, concatenates them, and returns the resulting string.
joints — Property in class flash.display.GraphicsStroke
- Specifies the type of joint appearance - used at angles.
JointStyle — Final class in package flash.display
-The JointStyle class is an enumeration of constant values that specify the joint style to use in drawing lines.
JPEGEncoderOptions — Final class in package flash.display
- The JPEGEncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method.
JPEGEncoderOptions(quality:uint) — Constructor in class flash.display.JPEGEncoderOptions
- Creates a JPEGEncoderOptions object with the specified setting.
jpegImage — Property in class flash.events.WebViewDrawEvent
- The BitmapData object containing the JPEG-encoded contents rendered from the StageWebView object.
JPEGLoaderContext — Class in package flash.system
- The JPEGLoaderContext class includes a property for enabling a deblocking filter when loading a JPEG image.
JPEGLoaderContext(deblockingFilter:Number, checkPolicyFile:Boolean, applicationDomain:flash.system:ApplicationDomain, securityDomain:flash.system:SecurityDomain) — Constructor in class flash.system.JPEGLoaderContext
- Creates a new JPEGLoaderContext object with the specified settings.
JPEGXREncoderOptions — Final class in package flash.display
- The JPEGXREncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method.
JPEGXREncoderOptions(quantization:uint, colorSpace:String, trimFlexBits:uint) — Constructor in class flash.display.JPEGXREncoderOptions
- Creates a JPEGEXREncoderOptions object with the specified settings.
JSON — Final class in Top Level
- - The JSON class lets applications import and export data using JavaScript Object Notation (JSON) format.
justificationStyle — Property in class flash.text.engine.EastAsianJustifier
- Specifies the justification style for the text in a text block.
JustificationStyle — Final class in package flash.text.engine
-The JustificationStyle class is an enumeration of constant values for setting the justificationStyle property -of the EastAsianJustifier class.
JUSTIFY — Constant static property in class flash.text.TextFormatAlign
- Constant; justifies text within the text field.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/all-index-K.html b/html-docs/all-index-K.html deleted file mode 100644 index a6b5aa9..0000000 --- a/html-docs/all-index-K.html +++ /dev/null @@ -1,1083 +0,0 @@ - - - - - -K Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
K — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the K key (75).
KANNADA — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Kannada digit set.
KAYAH_LI — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Kayah Li digit set.
KEEP — Constant static property in class flash.display3D.Context3DStencilAction
- Keep the current stencil buffer value.
KEEP_AWAKE — Constant static property in class flash.desktop.SystemIdleMode
- Prevents the system from dropping into an idle mode.
kerning — Property in class flash.text.TextFormat
- A Boolean value that indicates whether kerning is enabled (true) - or disabled (false).
kerning — Property in class flash.text.engine.ElementFormat
- Kerning adjusts the pixels between certain character pairs to improve readability.
Kerning — Final class in package flash.text.engine
-The Kerning class is an enumeration of constant values used with ElementFormat.kerning.
Keyboard — Final class in package flash.ui
- - The Keyboard class is used to build an interface that can be controlled by a user with a standard keyboard.
KeyboardEvent — Class in package flash.events
- - A KeyboardEvent object id dispatched in response to user input through a keyboard.
KeyboardEvent(type:String, bubbles:Boolean, cancelable:Boolean, charCodeValue:uint, keyCodeValue:uint, keyLocationValue:uint, ctrlKeyValue:Boolean, altKeyValue:Boolean, shiftKeyValue:Boolean, controlKeyValue:Boolean, commandKeyValue:Boolean, functionKeyValue:Boolean) — Constructor in class flash.events.KeyboardEvent
- - Creates an Event object that contains specific information about keyboard events.
KeyboardType — Final class in package flash.ui
- The KeyboardType class is an enumeration class that provides values for different categories of physical computer or device keyboards.
keyCode — Property in class flash.events.FocusEvent
- The key code value of the key pressed to trigger a keyFocusChange event.
keyCode — Property in class flash.events.KeyboardEvent
- - The key code value of the key pressed or released.
keyDown — Event in class flash.desktop.NativeApplication
- Dispatched when the user presses a key.
keyDown — Event in class flash.display.InteractiveObject
- Dispatched when the user presses a key.
keyDown — Event in class flash.text.StageText
- Dispatched when the user presses a key.
KEY_DOWN — Constant static property in class flash.events.KeyboardEvent
- - The KeyboardEvent.KEY_DOWN constant defines the value of the type property of a keyDown event object.
keyEquivalent — Property in class flash.display.NativeMenuItem
- - The key equivalent for this menu item.
keyEquivalentModifiers — Property in class flash.display.NativeMenuItem
- - The array of key codes for the key equivalent modifiers.
keyFocusChange — Event in class flash.display.InteractiveObject
- Dispatched when the user attempts to change focus by using keyboard navigation.
KEY_FOCUS_CHANGE — Constant static property in class flash.events.FocusEvent
- Defines the value of the type property of a keyFocusChange event object.
keyFrameInterval — Property in class flash.media.Camera
- - The number of video frames transmitted in full (called keyframes) - - instead of being interpolated by the video compression algorithm.
keyFrameInterval — Property in class flash.media.VideoStreamSettings
- The number of video frames transmitted in full (called keyframes or IDR frames) instead of - being interpolated by the video compression algorithm.
keyLocation — Property in class flash.events.KeyboardEvent
- - Indicates the location of the key on the keyboard.
KeyLocation — Final class in package flash.ui
-The KeyLocation class contains constants that indicate the location of a key pressed on -the keyboard or keyboard-like input device.
KEYNAME_BEGIN — Constant static property in class flash.ui.Keyboard
- - The Begin key - -
KEYNAME_BREAK — Constant static property in class flash.ui.Keyboard
- - The Break key - -
KEYNAME_CLEARDISPLAY — Constant static property in class flash.ui.Keyboard
- - The Clear Display key - -
KEYNAME_CLEARLINE — Constant static property in class flash.ui.Keyboard
- - The Clear Line key - -
KEYNAME_DELETE — Constant static property in class flash.ui.Keyboard
- - The Delete key - -
KEYNAME_DELETECHAR — Constant static property in class flash.ui.Keyboard
- - The Delete Character key - -
KEYNAME_DELETELINE — Constant static property in class flash.ui.Keyboard
- - The Delete Line key - -
KEYNAME_DOWNARROW — Constant static property in class flash.ui.Keyboard
- - The down arrow - - - -
KEYNAME_END — Constant static property in class flash.ui.Keyboard
- - The End key - -
KEYNAME_EXECUTE — Constant static property in class flash.ui.Keyboard
- - The Execute key - -
KEYNAME_F1 — Constant static property in class flash.ui.Keyboard
- - The F1 key - -
KEYNAME_F10 — Constant static property in class flash.ui.Keyboard
- - The F10 key - -
KEYNAME_F11 — Constant static property in class flash.ui.Keyboard
- - The F11 key - -
KEYNAME_F12 — Constant static property in class flash.ui.Keyboard
- - The F12 key - -
KEYNAME_F13 — Constant static property in class flash.ui.Keyboard
- - The F13 key - -
KEYNAME_F14 — Constant static property in class flash.ui.Keyboard
- - The F14 key - -
KEYNAME_F15 — Constant static property in class flash.ui.Keyboard
- - The F15 key - -
KEYNAME_F16 — Constant static property in class flash.ui.Keyboard
- - The F16 key - -
KEYNAME_F17 — Constant static property in class flash.ui.Keyboard
- - The F17 key - -
KEYNAME_F18 — Constant static property in class flash.ui.Keyboard
- - The F18 key - -
KEYNAME_F19 — Constant static property in class flash.ui.Keyboard
- - The F19 key - -
KEYNAME_F2 — Constant static property in class flash.ui.Keyboard
- - The F2 key - -
KEYNAME_F20 — Constant static property in class flash.ui.Keyboard
- - The F20 key - -
KEYNAME_F21 — Constant static property in class flash.ui.Keyboard
- - The F21 key - -
KEYNAME_F22 — Constant static property in class flash.ui.Keyboard
- - The F22 key - -
KEYNAME_F23 — Constant static property in class flash.ui.Keyboard
- - The F23 key - -
KEYNAME_F24 — Constant static property in class flash.ui.Keyboard
- - The F24 key - -
KEYNAME_F25 — Constant static property in class flash.ui.Keyboard
- - The F25 key - -
KEYNAME_F26 — Constant static property in class flash.ui.Keyboard
- - The F26 key - -
KEYNAME_F27 — Constant static property in class flash.ui.Keyboard
- - The F27 key - -
KEYNAME_F28 — Constant static property in class flash.ui.Keyboard
- - The F28 key - -
KEYNAME_F29 — Constant static property in class flash.ui.Keyboard
- - The F29 key - -
KEYNAME_F3 — Constant static property in class flash.ui.Keyboard
- - The F3 key - -
KEYNAME_F30 — Constant static property in class flash.ui.Keyboard
- - -
KEYNAME_F31 — Constant static property in class flash.ui.Keyboard
- - The F31 key - -
KEYNAME_F32 — Constant static property in class flash.ui.Keyboard
- - The F32 key - -
KEYNAME_F33 — Constant static property in class flash.ui.Keyboard
- - The F33 key - -
KEYNAME_F34 — Constant static property in class flash.ui.Keyboard
- - The F34 key - -
KEYNAME_F35 — Constant static property in class flash.ui.Keyboard
- - The F35 key - -
KEYNAME_F4 — Constant static property in class flash.ui.Keyboard
- - The F4 key - -
KEYNAME_F5 — Constant static property in class flash.ui.Keyboard
- - The F5 key - -
KEYNAME_F6 — Constant static property in class flash.ui.Keyboard
- - The F6 key - -
KEYNAME_F7 — Constant static property in class flash.ui.Keyboard
- - The F7 key - -
KEYNAME_F8 — Constant static property in class flash.ui.Keyboard
- - The F8 key - -
KEYNAME_F9 — Constant static property in class flash.ui.Keyboard
- - The F9 key - -
KEYNAME_FIND — Constant static property in class flash.ui.Keyboard
- - The Find key - -
KEYNAME_HELP — Constant static property in class flash.ui.Keyboard
- - The Help key - -
KEYNAME_HOME — Constant static property in class flash.ui.Keyboard
- - The Home key - -
KEYNAME_INSERT — Constant static property in class flash.ui.Keyboard
- - The Insert key - -
KEYNAME_INSERTCHAR — Constant static property in class flash.ui.Keyboard
- - The Insert Character key - -
KEYNAME_INSERTLINE — Constant static property in class flash.ui.Keyboard
- - The Insert Line key - -
KEYNAME_LEFTARROW — Constant static property in class flash.ui.Keyboard
- - The left arrow - - - -
KEYNAME_MENU — Constant static property in class flash.ui.Keyboard
- - The Menu key - -
KEYNAME_MODESWITCH — Constant static property in class flash.ui.Keyboard
- - The Mode Switch key - -
KEYNAME_NEXT — Constant static property in class flash.ui.Keyboard
- - The Next key - -
KEYNAME_PAGEDOWN — Constant static property in class flash.ui.Keyboard
- - The Page Down key - -
KEYNAME_PAGEUP — Constant static property in class flash.ui.Keyboard
- - The Page Up key - -
KEYNAME_PAUSE — Constant static property in class flash.ui.Keyboard
- - The Pause key - -
KEYNAME_PLAYPAUSE — Constant static property in class flash.ui.Keyboard
- - The Play_Pause key - -
KEYNAME_PREV — Constant static property in class flash.ui.Keyboard
- - The Previous key - -
KEYNAME_PRINT — Constant static property in class flash.ui.Keyboard
- - The Print key - -
KEYNAME_PRINTSCREEN — Constant static property in class flash.ui.Keyboard
- - The Print Screen - -
KEYNAME_REDO — Constant static property in class flash.ui.Keyboard
- - The Redo key - -
KEYNAME_RESET — Constant static property in class flash.ui.Keyboard
- - The Reset key - -
KEYNAME_RIGHTARROW — Constant static property in class flash.ui.Keyboard
- - The right arrow - - - -
KEYNAME_SCROLLLOCK — Constant static property in class flash.ui.Keyboard
- - The Scroll Lock key - -
KEYNAME_SELECT — Constant static property in class flash.ui.Keyboard
- - The Select key - -
KEYNAME_STOP — Constant static property in class flash.ui.Keyboard
- - The Stop key - -
KEYNAME_SYSREQ — Constant static property in class flash.ui.Keyboard
- - The System Request key - -
KEYNAME_SYSTEM — Constant static property in class flash.ui.Keyboard
- - The System key - -
KEYNAME_UNDO — Constant static property in class flash.ui.Keyboard
- - The Undo key - -
KEYNAME_UPARROW — Constant static property in class flash.ui.Keyboard
- - The up arrow - -
KEYNAME_USER — Constant static property in class flash.ui.Keyboard
- - The User key - -
KEYPAD — Constant static property in class flash.ui.KeyboardType
- A phone-style 12-button keypad.
keyUp — Event in class flash.desktop.NativeApplication
- Dispatched when the user releases a key.
keyUp — Event in class flash.display.InteractiveObject
- Dispatched when the user releases a key.
keyUp — Event in class flash.text.StageText
- Dispatched when the user releases a key.
KEY_UP — Constant static property in class flash.events.KeyboardEvent
- - The KeyboardEvent.KEY_UP constant defines the value of the type property of a keyUp event object.
KHMER — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Khmer digit set.
knockout — Property in class flash.filters.BevelFilter
- Applies a knockout effect (true), which effectively - makes the object's fill transparent and reveals the background color of the document.
knockout — Property in class flash.filters.DropShadowFilter
- Applies a knockout effect (true), which effectively - makes the object's fill transparent and reveals the background color of the document.
knockout — Property in class flash.filters.GlowFilter
- Specifies whether the object has a knockout effect.
knockout — Property in class flash.filters.GradientBevelFilter
- Specifies whether the object has a knockout effect.
knockout — Property in class flash.filters.GradientGlowFilter
- Specifies whether the object has a knockout effect.
knownExtensions — Static property in class flash.external.ExtensionContext
- - Gets a list of the extension identifiers for ANEs that are registered with the runtime.
KOREAN — Constant static property in class flash.system.IMEConversionMode
- The string "KOREAN", for use with the - IME.conversionMode property.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Oct 12 2022, 12:45 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/all-index-L.html b/html-docs/all-index-L.html deleted file mode 100644 index c4020e3..0000000 --- a/html-docs/all-index-L.html +++ /dev/null @@ -1,1945 +0,0 @@ - - - - - -L Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
L — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the L key (76).
label — Statement
Associates a statement with an identifier that can be referenced by break or continue.
label — Property in class flash.display.NativeMenuItem
- - The display string of this menu item.
labels — Property in class flash.display.Scene
- An array of FrameLabel objects for the scene.
LANDSCAPE — Constant static property in class flash.display.StageAspectRatio
- Specifies a device orientation that presents a landscape UI -
LANDSCAPE — Constant static property in class flash.printing.PrintJobOrientation
- The landscape (horizontal) image orientation for printing.
language — Static property in class flash.system.Capabilities
- Specifies the language code of the system on which the content is running.
languages — Static property in class flash.system.Capabilities
- An array of strings that contain information about the user's preferred user interface languages, as set - through the operating system.
LAO — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Lao digit set.
LAST — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for watching the last channel or show watched.
lastChild — Property in class flash.xml.XMLNode
- An XMLNode value that references the last child in the node's child list.
lastIndex — Property in class RegExp
- - Specifies the index position in the string at which to start the next search.
lastIndexOf(searchElement, fromIndex:int) — Method in class Array
- - Searches for an item in an array, working backward from the last item, and returns the index position of the matching item using strict equality (===).
lastIndexOf(val:String, startIndex:Number) — Method in class String
- - Searches the string from right to left and returns the index of the last occurrence - - of val found before startIndex.
lastIndexOf(searchElement, fromIndex:int) — Method in class Vector
- Searches for an item in the Vector, working backward from the specified - index position, and returns the index position of the matching item.
lastInsertRowID — Property in class flash.data.SQLConnection
- The last generated row identifier created by a SQL INSERT - statement.
lastInsertRowID — Property in class flash.data.SQLResult
- The last generated row identifier generated by a SQL INSERT - statement.
lastLine — Property in class flash.text.engine.TextBlock
- The last TextLine in the TextBlock, if any.
lastOperationStatus — Property in class flash.globalization.Collator
- The status of the most recent operation that this Collator object performed.
lastOperationStatus — Property in class flash.globalization.CurrencyFormatter
- The status of the most recent operation that this CurrencyFormatter object performed.
lastOperationStatus — Property in class flash.globalization.DateTimeFormatter
- The status of previous operation that this DateTimeFormatter object performed.
lastOperationStatus — Property in class flash.globalization.LocaleID
- The status of the most recent operation that this LocaleID object performed.
lastOperationStatus — Property in class flash.globalization.NumberFormatter
- The status of previous operation that this NumberFormatter object performed.
lastOperationStatus — Property in class flash.globalization.StringTools
- The status of the most recent operation that this StringTools object performed.
LastOperationStatus — Final class in package flash.globalization
- The LastOperationStatus class enumerates constant values that represent the status of the most recent globalization service operation.
lastPage — Property in class flash.printing.PrintJob
- The page number of the last page of the range entered by the user in the operating system's - Print dialog.
latitude — Property in class flash.events.GeolocationEvent
- The latitude in degrees.
launch(requestedMediaType:String) — Method in class flash.media.CameraUI
- Launches the default camera application on the device.
LAYER — Constant static property in class flash.display.BlendMode
-Forces the creation of a transparency group for the display object.
LCD — Constant static property in class flash.text.TextDisplayMode
- Forces Flash Player to use LCD subpixel anti-aliasing.
leading — Property in class flash.text.TextFormat
- An integer representing the amount of vertical space (called leading) - between lines.
leading — Property in class flash.text.TextLineMetrics
- The leading value is the measurement of the vertical distance between the lines of text.
leadingZero — Property in class flash.globalization.CurrencyFormatter
- Specifies whether a leading zero is included in a formatted currency amount when there are no integer digits - to the left of the decimal separator.
leadingZero — Property in class flash.globalization.NumberFormatter
- Specifies whether a leading zero is included in a formatted number when there are no integer digits - to the left of the decimal separator.
left — Property in class flash.geom.Rectangle
- - The x coordinate of the top-left corner of the rectangle.
LEFT — Constant static property in class flash.display.NativeWindowResize
-The left edge of the window.
LEFT — Constant static property in class flash.display.StageAlign
-Specifies that the Stage is aligned on the left.
LEFT — Constant static property in class flash.text.TextFieldAutoSize
- Specifies that the text is to be treated as left-justified text, - meaning that the left side of the text field remains fixed and any - resizing of a single line is on the right side.
LEFT — Constant static property in class flash.text.TextFormatAlign
- Constant; aligns text to the left within the text field.
LEFT — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Left Arrow key (37).
LEFT — Constant static property in class flash.ui.KeyLocation
- Indicates the key activated is in the left key location (there is more than one possible location for this - key).
LEFTBRACKET — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the [ key (219).
leftExtension — Property in class flash.filters.ShaderFilter
- The growth in pixels on the left side of the target object.
leftMargin — Property in class flash.text.TextFormat
- The left margin of the paragraph, in pixels.
leftPeak — Property in class flash.media.SoundChannel
- The current amplitude (volume) of the left channel, from 0 (silent) to 1 (full amplitude).
leftToLeft — Property in class flash.media.SoundTransform
- A value, from 0 (none) to 1 (all), specifying how much of the left input is played in the - left speaker.
leftToRight — Property in class flash.media.SoundTransform
- A value, from 0 (none) to 1 (all), specifying how much of the left input is played in the - right speaker.
LEGAL — Constant static property in class flash.printing.PaperSize
- Traditional legal size - -
len — Property in class flash.net.NetStreamPlayOptions
- The duration of playback, in seconds, for the stream specified in streamName.
length — Property in class arguments
- - The number of arguments passed to the function.
length — Property in class Array
- - A non-negative integer specifying the number of elements in the array.
length — Property in class Function
- - Returns the length of the argument list for this method.
length — Property in class String
- - An integer specifying the number of characters in the specified String object.
length — Property in class Vector
- The range of valid indices available in the Vector.
length() — Method in class XML
- - For XML objects, this method always returns the integer 1.
length() — Method in class XMLList
- - Returns the number of properties in the XMLList object.
length — Property in class flash.geom.Point
- The length of the line segment from (0,0) to this point.
length — Property in class flash.geom.Vector3D
- The length, magnitude, of the current Vector3D object from the origin (0,0,0) to - the object's x, y, and z coordinates.
length — Property in class flash.media.Sound
- The length of the current sound in milliseconds.
length — Property in class flash.text.TextField
- - The number of characters in a text field.
length — Property in class flash.utils.ByteArray
- - The length of the ByteArray object, in bytes.
lengthSquared — Property in class flash.geom.Vector3D
- The square of the length of the current Vector3D object, calculated using the x, - y, and z properties.
LEPCHA — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Lepcha digit set.
LESS — Constant static property in class flash.display3D.Context3DCompareMode
- Less than (<).
LESS_EQUAL — Constant static property in class flash.display3D.Context3DCompareMode
- Less than or equal (<=).
LETTER — Constant static property in class flash.printing.PaperSize
- Traditional letter size - -
letterSpacing — Property in class flash.text.TextFormat
- A number representing the amount of space that is uniformly distributed between all characters.
letterSpacing — Property in class flash.text.engine.SpaceJustifier
- Specifies whether to use letter spacing during justification.
level — Property in class air.system.License
- - Level of the license (enterprise/professional/basic/free) - -
level — Property in class flash.events.StatusEvent
- The category of the message, such as "status", "warning" or "error".
level — Property in class flash.media.H264VideoStreamSettings
- Level used for H.264/AVC encoding.
LEVEL_1 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 1.
LEVEL_1_1 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 1.1.
LEVEL_1_2 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 1.2.
LEVEL_1_3 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 1.3.
LEVEL_1B — Constant static property in class flash.media.H264Level
- Constant for H.264 level 1b.
LEVEL_2 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 2.
LEVEL_2_1 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 2.1.
LEVEL_2_2 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 2.2.
LEVEL_3 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 3.
LEVEL_3_1 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 3.1.
LEVEL_3_2 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 3.2.
LEVEL_4 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 4.
LEVEL_4_1 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 4.1.
LEVEL_4_2 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 4.2.
LEVEL_5 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 5.
LEVEL_5_1 — Constant static property in class flash.media.H264Level
- Constant for H.264 level 5.1.
lf32(addr) — Package function in avm2.intrinsics.memory
- - Loads a 32-bit floating point value from the given addr in domain memory.
lf64(addr) — Package function in avm2.intrinsics.memory
- - Loads a 64-bit floating point value from the given addr in domain memory.
li16(addr) — Package function in avm2.intrinsics.memory
- - Loads a 16-bit integer value from the given addr in domain memory.
li32(addr) — Package function in avm2.intrinsics.memory
- - Loads a 32-bit integer value from the given addr in domain memory.
li8(addr) — Package function in avm2.intrinsics.memory
- - Loads an 8-bit integer value from the given addr in domain memory.
License — Class in package air.system
- - The License class is used to provide information about the AIR SDK license, - - for a running application.
License() — Constructor in class air.system.License
- - Default constructor - do not call this directly, instead use one of the static methods - - such as load or loadFromFile.
licenseID — Property in class flash.events.DRMReturnVoucherCompleteEvent
- The license ID that was passed into the DRMManager.returnVoucher() call.
licenseID — Property in class flash.events.DRMReturnVoucherErrorEvent
- The license ID that was passed into the returnVoucher() call that resulted in this error.
licenseID — Property in class flash.net.drm.DRMContentData
- A unique id identifying the content associated with this metadata on - the media rights server.
licenseID — Property in class flash.net.drm.DRMVoucher
- The unique license ID for this voucher.
LICENSE_REQUEST — Constant static property in class flash.events.DRMLicenseRequestEvent
- The string constant to use for the license request event - in the type parameter when adding and removing event listeners.
ligatureLevel — Property in class flash.text.engine.ElementFormat
- The ligature level used for this text.
LigatureLevel — Final class in package flash.text.engine
-The LigatureLevel class is an enumeration of constant values used in setting the ligatureLevel property -of the ElementFormat class.
LIGHT_COLOR — Constant static property in class flash.text.TextColorType
- Used in the colorType parameter in the setAdvancedAntiAliasingTable() method.
LIGHTEN — Constant static property in class flash.display.BlendMode
-Selects the lighter of the constituent colors of the display object and the colors of the background (the -colors with the larger values).
LIGHTWEIGHT — Constant static property in class flash.display.NativeWindowType
- A minimal window.
LIMBU — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Limbu digit set.
LINEAR — Constant static property in class flash.display.GradientType
- Value used to specify a linear gradient fill.
LINEAR — Constant static property in class flash.display3D.Context3DTextureFilter
- Use linear interpolation when upsampling textures - (gives a smooth, blurry look).
LINEAR_RGB — Constant static property in class flash.display.InterpolationMethod
- Specifies that the linear RGB interpolation method should be used.
lineBitmapStyle(bitmap:flash.display:BitmapData, matrix:flash.geom:Matrix, repeat:Boolean, smooth:Boolean) — Method in class flash.display.Graphics
- Specifies a bitmap to use for the line stroke when drawing lines.
lineEnding — Static property in class flash.filesystem.File
- - The line-ending character sequence used by the host operating system.
lineGap — Property in class flash.text.engine.FontMetrics
- The lineGap value is the suggested gap between lines.
lineGradientStyle(type:String, colors:Array, alphas:Array, ratios:Array, matrix:flash.geom:Matrix, spreadMethod:String, interpolationMethod:String, focalPointRatio:Number) — Method in class flash.display.Graphics
- Specifies a gradient to use for the stroke when drawing lines.
lineJustification — Property in class flash.text.engine.TextJustifier
- Specifies the line justification for the text in a text block.
LineJustification — Final class in package flash.text.engine
-The LineJustification class is an enumeration of constant values used in setting the lineJustfication property -of the TextJustifier subclasses.
lineRotation — Property in class flash.text.engine.TextBlock
- Rotates the text lines in the text block as a unit.
LineScaleMode — Final class in package flash.display
-The LineScaleMode class provides values for the scaleMode -parameter in the Graphics.lineStyle() method.
lineShaderStyle(shader:flash.display:Shader, matrix:flash.geom:Matrix) — Method in class flash.display.Graphics
- Specifies a shader to use for the line stroke when drawing lines.
lineStyle(thickness:Number, color:uint, alpha:Number, pixelHinting:Boolean, scaleMode:String, caps:String, joints:String, miterLimit:Number) — Method in class flash.display.Graphics
- Specifies a line style used for subsequent calls to - Graphics methods such as the lineTo() method or the drawCircle() method.
lineTo(x:Number, y:Number) — Method in class flash.display.Graphics
- Draws a line using the current line style from the current drawing position to (x, y); - the current drawing position is then set to (x, y).
lineTo(x:Number, y:Number) — Method in class flash.display.GraphicsPath
- Adds a new "lineTo" command to the commands vector and - new coordinates to the data vector.
LINE_TO — Constant static property in class flash.display.GraphicsPathCommand
- Specifies a drawing command that draws a line from the current drawing position to the x- and y-coordinates - specified in the data vector.
LINING — Constant static property in class flash.text.engine.DigitCase
- Used to specify lining digit case.
link — Event in class flash.text.TextField
- - Dispatched when a user clicks a hyperlink in an - - HTML-enabled text field, where the URL begins with "event:".
link — Property in class flash.ui.ContextMenu
- The URLRequest of the link.
LINK — Constant static property in class air.utils.ZipEntry
- - Flag value for a symbolic link entry - -
LINK — Constant static property in class flash.desktop.NativeDragActions
- Defines the string to use for the link action.
LINK — Constant static property in class flash.events.TextEvent
- Defines the value of the type property of a link event object.
listen(backlog:int) — Method in class flash.net.ServerSocket
- Initiates listening for TCP connections on the bound IP address and port.
listening — Property in class flash.net.ServerSocket
- Indicates whether the server socket is listening for incoming connections.
listOwnedWindows() — Method in class flash.display.NativeWindow
- - Returns a list of the NativeWindow objects that are owned by this window.
listStreams() — Method in class flash.net.NetMonitor
- Retrieves all NetStream objects belonging to this NetMonitor object's security context.
listWorkers() — Method in class flash.system.WorkerDomain
- Provides access to the set of workers in the WorkerDomain that are - currently running (the Worker instance's state property is - WorkerState.RUNNING).
LITTLE_ENDIAN — Constant static property in class flash.utils.Endian
- Indicates the least significant byte of the multibyte number appears first in the sequence of bytes.
LIVE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for returning to live [position in broadcast].
liveDelay — Property in class flash.net.NetStream
- The number of seconds of data in the subscribing stream's - buffer in live (unbuffered) mode.
LN10 — Constant static property in class Math
- - A mathematical constant for the natural logarithm of 10, expressed as loge10, - - with an approximate value of 2.302585092994046.
LN2 — Constant static property in class Math
- - A mathematical constant for the natural logarithm of 2, expressed as loge2, - - with an approximate value of 0.6931471805599453.
load() — Static method in class air.system.License
- - Load data from the default location for this application or user.
load(file:flash.filesystem:File) — Static method in class air.utils.ZipArchive
- - Creates a new ZipArchive object by loading in data from a file.
load(request:flash.net:URLRequest, context:flash.system:LoaderContext) — Method in class flash.display.Loader
- - Loads a SWF, JPEG, progressive JPEG, unanimated GIF, or PNG file into an object that is a child of - - this Loader object.
load() — Method in class flash.external.ExtensionInfo
- - A utility method to load in the native library for a dynamic extension.
load(urlRequestToLoad:flash.net:URLRequest) — Method in class flash.html.HTMLLoader
load(stream:flash.net:URLRequest, context:flash.media:SoundLoaderContext) — Method in class flash.media.Sound
- Initiates loading of an external MP3 file from the specified URL.
load() — Method in class flash.net.FileReference
- Starts the load of a local file selected by a user.
load(request:flash.net:URLRequest) — Method in class flash.net.URLLoader
- - Sends and loads data from the specified URL.
load(request:flash.net:URLRequest) — Method in class flash.net.URLStream
- - Begins downloading the URL specified in the request parameter.
loadBytes(bytes:flash.utils:ByteArray, context:flash.system:LoaderContext) — Method in class flash.display.Loader
- - Loads from binary data stored in a ByteArray object.
loadCompressedDataFromByteArray(bytes:flash.utils:ByteArray, bytesLength:uint) — Method in class flash.media.Sound
- load MP3 sound data from a ByteArray object into a Sound object.
loaded — Property in class flash.html.HTMLLoader
loader — Property in class flash.display.LoaderInfo
- The Loader object associated with this LoaderInfo object.
Loader — Class in package flash.display
- - The Loader class is used to load SWF files or image (JPG, PNG, or GIF) files.
Loader() — Constructor in class flash.display.Loader
- - Creates a Loader object that you can use to load files, such as SWF, JPEG, GIF, or PNG files.
LoaderContext — Class in package flash.system
- The LoaderContext class provides options for loading SWF files and other media by using the Loader class.
LoaderContext(checkPolicyFile:Boolean, applicationDomain:flash.system:ApplicationDomain, securityDomain:flash.system:SecurityDomain) — Constructor in class flash.system.LoaderContext
- Creates a new LoaderContext object, with the specified settings.
loaderInfo — Property in class flash.display.DisplayObject
- - Returns a LoaderInfo object containing information about loading the file - - to which this display object belongs.
LoaderInfo — Class in package flash.display
- The LoaderInfo class provides information about a loaded SWF file or a loaded image file - (JPEG, GIF, or PNG).
loaderURL — Property in class flash.display.LoaderInfo
- The URL of the SWF file that initiated the loading of the media - described by this LoaderInfo object.
loadExtension(extensionID:String, aneFolder:flash.filesystem:File) — Static method in class flash.external.ExtensionContext
- - Loads an extension into the AIR runtime so that it can be created via createExtensionContext.
loadFilePromise(promise:flash.desktop:IFilePromise, context:flash.system:LoaderContext) — Method in class flash.display.Loader
- - Loads an IFilePromise instance.
loadFromByteArray(data:flash.utils:ByteArray) — Static method in class air.utils.ZipArchive
- - Creates a new ZipArchive object by loading in data from a byte array.
loadFromFile(license:flash.filesystem:File) — Static method in class air.system.License
- - Load data from a specific adt.lic file rather than pick up the application license.
loadPCMFromByteArray(bytes:flash.utils:ByteArray, samples:uint, format:String, stereo:Boolean, sampleRate:Number) — Method in class flash.media.Sound
- Load PCM 32-bit floating point sound data from a ByteArray object into a Sound object.
loadPolicyFile(url:String) — Static method in class flash.system.Security
- Looks for a policy file at the location specified by the url - parameter.
loadPreviewVoucher(contentData:flash.net.drm:DRMContentData) — Method in class flash.net.drm.DRMManager
- Gets a preview voucher from the license server, which you can use to let a user verify - that they can play content on particular computer.
loadSchema(type:Class, name:String, database:String, includeColumnSchema:Boolean, responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Loads schema information from the connected database or any attached databases.
loadString(htmlContent:String) — Method in class flash.html.HTMLLoader
loadString(text:String, mimeType:String) — Method in class flash.media.StageWebView
- - Loads and displays the specified HTML string.
loadURL(url:String) — Method in class flash.media.StageWebView
- - Loads the page at the specified URL.
loadVoucher(contentData:flash.net.drm:DRMContentData, setting:String) — Method in class flash.net.drm.DRMManager
- Loads a voucher from a media rights server or the local voucher cache.
LoadVoucherSetting — Final class in package flash.net.drm
- The LoadVoucherSetting class provides string constants for use - with the settings parameter of the DRMManager loadVoucher() method.
local3DToGlobal(point3d:flash.geom:Vector3D) — Method in class flash.display.DisplayObject
- - Converts a three-dimensional point of the three-dimensional display - - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
localAddress — Property in class flash.net.DatagramSocket
- - The IP address this socket is bound to on the local machine.
localAddress — Property in class flash.net.ServerSocket
- The IP address on which the socket is listening.
localAddress — Property in class flash.net.Socket
- - The IP address this socket is bound to on the local machine.
LocalConnection — Class in package flash.net
- The LocalConnection class lets you create a LocalConnection object that can invoke a method in another - LocalConnection object.
LocalConnection() — Constructor in class flash.net.LocalConnection
- Creates a LocalConnection object.
localCoverageFrom — Property in class flash.net.NetGroup
- Specifies the start of the range of group addresses for which this node is the "nearest" and responsible.
localCoverageTo — Property in class flash.net.NetGroup
- Specifies the end of the range of group addresses for which this node is the "nearest" and responsible.
locale — Property in class flash.text.StageText
- - Indicates the locale of the text.
locale — Property in class flash.text.engine.ElementFormat
- The locale of the text.
locale — Property in class flash.text.engine.TextJustifier
- Specifies the locale to determine the justification rules for the text in a text block.
localeChain — Property in class air.update.ApplicationUpdaterUI
- - An array defining the locale chain used - - by the user interface.
localeCompare(other:String, ... rest) — Method in class String
- - Compares the sort order of two or more strings and returns the result of the comparison as an integer.
LocaleID — Final class in package flash.globalization
- The LocaleID class provides methods for parsing and using locale ID names.
LocaleID(name:String) — Constructor in class flash.globalization.LocaleID
- Constructs a new LocaleID object, given a locale name.
localFileReadDisable — Static property in class flash.system.Capabilities
- Specifies whether read access to the user's hard disk has been - administratively prohibited (true) or allowed - (false).
localityName — Property in class flash.security.X500DistinguishedName
- Returns the DN LocalityName attribute.
localName — Property in class QName
- - The local name of the QName object.
localName() — Method in class XML
- - Gives the local name portion of the qualified name of the XML object.
localName — Property in class flash.xml.XMLNode
- The local name portion of the XML node's name.
LOCAL_ONLY — Constant static property in class flash.net.drm.LoadVoucherSetting
- Loads the voucher from the local cache only.
localPort — Property in class flash.net.DatagramSocket
- - The port this socket is bound to on the local machine.
localPort — Property in class flash.net.ServerSocket
- The port on which the socket is listening.
localPort — Property in class flash.net.Socket
- - The port this socket is bound to on the local machine.
LOCAL_STORAGE — Constant static property in class flash.system.SecurityPanel
- When passed to Security.showSettings(), displays the - Local Storage Settings panel in Flash Player Settings.
localTimeZone — Static property in class Date
- - The TimeZone object to use as the "local" value.
localToGlobal(point:flash.geom:Point) — Method in class flash.display.DisplayObject
- - Converts the point object from the display object's (local) coordinates to the - - Stage (global) coordinates.
LOCAL_TRUSTED — Constant static property in class flash.system.Security
- The file is a local file and has been trusted by the user, - using either the Flash Player Settings Manager or a FlashPlayerTrust configuration - file.
LOCAL_WITH_FILE — Constant static property in class flash.system.Security
- The file is a local file, has not been trusted by the user, - and it is not a SWF file that was published with a networking designation.
LOCAL_WITH_NETWORK — Constant static property in class flash.system.Security
- The file is a local file, has not been trusted by the user, and it is a SWF - file that was published with a networking designation.
localX — Property in class flash.events.GestureEvent
- The horizontal coordinate at which the event occurred relative to the containing sprite.
localX — Property in class flash.events.MouseEvent
- - When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.
localX — Property in class flash.events.TouchEvent
- The horizontal coordinate at which the event occurred relative to the containing sprite.
localY — Property in class flash.events.GestureEvent
- The vertical coordinate at which the event occurred relative to the containing sprite.
localY — Property in class flash.events.MouseEvent
- - When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.
localY — Property in class flash.events.TouchEvent
- The vertical coordinate at which the event occurred relative to the containing sprite.
location — Property in class flash.events.LocationChangeEvent
- The destination URL of the change.
location — Property in class flash.html.HTMLLoader
location — Property in class flash.media.StageWebView
- - The URL of the current location.
LOCATION_ACCURACY_BEST — Constant static property in class flash.sensors.Geolocation
-

The best level of accuracy available.

- -
LOCATION_ACCURACY_BEST_FOR_NAVIGATION — Constant static property in class flash.sensors.Geolocation
-

The highest possible accuracy that uses additional sensor data to facilitate navigation apps.

- -
LOCATION_ACCURACY_HUNDRED_METERS — Constant static property in class flash.sensors.Geolocation
-

Accurate to within one hundred meters.

- -
LOCATION_ACCURACY_KILOMETER — Constant static property in class flash.sensors.Geolocation
-

Accurate to the nearest kilometer.

- -
LOCATION_ACCURACY_NEAREST_TEN_METERS — Constant static property in class flash.sensors.Geolocation
-

Accurate to within ten meters of the desired target.

- -
LOCATION_ACCURACY_THREE_KILOMETERS — Constant static property in class flash.sensors.Geolocation
-

Accurate to the nearest three kilometers.

- -
locationAlwaysUsePermission — Property in class flash.sensors.Geolocation
- This property determines the access permission type usage of geolocation.
locationBarVisible — Property in class flash.html.HTMLWindowCreateOptions
- Whether a location bar should be displayed.
locationChange — Event in class flash.media.StageWebView
- - Signals that the location property of the StageWebView object has changed.
LOCATION_CHANGE — Constant static property in class flash.events.Event
- The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
LOCATION_CHANGE — Constant static property in class flash.events.LocationChangeEvent
- Dispatched after every location change.
LocationChangeEvent — Class in package flash.events
- An HTMLLoader or StageWebView object dispatches a LocationChangeEvent object when a new page loads.
LocationChangeEvent(type:String, bubbles:Boolean, cancelable:Boolean, location:String) — Constructor in class flash.events.LocationChangeEvent
- Creates a LocationChangeEvent object.
locationChanging — Event in class flash.media.StageWebView
- - Signals that the location property of the StageWebView object is about to change.
LOCATION_CHANGING — Constant static property in class flash.events.LocationChangeEvent
- The LOCATION_CHANGING constant defines the value of the type property LocationChangeEvent object - dispatched before a change in page location.
lock() — Method in class flash.concurrent.Mutex
- - Pauses execution of the current worker until this mutex is available and - - then takes ownership of the mutex.
lock() — Method in class flash.display.BitmapData
- - Locks an image so that any objects that reference the BitmapData object, such as Bitmap objects, - - are not updated when this BitmapData object changes.
locked — Property in class flash.text.engine.ElementFormat
- Indicates whether the ElementFormat is locked.
locked — Property in class flash.text.engine.FontDescription
- - Indicates whether or not the FontDescription is locked.
log(val:Number) — Static method in class Math
- - Returns the natural logarithm of the parameter val.
LOG10E — Constant static property in class Math
- - A mathematical constant for the base-10 logarithm of the constant e (Math.E), - - expressed as log10e, with an approximate value of 0.4342944819032518.
LOG2E — Constant static property in class Math
- - A mathematical constant for the base-2 logarithm of the constant e, expressed - - as log2e, with an approximate value of 1.442695040888963387.
LOGIN — Constant static property in class flash.desktop.InvokeEventReason
- Desktop only; indicates that the InvokeEvent event occurred due to the user logging in.
LONG — Constant static property in class flash.data.SQLColumnNameStyle
- Indicates that column names returned from a SELECT statement use - long-column-name format.
LONG — Constant static property in class flash.globalization.DateTimeStyle
- Specifies the long style of a date or time.
LONG_ABBREVIATION — Constant static property in class flash.globalization.DateTimeNameStyle
- Specifies the long abbreviation style for month names and weekday names.
longitude — Property in class flash.events.GeolocationEvent
- The longitude in degrees.
lookup — Event in class flash.net.dns.DNSResolver
- Dispatched when a DNS look-up is complete.
lookup(host:String, recordType:Class) — Method in class flash.net.dns.DNSResolver
- Looks up a DNS resource record based on a query string.
LOOKUP — Constant static property in class flash.events.DNSResolverEvent
- Defines the value of the type property of a lookup event object.
loop — Property in class flash.ui.ContextMenuBuiltInItems
-Lets the user set a SWF file to start over automatically when it reaches the final -frame (does not appear for a single-frame SWF file).
loopback — Property in class flash.media.Camera
- - Indicates whether a local view of what the camera is capturing is compressed - - and decompressed (true), as it would be for live transmission using - - Flash Media Server, or uncompressed (false).
LOW — Constant static property in class flash.display.StageQuality
- Specifies low rendering quality.
LOW — Constant static property in class flash.filters.BitmapFilterQuality
- Defines the low quality filter setting.
LOWERCASE — Constant static property in class flash.text.engine.TypographicCase
- Specifies that all characters use lowercase glyphs on output.
LOWEST_FIRST — Constant static property in class flash.net.NetGroupReplicationStrategy
- Specifies that when fetching objects from a neighbor to satisfy a want, the objects with the - lowest index numbers are requested first.
LZMA — Constant static property in class flash.utils.CompressionAlgorithm
- - Defines the string to use for the lzma compression algorithm.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/all-index-M.html b/html-docs/all-index-M.html deleted file mode 100644 index 63dfbe7..0000000 --- a/html-docs/all-index-M.html +++ /dev/null @@ -1,1908 +0,0 @@ - - - - - -M Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
M — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the M key (77).
macType — Property in class flash.net.FileFilter
- A list of Macintosh file types.
MAIN — Constant static property in class flash.media.H264Profile
- Constant for H.264/AVC main profile.
mainExtension — Static property in class flash.external.HostObject
- Retrieve the fully qualified package name of the main object model extension.
mainScreen — Static property in class flash.display.Screen
- - The primary display.
makeUnique() — Method in class flash.net.GroupSpecifier
- Adds a strong pseudorandom tag to the groupspec to make it unique.
MALAYALAM — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Malayalam digit set.
manageCookies — Property in class flash.html.HTMLLoader
manageCookies — Property in class flash.net.URLRequest
- Specifies whether the HTTP protocol stack should manage cookies for this - request.
manageCookies — Static property in class flash.net.URLRequestDefaults
- The default setting for the manageCookies property of URLRequest objects.
manufacturer — Static property in class flash.system.Capabilities
- Specifies the manufacturer of the running version of - Flash Player or the AIR runtime, in the format "Adobe - OSName".
map(callback:Function, thisObject) — Method in class Array
- - Executes a function on each item in an array, and constructs a new array of items corresponding to the results of the function on - - each item in the original array.
map(callback:Function, thisObject:Object) — Method in class Vector
- Executes a function on each item in the Vector, and returns a new Vector - of items corresponding to the results of calling the function on - each item in this Vector.
mapBitmap — Property in class flash.filters.DisplacementMapFilter
- A BitmapData object containing the displacement map data.
mapPoint — Property in class flash.filters.DisplacementMapFilter
- A value that contains the offset of the upper-left corner of - the target display object from the upper-left corner of the map image.
mapTouchToMouse — Static property in class flash.ui.Multitouch
- Specifies whether the AIR runtime maps touch events to mouse events.
marshallExceptions — Static property in class flash.external.ExternalInterface
- Indicates whether the external interface should attempt to pass ActionScript exceptions to the - current browser and JavaScript exceptions to the player.
mask — Property in class flash.display.DisplayObject
- - The calling display object is masked by the specified mask object.
MASTER_SHELL — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging the "Master Shell" (e.g.
match(pattern) — Method in class String
- - Matches the specifed pattern against the - - string.
MATCHING — Constant static property in class flash.globalization.CollatorMode
- Initializes a Collator object so that the compare method is optimized for - determining whether two strings are equivalent.
Math — Final class in Top Level
- - The Math class contains methods and constants that represent common mathematical - - functions and values.
matrix — Property in class flash.display.GraphicsBitmapFill
- A matrix object (of the flash.geom.Matrix class) that - defines transformations on the bitmap.
matrix — Property in class flash.display.GraphicsGradientFill
- A transformation matrix as defined by the - Matrix class.
matrix — Property in class flash.display.GraphicsShaderFill
- A matrix object (of the flash.geom.Matrix class), which you can use to - define transformations on the shader.
matrix — Property in class flash.filters.ColorMatrixFilter
- An array of 20 items for 4 x 5 color transform.
matrix — Property in class flash.filters.ConvolutionFilter
- An array of values used for matrix transformation.
matrix — Property in class flash.geom.Transform
- A Matrix object containing values that alter the scaling, rotation, - and translation of the display object.
Matrix — Class in package flash.geom
- - The Matrix class represents a transformation matrix that determines how to map points from one - - coordinate space to another.
Matrix(a:Number, b:Number, c:Number, d:Number, tx:Number, ty:Number) — Constructor in class flash.geom.Matrix
- - Creates a new Matrix object with the specified parameters.
MATRIX2X2 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - float2x2 value, equivalent to a 2-by-2 matrix.
matrix3D — Property in class flash.geom.Transform
- Provides access to the Matrix3D object of a three-dimensional display object.
Matrix3D — Class in package flash.geom
- The Matrix3D class represents a transformation matrix that determines the position and orientation of - a three-dimensional (3D) display object.
Matrix3D(v) — Constructor in class flash.geom.Matrix3D
- Creates a Matrix3D object.
MATRIX3X3 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - float3x3 value, equivalent to a 3-by-3 matrix.
MATRIX4X4 — Constant static property in class flash.display.ShaderParameterType
- Indicates that the shader parameter is defined as a - float4x4 value, equivalent to a 4-by-4 matrix.
matrixX — Property in class flash.filters.ConvolutionFilter
- The x dimension of the matrix (the number of columns in the matrix).
matrixY — Property in class flash.filters.ConvolutionFilter
- The y dimension of the matrix (the number of rows in the matrix).
max(val1:Number, val2:Number, ... rest) — Static method in class Math
- - Evaluates val1 and val2 (or more values) and returns the largest value.
maxBackBufferHeight — Property in class flash.display3D.Context3D
- - Specifies the maximum height of the back buffer.
maxBackBufferWidth — Property in class flash.display3D.Context3D
- - Specifies the maximum width of the back buffer.
MAX_BUFFER_SIZE — Constant static property in class flash.ui.GameInputDevice
- Specifies the maximum size for the buffer used to cache sampled - control values.
maxBytesPerSecond — Property in class flash.net.NetStreamInfo
- Specifies the maximum rate at which the NetStream buffer is filled in bytes per second.
maxChars — Property in class flash.text.StageText
- - Indicates the maximum number of characters that a user can enter into the text field.
maxChars — Property in class flash.text.TextField
- - The maximum number of characters that the text field can contain, as entered by a user.
maximizable — Property in class flash.display.NativeWindow
- - Reports the maximizable setting used to create this window.
maximizable — Property in class flash.display.NativeWindowInitOptions
- Specifies whether the window can be maximized by the user.
maximize() — Method in class flash.display.NativeWindow
- - Maximizes this window.
MAXIMIZED — Constant static property in class flash.display.NativeWindowDisplayState
- The maximized display state.
maximumSpacing — Property in class flash.text.engine.SpaceJustifier
- Specifies the maximum spacing (as a multiplier of the width of a normal space) between words to use during justification.
maxLevel — Static property in class flash.text.TextRenderer
- The adaptively sampled distance fields (ADFs) quality level for advanced anti-aliasing.
maxLevelIDC — Static property in class flash.system.Capabilities
- Retrieves the highest H.264 Level IDC that the client hardware supports.
MAX_LINE_WIDTH — Constant static property in class flash.text.engine.TextLine
- The maximum requested width of a text line, in pixels.
maxPage — Property in class flash.printing.PrintUIOptions
- The maxiumum page number the user can enter - in the print dialog.
maxPauseBufferTime — Property in class flash.net.NetStream
- Specifies how long to buffer messages during pause mode, in seconds.
maxPeerConnections — Property in class flash.net.NetConnection
- The total number of inbound and outbound peer connections that this instance of Flash Player or Adobe AIR allows.
maxPixelsPerInch — Property in class flash.printing.PrintJob
- The physical resolution of the selected printer, in pixels per inch.
maxScrollH — Property in class flash.text.TextField
- - The maximum value of scrollH.
maxScrollV — Property in class flash.text.TextField
- - The maximum value of scrollV.
maxSize — Property in class flash.display.NativeWindow
- - The maximum size for this window.
maxSupportedGroupspecVersion — Static property in class flash.net.GroupSpecifier
- Specifies the maximum groupspec version supported by - this runtime.
MAX_TIP_LENGTH — Constant static property in class flash.desktop.SystemTrayIcon
- The permitted length of the system tray icon tooltip.
maxTouchPoints — Static property in class flash.ui.Multitouch
- The maximum number of concurrent touch points supported by the current environment.
maxValue — Property in class flash.ui.GameInputControl
- Returns the maximum value for this control.
MAX_VALUE — Constant static property in class float
- - The largest representable number (single-precision IEEE-754).
MAX_VALUE — Constant static property in class int
- - The largest representable 32-bit signed integer, which is 2,147,483,647.
MAX_VALUE — Constant static property in class Number
- - The largest representable number (double-precision IEEE-754).
MAX_VALUE — Constant static property in class uint
- - The largest representable 32-bit unsigned integer, which is 4,294,967,295.
MD5 — Constant static property in class air.security.Digest
- - Definition for the MD5 algorithm - -
MEDIA — Constant static property in class flash.media.AudioPlaybackMode
- A mode for playing media sounds.
MediaEvent — Class in package flash.events
- CameraRoll and CameraUI classes dispatch MediaEvent objects when a media stream - is available.
MediaEvent(type:String, bubbles:Boolean, cancelable:Boolean, data:flash.media:MediaPromise) — Constructor in class flash.events.MediaEvent
- Creates an MediaEvent object that contains information about the available media file.
mediaPlaybackRequiresUserAction — Property in class flash.media.StageWebView
- - Set whether User is required to perform gesture to play media content.
MediaPromise — Class in package flash.media
- The MediaPromise class represents the promise to deliver a media object.
mediaType — Property in class flash.media.MediaPromise
- The general type of media, either image or video.
MediaType — Final class in package flash.media
- The MediaType class enumerates the general types of media that can be returned by a camera.
mediaTypeData — Event in class flash.net.NetStream
- Dispatched when playing video content and certain type of messages are processed.
MEDIA_TYPE_DATA — Constant static property in class flash.events.NetDataEvent
- The NetDataEvent.MEDIA_TYPE_DATA constant defines the value of the type property of the NetDataEvent object - dispatched when a data message in the media stream is encountered by the NetStream object.
MEDIUM — Constant static property in class flash.display.StageQuality
- Specifies medium rendering quality.
MEDIUM — Constant static property in class flash.filters.BitmapFilterQuality
- Defines the medium quality filter setting.
MEDIUM — Constant static property in class flash.globalization.DateTimeStyle
- Specifies the medium style of a date or time.
MEMORY_ALLOCATION_ERROR — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that memory allocation has failed.
menu — Property in class flash.desktop.DockIcon
- The system-supplied menu of this dock icon.
menu — Property in class flash.desktop.NativeApplication
- - The application menu.
menu — Property in class flash.desktop.SystemTrayIcon
- The system tray icon menu.
menu — Property in class flash.display.NativeMenuItem
- - The menu that contains this item.
menu — Property in class flash.display.NativeWindow
- - The native menu for this window.
MENU — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging the menu.
menuBarVisible — Property in class flash.html.HTMLWindowCreateOptions
- Specifies whether a menu bar should be displayed.
menuItemSelect — Event in class flash.ui.ContextMenuItem
- Dispatched when a user selects an item from a context menu.
MENU_ITEM_SELECT — Constant static property in class flash.events.ContextMenuEvent
- Defines the value of the type property of a menuItemSelect event object.
menuSelect — Event in class flash.ui.ContextMenu
- Dispatched when a user first generates a - context menu but before the contents of the context menu are displayed.
MENU_SELECT — Constant static property in class flash.events.ContextMenuEvent
- Defines the value of the type property of a menuSelect event object.
merge(sourceBitmapData:flash.display:BitmapData, sourceRect:flash.geom:Rectangle, destPoint:flash.geom:Point, redMultiplier:uint, greenMultiplier:uint, blueMultiplier:uint, alphaMultiplier:uint) — Method in class flash.display.BitmapData
- - Performs per-channel blending from a source image to a destination image.
mergeTextElements(beginIndex:int, endIndex:int) — Method in class flash.text.engine.GroupElement
- Merges the text from the range of elements that the beginIndex and endIndex - parameters specify into the element specified by beginIndex without affecting the format of that element.
message — Property in class Error
- - Contains the message associated with the Error object.
messageAvailable — Property in class flash.system.MessageChannel
- - Indicates whether the MessageChannel has one or more messages from - - the sending worker in its internal message queue.
MessageChannel — Final class in package flash.system
- - The MessageChannel class provides a mechanism for a worker to communicate - - with another worker.
MessageChannelState — Final class in package flash.system
- - This class defines constants that represent the possible values for the - - MessageChannel class's state property.
metaData — Property in class flash.display.DisplayObject
- - Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
metaData — Property in class flash.net.NetStreamInfo
- The most recent metadata object associated with the media being played.
method — Property in class flash.net.URLRequest
- Controls the HTTP form submission method.
mfence() — Package function in avm2.intrinsics.memory
- - A complete memory barrier for domainMemory (for both load and store instructions).
Microphone — Final class in package flash.media
- - Use the Microphone class to monitor or capture audio from a microphone.
MICROPHONE — Constant static property in class flash.system.SecurityPanel
- When passed to Security.showSettings(), displays the - Microphone panel in Flash Player Settings.
MicrophoneEnhancedMode — Final class in package flash.media
- The MicrophoneEnhancedMode class is an enumeration of constant values used in setting the mode property - of MicrophoneEnhancedOptions class.
MicrophoneEnhancedOptions — Final class in package flash.media
- The MicrophoneEnhancedOptions class provides configuration options for enhanced audio (acoustic echo cancellation).
MicrophoneEnhancedOptions() — Constructor in class flash.media.MicrophoneEnhancedOptions
middleClick — Event in class flash.display.InteractiveObject
- - Dispatched when a user presses and releases the middle button of the user's - - pointing device over the same InteractiveObject.
MIDDLE_CLICK — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a middleClick event object.
middleMouseDown — Event in class flash.display.InteractiveObject
- - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.
MIDDLE_MOUSE_DOWN — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a middleMouseDown event object.
middleMouseUp — Event in class flash.display.InteractiveObject
- - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.
MIDDLE_MOUSE_UP — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a middleMouseUp event object.
milliseconds — Property in class Date
- - The milliseconds (an integer from 0 to 999) portion of a Date object - - according to local time.
millisecondsUTC — Property in class Date
- - The milliseconds (an integer from 0 to 999) portion of a Date object - - according to universal time (UTC).
min(val1:Number, val2:Number, ... rest) — Static method in class Math
- - Evaluates val1 and val2 (or more values) and returns the smallest value.
MIN_DOMAIN_MEMORY_LENGTH — Static property in class flash.system.ApplicationDomain
- Gets the minimum memory object length required to be used as - ApplicationDomain.domainMemory.
minGroupspecVersion — Property in class flash.net.GroupSpecifier
- Specifies the minimum version number the generated groupspec - will have.
minimizable — Property in class flash.display.NativeWindow
- - Reports the minimizable setting used to create this window.
minimizable — Property in class flash.display.NativeWindowInitOptions
- Specifies whether the window can be minimized by the user.
minimize() — Method in class flash.display.NativeWindow
- - Minimizes this window.
MINIMIZED — Constant static property in class flash.display.NativeWindowDisplayState
- The minimized display state.
MINIMUM — Constant static property in class flash.text.engine.LigatureLevel
- Used to specify minimum ligatures.
minimumSpacing — Property in class flash.text.engine.SpaceJustifier
- Specifies the minimum spacing (as a multiplier of the width of a normal space) between words to use during justification.
minPage — Property in class flash.printing.PrintUIOptions
- The minimum page number a user can enter - in the print dialog.
minSize — Property in class flash.display.NativeWindow
- - The minimum size for this window.
MINUS — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the - key (189).
minutes — Property in class Date
- - The minutes (an integer from 0 to 59) portion of a Date object - - according to local time.
minutesUTC — Property in class Date
- - The minutes (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC).
minValue — Property in class flash.ui.GameInputControl
- Returns the minimum value for this control.
MIN_VALUE — Constant static property in class float
- - The smallest (closest to zero, not most negative) representable single-precision IEEE-754 number that does not compare equal to zero.
MIN_VALUE — Constant static property in class int
- - The smallest representable 32-bit signed integer, which is -2,147,483,648.
MIN_VALUE — Constant static property in class Number
- - The smallest (closest to zero, not most negative) representable IEEE-754 number that does not compare equal to zero.
MIN_VALUE — Constant static property in class uint
- - The smallest representable unsigned integer, which is 0.
MIPLINEAR — Constant static property in class flash.display3D.Context3DMipFilter
- Select the two closest MIP levels and linearly blend between them - (the highest quality mode, but has some performance cost).
MIPNEAREST — Constant static property in class flash.display3D.Context3DMipFilter
- Use the nearest neighbor metric to select MIP levels - (the fastest rendering method).
MIPNONE — Constant static property in class flash.display3D.Context3DMipFilter
- Always use the top level texture - (has a performance penalty when downscaling).
mirror — Property in class flash.text.engine.TextLineMirrorRegion
- The EventDispatcher object to which events affecting the mirror region are mirrored.
mirrorRegions — Property in class flash.text.engine.TextLine
- A Vector containing the TextLineMirrorRegion objects associated with the line, or null if none exist.
MITER — Constant static property in class flash.display.JointStyle
- - Specifies mitered joints in the joints parameter of the - flash.display.Graphics.lineStyle() method.
miterLimit — Property in class flash.display.GraphicsStroke
- Indicates the limit at which a miter is cut off.
mnemonicIndex — Property in class flash.display.NativeMenuItem
- - The position of the mnemonic character in the menu item label.
mode — Property in class flash.display.Screen
- - The current screen mode of the Screen object.
mode — Property in class flash.filters.DisplacementMapFilter
- The mode for the filter.
mode — Property in class flash.media.MicrophoneEnhancedOptions
- Controls enhanced microphone mode.
modes — Property in class flash.display.Screen
- - The array of ScreenMode objects of the Screen object.
modificationDate — Property in class flash.net.FileReference
- The date that the file on the local disk was last modified.
modified — Property in class air.utils.ZipEntry
- - The 'last modified' date/time for this entry, which will determine the file - - time set on an entry if it is unzipped to a file.
MONGOLIAN — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Mongolian digit set.
month — Property in class Date
- - The month (0 for January, 1 for February, and so on) portion of a - - Date object according to local time.
monthUTC — Property in class Date
- - The month (0 [January] to 11 [December]) portion of a Date object - - according to universal time (UTC).
MorphShape — Final class in package flash.display
- The MorphShape class represents MorphShape objects on the display list.
motionLevel — Property in class flash.media.Camera
- - The amount of motion required to invoke the activity event.
motionTimeout — Property in class flash.media.Camera
- - The number of milliseconds between the time the camera stops detecting motion and the time the activity event is invoked.
Mouse — Final class in package flash.ui
- The methods of the Mouse class are used to hide and show the mouse pointer, - or to set the pointer to a specific style.
mouseChildren — Property in class flash.display.DisplayObjectContainer
- Determines whether or not the children of the object are mouse, or user input device, enabled.
mouseChildren — Property in class flash.display.Stage
- Determines whether or not the children of the object are mouse, or user input device, enabled.
MouseCursor — Final class in package flash.ui
-The MouseCursor class is an enumeration of constant values used in setting the cursor property -of the Mouse class.
MouseCursorData — Final class in package flash.ui
- The MouseCursorData class lets you define the appearance of a "native" mouse cursor.
MouseCursorData() — Constructor in class flash.ui.MouseCursorData
- Creates a MouseCursorData object.
mouseDown — Event in class flash.desktop.SystemTrayIcon
- Dispatched by this SystemTrayIcon object on mouse down.
mouseDown — Event in class flash.display.InteractiveObject
- - Dispatched when a user presses the pointing device button over an InteractiveObject instance.
MOUSE_DOWN — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a mouseDown event object.
MOUSE_DOWN — Constant static property in class flash.events.ScreenMouseEvent
- The ScreenMouseEvent.MOUSE_DOWN constant defines the value of the type - property of a mouseDown event object.
mouseEnabled — Property in class flash.display.InteractiveObject
- - Specifies whether this object receives mouse, or other user input, messages.
MouseEvent — Class in package flash.events
- - A MouseEvent object is dispatched into the event flow whenever mouse events occur.
MouseEvent(type:String, bubbles:Boolean, cancelable:Boolean, localX:Number, localY:Number, relatedObject:flash.display:InteractiveObject, ctrlKey:Boolean, altKey:Boolean, shiftKey:Boolean, buttonDown:Boolean, delta:int, commandKey:Boolean, controlKey:Boolean, clickCount:int) — Constructor in class flash.events.MouseEvent
- - Creates an Event object that contains information about mouse events.
mouseFocusChange — Event in class flash.display.InteractiveObject
- - Dispatched when the user attempts to change focus by using a pointer device.
MOUSE_FOCUS_CHANGE — Constant static property in class flash.events.FocusEvent
- Defines the value of the type property of a mouseFocusChange event object.
mouseLeave — Event in class flash.display.Stage
- Dispatched by the Stage object when the pointer moves out of the - stage area.
MOUSE_LEAVE — Constant static property in class flash.events.Event
- The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
mouseLock — Property in class flash.display.Stage
- Set to true to enable mouse locking.
mouseMove — Event in class flash.display.InteractiveObject
- - Dispatched when a user moves the pointing device while it is over an InteractiveObject.
MOUSE_MOVE — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a mouseMove event object.
mouseOut — Event in class flash.display.InteractiveObject
- - Dispatched when the user moves a pointing device away from an InteractiveObject instance.
MOUSE_OUT — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a mouseOut event object.
mouseOver — Event in class flash.display.InteractiveObject
- - Dispatched when the user moves a pointing device over an InteractiveObject instance.
MOUSE_OVER — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a mouseOver event object.
mouseTarget — Property in class flash.events.ContextMenuEvent
- The display list object on which the user right-clicked to display the context menu.
mouseUp — Event in class flash.desktop.SystemTrayIcon
- Dispatched by this SystemTrayIcon object on mouse up.
mouseUp — Event in class flash.display.InteractiveObject
- - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.
MOUSE_UP — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a mouseUp event object.
MOUSE_UP — Constant static property in class flash.events.ScreenMouseEvent
- The ScreenMouseEvent.MOUSE_UP constant defines the value of the type - property of a mouseUp event object.
mouseWheel — Event in class flash.display.InteractiveObject
- - Dispatched when a mouse wheel is spun over an InteractiveObject instance.
MOUSE_WHEEL — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a mouseWheel event object.
mouseWheelEnabled — Property in class flash.text.TextField
- - A Boolean value that indicates whether Flash Player automatically scrolls multiline - - text fields when the user clicks a text field and rolls the mouse wheel.
mouseWheelHorizontal — Event in class flash.display.InteractiveObject
- - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.
MOUSE_WHEEL_HORIZONTAL — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a mouseWheelHorizontal event object.
mouseX — Property in class flash.display.DisplayObject
- - Indicates the x coordinate of the mouse or user input device position, in pixels.
mouseY — Property in class flash.display.DisplayObject
- - Indicates the y coordinate of the mouse or user input device position, in pixels.
move — Event in class flash.display.NativeWindow
- - Dispatched by this NativeWindow object after the window has been moved on the desktop.
MOVE — Constant static property in class flash.desktop.NativeDragActions
- Defines the string to use for the move action.
MOVE — Constant static property in class flash.events.NativeWindowBoundsEvent
- Defines the value of the type property of a move event object.
movementX — Property in class flash.events.MouseEvent
- - When mouse locking is enabled, the change in mouse position - - in the X direction since the last mouse event.
movementY — Property in class flash.events.MouseEvent
- - When mouse locking is enabled, the change in mouse position - - in the Y direction since the last mouse event.
moveTo(x:Number, y:Number) — Method in class flash.display.Graphics
- Moves the current drawing position to (x, y).
moveTo(x:Number, y:Number) — Method in class flash.display.GraphicsPath
- Adds a new "moveTo" command to the commands vector and - new coordinates to the data vector.
moveTo(newLocation:flash.net:FileReference, overwrite:Boolean) — Method in class flash.filesystem.File
- - Moves the file or directory at the location specified by this File object to - - the location specified by the destination parameter.
MOVE_TO — Constant static property in class flash.display.GraphicsPathCommand
- Specifies a drawing command that moves the current drawing position to the x- and y-coordinates specified in the data vector.
moveToAsync(newLocation:flash.net:FileReference, overwrite:Boolean) — Method in class flash.filesystem.File
- - Begins moving the file or directory at the location specified by this File object to - - the location specified by the newLocation parameter.
moveToTrash() — Method in class flash.filesystem.File
- - Moves a file or directory to the trash.
moveToTrashAsync() — Method in class flash.filesystem.File
- - Asynchronously moves a file or directory to the trash.
MovieClip — Dynamic class in package flash.display
- The MovieClip class inherits from the following classes: Sprite, DisplayObjectContainer, - InteractiveObject, DisplayObject, and EventDispatcher.
MovieClip() — Constructor in class flash.display.MovieClip
- Creates a new MovieClip instance.
moving — Event in class flash.display.NativeWindow
- - Dispatched by the NativeWindow object immediately before the window is to be moved on - - the desktop.
MOVING — Constant static property in class flash.events.NativeWindowBoundsEvent
- Defines the value of the type property of a moving event object.
mtu — Property in class flash.net.NetworkInterface
- The maximum transmission unit (MTU) of this network interface.
multicastAvailabilitySendToAll — Property in class flash.net.NetStream
- For RTMFP connections, specifies whether peer-to-peer multicast fragment availability messages are - sent to all peers or to just one peer.
multicastAvailabilityUpdatePeriod — Property in class flash.net.NetStream
- For RTMFP connections, specifies the interval in seconds between messages sent to peers informing them that - the local node has new peer-to-peer multicast media fragments available.
multicastEnabled — Property in class flash.net.GroupSpecifier
- Specifies whether streaming is enabled for the NetGroup.
multicastFetchPeriod — Property in class flash.net.NetStream
- For RTMFP connections, specifies the time in seconds between when the local node learns that a peer-to-peer - multicast media fragment is available and when it tries to fetch it from a peer.
multicastInfo — Property in class flash.net.NetStream
- For RTMFP connections, returns a NetStreamMulticastInfo object whose properties contain statistics about the quality of service.
multicastPushNeighborLimit — Property in class flash.net.NetStream
- For RTMFP connections, specifies the maximum number of peers to which to proactively push - multicast media.
multicastRelayMarginDuration — Property in class flash.net.NetStream
- For RTMFP connections, specifies the duration in seconds that peer-to-peer multicast data remains - available to send to peers that request it beyond a specified duration.
multicastWindowDuration — Property in class flash.net.NetStream
- For RTMFP connections, specifies the duration in seconds of the peer-to-peer multicast reassembly - window.
multiline — Property in class RegExp
- - Specifies whether the m (multiline) flag is set.
multiline — Property in class flash.text.StageText
- - Indicates whether the StageText object can display more than one line of - - text.
multiline — Property in class flash.text.StageTextInitOptions
- Specifies whether the StageText object displays multiple lines of text.
multiline — Property in class flash.text.TextField
- - Indicates whether field is a multiline text field.
MULTIPLY — Constant static property in class flash.display.BlendMode
-Multiplies the values of the display object constituent colors by the constituent colors of -the background color, and normalizes by dividing by 0xFF, -resulting in darker colors.
Multitouch — Final class in package flash.ui
- The Multitouch class manages and provides information about the current environment's support for handling - contact from user input devices, including contact that has two or more touch points (such as a user's fingers on a touch screen).
MultitouchInputMode — Final class in package flash.ui
- The MultitouchInputMode class provides values for the inputMode property in the flash.ui.Multitouch class.
muted — Property in class flash.media.Camera
- - A Boolean value indicating whether the user has denied access to the camera - - (true) or allowed access (false) in the Flash Player Privacy dialog box.
muted — Property in class flash.media.Microphone
- Specifies whether the user has denied access to the microphone (true) - or allowed access (false).
muted — Property in class flash.sensors.Accelerometer
- Specifies whether the user has denied access to the accelerometer (true) - or allowed access (false).
muted — Property in class flash.sensors.DeviceRotation
- Specifies whether the user has denied access to the Device Rotation data (true) - or allowed access (false).
muted — Property in class flash.sensors.Geolocation
- Specifies whether the user has denied access to the geolocation (true) - or allowed access (false).
mutex — Property in class flash.concurrent.Condition
- - The mutex associated with this condition.
Mutex — Final class in package flash.concurrent
- - The Mutex (short for "mutual exclusion") class provides a way to make sure - - that only one set of code operates on a particular block of memory or other - - shared resource at a time.
Mutex() — Constructor in class flash.concurrent.Mutex
- - Creates a new Mutex instance.
MXRecord — Class in package flash.net.dns
- The MXRecord class represents a Domain Name System (DNS) MX resource record containing a mail exchange server address.
MXRecord() — Constructor in class flash.net.dns.MXRecord
- Creates an MX resource record.
MYANMAR — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Myanmar digit set.
MYANMAR_SHAN — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Myanmar Shan digit set.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/all-index-N.html b/html-docs/all-index-N.html deleted file mode 100644 index 50e26e3..0000000 --- a/html-docs/all-index-N.html +++ /dev/null @@ -1,2178 +0,0 @@ - - - - - -N Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
N — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the N key (78).
name — Property in class Error
- - Contains the name of the Error object.
name() — Method in class XML
- - Gives the qualified name for the XML object.
name — Property in class air.utils.ZipEntry
- - The name of the entry (including folder structure where required) - - -
name — Property in class flash.accessibility.AccessibilityProperties
- Provides a name for this display object in the accessible presentation.
name — Property in class flash.data.SQLColumnSchema
- Gets the name of the column.
name — Property in class flash.data.SQLSchema
- The name of this schema object.
name — Property in class flash.display.DisplayObject
- - Indicates the instance name of the DisplayObject.
name — Property in class flash.display.FrameLabel
- The name of the label.
name — Property in class flash.display.NativeMenuItem
- - The name of this menu item.
name — Property in class flash.display.Scene
- The name of the scene.
name — Property in class flash.external.ExtensionInfo
- - The extension name, as provided in the extension's XML descriptor file.
name — Property in class flash.filesystem.StorageVolume
- The name of the volume.
name — Property in class flash.globalization.LocaleID
- Returns a slightly more "canonical" locale identifier.
name — Property in class flash.media.Camera
- - The name of the current camera, as returned by the camera hardware.
name — Property in class flash.media.Microphone
- The name of the current sound capture device, as returned by the sound capture hardware.
name — Property in class flash.net.FileReference
- The name of the file on the local disk.
name — Property in class flash.net.NetworkInterface
- The name of this network interface.
name — Property in class flash.net.URLRequestHeader
- An HTTP request header name (such as Content-Type or SOAPAction).
name — Property in class flash.net.dns.ResourceRecord
- The query string used to look up this resource record.
name — Property in class flash.net.drm.DRMDeviceGroup
- The domain name of this device group.
name — Property in class flash.ui.GameInputDevice
- Returns the name of this device.
NAME — Constant static property in class flash.text.StageTextContentType
- -

Content is a name

- - - -
names — Static property in class flash.media.Camera
- - An array of strings containing the names of all available cameras.
names — Static property in class flash.media.Microphone
- An array of strings containing the names of all available sound capture devices.
namespace — Statement
Allows you to control the visibility of definitions.
namespace(prefix:String) — Method in class XML
- - If no parameter is provided, gives the namespace associated with the qualified name of - - this XML object.
Namespace — Final class in Top Level
- - -The Namespace class contains methods and properties for defining and working with namespaces.
Namespace(uriValue) — Constructor in class Namespace
- - Creates a Namespace object.
Namespace(prefixValue, uriValue) — Constructor in class Namespace
- - Creates a Namespace object according to the values of the prefixValue and uriValue parameters.
namespaceDeclarations() — Method in class XML
- - Lists namespace declarations associated with the XML object in the context of its parent.
namespaceURI — Property in class flash.xml.XMLNode
- If the XML node has a prefix, namespaceURI is the value of the xmlns - declaration for that prefix (the URI), which is typically called the namespace URI.
NaN — Package constant property in Top Level
- - A special member of the Number data type that represents a value that is "not a number" (NaN).
NaN — Constant static property in class float
- - The single-precision IEEE-754 value representing Not a Number (NaN).
NaN — Constant static property in class Number
- - The IEEE-754 value representing Not a Number (NaN).
NationalDigitsType — Final class in package flash.globalization
- The NationalDigitsType class enumerates constants that indicate digit sets used by the NumberFormatter class.
native — Statement
Specifies that a function or method is implemented by Flash Player in native code.
nativeApplication — Static property in class flash.desktop.NativeApplication
- - The singleton instance of the NativeApplication object.
NativeApplication — Final class in package flash.desktop
- - The NativeApplication class represents this AIR application.
NativeDragActions — Class in package flash.desktop
-The NativeDragActions class defines string constants for the names of the drag-and-drop actions.
nativeDragComplete — Event in class flash.display.InteractiveObject
- - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.
NATIVE_DRAG_COMPLETE — Constant static property in class flash.events.NativeDragEvent
- NativeDragEvent.NATIVE_DRAG_COMPLETE defines the value of the - type property of a nativeDragComplete event object.
nativeDragDrop — Event in class flash.display.InteractiveObject
- - 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().
NATIVE_DRAG_DROP — Constant static property in class flash.events.NativeDragEvent
- NativeDragEvent.NATIVE_DRAG_DROP defines the value of the type - property of a nativeDragDrop event object.
nativeDragEnter — Event in class flash.display.InteractiveObject
- - Dispatched by an InteractiveObject when a drag gesture enters its boundary.
NATIVE_DRAG_ENTER — Constant static property in class flash.events.NativeDragEvent
- NativeDragEvent.NATIVE_DRAG_ENTER defines the value of the - type property of a nativeDragEnter event object.
NativeDragEvent — Class in package flash.events
- Native drag events are dispatched by the interactive objects involved in a - drag-and-drop operation.
NativeDragEvent(type:String, bubbles:Boolean, cancelable:Boolean, localX:Number, localY:Number, relatedObject:flash.display:InteractiveObject, clipboard:flash.desktop:Clipboard, allowedActions:flash.desktop:NativeDragOptions, dropAction:String, controlKey:Boolean, altKey:Boolean, shiftKey:Boolean, commandKey:Boolean) — Constructor in class flash.events.NativeDragEvent
- Creates an Event object with specific information relevant to native drag-and-drop events.
nativeDragExit — Event in class flash.display.InteractiveObject
- - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.
NATIVE_DRAG_EXIT — Constant static property in class flash.events.NativeDragEvent
- NativeDragEvent.NATIVE_DRAG_EXIT defines the value of the type - property of a nativeDragExit event object.
NativeDragManager — Class in package flash.desktop
- The NativeDragManager class coordinates drag-and-drop operations.
NativeDragOptions — Class in package flash.desktop
- The NativeDragOptions class defines constants for the names of drag-and-drop actions allowed in a drag-and-drop operation.
nativeDragOver — Event in class flash.display.InteractiveObject
- - Dispatched by an InteractiveObject continually while a drag gesture remains within its - - boundary.
NATIVE_DRAG_OVER — Constant static property in class flash.events.NativeDragEvent
- NativeDragEvent.NATIVE_DRAG_OVER defines the value of the type - property of a nativeDragOver event object.
nativeDragStart — Event in class flash.display.InteractiveObject
- - Dispatched at the beginning of a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.
NATIVE_DRAG_START — Constant static property in class flash.events.NativeDragEvent
- NativeDragEvent.NATIVE_DRAG_START defines the value of the type - property of a nativeDragStart event object.
nativeDragUpdate — Event in class flash.display.InteractiveObject
- - Dispatched during a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.
NATIVE_DRAG_UPDATE — Constant static property in class flash.events.NativeDragEvent
- NativeDragEvent.NATIVE_DRAG_UPDATE defines the value of the - type property of a nativeDragUpdate event object.
NativeMenu — Class in package flash.display
- - The NativeMenu class contains methods and properties for defining native menus.
NativeMenu() — Constructor in class flash.display.NativeMenu
- - Creates a new NativeMenu object.
NativeMenuItem — Class in package flash.display
- - The NativeMenuItem class represents a single item in a menu.
NativeMenuItem(label:String, isSeparator:Boolean) — Constructor in class flash.display.NativeMenuItem
- - Creates a new NativeMenuItem object.
nativePath — Property in class flash.filesystem.File
- - The full path in the host operating system representation.
NativeProcess — Class in package flash.desktop
- The NativeProcess class provides command line integration and general launching capabilities.
NativeProcess() — Constructor in class flash.desktop.NativeProcess
- Constructs an uninitialized NativeProcess object.
NativeProcessExitEvent — Class in package flash.events
- This event is dispatched by the NativeProcess object when the process exits.
NativeProcessExitEvent(type:String, bubbles:Boolean, cancelable:Boolean, exitCode:Number) — Constructor in class flash.events.NativeProcessExitEvent
- Creates a NativeProcessExitEvent which contains specific information regarding a NativeProcess's exit code -
NativeProcessStartupInfo — Class in package flash.desktop
- This class provides the basic information used to start a process on the host operating system.
NativeProcessStartupInfo() — Constructor in class flash.desktop.NativeProcessStartupInfo
- Constructs an empty NativeProcessStartupInfo object.
nativeWindow — Property in class flash.display.Stage
- A reference to the NativeWindow object containing this Stage.
NativeWindow — Class in package flash.display
- - The NativeWindow class provides an interface for creating and controlling native desktop windows.
NativeWindow(initOptions:flash.display:NativeWindowInitOptions) — Constructor in class flash.display.NativeWindow
- - Creates a new NativeWindow instance and a corresponding operating system window.
NativeWindowBoundsEvent — Class in package flash.events
- A NativeWindow object dispatches a NativeWindowBoundsEvent object when the size or location - of the window changes.
NativeWindowBoundsEvent(type:String, bubbles:Boolean, cancelable:Boolean, beforeBounds:flash.geom:Rectangle, afterBounds:flash.geom:Rectangle) — Constructor in class flash.events.NativeWindowBoundsEvent
- Creates an Event object with specific information relevant to window bounds events.
NativeWindowDisplayState — Final class in package flash.display
- The NativeWindowDisplayState class defines constants for the names of the window display states.
NativeWindowDisplayStateEvent — Class in package flash.events
- A NativeWindow object dispatches events of the NativeWindowDisplayStateEvent class when the window - display state changes.
NativeWindowDisplayStateEvent(type:String, bubbles:Boolean, cancelable:Boolean, beforeDisplayState:String, afterDisplayState:String) — Constructor in class flash.events.NativeWindowDisplayStateEvent
- Creates an Event object with specific information relevant to window display state events.
NativeWindowInitOptions — Class in package flash.display
- The NativeWindowInitOptions class defines the initialization options - used to construct a new NativeWindow instance.
NativeWindowInitOptions() — Constructor in class flash.display.NativeWindowInitOptions
- Creates a new NativeWindowInitOptions object.
NativeWindowRenderMode — Final class in package flash.display
- The NativeWindowRenderMode class defines constants for the renderMode property of the - NativeWindowInitOptions object used to create a native window.
NativeWindowResize — Final class in package flash.display
-The NativeWindowResize class defines constants for the possible values - of the edgeOrCorner parameter of the NativeWindow - startResize() method.
NativeWindowSystemChrome — Final class in package flash.display
- The NativeWindowSystemChrome class defines constants for the systemChrome - property of the NativeWindowInitOptions object used to create a native window.
NativeWindowType — Final class in package flash.display
- The NativeWindowType class defines constants for the type property of the - NativeWindowInitOptions object used to create a native window.
navigateInSystemBrowser — Property in class flash.html.HTMLLoader
navigateToURL(request, window) — Package function in flash.net
- Opens or replaces a window in the application that contains the Flash Player container - (usually a browser).
nearEquals(toCompare:flash.geom:Vector3D, tolerance:Number, allFour:Boolean) — Method in class flash.geom.Vector3D
- Compares the elements of the current Vector3D object with the elements of a specified - Vector3D object to determine whether they are nearly equal.
NEAREST — Constant static property in class flash.display3D.Context3DTextureFilter
- Use nearest neighbor sampling when upsampling textures - (gives a pixelated, sharp mosaic look).
NEAREST — Constant static property in class flash.net.NetGroupReceiveMode
- Specifies that this node accepts local messages from neighbors that send messages to group - addresses that don't match this node's address exactly.
nearID — Property in class flash.net.NetConnection
- The identifier of this Flash Player or Adobe AIR instance for this NetConnection instance.
nearNonce — Property in class flash.net.NetConnection
- A value chosen substantially by this Flash Player or Adobe AIR instance, unique to this connection.
nearNonce — Property in class flash.net.NetStream
- For RTMFP and RTMPE connections, a value chosen substantially by this end of the stream, unique to this connection.
needsSoftKeyboard — Property in class flash.display.InteractiveObject
- - Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - - when this InteractiveObject instance receives focus.
negate() — Method in class flash.geom.Vector3D
- Sets the current Vector3D object to its inverse.
NEGATIVE — Constant static property in class flash.display.TriangleCulling
- Specifies culling of all triangles facing toward the current view point.
negativeCurrencyFormat — Property in class flash.globalization.CurrencyFormatter
- A numeric value that indicates a formatting pattern for negative currency amounts.
NEGATIVE_INFINITY — Constant static property in class float
- - Specifies the single-precision IEEE-754 value representing negative infinity.
NEGATIVE_INFINITY — Constant static property in class Number
- - Specifies the IEEE-754 value representing negative infinity.
negativeNumberFormat — Property in class flash.globalization.NumberFormatter
- A numeric value that indicates a formatting pattern for negative numbers.
negativeSymbol — Property in class flash.globalization.CurrencyFormatter
- The negative symbol used when formatting negative currency amounts.
negativeSymbol — Property in class flash.globalization.NumberFormatter
- The negative symbol to be used when formatting negative values.
neighborCount — Property in class flash.net.NetGroup
- Specifies the number of group members to which this node is directly connected.
NELLYMOSER — Constant static property in class flash.media.SoundCodec
- Specifies that the Nellymoser codec be used for compressing audio.
NetConnection — Class in package flash.net
- The NetConnection class creates a two-way connection between a client and a server.
NetConnection() — Constructor in class flash.net.NetConnection
- Creates a NetConnection object.
NetDataEvent — Class in package flash.events
-A NetStream object dispatches a NetDataEvent object when a data message is encountered in the media stream.
NetDataEvent(type:String, bubbles:Boolean, cancelable:Boolean, timestamp:Number, info:Object) — Constructor in class flash.events.NetDataEvent
- Creates an event object that contains information about media data events.
NetGroup — Class in package flash.net
-Instances of the NetGroup class represent membership in an RTMFP group.
NetGroup(connection:flash.net:NetConnection, groupspec:String) — Constructor in class flash.net.NetGroup
- Constructs a NetGroup on the specified NetConnection object and joins it to the group - specified by groupspec.
NetGroupInfo — Final class in package flash.net
-The NetGroupInfo class specifies various Quality of Service (QoS) statistics -related to a NetGroup object's underlying RTMFP Peer-to-Peer data transport.
NetGroupReceiveMode — Final class in package flash.net
-The NetGroupReceiveMode class is an enumeration of constant values used for the receiveMode property -of the NetGroup class.
NetGroupReplicationStrategy — Final class in package flash.net
-The NetGroupReplicationStrategy class is an enumeration of constant values used in setting the replicationStrategy property -of the NetGroup class.
NetGroupSendMode — Final class in package flash.net
-The NetGroupSendMode class is an enumeration of constant values used for the sendMode parameter of the NetGroup.sendToNeighbor() -method.
NetGroupSendResult — Final class in package flash.net
-The NetGroupSendResult class is an enumeration of constant values used for the return value of the -Directed Routing methods associated with a NetGroup instance.
NetMonitor — Class in package flash.net
- The NetMonitor class maintains a list of NetStream objects.
NetMonitorEvent — Class in package flash.events
- A NetMonitor object dispatches NetMonitorEvent objects when a NetStream object is created.
NetMonitorEvent(type:String, bubbles:Boolean, cancelable:Boolean, netStream:flash.net:NetStream) — Constructor in class flash.events.NetMonitorEvent
- Creates an event object that contains information about netStreamCreate events.
netStatus — Event in class flash.net.NetConnection
- Dispatched when a NetConnection object is reporting its status or error condition.
netStatus — Event in class flash.net.NetGroup
- Dispatched when a NetGroup object is reporting its status or error condition.
netStatus — Event in class flash.net.NetStream
- Dispatched when a NetStream object is reporting its status or error condition.
netStatus — Event in class flash.net.SharedObject
- Dispatched when a SharedObject instance is reporting its status or error condition.
NET_STATUS — Constant static property in class flash.events.NetStatusEvent
- Defines the value of the type property of a netStatus event object.
NetStatusEvent — Class in package flash.events
-A NetConnection, NetStream, or SharedObject object dispatches NetStatusEvent objects when a it reports its status.
NetStatusEvent(type:String, bubbles:Boolean, cancelable:Boolean, info:Object) — Constructor in class flash.events.NetStatusEvent
- Creates an Event object that contains information about netStatus events.
netstream — Property in class flash.events.DRMAuthenticateEvent
- The NetStream object that initiated this event.
netStream — Property in class flash.events.NetMonitorEvent
- The new NetStream object.
NetStream — Class in package flash.net
- The NetStream class opens a one-way streaming channel over a NetConnection.
NetStream(connection:flash.net:NetConnection, peerID:String) — Constructor in class flash.net.NetStream
- Creates a stream that you can use to play media files and send data over a NetConnection object.
NetStreamAppendBytesAction — Final class in package flash.net
-The NetStreamAppendBytesAction class is an enumeration of the constants you can pass to the NetStream.appendBytesAction() method.
netStreamCreate — Event in class flash.net.NetMonitor
- Dispatched when a new NetStream object is created within the security context of this NetMonitor instance.
NET_STREAM_CREATE — Constant static property in class flash.events.NetMonitorEvent
- The NetMonitorEvent.NET_STREAM_CREATE constant defines the value of the type property of an netStreamCreate event object.
NetStreamInfo — Final class in package flash.net
- The NetStreamInfo class specifies the various Quality of Service (QOS) statistics and other information related to a NetStream object - and the underlying streaming buffer for audio, video, and data.
NetStreamMulticastInfo — Final class in package flash.net
-The NetStreamMulticastInfo class specifies various Quality of Service (QoS) statistics -related to a NetStream object's underlying RTMFP Peer-to-Peer and IP Multicast stream transport.
NetStreamPlayOptions — Dynamic class in package flash.net
- The NetStreamPlayOptions class specifies the various options that can be passed - to the NetStream.play2() method.
NetStreamPlayOptions() — Constructor in class flash.net.NetStreamPlayOptions
- Creates a NetStreamPlayOptions object to specify the options that are passed to the NetStream.play2() method.
NetStreamPlayTransitions — Class in package flash.net
- The NetStreamPlayTransitions class specifies the valid strings that you can use with the - NetStreamPlayOptions.transition property.
networkChange — Event in class flash.desktop.NativeApplication
- - Dispatched when either a new network connection becomes available or - - an existing network connection is lost.
networkChange — Event in class flash.net.NetworkInfo
- - Dispatched when the network interfaces have changed.
NETWORK_CHANGE — Constant static property in class flash.events.Event
- The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
networkIdleTimeout — Static property in class flash.net.drm.DRMManager
networkInfo — Static property in class flash.net.NetworkInfo
- - The singleton instance of the NetworkInfo object.
NetworkInfo — Class in package flash.net
- - The NetworkInfo class provides information about the network - - interfaces on a computer.
NetworkInterface — Class in package flash.net
- The NetworkInterface class describes a network interface.
NEVER — Constant static property in class flash.display.PixelSnapping
- A constant value used in the pixelSnapping property of a Bitmap object - to specify that no pixel snapping occurs.
NEVER — Constant static property in class flash.display3D.Context3DCompareMode
- The comparison never evaluates as true.
NEVER — Constant static property in class flash.security.ReferencesValidationSetting
- Never check references.
NEVER — Constant static property in class flash.security.RevocationCheckSettings
- Do not check certificate revocation.
NEVER — Constant static property in class flash.text.StageTextClearButtonMode
- StageText clearButton is never shown -
new — Operator
Instantiates a class instance.
NEW — Constant static property in class flash.system.WorkerState
- This state indicates that an object that represents the new worker has - been created, but the worker is not executing code.
NEW_TAI_LUE — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the New Tai Lue digit set.
next(prefetch:int, responder:flash.net:Responder) — Method in class flash.data.SQLStatement
- Retrieves the next portion of a SELECT statement's result set.
NEXT — Constant static property in class flash.text.ReturnKeyLabel
- Use the label, "Next".
NEXT — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for skipping to next track or chapter.
NEXT_DECREASING — Constant static property in class flash.net.NetGroupSendMode
- Specifies the neighbor with the nearest group address in the decreasing direction.
nextFrame() — Method in class flash.display.MovieClip
- Sends the playhead to the next frame and stops it.
NEXT_INCREASING — Constant static property in class flash.net.NetGroupSendMode
- Specifies the neighbor with the nearest group address in the increasing direction.
nextLine — Property in class flash.text.engine.TextLine
- The next TextLine in the TextBlock, or null if the current line is the last line in the block - or the validity of the line is TextLineValidity.STATIC.
nextname(obj, idx) — Package function in avm2.intrinsics.iteration
- - Get the name of the next property.
nextName(index:int) — Method in class flash.utils.Proxy
nextNameIndex(index:int) — Method in class flash.utils.Proxy
nextRegion — Property in class flash.text.engine.TextLineMirrorRegion
- The next TextLineMirrorRegion in the set derived from the text element, or null if the current region is the last mirror region - in the set.
nextScene() — Method in class flash.display.MovieClip
- Moves the playhead to the next scene of the MovieClip instance.
nextSibling — Property in class flash.xml.XMLNode
- An XMLNode value that references the next sibling in the parent node's child list.
nextvalue(obj, idx) — Package function in avm2.intrinsics.iteration
- - Get the value of the next property.
nextValue(index:int) — Method in class flash.utils.Proxy
NKO — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Nko digit set.
noAutoLabeling — Property in class flash.accessibility.AccessibilityProperties
- If true, disables the Flash Player default auto-labeling system.
NO_BORDER — Constant static property in class flash.display.StageScaleMode
-Specifies that the entire application fill the specified area, without distortion but possibly with -some cropping, while maintaining the original aspect ratio of the application.
NO_CASE — Constant static property in class flash.data.SQLCollationType
- Indicates that the column is defined to use the NOCASE collation sequence.
nodeKind() — Method in class XML
- - Specifies the type of node: text, comment, processing-instruction, - - attribute, or element.
nodeName — Property in class flash.xml.XMLNode
- A string representing the node name of the XMLNode object.
nodeType — Property in class flash.xml.XMLNode
- A nodeType constant value, either XMLNodeType.ELEMENT_NODE for an XML element or - XMLNodeType.TEXT_NODE for a text node.
nodeValue — Property in class flash.xml.XMLNode
- The node value of the XMLDocument object.
NO_ERROR — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that the last operation succeeded without any errors.
NO_ERROR — Constant static property in class flash.media.StageVideoAvailabilityReason
- Stage video is currently available, no errors occurred -
noise(randomSeed:int, low:uint, high:uint, channelOptions:uint, grayScale:Boolean) — Method in class flash.display.BitmapData
- - Fills an image with pixels representing random noise.
noiseSuppressionLevel — Property in class flash.media.Microphone
- Maximum attenuation of the noise in dB (negative number) used for Speex encoder.
NONE — Constant static property in class flash.desktop.NativeDragActions
- Defines the string to use when no action is specified.
NONE — Constant static property in class flash.display.CapsStyle
- - Used to specify no caps in the caps parameter of the - flash.display.Graphics.lineStyle() method.
NONE — Constant static property in class flash.display.FocusDirection
- Indicates that focus object within the interactive object should not change.
NONE — Constant static property in class flash.display.LineScaleMode
- With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line never scales.
NONE — Constant static property in class flash.display.NativeWindowResize
-Used for keyboard resizing on systems (such as Windows) that support keyboard resizing.
NONE — Constant static property in class flash.display.NativeWindowSystemChrome
- No system chrome.
NONE — Constant static property in class flash.display.TriangleCulling
- Specifies no culling.
NONE — Constant static property in class flash.display3D.Context3DTriangleFace
- -
NONE — Constant static property in class flash.globalization.DateTimeStyle
- Specifies that the date or time should not be included in the formatted string.
NONE — Constant static property in class flash.system.TouchscreenType
- The computer or device does not have a supported touchscreen.
NONE — Constant static property in class flash.text.AutoCapitalize
- No automatic capitalization.
NONE — Constant static property in class flash.text.GridFitType
- Doesn't set grid fitting.
NONE — Constant static property in class flash.text.TextFieldAutoSize
- - Specifies that no resizing is to occur.
NONE — Constant static property in class flash.text.engine.BreakOpportunity
- Treats no characters in the ContentElement object as line break opportunities.
NONE — Constant static property in class flash.text.engine.CFFHinting
- No hinting is applied.
NONE — Constant static property in class flash.text.engine.LigatureLevel
- Used to specify no ligatures.
NONE — Constant static property in class flash.ui.KeyboardType
- No physical keyboard is supported.
NONE — Constant static property in class flash.ui.MultitouchInputMode
- Specifies that all user contact with a touch-enabled device is interpreted as a type of mouse event.
nonLinearProcessing — Property in class flash.media.MicrophoneEnhancedOptions
- Enable non-linear processing.
NON_ZERO — Constant static property in class flash.display.GraphicsPathWinding
-Establishes the non-zero winding type.
NO_OP — Constant static property in class flash.display.GraphicsPathCommand
- Represents the default "do nothing" command.
NORMAL — Constant static property in class flash.desktop.SystemIdleMode
- The system follows the normal "idle user" behavior.
NORMAL — Constant static property in class flash.display.BlendMode
-The display object appears in front of the background.
NORMAL — Constant static property in class flash.display.LineScaleMode
- With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line always scales when the object is scaled (the default).
NORMAL — Constant static property in class flash.display.NativeWindowDisplayState
- The normal display state.
NORMAL — Constant static property in class flash.display.NativeWindowType
- A typical window.
NORMAL — Constant static property in class flash.display.StageDisplayState
-Specifies that the Stage is in normal mode.
NORMAL — Constant static property in class flash.text.AntiAliasType
- Sets anti-aliasing to the anti-aliasing that is used in Flash Player 7 and earlier.
NORMAL — Constant static property in class flash.text.TextInteractionMode
- The text field's default interaction mode is NORMAL and it varies across platform.
NORMAL — Constant static property in class flash.text.engine.FontPosture
- Used to indicate normal font posture.
NORMAL — Constant static property in class flash.text.engine.FontWeight
- Used to indicate normal font weight.
NORMAL — Constant static property in class flash.text.engine.RenderingMode
- Sets rendering mode to the rendering mode that is used in Flash Player 7 and earlier.
normalize() — Method in class XML
- - For the XML object and all descendant XML objects, merges adjacent text nodes and - - eliminates empty text nodes.
normalize() — Method in class XMLList
- - Merges adjacent text nodes and eliminates empty text nodes for each - - of the following: all text nodes in the XMLList, all the XML objects - - contained in the XMLList, and the descendants of all the XML objects in - - the XMLList.
normalize(thickness:Number) — Method in class flash.geom.Point
- Scales the line segment between (0,0) and the current point to a set length.
normalize() — Method in class flash.geom.Vector3D
- Converts a Vector3D object to a unit vector by dividing the first three elements - (x, y, z) by the length of the vector.
NO_ROUTE — Constant static property in class flash.net.NetGroupSendResult
- Indicates no neighbor could be found to route the message toward its requested destination.
NO_SCALE — Constant static property in class flash.display.StageScaleMode
-Specifies that the size of the application be fixed, so that it remains unchanged even as the size -of the player window changes.
NOT_EQUAL — Constant static property in class flash.display3D.Context3DCompareMode
- Not equal (!=).
notification — Event in class flash.notifications.RemoteNotifier
- Dispatched in response to a new notification received by the application.
NOTIFICATION — Constant static property in class flash.desktop.InvokeEventReason
- iOS only; indicates that the InvokeEvent occurred because the application was invoked on receiving a remote notification - -
NOTIFICATION — Constant static property in class flash.events.RemoteNotificationEvent
- Defines the value of the type property of a RemoteNotificationEvent event object.
NotificationStyle — Final class in package flash.notifications
- The NotificationStyle class defines constants for the styles of notifications supported by RemoteNotifier class.
notificationStyles — Property in class flash.notifications.RemoteNotifierSubscribeOptions
- Specifies the vector string of all the notification styles you need to register at once.
NotificationType — Final class in package flash.desktop
- The NotificationType class defines constants for use in the priority - parameter of the DockIcon bounce() method and the type - parameter of the NativeWindow notifyUser() method.
notify() — Method in class flash.concurrent.Condition
- - Specifes that the condition that this Condition object represents has - - been satisfied and that ownership of the mutex will be returned to the - - next worker (if any) that's waiting on this condition.
notifyAll() — Method in class flash.concurrent.Condition
- - Specifies that the condition that this Condition object represents has - - been satisfied and that ownership of the mutex will be returned to all - - workers that are waiting on this condition.
notifyUser(type:String) — Method in class flash.display.NativeWindow
- - Triggers a visual cue through the operating system that an event of - - interest has occurred.
NOT_YET_VALID — Constant static property in class flash.security.CertificateStatus
- The certificate is not yet valid.
null — Statement
A special value that can be assigned to variables or returned by a function if no data was provided.
Null — Special Type
A special data type that represents the lack of a value.
Number — Final class in Top Level
- - A data type representing an IEEE-754 double-precision floating-point number.
Number(expression) — Package function in Top Level
- - Converts a given value to a Number value.
Number(num:Object) — Constructor in class Number
- - Creates a Number object with the specified value.
NUMBER — Constant static property in class flash.text.SoftKeyboardType
-

A numeric keypad designed for PIN entry.

NUMBER_0 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the 0 key (48).
NUMBER_1 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the 1 key (49).
NUMBER_2 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the 2 key (50).
NUMBER_3 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the 3 key (51).
NUMBER_4 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the 4 key (52).
NUMBER_5 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the 5 key (53).
NUMBER_6 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the 6 key (54).
NUMBER_7 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the 7 key (55).
NUMBER_8 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the 8 key (56).
NUMBER_9 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the 9 key (57).
NumberFormatter — Final class in package flash.globalization
- The NumberFormatter class provides locale-sensitive formatting and parsing of numeric values.
NumberFormatter(requestedLocaleIDName:String) — Constructor in class flash.globalization.NumberFormatter
- Constructs a new NumberFormatter object to format numbers according to - the conventions of a given locale.
numberOfSeats — Property in class air.system.License
- - Number of developer seats for this licensee (only available after the - - details have been checked online).
numberOfVouchersReturned — Property in class flash.events.DRMReturnVoucherCompleteEvent
- The number of vouchers that matches the criterion passed into DRMManager.returnVoucher() and subsequently returned.
NUMBER_OVERFLOW_ERROR — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that an operation resulted a value that exceeds a specified numeric type.
NumberParseResult — Final class in package flash.globalization
- A data structure that holds information about a number that was extracted by parsing a string.
NumberParseResult(value:Number, startIndex:int, endIndex:int) — Constructor in class flash.globalization.NumberParseResult
- Constructs a number parse result object.
numChildren — Property in class flash.display.DisplayObjectContainer
- Returns the number of children of this object.
numChildren — Property in class flash.display.Stage
- Returns the number of children of this object.
numControls — Property in class flash.ui.GameInputDevice
- Returns the number of controls on this device.
numDevices — Static property in class flash.ui.GameInput
- Provides the number of connected input devices.
NUMERIC — Constant static property in class Array
- - Specifies numeric (instead of character-string) sorting for the Array class sorting methods.
numericComparison — Property in class flash.globalization.Collator
- Controls how numeric values embedded in strings are handled during string comparison.
numFrames — Property in class flash.display.Scene
- The number of frames in the scene.
numItems — Property in class flash.display.NativeMenu
- - The number of NativeMenuItem objects in this menu.
numItems — Property in class flash.ui.ContextMenu
- The number of items in this menu.
numLines — Property in class flash.text.TextField
- - Defines the number of text lines in a multiline text field.
numLock — Static property in class flash.ui.Keyboard
- - Specifies whether the Num Lock key is activated (true) or not (false).
NUMPAD — Constant static property in class flash.ui.Keyboard
- - Constant associated with the pseudo-key code for the the number pad (21).
NUM_PAD — Constant static property in class flash.ui.KeyLocation
- Indicates the key activation originated on the numeric keypad or with a virtual key corresponding - to the numeric keypad.
NUMPAD_0 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the number 0 key on the number pad (96).
NUMPAD_1 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the number 1 key on the number pad (97).
NUMPAD_2 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the number 2 key on the number pad (98).
NUMPAD_3 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the number 3 key on the number pad (99).
NUMPAD_4 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the number 4 key on the number pad (100).
NUMPAD_5 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the number 5 key on the number pad (101).
NUMPAD_6 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the number 6 key on the number pad (102).
NUMPAD_7 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the number 7 key on the number pad (103).
NUMPAD_8 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the number 8 key on the number pad (104).
NUMPAD_9 — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the number 9 key on the number pad (105).
NUMPAD_ADD — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the addition key on the number pad (107).
NUMPAD_DECIMAL — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the decimal key on the number pad (110).
NUMPAD_DIVIDE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the division key on the number pad (111).
NUMPAD_ENTER — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Enter key on the number pad (108).
NUMPAD_MULTIPLY — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the multiplication key on the number pad (106).
NUMPAD_SUBTRACT — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the subtraction key on the number pad (109).
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/all-index-O.html b/html-docs/all-index-O.html deleted file mode 100644 index e882b16..0000000 --- a/html-docs/all-index-O.html +++ /dev/null @@ -1,960 +0,0 @@ - - - - - -O Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
O — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the O key (79).
Object — Dynamic class in Top Level
- - The Object class is at the root of the ActionScript - - runtime class hierarchy.
Object(value) — Package function in Top Level
- - Every value in ActionScript 3.0 is an object, which means that calling Object() on a value returns that value.
Object() — Constructor in class Object
- - Creates an Object object and stores a reference to the object's constructor method in the object's constructor property.
objectEncoding — Property in class air.security.Digest
- Used to determine whether the AMF3 or AMF0 format is used when writing binary data using the - writeObject() method.
objectEncoding — Property in class flash.filesystem.FileStream
- Specifies whether the AMF3 or AMF0 format is used when writing or reading binary data by using the - readObject() or writeObject() method.
objectEncoding — Property in class flash.net.NetConnection
- The object encoding for this NetConnection instance.
objectEncoding — Property in class flash.net.NetStream
- The object encoding (AMF version) for this NetStream object.
objectEncoding — Property in class flash.net.SharedObject
- The object encoding (AMF version) for this shared object.
objectEncoding — Property in class flash.net.Socket
- Controls the version of AMF used when writing or reading an object.
objectEncoding — Property in class flash.net.URLStream
- Controls the version of Action Message Format (AMF) used when writing or reading an object.
objectEncoding — Property in class flash.utils.ByteArray
- - Used to determine whether the ActionScript 3.0, ActionScript 2.0, or ActionScript 1.0 format should be - - used when writing to, or reading from, a ByteArray instance.
objectEncoding — Property in interface flash.utils.IDataInput
- - Used to determine whether the AMF3 or AMF0 format is used when writing or reading binary data using the - - readObject() method.
objectEncoding — Property in interface flash.utils.IDataOutput
- - Used to determine whether the AMF3 or AMF0 format is used when writing or reading binary data using the - - writeObject() method.
ObjectEncoding — Final class in package flash.net
- - The ObjectEncoding class is used in defining serialization settings in classes - - that serialize objects (such as FileStream, NetStream, NetConnection, SharedObject, - - and ByteArray) to work with prior versions of ActionScript.
objectID — Static property in class flash.external.ExternalInterface
- Returns the id attribute of the object tag in Internet Explorer, - or the name attribute of the embed tag in Netscape.
object_proxy — Statement
Defines methods of the ObjectProxy class.
objectReplicationEnabled — Property in class flash.net.GroupSpecifier
- Specifies whether object replication is enabled for the NetGroup.
objectReplicationReceiveBytesPerSecond — Property in class flash.net.NetGroupInfo
- Specifies the rate at which the local node is receiving objects from - peers via the Object Replication system, in bytes per second.
objectReplicationSendBytesPerSecond — Property in class flash.net.NetGroupInfo
- Specifies the rate at which objects are being copied from the local node to peers - by the Object Replication system, in bytes per second.
OFF — Constant static property in class flash.display.ColorCorrection
-Turns off color correction regardless of the player host environment.
OFF — Constant static property in class flash.media.MicrophoneEnhancedMode
- All enhanced microphone functionality is off.
OFF — Constant static property in class flash.text.engine.Kerning
- Used to indicate kerning is disabled.
offlineLeaseEndDate — Property in class flash.net.drm.DRMVoucher
- The date and time at which this voucher expires for offline playback.
offlineLeasePeriod — Property in class flash.events.DRMStatusEvent
- The remaining number of days that content can be viewed offline.
offlineLeaseStartDate — Property in class flash.net.drm.DRMVoucher
- The date and time at which this voucher becomes valid for offline playback.
offset(dx:Number, dy:Number) — Method in class flash.geom.Point
- Offsets the Point object by the specified amount.
offset(dx:Number, dy:Number) — Method in class flash.geom.Rectangle
- - Adjusts the location of the Rectangle object, as determined by its top-left corner, - - by the specified amounts.
offset — Property in class flash.net.NetStreamPlayOptions
- The absoulte stream time at which the server switches between streams of different bitrates for Flash Media Server dynamic streaming.
offsetPoint(point:flash.geom:Point) — Method in class flash.geom.Rectangle
- - Adjusts the location of the Rectangle object using a Point object as a parameter.
offsetX — Property in class flash.events.TransformGestureEvent
- The horizontal translation of the display object, since the previous gesture event.
offsetY — Property in class flash.events.TransformGestureEvent
- The vertical translation of the display object, since the previous gesture event.
OL_CHIKI — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Ol Chiki digit set.
oldStreamName — Property in class flash.net.NetStreamPlayOptions
- The name of the old stream or the stream to transition from.
OLD_STYLE — Constant static property in class flash.text.engine.DigitCase
- Used to specify old style digit case.
ON — Constant static property in class flash.display.ColorCorrection
-Turns on color correction regardless of the player host environment, if available.
ON — Constant static property in class flash.text.engine.Kerning
- Used to indicate kerning is enabled.
onCuePoint — Event in class flash.net.NetStream
- Establishes a listener to respond when an embedded cue point is reached while playing a video file.
ON_DEMAND — Constant static property in class flash.system.ImageDecodingPolicy
- Constant; specifies that the image being loaded will be decoded when needed and that the decoded data may be flushed at will by the system.
onDRMContentData — Event in class flash.net.NetStream
- Establishes a listener to respond when AIR extracts DRM content metadata embedded in a media file.
ONE — Constant static property in class flash.display3D.Context3DBlendFactor
- The blend factor is (1,1,1,1).
ONE_MINUS_DESTINATION_ALPHA — Constant static property in class flash.display3D.Context3DBlendFactor
- The blend factor is (1-Da,1-Da,1-Da,1-Da), where Da is - the alpha component of the current color in the color buffer.
ONE_MINUS_DESTINATION_COLOR — Constant static property in class flash.display3D.Context3DBlendFactor
- The blend factor is (1-Dr,1-Dg,1-Db,1-Da), where Dr/g/b/a is - the corresponding component of the current color in the color buffer.
ONE_MINUS_SOURCE_ALPHA — Constant static property in class flash.display3D.Context3DBlendFactor
- The blend factor is (1-Sa,1-Sa,1-Sa,1-Sa), where Sa is - the alpha component of the fragment color computed by the pixel program.
ONE_MINUS_SOURCE_COLOR — Constant static property in class flash.display3D.Context3DBlendFactor
- The blend factor is (1-Sr,1-Sg,1-Sb,1-Sa), where Sr/g/b/a is - the corresponding component of the fragment color computed by the pixel program.
onImageData — Event in class flash.net.NetStream
- Establishes a listener to respond when Flash Player receives image data as a byte array embedded in a media file that is - playing.
ON_LOAD — Constant static property in class flash.system.ImageDecodingPolicy
- Constant; specifies that the image being loaded will be decoded on load, prior to the complete event being sent.
ONLY_WHEN_IN_USE — Constant static property in class flash.permissions.PermissionStatus
- Specifies that the permission has been granted only when App is in use.
onMetaData — Event in class flash.net.NetStream
- Establishes a listener to respond when Flash Player receives descriptive information embedded in the video being played.
onPeerConnect(subscriber:flash.net:NetStream) — Method in class flash.net.NetStream
- Invoked when a peer-publishing stream matches a peer-subscribing stream.
onPlayStatus — Event in class flash.net.NetStream
- Establishes a listener to respond when a NetStream object has completely played a stream.
onSeekPoint — Event in class flash.net.NetStream
- Called synchronously from appendBytes() when the append bytes parser encounters a point that it believes is a seekable - point (for example, a video key frame).
onTextData — Event in class flash.net.NetStream
- Establishes a listener to respond when Flash Player receives text data embedded in a media file that is playing.
onXMPData — Event in class flash.net.NetStream
- Establishes a listener to respond when Flash Player receives information specific to Adobe - Extensible Metadata Platform (XMP) embedded in the video being played.
opaqueBackground — Property in class flash.display.DisplayObject
- Specifies whether the display object is opaque with a certain background color.
open — Event in class flash.data.SQLConnection
- Dispatched when an openAsync() method call's operation - completes successfully.
open(reference:Object, openMode:String, autoCompact:Boolean, pageSize:int, encryptionKey:flash.utils:ByteArray) — Method in class flash.data.SQLConnection
- Opens a synchronous connection to the database file at the specified location in the file system, - or creates and opens a new database file at the location, or creates and opens an - in-memory database.
open() — Method in interface flash.desktop.IFilePromise
- Returns the data provider object.
open — Event in class flash.display.LoaderInfo
- Dispatched when a load operation starts.
open(file:flash.filesystem:File, fileMode:String) — Method in class flash.filesystem.FileStream
- Opens the FileStream object synchronously, pointing to the file specified by the file parameter.
open() — Method in class flash.media.MediaPromise
- Opens the underlying data source and returns the IDataInput instance allowing you to read it.
open — Event in class flash.media.Sound
- Dispatched when a load operation starts.
open — Event in class flash.net.FileReference
- Dispatched when an upload or download operation starts.
open — Event in class flash.net.URLLoader
- Dispatched when the download operation commences following - a call to the URLLoader.load() method.
open — Event in class flash.net.URLStream
- Dispatched when a load operation starts.
open — Event in class flash.system.SystemUpdater
- Dispatched when an update begins.
OPEN — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that either the SQLConnection.open() method or the SQLConnection.openAsync() method was called.
OPEN — Constant static property in class flash.events.Event
- The Event.OPEN constant defines the value of the type property of an open event object.
OPEN — Constant static property in class flash.events.SQLEvent
- The SQLEvent.OPEN constant defines the value of the - type property of a open event object.
OPEN — Constant static property in class flash.system.MessageChannelState
- This state indicates that the message channel is open and available for use.
openAsync(reference:Object, openMode:String, responder:flash.net:Responder, autoCompact:Boolean, pageSize:int, encryptionKey:flash.utils:ByteArray) — Method in class flash.data.SQLConnection
- Opens an asynchronous connection to the database file at the specified location in the file system, - or creates and opens a new database file at the location, or creates and opens an - in-memory database.
openAsync(file:flash.filesystem:File, fileMode:String) — Method in class flash.filesystem.FileStream
- Opens the FileStream object asynchronously, pointing to the file specified by the file parameter.
openedWindows — Property in class flash.desktop.NativeApplication
- - An array containing all the open native windows of this application.
OPEN_URL — Constant static property in class flash.desktop.InvokeEventReason
- Mobile only; indicates that the InvokeEvent occurred because the application was invoked by another application or by the system.
openWithDefaultApplication() — Method in class flash.filesystem.File
- Opens the file in the application registered by the operating system to open this file type.
operation — Property in class flash.errors.SQLError
- A value indicating the operation that was being attempted when the error occurred.
optimumSpacing — Property in class flash.text.engine.SpaceJustifier
- Specifies the optimum spacing (as a multiplier of the width of a normal space) between words to use during justification.
OPTIONS — Constant static property in class flash.net.URLRequestMethod
- Specifies that the URLRequest object is OPTIONS.
orderInBackOf(window:flash.display:NativeWindow) — Method in class flash.display.NativeWindow
- - Sends this window directly behind the specified window.
orderInFrontOf(window:flash.display:NativeWindow) — Method in class flash.display.NativeWindow
- - Brings this window directly in front of the specified window.
orderToBack() — Method in class flash.display.NativeWindow
- - Sends this window behind any other visible windows.
orderToFront() — Method in class flash.display.NativeWindow
- - Brings this window in front of any other visible windows.
organizationalUnitName — Property in class flash.security.X500DistinguishedName
- Returns the DN OrganizationalUnitName attribute.
organizationName — Property in class flash.security.X500DistinguishedName
- Returns the DN OrganizationName attribute.
orientation — Property in class flash.display.Stage
- The current orientation of the stage.
orientation — Property in class flash.printing.PrintJob
- The image orientation for printing.
Orientation3D — Final class in package flash.geom
-The Orientation3D class is an enumeration of constant values for representing the orientation style -of a Matrix3D object.
orientationChange — Event in class flash.display.Stage
- Dispatched by the Stage object when the stage orientation changes.
ORIENTATION_CHANGE — Constant static property in class flash.events.StageOrientationEvent
- The ORIENTATION_CHANGE constant defines the value of the type property of - a orientationChange event object.
orientationChanging — Event in class flash.display.Stage
- Dispatched by the Stage object when the stage orientation begins changing.
ORIENTATION_CHANGING — Constant static property in class flash.events.StageOrientationEvent
- The ORIENTATION_CHANGING constant defines the value of the type property of - a orientationChanging event object.
origin — Property in class flash.media.CameraRollBrowseOptions
- Specifies the origin rect of the object that launched CameraRoll image picker.
ORIGINAL_ONLY — Constant static property in class flash.desktop.ClipboardTransferMode
- The Clipboard object should only return a reference.
ORIGINAL_PREFERRED — Constant static property in class flash.desktop.ClipboardTransferMode
- The Clipboard object should return a reference if available and a copy if not.
originalUrl — Property in class flash.html.HTMLHistoryItem
- The original URL of the HTML page, before any redirects.
ORIYA — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Oriya digit set.
os — Static property in class flash.system.Capabilities
- Specifies the current operating system.
OSMANYA — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Osmanya digit set.
OTHER_EXECUTE — Constant static property in class air.utils.ZipEntry
- - Flag value for other-execute permission - -
OTHER_READ — Constant static property in class air.utils.ZipEntry
- - Flag value for other-read permission - -
OTHER_WRITE — Constant static property in class air.utils.ZipEntry
- - Flag value for other-write permission - -
OTP_SMS — Constant static property in class flash.text.StageTextContentType
- -

Content is a One-Time-Password from an SMS

- - - -
OUTER — Constant static property in class flash.filters.BitmapFilterType
- Defines the setting that applies a filter to the outer area of an object.
output(outString:String) — Static method in class flash.system.System
- - Output a string to the console via 'stdout'.
outputProgress — Event in class flash.filesystem.FileStream
- Signals that buffered data has been written to the file.
outputProgress — Event in class flash.net.Socket
- Dispatched when a socket moves data from its write buffer to the networking transport layer -
OUTPUT_PROGRESS — Constant static property in class flash.events.OutputProgressEvent
- Defines the value of the type property of an outputProgress event object.
OutputProgressEvent — Class in package flash.events
- A FileStream object dispatches OutputProgressEvent objects as pending asynchronous file write operations are - performed.
OutputProgressEvent(type:String, bubbles:Boolean, cancelable:Boolean, bytesPending:Number, bytesTotal:Number) — Constructor in class flash.events.OutputProgressEvent
- Creates an Event object that contains information about output progress events.
outsideCutoff — Property in class flash.text.CSMSettings
- The outside cutoff value, below which densities are set to zero.
OVERLAY — Constant static property in class flash.display.BlendMode
-Adjusts the color of each pixel based on the darkness of the background.
override — Statement
Specifies that a method replaces an inherited method.
overState — Property in class flash.display.SimpleButton
- Specifies a display object that is used as the visual - object for the button over state — the state that the button is in when - the pointer is positioned over the button.
owner — Property in class flash.display.NativeWindow
- - The NativeWindow object that owns this window.
owner — Property in class flash.display.NativeWindowInitOptions
- Specifies the NativeWindow object that should own any windows created with - this NativeWindowInitOptions.
OWNER_EXECUTE — Constant static property in class air.utils.ZipEntry
- - Flag value for owner-execute permission - -
OWNER_READ — Constant static property in class air.utils.ZipEntry
- - Flag value for owner-read permission - -
OWNER_WRITE — Constant static property in class air.utils.ZipEntry
- - Flag value for owner-write permission - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/all-index-P.html b/html-docs/all-index-P.html deleted file mode 100644 index 01013e5..0000000 --- a/html-docs/all-index-P.html +++ /dev/null @@ -1,2211 +0,0 @@ - - - - - -P Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
P — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the P key (80).
package — Statement
Allows you to organize your code into discrete groups that can be imported by other scripts.
PAD — Constant static property in class flash.display.SpreadMethod
-Specifies that the gradient use the pad spread method.
pageDomain — Static property in class flash.system.Security
- The domain portion of the HTML page containing the swf.
PAGE_DOWN — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Page Down key (34).
pageHeight — Property in class flash.printing.PrintJob
- The height of the largest area which can be centered in the actual printable - area on the page, in points.
pageSize — Property in class flash.data.SQLConnection
- Indicates the database page size (in bytes) that was specified when the current database - was originally created (the value that was specified for the pageSize - parameter in the open() or openAsync() call that created the - database).
PAGE_UP — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Page Up key (33).
pageWidth — Property in class flash.printing.PrintJob
- The width of the largest area which can be centered in the actual printable - area on the page, in points.
paintsDefaultBackground — Property in class flash.html.HTMLLoader
paletteMap(sourceBitmapData:flash.display:BitmapData, sourceRect:flash.geom:Rectangle, destPoint:flash.geom:Point, redArray:Array, greenArray:Array, blueArray:Array, alphaArray:Array) — Method in class flash.display.BitmapData
- - Remaps the color channel values in an image that has up to four arrays of color palette data, one - - for each channel.
pan — Property in class flash.media.SoundTransform
- The left-to-right panning of the sound, ranging from -1 (full pan left) - to 1 (full pan right).
pan — Property in class flash.media.StageVideo
- The pan setting for displaying the video, specified as a Point object.
paperArea — Property in class flash.printing.PrintJob
- The bounds of the printer media in points.
paperHeight — Property in class flash.printing.PrintJob
- The overall paper height, in points.
PaperSize — Final class in package flash.printing
-This class provides the available values for the paperSize parameter of -the PrintJob.selectPaperSize() method.
paperWidth — Property in class flash.printing.PrintJob
- The overall paper width, in points.
parameters — Property in class flash.data.SQLStatement
- Serves as an associative array to which you add values for the - parameters specified in the SQL statement's - text property.
parameters — Property in class flash.display.LoaderInfo
- An object that contains name-value pairs that represent the parameters provided - to the loaded SWF file.
parameters — Property in class flash.system.LoaderContext
- An Object containing the parameters to pass to the LoaderInfo object of the content.
parent() — Method in class XML
- - Returns the parent of the XML object.
parent() — Method in class XMLList
- - Returns the parent of the XMLList object if all items in the XMLList object have the same parent.
parent — Property in class flash.display.DisplayObject
- Indicates the DisplayObjectContainer object that contains this display object.
parent — Property in class flash.display.NativeMenu
- - The parent menu.
parent — Property in class flash.filesystem.File
- - The directory that contains the file or directory referenced by this File object.
parent — Property in class flash.net.NetworkInterface
- The NetworkInterface object representing the parent interface (if this interface has a parent).
parentAllowsChild — Property in class flash.display.LoaderInfo
- Expresses the trust relationship from Loader (parent) to the content (child).
parentDomain — Property in class flash.system.ApplicationDomain
- Gets the parent domain of this application domain.
parentNode — Property in class flash.xml.XMLNode
- An XMLNode value that references the parent node of the specified XML object, or returns - null if the node has no parent.
parentSandboxBridge — Property in class flash.display.LoaderInfo
- A object that can be set by code in the Loader object's sandbox to expose properties and methods that can be accessed - by the loaded content's code.
parse(date:String) — Static method in class Date
- - Converts a string representing a date into a number equaling the number of milliseconds - - elapsed since January 1, 1970, UTC.
parse(text:String, reviver:Function) — Static method in class JSON
- - Accepts a JSON-formatted String and returns an ActionScript Object that represents that value.
parse(inputString:String) — Method in class flash.globalization.CurrencyFormatter
- Parses a string into a currency amount and a currency symbol.
parse(parseString:String) — Method in class flash.globalization.NumberFormatter
- Parses a string and returns a NumberParseResult object containing the parsed elements.
parseCSS(CSSText:String) — Method in class flash.text.StyleSheet
- Parses the CSS in CSSText and loads the style sheet with it.
PARSE_ERROR — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that the parsing of a number failed.
parseFloat(str) — Package function in Top Level
- - Converts a string to a floating-point number.
parseInt(str, radix) — Package function in Top Level
- - Converts a string to an integer.
parseNumber(parseString:String) — Method in class flash.globalization.NumberFormatter
- Parses a string that contains only digits and optional whitespace characters and returns a Number.
parseXML(source:String) — Method in class flash.xml.XMLDocument
- Parses the XML text specified in the value parameter - and populates the specified XMLDocument object with the resulting XML tree.
PASSWORD — Constant static property in class flash.text.StageTextContentType
- -

Content is a password

- - - -
passwordPrompt — Property in class flash.events.DRMAuthenticateEvent
- A prompt for a password credential, provided by the server.
paste() — Method in class flash.desktop.NativeApplication
- - Invokes an internal paste command on the focused display object.
paste — Event in class flash.display.InteractiveObject
- - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - - or selects 'Paste' from the text context menu.
paste — Property in class flash.ui.ContextMenuClipboardItems
- Enables or disables the 'Paste' item on the clipboard menu.
PASTE — Constant static property in class flash.events.Event
- The Event.PASTE constant defines the value of the type property of a paste event object.
path — Property in class air.update.events.StatusFileUpdateEvent
- - The nativePath property of - - the update File object specified by the airFile parameter - - in a call to the installFromAIRFile() method.
PATTERN_SYNTAX_ERROR — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that the pattern for formatting a number, date, or time is invalid.
pause() — Method in class flash.net.NetStream
- Pauses playback of a video stream.
pause() — Static method in class flash.system.System
- - Pauses Flash Player or the AIR Debug Launcher (ADL).
PAUSE — Constant static property in class flash.events.ThrottleType
- This constant is used for the status property in the ThrottleEvent class.
PAUSE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for pausing transport mode.
pauseForGCIfCollectionImminent(imminence:Number) — Static method in class flash.system.System
- - Advise the garbage collector that if the collector's imminence exceeds the function's imminence parameter then the - - collector should finish the incremental collection cycle.
pausesLocationUpdatesAutomatically — Property in class flash.sensors.Geolocation
- This property determines whether the geolocation services should pause due to app inactivity - when application goes into background (on iOS).
PCMA — Constant static property in class flash.media.SoundCodec
- Specifies that the G711 A-law codec be used for compressing audio.
PCMU — Constant static property in class flash.media.SoundCodec
- Specifies that the G711 u-law codec be used for compressing audio.
pdfCapability — Static property in class flash.html.HTMLLoader
peerStreams — Property in class flash.net.NetStream
- An object that holds all of the subscribing NetStream instances that are listening to this publishing NetStream instance.
peerToPeerDisabled — Property in class flash.net.GroupSpecifier
- Specifies whether peer-to-peer connections are disabled for the NetGroup or NetStream.
PEN — Constant static property in class flash.events.TouchEventIntent
- The touch event is generated by the primary end of an active stylus or by a pen on a system that can distinguish pen from touch.
PENDING — Constant static property in class flash.net.SharedObjectFlushStatus
- Indicates that the user is being prompted to increase disk space for the shared object - before the flush can occur.
period — Property in class flash.net.drm.DRMPlaybackTimeWindow
- The period of time during which a DRM voucher is valid - (the playback window), in seconds.
PERIOD — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the .
perlinNoise(baseX:Number, baseY:Number, numOctaves:uint, randomSeed:int, stitch:Boolean, fractalNoise:Boolean, channelOptions:uint, grayScale:Boolean, offsets:Array) — Method in class flash.display.BitmapData
- - Generates a Perlin noise image.
PermissionError — Class in package flash.errors
- Permission error is dispatched when the application tries to access a resource - without requesting appropriate permissions.
PermissionError(message:String, id:int) — Constructor in class flash.errors.PermissionError
- Creates a new instance of the PermissionError class.
PermissionEvent — Final class in package flash.events
PermissionEvent(type:String, bubbles:Boolean, cancelable:Boolean, status:String) — Constructor in class flash.events.PermissionEvent
- Creates an PermissionEvent object that contains information about the name of the permission and its status.
permissionManager — Static property in class flash.media.Camera
- - Retrieves the permission manager object for the Camera resource - - -
permissionManager — Static property in class flash.media.Microphone
- Retrieves the permission manager object for the Camera resource -
PermissionManager — Final class in package flash.permissions
- A PermissionManager object provides access to information about operating system permissions for a - restricted resource such as camera or microphone.
permissionStatus — Event in class flash.filesystem.File
- - Dispatched when the application requests permission to access filesystem.
permissionStatus — Static property in class flash.filesystem.File
- - Determine whether the application has been granted the permission to access filesystem.
permissionStatus — Event in class flash.media.Camera
- - Dispatched when the application requests permission to use camera on the device.
permissionStatus — Static property in class flash.media.Camera
- - Determine whether the application has been granted the permission to use camera.
permissionStatus — Event in class flash.media.CameraRoll
- Dispatched when the application requests permission to access camera roll.
permissionStatus — Static property in class flash.media.CameraRoll
- Determine whether the application has been granted the permission to access camera roll.
permissionStatus — Event in class flash.media.CameraUI
- Dispatched when the application requests permission to access Camera UI.
permissionStatus — Static property in class flash.media.CameraUI
- Determine whether the application has been granted the permission to use camera.
permissionStatus — Event in class flash.media.Microphone
- Dispatched when the application requests permission to use Microphone on the device.
permissionStatus — Static property in class flash.media.Microphone
- Determine whether the application has been granted the permission to use Microphone.
permissionStatus — Event in class flash.net.FileReference
- Dispatched when the application requests permission to access filesystem.
permissionStatus — Static property in class flash.net.FileReference
- Determine whether the application has been granted the permission to access filesystem.
permissionStatus — Static property in class flash.net.NetworkInfo
- - Determine whether the application has been granted the permission to access NetworkInfo.
permissionStatus — Event in class flash.permissions.PermissionManager
- Dispatched when the application receives a change in permission from the OS.
permissionStatus — Property in class flash.permissions.PermissionManager
- Determine whether the application has been granted the permission to use resource.
permissionStatus — Event in class flash.sensors.Geolocation
permissionStatus — Static property in class flash.sensors.Geolocation
- Determine whether the application has been granted the permission to use geolocation services.
PermissionStatus — Final class in package flash.permissions
-The PermissionStatus class is an enumeration of constant values that specify the -authorization status of a permission - -
PERMISSION_STATUS — Constant static property in class flash.events.PermissionEvent
perspectiveProjection — Property in class flash.geom.Transform
- Provides access to the PerspectiveProjection object of a three-dimensional display - object.
PerspectiveProjection — Class in package flash.geom
- The PerspectiveProjection class provides an easy way to assign or modify the perspective - transformations of a display object and all of its children.
PerspectiveProjection() — Constructor in class flash.geom.PerspectiveProjection
- Creates an instance of a PerspectiveProjection object.
phase — Property in class flash.events.GestureEvent
- A value from the GesturePhase class indicating the progress of the touch gesture.
PHONE — Constant static property in class flash.text.SoftKeyboardType
-

A keyboard optimized for entering phone numbers.

PHONE_NUMBER — Constant static property in class flash.text.StageTextContentType
- -

Content is a phone number

- - - -
physicalKeyboardType — Static property in class flash.ui.Keyboard
- - Indicates the type of physical keyboard provided by the computer or device, if any.
PI — Constant static property in class Math
- - A mathematical constant for the ratio of the circumference of a circle to its diameter, - - expressed as pi, with a value of 3.141592653589793.
pitch — Property in class flash.events.DeviceRotationEvent
- pitch along the x-axis, measured in degrees.
PIXEL — Constant static property in class flash.text.GridFitType
- Fits strong horizontal and vertical lines to the pixel grid.
pixelAspectRatio — Static property in class flash.system.Capabilities
- Specifies the pixel aspect ratio of the screen.
pixelBounds — Property in class flash.geom.Transform
- A Rectangle object that defines the bounding rectangle of the display object on the stage.
pixelDissolve(sourceBitmapData:flash.display:BitmapData, sourceRect:flash.geom:Rectangle, destPoint:flash.geom:Point, randomSeed:int, numPixels:int, fillColor:uint) — Method in class flash.display.BitmapData
- - Performs a pixel dissolve either from a source image to a destination image or by using the same image.
pixelHinting — Property in class flash.display.GraphicsStroke
- Specifies whether to hint strokes - to full pixels.
pixelSnapping — Property in class flash.display.Bitmap
- Controls whether or not the Bitmap object is snapped to the nearest pixel.
PixelSnapping — Final class in package flash.display
- -The PixelSnapping class is an enumeration of constant values for setting the pixel snapping options -by using the pixelSnapping property of a Bitmap object.
pixelsPerInch — Property in class flash.printing.PrintJobOptions
- Specifies the resolution to use for bitmaps, in pixels per inch.
placeLoadStringContentInApplicationSandbox — Property in class flash.html.HTMLLoader
PLATFORM_API_FAILED — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that an underlying platform API failed for an operation.
play() — Method in class flash.display.MovieClip
- Moves the playhead in the timeline of the movie clip.
play(startTime:Number, loops:int, sndTransform:flash.media:SoundTransform) — Method in class flash.media.Sound
- Generates a new SoundChannel object to play back the sound.
play(... rest) — Method in class flash.net.NetStream
- Plays a media file from a local directory or a web server; plays a media file or a live stream from Flash Media Server.
play — Property in class flash.ui.ContextMenuBuiltInItems
-Lets the user start a paused SWF file (does not appear for a single-frame SWF file).
PLAY — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging play transport mode.
play2(param:flash.net:NetStreamPlayOptions) — Method in class flash.net.NetStream
- Switches seamlessly between files with multiple bit rates and allows a NetStream to resume when a connection is dropped and reconnected.
playbackBytesPerSecond — Property in class flash.net.NetStreamInfo
- Returns the stream playback rate in bytes per second.
playbackTimeWindow — Property in class flash.net.drm.DRMVoucher
- The time period, after the first viewing, during which - the associated content can be viewed or reviewed.
playerType — Static property in class flash.system.Capabilities
- Specifies the type of runtime environment.
PLAYLIST_SIGNING — Constant static property in class flash.security.SignerTrustSettings
- The certificate is trusted for signing playlists.
PLAY_PAUSE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging play/pause transport mode.
PNGEncoderOptions — Final class in package flash.display
- The PNGEncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method.
PNGEncoderOptions(fastCompression:Boolean) — Constructor in class flash.display.PNGEncoderOptions
- Creates a PNGEncoderOptions object, optionally specifying compression settings.
pngImage — Property in class flash.events.WebViewDrawEvent
- The ByteArray object containing the PNG-encoded contents rendered from the StageWebView object.
Point — Class in package flash.geom
- The Point object represents a location in a two-dimensional coordinate system, where x - represents the horizontal axis and y represents the vertical axis.
Point(x:Number, y:Number) — Constructor in class flash.geom.Point
- Creates a new point.
pointAt(pos:flash.geom:Vector3D, at:flash.geom:Vector3D, up:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Rotates the display object so that it faces a specified position.
pointTowards(percent:Number, mat:flash.geom:Matrix3D, pos:flash.geom:Vector3D, at:flash.geom:Vector3D, up:flash.geom:Vector3D) — Static method in class flash.geom.Utils3D
- Interpolates the orientation of an object toward a position.
pointTowardsToOutput(percent:Number, mat:flash.geom:Matrix3D, pos:flash.geom:Vector3D, at:flash.geom:Vector3D, up:flash.geom:Vector3D, output:flash.geom:Matrix3D) — Static method in class flash.geom.Utils3D
- Interpolates the orientation of an object toward a position.
poisonStrings — Static property in class flash.system.System
- - Sets a flag to poison the memory used by any String object when it is garbage collected.
polar(len:Number, angle:Number) — Static method in class flash.geom.Point
- Converts a pair of polar coordinates to a Cartesian point coordinate.
polarToOutput(len:Number, angle:Number, output:flash.geom:Point) — Static method in class flash.geom.Point
- Converts a pair of polar coordinates to a Cartesian point coordinate.
policies — Property in class flash.events.DRMStatusEvent
- A custom object of the DRM status event.
policies — Property in class flash.net.drm.DRMVoucher
- The custom application-defined rights, if any, defined by the customer when packaging the content.
policyID — Property in class flash.events.DRMReturnVoucherCompleteEvent
- The policyID that was passed into the DRMManager.returnVoucher() call.
policyID — Property in class flash.events.DRMReturnVoucherErrorEvent
- The policy ID that was passed into the returnVoucher() call that resulted in this error.
policyID — Property in class flash.net.drm.DRMVoucher
- The unique policy ID for this voucher.
policyID — Property in class flash.net.drm.VoucherAccessInfo
A unique identifier for the policy that this VoucherAccessInfo represents.
pop() — Method in class Array
- - Removes the last element from an array and returns the value of that element.
pop() — Method in class Vector
- Removes the last element from the Vector and returns that element.
port — Property in class flash.net.dns.SRVRecord
- The port the service is using on the server.
PORTRAIT — Constant static property in class flash.display.StageAspectRatio
- Specifies a device orientation that presents a portrait UI -
PORTRAIT — Constant static property in class flash.printing.PrintJobOrientation
- The portrait (vertical) image orientation for printing.
position — Property in class flash.events.SampleDataEvent
- The position of the data in the audio stream.
position — Property in class flash.filesystem.FileStream
- The current position in the file.
position — Property in class flash.geom.Matrix3D
- A Vector3D object that holds the position, the 3D coordinate (x,y,z) of a display object - within the transformation's frame of reference.
position — Property in class flash.media.Camera
- - Specifies the side of a device on which the camera is located.
position — Property in class flash.media.SoundChannel
- When the sound is playing, the position property indicates in milliseconds the current point - that is being played in the sound file.
position — Property in class flash.text.engine.TabStop
- The position of the tab stop, in pixels, relative to the start of the text line.
position — Property in class flash.utils.ByteArray
- - Moves, or returns the current position, in bytes, of the file - - pointer into the ByteArray object.
POSITIVE — Constant static property in class flash.display.TriangleCulling
- Specifies culling of all triangles facing away from the current view point.
positiveCurrencyFormat — Property in class flash.globalization.CurrencyFormatter
- A numeric value that indicates a formatting pattern for positive currency amounts.
POSITIVE_INFINITY — Constant static property in class float
- - Specifies the single-prevision IEEE-754 value representing positive infinity.
POSITIVE_INFINITY — Constant static property in class Number
- - Specifies the IEEE-754 value representing positive infinity.
POSSIBLY_INVALID — Constant static property in class flash.text.engine.TextLineValidity
- Specifies that the text line is possibly invalid.
post(message:Object) — Method in class flash.net.NetGroup
- Sends a message to all members of a group.
POST — Constant static property in class flash.net.URLRequestMethod
- Specifies that the URLRequest object is a POST.
postingEnabled — Property in class flash.net.GroupSpecifier
- Specifies whether posting is enabled for the NetGroup.
postingReceiveControlBytesPerSecond — Property in class flash.net.NetGroupInfo
- Specifies the rate at which the local node is receiving posting control overhead messages from peers, in bytes per second.
postingReceiveDataBytesPerSecond — Property in class flash.net.NetGroupInfo
- Specifies the rate at which the local node is receiving posting data from - peers, in bytes per second.
postingSendControlBytesPerSecond — Property in class flash.net.NetGroupInfo
- Specifies the rate at which the local node is sending posting control overhead messages to peers, in bytes per second.
postingSendDataBytesPerSecond — Property in class flash.net.NetGroupInfo
- Specifies the rate at which the local node is sending posting data to - peers, in bytes per second.
postMessage(message:String) — Method in class flash.media.StageWebView
- - Posts a message to the HTML content within the StageWebView host.
pow(base:Number, pow:Number) — Static method in class Math
- - Computes and returns base to the power of pow.
precisionHint — Property in class flash.display.Shader
- The precision of math operations performed by the shader.
preference — Property in class flash.net.dns.MXRecord
- The priority of the mail exchange identified by this record.
prefix — Property in class Namespace
- - The prefix of the namespace.
prefix — Property in class flash.xml.XMLNode
- The prefix portion of the XML node name.
prefixLength — Property in class flash.net.InterfaceAddress
- The prefix length for this address.
preloadComplete(mainClass:String) — Method in class flash.display.Stage
- Notify to the runtime that a preloader is complete and request to load the main class.
preloadEmbeddedData(param:flash.net:NetStreamPlayOptions) — Method in class flash.net.NetStream
- Extracts any DRM metadata from a locally stored media file.
preparing — Event in class flash.display.NativeMenu
- - Dispatched by the NativeMenu object when a key equivalent is pressed and immediately before the menu is displayed.
preparing — Event in class flash.display.NativeMenuItem
- - Dispatched by this NativeMenuItem object when its key equivalent is pressed and immediately before the containing menu is displayed.
PREPARING — Constant static property in class flash.events.Event
- The Event.PREPARING constant defines the value of the type property of a preparing event object.
prepend(rhs:flash.geom:Matrix3D) — Method in class flash.geom.Matrix3D
- Prepends a matrix by multiplying the current Matrix3D object by another Matrix3D object.
prependChild(value:Object) — Method in class XML
- - Inserts a copy of the provided child object into the XML element before any existing XML - - properties for that element.
prependRotation(degrees:Number, axis:flash.geom:Vector3D, pivotPoint:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Prepends an incremental rotation to a Matrix3D object.
prependScale(xScale:Number, yScale:Number, zScale:Number) — Method in class flash.geom.Matrix3D
- Prepends an incremental scale change along the x, y, and z axes to a Matrix3D object.
prependTranslation(x:Number, y:Number, z:Number) — Method in class flash.geom.Matrix3D
- Prepends an incremental translation, a repositioning along the x, y, - and z axes, to a Matrix3D object.
present() — Method in class flash.display3D.Context3D
- - Displays the back rendering buffer.
preserveAlpha — Property in class flash.filters.ConvolutionFilter
- Indicates if the alpha channel is preserved without the filter effect - or if the convolution filter is applied - to the alpha channel as well as the color channels.
PressAndTapGestureEvent — Class in package flash.events
- The PressAndTapGestureEvent class lets you handle press-and-tap gesture on touch-enabled devices.
PressAndTapGestureEvent(type:String, bubbles:Boolean, cancelable:Boolean, phase:String, localX:Number, localY:Number, tapLocalX:Number, tapLocalY:Number, ctrlKey:Boolean, altKey:Boolean, shiftKey:Boolean, commandKey:Boolean, controlKey:Boolean) — Constructor in class flash.events.PressAndTapGestureEvent
- Creates an Event object that contains information about complex multi-touch events, such as - a user raising a context-sensitive popup menu.
pressure — Property in class flash.events.TouchEvent
- A value between 0.0 and 1.0 indicating force of the contact with the device.
prettyIndent — Static property in class XML
- - Determines the amount of indentation applied by - - the toString() and toXMLString() methods when - - the XML.prettyPrinting property is set to true.
prettyPrinting — Static property in class XML
- - Determines whether the toString() - - and toXMLString() methods normalize white space characters between some tags.
preventBackup — Property in class flash.filesystem.File
- - Indicates whether or not the runtime prevents this File object from being backed up to the cloud.
preventBackup — Static property in class flash.net.SharedObject
- Specifies whether or not local shared objects will be backed up on the iOS cloud backup service.
preventDefault() — Method in class flash.events.Event
- Cancels an event's default behavior if that behavior can be canceled.
prevFrame() — Method in class flash.display.MovieClip
- Sends the playhead to the previous frame and stops it.
PREVIOUS — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for skipping to previous track or chapter.
previousApplicationStorageDirectory — Property in class air.update.ApplicationUpdater
- - The previous location of the application storage directory, if it changed - - after an update.
previousApplicationStorageDirectory — Property in class air.update.ApplicationUpdaterUI
- - The previous location of the application storage directory, if it changed - - after an update.
previousLine — Property in class flash.text.engine.TextLine
- The previous TextLine in the TextBlock, or null if the line is the first line in the block - or the validity of the line is TextLineValidity.STATIC.
previousRegion — Property in class flash.text.engine.TextLineMirrorRegion
- The previous TextLineMirrorRegion in the set derived from the text element, or null if the current region is the first mirror - region in the set.
previousSibling — Property in class flash.xml.XMLNode
- An XMLNode value that references the previous sibling in the parent node's child list.
previousVersion — Property in class air.update.ApplicationUpdater
- - The previous version of the application.
previousVersion — Property in class air.update.ApplicationUpdaterUI
- - The previous version of the application.
prevScene() — Method in class flash.display.MovieClip
- Moves the playhead to the previous scene of the MovieClip instance.
primaryKey — Property in class flash.data.SQLColumnSchema
- Indicates whether this column is the primary key column (or one of the primary key columns - in a composite key) for its associated table.
PRINCIPAL_MISMATCH — Constant static property in class flash.security.CertificateStatus
- The certificate common name does not match the expected host name.
print — Property in class flash.ui.ContextMenuBuiltInItems
-Lets the user send the displayed frame image to a printer.
printableArea — Property in class flash.printing.PrintJob
- The bounds of the printer media's printable area in points.
printAsBitmap — Property in class flash.printing.PrintJobOptions
- Specifies whether the content in the print job is printed as a bitmap or as a vector.
printer — Property in class flash.printing.PrintJob
- Gets or sets the printer to use for the current print job.
printers — Static property in class flash.printing.PrintJob
- Provides a list of the available printers as String name values.
PrintJob — Class in package flash.printing
- The PrintJob class lets you create content and print it to one or - more pages.
PrintJob() — Constructor in class flash.printing.PrintJob
- Creates a PrintJob object that you can use to print one or more pages.
PrintJobOptions — Class in package flash.printing
- The PrintJobOptions class contains properties to use with the - options parameter of the PrintJob.addPage() method.
PrintJobOptions(printAsBitmap:Boolean) — Constructor in class flash.printing.PrintJobOptions
- Creates a new PrintJobOptions object.
PrintJobOrientation — Final class in package flash.printing
-This class provides values that are used by the PrintJob.orientation property for the image position of a printed page.
printMethod — Property in class flash.printing.PrintJobOptions
PrintMethod — Final class in package flash.printing
-This class provides values for the PrintJobOptions.printMethod property -to specify the method of printing a page.
PrintUIOptions — Final class in package flash.printing
- The PrintUIOptions class is used to specify options for print dialogs that are displayed to the - user.
PrintUIOptions() — Constructor in class flash.printing.PrintUIOptions
- Creates a new PrintUIOptions object.
PRIORITIZE_LEAST_ADJUSTMENT — Constant static property in class flash.text.engine.JustificationStyle
- Bases justification on either expanding or compressing - the line, whichever gives a result closest to the desired width.
priority — Property in class flash.net.dns.SRVRecord
- The priority of the service host identified by this record.
PRIVACY — Constant static property in class flash.system.SecurityPanel
- When passed to Security.showSettings(), displays the - Privacy Settings panel in Flash Player Settings.
private — Statement
Specifies that a variable, constant, method or namespace is available only to the class that defines it.
privateMemory — Static property in class flash.system.System
- - The entire amount of memory (in bytes) used by an application.
processingInstructions(name:String) — Method in class XML
- - If a name parameter is provided, lists all the children of the XML object - - that contain processing instructions with that name.
processingInstructions(name:String) — Method in class XMLList
- - If a name parameter is provided, lists all the children of the XMLList object that - - contain processing instructions with that name.
PROFESSIONAL — Constant static property in class air.system.License
- - Definition for a Professional license level - -
profile — Property in class flash.display3D.Context3D
- - The feature-support profile in use by this Context3D object.
profile — Property in class flash.media.H264VideoStreamSettings
- Profile used for H.264/AVC encoding.
Program3D — Final class in package flash.display3D
- The Program3D class represents a pair of rendering programs (also called "shaders") - uploaded to the rendering context.
progress — Event in class air.update.ApplicationUpdater
- - Dispatched as the update file is downloaded.
progress — Event in class air.update.ApplicationUpdaterUI
- - Dispatched as the update file is downloaded.
progress — Event in class air.utils.ZipArchive
- - Dispatched during an asynchronous zip/unzip operation.
progress — Event in class flash.display.LoaderInfo
- Dispatched when data is received as the download operation progresses.
progress — Property in class flash.display.ShaderJob
- The progress of a running shader.
progress — Event in class flash.filesystem.FileStream
- Signals the availability of new data on the stream.
progress — Event in class flash.media.MediaPromise
- A MediaPromise object dispatches progress events as the data becomes available.
progress — Event in class flash.media.Sound
- Dispatched when data is received as a load operation progresses.
progress — Event in class flash.net.FileReference
- Dispatched periodically during the file upload or download operation.
progress — Event in class flash.net.URLLoader
- - Dispatched when data is received as the download operation progresses.
progress — Event in class flash.net.URLStream
- - Dispatched when data is received as the download operation progresses.
progress — Event in class flash.system.SystemUpdater
- Dispatched to indicate download progress.
PROGRESS — Constant static property in class flash.events.ProgressEvent
- Defines the value of the type property of a progress event object.
ProgressEvent — Class in package flash.events
- A ProgressEvent object is dispatched when a load operation has begun or a socket has received data.
ProgressEvent(type:String, bubbles:Boolean, cancelable:Boolean, bytesLoaded:Number, bytesTotal:Number) — Constructor in class flash.events.ProgressEvent
- Creates an Event object that contains information about progress events.
project() — Method in class flash.geom.Vector3D
- Divides the value of the x, y, and z properties of the - current Vector3D object by the value of its w property.
projectionCenter — Property in class flash.geom.PerspectiveProjection
- A two-dimensional point representing the center of the projection, the vanishing point for the display object.
projectVector(m:flash.geom:Matrix3D, v:flash.geom:Vector3D) — Static method in class flash.geom.Utils3D
- Using a projection Matrix3D object, projects a Vector3D object from one space coordinate to another.
projectVectors(m:flash.geom:Matrix3D, verts, projectedVerts, uvts) — Static method in class flash.geom.Utils3D
- Using a projection Matrix3D object, projects a Vector of three-dimensional space coordinates (verts) - to a Vector of two-dimensional space coordinates (projectedVerts).
projectVectorToOutput(m:flash.geom:Matrix3D, v:flash.geom:Vector3D, output:flash.geom:Vector3D) — Static method in class flash.geom.Utils3D
- Using a projection Matrix3D object, projects a Vector3D object from one space coordinate to another.
propertyIsEnumerable(name:String) — Method in class Object
- - Indicates whether the specified property exists and is enumerable.
propertyIsEnumerable(p:String) — Method in class XML
- - Checks whether the property p is in the set of properties that can be iterated in a - - for..in statement applied to the XML object.
propertyIsEnumerable(p:String) — Method in class XMLList
- - Checks whether the property p is in the set of properties that can be iterated in a for..in statement - - applied to the XMLList object.
PROPORTIONAL — Constant static property in class flash.text.engine.DigitWidth
- Used to specify proportional digit width.
protected — Statement
Specifies that a variable, constant, method, or namespace is available only to the class that defines it and to any subclasses of that class.
protocol — Property in class air.net.WebSocket
- - The protocol for the WebSocket connection (for the Sec-WebSocket-Protocol field).
protocol — Property in class flash.net.NetConnection
- The protocol used to establish the connection.
prototype — Static property in class Object
- - A reference to the prototype object of a class or function object.
proximityBegin — Event in class flash.display.InteractiveObject
- - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.
PROXIMITY_BEGIN — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a PROXIMITY_BEGIN - touch event object.
proximityEnd — Event in class flash.display.InteractiveObject
- - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.
PROXIMITY_END — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a PROXIMITY_END - touch event object.
proximityMove — Event in class flash.display.InteractiveObject
- - Dispatched when the user moves an active stylus over the screen while remaining within - - the proximity detection threshold.
PROXIMITY_MOVE — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a PROXIMITY_MOVE - touch event object.
proximityOut — Event in class flash.display.InteractiveObject
- - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - - the proximity detection threshold of the screen.
PROXIMITY_OUT — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a PROXIMITY_OUT - touch event object.
proximityOver — Event in class flash.display.InteractiveObject
- - Dispatched when the user moves an active stylus directly above this InteractiveObject - - while remaining within the proximity detection threshold of the screen.
PROXIMITY_OVER — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a PROXIMITY_OVER - touch event object.
proximityRollOut — Event in class flash.display.InteractiveObject
- - Dispatched when the user moves an active stylus away from this InteractiveObject - - and any of its children while remaining within the proximity detection threshold of the screen.
PROXIMITY_ROLL_OUT — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a PROXIMITY_ROLL_OUT - touch event object.
proximityRollOver — Event in class flash.display.InteractiveObject
- - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - - object's tree of descendents in the display list - - (while remaining within the proximity detection threshold of the screen).
PROXIMITY_ROLL_OVER — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a PROXIMITY_ROLL_OVER - touch event object.
Proxy — Class in package flash.utils
proxyType — Property in class flash.net.NetConnection
- Determines which fallback methods are tried if an - initial connection attempt to Flash Media Server fails.
ptrdName — Property in class flash.net.dns.PTRRecord
- The canonical domain name assigned to the query IP address.
PTRRecord — Class in package flash.net.dns
- The PTRRecord class represents a Domain Name System (DNS) PTR resource record containing a canonical domain name.
PTRRecord() — Constructor in class flash.net.dns.PTRRecord
- Creates a PTR resource record.
public — Statement
Specifies that a class, variable, constant or method is available to any caller.
publish(name:String, type:String) — Method in class flash.net.NetStream
- Sends streaming audio, video, and data messages from a client to Flash Media Server, - optionally recording the stream during transmission.
publisherID — Property in class flash.desktop.NativeApplication
- - The publisher ID of this application.
PUNCTUATION — Constant static property in class flash.text.SoftKeyboardType
-

A keyboard optimized for entering punctuation.

- -
push(... rest) — Method in class Array
- - Adds one or more elements to the end of an array and returns the new length of the array.
push(... rest) — Method in class Vector
- Adds one or more elements to the end of the Vector and returns - the new length of the Vector.
PUSH_IN_KINSOKU — Constant static property in class flash.text.engine.JustificationStyle
- Bases justification on compressing kinsoku at the end of the line, - or expanding it if no kinsoku occurs or if that space is insufficient.
PUSH_OUT_ONLY — Constant static property in class flash.text.engine.JustificationStyle
- Bases justification on expanding the line.
PUT — Constant static property in class flash.net.URLRequestMethod
- Specifies that the URLRequest object is a PUT.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/all-index-Q.html b/html-docs/all-index-Q.html deleted file mode 100644 index 1e69a53..0000000 --- a/html-docs/all-index-Q.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - -Q Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
Q — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Q key (81).
QName — Final class in Top Level
- - -QName objects represent qualified names of XML elements and attributes.
QName(uri:Namespace, localName:QName) — Constructor in class QName
- - Creates a QName object with a URI from a Namespace object and a localName from a QName object.
QName(qname:QName) — Constructor in class QName
- - Creates a QName object that is a copy of another QName object.
quality — Property in class flash.display.JPEGEncoderOptions
- A value between 1 and 100, where 1 means the lowest quality and 100 means the highest quality.
quality — Property in class flash.display.Stage
- A value from the StageQuality class that specifies which rendering quality is used.
quality — Property in class flash.filters.BevelFilter
- The number of times to apply the filter.
quality — Property in class flash.filters.BlurFilter
- The number of times to perform the blur.
quality — Property in class flash.filters.DropShadowFilter
- The number of times to apply the filter.
quality — Property in class flash.filters.GlowFilter
- The number of times to apply the filter.
quality — Property in class flash.filters.GradientBevelFilter
- The number of times to apply the filter.
quality — Property in class flash.filters.GradientGlowFilter
- The number of times to apply the filter.
quality — Property in class flash.media.Camera
- - The required level of picture quality, as determined by the amount of compression being applied to each video - - frame.
quality — Property in class flash.media.VideoStreamSettings
- The required level of picture quality, as determined by the amount of compression being applied to each video - frame.
quality — Property in class flash.ui.ContextMenuBuiltInItems
-Lets the user set the resolution of the SWF file at run time.
quantization — Property in class flash.display.JPEGXREncoderOptions
- Specifies the amount of lossy in the compression.
quaternion — Property in class flash.events.DeviceRotationEvent
- Quaternion data for the device rotation in the [w, x, y, z] format.
QUATERNION — Constant static property in class flash.geom.Orientation3D
- The quaternion orientation uses complex numbers.
QUOTE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the ' key (222).
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/all-index-R.html b/html-docs/all-index-R.html deleted file mode 100644 index 3d92c1b..0000000 --- a/html-docs/all-index-R.html +++ /dev/null @@ -1,2856 +0,0 @@ - - - - - -R Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
R — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the R key (82).
RADIAL — Constant static property in class flash.display.GradientType
- Value used to specify a radial gradient fill.
random() — Static method in class Math
- - Returns a pseudo-random number n, where 0 <= n < 1.
RangeError — Dynamic class in Top Level
- - A RangeError exception is thrown when a numeric value is outside the acceptable range.
RangeError(message:String) — Constructor in class RangeError
- - Creates a new RangeError object.
RAREST_FIRST — Constant static property in class flash.net.NetGroupReplicationStrategy
- Specifies that when fetching objects from a neighbor to satisfy a want, the objects with - the fewest replicas among all the neighbors are requested first.
rate — Property in class flash.media.Microphone
- The rate at which the microphone is capturing sound, in kHz.
ratios — Property in class flash.display.GraphicsGradientFill
- An array of color distribution ratios.
ratios — Property in class flash.filters.GradientBevelFilter
- An array of color distribution ratios for the corresponding colors in the - colors array.
ratios — Property in class flash.filters.GradientGlowFilter
- An array of color distribution ratios for the corresponding colors in the - colors array.
rawData — Property in class flash.geom.Matrix3D
- A Vector of 16 Numbers, where every four elements is - a column of a 4x4 matrix.
rawOffset — Property in class TimeZone
- - The standard offset between this time zone and UTC, in milliseconds.
rawText — Property in class flash.text.engine.ContentElement
- A copy of the text in the element, including any U+FDEF characters.
rawTextLength — Property in class flash.text.engine.TextLine
- The length of the raw text in the text block that became the line, - including the U+FDEF characters representing graphic elements - and any trailing spaces, which are part of the line but not are displayed.
READ — Constant static property in class flash.data.SQLMode
- Indicates that the connection is opened in read-only mode.
READ — Constant static property in class flash.filesystem.FileMode
- Used for a file to be opened in read-only mode.
readAhead — Property in class flash.filesystem.FileStream
- The minimum amount of data to read from disk when reading files asynchronously.
readBoolean() — Method in class flash.filesystem.FileStream
- - Reads a Boolean value from the file stream, byte stream, or byte array.
readBoolean() — Method in class flash.net.Socket
- - Reads a Boolean value from the socket.
readBoolean() — Method in class flash.net.URLStream
- - Reads a Boolean value from the stream.
readBoolean() — Method in class flash.utils.ByteArray
- - Reads a Boolean value from the byte stream.
readBoolean() — Method in interface flash.utils.IDataInput
- - Reads a Boolean value from the file stream, byte stream, or byte array.
readByte() — Method in class flash.filesystem.FileStream
- - Reads a signed byte from the file stream, byte stream, or byte array.
readByte() — Method in class flash.net.Socket
- - Reads a signed byte from the socket.
readByte() — Method in class flash.net.URLStream
- - Reads a signed byte from the stream.
readByte() — Method in class flash.utils.ByteArray
- - Reads a signed byte from the byte stream.
readByte() — Method in interface flash.utils.IDataInput
- - Reads a signed byte from the file stream, byte stream, or byte array.
readBytes(bytes:flash.utils:ByteArray, offset:uint, length:uint) — Method in class flash.filesystem.FileStream
- - Reads the number of data bytes, specified by the length parameter, - - from the file stream, byte stream, or byte array.
readBytes(bytes:flash.utils:ByteArray, offset:uint, length:uint) — Method in class flash.net.Socket
- - Reads the number of data bytes specified by the length - - parameter from the socket.
readBytes(bytes:flash.utils:ByteArray, offset:uint, length:uint) — Method in class flash.net.URLStream
- - Reads length bytes of data from the stream.
readBytes(bytes:flash.utils:ByteArray, offset:uint, length:uint) — Method in class flash.utils.ByteArray
- - Reads the number of data bytes, specified by the length parameter, from the byte stream.
readBytes(bytes:flash.utils:ByteArray, offset:uint, length:uint) — Method in interface flash.utils.IDataInput
- - Reads the number of data bytes, specified by the length parameter, - - from the file stream, byte stream, or byte array.
readDouble() — Method in class flash.filesystem.FileStream
- - Reads an IEEE 754 double-precision floating point number from the file stream, byte stream, or byte array.
readDouble() — Method in class flash.net.Socket
- - Reads an IEEE 754 double-precision floating-point number from the socket.
readDouble() — Method in class flash.net.URLStream
- - Reads an IEEE 754 double-precision floating-point number from the stream.
readDouble() — Method in class flash.utils.ByteArray
- - Reads an IEEE 754 double-precision (64-bit) floating-point number from the byte stream.
readDouble() — Method in interface flash.utils.IDataInput
- - Reads an IEEE 754 double-precision floating point number from the file stream, byte stream, or byte array.
readExternal(input:flash.utils:IDataInput) — Method in interface flash.utils.IExternalizable
- - A class implements this method to decode itself from a data stream by calling the methods of the IDataInput - - interface.
readFloat() — Method in class flash.filesystem.FileStream
- - Reads an IEEE 754 single-precision floating point number from the file stream, byte stream, or byte array.
readFloat() — Method in class flash.net.Socket
- - Reads an IEEE 754 single-precision floating-point number from the socket.
readFloat() — Method in class flash.net.URLStream
- - Reads an IEEE 754 single-precision floating-point number from the stream.
readFloat() — Method in class flash.utils.ByteArray
- - Reads an IEEE 754 single-precision (32-bit) floating-point number from the byte stream.
readFloat() — Method in interface flash.utils.IDataInput
- - Reads an IEEE 754 single-precision floating point number from the file stream, byte stream, or byte array.
readGraphicsData(recurse:Boolean) — Method in class flash.display.Graphics
- Queries a Sprite or Shape object (and optionally, its children) for its vector - graphics content.
readInt() — Method in class flash.filesystem.FileStream
- - Reads a signed 32-bit integer from the file stream, byte stream, or byte array.
readInt() — Method in class flash.net.Socket
- - Reads a signed 32-bit integer from the socket.
readInt() — Method in class flash.net.URLStream
- - Reads a signed 32-bit integer from the stream.
readInt() — Method in class flash.utils.ByteArray
- - Reads a signed 32-bit integer from the byte stream.
readInt() — Method in interface flash.utils.IDataInput
- - Reads a signed 32-bit integer from the file stream, byte stream, or byte array.
readMultiByte(length:uint, charSet:String) — Method in class flash.filesystem.FileStream
- - Reads a multibyte string of specified length from the file stream, byte stream, or byte array using the - - specified character set.
readMultiByte(length:uint, charSet:String) — Method in class flash.net.Socket
- - Reads a multibyte string from the byte stream, using the specified character set.
readMultiByte(length:uint, charSet:String) — Method in class flash.net.URLStream
- - Reads a multibyte string of specified length from the byte stream using the - - specified character set.
readMultiByte(length:uint, charSet:String) — Method in class flash.utils.ByteArray
- - Reads a multibyte string of specified length from the byte stream using the - - specified character set.
readMultiByte(length:uint, charSet:String) — Method in interface flash.utils.IDataInput
- - Reads a multibyte string of specified length from the file stream, byte stream, or byte array using the - - specified character set.
readObject() — Method in class flash.filesystem.FileStream
- - Reads an object from the file stream, byte stream, or byte array, encoded in AMF - - serialized format.
readObject() — Method in class flash.net.Socket
- - Reads an object from the socket, encoded in AMF serialized format.
readObject() — Method in class flash.net.URLStream
- - Reads an object from the socket, encoded in Action Message Format (AMF).
readObject() — Method in class flash.utils.ByteArray
- - Reads an object from the byte array, encoded in AMF - - serialized format.
readObject() — Method in interface flash.utils.IDataInput
- - Reads an object from the file stream, byte stream, or byte array, encoded in AMF - - serialized format.
readShort() — Method in class flash.filesystem.FileStream
- - Reads a signed 16-bit integer from the file stream, byte stream, or byte array.
readShort() — Method in class flash.net.Socket
- - Reads a signed 16-bit integer from the socket.
readShort() — Method in class flash.net.URLStream
- - Reads a signed 16-bit integer from the stream.
readShort() — Method in class flash.utils.ByteArray
- - Reads a signed 16-bit integer from the byte stream.
readShort() — Method in interface flash.utils.IDataInput
- - Reads a signed 16-bit integer from the file stream, byte stream, or byte array.
readUnsignedByte() — Method in class flash.filesystem.FileStream
- - Reads an unsigned byte from the file stream, byte stream, or byte array.
readUnsignedByte() — Method in class flash.net.Socket
- - Reads an unsigned byte from the socket.
readUnsignedByte() — Method in class flash.net.URLStream
- - Reads an unsigned byte from the stream.
readUnsignedByte() — Method in class flash.utils.ByteArray
- - Reads an unsigned byte from the byte stream.
readUnsignedByte() — Method in interface flash.utils.IDataInput
- - Reads an unsigned byte from the file stream, byte stream, or byte array.
readUnsignedInt() — Method in class flash.filesystem.FileStream
- - Reads an unsigned 32-bit integer from the file stream, byte stream, or byte array.
readUnsignedInt() — Method in class flash.net.Socket
- - Reads an unsigned 32-bit integer from the socket.
readUnsignedInt() — Method in class flash.net.URLStream
- - Reads an unsigned 32-bit integer from the stream.
readUnsignedInt() — Method in class flash.utils.ByteArray
- - Reads an unsigned 32-bit integer from the byte stream.
readUnsignedInt() — Method in interface flash.utils.IDataInput
- - Reads an unsigned 32-bit integer from the file stream, byte stream, or byte array.
readUnsignedShort() — Method in class flash.filesystem.FileStream
- - Reads an unsigned 16-bit integer from the file stream, byte stream, or byte array.
readUnsignedShort() — Method in class flash.net.Socket
- - Reads an unsigned 16-bit integer from the socket.
readUnsignedShort() — Method in class flash.net.URLStream
- - Reads an unsigned 16-bit integer from the stream.
readUnsignedShort() — Method in class flash.utils.ByteArray
- - Reads an unsigned 16-bit integer from the byte stream.
readUnsignedShort() — Method in interface flash.utils.IDataInput
- - Reads an unsigned 16-bit integer from the file stream, byte stream, or byte array.
readUTF() — Method in class flash.filesystem.FileStream
- - Reads a UTF-8 string from the file stream, byte stream, or byte array.
readUTF() — Method in class flash.net.Socket
- - Reads a UTF-8 string from the socket.
readUTF() — Method in class flash.net.URLStream
- - Reads a UTF-8 string from the stream.
readUTF() — Method in class flash.utils.ByteArray
- - Reads a UTF-8 string from the byte stream.
readUTF() — Method in interface flash.utils.IDataInput
- - Reads a UTF-8 string from the file stream, byte stream, or byte array.
readUTFBytes(length:uint) — Method in class flash.filesystem.FileStream
- - Reads a sequence of UTF-8 bytes from the byte stream or byte array and returns a string.
readUTFBytes(length:uint) — Method in class flash.net.Socket
- - Reads the number of UTF-8 data bytes specified by the length - - parameter from the socket, and returns a string.
readUTFBytes(length:uint) — Method in class flash.net.URLStream
- - Reads a sequence of length UTF-8 - - bytes from the stream, and returns a string.
readUTFBytes(length:uint) — Method in class flash.utils.ByteArray
- - Reads a sequence of UTF-8 bytes specified by the length - - parameter from the byte stream and returns a string.
readUTFBytes(length:uint) — Method in interface flash.utils.IDataInput
- - Reads a sequence of UTF-8 bytes from the byte stream or byte array and returns a string.
reason — Property in class flash.events.AudioOutputChangeEvent
- Reports the reason that triggers this AudioOutputchangeEvent.
reason — Property in class flash.events.InvokeEvent
- The reason for this InvokeEvent.
reason — Constant property in class flash.events.StageVideoAvailabilityEvent
receive() — Method in class flash.net.DatagramSocket
- - Enables this DatagramSocket object to receive incoming packets on the bound IP address and port.
receive(blockUntilReceived:Boolean) — Method in class flash.system.MessageChannel
- Retrieves a single message object from the queue of messages sent - through this message channel.
receiveAudio(flag:Boolean) — Method in class flash.net.NetStream
- Specifies whether incoming audio plays on the stream.
receiveControlBytesPerSecond — Property in class flash.net.NetStreamMulticastInfo
- Specifies the rate at which the local node is receiving control overhead messages from peers, in bytes per second.
receiveDataBytesPerSecond — Property in class flash.net.NetStreamMulticastInfo
- Specifies the rate at which the local node is receiving media data from peers, from the server, and over IP multicast, in bytes per second.
receiveDataBytesPerSecondFromIPMulticast — Property in class flash.net.NetStreamMulticastInfo
- Specifies the rate at which the local node is receiving data from IP Multicast, in bytes per second.
receiveDataBytesPerSecondFromServer — Property in class flash.net.NetStreamMulticastInfo
- Specifies the rate at which the local node is receiving media data from the server, in bytes per second.
receiveMode — Property in class flash.net.NetGroup
- Specifies this node's routing receive mode as one of values in the NetGroupReceiveMode enum class.
receiveVideo(flag:Boolean) — Method in class flash.net.NetStream
- Specifies whether incoming video plays on the stream.
receiveVideoFPS(FPS:Number) — Method in class flash.net.NetStream
- Specifies the frame rate for incoming video.
recompose(components, orientationStyle:String) — Method in class flash.geom.Matrix3D
- Sets the transformation matrix's translation, rotation, and scale settings.
RECORD — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for recording or engaging record transport mode.
recreateTextLine(textLine:flash.text.engine:TextLine, previousLine:flash.text.engine:TextLine, width:Number, lineOffset:Number, fitSomething:Boolean) — Method in class flash.text.engine.TextBlock
- Instructs the text block to re-use an existing text line to create a line of text from its content, beginning at the point - specified by the previousLine parameter and breaking at the point specified by the - width parameter.
rect — Property in class flash.display.BitmapData
- - The rectangle that defines the size and location of the bitmap image.
Rectangle — Class in package flash.geom
- - A Rectangle object is an area defined by its position, as - - indicated by its top-left corner point (x, y) and by its width - - and its height.
Rectangle(x:Number, y:Number, width:Number, height:Number) — Constructor in class flash.geom.Rectangle
- - Creates a new Rectangle object with the top-left corner specified by the x - - and y parameters and with the specified width and height - - parameters.
RectangleTexture — Final class in package flash.display3D.textures
- The Rectangle Texture class represents a 2-dimensional texture uploaded to a rendering context.
RED — Constant static property in class flash.display.BitmapDataChannel
- The red channel.
RED — Constant static property in class flash.ui.Keyboard
- - Red function key button.
redirected — Property in class flash.events.HTTPStatusEvent
- Indicates whether the request was redirected.
redMultiplier — Property in class flash.geom.ColorTransform
- A decimal value that is multiplied with the red channel value.
redOffset — Property in class flash.geom.ColorTransform
- A number from -255 to 255 that is added to the red channel value after it has been - multiplied by the redMultiplier value.
reencrypt — Event in class flash.data.SQLConnection
- Dispatched when a reencrypt() method call's operation completes - successfully.
reencrypt(newEncryptionKey:flash.utils:ByteArray, responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Changes the encryption key of an encrypted database.
REENCRYPT — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.reencrypt() method was called.
REENCRYPT — Constant static property in class flash.events.SQLEvent
- The SQLEvent.REENCRYPT constant defines the value of the - type property of a reencrypt event object.
ReferenceError — Dynamic class in Top Level
- - A ReferenceError exception is thrown when a reference to an undefined property is - - attempted on a sealed (nondynamic) object.
ReferenceError(message:String) — Constructor in class ReferenceError
- - Creates a new ReferenceError object.
referencesStatus — Property in class flash.security.XMLSignatureValidator
- The validity status of the data in the references in the signature SignedInfo - element.
referencesValidationSetting — Property in class flash.security.XMLSignatureValidator
- Specifies the conditions under which references are checked.
ReferencesValidationSetting — Final class in package flash.security
- The ReferencesValidationSetting class defines constants used by the referencesValidationSetting - property of an XMLSignatureValidator object.
REFLECT — Constant static property in class flash.display.SpreadMethod
-Specifies that the gradient use the reflect spread method.
refreshRate — Property in class flash.display.ScreenMode
- The screen refresh rate of the ScreenMode in hertz.
RegExp — Dynamic class in Top Level
- - - The RegExp class lets you work with regular expressions, which are patterns that you can use - - to perform searches in strings and to replace text in strings.
RegExp(re:String, flags:String) — Constructor in class RegExp
- - Lets you construct a regular expression from two strings.
registerClassAlias(aliasName, classObject) — Package function in flash.net
- - Preserves the class (type) of an object when the object is encoded in Action Message Format (AMF).
registerCommandHandler(commandName:String, handler:Function) — Static method in class flash.profiler.Telemetry
- Register a function that can be called by issuing a command over a socket -

Returns true if the registration is successful.

registerCursor(name:String, cursor:flash.ui:MouseCursorData) — Static method in class flash.ui.Mouse
- Registers a native cursor under the given name, with the given data.
registerFont(font:Class) — Static method in class flash.text.Font
- - Registers a font class in the global font list.
registerFontFromByteArray(fontData:flash.utils:ByteArray) — Static method in class flash.text.Font
- - Registers a font class in the global font list, using dynamic data.
REGULAR — Constant static property in class flash.text.FontStyle
- Defines the plain style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method.
relatedObject — Property in class flash.events.FocusEvent
- A reference to the complementary InteractiveObject instance that is affected by the - change in focus.
relatedObject — Property in class flash.events.MouseEvent
- - A reference to a display list object that is related to the event.
relatedObject — Property in class flash.events.SoftKeyboardEvent
- A reference to a display list object that is related to the event.
relatedObject — Property in class flash.events.TouchEvent
- A reference to a display list object that is related to the event.
relativeEnd — Property in class flash.text.ime.CompositionAttributeRange
- The position of the end of the composition clause, relative to the beginning - of the inline edit session.
relativePath — Property in interface flash.desktop.IFilePromise
- The relative path and file name of the file that will be created by this file promise.
relativePath — Property in class flash.media.MediaPromise
- The file name of the media object, if one exists.
relativeStart — Property in class flash.text.ime.CompositionAttributeRange
- The relative start position from the beginning of the current inline editing session.
releaseLineCreationData() — Method in class flash.text.engine.TextBlock
- Instructs the text block to release all the temporary data associated with the creation of text lines.
releaseLines(firstLine:flash.text.engine:TextLine, lastLine:flash.text.engine:TextLine) — Method in class flash.text.engine.TextBlock
- Removes a range of text lines from the list of lines maintained by the TextBlock.
releaseOutside — Event in class flash.display.InteractiveObject
- - Dispatched when a user releases the button on the pointing device after the - - user first pressed the button over an InteractiveObject instance - - and then moved the pointing device off of the InteractiveObject instance.
RELEASE_OUTSIDE — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a releaseOutside event object.
releaseSavepoint — Event in class flash.data.SQLConnection
- Dispatched when a releaseSavepoint() method call's operation - completes successfully.
releaseSavepoint(name:String, responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- This method commits the SQL operations made since the most recent savepoint - or the named savepoint if a name is specified.
RELEASE_SAVEPOINT — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.releaseSavepoint() method was called.
RELEASE_SAVEPOINT — Constant static property in class flash.events.SQLEvent
- The SQLEvent.RELEASE_SAVEPOINT constant defines the value of the - type property of a releaseSavepoint event object.
reload() — Method in class flash.html.HTMLLoader
reload() — Method in class flash.media.StageWebView
- - Reloads the current page.
REMOTE — Constant static property in class flash.system.Security
- The file is from an Internet URL and operates under domain-based sandbox rules.
remoteAddress — Property in class flash.net.DatagramSocket
- - The IP address of the remote machine to which this socket is connected.
remoteAddress — Property in class flash.net.Socket
- - The IP address of the remote machine to which this socket is connected.
RemoteNotificationEvent — Final class in package flash.events
- Contains events that are dispatched by flash.notifications.RemoteNotifier in response to push notification events from APNs.
RemoteNotificationEvent(type:String, bubbles:Boolean, cancelable:Boolean, data:Object, tokenId:String) — Constructor in class flash.events.RemoteNotificationEvent
- Contains events that are dispatched by flash.notifications.RemoteNotifier in response to push notification events from APNs.
RemoteNotifier — Class in package flash.notifications
- The RemoteNotifier class lets you subscribe to and unsubscribe from push notifications.
RemoteNotifier() — Constructor in class flash.notifications.RemoteNotifier
- Creates a new RemoteNotifier object.
RemoteNotifierSubscribeOptions — Final class in package flash.notifications
- The RemoteNotifierSubscribeOptions class defines the initialization options that may be used - during the remote notification subscription process.
RemoteNotifierSubscribeOptions() — Constructor in class flash.notifications.RemoteNotifierSubscribeOptions
- Creates a new RemoteNotifierSubscribeOptions object.
remotePort — Property in class flash.net.DatagramSocket
- - The port on the remote machine to which this socket is connected.
remotePort — Property in class flash.net.Socket
- - The port on the remote machine to which this socket is connected.
removeAllItems() — Method in class flash.display.NativeMenu
- Removes all items from the menu.
removeAllItems() — Method in class flash.ui.ContextMenu
- Removes all items from the menu.
removeAsDefaultApplication(extension:String) — Method in class flash.desktop.NativeApplication
- - Removes this application as the default for opening files with the specified extension.
removeAt(index:int) — Method in class Array
- - Remove a single element from an array.
removeAt(index:int) — Method in class Vector
- Remove a single element from the Vector.
removeChild(child:flash.display:DisplayObject) — Method in class flash.display.DisplayObjectContainer
- Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
removeChildAt(index:int) — Method in class flash.display.DisplayObjectContainer
- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer.
removeChildAt(index:int) — Method in class flash.display.Stage
- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer.
removeChildren(beginIndex:int, endIndex:int) — Method in class flash.display.DisplayObjectContainer
- Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
removed — Event in class flash.display.DisplayObject
- Dispatched when a display object is about to be removed from the display list.
REMOVED — Constant static property in class flash.events.Event
- The Event.REMOVED constant defines the value of the type property of - a removed event object.
removedFromStage — Event in class flash.display.DisplayObject
- 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.
REMOVED_FROM_STAGE — Constant static property in class flash.events.Event
- The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
removeEntry(entry:String) — Method in class air.utils.ZipArchive
- - Remove an entry from the archive using its name.
removeEventListener(type:String, listener:Function, useCapture:Boolean) — Method in class flash.data.SQLConnection
- Removes a listener from the EventDispatcher object.
removeEventListener(type:String, listener:Function, useCapture:Boolean) — Method in class flash.desktop.NativeApplication
- Removes a listener from the EventDispatcher object.
removeEventListener(type:String, listener:Function, useCapture:Boolean) — Method in class flash.events.EventDispatcher
- Removes a listener from the EventDispatcher object.
removeEventListener(type:String, listener:Function, useCapture:Boolean) — Method in interface flash.events.IEventDispatcher
- Removes a listener from the EventDispatcher object.
removeEventListener(type:String, listener:Function, useCapture:Boolean) — Method in class flash.system.MessageChannel
- Removes a listener from the EventDispatcher object.
removeEventListener(type:String, listener:Function, useCapture:Boolean) — Method in class flash.system.Worker
- Removes a listener from the EventDispatcher object.
removeFromDeviceGroup(deviceGroup:flash.net.drm:DRMDeviceGroup) — Method in class flash.net.drm.DRMManager
- Removes the currently running device from a device group.
REMOVE_FROM_DEVICE_GROUP_COMPLETE — Constant static property in class flash.events.DRMDeviceGroupEvent
REMOVE_FROM_DEVICE_GROUP_ERROR — Constant static property in class flash.events.DRMDeviceGroupErrorEvent
removeHaveObjects(startIndex:Number, endIndex:Number) — Method in class flash.net.NetGroup
- Removes objects from startIndex through endIndex, from the set of objects this node - advertises to neighbors as objects for which it fulfills requests.
removeItem(name:String) — Static method in class flash.data.EncryptedLocalStore
- Removes the item with the given name from the encrypted local store.
removeItem(item:flash.display:NativeMenuItem) — Method in class flash.display.NativeMenu
- Removes the specified menu item.
removeItemAt(index:int) — Method in class flash.display.NativeMenu
- Removes and returns the menu item at the specified index.
removeItemAt(index:int) — Method in class flash.ui.ContextMenu
- Removes and returns the menu item at the specified index.
removeNamespace(ns:Namespace) — Method in class XML
- - Removes the given namespace for this object and all descendants.
removeNode() — Method in class flash.xml.XMLNode
- Removes the specified XML object from its parent.
removeWantObjects(startIndex:Number, endIndex:Number) — Method in class flash.net.NetGroup
- Removes objects from startIndex through endIndex, from the set of objects to retrieve.
render — Event in class flash.display.DisplayObject
- [broadcast event] Dispatched when the display list is about to be updated and rendered.
RENDER — Constant static property in class flash.events.Event
- The Event.RENDER constant defines the value of the type property of a render event object.
renderingMode — Property in class flash.text.engine.FontDescription
- - The rendering mode used for this text.
RenderingMode — Final class in package flash.text.engine
-The RenderingMode class provides values for rendering mode in the FontDescription class.
renderMode — Property in class flash.display.NativeWindow
- - Reports the window renderMode setting used to create this window.
renderMode — Property in class flash.display.NativeWindowInitOptions
- Specifies the render mode of the NativeWindow object created with this NativeWindowInitOptions.
renderState — Event in class flash.display3D.textures.VideoTexture
renderState — Event in class flash.media.StageVideo
- Dispatched by the StageVideo object when the render state of the StageVideo object changes.
RENDER_STATE — Constant static property in class flash.events.StageVideoEvent
- The StageVideoEvent.RENDER_STATE constant defines the value of the type property of a renderState event object.
RENDER_STATE — Constant static property in class flash.events.VideoEvent
- Defines the value of the type property of a renderState event object.
RENDER_STATE — Constant static property in class flash.events.VideoTextureEvent
- The VideoTextureEvent.RENDER_STATE constant defines the value of the type property of a renderState event object.
RENDER_STATUS_ACCELERATED — Constant static property in class flash.events.VideoEvent
-

For internal use only.

RENDER_STATUS_SOFTWARE — Constant static property in class flash.events.VideoEvent
-

For internal use only.

RENDER_STATUS_UNAVAILABLE — Constant static property in class flash.events.VideoEvent
-

For internal use only.

repeat — Property in class flash.display.GraphicsBitmapFill
- Specifies whether to repeat the bitmap image in a tiled pattern.
REPEAT — Constant static property in class flash.display.SpreadMethod
-Specifies that the gradient use the repeat spread method.
REPEAT — Constant static property in class flash.display3D.Context3DWrapMode
- Repeat (tile) texture coordinates outside the 0..1 range.
repeatCount — Property in class flash.utils.Timer
- The total number of times the timer is set to run.
REPEAT_U_CLAMP_V — Constant static property in class flash.display3D.Context3DWrapMode
- Repeat in U axis but Clamp in V axis.
replace(pattern, repl:Object) — Method in class String
- - Matches the specifed pattern against the string and returns a new string - - in which the first match of pattern is replaced with the content specified by repl.
replace(propertyName:Object, value:XML) — Method in class XML
- - Replaces the properties specified by the propertyName parameter - - with the given value parameter.
replaceElements(beginIndex:int, endIndex:int, newElements) — Method in class flash.text.engine.GroupElement
- Replaces the range of elements that the beginIndex and - endIndex parameters specify with the contents - of the newElements parameter.
replaceSelectedText(value:String) — Method in class flash.text.TextField
- - Replaces the current selection with the contents of the value parameter.
replaceText(beginIndex:int, endIndex:int, newText:String) — Method in class flash.text.TextField
- - Replaces the range of characters that the beginIndex and - - endIndex parameters specify with the contents - - of the newText parameter.
replaceText(beginIndex:int, endIndex:int, newText:String) — Method in class flash.text.engine.TextElement
- Replaces the range of characters that the beginIndex and - endIndex parameters specify with the contents - of the newText parameter.
replicationStrategy — Property in class flash.net.NetGroup
- Specifies the object replication fetch strategy.
reportError(e:flash.events:ErrorEvent) — Method in interface flash.desktop.IFilePromise
- Called by the AIR runtime to inform the IFilePromise implementation of errors - that occur when reading data from the data provider object.
reportError(e:flash.events:ErrorEvent) — Method in class flash.media.MediaPromise
- Used by the runtime to report errors.
requestContext3D(context3DRenderMode:String, profile:String) — Method in class flash.display.Stage3D
- Request the creation of a Context3D object for this Stage3D instance.
requestContext3DMatchingProfiles(profiles) — Method in class flash.display.Stage3D
- Request the creation of a Context3D object for this Stage3D instance.
requestedContentParent — Property in class flash.system.LoaderContext
- The parent to which the Loader will attempt to add the loaded content.
requestedLocaleIDName — Property in class flash.globalization.Collator
- The name of the requested locale ID that was passed to the constructor of this Collator object.
requestedLocaleIDName — Property in class flash.globalization.CurrencyFormatter
- The name of the requested locale ID that was passed to the constructor of this CurrencyFormatter object.
requestedLocaleIDName — Property in class flash.globalization.DateTimeFormatter
- The name of the requested locale ID that was passed to the constructor of this DateTimeFormatter object.
requestedLocaleIDName — Property in class flash.globalization.NumberFormatter
- The name of the requested locale ID that was passed to the constructor of this NumberFormatter object.
requestedLocaleIDName — Property in class flash.globalization.StringTools
- The name of the requested locale ID that was passed to the constructor of this StringTools object.
requestHeaders — Property in class flash.net.URLRequest
- The array of HTTP request headers to be appended to the - HTTP request.
requestPermission() — Method in class flash.filesystem.File
- - Requests permission to access filesystem.
requestPermission() — Method in class flash.media.Camera
- - Requests camera permission for the application.
requestPermission() — Method in class flash.media.CameraRoll
- Requests permission to access system media library or "camera roll".
requestPermission() — Method in class flash.media.CameraUI
- Requests permission to access Camera UI.
requestPermission() — Method in class flash.media.Microphone
- Requests Microphone permission for the application.
requestPermission() — Method in class flash.net.FileReference
- Requests permission to access filesystem.
requestPermission() — Method in class flash.permissions.PermissionManager
- Requests permission for the application to use the resource.
requestPermission() — Method in class flash.sensors.Geolocation
- Requests geolocation permission for the application.
requestSoftKeyboard() — Method in class flash.display.InteractiveObject
- - Raises a virtual keyboard.
REQUIRED_IF_AVAILABLE — Constant static property in class flash.security.RevocationCheckSettings
- Check certificate revocation if the certificate includes revocation information.
reset() — Method in class air.security.Digest
- - Resets the object for re-use by removing all earlier data - - -
reset() — Static method in class flash.data.EncryptedLocalStore
- Clears the entire encrypted local store, deleting all data.
reset() — Method in class flash.utils.Timer
- Stops the timer, if it is running, and sets the currentCount property back to 0, - like the reset button of a stopwatch.
RESET — Constant static property in class flash.net.NetStreamPlayTransitions
- Clears any previous play calls and plays the specified stream immediately.
RESET_BEGIN — Constant static property in class flash.net.NetStreamAppendBytesAction
- Indicates a timescale discontinuity.
resetDRMVouchers() — Method in class flash.net.drm.DRMManager
- In AIR applications this deletes all locally cached digital rights management (DRM) voucher data.
RESET_SEEK — Constant static property in class flash.net.NetStreamAppendBytesAction
- Indicates a timescale discontinuity.
resizable — Property in class flash.display.NativeWindow
- - Reports the resizable setting used to create this window.
resizable — Property in class flash.display.NativeWindowInitOptions
- Specifies whether the window can be resized by the user.
resizable — Property in class flash.html.HTMLWindowCreateOptions
- Specifies whether the window should be resizable.
resize — Event in class flash.display.NativeWindow
- - Dispatched by this NativeWindow object after the window has been resized.
resize — Event in class flash.display.Stage
- Dispatched when the scaleMode property of the Stage object is set to - StageScaleMode.NO_SCALE and the SWF file is resized.
RESIZE — Constant static property in class flash.events.Event
- The Event.RESIZE constant defines the value of the type property of a resize event object.
RESIZE — Constant static property in class flash.events.NativeWindowBoundsEvent
- Defines the value of the type property of a resize event object.
resizeToScreen(target:flash.display:Screen) — Method in class flash.display.NativeWindow
- - Move and resize this window to match the full size of the target Screen.
resizing — Event in class flash.display.NativeWindow
- - Dispatched by this NativeWindow object immediately before the window is to be resized on - - the desktop.
RESIZING — Constant static property in class flash.events.NativeWindowBoundsEvent
- Defines the value of the type property of a resizing event object.
resolvePath(path:String) — Method in class flash.filesystem.File
- - Creates a new File object with a path relative to this File object's path, based on the - - path parameter (a string).
resourceName — Property in class flash.net.NetStreamInfo
- The resource name used when NetStream.play() was called.
ResourceRecord — Class in package flash.net.dns
- The ResourceRecord class is the base class for Domain Name System (DNS) resource record classes.
resourceRecords — Property in class flash.events.DNSResolverEvent
- An array containing the resource records returned by the DNS lookup operation.
resourceType — Property in class flash.permissions.PermissionManager
- Which resource this PermissionManager instance is responsible for -
Responder — Class in package flash.net
- The Responder class provides an object that is used - in NetConnection.call() to handle return - values from the server related to the success or failure of - specific operations.
Responder(result:Function, status:Function) — Constructor in class flash.net.Responder
- Creates a new Responder object.
responseHeaders — Property in class flash.events.HTTPStatusEvent
- The response headers that the response returned, as an array of URLRequestHeader objects.
responseURL — Property in class flash.events.HTTPStatusEvent
- The URL that the response was returned from.
... (rest) parameter — Statement
Specifies that a function will accept any number of comma-delimited arguments.
restore() — Method in class flash.display.NativeWindow
- - Restores this window from either a minimized or a maximized state.
restrict — Property in class flash.text.StageText
- - Restricts the set of characters that a user can enter into the text field.
restrict — Property in class flash.text.TextField
- - Indicates the set of characters that a user can enter into the text field.
result — Event in class flash.data.SQLStatement
- Dispatched when an execute() or - next() method call's operation completes successfully.
RESULT — Constant static property in class flash.events.SQLEvent
- The SQLEvent.RESULT constant defines the value of the - type property of a result event object.
resume() — Method in class flash.net.NetStream
- Resumes playback of a video stream that is paused.
resume() — Static method in class flash.system.System
- - Resumes the application after calling System.pause().
RESUME — Constant static property in class flash.events.ThrottleType
- This constant is used for the status property in the ThrottleEvent class.
RESUME — Constant static property in class flash.net.NetStreamPlayTransitions
- - Requests data from the new connection starting from the point at which the previous connection ended.
return — Statement
Causes execution to return immediately to the calling function.
RETURNINDEXEDARRAY — Constant static property in class Array
- - Specifies that a sort returns an array that consists of array indices.
returnKeyLabel — Property in class flash.text.StageText
- - Indicates the label on the Return key for devices that feature a soft keyboard.
ReturnKeyLabel — Final class in package flash.text
-The ReturnKeyLabel class defines the values to use for - the returnKeyLabel property of the StageText class.
returnVoucher(inServerURL:String, immediateCommit:Boolean, licenseID:String, policyID:String) — Method in class flash.net.drm.DRMManager
- - Returns to the license server all vouchers that match all specified criteria.
RETURN_VOUCHER_COMPLETE — Constant static property in class flash.events.DRMReturnVoucherCompleteEvent
- The string constant to use for the return voucher complete event - in the type parameter when adding and removing event listeners.
RETURN_VOUCHER_ERROR — Constant static property in class flash.events.DRMReturnVoucherErrorEvent
- The string constant to use for the return voucher error event - in the type parameter when adding and removing event listeners.
reverse() — Method in class Array
- - Reverses the array in place.
reverse() — Method in class Vector
- Reverses the order of the elements in the Vector.
revocationCheckSetting — Property in class flash.security.XMLSignatureValidator
- Specifies how certificate revocation is checked.
RevocationCheckSettings — Final class in package flash.security
- The RevocationCheckSettings class defines constants used by the - revocationCheckSetting property of an XMLSignatureValidator object.
REVOKED — Constant static property in class flash.security.CertificateStatus
- The certificate has been revoked.
rewind — Property in class flash.ui.ContextMenuBuiltInItems
-Lets the user set a SWF file to play from the first frame when selected, at any time (does not -appear for a single-frame SWF file).
REWIND — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging rewind transport mode.
RGB — Constant static property in class flash.display.InterpolationMethod
- Specifies that the RGB interpolation method should be used.
RGBA_HALF_FLOAT — Constant static property in class flash.display3D.Context3DTextureFormat
-
RICH_TEXT_FORMAT — Constant static property in class flash.desktop.ClipboardFormats
- Rich Text Format data.
right — Property in class flash.geom.Rectangle
- - The sum of the x and - - width properties.
RIGHT — Constant static property in class flash.display.NativeWindowResize
-The right edge of the window.
RIGHT — Constant static property in class flash.display.StageAlign
-Specifies that the Stage is aligned to the right.
RIGHT — Constant static property in class flash.text.TextFieldAutoSize
- Specifies that the text is to be treated as right-justified text, - meaning that the right side of the text field remains fixed and any - resizing of a single line is on the left side.
RIGHT — Constant static property in class flash.text.TextFormatAlign
- Constant; aligns text to the right within the text field.
RIGHT — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Right Arrow key (39).
RIGHT — Constant static property in class flash.ui.KeyLocation
- Indicates the key activated is in the right key location (there is more than one possible location for this - key).
RIGHTBRACKET — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the ] key (221).
rightClick — Event in class flash.desktop.SystemTrayIcon
- Dispatched by this SystemTrayIcon object on right mouse click.
rightClick — Event in class flash.display.InteractiveObject
- - Dispatched when a user presses and releases the right button of the user's - - pointing device over the same InteractiveObject.
RIGHT_CLICK — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a rightClick event object.
RIGHT_CLICK — Constant static property in class flash.events.ScreenMouseEvent
- The ScreenMouseEvent.RIGHT_CLICK constant defines the value of the type - property of a rightClick event object.
rightExtension — Property in class flash.filters.ShaderFilter
- The growth in pixels on the right side of the target object.
rightMargin — Property in class flash.text.TextFormat
- The right margin of the paragraph, in pixels.
rightMouseDown — Event in class flash.desktop.SystemTrayIcon
- Dispatched by this SystemTrayIcon object on right mouse down.
rightMouseDown — Event in class flash.display.InteractiveObject
- - Dispatched when a user presses the pointing device button over an InteractiveObject instance.
RIGHT_MOUSE_DOWN — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a rightMouseDown event object.
RIGHT_MOUSE_DOWN — Constant static property in class flash.events.ScreenMouseEvent
- The ScreenMouseEvent.RIGHT_MOUSE_DOWN constant defines the value of the type - property of a rightMouseDown event object.
rightMouseUp — Event in class flash.desktop.SystemTrayIcon
- Dispatched by this SystemTrayIcon object on right mouse up.
rightMouseUp — Event in class flash.display.InteractiveObject
- - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.
RIGHT_MOUSE_UP — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a rightMouseUp event object.
RIGHT_MOUSE_UP — Constant static property in class flash.events.ScreenMouseEvent
- The ScreenMouseEvent.RIGHT_MOUSE_UP constant defines the value of the type - property of a rightMouseUp event object.
rightPeak — Property in class flash.media.SoundChannel
- The current amplitude (volume) of the right channel, from 0 (silent) to 1 (full amplitude).
rightToLeft — Property in class flash.media.SoundTransform
- A value, from 0 (none) to 1 (all), specifying how much of the right input is played in the - left speaker.
rightToRight — Property in class flash.media.SoundTransform
- A value, from 0 (none) to 1 (all), specifying how much of the right input is played in the - right speaker.
roll — Property in class flash.events.DeviceRotationEvent
- Roll along the y-axis, measured in degrees.
rollback — Event in class flash.data.SQLConnection
- Dispatched when a rollback() method call's operation - completes successfully.
rollback(responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Rolls back an existing transaction created using the begin() method, - meaning all changes made by any SQL statements in the transaction are discarded.
ROLLBACK — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.rollback() method was called.
ROLLBACK — Constant static property in class flash.events.SQLEvent
- The SQLEvent.ROLLBACK constant defines the value of the - type property of a rollback event object.
rollbackToSavepoint — Event in class flash.data.SQLConnection
- Dispatched when a rollbackToSavepoint() method call's operation - completes successfully.
rollbackToSavepoint(name:String, responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Rolls back any SQL operations since the most recent savepoint or the named - savepoint if a name is specified.
ROLLBACK_TO_SAVEPOINT — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.rollbackToSavepoint() method was called.
ROLLBACK_TO_SAVEPOINT — Constant static property in class flash.events.SQLEvent
- The SQLEvent.ROLLBACK_TO_SAVEPOINT constant defines the value of the - type property of a rollbackToSavepoint event object.
rollOut — Event in class flash.display.InteractiveObject
- - Dispatched when the user moves a pointing device away from an InteractiveObject - - instance.
ROLL_OUT — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a rollOut event object.
rollOver — Event in class flash.display.InteractiveObject
- - Dispatched when the user moves a pointing device over an InteractiveObject instance.
ROLL_OVER — Constant static property in class flash.events.MouseEvent
- - Defines the value of the type property of a rollOver event object.
ROMAN — Constant static property in class flash.text.engine.TextBaseline
- Specifies a roman baseline.
root — Property in class flash.display.DisplayObject
- 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.
rootDirectory — Property in class flash.events.StorageVolumeChangeEvent
- A File object corresponding to the root directory of the mounted volume.
rootDirectory — Property in class flash.filesystem.StorageVolume
- A File object corresponding to the root directory of the volume.
rotate(angle:Number) — Method in class flash.geom.Matrix
- - Applies a rotation transformation to the Matrix object.
ROTATE_0 — Constant static property in class flash.text.engine.TextRotation
- Specifies no rotation.
ROTATE_180 — Constant static property in class flash.text.engine.TextRotation
- Specifies a 180 degree rotation.
ROTATE_270 — Constant static property in class flash.text.engine.TextRotation
- Specifies a 270 degree clockwise rotation.
ROTATE_90 — Constant static property in class flash.text.engine.TextRotation
- Specifies a 90 degree clockwise rotation.
ROTATED_LEFT — Constant static property in class flash.display.StageOrientation
- Specifies that the stage is currently rotated left relative to the default orientation.
ROTATED_RIGHT — Constant static property in class flash.display.StageOrientation
- Specifies that the stage is currently rotated right relative to the default orientation.
rotation — Property in class flash.display.DisplayObject
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
rotation — Property in class flash.events.TransformGestureEvent
- The current rotation angle, in degrees, of the display object along the z-axis, since the previous gesture event.
rotationX — Property in class flash.display.DisplayObject
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
rotationY — Property in class flash.display.DisplayObject
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
rotationZ — Property in class flash.display.DisplayObject
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
round(val:Number) — Static method in class Math
- - Rounds the value of the parameter val up or down to the nearest - - integer and returns the value.
ROUND — Constant static property in class flash.display.CapsStyle
- - Used to specify round caps in the caps parameter of the - flash.display.Graphics.lineStyle() method.
ROUND — Constant static property in class flash.display.JointStyle
- - Specifies round joints in the joints parameter of the - flash.display.Graphics.lineStyle() method.
routingEnabled — Property in class flash.net.GroupSpecifier
- Specifies whether directed routing methods are enabled for the NetGroup.
routingReceiveBytesPerSecond — Property in class flash.net.NetGroupInfo
- Specifies the rate at which the local node is receiving directed routing messages - from peers, in bytes per second.
routingSendBytesPerSecond — Property in class flash.net.NetGroupInfo
- Specifies the rate at which the local node is sending directed routing messages to - peers, in bytes per second.
rowID — Property in class flash.events.SQLUpdateEvent
- The unique row identifier of the row that was inserted, deleted, or updated.
rowsAffected — Property in class flash.data.SQLResult
- Indicates how many rows were affected by the operation.
running — Property in class flash.desktop.NativeProcess
- Indicates if this native process is currently running.
running — Property in class flash.utils.Timer
- The timer's current state; true if the timer is running, otherwise false.
RUNNING — Constant static property in class flash.system.WorkerState
- This state indicates that the worker has begun executing application code - and it has not been instructed to stop execution.
runtimeApplicationDomain — Property in class flash.html.HTMLLoader
runtimePatchLevel — Property in class flash.desktop.NativeApplication
- - The patch level of the runtime hosting this application.
runtimeVersion — Property in class flash.desktop.NativeApplication
- - The version number of the runtime hosting this application.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/all-index-S.html b/html-docs/all-index-S.html deleted file mode 100644 index add5d76..0000000 --- a/html-docs/all-index-S.html +++ /dev/null @@ -1,6432 +0,0 @@ - - - - - -S Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
S — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the S key (83).
safeArea — Property in class flash.display.Screen
- - The bounds of the 'safe' area on this screen in which content will always be visible.
sameDomain — Property in class flash.display.LoaderInfo
- Expresses the domain relationship between the loader and the content: true if they have - the same origin domain; false otherwise.
sampleData — Event in class flash.media.Microphone
- Dispatched when the microphone has sound data in the buffer.
sampleData — Event in class flash.media.Sound
- Dispatched when the runtime requests new audio data.
SAMPLE_DATA — Constant static property in class flash.events.SampleDataEvent
- Defines the value of the type property of a SampleDataEvent event object.
SampleDataEvent — Class in package flash.events
- Dispatched when a Sound object requests new audio data or when a Microphone object - has new audio data to provide.
SampleDataEvent(type:String, bubbles:Boolean, cancelable:Boolean, theposition:Number, thedata:flash.utils:ByteArray) — Constructor in class flash.events.SampleDataEvent
- Creates an event object that contains information about audio data events.
sampleInterval — Property in class flash.ui.GameInputDevice
- Specifies the rate (in milliseconds) at which to retrieve control - values.
sandboxType — Property in class flash.events.BrowserInvokeEvent
- The sandbox type for the content in the browser.
sandboxType — Static property in class flash.system.Security
- Indicates the type of security sandbox in which the calling file is operating.
SAURASHTRA — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Saurashtra digit set.
save(file:flash.filesystem:File) — Method in class air.utils.ZipArchive
- - Saves a ZipArchive object to a file.
save(data, defaultFileName:String) — Method in class flash.net.FileReference
- Opens a dialog box that lets the user save a file to the local filesystem.
save — Property in class flash.ui.ContextMenuBuiltInItems
-Lets the user with Shockmachine installed save a SWF file.
saveToByteArray(bytes:flash.utils:ByteArray) — Method in class air.utils.ZipArchive
- - Saves a ZipArchive object to a byte array.
scale(sx:Number, sy:Number) — Method in class flash.geom.Matrix
- - Applies a scaling transformation to the matrix.
scale9Grid — Property in class flash.display.DisplayObject
- - The current scaling grid that is in effect.
scaleBy(s:Number) — Method in class flash.geom.Vector3D
- Scales the current Vector3D object by a scalar, a magnitude.
scaleMode — Property in class flash.display.GraphicsStroke
- Specifies the stroke thickness scaling.
scaleMode — Property in class flash.display.Stage
- A value from the StageScaleMode class that specifies which scale mode to use.
scaleX — Property in class flash.display.DisplayObject
- - Indicates the horizontal scale (percentage) of the object as applied from the registration point.
scaleX — Property in class flash.events.TransformGestureEvent
- The horizontal scale of the display object, since the previous gesture event.
scaleX — Property in class flash.filters.DisplacementMapFilter
- The multiplier to use to scale the x displacement result from the map calculation.
scaleY — Property in class flash.display.DisplayObject
- - Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
scaleY — Property in class flash.events.TransformGestureEvent
- The vertical scale of the display object, since the previous gesture event.
scaleY — Property in class flash.filters.DisplacementMapFilter
- The multiplier to use to scale the y displacement result from the map calculation.
scaleZ — Property in class flash.display.DisplayObject
- - Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
scanHardware() — Package function in flash.media
- - Forces a rescan of the microphones and cameras on the system.
Scene — Final class in package flash.display
- The Scene class includes properties for identifying the name, labels, and number of frames - in a scene.
scenes — Property in class flash.display.MovieClip
- An array of Scene objects, each listing the name, the number of frames, - and the frame labels for a scene in the MovieClip instance.
schema — Event in class flash.data.SQLConnection
- Dispatched when a loadSchema() method call's operation completes - successfully and the schema results are ready.
SCHEMA — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.loadSchema() method was called.
SCHEMA — Constant static property in class flash.events.SQLEvent
- The SQLEvent.SCHEMA constant defines the value of the - type property of a schema event object.
Screen — Final class in package flash.display
- - The Screen class provides information about the display screens available to this application.
SCREEN — Constant static property in class flash.display.BlendMode
-Multiplies the complement (inverse) of the display object color by the complement of the background -color, resulting in a bleaching effect.
screenColor — Static property in class flash.system.Capabilities
- Specifies the screen color.
screenDPI — Static property in class flash.system.Capabilities
- Specifies the dots-per-inch (dpi) resolution of the screen, in pixels.
ScreenMode — Class in package flash.display
- The ScreenMode object provides information about the width, height and refresh rate of a Screen.
ScreenMouseEvent — Class in package flash.events
-The SystemTrayIcon object dispatches events of type ScreenMouseEvent in response to mouse interaction.
ScreenMouseEvent(type:String, bubbles:Boolean, cancelable:Boolean, screenX:Number, screenY:Number, ctrlKey:Boolean, altKey:Boolean, shiftKey:Boolean, buttonDown:Boolean, commandKey:Boolean, controlKey:Boolean) — Constructor in class flash.events.ScreenMouseEvent
- Creates a ScreenMouseEvent object that contains the mouse location in - screen coordinates.
screenResolutionX — Static property in class flash.system.Capabilities
- Specifies the maximum horizontal resolution of the screen.
screenResolutionY — Static property in class flash.system.Capabilities
- Specifies the maximum vertical resolution of the screen.
screens — Static property in class flash.display.Screen
- - The array of the currently available screens.
screenX — Property in class flash.events.ScreenMouseEvent
- The X position of the click in screen coordinates.
screenY — Property in class flash.events.ScreenMouseEvent
- The Y position of the click in screen coordinates.
ScriptTimeoutError — Dynamic class in package flash.errors
- - The ScriptTimeoutError exception is thrown when the script timeout interval is reached.
ScriptTimeoutError(message:String) — Constructor in class flash.errors.ScriptTimeoutError
- - Creates a new ScriptTimeoutError object.
scroll(x:int, y:int) — Method in class flash.display.BitmapData
- - Scrolls an image by a certain (x, y) pixel amount.
scroll — Event in class flash.text.TextField
- - Dispatched by a TextField object after the user scrolls.
SCROLL — Constant static property in class flash.events.Event
- The Event.SCROLL constant defines the value of the type property of a scroll event object.
scrollBarsVisible — Property in class flash.html.HTMLWindowCreateOptions
- Specifies whether scrollbars should be displayed.
scrollH — Property in class flash.html.HTMLLoader
scrollH — Property in class flash.text.TextField
- - The current horizontal scrolling position.
scrollRect — Property in class flash.display.DisplayObject
- - The scroll rectangle bounds of the display object.
scrollV — Property in class flash.html.HTMLLoader
scrollV — Property in class flash.text.TextField
- - The vertical position of text in a text field.
search(pattern) — Method in class String
- - Searches for the specifed pattern and returns the index of - - the first matching substring.
SEARCH — Constant static property in class flash.text.ReturnKeyLabel
- Use the label, "Search".
SEARCH — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for the search button.
searchText — Property in interface flash.accessibility.ISearchableText
- Gets the search text from a component implementing ISearchableText.
seconds — Property in class Date
- - The seconds (an integer from 0 to 59) portion of a Date object - - according to local time.
secondsUTC — Property in class Date
- - The seconds (an integer from 0 to 59) portion of a Date object - - according to universal time (UTC).
SecureSocket — Class in package flash.net
- - The SecureSocket class enables code to make socket connections using the Secure Sockets Layer (SSL) - - and Transport Layer Security (TLS) protocols.
SecureSocket() — Constructor in class flash.net.SecureSocket
- - Creates a new SecureSocket object.
Security — Final class in package flash.system
- The Security class lets you specify how content in different domains can communicate with - each other.
securityDomain — Property in class flash.events.BrowserInvokeEvent
- The security domain for the content in the browser, such as - "www.adobe.com" or "www.example.org".
securityDomain — Property in class flash.system.LoaderContext
- Specifies the security domain to use for a Loader.load() operation.
SecurityDomain — Class in package flash.system
- The SecurityDomain class represents the current security "sandbox," also known as a security domain.
securityError — Event in class air.net.WebSocket
- - Dispatched if there is a security error when trying to open a WebSocket connection.
securityError — Event in class air.system.License
- - Dispatched if a call to License.checkDetailsOnline() - - attempts to load data from a server outside the security sandbox.
securityError — Event in class flash.filesystem.File
- - Dispatched when an operation violates a security constraint.
securityError — Event in class flash.net.FileReference
- Dispatched when a call to the FileReference.upload() - or FileReference.download() method tries to upload a file to a server or - get a file from a server that is outside the caller's security sandbox.
securityError — Event in class flash.net.LocalConnection
- Dispatched if a call to LocalConnection.send() - attempts to send data to a different security sandbox.
securityError — Event in class flash.net.NetConnection
- Dispatched if a call to NetConnection.call() - attempts to connect to a server outside the caller's security sandbox.
securityError — Event in class flash.net.SecureSocket
- - Dispatched when a call to SecureSocket.connect() fails because of a security restriction.
securityError — Event in class flash.net.Socket
- - Dispatched if a call to Socket.connect() attempts to connect to a server - - prohibited by the caller's security sandbox or to a port lower than 1024 and no socket policy file - - exists to permit such a connection.
securityError — Event in class flash.net.URLLoader
- - Dispatched if a call to URLLoader.load() - - attempts to load data from a server outside the security sandbox.
securityError — Event in class flash.net.URLStream
- - Dispatched if a call to URLStream.load() - - attempts to load data from a server outside the security sandbox.
securityError — Event in class flash.net.XMLSocket
- Dispatched if a call to the XMLSocket.connect() method - attempts to connect either to a server outside the caller's security sandbox or to a port lower than 1024.
securityError — Event in class flash.system.SystemUpdater
- Dispatched upon encountering a security error.
SecurityError — Dynamic class in Top Level
- - The SecurityError exception is thrown when some type of security violation - - takes place.
SecurityError(message:String) — Constructor in class SecurityError
- - Creates a new SecurityError object.
SECURITY_ERROR — Constant static property in class flash.events.SecurityErrorEvent
- - The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object.
SecurityErrorEvent — Class in package flash.events
- -An object dispatches a SecurityErrorEvent object to report the occurrence of a - -security error.
SecurityErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, text:String, id:int) — Constructor in class flash.events.SecurityErrorEvent
- - Creates an Event object that contains information about security error events.
SecurityPanel — Final class in package flash.system
- The SecurityPanel class provides values for specifying - which Security Settings panel you want to display.
seek(offset:Number) — Method in class flash.net.NetStream
- Seeks the keyframe (also called an I-frame in the video industry) closest to - the specified location.
select — Event in class flash.display.NativeMenu
- - Dispatched by this NativeMenu object when one of its menu items or an item - - in one of its descendant submenus is selected.
select — Event in class flash.display.NativeMenuItem
- - Dispatched whenever a menu item is selected by the user.
select — Event in class flash.filesystem.File
- - Dispatched when the user selects a file or directory from a file- or directory-browsing dialog box.
select — Event in class flash.media.CameraRoll
- Dispatched when a user selects an image from the device media library.
select — Event in class flash.net.FileReference
- Dispatched when the user selects a file for upload or download from the file-browsing dialog box.
select — Event in class flash.net.FileReferenceList
- Dispatched when the user selects one or more files to upload from the file-browsing dialog box.
SELECT — Constant static property in class flash.events.Event
- The Event.SELECT constant defines the value of the type property of a select event object.
SELECT — Constant static property in class flash.events.MediaEvent
- A constant for the select MediaEvent.
selectable — Property in class flash.text.TextField
- - A Boolean value that indicates whether the text field is selectable.
selectAll() — Method in class flash.desktop.NativeApplication
- - Invokes an internal selectAll command on the focused display object.
selectAll — Event in class flash.display.InteractiveObject
- - 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.
selectAll — Property in class flash.ui.ContextMenuClipboardItems
- Enables or disables the 'Select All' item on the clipboard menu.
SELECT_ALL — Constant static property in class flash.events.Event
- The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
selected — Property in class flash.text.ime.CompositionAttributeRange
- A property defining the current composition clause is active and - lengthened or shortened or edited with the IME while the neighboring - clauses are not changing.
selectedDeviceIndex — Property in class flash.media.AudioDeviceManager
- The index of the current selected audio output device, as reflected in the - array returned by AudioDeviceManager.deviceNames.
SELECTION — Constant static property in class flash.text.TextInteractionMode
- On mobile platforms like Android, the text field starts in normal mode(which implies scroll and non-selectable mode).
selectionActiveIndex — Property in interface flash.accessibility.ISimpleTextSelection
- The zero-based character index value of the last character in the current selection.
selectionActiveIndex — Property in class flash.text.StageText
- - The zero-based character index value of the last character in the current selection.
selectionActiveIndex — Property in interface flash.text.ime.IIMEClient
- The zero-based character index value of the last character in the current selection.
selectionAnchorIndex — Property in interface flash.accessibility.ISimpleTextSelection
- The zero-based character index value of the first character in the current selection.
selectionAnchorIndex — Property in class flash.text.StageText
- - The zero-based character index value of the first character in the current selection.
selectionAnchorIndex — Property in interface flash.text.ime.IIMEClient
- The zero-based character index value of the first character in the current selection.
selectionBeginIndex — Property in class flash.text.TextField
- - The zero-based character index value of the first character in the current selection.
selectionEndIndex — Property in class flash.text.TextField
- - The zero-based character index value of the last character in the current selection.
selectMultiple — Event in class flash.filesystem.File
- - Dispatched when the user selects files from the dialog box opened by a call to the - - browseForOpenMultiple() method.
SELECT_MULTIPLE — Constant static property in class flash.events.FileListEvent
- The FileListEvent.SELECT_MULTIPLE constant defines the value of the - type property of the event object for a selectMultiple event.
selectPaperSize(paperSize:String) — Method in class flash.printing.PrintJob
- Set the paper size.
selectRange(anchorIndex:int, activeIndex:int) — Method in class flash.text.StageText
- - Selects the text specified by the index values of the first and last characters.
selectRange(anchorIndex:int, activeIndex:int) — Method in interface flash.text.ime.IIMEClient
- Sets the range of selected text in the component.
SEMICOLON — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the ; key (186).
send(bytes:flash.utils:ByteArray, offset:uint, length:uint, address:String, port:int) — Method in class flash.net.DatagramSocket
- - Sends packet containing the bytes in the ByteArray using UDP.
send(connectionName:String, methodName:String, ... rest) — Method in class flash.net.LocalConnection
- Invokes the method named methodName on a connection that was opened with the - connect(connectionName) method (in the receiving LocalConnection - object).
send(handlerName:String, ... rest) — Method in class flash.net.NetStream
- Sends a message on a published stream to all subscribing clients.
send(... rest) — Method in class flash.net.SharedObject
- Broadcasts a message to all clients connected to a remote shared object, - including the client that sent the message.
send(object) — Method in class flash.net.XMLSocket
- Converts the XML object or data specified in the object parameter - to a string and transmits it to the server, followed by a zero (0) byte.
send() — Method in class flash.printing.PrintJob
- Sends spooled pages to the printer after successful calls to the start() or - start2() and addPage() methods.
send(arg, queueLimit:int) — Method in class flash.system.MessageChannel
- - Sends an object from the sending worker, adding it to the message - - queue for the receiving worker.
sendControlBytesPerSecond — Property in class flash.net.NetStreamMulticastInfo
- Specifies the rate at which the local node is sending control overhead messages to peers and the server, in bytes per second.
sendControlBytesPerSecondToServer — Property in class flash.net.NetStreamMulticastInfo
- Specifies the rate at which the local node is sending control overhead messages to the server, in bytes per second.
sendDataBytesPerSecond — Property in class flash.net.NetStreamMulticastInfo
- Specifies the rate at which media data is being sent by the local node to peers, in bytes per second.
sendMessage(opcode:uint, data) — Method in class air.net.WebSocket
- - Sends a message via the WebSocket protocol.
sendMetric(metric:String, value) — Static method in class flash.profiler.Telemetry
- Requests a custom metric from Telemetry.
sendSpanMetric(metric:String, startSpanMarker:Number, value) — Static method in class flash.profiler.Telemetry
- Requests a custom span metric from Telemetry -

Use Telemetry.spanMarker to get a marker at the start of function to be profiled and call Telemetry.sendSpanMetric at the end of function - with the marker.

sendToAllNeighbors(message:Object) — Method in class flash.net.NetGroup
- Sends a message to all neighbors.
sendToNearest(message:Object, groupAddress:String) — Method in class flash.net.NetGroup
- Sends a message to the neighbor (or local node) nearest to the specified group address.
sendToNeighbor(message:Object, sendMode:String) — Method in class flash.net.NetGroup
- Sends a message to the neighbor specified by the sendMode parameter.
sendToURL(request) — Package function in flash.net
- Sends a URL request to a server, but ignores any response.
SENT — Constant static property in class flash.net.NetGroupSendResult
- Indicates that a route was found for the message and it was forwarded toward its destination.
SENTENCE — Constant static property in class flash.text.AutoCapitalize
- Capitalize the first word of every sentence.
separator — Static property in class flash.filesystem.File
- - The host operating system's path component separator character.
separatorBefore — Property in class flash.ui.ContextMenuItem
- Indicates whether a separator bar should appear above the specified menu item.
serialNumber — Property in class flash.security.X509Certificate
- Provides the serial number of the certificate as a hexadecimal string.
serverCertificate — Property in class flash.net.SecureSocket
- - Holds the X.509 certificate obtained from the server after a secure SSL/TLS connection is established.
serverCertificateStatus — Property in class flash.net.SecureSocket
- - Returns the status of the server's certificate.
serverChannelEnabled — Property in class flash.net.GroupSpecifier
- Specifies whether members of the NetGroup can open a channel to the server.
ServerSocket — Class in package flash.net
- The ServerSocket class allows code to act as a server for Transport Control Protocol (TCP) - connections.
ServerSocket() — Constructor in class flash.net.ServerSocket
- Creates a ServerSocket object.
ServerSocketConnectEvent — Class in package flash.events
- A ServerSocket object dispatches a ServerSocketConnectEvent object when a client attempts - to connect to the server socket.
ServerSocketConnectEvent(type:String, bubbles:Boolean, cancelable:Boolean, socket:flash.net:Socket) — Constructor in class flash.events.ServerSocketConnectEvent
- Creates a ServerSocketConnectEvent object that contains information about a client connection.
serverString — Static property in class flash.system.Capabilities
- A URL-encoded string that specifies values for each Capabilities - property.
serverURL — Property in class flash.events.DRMAuthenticationCompleteEvent
- The URL of the media rights server.
serverURL — Property in class flash.events.DRMAuthenticationErrorEvent
- The URL of the media rights server that rejected the authentication attempt.
serverURL — Property in class flash.events.DRMLicenseRequestEvent
- The URL which will be used to communicate with the license server - -
serverURL — Property in class flash.events.DRMReturnVoucherCompleteEvent
- The URL of the media rights server.
serverURL — Property in class flash.events.DRMReturnVoucherErrorEvent
- The URL of the media rights server for this return Voucher attempt.
serverURL — Property in class flash.net.drm.DRMContentData
- The URL of a media rights server that - provides the voucher that is required to view the associated content.
serverURL — Property in class flash.net.drm.DRMDeviceGroup
- The URL of the registration server for this device group.
serverURL — Property in class flash.net.drm.DRMVoucher
- The url to the license server for this DRMVoucher.
set — Statement
Defines a setter, which is a method that appears in the public interface as a property.
__set(propName:String, value) — Method in class flash.external.HostObject
- The universal setter method stores the supplied value into - the given property.
SET — Constant static property in class flash.display3D.Context3DStencilAction
- Replace the stencil buffer value with the reference value.
setAdvancedAntiAliasingTable(fontName:String, fontStyle:String, colorType:String, advancedAntiAliasingTable:Array) — Static method in class flash.text.TextRenderer
- Sets a custom continuous stroke modulation (CSM) lookup table for a font.
setAsDefaultApplication(extension:String) — Method in class flash.desktop.NativeApplication
- - Sets this application as the default application for opening files with the specified extension.
setAspectRatio(newAspectRatio:String) — Method in class flash.display.Stage
- Sets the stage to an orientation with the specified aspect ratio.
setAuthenticationToken(serverUrl:String, domain:String, token:flash.utils:ByteArray) — Method in class flash.net.drm.DRMManager
- Sets the authentication token to use for communication with the specified server and domain.
setBlendFactors(sourceFactor:String, destinationFactor:String) — Method in class flash.display3D.Context3D
- - Specifies the factors used to blend the output color of a drawing operation with the existing color.
setChildIndex(child:flash.display:DisplayObject, index:int) — Method in class flash.display.DisplayObjectContainer
- Changes the position of an existing child in the display object container.
setChildIndex(child:flash.display:DisplayObject, index:int) — Method in class flash.display.Stage
- Changes the position of an existing child in the display object container.
setChildren(value:Object) — Method in class XML
- - Replaces the child properties of the XML object with the specified set of XML properties, - - provided in the value parameter.
setClipboard(string:String) — Static method in class flash.system.System
- - Replaces the contents of the Clipboard with a specified text string.
setColorMask(red:Boolean, green:Boolean, blue:Boolean, alpha:Boolean) — Method in class flash.display3D.Context3D
- - Sets the mask used when writing colors to the render buffer.
setCompositionString(composition:String) — Static method in class flash.system.IME
- Sets the IME composition string.
setCulling(triangleFaceToCull:String) — Method in class flash.display3D.Context3D
- - Sets triangle culling mode.
setCurrency(currencyISOCode:String, currencySymbol:String) — Method in class flash.globalization.CurrencyFormatter
- Sets the currencyISOCode and currencySymbol properties of the CurrencyFormatter object.
setData(format:String, data:Object, serializable:Boolean) — Method in class flash.desktop.Clipboard
- Adds a representation of the information to be transferred in the specified data format.
setDataHandler(format:String, handler:Function, serializable:Boolean) — Method in class flash.desktop.Clipboard
- Adds a reference to a handler function that produces the data to be transfered.
setDate(day:Number) — Method in class Date
- - Sets the day of the month, according to local time, and returns the new time in - - milliseconds.
setDateTimePattern(pattern:String) — Method in class flash.globalization.DateTimeFormatter
- Sets the pattern string used by this DateTimeFormatter object to format dates and times.
setDateTimeStyles(dateStyle:String, timeStyle:String) — Method in class flash.globalization.DateTimeFormatter
- Sets the date and time styles for this instance of the DateTimeFormatter.
setDepthTest(depthMask:Boolean, passCompareMode:String) — Method in class flash.display3D.Context3D
- - Sets type of comparison used for depth testing.
setDirty(propertyName:String) — Method in class flash.net.SharedObject
- Indicates to the server that the value of a property - in the shared object has changed.
setElements(value) — Method in class flash.text.engine.GroupElement
- Sets the elements in the group to the contents of the Vector.
setEmpty() — Method in class flash.geom.Rectangle
- - Sets all of the Rectangle object's properties to 0.
setFillMode(fillMode:String) — Method in class flash.display3D.Context3D
- - Set fill mode used for render.
setFullYear(year:Number, month:Number, day:Number) — Method in class Date
- - Sets the year, according to local time, and returns the new time in milliseconds.
setHours(hour:Number, minute:Number, second:Number, millisecond:Number) — Method in class Date
- - Sets the hour, according to local time, and returns the new time in milliseconds.
setInterval(closure, delay, ... rest) — Package function in flash.utils
- Runs a function at a specified interval (in milliseconds).
setItem(name:String, data:flash.utils:ByteArray, stronglyBound:Boolean) — Static method in class flash.data.EncryptedLocalStore
- - Stores a ByteArray object under the specified name.
setItemIndex(item:flash.display:NativeMenuItem, index:int) — Method in class flash.display.NativeMenu
- - Moves a menu item to the specified position.
setKeyFrameInterval(keyFrameInterval:int) — Method in class flash.media.Camera
- - Specifies which video frames are transmitted in full (called keyframes) - - instead of being interpolated by the video compression algorithm.
setKeyFrameInterval(keyFrameInterval:int) — Method in class flash.media.VideoStreamSettings
- The number of video frames transmitted in full (called keyframes or Instantaneous Decoding Refresh (IDR) frames) instead of being interpolated by the video compression algorithm.
setLocalName(name:String) — Method in class XML
- - Changes the local name of the XML object to the given name parameter.
setLoginCredentialsForHost(hostname:String, user:String, password:String) — Static method in class flash.net.URLRequestDefaults
- Sets default user and password credentials for a selected host.
setLoopback(compress:Boolean) — Method in class flash.media.Camera
- - Specifies whether to use a compressed video stream for a local view of the camera.
setLoopBack(state:Boolean) — Method in class flash.media.Microphone
- Routes audio captured by a microphone to the local speakers.
setMilliseconds(millisecond:Number) — Method in class Date
- - Sets the milliseconds, according to local time, and returns the new time in - - milliseconds.
setMinutes(minute:Number, second:Number, millisecond:Number) — Method in class Date
- - Sets the minutes, according to local time, and returns the new time in milliseconds.
setMode(width:int, height:int, fps:Number, favorArea:Boolean) — Method in class flash.media.Camera
- - Sets the camera capture mode to the native mode that best meets the specified requirements.
setMode(width:int, height:int, fps:Number) — Method in class flash.media.VideoStreamSettings
- Sets the resolution and frame rate used for video encoding.
setMonth(month:Number, day:Number) — Method in class Date
- - Sets the month and optionally the day of the month, according to local time, and - - returns the new time in milliseconds.
setMotionLevel(motionLevel:int, timeout:int) — Method in class flash.media.Camera
- - Specifies how much motion is required to dispatch the activity event.
setName(name:String) — Method in class XML
- - Sets the name of the XML object to the given qualified name or attribute name.
setNamespace(ns:Namespace) — Method in class XML
- - Sets the namespace associated with the XML object.
setOrientation(newOrientation:String) — Method in class flash.display.Stage
- Sets the stage to the specified orientation.
setPixel(x:int, y:int, color:uint) — Method in class flash.display.BitmapData
- - Sets a single pixel of a BitmapData object.
setPixel32(x:int, y:int, color:uint) — Method in class flash.display.BitmapData
- - Sets the color and alpha transparency values of a single pixel of a BitmapData - - object.
setPixels(rect:flash.geom:Rectangle, inputByteArray:flash.utils:ByteArray) — Method in class flash.display.BitmapData
- - Converts a byte array into a rectangular region of pixel data.
setPostingPassword(password:String, salt:String) — Method in class flash.net.GroupSpecifier
- Specifies whether a password is required to post in the NetGroup.
setProfileLevel(profile:String, level:String) — Method in class flash.media.H264VideoStreamSettings
- Set profile and level for video encoding.
setProgram(program:flash.display3D:Program3D) — Method in class flash.display3D.Context3D
- - Sets vertex and fragment shader programs to use for subsequent rendering.
setProgramConstantsFromByteArray(programType:String, firstRegister:int, numRegisters:int, data:flash.utils:ByteArray, byteArrayOffset:uint) — Method in class flash.display3D.Context3D
- - Set constants for use by shader programs using values stored in a ByteArray.
setProgramConstantsFromFloatVector(programType:String, firstRegister:int, data, numRegisters:int) — Method in class flash.display3D.Context3D
- - Sets the constant inputs for the shader programs.
setProgramConstantsFromMatrix(programType:String, firstRegister:int, matrix:flash.geom:Matrix3D, transposedMatrix:Boolean) — Method in class flash.display3D.Context3D
- - Sets constants for use by shader programs using values stored in a Matrix3D.
setProgramConstantsFromVector(programType:String, firstRegister:int, data, numRegisters:int) — Method in class flash.display3D.Context3D
- - Sets the constant inputs for the shader programs.
setProperty(propertyName:String, value:Object) — Method in class flash.net.SharedObject
- Updates the value of a property in a shared object and indicates to the server - that the value of the property has changed.
setProperty(name, value) — Method in class flash.utils.Proxy
setPropertyIsEnumerable(name:String, isEnum:Boolean) — Method in class Object
- - Sets the availability of a dynamic property for loop operations.
setPublishPassword(password:String, salt:String) — Method in class flash.net.GroupSpecifier
- Specifies whether a password is required to publish a multicast stream in the NetStream.
setQuality(bandwidth:int, quality:int) — Method in class flash.media.Camera
- - Sets the maximum amount of bandwidth per second or the required picture quality - - of the current outgoing video feed.
setQuality(bandwidth:int, quality:int) — Method in class flash.media.VideoStreamSettings
- Sets maximum amount of bandwidth per second or the required picture quality that the current - outgoing video feed can use.
setRenderToBackBuffer() — Method in class flash.display3D.Context3D
- - Sets the back rendering buffer as the render target.
setRenderToTexture(texture:flash.display3D.textures:TextureBase, enableDepthAndStencil:Boolean, antiAlias:int, surfaceSelector:int, colorOutputIndex:int) — Method in class flash.display3D.Context3D
- - Sets the specified texture as the rendering target.
setRequestedUpdateInterval(interval:Number) — Method in class flash.sensors.Accelerometer
- The setRequestedUpdateInterval method is used to set the desired time interval - for updates.
setRequestedUpdateInterval(interval:Number) — Method in class flash.sensors.DeviceRotation
- The setRequestedUpdateInterval method is used to set the desired time interval - for updates.
setRequestedUpdateInterval(interval:Number) — Method in class flash.sensors.Geolocation
- Used to set the time interval for updates, in milliseconds.
setSamplerStateAt(sampler:int, wrap:String, filter:String, mipfilter:String) — Method in class flash.display3D.Context3D
- - Manually override texture sampler state.
setSavepoint — Event in class flash.data.SQLConnection
- Dispatched when a setSavepoint() method call's operation - completes successfully.
setSavepoint(name:String, responder:flash.net:Responder) — Method in class flash.data.SQLConnection
- Creates a savepoint, which is like a bookmark within a database transaction.
SET_SAVEPOINT — Constant static property in class flash.errors.SQLErrorOperation
- Indicates that the SQLConnection.setSavepoint() method was called.
SET_SAVEPOINT — Constant static property in class flash.events.SQLEvent
- The SQLEvent.SET_SAVEPOINT constant defines the value of the - type property of a setSavepoint event object.
setScissorRectangle(rectangle:flash.geom:Rectangle) — Method in class flash.display3D.Context3D
- - Sets a scissor rectangle, which is type of drawing mask.
setSeconds(second:Number, millisecond:Number) — Method in class Date
- - Sets the seconds, according to local time, and returns the new time in milliseconds.
setSelectColor(hexColor:uint) — Method in class flash.text.TextSnapshot
- Specifies the color to use when highlighting characters that have been selected with the - setSelected() method.
setSelected(beginIndex:int, endIndex:int, select:Boolean) — Method in class flash.text.TextSnapshot
- Specifies a range of characters in a TextSnapshot object to be selected or deselected.
setSelection(beginIndex:int, endIndex:int) — Method in class flash.text.TextField
- - Sets as selected the text designated by the index values of the - - first and last characters, which are specified with the beginIndex - - and endIndex parameters.
setSettings(... rest) — Static method in class XML
- - Sets values for the following XML properties: ignoreComments, - - ignoreProcessingInstructions, ignoreWhitespace, - - prettyIndent, and prettyPrinting.
setSharedProperty(key:String, value) — Method in class flash.system.Worker
- Provides a named value that is available to code running in the worker's swf.
setSilenceLevel(silenceLevel:Number, timeout:int) — Method in class flash.media.Microphone
- Sets the minimum input level that should be considered sound and (optionally) the amount - of silent time signifying that silence has actually begun.
setStencilActions(triangleFace:String, compareMode:String, actionOnBothPass:String, actionOnDepthFail:String, actionOnDepthPassStencilFail:String) — Method in class flash.display3D.Context3D
- - Sets stencil mode and operation.
setStencilReferenceValue(referenceValue:uint, readMask:uint, writeMask:uint) — Method in class flash.display3D.Context3D
- - Sets the stencil comparison value used for stencil tests.
setStyle(styleName:String, styleObject:Object) — Method in class flash.text.StyleSheet
- Adds a new style with the specified name to the style sheet object.
setTextFormat(format:flash.text:TextFormat, beginIndex:int, endIndex:int) — Method in class flash.text.TextField
- - Applies the text formatting that the format parameter specifies to the specified text in a text field.
setTextureAt(sampler:int, texture:flash.display3D.textures:TextureBase) — Method in class flash.display3D.Context3D
- - Specifies the texture to use for a texture input register of a fragment program.
setTime(millisecond:Number) — Method in class Date
- - Sets the date in milliseconds since midnight on January 1, 1970, and returns the new - - time in milliseconds.
setTimeout(closure, delay, ... rest) — Package function in flash.utils
- Runs a specified function after a specified delay (in milliseconds).
settings() — Static method in class XML
- - Retrieves the following properties: ignoreComments, - - ignoreProcessingInstructions, ignoreWhitespace, - - prettyIndent, and prettyPrinting.
SETTINGS_MANAGER — Constant static property in class flash.system.SecurityPanel
- When passed to Security.showSettings(), displays the - Settings Manager (in a separate browser window).
setTo(aa:Number, ba:Number, ca:Number, da:Number, txa:Number, tya:Number) — Method in class flash.geom.Matrix
- - Sets the members of Matrix to the specified values - - - -
setTo(xa:Number, ya:Number) — Method in class flash.geom.Point
- Sets the members of Point to the specified values - -
setTo(xa:Number, ya:Number, widtha:Number, heighta:Number) — Method in class flash.geom.Rectangle
- - Sets the members of Rectangle to the specified values - - - -
setTo(xa:Number, ya:Number, za:Number) — Method in class flash.geom.Vector3D
- Sets the members of Vector3D to the specified values - -
SETUP — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging the setup application or menu.
setUseEchoSuppression(useEchoSuppression:Boolean) — Method in class flash.media.Microphone
- Specifies whether to use the echo suppression feature of the audio codec.
setUTCDate(day:Number) — Method in class Date
- - Sets the day of the month, in universal time (UTC), and returns the new time in - - milliseconds.
setUTCFullYear(year:Number, month:Number, day:Number) — Method in class Date
- - Sets the year, in universal time (UTC), and returns the new time in milliseconds.
setUTCHours(hour:Number, minute:Number, second:Number, millisecond:Number) — Method in class Date
- - Sets the hour, in universal time (UTC), and returns the new time in milliseconds.
setUTCMilliseconds(millisecond:Number) — Method in class Date
- - Sets the milliseconds, in universal time (UTC), and returns the new time in milliseconds.
setUTCMinutes(minute:Number, second:Number, millisecond:Number) — Method in class Date
- - Sets the minutes, in universal time (UTC), and returns the new time in milliseconds.
setUTCMonth(month:Number, day:Number) — Method in class Date
- - Sets the month, and optionally the day, in universal time(UTC) and returns the new - - time in milliseconds.
setUTCSeconds(second:Number, millisecond:Number) — Method in class Date
- - Sets the seconds, and optionally the milliseconds, in universal time (UTC) and - - returns the new time in milliseconds.
setVector(rect:flash.geom:Rectangle, inputVector) — Method in class flash.display.BitmapData
- - Converts a Vector into a rectangular region of pixel data.
setVertexBufferAt(index:int, buffer:flash.display3D:VertexBuffer3D, bufferOffset:int, format:String) — Method in class flash.display3D.Context3D
- - Specifies which vertex data components correspond to a single vertex shader program input.
sf32(value, addr) — Package function in avm2.intrinsics.memory
- - Stores a 32-bit floating point value into the given addr in domain memory.
sf64(value, addr) — Package function in avm2.intrinsics.memory
- - Stores a 64-bit floating point value into the given addr in domain memory.
SHA1 — Constant static property in class air.security.Digest
- - Definition for the SHA-1 algorithm - -
SHA256 — Constant static property in class air.security.Digest
- - Definition for the SHA-256 algorithm - -
SHA512 — Constant static property in class air.security.Digest
- - Definition for the SHA-512 algorithm - -
shader — Property in class flash.display.GraphicsShaderFill
- The shader to use for the fill.
shader — Property in class flash.display.ShaderJob
- The shader that's used for the operation.
shader — Property in class flash.filters.ShaderFilter
- The shader to use for this filter.
Shader — Class in package flash.display
- A Shader instance represents a Pixel Bender shader kernel in ActionScript.
Shader(code:flash.utils:ByteArray) — Constructor in class flash.display.Shader
- Creates a new Shader instance.
SHADER — Constant static property in class flash.display.BlendMode
-Uses a shader to define the blend between objects.
ShaderData — Final dynamic class in package flash.display
- A ShaderData object contains properties representing any parameters and - inputs for a shader kernel, as well as properties containing any metadata - specified for the shader.
ShaderData(byteCode:flash.utils:ByteArray) — Constructor in class flash.display.ShaderData
- Creates a ShaderData instance.
ShaderEvent — Class in package flash.events
- A ShaderEvent is dispatched when a shader operation launched from - a ShaderJob finishes.
ShaderEvent(type:String, bubbles:Boolean, cancelable:Boolean, bitmap:flash.display:BitmapData, array:flash.utils:ByteArray, vector) — Constructor in class flash.events.ShaderEvent
- Creates a ShaderEvent object to pass to event listeners.
ShaderFilter — Class in package flash.filters
- The ShaderFilter class applies a filter by executing a shader on the object - being filtered.
ShaderFilter(shader:flash.display:Shader) — Constructor in class flash.filters.ShaderFilter
- Creates a new shader filter.
ShaderInput — Final dynamic class in package flash.display
- A ShaderInput instance represents a single input image for - a shader kernel.
ShaderInput() — Constructor in class flash.display.ShaderInput
- Creates a ShaderInput instance.
ShaderJob — Class in package flash.display
- A ShaderJob instance is used to execute a shader operation in stand-alone mode.
ShaderJob(shader:flash.display:Shader, target:Object, width:int, height:int) — Constructor in class flash.display.ShaderJob
- -
ShaderParameter — Final dynamic class in package flash.display
- A ShaderParameter instance represents a single input parameter of - a shader kernel.
ShaderParameter() — Constructor in class flash.display.ShaderParameter
- Creates a ShaderParameter instance.
ShaderParameterType — Final class in package flash.display
- This class defines the constants that represent the possible values for - the ShaderParameter class's type property.
ShaderPrecision — Final class in package flash.display
- This class defines the constants that represent the possible values for - the Shader class's precisionHint property.
shadowAlpha — Property in class flash.filters.BevelFilter
- The alpha transparency value of the shadow color.
shadowColor — Property in class flash.filters.BevelFilter
- The shadow color of the bevel.
Shape — Class in package flash.display
- This class is used to create lightweight shapes using the ActionScript drawing application program interface (API).
Shape() — Constructor in class flash.display.Shape
- Creates a new Shape object.
shareable — Property in class flash.utils.ByteArray
- - Every byte array can either be "non-shareable" or "shareable".
sharedEvents — Property in class flash.display.LoaderInfo
- An EventDispatcher instance that can be used to exchange events across security boundaries.
SharedObject — Class in package flash.net
- The SharedObject class is used to read and store limited amounts of data on a user's computer - or on a server.
SharedObjectFlushStatus — Final class in package flash.net
- The SharedObjectFlushStatus class provides values for the code returned from a call to the SharedObject.flush() method.
sharpness — Property in class flash.text.TextField
- - The sharpness of the glyph edges in this text field.
shift() — Method in class Array
- - Removes the first element from an array and returns that element.
shift() — Method in class Vector
- Removes the first element from the Vector and returns that element.
SHIFT — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Shift key (16).
shiftKey — Property in class flash.events.FocusEvent
- Indicates whether the Shift key modifier is activated, in which case the value is - true.
shiftKey — Property in class flash.events.GestureEvent
- Indicates whether the Shift key is active (true) or inactive - (false).
shiftKey — Property in class flash.events.KeyboardEvent
- - Indicates whether the Shift key modifier is active (true) or inactive - - (false).
shiftKey — Property in class flash.events.MouseEvent
- - Indicates whether the Shift key is active (true) or inactive - - (false).
shiftKey — Property in class flash.events.TouchEvent
- Indicates whether the Shift key is active (true) or inactive - (false).
SHORT — Constant static property in class flash.data.SQLColumnNameStyle
- Indicates that column names returned from a SELECT statement use short-column-name - format.
SHORT — Constant static property in class flash.globalization.DateTimeStyle
- Specifies the short style of a date or time.
SHORT_ABBREVIATION — Constant static property in class flash.globalization.DateTimeNameStyle
- Specifies the short abbreviation style for month names and weekday names.
shortcut — Property in class flash.accessibility.AccessibilityProperties
- Indicates a keyboard shortcut associated with this display object.
show() — Static method in class flash.ui.Mouse
- Displays the pointer.
SHOW_ALL — Constant static property in class flash.display.StageScaleMode
-Specifies that the entire application be visible in the specified area without distortion while -maintaining the original aspect ratio of the application.
showDefaultContextMenu — Property in class flash.display.Stage
- Specifies whether to show or hide the default items in the Flash runtime - context menu.
showPageSetupDialog() — Method in class flash.printing.PrintJob
- Displays the operating system's Page Setup dialog if the current environment - supports it.
showRedrawRegions(on, color) — Package function in flash.profiler
- Shows or hides redraw regions.
showSettings(panel:String) — Static method in class flash.system.Security
- Displays the Security Settings panel in Flash Player.
si16(value, addr) — Package function in avm2.intrinsics.memory
- - Stores a 16-bit integer value into the given addr in domain memory.
si32(value, addr) — Package function in avm2.intrinsics.memory
- - Stores a 32-bit integer value into the given addr in domain memory.
si8(value, addr) — Package function in avm2.intrinsics.memory
- - Stores an 8-bit integer value into the given addr in domain memory.
signatureAlgorithmOID — Property in class flash.security.X509Certificate
- Provides the signature algorithm Object Identifier (OID).
signatureAlgorithmParams — Property in class flash.security.X509Certificate
- Provides the signature algorithm's parameters.
SignatureStatus — Final class in package flash.security
- The SignatureStatus class defines constants used by the validityStatus - property of an XMLSignatureValidator object.
signerCN — Property in class flash.security.XMLSignatureValidator
- The Common Name field of the signing certificate.
signerDN — Property in class flash.security.XMLSignatureValidator
- The Distinguished Name field of the signing certificate.
signerExtendedKeyUsages — Property in class flash.security.XMLSignatureValidator
- An array containing the Extended Key Usages OIDs listed in the signing certificate.
signerTrustSettings — Property in class flash.security.XMLSignatureValidator
- An array containing the trust settings of the signing certificate.
SignerTrustSettings — Final class in package flash.security
- The SignerTrustSettings class defines constants used with the - signerTrustSettings property of an XMLSignatureValidator object.
SIGNING — Constant static property in class flash.security.SignerTrustSettings
- The certificate is trusted for signing in general.
silenceLevel — Property in class flash.media.Microphone
- The amount of sound required to activate the microphone and dispatch - the activity event.
silenceTimeout — Property in class flash.media.Microphone
- The number of milliseconds between the time the microphone stops - detecting sound and the time the activity event is dispatched.
silent — Property in class flash.accessibility.AccessibilityProperties
- If true, excludes this display object from accessible presentation.
SimpleButton — Class in package flash.display
- The SimpleButton class lets you control all instances of button symbols in a SWF - file.
SimpleButton(upState:flash.display:DisplayObject, overState:flash.display:DisplayObject, downState:flash.display:DisplayObject, hitTestState:flash.display:DisplayObject) — Constructor in class flash.display.SimpleButton
- Creates a new SimpleButton instance.
sin(angleRadians:Number) — Static method in class Math
- - Computes and returns the sine of the specified angle in radians.
size — Property in class flash.geom.Rectangle
- - The size of the Rectangle object, expressed as a Point object with the values - - of the width and height properties.
size — Property in class flash.net.FileReference
- The size of the file on the local disk in bytes.
size — Property in class flash.net.SharedObject
- The current size of the shared object, in bytes.
size — Property in class flash.text.TextFormat
- The size in pixels of text in this text format.
sizeX — Property in class flash.events.TouchEvent
- Width of the contact area.
sizeY — Property in class flash.events.TouchEvent
- Height of the contact area.
SKIP_BACKWARD — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging quick skip backward (usually 7-10 seconds).
SKIP_FORWARD — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging quick skip ahead (usually 30 seconds).
SLASH — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the / key (191).
slice(startIndex:int, endIndex:int) — Method in class Array
- - Returns a new array that consists of a range of elements from the original array, without modifying the original array.
slice(startIndex:Number, endIndex:Number) — Method in class String
- - Returns a string that includes the startIndex character - - and all characters up to, but not including, the endIndex character.
slice(startIndex:int, endIndex:int) — Method in class Vector
- Returns a new Vector that consists of a range of elements from - the original Vector, without modifying the original Vector.
SMALL_CAPS — Constant static property in class flash.text.engine.TypographicCase
- Specifies that uppercase characters use small-caps glyphs on output.
smooth — Property in class flash.display.GraphicsBitmapFill
- Specifies whether to apply a smoothing algorithm to the bitmap image.
smoothing — Property in class flash.display.Bitmap
- Controls whether or not the bitmap is smoothed when scaled.
smoothing — Property in class flash.media.Video
- Specifies whether the video should be smoothed (interpolated) when it is scaled.
socket — Property in class flash.events.ServerSocketConnectEvent
- The socket for the new connection.
Socket — Class in package flash.net
- - The Socket class enables code to establish Transport Control Protocol (TCP) socket - - connections for sending and receiving binary data.
Socket(host:String, port:int) — Constructor in class flash.net.Socket
- - Creates a new Socket object.
socketData — Event in class flash.net.SecureSocket
- - Dispatched when a socket has received data.
socketData — Event in class flash.net.Socket
- - Dispatched when a socket has received data.
SOCKET_DATA — Constant static property in class flash.events.ProgressEvent
- Defines the value of the type property of a socketData event object.
softKeyboard — Property in class flash.display.InteractiveObject
- - Controls the appearance of the soft keyboard.
softKeyboardActivate — Event in class flash.display.InteractiveObject
- - Dispatched immediately after the soft keyboard is raised.
softKeyboardActivate — Event in class flash.text.StageText
- - Dispatched after the soft keyboard is activated, as a result of the - - StageText object acquiring focus.
SOFT_KEYBOARD_ACTIVATE — Constant static property in class flash.events.SoftKeyboardEvent
- The SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE constant defines the value of the type property SoftKeyboardEvent - object when a soft keyboard is displayed.
softKeyboardActivating — Event in class flash.display.InteractiveObject
- - Dispatched immediately before the soft keyboard is raised.
softKeyboardActivating — Event in class flash.text.StageText
- - Dispatched before soft keyboard activation, as a result of the - - StageText object acquiring focus.
SOFT_KEYBOARD_ACTIVATING — Constant static property in class flash.events.SoftKeyboardEvent
- The SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING constant defines the value of the type property SoftKeyboardEvent - object immediately before a soft keyboard is displayed.
softKeyboardDeactivate — Event in class flash.display.InteractiveObject
- - Dispatched immediately after the soft keyboard is lowered.
softKeyboardDeactivate — Event in class flash.text.StageText
- - Dispatched after the soft keyboard is deactivated, as a result of the - - StageText object losing focus.
SOFT_KEYBOARD_DEACTIVATE — Constant static property in class flash.events.SoftKeyboardEvent
- The SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE constant defines the value of the type property SoftKeyboardEvent - object when a soft keyboard is lowered or hidden.
SoftKeyboardEvent — Class in package flash.events
-A SoftKeyboardEvent object is dispatched when a software-driven keyboard is activated or de-activated on a device or operating system.
SoftKeyboardEvent(type:String, bubbles:Boolean, cancelable:Boolean, relatedObjectVal:flash.display:InteractiveObject, triggerTypeVal:String) — Constructor in class flash.events.SoftKeyboardEvent
- Creates an event object that contains information about soft keyboard activation and de-activation events.
softKeyboardInputAreaOfInterest — Property in class flash.display.InteractiveObject
- - Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
softKeyboardRect — Property in class flash.display.Stage
- A Rectangle specifying the area of the stage that is currently covered by a soft - keyboard.
SoftKeyboardTrigger — Class in package flash.events
- The SoftKeyboardTrigger class provides enumerator values for the triggerType property - of the SoftKeyboardEvent class.
softKeyboardType — Property in class flash.text.StageText
- - Controls the appearance of the soft keyboard.
SoftKeyboardType — Final class in package flash.text
- The SoftKeyboardType class defines the types of soft keyboards for - mobile applications.
SOFTWARE — Constant static property in class flash.display3D.Context3DRenderMode
- Use software 3D rendering.
SOFTWARE — Constant static property in class flash.media.VideoStatus
- Indicates software video decoding.
SOLID — Constant static property in class flash.display3D.Context3DFillMode
- The fill mode is solid mode.
some(callback:Function, thisObject) — Method in class Array
- - Executes a test function on each item in the array until an item is reached that returns true.
some(callback:Function, thisObject:Object) — Method in class Vector
- Executes a test function on each item in the Vector until an - item is reached that returns true.
songName — Property in class flash.media.ID3Info
- The name of the song; corresponds to the ID3 2.0 tag TIT2.
SORENSON — Constant static property in class flash.media.VideoCodec
- Constant value indicating that Sorenson Spark codec is used for compressing video.
sort(... rest) — Method in class Array
- - Sorts the elements in an array.
sort(sortBehavior) — Method in class Vector
- Sorts the elements in the Vector object, and also returns a sorted Vector object.
SORTING — Constant static property in class flash.globalization.CollatorMode
- Initializes a Collator object so that the compare method is optimized for - sorting a list of text strings to be displayed to an end user.
sortOn(fieldName:Object, options:Object) — Method in class Array
- - Sorts the elements in an array according to one or more fields in the array.
Sound — Class in package flash.media
- The Sound class lets you work with sound in an application.
Sound(stream:flash.net:URLRequest, context:flash.media:SoundLoaderContext) — Constructor in class flash.media.Sound
- Creates a new Sound object.
SOUND — Constant static property in class flash.notifications.NotificationStyle
- A notification style to play sound upon receiving a notification.
SoundChannel — Final class in package flash.media
- The SoundChannel class controls a sound in an application.
SoundCodec — Final class in package flash.media
-The SoundCodec class is an enumeration of constant values used in setting the codec property -of the Microphone class.
soundComplete — Event in class flash.media.SoundChannel
- Dispatched when a sound has finished playing.
SOUND_COMPLETE — Constant static property in class flash.events.Event
- The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
SoundLoaderContext — Class in package flash.media
- The SoundLoaderContext class provides security checks for files that load sound.
SoundLoaderContext(bufferTime:Number, checkPolicyFile:Boolean) — Constructor in class flash.media.SoundLoaderContext
- Creates a new sound loader context object.
SoundMixer — Final class in package flash.media
-The SoundMixer class contains static properties and methods for global sound control -in the application.
soundTransform — Property in class flash.display.SimpleButton
- The SoundTransform object assigned to this button.
soundTransform — Property in class flash.display.Sprite
- Controls sound within this sprite.
soundTransform — Property in class flash.media.Microphone
- Controls the sound of this microphone object when it is in loopback mode.
soundTransform — Property in class flash.media.SoundChannel
- The SoundTransform object assigned to the sound channel.
soundTransform — Static property in class flash.media.SoundMixer
- The SoundTransform object that controls global sound properties.
soundTransform — Property in class flash.net.NetStream
- Controls sound in this NetStream object.
SoundTransform — Final class in package flash.media
- The SoundTransform class contains properties for volume and panning.
SoundTransform(vol:Number, panning:Number) — Constructor in class flash.media.SoundTransform
- Creates a SoundTransform object.
source — Property in class RegExp
- - Specifies the pattern portion of the regular expression.
SOURCE_ALPHA — Constant static property in class flash.display3D.Context3DBlendFactor
- The blend factor is (Sa,Sa,Sa,Sa), where Sa is - the alpha component of the fragment color computed by the pixel program.
SOURCE_COLOR — Constant static property in class flash.display3D.Context3DBlendFactor
- The blend factor is (Sr,Sg,Sb,Sa), where Sr/g/b/a is - the corresponding component of the fragment color computed by the pixel program.
SPACE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Spacebar (32).
spaceAvailable — Property in class flash.filesystem.File
- - The space available for use at this File location, in bytes.
SpaceJustifier — Final class in package flash.text.engine
- The SpaceJustifier class represents properties that control the justification options for text lines in a text block.
SpaceJustifier(locale:String, lineJustification:String, letterSpacing:Boolean) — Constructor in class flash.text.engine.SpaceJustifier
- Creates a SpaceJustifier object.
spanMarker — Static property in class flash.profiler.Telemetry
- Returns a marker for use with Telemetry.sendSpanMetric -
SPEAKER_MUTE — Constant static property in class flash.media.MicrophoneEnhancedMode
- Use this mode when the speaker is muted.
specifiedWidth — Property in class flash.text.engine.TextLine
- The width that was specified to the TextBlock.createTextLine() method when it created the line.
speed — Property in class flash.events.GeolocationEvent
- The speed in meters/second.
SPEEX — Constant static property in class flash.media.SoundCodec
- Specifies that the Speex codec be used for compressing audio.
splice(startIndex:int, deleteCount:uint, ... rest) — Method in class Array
- - Adds elements to and removes elements from an array.
splice(startIndex:int, deleteCount:uint, ... rest) — Method in class Vector
- Adds elements to and removes elements from the Vector.
split(delimiter, limit:Number) — Method in class String
- - Splits a String object into an array of substrings - - by dividing it wherever the specified delimiter parameter - - occurs.
splitTextElement(elementIndex:int, splitIndex:int) — Method in class flash.text.engine.GroupElement
- Splits a TextElement into two, creating a new TextElement at the specified position.
spreadMethod — Property in class flash.display.GraphicsGradientFill
- A value from the SpreadMethod class that - specifies which spread method to use.
SpreadMethod — Final class in package flash.display
-The SpreadMethod class provides values for the spreadMethod parameter -in the beginGradientFill() and lineGradientStyle() methods of the Graphics class.
Sprite — Class in package flash.display
- The Sprite class is a basic display list building block: a display list node that can display - graphics and can also contain children.
Sprite() — Constructor in class flash.display.Sprite
- Creates a new Sprite instance.
sql — Property in class flash.data.SQLSchema
- Returns the entire text of the SQL statement that was used to create this schema object.
SQLCollationType — Class in package flash.data
- This class contains the constants that represent the possible values for the - defaultCollationType parameter of the SQLColumnSchema constructor, as well as the - SQLColumnSchema.defaultCollationType property.
SQLColumnNameStyle — Class in package flash.data
- This class contains the constants that represent the possible values for the - SQLConnection.columnNameStyle property.
SQLColumnSchema — Class in package flash.data
- The SQLColumnSchema class provides information describing the characteristics of a specific column - within a table in a database.
SQLColumnSchema(name:String, primaryKey:Boolean, allowNull:Boolean, autoIncrement:Boolean, dataType:String, defaultCollationType:String) — Constructor in class flash.data.SQLColumnSchema
- Constructs a SQLColumnSchema instance.
sqlConnection — Property in class flash.data.SQLStatement
- The SQLConnection object that manages the connection to the database or databases on which - the statement is executed.
SQLConnection — Class in package flash.data
- A SQLConnection instance is used to manage the creation of and connection to local SQL database files - (local databases).
SQLConnection() — Constructor in class flash.data.SQLConnection
- Creates a SQLConnection instance.
SQLError — Class in package flash.errors
- A SQLError instance provides detailed information about a failed operation.
SQLError(operation:String, details:String, message:String, id:int, detailID:int, detailArgs:Array) — Constructor in class flash.errors.SQLError
- Creates a SQLError instance that can be thrown or used with a - SQLErrorEvent instance's error property.
SQLErrorEvent — Class in package flash.events
- A SQLErrorEvent instance is dispatched by a SQLConnection instance or SQLStatement instance - when an error occurs while performing a database operation in asynchronous execution mode.
SQLErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, error:flash.errors:SQLError) — Constructor in class flash.events.SQLErrorEvent
- Creates a SQLErrorEvent object to pass as an argument to event listeners.
SQLErrorOperation — Class in package flash.errors
- This class contains the constants that represent the possible values for the - SQLError.operation property.
SQLEvent — Class in package flash.events
- Adobe AIR dispatches SQLEvent objects when one of the operations performed by - a SQLConnection or SQLStatement instance completes successfully.
SQLEvent(type:String, bubbles:Boolean, cancelable:Boolean) — Constructor in class flash.events.SQLEvent
- Creates a SQLEvent object to pass as a parameter to event listeners.
SQLIndexSchema — Class in package flash.data
- A SQLIndexSchema instance provides information describing a specific index - in a database.
SQLIndexSchema(database:String, name:String, sql:String, table:String) — Constructor in class flash.data.SQLIndexSchema
- Creates a SQLIndexSchema instance.
SQLMode — Class in package flash.data
- This class contains the constants that represent the possible values for the - openMode parameter of the SQLConnection.open() and - SQLConnection.openAsync() methods.
SQLResult — Class in package flash.data
- The SQLResult class provides access to data returned in response to the execution of a - SQL statement (a SQLStatement instance).
SQLResult(data:Array, rowsAffected:Number, complete:Boolean, rowID:Number) — Constructor in class flash.data.SQLResult
- Creates a SQLResult instance.
SQLSchema — Class in package flash.data
- The SQLSchema class is the base class for schema information for database objects - such as tables, views, and indices.
SQLSchema(database:String, name:String, sql:String) — Constructor in class flash.data.SQLSchema
- Creates a SQLSchema instance.
SQLSchemaResult — Class in package flash.data
- A SQLSchemaResult instance contains the information resulting from a call to - the SQLConnection.loadSchema() method.
SQLSchemaResult(tables:Array, views:Array, indices:Array, triggers:Array) — Constructor in class flash.data.SQLSchemaResult
- Creates a SQLSchemaResult instance.
SQLStatement — Class in package flash.data
- A SQLStatement instance is used to execute a SQL statement against a local SQL database - that is open through a SQLConnection instance.
SQLStatement() — Constructor in class flash.data.SQLStatement
- Creates a SQLStatement instance.
SQLTableSchema — Class in package flash.data
- A SQLTableSchema instance provides information describing a specific table - in a database.
SQLTableSchema(database:String, name:String, sql:String, columns:Array) — Constructor in class flash.data.SQLTableSchema
- Creates a SQLTableSchema instance.
SQLTransactionLockType — Class in package flash.data
- This class contains the constants that represent the possible values for the - option parameter of the SQLConnection.begin() method.
SQLTriggerSchema — Class in package flash.data
- A SQLTriggerSchema instance provides information describing a specific trigger - in a database.
SQLTriggerSchema(database:String, name:String, sql:String, table:String) — Constructor in class flash.data.SQLTriggerSchema
- Creates a SQLTriggerSchema instance.
SQLUpdateEvent — Class in package flash.events
- A SQLUpdateEvent object is dispatched by a SQLConnection object when a data change occurs - on any table associated with the SQLConnection instance.
SQLUpdateEvent(type:String, bubbles:Boolean, cancelable:Boolean, table:String, rowID:Number) — Constructor in class flash.events.SQLUpdateEvent
- Creates a new SQLUpdateEvent instance.
SQLViewSchema — Class in package flash.data
- A SQLViewSchema instance provides information describing a specific view - in a database.
SQLViewSchema(database:String, name:String, sql:String, columns:Array) — Constructor in class flash.data.SQLViewSchema
- Creates a SQLViewSchema instance.
sqrt(val:Number) — Static method in class Math
- - Computes and returns the square root of the specified number.
SQRT1_2 — Constant static property in class Math
- - A mathematical constant for the square root of one-half, with an approximate - - value of 0.7071067811865476.
SQRT2 — Constant static property in class Math
- - A mathematical constant for the square root of 2, with an approximate - - value of 1.4142135623730951.
SQUARE — Constant static property in class flash.display.CapsStyle
- - Used to specify square caps in the caps parameter of the - flash.display.Graphics.lineStyle() method.
srcAddress — Property in class flash.events.DatagramSocketDataEvent
- The IP address of the machine that sent the packet.
srcPort — Property in class flash.events.DatagramSocketDataEvent
- The port on the machine that sent the packet.
SRTT — Property in class flash.net.NetStreamInfo
- The smoothed round trip time (SRTT) for the NetStream session, in milliseconds.
SRVRecord — Class in package flash.net.dns
- The SRVRecord class represents a Domain Name System (DNS) SRV resource record containing a service host.
SRVRecord() — Constructor in class flash.net.dns.SRVRecord
- Creates an SRV resource record.
StackOverflowError — Dynamic class in package flash.errors
- - ActionScript throws a StackOverflowError exception when the stack available to the script - - is exhausted.
StackOverflowError(message:String) — Constructor in class flash.errors.StackOverflowError
- - Creates a new StackOverflowError object.
stackTrace — Property in class flash.events.HTMLUncaughtScriptExceptionEvent
- An array of objects that represent the stack trace at the time the throw statement - that resulted in the uncaught exception was executed.
stage — Property in class flash.display.DisplayObject
- - The Stage of the display object.
stage — Property in class flash.display.NativeWindow
- - The Stage object for this window.
stage — Property in class flash.media.StageWebView
- - The stage on which this StageWebView object is displayed.
stage — Property in class flash.text.StageText
- - The stage on which this StageText object is displayed.
Stage — Class in package flash.display
- The Stage class represents the main drawing area.
Stage3D — Class in package flash.display
- The Stage3D class provides a display area and a programmable rendering context for drawing 2D and 3D graphics.
Stage3D() — Constructor in class flash.display.Stage3D
stage3Ds — Property in class flash.display.Stage
- A list of Stage3D objects available for displaying 3-dimensional content.
StageAlign — Final class in package flash.display
-The StageAlign class provides constant values to use for the Stage.align property.
StageAspectRatio — Final class in package flash.display
- The StageAspectRatio class provides values for the Stage.setAspectRatio() method.
StageDisplayState — Final class in package flash.display
-The StageDisplayState class provides values for the Stage.displayState property.
stageFocusRect — Property in class flash.display.Stage
- Specifies whether or not objects display a glowing border when they have focus.
stageHeight — Property in class flash.display.Stage
- The current height, in pixels, of the Stage.
StageOrientation — Final class in package flash.display
- The StageOrientation class defines constants enumerating the possible orientations of the stage and the device.
StageOrientationEvent — Class in package flash.events
- A Stage object dispatches a StageOrientationEvent object when the orientation - of the stage changes.
StageOrientationEvent(type:String, bubbles:Boolean, cancelable:Boolean, beforeOrientation:String, afterOrientation:String) — Constructor in class flash.events.StageOrientationEvent
- Creates a StageOrientationEvent object with specific information relevant to stage orientation events.
StageQuality — Final class in package flash.display
-The StageQuality class provides values for the Stage.quality property -and for the value of the quality parameter to -the BitmapData.drawWithQuality() method.
StageScaleMode — Final class in package flash.display
-The StageScaleMode class provides values for the Stage.scaleMode property.
StageText — Final class in package flash.text
- - The StageText class is used to present the user with a native text input field.
StageText(initOptions:flash.text:StageTextInitOptions) — Constructor in class flash.text.StageText
- - Creates a StageText object.
StageTextClearButtonMode — Final class in package flash.text
- This class defines an enumeration that provides option for clearButton.
StageTextContentType — Final class in package flash.text
- - The StageTextContentType class defines the content type/hint that is provided to mobile - - operating systems when using a StageText text input control.
StageTextInitOptions — Class in package flash.text
- The StageTextInitOptions class defines the options available for initializing - a StageText object.
StageTextInitOptions(multiline:Boolean) — Constructor in class flash.text.StageTextInitOptions
- Creates a StageTextInitOptions object.
StageVideo — Class in package flash.media
- The StageVideo object uses the device's hardware acceleration capabilities, if available, to display - live or recorded video in an application.
stageVideoAvailability — Event in class flash.display.Stage
- Dispatched by the Stage object when the state of the stageVideos property changes.
StageVideoAvailability — Final class in package flash.media
- This class defines an enumeration that indicates whether stage video is currently available.
STAGE_VIDEO_AVAILABILITY — Constant static property in class flash.events.StageVideoAvailabilityEvent
- Defines the value of the type property of a stageVideoAvailability event object.
StageVideoAvailabilityEvent — Class in package flash.events
-

This event fires when the state of the Stage.stageVideos property changes.

StageVideoAvailabilityEvent(type:String, bubbles:Boolean, cancelable:Boolean, availability:String) — Constructor in class flash.events.StageVideoAvailabilityEvent
-

Constructor.

-
StageVideoAvailabilityReason — Final class in package flash.media
- This class defines an enumeration that indicates whether stage video is currently available.
StageVideoEvent — Class in package flash.events
- A StageVideo object dispatches a StageVideoEvent object after the attachNetStream() method - of the StageVideo object and the play() method of - the attached NetStream object have both been called.
StageVideoEvent(type:String, bubbles:Boolean, cancelable:Boolean, status:String, colorSpace:String) — Constructor in class flash.events.StageVideoEvent
- Creates an Event object that contains information about StageVideo events.
stageVideos — Property in class flash.display.Stage
- - A list of StageVideo objects available for playing external videos.
StageWebView — Final class in package flash.media
- - The StageWebView class displays HTML content in a stage view port.
StageWebView(... rest) — Constructor in class flash.media.StageWebView
- - Creates a StageWebView object.
stageWidth — Property in class flash.display.Stage
- Specifies the current width, in pixels, of the Stage.
stageX — Property in class flash.events.GestureEvent
- The horizontal coordinate at which the event occurred in global Stage coordinates.
stageX — Property in class flash.events.MouseEvent
- - The horizontal coordinate at which the event occurred in global Stage coordinates.
stageX — Property in class flash.events.TouchEvent
- The horizontal coordinate at which the event occurred in global Stage coordinates.
stageY — Property in class flash.events.GestureEvent
- The vertical coordinate at which the event occurred in global Stage coordinates.
stageY — Property in class flash.events.MouseEvent
- - The vertical coordinate at which the event occurred in global Stage coordinates.
stageY — Property in class flash.events.TouchEvent
- The vertical coordinate at which the event occurred in global Stage coordinates.
STANDALONE — Constant static property in class flash.globalization.DateTimeNameContext
- Indicates that the date element name is used in a "stand alone" context, independent of other formats.
STANDARD — Constant static property in class flash.desktop.InvokeEventReason
- Indicates that the InvokeEvent occured for any reason other than login or open url.
STANDARD — Constant static property in class flash.display.NativeWindowSystemChrome
- The standard chrome for the host operating system.
STANDARD — Constant static property in class flash.display3D.Context3DProfile
- Use an standard profile to target GPUs which support MRT, AGAL2 and float textures.
STANDARD — Constant static property in class flash.ui.KeyLocation
- Indicates the key activation is not distinguished as the left or right version of the key, - and did not originate on the numeric keypad (or did not originate with a virtual - key corresponding to the numeric keypad).
STANDARD_CONSTRAINED — Constant static property in class flash.display3D.Context3DProfile
- Use an standard profile to target GPUs which support AGAL2 and float textures.
standardError — Property in class flash.desktop.NativeProcess
- Provides access to the standard error output from this native process.
standardErrorClose — Event in class flash.desktop.NativeProcess
- Signals that the NativeProcess has closed its error stream.
STANDARD_ERROR_CLOSE — Constant static property in class flash.events.Event
- The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
standardErrorData — Event in class flash.desktop.NativeProcess
- Signals that the native process has data available to read on the standard error (stderror) stream.
STANDARD_ERROR_DATA — Constant static property in class flash.events.ProgressEvent
- Defines the value of the type property of a standardErrorData event object.
standardErrorIoError — Event in class flash.desktop.NativeProcess
- Signals that reading from the standard error (stderror) stream has failed.
STANDARD_ERROR_IO_ERROR — Constant static property in class flash.events.IOErrorEvent
- The standardErrorIoError event is dispatched when an error occurs while - reading data from the standardError stream of a NativeProcess object.
STANDARD_EXTENDED — Constant static property in class flash.display3D.Context3DProfile
- Use standard extended profile to target GPUs which support AGAL3 and instanced drawing feature.
standardInput — Property in class flash.desktop.NativeProcess
- Provides access to the standard input of this native process.
standardInputClose — Event in class flash.desktop.NativeProcess
- Signals that the NativeProcess object has closed its input stream by calling the closeInput() - method.
STANDARD_INPUT_CLOSE — Constant static property in class flash.events.Event
- The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
standardInputIoError — Event in class flash.desktop.NativeProcess
- Signals that writing to the standard input (stdin) stream has failed.
STANDARD_INPUT_IO_ERROR — Constant static property in class flash.events.IOErrorEvent
- The standardInputIoError event is dispatched when an error occurs while - writing data to the standardInput of a NativeProcess object.
standardInputProgress — Event in class flash.desktop.NativeProcess
- Signals that the NativeProcess has written data to the input stream for the child process.
STANDARD_INPUT_PROGRESS — Constant static property in class flash.events.ProgressEvent
- Defines the value of the type property of a standardInputProgress event object.
standardOutput — Property in class flash.desktop.NativeProcess
- Provides access to the standard output pipe of this native process.
standardOutputClose — Event in class flash.desktop.NativeProcess
- Signals that the NativeProcess has closed its output stream.
STANDARD_OUTPUT_CLOSE — Constant static property in class flash.events.Event
- The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
standardOutputData — Event in class flash.desktop.NativeProcess
- Signals that the native process has data available to read on the output stream.
STANDARD_OUTPUT_DATA — Constant static property in class flash.events.ProgressEvent
- Defines the value of the type property of a standardOutputData event object.
standardOutputIoError — Event in class flash.desktop.NativeProcess
- Signals that reading from the stdout stream has failed.
STANDARD_OUTPUT_IO_ERROR — Constant static property in class flash.events.IOErrorEvent
- The standardOutputIoError event is dispatched when an error occurs while - reading data from the standardOutput stream of a NativeProcess object.
start(info:flash.desktop:NativeProcessStartupInfo) — Method in class flash.desktop.NativeProcess
- Starts the native process identified by the start up info specified.
start(waitForCompletion:Boolean) — Method in class flash.display.ShaderJob
- Starts a shader operation in synchronous or asynchronous mode, according to the - value of the waitForCompletion parameter.
start — Property in class flash.net.NetStreamPlayOptions
- The start time, in seconds, for streamName.
start() — Method in class flash.printing.PrintJob
- Displays the operating system's Print dialog box and starts spooling.
start() — Method in class flash.system.Worker
- Starts the execution of the worker.
start() — Method in class flash.utils.Timer
- Starts the timer, if it is not already running.
START — Constant static property in class flash.text.TextFormatAlign
- Constant; aligns text to the start edge of a line.
START — Constant static property in class flash.text.engine.TabAlignment
- Positions the start of the tabbed text at the tab stop.
start2(uiOptions:flash.printing:PrintUIOptions, showPrintDialog:Boolean) — Method in class flash.printing.PrintJob
- Optionally displays the operating system's Print dialog box, starts spooling, and - possibly modifies the PrintJob read-only property values.
startAtLogin — Property in class flash.desktop.NativeApplication
- - Specifies whether this application is automatically launched whenever the - - current user logs in.
startCachingSamples(numSamples:int, controls) — Method in class flash.ui.GameInputDevice
- Requests this device to start keeping a cache of sampled values.
startDate — Property in class flash.net.drm.DRMPlaybackTimeWindow
- The start date for the period of time during which a DRM voucher is valid - (the playback window).
startDrag(lockCenter:Boolean, bounds:flash.geom:Rectangle) — Method in class flash.display.Sprite
- Lets the user drag the specified sprite.
startIndex — Property in class flash.globalization.NumberParseResult
- The index of the first character of the numeric portion of the input string.
startMove() — Method in class flash.display.NativeWindow
- - Starts a system-controlled move of this window.
startResize(edgeOrCorner:String) — Method in class flash.display.NativeWindow
- - Starts a system-controlled resize operation of this window.
startServer(s:flash.net:Socket) — Method in class air.net.WebSocket
- - Takes over an existing connection in order to act as a socket server.
startsWith(other:String) — Method in class String
- - Checks whether this String object starts with the string that is passed in.
startTouchDrag(touchPointID:int, lockCenter:Boolean, bounds:flash.geom:Rectangle) — Method in class flash.display.Sprite
- Lets the user drag the specified sprite on a touch-enabled device.
state — Property in class flash.events.ThrottleEvent
- Describes the state that the player is entering: - ThrottleType.THROTTLE, ThrottleType.PAUSE, or ThrottleType.RESUME.
state — Property in class flash.system.MessageChannel
- - Indicates the current state of the MessageChannel object (open, - - closing, or closed).
state — Property in class flash.system.Worker
- The current state of the worker in its lifecycle.
STATEMENT — Constant static property in class flash.printing.PaperSize
- Statement size - -
stateOrProvinceName — Property in class flash.security.X500DistinguishedName
- Returns the DN StateOrProvinceName attribute.
static — Statement
Specifies that a variable, constant, or method belongs to the class, rather than to instances of the class.
STATIC — Constant static property in class flash.text.engine.TextLineValidity
- Specifies that the line is static, and that the connection between the line and the text block has been severed.
STATIC_DRAW — Constant static property in class flash.display3D.Context3DBufferUsage
- Indicates the buffer will be used for drawing and be updated once - -

This type is the default value for buffers in Stage3D.

- -
StaticText — Final class in package flash.text
- This class represents StaticText objects on the display list.
status — Property in class flash.events.HTTPStatusEvent
- The HTTP status code returned by the server.
status — Property in class flash.events.PermissionEvent
- Check whether the permission has been granted or denied.
status — Property in class flash.events.StageVideoEvent
- The status of the StageVideo object.
status — Property in class flash.events.VideoEvent
-

Returns the rendering status of the VideoEvent object.

status — Property in class flash.events.VideoTextureEvent
- The status of the VideoTexture object.
status — Event in class flash.external.ExtensionContext
- - The ExtensionContext class provides an interface for calling functions - - in the native implementation of a native extension for Adobe AIR.
status — Event in class flash.media.Camera
- - Dispatched when a camera reports its status.
status — Event in class flash.media.Microphone
- Dispatched when a microphone reports its status.
status — Event in class flash.net.LocalConnection
- Dispatched when a LocalConnection object reports its status.
status — Event in class flash.net.NetStream
- Dispatched when the application attempts to play content encrypted with digital rights management (DRM), - by invoking the NetStream.play() method.
status — Event in class flash.notifications.RemoteNotifier
- Dispatched if an error is encountered during the subscription process.
status — Event in class flash.sensors.Accelerometer
- Dispatched when an accelerometer changes its status.
status — Event in class flash.sensors.DeviceRotation
- Dispatched when device rotation changes its status.
status — Event in class flash.sensors.Geolocation
- The Geolocation object dispatches status events when the user changes access - to the location sensor.
status — Event in class flash.system.SystemUpdater
- Dispatched when the update fails.
STATUS — Constant static property in class flash.events.StatusEvent
- Defines the value of the type property of a status event object.
statusBarVisible — Property in class flash.html.HTMLWindowCreateOptions
- Specifies whether a status bar should be displayed.
StatusEvent — Class in package flash.events
- An object dispatches a StatusEvent object when a device, such as a camera or microphone, or an object such as a LocalConnection object reports its status.
StatusEvent(type:String, bubbles:Boolean, cancelable:Boolean, code:String, level:String) — Constructor in class flash.events.StatusEvent
- Creates an Event object that contains information about status events.
StatusFileUpdateErrorEvent — Class in package air.update.events
- - A StatusUpdateFileErrorEvent is dispatched when a call to the checkForUpdate() method of a ApplicationUpdater object encounters an error - - while downloading or parsing the update descriptor file.
StatusFileUpdateErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, text:String, id:int) — Constructor in class air.update.events.StatusFileUpdateErrorEvent
- - The constructor function.
StatusFileUpdateEvent — Class in package air.update.events
- - Dispatched after the updater successfully validates the - - file in the call to the installFromAIRFile() method.
StatusFileUpdateEvent(type:String, bubbles:Boolean, cancelable:Boolean, available:Boolean, version:String, path:String) — Constructor in class air.update.events.StatusFileUpdateEvent
- - The constructor function.
STATUS_OK — Constant static property in class flash.html.HTMLPDFCapability
- A sufficient version (8.1 or later) of Adobe Reader is detected and PDF content - can be loaded in an HTMLLoader object.
STATUS_OK — Constant static property in class flash.html.HTMLSWFCapability
- A sufficient version of Adobe Flash Player is detected and SWF content - can be loaded in a HTMLLoader object.
StatusUpdateErrorEvent — Class in package air.update.events
- - A StatusUpdateErrorEvent is dispatched when a call to the checkForUpdate() method - - of an ApplicationUpdater object encounters an error while downloading or parsing the update descriptor file.
StatusUpdateErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, text:String, id:int, subErrorID:int) — Constructor in class air.update.events.StatusUpdateErrorEvent
- - The constructor function.
StatusUpdateEvent — Class in package air.update.events
- - An updater object dispatches a StatusUpdateEvent object after the updater successfully - - downloads and interprets the update descriptor file.
StatusUpdateEvent(type:String, bubbles:Boolean, cancelable:Boolean, available:Boolean, version:String, details:Array, versionLabel:String) — Constructor in class air.update.events.StatusUpdateEvent
- - The constructor function.
STENCIL — Constant static property in class flash.display3D.Context3DClearMask
- Clear only the stencil buffer.
step(frames:int) — Method in class flash.net.NetStream
- Steps forward or back the specified number of frames, relative to the currently displayed frame.
stop() — Method in class flash.display.MovieClip
- Stops the playhead in the movie clip.
stop() — Method in class flash.media.SoundChannel
- Stops the sound playing in the channel.
stop() — Method in class flash.media.StageWebView
- - Halts the current load operation.
stop() — Method in class flash.utils.Timer
- Stops the timer.
STOP — Constant static property in class flash.net.NetStreamPlayTransitions
- - Stops playing the streams in a playlist.
STOP — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for stopping transport mode.
stopAll() — Static method in class flash.media.SoundMixer
- Stops all sounds currently playing.
stopAllMovieClips() — Method in class flash.display.DisplayObjectContainer
- Recursively stops the timeline execution of all MovieClips rooted at this object.
stopCachingSamples() — Method in class flash.ui.GameInputDevice
- Stops sample caching.
stopDrag() — Method in class flash.display.Sprite
- Ends the startDrag() method.
stopImmediatePropagation() — Method in class flash.events.Event
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
stopPropagation() — Method in class flash.events.Event
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
stopTouchDrag(touchPointID:int) — Method in class flash.display.Sprite
- Ends the startTouchDrag() method, for use with touch-enabled devices.
storageVolume — Property in class flash.events.StorageVolumeChangeEvent
- A StorageVolume object containing information about a mounted volume.
StorageVolume — Class in package flash.filesystem
- A StorageVolume object includes properties defining a mass storage volume.
StorageVolume(rootDirPath:flash.filesystem:File, name:String, writable:Boolean, removable:Boolean, fileSysType:String, drive:String) — Constructor in class flash.filesystem.StorageVolume
- The constructor function.
StorageVolumeChangeEvent — Class in package flash.events
- The StorageVolumeInfo.storageVolumeInfo object dispatches a StorageVolumeChangeEvent event - object when a storage volume is mounted or unmounted.
StorageVolumeChangeEvent(type:String, bubbles:Boolean, cancelable:Boolean, path:flash.filesystem:File, volume:flash.filesystem:StorageVolume) — Constructor in class flash.events.StorageVolumeChangeEvent
- Creates a StorageVolumeChangeEvent object to pass as an argument to event listeners.
storageVolumeInfo — Static property in class flash.filesystem.StorageVolumeInfo
- - The singleton instance of the StorageVolumeInfo object.
StorageVolumeInfo — Final class in package flash.filesystem
- - The StorageVolumeInfo object dispatches a StorageVolumeChangeEvent object when a - - storage volume is mounted or unmounted.
storageVolumeMount — Event in class flash.filesystem.StorageVolumeInfo
- - Dispatched when a storage volume has been mounted.
STORAGE_VOLUME_MOUNT — Constant static property in class flash.events.StorageVolumeChangeEvent
- The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the - type property of a StorageVolumeChangeEvent when a volume is mounted.
storageVolumeUnmount — Event in class flash.filesystem.StorageVolumeInfo
- - Dispatched when a storage volume has been unmounted.
STORAGE_VOLUME_UNMOUNT — Constant static property in class flash.events.StorageVolumeChangeEvent
- The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the - type property of a StorageVolumeChangeEvent when a volume is unmounted.
storeVoucher(voucher:flash.utils:ByteArray) — Method in class flash.net.drm.DRMManager
- - -
streamName — Property in class flash.net.NetStreamPlayOptions
- The name of the new stream to transition to or to play.
strength — Property in class flash.filters.BevelFilter
- The strength of the imprint or spread.
strength — Property in class flash.filters.DropShadowFilter
- The strength of the imprint or spread.
strength — Property in class flash.filters.GlowFilter
- The strength of the imprint or spread.
strength — Property in class flash.filters.GradientBevelFilter
- The strength of the imprint or spread.
strength — Property in class flash.filters.GradientGlowFilter
- The strength of the imprint or spread.
strikethroughOffset — Property in class flash.text.engine.FontMetrics
- The strikethroughOffset value is the suggested vertical offset from the Roman baseline for a strikethrough.
strikethroughThickness — Property in class flash.text.engine.FontMetrics
- The strikethroughThickness value is the suggested thickness for a strikethrough.
String — Final class in Top Level
- - The String class is a data type that represents a string of characters.
String(expression) — Package function in Top Level
- - Returns a string representation of the specified parameter.
String(val:String) — Constructor in class String
- - Creates a new String object initialized to the specified string.
STRING_BEGIN — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Begin constant - -
STRING_BREAK — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Break constant - -
STRING_CLEARDISPLAY — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Clear Display constant - -
STRING_CLEARLINE — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Clear Line constant - -
stringData — Property in class flash.events.WebSocketEvent
- - Retrieves the WebSocket message string for 'TEXT' messages.
STRING_DELETE — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Delete constant - -
STRING_DELETECHAR — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Delete Character constant - -
STRING_DELETELINE — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Delete Line constant - -
STRING_DOWNARROW — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode down arrow constant - -
STRING_END — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode End constant - -
STRING_EXECUTE — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Execute constant - -
STRING_F1 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F1 constant - -
STRING_F10 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F10 constant - -
STRING_F11 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F11 constant - -
STRING_F12 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F12 constant - -
STRING_F13 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F13 constant - -
STRING_F14 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F14 constant - -
STRING_F15 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F15 constant - -
STRING_F16 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F16 constant - -
STRING_F17 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F17 constant - -
STRING_F18 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F18 constant - -
STRING_F19 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F19 constant - -
STRING_F2 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F2 constant - -
STRING_F20 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F20 constant - -
STRING_F21 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F21 constant - -
STRING_F22 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F22 constant - -
STRING_F23 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F23 constant - -
STRING_F24 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F24 constant - -
STRING_F25 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F25 constant - -
STRING_F26 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F26 constant - -
STRING_F27 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F27 constant - -
STRING_F28 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F28 constant - -
STRING_F29 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F29 constant - -
STRING_F3 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F3 constant - -
STRING_F30 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F30 constant - -
STRING_F31 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F31 constant - -
STRING_F32 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F32 constant - -
STRING_F33 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F33 constant - -
STRING_F34 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F34 constant - -
STRING_F35 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F35 constant - -
STRING_F4 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F4 constant - -
STRING_F5 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F5 constant - -
STRING_F6 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F6 constant - -
STRING_F7 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F7 constant - -
STRING_F8 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F8 constant - -
STRING_F9 — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode F9 constant - -
STRING_FIND — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Find constant - -
STRING_HELP — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Help constant - -
STRING_HOME — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Home constant - -
stringify(value:Object, replacer, space) — Static method in class JSON
- - Returns a String, in JSON format, that represents an ActionScript value.
STRING_INSERT — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Insert constant - -
STRING_INSERTCHAR — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Insert Character constant - -
STRING_INSERTLINE — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Insert Line constant - -
STRING_LEFTARROW — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode left arrow constant - -
STRING_MENU — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Menu constant - -
STRING_MODESWITCH — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Mode Switch constant - -
STRING_NEXT — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Next constant - -
STRING_PAGEDOWN — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Page Down constant - -
STRING_PAGEUP — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Page Up constant - -
STRING_PAUSE — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Pause constant - -
STRING_PREV — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Previous constant - -
STRING_PRINT — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Print constant - -
STRING_PRINTSCREEN — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Print Screen constant - -
STRING_REDO — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Redo constant - -
STRING_RESET — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Reset constant - -
STRING_RIGHTARROW — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode right arrow constant - -
STRING_SCROLLLOCK — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Scroll Lock constant - -
STRING_SELECT — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Select constant - -
STRING_STOP — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Stop constant - -
STRING_SYSREQ — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode System Request constant - -
STRING_SYSTEM — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode System constant - -
StringTools — Final class in package flash.globalization
- The StringTools class provides locale-sensitive case conversion methods.
StringTools(requestedLocaleIDName:String) — Constructor in class flash.globalization.StringTools
- Constructs a new StringTools object that provides case conversion and other utilities according to - the conventions of a given locale.
STRING_UNDO — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode Undo constant - -
STRING_UPARROW — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode up arrow constant - -
STRING_USER — Constant static property in class flash.ui.Keyboard
- - The OS X Unicode User constant - -
stub — Property in class flash.accessibility.AccessibilityImplementation
- Used to create a component accessibility stub.
styleNames — Property in class flash.text.StyleSheet
- An array that contains the names (as strings) of all of the styles registered - in this style sheet.
styleSheet — Property in class flash.text.TextField
- - Attaches a style sheet to the text field.
StyleSheet — Dynamic class in package flash.text
- The StyleSheet class lets you create a StyleSheet object that contains text - formatting rules for font size, color, and other styles.
StyleSheet() — Constructor in class flash.text.StyleSheet
- Creates a new StyleSheet object.
STYLUS — Constant static property in class flash.system.TouchscreenType
- A touchscreen designed for use with a stylus.
subErrorID — Property in class air.update.events.DownloadErrorEvent
- - Provides information in addition to the errorId property.
subErrorID — Property in class air.update.events.StatusUpdateErrorEvent
- - Provides information in addition to the errorId property.
subErrorID — Property in class flash.errors.DRMManagerError
- The specific error number.
subErrorID — Property in class flash.events.DRMAuthenticationErrorEvent
- A more detailed error code.
subErrorID — Property in class flash.events.DRMDeviceGroupErrorEvent
subErrorID — Property in class flash.events.DRMErrorEvent
- An error ID that indicates more detailed information about the underlying problem.
subErrorID — Property in class flash.events.DRMReturnVoucherErrorEvent
- A more detailed error code.
subInterfaces — Property in class flash.net.NetworkInterface
- The list of subinterfaces attached to this network interface.
subject — Property in class flash.security.X509Certificate
- Provides the subject's Distinguished Name (DN).
subjectPublicKey — Property in class flash.security.X509Certificate
- Provides the subject's public key.
subjectPublicKeyAlgorithmOID — Property in class flash.security.X509Certificate
- Provides the algorithm OID for the subject's public key.
subjectUniqueID — Property in class flash.security.X509Certificate
- Provides the subject's unique identifier.
submenu — Property in class flash.display.NativeMenuItem
- - The submenu associated with this menu item.
SUBPIXEL — Constant static property in class flash.text.GridFitType
- Fits strong horizontal and vertical lines to the sub-pixel - grid on LCD monitors.
subscribe(options:flash.notifications:RemoteNotifierSubscribeOptions) — Method in class flash.notifications.RemoteNotifier
- Subscribes/registers the application to receive remote notifications from APNs.
subscriptOffset — Property in class flash.text.engine.FontMetrics
- The subscriptOffset value is the suggested vertical offset from the Roman baseline for a subscript.
subscriptScale — Property in class flash.text.engine.FontMetrics
- The subscriptScale value is the suggested scale factor to apply to the point size for a subscript.
substr(startIndex:Number, len:Number) — Method in class String
- - Returns a substring consisting of the characters that start at the specified - - startIndex and with a length specified by len.
substring(startIndex:Number, endIndex:Number) — Method in class String
- - Returns a string consisting of the character specified by startIndex - - and all characters up to endIndex - 1.
SUBTITLE — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for toggling subtitles.
subtract(v:flash.geom:Point) — Method in class flash.geom.Point
- Subtracts the coordinates of another point from the coordinates of this point to create a new - point.
subtract(a:flash.geom:Vector3D) — Method in class flash.geom.Vector3D
- Subtracts the value of the x, y, and z elements of the current Vector3D object - from the values of the x, y, and z elements of another Vector3D object.
SUBTRACT — Constant static property in class flash.display.BlendMode
-Subtracts the values of the constituent colors in the display object from the values of the background -color, applying a floor of 0.
subtractToOutput(v:flash.geom:Point, output:flash.geom:Point) — Method in class flash.geom.Point
- Subtracts the coordinates of another point from the coordinates of this point to create a new - point.
subtractToOutput(a:flash.geom:Vector3D, output:flash.geom:Vector3D) — Method in class flash.geom.Vector3D
- Subtracts the value of the x, y, and z elements of the current Vector3D object - from the values of the x, y, and z elements of another Vector3D object.
SUCCESS — Constant static property in class flash.text.engine.TextLineCreationResult
- Indicates the line was successfully broken.
SUNDANESE — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Sundanese digit set.
super — Statement
Invokes the superclass or parent version of a method or constructor.
superscriptOffset — Property in class flash.text.engine.FontMetrics
- The superscriptOffset value is the suggested vertical offset from the Roman baseline for a superscript.
superscriptScale — Property in class flash.text.engine.FontMetrics
- The superscriptScale value is the suggested scale factor to apply to the point size for a superscript.
supportedGestures — Static property in class flash.ui.Multitouch
- A Vector array (a typed array of string values) of multi-touch contact types supported in the current environment.
supportedNotificationStyles — Static property in class flash.notifications.RemoteNotifier
- A vector list of all supported notification styles.
supportedOrientations — Property in class flash.display.Stage
- The orientations supported by the current device.
supports32BitProcesses — Static property in class flash.system.Capabilities
- Specifies whether the system supports running 32-bit processes.
supports64BitProcesses — Static property in class flash.system.Capabilities
- Specifies whether the system supports running 64-bit processes.
supportsAddBitmapData — Static property in class flash.media.CameraRoll
- Whether the CameraRoll.addBitmapData() method is supported.
supportsBrowseForImage — Static property in class flash.media.CameraRoll
- Reports whether the CameraRoll.browseForImage() method is supported.
supportsCursor — Static property in class flash.ui.Mouse
- Indicates whether the computer or device displays a persistent cursor.
supportsDefaultApplication — Static property in class flash.desktop.NativeApplication
- - Indicates whether setAsDefaultApplication(), removeAsDefaultApplication(), and - - isSetAsDefaultApplication() are supported on the current platform.
supportsDockIcon — Static property in class flash.desktop.NativeApplication
- - Indicates whether AIR supports dock-style application icons on the current operating system.
supportsFilePromise — Property in class flash.desktop.Clipboard
- Indicates whether the file promise clipboard format is supported on the client system.
supportsGestureEvents — Static property in class flash.ui.Multitouch
- Indicates whether the current environment supports gesture input, such as rotating two fingers - around a touch screen.
supportsMenu — Static property in class flash.desktop.NativeApplication
- - Specifies whether the current operating system supports a global application menu bar.
supportsMenu — Static property in class flash.display.NativeWindow
- - Indicates whether AIR supports native window menus on the current computer system.
supportsNativeCursor — Static property in class flash.ui.Mouse
- Indicates whether the current configuration supports native cursors.
supportsNotification — Static property in class flash.display.NativeWindow
- - Indicates whether AIR supports window notification cueing on the current computer system.
supportsOrientationChange — Static property in class flash.display.Stage
- Whether the application supports changes in the stage orientation (and device rotation).
supportsPageSetupDialog — Static property in class flash.printing.PrintJob
- Indicates whether the Flash runtime environment supports a separate - Page Setup dialog.
supportsStartAtLogin — Static property in class flash.desktop.NativeApplication
- - Indicates whether startAtLogin is supported on the current platform.
supportsSystemTrayIcon — Static property in class flash.desktop.NativeApplication
- - Specifies whether AIR supports system tray icons on the current operating system.
supportsTouchEvents — Static property in class flash.ui.Multitouch
- Indicates whether the current environment supports basic touch input, such as a single finger tap.
supportsTransparency — Static property in class flash.display.NativeWindow
- - Indicates whether AIR supports native windows with transparent pixels.
supportsVideoTexture — Static property in class flash.display3D.Context3D
- - Indicates if Context3D supports video texture.
suspend — Event in class flash.desktop.NativeApplication
- - Dispatched when the application is about to be suspended by the operating system.
SUSPEND — Constant static property in class flash.events.Event
- The Event.SUSPEND constant defines the value of the type property of an suspend event object.
SWAP — Constant static property in class flash.net.NetStreamPlayTransitions
- Replaces a content stream with a different content stream and maintains the rest of the playlist.
swapChildren(child1:flash.display:DisplayObject, child2:flash.display:DisplayObject) — Method in class flash.display.DisplayObjectContainer
- Swaps the z-order (front-to-back order) of the two specified child objects.
swapChildrenAt(index1:int, index2:int) — Method in class flash.display.DisplayObjectContainer
- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list.
swapChildrenAt(index1:int, index2:int) — Method in class flash.display.Stage
- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list.
swfCapability — Static property in class flash.html.HTMLLoader
swfVersion — Property in class flash.display.LoaderInfo
- The file format version of the loaded SWF file.
SWFVersion — Final class in package flash.display
- The SWFVersion class is an enumeration of constant values that indicate the - file format version of a loaded SWF file.
switch — Statement
Causes control to transfer to one of several statements, depending on the value of an expression.
SWITCH — Constant static property in class flash.net.NetStreamPlayTransitions
- Switches from playing one stream to another stream, typically with streams of the same content.
sxi1(value) — Package function in avm2.intrinsics.memory
- - Sign-extends a 1-bit integer value to a 32-bit integer value.
sxi16(value) — Package function in avm2.intrinsics.memory
- - Sign-extends a 16-bit integer value to a 32-bit integer value.
sxi8(value) — Package function in avm2.intrinsics.memory
- - Sign-extends an 8-bit integer value to a 32-bit integer value.
sync — Event in class flash.net.SharedObject
- Dispatched when a remote shared object has been updated by the server.
SYNC — Constant static property in class flash.events.SyncEvent
- Defines the value of the type property of a sync event object.
SyncEvent — Class in package flash.events
- An SharedObject object representing a remote shared object dispatches a SyncEvent object when the remote - shared object has been updated by the server.
SyncEvent(type:String, bubbles:Boolean, cancelable:Boolean, changeList:Array) — Constructor in class flash.events.SyncEvent
- Creates an Event object that contains information about sync events.
SyntaxError — Dynamic class in Top Level
- - A SyntaxError exception is thrown when a parsing error occurs, for one of the following reasons:.
SyntaxError(message:String) — Constructor in class SyntaxError
- - Creates a new SyntaxError object.
System — Final class in package flash.system
- - The System class contains properties related to local settings and operations.
SYSTEM — Constant static property in class flash.system.SystemUpdaterType
- Updates the player runtime itself.
systemCharset — Static property in class flash.filesystem.File
- - The default encoding used by the host operating system.
systemChrome — Property in class flash.display.NativeWindow
- - Reports the system chrome setting used to create this window.
systemChrome — Property in class flash.display.NativeWindowInitOptions
- Specifies whether system chrome is provided for the window.
systemClearMenuItem() — Static method in class flash.ui.ContextMenuItem
systemCopyLinkMenuItem() — Static method in class flash.ui.ContextMenuItem
systemCopyMenuItem() — Static method in class flash.ui.ContextMenuItem
systemCutMenuItem() — Static method in class flash.ui.ContextMenuItem
systemIdleMode — Property in class flash.desktop.NativeApplication
- - Provides a way for applications to prevent the user interface from going into "idle" mode.
SystemIdleMode — Final class in package flash.desktop
- The SystemIdleMode class provides constant values for system idle behaviors.
systemMaxSize — Static property in class flash.display.NativeWindow
- - The largest window size allowed by the operating system.
systemMinSize — Static property in class flash.display.NativeWindow
- - The smallest window size allowed by the operating system.
systemOpenLinkMenuItem() — Static method in class flash.ui.ContextMenuItem
systemPasteMenuItem() — Static method in class flash.ui.ContextMenuItem
systemSelectAllMenuItem() — Static method in class flash.ui.ContextMenuItem
SystemTrayIcon — Class in package flash.desktop
- The SystemTrayIcon class represents the Windows® taskbar notification - area (system tray)-style icon.
systemUpdateNeeded — Property in class flash.events.DRMDeviceGroupErrorEvent
systemUpdateNeeded — Property in class flash.events.DRMErrorEvent
- Indicates whether a system update is needed to play the DRM-protected content.
SystemUpdater — Class in package flash.system
- The SystemUpdater class allows you to update modules of the Flash Player, - such as the DRM module for Adobe Access, as well as the Flash Player itself.
SystemUpdater() — Constructor in class flash.system.SystemUpdater
- Constructor.
SystemUpdaterType — Class in package flash.system
- The SystemUpdaterType class provides constants for a system update.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/all-index-Symbols.html b/html-docs/all-index-Symbols.html deleted file mode 100644 index 1cd65d4..0000000 --- a/html-docs/all-index-Symbols.html +++ /dev/null @@ -1,451 +0,0 @@ - - - - - -Symbols Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
@ (attribute identifier) — Operator
Identifies attributes of an XML or XMLList object.
* — Special Type
Specifies that a property is untyped.
+ (addition) — Operator
Adds numeric expressions.
+= (addition assignment) — Operator
Assigns expression1 the value of expression1 + expression2.
[] (array access) — Operator
Initializes a new array or multidimensional array with the specified elements (a0, and so on), or accesses elements in an array.
= (assignment) — Operator
Assigns the value of expression2 (the operand on the right) to the variable, array element, or property in expression1.
& (bitwise AND) — Operator
Converts expression1 and expression2 to 32-bit unsigned integers, and performs a Boolean AND operation on each bit of the integer parameters.
&= (bitwise AND assignment) — Operator
Assigns expression1 the value of expression1 & expression2.
<< (bitwise left shift) — Operator
Converts expression1 and shiftCount to 32-bit integers, and shifts all the bits in expression1 to the left by the number of places specified by the integer resulting from the conversion of shiftCount.
<<= (bitwise left shift and assignment) — Operator
Performs a bitwise left shift (<<=) operation and stores the contents as a result in expression1.
~ (bitwise NOT) — Operator
Converts expression to a 32-bit signed integer, and then applies a bitwise one's complement.
| (bitwise OR) — Operator
Converts expression1 and expression2 to 32-bit unsigned integers, and places a 1 in each bit position where the corresponding bits of either expression1 or expression2 are 1.
|= (bitwise OR assignment) — Operator
Assigns expression1 the value of expression1 | expression2.
>> (bitwise right shift) — Operator
Converts expression and shiftCount to 32-bit integers, and shifts all the bits in expression to the right by the number of places specified by the integer that results from the conversion of shiftCount.
>>= (bitwise right shift and assignment) — Operator
Performs a bitwise right-shift operation and stores the result in expression.
>>> (bitwise unsigned right shift) — Operator
The same as the bitwise right shift (>>) operator except that it does not preserve the sign of the original expression because the bits on the left are always filled with 0.
>>>= (bitwise unsigned right shift and assignment) — Operator
Performs an unsigned bitwise right-shift operation and stores the result in expression.
^ (bitwise XOR) — Operator
Converts expression1 and expression2 to 32-bit unsigned integers, and places a 1 in each bit position where the corresponding bits in expression1 or expression2, but not both, are 1.
^= (bitwise XOR assignment) — Operator
Assigns expression1 the value of expression1 ^ expression2.
/*..*/ (block comment delimiter) — Operator
Delimits one or more lines of script comments.
{ } (braces (XML)) — Operator
Evaluates an expression that is used in an XML or XMLList initializer.
[ ] (brackets (XML)) — Operator
Accesses a property or attribute of an XML or XMLList object.
, (comma) — Operator
Evaluates expression1, then expression2, and so on.
+ (concatenation) — Operator
Concatenates (combines) strings.
+= (concatenation assignment) — Operator
Assigns expression1 the value of expression1 + expression2.
+= (concatenation assignment (XMLList)) — Operator
Assigns expression1, which is an XMLList object, the value of expression1 + expression2.
+ (concatenation (XMLList)) — Operator
Concatenates (combines) XML or XMLList values into an XMLList object.
?: (conditional) — Operator
Evaluates expression1, and if the value of expression1 is true, the result is the value of expression2; otherwise the result is the value of expression3.
-- (decrement) — Operator
Subtracts 1 from the operand.
.. (descendant accessor) — Operator
Navigates to descendant elements of an XML or XMLList object, or (combined with the @ operator) finds matching attributes of descendants.
/ (division) — Operator
Divides expression1 by expression2.
/= (division assignment) — Operator
Assigns expression1 the value of expression1 / expression2.
. (dot) — Operator
Accesses class variables and methods, gets and sets object properties, and delimits imported packages or classes.
. (dot (XML)) — Operator
Navigates to child elements of an XML or XMLList object, or (combined with the @ operator) returns attributes of an XML or XMLList object.
== (equality) — Operator
Tests two expressions for equality.
> (greater than) — Operator
Compares two expressions and determines whether expression1 is greater than expression2; if it is, the result is true.
>= (greater than or equal to) — Operator
Compares two expressions and determines whether expression1 is greater than or equal to expression2 (true) or expression1 is less than expression2 (false).
++ (increment) — Operator
Adds 1 to an expression.
!= (inequality) — Operator
Tests for the exact opposite of the equality (==) operator.
< (less than) — Operator
Compares two expressions and determines whether expression1 is less than expression2; if so, the result is true.
<= (less than or equal to) — Operator
Compares two expressions and determines whether expression1 is less than or equal to expression2; if it is, the result is true.
// (line comment delimiter) — Operator
Indicates the beginning of a script comment.
&& (logical AND) — Operator
Returns expression1 if it is false or can be converted to false, and expression2 otherwise.
&&= (logical AND assignment) — Operator
Assigns expression1 the value of expression1 && expression2.
! (logical NOT) — Operator
Inverts the Boolean value of a variable or expression.
|| (logical OR) — Operator
Returns expression1 if it is true or can be converted to true, and expression2 otherwise.
||= (logical OR assignment) — Operator
Assigns expression1 the value of expression1 || expression2.
% (modulo) — Operator
Calculates the remainder of expression1 divided by expression2.
%= (modulo assignment) — Operator
Assigns expression1 the value of expression1 % expression2.
* (multiplication) — Operator
Multiplies two numerical expressions.
*= (multiplication assignment) — Operator
Assigns expression1 the value of expression1 * expression2.
:: (name qualifier) — Operator
Identifies the namespace of a property, a method, an XML property, or an XML attribute.
?. (null condition member access) — Operator
Accesses class variables and methods, gets and sets object properties, with an inherent null-object check.
?? (nullish coalescing) — Operator
Returns expression1 unless if it is null or undefined, and expression2 otherwise.
{} (object initializer) — Operator
Creates a new object and initializes it with the specified name and value property pairs.
() (parentheses) — Operator
Performs a grouping operation on one or more parameters, performs sequential evaluation of expressions, or surrounds one or more parameters and passes them as arguments to a function that precedes the parentheses.
( ) (parentheses (XML)) — Operator
Evaluates an expression in an E4X XML construct.
/ (RegExp delimiter) — Operator
When used before and after characters, indicates that the characters have a literal value and are considered a regular expression (RegExp), not a variable, string, or other ActionScript element.
... (rest) parameter — Statement
Specifies that a function will accept any number of comma-delimited arguments.
=== (strict equality) — Operator
Tests two expressions for equality, but does not perform automatic data conversion.
!== (strict inequality) — Operator
Tests for the exact opposite of the strict equality (===) operator.
" (string delimiter) — Operator
When used before and after characters, indicates that the characters have a literal value and are considered a string, not a variable, numerical value, or other ActionScript element.
- (subtraction) — Operator
Used for negating or subtracting.
-= (subtraction assignment) — Operator
Assigns expression1 the value of expression1 - expression2.
: (type) — Operator
Used for assigning a data type; this operator specifies the variable type, function return type, or function parameter type.
< > (XML literal tag delimiter) — Operator
Defines an XML tag in an XML literal.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/all-index-T.html b/html-docs/all-index-T.html deleted file mode 100644 index 944987d..0000000 --- a/html-docs/all-index-T.html +++ /dev/null @@ -1,3014 +0,0 @@ - - - - - -T Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
T — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the T key (84).
TAB — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Tab key (9).
TabAlignment — Final class in package flash.text.engine
-The TabAlignment class is an enumeration of constant values that you can use to set the tabAlignment property -of the TabStop class.
tabChildren — Property in class flash.display.DisplayObjectContainer
- Determines whether the children of the object are tab enabled.
tabChildren — Property in class flash.display.Stage
- Determines whether the children of the object are tab enabled.
tabChildrenChange — Event in class flash.display.InteractiveObject
- - Dispatched when the value of the object's tabChildren flag changes.
TAB_CHILDREN_CHANGE — Constant static property in class flash.events.Event
- The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
tabEnabled — Property in class flash.display.InteractiveObject
- - Specifies whether this object is in the tab order.
tabEnabledChange — Event in class flash.display.InteractiveObject
- - Dispatched when the object's tabEnabled flag changes.
TAB_ENABLED_CHANGE — Constant static property in class flash.events.Event
- The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
tabIndex — Property in class flash.display.InteractiveObject
- - Specifies the tab ordering of objects in a SWF file.
tabIndexChange — Event in class flash.display.InteractiveObject
- - Dispatched when the value of the object's tabIndex property changes.
TAB_INDEX_CHANGE — Constant static property in class flash.events.Event
- The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
table — Property in class flash.data.SQLIndexSchema
- The name of the table to which this index is attached.
table — Property in class flash.data.SQLTriggerSchema
- The name of the table on which this trigger is defined, or the name of the view if - the trigger is defined on a view.
table — Property in class flash.events.SQLUpdateEvent
- The name of the table whose data change caused the event to be dispatched.
tables — Property in class flash.data.SQLSchemaResult
- An array of SQLTableSchema instances requested in a call - to SQLConnection.loadSchema().
TabStop — Final class in package flash.text.engine
- The TabStop class represents the properties of a tab stop in a text block.
TabStop(alignment:String, position:Number, decimalAlignmentToken:String) — Constructor in class flash.text.engine.TabStop
- Creates a new TabStop.
tabStops — Property in class flash.text.TextFormat
- Specifies custom tab stops as an array of non-negative integers.
tabStops — Property in class flash.text.engine.TextBlock
- Specifies the tab stops for the text in the text block, - in the form of a Vector of TabStop objects.
TABULAR — Constant static property in class flash.text.engine.DigitWidth
- Used to specify tabular digit width.
TAMIL — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Tamil digit set.
tan(angleRadians:Number) — Static method in class Math
- - Computes and returns the tangent of the specified angle.
tapLocalX — Property in class flash.events.PressAndTapGestureEvent
- The horizontal coordinate at which the event occurred relative to the containing interactive object.
tapLocalY — Property in class flash.events.PressAndTapGestureEvent
- The vertical coordinate at which the event occurred relative to the containing interactive object.
tapStageX — Property in class flash.events.PressAndTapGestureEvent
- The horizontal coordinate at which the tap touch occurred in global Stage coordinates.
tapStageY — Property in class flash.events.PressAndTapGestureEvent
- The vertical coordinate at which the tap touch occurred in global Stage coordinates.
target — Property in class flash.display.ShaderJob
- The object into which the result of the shader operation is written.
target — Property in class flash.events.Event
- The event target.
target — Property in class flash.net.dns.SRVRecord
- The canonical host name of the server providing the service.
target — Property in class flash.text.TextFormat
- Indicates the target window where the hyperlink is displayed.
targetFrameRate — Property in class flash.events.ThrottleEvent
- The frame rate that Flash Player or AIR targets after the ThrottleEvent is dispatched.
targetType — Property in class flash.events.WebViewDrawEvent
- The type of image data that is being held by this object.
tcpNoDelay — Property in class flash.net.Socket
- - Whether to use the 'TCP_NODELAY' setting to avoid the use of Nagle's algorithm.
Telemetry — Final class in package flash.profiler
- The Telemetry class lets an application profile ActionScript code and register handlers for commands -
TELUGU — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Telugu digit set.
terminate() — Method in class flash.printing.PrintJob
- Signals that the print job should be terminated without sending.
terminate() — Method in class flash.system.Worker
- Stops this worker's code execution.
TERMINATED — Constant static property in class flash.system.WorkerState
- This state indicates that the worker has been stopped by code in another - worker calling this Worker object's terminate() method.
test(str:String) — Method in class RegExp
- - Tests for the match of the regular expression in the given string str.
text() — Method in class XML
- - Returns an XMLList object of all XML properties of the XML object that represent XML text nodes.
text() — Method in class XMLList
- - Calls the text() method of each XML - - object and returns an XMLList object that contains the results.
text — Property in class flash.data.SQLStatement
- The actual SQL text of the statement.
text — Property in class flash.events.TextEvent
- For a textInput event, the character or sequence of characters - entered by the user.
text — Property in class flash.text.StageText
- - The current text in the text field.
text — Property in class flash.text.StaticText
- Returns the current text of the static text field.
text — Property in class flash.text.TextField
- - A string that is the current text in the text field.
text — Property in class flash.text.engine.ContentElement
- A copy of the text in the element, not including any U+FDEF characters, which represent graphic elements in the String.
text — Property in class flash.text.engine.TextElement
- Receives the text that is the content of the element.
TEXT — Constant static property in class flash.net.URLLoaderDataFormat
- Specifies that downloaded data is received as text.
textAlign — Property in class flash.text.StageText
- - Indicates the paragraph alignment.
TextBaseline — Final class in package flash.text.engine
-The TextBaseline class is an enumeration of constant values to use in setting the dominantBaseline and -alignmentBaseline properties of the ElementFormat class.
textBlock — Property in class flash.text.engine.ContentElement
- The TextBlock to which this element belongs.
textBlock — Property in class flash.text.engine.TextLine
- The TextBlock containing this text line, or null if the validity of the line is TextLineValidity.STATIC, - meaning that the connection between the line and the TextBlock has been severed.
TextBlock — Final class in package flash.text.engine
- The TextBlock class is a factory for the creation of TextLine objects, which you can - render by placing them on the display list.
TextBlock(content:flash.text.engine:ContentElement, tabStops, textJustifier:flash.text.engine:TextJustifier, lineRotation:String, baselineZero:String, bidiLevel:int, applyNonLinearFontScaling:Boolean, baselineFontDescription:flash.text.engine:FontDescription, baselineFontSize:Number) — Constructor in class flash.text.engine.TextBlock
- Creates a TextBlock object -
textBlockBeginIndex — Property in class flash.text.engine.ContentElement
- The index in the text block of the first character of this element.
textBlockBeginIndex — Property in class flash.text.engine.TextLine
- The index of the first character of the line in the raw text of the text block.
textColor — Property in class flash.text.TextField
- - The color of the text in a text field, in hexadecimal format.
TextColorType — Final class in package flash.text
-The TextColorType class provides color values for the flash.text.TextRenderer class.
TextDisplayMode — Final class in package flash.text
- The TextDisplayMode class contains values that control the subpixel anti-aliasing of the advanced anti-aliasing system.
TextElement — Final class in package flash.text.engine
- The TextElement class represents a string of formatted text.
TextElement(text:String, elementFormat:flash.text.engine:ElementFormat, eventMirror:flash.events:EventDispatcher, textRotation:String) — Constructor in class flash.text.engine.TextElement
- Creates a new TextElement instance.
textEncodingFallback — Property in class flash.html.HTMLLoader
textEncodingOverride — Property in class flash.html.HTMLLoader
TextEvent — Class in package flash.events
- An object dispatches a TextEvent object when a user enters text in a text field or clicks - a hyperlink in an HTML-enabled text field.
TextEvent(type:String, bubbles:Boolean, cancelable:Boolean, text:String) — Constructor in class flash.events.TextEvent
- Creates an Event object that contains information about text events.
TextExtent — Class in package flash.text
- The TextExtent class contains information about the extents of some - text in a text field.
TextExtent(width:Number, height:Number, textFieldWidth:Number, textFieldHeight:Number, ascent:Number, descent:Number) — Constructor in class flash.text.TextExtent
TextField — Class in package flash.text
- - The TextField class is used to create display objects for text display and input.
TextField() — Constructor in class flash.text.TextField
- - Creates a new TextField instance.
TextFieldAutoSize — Final class in package flash.text
-The TextFieldAutoSize class is an enumeration of constant values used in setting the autoSize -property of the TextField class.
textFieldHeight — Property in class flash.text.TextExtent
TextFieldType — Final class in package flash.text
-The TextFieldType class is an enumeration of constant values used in setting the type property -of the TextField class.
textFieldWidth — Property in class flash.text.TextExtent
TextFormat — Class in package flash.text
- The TextFormat class represents character formatting information.
TextFormat(font:String, size:Object, color:Object, bold:Object, italic:Object, underline:Object, url:String, target:String, align:String, leftMargin:Object, rightMargin:Object, indent:Object, leading:Object) — Constructor in class flash.text.TextFormat
- Creates a TextFormat object with the specified properties.
TEXT_FORMAT — Constant static property in class flash.desktop.ClipboardFormats
- String data.
TextFormatAlign — Final class in package flash.text
- The TextFormatAlign class provides values for text alignment in the TextFormat class.
textHeight — Property in class flash.text.TextField
- - The height of the text in pixels.
textHeight — Property in class flash.text.engine.TextLine
- The logical height of the text line, which is equal to ascent + descent.
textInput — Event in class flash.display.InteractiveObject
- - Dispatched when a user enters one or more - - characters of text.
textInput — Event in class flash.text.TextField
- - Flash Player dispatches the textInput event when a user enters one or more - - characters of text.
textInput — Event in interface flash.text.ime.IIMEClient
- Dispatched when the user enters text.
TEXT_INPUT — Constant static property in class flash.events.TextEvent
- Defines the value of the type property of a textInput event object.
textInteractionMode — Property in class flash.text.TextField
- - The interaction mode property, Default value is TextInteractionMode.NORMAL.
TextInteractionMode — Final class in package flash.text
- A class that defines the Interactive mode of a text field object.
textInteractionModeChange — Event in class flash.text.TextField
- - Flash Player dispatches the textInteractionModeChange event when a user - - changes the interaction mode of a text field.
TEXT_INTERACTION_MODE_CHANGE — Constant static property in class flash.events.Event
- The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
textJustifier — Property in class flash.text.engine.TextBlock
- Specifies the TextJustifier to use during line creation.
TextJustifier — Class in package flash.text.engine
- The TextJustifier class is an abstract base class for the justifier types that you can apply to a TextBlock, specifically the - EastAsianJustifier and SpaceJustifier classes.
TextJustifier(locale:String, lineJustification:String) — Constructor in class flash.text.engine.TextJustifier
- Calling the new TextJustifier() constructor throws an - ArgumentError exception.
textLine — Property in class flash.text.engine.TextLineMirrorRegion
- The TextLine containing this mirror region.
TextLine — Final class in package flash.text.engine
- The TextLine class is used to display text on the display list.
textLineCreationResult — Property in class flash.text.engine.TextBlock
- Indicates the result of a createTextLine() operation.
TextLineCreationResult — Final class in package flash.text.engine
-The TextLineCreationResult class is an enumeration of constant values used with TextBlock.textLineCreationResult.
TextLineMetrics — Class in package flash.text
- The TextLineMetrics class contains information about the text position and measurements of a - line of text within a text field.
TextLineMetrics(x:Number, width:Number, height:Number, ascent:Number, descent:Number, leading:Number) — Constructor in class flash.text.TextLineMetrics
- Creates a TextLineMetrics object.
TextLineMirrorRegion — Final class in package flash.text.engine
- The TextLineMirrorRegion class represents a portion of a text line wherein events are mirrored to another event dispatcher.
TextLineValidity — Final class in package flash.text.engine
-The TextLineValidity class is an enumeration of constant values for setting the validity property -of the TextLine class.
TEXT_NODE — Constant static property in class flash.xml.XMLNodeType
- Specifies that the node is a text node.
TextRenderer — Final class in package flash.text
- The TextRenderer class provides functionality for the advanced anti-aliasing capability of - embedded fonts.
textRotation — Property in class flash.text.engine.ContentElement
- The rotation to apply to the element as a unit.
textRotation — Property in class flash.text.engine.ElementFormat
- Sets the rotation applied to individual glyphs.
TextRotation — Final class in package flash.text.engine
-The TextRotation class is an enumeration of constant values used with the following properties: -ElementFormat.textRotation, ContentElement.textRotation, -TextBlock.lineRotation, and TextLine.getAtomTextRotation().
textSnapshot — Property in class flash.display.DisplayObjectContainer
- Returns a TextSnapshot object for this DisplayObjectContainer instance.
textSnapshot — Property in class flash.display.Stage
- Returns a TextSnapshot object for this DisplayObjectContainer instance.
TextSnapshot — Class in package flash.text
- TextSnapshot objects let you work with static text in a movie clip.
Texture — Final class in package flash.display3D.textures
- - The Texture class represents a 2-dimensional texture uploaded to a rendering context.
TextureBase — Class in package flash.display3D.textures
- The TextureBase class is the base class for Context3D texture objects.
textureReady — Event in class flash.display3D.textures.CubeTexture
- - Dispatched by the CubeTexture object when an asynchronous texture upload - - operation has completed successfully, and the texture can then be used.
textureReady — Event in class flash.display3D.textures.RectangleTexture
- - Dispatched by the RectangleTexture object when an asynchronous texture upload - - operation has completed successfully, and the texture can then be used.
textureReady — Event in class flash.display3D.textures.Texture
- - Dispatched by the Texture object when an asynchronous texture upload - - operation has completed successfully, and the texture can then be used.
TEXTURE_READY — Constant static property in class flash.events.Event
- The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
textWidth — Property in class flash.text.TextField
- - The width of the text in pixels.
textWidth — Property in class flash.text.engine.TextLine
- The logical width of the text line, which is the width that the text engine uses to lay out the line.
THAI — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Thai digit set.
thickness — Property in class flash.display.GraphicsStroke
- Indicates the thickness of the line in - points; valid values are 0-255.
thickness — Property in class flash.text.TextField
- - The thickness of the glyph edges in this text field.
this — Statement
A reference to a method's containing object.
threshold(sourceBitmapData:flash.display:BitmapData, sourceRect:flash.geom:Rectangle, destPoint:flash.geom:Point, operation:String, threshold:uint, color:uint, mask:uint, copySource:Boolean) — Method in class flash.display.BitmapData
- - Tests pixel values in an image against a specified threshold and sets pixels that pass the test to new color values.
THROTTLE — Constant static property in class flash.events.ThrottleEvent
- Defines the value of the type property of a ThrottleEvent event object.
THROTTLE — Constant static property in class flash.events.ThrottleType
- This constant is used for the state property in the ThrottleEvent class.
ThrottleEvent — Class in package flash.events
- A ThrottleEvent is dispatched when the Flash Player throttles, pauses, or resumes content.
ThrottleEvent(type:String, bubbles:Boolean, cancelable:Boolean, state:String, targetFrameRate:Number) — Constructor in class flash.events.ThrottleEvent
- Creates an Event object that contains information about the ThrottleEvent.
ThrottleType — Final class in package flash.events
- The ThrottleType class provides values for the playback state property - of the flash.event.ThrottleEvent class.
throw — Statement
Generates, or throws, an error that can be handled, or caught, by a catch code block.
TIBETAN — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Tibetan digit set.
time — Property in class Date
- - The number of milliseconds since midnight January 1, 1970, universal time, - - for a Date object.
time — Property in class flash.net.NetStream
- The position of the playhead, in seconds.
timeout — Property in class flash.net.Socket
- - Indicates the number of milliseconds to wait for a connection.
timeout — Property in class flash.net.XMLSocket
- Indicates the number of milliseconds to wait for a connection.
timer — Event in class flash.utils.Timer
- Dispatched whenever a Timer object reaches an interval specified according to the Timer.delay property.
Timer — Class in package flash.utils
- The Timer class is the interface to timers, which let you - run code on a specified time sequence.
Timer(delay:Number, repeatCount:int) — Constructor in class flash.utils.Timer
- Constructs a new Timer object with the specified delay - and repeatCount states.
TIMER — Constant static property in class flash.events.TimerEvent
- Defines the value of the type property of a timer event object.
timerComplete — Event in class flash.utils.Timer
- Dispatched whenever it has completed the number of requests set by Timer.repeatCount.
TIMER_COMPLETE — Constant static property in class flash.events.TimerEvent
- Defines the value of the type property of a timerComplete event object.
TimerEvent — Class in package flash.events
- A Timer object dispatches a TimerEvent objects whenever the Timer object reaches the interval - specified by the Timer.delay property.
TimerEvent(type:String, bubbles:Boolean, cancelable:Boolean) — Constructor in class flash.events.TimerEvent
- Creates an Event object with specific information relevant to timer events.
timeSinceLastUserInput — Property in class flash.desktop.NativeApplication
- - The time, in seconds, since the last user input.
timestamp — Property in class flash.events.AccelerometerEvent
- The number of milliseconds at the time of the event since the runtime was initialized.
timestamp — Property in class flash.events.DeviceRotationEvent
- The number of milliseconds at the time of the event since the runtime was initialized.
timestamp — Property in class flash.events.GeolocationEvent
- The number of milliseconds at the time of the event since the runtime was initialized.
timestamp — Property in class flash.events.NetDataEvent
- The timestamp of the data message in the media stream.
timestamp — Property in class flash.events.TouchEvent
- Reports the time of the event in relative milliseconds.
TimeZone — Class in Top Level
- - The TimeZone class provides information about timezones that can be used in date calculations - - and to find out about different locations and their time zone offsets.
timezoneOffset — Property in class Date
- - The difference, in minutes, between universal time (UTC) and the computer's local time.
title — Property in class flash.display.NativeWindow
- - The window title.
title — Property in class flash.html.HTMLHistoryItem
- The title of the HTML page.
title — Property in class flash.media.StageWebView
- - The HTML title value.
TITLE — Constant static property in class flash.text.engine.TypographicCase
- Specifies that uppercase characters use title glyphs on output.
toBase64() — Method in class flash.utils.ByteArray
- - Converts the byte array into a base64 string.
toByteArray() — Method in class flash.net.drm.DRMVoucher
toDateString() — Method in class Date
- - Returns a string representation of the day and date only, and does not include the time or timezone.
toExponential(fractionDigits:uint) — Method in class float
- - Returns a string representation of the float value in exponential notation.
toExponential(fractionDigits:uint) — Method in class int
- - Returns a string representation of the number in exponential notation.
toExponential(fractionDigits:uint) — Method in class Number
- - Returns a string representation of the number in exponential notation.
toExponential(fractionDigits:uint) — Method in class uint
- - Returns a string representation of the number in exponential notation.
toFixed(fractionDigits:uint) — Method in class float
- - Returns a string representation of the float value in fixed-point notation.
toFixed(fractionDigits:uint) — Method in class int
- - Returns a string representation of the number in fixed-point notation.
toFixed(fractionDigits:uint) — Method in class Number
- - Returns a string representation of the number in fixed-point notation.
toFixed(fractionDigits:uint) — Method in class uint
- - Returns a string representation of the number in fixed-point notation.
togglePause() — Method in class flash.net.NetStream
- Pauses or resumes playback of a stream.
toHexString() — Method in class flash.utils.ByteArray
- - Converts the byte array into a hex string.
toJSON(k:String) — Method in class Date
- - Provides an overridable method for customizing the JSON encoding of values in an Date object.
toJSON(k:String) — Method in class XML
- - Provides an overridable method for customizing the JSON encoding of values in an XML object.
token — Property in class flash.events.DRMAuthenticationCompleteEvent
- The authentication token.
token — Event in class flash.notifications.RemoteNotifier
- Dispatched when a notification token is available from the iOS - upon successful subscription for remote notifications.
TOKEN — Constant static property in class flash.events.RemoteNotificationEvent
- Defines the value of the type property of a RemoteNotificationEvent event object.
tokenId — Property in class flash.events.RemoteNotificationEvent
- Cotains the tokenId received from APNs, used to identify the application.
toLocaleDateString() — Method in class Date
- - Returns a String representation of the day and date only, and does not include the time or timezone.
toLocaleLowerCase() — Method in class String
- - Returns a copy of this string, with all uppercase characters converted - - to lowercase.
toLocaleString() — Method in class Array
- - Returns a string that represents the elements in the specified array.
toLocaleString() — Method in class Date
- - Returns a String representation of the day, date, time, given in local time.
toLocaleString() — Method in class Object
- - Returns the string representation of this object, formatted according to locale-specific conventions.
toLocaleString() — Method in class Vector
- Returns a string that represents the elements in the specified Vector.
toLocaleTimeString() — Method in class Date
- - Returns a String representation of the time only, and does not include the day, date, year, or timezone.
toLocaleUpperCase() — Method in class String
- - Returns a copy of this string, with all lowercase characters converted - - to uppercase.
toLowerCase() — Method in class String
- - Returns a copy of this string, with all uppercase characters converted - - to lowercase.
toLowerCase(s:String) — Method in class flash.globalization.StringTools
- Converts a string to lowercase according to language conventions.
toMatrix3D() — Method in class flash.geom.PerspectiveProjection
- Returns the underlying Matrix3D object of the display object.
toMatrix3DToOutput(output:flash.geom:Matrix3D) — Method in class flash.geom.PerspectiveProjection
- Returns the underlying Matrix3D object of the display object, reusing any passed-in object.
toolBarVisible — Property in class flash.html.HTMLWindowCreateOptions
- Specifies whether a toolbar bar should be displayed.
tooltip — Property in class flash.desktop.SystemTrayIcon
- The tooltip that pops up for the system tray icon.
top — Property in class flash.geom.Rectangle
- - The y coordinate of the top-left corner of the rectangle.
TOP — Constant static property in class flash.display.FocusDirection
- Indicates that focus should be given to the object at the beginning of the reading order.
TOP — Constant static property in class flash.display.NativeWindowResize
-The top edge of the window.
TOP — Constant static property in class flash.display.StageAlign
-Specifies that the Stage is aligned at the top.
topExtension — Property in class flash.filters.ShaderFilter
- The growth in pixels on the top side of the target object.
topLeft — Property in class flash.geom.Rectangle
- - The location of the Rectangle object's top-left corner, determined by the x and - - y coordinates of the point.
TOP_LEFT — Constant static property in class flash.display.NativeWindowResize
-The top-left corner of the window.
TOP_LEFT — Constant static property in class flash.display.StageAlign
-Specifies that the Stage is aligned in the top-left corner.
Top Level — Package
toPrecision(precision:uint) — Method in class float
- - Returns a string representation of the float value either in exponential notation or in - - fixed-point notation.
toPrecision(precision:uint) — Method in class int
- - Returns a string representation of the number either in exponential notation or in - - fixed-point notation.
toPrecision(precision:uint) — Method in class Number
- - Returns a string representation of the number either in exponential notation or in - - fixed-point notation.
toPrecision(precision:uint) — Method in class uint
- - Returns a string representation of the number either in exponential notation or in - - fixed-point notation.
TOP_RIGHT — Constant static property in class flash.display.NativeWindowResize
-The top-right corner of the window.
TOP_RIGHT — Constant static property in class flash.display.StageAlign
-Specifies that the Stage is aligned in the top-right corner.
toString() — Method in class Array
- - Returns a string that represents the elements in the specified array.
toString() — Method in class Boolean
- - Returns the string representation ("true" or - - "false") of the Boolean object.
toString() — Method in class Date
- - Returns a String representation of the day, date, time, and timezone.
toString() — Method in class Error
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
toString(radix) — Method in class float
- - Returns the string representation of the specified float object.
toString(radix:uint) — Method in class int
- - Returns the string representation of an int object.
toString() — Method in class Namespace
- - Equivalent to the Namespace.uri property.
toString(radix:Number) — Method in class Number
- - Returns the string representation of the specified Number object (myNumber).
toString() — Method in class Object
- - Returns the string representation of the specified object.
toString() — Method in class QName
- - Returns a string composed of the URI, and the local name for the - - QName object, separated by "::".
toString(radix:uint) — Method in class uint
- - Returns the string representation of a uint object.
toString() — Method in class Vector
- Returns a string that represents the elements in the Vector.
toString() — Method in class XML
- - Returns a string representation of the XML object.
toString() — Method in class XMLList
- - Returns a string representation of all the XML objects in an XMLList object.
toString() — Method in class air.update.events.DownloadErrorEvent
- - Returns a string that contains all the properties of the object.
toString() — Method in class air.update.events.StatusFileUpdateErrorEvent
- - Returns a string that contains all the properties of the object.
toString() — Method in class air.update.events.StatusFileUpdateEvent
- - Returns a string that contains all the properties of the object.
toString() — Method in class air.update.events.StatusUpdateErrorEvent
- - Returns a string that contains all the properties of the object.
toString() — Method in class air.update.events.StatusUpdateEvent
- - Returns a string that contains all the properties of the object.
toString() — Method in class air.update.events.UpdateEvent
- - Returns a string that contains all the properties of the object.
toString() — Method in class flash.desktop.NativeDragOptions
- Constructs a string containing the current settings of this NativeDragOptions object.
toString() — Method in class flash.display.NativeMenuItem
- - Returns a string containing all the properties of the NativeMenuItem object.
toString() — Method in class flash.errors.DRMManagerError
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
toString() — Method in class flash.errors.PermissionError
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
toString() — Method in class flash.errors.SQLError
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
toString() — Method in class flash.events.AccelerometerEvent
- Returns a string that contains all the properties of the AccelerometerEvent object.
toString() — Method in class flash.events.ActivityEvent
- Returns a string that contains all the properties of the ActivityEvent object.
toString() — Method in class flash.events.AsyncErrorEvent
- Returns a string that contains all the properties of the AsyncErrorEvent object.
toString() — Method in class flash.events.ContextMenuEvent
- Returns a string that contains all the properties of the ContextMenuEvent object.
toString() — Method in class flash.events.DataEvent
- - Returns a string that contains all the properties of the DataEvent object.
toString() — Method in class flash.events.DatagramSocketDataEvent
- Returns a string that contains all the properties of the DatagramSocketDataEvent object.
toString() — Method in class flash.events.DeviceRotationEvent
- Returns a string that contains all the properties of the DeviceRotationEvent object.
toString() — Method in class flash.events.DNSResolverEvent
- Returns a string that contains all the properties of the DNSResolverEvent object.
toString() — Method in class flash.events.DRMAuthenticateEvent
- Returns a string that contains all the properties of the DRMAuthenticateEvent object.
toString() — Method in class flash.events.DRMDeviceGroupErrorEvent
toString() — Method in class flash.events.DRMDeviceGroupEvent
toString() — Method in class flash.events.DRMErrorEvent
- Returns a string that contains all the properties of the DRMErrorEvent object.
toString() — Method in class flash.events.DRMStatusEvent
- Returns a string that contains all the properties of the DRMStatusEvent object.
toString() — Method in class flash.events.ErrorEvent
- Returns a string that contains all the properties of the ErrorEvent object.
toString() — Method in class flash.events.Event
- Returns a string containing all the properties of the Event object.
toString() — Method in class flash.events.FocusEvent
- Returns a string that contains all the properties of the FocusEvent object.
toString() — Method in class flash.events.FullScreenEvent
- Returns a string that contains all the properties of the FullScreenEvent object.
toString() — Method in class flash.events.GeolocationEvent
- Returns a string that contains all the properties of the GeolocationEvent object.
toString() — Method in class flash.events.GestureEvent
- Returns a string that contains all the properties of the GestureEvent object.
toString() — Method in class flash.events.HTTPStatusEvent
- Returns a string that contains all the properties of the HTTPStatusEvent object.
toString() — Method in class flash.events.IMEEvent
- Returns a string that contains all the properties of the IMEEvent object.
toString() — Method in class flash.events.IOErrorEvent
- Returns a string that contains all the properties of the IOErrorEvent object.
toString() — Method in class flash.events.KeyboardEvent
- - Returns a string that contains all the properties of the KeyboardEvent object.
toString() — Method in class flash.events.LocationChangeEvent
- Returns a string that contains all the properties of the LocationChangeEvent object.
toString() — Method in class flash.events.MediaEvent
- Returns a string that contains all the properties of MediaEvent object.
toString() — Method in class flash.events.MouseEvent
- - Returns a string that contains all the properties of the MouseEvent object.
toString() — Method in class flash.events.NativeDragEvent
- Formats the properties of this NativeDragEvent object as a string.
toString() — Method in class flash.events.NativeProcessExitEvent
- Returns a string that contains all the properties of the NativeProcessExitEvent object.
toString() — Method in class flash.events.NativeWindowBoundsEvent
- Returns a string that contains all the properties of the NativeWindowBoundsEvent object.
toString() — Method in class flash.events.NativeWindowDisplayStateEvent
- Returns a string that contains all the properties of the NativeWindowDisplayStateEvent object.
toString() — Method in class flash.events.NetDataEvent
- Returns a string that contains all the properties of the NetDataEvent object.
toString() — Method in class flash.events.NetMonitorEvent
- Returns a string that contains all the properties of the NetMonitorEvent object.
toString() — Method in class flash.events.NetStatusEvent
- Returns a string that contains all the properties of the NetStatusEvent object.
toString() — Method in class flash.events.OutputProgressEvent
- Returns a string that contains all the properties of the OutputProgressEvent object.
toString() — Method in class flash.events.PermissionEvent
- Returns a string that contains all the properties of the PermissionEvent object.
toString() — Method in class flash.events.PressAndTapGestureEvent
- Returns a string that contains all the properties of the PressAndTapGestureEvent object.
toString() — Method in class flash.events.ProgressEvent
- Returns a string that contains all the properties of the ProgressEvent object.
toString() — Method in class flash.events.SampleDataEvent
- Returns a string that contains all the properties of the SampleDataEvent object.
toString() — Method in class flash.events.ScreenMouseEvent
- Returns a string that contains all the properties of the ScreenMouseEvent object.
toString() — Method in class flash.events.SecurityErrorEvent
- - Returns a string that contains all the properties of the SecurityErrorEvent object.
toString() — Method in class flash.events.ServerSocketConnectEvent
- Returns a string that contains all the properties of the ServerSocketConnectEvent object.
toString() — Method in class flash.events.ShaderEvent
- Returns a string that contains all the properties of the ShaderEvent object.
toString() — Method in class flash.events.SoftKeyboardEvent
- Returns a string that contains all the properties of the SoftKeyboardEvent object.
toString() — Method in class flash.events.SQLErrorEvent
- Returns a string that contains all the properties of the SQLErrorEvent object.
toString() — Method in class flash.events.StageOrientationEvent
- Returns a string that contains all the properties of the StageOrientationEvent object.
toString() — Method in class flash.events.StatusEvent
- Returns a string that contains all the properties of the StatusEvent object.
toString() — Method in class flash.events.StorageVolumeChangeEvent
- Returns a string containing all the properties of the Event object.
toString() — Method in class flash.events.SyncEvent
- Returns a string that contains all the properties of the SyncEvent object.
toString() — Method in class flash.events.TextEvent
- Returns a string that contains all the properties of the TextEvent object.
toString() — Method in class flash.events.ThrottleEvent
- Returns a string that contains all the properties of the ThrottleEvent object.
toString() — Method in class flash.events.TimerEvent
- Returns a string that contains all the properties of the TimerEvent object.
toString() — Method in class flash.events.TouchEvent
- Returns a string that contains all the properties of the TouchEvent object.
toString() — Method in class flash.events.TransformGestureEvent
- Returns a string that contains all the properties of the TransformGestureEvent object.
toString() — Method in class flash.events.UncaughtErrorEvent
- Returns a string that contains all the properties of the UncaughtErrorEvent object.
toString() — Method in class flash.events.VsyncStateChangeAvailabilityEvent
- Returns a string that contains all the properties of the VsyncStateChangeAvailabilityEvent object.
toString() — Method in class flash.events.WebViewDrawEvent
- Returns a string that contains all the properties of the ProgressEvent object.
toString() — Method in class flash.external.HostObject
- Implement toString() by calling the host object's toString() method if - available; if not, return [HostObject xxx], where xxx is the class name.
toString() — Method in class flash.geom.ColorTransform
- Formats and returns a string that describes all of the properties of the - ColorTransform object.
toString() — Method in class flash.geom.Matrix
- - Returns a text value listing the properties of the Matrix object.
toString() — Method in class flash.geom.Point
- Returns a string that contains the values of the x and y coordinates.
toString() — Method in class flash.geom.Rectangle
- - Builds and returns a string that lists the horizontal and vertical positions - - and the width and height of the Rectangle object.
toString() — Method in class flash.geom.Vector3D
- Returns a string representation of the current Vector3D object.
toString() — Method in class flash.net.GroupSpecifier
- Identical to the groupspecWithAuthorizations() method.
toString() — Method in class flash.net.NetGroupInfo
- Returns a string containing the values of the properties of the NetGroupInfo object.
toString() — Method in class flash.net.NetStreamInfo
- Returns a text value listing the properties of the NetStreamInfo object.
toString() — Method in class flash.net.NetStreamMulticastInfo
- Returns a string listing the properties of the NetStreamMulticastInfo object.
toString() — Method in class flash.net.URLVariables
- Returns a string containing all enumerable variables, - in the MIME content encoding application/x-www-form-urlencoded.
toString() — Method in class flash.security.X500DistinguishedName
- Returns all DN properties in one string.
toString() — Method in class flash.system.MessageChannel
- - Returns the string representation of the specified object.
toString() — Method in class flash.utils.ByteArray
- - Converts the byte array to a string.
toString() — Method in class flash.xml.XMLDocument
- Returns a string representation of the XML object.
toString() — Method in class flash.xml.XMLNode
- Evaluates the specified XMLNode object, constructs a textual representation of the XML structure, - including the node, children, and attributes, and returns the result as a string.
totalAscent — Property in class flash.text.engine.TextLine
- Specifies the number of pixels from the baseline to the top of the tallest character or graphic in the line.
totalChanges — Property in class flash.data.SQLConnection
- Contains the total number of data changes that have been made since the - connection to the database was opened.
totalDescent — Property in class flash.text.engine.TextLine
- Specifies the number of pixels from the baseline to the bottom of the lowest-descending character or graphic in the line.
totalFrames — Property in class flash.display.MovieClip
- The total number of frames in the MovieClip instance.
totalGPUMemory — Property in class flash.display3D.Context3D
- - Returns the total GPU memory allocated by Stage3D data structures of an application.
totalHeight — Property in class flash.text.engine.TextLine
- The total logical height of the text line, which is equal to totalAscent + totalDescent.
totalMemory — Static property in class flash.system.System
- - The amount of memory (in bytes) currently in use that has been directly allocated by - - Flash Player or AIR.
totalMemoryNumber — Static property in class flash.system.System
- - The amount of memory (in bytes) currently in use that has been directly allocated by - - Flash Player or AIR.
toTimeString() — Method in class Date
- - Returns a String representation of the time and timezone only, and does not include the day and date.
touchBegin — Event in class flash.display.InteractiveObject
- - 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).
TOUCH_BEGIN — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a TOUCH_BEGIN touch event object.
touchEnd — Event in class flash.display.InteractiveObject
- - 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).
TOUCH_END — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a TOUCH_END touch event object.
TouchEvent — Class in package flash.events
- The TouchEvent class lets you handle events on devices that detect user contact with - the device (such as a finger on a touch screen).
TouchEvent(type:String, bubbles:Boolean, cancelable:Boolean, touchPointID:int, isPrimaryTouchPoint:Boolean, localX:Number, localY:Number, sizeX:Number, sizeY:Number, pressure:Number, relatedObject:flash.display:InteractiveObject, ctrlKey:Boolean, altKey:Boolean, shiftKey:Boolean, commandKey:Boolean, controlKey:Boolean, timestamp:Number, touchIntent:String, samples:flash.utils:ByteArray, isTouchPointCanceled:Boolean) — Constructor in class flash.events.TouchEvent
- Creates an Event object that contains information about touch events.
TouchEventIntent — Final class in package flash.events
- The TouchEventIntent class defines constants for the touchIntent property of the TouchEvent class.
touchIntent — Property in class flash.events.TouchEvent
- Reports whether the touch was generated by the primary or the eraser end of a stylus.
touchMove — Event in class flash.display.InteractiveObject
- - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.
TOUCH_MOVE — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a TOUCH_MOVE touch event object.
touchOut — Event in class flash.display.InteractiveObject
- - 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).
TOUCH_OUT — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a TOUCH_OUT touch event object.
touchOver — Event in class flash.display.InteractiveObject
- - 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).
TOUCH_OVER — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a TOUCH_OVER touch event object.
TOUCH_POINT — Constant static property in class flash.ui.MultitouchInputMode
- Specifies that events are dispatched only for basic touch events, such as a single finger tap.
touchPointID — Property in class flash.events.TouchEvent
- A unique identification number (as an int) assigned to the touch point.
touchRollOut — Event in class flash.display.InteractiveObject
- - 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).
TOUCH_ROLL_OUT — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a TOUCH_ROLL_OUT touch event object.
touchRollOver — Event in class flash.display.InteractiveObject
- - 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).
TOUCH_ROLL_OVER — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a TOUCH_ROLL_OVER touch event object.
touchscreenType — Static property in class flash.system.Capabilities
- Specifies the type of touchscreen supported, if any.
TouchscreenType — Final class in package flash.system
- The TouchscreenType class is an enumeration class that provides values for the different types of touch screens.
touchTap — Event in class flash.display.InteractiveObject
- - 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).
TOUCH_TAP — Constant static property in class flash.events.TouchEvent
- Defines the value of the type property of a TOUCH_TAP touch event object.
toUpperCase() — Method in class String
- - Returns a copy of this string, with all lowercase characters converted - - to uppercase.
toUpperCase(s:String) — Method in class flash.globalization.StringTools
- Converts a string to uppercase according to language conventions.
toUTCString() — Method in class Date
- - Returns a String representation of the day, date, and time in universal time (UTC).
toXMLString() — Method in class XML
- - Returns a string representation of the XML object.
toXMLString() — Method in class XMLList
- - Returns a string representation of all the XML objects in an XMLList object.
trace(... rest) — Package function in Top Level
- - Displays expressions, or writes to log files, while debugging.
track — Property in class flash.media.ID3Info
- The track number; corresponds to the ID3 2.0 tag TRCK.
trackAsMenu — Property in class flash.display.MovieClip
- Indicates whether other display objects that are SimpleButton or MovieClip objects can receive - mouse release events or other user input release events.
trackAsMenu — Property in class flash.display.SimpleButton
- Indicates whether other display objects that are SimpleButton or MovieClip objects can receive - user input release events.
trackingLeft — Property in class flash.text.engine.ElementFormat
- The tracking or manual kerning applied to the left of each glyph in pixels.
trackingRight — Property in class flash.text.engine.ElementFormat
- The tracking or manual kerning applied to the right of each glyph in pixels.
trailingZeros — Property in class flash.globalization.CurrencyFormatter
- Specifies whether trailing zeros are included in the formatted currency amount.
trailingZeros — Property in class flash.globalization.NumberFormatter
- Specifies whether trailing zeros are included in a formatted number.
transform — Property in class flash.display.DisplayObject
- - An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
transform(formatObject:Object) — Method in class flash.text.StyleSheet
- Extends the CSS parsing capability.
Transform — Class in package flash.geom
- The Transform class provides access to color adjustment properties and two- or three-dimensional - transformation objects that can be applied to a display object.
TransformGestureEvent — Class in package flash.events
- The TransformGestureEvent class lets you handle complex movement input events (such as moving fingers across a touch screen) - that the device or operating system interprets as a gesture.
TransformGestureEvent(type:String, bubbles:Boolean, cancelable:Boolean, phase:String, localX:Number, localY:Number, scaleX:Number, scaleY:Number, rotation:Number, offsetX:Number, offsetY:Number, ctrlKey:Boolean, altKey:Boolean, shiftKey:Boolean, commandKey:Boolean, controlKey:Boolean, velocity:Number) — Constructor in class flash.events.TransformGestureEvent
- Creates an Event object that contains information about complex multi-touch events, such as - a user sliding his or her finger across a screen.
transformPoint(point:flash.geom:Point) — Method in class flash.geom.Matrix
- - Returns the result of applying the geometric transformation represented by the Matrix object to the - - specified point.
transformPointToOutput(point:flash.geom:Point, output:flash.geom:Point) — Method in class flash.geom.Matrix
- - Returns the result of applying the geometric transformation represented by the Matrix object to the - - specified point.
transformVector(v:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Uses the transformation matrix to transform a Vector3D object from one space coordinate - to another.
transformVectors(vin, vout) — Method in class flash.geom.Matrix3D
- Uses the transformation matrix to transform a Vector of Numbers from one - coordinate space to another.
transformVectorToOutput(v:flash.geom:Vector3D, output:flash.geom:Vector3D) — Method in class flash.geom.Matrix3D
- Uses the transformation matrix to transform a Vector3D object from one space coordinate - to another.
transition — Property in class flash.net.NetStreamPlayOptions
- The mode in which streamName is played or transitioned to.
translate(dx:Number, dy:Number) — Method in class flash.geom.Matrix
- - Translates the matrix along the x and y axes, as specified by the dx - - and dy parameters.
transparent — Property in class flash.display.BitmapData
- - Defines whether the bitmap image supports per-pixel transparency.
transparent — Property in class flash.display.NativeWindow
- - Reports the transparency setting used to create this window.
transparent — Property in class flash.display.NativeWindowInitOptions
- Specifies whether the window supports transparency and alpha blending against the desktop.
transpose() — Method in class flash.geom.Matrix3D
- Converts the current Matrix3D object to a matrix where the rows and columns - are swapped.
TriangleCulling — Final class in package flash.display
- Defines codes for culling algorithms that determine which triangles not to render when drawing triangle paths.
triggers — Property in class flash.data.SQLSchemaResult
- An array of SQLTriggerSchema instances requested in a call - to SQLConnection.loadSchema().
triggerType — Property in class flash.events.SoftKeyboardEvent
- Indicates whether the change in keyboard status has been triggered by - an application (such as programmatic use of requestSoftKeyboard()) or by the user - (such as selecting a text field).
trimFlexBits — Property in class flash.display.JPEGXREncoderOptions
- Determines the amount of extra entropy data that is cut after quantization.
true — Statement
A Boolean value representing true.
truncate() — Method in class flash.filesystem.FileStream
- Truncates the file at the position specified by the position property of the FileStream - object.
TRUNCATED_CHAR_FOUND — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that a truncated Unicode character value was found.
TRUSTED — Constant static property in class flash.security.CertificateStatus
- A valid, trusted certificate.
try..catch..finally — Statement
Encloses a block of code in which an error can occur, and then responds to the error.
tryLock() — Method in class flash.concurrent.Mutex
- - Acquires ownership of the mutex if it is available.
ttl — Property in class flash.net.dns.ResourceRecord
- The resource time-to-live (ttl) value.
tx — Property in class flash.geom.Matrix
- - The distance by which to translate each point along the x axis.
ty — Property in class flash.geom.Matrix
- - The distance by which to translate each point along the y axis.
type — Property in class flash.display.GraphicsGradientFill
- A value from the GradientType class that - specifies which gradient type to use.
type — Property in class flash.display.NativeWindow
- - Reports the window type setting used to create this window.
type — Property in class flash.display.NativeWindowInitOptions
- Specifies the type of the window to be created.
type — Property in class flash.display.ShaderParameter
- The data type of the parameter as defined in the shader.
type — Property in class flash.events.Event
- The type of event.
type — Property in class flash.filters.BevelFilter
- The placement of the bevel on the object.
type — Property in class flash.filters.GradientBevelFilter
- The placement of the bevel effect.
type — Property in class flash.filters.GradientGlowFilter
- The placement of the filter effect.
type — Property in class flash.net.FileReference
- The file type.
type — Property in class flash.text.TextField
- - The type of the text field.
TypeError — Dynamic class in Top Level
- - A TypeError exception is thrown when the actual type of an operand is different - - from the expected type.
TypeError(message:String) — Constructor in class TypeError
- - Creates a new TypeError object.
typeof — Operator
Evaluates expression and returns a string specifying the expression's data type.
typographicCase — Property in class flash.text.engine.ElementFormat
- The typographic case used for this text.
TypographicCase — Final class in package flash.text.engine
-The TypographicCase class is an enumeration of constant values for setting the typographicCase property -of the ElementFormat class.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/all-index-U.html b/html-docs/all-index-U.html deleted file mode 100644 index 506fa54..0000000 --- a/html-docs/all-index-U.html +++ /dev/null @@ -1,1481 +0,0 @@ - - - - - -U Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
U — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the U key (85).
uint — Final class in Top Level
- - The uint class provides methods for working with a data type representing a 32-bit unsigned integer.
uint(value) — Package function in Top Level
- - Converts a given numeric value to an unsigned integer value.
uint(num:Object) — Constructor in class uint
- - Creates a new uint object.
UNAVAILABLE — Constant static property in class flash.media.StageVideoAvailability
- Stage video is not currently available.
UNAVAILABLE — Constant static property in class flash.media.StageVideoAvailabilityReason
- Stage video is not currently available, no hardware was available -
UNAVAILABLE — Constant static property in class flash.media.VideoStatus
- Video decoding is not supported.
uncaughtError — Event in class flash.events.UncaughtErrorEvents
- Dispatched when an error occurs and developer code doesn't detect and handle - the error.
UNCAUGHT_ERROR — Constant static property in class flash.events.UncaughtErrorEvent
- Defines the value of the type property of an uncaughtError event object.
UncaughtErrorEvent — Class in package flash.events
- An UncaughtErrorEvent object is dispatched by an instance of the UncaughtErrorEvents - class when an uncaught error occurs.
UncaughtErrorEvent(type:String, bubbles:Boolean, cancelable:Boolean, error_in) — Constructor in class flash.events.UncaughtErrorEvent
- Creates an UncaughtErrorEvent object that contains information about an - uncaughtError event.
uncaughtErrorEvents — Property in class flash.display.Loader
- - An object that dispatches an uncaughtError event when an unhandled error - - occurs in the SWF that's loaded by this Loader object.
uncaughtErrorEvents — Property in class flash.display.LoaderInfo
- An object that dispatches an uncaughtError event when an unhandled error - occurs in code in this LoaderInfo object's SWF file.
UncaughtErrorEvents — Class in package flash.events
- The UncaughtErrorEvents class provides a way to receive uncaught - error events.
UncaughtErrorEvents() — Constructor in class flash.events.UncaughtErrorEvents
- Creates an UncaughtErrorEvents instance.
UNCAUGHT_SCRIPT_EXCEPTION — Constant static property in class flash.events.HTMLUncaughtScriptExceptionEvent
- The HTMLUncaughtScriptExceptionEvent.UNCAUGHT_SCRIPT_EXCEPTION constant - defines the value of the type property of an - uncaughtScriptException event object.
UNCOMMON — Constant static property in class flash.text.engine.LigatureLevel
- Used to specify uncommon ligatures.
uncompress(algorithm:String) — Method in class flash.utils.ByteArray
- - Decompresses the byte array.
unconnectedPeerStreams — Property in class flash.net.NetConnection
- An object that holds all of the peer subscriber NetStream objects that are not associated with publishing NetStream objects.
undefined — Package constant property in Top Level
- - A special value that applies to untyped variables that have not been initialized or dynamic object properties that are not initialized.
underline — Property in class flash.text.TextFormat
- Indicates whether the text that uses this text format is underlined (true) - or not (false).
underlineOffset — Property in class flash.text.engine.FontMetrics
- The underlineOffset value is the suggested vertical offset from the Roman baseline for an underline.
underlineThickness — Property in class flash.text.engine.FontMetrics
- The underlineThickness value is the suggested thickness for an underline.
unescape(str) — Package function in Top Level
- - Evaluates the parameter str as a string, decodes the string from URL-encoded format - - (converting all hexadecimal sequences to ASCII characters), and returns the string.
unescapeMultiByte(value) — Package function in flash.utils
- Returns an unescaped copy of the input string, which is decoded from either system code page page or UTF-8 depending on the value of System.useCodePage.
UNEXPECTED_TOKEN — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that an unexpected token was detected in a Locale ID string.
ungroupElements(groupIndex:int) — Method in class flash.text.engine.GroupElement
- Ungroups the elements in a nested GroupElement that groupIndex specifies within an outer - GroupElement object.
union(toUnion:flash.geom:Rectangle) — Method in class flash.geom.Rectangle
- - Adds two rectangles together to create a new Rectangle object, by - - filling in the horizontal and vertical space between the two rectangles.
unionToOutput(toUnion:flash.geom:Rectangle, output:flash.geom:Rectangle) — Method in class flash.geom.Rectangle
- - Adds two rectangles together to create a new Rectangle object, by - - filling in the horizontal and vertical space between the two rectangles.
UNIQUESORT — Constant static property in class Array
- - Specifies the unique sorting requirement for the Array class sorting methods.
UNJUSTIFIED — Constant static property in class flash.text.engine.LineJustification
- Do not justify lines.
unjustifiedTextWidth — Property in class flash.text.engine.TextLine
- The width of the line if it was not justified.
UNKNOWN — Constant static property in class flash.display.StageOrientation
- Specifies that the device has not determined an orientation.
UNKNOWN — Constant static property in class flash.events.TouchEventIntent
- A general contact type, for example, the touch event is generated by a finger, the palm of a hand, or a passive stylus.
UNKNOWN — Constant static property in class flash.media.CameraPosition
- The Camera.position property returns this when the position of the Camera cannot be determined.
UNKNOWN — Constant static property in class flash.permissions.PermissionStatus
- - Specifies that the permission hasn't been requested yet.
UNKNOWN — Constant static property in class flash.security.CertificateStatus
- The validity of the certificate is not known.
UNKNOWN — Constant static property in class flash.security.SignatureStatus
- Unknown status.
UNKNOWN — Constant static property in class flash.system.IMEConversionMode
- The string "UNKNOWN", which can be returned by a call to - the IME.conversionMode property.
UNLESS_EDITING — Constant static property in class flash.text.StageTextClearButtonMode
- StageText clearButton is not shown while editing -
unload() — Method in class flash.display.Loader
- - Removes a child of this Loader object that was loaded by using the load() method.
unload — Event in class flash.display.LoaderInfo
- Dispatched by a LoaderInfo object whenever a loaded object is removed by using the unload() - method of the Loader object, or when a second load is performed by the same Loader object and the - original content is removed prior to the load beginning.
UNLOAD — Constant static property in class flash.events.Event
- The Event.UNLOAD constant defines the value of the type property of an unload event object.
unloadAndStop(gc:Boolean) — Method in class flash.display.Loader
- - Attempts to unload child SWF file contents and stops the execution of commands from loaded SWF files.
unlock() — Method in class flash.concurrent.Mutex
- - Releases ownership of this mutex, allowing any worker to acquire it and - - perform work on the associated resource.
unlock(changeRect:flash.geom:Rectangle) — Method in class flash.display.BitmapData
- - Unlocks an image so that any objects that reference the BitmapData object, such as Bitmap objects, - - are updated when this BitmapData object changes.
unregisterCommandHandler(commandName:String) — Static method in class flash.profiler.Telemetry
unregisterCursor(name:String) — Static method in class flash.ui.Mouse
- Unregisters the native cursor with the given name.
unshift(... rest) — Method in class Array
- - Adds one or more elements to the beginning of an array and returns the new length of the array.
unshift(... rest) — Method in class Vector
- Adds one or more elements to the beginning of the Vector and returns - the new length of the Vector.
unsubscribe() — Method in class flash.notifications.RemoteNotifier
- Unsubscribes the application from receiving remote notifications via APNs.
UNSUPPORTED — Constant static property in class flash.display.ColorCorrectionSupport
-Color correction is not supported by the host environment.
UNSUPPORTED_ERROR — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that the requested operation or option is not supported.
UNTRUSTED_SIGNERS — Constant static property in class flash.security.CertificateStatus
- The certificate does not chain to a trusted root certificate.
UP — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Up Arrow key (38).
update — Event in class flash.data.SQLConnection
- Dispatched when data in any table in any of the connected databases changes as a result - of a SQL UPDATE command.
update(airFile:flash.filesystem:File, version:String) — Method in class flash.desktop.Updater
- Updates the currently running application with the version of the - application contained in the specified AIR file.
update — Event in class flash.sensors.Accelerometer
- The update event is dispatched in response to updates from the accelerometer sensor.
update — Event in class flash.sensors.DeviceRotation
- The update event is dispatched when the device is rotated in response to updates from the combined readings - from accelerometer and gyroscope sensors.
update — Event in class flash.sensors.Geolocation
- The update event is dispatched in response to updates from the location sensor.
update(type:String) — Method in class flash.system.SystemUpdater
- Begins an update of a given type.
UPDATE — Constant static property in class flash.data.SQLMode
- Indicates that the connection is opened for updates but a - new database file is not created if the specified file doesn't exist.
UPDATE — Constant static property in class flash.events.AccelerometerEvent
- Defines the value of the type property of a AccelerometerEvent event object.
UPDATE — Constant static property in class flash.events.DeviceRotationEvent
- Defines the value of the type property of a DeviceRotationEvent event object.
UPDATE — Constant static property in class flash.events.GeolocationEvent
- Defines the value of the type property of a GeolocationEvent event object.
UPDATE — Constant static property in class flash.events.GesturePhase
- The progress of a gesture (such as moving a finger across a touch enabled screen).
UPDATE — Constant static property in class flash.events.SQLUpdateEvent
- The SQLUpdateEvent.UPDATE constant defines the value of the - type property of a SQLConnection update event.
UPDATE — Constant static property in class flash.filesystem.FileMode
- Used for a file to be opened in read/write mode.
updateAfterEvent() — Method in class flash.events.GestureEvent
- Refreshes the Flash runtime display after processing the gesture event, in case the display list has been modified by the event handler.
updateAfterEvent() — Method in class flash.events.KeyboardEvent
- - Indicates that the display should be rendered after processing of this event completes, if the display - - list has been modified - - -
updateAfterEvent() — Method in class flash.events.MouseEvent
- - Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
updateAfterEvent() — Method in class flash.events.TimerEvent
- Instructs Flash Player or the AIR runtime to render - after processing of this event completes, if the display list has been modified.
updateAfterEvent() — Method in class flash.events.TouchEvent
- Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
updateComposition(text:String, attributes, compositionStartIndex:int, compositionEndIndex:int) — Method in interface flash.text.ime.IIMEClient
- Callback for updating the contents of the inline editing session.
updateDescriptor — Property in class air.update.ApplicationUpdater
- - The content of the update descriptor file downloaded from the update URL.
updateDescriptor — Property in class air.update.ApplicationUpdaterUI
- - The content of the update descriptor file downloaded from the update URL.
updateError — Event in class air.update.ApplicationUpdater
- - Dispatched if an error occurs while trying to download or parse the update descriptor file.
updateError — Event in class air.update.ApplicationUpdaterUI
- - - - Dispatched if an error occurs while trying to download or parse the update descriptor file.
UPDATE_ERROR — Constant static property in class air.update.events.StatusUpdateErrorEvent
- - The StatusUpdateErrorEvent.UPDATE_ERROR constant defines the value of the - - type property of the event object for a statusUpdateError event.
UpdateEvent — Class in package air.update.events
- - A UpdateEvent is dispatched by a ApplicationUpdater object during the update process.
UpdateEvent(type:String, bubbles:Boolean, cancelable:Boolean) — Constructor in class air.update.events.UpdateEvent
- - The constructor function.
updateLocation(locationURL:String) — Method in class flash.html.HTMLHost
- The function called when JavaScript code in the HTMLLoader object sets the - window.location property.
updateProperties() — Static method in class flash.accessibility.Accessibility
- Tells Flash Player to apply any accessibility changes made by using the DisplayObject.accessibilityProperties property.
Updater — Final class in package flash.desktop
- The Updater class is used to update the currently running application - with a different version.
Updater() — Constructor in class flash.desktop.Updater
- The constructor function for the Updater class.
updateStatus — Event in class air.update.ApplicationUpdater
- - Dispatched after the updater successfully downloads and - - interprets the update descriptor file.
updateStatus — Event in class air.update.ApplicationUpdaterUI
- - - - Dispatched after the updater successfully downloads and - - interprets the update descriptor file.
updateStatus(status:String) — Method in class flash.html.HTMLHost
- The function called when JavaScript code in the HTMLLoader object sets the - window.status property.
UPDATE_STATUS — Constant static property in class air.update.events.StatusUpdateEvent
- - The StatusUpdateEvent.UPDATE_STATUS constant defines the value of the - - type property of the event object for a updateStatus event.
updateTitle(title:String) — Method in class flash.html.HTMLHost
- The function called when JavaScript code in the HTMLLoader object sets the - window.document.title property or when the title - element changes, either via the DOM or because of a new page load.
updateURL — Property in class air.update.ApplicationUpdater
- - The location of the update descriptor file.
updateURL — Property in class air.update.ApplicationUpdaterUI
- - The location of the update descriptor file.
upload(vertexProgram:flash.utils:ByteArray, fragmentProgram:flash.utils:ByteArray) — Method in class flash.display3D.Program3D
- Uploads a pair of rendering programs expressed in AGAL (Adobe Graphics Assembly Language) bytecode.
upload(request:flash.net:URLRequest, uploadDataFieldName:String, testUpload:Boolean) — Method in class flash.net.FileReference
- Starts the upload of the file to a remote server.
uploadCompleteData — Event in class flash.net.FileReference
- Dispatched after data is received from the server after a successful upload.
UPLOAD_COMPLETE_DATA — Constant static property in class flash.events.DataEvent
- - Defines the value of the type property of an uploadCompleteData event object.
uploadCompressedTextureFromByteArray(data:flash.utils:ByteArray, byteArrayOffset:uint, async:Boolean) — Method in class flash.display3D.textures.CubeTexture
- Uploads a cube texture in Adobe Texture Format (ATF) from a byte array.
uploadCompressedTextureFromByteArray(data:flash.utils:ByteArray, byteArrayOffset:uint, async:Boolean) — Method in class flash.display3D.textures.Texture
- Uploads a compressed texture in Adobe Texture Format (ATF) from a ByteArray object.
uploadFromBitmapData(source:flash.display:BitmapData, side:uint, miplevel:uint) — Method in class flash.display3D.textures.CubeTexture
- Uploads a component of a cube map texture from a BitmapData object.
uploadFromBitmapData(source:flash.display:BitmapData) — Method in class flash.display3D.textures.RectangleTexture
- Uploads a texture from a BitmapData object.
uploadFromBitmapData(source:flash.display:BitmapData, miplevel:uint) — Method in class flash.display3D.textures.Texture
- Uploads a texture from a BitmapData object.
uploadFromBitmapDataAsync(source:flash.display:BitmapData) — Method in class flash.display3D.textures.RectangleTexture
- Uploads a texture from a BitmapData object.
uploadFromBitmapDataAsync(source:flash.display:BitmapData, miplevel:uint) — Method in class flash.display3D.textures.Texture
- Uploads miplevel 0 for a texture from a BitmapData object asynchronously.
uploadFromByteArray(data:flash.utils:ByteArray, byteArrayOffset:int, startOffset:int, count:int) — Method in class flash.display3D.IndexBuffer3D
- Store in the graphics subsystem vertex indices.
uploadFromByteArray(data:flash.utils:ByteArray, byteArrayOffset:int, startVertex:int, numVertices:int) — Method in class flash.display3D.VertexBuffer3D
- - Uploads the data for a set of points to the rendering context from a byte array.
uploadFromByteArray(data:flash.utils:ByteArray, byteArrayOffset:uint, side:uint, miplevel:uint) — Method in class flash.display3D.textures.CubeTexture
- Uploads a component of a cube map texture from a ByteArray object.
uploadFromByteArray(data:flash.utils:ByteArray, byteArrayOffset:uint) — Method in class flash.display3D.textures.RectangleTexture
- Uploads a texture from a ByteArray.
uploadFromByteArray(data:flash.utils:ByteArray, byteArrayOffset:uint, miplevel:uint) — Method in class flash.display3D.textures.Texture
- Uploads a texture from a ByteArray.
uploadFromByteArrayAsync(data:flash.utils:ByteArray, byteArrayOffset:uint) — Method in class flash.display3D.textures.RectangleTexture
- Uploads a texture from a ByteArray.
uploadFromByteArrayAsync(data:flash.utils:ByteArray, byteArrayOffset:uint, miplevel:uint) — Method in class flash.display3D.textures.Texture
- Uploads miplevel 0 for a texture from a ByteArray asynchronously.
uploadFromFloatVector(data, startVertex:int, numVertices:int) — Method in class flash.display3D.VertexBuffer3D
- - Uploads the data for a set of points to the rendering context from a float vector array.
uploadFromVector(data, startOffset:int, count:int) — Method in class flash.display3D.IndexBuffer3D
- Store in the graphics subsystem vertex indices.
uploadFromVector(data, startVertex:int, numVertices:int) — Method in class flash.display3D.VertexBuffer3D
- - Uploads the data for a set of points to the rendering context from a vector array.
uploadUnencoded(request:flash.net:URLRequest) — Method in class flash.net.FileReference
- Initiate uploading a file to a URL without any encoding.
UPPERCASE — Constant static property in class flash.text.engine.TypographicCase
- Specifies that all characters use uppercase glyphs on output.
UPSIDE_DOWN — Constant static property in class flash.display.StageOrientation
- Specifies that the stage is currently upside down relative to the default orientation.
upState — Property in class flash.display.SimpleButton
- Specifies a display object that is used as the visual - object for the button up state — the state that the button is in when - the pointer is not positioned over the button.
uri — Property in class Namespace
- - The Uniform Resource Identifier (URI) of the namespace.
uri — Property in class QName
- - The Uniform Resource Identifier (URI) of the QName object.
uri — Property in class flash.net.NetConnection
- The URI passed to the NetConnection.connect() method.
uri — Property in class flash.net.NetStreamInfo
- The URI used when NetConnection.connect() was called.
uriDereferencer — Property in class flash.security.XMLSignatureValidator
- The IURIDereferencer implementation.
URIError — Dynamic class in Top Level
- - A URIError exception is thrown when one of the global URI handling functions is used - - in a way that is incompatible with its definition.
URIError(message:String) — Constructor in class URIError
- - Creates a new URIError object.
url — Property in class flash.display.LoaderInfo
- The URL of the media being loaded.
url — Property in class flash.filesystem.File
- - The URL for this file path.
url — Property in class flash.html.HTMLHistoryItem
- The URL of the HTML page.
url — Property in class flash.media.Sound
- The URL from which this sound was loaded.
url — Property in class flash.net.URLRequest
- The URL to be requested.
url — Property in class flash.text.TextFormat
- Indicates the target URL for the text in this text format.
URL — Constant static property in class flash.text.SoftKeyboardType
-

A keyboard optimized for entering URLs.

URL_FORMAT — Constant static property in class flash.desktop.ClipboardFormats
- A URL string (AIR only).
URLLoader — Class in package flash.net
- - The URLLoader class downloads data from a URL - - as text, binary data, or URL-encoded variables.
URLLoader(request:flash.net:URLRequest) — Constructor in class flash.net.URLLoader
- - Creates a URLLoader object.
URLLoaderDataFormat — Final class in package flash.net
- The URLLoaderDataFormat class provides values that specify how downloaded data is received.
urlPrompt — Property in class flash.events.DRMAuthenticateEvent
- A prompt for a URL string, provided by the server.
URLRequest — Final class in package flash.net
- The URLRequest class captures all of the information in a single HTTP request.
URLRequest(url:String) — Constructor in class flash.net.URLRequest
- Creates a URLRequest object.
URLRequestDefaults — Class in package flash.net
- The URLRequestDefaults class includes static properties that you can set to define - default values for the properties of the URLRequest class.
URLRequestHeader — Final class in package flash.net
- A URLRequestHeader object encapsulates a single HTTP request header - and consists of a name/value pair.
URLRequestHeader(name:String, value:String) — Constructor in class flash.net.URLRequestHeader
- Creates a new URLRequestHeader object that encapsulates a single HTTP request header.
URLRequestMethod — Final class in package flash.net
- The URLRequestMethod class provides values that specify whether the URLRequest object should - use the POST method or the GET method when sending data to a server.
URLStream — Class in package flash.net
- - The URLStream class provides low-level access to - - downloading URLs.
URLVariables — Dynamic class in package flash.net
- The URLVariables class allows you to transfer - variables between an application and a - server.
URLVariables(source:String) — Constructor in class flash.net.URLVariables
- Creates a new URLVariables object.
useCache — Property in class flash.html.HTMLLoader
useCache — Property in class flash.net.URLRequest
- Specifies whether the local cache should be consulted before this URLRequest - fetches data.
useCache — Static property in class flash.net.URLRequestDefaults
- The default setting for the useCache property of URLRequest objects.
useCodePage — Static property in class flash.system.System
- - A Boolean value that determines which code page to use to interpret external text files.
USE_DOMINANT_BASELINE — Constant static property in class flash.text.engine.TextBaseline
- Specifies that the alignmentBaseline is the same as the dominantBaseline.
useEchoSuppression — Property in class flash.media.Microphone
- Set to true if echo suppression is enabled; false otherwise.
useGrouping — Property in class flash.globalization.CurrencyFormatter
- Enables the use of the grouping separator when formatting currency amounts.
useGrouping — Property in class flash.globalization.NumberFormatter
- Enables the use of the grouping separator when formatting numbers.
useHandCursor — Property in class flash.display.SimpleButton
- A Boolean value that, when set to true, indicates whether - the hand cursor is shown when the pointer rolls over a button.
useHandCursor — Property in class flash.display.Sprite
- A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls - over a sprite in which the buttonMode property is set to true.
useHardwareDecoder — Property in class flash.net.NetStream
- Specifies whether to use hardware accelerated decoding on the stream.
useJitterBuffer — Property in class flash.net.NetStream
- Minimize latency for live un-buffered streaming (bufferTime = 0).
use namespace — Statement
Causes the specified namespaces to be added to the set of open namespaces.
userAgent — Property in class flash.html.HTMLLoader
userAgent — Property in class flash.net.URLRequest
- Specifies the user-agent string to be used in the HTTP request.
userAgent — Static property in class flash.net.URLRequestDefaults
- The default setting for the userAgent property of URLRequest objects.
userData — Property in class flash.text.engine.ContentElement
- Provides a way for an application to associate arbitrary data with the element.
userData — Property in class flash.text.engine.TextBlock
- Provides a way for the application to associate arbitrary data with the text block.
userData — Property in class flash.text.engine.TextLine
- Provides a way for the application to associate arbitrary data with the text line.
userDirectory — Static property in class flash.filesystem.File
- - The user's directory.
USER_DISABLED — Constant static property in class flash.media.StageVideoAvailabilityReason
- Stage video is not currently available, the user disabled HW acceleration -
useRedirectedURL(sourceRequest:flash.net:URLRequest, wholeURL:Boolean, pattern, replace:String) — Method in class flash.net.URLRequest
- - Allows substitution of a redirected URL from a source URLRequest for some portion of the URL - in a new URLRequest.
useRichTextClipboard — Property in class flash.text.TextField
- - Specifies whether to copy and paste the text formatting along with the text.
userIdle — Event in class flash.desktop.NativeApplication
- - Dispatched when the user has been idle.
USER_IDLE — Constant static property in class flash.events.Event
- The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
USERNAME_AND_PASSWORD — Constant static property in class flash.net.drm.AuthenticationMethod
- Indicates that a valid user name and password are required.
usernamePrompt — Property in class flash.events.DRMAuthenticateEvent
- A prompt for a user name credential, provided by the server.
userPresent — Event in class flash.desktop.NativeApplication
- - Dispatched when the operating system detects mouse or keyboard activity after an idle period.
USER_PRESENT — Constant static property in class flash.events.Event
- The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
USER_SELECTION — Constant static property in class flash.media.AudioOutputChangeReason
- Audio Output is changed by user selecting a different device.
USER_TRIGGERED — Constant static property in class flash.events.SoftKeyboardTrigger
- Indicates that user action invoked the event.
usesDaylightSavings — Property in class TimeZone
- - Whether this time zone has a daylight savings change.
useSpeakerphoneForVoice — Static property in class flash.media.SoundMixer
- Toggles the speakerphone when the device is in voice mode.
useSystemTrustStore — Property in class flash.security.XMLSignatureValidator
- Specifies that certificates in the system trust store are used for chain building.
USING_DEFAULT_WARNING — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that an operating system default value was used during the most recent operation.
USING_FALLBACK_WARNING — Constant static property in class flash.globalization.LastOperationStatus
- Indicates that a fallback value was set during the most recent operation.
usingTLS — Property in class flash.net.NetConnection
- Indicates whether a secure connection was made using native Transport Layer Security (TLS) - rather than HTTPS.
UTC(year:Number, month:Number, date:Number, hour:Number, minute:Number, second:Number, millisecond:Number) — Static method in class Date
- - Returns the number of milliseconds between midnight on January 1, 1970, universal time, - - and the time specified in the parameters.
UTILITY — Constant static property in class flash.display.NativeWindowType
- A utility window.
Utils3D — Class in package flash.geom
- The Utils3D class contains static methods that simplify the implementation of certain three-dimensional - matrix operations.
uvtData — Property in class flash.display.GraphicsTrianglePath
- A Vector of normalized coordinates used to apply texture mapping.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/all-index-V.html b/html-docs/all-index-V.html deleted file mode 100644 index 2da438d..0000000 --- a/html-docs/all-index-V.html +++ /dev/null @@ -1,861 +0,0 @@ - - - - - -V Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
V — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the V key (86).
VAI — Constant static property in class flash.globalization.NationalDigitsType
- Represents the Unicode value for the zero digit of the Vai digit set.
VALID — Constant static property in class flash.security.SignatureStatus
- Valid status.
VALID — Constant static property in class flash.text.engine.TextLineValidity
- Specifies that the text line is valid.
VALID_IDENTITY — Constant static property in class flash.security.ReferencesValidationSetting
- Only check references if the signing certificate is valid and trusted.
validity — Property in class flash.text.engine.TextLine
- Specifies the current validity of the text line.
validityStatus — Property in class flash.security.XMLSignatureValidator
- The validity status of a verified XML signature.
validNotAfter — Property in class flash.security.X509Certificate
- Indicates the date on which the certificate's validity period ends.
validNotBefore — Property in class flash.security.X509Certificate
- Indicates the date on which the certificate's validity period begins.
VALID_OR_UNKNOWN_IDENTITY — Constant static property in class flash.security.ReferencesValidationSetting
- Check references even if the signing certificate is untrusted (does not chain to a known trusted root).
value — Property in class flash.display.ShaderParameter
- The value or values that are passed in as the parameter value to the shader.
value — Property in class flash.globalization.CurrencyParseResult
- The currency amount value that was extracted from the input string.
value — Property in class flash.globalization.NumberParseResult
- The value of the numeric portion of the input string.
value — Property in class flash.net.URLRequestHeader
- The value associated with the name property (such as text/plain).
value — Property in class flash.ui.GameInputControl
- Returns the value for this control.
valueOf() — Method in class Boolean
- - Returns true if the value of the specified Boolean - - object is true; false otherwise.
valueOf() — Method in class Date
- - Returns the number of milliseconds since midnight January 1, 1970, universal time, - - for a Date object.
valueOf() — Method in class float
- - Returns the primitive value type of the specified float object.
valueOf() — Method in class int
- - Returns the primitive value of the specified int object.
valueOf() — Method in class Namespace
- - Returns the URI value of the specified object.
valueOf() — Method in class Number
- - Returns the primitive value type of the specified Number object.
valueOf() — Method in class Object
- - Returns the primitive value of the specified object.
valueOf() — Method in class QName
- - Returns the QName object.
valueOf() — Method in class String
- - Returns the primitive value of a String instance.
valueOf() — Method in class uint
- - Returns the primitive uint type value of the specified - - uint object.
valueOf() — Method in class XML
- - Returns the XML object.
valueOf() — Method in class XMLList
- - Returns the XMLList object.
valueOf() — Method in class flash.external.HostObject
- Implement valueOf() by calling the host object's valueOf() method if - available; if not, return this instance to indicate the absence of - a primitive value.
var — Statement
Specifies a variable.
VARIABLES — Constant static property in class flash.net.URLLoaderDataFormat
- Specifies that downloaded data is received as URL-encoded variables.
vector — Property in class flash.events.ShaderEvent
- - The Vector.<Number> object that was passed to the ShaderJob.start() method.
Vector — Dynamic class in Top Level
- The Vector class lets you access and manipulate a vector — an array whose elements - all have the same data type.
Vector(sourceArray) — Package function in Top Level
- Creates a new Vector instance whose elements are instances of the specified data type.
Vector(length:uint, fixed:Boolean) — Constructor in class Vector
- Creates a Vector with the specified base type.
VECTOR — Constant static property in class flash.printing.PrintMethod
- The vector method of printing.
Vector3D — Class in package flash.geom
- The Vector3D class represents a point or a location in the three-dimensional space using the - Cartesian coordinates x, y, and z.
Vector3D(x:Number, y:Number, z:Number, w:Number) — Constructor in class flash.geom.Vector3D
- Creates an instance of a Vector3D object.
velocity — Property in class flash.events.TransformGestureEvent
- The velocity, in pixels per second, of the transform gesture event.
verify(signature:XML) — Method in class flash.security.XMLSignatureValidator
- Verifies the specified signature.
VerifyError — Dynamic class in Top Level
- - The VerifyError class represents an error that occurs when a malformed - - or corrupted SWF file is encountered.
VerifyError(message:String) — Constructor in class VerifyError
- - Creates a new VerifyError object.
version — Property in class air.update.events.StatusFileUpdateEvent
- - The version string of the update.
version — Property in class air.update.events.StatusUpdateEvent
- - The version string of the update.
version — Property in class flash.security.X509Certificate
- Provides the version number of the certificate format.
version — Static property in class flash.system.Capabilities
- Specifies the Flash Player or Adobe® AIR® - platform and version information.
versionLabel — Property in class air.update.events.StatusFileUpdateEvent
- - The version label string of the update.
versionLabel — Property in class air.update.events.StatusUpdateEvent
- - The version label string of the update.
versionNumber — Property in class flash.external.ExtensionInfo
- - The extension version number, as provided in the extension's XML descriptor file.
VERTEX — Constant static property in class flash.display3D.Context3DProgramType
- A vertex program.
VertexBuffer3D — Class in package flash.display3D
- - The VertexBuffer3D class represents a set of vertex data uploaded to a rendering context.
VERTICAL — Constant static property in class flash.display.LineScaleMode
- With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line scales only vertically.
verticalAccuracy — Property in class flash.events.GeolocationEvent
- The vertical accuracy in meters.
verticalTextLayout — Property in interface flash.text.ime.IIMEClient
- Indicates whether the text in the component is vertical or not.
vertices — Property in class flash.display.GraphicsTrianglePath
- A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair).
Video — Class in package flash.media
- - The Video class displays live or recorded video in an application - without embedding the video in your SWF file.
Video(width:int, height:int) — Constructor in class flash.media.Video
- Creates a new Video instance.
VIDEO — Constant static property in class flash.media.MediaType
- A video.
videoBufferByteLength — Property in class flash.net.NetStreamInfo
- Provides the NetStream video buffer size in bytes.
videoBufferLength — Property in class flash.net.NetStreamInfo
- Provides NetStream video buffer size in seconds.
videoByteCount — Property in class flash.net.NetStreamInfo
- Specifies the total number of video bytes that have arrived in the queue, regardless of how many have been played or flushed.
videoBytesPerSecond — Property in class flash.net.NetStreamInfo
- Specifies the rate at which the NetStream video buffer is filled in bytes per second.
VideoCodec — Final class in package flash.media
- The VideoCodec class is an enumeration of constant values of supported video codecs.
VideoEvent — Class in package flash.events
-

This event class reports the current video rendering status.

VideoEvent(type:String, bubbles:Boolean, cancelable:Boolean, status:String) — Constructor in class flash.events.VideoEvent
-

Constructor.

-
videoFrame — Event in class flash.media.Camera
- - Dispatched after a new camera frame is processed by the runtime and is available to be copied.
VIDEO_FRAME — Constant static property in class flash.events.Event
- The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
videoHeight — Property in class flash.display3D.textures.VideoTexture
- An integer specifying the height of the video stream, in pixels.
videoHeight — Property in class flash.media.StageVideo
- An integer specifying the height of the video stream, in pixels.
videoHeight — Property in class flash.media.Video
- An integer specifying the height of the video stream, in pixels.
videoLossRate — Property in class flash.net.NetStreamInfo
- Provides the NetStream video loss rate (ratio of lost messages to total messages).
videoReliable — Property in class flash.net.NetStream
- For RTMFP connections, specifies whether video is sent with full reliability.
videoSampleAccess — Property in class flash.net.NetStream
- For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the video stream.
VideoStatus — Final class in package flash.media
- This class defines an enumeration that describes possible levels of video decoding.
videoStreamSettings — Property in class flash.net.NetStream
VideoStreamSettings — Class in package flash.media
- The VideoStreamSettings class enables specifying video compression settings for each NetStream.
VideoStreamSettings() — Constructor in class flash.media.VideoStreamSettings
- Creates a setting object that specifies to use Sorenson Spark video codec for compresion.
VideoTexture — Final class in package flash.display3D.textures
- Prior to Flash Player 21, the use of video in Stage3D required the use of the Video object - (which is not hardware accelerated), copying of video frame to a BitmapData object, - and loading of the data onto the GPU which is CPU intensive.
VideoTextureEvent — Class in package flash.events
- Almost exactly StageVideoEvent.
VideoTextureEvent(type:String, bubbles:Boolean, cancelable:Boolean, status:String, colorSpace:String) — Constructor in class flash.events.VideoTextureEvent
-
videoWidth — Property in class flash.display3D.textures.VideoTexture
- An integer specifying the width of the video stream, in pixels.
videoWidth — Property in class flash.media.StageVideo
- An integer specifying the width of the video stream, in pixels.
videoWidth — Property in class flash.media.Video
- An integer specifying the width of the video stream, in pixels.
viewPort — Property in class flash.media.StageVideo
- The absolute position and size of the video surface in pixels.
viewPort — Property in class flash.media.StageWebView
- - The area on the stage in which the StageWebView object is displayed.
viewPort — Property in class flash.text.StageText
- - The area on the stage in which the StageText object is displayed.
views — Property in class flash.data.SQLSchemaResult
- An array of SQLViewSchema instances requested in a call - to SQLConnection.loadSchema().
visible — Property in class flash.display.DisplayObject
- Whether or not the display object is visible.
visible — Property in class flash.display.NativeWindow
- - Specifies whether this window is visible.
visible — Property in class flash.display.Stage3D
- Specifies whether this Stage3D object is visible.
visible — Property in class flash.text.StageText
- - Indicates whether the StageText object is visible.
visible — Property in class flash.ui.ContextMenuItem
- Indicates whether the specified menu item is visible when the Flash Player - context menu is displayed.
visibleBounds — Property in class flash.display.Screen
- - The bounds of the area on this screen in which windows can be visible.
VOD — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the button for engaging video-on-demand.
VOICE — Constant static property in class flash.media.AudioPlaybackMode
- A mode for playing voice audio.
void — Operator
Evaluates an expression and then discards its value, returning undefined.
void — Special Type
Specifies that a function cannot return any value.
volume — Property in class flash.media.SoundTransform
- The volume, ranging from 0 (silent) to 1 (full volume).
voucher — Property in class flash.events.DRMStatusEvent
- A DRMVoucher object for the content.
VoucherAccessInfo — Final class in package flash.net.drm
- A VoucherAccessInfo object presents the information that is required - to successfully retrieve and consume a voucher, such as the type - of authentication and the content domain of the media rights server.
voucherEndDate — Property in class flash.events.DRMStatusEvent
- The absolute date on which the voucher expires and the content can no longer be viewed by users.
voucherEndDate — Property in class flash.net.drm.DRMVoucher
- The date on which this voucher expires.
voucherStartDate — Property in class flash.net.drm.DRMVoucher
- The beginning of this voucher's validity period.
VP6 — Constant static property in class flash.media.VideoCodec
- Constant value indicating that On2Vp6 codec is used for compressing video.
vsyncEnabled — Property in class flash.display.Stage
- This represents current state of vsync of underlying graphics solution - We can enable/disable vsync, so we would immediately render without waiting for next VSYNC'ed state.
VsyncStateChangeAvailability — Event in class flash.display.Stage
- Dispatched by the Stage object when the state of the vsync property is changed.
VSYNC_STATE_CHANGE_AVAILABILITY — Constant static property in class flash.events.VsyncStateChangeAvailabilityEvent
- Defines the value of the type property of a VsyncStateChangeAvailabilityEvent event object.
VsyncStateChangeAvailabilityEvent — Class in package flash.events
- The Stage class dispatches VsyncStateChangeAvailabilityEvent when the availablity of Stage for changing vsync state changes.
VsyncStateChangeAvailabilityEvent(type:String, bubbles:Boolean, cancelable:Boolean, available:Boolean) — Constructor in class flash.events.VsyncStateChangeAvailabilityEvent
-

Constructor.

- Creates an VsyncStateChangeAvailabilityEvent object that contains information about availability of vsync state change.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/all-index-W.html b/html-docs/all-index-W.html deleted file mode 100644 index fa04738..0000000 --- a/html-docs/all-index-W.html +++ /dev/null @@ -1,1148 +0,0 @@ - - - - - -W Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
w — Property in class flash.geom.Vector3D
- The fourth element of a Vector3D object (in addition to the x, y, - and z properties) can hold - data such as the angle of rotation.
W — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the W key (87).
wait(timeout:Number) — Method in class flash.concurrent.Condition
- - Specifies that the condition that this Condition object represents isn't - - satisfied, and the current worker needs to wait until it is satisfied - - before executing more code.
wasPendingUpdate — Property in class air.update.ApplicationUpdater
- - Whether there was a postponed update, even if it failed - - to install (true); false otherwise.
wasPendingUpdate — Property in class air.update.ApplicationUpdaterUI
- - Whether there was a postponed update, even if it failed - - to install (true); false otherwise.
WebSocket — Class in package air.net
- - The WebSocket class is a utility that encapsulates a normal Socket object - - and implements the WebSocket protocol (RFC 6455).
WebSocket() — Constructor in class air.net.WebSocket
- - Constructor for a WebSocket object.
websocketData — Event in class air.net.WebSocket
- - Dispatched when the WebSocket receives a message.
WebSocketEvent — Class in package flash.events
- - An event that contains data received from a WebSocket object.
WebSocketEvent(type:String, format:uint, data:flash.utils:ByteArray) — Constructor in class flash.events.WebSocketEvent
- - Constructor for a WebSocketEvent object.
webViewDrawComplete — Event in class flash.media.StageWebView
- - Dispatched when the StageWebView rendering to a target has completed.
WEBVIEW_DRAW_COMPLETE — Constant static property in class flash.events.WebViewDrawEvent
- Defines the value of the type property of a progress event object.
WebViewDrawEvent — Class in package flash.events
- A WebViewDrawEvent object is dispatched when a StageWebView object has completed some asynchronous - draw event.
WebViewDrawEvent(type:String, bubbles:Boolean, cancelable:Boolean) — Constructor in class flash.events.WebViewDrawEvent
- Creates an Event object that contains the rendered StageWebView content.
webViewMessage — Event in class flash.media.StageWebView
- - Dispatched when the HTML contents within the StageWebView posts a message out - - to the client application.
WEBVIEW_MESSAGE — Constant static property in class flash.events.DataEvent
- - Defines the value of the type property of an webViewMessage event object.
weight — Property in class flash.net.dns.SRVRecord
- The relative weight to use when selecting from service hosts that have the same priority.
while — Statement
Evaluates a condition and if the condition evaluates to true, executes one or more statements before looping back to evaluate the condition again.
WHILE_EDITING — Constant static property in class flash.text.StageTextClearButtonMode
- StageText clearButton is visible while editing -
wideLineTo(x:Number, y:Number) — Method in class flash.display.GraphicsPath
- Adds a new "wideLineTo" command to the commands vector and - new coordinates to the data vector.
WIDE_LINE_TO — Constant static property in class flash.display.GraphicsPathCommand
- Specifies a "line to" drawing command, but uses two sets of coordinates (four values) instead of one set.
wideMoveTo(x:Number, y:Number) — Method in class flash.display.GraphicsPath
- Adds a new "wideMoveTo" command to the commands vector and - new coordinates to the data vector.
WIDE_MOVE_TO — Constant static property in class flash.display.GraphicsPathCommand
- Specifies a "move to" drawing command, but uses two sets of coordinates (four values) instead of one set.
width — Property in class flash.desktop.DockIcon
- The current display width of the icon in pixels.
width — Property in class flash.desktop.InteractiveIcon
- The current display width of the icon in pixels.
width — Property in class flash.desktop.SystemTrayIcon
- The current display width of the icon in pixels.
width — Property in class flash.display.BitmapData
- - The width of the bitmap image in pixels.
width — Property in class flash.display.DisplayObject
- Indicates the width of the display object, in pixels.
width — Property in class flash.display.LoaderInfo
- The nominal width of the loaded content.
width — Property in class flash.display.NativeWindow
- - The width of this window in pixels.
width — Property in class flash.display.ScreenMode
- The screen width of the ScreenMode in pixels.
width — Property in class flash.display.ShaderInput
- The width of the shader input.
width — Property in class flash.display.ShaderJob
- The width of the result data in the target if it is - a ByteArray or Vector.<Number> instance.
width — Property in class flash.display.Stage
- Indicates the width of the display object, in pixels.
width — Property in class flash.geom.Rectangle
- - The width of the rectangle, in pixels.
width — Property in class flash.html.HTMLLoader
width — Property in class flash.html.HTMLWindowCreateOptions
- Specifies the desired initial width of the new window.
width — Property in class flash.media.Camera
- - The current capture width, in pixels.
width — Property in class flash.media.CameraRollBrowseOptions
- Specifies the width of the CameraRoll image picker.
width — Property in class flash.media.VideoStreamSettings
- The current encoded width, in pixels.
width — Property in class flash.text.TextExtent
width — Property in class flash.text.TextLineMetrics
- The width value is the width of the text of the selected lines (not necessarily the complete text) in pixels.
willTrigger(type:String) — Method in class flash.display.Stage
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
willTrigger(type:String) — Method in class flash.events.EventDispatcher
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
willTrigger(type:String) — Method in interface flash.events.IEventDispatcher
- Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
winding — Property in class flash.display.GraphicsPath
- Specifies the winding rule using a value defined in the GraphicsPathWinding class.
window — Property in class flash.html.HTMLLoader
windowBlur() — Method in class flash.html.HTMLHost
- The function called when JavaScript code in the HTMLLoader object calls the - window.blur() method.
windowClose() — Method in class flash.html.HTMLHost
- The function called when JavaScript code in the HTMLLoader object calls the - window.close() method.
windowFocus() — Method in class flash.html.HTMLHost
- The function called when JavaScript code in the HTMLLoader object calls the - window.focus() method.
windowRect — Property in class flash.html.HTMLHost
- The property that is changed when JavaScript code in the HTMLLoader object calls - the window.moveBy(), window.moveTo(), - window.resizeBy(), or window.resizeTo() method.
WIREFRAME — Constant static property in class flash.display3D.Context3DFillMode
- The fill mode is wireframe mode.
with — Statement
Establishes a default object to be used for the execution of a statement or statements, potentially reducing the amount of code that needs to be written.
wmodeGPU — Property in class flash.display.Stage
- Indicates whether GPU compositing is available and in use.
WMODE_INCOMPATIBLE — Constant static property in class flash.media.StageVideoAvailabilityReason
- Stage video is not currently available, the wmode doesn't support Stage video.
WORD — Constant static property in class flash.text.AutoCapitalize
- Capitalize every word.
wordWrap — Property in class flash.text.TextField
- - A Boolean value that indicates whether the text field has word wrap.
Worker — Final class in package flash.system
- A Worker object represents a worker, which is a virtual instance of the - Flash runtime.
WorkerDomain — Final class in package flash.system
- The WorkerDomain class provides a way to create Worker objects and access - them.
workerState — Event in class flash.system.Worker
-Dispatched when the value of the worker's state property changes.
WorkerState — Final class in package flash.system
- This class defines constants that represent the possible values of the - Worker class's state property.
WORKER_STATE — Constant static property in class flash.events.Event
- The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
workingDirectory — Property in class flash.desktop.NativeProcessStartupInfo
- The File object that references the initial working directory for the - new native process.
workingDirectory — Static property in class flash.filesystem.File
- - The application's working directory (used primarily for command-line applications).
WRAP — Constant static property in class flash.filters.DisplacementMapFilterMode
- Wraps the displacement value to the other side of the source image.
WRITE — Constant static property in class flash.filesystem.FileMode
- Used for a file to be opened in write-only mode.
writeBase64(base64:String) — Method in class flash.utils.ByteArray
- - Writes data into the byte array from a base64 string.
writeBoolean(value:Boolean) — Method in class air.security.Digest
- - Writes a Boolean value.
writeBoolean(value:Boolean) — Method in class flash.filesystem.FileStream
- - Writes a Boolean value.
writeBoolean(value:Boolean) — Method in class flash.net.Socket
- - Writes a Boolean value to the socket.
writeBoolean(value:Boolean) — Method in class flash.utils.ByteArray
- - Writes a Boolean value.
writeBoolean(value:Boolean) — Method in interface flash.utils.IDataOutput
- - Writes a Boolean value.
writeByte(value:int) — Method in class air.security.Digest
- - Writes a byte.
writeByte(value:int) — Method in class flash.filesystem.FileStream
- - Writes a byte.
writeByte(value:int) — Method in class flash.net.Socket
- - Writes a byte to the socket.
writeByte(value:int) — Method in class flash.utils.ByteArray
- - Writes a byte to the byte stream.
writeByte(value:int) — Method in interface flash.utils.IDataOutput
- - Writes a byte.
writeBytes(bytes:flash.utils:ByteArray, offset:uint, length:uint) — Method in class air.security.Digest
- - Writes a sequence of bytes from the - - specified byte array, bytes, - - starting at the byte specified by offset - - (using a zero-based index) - - with a length specified by length, - - into the data to be used for the digest.
writeBytes(bytes:flash.utils:ByteArray, offset:uint, length:uint) — Method in class flash.filesystem.FileStream
- - Writes a sequence of bytes from the - - specified byte array, bytes, - - starting at the byte specified by offset - - (using a zero-based index) - - with a length specified by length, - - into the file stream, byte stream, or byte array.
writeBytes(bytes:flash.utils:ByteArray, offset:uint, length:uint) — Method in class flash.net.Socket
- - Writes a sequence of bytes from the specified byte array.
writeBytes(bytes:flash.utils:ByteArray, offset:uint, length:uint) — Method in class flash.utils.ByteArray
- - Writes a sequence of length bytes from the - - specified byte array, bytes, - - starting offset(zero-based index) bytes - - into the byte stream.
writeBytes(bytes:flash.utils:ByteArray, offset:uint, length:uint) — Method in interface flash.utils.IDataOutput
- - Writes a sequence of bytes from the - - specified byte array, bytes, - - starting at the byte specified by offset - - (using a zero-based index) - - with a length specified by length, - - into the file stream, byte stream, or byte array.
writeDouble(value:Number) — Method in class air.security.Digest
- - Writes an IEEE 754 double-precision (64-bit) floating point number.
writeDouble(value:Number) — Method in class flash.filesystem.FileStream
- - Writes an IEEE 754 double-precision (64-bit) floating point number.
writeDouble(value:Number) — Method in class flash.net.Socket
- - Writes an IEEE 754 double-precision floating-point number to the socket.
writeDouble(value:Number) — Method in class flash.utils.ByteArray
- - Writes an IEEE 754 double-precision (64-bit) floating-point number to the byte stream.
writeDouble(value:Number) — Method in interface flash.utils.IDataOutput
- - Writes an IEEE 754 double-precision (64-bit) floating point number.
writeDynamicProperties(obj:Object, output:flash.net:IDynamicPropertyOutput) — Method in interface flash.net.IDynamicPropertyWriter
- - Writes the name and value of an IDynamicPropertyOutput object to an object with - - dynamic properties.
writeDynamicProperty(name:String, value) — Method in interface flash.net.IDynamicPropertyOutput
- - Adds a dynamic property to the binary output of a serialized object.
writeExternal(output:flash.utils:IDataOutput) — Method in interface flash.utils.IExternalizable
- - A class implements this method to encode itself for a data stream by calling the methods of the IDataOutput - - interface.
writeFloat(value:Number) — Method in class air.security.Digest
- - Writes an IEEE 754 single-precision (32-bit) floating point number.
writeFloat(value:Number) — Method in class flash.filesystem.FileStream
- - Writes an IEEE 754 single-precision (32-bit) floating point number.
writeFloat(value:Number) — Method in class flash.net.Socket
- - Writes an IEEE 754 single-precision floating-point number to the socket.
writeFloat(value:Number) — Method in class flash.utils.ByteArray
- - Writes an IEEE 754 single-precision (32-bit) floating-point number to the byte stream.
writeFloat(value:Number) — Method in interface flash.utils.IDataOutput
- - Writes an IEEE 754 single-precision (32-bit) floating point number.
writeHexString(hex:String) — Method in class flash.utils.ByteArray
- - Writes data into the byte array from a hex string.
writeInt(value:int) — Method in class air.security.Digest
- - Writes a 32-bit signed integer.
writeInt(value:int) — Method in class flash.filesystem.FileStream
- - Writes a 32-bit signed integer.
writeInt(value:int) — Method in class flash.net.Socket
- - Writes a 32-bit signed integer to the socket.
writeInt(value:int) — Method in class flash.utils.ByteArray
- - Writes a 32-bit signed integer to the byte stream.
writeInt(value:int) — Method in interface flash.utils.IDataOutput
- - Writes a 32-bit signed integer.
writeMultiByte(value:String, charSet:String) — Method in class air.security.Digest
- - Writes a multibyte string to the file stream, byte stream, or byte array, using the specified character set.
writeMultiByte(value:String, charSet:String) — Method in class flash.filesystem.FileStream
- - Writes a multibyte string to the file stream, byte stream, or byte array, using the specified character set.
writeMultiByte(value:String, charSet:String) — Method in class flash.net.Socket
- - Writes a multibyte string from the byte stream, using the specified character set.
writeMultiByte(value:String, charSet:String) — Method in class flash.utils.ByteArray
- - Writes a multibyte string to the byte stream using the specified character set.
writeMultiByte(value:String, charSet:String) — Method in interface flash.utils.IDataOutput
- - Writes a multibyte string to the file stream, byte stream, or byte array, using the specified character set.
writeObject(object) — Method in class air.security.Digest
- - Writes an object to the file stream, byte stream, or byte array, in AMF serialized - - format.
writeObject(object) — Method in class flash.filesystem.FileStream
- - Writes an object to the file stream, byte stream, or byte array, in AMF serialized - - format.
writeObject(object) — Method in class flash.net.Socket
- - Write an object to the socket in AMF serialized format.
writeObject(object) — Method in class flash.utils.ByteArray
- - Writes an object into the byte array in AMF - - serialized format.
writeObject(object) — Method in interface flash.utils.IDataOutput
- - Writes an object to the file stream, byte stream, or byte array, in AMF serialized - - format.
writeRandomBytes() — Method in class flash.utils.ByteArray
- - Writes random data into the byte array.
writeRequestedObject(requestID:int, object:Object) — Method in class flash.net.NetGroup
- Satisfies the request as received by - NetStatusEvent NetGroup.Replication.Request for an object previously - advertised with the addHaveObjects() method.
writeShort(value:int) — Method in class air.security.Digest
- - Writes a 16-bit integer.
writeShort(value:int) — Method in class flash.filesystem.FileStream
- - Writes a 16-bit integer.
writeShort(value:int) — Method in class flash.net.Socket
- - Writes a 16-bit integer to the socket.
writeShort(value:int) — Method in class flash.utils.ByteArray
- - Writes a 16-bit integer to the byte stream.
writeShort(value:int) — Method in interface flash.utils.IDataOutput
- - Writes a 16-bit integer.
writeUnsignedInt(value:uint) — Method in class air.security.Digest
- - Writes a 32-bit unsigned integer.
writeUnsignedInt(value:uint) — Method in class flash.filesystem.FileStream
- - Writes a 32-bit unsigned integer.
writeUnsignedInt(value:uint) — Method in class flash.net.Socket
- - Writes a 32-bit unsigned integer to the socket.
writeUnsignedInt(value:uint) — Method in class flash.utils.ByteArray
- - Writes a 32-bit unsigned integer to the byte stream.
writeUnsignedInt(value:uint) — Method in interface flash.utils.IDataOutput
- - Writes a 32-bit unsigned integer.
writeUTF(value:String) — Method in class air.security.Digest
- - Writes a UTF-8 string to the file stream, byte stream, or byte array.
writeUTF(value:String) — Method in class flash.filesystem.FileStream
- - Writes a UTF-8 string to the file stream, byte stream, or byte array.
writeUTF(value:String) — Method in class flash.net.Socket
- - Writes the following data to the socket: a 16-bit unsigned integer, which - - indicates the length of the specified UTF-8 string in bytes, followed by - - the string itself.
writeUTF(value:String) — Method in class flash.utils.ByteArray
- - Writes a UTF-8 string to the byte stream.
writeUTF(value:String) — Method in interface flash.utils.IDataOutput
- - Writes a UTF-8 string to the file stream, byte stream, or byte array.
writeUTFBytes(value:String) — Method in class air.security.Digest
- - Writes a UTF-8 string.
writeUTFBytes(value:String) — Method in class flash.filesystem.FileStream
- - Writes a UTF-8 string.
writeUTFBytes(value:String) — Method in class flash.net.Socket
- - Writes a UTF-8 string to the socket.
writeUTFBytes(value:String) — Method in class flash.utils.ByteArray
- - Writes a UTF-8 string to the byte stream.
writeUTFBytes(value:String) — Method in interface flash.utils.IDataOutput
- - Writes a UTF-8 string.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/all-index-X.html b/html-docs/all-index-X.html deleted file mode 100644 index 7971b33..0000000 --- a/html-docs/all-index-X.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - -X Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
x — Property in class flash.display.DisplayObject
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
x — Property in class flash.display.NativeWindow
- - The horizontal axis coordinate of this window's top left corner relative to the - - origin of the operating system desktop.
x — Property in class flash.display.Stage3D
- The horizontal coordinate of the Stage3D display on the stage, in pixels.
x — Property in class flash.geom.Point
- The horizontal coordinate of the point.
x — Property in class flash.geom.Rectangle
- The x coordinate of the top-left corner of the rectangle.
x — Property in class flash.geom.Vector3D
- The first element of a Vector3D object, such as - the x coordinate of a point in the three-dimensional space.
x — Property in class flash.html.HTMLWindowCreateOptions
- Specifies the desired initial x position of the new window on the screen.
x — Property in class flash.text.TextLineMetrics
- The x value is the left position of the first character in pixels.
X — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the X key (88).
X500DistinguishedName — Class in package flash.security
- The X500DistinguishedName class defines Distinguished Name (DN) properties for use in the - X509Certificate class.
X509Certificate — Class in package flash.security
- The X509Certificate class represents an X.509 certificate.
X_AXIS — Constant static property in class flash.geom.Vector3D
- The x axis defined as a Vector3D object with coordinates (1,0,0).
XML — Final dynamic class in Top Level
- - The XML class contains methods and properties for working with XML objects.
XML(expression) — Package function in Top Level
- - Converts an object to an XML object.
XML(value:Object) — Constructor in class XML
- - Creates a new XML object.
xmlDecl — Property in class flash.xml.XMLDocument
- A string that specifies information about a document's XML declaration.
XMLDocument — Class in package flash.xml
- The XMLDocument class represents the legacy XML object - that was present in ActionScript 2.0.
XMLDocument(source:String) — Constructor in class flash.xml.XMLDocument
- Creates a new XMLDocument object.
XMLList — Final dynamic class in Top Level
- - The XMLList class contains methods for working with one or more XML elements.
XMLList(expression) — Package function in Top Level
- - Converts an object to an XMLList object.
XMLList(value:Object) — Constructor in class XMLList
- - Creates a new XMLList object.
XMLNode — Class in package flash.xml
- The XMLNode class represents the legacy XML object - that was present in ActionScript 2.0 and that was renamed in ActionScript 3.0.
XMLNode(type:uint, value:String) — Constructor in class flash.xml.XMLNode
- Creates a new XMLNode object.
XMLNodeType — Final class in package flash.xml
- The XMLNodeType class contains constants used with - XMLNode.nodeType.
XMLSignatureValidator — Class in package flash.security
- The XMLSignatureValidator class validates whether an XML - signature file is well formed, unmodified, and, optionally, whether - it is signed using a key linked to a trusted digital certificate.
XMLSignatureValidator() — Constructor in class flash.security.XMLSignatureValidator
- Creates an XMLSignatureValidator object.
XMLSocket — Class in package flash.net
- The XMLSocket class implements client sockets that let the - Flash Player or AIR application communicate - with a server computer identified by an IP address or domain name.
XMLSocket(host:String, port:int) — Constructor in class flash.net.XMLSocket
- Creates a new XMLSocket object.
xmpData — Property in class flash.net.NetStreamInfo
- The most recent XMP data object associated with the media being played.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/all-index-Y.html b/html-docs/all-index-Y.html deleted file mode 100644 index e766be0..0000000 --- a/html-docs/all-index-Y.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - -Y Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
y — Property in class flash.display.DisplayObject
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
y — Property in class flash.display.NativeWindow
- - The vertical axis coordinate of this window's top left corner relative to the - - upper left corner of the operating system's desktop.
y — Property in class flash.display.Stage3D
- The vertical coordinate of the Stage3D display on the stage, in pixels.
y — Property in class flash.geom.Point
- The vertical coordinate of the point.
y — Property in class flash.geom.Rectangle
- The y coordinate of the top-left corner of the rectangle.
y — Property in class flash.geom.Vector3D
- The second element of a Vector3D object, such as - the y coordinate of a point in the three-dimensional space.
y — Property in class flash.html.HTMLWindowCreateOptions
- Specifies the desired initial y position of the new window on the screen.
Y — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Y key (89).
yaw — Property in class flash.events.DeviceRotationEvent
- yaw along the z-axis, measured in degrees.
Y_AXIS — Constant static property in class flash.geom.Vector3D
- The y axis defined as a Vector3D object with coordinates (0,1,0).
year — Property in class flash.media.ID3Info
- The year of the recording; corresponds to the ID3 2.0 tag TYER.
YELLOW — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the yellow function key button.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/all-index-Z.html b/html-docs/all-index-Z.html deleted file mode 100644 index 9ee493c..0000000 --- a/html-docs/all-index-Z.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - -Z Index (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
z — Property in class flash.display.DisplayObject
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
z — Property in class flash.geom.Vector3D
- The third element of a Vector3D object, such as - the z coordinate of a point in three-dimensional space.
Z — Constant static property in class flash.ui.Keyboard
- - Constant associated with the key code value for the Z key (90).
Z_AXIS — Constant static property in class flash.geom.Vector3D
- The z axis defined as a Vector3D object with coordinates (0,0,1).
ZERO — Constant static property in class flash.display3D.Context3DBlendFactor
- The blend factor is (0,0,0,0).
ZERO — Constant static property in class flash.display3D.Context3DStencilAction
- Set the stencil buffer value to 0.
ZipArchive — Class in package air.utils
- - The ZipArchive class is used to represent a zipped-up set of files in memory.
ZipArchive() — Constructor in class air.utils.ZipArchive
- - Creates a new, empty zip archive to which new entries can be added.
ZipEntry — Class in package air.utils
- - The ZipEntry class is used to represent a single file within a zip archive.
ZipEntry(name:String, compress:Boolean) — Constructor in class air.utils.ZipEntry
- - Creates a new zip entry, with optional parameters to set the name and storage type.
ZLIB — Constant static property in class flash.utils.CompressionAlgorithm
- - Defines the string to use for the zlib compression algorithm.
zoom — Property in class flash.media.StageVideo
- The zoom setting of the video, specified as a Point object.
zoom — Property in class flash.ui.ContextMenuBuiltInItems
-Lets the user zoom in and out on a SWF file at run time.
Symbols  A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z  
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/appendices.html b/html-docs/appendices.html deleted file mode 100644 index fdf58e5..0000000 --- a/html-docs/appendices.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - -Appendices (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The Adobe Flex 2 Language ReferenceActionScript 3.0 Language and Components Reference contains these appendices:

-
- - - - - - - - - - - - - - - - - - - - - - -
 AppendixDescription
 Compiler Errors 
 Compiler Warnings 
 Run-Time Errors 
 ActionScript 2.0 Migration 
 Character Set Codes 
 What's New 
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Sat Jan 11 2025, 8:31 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/arguments.html b/html-docs/arguments.html deleted file mode 100644 index d5b90ac..0000000 --- a/html-docs/arguments.html +++ /dev/null @@ -1,402 +0,0 @@ - - - - - - - - -arguments (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic class arguments
Inheritancearguments Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - An arguments object is used to store and access a function's arguments. - - Within a function's body, you can access its arguments object by using the local arguments - - variable. - -

- - The arguments are stored as array elements: the first is accessed as - - arguments[0], the second as arguments[1], and so on. The - - arguments.length property indicates the number of arguments passed to - - the function. There may be a different number of arguments passed than - - the function declares. - -

- -

- - Unlike previous versions of ActionScript, ActionScript 3.0 has no arguments.caller property. - - To get a reference to the function - - that called the current function, you must pass a reference to that function as an - - argument. An example of this technique can be found in the example for arguments.callee. - -

- -

ActionScript 3.0 includes a new ...(rest) keyword that is recommended instead of the - - arguments class.

- - - -

-

-View the examples. -

-

-See also -

-
-...(rest) -
-Function -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
  callee : Function -
- - A reference to the currently executing function.
-		arguments
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  length : Number -
- - The number of arguments passed to the function.
-		arguments
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
calleeproperty
-
-public var callee:Function -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - A reference to the currently executing function. - - -


-Example -
The following code shows how to get a reference to the function - that calls the function named secondFunction(). The firstFunction() function has - the Boolean argument of true - to demonstrate that secondFunction() successfully calls firstFunction() and - to prevent an infinite loop of each function calling the other. - -

Because the callSecond parameter is true, firstFunction() - calls secondFunction() and passes a reference to itself as the only - argument. The function secondFunction() receives this argument and stores it - using a parameter named caller, which is of data type Function. From within secondFunction(), the - caller parameter is then used to call the firstFunction function, - but this time with the callSecond argument set to false.

- -

When execution returns to firstFunction(), the trace() - statement is executed because callSecond is false.

-
-
-  package {
-    import flash.display.Sprite;
-	
-	public class ArgumentsExample extends Sprite {
-		private var count:int = 1;
-		
-		public function ArgumentsExample() {
-			firstFunction(true);
-		}
-
-		public function firstFunction(callSecond:Boolean) {
-			trace(count + ": firstFunction");
-			if(callSecond) {
-				secondFunction(arguments.callee);
-			}
-			else {
-				trace("CALLS STOPPED");
-			}
-		}
-
-		public function secondFunction(caller:Function) {
-			trace(count + ": secondFunction\n");
-			count++;
-			caller(false);
-		}		
-	}
-}
-
-

-
- - - - - -
lengthproperty 
-
-public var length:Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - The number of arguments passed to the function. This may be more or less - - than the function declares. - - - -

- -
Examples
-
examples\ArgumentsExample
-
The following example shows uses for various arguments properties, - such as callee and length. -
-
-package {
-    import flash.display.Sprite;
-	
-	public class ArgumentsExample extends Sprite {
-		public function ArgumentsExample() {
-				println("Hello World");
-		}
-		
-		public function println(str:String):void {
-			trace(arguments.callee == this.println); // true
-			trace(arguments.length);				 // 1
-			trace(arguments[0]);					 // Hello World
-			trace(str);								// Hello World
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/avm2/intrinsics/iteration/package-detail.html b/html-docs/avm2/intrinsics/iteration/package-detail.html deleted file mode 100644 index f0db5aa..0000000 --- a/html-docs/avm2/intrinsics/iteration/package-detail.html +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - -avm2.intrinsics.iteration Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The amv2.intrinsics.iteration package includes the low-level/intrinsic APIs for iterating through an object's properties. These functions are built into the ASC2 compiler and are replaced by single ActionScript ByteCode instructions hence there is no function call overhead when using these.

-
-
- -
Functions
- - - - - - - - - - - - - -
 FunctionDescription
 hasnext - - Determine whether the given object has any more properties.
 nextname - - Get the name of the next property.
 nextvalue - - Get the value of the next property.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
-
- - diff --git a/html-docs/avm2/intrinsics/iteration/package.html b/html-docs/avm2/intrinsics/iteration/package.html deleted file mode 100644 index 6d24756..0000000 --- a/html-docs/avm2/intrinsics/iteration/package.html +++ /dev/null @@ -1,245 +0,0 @@ - - - - - - - -avm2.intrinsics.iteration Details (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-Function details for the avm2.intrinsics.iteration package.
-
Public Functions
- - - - - - - - - - - - - -
 FunctionDefined by
   -
-hasnext(obj:Object, idx:int):int -
-
- - Determine whether the given object has any more properties.
-		avm2.intrinsics.iteration
   -
-nextname(obj:Object, idx:int):String -
-
- - Get the name of the next property.
-		avm2.intrinsics.iteration
   -
-nextvalue(obj:Object, idx:int):* -
-
- - Get the value of the next property.
-		avm2.intrinsics.iteration
-
- -
Function detail
- - - - - -
hasnext()function
-
-public function hasnext(obj:Object, idx:int):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Determine whether the given object has any more properties. - -

Parameters - - - - - - - - - - -
obj:Object — The object to test for properties. - -
 
idx:int — The previous property index (or zero to get the first property index). - -
-

-Returns - - - - -
int — - Returns the next property index for this object, or zero if there are no more properties. - - - -
-
- - - - - -
nextname()function 
-
-public function nextname(obj:Object, idx:int):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Get the name of the next property. - -

Parameters - - - - - - - - - - -
obj:Object — The object for which to get a property name. - -
 
idx:int — The property index (as returned by hasnext). - -
-

-Returns - - - - -
String — - Returns the property's name based on the provided index, or null if this is an invalid index. - - - -
-
- - - - - -
nextvalue()function 
-
-public function nextvalue(obj:Object, idx:int):* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Get the value of the next property. - -

Parameters - - - - - - - - - - -
obj:Object — The object for which to get a property value. - -
 
idx:int — The property index (as returned by hasnext). - -
-

-Returns - - - - -
* — Returns the property's value based on the provided index, or undefined if this is an invalid index. - -
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/avm2/intrinsics/memory/package-detail.html b/html-docs/avm2/intrinsics/memory/package-detail.html deleted file mode 100644 index b66ebf6..0000000 --- a/html-docs/avm2/intrinsics/memory/package-detail.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - - -avm2.intrinsics.memory Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The amv2.intrinsics.memory package includes the low-level/intrinsic memory access APIs for loading and storing values into the application's domain memory, and for concurrency operations. Most of these functions are built into the ASC2 compiler and are replaced by single ActionScript ByteCode instructions hence eliminating the overhead involved in function calls. The concurrency utilities (mfence and casi32) are native C++ method calls.

-
-
- -
Functions
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 FunctionDescription
 casi32 - - A compare-and-swap operation for domainMemory.
 lf32 - - Loads a 32-bit floating point value from the given addr in domain memory.
 lf64 - - Loads a 64-bit floating point value from the given addr in domain memory.
 li16 - - Loads a 16-bit integer value from the given addr in domain memory.
 li32 - - Loads a 32-bit integer value from the given addr in domain memory.
 li8 - - Loads an 8-bit integer value from the given addr in domain memory.
 mfence - - A complete memory barrier for domainMemory (for both load and store instructions).
 sf32 - - Stores a 32-bit floating point value into the given addr in domain memory.
 sf64 - - Stores a 64-bit floating point value into the given addr in domain memory.
 si16 - - Stores a 16-bit integer value into the given addr in domain memory.
 si32 - - Stores a 32-bit integer value into the given addr in domain memory.
 si8 - - Stores an 8-bit integer value into the given addr in domain memory.
 sxi1 - - Sign-extends a 1-bit integer value to a 32-bit integer value.
 sxi16 - - Sign-extends a 16-bit integer value to a 32-bit integer value.
 sxi8 - - Sign-extends an 8-bit integer value to a 32-bit integer value.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
-
- - diff --git a/html-docs/avm2/intrinsics/memory/package.html b/html-docs/avm2/intrinsics/memory/package.html deleted file mode 100644 index 2f5a0ff..0000000 --- a/html-docs/avm2/intrinsics/memory/package.html +++ /dev/null @@ -1,968 +0,0 @@ - - - - - - - -avm2.intrinsics.memory Details (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-Function details for the avm2.intrinsics.memory package.
-
Public Functions
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 FunctionDefined by
   -
-casi32(addr:int, expectedVal:int, newVal:int):int -
-
- - A compare-and-swap operation for domainMemory.
-		avm2.intrinsics.memory
   -
-lf32(addr:int):Number -
-
- - Loads a 32-bit floating point value from the given addr in domain memory.
-		avm2.intrinsics.memory
   -
-lf64(addr:int):Number -
-
- - Loads a 64-bit floating point value from the given addr in domain memory.
-		avm2.intrinsics.memory
   -
-li16(addr:int):int -
-
- - Loads a 16-bit integer value from the given addr in domain memory.
-		avm2.intrinsics.memory
   -
-li32(addr:int):int -
-
- - Loads a 32-bit integer value from the given addr in domain memory.
-		avm2.intrinsics.memory
   -
-li8(addr:int):int -
-
- - Loads an 8-bit integer value from the given addr in domain memory.
-		avm2.intrinsics.memory
   -
-mfence():void -
-
- - A complete memory barrier for domainMemory (for both load and store instructions).
-		avm2.intrinsics.memory
   -
-sf32(value:Number, addr:int):void -
-
- - Stores a 32-bit floating point value into the given addr in domain memory.
-		avm2.intrinsics.memory
   -
-sf64(value:Number, addr:int):void -
-
- - Stores a 64-bit floating point value into the given addr in domain memory.
-		avm2.intrinsics.memory
   -
-si16(value:int, addr:int):void -
-
- - Stores a 16-bit integer value into the given addr in domain memory.
-		avm2.intrinsics.memory
   -
-si32(value:int, addr:int):void -
-
- - Stores a 32-bit integer value into the given addr in domain memory.
-		avm2.intrinsics.memory
   -
-si8(value:int, addr:int):void -
-
- - Stores an 8-bit integer value into the given addr in domain memory.
-		avm2.intrinsics.memory
   -
-sxi1(value:int):int -
-
- - Sign-extends a 1-bit integer value to a 32-bit integer value.
-		avm2.intrinsics.memory
   -
-sxi16(value:int):int -
-
- - Sign-extends a 16-bit integer value to a 32-bit integer value.
-		avm2.intrinsics.memory
   -
-sxi8(value:int):int -
-
- - Sign-extends an 8-bit integer value to a 32-bit integer value.
-		avm2.intrinsics.memory
-
- -
Function detail
- - - - - -
casi32()function
-
-public function casi32(addr:int, expectedVal:int, newVal:int):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - A compare-and-swap operation for domainMemory. - - This behaves like the ByteArray.atomicCompareAndSwapIntAt method, but operates on the - - current domain memory. The 32-bit value found at the addr offset into domain memory is - - checked, and if this is equal to the expectedValue value, then the newValue - - value is written into this offset, and the old (expected) value is returned. Otherwise, the domain - - memory is not updated, and the actual value found at this address is returned. - -

Parameters - - - - - - - - - - - - - - - - -
addr:int — The address/offset into the domain memory byte array at which to perform the compare/swap operation. - -
 
expectedVal:int — Contains the expected value of the integer to be replaced by the newValue parameter. - -
 
newVal:int — The new value to put into the location at the addr offset, if the existing value equals the exptectedValue parameter. - -
-

-Returns - - - - -
int — - Returns the previous value at the specified offset into the domain memory. - - - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-ByteArray.atomicCompareAndSwapIntAt() method. -
-
- - - - - -
lf32()function 
-
-public function lf32(addr:int):Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Loads a 32-bit floating point value from the given addr in domain memory. - -

Parameters - - - - -
addr:int — The address/offset into the domain memory byte array from which to load the value. - -
-

-Returns - - - - -
Number — - Returns the 32-bit single-precision floating point value found at this memory location. - - - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
lf64()function 
-
-public function lf64(addr:int):Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Loads a 64-bit floating point value from the given addr in domain memory. - -

Parameters - - - - -
addr:int — The address/offset into the domain memory byte array from which to load the value. - -
-

-Returns - - - - -
Number — - Returns the 64-bit double-precsision floating point value found at this memory location. - - - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
li16()function 
-
-public function li16(addr:int):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Loads a 16-bit integer value from the given addr in domain memory. - -

Parameters - - - - -
addr:int — The address/offset into the domain memory byte array from which to load the value. - -
-

-Returns - - - - -
int — - Returns the 16-bit integer value found at this memory location. - - - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
li32()function 
-
-public function li32(addr:int):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Loads a 32-bit integer value from the given addr in domain memory. - -

Parameters - - - - -
addr:int — The address/offset into the domain memory byte array from which to load the value. - -
-

-Returns - - - - -
int — - Returns the 32-bit integer value found at this memory location. - - - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
li8()function 
-
-public function li8(addr:int):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Loads an 8-bit integer value from the given addr in domain memory. - -

Parameters - - - - -
addr:int — The address/offset into the domain memory byte array from which to load the value. - -
-

-Returns - - - - -
int — - Returns the 8-bit integer value found at this memory location. - - - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
mfence()function 
-
-public function mfence():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - A complete memory barrier for domainMemory (for both load and store instructions). - -

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
sf32()function 
-
-public function sf32(value:Number, addr:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Stores a 32-bit floating point value into the given addr in domain memory. - -

Parameters - - - - - - - - - - -
value:Number — The 32-bit single-precision floating point value to be stored into the domain memory. - -
 
addr:int — The address/offset into the domain memory byte array into which to store the value. - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
sf64()function 
-
-public function sf64(value:Number, addr:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Stores a 64-bit floating point value into the given addr in domain memory. - -

Parameters - - - - - - - - - - -
value:Number — The 64-bit double-precision floating point value to be stored into the domain memory. - -
 
addr:int — The address/offset into the domain memory byte array into which to store the value. - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
si16()function 
-
-public function si16(value:int, addr:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Stores a 16-bit integer value into the given addr in domain memory. - -

Parameters - - - - - - - - - - -
value:int — The integer value treated as a 16-bit value to be stored into the domain memory. - -
 
addr:int — The address/offset into the domain memory byte array into which to store the value. - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
si32()function 
-
-public function si32(value:int, addr:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Stores a 32-bit integer value into the given addr in domain memory. - -

Parameters - - - - - - - - - - -
value:int — The integer value to be stored into the domain memory. - -
 
addr:int — The address/offset into the domain memory byte array into which to store the value. - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
si8()function 
-
-public function si8(value:int, addr:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Stores an 8-bit integer value into the given addr in domain memory. - -

Parameters - - - - - - - - - - -
value:int — The integer value treated as an 8-bit value to be stored into the domain memory. - -
 
addr:int — The address/offset into the domain memory byte array into which to store the value. - -
-

-See also -

-
-ApplicationDomain domainMemory property -
-
- - - - - -
sxi1()function 
-
-public function sxi1(value:int):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Sign-extends a 1-bit integer value to a 32-bit integer value. - -

Parameters - - - - -
value:int — The integer value that is treated as a 1-bit value. - -
-

-Returns - - - - -
int — - Returns the 32-bit integer value created by sign-extending the 1-bit argument. - - - -
-
- - - - - -
sxi16()function 
-
-public function sxi16(value:int):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Sign-extends a 16-bit integer value to a 32-bit integer value. - -

Parameters - - - - -
value:int — The integer value that is treated as a 16-bit value. - -
-

-Returns - - - - -
int — - Returns the 32-bit integer value created by sign-extending the 16-bit argument. - - - -
-
- - - - - -
sxi8()function 
-
-public function sxi8(value:int):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Sign-extends an 8-bit integer value to a 32-bit integer value. - -

Parameters - - - - -
value:int — The integer value that is treated as an 8-bit value. - -
-

-Returns - - - - -
int — - Returns the 32-bit integer value created by sign-extending the 8-bit argument. - - - -
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/charset-codes.html b/html-docs/charset-codes.html deleted file mode 100644 index 2b9d244..0000000 --- a/html-docs/charset-codes.html +++ /dev/null @@ -1,1278 +0,0 @@ - - - - - - - -Supported Character Sets (ActionScript 3.0) - - - - - - - - - - - - - - - -
- -
-

-
-
Flash Player and AIR support a subset of the style character set definitions specified by the IANA (http://www.iana.org/assignments/character-sets). The following table lists the supported character sets, and either the label value or an alias value (aliases point to the same base definition) can be used to specify the desired character set:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Character SetLabelAlias
Arabic (ASMO 708)ASMO-708 
Arabic (DOS)DOS-720 
Arabic (ISO)iso-8859-6arabic, csISOLatinArabic, ECMA-114, ISO_8859-6, ISO_8859-6:1987, iso-ir-127
Arabic (Mac)x-mac-arabic 
Arabic (Windows)windows-1256cp1256
Baltic (DOS)ibm775CP500
Baltic (ISO)iso-8859-4csISOLatin4, ISO_8859-4, ISO_8859-4:1988, iso-ir-110, l4, latin4
Baltic (Windows)windows-1257 
Central European (DOS)ibm852cp852
Central European (ISO)iso-8859-2csISOLatin2, iso_8859-2, iso_8859-2:1987, iso8859-2, iso-ir-101, l2, latin2
Central European (Mac)x-mac-ce 
Central European (Windows)windows-1250x-cp1250
Chinese National Standardgb18030 
Chinese Simplified (EUC)EUC-CNx-euc-cn
Chinese Simplified (GB2312)gb2312chinese, CN-GB, csGB2312, csGB231280, csISO58GB231280, GB_2312-80, GB231280, GB2312-80, GBK, iso-ir-58
Chinese Simplified (GB18030)gb18030 
Chinese Simplified (HZ)hz-gb-2312 
Chinese Simplified (Mac)x-mac-chinesesimp 
Chinese Traditional (Big5)big5cn-big5, csbig5, x-x-big5
Chinese Traditional (CNS)x-Chinese-CNS 
Chinese Traditional (Eten)x-Chinese-Eten 
Chinese Traditional (Mac)x-mac-chinesetrad 
Cyrillic (DOS)cp866ibm866
Cyrillic (ISO)iso-8859-5csISOLatin5, csISOLatinCyrillic, cyrillic, ISO_8859-5, ISO_8859-5:1988, iso-ir-144, l5
Cyrillic (KOI8-R)koi8-rcsKOI8R, koi, koi8, koi8r
Cyrillic (KOI8-U)koi8-ukoi8-ru
Cyrillic (Mac)x-mac-cyrillic 
Cyrillic (Windows)windows-1251x-cp1251
Europax-Europa 
German (IA5)x-IA5-German 
Greek (DOS)ibm737 
Greek (ISO)iso-8859-7csISOLatinGreek, ECMA-118, ELOT_928, greek, greek8, ISO_8859-7, ISO_8859-7:1987, iso-ir-126
Greek (Mac)x-mac-greek 
Greek (Windows)windows-1253 
Greek, Modern (DOS)ibm869 
Hebrew (DOS)DOS-862 
Hebrew (ISO-Logical)iso-8859-8-ilogical
Hebrew (ISO-Visual)iso-8859-8csISOLatinHebrew, hebrew, ISO_8859-8, ISO_8859-8:1988, ISO-8859-8, iso-ir-138, visual
Hebrew (Mac)x-mac-hebrew 
Hebrew (Windows)windows-1255ISO_8859-8-I, ISO-8859-8, visual
IBM EBCDIC (Arabic)x-EBCDIC-Arabic 
IBM EBCDIC (Cyrillic Russian)x-EBCDIC-CyrillicRussian 
IBM EBCDIC (Cyrillic Serbian-Bulgarian)x-EBCDIC-CyrillicSerbianBulgarian 
IBM EBCDIC (Denmark-Norway)x-EBCDIC-DenmarkNorway 
IBM EBCDIC (Denmark-Norway-Euro)x-ebcdic-denmarknorway-euro 
IBM EBCDIC (Finland-Sweden)x-EBCDIC-FinlandSweden 
IBM EBCDIC (Finland-Sweden-Euro)x-ebcdic-finlandsweden-euro 
IBM EBCDIC (Finland-Sweden-Euro)x-ebcdic-finlandsweden-euroX-EBCDIC-France
IBM EBCDIC (France-Euro)x-ebcdic-france-euro 
IBM EBCDIC (Germany)x-EBCDIC-Germany 
IBM EBCDIC (Germany-Euro)x-ebcdic-germany-euro 
IBM EBCDIC (Greek Modern)x-EBCDIC-GreekModern 
IBM EBCDIC (Greek)x-EBCDIC-Greek 
IBM EBCDIC (Hebrew)x-EBCDIC-Hebrew 
IBM EBCDIC (Icelandic)x-EBCDIC-Icelandic 
IBM EBCDIC (Icelandic-Euro)x-ebcdic-icelandic-euro 
IBM EBCDIC (International-Euro)x-ebcdic-international-euro 
IBM EBCDIC (Italy)x-EBCDIC-Italy 
IBM EBCDIC (Italy-Euro)x-ebcdic-italy-euro 
IBM EBCDIC (Japanese and Japanese Katakana)x-EBCDIC-JapaneseAndKana 
IBM EBCDIC (Japanese and Japanese-Latin)x-EBCDIC-JapaneseAndJapaneseLatin 
IBM EBCDIC (Japanese and US-Canada)x-EBCDIC-JapaneseAndUSCanada 
IBM EBCDIC (Japanese katakana)x-EBCDIC-JapaneseKatakana 
IBM EBCDIC (Korean and Korean Extended)x-EBCDIC-KoreanAndKoreanExtended 
IBM EBCDIC (Korean Extended)x-EBCDIC-KoreanExtended 
IBM EBCDIC (Multilingual Latin-2)CP870 
IBM EBCDIC (Simplified Chinese)x-EBCDIC-SimplifiedChinese 
IBM EBCDIC (Spain)X-EBCDIC-Spain 
IBM EBCDIC (Spain-Euro)x-ebcdic-spain-euro 
IBM EBCDIC (Thai)x-EBCDIC-Thai 
IBM EBCDIC (Traditional Chinese)x-EBCDIC-TraditionalChinese 
IBM EBCDIC (Turkish Latin-5)CP1026 
IBM EBCDIC (Turkish)x-EBCDIC-Turkish 
IBM EBCDIC (UK)x-EBCDIC-UK 
IBM EBCDIC (UK-Euro)x-ebcdic-uk-euro 
IBM EBCDIC (US-Canada)ebcdic-cp-us 
IBM EBCDIC (US-Canada-Euro)x-ebcdic-cp-us-euro 
Icelandic (DOS)ibm861 
Icelandic (Mac)x-mac-icelandic 
ISCII Assamesex-iscii-as 
ISCII Bengalix-iscii-be 
ISCII Devanagarix-iscii-de 
ISCII Gujarathix-iscii-gu 
ISCII Kannadax-iscii-ka 
ISCII Malayalamx-iscii-ma 
ISCII Oriyax-iscii-or 
ISCII Panjabix-iscii-pa 
ISCII Tamilx-iscii-ta 
ISCII Telugux-iscii-te 
Japanese (EUC)euc-jpcsEUCPkdFmtJapanese, Extended_UNIX_Code_Packed_Format_for_Japanese, x-euc, x-euc-jp
Japanese (JIS)iso-2022-jp 
Japanese (JIS-Allow 1 byte Kana - SO/SI)iso-2022-jp_iso-2022-jp$SIO
Japanese (JIS-Allow 1 byte Kana)csISO2022JP_iso-2022-jp
Japanese (Mac)x-mac-japanese 
Japanese (Shift-JIS)shift_jiscsShiftJIS, csWindows31J, ms_Kanji, shift-jis, x-ms-cp932, x-sjis
Koreanks_c_5601-1987csKSC56011987, euc-kr, iso-ir-149, korean, ks_c_5601, ks_c_5601_1987, ks_c_5601-1989, KSC_5601, KSC5601
Korean (EUC)euc-krcsEUCKR
Korean (ISO)iso-2022-krcsISO2022KR
Korean (Johab)Johab 
Korean (Mac)x-mac-korean 
Latin 3 (ISO)iso-8859-3csISO, Latin3, ISO_8859-3, ISO_8859-3:1988, iso-ir-109, l3, latin3
Latin 9 (ISO)iso-8859-15csISO, Latin9, ISO_8859-15, l9, latin9
Norwegian (IA5)x-IA5-Norwegian 
OEM United StatesIBM437437, cp437, csPC8, CodePage437
Swedish (IA5)x-IA5-Swedish 
Thai (Windows)windows-874DOS-874, iso-8859-11, TIS-620
Turkish (DOS)ibm857 
Turkish (ISO)iso-8859-9csISO, Latin5, ISO_8859-9, ISO_8859-9:1989, iso-ir-148, l5, latin5
Turkish (Mac)x-mac-turkish 
Turkish (Windows)windows-1254ISO_8859-9, ISO_8859-9:1989, iso-8859-9, iso-ir-148, latin5
Unicodeunicodeutf-16
Unicode (Big-Endian)unicodeFFFE 
Unicode (UTF-7)utf-7csUnicode11UTF7, unicode-1-1-utf-7, x-unicode-2-0-utf-7
Unicode (UTF-8)utf-8unicode-1-1-utf-8, unicode-2-0-utf-8, x-unicode-2-0-utf-8
US-ASCIIus-asciiANSI_X3.4-1968, ANSI_X3.4-1986, ascii, cp367, csASCII, IBM367, ISO_646.irv:1991, ISO646-US, iso-ir-6us
Vietnamese (Windows)windows-1258 
Western European (DOS)ibm850 
Western European (IA5)x-IA5 
Western European (ISO)iso-8859-1cp819, csISO, Latin1, ibm819, iso_8859-1, iso_8859-1:1987, iso8859-1, iso-ir-100, l1, latin1
Western European (Mac)macintosh 
Western European (Windows)Windows-1252ANSI_X3.4-1968, ANSI_X3.4-1986, ascii, cp367, cp819, csASCII, IBM367, ibm819, ISO_646.irv:1991, iso_8859-1, iso_8859-1:1987, ISO646-US, iso8859-1, iso-8859-1, iso-ir-100, iso-ir-6, latin1, us, us-ascii, x-ansi
- -
- - -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:13 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/class-summary.html b/html-docs/class-summary.html deleted file mode 100644 index 1b2be36..0000000 --- a/html-docs/class-summary.html +++ /dev/null @@ -1,3847 +0,0 @@ - - - - - -All Classes (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
-

Documentation for ActionScript™ classes includes syntax, usage information, - and code samples for methods, properties, and event handlers and listeners that belong to a - specific class in ActionScript™ (as opposed to global functions or properties). The classes - are listed alphabetically. If you are not sure to which class a certain member belongs, you can look it up in the Index.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassPackageDescription
 AAAARecord -
-		flash.net.dns - The AAAARecord class represents a Domain Name System (DNS) AAAA resource record containing an IPv6 address.
 Accelerometer -
-		flash.sensors - The Accelerometer class dispatches events based on activity detected by the device's motion sensor.
 AccelerometerEvent -
-		flash.events -The Accelerometer class dispatches AccelerometerEvent objects when acceleration updates are obtained from the Accelerometer sensor installed on the device.
 Accessibility -
-		flash.accessibility - The Accessibility class manages communication with screen readers.
 AccessibilityImplementation -
-		flash.accessibility - - The AccessibilityImplementation class is the base class in Flash Player - that allows for the implementation of accessibility in components.
 AccessibilityProperties -
-		flash.accessibility - The AccessibilityProperties class lets you control the presentation of Flash objects to accessibility - aids, such as screen readers.
 ActionScriptVersion -
-		flash.display - The ActionScriptVersion class is an enumeration of constant values that - indicate the language version of a loaded SWF file.
 ActivityEvent -
-		flash.events -A Camera or Microphone object dispatches an ActivityEvent object whenever a camera or microphone reports that it has -become active or inactive.
 AntiAliasType -
-		flash.text -The AntiAliasType class provides values for anti-aliasing in the flash.text.TextField class.
 ApplicationDomain -
-		flash.system - The ApplicationDomain class is a container for discrete groups of class definitions.
 ApplicationUpdater -
-		air.update - - The ApplicationUpdater class defines the basic functionality of the update framework for - - Adobe® AIR® applications, without providing any default user interface.
 ApplicationUpdaterUI -
-		air.update - - The ApplicationUpdaterUI class defines the basic functionality of the update framework for - - Adobe® AIR® applications, and it provides a default user interface.
 ARecord -
-		flash.net.dns - The ARecord class represents a Domain Name System (DNS) A resource record containing an IPv4 address.
 ArgumentError -
-		Top Level - - The ArgumentError class represents an error that occurs when the arguments - - supplied in a function do not match the arguments defined for - - that function.
 arguments -
-		Top Level - - An arguments object is used to store and access a function's arguments.
 Array -
-		Top Level - - The Array class lets you access and manipulate arrays.
 AsyncErrorEvent -
-		flash.events - An object dispatches an AsyncErrorEvent when an exception is thrown from native - asynchronous code, which could be from, for example, LocalConnection, NetConnection, - SharedObject, or NetStream.
 AudioDecoder -
-		flash.media - The AudioDecoder class enumerates the types of multichannel audio that a - system can support.
 AudioDeviceManager -
-		flash.media - - Use the AudioDeviceManager class to get audio device information of the system, and - select a device for audio playback.
 AudioOutputChangeEvent -
-		flash.events -

This event fires when user selects a different audio output device from Flash Player's settings - UI, or an audio device gets added to / removed from the system.

- -
 AudioOutputChangeReason -
-		flash.media - This class defines an enumeration that indicates the reason for AudioOutputChangeEvent.
 AudioPlaybackMode -
-		flash.media - The AudioPlaybackMode class defines constants for the audioPlaybackMode property of the - SoundMixer class.
 AuthenticationMethod -
-		flash.net.drm - The AuthenticationMethod class provides string constants enumerating the - different types of authentication used by the authenticationMethod - property of the DRMContentData class.
 AutoCapitalize -
-		flash.text -The AutoCapitalize class defines constants for the -autoCapitalize property of the StageText class.
 AVM1Movie -
-		flash.display - AVM1Movie is a simple class that represents AVM1 movie clips, which use ActionScript 1.0 or 2.0.
 BevelFilter -
-		flash.filters - The BevelFilter class lets you add a bevel effect to display objects.
 Bitmap -
-		flash.display - The Bitmap class represents display objects that represent bitmap images.
 BitmapData -
-		flash.display - - The BitmapData class lets you work with the data (pixels) of a Bitmap object - - bitmap image.
 BitmapDataChannel -
-		flash.display -The BitmapDataChannel class is an enumeration of constant values that indicate which channel to -use: red, blue, green, or alpha transparency.
 BitmapEncodingColorSpace -
-		flash.display - The BitmapEncodingColorSpace class defines the constants that specify how color channels are sampled - by the flash.display.BitmapData.encode() method when specifying the compressor as - flash.display.JPEGXREncoderOptions.
 BitmapFilter -
-		flash.filters - The BitmapFilter class is the base class for all image filter effects.
 BitmapFilterQuality -
-		flash.filters -The BitmapFilterQuality class contains values to set the rendering quality of a BitmapFilter object.
 BitmapFilterType -
-		flash.filters -The BitmapFilterType class contains values to set the type of a BitmapFilter.
 BlendMode -
-		flash.display -A class that provides constant values for visual blend mode effects.
 BlurFilter -
-		flash.filters - The BlurFilter class lets you apply a blur visual effect to display objects.
 Boolean -
-		Top Level - -A Boolean object is a data type that can have one of two values, either true or false, - -used for logical operations.
 BreakOpportunity -
-		flash.text.engine -The BreakOpportunity class is an enumeration of constant values that you can use to set the breakOpportunity property -of the ElementFormat class.
 BrowserInvokeEvent -
-		flash.events - The NativeApplication object of an AIR application dispatches a browserInvoke event when the - application is invoked as the result of a SWF file in the browser using the browser - invocation feature.
 ByteArray -
-		flash.utils - - The ByteArray class provides methods and properties to optimize reading, writing, - - and working with binary data.
 Camera -
-		flash.media - - Use the Camera class to capture video from the client system or device camera.
 CameraPosition -
-		flash.media - The CameraPosition class defines constants for the position property of the - Camera class.
 CameraRoll -
-		flash.media -The CameraRoll class allows you to access image data in the system media library or "camera roll." - -

AIR profile support: This feature is supported -on mobile devices, but it is not supported on desktop operating systems or AIR for TV devices.

 CameraRollBrowseOptions -
-		flash.media - The CameraRollBrowseOptions class defines the initialization options that may be used - when using the Camera Roll API to launch the Image Picker.
 CameraUI -
-		flash.media - The CameraUI class allows you to capture a still image or video using the default camera application on a device.
 Capabilities -
-		flash.system - The Capabilities class provides properties that - describe the system and runtime that are hosting the application.
 CapsStyle -
-		flash.display - The CapsStyle class is an enumeration of constant values that specify the caps style to use in drawing lines.
 CertificateStatus -
-		flash.security - The CertificateStatus class defines constants used to report the - results of certificate validation processing by a SecureSocket object.
 CFFHinting -
-		flash.text.engine -The CFFHinting class defines values for cff hinting in the FontDescription class.
 Class -
-		Top Level - - A Class object is created for each class definition in a program.
 Clipboard -
-		flash.desktop - The Clipboard class provides a container for transferring data and objects through the clipboard.
 ClipboardFormats -
-		flash.desktop -The ClipboardFormats class defines constants for the names of the standard data formats used with the Clipboard class.
 ClipboardTransferMode -
-		flash.desktop - The ClipboardTransferMode class defines constants for the modes used as values of the transferMode - parameter of the Clipboard.getData() method.
 Collator -
-		flash.globalization - The Collator class provides locale-sensitive string comparison capabilities.
 CollatorMode -
-		flash.globalization - The CollatorMode class enumerates constant values that govern the behavior of string comparisons - performed by a Collator object.
 ColorCorrection -
-		flash.display -The ColorCorrection class provides values for the flash.display.Stage.colorCorrection property.
 ColorCorrectionSupport -
-		flash.display -The ColorCorrectionSupport class provides values for the flash.display.Stage.colorCorrectionSupport property.
 ColorMatrixFilter -
-		flash.filters -The ColorMatrixFilter class lets you apply a 4 x 5 matrix transformation on the RGBA color and alpha values -of every pixel in the input image to produce a result with a new set of RGBA color and alpha values.
 ColorTransform -
-		flash.geom - The ColorTransform class lets you adjust the color values in a display object.
 CompositionAttributeRange -
-		flash.text.ime -The CompositionAttributeRange class represents a range of composition attributes for use with IME (input method editor) events.
 CompressionAlgorithm -
-		flash.utils - - The CompressionAlgorithm class defines string constants for the names of compress and uncompress options.
 Condition -
-		flash.concurrent - - A Condition object is a tool for sharing a resource between workers with the - - additional capability of pausing execution until a particular condition is - - satisfied.
 ContentElement -
-		flash.text.engine - The ContentElement class serves as a base class for the element types that can appear in a GroupElement, namely a GraphicElement, - another GroupElement, or a TextElement.
 Context3D -
-		flash.display3D - - The Context3D class provides a context for rendering geometrically defined graphics.
 Context3DBlendFactor -
-		flash.display3D - Defines the values to use for specifying the source and destination blend factors.
 Context3DBufferUsage -
-		flash.display3D - Defines the values to use for specifying the buffer usage type.
 Context3DClearMask -
-		flash.display3D - Defines the values to use for specifying Context3D clear masks.
 Context3DCompareMode -
-		flash.display3D - Defines the values to use for specifying 3D buffer comparisons in the setDepthTest() and setStencilAction() methods - of a Context3D instance.
 Context3DFillMode -
-		flash.display3D - Defines the values to use for specifying 3D render fill mode in the setFillMode() methods - of a Context3D instance.
 Context3DMipFilter -
-		flash.display3D - Defines the values to use for sampler mipmap filter mode - -
 Context3DProfile -
-		flash.display3D - Defines the values to use for specifying the Context3D profile.
 Context3DProgramType -
-		flash.display3D - Defines the values to use for specifying whether a shader program is - a fragment or a vertex program.
 Context3DRenderMode -
-		flash.display3D - Defines the values to use for specifying the Context3D render mode.
 Context3DStencilAction -
-		flash.display3D - Defines the values to use for specifying stencil actions.
 Context3DTextureFilter -
-		flash.display3D - Defines the values to use for sampler filter mode.
 Context3DTextureFormat -
-		flash.display3D - Defines the values to use for specifying a texture format.
 Context3DTriangleFace -
-		flash.display3D - Constants to specify the orientation of a triangle relative to the view point.
 Context3DVertexBufferFormat -
-		flash.display3D - Defines the values to use for specifying vertex buffers.
 Context3DWrapMode -
-		flash.display3D - Defines the values to use for sampler wrap mode - -
 ContextMenu -
-		flash.ui - The ContextMenu class provides control over the items displayed in context menus.
 ContextMenuBuiltInItems -
-		flash.ui -The ContextMenuBuiltInItems class describes the items that are built in to a context menu.
 ContextMenuClipboardItems -
-		flash.ui - The ContextMenuClipboardItems class lets you enable or disable the commands in the clipboard context menu.
 ContextMenuEvent -
-		flash.events - An InteractiveObject dispatches a ContextMenuEvent object when the user opens or interacts with - the context menu.
 ContextMenuItem -
-		flash.ui - The ContextMenuItem class represents an item in the context - menu.
 ConvolutionFilter -
-		flash.filters -The ConvolutionFilter class applies a matrix convolution filter effect.
 CSMSettings -
-		flash.text - The CSMSettings class contains properties for use with the - TextRenderer.setAdvancedAntiAliasingTable() method - to provide continuous stroke modulation (CSM).
 CubeTexture -
-		flash.display3D.textures - The CubeTexture class represents a cube texture uploaded to a rendering context.
 CurrencyFormatter -
-		flash.globalization - The CurrencyFormatter class provides locale-sensitive formatting and parsing of currency values.
 CurrencyParseResult -
-		flash.globalization - A data structure that represents a currency amount and currency symbol or string that were extracted by parsing a currency value.
 DataEvent -
-		flash.events - -An object dispatches a DataEvent object when raw data has completed loading.
 DatagramSocket -
-		flash.net - - The DatagramSocket class enables code to send and receive - - Universal Datagram Protocol (UDP) packets.
 DatagramSocketDataEvent -
-		flash.events - A DatagramSocketDataEvent object is dispatched when Datagram socket has received data.
 Date -
-		Top Level - - The Date class represents date and time information.
 DateTimeFormatter -
-		flash.globalization - The DateTimeFormatter class provides locale-sensitive formatting for Date objects and access to localized - date field names.
 DateTimeNameContext -
-		flash.globalization - The DateTimeNameContext class enumerates constant values representing the formatting context in which a month name - or weekday name is used.
 DateTimeNameStyle -
-		flash.globalization - The DateTimeNameStyle class enumerates constants that control the length of the month names and weekday names - that are used when formatting dates.
 DateTimeStyle -
-		flash.globalization - Enumerates constants that determine a locale-specific date and time formatting pattern.
 DefinitionError -
-		Top Level - - The DefinitionError class represents an error that occurs when user code - - attempts to define an identifier that is already defined.
 DeviceRotation -
-		flash.sensors - The DeviceRotation class dispatches events based on activity detected by the device's acceletometer, - gyroscope sensors.
 DeviceRotationEvent -
-		flash.events -The DeviceRotation class dispatches DeviceRotationEvent and returns roll, yaw, pitch and quaternion data when DeviceRotation updates are obtained from the combined readings from -Accelerometer and Gyroscope sensors' readings installed on the device.
 Dictionary -
-		flash.utils - - The Dictionary class lets you create a dynamic collection of properties, which uses strict equality - - (===) for key comparison.
 Digest -
-		air.security - - The Digest class is used to generate a digest, or hash, of some data.
 DigitCase -
-		flash.text.engine -The DigitCase class is an enumeration of constant values used in setting the digitCase property -of the ElementFormat class.
 DigitWidth -
-		flash.text.engine -The DigitWidth class is an enumeration of constant values used in setting the digitWidth property -of the ElementFormat class.
 DisplacementMapFilter -
-		flash.filters -The DisplacementMapFilter class uses the pixel values from the specified BitmapData object -(called the displacement map image) to perform a displacement of an object.
 DisplacementMapFilterMode -
-		flash.filters -The DisplacementMapFilterMode class provides values for the mode property -of the DisplacementMapFilter class.
 DisplayObject -
-		flash.display - The DisplayObject class is the base class for all objects that can be placed on - the display list.
 DisplayObjectContainer -
-		flash.display -The DisplayObjectContainer class is the base class for all objects that can serve as display object containers on -the display list.
 DNSResolver -
-		flash.net.dns - The DNSResolver class lets you lookup Domain Name System (DNS) resource records.
 DNSResolverEvent -
-		flash.events - The DNSResolverEvent class represents the results of a Domain Name System (DNS) lookup operation.
 DockIcon -
-		flash.desktop - The DockIcon class represents the Mac OS X®-style dock icon.
 DownloadErrorEvent -
-		air.update.events - - A DownloadErrorEvent object is dispatched by an ApplicationUpdater or ApplicationUpdaterUI - - object when an error happens while downloading the update file.
 DRMAuthenticateEvent -
-		flash.events - A NetStream object dispatchs a DRMAuthenticateEvent object when attempting to play digital rights management (DRM) encrypted - content that requires a user credential for authentication.
 DRMAuthenticationCompleteEvent -
-		flash.events - The DRMManager dispatches a DRMAuthenticationCompleteEvent object when a call to the authenticate() - method of the DRMManager object succeeds.
 DRMAuthenticationErrorEvent -
-		flash.events - The DRMManager dispatches a DRMAuthenticationErrorEvent object when a call to the authenticate() - method of the DRMManager object fails.
 DRMContentData -
-		flash.net.drm - The DRMContentData class provides the information required to - obtain the voucher necessary to view DRM-protected content.
 DRMDeviceGroup -
-		flash.net.drm - A device group signifies a group of playback devices that shares protected-content playback rights.
 DRMDeviceGroupErrorEvent -
-		flash.events -

Issued by the DRMManager when any error occurs during any device group related calls.

-

It is the application's responsibility to explicitly handle the error events.These events include cases - where the user inputs valid credentials, but the voucher protecting the encrypted content restricts the access - to the content.

 DRMDeviceGroupEvent -
-		flash.events -

Issued by the DRMManager when a device group related call successfully completes.

 DRMErrorEvent -
-		flash.events - The DRMErrorEvent class provides information about errors that occur when playing digital rights management (DRM) - encrypted files.
 DRMLicenseRequestEvent -
-		flash.events - The DRMManager dispatches a DRMLicenseRequestEvent object before each call to the loadVoucher() - or loadPreviewVoucher() methods of the DRMManager object succeeds.
 DRMManager -
-		flash.net.drm - The DRMManager manages the retrieval and storage of the vouchers needed to view - DRM-protected content.
 DRMManagerError -
-		flash.errors - The DRMManager dispatches a DRMManagerError event to report errors.
 DRMPlaybackTimeWindow -
-		flash.net.drm - The DRMPlaybackTimeWindow class represents the period of time during which a - DRM voucher is valid.
 DRMReturnVoucherCompleteEvent -
-		flash.events - The DRMManager dispatches a DRMVoucherReturnCompleteEvent object when a call to the returnVoucher() - method of the DRMManager object succeeds.
 DRMReturnVoucherErrorEvent -
-		flash.events - The DRMManager dispatches a DRMReturnVoucherErrorEvent object when a call to the returnVoucher() - method of the DRMManager object fails.
 DRMStatusEvent -
-		flash.events - A NetStream object dispatches a DRMStatusEvent object when the content protected using - digital rights management (DRM) begins playing successfully (when the voucher is - verified, and when the user is authenticated and authorized to view the content).
 DRMVoucher -
-		flash.net.drm - The DRMVoucher class is a handle to the license token that allows a user to view DRM-protected content.
 DropShadowFilter -
-		flash.filters -The DropShadowFilter class lets you add a drop shadow to display objects.
 EastAsianJustifier -
-		flash.text.engine - The EastAsianJustifier class has properties to control the justification options for text lines whose - content is primarily East Asian text.
 ElementFormat -
-		flash.text.engine - The ElementFormat class represents formatting information which can be applied to a ContentElement.
 EncryptedLocalStore -
-		flash.data - - The EncryptedLocalStore class (ELS) provides an encrypted local storage mechanism - - that can be used as a small cache for an application's private data.
 Encryption -
-		air.security - - The Encryption class is used to encrypt and decrypt ByteArray objects - - using industry-standard AES-CBC algorithms.
 Endian -
-		flash.utils - The Endian class contains values that denote the byte order used to represent multibyte - numbers.
 Error -
-		Top Level - - The Error class contains information about an error that occurred in a script.
 ErrorEvent -
-		flash.events -An object dispatches an ErrorEvent object when an error causes an asynchronous operation -to fail.
 EvalError -
-		Top Level - - The EvalError class represents an error that occurs when user code - - calls the eval() function or attempts to use the new - - operator with the Function object.
 Event -
-		flash.events - The Event class is used as the base class for the creation of Event objects, - which are passed as parameters to event listeners when an event occurs.
 EventDispatcher -
-		flash.events -The EventDispatcher class is the base class for all runtime classes that dispatch events.
 EventPhase -
-		flash.events - The EventPhase class provides values for the eventPhase property of the Event class.
 ExtensionContext -
-		flash.external

The ExtensionContext class also provides a static method getExtensionDirectory() for - - accessing the directory in which the extension is installed on the device.

 ExtensionInfo -
-		flash.external - - The ExtensionInfo class provides details about a particular AIR Native Extension.
 ExternalInterface -
-		flash.external - The ExternalInterface class is an application programming interface - that enables straightforward communication between ActionScript and the SWF - container– for example, an HTML page with JavaScript or a desktop application - that uses Flash Player to display a SWF file.
 File -
-		flash.filesystem - - A File object represents a path to a file or directory.
 FileFilter -
-		flash.net - The FileFilter class is used to indicate what files on the user's system are shown - in the file-browsing dialog box that is displayed when the FileReference.browse() - method, the FileReferenceList.browse() method is called or a - browse method of a File, FileReference, or FileReferenceList object is called.
 FileListEvent -
-		flash.events - A File object dispatches a FileListEvent object when a call to the getDirectoryListingAsync() method - of a File object successfully enumerates a set of files and directories or when a user selects files after a - call to the browseForOpenMultiple() method.
 FileMode -
-		flash.filesystem - The FileMode class defines string constants used in the fileMode parameter of - the open() and openAsync() methods of the FileStream class.
 FileReference -
-		flash.net - The FileReference class provides a means to upload and - download files between a user's computer and a server.
 FileReferenceList -
-		flash.net - The FileReferenceList class provides a means to let users select one or more files for uploading.
 FileStream -
-		flash.filesystem - A FileStream object is used to read and write files.
 float -
-		Top Level - - A data type representing an IEEE-754 single-precision floating-point number.
 FocusDirection -
-		flash.display - The FocusDirection class enumerates values to be used for the - direction parameter of the assignFocus() method - of a Stage object and for the direction property of a FocusEvent object.
 FocusEvent -
-		flash.events - An object dispatches a FocusEvent object when the user changes the focus from one object - in the display list to another.
 Font -
-		flash.text - - The Font class is used to manage embedded fonts in SWF files.
 FontDescription -
-		flash.text.engine - - The FontDescription class represents the information necessary to describe a font.
 FontLookup -
-		flash.text.engine -The FontLookup class is an enumeration of constant values used with FontDescription.fontLookup.
 FontMetrics -
-		flash.text.engine - The FontMetrics class contains measurement and offset information about a font.
 FontPosture -
-		flash.text.engine -The FontPosture class is an enumeration of constant values used with FontDescription.fontPosture to -set text to italic or normal.
 FontStyle -
-		flash.text -The FontStyle class provides values for the TextRenderer class.
 FontType -
-		flash.text - The FontType class contains the enumerated constants "embedded" - and "device" for the fontType property of the Font class.
 FontWeight -
-		flash.text.engine -The FontWeight class is an enumeration of constant values used with FontDescription.fontWeight.
 FrameLabel -
-		flash.display - - The FrameLabel object contains properties that specify a frame number and the - corresponding label name.
 FullScreenEvent -
-		flash.events -The Stage object dispatches a FullScreenEvent object whenever the Stage enters or leaves full-screen display mode.
 Function -
-		Top Level - - A function is the basic unit of code that can be invoked in ActionScript.
 GameInput -
-		flash.ui - The GameInput class is the entry point into the GameInput - API.
 GameInputControl -
-		flash.ui - The GameInputControl class represents a control on an input device.
 GameInputDevice -
-		flash.ui - The GameInputDevice class represents a single input device - commonly used for gaming.
 GameInputEvent -
-		flash.events - The GameInputEvent class represents an event that is - dispatched when a game input device has either been added or removed - from the application platform.
 Geolocation -
-		flash.sensors - The Geolocation class dispatches events in response to the device's location sensor.
 GeolocationEvent -
-		flash.events -A Geolocation object dispatches GeolocationEvent objects when it receives updates from the location sensor installed on the device.
 GestureEvent -
-		flash.events - The GestureEvent class lets you handle multi-touch events on devices that detect complex user contact with - the device (such as pressing two fingers on a touch screen at the same time).
 GesturePhase -
-		flash.events - The GesturePhase class is an enumeration class of constant values for use with the GestureEvent, PressAndTapGestureEvent, and TransformGestureEvent - classes.
 GlowFilter -
-		flash.filters - The GlowFilter class lets you apply a glow effect to display objects.
 GradientBevelFilter -
-		flash.filters -The GradientBevelFilter class lets you apply a gradient bevel effect to -display objects.
 GradientGlowFilter -
-		flash.filters - The GradientGlowFilter class lets you apply a gradient glow effect to display objects.
 GradientType -
-		flash.display -The GradientType class provides values for the type parameter in the -beginGradientFill() and lineGradientStyle() methods of the flash.display.Graphics class.
 GraphicElement -
-		flash.text.engine - The GraphicElement class represents a graphic element in a TextBlock or GroupElement object.
 Graphics -
-		flash.display - The Graphics class contains a set of methods that you can use to create a vector shape.
 GraphicsBitmapFill -
-		flash.display - Defines a bitmap fill.
 GraphicsEndFill -
-		flash.display - Indicates the end of a graphics fill.
 GraphicsGradientFill -
-		flash.display - Defines a gradient fill.
 GraphicsPath -
-		flash.display - A collection of drawing commands and the coordinate parameters for those commands.
 GraphicsPathCommand -
-		flash.display - Defines the values to use for specifying path-drawing commands.
 GraphicsPathWinding -
-		flash.display -The GraphicsPathWinding class provides values for the flash.display.GraphicsPath.winding property -and the flash.display.Graphics.drawPath() method -to determine the direction to draw a path.
 GraphicsShaderFill -
-		flash.display - Defines a shader fill.
 GraphicsSolidFill -
-		flash.display - Defines a solid fill.
 GraphicsStroke -
-		flash.display - Defines a line style or stroke.
 GraphicsTrianglePath -
-		flash.display - Defines an ordered set of triangles that can be rendered using - either (u,v) fill coordinates or a normal fill.
 GridFitType -
-		flash.text -The GridFitType class defines values for grid fitting in the TextField class.
 GroupElement -
-		flash.text.engine - A GroupElement object groups a collection of TextElement, GraphicElement, or other GroupElement objects - that you can assign as a unit to the content property of a TextBlock object.
 GroupSpecifier -
-		flash.net - The GroupSpecifier class is used to construct the opaque groupspec strings - that can be passed to NetStream and NetGroup constructors.
 H264Level -
-		flash.media - The H264Level class is an enumeration of constant values used in setting the - level of H264VideoStreamSettings class.
 H264Profile -
-		flash.media - The H264Profile class is an enumeration of constant values used in setting the profile - of H264VideoStreamSettings class.
 H264VideoStreamSettings -
-		flash.media - The H264VideoStreamSettings class enables specifying video compression settings for each NetStream.
 HostObject -
-		flash.external - The HostObject is the base class of all host objects.
 HTMLHistoryItem -
-		flash.html - An HTMLHistoryItem object describes a location in the navigation history of - an HTMLLoader object.
 HTMLHost -
-		flash.html - An HTMLHost object defines behaviors of an HTMLLoader object for user interface elements that - can be controlled by setting various properties or by calling various methods of the window - object of the HTML page.
 HTMLLoader -
-		flash.html 
 HTMLPDFCapability -
-		flash.html - The HTMLPDFCapability class contains possible values of the pdfCapability property of - an HTMLLoader object.
 HTMLSWFCapability -
-		flash.html - The HTMLSWFCapability class contains possible values of the swfCapability property of - an HTMLLoader object.
 HTMLUncaughtScriptExceptionEvent -
-		flash.events - An HTMLLoader object dispatches an HTMLUncaughtScriptExceptionEvent object whenever a JavaScript exception - is thrown and not handled with a catch statement.
 HTMLWindowCreateOptions -
-		flash.html - This class defines the options that can be specified when JavaScript running - in an HTMLLoader object tries to create a new HTML window by calling the - window.open() method.
 HTTPStatusEvent -
-		flash.events -The application dispatches HTTPStatusEvent objects when a network request returns an HTTP -status code.
 IBitmapDrawable -
-		flash.display - The IBitmapDrawable interface is implemented by objects that can be passed as the source - parameter of the draw() method of the BitmapData class.
 Icon -
-		flash.desktop - The Icon class represents an operating system icon.
 ID3Info -
-		flash.media - The ID3Info class contains properties that reflect ID3 metadata.
 IDataInput -
-		flash.utils - -The IDataInput interface provides a set of methods for reading binary data.
 IDataOutput -
-		flash.utils - -The IDataOutput interface provides a set of methods for writing binary data.
 IDynamicPropertyOutput -
-		flash.net - - This interface controls the serialization of dynamic properties of dynamic objects.
 IDynamicPropertyWriter -
-		flash.net - - This interface is used with the IDynamicPropertyOutput interface to control - - the serialization of dynamic properties of dynamic objects.
 IEventDispatcher -
-		flash.events -The IEventDispatcher interface defines methods for adding or removing event listeners, checks -whether specific types of event listeners are registered, and dispatches events.
 IExternalizable -
-		flash.utils - - The IExternalizable interface provides control over serialization of a class as it is encoded - - into a data stream.
 IFilePromise -
-		flash.desktop - The IFilePromise interface defines the interface used by the AIR runtime to read data for a file promise.
 IGraphicsData -
-		flash.display - This interface is used to define objects that can be used as parameters in the flash.display.Graphics - methods, including fills, strokes, and paths.
 IGraphicsFill -
-		flash.display - This interface is used to define objects that can be used as fill parameters in the flash.display.Graphics - methods and drawing classes.
 IGraphicsPath -
-		flash.display - This interface is used to define objects that can be used as path parameters in the flash.display.Graphics - methods and drawing classes.
 IGraphicsStroke -
-		flash.display - This interface is used to define objects that can be used as stroke parameters in the flash.display.Graphics - methods and drawing classes.
 IIMEClient -
-		flash.text.ime -Interface for IME (input method editor) clients.
 ImageDecodingPolicy -
-		flash.system - The ImageDecodingPolicy class provides values for imageDecodingPolicy in the LoaderContext class.
 IME -
-		flash.system - The IME class lets you directly manipulate the operating system's input method - editor (IME) in the Flash runtime application that is running on a client computer.
 IMEConversionMode -
-		flash.system - This class contains constants for use with the IME.conversionMode - property.
 IMEEvent -
-		flash.events - An IMEEvent object is dispatched when the user enters text using an input method editor - (IME).
 IndexBuffer3D -
-		flash.display3D - IndexBuffer3D is used to represent lists of vertex indices comprising graphic elements retained - by the graphics subsystem.
 int -
-		Top Level - - The int class lets you work with the data type representing a 32-bit signed integer.
 InteractiveIcon -
-		flash.desktop - The InteractiveIcon class is the base class for the operating - system icons associated with applications.
 InteractiveObject -
-		flash.display - - 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.
 InterfaceAddress -
-		flash.net - The InterfaceAddress class reports the properties of a network interface address.
 InterpolationMethod -
-		flash.display -The InterpolationMethod class provides values for the interpolationMethod -parameter in the Graphics.beginGradientFill() and -Graphics.lineGradientStyle() methods.
 InvalidSWFError -
-		flash.errors - - The Flash runtimes throw this exception when they encounter a corrupted SWF file.
 InvokeEvent -
-		flash.events - The NativeApplication object of an AIR application dispatches an invoke event when the - application is invoked.
 InvokeEventReason -
-		flash.desktop - The InvokeEventReason class enumerates values returned by the - reason property of an InvokeEvent object.
 IOErrorEvent -
-		flash.events -An IOErrorEvent object is dispatched when an error causes input or output operations to fail.
 IPVersion -
-		flash.net - The IPVersion class defines constants representing the different families of IP addresses.
 ISearchableText -
-		flash.accessibility - The ISearchableText interface can be implemented by objects that - contain text which should be searchable on the web.
 ISimpleTextSelection -
-		flash.accessibility - - The ISimpleTextSelection class can be used to add support for - the MSAA ISimpleTextSelection interface to an AccessibilityImplementation.
 IURIDereferencer -
-		flash.security - IURIDereferencer defines an interface for objects that resolve - URIs in an XML signature.
 JointStyle -
-		flash.display -The JointStyle class is an enumeration of constant values that specify the joint style to use in drawing lines.
 JPEGEncoderOptions -
-		flash.display - The JPEGEncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method.
 JPEGLoaderContext -
-		flash.system - The JPEGLoaderContext class includes a property for enabling a deblocking filter when loading a JPEG image.
 JPEGXREncoderOptions -
-		flash.display - The JPEGXREncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method.
 JSON -
-		Top Level - - The JSON class lets applications import and export data using JavaScript Object Notation (JSON) format.
 JustificationStyle -
-		flash.text.engine -The JustificationStyle class is an enumeration of constant values for setting the justificationStyle property -of the EastAsianJustifier class.
 Kerning -
-		flash.text.engine -The Kerning class is an enumeration of constant values used with ElementFormat.kerning.
 Keyboard -
-		flash.ui - - The Keyboard class is used to build an interface that can be controlled by a user with a standard keyboard.
 KeyboardEvent -
-		flash.events - - A KeyboardEvent object id dispatched in response to user input through a keyboard.
 KeyboardType -
-		flash.ui - The KeyboardType class is an enumeration class that provides values for different categories of physical computer or device keyboards.
 KeyLocation -
-		flash.ui -The KeyLocation class contains constants that indicate the location of a key pressed on -the keyboard or keyboard-like input device.
 LastOperationStatus -
-		flash.globalization - The LastOperationStatus class enumerates constant values that represent the status of the most recent globalization service operation.
 License -
-		air.system - - The License class is used to provide information about the AIR SDK license, - - for a running application.
 LigatureLevel -
-		flash.text.engine -The LigatureLevel class is an enumeration of constant values used in setting the ligatureLevel property -of the ElementFormat class.
 LineJustification -
-		flash.text.engine -The LineJustification class is an enumeration of constant values used in setting the lineJustfication property -of the TextJustifier subclasses.
 LineScaleMode -
-		flash.display -The LineScaleMode class provides values for the scaleMode -parameter in the Graphics.lineStyle() method.
 Loader -
-		flash.display - - The Loader class is used to load SWF files or image (JPG, PNG, or GIF) files.
 LoaderContext -
-		flash.system - The LoaderContext class provides options for loading SWF files and other media by using the Loader class.
 LoaderInfo -
-		flash.display - The LoaderInfo class provides information about a loaded SWF file or a loaded image file - (JPEG, GIF, or PNG).
 LoadVoucherSetting -
-		flash.net.drm - The LoadVoucherSetting class provides string constants for use - with the settings parameter of the DRMManager loadVoucher() method.
 LocalConnection -
-		flash.net - The LocalConnection class lets you create a LocalConnection object that can invoke a method in another - LocalConnection object.
 LocaleID -
-		flash.globalization - The LocaleID class provides methods for parsing and using locale ID names.
 LocationChangeEvent -
-		flash.events - An HTMLLoader or StageWebView object dispatches a LocationChangeEvent object when a new page loads.
 Math -
-		Top Level - - The Math class contains methods and constants that represent common mathematical - - functions and values.
 Matrix -
-		flash.geom - - The Matrix class represents a transformation matrix that determines how to map points from one - - coordinate space to another.
 Matrix3D -
-		flash.geom - The Matrix3D class represents a transformation matrix that determines the position and orientation of - a three-dimensional (3D) display object.
 MediaEvent -
-		flash.events - CameraRoll and CameraUI classes dispatch MediaEvent objects when a media stream - is available.
 MediaPromise -
-		flash.media - The MediaPromise class represents the promise to deliver a media object.
 MediaType -
-		flash.media - The MediaType class enumerates the general types of media that can be returned by a camera.
 MessageChannel -
-		flash.system - The MessageChannel class provides a mechanism for a worker to communicate - with another worker.
 MessageChannelState -
-		flash.system - This class defines constants that represent the possible values for the - MessageChannel class's state property.
 Microphone -
-		flash.media - - Use the Microphone class to monitor or capture audio from a microphone.
 MicrophoneEnhancedMode -
-		flash.media - The MicrophoneEnhancedMode class is an enumeration of constant values used in setting the mode property - of MicrophoneEnhancedOptions class.
 MicrophoneEnhancedOptions -
-		flash.media - The MicrophoneEnhancedOptions class provides configuration options for enhanced audio (acoustic echo cancellation).
 MorphShape -
-		flash.display - The MorphShape class represents MorphShape objects on the display list.
 Mouse -
-		flash.ui - The methods of the Mouse class are used to hide and show the mouse pointer, - or to set the pointer to a specific style.
 MouseCursor -
-		flash.ui -The MouseCursor class is an enumeration of constant values used in setting the cursor property -of the Mouse class.
 MouseCursorData -
-		flash.ui - The MouseCursorData class lets you define the appearance of a "native" mouse cursor.
 MouseEvent -
-		flash.events - - A MouseEvent object is dispatched into the event flow whenever mouse events occur.
 MovieClip -
-		flash.display - The MovieClip class inherits from the following classes: Sprite, DisplayObjectContainer, - InteractiveObject, DisplayObject, and EventDispatcher.
 Multitouch -
-		flash.ui - The Multitouch class manages and provides information about the current environment's support for handling - contact from user input devices, including contact that has two or more touch points (such as a user's fingers on a touch screen).
 MultitouchInputMode -
-		flash.ui - The MultitouchInputMode class provides values for the inputMode property in the flash.ui.Multitouch class.
 Mutex -
-		flash.concurrent - - The Mutex (short for "mutual exclusion") class provides a way to make sure - - that only one set of code operates on a particular block of memory or other - - shared resource at a time.
 MXRecord -
-		flash.net.dns - The MXRecord class represents a Domain Name System (DNS) MX resource record containing a mail exchange server address.
 Namespace -
-		Top Level - - -The Namespace class contains methods and properties for defining and working with namespaces.
 NationalDigitsType -
-		flash.globalization - The NationalDigitsType class enumerates constants that indicate digit sets used by the NumberFormatter class.
 NativeApplication -
-		flash.desktop - - The NativeApplication class represents this AIR application.
 NativeDragActions -
-		flash.desktop -The NativeDragActions class defines string constants for the names of the drag-and-drop actions.
 NativeDragEvent -
-		flash.events - Native drag events are dispatched by the interactive objects involved in a - drag-and-drop operation.
 NativeDragManager -
-		flash.desktop - The NativeDragManager class coordinates drag-and-drop operations.
 NativeDragOptions -
-		flash.desktop - The NativeDragOptions class defines constants for the names of drag-and-drop actions allowed in a drag-and-drop operation.
 NativeMenu -
-		flash.display - - The NativeMenu class contains methods and properties for defining native menus.
 NativeMenuItem -
-		flash.display - - The NativeMenuItem class represents a single item in a menu.
 NativeProcess -
-		flash.desktop - The NativeProcess class provides command line integration and general launching capabilities.
 NativeProcessExitEvent -
-		flash.events - This event is dispatched by the NativeProcess object when the process exits.
 NativeProcessStartupInfo -
-		flash.desktop - This class provides the basic information used to start a process on the host operating system.
 NativeWindow -
-		flash.display - - The NativeWindow class provides an interface for creating and controlling native desktop windows.
 NativeWindowBoundsEvent -
-		flash.events - A NativeWindow object dispatches a NativeWindowBoundsEvent object when the size or location - of the window changes.
 NativeWindowDisplayState -
-		flash.display - The NativeWindowDisplayState class defines constants for the names of the window display states.
 NativeWindowDisplayStateEvent -
-		flash.events - A NativeWindow object dispatches events of the NativeWindowDisplayStateEvent class when the window - display state changes.
 NativeWindowInitOptions -
-		flash.display - The NativeWindowInitOptions class defines the initialization options - used to construct a new NativeWindow instance.
 NativeWindowRenderMode -
-		flash.display - The NativeWindowRenderMode class defines constants for the renderMode property of the - NativeWindowInitOptions object used to create a native window.
 NativeWindowResize -
-		flash.display -The NativeWindowResize class defines constants for the possible values - of the edgeOrCorner parameter of the NativeWindow - startResize() method.
 NativeWindowSystemChrome -
-		flash.display - The NativeWindowSystemChrome class defines constants for the systemChrome - property of the NativeWindowInitOptions object used to create a native window.
 NativeWindowType -
-		flash.display - The NativeWindowType class defines constants for the type property of the - NativeWindowInitOptions object used to create a native window.
 NetConnection -
-		flash.net - The NetConnection class creates a two-way connection between a client and a server.
 NetDataEvent -
-		flash.events -A NetStream object dispatches a NetDataEvent object when a data message is encountered in the media stream.
 NetGroup -
-		flash.net -Instances of the NetGroup class represent membership in an RTMFP group.
 NetGroupInfo -
-		flash.net -The NetGroupInfo class specifies various Quality of Service (QoS) statistics -related to a NetGroup object's underlying RTMFP Peer-to-Peer data transport.
 NetGroupReceiveMode -
-		flash.net -The NetGroupReceiveMode class is an enumeration of constant values used for the receiveMode property -of the NetGroup class.
 NetGroupReplicationStrategy -
-		flash.net -The NetGroupReplicationStrategy class is an enumeration of constant values used in setting the replicationStrategy property -of the NetGroup class.
 NetGroupSendMode -
-		flash.net -The NetGroupSendMode class is an enumeration of constant values used for the sendMode parameter of the NetGroup.sendToNeighbor() -method.
 NetGroupSendResult -
-		flash.net -The NetGroupSendResult class is an enumeration of constant values used for the return value of the -Directed Routing methods associated with a NetGroup instance.
 NetMonitor -
-		flash.net - The NetMonitor class maintains a list of NetStream objects.
 NetMonitorEvent -
-		flash.events - A NetMonitor object dispatches NetMonitorEvent objects when a NetStream object is created.
 NetStatusEvent -
-		flash.events -A NetConnection, NetStream, or SharedObject object dispatches NetStatusEvent objects when a it reports its status.
 NetStream -
-		flash.net - The NetStream class opens a one-way streaming channel over a NetConnection.
 NetStreamAppendBytesAction -
-		flash.net -The NetStreamAppendBytesAction class is an enumeration of the constants you can pass to the NetStream.appendBytesAction() method.
 NetStreamInfo -
-		flash.net - The NetStreamInfo class specifies the various Quality of Service (QOS) statistics and other information related to a NetStream object - and the underlying streaming buffer for audio, video, and data.
 NetStreamMulticastInfo -
-		flash.net -The NetStreamMulticastInfo class specifies various Quality of Service (QoS) statistics -related to a NetStream object's underlying RTMFP Peer-to-Peer and IP Multicast stream transport.
 NetStreamPlayOptions -
-		flash.net - The NetStreamPlayOptions class specifies the various options that can be passed - to the NetStream.play2() method.
 NetStreamPlayTransitions -
-		flash.net - The NetStreamPlayTransitions class specifies the valid strings that you can use with the - NetStreamPlayOptions.transition property.
 NetworkInfo -
-		flash.net - - The NetworkInfo class provides information about the network - - interfaces on a computer.
 NetworkInterface -
-		flash.net - The NetworkInterface class describes a network interface.
 NotificationStyle -
-		flash.notifications - The NotificationStyle class defines constants for the styles of notifications supported by RemoteNotifier class.
 NotificationType -
-		flash.desktop - The NotificationType class defines constants for use in the priority - parameter of the DockIcon bounce() method and the type - parameter of the NativeWindow notifyUser() method.
 Number -
-		Top Level - - A data type representing an IEEE-754 double-precision floating-point number.
 NumberFormatter -
-		flash.globalization - The NumberFormatter class provides locale-sensitive formatting and parsing of numeric values.
 NumberParseResult -
-		flash.globalization - A data structure that holds information about a number that was extracted by parsing a string.
 Object -
-		Top Level - - The Object class is at the root of the ActionScript - - runtime class hierarchy.
 ObjectEncoding -
-		flash.net - - The ObjectEncoding class is used in defining serialization settings in classes - - that serialize objects (such as FileStream, NetStream, NetConnection, SharedObject, - - and ByteArray) to work with prior versions of ActionScript.
 Orientation3D -
-		flash.geom -The Orientation3D class is an enumeration of constant values for representing the orientation style -of a Matrix3D object.
 OutputProgressEvent -
-		flash.events - A FileStream object dispatches OutputProgressEvent objects as pending asynchronous file write operations are - performed.
 PaperSize -
-		flash.printing -This class provides the available values for the paperSize parameter of -the PrintJob.selectPaperSize() method.
 PermissionError -
-		flash.errors - Permission error is dispatched when the application tries to access a resource - without requesting appropriate permissions.
 PermissionEvent -
-		flash.events 
 PermissionManager -
-		flash.permissions - A PermissionManager object provides access to information about operating system permissions for a - restricted resource such as camera or microphone.
 PermissionStatus -
-		flash.permissions -The PermissionStatus class is an enumeration of constant values that specify the -authorization status of a permission - -
 PerspectiveProjection -
-		flash.geom - The PerspectiveProjection class provides an easy way to assign or modify the perspective - transformations of a display object and all of its children.
 PixelSnapping -
-		flash.display - -The PixelSnapping class is an enumeration of constant values for setting the pixel snapping options -by using the pixelSnapping property of a Bitmap object.
 PNGEncoderOptions -
-		flash.display - The PNGEncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method.
 Point -
-		flash.geom - The Point object represents a location in a two-dimensional coordinate system, where x - represents the horizontal axis and y represents the vertical axis.
 PressAndTapGestureEvent -
-		flash.events - The PressAndTapGestureEvent class lets you handle press-and-tap gesture on touch-enabled devices.
 PrintJob -
-		flash.printing - The PrintJob class lets you create content and print it to one or - more pages.
 PrintJobOptions -
-		flash.printing - The PrintJobOptions class contains properties to use with the - options parameter of the PrintJob.addPage() method.
 PrintJobOrientation -
-		flash.printing -This class provides values that are used by the PrintJob.orientation property for the image position of a printed page.
 PrintMethod -
-		flash.printing -This class provides values for the PrintJobOptions.printMethod property -to specify the method of printing a page.
 PrintUIOptions -
-		flash.printing - The PrintUIOptions class is used to specify options for print dialogs that are displayed to the - user.
 Program3D -
-		flash.display3D - The Program3D class represents a pair of rendering programs (also called "shaders") - uploaded to the rendering context.
 ProgressEvent -
-		flash.events - A ProgressEvent object is dispatched when a load operation has begun or a socket has received data.
 Proxy -
-		flash.utils 
 PTRRecord -
-		flash.net.dns - The PTRRecord class represents a Domain Name System (DNS) PTR resource record containing a canonical domain name.
 QName -
-		Top Level - - -QName objects represent qualified names of XML elements and attributes.
 RangeError -
-		Top Level - - A RangeError exception is thrown when a numeric value is outside the acceptable range.
 Rectangle -
-		flash.geom - - A Rectangle object is an area defined by its position, as - - indicated by its top-left corner point (x, y) and by its width - - and its height.
 RectangleTexture -
-		flash.display3D.textures - The Rectangle Texture class represents a 2-dimensional texture uploaded to a rendering context.
 ReferenceError -
-		Top Level - - A ReferenceError exception is thrown when a reference to an undefined property is - - attempted on a sealed (nondynamic) object.
 ReferencesValidationSetting -
-		flash.security - The ReferencesValidationSetting class defines constants used by the referencesValidationSetting - property of an XMLSignatureValidator object.
 RegExp -
-		Top Level - - - The RegExp class lets you work with regular expressions, which are patterns that you can use - - to perform searches in strings and to replace text in strings.
 RemoteNotificationEvent -
-		flash.events - Contains events that are dispatched by flash.notifications.RemoteNotifier in response to push notification events from APNs.
 RemoteNotifier -
-		flash.notifications - The RemoteNotifier class lets you subscribe to and unsubscribe from push notifications.
 RemoteNotifierSubscribeOptions -
-		flash.notifications - The RemoteNotifierSubscribeOptions class defines the initialization options that may be used - during the remote notification subscription process.
 RenderingMode -
-		flash.text.engine -The RenderingMode class provides values for rendering mode in the FontDescription class.
 ResourceRecord -
-		flash.net.dns - The ResourceRecord class is the base class for Domain Name System (DNS) resource record classes.
 Responder -
-		flash.net - The Responder class provides an object that is used - in NetConnection.call() to handle return - values from the server related to the success or failure of - specific operations.
 ReturnKeyLabel -
-		flash.text -The ReturnKeyLabel class defines the values to use for - the returnKeyLabel property of the StageText class.
 RevocationCheckSettings -
-		flash.security - The RevocationCheckSettings class defines constants used by the - revocationCheckSetting property of an XMLSignatureValidator object.
 SampleDataEvent -
-		flash.events - Dispatched when a Sound object requests new audio data or when a Microphone object - has new audio data to provide.
 Scene -
-		flash.display - The Scene class includes properties for identifying the name, labels, and number of frames - in a scene.
 Screen -
-		flash.display - - The Screen class provides information about the display screens available to this application.
 ScreenMode -
-		flash.display - The ScreenMode object provides information about the width, height and refresh rate of a Screen.
 ScreenMouseEvent -
-		flash.events -The SystemTrayIcon object dispatches events of type ScreenMouseEvent in response to mouse interaction.
 ScriptTimeoutError -
-		flash.errors - - The ScriptTimeoutError exception is thrown when the script timeout interval is reached.
 SecureSocket -
-		flash.net - - The SecureSocket class enables code to make socket connections using the Secure Sockets Layer (SSL) - - and Transport Layer Security (TLS) protocols.
 Security -
-		flash.system - The Security class lets you specify how content in different domains can communicate with - each other.
 SecurityDomain -
-		flash.system - The SecurityDomain class represents the current security "sandbox," also known as a security domain.
 SecurityError -
-		Top Level - - The SecurityError exception is thrown when some type of security violation - - takes place.
 SecurityErrorEvent -
-		flash.events - -An object dispatches a SecurityErrorEvent object to report the occurrence of a - -security error.
 SecurityPanel -
-		flash.system - The SecurityPanel class provides values for specifying - which Security Settings panel you want to display.
 ServerSocket -
-		flash.net - The ServerSocket class allows code to act as a server for Transport Control Protocol (TCP) - connections.
 ServerSocketConnectEvent -
-		flash.events - A ServerSocket object dispatches a ServerSocketConnectEvent object when a client attempts - to connect to the server socket.
 Shader -
-		flash.display - A Shader instance represents a Pixel Bender shader kernel in ActionScript.
 ShaderData -
-		flash.display - A ShaderData object contains properties representing any parameters and - inputs for a shader kernel, as well as properties containing any metadata - specified for the shader.
 ShaderEvent -
-		flash.events - A ShaderEvent is dispatched when a shader operation launched from - a ShaderJob finishes.
 ShaderFilter -
-		flash.filters - The ShaderFilter class applies a filter by executing a shader on the object - being filtered.
 ShaderInput -
-		flash.display - A ShaderInput instance represents a single input image for - a shader kernel.
 ShaderJob -
-		flash.display - A ShaderJob instance is used to execute a shader operation in stand-alone mode.
 ShaderParameter -
-		flash.display - A ShaderParameter instance represents a single input parameter of - a shader kernel.
 ShaderParameterType -
-		flash.display - This class defines the constants that represent the possible values for - the ShaderParameter class's type property.
 ShaderPrecision -
-		flash.display - This class defines the constants that represent the possible values for - the Shader class's precisionHint property.
 Shape -
-		flash.display - This class is used to create lightweight shapes using the ActionScript drawing application program interface (API).
 SharedObject -
-		flash.net - The SharedObject class is used to read and store limited amounts of data on a user's computer - or on a server.
 SharedObjectFlushStatus -
-		flash.net - The SharedObjectFlushStatus class provides values for the code returned from a call to the SharedObject.flush() method.
 SignatureStatus -
-		flash.security - The SignatureStatus class defines constants used by the validityStatus - property of an XMLSignatureValidator object.
 SignerTrustSettings -
-		flash.security - The SignerTrustSettings class defines constants used with the - signerTrustSettings property of an XMLSignatureValidator object.
 SimpleButton -
-		flash.display - The SimpleButton class lets you control all instances of button symbols in a SWF - file.
 Socket -
-		flash.net - - The Socket class enables code to establish Transport Control Protocol (TCP) socket - - connections for sending and receiving binary data.
 SoftKeyboardEvent -
-		flash.events -A SoftKeyboardEvent object is dispatched when a software-driven keyboard is activated or de-activated on a device or operating system.
 SoftKeyboardTrigger -
-		flash.events - The SoftKeyboardTrigger class provides enumerator values for the triggerType property - of the SoftKeyboardEvent class.
 SoftKeyboardType -
-		flash.text - The SoftKeyboardType class defines the types of soft keyboards for - mobile applications.
 Sound -
-		flash.media - The Sound class lets you work with sound in an application.
 SoundChannel -
-		flash.media - The SoundChannel class controls a sound in an application.
 SoundCodec -
-		flash.media -The SoundCodec class is an enumeration of constant values used in setting the codec property -of the Microphone class.
 SoundLoaderContext -
-		flash.media - The SoundLoaderContext class provides security checks for files that load sound.
 SoundMixer -
-		flash.media -The SoundMixer class contains static properties and methods for global sound control -in the application.
 SoundTransform -
-		flash.media - The SoundTransform class contains properties for volume and panning.
 SpaceJustifier -
-		flash.text.engine - The SpaceJustifier class represents properties that control the justification options for text lines in a text block.
 SpreadMethod -
-		flash.display -The SpreadMethod class provides values for the spreadMethod parameter -in the beginGradientFill() and lineGradientStyle() methods of the Graphics class.
 Sprite -
-		flash.display - The Sprite class is a basic display list building block: a display list node that can display - graphics and can also contain children.
 SQLCollationType -
-		flash.data - This class contains the constants that represent the possible values for the - defaultCollationType parameter of the SQLColumnSchema constructor, as well as the - SQLColumnSchema.defaultCollationType property.
 SQLColumnNameStyle -
-		flash.data - This class contains the constants that represent the possible values for the - SQLConnection.columnNameStyle property.
 SQLColumnSchema -
-		flash.data - The SQLColumnSchema class provides information describing the characteristics of a specific column - within a table in a database.
 SQLConnection -
-		flash.data - A SQLConnection instance is used to manage the creation of and connection to local SQL database files - (local databases).
 SQLError -
-		flash.errors - A SQLError instance provides detailed information about a failed operation.
 SQLErrorEvent -
-		flash.events - A SQLErrorEvent instance is dispatched by a SQLConnection instance or SQLStatement instance - when an error occurs while performing a database operation in asynchronous execution mode.
 SQLErrorOperation -
-		flash.errors - This class contains the constants that represent the possible values for the - SQLError.operation property.
 SQLEvent -
-		flash.events - Adobe AIR dispatches SQLEvent objects when one of the operations performed by - a SQLConnection or SQLStatement instance completes successfully.
 SQLIndexSchema -
-		flash.data - A SQLIndexSchema instance provides information describing a specific index - in a database.
 SQLMode -
-		flash.data - This class contains the constants that represent the possible values for the - openMode parameter of the SQLConnection.open() and - SQLConnection.openAsync() methods.
 SQLResult -
-		flash.data - The SQLResult class provides access to data returned in response to the execution of a - SQL statement (a SQLStatement instance).
 SQLSchema -
-		flash.data - The SQLSchema class is the base class for schema information for database objects - such as tables, views, and indices.
 SQLSchemaResult -
-		flash.data - A SQLSchemaResult instance contains the information resulting from a call to - the SQLConnection.loadSchema() method.
 SQLStatement -
-		flash.data - A SQLStatement instance is used to execute a SQL statement against a local SQL database - that is open through a SQLConnection instance.
 SQLTableSchema -
-		flash.data - A SQLTableSchema instance provides information describing a specific table - in a database.
 SQLTransactionLockType -
-		flash.data - This class contains the constants that represent the possible values for the - option parameter of the SQLConnection.begin() method.
 SQLTriggerSchema -
-		flash.data - A SQLTriggerSchema instance provides information describing a specific trigger - in a database.
 SQLUpdateEvent -
-		flash.events - A SQLUpdateEvent object is dispatched by a SQLConnection object when a data change occurs - on any table associated with the SQLConnection instance.
 SQLViewSchema -
-		flash.data - A SQLViewSchema instance provides information describing a specific view - in a database.
 SRVRecord -
-		flash.net.dns - The SRVRecord class represents a Domain Name System (DNS) SRV resource record containing a service host.
 StackOverflowError -
-		flash.errors - - ActionScript throws a StackOverflowError exception when the stack available to the script - - is exhausted.
 Stage -
-		flash.display - The Stage class represents the main drawing area.
 Stage3D -
-		flash.display - The Stage3D class provides a display area and a programmable rendering context for drawing 2D and 3D graphics.
 StageAlign -
-		flash.display -The StageAlign class provides constant values to use for the Stage.align property.
 StageAspectRatio -
-		flash.display - The StageAspectRatio class provides values for the Stage.setAspectRatio() method.
 StageDisplayState -
-		flash.display -The StageDisplayState class provides values for the Stage.displayState property.
 StageOrientation -
-		flash.display - The StageOrientation class defines constants enumerating the possible orientations of the stage and the device.
 StageOrientationEvent -
-		flash.events - A Stage object dispatches a StageOrientationEvent object when the orientation - of the stage changes.
 StageQuality -
-		flash.display -The StageQuality class provides values for the Stage.quality property -and for the value of the quality parameter to -the BitmapData.drawWithQuality() method.
 StageScaleMode -
-		flash.display -The StageScaleMode class provides values for the Stage.scaleMode property.
 StageText -
-		flash.text - - The StageText class is used to present the user with a native text input field.
 StageTextClearButtonMode -
-		flash.text - This class defines an enumeration that provides option for clearButton.
 StageTextContentType -
-		flash.text - - The StageTextContentType class defines the content type/hint that is provided to mobile - - operating systems when using a StageText text input control.
 StageTextInitOptions -
-		flash.text - The StageTextInitOptions class defines the options available for initializing - a StageText object.
 StageVideo -
-		flash.media - The StageVideo object uses the device's hardware acceleration capabilities, if available, to display - live or recorded video in an application.
 StageVideoAvailability -
-		flash.media - This class defines an enumeration that indicates whether stage video is currently available.
 StageVideoAvailabilityEvent -
-		flash.events -

This event fires when the state of the Stage.stageVideos property changes.

 StageVideoAvailabilityReason -
-		flash.media - This class defines an enumeration that indicates whether stage video is currently available.
 StageVideoEvent -
-		flash.events - A StageVideo object dispatches a StageVideoEvent object after the attachNetStream() method - of the StageVideo object and the play() method of - the attached NetStream object have both been called.
 StageWebView -
-		flash.media - - The StageWebView class displays HTML content in a stage view port.
 StaticText -
-		flash.text - This class represents StaticText objects on the display list.
 StatusEvent -
-		flash.events - An object dispatches a StatusEvent object when a device, such as a camera or microphone, or an object such as a LocalConnection object reports its status.
 StatusFileUpdateErrorEvent -
-		air.update.events - - A StatusUpdateFileErrorEvent is dispatched when a call to the checkForUpdate() method of a ApplicationUpdater object encounters an error - - while downloading or parsing the update descriptor file.
 StatusFileUpdateEvent -
-		air.update.events - - Dispatched after the updater successfully validates the - - file in the call to the installFromAIRFile() method.
 StatusUpdateErrorEvent -
-		air.update.events - - A StatusUpdateErrorEvent is dispatched when a call to the checkForUpdate() method - - of an ApplicationUpdater object encounters an error while downloading or parsing the update descriptor file.
 StatusUpdateEvent -
-		air.update.events - - An updater object dispatches a StatusUpdateEvent object after the updater successfully - - downloads and interprets the update descriptor file.
 StorageVolume -
-		flash.filesystem - A StorageVolume object includes properties defining a mass storage volume.
 StorageVolumeChangeEvent -
-		flash.events - The StorageVolumeInfo.storageVolumeInfo object dispatches a StorageVolumeChangeEvent event - object when a storage volume is mounted or unmounted.
 StorageVolumeInfo -
-		flash.filesystem - - The StorageVolumeInfo object dispatches a StorageVolumeChangeEvent object when a - - storage volume is mounted or unmounted.
 String -
-		Top Level - - The String class is a data type that represents a string of characters.
 StringTools -
-		flash.globalization - The StringTools class provides locale-sensitive case conversion methods.
 StyleSheet -
-		flash.text - The StyleSheet class lets you create a StyleSheet object that contains text - formatting rules for font size, color, and other styles.
 SWFVersion -
-		flash.display - The SWFVersion class is an enumeration of constant values that indicate the - file format version of a loaded SWF file.
 SyncEvent -
-		flash.events - An SharedObject object representing a remote shared object dispatches a SyncEvent object when the remote - shared object has been updated by the server.
 SyntaxError -
-		Top Level - - A SyntaxError exception is thrown when a parsing error occurs, for one of the following reasons:.
 System -
-		flash.system - - The System class contains properties related to local settings and operations.
 SystemIdleMode -
-		flash.desktop - The SystemIdleMode class provides constant values for system idle behaviors.
 SystemTrayIcon -
-		flash.desktop - The SystemTrayIcon class represents the Windows® taskbar notification - area (system tray)-style icon.
 SystemUpdater -
-		flash.system - The SystemUpdater class allows you to update modules of the Flash Player, - such as the DRM module for Adobe Access, as well as the Flash Player itself.
 SystemUpdaterType -
-		flash.system - The SystemUpdaterType class provides constants for a system update.
 TabAlignment -
-		flash.text.engine -The TabAlignment class is an enumeration of constant values that you can use to set the tabAlignment property -of the TabStop class.
 TabStop -
-		flash.text.engine - The TabStop class represents the properties of a tab stop in a text block.
 Telemetry -
-		flash.profiler - The Telemetry class lets an application profile ActionScript code and register handlers for commands -
 TextBaseline -
-		flash.text.engine -The TextBaseline class is an enumeration of constant values to use in setting the dominantBaseline and -alignmentBaseline properties of the ElementFormat class.
 TextBlock -
-		flash.text.engine - The TextBlock class is a factory for the creation of TextLine objects, which you can - render by placing them on the display list.
 TextColorType -
-		flash.text -The TextColorType class provides color values for the flash.text.TextRenderer class.
 TextDisplayMode -
-		flash.text - The TextDisplayMode class contains values that control the subpixel anti-aliasing of the advanced anti-aliasing system.
 TextElement -
-		flash.text.engine - The TextElement class represents a string of formatted text.
 TextEvent -
-		flash.events - An object dispatches a TextEvent object when a user enters text in a text field or clicks - a hyperlink in an HTML-enabled text field.
 TextExtent -
-		flash.text - The TextExtent class contains information about the extents of some - text in a text field.
 TextField -
-		flash.text - - The TextField class is used to create display objects for text display and input.
 TextFieldAutoSize -
-		flash.text -The TextFieldAutoSize class is an enumeration of constant values used in setting the autoSize -property of the TextField class.
 TextFieldType -
-		flash.text -The TextFieldType class is an enumeration of constant values used in setting the type property -of the TextField class.
 TextFormat -
-		flash.text - The TextFormat class represents character formatting information.
 TextFormatAlign -
-		flash.text - The TextFormatAlign class provides values for text alignment in the TextFormat class.
 TextInteractionMode -
-		flash.text - A class that defines the Interactive mode of a text field object.
 TextJustifier -
-		flash.text.engine - The TextJustifier class is an abstract base class for the justifier types that you can apply to a TextBlock, specifically the - EastAsianJustifier and SpaceJustifier classes.
 TextLine -
-		flash.text.engine - The TextLine class is used to display text on the display list.
 TextLineCreationResult -
-		flash.text.engine -The TextLineCreationResult class is an enumeration of constant values used with TextBlock.textLineCreationResult.
 TextLineMetrics -
-		flash.text - The TextLineMetrics class contains information about the text position and measurements of a - line of text within a text field.
 TextLineMirrorRegion -
-		flash.text.engine - The TextLineMirrorRegion class represents a portion of a text line wherein events are mirrored to another event dispatcher.
 TextLineValidity -
-		flash.text.engine -The TextLineValidity class is an enumeration of constant values for setting the validity property -of the TextLine class.
 TextRenderer -
-		flash.text - The TextRenderer class provides functionality for the advanced anti-aliasing capability of - embedded fonts.
 TextRotation -
-		flash.text.engine -The TextRotation class is an enumeration of constant values used with the following properties: -ElementFormat.textRotation, ContentElement.textRotation, -TextBlock.lineRotation, and TextLine.getAtomTextRotation().
 TextSnapshot -
-		flash.text - TextSnapshot objects let you work with static text in a movie clip.
 Texture -
-		flash.display3D.textures - The Texture class represents a 2-dimensional texture uploaded to a rendering context.
 TextureBase -
-		flash.display3D.textures - The TextureBase class is the base class for Context3D texture objects.
 ThrottleEvent -
-		flash.events - A ThrottleEvent is dispatched when the Flash Player throttles, pauses, or resumes content.
 ThrottleType -
-		flash.events - The ThrottleType class provides values for the playback state property - of the flash.event.ThrottleEvent class.
 Timer -
-		flash.utils - The Timer class is the interface to timers, which let you - run code on a specified time sequence.
 TimerEvent -
-		flash.events - A Timer object dispatches a TimerEvent objects whenever the Timer object reaches the interval - specified by the Timer.delay property.
 TimeZone -
-		Top Level - - The TimeZone class provides information about timezones that can be used in date calculations - - and to find out about different locations and their time zone offsets.
 TouchEvent -
-		flash.events - The TouchEvent class lets you handle events on devices that detect user contact with - the device (such as a finger on a touch screen).
 TouchEventIntent -
-		flash.events - The TouchEventIntent class defines constants for the touchIntent property of the TouchEvent class.
 TouchscreenType -
-		flash.system - The TouchscreenType class is an enumeration class that provides values for the different types of touch screens.
 Transform -
-		flash.geom - The Transform class provides access to color adjustment properties and two- or three-dimensional - transformation objects that can be applied to a display object.
 TransformGestureEvent -
-		flash.events - The TransformGestureEvent class lets you handle complex movement input events (such as moving fingers across a touch screen) - that the device or operating system interprets as a gesture.
 TriangleCulling -
-		flash.display - Defines codes for culling algorithms that determine which triangles not to render when drawing triangle paths.
 TypeError -
-		Top Level - - A TypeError exception is thrown when the actual type of an operand is different - - from the expected type.
 TypographicCase -
-		flash.text.engine -The TypographicCase class is an enumeration of constant values for setting the typographicCase property -of the ElementFormat class.
 uint -
-		Top Level - - The uint class provides methods for working with a data type representing a 32-bit unsigned integer.
 UncaughtErrorEvent -
-		flash.events - An UncaughtErrorEvent object is dispatched by an instance of the UncaughtErrorEvents - class when an uncaught error occurs.
 UncaughtErrorEvents -
-		flash.events - The UncaughtErrorEvents class provides a way to receive uncaught - error events.
 UpdateEvent -
-		air.update.events - - A UpdateEvent is dispatched by a ApplicationUpdater object during the update process.
 Updater -
-		flash.desktop - The Updater class is used to update the currently running application - with a different version.
 URIError -
-		Top Level - - A URIError exception is thrown when one of the global URI handling functions is used - - in a way that is incompatible with its definition.
 URLLoader -
-		flash.net - - The URLLoader class downloads data from a URL - - as text, binary data, or URL-encoded variables.
 URLLoaderDataFormat -
-		flash.net - The URLLoaderDataFormat class provides values that specify how downloaded data is received.
 URLRequest -
-		flash.net - The URLRequest class captures all of the information in a single HTTP request.
 URLRequestDefaults -
-		flash.net - The URLRequestDefaults class includes static properties that you can set to define - default values for the properties of the URLRequest class.
 URLRequestHeader -
-		flash.net - A URLRequestHeader object encapsulates a single HTTP request header - and consists of a name/value pair.
 URLRequestMethod -
-		flash.net - The URLRequestMethod class provides values that specify whether the URLRequest object should - use the POST method or the GET method when sending data to a server.
 URLStream -
-		flash.net - - The URLStream class provides low-level access to - - downloading URLs.
 URLVariables -
-		flash.net - The URLVariables class allows you to transfer - variables between an application and a - server.
 Utils3D -
-		flash.geom - The Utils3D class contains static methods that simplify the implementation of certain three-dimensional - matrix operations.
 Vector -
-		Top Level - The Vector class lets you access and manipulate a vector — an array whose elements - all have the same data type.
 Vector3D -
-		flash.geom - The Vector3D class represents a point or a location in the three-dimensional space using the - Cartesian coordinates x, y, and z.
 VerifyError -
-		Top Level - - The VerifyError class represents an error that occurs when a malformed - - or corrupted SWF file is encountered.
 VertexBuffer3D -
-		flash.display3D - - The VertexBuffer3D class represents a set of vertex data uploaded to a rendering context.
 Video -
-		flash.media - - The Video class displays live or recorded video in an application - without embedding the video in your SWF file.
 VideoCodec -
-		flash.media - The VideoCodec class is an enumeration of constant values of supported video codecs.
 VideoEvent -
-		flash.events -

This event class reports the current video rendering status.

 VideoStatus -
-		flash.media - This class defines an enumeration that describes possible levels of video decoding.
 VideoStreamSettings -
-		flash.media - The VideoStreamSettings class enables specifying video compression settings for each NetStream.
 VideoTexture -
-		flash.display3D.textures - Prior to Flash Player 21, the use of video in Stage3D required the use of the Video object - (which is not hardware accelerated), copying of video frame to a BitmapData object, - and loading of the data onto the GPU which is CPU intensive.
 VideoTextureEvent -
-		flash.events - Almost exactly StageVideoEvent.
 VoucherAccessInfo -
-		flash.net.drm - A VoucherAccessInfo object presents the information that is required - to successfully retrieve and consume a voucher, such as the type - of authentication and the content domain of the media rights server.
 VsyncStateChangeAvailabilityEvent -
-		flash.events - The Stage class dispatches VsyncStateChangeAvailabilityEvent when the availablity of Stage for changing vsync state changes.
 WebSocket -
-		air.net - - The WebSocket class is a utility that encapsulates a normal Socket object - - and implements the WebSocket protocol (RFC 6455).
 WebSocketEvent -
-		flash.events - - An event that contains data received from a WebSocket object.
 WebViewDrawEvent -
-		flash.events - A WebViewDrawEvent object is dispatched when a StageWebView object has completed some asynchronous - draw event.
 Worker -
-		flash.system - A Worker object represents a worker, which is a virtual instance of the - Flash runtime.
 WorkerDomain -
-		flash.system - The WorkerDomain class provides a way to create Worker objects and access - them.
 WorkerState -
-		flash.system - This class defines constants that represent the possible values of the - Worker class's state property.
 X500DistinguishedName -
-		flash.security - The X500DistinguishedName class defines Distinguished Name (DN) properties for use in the - X509Certificate class.
 X509Certificate -
-		flash.security - The X509Certificate class represents an X.509 certificate.
 XML -
-		Top Level - - The XML class contains methods and properties for working with XML objects.
 XMLDocument -
-		flash.xml - The XMLDocument class represents the legacy XML object - that was present in ActionScript 2.0.
 XMLList -
-		Top Level - - The XMLList class contains methods for working with one or more XML elements.
 XMLNode -
-		flash.xml - The XMLNode class represents the legacy XML object - that was present in ActionScript 2.0 and that was renamed in ActionScript 3.0.
 XMLNodeType -
-		flash.xml - The XMLNodeType class contains constants used with - XMLNode.nodeType.
 XMLSignatureValidator -
-		flash.security - The XMLSignatureValidator class validates whether an XML - signature file is well formed, unmodified, and, optionally, whether - it is signed using a key linked to a trusted digital certificate.
 XMLSocket -
-		flash.net - The XMLSocket class implements client sockets that let the - Flash Player or AIR application communicate - with a server computer identified by an IP address or domain name.
 ZipArchive -
-		air.utils - - The ZipArchive class is used to represent a zipped-up set of files in memory.
 ZipEntry -
-		air.utils - - The ZipEntry class is used to represent a single file within a zip archive.
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/compilerErrors.html b/html-docs/compilerErrors.html deleted file mode 100644 index de97268..0000000 --- a/html-docs/compilerErrors.html +++ /dev/null @@ -1,1073 +0,0 @@ - - - - - -Compiler Errors (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
-

The following is a list of compilation errors that the compiler generates when it encounters invalid code. A subset of these errors is detected only when compiling code in strict mode. - Strict mode adds three constraints not found in the standard language: -

-

    -
  • Expressions have static types and type errors are verification errors.
    • -
  • Additional verification rules catch common programming errors.
    • -
  • Verification errors are reported ahead of time. These are the verification errors that occur only in strict mode:
    • -
      -
    • Function call signature matching, which checks the number of parameters supplied and their types.
      • -
    • Duplicate definition conflicts.
      • -
    • Unbound references, which occur when accessing methods or properties that are not defined at compile time.
      • -
    • Dynamically adding properties on sealed objects.
      • -
    • Writing to constant variables.
      • -
    • Deleting fixed properties.
      • -
    • Comparison expressions that use incompatible types.
      • -
    • Unfound packages.
      • -
-

-

-See also -

-
-Compiler Warnings -
-Run-Time Errors -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 CodeMessageDescription
 1000Ambiguous reference to _. - - - - A reference might be to more than one item. For example, the following uses the namespaces rss and xml, each of which defines a - different value for the hello() function. The - trace(hello()) statement returns this error because it cannot determine which namespace to use. - -
private namespace rss;
-private namespace xml;
-    
-public function ErrorExamples() {
-  	use namespace rss;
-   	use namespace xml;
-	trace(hello());
-}
-    
-rss function hello():String {
-      	return "hola";
-    }
-    
-    xml function hello():String {
-        return "foo";
-    }
- - -

Correct an ambiguous reference by making the reference specific. The following example uses the form namespace::function to specify - which namespace to use:

- - -
public function ErrorExamples() {
-    
-    trace(rss::hello());
-    trace(xml::hello());
-}
- - -
 1003Access specifiers are not allowed with namespace attributes. - You can not use both an access specifier (such as private or public) and a namespace attribute on a definition.
 1004Namespace was not found or is not a compile-time constant. - - - The namespace is either unknown or is an expression that could have different values at run time. - Check that you are spelling the namespace correctly and that its definition is imported correctly.
 1006A super expression can be used only inside class instance methods. 
 1007A super statement can be used only inside class instance constructors. - - You cannot use the super statement within static members. You can - use the super statement only within class instances. - -
 1008Attribute is invalid. 
 1010The override attribute may be used only on class property definitions. - - You cannot use the override keyword within a function block. -
 1011The virtual attribute may be used only on class property definitions. - - You cannot use the virtual attribute when you declare a property that does not belong to a class - (for example, when you declare a variable within a function block). -
 1012The static attribute may be used only on definitions inside a class. 
 1013The private attribute may be used only on class property definitions. 
 1014The intrinsic attribute is no longer supported. - - ActionScript 3.0 does not support the intrinsic keyword. -
 1016Base class is final. - - The superclass cannot be extended because it is marked - as final. -
 1017The definition of base class _ was not found. 
 1018Duplicate class definition: _. 
 1020Method marked override must override another method. 
 1021Duplicate function definition. - - You cannot declare more than one function with the same identifier name within the same scope. -
 1022Cannot override a final accessor. 
 1023Incompatible override. - A function marked override must exactly match the parameter and return type declaration of the function it is overriding. -It must have the same number of parameters, each of the same type, and declare the same return type. If any of the parameters are optional, that -must match as well. Both functions must use the same access specifier (public, private, and so on) or namespace attribute as well.
 1024Overriding a function that is not marked for override. - - - If a method in a class overrides a method in a base class, you must explicitly declare it by using the override attribute, as this example shows: - - 
public override function foo():void{};
- -
 1025Cannot redefine a final method. - - The method cannot be extended because it is marked - as final in the base class. -
 1026Constructor functions must be instance methods. 
 1027Functions cannot be both static and override. 
 1028Functions cannot be both static and virtual. 
 1029Functions cannot be both final and virtual. 
 1030Must specify name of variable arguments array. - - - The ...(rest) parameter definition specifies that all values supplied after ...(rest) - are collected into any array. - You must specify a name for the array, as in the expression - function foo(x,...(rest)). - - -
 1033Virtual variables are not supported. 
 1034Variables cannot be native. 
 1035Variables cannot be both final and virtual. 
 1037Packages cannot be nested. 
 1038Target of break statement was not found. 
 1039Target of continue statement was not found. 
 1040Duplicate label definition. 
 1041Attributes are not callable. 
 1042The this keyword can not be used in static methods. It can only be used in instance methods, function closures, and global code. - - - You cannot use the this keyword within a static member, because - this would have no context. - -
 1043Undefined namespace. 
 1044Interface method _ in namespace _ not implemented by class _. 
 1045Interface _ was not found. 
 1046Type was not found or was not a compile-time constant: _. - - - The class used as a type declaration is either unknown or is an expression that could have different values at run time. - Check that you are importing the correct class and that its package location - has not changed. Also, check that the package that contains the code (not the - imported class) is defined correctly (for example, make sure to use proper - ActionScript 3.0 package syntax, and not ActionScript 2.0 syntax). - -

The error can also occur if the class being referenced is not defined in a namespace that is in use or is not defined as public:

- - 
public class Foo{}
- -

If you are using Flex™ Builder™ 2 and the class is in a library, - make sure to set the class path for the project.

- - - -
 1047Parameter initializer unknown or is not a compile-time constant. - - - The value used as the default value for the parameter is either undefined or could have different values at run time. Check that the initializer is spelled - correctly, and that the initializer value isn't an expression that could result in different possible values at run time. -
 1048Method cannot be used as a constructor. - - - It is not possible to create an instance of a method of a class. Only global functions can be used in new expressions. - -
class D { function xx() { return 22; } }
-var d:D = new D();
-var x = new d.xx(); // error, method cannot be used as constructor
-function yy() { this.a = 22; }
-var z = new yy(); // no error, global functions can be used as constructors.
- -
 1049Illegal assignment to a variable specified as constant. 
 1050Cannot assign to a non-reference value. 
 1051Return value must be undefined. - - You are attempting to use the return statement within a method that - has a declared return type void. -
 1052Constant initializer unknown or is not a compile-time constant. - - - The value used to initialize the constant is either undefined or could have different values at run time. Check that the initializer is spelled - correctly, and that the initializer value isn't an expression that could result in different possible values at run time. -
 1053Accessor types must match. 
 1054Return type of a setter definition must be unspecified or void. - - You cannot specify a return value for a setter function. For example, the following is invalid: - - 
public function set gamma(g:Number):Number;
- -

The following is valid:

- - 
public function set gamma(g:Number):void;
-
 1058Property is write-only. 
 1059Property is read-only. - - - This property is defined through a getter function, which allows you to retrieve that property's value. There is no setter function defined - for this property, however, so it is read-only. -

In the following example, line 3 generates an error because there is no setter function defined for xx:

- -
class D { function get xx() { return 22; } }
-var d:D = new D();
-d.xx = 44; // error, property is read-only
-
 1061Call to a possibly undefined method _ through a reference with static type _. - - - You are calling a method that is not defined. -
 1063Unable to open file: _. 
 1064Invalid metadata. - - This metadata is unrecognized. -
 1065Metadata attributes cannot have more than one element. 
 1067Implicit coercion of a value of type _ to an unrelated type _. - - You are attempting to cast an object to a type to which it cannot be converted. This can happen - if the class you are casting to is not in the inheritance chain of the object being cast. - This error appears only when the compiler is running in strict mode. -
 1068Unable to open included file: _. 
 1069Syntax error: definition or directive expected. - - - Check the syntax in the line. -
 1071Syntax error: expected a definition keyword (such as function) after attribute _, not _. - - - This error will occur if the author forgets to use the "var" or "function" keyword in a declaration. -
public int z;// should be 'public var z:int;'
- - This error might also occur when the compiler encounters an unexpected character. For example, - the following use of the trace() function is invalid, because of the missing - parentheses (the correct syntax is trace("hello")): - -
-trace "hello"
-
- -
 1072Syntax error: expecting xml before namespace. - - - The correct statement syntax is default xml namespace = ns. Either the keyword xml (note the lowercase) - is missing or an incorrect keyword was used. For more - information, see the default xml namespace - directive. - -
 1073Syntax error: expecting a catch or a finally clause. 
 1075Syntax error: the 'each' keyword is not allowed without an 'in' operator. 
 1076Syntax error: expecting left parenthesis before the identifier. 
 1077Expecting CaseLabel. - - - The compiler expected a case statement at this point in the switch block. The following switch block incorrectly includes a call to print before the first case statement: - -
switch(x)
-{
-trace(2);
-case 0:  trace(0); 
-break
-}
- -
 1078Label must be a simple identifier. 
 1079A super expression must have one operand. 
 1080Expecting increment or decrement operator. 
 1082Expecting a single expression within parentheses. 
 1083Syntax error: _ is unexpected. - - - - The line of code is missing some information. In the following example, - some expression (such as another number) needs to be included after the final plus sign: - - 
var sum:int = 1 + 2 + ;
- -
 1084Syntax error: expecting _ before _. - - - The expression was unexpected at this point. - If the error says "Expecting right brace before end of program," a block of code - is missing a closing brace (}). - -

If the error says "Expecting left parenthesis before _," you may have omitted a - parenthesis from a conditional expression, as shown in the following example, which is intentionally incorrect:

- - 
var fact:int = 1 * 2 * 3;
-if fact > 2 {
-	var bigger:Boolean = true;
-}
- -
 1086Syntax error: expecting semicolon before _. 
 1087Syntax error: extra characters found after end of program. 
 1093Syntax error. 
 1094Syntax error: A string literal must be terminated before the line break. 
 1095Syntax error: A string literal must be terminated before the line break. 
 1097Syntax error: input ended before reaching the closing quotation mark for a string literal. 
 1099Syntax error. 
 1100Syntax error: XML does not have matching begin and end tags. 
 1102Cannot delete super descendants. 
 1103Duplicate namespace definition. - - - You defined the namespace more than once. Delete or modify the duplicate definition. -
 1105Target of assignment must be a reference value. - - - You can assign a value to a variable, but you cannot assign a value to another value. -
 1106Operand of increment must be a reference. - - The operand must be a variable, an element in an array, or a property of an object. -
 1107Increment operand is invalid. - - - The operand must be a variable, an element in an array, or a property of an object. -
 1108Decrement operand is invalid. - - The operand must be a variable, an element in an array, or a property of an object. -
 1109Expecting an expression. - - - - An expression is missing in a part of the code. For example, the following produces this - error (there is a condition missing from the if statement: - -
var x = (5 > 2) ? 
-trace(x)
- -
 1110Missing XML tag name. 
 1112Possible infinite recursion due to this file include: _. - - - A file that is included in the source being compiled contains other include statements that would cause an infinite loop. For example, the following files. a.as and b.as, generate this error because each file tries to include the other. -

- File a.as contains the following, which attempts to include the file b.as:

-
import foo.bar.baz;
-include "b.as"
-trace(2);
-

File b.as contains the following, which attempts to include the file a.as:

- 
include "a.as"
- -
 1113Circular type reference was detected in _. - - A class is trying to extend a superclass. For example, class A cannot extend class B if B inherits from A: -
class a extends b { }
-class b extends a { }
-
 1114The public attribute can only be used inside a package. 
 1115The internal attribute can only be used inside a package. 
 1116A user-defined namespace attribute can only be used at the top level of a class definition. 
 1118Implicit coercion of a value with static type _ to a possibly unrelated type _. - You are using a value that is not of the expected type and no implicit coercion exists to convert it to the expected type. -

Perhaps you are using a supertype where a subtype is expected. For example:

-
class A {}
-var a:A = new A(); 
-class B extends A { function f() }
-var b : B = a // error
-

The last statement generates an error because it attempts to assign an object of type A to a variable of type B.

-

Similarly, the following defines the foo() function, which takes a parameter of type B. The statement foo(a); - generates an error because it attempts to use a parameter of type A:

-
function foo(x:B) { }
-foo(a);
-

Also, the following statement generates an error because the returned value for foo2() must be type B:

- 
function foo2():B { return new A(); }
-
 1119Access of possibly undefined property _ through a reference with static type _. - - - - - You are attempting to access a property that does not exist for the specified object. For example, - the following code generates this error because an int object does not have a property named - assortment: - -
var i:int = 44;
-var str:String = i.assortment;
- - This error appears only when the compiler is running in strict mode. - -
 1120Access of undefined property _. - - - - You are attempting to access an undefined variable. For example, if the variable - huh has not been defined, a call to it generates this error: - -
huh = 55;
- - This error can appear only when the compiler is running in strict mode. - -
 1121A getter definition must have no parameters. 
 1122A setter definition must have exactly one parameter. 
 1123A setter definition cannot have optional parameters. 
 1124Return type of a getter definition must not be void. - - - A getter function simulates a variable. Because variables cannot be of type void, you cannot declare getter functions to return type void. -
 1125Methods defined in an interface must not have a body. 
 1126Function does not have a body. 
 1127Attribute _ was specified multiple times. - - - You specified an attribute more than once in the same statement. For example, the statement public static public var x; generates - this error because it specifies that the variable x is public twice. Delete duplicate declarations. -
 1129Duplicate interface definition: _. - - - Change or delete the duplicate definitions. -
 1130A constructor cannot specify a return type. 
 1131Classes must not be nested. 
 1132The attribute final can only be used on a method defined in a class. 
 1133The native attribute can only be used with function definitions. 
 1134The dynamic attribute can only be used with class definitions. 
 1135Syntax error: _ is not a valid type. 
 1136Incorrect number of arguments. Expected _. - - - The function expects a different number of arguments than those you provided. For example, the following defines function goo, which has two arguments: -
class A { static function goo(x:int,y:int) 
-{ return(x+y); } }
-

The following statement would generate an error because it provides three arguments:

-
A.goo(1,2,3);
-
 1137Incorrect number of arguments. Expected no more than _. 
 1138Required parameters are not permitted after optional parameters. 
 1139Variable declarations are not permitted in interfaces. 
 1140Parameters specified after the ...rest parameter definition keyword can only be an Array data type. 
 1141A class can only extend another class, not an interface. 
 1142An interface can only extend other interfaces, but _ is a class. - - You are attempting to have the interface extend a class. An interface can only extend another interface. -
 1143The override attribute can only be used on a method defined in a class. 
 1144Interface method _ in namespace _ is implemented with an incompatible signature in class _. - - - Method signatures must match exactly. -
 1145Native methods cannot have a body. - - You cannot use native because it is a reserved keyword. -
 1146A constructor cannot be a getter or setter method. 
 1147An AS source file was not specified. 
 1149The return statement cannot be used in static initialization code. 
 1150The protected attribute can only be used on class property definitions. 
 1151A conflict exists with definition _ in namespace _. - - - You cannot declare more than one variable with the same identifier name within the same scope unless all such variables are declared to be of - the same type. In ActionScript 3.0, different code blocks (such as those used in two for loops in the same function definition) are considered to be in the same scope. -

The following code example correctly casts the variable x as the same type:

-
function test()
-{
-	var x:int = 3;
-	for(var x:int = 33; x < 55; x++)
-	trace(x);
-	for(var x:int = 11; x < 33; x++)
-	trace(x)
-}
-

The following code example generates an error because the type casting in the variable declaration and the for loops are different:

-
function test()
-{
-	var x:String = "The answer is";
-	for(var x:int = 33; x < 55; x++) // error
-	trace(x);
-	for(var x:unit = 11; x < 33; x++) // error
-	trace(x)
-}
-
 1152 A conflict exists with inherited definition _ in namespace _. 
 1153A constructor can only be declared public. 
 1154Only one of public, private, protected, or internal can be specified on a definition. 
 1155Accessors cannot be nested inside other functions. 
 1156Interfaces cannot be instantiated with the new operator. 
 1157Interface members cannot be declared public, private, protected, or internal. 
 1158Syntax error: missing left brace ({) before the function body. 
 1159The return statement cannot be used in package initialization code. 
 1160The native attribute cannot be used in interface definitions. - - You cannot use native because it is a reserved keyword. -
 1162Only one namespace attribute can be used per definition. 
 1163Method _ conflicts with definition inherited from interface _. 
 1165Interface attribute _ is invalid. 
 1166Namespace declarations are not permitted in interfaces. 
 1167Class _ implements interface _ multiple times. - - - The class implements the same interface more than once. For example, the following generates this error because - class C implements interface A twice: - -
interface A {  public function f();  };
-class C implements A,A {
-public function f() { trace("f"); }
-}
- -

The correct implementing statement should be class C implements A {.

-
 1168Illegal assignment to function _. - - - You are attempting to redefine a function. For example, the following defines the function topLevel() - to print the word "top". The second statement generates an error because it assigns a different return value to the function: -
function topLevel() { trace("top"); }
-topLevel = function() { trace("replacement works in ~");} // error
-
 1169Namespace attributes are not permitted on interface methods. 
 1170Function does not return a value. - - - Every possible control flow in a function must return a value whenever the return type is something other than void. The following function - f(x) does not generate an error because the if..else statement always returns a value: - -
function f(x):int
-{
-if (x)
-    	return 2;
-else
-    	return 3;
-} // no error
- -

However, the function g(x) below generates the error because the switch statement does not always -return a value.

-
function g(x:int):int
-{
-switch(x)
-{
-      	case 1: return 1;
-      	case 2: return 2:
-}
-// return 2;//uncomment to remove the error
-}
- -

This checking is enabled only when the function declares a return type other than void.

-
 1171A namespace initializer must be either a literal string or another namespace. 
 1172Definition _ could not be found. 
 1173Label definition is invalid. 
 1176Comparison between a value with static type _ and a possibly unrelated type _. -This error is enabled in strict mode.
 1177The return statement cannot be used in global initialization code. 
 1178Attempted access of inaccessible property _ through a reference with static type _. 
 1180Call to a possibly undefined method _. -This error appears only when the compiler is running in strict mode.
 1181Forward reference to base class _. 
 1182Package cannot be used as a value: _. 
 1184Incompatible default value of type _ where _ is expected. 
 1185The switch has more than one default, but only one default is allowed. 
 1188Illegal assignment to class _. 
 1189Attempt to delete the fixed property _. Only dynamically defined properties can be deleted. -Delete removes dynamically defined properties from an object. Declared properties of a class can not be deleted. This error appears only when the compiler is running in strict mode.
 1190Base class was not found or is not a compile-time constant. 
 1191Interface was not found or is not a compile-time constant. 
 1192The static attribute is not allowed on namespace definitions. 
 1193Interface definitions must not be nested within class or other interface definitions. 
 1194The prototype attribute is invalid. 
 1195Attempted access of inaccessible method _ through a reference with static type _. - You are either calling a private method from another class, or calling a method defined in a namespace that is not in use. If you are calling a method defined in an unused namespace, add a use statement for the required namespace. -
 1196Syntax error: expecting an expression after the throw. 
 1197The class _ cannot extend _ since both are associated with library symbols or the main timeline. 
 1198Attributes are not allowed on package definition. 
 1199Internal error: _. 
 1200Syntax error: invalid for-in initializer, only 1 expression expected. 
 1201A super statement cannot occur after a this, super, return, or throw statement. 
 1202Access of undefined property _ in package _. - - - - You are attempting to access an undefined variable in a package. For example, if the variable - p.huh has not been defined, a call to it generates this error: - -
p.huh = 55;
- - This error can only appear when the compiler is running in strict mode. - -
 1203No default constructor found in base class _. - You must explicitly call the constructor of the base class with a super() statement if it has 1 or more required arguments.
 1204/* found without matching */ . - - - The characters '/*' where found, which indicate the beginning of a comment, but the corresponding characters, '*/', which indicate the end of the comment block, were not found. -
 1205Syntax Error: expecting a left brace({)or string literal(""). 
 1206A super statement can be used only as the last item in a constructor initializer list. - - You cannot use the super statement within a constructor. You can - use the super statement only as the last item in the constructor initializer list. - -
 1207The this keyword can not be used in property initializers. - - - You cannot use the this keyword within a property initializer. - -
 1208The initializer for a configuration value must be a compile time constant. - - - The initializer of a configuration value must be a value known at compile time. The initializer may be a constant string, number, or boolean, or - a reference to another previously defined configuration value. - -
 1209A configuration variable may only be declared const. - - - When defining a configuration variable, it must be declared as const. - -
 1210A configuration value must be declared at the top level of a program or package. - - - A configuration value must be declared at the top level of a program or package. - -
 1211Namespace _ conflicts with a configuration namespace. - - - A namespace may not have the same name as a configuration namespace. - -
 1212Precision must be an integer between 1 and 34. 
 1214Incompatible Version: can not reference definition _ introduced in version _ from code with version _. 
 1215Invalid initialization: conversion to type _ loses data. 
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:01 AM GMT+01:00
Creative Commons License
-
-
- - diff --git a/html-docs/compilerWarnings.html b/html-docs/compilerWarnings.html deleted file mode 100644 index d48f2dc..0000000 --- a/html-docs/compilerWarnings.html +++ /dev/null @@ -1,463 +0,0 @@ - - - - - -Compiler Warnings (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
-

Compiler warning messages identify code that is valid and compiles successfully, but - may not be what the author intended. To enable detecting these possible problems, compile ActionScript projects in warning mode. - -

Some of these warnings (for example, "Missing type declaration.") are coding style choices that you have the option whether to enforce. - Others (for example, "Impossible assignment to null.") point out statements that are valid, but are unlikely to behave as the user - expects. A third class of warnings covers issues you may encounter when porting ActionScript 2.0 code to ActionScript 3.0.

- -

-

-See also -

-
-Compiler Errors -
-Run-Time Errors -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 CodeMessageDescription
 1009_ '_' has no type declaration. - - - - Not declaring a data type is a coding style preference. A function return type, parameter, or variable has no type declaration. - However, using type declarations enables the compiler to write more efficient code, as well as detect more errors at compile time. - Enable this warning if you want to be reminded when you fail to use a type declaration. - -
 1013Variables of type _ cannot be undefined. The value undefined will be type coerced to _ before comparison. - - - Only variables of type * can be undefined. With a few exceptions, uninitialized variables have a default value of null rather than undefined. - The exceptions include: Boolean variables, which have a default value of false. Number variables, which have a default value of NaN, and int or uint variables, which have a default value of 0. - -
 1031Migration issue: Result of new _ will be the return value of _, rather than a new instance of that function. - - - This is a code migration warning. The detected code behaves differently in ActionScript 3.0 than in ActionScript 2.0, as shown in the following example: -
function f(){
-   this.b = 22;
-   this.a = new Array(2);Â  
-   this.a[0] = 33;
-   this.a[1] = 44;
-   return a; 
-   } 
-   // returns a new instance of f in ActionScript 2.0 and a new 2 element array in ActionScript 3.0
-   var d = new f();Â  // Warning here
-   trace(d.a);       // undefined in ActionScript 3.0, [33,44] in ActionScript 2.0.
-
- -
 1035Use of Boolean() with no arguments. - - - This is a code migration warning. The Boolean() function returns false in ActionScript 3.0, but undefined in ActionScript 2.0. - -
 1039Migration issue: When the Number('') function is called with an empty string argument it returns 0 in ActionScript 3.0, and NaN in ActionScript 2.0. - - - This is a code migration warning. The Number() method called with a String argument skips over all white space in the string and return a default value of 0 if no digits are detected. -In ActionScript 2.0, any white space in the string causes the result to be NaN. - -
 1045Migration issue: Array.toString() handling of null and undefined elements has changed. - - - This is a code migration warning. In ActionScript 2.0, null array elements convert to null and undefined elements convert to undefined. -In ActionScript 3.0, both null and undefined elements convert to the empty string ''. If you have code that parses the toString() output from an Array, -you may need to adjust your code for this difference. - -
 1059Migration issue: The property _ is no longer supported. _. - - - This is a code migration warning. The property you are attempting to use does not exist in ActionScript 3.0. - -
 1061Migration issue: The method _ is no longer supported. _. - - - This is a code migration warning. The method you are attempting to use does not exist in ActionScript 3.0. - -
 1066__resolve is no longer supported. 
 1067Migration issue: __resolve is no longer supported. Use the new Proxy class for similar functionality. - - - This is a code migration warning. See Proxy in this language reference for more information on the replacement for __resolve. - -
 1071Migration issue: _level is no longer supported. For more information, see the flash.display package. - - - This is a code migration warning. The property you are attempting to use does not exist in ActionScript 3.0. - -
 1073Migration issue: _ is not a dynamic class. Instances cannot have members added to them dynamically. - - - This is a code migration warning. In ActionScript 2.0, many classes such as Number are dynamic, which means that new properties can -be added to instances of those classes at run time. This warning results from code that tries to add a property to an instance of a non-dynamic class. - -
 1083Migration issue: Method _ will behave differently in ActionScript 3.0 due to the change in scoping for the this keyword. See the entry for warning 1083 for additional information. - - - This is a code migration warning. This warning is generated when a method of an object is used as a value, usually as a callback function. - In ActionScript 2.0, functions are executed in the context they are called from. In ActionScript 3.0, functions are always - executed in the context where they were defined. Thus, variable and method names are resolved to the class that the callback is part of, rather - than relative to the context it is called from, as in the following example: - -
class a 
-{ 
-   var x; 
-   function a() { x = 1; } 
-   function b() { trace(x); } 
-}
-
-var A:a = new a();
-var f:Function = a.b; // warning triggered here
-var x = 22;
-f(); // prints 1 in ActionScript 3.0, 22 in ActionScript 2.0
-
 1085_ will be scoped to the default namespace: _ internal. It will not be visible outside of this package. - - - Not declaring a namespace is a coding style preference. Enable this warning if you want to be reminded when you forget to declare a namespace or access specifier for a definition. - Without one, the definition is not visible to code located outside of this file. To make it visible to code outside this file, declare it with the access specifier public or with - a namespace declaration. To keep the definition local to this file and avoid this warning, declare the definition as private. - -
 1087Migration issue: ActionScript 3.0 iterates over an object's properties within a "for x in target" statement in random order. - - - This is a code migration warning. In ActionScript 2.0, the order in which the properties of an object were processed was always the same. -In ActionScript 3.0, the order is random and can change from machine to machine. If unexpected ordering behavior occurs, inspect this loop to determine if this change in behavior may affect your code. - -
 1089Error code: _. - - - This is due to either a corrupt source file or a bug in the compiler code. Please contact Adobe, Inc. to file a bug. - -
 1091Migration issue: _ - - - This is a code migration warning. In ActionScript 2.0 declaring a method by a special name (such as onMouseDown) would cause Flash to -call that method when a certain event occurred. In ActionScript 3.0, you must call addEventListener() with a method in order to register it to -receive that event. See addEventListener in this language reference for details. - -
 1093Negative value used where a uint (non-negative) value is expected. - - - Assigning a negative value to a uint data type results in an extremely large positive value. var x:uint = -1; trace(x); // 4294967295. - -
 1097Illogical comparison with null. Variables of type _ cannot be null. - - - Instances of Boolean, int, uint, and Number cannot be null. The comparison operator type converts null to false before -comparing it to a Boolean, or to 0 before comparing it with a Number, int, or uint data type. - -
 1099Illogical comparison with NaN. This statement always evaluates to false. - - - NaN has the unique mathematical property that any comparison involving it evaluates to false. Use the global isNaN() function to detect a NaN value instead, as in the following example: -
trace(NaN == NaN); // false!
-trace(NaN != NaN); // false again!
-trace(isNaN(NaN)); // true
-
-
 1101Assignment within conditional. Did you mean == instead of =? - - - - The result of an = assignment statement is the value of the right-hand side of the = statement. - You can use an assignment statement as a conditional test, but it is not recommended. - It usually is the result of a typo where a == equality test was intended, as the following example shows: -
var x:Boolean = false;
-var y:Boolean = true;
-// it is hard to determine if the line below intentionally sets x's value to y's or if its a typo
-if (x = y) { trace("x is assigned y's value of true, making the conditional test evaluate as true."); }
-
-
 1103null used where a _ value was expected. - - - Boolean, Number, int, and uint variables cannot be assigned null as a value. The null value is implicitly cast to false when assigned to a Boolean, and to 0 when assigned to an int, uint, or Number. - -
 1105No constructor function was specified for class _. - - - Not specifying a constructor function is a coding style preference. Enable this warning if you want to always declare constructors for classes. -This warning is intended to help find cases where a class name is changed but its constructor's name is not. -Conditions such as this are not flagged as a problem without this warning, the former constructor appears to be a normal function. - -
 1107Empty statement found where block of code expected. Did you type ';' accidentally? - - - It is common to accidentally type ; before block of code. -
 if (x == y);
-{
-	trace("This code will be executed no matter what are the x and y values.")
-}
-
- -
 1111The constant was not initialized. 
 1113Array(x) behaves the same as new Array(x). To cast a value to type Array use the expression x as Array instead of Array(x). 
 1115The super() statement will be executed prior to entering this constructor. Add a call to super() within the constructor if you want to explicitly control when it is executed. - - - Adding a call to super() within the constructor is a coding style preference. Enable this warning if you want to always be explicit about when super() is called. -This can help catch cases where you meant to call super() after some local initialization code and forgot to add it. - -
 3552Appending text to a TextField using += is many times slower than using the TextField.appendText() method. - - - See this language reference for the appendText() method of the TextField class for details on this significant text optimization. - -
 3554Function value used where type _ was expected. Possibly the parentheses () are missing after this function reference. - -You can use functions themselves as values in ActionScript. The code in question is using a value of type Function where a type other than Function, Object, or * is expected. Usually, -this indicates a typo where the parentheses () were omitted after the function name. -
 3556The instanceof operator is deprecated, use the is operator instead. 
 3574Migration issue: The ActionScript 2.0 XML class has been renamed XMLDocument. - - - This is a code migration warning. XML is a different class in ActionScript 3.0 than it was in ActionScript 2.0. In ActionScript 3.0, the XMLDocument class is the equivalent of the XML class in ActionScript 2.0. -The ActionScript 3.0 XML class offers improved functionality with an easier and more powerful API. See XML in the ActionScript Language Reference for additional details. - -
 3576Date(x) behaves the same as new Date().toString(). To cast a value to type Date use "x as Date" instead of Date(x). 
 3582Importing a package by the same name as the current class will hide that class identifier in this scope. 
 3584More than one argument named '_' specified. References to that argument will always resolve to the last one. 
 3590Non-Boolean value used where a Boolean value was expected. 
 3591_ used where a Boolean value was expected. The expression will be type coerced to Boolean. 
 3593_ is not a recognized property of the dynamic class _. - - - The strict compilation mode does not check for undefined properties on instances of dynamic classes. The types Date, RegExp, and Error are -dynamic for backwards compatibility with ECMAScript. This warning finds usages of undefined properties on instances of those classes. -A common problem is attempting to get or set a non-existent year property on a Date value. The correct property name is fullYear. - -
 3595_ is not a recognized method of the dynamic class _. - - - The strict compilation mode does not check for undefined methods on instances of dynamic classes. The types Date, RegExp, and Error are -dynamic for backwards compatibility with ECMAScript. This warning finds usages of undefined methods on instances of those classes. - -
 3597Duplicate variable definition. - - - The compiler has detected a duplicate definition for a variable. This can lead to unexpected results. ActionScript does not support block level - scoping of variables. All variables defined within a function body exist within the same scope, even if they are defined within an - if statement, while statement, for statement, and so on: for example, the following code redeclares the variable x twice: - - 

-function test() {
-	var x:Number = 10;
-	if (true) {
-	    for (var x=0; x < 5; x++)  // warning here, this is the second defintion of x
-	    trace(x);
-	}
-	trace(x); // 5, not 10.  The last value set by the for loop above is the current value of x
-}
- -
 3598Definition name is the same as an imported package name. Unqualified references to that name will resolve to the package and not the definition. 
 3599Definition name is the same as an imported package name. Unqualified references to that name will resolve to the package and not the definition. - - - If a definition is named the same as a package that is in scope, then any unqualified references to that name will resolve to the package instead of the definition. This can - result in unexpected errors when attempting to reference the variable. Any references to the definition need to be qualified to resolve to the definition and not the package. - -
 3600Possible attempt to delete a fixed property. 
 3601The declared property _ cannot be deleted. To free associated memory, set its value to null. - Delete removes dynamically defined properties from an object. Declared properties of a class can not be deleted, the operation merely fails silently. To free memory associated with this variable, set its value to null instead.
 3602Use of deprecated definition. 
 3603'_' has been deprecated. - This definition is deprecated and may be removed in the future.
 3604Use of deprecated definition. 
 3605_ -  
 3606Use of deprecated definition. 
 3607'_' has been deprecated. Please use '_'. -  
 3608Use of deprecated definition. 
 3609'_' has been deprecated since _. Please use '_'. -  
 3610Use of deprecated definition. 
 3611'_' has been deprecated since _. -  
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:13 PM GMT+01:00
Creative Commons License
-
-
- - diff --git a/html-docs/conventions.html b/html-docs/conventions.html deleted file mode 100644 index 6987e06..0000000 --- a/html-docs/conventions.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - - -Conventions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- -
- -

This page explains the conventions used in the Adobe Flex 2 Language ReferenceActionScript 3.0 Language and Components Reference.

-

Typographical conventions -

-

This reference uses the following typographical conventions:

-
    -
  • Italic font indicates a value that you replace with a specific value.
    • -
  • Bold font indicates language elements.
    • - -
  • Code font indicates code snippets or language elements in the text.
    • -
  • In ActionScript, double forward slashes (//) precede comments.
    • -
  • In ActionScript, forward slashes and -asterisks (/*... */) denote the beginning and end, respectively, of commented lines.
    • -
  • In MXML, the characters <!-- and --> denote the beginning and end of commented lines, respectively.
    • -
  • Numeric value ranges in code are represented as 0..59.
    • -
-

Note: In code examples, long lines of code may be broken for readability. If an error occurs when you -copy and paste example code, verify that a long line of code does not contain a return.

- -

Presentation of class APIs

-

APIs are presented in typical API documentation format, but with the following modifications -to help you better understand the ActionScript language:

- -
    -
  • The Package entry lists the package to which the class belongs.
    • -
  • The Class entry lists the class and its attributes.
    • -
  • Inheritance information shows the inheritance path and list inherited elements. -Two types of arrow indicate inheritance: -
      -
    • In the Inheritance entry at the top of the class description, a right-hand arrow points to the -superclass that the class inherits from.
      • -
    • In the Public Properties and Public Methods sections, an upward arrow appears to the left of a property or -method inherited from another class.
      • -
    • -
  • The Implements entry lists any interfaces that the class implements.
    • -
  • The Subclasses entry lists any classes that inherit from this class.
    • - -
  • Constructors are listed as the first method in each Public Methods summary; thereafter, the methods -are listed alphabetically.
    • -
- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:13 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/accessibility/Accessibility.html b/html-docs/flash/accessibility/Accessibility.html deleted file mode 100644 index e8ff6c1..0000000 --- a/html-docs/flash/accessibility/Accessibility.html +++ /dev/null @@ -1,518 +0,0 @@ - - - - - - - - -flash.accessibility.Accessibility (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.accessibility
Classpublic final class Accessibility
InheritanceAccessibility Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The Accessibility class manages communication with screen readers. Screen readers are a - type of assistive technology for visually impaired users that provides an audio version of - screen content. The methods of the Accessibility class are static—that is, you don't - have to create an instance of the class to use its methods. -

Mobile Browser Support: This class is not supported in mobile browsers.

-

AIR profile support: This feature is supported on all desktop operating systems, - but is not supported on mobile devices or on AIR for TV devices. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

To get and set accessible properties for a specific object, such as a button, movie - clip, or text field, use the DisplayObject.accessibilityProperties property. - To determine whether the player or runtime is running in an environment that supports accessibility aids, use - the Capabilities.hasAccessibility property.

-

Note: AIR 2 supports the JAWS 11 (or higher) screen reader software. For additional information, - please see http://www.adobe.com/accessibility/.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.DisplayObject.accessibilityProperties -
-flash.system.Capabilities.hasAccessibility -
-Socket -
-http://www.adobe.com/accessibility/ -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
  active : Boolean -
[static][read-only] - Indicates whether a screen reader is active and the application is - communicating with it.
-		Accessibility
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-updateProperties():void -
-
[static] - Tells Flash Player to apply any accessibility changes made by using the DisplayObject.accessibilityProperties property.
-		Accessibility
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
activeproperty
-
-active:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether a screen reader is active and the application is - communicating with it. Use this method when you want your application to behave - differently in the presence of a screen reader. -

Once this property is set to true, it remains true for the duration - of the application. (It is unusual for a user to turn off the screen reader once it is - started.)

- -

Note: Before calling this method, wait 1 or 2 seconds after launching your - AIR application or after the first appearance of the Flash® Player window in which - your document is playing. Otherwise, you might get a return value of false - even if there is an active accessibility client. This happens because of an asynchronous - communication mechanism between accessibility clients and Flash Player or AIR.

- To determine whether the player is running in an environment that supports screen readers, use the - Capabilities.hasAccessibility property. - Implementation -
-    public static function get active():Boolean -
-

-See also -

-
-flash.system.Capabilities.hasAccessibility -
-updateProperties() -
-
- -
Method detail
- - - - - -
updateProperties()method
-
-public static function updateProperties():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Tells Flash Player to apply any accessibility changes made by using the DisplayObject.accessibilityProperties property. - You need to call this method for your changes to take effect. -

If you modify the accessibility properties for multiple objects, only one call to the - Accessibility.updateProperties() method is necessary; multiple calls can result in - reduced performance and erroneous screen reader output.

-
-Throws - - - - -
Error — Accessibility is not supported in this version of - Flash Player. Do not call the Accessibility.updateProperties() method - if the flash.system.Capabilities.hasAccessibility property is false. -
-

-See also -

-
-active -
-flash.display.DisplayObject.accessibilityProperties -
-flash.system.Capabilities.hasAccessibility -
-
- -
Examples
-
examples\AccessibilityExample
-
The following example uses AccessibilityExample, - CustomAccessibleButton, CustomSimpleButton, and - ButtonDisplayState sample classes to create an accessibility-compliant - menu that works with most screen readers. The example carries out the following tasks: -
    -
  1. It traces the Accessibility.active property to determine whether a screen - reader is currently active and the player is communicating with it.
    2. -
  2. If the active property returns true, the example calls the - updateProperties() method to apply the accessibility changes made to the buttons in - this example.
    3. -
  3. The example calls the flash.utils.setTimeout() method, specifying that the updateAccessibility() closure method - should be called after 2 seconds.
    4. -
- -

Note: Call setTimeout() before checking Accessibility.active - to give Flash Player the 2 seconds it needs to connect to a screen reader if one is available. - If you do not supply a sufficient delay time, the setTimeout call might return false even if a screen reader is available. -

- -

The following example processes the Accessibility.updateProperties() - method only if the call to Accessibility.active returns true, which occurs - only if Flash Player is currently connected to an active screen reader. If updateProperties - is called without an active screen reader, it throws an IllegalOperationError exception.

-
-
-package {
-	import flash.display.Sprite;
-	import flash.accessibility.Accessibility;
-	import flash.utils.setTimeout;
-	
-	public class AccessibilityExample extends Sprite {
-		public static const BUTTON_WIDTH:uint = 90;
-		public static const BUTTON_HEIGHT:uint = 20;
-		
-		private var gutter:uint = 5;
-		private var menuLabels:Array = new Array("PROJECTS", "PORTFOLIO", "CONTACT");
-		private var menuDescriptions:Array = new Array("Learn more about our projects"
-													 , "See our portfolio"
-													 , "Get in touch with our team");
-		
-		public function AccessibilityExample() {
-			configureAssets();
-			setTimeout(updateAccessibility, 2000); 
-		}
-		
-		private function updateAccessibility():void {
-			trace("Accessibility.active: " + Accessibility.active);
-			if(Accessibility.active) {
-				Accessibility.updateProperties();
-			}
-		}
-		
-		private function configureAssets():void {
-			var child:CustomAccessibleButton;
-			for(var i:uint; i < menuLabels.length; i++) {
-				child = new CustomAccessibleButton();
-				child.y = (numChildren * (BUTTON_HEIGHT + gutter));
-				child.setLabel(menuLabels[i]);
-				child.setDescription(menuDescriptions[i]);
-				addChild(child);
-			}
-		}
-	}
-}
-	
-import flash.accessibility.AccessibilityProperties;
-import flash.display.Shape;
-import flash.display.SimpleButton;
-import flash.display.Sprite;
-import flash.events.Event;
-import flash.text.TextFormat;
-import flash.text.TextField;
-
-
-class CustomAccessibleButton extends Sprite {
-	private var button:SimpleButton;
-	private var label:TextField;
-	private var description:String;
-	private var _name:String;
-		
-	public function CustomAccessibleButton(_width:uint = 0, _height:uint = 0) {
-		_width = (_width == 0) ? AccessibilityExample.BUTTON_WIDTH : _width;
-		_height = (_height == 0) ? AccessibilityExample.BUTTON_HEIGHT : _height;
-		
-		button = buildButton(_width, _height);
-		label = buildLabel(_width, _height);
-			
-		addEventListener(Event.ADDED, addedHandler);
-	}
-		
-	private function addedHandler(event:Event):void {
-		trace("addedHandler: " + this._name);
-		var accessProps:AccessibilityProperties = new AccessibilityProperties();
-		accessProps.name = this._name;
-		accessProps.description = description;
-		accessibilityProperties = accessProps;
-		removeEventListener(Event.ADDED, addedHandler);
-	}
-		
-	private function buildButton(_width:uint, _height:uint):SimpleButton {
-		var child:SimpleButton = new CustomSimpleButton(_width, _height);
-		addChild(child);
-		return child;
-	}
-
-	private function buildLabel(_width:uint, _height:uint):TextField {
-		var format:TextFormat = new TextFormat();
-		format.font = "Verdana";
-		format.size = 11;
-		format.color = 0xFFFFFF;
-		format.align = TextFormatAlign.CENTER;
-		format.bold = true;
-		
-		var child:TextField = new TextField();
-		child.y = 1;
-		child.width = _width;
-		child.height = _height;
-		child.selectable = false;
-		child.defaultTextFormat = format;
-		child.mouseEnabled = false;
-			
-		addChild(child);
-		return child;
-	}
-		
-	public function setLabel(text:String):void {
-		label.text = text;
-		this._name = text;
-	}
-		
-	public function setDescription(text:String):void {
-		description = text;
-	}
-}
-	
-class CustomSimpleButton extends SimpleButton {
-	private var upColor:uint = 0xFFCC00;
-	private var overColor:uint = 0xCCFF00;
-	private var downColor:uint = 0x00CCFF;
-
-	public function CustomSimpleButton(_width:uint, _height:uint) {
-		downState = new ButtonDisplayState(downColor, _width, _height);
-		overState = new ButtonDisplayState(overColor, _width, _height);
-		upState = new ButtonDisplayState(upColor, _width, _height);
-		hitTestState = new ButtonDisplayState(upColor, _width, _height);
-		useHandCursor = true;
-	}		
-}
-
-class ButtonDisplayState extends Shape {
-	private var bgColor:uint;
-	private var _width:uint;
-	private var _height:uint;
-
-	public function ButtonDisplayState(bgColor:uint, _width:uint, _height:uint) {
-		this.bgColor = bgColor;
-		this._width = _width;
-		this._height = _height;
-		draw();
-	}
-
-	private function draw():void {
-		graphics.beginFill(bgColor);
-		graphics.drawRect(0, 0, _width, _height);
-		graphics.endFill();
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/accessibility/AccessibilityImplementation.html b/html-docs/flash/accessibility/AccessibilityImplementation.html deleted file mode 100644 index 82c29f5..0000000 --- a/html-docs/flash/accessibility/AccessibilityImplementation.html +++ /dev/null @@ -1,1243 +0,0 @@ - - - - - - - - -flash.accessibility.AccessibilityImplementation (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.accessibility
Classpublic class AccessibilityImplementation
InheritanceAccessibilityImplementation Inheritance Object
-

- - - - -
Runtime version: AIR 2 -
-

-

- - The AccessibilityImplementation class is the base class in Flash Player - that allows for the implementation of accessibility in components. - This class enables communication between a component and a screen reader. - Screen readers are used to translate screen content into synthesized speech - or braille for visually impaired users. -

The AccessibilityImplementation class provides a set of methods that allow a component - developer to make information about system roles, object based events, and states available - to assistive technology.

-

Adobe Flash Player uses Microsoft Active Accessibility (MSAA), which provides a descriptive - and standardized way for applications and screen readers to communicate. For more information - on how the Flash Player works with MSAA, see the accessibility chapter in Using Flex SDK.

-

The methods of the AccessibilityImplementation class are a subset of the - IAccessible interface - for a component instance.

-

The way that an AccessibilityImplementation implements the IAccessible interface, - and the events that it sends, depend on the kind of component being implemented.

-

Do not directly instantiate AccessibilityImplementation by calling its constructor. - Instead, create new accessibility implementations by extending the - AccImpl class for each new component. - In Flash, see the fl.accessibility package. - In Flex, see the mx.accessibility package and - the accessibility chapter in Using Flex SDK.

-

Note: The AccessibilityImplementation class is not supported in AIR runtime versions before AIR 2. The class is - available for compilation in AIR versions before AIR 2, but is not supported in the runtime until AIR 2.

- -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  errno : uint -
- Indicates an error code.
-		AccessibilityImplementation
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  stub : Boolean -
- Used to create a component accessibility stub.
-		AccessibilityImplementation
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-AccessibilityImplementation()
-
- Static constructor.
-		AccessibilityImplementation
   -
-accDoDefaultAction(childID:uint):void -
-
- An IAccessible method that performs the default action associated with the component - that this AccessibilityImplementation represents or of one of its child elements.
-		AccessibilityImplementation
   -
-accLocation(childID:uint):* -
-
- MSAA method for returning a DisplayObject or Rectangle - specifying the bounding box of a child element in the AccessibilityImplementation.
-		AccessibilityImplementation
   -
-accSelect(operation:uint, childID:uint):void -
-
- IAccessible method for altering the selection in the component - that this AccessibilityImplementation represents.
-		AccessibilityImplementation
   -
-get_accDefaultAction(childID:uint):String -
-
- MSAA method for returning the default action of the component - that this AccessibilityImplementation represents or of one of its child elements.
-		AccessibilityImplementation
   -
-get_accFocus():uint -
-
- MSAA method for returning the unsigned integer ID of the child element, if any, - that has child focus within the component.
-		AccessibilityImplementation
   -
-get_accName(childID:uint):String -
-
- MSAA method for returning the name for the component - that this AccessibilityImplementation represents or for one of its child elements.
-		AccessibilityImplementation
   -
-get_accRole(childID:uint):uint -
-
- MSAA method for returning the system role for the component - that this AccessibilityImplementation represents or for one of its child elements.
-		AccessibilityImplementation
   -
-get_accSelection():Array -
-
- MSAA method for returning an array containing the IDs of all child elements that are selected.
-		AccessibilityImplementation
   -
-get_accState(childID:uint):uint -
-
- IAccessible method for returning the current runtime state of the component that this - AccessibilityImplementation represents or of one of its child elements.
-		AccessibilityImplementation
   -
-get_accValue(childID:uint):String -
-
- MSAA method for returning the runtime value of the component that this - AccessibilityImplementation represents or of one of its child elements.
-		AccessibilityImplementation
   -
-get_selectionActiveIndex():* -
-
-		AccessibilityImplementation
   -
-get_selectionAnchorIndex():* -
-
-		AccessibilityImplementation
   -
-getChildIDArray():Array -
-
- Returns an array containing the unsigned integer IDs of all child elements - in the AccessibilityImplementation.
-		AccessibilityImplementation
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-isLabeledBy(labelBounds:Rectangle):Boolean -
-
- - Returns true or false to indicate whether a text object having - a bounding box specified by a x, y, width, and height - should be considered a label for the component that this AccessibilityImplementation represents.
-		AccessibilityImplementation
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
errnoproperty
-
-public var errno:uint -

- - - - -
Runtime version: AIR 2
-

- Indicates an error code. Errors are indicated out-of-band, rather than in return values. - To indicate an error, set the errno property to one of the error codes - documented in the AccessibilityImplementation Constants appendix. - This causes your return value to be ignored. The errno property - of your AccessibilityImplementation is always cleared (set to zero) by the player - before any AccessibilityImplementation method is called. - -

-See also -

-
-AccessibilityImplementation Constants -
-
- - - - - -
stubproperty 
-
-public var stub:Boolean -

- - - - -
Runtime version: AIR 2
-

- Used to create a component accessibility stub. - If a component is released without an ActionScript accessibility implementation, - Adobe recommends that you add a component accessibility stub. - This stub causes Flash Player, for accessibility purposes, to treat the component - as a simple graphic rather than exposing the internal structure of buttons, - textfields, and so on, within the component. -

To create a component accessibility stub, - subclass the relevant AccImpl class, overriding the property stub - with a value of true.

-

-See also -

-
The mx.accessibility.AccImpl class in Flex (\sdks\4.0.0\frameworks\projects\framework\src\mx\accessibility\AccImpl.as)"
The fl.accessibility.AccImpl class in Flash (\Local Settings\Application Data\Adobe\Flash CS5\en_US\Configuration\Classes\mx\accessibility\AccImpl.as)"
-
- -
Constructor detail
- - - - - -
AccessibilityImplementation()constructor
-
-public function AccessibilityImplementation() -

- - - - -
Runtime version: AIR 2
-

- Static constructor. Do not directly instantiate AccessibilityImplementation by calling its constructor. - Instead, create new accessibility implementations by extending the mx.accessibility.AccImpl - class for each new component. - -

-See also -

-
mx.accessibility.AccImpl
-
- -
Method detail
- - - - - -
accDoDefaultAction()method
-
-public function accDoDefaultAction(childID:uint):void -

- - - - -
Runtime version: AIR 2
-

- An IAccessible method that performs the default action associated with the component - that this AccessibilityImplementation represents or of one of its child elements. - -

Implement this method only if the AccessibilityImplementation represents a UI element - that has a default action in the MSAA model.

-

If you are implementing accDoDefaultAction() only for the AccessibilityImplementation - itself, or only for its child elements, you will need in some cases to indicate that there - is no default action for the particular childID that was passed. - Do this by setting the errno property to E_MEMBERNOTFOUND.

- Parameters - - - - -
childID:uint — An unsigned integer corresponding to one of the component's child elements, - as defined by getChildIDArray(). -
-
-Example -

-
- - - - - -
accLocation()method 
-
-public function accLocation(childID:uint):* -

- - - - -
Runtime version: AIR 2
-

- MSAA method for returning a DisplayObject or Rectangle - specifying the bounding box of a child element in the AccessibilityImplementation. - -

This method is never called with a childID of zero. - If your AccessibilityImplementation will never contain child elements, you should not implement - this method. If your AccessibilityImplementation can contain child elements, - this method is mandatory.

- -

You can usually satisfy the requirements of this method by returning an - object that represents the child element itself. This works as long as the - child element is a DisplayObject. - In these cases, simply return the DisplayObject that corresponds to - the instance name associated with the relevant visual object in display list.

- -

If a child element does not qualify for the technique described above, - you may do the bounding-box math yourself and return a Rectangle with: - x, y, width, and height properties. - The x and y members specify the upper-left corner of the bounding box, and - the width and height members specify its size. All four members - should be in units of Stage pixels, and relative to the origin of the component - that the AccessibilityImplementation represents. The x and y properties may have - negative values, since the origin of a DisplayObject is not necessarily in its - upper-left corner.

- -

If the child element specified by childID is not visible (that is, get_accState - for that child would return a value including STATE_SYSTEM_INVISIBLE), you - may return null from accLocation. You can also - return a Rectangle representing the coordinates where the child element would - appear if it were visible.

- Parameters - - - - -
childID:uint — An unsigned integer corresponding to one of the component's child elements - as defined by getChildIDArray(). -
-

-Returns - - - - -
* — DisplayObject or Rectangle specifying the bounding box - of the child element specified by childID parameter. - -
-

-See also -

-
-flash.display.DisplayObject -
-flash.geom.Rectangle -
-getChildIDArray() -
-Microsoft Accessibility Developer Center: IAccessible::accLocation -
-
-Example -

-
- - - - - -
accSelect()method 
-
-public function accSelect(operation:uint, childID:uint):void -

- - - - -
Runtime version: AIR 2
-

- IAccessible method for altering the selection in the component - that this AccessibilityImplementation represents. -

The childID parameter will always be nonzero. This method - always applies to a child element rather than the overall component; - Flash Player manages the selection of the overall component itself.

- -

The selFlag parameter is a bitfield consisting of one or more selection flag constants - that allows an MSAA client to indicate how the item referenced by the childID - should be selected or take focus. What follows are descriptions of the selection flag constants - and what they communicate to the accessibility implementation. - As a practical matter, most implementations of this method in accessibility implementations - that inherit from the Flex mx.accessibility.ListBaseAccImpl class - ignore the selFlag constant and instead rely on the component's keyboard selection behavior - to handle multi-selection.

- -

The selFlag parameter may or may not contain the SELFLAG_TAKEFOCUS - flag. If it does, you should set the child focus to the specified childID, - and, unless SELFLAG_EXTENDSELECTION is also present, make that child element - the selection anchor. Otherwise, the child focus and selection anchor should - remain unmodified, despite the fact that additional flags described below - may modify the selection.

-

The selFlag argument will always contain one of the following four - flags, which indicate what kind of selection modification is desired:

-
    -

  • SELFLAG_TAKESELECTION: Clear any existing selection, and set the selection - to the specified childID.

    -
    • -

  • SELFLAG_EXTENDSELECTION: Calculate the range of child elements between - and including the selection anchor and the specified childID. If - SELFLAG_ADDSELECTION is present, add all of these child elements to the - selection. If SELFLAG_REMOVESELECTION is present, remove all of these child - elements from the selection. If neither SELFLAG_ADDSELECTION nor SELFLAG_REMOVESELECTION - is present, all of these child elements should take on the selection anchor's - selection state: if the selection anchor is selected, add these child elements - to the selection; otherwise remove them from the selection.

    -
    • -

  • SELFLAG_ADDSELECTION (without SELFLAG_EXTENDSELECTION): Add the specified - childID to the selection.

    -
    • -

  • SELFLAG_REMOVESELECTION (without SELFLAG_EXTENDSELECTION): Remove the - specified childID from the selection.

    • -
-

Note that for a non-multi-selectable component, the only valid selFlag - parameter values are SELFLAG_TAKEFOCUS and SELFLAG_TAKESELECTION. - You could in theory - also choose to support SELFLAG_REMOVESELECTION for a non-multi-selectable - component that allowed the user to force a null selection, but in practice - most non-multi-selectable components do not work this way, and MSAA clients - may not attempt this type of operation.

-

If you encounter flags that seem invalid, set errno to E_INVALIDARG.

-

Finally, note that when accSelect is called, Flash Player - ensures that it has host focus (the window focus of its container - application), and that your component has focus within Flash Player.

- - Parameters - - - - - - - - - - -
operation:uint — A bitfield consisting of one or more selection flag constants to indicate - how the item is selected or takes focus. -
 
childID:uint — An unsigned integer corresponding to one of the component's child elements - as defined by getChildIDArray(). - -
-

-See also -

-
-getChildIDArray() -
-Microsoft Accessibility Developer Center: IAccessible::accSelect -
-
-Example -

-
- - - - - -
get_accDefaultAction()method 
-
-public function get_accDefaultAction(childID:uint):String -

- - - - -
Runtime version: AIR 2
-

- MSAA method for returning the default action of the component - that this AccessibilityImplementation represents or of one of its child elements. -

Implement this method only if the AccessibilityImplementation represents a UI element - that has a default action in the MSAA model; be sure to return the exact string - that the MSAA model specifies. - For example, the default action string for a Button component is "Press."

-

If you are implementing get_accDefaultAction only for the - AccessibilityImplementation itself, or only for its child elements, - you will need in some cases to indicate that there is no default action - for the particular childID that was passed. - Do this by simply returning null.

- - Parameters - - - - -
childID:uint — An unsigned integer corresponding to one of the component's child elements, - as defined by getChildIDArray(). - -
-

-Returns - - - - -
String — - The default action string specified in the MSAA model for the AccessibilityImplementation - or for one of its child elements. - - -
-

-See also -

-
-getChildIDArray() -
-Microsoft Accessibility Developer Center: IAccessible::get_accDefaultAction -
-
-Example -

-
- - - - - -
get_accFocus()method 
-
-public function get_accFocus():uint -

- - - - -
Runtime version: AIR 2
-

- MSAA method for returning the unsigned integer ID of the child element, if any, - that has child focus within the component. If no child has child focus, the method returns zero. - -

-Returns - - - - -
uint — - The unsigned integer ID of the child element, if any, that has child focus within the component. - - -
-

-See also -

-
-getChildIDArray() -
-Microsoft Accessibility Developer Center: IAccessible::get_accFocus -
-
-Example -

-
- - - - - -
get_accName()method 
-
-public function get_accName(childID:uint):String -

- - - - -
Runtime version: AIR 2
-

- MSAA method for returning the name for the component - that this AccessibilityImplementation represents or for one of its child elements. - -

In the case of the AccessibilityImplementation itself (childID == 0), - if this method is not implemented, or does not return a value, Flash Player - uses the AccessibilityProperties.name property value, if it is present.

-

For AccessibilityImplementations that can have child elements, this method must be implemented, - and must return a string value when childID is nonzero.

-

Depending on the type of user interface element, names in MSAA mean one of two different - things: an author-assigned name, or the actual text content of the element. - Usually, an AccessibilityImplementation itself will fall into the former category. - Its name property is an author-assigned name. Child elements - always fall into the second category. Their names indicate their text content.

-

When the name property of an AccessibilityImplementation has the meaning - of an author-assigned name, there are two ways in which components can acquire names from authors. - The first entails names present within the component itself; for example, a checkbox - component might include a text label that serves as its name. The second—a fallback from - the first—entails names specified in the UI and ending - up in AccessibilityProperties.name. This fallback option allows users to specify - names just as they would for any other Sprite or MovieClip.

-

This leaves three possibilities for the AccessibilityImplementation itself (childID == zero):

-
    -

  • Author-assigned name within component. The get_accName method - should be implemented and should return a string value that contains the - AccessibilityImplementation's name when childID is zero. If childID is zero but the - AccessibilityImplementation has no name, get_accName should return an empty string to prevent - the player from falling back to the AccessibilityProperties.name property.

    -
    • -

  • Author-assigned name from UI. If the AccessibilityImplementation can have child - elements, the get_accName method should be implemented but should not return a value when - childID is zero. If the AccessibilityImplementation will never have child elements, - get_accName should not be implemented.

    -
    • -

  • Name signifying content. The get_accName method should be - implemented and should return an appropriate string value when childID - is zero. If childId is zero but the AccessibilityImplementation has no content, - get_accName should return an empty string to prevent the player from falling back to - the AccessibilityProperties.name property.

    -
    • -
-

Note that for child elements (if the AccessibilityImplementation can have them), the third case - always applies. The get_accName method should be implemented and should - return an appropriate string value when childID is nonzero.

- Parameters - - - - -
childID:uint — An unsigned integer corresponding to one of the component's child elements - as defined by getChildIDArray(). -
-

-Returns - - - - -
String — - Name of the component or one of its child elements. - - - -
-

-See also -

-
-getChildIDArray() -
-flash.accessibility.AccessibilityProperties -
-flash.accessibility.AccessibilityProperties.name -
mx.accessibility.AccImpl.get_accName()
mx.accessibility.AccImpl.getName()
mx.accessibility.AccImpl.getStatusName()
-Microsoft Accessibility Developer Center: IAccessible::get_accName -
-
-Example -

-
- - - - - -
get_accRole()method 
-
-public function get_accRole(childID:uint):uint -

- - - - -
Runtime version: AIR 2
-

- MSAA method for returning the system role for the component - that this AccessibilityImplementation represents or for one of its child elements. - System roles are predefined for all the components in MSAA. - -

Parameters - - - - -
childID:uint — An unsigned integer corresponding to one of the component's - child elements as defined by getChildIDArray(). - -
-

-Returns - - - - -
uint — - System role associated with the component. - - - -
-
-Throws - - - - -
Error — Error code 2143, AccessibilityImplementation.get_accRole() must be overridden from its default. -
-

-See also -

-
-getChildIDArray() -
-AccessibilityImplementation Constants: Object Role Constants -
-Microsoft Accessibility Developer Center: IAccessible::get_accRole -
-
- - - - - -
get_accSelection()method 
-
-public function get_accSelection():Array -

- - - - -
Runtime version: AIR 2
-

- MSAA method for returning an array containing the IDs of all child elements that are selected. - The returned array may contain zero, one, or more IDs, all unsigned integers. -

-Returns - - - - -
Array — - An array of the IDs of all child elements that are selected. - - - -
-

-See also -

-
-getChildIDArray() -
-Microsoft Accessibility Developer Center: IAccessible::get_accSelection -
-
-Example -

-
- - - - - -
get_accState()method 
-
-public function get_accState(childID:uint):uint -

- - - - -
Runtime version: AIR 2
-

- IAccessible method for returning the current runtime state of the component that this - AccessibilityImplementation represents or of one of its child elements. -

This method must return a combination of zero, one, or more of the predefined - object state constants for components in MSAA. - When more than one state applies, the state constants should be combined into a bitfield - using |, the bitwise OR operator.

-

To indicate that none of the state constants currently applies, this method should return zero.

-

You should not need to track or report the STATE_SYSTEM_FOCUSABLE or STATE_SYSTEM_FOCUSED states. - Flash Player handles these states automatically.

- Parameters - - - - -
childID:uint — An unsigned integer corresponding to one of the component's child elements - as defined by getChildIDArray(). -
-

-Returns - - - - -
uint — - A combination of zero, one, or more of the system state constants. - Multiple constants are assembled into a bitfield using |, the bitwise OR operator. - - - - -
-
-Throws - - - - -
Error — Error code 2144, AccessibilityImplementation.get_accState() must be overridden from its default. -
-

-See also -

-
-getChildIDArray() -
-AccessibilityImplementation Constants: Object State Constants -
-Microsoft Accessibility Developer Center: IAccessible::get_accState -
-
-Example -

-
- - - - - -
get_accValue()method 
-
-public function get_accValue(childID:uint):String -

- - - - -
Runtime version: AIR 2
-

- MSAA method for returning the runtime value of the component that this - AccessibilityImplementation represents or of one of its child elements. -

Implement this method only if your AccessibilityImplementation represents a UI element - that has a value in the MSAA model. Be aware that some UI elements that have an apparent 'value' - actually expose this value by different means, such as - get_accName (text, for example), - get_accState (check boxes, for example), or get_accSelection - (list boxes, for example).

-

If you are implementing get_accValue only for the AccessibilityImplementation itself, or - only for its child elements, you will need in some cases to indicate that - there is no concept of value for the particular childID that was passed. - Do this by simply returning null.

- Parameters - - - - -
childID:uint — An unsigned integer corresponding to one of the component's child elements - as defined by getChildIDArray(). - -
-

-Returns - - - - -
String — - A string representing the runtime value of the component of of one of its child elements. - - - -
-

-See also -

-
-getChildIDArray() -
-Microsoft Accessibility Developer Center: IAccessible::get_accValue -
-
-Example -

-
- - - - - -
get_selectionActiveIndex()method 
-
-public function get_selectionActiveIndex():* -

-Returns - - - - -
*
-
- - - - - -
get_selectionAnchorIndex()method 
-
-public function get_selectionAnchorIndex():* -

-Returns - - - - -
*
-
- - - - - -
getChildIDArray()method 
-
-public function getChildIDArray():Array -

- - - - -
Runtime version: AIR 2
-

- Returns an array containing the unsigned integer IDs of all child elements - in the AccessibilityImplementation. -

The length of the array may be zero. The IDs in the array should - appear in the same logical order as the child elements they represent. If your - AccessibilityImplementation can contain child elements, this method is mandatory; otherwise, do - not implement it.

-

In assigning child IDs to your child elements, use any scheme that - preserves uniqueness within each instance of your AccessibilityImplementation. Child IDs need not - be contiguous, and their ordering need not match the logical ordering of the - child elements. You should arrange so as to not reuse child IDs; if a child - element is deleted, its ID should never be used again for the lifetime of - that AccessibilityImplementation instance. Be aware that, due to implementation choices in the Flash - player code, undesirable behavior can result if you use child IDs that exceed - one million.

-

-Returns - - - - -
Array — - Array containing the unsigned integer IDs of all child elements in the AccessibilityImplementation. - - - -
-
-Example -

-
- - - - - -
isLabeledBy()method 
-
-public function isLabeledBy(labelBounds:Rectangle):Boolean -

- - - - -
Runtime version: AIR 2
-

- - Returns true or false to indicate whether a text object having - a bounding box specified by a x, y, width, and height - should be considered a label for the component that this AccessibilityImplementation represents. - -

The x and y coordinates are relative to the upper-left corner - of the component to which the AccessibilityImplementation applies, and may be negative. All coordinates - are in units of Stage pixels.

-

This method allows accessible components to fit into the Flash Player's search - for automatic labeling relationships, which allow text external to an object - to supply the object's name. This method is provided because it is expected - that the criteria for recognizing labels will differ from component to component. - If you implement this method, you should aim to use geometric criteria similar - to those in use inside the player code for buttons and textfields. Those criteria - are as follows:

- -

    -
  • For buttons, any text falling entirely inside the button is considered a label.
    • -
  • For textfields, any text appearing nearby above and left-aligned, - or nearby to the left, is considered a label.
    • -

-

If the component that the AccessibilityImplementation represents should never participate in automatic - labeling relationships, do not implement isLabeledBy. This is equivalent - to always returning false. One case in which isLabeledBy should - not be implemented is when the AccessibilityImplementation falls into the "author-assigned name - within component" case described under get_accName above.

-

Note that this method is not based on any IAccessible method; it is - specific to Flash.

- - Parameters - - - - -
labelBounds:Rectangle — A Rectangle representing the bounding box of a text object. -
-

-Returns - - - - -
Boolean — - true or false to indicate whether a text object having the given label bounds should be considered a label for the component that this AccessibilityImplementation represents. - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/accessibility/AccessibilityProperties.html b/html-docs/flash/accessibility/AccessibilityProperties.html deleted file mode 100644 index c233a54..0000000 --- a/html-docs/flash/accessibility/AccessibilityProperties.html +++ /dev/null @@ -1,630 +0,0 @@ - - - - - - - - -flash.accessibility.AccessibilityProperties (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.accessibility
Classpublic class AccessibilityProperties
InheritanceAccessibilityProperties Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The AccessibilityProperties class lets you control the presentation of Flash objects to accessibility - aids, such as screen readers. -

You can attach an AccessibilityProperties object to any display object, but Flash Player will read - your AccessibilityProperties object only for certain kinds of objects: entire - SWF files (as represented by DisplayObject.root), container objects - (DisplayObjectContainer and subclasses), buttons - (SimpleButton and subclasses), and text (TextField and subclasses).

-

The name property of these objects is the most important property to specify because - accessibility aids provide the names of objects to users as a basic means of navigation. Do not - confuse AccessibilityProperties.name with DisplayObject.name; these are - separate and unrelated. The AccessibilityProperties.name property is a name - that is read aloud by the accessibility aids, whereas DisplayObject.name is essentially a - variable name visible only to ActionScript code.

-

In Flash Professional, the properties of AccessibilityProperties objects override - the corresponding settings available in the Accessibility panel during authoring.

- -

To determine whether Flash Player is running in an environment that supports accessibility aids, use - the Capabilities.hasAccessibility property. If you modify AccessibilityProperties - objects, you need to call the Accessibility.updateProperties() method for the changes to - take effect.

-

-

-View the examples. -

-

-See also -

-
-flash.accessibility.Accessibility.updateProperties() -
-flash.display.DisplayObject.accessibilityProperties -
-flash.display.InteractiveObject.tabIndex -
-flash.system.Capabilities.hasAccessibility -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  description : String -
- Provides a description for this display object in the accessible presentation.
-		AccessibilityProperties
  forceSimple : Boolean -
- If true, causes Flash Player to exclude child objects within this - display object from the accessible presentation.
-		AccessibilityProperties
  name : String -
- Provides a name for this display object in the accessible presentation.
-		AccessibilityProperties
  noAutoLabeling : Boolean -
- If true, disables the Flash Player default auto-labeling system.
-		AccessibilityProperties
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  shortcut : String -
- Indicates a keyboard shortcut associated with this display object.
-		AccessibilityProperties
  silent : Boolean -
- If true, excludes this display object from accessible presentation.
-		AccessibilityProperties
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-AccessibilityProperties()
-
- Creates a new AccessibilityProperties object.
-		AccessibilityProperties
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
descriptionproperty
-
-public var description:String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Provides a description for this display object in the accessible presentation. - If you have a lot of information to present about the object, it is - best to choose a concise name and put most of your content in the - description property. - Applies to whole SWF files, containers, buttons, and text. The default value - is an empty string. -

In Flash Professional, this property corresponds to the Description field in the Accessibility panel.

-
- - - - - -
forceSimpleproperty 
-
-public var forceSimple:Boolean -

- - - - -
Runtime version: 
-

- If true, causes Flash Player to exclude child objects within this - display object from the accessible presentation. - The default is false. Applies to whole SWF files and containers. -

- - - - - -
nameproperty 
-
-public var name:String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Provides a name for this display object in the accessible presentation. - Applies to whole SWF files, containers, buttons, and text. Do not confuse with - DisplayObject.name, which is unrelated. The default value - is an empty string. -

In Flash Professional, this property corresponds to the Name field in the Accessibility panel.

-
- - - - - -
noAutoLabelingproperty 
-
-public var noAutoLabeling:Boolean -

- - - - -
Runtime version: 
-

- If true, disables the Flash Player default auto-labeling system. - Auto-labeling causes text objects inside buttons to be treated as button names, - and text objects near text fields to be treated as text field names. - The default is false. Applies only to whole SWF files. -

The noAutoLabeling property value is ignored unless you specify it before the - first time an accessibility aid examines your SWF file. If you plan to set - noAutoLabeling to true, you should do so as early as - possible in your code.

-
- - - - - -
shortcutproperty 
-
-public var shortcut:String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates a keyboard shortcut associated with this display object. - Supply this string only for UI controls that you have associated with a shortcut key. - Applies to containers, buttons, and text. The default value - is an empty string. - -

Note: Assigning this property does not automatically assign the specified key - combination to this object; you must do that yourself, for example, by - listening for a KeyboardEvent.

-

The syntax for this string uses long names for modifier keys, and - the plus(+) character to indicate key combination. Examples of valid strings are - "Ctrl+F", "Ctrl+Shift+Z", and so on.

-
- - - - - -
silentproperty 
-
-public var silent:Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- If true, excludes this display object from accessible presentation. - The default is false. Applies to whole SWF files, containers, buttons, and text. -

- -
Constructor detail
- - - - - -
AccessibilityProperties()constructor
-
-public function AccessibilityProperties() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new AccessibilityProperties object. -

- -
Examples
-
examples\AccessibilityPropertiesExample
-
The following example uses the AccessibilityExample, - CustomAccessibleButton, CustomSimpleButton, and ButtonDisplayState classes - to create an accessibility-compliant menu that works with common screen readers. The main - functionality of the AccessibilityProperties class is as follows: - -
    -
  1. Call configureAssets, which creates a custom button and sets its label and - description. These are the values that the screen reader conveys to the end user.
    2. -
  2. Call setTimeOut() to ensure that Flash Player has enough time to detect the - screen reader before updating the properties.
    3. -
- -

Note: Call setTimeout() before checking Accessibility.active. - to give Flash Player the 2 seconds it needs to connect to a screen reader, - if one is available. If you do not provide a sufficient delay time, the setTimeout call might return false, even - if a screen reader is available.

- -

The following example processes the Accessibility.updateProperties() - method only if the call to Accessibility.active returns true, which - occurs only if Flash Player is currently connected to an active screen reader. If updateProperties - is called without an active screen reader, it throws an IllegalOperationError exception.

-
-
-package {
-	import flash.display.Sprite;
-	import flash.accessibility.Accessibility;
-	import flash.utils.setTimeout;
-	
-	public class AccessibilityPropertiesExample extends Sprite {
-		public static const BUTTON_WIDTH:uint = 90;
-		public static const BUTTON_HEIGHT:uint = 20;
-		
-		private var gutter:uint = 5;
-		private var menuLabels:Array = new Array("PROJECTS", "PORTFOLIO", "CONTACT");
-		private var menuDescriptions:Array = new Array("Learn more about our projects"
-													 , "See our portfolio"
-													 , "Get in touch with our team");
-		
-		public function AccessibilityPropertiesExample() {
-			configureAssets();
-			setTimeout(updateAccessibility, 2000); 
-		}
-		
-		private function updateAccessibility():void {
-			trace("Accessibility.active: " + Accessibility.active);
-			if(Accessibility.active) {
-				Accessibility.updateProperties();
-			}
-		}
-		
-		private function configureAssets():void {
-			var child:CustomAccessibleButton;
-			for(var i:uint; i < menuLabels.length; i++) {
-				child = new CustomAccessibleButton();
-				child.y = (numChildren * (BUTTON_HEIGHT + gutter));
-				child.setLabel(menuLabels[i]);
-				child.setDescription(menuDescriptions[i]);
-				addChild(child);
-			}
-		}
-	}
-
-
-import flash.accessibility.AccessibilityProperties;
-import flash.display.Shape;
-import flash.display.SimpleButton;
-import flash.display.Sprite;
-import flash.events.Event;
-import flash.text.TextFormat;
-import flash.text.TextField;
-	
-class CustomAccessibleButton extends Sprite {
-	private var button:SimpleButton;
-	private var label1:TextField;
-	private var description:String;
-	private var _name:String;
-		
-	public function CustomAccessibleButton(_width:uint = 0, _height:uint = 0) {
-		_width = (_width == 0) ? AccessibilityPropertiesExample.BUTTON_WIDTH : _width;
-		_height = (_height == 0) ? AccessibilityPropertiesExample.BUTTON_HEIGHT : _height;
-			
-		button = buildButton(_width, _height);
-		label1 = buildLabel(_width, _height);
-			
-		addEventListener(Event.ADDED, addedHandler);
-	}
-		
-	private function addedHandler(event:Event):void {
-		trace("addedHandler: " + name);
-		var accessProps:AccessibilityProperties = new AccessibilityProperties();
-		accessProps.name = this._name;
-		accessProps.description = description;
-		accessibilityProperties = accessProps;
-		removeEventListener(Event.ADDED, addedHandler);
-	}
-		
-	private function buildButton(_width:uint, _height:uint):SimpleButton {
-		var child:SimpleButton = new CustomSimpleButton(_width, _height);
-		addChild(child);
-		return child;
-	}
-
-	private function buildLabel(_width:uint, _height:uint):TextField {
-		var format:TextFormat = new TextFormat();
-		format.font = "Verdana";
-		format.size = 11;
-		format.color = 0xFFFFFF;
-		format.align = TextFormatAlign.CENTER;
-		format.bold = true;
-			
-		var child:TextField = new TextField();
-		child.y = 1;
-		child.width = _width;
-		child.height = _height;
-		child.selectable = false;
-		child.defaultTextFormat = format;
-		child.mouseEnabled = false;
-			
-		addChild(child);
-		return child;
-	}
-		
-	public function setLabel(text:String):void {
-		label1.text = text;
-		this._name = text;
-	}
-		
-	public function setDescription(text:String):void {
-		description = text;
-	}
-}
-	
-class CustomSimpleButton extends SimpleButton {
-	private var upColor:uint = 0xFFCC00;
-	private var overColor:uint = 0xCCFF00;
-	private var downColor:uint = 0x00CCFF;
-
-	public function CustomSimpleButton(_width:uint, _height:uint) {
-		downState = new ButtonDisplayState(downColor, _width, _height);
-		overState = new ButtonDisplayState(overColor, _width, _height);
-		upState = new ButtonDisplayState(upColor, _width, _height);
-		hitTestState = new ButtonDisplayState(upColor, _width, _height);
-		useHandCursor = true;
-	}		
-}
-
-class ButtonDisplayState extends Shape {
-	private var bgColor:uint;
-	private var _width:uint;
-	private var _height:uint;
-
-	public function ButtonDisplayState(bgColor:uint, _width:uint, _height:uint) {
-		this.bgColor = bgColor;
-		this._width = _width;
-		this._height = _height;
-		draw();
-	}
-
-	private function draw():void {
-		graphics.beginFill(bgColor);
-		graphics.drawRect(0, 0, _width, _height);
-		graphics.endFill();
-	}
-}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/accessibility/ISearchableText.html b/html-docs/flash/accessibility/ISearchableText.html deleted file mode 100644 index a5819b7..0000000 --- a/html-docs/flash/accessibility/ISearchableText.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - -flash.accessibility.ISearchableText (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - -
Packageflash.accessibility
Interfacepublic interface ISearchableText
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The ISearchableText interface can be implemented by objects that - contain text which should be searchable on the web. - -

-
-
-
- -
-
Public Properties
- - - - - - - -
 PropertyDefined by
  searchText : String -
[read-only] - Gets the search text from a component implementing ISearchableText.
-		ISearchableText
-
- -
- -
Property detail
- - - - - -
searchTextproperty
-
-searchText:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Gets the search text from a component implementing ISearchableText. - -

Implementation -
-    public function get searchText():String -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/accessibility/ISimpleTextSelection.html b/html-docs/flash/accessibility/ISimpleTextSelection.html deleted file mode 100644 index 798015c..0000000 --- a/html-docs/flash/accessibility/ISimpleTextSelection.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - - -flash.accessibility.ISimpleTextSelection (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - -
Packageflash.accessibility
Interfacepublic interface ISimpleTextSelection
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- - The ISimpleTextSelection class can be used to add support for - the MSAA ISimpleTextSelection interface to an AccessibilityImplementation. - -

If an AccessibilityImplementation subclass implements the two getters in this class, - a screen reader such as JAWS can determine the text selection range by calling them. - The AccessibilityImplementation subclass does not have to formally declare that it implements - this interface; you can simply declare getters for these two properties, as follows:

- 
-	class TextAreaAccImpl extends AccesibilityImplementation
-	{
-	...
-		public function get selectionAnchorIndex():int
-		{
-		...
-		}
-		public function get selectionActiveIndex():int
-		{
-		...
-	}
-	}
-
-

-

-See also -

-
-flash.accessibility.AccessibilityImplementation -
-
-
-
- -
-
Public Properties
- - - - - - - - - - -
 PropertyDefined by
  selectionActiveIndex : int -
[read-only] - The zero-based character index value of the last character in the current selection.
-		ISimpleTextSelection
  selectionAnchorIndex : int -
[read-only] - The zero-based character index value of the first character in the current selection.
-		ISimpleTextSelection
-
- -
- -
Property detail
- - - - - -
selectionActiveIndexproperty
-
-selectionActiveIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The zero-based character index value of the last character in the current selection. - If you want a component to support inline IME or accessibility, override this method. -

Implementation -
-    public function get selectionActiveIndex():int -
-
- - - - - -
selectionAnchorIndexproperty 
-
-selectionAnchorIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The zero-based character index value of the first character in the current selection. - If you want a component to support inline IME or accessibility, override this method. -

Implementation -
-    public function get selectionAnchorIndex():int -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/accessibility/package-detail.html b/html-docs/flash/accessibility/package-detail.html deleted file mode 100644 index d643116..0000000 --- a/html-docs/flash/accessibility/package-detail.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - -flash.accessibility Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.accessibility package contains classes for supporting accessibility in Flash content and applications.

-
-
- -
Interfaces
- - - - - - - - - - -
 InterfaceDescription
 ISearchableText - The ISearchableText interface can be implemented by objects that - contain text which should be searchable on the web.
 ISimpleTextSelection - - The ISimpleTextSelection class can be used to add support for - the MSAA ISimpleTextSelection interface to an AccessibilityImplementation.
- -
Classes
- - - - - - - - - - - - - -
 ClassDescription
 Accessibility - The Accessibility class manages communication with screen readers.
 AccessibilityImplementation - - The AccessibilityImplementation class is the base class in Flash Player - that allows for the implementation of accessibility in components.
 AccessibilityProperties - The AccessibilityProperties class lets you control the presentation of Flash objects to accessibility - aids, such as screen readers.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/concurrent/Condition.html b/html-docs/flash/concurrent/Condition.html deleted file mode 100644 index 7139ba5..0000000 --- a/html-docs/flash/concurrent/Condition.html +++ /dev/null @@ -1,738 +0,0 @@ - - - - - - - - -flash.concurrent.Condition (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.concurrent
Classpublic final class Condition
InheritanceCondition Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

-

- - A Condition object is a tool for sharing a resource between workers with the - - additional capability of pausing execution until a particular condition is - - satisfied. A Condition object is used in conjunction with a Mutex object, and - - adds additional functionality to the mutex's behavior. By working in - - combination with a mutex, the runtime ensures that each transition of - - ownership between workers is atomic. - - - -

The following is one possible workflow for using a Condition object:

- -
    - -
  1. Before using a Condition object, the first worker must take ownership - - of the condition's associated mutex by calling the Mutex object's - - lock() or tryLock() methods.
    2. - -
  2. The worker's code operates on the shared resource until some condition - - becomes false, preventing the worker from doing more work with the - - shared resource. For example, if the shared resource is a set of data - - to process, when there is no more data to process the worker can't - - do any more work.
    3. - -
  3. At that point, call the Condition object's wait() method - - to pause the worker's execution and release ownership of the mutex.
    4. - -
  4. At some point, a second worker takes ownership of the mutex. Because - - the mutex is available, it is safe for the second worker's code to - - operate on the shared resource. The second worker does whatever is - - necessary to satisfy the condition so that the first worker can do its - - work again. For example, if the first worker has no data to process, - - the second worker could pass more data to process into the shared resource.
    5. - -
  5. At that point, the condition related to the first worker's work is now - - true, so the first worker needs to be notified that the condition is - - fulfilled. To notify the first worker, the second worker's code calls - - the Condition object's notify() method or its - - notifyAll() method.
    6. - -
  6. In addition to calling notify(), the second worker needs - - to release ownership of the mutex. It does this either by calling the - - Mutex object's unlock() method or the Condition object's - - wait() method. Since the first worker called the - - wait() method, ownership of the mutex returns to the - - first worker. Code execution in the first worker then continues again - - with the next line of code following the wait() call.
    7. - -
- - - -

The Condition class is one of the special object types that are shared - - between workers rather than copied between them. When you pass a condition - - from one worker to another worker either by calling the Worker object's - - setSharedProperty() method or by using a MessageChannel object, - - both workers have a reference to the same Condition object in the runtime's - - memory.

- - -

-

-See also -

-
-Mutex class -
-Worker class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - - Indicates whether the Condition class is supported for the current platform.
-		Condition
  mutex : Mutex -
[read-only] - - The mutex associated with this condition.
-		Condition
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Condition(mutex:Mutex)
-
- - Creates a new Condition instance.
-		Condition
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-notify():void -
-
- - Specifes that the condition that this Condition object represents has - - been satisfied and that ownership of the mutex will be returned to the - - next worker (if any) that's waiting on this condition.
-		Condition
   -
-notifyAll():void -
-
- - Specifies that the condition that this Condition object represents has - - been satisfied and that ownership of the mutex will be returned to all - - workers that are waiting on this condition.
-		Condition
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
   -
-wait(timeout:Number = -1):Boolean -
-
- - Specifies that the condition that this Condition object represents isn't - - satisfied, and the current worker needs to wait until it is satisfied - - before executing more code.
-		Condition
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - Indicates whether the Condition class is supported for the current platform. - - -

Note: if the Mutex class is not supported, creation - - of a Condition instance is not possible and this property is false.

- - - Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
mutexproperty 
-
-mutex:Mutex  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - The mutex associated with this condition. - - -

Implementation -
-    public function get mutex():Mutex -
-
- -
Constructor detail
- - - - - -
Condition()constructor
-
-public function Condition(mutex:Mutex) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - Creates a new Condition instance. - - -

Parameters - - - - -
mutex:Mutex — the mutex that the condition uses to control transitions - - between workers - - -
-
- -
Method detail
- - - - - -
notify()method
-
-public function notify():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - Specifes that the condition that this Condition object represents has - - been satisfied and that ownership of the mutex will be returned to the - - next worker (if any) that's waiting on this condition. - - -

Calling this method doesn't automatically release ownership of the - - mutex. After calling notify(), you should explicitly - - release ownership of the mutex in one of two ways: call the - - Mutex.unlock() method if the current worker doesn't need the - - mutex again, or call wait() if the worker should get - - ownership of the mutex again after other workers have completed their work.

- - -

One the mutex's lock is released, the next worker in the queue of - - workers that have called the wait() method acquires the - - mutex and resumes code execution.

- - -
-Throws - - - - -
Error — if the current worker doesn't - - own this condition's mutex - - -
-
- - - - - -
notifyAll()method 
-
-public function notifyAll():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - Specifies that the condition that this Condition object represents has - - been satisfied and that ownership of the mutex will be returned to all - - workers that are waiting on this condition. - - - -

Calling this method doesn't automatically release ownership of the - - mutex. After calling notify(), you should explicitly release - - ownership of the mutex in one of two ways: call the - - Mutex.unlock() method if the current worker doesn't need the - - mutex again, or call wait() if the worker should get - - ownership of the mutex again after other workers have completed their work.

- - -

Once the mutex's lock is released, the waiting workers receive - - ownership one at a time in the order they called the wait() - - method. Each worker that has called the wait() method - - acquires the mutex in turn and resumes code execution. When that worker - - calls the Mutex.unlock() method or the wait() - - method, mutex ownership then switches to the next waiting worker. Each - - time mutex ownership switches between workers, the transition is performed - - as a single atomic operation.

- - -
-Throws - - - - -
Error — if the current worker doesn't - - own this condition's mutex - - -
-
- - - - - -
wait()method 
-
-public function wait(timeout:Number = -1):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - Specifies that the condition that this Condition object represents isn't - - satisfied, and the current worker needs to wait until it is satisfied - - before executing more code. Calling this method pauses the current - - worker's execution thread and releases ownership of the condition's mutex. - - These steps are performed as a single atomic operation. The worker remains - - paused until another worker calls this Condition object's - - notify() or notifyAll() methods. - - -

Parameters - - - - -
timeout:Number (default = -1) — the maximum amount of time, in milliseconds, that the - - worker should pause execution before continuing. If this - - value is -1 (the default) there is no no timeout and - - execution pauses indefinitely. - - -
-

-Returns - - - - -
Boolean — - true if the method returned because the timeout - - time elapsed. Otherwise the method returns false. - - - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
Error — if the current worker doesn't - - own this condition's mutex - - -
 
ArgumentError — if the timeout argument is less than - - 0 and not -1 - - - -
 
ScriptTimeoutError — if the method is called from - - code in the primordial worker in Flash Player and worker pauses - - longer than the script timeout limit (15 seconds by default) - - -
 
Error — if the method is called and, while the calling - - worker's execution is paused, the waiting worker is terminated. - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/concurrent/Mutex.html b/html-docs/flash/concurrent/Mutex.html deleted file mode 100644 index abad6a8..0000000 --- a/html-docs/flash/concurrent/Mutex.html +++ /dev/null @@ -1,602 +0,0 @@ - - - - - - - - -flash.concurrent.Mutex (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.concurrent
Classpublic final class Mutex
InheritanceMutex Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

-

- - The Mutex (short for "mutual exclusion") class provides a way to make sure - - that only one set of code operates on a particular block of memory or other - - shared resource at a time. The primary use for a Mutex is to manage code in - - different workers accessing a shareable byte array (a ByteArray object whose - - shareable property is true). However, a Mutex can be - - used to manage workers' access to any shareable resource, such as an AIR native - - extension or a filesystem file. No matter what the resource, the purpose of - - the mutex is to ensure that only one set of code accesses the resource at a time. - - -

A mutex manages access using the concept of resource ownership. At any - - time a single mutex is "owned" by at most one worker. When ownership of a - - mutex switches from one worker to another the transision is atomic. This - - guarantees that it will never be possible for more than one worker to take - - ownership of the mutex. As long as code in a worker only operates on a shared - - resource when that worker owns the mutex, you can be certain that there will - - never be a conflict from multiple workers.

- - - -

Use the tryLock() method to take ownership of the mutex if - - it is available. Use the lock() method to pause the current - - worker's execution until the mutex is available, then take ownership of the - - mutex. Once the current worker has ownership of the mutex, it can safely - - operate on the shared resource. When those operations are complete, call the - - unlock() method to release the mutex. At that point the current - - worker should no longer access the shared resource.

- - -

The Mutex class is one of the special object types that are shared - - between workers rather than copied between them. When you pass a mutex from - - one worker to another worker either by calling the Worker object's - - setSharedProperty() method or by using a MessageChannel object, - - both workers have a reference to the same Mutex object in the runtime's memory.

- - -

-

-See also -

-
-Worker class -
-ByteArray.shareable property -
-Condition class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - - Indicates whether the use of the Mutex class is supported for the current platform.
-		Mutex
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Mutex()
-
- - Creates a new Mutex instance.
-		Mutex
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-lock():void -
-
- - Pauses execution of the current worker until this mutex is available and - - then takes ownership of the mutex.
-		Mutex
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-tryLock():Boolean -
-
- - Acquires ownership of the mutex if it is available.
-		Mutex
   -
-unlock():void -
-
- - Releases ownership of this mutex, allowing any worker to acquire it and - - perform work on the associated resource.
-		Mutex
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - Indicates whether the use of the Mutex class is supported for the current platform. - - -

This property is true if the current platform supports mutexes; otherwise - - false.

- - - Implementation -
-    public static function get isSupported():Boolean -
-
- -
Constructor detail
- - - - - -
Mutex()constructor
-
-public function Mutex() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - Creates a new Mutex instance. - - -


-Throws - - - - -
Error — if the mutex could not be initialized. - - - -
-
- -
Method detail
- - - - - -
lock()method
-
-public function lock():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - Pauses execution of the current worker until this mutex is available and - - then takes ownership of the mutex. If another worker owns the - - mutex when lock() is called, the calling worker's execution thread pauses at the - - lock() call and the worker is added to the queue of ownership - - requests. Once the calling worker acquires the mutex, the worker's - - execution continues with the line of code following the - - lock() call. - - -

Once the current worker has ownership of the mutex, it can safely - - operate on the shared resource. When those operations are complete, call - - the unlock() method to release the mutex. At that point the - - current worker should no longer access the shared resource.

- - -

Internally, a mutex keeps a count of the number of lock requests it - - has received. The mutex must receive the same number of unlock requests - - before it is completely released. If code in the worker that owns the - - mutex locks it again (by calling the lock() method) the - - internal lock count increases by one. You must call the - - unlock() method as many times as the number of lock requests - - to release ownership of the mutex.

- - - -

When multiple workers are waiting for a mutex, the mutex gives priority - - to assigning ownership to the longest-waiting worker. However, scheduling - - of worker threads is managed by the host operating system so there is no - - guarantee of a particular code execution order across workers.

- - -
- - - - - -
tryLock()method 
-
-public function tryLock():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - Acquires ownership of the mutex if it is available. If another worker - - already owns the mutex or another worker has called the lock() - - method and is waiting to acquire the mutex, the mutex is not available. - - In that case, calling this method returns false and code - - execution continues immediately. - - -

Once the current worker has ownership of the mutex, it can safely - - operate on the shared resource. When those operations are complete, call - - the unlock() method to release the mutex. At that point the - - current worker should no longer access the shared resource.

- - -

When multiple workers are waiting for a mutex, the mutex gives priority - - to assigning ownership to the longest-waiting worker. However, scheduling - - of worker threads is managed by the host operating system so there is no - - guarantee of a particular code execution order across workers.

- - -

-Returns - - - - -
Boolean — - true if the mutex was available (and is now owned - - by the current worker), or false if the current worker did - - not acquire ownership of the mutex. - - - - -
-
- - - - - -
unlock()method 
-
-public function unlock():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.5 - -
-

- - Releases ownership of this mutex, allowing any worker to acquire it and - - perform work on the associated resource. - - -

Internally, a mutex keeps a count of the number of lock requests it - - has received. Code in a worker must call the unlock() - - method as many times as the number of lock requests in order to release - - ownership of the mutex.

- - - -
-Throws - - - - -
Error — when the current worker - - doesn't own the mutex. - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/concurrent/package-detail.html b/html-docs/flash/concurrent/package-detail.html deleted file mode 100644 index cc87272..0000000 --- a/html-docs/flash/concurrent/package-detail.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - -flash.concurrent Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Classes
- - - - - - - - - - -
 ClassDescription
 Condition - - A Condition object is a tool for sharing a resource between workers with the - - additional capability of pausing execution until a particular condition is - - satisfied.
 Mutex - - The Mutex (short for "mutual exclusion") class provides a way to make sure - - that only one set of code operates on a particular block of memory or other - - shared resource at a time.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/crypto/package-detail.html b/html-docs/flash/crypto/package-detail.html deleted file mode 100644 index 1a09ae9..0000000 --- a/html-docs/flash/crypto/package-detail.html +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - -flash.crypto Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Functions
- - - - - - - -
 FunctionDescription
 generateRandomBytes - Generates a sequence of random bytes.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/crypto/package.html b/html-docs/flash/crypto/package.html deleted file mode 100644 index 60e2b9c..0000000 --- a/html-docs/flash/crypto/package.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - -flash.crypto Details (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
Public Functions
- - - - - - - -
 FunctionDefined by
   -
-generateRandomBytes(numberRandomBytes:uint):ByteArray -
-
- Generates a sequence of random bytes.
-		flash.crypto
-
- -
Function detail
- - - - - -
generateRandomBytes()function
-
-public function generateRandomBytes(numberRandomBytes:uint):ByteArray -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Generates a sequence of random bytes. -

Use generateRandomBytes() to generate cryptographic keys, strong identifiers, - session ids, and so on. The random sequence is generated using cryptographically strong functions provided - by the operating system. If the appropriate function is not available on an individual - client computer or device, then an error is thrown.

- - Parameters - - - - -
numberRandomBytes:uint — the number random bytes to generate, between 1 and 1024. -
-

-Returns - - - - -
ByteArray — - a ByteArray containing the generated bytes. - - - -
-
-Throws - - - - -
Error — when the random bytes could not be generated. -
-

-See also -

-
-Math.random() -
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/data/EncryptedLocalStore.html b/html-docs/flash/data/EncryptedLocalStore.html deleted file mode 100644 index 6b57603..0000000 --- a/html-docs/flash/data/EncryptedLocalStore.html +++ /dev/null @@ -1,839 +0,0 @@ - - - - - - - - -flash.data.EncryptedLocalStore (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class EncryptedLocalStore
InheritanceEncryptedLocalStore Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The EncryptedLocalStore class (ELS) provides an encrypted local storage mechanism - - that can be used as a small cache for an application's private data. - - - -

ELS data cannot be shared between applications. The intent of ELS is to allow an - - application to store easily recreated items such as login credentials and other private information. - - ELS data should not be considered as permanent; - - see "Limitations of the encrypted local store" and "Best practices for using ELS." below. - -

- - -

AIR profile support: This feature is not supported on AIR for TV devices. You can test - - for support at run time using the EncryptedLocalStore.isSupported property. See - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - - -

AIR provides an encrypted local store (ELS) for each AIR application installed on - - a user's computer or device. This lets you save and retrieve data that is - - stored on the user's local hard drive in an encrypted format that - - cannot easily be deciphered by other users. A separate encrypted - - local store is used for each AIR application, and each AIR application - - uses a separate encrypted local store for each user account on the computer.

- - - -

Use the encrypted local store to cache information - - that must be secured, such as login credentials for web services. - - The ELS is appropriate for storing information that must be kept - - private from other users. It does not, however, protect the data - - from other processes run under the same user account. It is thus - - not appropriate for protecting secret application data, such as DRM - - or encryption keys.

- - - -

AIR uses platform-specific storage mechanisms in order to secure the key to the ELS file. - - Internally it then uses AES-CBC 256- bit encryption to secure the data. This same approach - - is now used across all platforms/operating systems.

- - - -

With AIR 51.0, a new mechanism is being used, but if a getItem call fails to - - find the item in the new store, the older mechanism will be queried instead. When setItem - - is called, the item will be set in the new store, and removed from the old. In a future update - - of AIR, this fallback mechanism will be removed, so it would be necessary for applications to update - - through a 51.x version if they want to migrate the data.

- - - -

Information in the encrypted local store is only available to - - AIR application content in the application security sandbox.

- - - -

If you update an AIR application, the updated version retains - - access to any existing data in the encrypted local store unless:

- - - -
    - -
  • The items were added with the stronglyBound parameter - - set to true
    • - -
  • You have upgraded from the AIR 3.2 namespace to AIR 3.3 (the physical location of - - the encrypted local store changed between AIR 3.2 and AIR 3.3 for both Mac OS and Windows)
    • - -
  • The existing and update versions are both published prior - - to AIR 1.5.3 and the update is signed with a migration signature
    • - - - -
- - - -

Limitations of the encrypted local store

- -

The - - data in the encrypted local store is protected by the user's operating - - system account credentials. Other entities cannot access the data - - in the store unless they can login as that user. However, the data - - is not secure against access by other applications run by an authenticated - - user. Thus, data that your application - - may want to keep secret from users, such as keys used for licensing - - or digital rights management, is not secure. The ELS is not - - an appropriate location for storing such information. It is only - - an appropriate place for storing a user's private data, such as - - passwords. Note that the relevant user will normally have the access - - rights to be able to view the key that AIR uses to secure their ELS files.

- - - -

Data in the ELS can be lost for a variety of reasons. - - For example, the user could uninstall the application and delete - - the encrypted file. Or, the publisher ID could be changed as a result - - of an update. Thus the ELS should be treated as a private cache, - - not permanent data storage.

- - - -

The stronglyBound parameter - - is deprecated and should not be set to true. Setting - - the parameter to true does not provide any additional - - protection for data. At the same time, access to the data is lost - - whenever the application is updated - even if the publisher ID stays - - the same.

- - - -

The encrypted local store may perform more slowly - - if the stored data exceeds 10MB.

- - - -

When you uninstall an AIR - - application, the uninstaller does not delete data stored in the - - encrypted local store.

- - - -

Best practices for using ELS

- -

The best practices for using the ELS - - include:

- - - -
    - -
  • Use the ELS to store sensitive user data - - such as passwords (setting stronglyBound to false)
    • - - - -
  • Do not use the ELS to store applications secrets such as - - DRM keys or licensing tokens
    • - - - -
  • Provide a way for your application to recreate the data stored - - in the ELS if the ELS data is lost. For example, by prompting the - - user to re-enter their account credentials when necessary.
    • - - - -
  • Do not use the stronglyBound parameter.
    • - - - -
  • If you do set stronglyBound to true, - - do not migrate stored items during an update. Recreate the data - - after the update instead.
    • - - - -
  • Only store relatively small amounts of data. For large amounts - - of data, use an AIR SQL database with encryption.
    • - -
- - - -

Items in the encrypted local store are identified with a string. All items are - - stored as byte array data.

- - - -

Note that any internal failure within the ELS code may result in - - an error being thrown, by any of the functions, via an internal method called - - processErrorCode(). There are different types of errors, - - with different descriptions, based on the underlying failure. These details are not - - fully documented but indicate an unrecoverable error within the ELS handlers. The most - - appropriate behaviour would be to enclose any ELS function calls within a try/catch - - block and then call EncryptedLocalStore.reset() within the error handler. This - - would remove the ELS file and should allow information to then be successfully stored - - and retrieved again.

- - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - - The isSupported property is set to true if the - - EncryptedLocalStore class is supported on the current platform, otherwise it is - - set to false.
-		EncryptedLocalStore
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-getItem(name:String):ByteArray -
-
[static] - - The data corresponding to the specified name.
-		EncryptedLocalStore
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-removeItem(name:String):void -
-
[static] - - Removes the item with the given name from the encrypted local store.
-		EncryptedLocalStore
   -
-reset():void -
-
[static] - - Clears the entire encrypted local store, deleting all data.
-		EncryptedLocalStore
   -
-setItem(name:String, data:ByteArray, stronglyBound:Boolean = false):void -
-
[static] - - Stores a ByteArray object under the specified name.
-		EncryptedLocalStore
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - The isSupported property is set to true if the - - EncryptedLocalStore class is supported on the current platform, otherwise it is - - set to false. - - -

Implementation -
-    public static function get isSupported():Boolean -
-
- -
Method detail
- - - - - -
getItem()method
-
-public static function getItem(name:String):ByteArray -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The data corresponding to the specified name. - - - -

If an item does not exist by the specified name, this method returns null.

- - - - Parameters - - - - -
name:String — The name of the item in the encrypted local store. - - - -
-

-Returns - - - - -
ByteArray — - The ByteArray data. If there is no data for the provided name, - - the method returns null. - - - - - -
-
-Throws - - - - - - - - - - -
ArgumentError — The name value is null or an empty string. - -
 
Error — Various internal error situations could result in a generic Error object being thrown. - - - -
-
- - - - - -
removeItem()method 
-
-public static function removeItem(name:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Removes the item with the given name from the encrypted local store. - - - -

Parameters - - - - -
name:String — The name of the item in the encrypted local store. - - - -
-
-Throws - - - - - - - - - - -
ArgumentError — The name value is null or an empty string. - -
 
Error — Various internal error situations could result in a generic Error object being thrown. - - - -
-
- - - - - -
reset()method 
-
-public static function reset():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Clears the entire encrypted local store, deleting all data. - - -


-Throws - - - - -
Error — Various internal error situations could result in a generic Error object being thrown. - - - -
-
- - - - - -
setItem()method 
-
-public static function setItem(name:String, data:ByteArray, stronglyBound:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Stores a ByteArray object under the specified name. - - - -

Parameters - - - - - - - - - - - - - - - - -
name:String — The name of the item in the encrypted local store. - - - -
 
data:ByteArray — The data. - - - -
 
stronglyBound:Boolean (default = false) — (deprecated) The stronglyBound parameter should - - be set to false (the default value). If set to true, the stored item - - cannot be retrieved if any application files are altered. For example,if a user installs an - - update of your application, the updated application cannot read any strongly bound data that - - was previously written to the encrypted local store. - - - -
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — The name value is null or an empty string. - -
 
ArgumentError — The data value is null. - -
 
Error — Various internal error situations could result in a generic Error object being thrown. - - - - - -
-
- -
Examples
-
examples\EncryptedLocalStore.1
-
The following code stores a string in the encrypted local store, retrieves it, and then deletes it: -
-
-var str:String = "Bob";
-var bytes:ByteArray = new ByteArray();
-bytes.writeUTFBytes(str);
-EncryptedLocalStore.setItem("firstName", bytes);
-
-var storedValue:ByteArray = EncryptedLocalStore.getItem("firstName");
-trace(storedValue.readUTFBytes(storedValue.length)); // "Bob"
-
-EncryptedLocalStore.removeItem("firstName");
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Jul 3 2024, 9:16 AM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLCollationType.html b/html-docs/flash/data/SQLCollationType.html deleted file mode 100644 index 0f02f41..0000000 --- a/html-docs/flash/data/SQLCollationType.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - - - -flash.data.SQLCollationType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLCollationType
InheritanceSQLCollationType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- This class contains the constants that represent the possible values for the - defaultCollationType parameter of the SQLColumnSchema constructor, as well as the - SQLColumnSchema.defaultCollationType property. -

These values represent different collation sequences that can be specified for a column - in a database table. A collation sequence is a way of sorting and comparing data, - for example whether the database differentiates between uppercase and lowercase characters.

-

For more information about defining and using collation sequences, see the - "COLLATE" section in the appendix - "SQL support in local databases."

-

-

-See also -

-
-flash.data.SQLColumnSchema.defaultCollationType -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  BINARY : String = "binary"
[static] - Indicates that the column is defined to use the BINARY collation sequence.
-		SQLCollationType
  NO_CASE : String = "noCase"
[static] - Indicates that the column is defined to use the NOCASE collation sequence.
-		SQLCollationType
-
- -
- -
Constant detail
- - - - - -
BINARYconstant
-
-public static const BINARY:String = "binary" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the column is defined to use the BINARY collation sequence. - A SQLCollationType.BINARY collation compares two - values using their byte values, regardless of the text encoding of the characters. -

When binary collation is used with values of the TEXT storage class, the database - differentiates between uppercase and lowercase characters when sorting and comparing the column's - values.

-

-See also -

-
-flash.data.SQLColumnSchema.defaultCollationType -
-
- - - - - -
NO_CASEconstant 
-
-public static const NO_CASE:String = "noCase" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the column is defined to use the NOCASE collation sequence. - A SQLCollationType.NO_CASE collation ignores uppercase and lowercase differences - when sorting and comparing two values. -

-See also -

-
-flash.data.SQLColumnSchema.defaultCollationType -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLColumnNameStyle.html b/html-docs/flash/data/SQLColumnNameStyle.html deleted file mode 100644 index 87b73a5..0000000 --- a/html-docs/flash/data/SQLColumnNameStyle.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - - - - -flash.data.SQLColumnNameStyle (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLColumnNameStyle
InheritanceSQLColumnNameStyle Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- This class contains the constants that represent the possible values for the - SQLConnection.columnNameStyle property. These values indicate - different options that control how column names (property names) are formatted in the objects - returned as a result of a SQL SELECT statement. -

-

-See also -

-
-flash.data.SQLConnection.columnNameStyle -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  DEFAULT : String = "default"
[static] - Indicates that column names returned from a SELECT statement - use the default format.
-		SQLColumnNameStyle
  LONG : String = "long"
[static] - Indicates that column names returned from a SELECT statement use - long-column-name format.
-		SQLColumnNameStyle
  SHORT : String = "short"
[static] - Indicates that column names returned from a SELECT statement use short-column-name - format.
-		SQLColumnNameStyle
-
- -
- -
Constant detail
- - - - - -
DEFAULTconstant
-
-public static const DEFAULT:String = "default" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that column names returned from a SELECT statement - use the default format. In the default format, column names have the form - [table-name]_[column-name] when multiple tables are - included in the SELECT statement, or [column-name] when - the SELECT statement includes a single table. -

-See also -

-
-flash.data.SQLConnection.columnNameStyle -
-
- - - - - -
LONGconstant 
-
-public static const LONG:String = "long" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that column names returned from a SELECT statement use - long-column-name format. In this format, column names use the form - [table-name]_[column-name] regardless of how many - tables are included in the SELECT statement. -

-See also -

-
-flash.data.SQLConnection.columnNameStyle -
-
- - - - - -
SHORTconstant 
-
-public static const SHORT:String = "short" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that column names returned from a SELECT statement use short-column-name - format. In this format, column names use the form [column-name], - regardless of how many tables are included in the SELECT statement. -

If the result set contains multiple columns with the same name, only one property with that - name is added to the result object. The value assigned to that property is taken from the last - column with that name in the result row. For example, consider the following SELECT - statement:

- 
-	 SELECT customers.customerId, addresses.customerId
-	 FROM customers INNER JOIN addresses
-	    ON customers.customerId = addresses.customerId
-
-

When this statement is executed on a SQLConnection instance with short column name format, - each result object has a property named customerId, containing the - value from the addresses table's customerId column.

-

-See also -

-
-flash.data.SQLConnection.columnNameStyle -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLColumnSchema.html b/html-docs/flash/data/SQLColumnSchema.html deleted file mode 100644 index 3e95e95..0000000 --- a/html-docs/flash/data/SQLColumnSchema.html +++ /dev/null @@ -1,529 +0,0 @@ - - - - - - - - -flash.data.SQLColumnSchema (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLColumnSchema
InheritanceSQLColumnSchema Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The SQLColumnSchema class provides information describing the characteristics of a specific column - within a table in a database. -

To obtain column schema information for one or more tables in a database, use the - SQLConnection.loadSchema() method to load the schema information, making certain to - use true for the includeColumnSchema argument's value. In the resulting - SQLSchemaResult instance, each table and view definition includes a columns - property — an array of SQLColumnSchema instances representing the columns in the - table or view.

-

Generally, developer code does not construct SQLColumnSchema instances directly.

-

-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-flash.data.SQLTableSchema -
-flash.data.SQLViewSchema -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  allowNull : Boolean -
[read-only] - Indicates whether NULL values are allowed in this column.
-		SQLColumnSchema
  autoIncrement : Boolean -
[read-only] - Indicates whether this is an auto-increment column.
-		SQLColumnSchema
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  dataType : String -
[read-only] - Gets the data type of the column as a string.
-		SQLColumnSchema
  defaultCollationType : String -
[read-only] - Indicates the default collation sequence that is defined for this column.
-		SQLColumnSchema
  name : String -
[read-only] - Gets the name of the column.
-		SQLColumnSchema
  primaryKey : Boolean -
[read-only] - Indicates whether this column is the primary key column (or one of the primary key columns - in a composite key) for its associated table.
-		SQLColumnSchema
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLColumnSchema(name:String, primaryKey:Boolean, allowNull:Boolean, autoIncrement:Boolean, dataType:String, defaultCollationType:String)
-
- Constructs a SQLColumnSchema instance.
-		SQLColumnSchema
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
allowNullproperty
-
-allowNull:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether NULL values are allowed in this column. A column - that is declared with a NOT NULL constraint has a false - value for the allowNull property. -

Implementation -
-    public function get allowNull():Boolean -
-
- - - - - -
autoIncrementproperty 
-
-autoIncrement:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether this is an auto-increment column. An auto-increment column is a special type - of PRIMARY KEY column whose value is automatically generated as the next value - in a sequence of integers when a new row is inserted into the table. -

Implementation -
-    public function get autoIncrement():Boolean -
-
- - - - - -
dataTypeproperty 
-
-dataType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Gets the data type of the column as a string. The value is the literal data type name that was - specified in the CREATE TABLE statement that was used to define the table, or - null if no data type was specified. -

Implementation -
-    public function get dataType():String -
-
- - - - - -
defaultCollationTypeproperty 
-
-defaultCollationType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates the default collation sequence that is defined for this column. - The value of this property corresponds to one of the constants in the SQLCollationType class: -

    -
  • SQLCollationType.BINARY indicates that the column uses the - BINARY collation sequence.
    • -
  • SQLCollationType.NO_CASE indicates that the column uses the NOCASE - collation sequence, meaning that text comparisons are made in a case-insensitive manner.
    • -
-

Implementation -
-    public function get defaultCollationType():String -
-

-See also -

-
-flash.data.SQLCollationType -
-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Gets the name of the column. -

Implementation -
-    public function get name():String -
-
- - - - - -
primaryKeyproperty 
-
-primaryKey:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether this column is the primary key column (or one of the primary key columns - in a composite key) for its associated table. -

Implementation -
-    public function get primaryKey():Boolean -
-
- -
Constructor detail
- - - - - -
SQLColumnSchema()constructor
-
-public function SQLColumnSchema(name:String, primaryKey:Boolean, allowNull:Boolean, autoIncrement:Boolean, dataType:String, defaultCollationType:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Constructs a SQLColumnSchema instance. Generally, developer code does not call the SQLColumnSchema - constructor directly. To obtain schema information for a database, call the - SQLConnection.loadSchema() method. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
name:String — The name of the column. -
 
primaryKey:Boolean — Indicates whether this column is a part of the primary - key for the associated table. -
 
allowNull:Boolean — Indicates whether this column can contain NULL values. -
 
autoIncrement:Boolean — Indicates whether this is an auto increment column. -
 
dataType:String — The declared type of the column. -
 
defaultCollationType:String — The collation sequence defined for this column. - This value corresponds to one of the constants in the SQLCollationType class: -
    -
  • SQLCollationType.BINARY indicates that the column uses the - BINARY collation sequence.
    • -
  • SQLCollationType.NO_CASE indicates that the column uses the NOCASE - collation sequence, meaning text comparisons are made in a case-insensitive manner.
    • -
-
-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-flash.data.SQLCollationType -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLConnection.html b/html-docs/flash/data/SQLConnection.html deleted file mode 100644 index 26adb60..0000000 --- a/html-docs/flash/data/SQLConnection.html +++ /dev/null @@ -1,4713 +0,0 @@ - - - - - - - - -flash.data.SQLConnection (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLConnection
InheritanceSQLConnection Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A SQLConnection instance is used to manage the creation of and connection to local SQL database files - (local databases). - -

The functionality of the SQLConnection class falls into several categories:

- -
    -

  • A local SQL database file is created or opened by calling the open() method or the - SQLConnection instance to the SQLStatement's sqlConnection property.

    • -

  • The SQLConnection class also provides state for SQL statements, including a - mechanism for executing multiple statements in a transaction. Transactions are managed using the - begin(), commit(), and rollback() methods. In addition, the - setSavepoint(), releaseSavepoint(), and rollbackToSavepoint() methods - allow code to define and manage savepoints. These are used to subdivide transactions into sets of operations.

    • -

  • The SQLConnection class provides access to database schema information for connected - databases. A database's schema describes the definitions of its tables, columns, indices, and triggers. - See the loadSchema() method for more information.

    • - -

  • The SQLConnection class provides the ability to encrypt databases using AES with CCM. This provides - both authentication and privacy for data. To encrypt a database, a 16 byte key (specified using a - ByteArray) must be specified when the database is created. This key can later be changed - using the SQLConnection.reencrypt() method. Encryption imposes a performance penalty on - writes to and reads from the database. Encryption is applied to data stored on the disk, but not to a - temporary data cache in memory. Encryption is not supported for in-memory databases.

    • -

  • A SQLConnection instance can be used to receive database-level - event notifications and provide configuration control for - all aspects of a database, including cache page size, process canceling, and statement execution - options.

    • -
-

A SQLConnection instance operates in one of two distinct execution modes: asynchronous - and synchronous. To use synchronous execution, you use the open() method to connect to the - main database for the SQLConnection instance. To use asynchronous execution, use the openAsync() - method to connect to the main database for the instance.

-

When you're using asynchronous execution, you use event listeners or a Responder instance to - determine when an operation completes or fails. The operations run in the - background rather than in the main application thread, so the application continues - to run and respond to user interaction even while the database operations are being performed. Each - asynchronous SQLConnection instance executes SQL statements in its own thread.

-

In asynchronous execution mode, you begin a specific operation - by calling the appropriate method, and you can detect the completion (or failure) of the operation - by registering a listener for the appropriate event. Each operation has an associated event that - is dispatched when the operation completes successfully; for example, when an openAsync() - method call completes successfully (when the database connection is opened) the open - event is dispatched. When any operation fails, - an error event is dispatched. The SQLError instance in the SQLErrorEvent - object's error property contains information about the specific error, - including the operation that was being attempted and the reason the operation failed.

-

When you're using synchronous execution, you do not need to register event - listeners to determine when an operation completes or fails. To identify errors, - enclose the error-throwing statements in a try..catch block. Because - synchronous operations execute in the main execution thread, all application - functionality (including refreshing the screen and allowing mouse and keyboard - interaction) is paused while the database operation or operations are performed. - For long-running operations this can cause a noticeable pause in the application.

-

-

-See also -

-
-flash.data.SQLStatement -
-flash.events.SQLEvent -
-flash.events.SQLErrorEvent -
-flash.errors.SQLError -
-Quick Start: Working asynchronously with a local SQL database (Flex) -
-Quick Start: Working asynchronously with a local SQL database (Flash) -
-Quick Start: Working asynchronously with a local SQL database (HTML) -
-Quick Start: Working synchronously with a local SQL database (Flex) -
-Quick Start: Working synchronously with a local SQL database (Flash) -
-Quick Start: Working synchronously with a local SQL database (HTML) -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  autoCompact : Boolean -
[read-only] - Indicates whether autocompacting was enabled when the current database - was originally created (the value that was specified for the autoCompact - parameter in the open() or openAsync() call that created the - database).
-		SQLConnection
  cacheSize : uint -
- Provides access to the cache size for this connection, which represents the maximum number - of database disk pages that are held in memory at one time.
-		SQLConnection
  columnNameStyle : String -
- Indicates how column names are reported in the - result of a SELECT statement.
-		SQLConnection
  connected : Boolean -
[read-only] - Indicates whether the SQLConnection instance has an open connection - to a database file.
-		SQLConnection
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  inTransaction : Boolean -
[read-only] - Indicates whether this connection is currently involved in a transaction.
-		SQLConnection
  isSupported : Boolean -
[static][read-only] - Indicates whether SQLConnection class is supported on the current platform or not.
-		SQLConnection
  lastInsertRowID : Number -
[read-only] - The last generated row identifier created by a SQL INSERT - statement.
-		SQLConnection
  pageSize : uint -
[read-only] - Indicates the database page size (in bytes) that was specified when the current database - was originally created (the value that was specified for the pageSize - parameter in the open() or openAsync() call that created the - database).
-		SQLConnection
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  totalChanges : Number -
[read-only] - Contains the total number of data changes that have been made since the - connection to the database was opened.
-		SQLConnection
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLConnection()
-
- Creates a SQLConnection instance.
-		SQLConnection
   -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		SQLConnection
   -
-analyze(resourceName:String = null, responder:Responder = null):void -
-
- Gathers statistics about database indices and - stores them in the database.
-		SQLConnection
   -
-attach(name:String, reference:Object = null, responder:Responder = null, encryptionKey:ByteArray = null):void -
-
- Adds another database to the SQLConnection instance, giving the new database - the specified name.
-		SQLConnection
   -
-begin(option:String = null, responder:Responder = null):void -
-
- Begins a transaction within which all SQL statements executed against - the connection's database or databases are grouped.
-		SQLConnection
   -
-cancel(responder:Responder = null):void -
-
- Aborts all SQL statements that are currently executing on databases connected to the SQLConnection - instance.
-		SQLConnection
   -
-close(responder:Responder = null):void -
-
- Closes the current database connection.
-		SQLConnection
   -
-commit(responder:Responder = null):void -
-
- Commits an existing transaction, causing any actions performed by the transaction's - statements to be permanently applied to the database.
-		SQLConnection
   -
-compact(responder:Responder = null):void -
-
- Reclaims all unused space in the database.
-		SQLConnection
   -
-deanalyze(responder:Responder = null):void -
-
- Removes all statistical information created by a call to the - analyze() method.
-		SQLConnection
   -
-detach(name:String, responder:Responder = null):void -
-
- Detaches an additional database previously attached to the SQLConnection instance using - the attach() method.
-		SQLConnection
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-getSchemaResult():SQLSchemaResult -
-
- Provides access to the result of a call to the loadSchema() method.
-		SQLConnection
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-loadSchema(type:Class = null, name:String = null, database:String = "main", includeColumnSchema:Boolean = true, responder:Responder = null):void -
-
- Loads schema information from the connected database or any attached databases.
-		SQLConnection
   -
-open(reference:Object = null, openMode:String = "create", autoCompact:Boolean = false, pageSize:int = 1024, encryptionKey:ByteArray = null):void -
-
- Opens a synchronous connection to the database file at the specified location in the file system, - or creates and opens a new database file at the location, or creates and opens an - in-memory database.
-		SQLConnection
   -
-openAsync(reference:Object = null, openMode:String = "create", responder:Responder = null, autoCompact:Boolean = false, pageSize:int = 1024, encryptionKey:ByteArray = null):void -
-
- Opens an asynchronous connection to the database file at the specified location in the file system, - or creates and opens a new database file at the location, or creates and opens an - in-memory database.
-		SQLConnection
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-reencrypt(newEncryptionKey:ByteArray, responder:Responder = null):void -
-
- Changes the encryption key of an encrypted database.
-		SQLConnection
   -
-releaseSavepoint(name:String = null, responder:Responder = null):void -
-
- This method commits the SQL operations made since the most recent savepoint - or the named savepoint if a name is specified.
-		SQLConnection
   -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		SQLConnection
   -
-rollback(responder:Responder = null):void -
-
- Rolls back an existing transaction created using the begin() method, - meaning all changes made by any SQL statements in the transaction are discarded.
-		SQLConnection
   -
-rollbackToSavepoint(name:String = null, responder:Responder = null):void -
-
- Rolls back any SQL operations since the most recent savepoint or the named - savepoint if a name is specified.
-		SQLConnection
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setSavepoint(name:String = null, responder:Responder = null):void -
-
- Creates a savepoint, which is like a bookmark within a database transaction.
-		SQLConnection
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-analyze -
-		 - Dispatched when an analyze() operation - completes successfully.SQLConnection
   -
-attach -
-		 - Dispatched when an attach() method call's operation - completes successfully.SQLConnection
   -
-begin -
-		 - Dispatched when a begin() method call's operation - completes successfully.SQLConnection
   -
-cancel -
-		 - Dispatched when a cancel() method call's operation completes - successfully.SQLConnection
   -
-close -
-		 - Dispatched when a close() method call's operation - completes successfully.SQLConnection
   -
-commit -
-		 - Dispatched when a commit() method call's operation - completes successfully.SQLConnection
   -
-compact -
-		 - Dispatched when a compact() method call's operation - completes successfully.SQLConnection
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-deanalyze -
-		 - Dispatched when a deanalyze() method call's operation - completes successfully.SQLConnection
   -
-delete -
-		 - Dispatched when data in any table in any of the connected databases changes as a result - of a SQL DELETE command.SQLConnection
   -
-detach -
-		 - Dispatched when a detach() method call's operation - completes successfully.SQLConnection
   -
-error -
-		 - Dispatched when any of the SQLConnection object's asynchronous operations results - in an error.SQLConnection
   -
-insert -
-		 - Dispatched when data in any table in any of the connected databases changes as a result - of a SQL INSERT command.SQLConnection
   -
-open -
-		 - Dispatched when an openAsync() method call's operation - completes successfully.SQLConnection
   -
-reencrypt -
-		 - Dispatched when a reencrypt() method call's operation completes - successfully.SQLConnection
   -
-releaseSavepoint -
-		 - Dispatched when a releaseSavepoint() method call's operation - completes successfully.SQLConnection
   -
-rollback -
-		 - Dispatched when a rollback() method call's operation - completes successfully.SQLConnection
   -
-rollbackToSavepoint -
-		 - Dispatched when a rollbackToSavepoint() method call's operation - completes successfully.SQLConnection
   -
-schema -
-		 - Dispatched when a loadSchema() method call's operation completes - successfully and the schema results are ready.SQLConnection
   -
-setSavepoint -
-		 - Dispatched when a setSavepoint() method call's operation - completes successfully.SQLConnection
   -
-update -
-		 - Dispatched when data in any table in any of the connected databases changes as a result - of a SQL UPDATE command.SQLConnection
-
- -
- -
Property detail
- - - - - -
autoCompactproperty
-
-autoCompact:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether autocompacting was enabled when the current database - was originally created (the value that was specified for the autoCompact - parameter in the open() or openAsync() call that created the - database). If this property is true, unused space is removed from the database file - automatically after each write operation, keeping the database file smaller. If the property - is false, the space previously occupied by removed data is left in the database - file and reused when needed. Even when autoCompact is false, you can force the - database to reclaim unused space by calling the compact() method. -

If the connected property is false, this property - is set to false.

- Implementation -
-    public function get autoCompact():Boolean -
-

-See also -

-
-open() -
-openAsync() -
-
- - - - - -
cacheSizeproperty 
-
-cacheSize:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Provides access to the cache size for this connection, which represents the maximum number - of database disk pages that are held in memory at one time. Each page - uses about 1.5 KB of memory (depending on the value specified for the pageSize - parameter of the open() or openAsync() method call that created the - database). The default cache size is 2000. If an application is executing - UPDATE or DELETE operations that change many rows of a database, - increasing the cache size can improve speed at the cost of increased memory consumption. -

Implementation -
-    public function get cacheSize():uint -
-    public function set cacheSize(value:uint):void -
-
-Throws -
- - - - -
Error — When an attempt is made to set this - property while the SQLConnection instance isn't connected to a database (the - connected property is false); or if a transaction is currently open (the - inTransaction property is true). -
-

-See also -

-
-open() -
-openAsync() -
-
- - - - - -
columnNameStyleproperty 
-
-columnNameStyle:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates how column names are reported in the - result of a SELECT statement. -

The constants defined in the SQLColumnNameStyle class - represent the possible values for this property:

-
    -
  • SQLColumnNameStyle.LONG indicates that - column names are returned in the format [table-name]_[column-name].
    • -
  • SQLColumnNameStyle.SHORT specifies that column names are given - the format [column-name]. If there are multiple columns with the same name, - only one property with that name is added to the result object.
    • -
  • SQLColumnNameStyle.DEFAULT is the default value. When - this value is used, result column names are formatted according to the number of - tables in the SELECT statement that have similar column names. If the - SELECT statement includes only one table, the short name format - [column-name] is used, and if the SELECT - statement includes multiple tables joined together, whenever there is a naming collision - because two column names are identical, the long name format - [table-name]_[column-name] is used for the identically named columns.
    • -
- Implementation -
-    public function get columnNameStyle():String -
-    public function set columnNameStyle(value:String):void -
-
-Throws -
- - - - -
Error — When an attempt is made to set this - property while the SQLConnection instance isn't connected to a database (the - connected property is false). -
-

-See also -

-
-flash.data.SQLColumnNameStyle -
-
- - - - - -
connectedproperty 
-
-connected:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether the SQLConnection instance has an open connection - to a database file. -

Implementation -
-    public function get connected():Boolean -
-

-See also -

-
-open() -
-openAsync() -
-close() -
-
- - - - - -
inTransactionproperty 
-
-inTransaction:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether this connection is currently involved in a transaction. -

Implementation -
-    public function get inTransaction():Boolean -
-

-See also -

-
-begin() -
-commit() -
-rollback() -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Indicates whether SQLConnection class is supported on the current platform or not. -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
lastInsertRowIDproperty 
-
-lastInsertRowID:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The last generated row identifier created by a SQL INSERT - statement. A row identifier is used to uniquely identify a row in a table within - the database. The value is frequently generated by the database. -

The value is zero if no database is connected or no - INSERT statement has been executed.

-

The row identifier for a single SQL INSERT statement execution - can be obtained through the lastInsertRowID property of the SQLResult object - returned by the SQLStatement object's getResult() method (when called after the - SQLStatement dispatches its result event).

-

For more information on primary keys and generated row identifiers, - see the "CREATE TABLE" and - "Expressions" sections in the appendix - "SQL support in local databases."

- Implementation -
-    public function get lastInsertRowID():Number -
-

-See also -

-
-flash.data.SQLResult.lastInsertRowID -
-flash.events.SQLUpdateEvent.rowID -
-
- - - - - -
pageSizeproperty 
-
-pageSize:uint  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates the database page size (in bytes) that was specified when the current database - was originally created (the value that was specified for the pageSize - parameter in the open() or openAsync() call that created the - database). -

If the connected property is false, this property's - value is 0.

-

The page size for a database can be changed (using the open() or openAsync() - methods) until the first table is created in the database.

- Implementation -
-    public function get pageSize():uint -
-

-See also -

-
-open() -
-openAsync() -
-
- - - - - -
totalChangesproperty 
-
-totalChanges:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Contains the total number of data changes that have been made since the - connection to the database was opened. In addition to tracking changes - made by INSERT, DELETE, and UPDATE - statements, this value includes changes caused by triggers. -

When the database connection is closed, the value is - reset to 0. When the SQLConnection instance isn't connected - to a database, the value is 0.

- Implementation -
-    public function get totalChanges():Number -
-

-See also -

-
-flash.data.SQLResult.rowsAffected -
-
- -
Constructor detail
- - - - - -
SQLConnection()constructor
-
-public function SQLConnection() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLConnection instance. -


-Throws - - - - -
SecurityError — if constructor is called from any sandbox outside - of the main application sandbox. - -
-
- -
Method detail
- - - - - -
addEventListener()method
-
-public override function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event. You can register event listeners on all nodes in the - display list for a specific type of event, phase, and priority. - -

JavaScript code in the AIR runtime uses this method to register - event listeners for events defined by the AIR APIs. For other JavaScript events (such as the onload - event of the DOM body object), you can use standard event handling techniques, as you would - for content running in the browser.

- -

After you successfully register an event listener, you cannot change its priority - through additional calls to addEventListener(). To change a listener's - priority, you must first call removeListener(). Then you can register the - listener again with the new priority level.

- -

Keep in mind that after the listener is registered, subsequent calls to - addEventListener() with a different type or - useCapture value result in the creation of a separate listener registration. - For example, if you first register a listener with useCapture set to - true, it listens only during the capture phase. If you call - addEventListener() again using the same listener object, but with - useCapture set to false, you have two separate listeners: one - that listens during the capture phase and another that listens during the target and - bubbling phases. -

- -

You cannot register an event listener for only the target phase or the bubbling - phase. Those phases are coupled during registration because bubbling - applies only to the ancestors of the target node.

- -

If you no longer need an event listener, remove it by calling - removeEventListener(), or memory problems could result. Event listeners are not automatically - removed from memory because the garbage - collector does not remove the listener as long as the dispatching object exists (unless the useWeakReference - parameter is set to true).

- -

Copying an EventDispatcher instance does not copy the event listeners attached to it. - (If your newly created node needs an event listener, you must attach the listener after - creating the node.) However, if you move an EventDispatcher instance, the event listeners - attached to it move along with it.

- - -

If the event listener is being registered on a node while an event is being processed - on this node, the event listener is not triggered during the current phase but can be - triggered during a later phase in the event flow, such as the bubbling phase.

- -

If an event listener is removed from a node while an event is being processed on the node, - it is still triggered by the current actions. After it is removed, the event listener is - never invoked again (unless registered again for future processing).

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener function that processes the event. This function must accept - an Event object as its only parameter and must return nothing, as this example shows: - . - - 
function(evt:Event):void
- -

The function can have any name.

- -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Determines whether the listener works in the capture phase or the - target and bubbling phases. If useCapture is set to true, - the listener processes the event only during the capture phase and not in the - target or bubbling phase. If useCapture is false, the - listener processes the event only during the target or bubbling phase. To listen for - the event in all three phases, call addEventListener twice, once with - useCapture set to true, then again with - useCapture set to false. - -
 
priority:int (default = 0) — The priority level of the event listener. The priority is designated by - a signed 32-bit integer. The higher the number, the higher the priority. All listeners - with priority n are processed before listeners of priority n-1. If two - or more listeners share the same priority, they are processed in the order in which they - were added. The default priority is 0. - -
 
useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or - weak. A strong reference (the default) prevents your listener from being garbage-collected. - A weak reference does not.

Class-level member functions are not subject to garbage - collection, so you can set useWeakReference to true for - class-level member functions without subjecting them to garbage collection. If you set - useWeakReference to true for a listener that is a nested inner - function, the function will be garbage-collected and no longer persistent. If you create - references to the inner function (save it in another variable) then it is not - garbage-collected and stays persistent.

-
-
- - - - - -
analyze()method 
-
-public function analyze(resourceName:String = null, responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Gathers statistics about database indices and - stores them in the database. These statistics can then be used by the query optimizer - (the portion of the database engine that determines the most efficient way to - execute each statement). The statistics help the query optimizer make better - choices about which index or indices to use when executing a particular query. -

If a database has indices defined, but the analyze() method hasn't - been called, the runtime still uses those indices to execute statements. However, - without the additional statistical information generated by the analyze() method, - the runtime may not choose the most efficient index for a particular query.

-

When a table's data changes (as a result of INSERT, UPDATE, - or DELETE statements) the indices associated with that table change as well. - The statistical information generated by analyze() is not automatically - updated. Consequently, after a large number of data changes, calling the - analyze() method again might be beneficial. However, the benefit obtained - from calling analyze() again depends on several factors, including the - number of indices defined on a table, the relationship between the number of changed - rows and the total number of rows in the table, how much variation there is in the - table's indexed data, and how different the changed data is from the prechange data.

-

The resourceName parameter indicates whether the operation is - performed on the indices of all attached databases, a specific database, or a specific - table.

-

Each time this method is called, any previously created statistical - data is purged and recreated for the database or table specified in the resourceName - parameter (or all tables in all connected databases if resourceName is null). - This method can be called at any time - while a database connection is open. The analyze() operation and its statistical - data are not included in a transaction; however, it is best - not to call analyze() when the database has a current transaction (the - inTransaction property is true). This is because any data, table schema, - or index changes that have been executed in the transaction but not yet committed - are not taken into account by the analyze() call, and the - analyze() data is out of date as soon as the transaction is committed.

-

To remove the statistical data created with the analyze() method, use - the deanalyze() method.

- Parameters - - - - - - - - - - -
resourceName:String (default = null) — The name of the database or - table whose indices are to be analyzed. If the specified resource is a table - whose name is unique among all the attached databases, only the table name needs - to be specified. However, a table name can be specified in the form - [database-name].[table-name] to prevent ambiguity when the table name - is not unique. If the resourceName parameter is null - (the default), all the indices in all attached databases are analyzed. -
 
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null an analyze - or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
analyze:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous execution mode.
-
-Throws - - - - - - - - - - -
Error — When this method is called while the SQLConnection instance - isn't connected to a database (the connected property is false). -
 
SQLError — if the operation fails in synchronous execution mode. -
-

-See also -

-
-deanalyze() -
-
- - - - - -
attach()method 
-
-public function attach(name:String, reference:Object = null, responder:Responder = null, encryptionKey:ByteArray = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Adds another database to the SQLConnection instance, giving the new database - the specified name. Attaching a database allows that database to be used in SQL - statements executed against this SQLConnection instance. -

If a database is already attached using the specified name, calling attach() - results in an error. However, the same database may - be attached multiple times using unique names. Only ten databases can be attached - to a single SQLConnection instance.

-

Any SQL statement can be executed on a database connected using - attach() that can be executed on the main database (the database - connected using open() or openAsync()). - A SQL statement can access tables in any of the databases attached to the - statement's associated SQLConnection instance, including accessing tables from - multiple databases in a single statement. When the runtime is resolving table names - in a statement, it searches through the SQLConnection instance's databases in the order - in which the databases were attached, starting with the database that was connected - using the open() or openAsync() method. Use the database name (as specified in the - attach() method's name parameter) in the statement - to explicitly qualify a table name.

-

To remove a database attached using the attach() method, - use the detach() method. When the SQLConnection instance is closed (by - calling the close() method), all - attached databases are detached.

-

The attached database uses the same execution mode (synchronous or asynchronous) as - the main database, depending on whether the main database was connected using the open() - method or the openAsync() method.

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
name:String — The name that is used to identify the newly attached database. - This name can be used in SQL statements to explicitly indicate that a table belongs - to the specified database, when using the format [database-name].[table-name]. - The names "main" and "temp" are reserved and cannot be used. -
 
reference:Object (default = null) — A reference to the database file to attach - (a flash.filesystem.File instance). If the reference refers to a file that doesn't exist, either - a new database file is created or an error is thrown according to the value that was specified for the - openMode parameter in the open() or openAsync() call that - connected the main database. -

If the parameter's value is null, an in-memory database is created and attached.

-
 
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null an attach - or error event is dispatched when execution completes. - -
 
encryptionKey:ByteArray (default = null) — The encryption key for the database file. - If the attach() call creates a database, the database is encrypted and the - specified key is used as the encryption key for the database. If the call attaches an - existing encrypted database, the value must match the database's encryption key or an error occurs. - If the database being attached is not encrypted, or to create an unencrypted database, - the value must be null (the default). - -

A valid encryption key is 16 bytes long. An in-memory database cannot be encrypted, so this - parameter must be null when the reference parameter's value is - null.

- -

When attaching an encrypted database, if the encryption key provided doesn't match the - database's encryption key, an exception occurs. In synchronous execution mode, a SQLError - exception is thrown. In asynchronous execution mode, a SQLErrorEvent is dispatched, and the event - object's error property contains a SQLError instance. In either case, the - SQLError object's errorID property is 3138 ("File opened is not a database file").

- -

The encryptionKey parameter is available starting with AIR 1.5.

- -
-
-Events - - - - - - - - - - -
attach:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous execution mode.
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — When the name parameter is an empty string ("") - or null - -
 
ArgumentError — When the value specified for the reference parameter is not a - flash.filesystem.File instance - -
 
ArgumentError — When the encryptionKey argument is not null and - its length is not 16 bytes - -
 
ArgumentError — When the reference parameter is null and the - encryptionKey argument is not null -
 
Error — When the SQLConnection instance isn't connected to a database - (the connected property is false); - or if a transaction is currently open (the inTransaction property is true). -
 
SQLError — if the operation fails in synchronous execution mode. -
-

-See also -

-
-open() -
-openAsync() -
-detach() -
-
- - - - - -
begin()method 
-
-public function begin(option:String = null, responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Begins a transaction within which all SQL statements executed against - the connection's database or databases are grouped. -

By default, each SQL statement - is executed within its own transaction, and the transaction ends when - the statement's execution succeeds or fails. Creating a transaction using the - begin() method causes a new, manual transaction to be created. - From that point on, all SQL statements executed against the SQLConnection instance - take place within the transaction, and any actions or modifications performed - by the statements can be committed (made permanent) or rolled back (undone) as - a group.

-

To end a transaction, call the commit() or - rollback() method, depending on whether the changes made by the - transactions' statements are to be made permanent or discarded.

- -

Nested calls to begin() are ignored. You can create savepoints, - which are like bookmarks within a transaction, by calling the - setSavepoint() method. You can then partially commit or roll back - SQL statements by calling the releaseSavepoint() or - rollbackToSavepoint() methods. However, if a transaction is started - by calling begin(), changes are not permanently committed to the - database until the commit() method is called.

-

If the database connection closes while a transaction is currently open, - AIR rolls back the transaction automatically. (Note: for AIR 1.1 and previous - versions, an open transaction is automatically committed when a connection - closes.)

-

A transaction is not limited to statement executions in a single - database; it can include statements executed on different attached - databases.

- Parameters - - - - - - - - - - -
option:String (default = null) — Indicates the locking strategy that is used by - the transaction. The value can be one of the constants defined - in the SQLTransactionLockType class: -
    -
  • SQLTransactionLockType.DEFERRED indicates that a lock is not acquired - until the first read or write operation.
    • -
  • SQLTransactionLockType.EXCLUSIVE indicates that a lock is acquired as soon - as possible, and no other SQLConnection instance can read from or write to the database.
    • -
  • SQLTransactionLockType.IMMEDIATE indicates that a lock is acquired as soon - as possible, in which other SQLConnection instances can read from but can't write to the database.
    • -
-

The default value (null) is equivalent to SQLTransactionLockType.DEFERRED.

-
 
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null a begin - or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
begin:SQLEvent — Dispatched when the operation completes.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous execution mode.
-
-Throws - - - - - - - - - - - - - - - - -
Error — When this method is called while the SQLConnection instance - isn't connected to a database (the connected property is false). -
 
ArgumentError — If the option specified is not one of the SQLTransactionLockType - constants. -
 
SQLError — if the operation fails in synchronous execution mode. -
-

-See also -

-
-commit() -
-rollback() -
-setSavepoint() -
-releaseSavepoint() -
-rollbackToSavepoint() -
-flash.data.SQLTransactionLockType -
-
-Example -
The following example demonstrates executing multiple SQL INSERT - statements within a transaction. First a row is added to the "employees" table. Next the - primary key of the newly inserted row is retrieved, and used to add a row to the related - "phoneNumbers" table. -
-
-package
-{
-    import flash.data.SQLConnection;
-	import flash.data.SQLResult;
-	import flash.data.SQLStatement;
-	import flash.display.Sprite;
-	import flash.events.SQLErrorEvent;
-	import flash.events.SQLEvent;
-	import flash.filesystem.File;
-	
-	public class MultiInsertTransactionExample extends Sprite
-	{
-		private var conn:SQLConnection;
-		private var insertEmployee:SQLStatement;
-		private var insertPhoneNumber:SQLStatement;
-		
-		public function MultiInsertTransactionExample():void
-		{
-			// define where to find the database file
-			var appStorage:File = File.applicationStorageDirectory;
-			var dbFile:File = appStorage.resolvePath("ExampleDatabase.db");
-			
-			// open the database connection
-			conn = new SQLConnection();
-			conn.addEventListener(SQLErrorEvent.ERROR, errorHandler);
-			conn.addEventListener(SQLEvent.OPEN, openHandler);
-			conn.openAsync(dbFile);
-		}
-		
-		// Called when the database is connected
-		private function openHandler(event:SQLEvent):void
-		{
-			conn.removeEventListener(SQLEvent.OPEN, openHandler);
-			
-			// start a transaction
-			conn.addEventListener(SQLEvent.BEGIN, beginHandler);
-			conn.begin();
-		}
-		
-		// Called when the transaction begins
-		private function beginHandler(event:SQLEvent):void
-		{
-			conn.removeEventListener(SQLEvent.BEGIN, beginHandler);
-			
-			// create and execute the first SQL statement:
-			// insert an employee record
-			insertEmployee = new SQLStatement();
-			insertEmployee.sqlConnection = conn;
-			insertEmployee.text = 
-				"INSERT INTO employees (lastName, firstName, email) " + 
-				"VALUES (:lastName, :firstName, :email, :birthday)";
-			insertEmployee.parameters[":lastName"] = "Smith";
-			insertEmployee.parameters[":firstName"] = "Bob";
-			insertEmployee.parameters[":email"] = "bsmith@example.com";
-			insertEmployee.parameters[":birthday"] = new Date(1971, 8, 12);
-			
-			insertEmployee.addEventListener(SQLEvent.RESULT, insertEmployeeHandler);
-			insertEmployee.addEventListener(SQLErrorEvent.ERROR, errorHandler);
-			
-			insertEmployee.execute();
-		}
-		
-		// Called after the employee record is inserted
-		private function insertEmployeeHandler(event:SQLEvent):void
-		{
-			insertEmployee.removeEventListener(SQLEvent.RESULT, insertEmployeeHandler);
-			insertEmployee.removeEventListener(SQLErrorEvent.ERROR, errorHandler);
-			
-			// Get the employee id of the newly created employee row
-			var result:SQLResult = insertEmployee.getResult();
-			var employeeId:Number = result.lastInsertRowID;
-			
-			// Add a phone number to the related phoneNumbers table
-			insertPhoneNumber = new SQLStatement();
-			insertPhoneNumber.sqlConnection = conn;
-			insertPhoneNumber.text =
-				"INSERT INTO phoneNumbers (employeeId, type, number) " +
-				"VALUES (:employeeId, :type, :number)";
-			insertPhoneNumber.parameters[":employeeId"] = employeeId;
-			insertPhoneNumber.parameters[":type"] = "Home";
-			insertPhoneNumber.parameters[":number"] = "(555) 555-1234";
-			
-			insertPhoneNumber.addEventListener(SQLEvent.RESULT, insertPhoneNumberHandler);
-			insertPhoneNumber.addEventListener(SQLErrorEvent.ERROR, errorHandler);
-			
-			insertPhoneNumber.execute();
-		}
-		
-		// Called after the phone number record is inserted
-		private function insertPhoneNumberHandler(event:SQLEvent):void
-		{
-			insertPhoneNumber.removeEventListener(SQLEvent.RESULT, insertPhoneNumberHandler);
-			insertPhoneNumber.removeEventListener(SQLErrorEvent.ERROR, errorHandler);
-			
-			// No errors so far, so commit the transaction
-			conn.addEventListener(SQLEvent.COMMIT, commitHandler);
-			conn.commit();
-		}
-		
-		// Called after the transaction is committed
-		private function commitHandler(event:SQLEvent):void
-		{
-			conn.removeEventListener(SQLEvent.COMMIT, commitHandler);
-			
-			trace("Transaction complete");
-		}
-		
-		// Called whenever an error occurs
-		private function errorHandler(event:SQLErrorEvent):void
-		{
-			// If a transaction is happening, roll it back
-			if (conn.inTransaction)
-			{
-				conn.addEventListener(SQLEvent.ROLLBACK, rollbackHandler);
-				conn.rollback();
-			}
-			
-			trace(event.error.message);
-			trace(event.error.details);
-		}
-		
-		// Called when the transaction is rolled back
-		private function rollbackHandler(event:SQLEvent):void
-		{
-			conn.removeEventListener(SQLEvent.ROLLBACK, rollbackHandler);
-			
-			// add additional error handling, close the database, etc.
-		}
-	}
-}
-
-

The following example demonstrates executing multiple SQL DELETE - statements within a transaction. The transaction is used to delete an employee record. - First the related rows in the "phoneNumbers" table are deleted. Next the employee - record row is deleted from the "employees" table. -
-
-package
-{
-    import flash.data.SQLConnection;
-	import flash.data.SQLResult;
-	import flash.data.SQLStatement;
-	import flash.display.Sprite;
-	import flash.events.SQLErrorEvent;
-	import flash.events.SQLEvent;
-	import flash.filesystem.File;
-	
-	public class MultiDeleteTransactionExample extends Sprite
-	{
-		private var conn:SQLConnection;
-		private var deleteEmployee:SQLStatement;
-		private var deletePhoneNumbers:SQLStatement;
-		
-		private var employeeIdToDelete:Number = 25;
-		
-		public function MultiDeleteTransactionExample():void
-		{
-			// define where to find the database file
-			var appStorage:File = File.applicationStorageDirectory;
-			var dbFile:File = appStorage.resolvePath("ExampleDatabase.db");
-			
-			// open the database connection
-			conn = new SQLConnection();
-			conn.addEventListener(SQLErrorEvent.ERROR, errorHandler);
-			conn.addEventListener(SQLEvent.OPEN, openHandler);
-			conn.openAsync(dbFile);
-		}
-		
-		// Called when the database is connected
-		private function openHandler(event:SQLEvent):void
-		{
-			conn.removeEventListener(SQLEvent.OPEN, openHandler);
-			
-			// start a transaction
-			conn.addEventListener(SQLEvent.BEGIN, beginHandler);
-			conn.begin();
-		}
-		
-		// Called when the transaction begins
-		private function beginHandler(event:SQLEvent):void
-		{
-			conn.removeEventListener(SQLEvent.BEGIN, beginHandler);
-			
-			// Create and execute the first SQL statement:
-			// Delete an employee's phone number records
-			deletePhoneNumbers = new SQLStatement();
-			deletePhoneNumbers.sqlConnection = conn;
-			deletePhoneNumbers.text =
-				"DELETE FROM phoneNumbers " +
-				"WHERE employeeId = :employeeId";
-			deletePhoneNumbers.parameters[":employeeId"] = employeeIdToDelete;
-			
-			deletePhoneNumbers.addEventListener(SQLEvent.RESULT, deletePhoneNumbersHandler);
-			deletePhoneNumbers.addEventListener(SQLErrorEvent.ERROR, errorHandler);
-			
-			deletePhoneNumbers.execute();
-		}
-		
-		// Called after the phone number records are deleted
-		private function deletePhoneNumbersHandler(event:SQLEvent):void
-		{
-			deletePhoneNumbers.removeEventListener(SQLEvent.RESULT, deletePhoneNumbersHandler);
-			deletePhoneNumbers.removeEventListener(SQLErrorEvent.ERROR, errorHandler);
-			
-			deleteEmployee = new SQLStatement();
-			deleteEmployee.sqlConnection = conn;
-			deleteEmployee.text = 
-				"DELETE FROM employees " + 
-				"WHERE employeeId = :employeeId";
-			deleteEmployee.parameters[":employeeId"] = employeeIdToDelete;
-			
-			deleteEmployee.addEventListener(SQLEvent.RESULT, deleteEmployeeHandler);
-			deleteEmployee.addEventListener(SQLErrorEvent.ERROR, errorHandler);
-			
-			deleteEmployee.execute();
-		}
-		
-		// Called after the employee record is deleted
-		private function deleteEmployeeHandler(event:SQLEvent):void
-		{
-			deleteEmployee.removeEventListener(SQLEvent.RESULT, deleteEmployeeHandler);
-			deleteEmployee.removeEventListener(SQLErrorEvent.ERROR, errorHandler);
-			
-			// No errors so far, so commit the transaction
-			conn.addEventListener(SQLEvent.COMMIT, commitHandler);
-			conn.commit();
-		}
-		
-		// Called after the transaction is committed
-		private function commitHandler(event:SQLEvent):void
-		{
-			conn.removeEventListener(SQLEvent.COMMIT, commitHandler);
-			
-			trace("Transaction complete");
-		}
-		
-		// Called whenever an error occurs
-		private function errorHandler(event:SQLErrorEvent):void
-		{
-			// If a transaction is happening, roll it back
-			if (conn.inTransaction)
-			{
-				conn.addEventListener(SQLEvent.ROLLBACK, rollbackHandler);
-				conn.rollback();
-			}
-			
-			trace(event.error.message);
-			trace(event.error.details);
-		}
-		
-		// Called when the transaction is rolled back
-		private function rollbackHandler(event:SQLEvent):void
-		{
-			conn.removeEventListener(SQLEvent.ROLLBACK, rollbackHandler);
-			
-			// add additional error handling, close the database, etc.
-		}
-	}
-}
-
-

-
- - - - - -
cancel()method 
-
-public function cancel(responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Aborts all SQL statements that are currently executing on databases connected to the SQLConnection - instance. This method can be used to stop long running or runaway queries. -

If there are statements executing when the cancel() method is called, this method - aborts the statements' operations and any incomplete updates or transactions are rolled back. - If there are no statements currently executing, calling this method rolls back an open transaction - but otherwise does nothing.

- Parameters - - - - -
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null a cancel - or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
cancel:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous execution mode.
-
-Throws - - - - - - - - - - -
Error — When this method is called while the SQLConnection instance - isn't connected to a database (the connected property is false). -
 
SQLError — If the operation fails in synchronous execution mode. -
-

-See also -

-
-flash.data.SQLStatement -
-
- - - - - -
close()method 
-
-public function close(responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Closes the current database connection. Any attached databases are - detached as well. -

If there is an open - transaction when close() is called, the transaction is rolled back. - When a SQLConnection instance is - garbage-collected, the runtime calls close() automatically, including - if an AIR application is closed while a SQLConnection is still connected to a database.

- Parameters - - - - -
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null a close - or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
close:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous execution mode.
-
-Throws - - - - -
SQLError — If the operation fails in synchronous execution mode. -
-
- - - - - -
commit()method 
-
-public function commit(responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Commits an existing transaction, causing any actions performed by the transaction's - statements to be permanently applied to the database. -

Intermediate savepoints, which are like bookmarks in a transaction, can be created - by calling the setSavepoint() method. Using savepoints you can commit - portions of a transaction by calling the releaseSavepoint() - method, or roll back portions of a transaction by calling the - rollbackToSavepoint() method. However, - if a transaction is opened using the begin() method, changes are not - permanently saved to the database until the entire transaction is - committed by calling the commit() method.

- -

For a transaction that uses savepoints, any statements that were rolled back - using the rollbackToSavepoint() method are not committed when the - entire transaction is committed. Statements that were committed using - releaseSavepoint() or whose savepoints weren't released or rolled back - are committed to the database.

- - Parameters - - - - -
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null a commit - or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
commit:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation completes with a failure.
-
-Throws - - - - -
Error — When the method is called while the SQLConnection - instance isn't connected to a database (the connected property is - false); or if no transaction is currently open (the - inTransaction property is false). -
-

-See also -

-
-begin() -
-rollback() -
-setSavepoint() -
-releaseSavepoint() -
-rollbackToSavepoint() -
-
- - - - - -
compact()method 
-
-public function compact(responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Reclaims all unused space in the database. When an object (table, index, or trigger) is - dropped from the database, it leaves behind empty space. This makes the database file - larger than it needs to be, but can speed up INSERT operations. - Over time, INSERT and DELETE operations can leave the database - file structure fragmented, which slows down disk access to the database contents. This - method compacts the database file, eliminating free pages, aligning table data to be - contiguous, and otherwise cleaning up the database file structure. -

The compact() operation can't be performed on an attached database file; - it can only be performed on the main (original) database file opened by the SQLConnection - instance. This operation fails if there is an active transaction, and has no effect - on an in-memory database.

- Parameters - - - - -
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null a compact - or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
compact:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous execution mode.
-
-Throws - - - - - - - - - - -
Error — If the method is called while the SQLConnection instance - isn't connected to a database (the connected property is false); - or if a transaction is currently in progress (the inTransaction - property is true). -
 
SQLError — If the operation fails in synchronous execution mode. -
-
- - - - - -
deanalyze()method 
-
-public function deanalyze(responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Removes all statistical information created by a call to the - analyze() method. -

Because the statistics generated by the analyze() method take up space in - a database, calling deanalyze() allows you to reclaim that space, such as - after dropping several indices or tables.

-

This operation is not included in an active transaction.

- Parameters - - - - -
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null a deanalyze - or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
deanalyze:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous execution mode.
-
-Throws - - - - - - - - - - -
Error — When this method is called while the SQLConnection instance - isn't connected to a database (the connected property is false). -
 
SQLError — If the operation fails in synchronous execution mode. -
-

-See also -

-
-analyze() -
-
- - - - - -
detach()method 
-
-public function detach(name:String, responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Detaches an additional database previously attached to the SQLConnection instance using - the attach() method. It is possible to have the same database - attached multiple times using different names, and detaching one - connection leaves the others intact. A database cannot be detached - if the connection has an open transaction (if the inTransaction - property is true). -

Parameters - - - - - - - - - - -
name:String — The given name of the database to detach. -
 
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null a detach - or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
detach:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous execution mode.
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — If the name argument is null or contains - an empty string (""). -
 
Error — If this method is called while the SQLConnection instance - isn't connected to a database (the connected property is false); or - if the SQLConnection instance has an open transaction (the inTransaction - property is true). -
 
SQLError — If the operation fails in synchronous execution mode. -
-

-See also -

-
-attach() -
-
- - - - - -
getSchemaResult()method 
-
-public function getSchemaResult():SQLSchemaResult -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Provides access to the result of a call to the loadSchema() method. - The getSchemaResult() method behaves as a first-in, first-out queue of - results. Each time the loadSchema() method call completes (each time the - schema event is dispatched in asynchronous execution mode), - a new SQLSchemaResult object is added to the queue. - Each time the getSchemaResult() method - is called, the earliest result (the one that was added to the queue first) is returned and removed - from the queue. When there are no more objects left in the queue, getSchemaResult() - returns null. -

When the database connection is closed the method returns null.

-

-Returns - - - - -
SQLSchemaResult
-

-See also -

-
-loadSchema() -
-schema -
-
- - - - - -
loadSchema()method 
-
-public function loadSchema(type:Class = null, name:String = null, database:String = "main", includeColumnSchema:Boolean = true, responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Loads schema information from the connected database or any attached databases. - The schema indicates the structure of the database's tables, columns, indices, and triggers. -

To access the loaded schema use the SQLConnection.getSchemaResult() method.

-

In asynchronous execution mode, a schema event is dispatched if the operation - is successful, or an error event is dispatched if the operation fails.

-

The combination of the type and name parameter values determines the - type of schema data that's generated by the loadSchema() method and, consequently, the - values of the properties of the SQLSchemaResult instance that's generated. The following - table lists the valid type and name pairs and the schema data that's - generated as a result:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type argumentname argumentRetrieves schema data for:
nullnullall objects in the database (all tables, views, triggers, and indices)
SQLIndexSchemanullall indices in the database
SQLIndexSchemavalid table nameall indices defined on the specified table
SQLIndexSchemavalid index namethe specified index
SQLTableSchemanullall tables in the database
SQLTableSchemavalid table namethe specified table
SQLTriggerSchemanullall triggers in the database
SQLTriggerSchemavalid table nameall triggers associated with the specified table
SQLTriggerSchemavalid view nameall triggers associated with the specified view
SQLTriggerSchemavalid trigger namethe specified trigger
SQLViewSchemanullall views in the database
SQLViewSchemavalid view namethe specified view
-

If the combination of type and name arguments does not correspond to - one of the specified combinations, an error event is dispatched in asynchronous - execution mode or an exception is thrown in synchronous execution mode. - For instance, if the type argument is SQLViewSchema and the name - argument is the name of a table (rather than the name of a view), an error is raised indicating that - the database doesn't contain an object of the specified type with the specified name.

- -

If the database is empty (it doesn't contain any tables, views, triggers, - or indices), calling the loadSchema() method results in an error.

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:Class (default = null) — Indicates the type of schema to load. A null value (the - default) indicates that all the schema information should be loaded. - Specifying a non-null value for this parameter narrows the scope of the - resulting schema, removing potentially unneeded information from the results - and making the operation more efficient. The value must be the class name of - one of the following classes: -
    -
  • SQLIndexSchema
    • -
  • SQLTableSchema
    • -
  • SQLTriggerSchema
    • -
  • SQLViewSchema
    • -
-
 
name:String (default = null) — Indicates which resource's schema is loaded. How this value is - used depends on the type argument specified. Typically, this is the name of a database - object such as a table name, an index or view name, and so forth. If a value is specified, - only schema information for the database object with the specified name is included in the - result. -

If the specified value is not valid an error event is - dispatched (or an error is thrown in synchronous execution mode). The type parameter - value must correspond to the type of the object named in order for the value to be valid, as described - in the method description.

-

If the name argument is null then all schemata of the specified - type are included. If the value specified is not valid an error event is dispatched.

-
 
database:String (default = "main") — The name of the database whose schema is loaded. If the value specified - is not valid an error event is dispatched. -
 
includeColumnSchema:Boolean (default = true) — Indicates whether the result includes schema information for the - columns of tables and views. -
 
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null a schema - or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
schema:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation completes with a failure.
-
-Throws - - - - - - - - - - - - - - - - -
Error — When the method is called while the SQLConnection instance - isn't connected to a database (the connected property is false). -
 
ArgumentError — When the specified type argument value isn't - one of the allowed types. -
 
SQLError — When using synchronous execution mode, if an invalid value is supplied for the name - or database parameters. -
-

-See also -

-
-getSchemaResult() -
-schema -
-flash.data.SQLIndexSchema -
-flash.data.SQLTableSchema -
-flash.data.SQLTriggerSchema -
-flash.data.SQLViewSchema -
-
- - - - - -
open()method 
-
-public function open(reference:Object = null, openMode:String = "create", autoCompact:Boolean = false, pageSize:int = 1024, encryptionKey:ByteArray = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Opens a synchronous connection to the database file at the specified location in the file system, - or creates and opens a new database file at the location, or creates and opens an - in-memory database. The operations of creating and opening the database, as well as all other operations - that are performed using this SQLConnection instance (including statement execution and other operations - performed by a SQLStatement instance associated with this SQLConnection instance) are performed - synchronously when the database is opened using this method. To perform operations - asynchronously, open the database connection using the openAsync() method instead. - -

Once a database is connected, use a SQLStatement instance to execute SQL commands. - Database-level operations such as beginning or ending transactions, loading schema information, - and other operations are performed using the SQLConnection instance.

-

A database that is connected using the open() method is automatically - assigned the database name "main". That name can be used to explicitly qualify - table names in SQL statements using the format [database-name].[table-name].

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
reference:Object (default = null) — The location of the database file that is opened. This value must be - a flash.filesystem.File instance. If the parameter's value is null, an in-memory database - is created and opened. -
 
openMode:String (default = "create") — Indicates how the database is opened. The value can be any of the - constants defined in the SQLMode class. The default value is - SQLMode.CREATE, indicating that if a database file is not found at the specified - location, one is created. If openMode is SQLMode.READ and - the specified file does not exist then an error occurs. This parameter is ignored - when the reference parameter is null. -
 
autoCompact:Boolean (default = false) — Indicates whether unused space in the database is reclaimed automatically. - This parameter is only valid when creating a new database file or opening a database file in which - no tables have been created. By default, the space taken up by removed data is left in the database - file and reused when needed. Setting this parameter to true causes the database to - automatically reclaim unused space. This can negatively affect performance because it requires - additional processing each time data is written to the database and can also cause the - database data to become fragmented over time. - At any time you can force the database to reclaim unused space in a database file and - defragment the database file using the compact() method. -

This parameter is ignored when the openMode parameter is SQLMode.READ.

-
 
pageSize:int (default = 1024) — Indicates the page size (in bytes) for the database. This parameter is - only valid when creating a new database file or opening a database file in which - no tables have been created. The value must be a power of two greater than or equal to - 512 and less than or equal to 32768. The default value is 1024 bytes. This value can only be set - before any tables are created. Once the tables are created attempting to change this value - results in an error. -
 
encryptionKey:ByteArray (default = null) — The encryption key for the database file. - If the open() call creates a database, the database is encrypted and the - specified key is used as the encryption key for the database. If the call opens an - encrypted database, the value must match the database's encryption key or an error occurs. - If the database being opened is not encrypted, or to create an unencrypted database, - the value must be null (the default) or an error occurs. - -

A valid encryption key is 16 bytes long. An in-memory database cannot be encrypted, so this - parameter must be null when the reference parameter's value is - null.

- -

When opening an encrypted database, if the encryption key provided doesn't match the - database's encryption key, a SQLError exception is thrown. In that case the SQLError object's - errorID property is 3138 ("File opened is not a database file").

- -

The encryptionKey parameter is available starting with AIR 1.5.

- -
-
-Events - - - - -
open:SQLEvent — Dispatched when the operation completes successfully.
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — When the SQLConnection instance already has an open connection - to a database (the connected property is true). -
 
SQLError — If the operation fails. The connection is never left open after a failed - operation. -
 
ArgumentError — When the value specified for the reference parameter is not a - flash.filesystem.File instance - -
 
ArgumentError — When the encryptionKey argument is not null and - its length is not 16 bytes - -
 
ArgumentError — When the reference parameter is null and the - encryptionKey argument is not null -
 
ArgumentError — If an invalid pageSize parameter is specified. - This includes passing a page size when the mode is SQLMode.READ. - -
-

-See also -

-
-openAsync() -
-close() -
-flash.data.SQLMode -
-
- - - - - -
openAsync()method 
-
-public function openAsync(reference:Object = null, openMode:String = "create", responder:Responder = null, autoCompact:Boolean = false, pageSize:int = 1024, encryptionKey:ByteArray = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Opens an asynchronous connection to the database file at the specified location in the file system, - or creates and opens a new database file at the location, or creates and opens an - in-memory database. The operations of creating and opening the database, as well as all other operations - that are performed using this SQLConnection instance (including statement execution and other operations - performed by a SQLStatement instance associated with this SQLConnection instance) are performed - asynchronously when the database is opened using this method. To perform operations - synchronously, open the database connection using the open() method instead. -

Once a database is connected, use a SQLStatement instance to execute SQL commands. - Database-level operations such as beginning or ending transactions, loading schema information, - and other operations are performed using the SQLConnection instance.

-

A database that is connected using the openAsync() method is automatically - assigned the database name "main"; that name can be used to explicitly qualify - table names in SQL statements using the format [database-name].[table-name].

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
reference:Object (default = null) — The location of the database file that is opened. This value must be - a flash.filesystem.File instance. If the parameter's value is null, an in-memory database - is created and opened. -
 
openMode:String (default = "create") — Indicates how the database is opened. The value can be any of the - constants defined in the SQLMode class. The default value is - SQLMode.CREATE, indicating that if a database file is not found at the specified - location, one is created. If openMode is SQLMode.READ and - the specified file does not exist then an error event is dispatched. This parameter is ignored - when the reference parameter is null. -
 
responder:Responder (default = null) — An object that designates methods to be called when the operation succeeds or fails. - If the responder argument is null an open or error - event is dispatched when execution completes. -
 
autoCompact:Boolean (default = false) — Indicates whether unused space in the database is reclaimed automatically. - This parameter is only valid when creating a new database file or opening a database file in which - no tables have been created. By default, the space taken up by removed data is left in the database - file and reused when needed. Setting this parameter to true causes the database to - automatically reclaim unused space. This can negatively affect performance because it requires - additional processing each time data is written to the database and can also cause the - database data to become fragmented over time. - To force the database to reclaim unused space in a database file at any time and to - defragment the database file, use the compact() method. -

This parameter is ignored when the openMode parameter is SQLMode.READ.

-
 
pageSize:int (default = 1024) — Indicates the page size (in bytes) for the database. This parameter is - only valid when creating a new database file or opening a database file in which - no tables have been created. The value must be a power of two greater than or equal to - 512 and less than or equal to 32768. The default value is 1024 bytes. This value can only be set - before any tables are created. Once the tables are created attempting to change this value - results in an error. -
 
encryptionKey:ByteArray (default = null) — The encryption key for the database file. - If the openAsync() call creates a database, the database is encrypted and the - specified key is used as the encryption key for the database. If the call opens an - encrypted database, the value must match the database's encryption key or an error occurs. - If the database being opened is not encrypted, the value must be null (the - default) or an error occurs. - -

A valid encryption key is 16 bytes long. An in-memory database cannot be encrypted, so this - parameter must be null when the reference parameter's value is - null.

- -

When opening an encrypted database, if the encryption key provided doesn't match the - database's encryption key, a SQLErrorEvent is dispatched. The event object's - error property contains a SQLError instance. That SQLError object's - errorID property is 3138 ("File opened is not a database file").

- -

The encryptionKey parameter is available starting with AIR 1.5.

- -
-
-Events - - - - - - - - - - -
open:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails. The connection is never left open after a - failed operation.
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — When the SQLConnection instance already has an open connection - to a database (the connected property is true). -
 
ArgumentError — When the value specified for the reference parameter is not a - flash.filesystem.File instance - -
 
ArgumentError — When the encryptionKey argument is not null and - its length is not 16 bytes - -
 
ArgumentError — When the reference parameter is null and the - encryptionKey argument is not null -
 
ArgumentError — If an invalid pageSize parameter is specified. - This includes passing a page size when the mode is SQLMode.READ. - -
-

-See also -

-
-open() -
-close() -
-flash.data.SQLMode -
-
- - - - - -
reencrypt()method 
-
-public function reencrypt(newEncryptionKey:ByteArray, responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Changes the encryption key of an encrypted database. This method only affects the encryption - key of the main database (the database that was connected using the open() or - openAsync() method). You can only call reencrypt() on a database - that was encrypted when it was created. Once a database has been created as an encrypted database, - it cannot be unencrypted. Likewise, a database that is created without encryption cannot be - encrypted later. - -

The reencryption operation runs in its own transaction. If the reencryption process - is interrupted, the database rolls back the transaction and the encryption key is not changed.

- Parameters - - - - - - - - - - -
newEncryptionKey:ByteArray — A ByteArray containing the new encryption key for the database. A valid - encryption key is 16 bytes long. - -
 
responder:Responder (default = null) — An object that designates methods to be called when the operation succeeds or fails. - If the responder argument is null a reencrypt or - error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
reencrypt:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails.
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — When the newEncryptionKey value is null or its - length is not 16 bytes. - -
 
Error — When the connection is not open, or if there is an open transaction. - -
 
SQLError — If the operation fails in synchronous execution mode. -
-

-See also -

-
-open() -
-openAsync() -
-attach() -
-
- - - - - -
releaseSavepoint()method 
-
-public function releaseSavepoint(name:String = null, responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- This method commits the SQL operations made since the most recent savepoint - or the named savepoint if a name is specified. - -

Note that until the entire transaction is committed, any changes are not - permanently saved to the database. If the transaction is started using the - begin() method, you must call the commit() method - to commit the entire transaction. If the transaction is started by calling - setSavepoint() while inTransaction is - false, you can finish the entire transaction either by calling - the commit() method or by calling releaseSavepoint() - or rollbackToSavepoint() for the first savepoint of the - transaction.

- -

If the code calls the rollback() method, it permanently discards - all changes in the transaction, regardless of whether releaseSavepoint() - is called before the transaction is rolled back.

-

If this method is called with no parameters (or with null for - the name parameter), it commits all database changes since the most - recent unnamed savepoint (the most recent savepoint created by calling - setSavepoint() with no name parameter). For example, - if the setSavepoint() method has been called three times, three - savepoints are set. Calling releaseSavepoint() at that point - commits the SQL operations performed since the third (newest) - savepoint.

- -

If a value is provided for the name parameter this method commits - all the SQL operations performed since the savepoint with the specified name. - If other savepoints have been created more recently than the specified savepoint, - operations performed after those savepoints are committed also.

- -

Once a savepoint is released or rolled back, that savepoint and any more - recent savepoints are removed. If code executes additional SQL operations after - a releaseSavepoint() or rollbackToSavepoint() call - removes a savepoint, those operations belong to the most recent remaining - savepoint. (In other words, they belong to the savepoint created most recently - before the removed savepoint.) If no savepoint remains, the operations belong - to the main transaction.

- - Parameters - - - - - - - - - - -
name:String (default = null) — String The name of the savepoint from which all SQL operations - should be committed. If no value is provided or if this parameter is - null (the default) then the most recent unnamed savepoint (created - by a call to setSavepoint() with no name value) is - used. The name value cannot be an empty string (""). -
 
responder:Responder (default = null) — Responder An object that designates methods to be called - when the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null a releaseSavepoint - or error event is dispatched when execution completes. - -
-
-Events - - - - - - - - - - -
releaseSavepoint:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous - execution mode.
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — when the name parameter value is an empty - string (""). - -
 
Error — When the method is called while the SQLConnection - instance isn't connected to a database (the connected property is - false); or if no transaction is currently open (the - inTransaction property is false). -
 
SQLError — If the operation fails in synchronous execution mode. -
-

-See also -

-
-setSavepoint() -
-rollbackToSavepoint() -
-
- - - - - -
removeEventListener()method 
-
-public override function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect. - -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener object to remove. - -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Specifies whether the listener was registered for the capture phase or the - target and bubbling phases. If the listener was registered for both the capture phase and the - target and bubbling phases, two calls to removeEventListener() are required - to remove both, one call with useCapture() set to true, and another - call with useCapture() set to false. - -
-
- - - - - -
rollback()method 
-
-public function rollback(responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Rolls back an existing transaction created using the begin() method, - meaning all changes made by any SQL statements in the transaction are discarded. -

Intermediate savepoints can be marked within a transaction by calling the - setSavepoint() method. Using savepoints you can commit portions - of a transaction by calling the releaseSavepoint() method, or - roll back portions of a transaction by calling rollbackToSavepoint(). - However, calling the rollback() method permanently discards all - changes made in a transaction, regardless of whether individual savepoints have - been released (committed) before the transaction is rolled back.

- Parameters - - - - -
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null a rollback - or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
rollback:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous - execution mode.
-
-Throws - - - - - - - - - - -
Error — When the method is called while the SQLConnection - instance isn't connected to a database (the connected property is - false); or if no transaction is currently open (the - inTransaction property is false). -
 
SQLError — If the operation fails in synchronous execution mode. -
-

-See also -

-
-begin() -
-commit() -
-setSavepoint() -
-releaseSavepoint() -
-rollbackToSavepoint() -
-
- - - - - -
rollbackToSavepoint()method 
-
-public function rollbackToSavepoint(name:String = null, responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Rolls back any SQL operations since the most recent savepoint or the named - savepoint if a name is specified. - -

Note that if the entire transaction is committed by calling the - commit() method, any changes in the transaction that are not - already rolled back using the rollbackToSavepoint() method are - permanently saved to the database. In addition, calling the rollback() - method permanently discards all changes, regardless of whether individual - savepoints have been released (committed) or rolled back before the transaction - is rolled back.

-

If this method is called with no parameters (or with null - for the name parameter), it rolls back all database changes since - the most recent unnamed savepoint (the most recent call to setSavepoint() - with no name parameter value).

- -

If a value is provided for the name parameter this method - rolls back all the SQL operations performed since the savepoint with the - specified name. If other savepoints have been created more recently than the - specified savepoint, operations performed since those savepoints are rolled - back also.

- -

Once a savepoint is released or rolled back, that savepoint and any more - recent savepoints are removed. If code executes additional SQL operations after - a releaseSavepoint() or rollbackToSavepoint() call - removes a savepoint, those operations belong to the most recent remaining - savepoint. (In other words, they belong to the savepoint created most recently - before the removed savepoint.) If no savepoint remains, the - operations belong to the main transaction.

- - - Parameters - - - - - - - - - - -
name:String (default = null) — String The name of the savepoint to which the database state should - be rolled back. If no value is provided or if this parameter is null - (the default) then most recent unnamed savepoint (created by a call to - setSavepoint() with no name value) is used. The - name value cannot be an empty string (""). -
 
responder:Responder (default = null) — Responder An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the responder - argument is null a rollbackToSavepoint or - error event is dispatched when execution completes. - -
-
-Events - - - - - - - - - - -
rollbackToSavepoint:SQLEvent — Dispatched when the operation completes - successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous - execution mode.
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — when the name parameter value is an empty - string (""). - -
 
Error — When the method is called while the SQLConnection - instance isn't connected to a database (the connected property is - false); or if no transaction is currently open (the - inTransaction property is false). -
 
SQLError — If the operation fails in synchronous execution mode. -
-

-See also -

-
-setSavepoint() -
-releaseSavepoint() -
-
- - - - - -
setSavepoint()method 
-
-public function setSavepoint(name:String = null, responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a savepoint, which is like a bookmark within a database transaction. - A savepoint represents a point within a transaction. The set of SQL operations - performed between savepoints can be committed or rolled back separately from - other operations using the releaseSavepoint() and - rollbackToSavepoint() methods. In this way, using a savepoint - allows you to treat a set of SQL operations as a nested transaction. - -

When the setSavepoint() method is called, if a transaction has - not already been opened (by calling the begin() method), calling - this method begins the transaction and creates a savepoint at the start of the - transaction. If a transaction is already open, calling setSavepoint() - creates a savepoint within the transaction.

- -

Note that until the entire transaction is committed, any changes are not - permanently saved to the database. If the transaction is started using the - begin() method, you must call the commit() method - to commit the entire transaction. If the transaction is started by calling - setSavepoint() while inTransaction is - false, you can finish the entire transaction either by calling - the commit() method. The transaction also finishes automatically - when you call releaseSavepoint() or rollbackToSavepoint() - for the savepoint that started the transaction.

- -

You can specify a name for a savepoint by providing a value for the - name parameter. This allows you to to rollback or commit all - changes made since that specific savepoint. If no name is specified - (the default) then an unnamed savepoint is created.

- -

Once a savepoint is released or rolled back, that savepoint and any more - recent savepoints are removed. If code executes additional SQL operations - after a releaseSavepoint() or rollbackToSavepoint() - call removes a savepoint, those operations belong to the most recent remaining - savepoint. (In other words, they belong to the savepoint created most recently - before the removed savepoint.) If no savepoint remains, the operations belong - to the main transaction.

- - Parameters - - - - - - - - - - -
name:String (default = null) — String The name for the savepoint. If no value is provided or - if this parameter is null (the default) then the next call - to releaseSavepoint() or rollbackToSavepoint() with - no name parameter specified commits or rolls back the SQL operations - performed since the unnamed savepoint. -

If the name provided is a duplicate of a previous named savepoint, the next call - to either SQLConnection.releaseSavepoint() or - SQLConnection.rollbackToSavepoint() commits or rolls back changes - made since the most recent savepoint with that name.

-

The name value cannot be an empty string ("").

-
 
responder:Responder (default = null) — Responder An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the responder - argument is null a setSavepoint or error - event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
setSavepoint:SQLEvent — Dispatched when the operation completes successfully.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous - execution mode.
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — when the name parameter value is an empty - string (""). - -
 
Error — When the method is called while the SQLConnection - instance isn't connected to a database (the connected property is - false). -
 
SQLError — If the operation fails in synchronous execution mode. -
-

-See also -

-
-begin() -
-releaseSavepoint() -
-rollbackToSavepoint() -
-commit() -
-rollback() -
-
-
Event detail
- - - - - -
analyzeevent 
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.ANALYZE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when an analyze() operation - completes successfully. -

- The SQLEvent.ANALYZE constant defines the value of the - type property of an analyze event object. - This type of event is dispatched when a - SQLConnection.analyze() method call completes successfully. - The analyze event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-analyze() -
-
- - - - - -
attachevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.ATTACH -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when an attach() method call's operation - completes successfully. -

- The SQLEvent.ATTACH constant defines the value of the - type property of an attach event object. - This type of event is dispatched when a - SQLConnection.attach() method call completes successfully. - The attach event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-attach() -
-
- - - - - -
beginevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.BEGIN -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a begin() method call's operation - completes successfully. -

- The SQLEvent.BEGIN constant defines the value of the - type property of a begin event object. - This type of event is dispatched when a - SQLConnection.begin() method call completes successfully. - The begin event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-begin() -
-
- - - - - -
cancelevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.CANCEL -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a cancel() method call's operation completes - successfully. -

- The SQLEvent.CANCEL constant defines the value of the - type property of a cancel event object. - This type of event is dispatched when a SQLConnection.cancel() - method call completes successfully. - The cancel event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection or SQLStatement object that performed the operation.
-

-See also -

-
-cancel() -
-
- - - - - -
closeevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.CLOSE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a close() method call's operation - completes successfully. -

- The SQLEvent.CLOSE constant defines the value of the - type property of a close event object. - This type of event is dispatched when a - SQLConnection.close() method call completes successfully. - The close event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-close() -
-
- - - - - -
commitevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.COMMIT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a commit() method call's operation - completes successfully. -

- The SQLEvent.COMMIT constant defines the value of the - type property of a commit event object. - This type of event is dispatched when a - SQLConnection.commit() method call completes successfully. - The commit event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-commit() -
-
- - - - - -
compactevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.COMPACT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a compact() method call's operation - completes successfully. -

- The SQLEvent.COMPACT constant defines the value of the - type property of a compact event object. - This type of event is dispatched when a - SQLConnection.compact() method call completes successfully. - The compact event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-compact() -
-
- - - - - -
deanalyzeevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.DEANALYZE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a deanalyze() method call's operation - completes successfully. -

- The SQLEvent.DEANALYZE constant defines the value of the - type property of a deanalyze event object. - This type of event is dispatched when a - SQLConnection.deanalyze() method call completes successfully. - The deanalyze event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-deanalyze() -
-
- - - - - -
deleteevent  
-
-Event object type: flash.events.SQLUpdateEvent -
-SQLUpdateEvent.type property = flash.events.SQLUpdateEvent.DELETE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when data in any table in any of the connected databases changes as a result - of a SQL DELETE command. The data change can be a direct result of a DELETE - statement executed through a SQLStatement instance, or an indirect result caused by a trigger firing - in response to a statement execution. -

- The SQLUpdateEvent.DELETE constant defines the value of the - type property of a SQLConnection delete event. - The delete event has the following properties: - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
rowIDThe unique row identifier of the row that was inserted, deleted, or updated.
targetThe SQLConnection object on which the operation was performed.
tableThe name of the table on which the change occurred.
-

-See also -

-
-flash.data.SQLStatement -
-
- - - - - -
detachevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.DETACH -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a detach() method call's operation - completes successfully. -

- The SQLEvent.DETACH constant defines the value of the - type property of a detach event object. - This type of event is dispatched when a - SQLConnection.detach() method call completes successfully. - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-detach() -
-
- - - - - -
errorevent  
-
-Event object type: flash.events.SQLErrorEvent -
-SQLErrorEvent.type property = flash.events.SQLErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when any of the SQLConnection object's asynchronous operations results - in an error. The SQLErrorEvent instance that's dispatched as the event object - has an error property that contains information about the operation that - was attempted and the cause of the failure. -

- The SQLErrorEvent.ERROR constant defines the value of the - type property of an error event dispatched when a call - to a method of a SQLConnection or SQLStatement instance completes - with an error. - The error event has the following properties: - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
errorA SQLError object containing information about the type of error that occurred and the operation that caused the error.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection or SQLStatement object reporting the error.
-

- - - - - -
insertevent  
-
-Event object type: flash.events.SQLUpdateEvent -
-SQLUpdateEvent.type property = flash.events.SQLUpdateEvent.INSERT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when data in any table in any of the connected databases changes as a result - of a SQL INSERT command. The data change can be a direct result of an INSERT - statement executed through a SQLStatement instance, or an indirect result caused by a trigger firing - in response to a statement execution. -

- The SQLUpdateEvent.INSERT constant defines the value of the - type property of a SQLConnection insert event. - The insert event has the following properties: - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
rowIDThe unique row identifier of the row that was inserted, deleted, or updated.
targetThe SQLConnection object on which the operation was performed.
tableThe name of the table on which the change occurred.
-

-See also -

-
-flash.data.SQLStatement -
-
- - - - - -
openevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.OPEN -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when an openAsync() method call's operation - completes successfully. -

- The SQLEvent.OPEN constant defines the value of the - type property of a open event object. - This type of event is dispatched when a - SQLConnection.open() or SQLConnection.openAsync() method call completes successfully. - The open event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-openAsync() -
-
- - - - - -
reencryptevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.REENCRYPT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Dispatched when a reencrypt() method call's operation completes - successfully. -

- The SQLEvent.REENCRYPT constant defines the value of the - type property of a reencrypt event object. - This type of event is dispatched when a - SQLConnection.reencrypt() method call completes successfully. - The reencrypt event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-reencrypt() -
-
- - - - - -
releaseSavepointevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.RELEASE_SAVEPOINT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when a releaseSavepoint() method call's operation - completes successfully. -

- The SQLEvent.RELEASE_SAVEPOINT constant defines the value of the - type property of a releaseSavepoint event object. - This type of event is dispatched when a SQLConnection.releaseSavepoint() - method call completes successfully. - The releaseSavepoint event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-releaseSavepoint() -
-
- - - - - -
rollbackevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.ROLLBACK -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a rollback() method call's operation - completes successfully. -

- The SQLEvent.ROLLBACK constant defines the value of the - type property of a rollback event object. - This type of event is dispatched when a - SQLConnection.rollback() method call completes successfully. - The rollback event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-rollback() -
-
- - - - - -
rollbackToSavepointevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.ROLLBACK_TO_SAVEPOINT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when a rollbackToSavepoint() method call's operation - completes successfully. -

- The SQLEvent.ROLLBACK_TO_SAVEPOINT constant defines the value of the - type property of a rollbackToSavepoint event object. - This type of event is dispatched when a SQLConnection.rollbackToSavepoint() - method call completes successfully. - The rollbackToSavepoint event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-rollbackToSavepoint() -
-
- - - - - -
schemaevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.SCHEMA -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a loadSchema() method call's operation completes - successfully and the schema results are ready. -

- The SQLEvent.SCHEMA constant defines the value of the - type property of a schema event object. - Dispatched when the SQLConnection.loadSchema() method - completes successfully. Once the SQLEvent.SCHEMA event - is dispatched the SQLConnection.getSchemaResult() method can be - used to get the schema information. - The schema event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-loadSchema() -
-
- - - - - -
setSavepointevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.SET_SAVEPOINT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when a setSavepoint() method call's operation - completes successfully. -

- The SQLEvent.SET_SAVEPOINT constant defines the value of the - type property of a setSavepoint event object. - This type of event is dispatched when a SQLConnection.setSavepoint() - method call completes successfully. - The setSavepoint event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-setSavepoint() -
-
- - - - - -
updateevent  
-
-Event object type: flash.events.SQLUpdateEvent -
-SQLUpdateEvent.type property = flash.events.SQLUpdateEvent.UPDATE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when data in any table in any of the connected databases changes as a result - of a SQL UPDATE command. The data change can be a direct result of a UPDATE - statement executed through a SQLStatement instance, or an indirect result caused by a trigger firing - in response to a statement execution. -

- The SQLUpdateEvent.UPDATE constant defines the value of the - type property of a SQLConnection update event. - -

The update event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
rowIDThe unique row identifier of the row that was inserted, deleted, or updated.
targetThe SQLConnection object on which the operation was performed.
tableThe name of the table on which the change occurred.
-

-See also -

-
-flash.data.SQLStatement -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLIndexSchema.html b/html-docs/flash/data/SQLIndexSchema.html deleted file mode 100644 index 4978dfa..0000000 --- a/html-docs/flash/data/SQLIndexSchema.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - - - -flash.data.SQLIndexSchema (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLIndexSchema
InheritanceSQLIndexSchema Inheritance SQLSchema Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A SQLIndexSchema instance provides information describing a specific index - in a database. - The available information includes the name of the associated table - (the table property), the - SQL statement used to create the index (the sql property), - and the name of the index (the name property). -

To obtain index schema information for a database, use the - SQLConnection.loadSchema() method to load the schema information, making certain to - use null or SQLIndexSchema for the type argument's value. - In the resulting SQLSchemaResult instance, the indices property contains an array - of SQLIndexSchema instances representing the indices in the database.

-

Generally, developer code does not construct SQLIndexSchema instances directly.

-

-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheriteddatabase : String -
- The name of the database to which this schema object belongs.
-		SQLSchema
 Inheritedname : String -
- The name of this schema object.
-		SQLSchema
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedsql : String -
- Returns the entire text of the SQL statement that was used to create this schema object.
-		SQLSchema
  table : String -
[read-only] - The name of the table to which this index is attached.
-		SQLIndexSchema
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLIndexSchema(database:String, name:String, sql:String, table:String)
-
- Creates a SQLIndexSchema instance.
-		SQLIndexSchema
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
tableproperty
-
-table:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The name of the table to which this index is attached. -

Implementation -
-    public function get table():String -
-
- -
Constructor detail
- - - - - -
SQLIndexSchema()constructor
-
-public function SQLIndexSchema(database:String, name:String, sql:String, table:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLIndexSchema instance. Generally, developer code does not call the SQLIndexSchema - constructor directly. To obtain schema information for a database, call the - SQLConnection.loadSchema() method. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
database:String — The name of the associated database. -
 
name:String — The name of the index. -
 
sql:String — The SQL statement used to create this index. -
 
table:String — The name of the table to which this index is attached. -
-

-See also -

-
-flash.data.SQLConnection.getSchemaResult() -
-flash.data.SQLSchemaResult.indices -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLMode.html b/html-docs/flash/data/SQLMode.html deleted file mode 100644 index 6ee24b2..0000000 --- a/html-docs/flash/data/SQLMode.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - -flash.data.SQLMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLMode
InheritanceSQLMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- This class contains the constants that represent the possible values for the - openMode parameter of the SQLConnection.open() and - SQLConnection.openAsync() methods. -

-

-See also -

-
-flash.data.SQLConnection.open() -
-flash.data.SQLConnection.openAsync() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  CREATE : String = "create"
[static] - Indicates that the connection is opened for updates, and a database - file is created if the specified file doesn't exist.
-		SQLMode
  READ : String = "read"
[static] - Indicates that the connection is opened in read-only mode.
-		SQLMode
  UPDATE : String = "update"
[static] - Indicates that the connection is opened for updates but a - new database file is not created if the specified file doesn't exist.
-		SQLMode
-
- -
- -
Constant detail
- - - - - -
CREATEconstant
-
-public static const CREATE:String = "create" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the connection is opened for updates, and a database - file is created if the specified file doesn't exist. In this - mode reading and writing are allowed to the database. If the database - does not exist one is created before the operation completes. - -

-See also -

-
-flash.data.SQLConnection.open() -
-flash.data.SQLConnection.openAsync() -
-
- - - - - -
READconstant 
-
-public static const READ:String = "read" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the connection is opened in read-only mode. In this - mode writes are not allowed to the database. If the database does not - exist the open operation fails. - -

-See also -

-
-flash.data.SQLConnection.open() -
-flash.data.SQLConnection.openAsync() -
-
- - - - - -
UPDATEconstant 
-
-public static const UPDATE:String = "update" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the connection is opened for updates but a - new database file is not created if the specified file doesn't exist. In this - mode reading and writing are allowed to the database. If the database - does not exist the open operation fails. - -

-See also -

-
-flash.data.SQLConnection.open() -
-flash.data.SQLConnection.openAsync() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLResult.html b/html-docs/flash/data/SQLResult.html deleted file mode 100644 index 8425969..0000000 --- a/html-docs/flash/data/SQLResult.html +++ /dev/null @@ -1,630 +0,0 @@ - - - - - - - - -flash.data.SQLResult (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLResult
InheritanceSQLResult Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The SQLResult class provides access to data returned in response to the execution of a - SQL statement (a SQLStatement instance). -

The SQLResult instance for a SQL statement is accessed by calling the - SQLStatement.getResult() method or - as an argument passed to the result handler of a Responder instance specified in a call to - SQLStatement.execute() or SQLStatement.next(). Generally, developer - code does not construct SQLResult instances directly.

-

You use a SQLResult object to access the rows of data returned from a - SELECT statement (using the data property), to get - row identifier information for an INSERT statement (using the - lastInsertRowID property), to determine the number of rows affected - by an INSERT, UPDATE, or DELETE statement - (using the rowsAffected property), or to determine whether there are - additional SELECT result rows that haven't been retrieved (using the - complete property).

-

-

-See also -

-
-flash.data.SQLStatement.getResult() -
-flash.data.SQLStatement.execute() -
-flash.data.SQLStatement.next() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  complete : Boolean -
[read-only] - Indicates whether all the resulting data from a statement execution has been returned.
-		SQLResult
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  data : Array -
[read-only] - The data returned as a result of the statement execution, specifically when - a SQL SELECT statement is executed.
-		SQLResult
  lastInsertRowID : Number -
[read-only] - The last generated row identifier generated by a SQL INSERT - statement.
-		SQLResult
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rowsAffected : Number -
[read-only] - Indicates how many rows were affected by the operation.
-		SQLResult
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLResult(data:Array = null, rowsAffected:Number = 0, complete:Boolean = true, rowID:Number = 0)
-
- Creates a SQLResult instance.
-		SQLResult
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
completeproperty
-
-complete:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether all the resulting data from a statement execution has been returned. -

When a statement returns one or more rows this property indicates - whether all of the rows have been returned. When a SQLStatement object's execute() - method is called with a prefetch argument value, only the specified number of - rows of the resulting - data are returned in the SQLResult object's data property. Subsequent calls - to SQLStatement.next() cause additional data to become available. This property - is used to determine when the final results have been returned.

-

Note that because the number of rows is unknown at execution time, the database cursor must move beyond - the last row before a statement's execution is considered complete. When the - SQLStatement.execute() method is called with a prefetch argument, at least one - row more than the total number of rows in the result set must be requested before - the resulting SQLResult instance's complete property is true.

- Implementation -
-    public function get complete():Boolean -
-

-See also -

-
-flash.data.SQLStatement.execute() -
-flash.data.SQLStatement.next() -
-
- - - - - -
dataproperty 
-
-data:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The data returned as a result of the statement execution, specifically when - a SQL SELECT statement is executed. -

When a statement returns one or more rows this property is an array containing objects - that represent the rows of result data. Each object in the array has - property names that correspond to the result data set's column names.

- -

For example, suppose you execute the following SQL SELECT statement:

- - 
-	 SELECT lastName, firstName
-	 FROM employees
-
- -

Assuming the employees table contains 10 rows, the - SQLResult.data property is an Array with 10 elements. Each element - is an object with two properties, lastName and firstName.

- -

The situation is more complex when you are using a SELECT statement - with a complex result column, such as an aggregate function. For example, - suppose you execute the following SQL:

- - 
-	 SELECT departmentId, SUM(salary)
-	 FROM employees
-	 GROUP BY departmentId
-
- -

In the results from this statement, each object in the data Array has - two properties named departmentId and SUM(salary). However, - "SUM(salary)" is not a valid identifier. If you are using a computed column such as an - aggregate or other function, specify an alias for the computed column in your SQL - statement. The alias is used as the property name in the result data objects. For - example, consider this alternative to the previous statement:

- - 
-	 SELECT departmentId, SUM(salary) AS salarySubtotal
-	 FROM employees
-	 GROUP BY departmentId
-
- -

In this statement's data array, the result objects have two - properties named departmentId and salarySubtotal.

- -

The data property is always an Array regardless of how many rows - and columns are in the result set. For example, the following SELECT statement - results in one row and one column, which is essentially a single value:

- - 
-	 SELECT COUNT(*) AS numEmployees
-	 FROM employees
-
- -

After executing the query the data property contains an Array object - with one element. That element is an object with a single property, - numEmployees.

- -

If there are duplicate column names in the result data, for example if the - SELECT statement includes an two different id columns - from two different tables, the duplicate names are given property names according - to the value of the SQLConnection.columnNameStyle property. By default, - each column's name is used as the property name, but if there is are multiple columns - in the result set with the same name, the long name format - [table-name]_[column-name] is used for the identically named columns. - This behavior can be changed by setting the SQLConnection.columnNameStyle - property.

- -

By default the objects in the data Array are Object instances. - However, by setting the value of the SQLStatement.itemClass property - to a class, the data Array elements are created as instances of - that class instead. For every column in the result data set, the - itemClass class must have a property whose name exactly matches the - column name.

- -

If a statement does not return any data this property is null. - This is the case if the statement is not a SELECT statement, or if - it is a SELECT statement that returns 0 rows.

- Implementation -
-    public function get data():Array -
-

-See also -

-
-SQLConnection.columnNameStyle -
-SQLStatement.itemClass -
-
-Example -
The following code demonstrates using the itemClass property - to have the runtime create instances of a custom class from SQL SELECT statement - results. -
-
-// Employee class definition
-package
-{
-    public class Employee
-    {
-        public var name:String;
-        public var ssn:String;
-        public var id:uint;
-        public override function toString():String
-        {
-            return "id: "+ id.toString() + " name: " + name + " ssn: " + ssn;
-        }
-    }
-}
-
-
-// using the Employee class as SQLStatement.itemClass
-var conn:SQLConnection;
-var dbStatement:SQLStatement;
-
-function init():void
-{
-    conn = new SQLConnection();
-    conn.addEventListener(SQLEvent.OPEN, connOpenHandler);
-	
-	dbStatement = new SQLStatement();
-    dbStatement.sqlConnection = conn;
-    dbStatement.text = "SELECT id, name, ssn FROM employees";
-    dbStatement.itemClass = Employee;
-	
-    var dbFile:File = new File(File.separator + "employee.db");
-    conn.open(dbFile);
-}
-
-function connOpenHandler(event:SQLEvent):void
-{
-    dbStatement.addEventListener(SQLEvent.RESULT, resultHandler);
-    dbStatement.execute();
-}
-
-function resultHandler(event:SQLEvent):void
-{
-    var result:SQLResult = dbStatement.getResult();
-    if (result != null)
-    {
-        var emp:Employee;
-		var numRows:int = result.data.length;
-        for (var i:int = 0; i < numRows; i++)
-        {
-            emp = result.data[i];
-            trace(emp.toString());
-        }
-    }
-}
-
-

-
- - - - - -
lastInsertRowIDproperty 
-
-lastInsertRowID:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The last generated row identifier generated by a SQL INSERT - statement. -

The value is 0 if the executed statement was not an - INSERT statement.

-

A row identifier is used to uniquely identify a row in a table within - the database. The value is frequently generated by the database.

-

For more information about primary keys and generated row identifiers, - see the "CREATE TABLE" and - "Expressions" sections in the appendix - "SQL support in local databases."

- Implementation -
-    public function get lastInsertRowID():Number -
-

-See also -

-
-flash.data.SQLConnection.lastInsertRowID -
-flash.events.SQLUpdateEvent.rowID -
-
- - - - - -
rowsAffectedproperty 
-
-rowsAffected:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates how many rows were affected by the operation. - Only changes that are directly specified by an INSERT, - UPDATE, or DELETE statement are counted. -

Auxiliary changes caused by triggers are not counted. - Use the SQLConnection.totalChanges property to find the total - number of changes including changes caused by triggers.

-

Note that when the related SQL operation is a DELETE statement - with no WHERE clause (that is, the statement deletes all the rows in the table), - the rowsAffected property is always 0, regardless of the number of rows - that were deleted. If you need to know the number of rows that are deleted, you can - include the WHERE clause WHERE 1 = 1, in which case all - the rows are deleted, and the rowsAffected property accurately - reflects the number of rows that were deleted. However, depending on the number of - rows being deleted, doing so may have a negative impact on the statement's performance.

- Implementation -
-    public function get rowsAffected():Number -
-

-See also -

-
-flash.data.SQLConnection.totalChanges -
-
- -
Constructor detail
- - - - - -
SQLResult()constructor
-
-public function SQLResult(data:Array = null, rowsAffected:Number = 0, complete:Boolean = true, rowID:Number = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLResult instance. Generally, developer code does not call the SQLResult - constructor directly. To retrieve a SQLResult instance associated with a particular SQLStatement - instance, call the instance's getResult() method. A SQLResult - instance is also passed as an argument to the result handler function when - a Responder instance is specified for an execute() or next() - method call. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
data:Array (default = null) — The array of rows returned from the execution of a statement. If - the statement doesn't return any rows this value should be null. -
 
rowsAffected:Number (default = 0) — Indicates how many rows the executed statement affected. -
 
complete:Boolean (default = true) — Indicates whether there are additional rows that can - be fetched or whether all data has been returned. -
 
rowID:Number (default = 0) — If the statement was a SQL INSERT operation this is the new - unique identifier for the row. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLSchema.html b/html-docs/flash/data/SQLSchema.html deleted file mode 100644 index 363dde9..0000000 --- a/html-docs/flash/data/SQLSchema.html +++ /dev/null @@ -1,398 +0,0 @@ - - - - - - - - -flash.data.SQLSchema (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.data
Classpublic class SQLSchema
InheritanceSQLSchema Inheritance Object
SubclassesSQLIndexSchema, SQLTableSchema, SQLTriggerSchema
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The SQLSchema class is the base class for schema information for database objects - such as tables, views, and indices. -

To obtain schema information for a database, use the - SQLConnection.loadSchema() method to load the schema information. - The resulting SQLSchemaResult instance contains arrays of instances representing the objects - in the database.

-

Generally, developer code does not construct SQLSchema instances directly.

-

-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  database : String -
[read-only] - The name of the database to which this schema object belongs.
-		SQLSchema
  name : String -
[read-only] - The name of this schema object.
-		SQLSchema
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  sql : String -
[read-only] - Returns the entire text of the SQL statement that was used to create this schema object.
-		SQLSchema
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLSchema(database:String, name:String, sql:String)
-
- Creates a SQLSchema instance.
-		SQLSchema
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
databaseproperty
-
-database:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The name of the database to which this schema object belongs. The name is "main" for the main - database associated with a SQLConnection instance (the database file that is - opened by calling a SQLConnection instance's open() or openAsync() method). For other - databases that are attached to the connection using the - SQLConnection.attach() method, the value is the name specified in the attach() - method call. -

Implementation -
-    public function get database():String -
-

-See also -

-
-flash.data.SQLConnection.open() -
-flash.data.SQLConnection.openAsync() -
-flash.data.SQLConnection.attach() -
-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The name of this schema object. Each object within a - database has a unique name. The name is defined in the SQL statement that creates the object - (such as the CREATE TABLE statement for a table). -

For example, if a database index is created using the following SQL statement, the value of the - name property for that index's schema would be "customer_index":

- 
CREATE INDEX customer_index ON customers (id)
- Implementation -
-    public function get name():String -
-
- - - - - -
sqlproperty 
-
-sql:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Returns the entire text of the SQL statement that was used to create this schema object. - Each object within a database is created using a SQL statement. -

For example, if a database index is created using the following SQL:

- 
CREATE INDEX customer_index ON customers (id)
-

the sql property for that index's schema would be the entire text of - the statement.

- Implementation -
-    public function get sql():String -
-
- -
Constructor detail
- - - - - -
SQLSchema()constructor
-
-public function SQLSchema(database:String, name:String, sql:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLSchema instance. Generally, developer code does not call the SQLSchema - constructor directly. To obtain schema information for a database, call the - SQLConnection.loadSchema() method. -

Parameters - - - - - - - - - - - - - - - - -
database:String — The name of the associated database. -
 
name:String — The name of the database object. -
 
sql:String — The SQL used to construct the database - object. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLSchemaResult.html b/html-docs/flash/data/SQLSchemaResult.html deleted file mode 100644 index 349f92e..0000000 --- a/html-docs/flash/data/SQLSchemaResult.html +++ /dev/null @@ -1,472 +0,0 @@ - - - - - - - - -flash.data.SQLSchemaResult (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLSchemaResult
InheritanceSQLSchemaResult Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A SQLSchemaResult instance contains the information resulting from a call to - the SQLConnection.loadSchema() method. It contains four Array properties - that hold the requested schema data, based on the argument values - used when calling SQLConnection.loadSchema(). -

To retrieve the SQLSchemaResult instance for a SQLConnection.loadSchema() - call, call the SQLConnection instance's getSchemaResult() method. Generally, developer - code does not create SQLSchemaResult instances directly.

-

-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-flash.data.SQLConnection.getSchemaResult() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  indices : Array -
[read-only] - An array of SQLIndexSchema instances requested in a call - to SQLConnection.loadSchema().
-		SQLSchemaResult
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  tables : Array -
[read-only] - An array of SQLTableSchema instances requested in a call - to SQLConnection.loadSchema().
-		SQLSchemaResult
  triggers : Array -
[read-only] - An array of SQLTriggerSchema instances requested in a call - to SQLConnection.loadSchema().
-		SQLSchemaResult
  views : Array -
[read-only] - An array of SQLViewSchema instances requested in a call - to SQLConnection.loadSchema().
-		SQLSchemaResult
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLSchemaResult(tables:Array, views:Array, indices:Array, triggers:Array)
-
- Creates a SQLSchemaResult instance.
-		SQLSchemaResult
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
indicesproperty
-
-indices:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An array of SQLIndexSchema instances requested in a call - to SQLConnection.loadSchema(). If the specified databases - do not contain any indices, or if the loadSchema() call - specifies to exclude indices from the result, the indices - property is an empty array (an array whose length property - is 0). -

Implementation -
-    public function get indices():Array -
-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-flash.data.SQLIndexSchema -
-
- - - - - -
tablesproperty 
-
-tables:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An array of SQLTableSchema instances requested in a call - to SQLConnection.loadSchema(). If the specified databases - do not contain any tables, or if the loadSchema() call - specifies to exclude tables from the result, the tables - property is an empty array (an array whose length property - is 0). -

Implementation -
-    public function get tables():Array -
-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-flash.data.SQLTableSchema -
-
- - - - - -
triggersproperty 
-
-triggers:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An array of SQLTriggerSchema instances requested in a call - to SQLConnection.loadSchema(). If the specified databases - do not contain any triggers, or if the loadSchema() call - specifies to exclude triggers from the result, the triggers - property is an empty array (an array whose length property - is 0). -

Implementation -
-    public function get triggers():Array -
-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-flash.data.SQLTriggerSchema -
-
- - - - - -
viewsproperty 
-
-views:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An array of SQLViewSchema instances requested in a call - to SQLConnection.loadSchema(). If the specified databases - do not contain any views, or if the loadSchema() call - indicates that views should be excluded from the result, the views - property is an empty array (an array whose length property - is 0). -

Implementation -
-    public function get views():Array -
-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-flash.data.SQLViewSchema -
-
- -
Constructor detail
- - - - - -
SQLSchemaResult()constructor
-
-public function SQLSchemaResult(tables:Array, views:Array, indices:Array, triggers:Array) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLSchemaResult instance. Generally, developer code does not call the SQLSchemaResult - constructor directly. To obtain schema information for a database, call the - SQLConnection.loadSchema() method. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
tables:Array — An array of SQLTableSchema instances as specified in the loadSchema() request. -
 
views:Array — An array of SQLViewSchema instances as specified in the loadSchema() request. -
 
indices:Array — An array of SQLIndexSchema instances as specified in the loadSchema() request. -
 
triggers:Array — An array of SQLTriggerSchema instances as specified in the loadSchema() request. -
-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLStatement.html b/html-docs/flash/data/SQLStatement.html deleted file mode 100644 index 9d7d874..0000000 --- a/html-docs/flash/data/SQLStatement.html +++ /dev/null @@ -1,1427 +0,0 @@ - - - - - - - - -flash.data.SQLStatement (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLStatement
InheritanceSQLStatement Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A SQLStatement instance is used to execute a SQL statement against a local SQL database - that is open through a SQLConnection instance. -

A SQLStatement instance is linked to a SQLConnection instance by setting the SQLConnection instance as the - value of the SQLStatement instance's sqlConnection property. The text property - is populated with the actual text of the SQL statement to execute. If necessary, SQL statement parameter - values are specified using the parameters property, and the statement is - carried out by calling the execute() method.

-

For a complete description of the SQL dialect supported in local SQL databases, see the appendix - SQL support in local databases.

-

In asynchronous execution mode, the execute() and next() methods are executed - in the background, and the runtime dispatches events to registered event listeners or to a specified Responder - instance when the operations complete or fail. - In synchronous mode, the methods are executed on the main application thread, meaning that no other code executes - until the database operations are completed. In addition, in synchronous mode if the methods fail the runtime - throws an exception rather than dispatching an error event.

-

-

-See also -

-
-flash.data.SQLConnection -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  executing : Boolean -
[read-only] - Indicates whether the statement is currently executing.
-		SQLStatement
  itemClass : Class -
- Indicates a class (data type) that is used for each - row returned as a result of the statement's execution.
-		SQLStatement
  parameters : Object -
[read-only] - Serves as an associative array to which you add values for the - parameters specified in the SQL statement's - text property.
-		SQLStatement
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  sqlConnection : SQLConnection -
- The SQLConnection object that manages the connection to the database or databases on which - the statement is executed.
-		SQLStatement
  text : String -
- The actual SQL text of the statement.
-		SQLStatement
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLStatement()
-
- Creates a SQLStatement instance.
-		SQLStatement
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-cancel():void -
-
- Cancels execution of this statement.
-		SQLStatement
   -
-clearParameters():void -
-
- Clears all current parameter settings.
-		SQLStatement
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-execute(prefetch:int = -1, responder:Responder = null):void -
-
- Executes the SQL in the text property against the database that - is connected to the SQLConnection object in the sqlConnection - property.
-		SQLStatement
   -
-getResult():SQLResult -
-
- Provides access to a SQLResult object containing the results of the statement - execution, including any result rows from a SELECT statement, and other - information about the statement execution for all executed statements.
-		SQLStatement
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-next(prefetch:int = -1, responder:Responder = null):void -
-
- Retrieves the next portion of a SELECT statement's result set.
-		SQLStatement
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-error -
-		 - Dispatched when an error occurs during an operation.SQLStatement
   -
-result -
-		 - Dispatched when an execute() or - next() method call's operation completes successfully.SQLStatement
-
- -
- -
Property detail
- - - - - -
executingproperty
-
-executing:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether the statement is currently executing. -

This property is true if execute() has been called and - not all of the results have been returned from the database.

- Implementation -
-    public function get executing():Boolean -
-

-See also -

-
-execute() -
-
- - - - - -
itemClassproperty 
-
-itemClass:Class  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates a class (data type) that is used for each - row returned as a result of the statement's execution. -

This property is intended for use in SWF-based AIR application only. - You cannot use it in JavaScript. (ActionScript lets you define custom classes, which you - can use with this property.)

-

By default, each row returned by a SELECT statement is - created as an Object instance, with the result set's column names as the - names of the properties of the object, and the value of each column as the - value of its associated property.

-

By specifying a class for the itemClass property, - each row returned by a SELECT statement executed by this SQLStatement instance - is created as an instance of the designated class. Each property of the itemClass instance is - assigned the value from the column with the same name as the property.

-

Any class assigned to this property must have a constructor - that does not require any parameters. In addition, the class must - have a single property for each column returned by the SELECT statement. - It is considered an error if a column in the SELECT list - does not have a matching property name in the itemClass class.

-

Implementation -
-    public function get itemClass():Class -
-    public function set itemClass(value:Class):void -
-

-See also -

-
-flash.data.SQLResult.data -
-
-Example -
The following code demonstrates using the itemClass property - to have the runtime create instances of a custom class from SQL SELECT statement - results. -
-
-// Employee class definition
-package
-{
-    public class Employee
-    {
-        public var name:String;
-        public var ssn:String;
-        public var id:uint;
-        public override function toString():String
-        {
-            return "id: "+ id.toString() + " name: " + name + " ssn: " + ssn;
-        }
-    }
-}
-
-
-// using the Employee class as SQLStatement.itemClass
-var conn:SQLConnection;
-var dbStatement:SQLStatement;
-
-function init():void
-{
-    conn = new SQLConnection();
-    conn.addEventListener(SQLEvent.OPEN, connOpenHandler);
-	
-	dbStatement = new SQLStatement();
-    dbStatement.sqlConnection = conn;
-    dbStatement.text = "SELECT id, name, ssn FROM employees";
-    dbStatement.itemClass = Employee;
-	
-    var dbFile:File = new File(File.separator + "employee.db");
-    conn.open(dbFile);
-}
-
-function connOpenHandler(event:SQLEvent):void
-{
-    dbStatement.addEventListener(SQLEvent.RESULT, resultHandler);
-    dbStatement.execute();
-}
-
-function resultHandler(event:SQLEvent):void
-{
-    var result:SQLResult = dbStatement.getResult();
-    if (result != null)
-    {
-        var emp:Employee;
-		var numRows:int = result.data.length;
-        for (var i:int = 0; i < numRows; i++)
-        {
-            emp = result.data[i];
-            trace(emp.toString());
-        }
-    }
-}
-
-

-
- - - - - -
parametersproperty 
-
-parameters:Object  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Serves as an associative array to which you add values for the - parameters specified in the SQL statement's - text property. The array keys are - the names of the parameters. If an unnamed parameter is specified - in the statement text, its key is the index of the parameter. -

Within the text of a SQL statement, a parameter is indicated with - one of the following characters: "?", ":", or "@".

-

The ":" and "@" tokens indicate a named parameter; the characters following - the token designate the name of the parameter.

-

For example, in the following SQL statement, a parameter named firstName - is specified using the ":" character:

- 
SELECT FROM employees WHERE firstName = :firstName
-

The "?" token indicates an indexed (numbered) parameter; each parameter - is automatically given an index according to the sequence of parameters - in the statement text. Parameter index values are zero based. In other words, the first parameter's index is 0.

-

Parameters are used to allow for typed substitution of - values that are unknown at the time the SQL statement is constructed. - The use of parameters is the only way to guarantee the storage class for - a value passed in to the database. When parameters are not used, all values are - converted from their text representation to a storage class based on the - associated column's type affinity. For more information on storage classes and - column affinity, see the - "Data type support" section - in the appendix - "SQL support in local databases".

-

Parameters are also used as a security measure to prevent a malicious technique known - as a SQL injection attack. In a SQL injection attack, a user enters SQL code in a - user-accessible location (for example, a data entry field). If application code constructs - a SQL statement by directly concatenating user input into the SQL text, the user-entered - SQL code is executed against the database. The following listing shows an - example of concatenating user input into SQL text. Do not use this - technique:

- 
-	 // assume the variables "username" and "password"
-     // contain user-entered data
-     var sql:String =
-         "SELECT userId " +
-         "FROM users " +
-         "WHERE username = '" + username + "' " +
-         "    AND password = '" + password + "'";
-     var statement:SQLStatement = new SQLStatement();
-     statement.text = sql;
-
- 
-	 // assume the variables "username" and "password"
-     // contain user-entered data
-     var sql =
-         "SELECT userId " +
-         "FROM users " +
-         "WHERE username = '" + username + "' " +
-         "    AND password = '" + password + "'";
-     var statement = new air.SQLStatement();
-     statement.text = sql;
-
-

Using statement parameters instead of concatenating user-entered values into - a statement's text prevents a SQL injection attack, because the parameter values are - treated explicitly as substituted values, rather than becoming part of the literal statement - text. The following is the recommended alternative to the previous listing:

- 
-	 // assume the variables "username" and "password"
-     // contain user-entered data
-     var sql:String =
-         "SELECT userId " +
-         "FROM users " +
-         "WHERE username = :username " +
-         "    AND password = :password";
-     var statement:SQLStatement = new SQLStatement();
-     statement.text = sql;
-     // set parameter values
-     statement.parameters[":username"] = username;
-     statement.parameters[":password"] = password;
-
- 
-	 // assume the variables "username" and "password"
-     // contain user-entered data
-     var sql =
-         "SELECT userId " +
-         "FROM users " +
-         "WHERE username = :username " +
-         "    AND password = :password";
-     var statement = new air.SQLStatement();
-     statement.text = sql;
-     // set parameter values
-     statement.parameters[":username"] = username;
-     statement.parameters[":password"] = password;
-
-

All parameter values must be set before - the statement is executed. Parameter values specified in the parameters - array are bound (that is, - combined with the statement text) when the execute() method is called. Once - execute() has been called, any - subsequent changes to the values are not applied to the executing - statement. However, on a subsequent execute() call the changed - values are used. If the statement text includes a parameter that doesn't have a value specified - in the parameters property, an error occurs.

-

To clear all the parameter values from the parameters property, - use the clearParameters() method.

- Implementation -
-    public function get parameters():Object -
-

-See also -

-
-text -
-clearParameters() -
-
-Example -
The following example shows the use of a named parameter, - :firstName, in a SQL statement. -
-
-// employees is a SQLStatement instance
-employees.text = "SELECT FROM employees WHERE first = :firstName";
-employees.parameters[":firstName"] = "Sam";
-employees.execute();
-
-

The following example shows the use of an unnamed parameter - in a SQL statement. -
-
-// employees is a SQLStatement instance
-employees.text = "SELECT FROM employees WHERE first = ?";
-employees.parameters[0] = "Sam";
-employees.execute();
-
-

-
- - - - - -
sqlConnectionproperty 
-
-sqlConnection:SQLConnection  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The SQLConnection object that manages the connection to the database or databases on which - the statement is executed. -

Implementation -
-    public function get sqlConnection():SQLConnection -
-    public function set sqlConnection(value:SQLConnection):void -
-
-Throws -
- - - - -
Error — When an attempt is made to change the value - of this property while the statement is executing. - -
-
- - - - - -
textproperty 
-
-text:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The actual SQL text of the statement. -

The text can be any supported SQL. For a complete description of the - SQL dialect supported in local SQL databases, see the appendix - "SQL support in local databases".

- Implementation -
-    public function get text():String -
-    public function set text(value:String):void -
-
-Throws -
- - - - -
Error — When an attempt is made to change the text - property while the statement is executing. -
-
- -
Constructor detail
- - - - - -
SQLStatement()constructor
-
-public function SQLStatement() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLStatement instance. -


-Throws - - - - -
SecurityError — If the constructor is called from any sandbox outside - of the main application sandbox. - -
-
- -
Method detail
- - - - - -
cancel()method
-
-public function cancel():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Cancels execution of this statement. Like SQLConnection.cancel() - this method is used to stop a long running query or to cancel a query that is not - yet complete. However, unlike SQLConnection.cancel() this method only cancels the - single statement. If the statement is not currently executing, calling this method does - nothing. -

No events are dispatched in direct response to the completion of the cancel() - operation. However, once the cancel() operation completes and statement execution - is cancelled, the SQLStatement instance dispatches an error event indicating that - the statement execution (the execute() or next() call) did not complete. - Alternatively, if a value was specified for the responder parameter of the - execute() or next() call, the specified fault handler method is called. - In either case, the SQLError instance that's passed to the listeners has an errorID - property with a value of 3118 (Operation aborted).

-
- - - - - -
clearParameters()method 
-
-public function clearParameters():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Clears all current parameter settings. -

-See also -

-
-parameters -
-
- - - - - -
execute()method 
-
-public function execute(prefetch:int = -1, responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Executes the SQL in the text property against the database that - is connected to the SQLConnection object in the sqlConnection - property. -

If the responder argument is not null the specified - Responder object designates methods that are called to handle the results - of the operation. If the responder argument is null, - in asynchronous execution mode a - result event is dispatched if the operation is successful, or an - error event is dispatched if the operation fails.

-

To access the results of a statement, such as the result rows of a SELECT - statement or the database generated primary key of an INSERT statement, call - the getResult() method. The results are available immediately after the - statement executes in synchronous mode, and when the result event - is dispatched in asynchronous mode.

-

Every statement must be prepared (compiled) before it can be executed. The first time - a SQLStatement instance's execute() method is called, the statement is - prepared by the runtime. Once a statement is prepared it does not need to be prepared - again unless the text property changes. Setting one or more parameter values - does not require the statement to be prepared again.

- Parameters - - - - - - - - - - -
prefetch:int (default = -1) — When the statement's text property is a - SELECT statement, this value indicates how many rows are - returned at one time by the statement. - The default value is -1, indicating that all the result rows are returned - at one time. This parameter is used in conjunction with the next() - method to divide large result sets into smaller sets of data. This can improve - a user's perception of application performance by returning initial results more - quickly and dividing result-processing operations. -

When the SQL statement is a SELECT query and a prefetch - argument greater than zero is specified, the statement is considered to be executing - until the entire result set is returned or either the SQLStatement.cancel() - or SQLConnection.cancel() method is called. Note that because the number of - rows in a result set is unknown at execution time, the database cursor must move beyond - the last row in the result set before the statement is considered complete. When a - prefetch argument is specified in an execute() call, at least - one row more than the total number of rows in the result set must be requested - (either through a prefetch value that's larger than the number of rows in the - result set, or through subsequent calls to the next() method) before - the resulting SQLResult instance's complete property is true.

-
 
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. In asynchronous execution mode, if the - responder argument is null - a result or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
result:SQLEvent — Dispatched when the statement execution completes - successfully, or when a prefetch argument value is specified and a SELECT - statement returns one or more rows of data.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous execution mode.
-
-Throws - - - - - - - - - - -
Error — If the text property is null - or contains an empty string (""); if the sqlConnection property is - not set; if the SQLConnection instance assigned to the sqlConnection property is not - connected; or if the statement is currently executing. -
 
SQLError — If the operation fails in synchronous execution mode. -
-

-See also -

-
-next() -
-getResult() -
-
-Example -
The following example demonstrates executing a SQLStatement, - using event listeners to determine when the statement execution completes - or fails. -
-
-var conn:SQLConnection;
-var dbStatement:SQLStatement;
-
-function init():void
-{
-    conn = new SQLConnection();
-    conn.addEventListener(SQLEvent.OPEN, connOpenHandler);
-	
-	dbStatement = new SQLStatement();
-    dbStatement.sqlConnection = conn;
-    dbStatement.text = "SELECT id, name, ssn FROM employees";
-	
-    var dbFile:File = new File(File.separator + "employee.db");
-    conn.open(dbFile);
-}
-
-function connOpenHandler(event:SQLEvent):void
-{
-    dbStatement.addEventListener(SQLEvent.RESULT, resultHandler);
-    dbStatement.addEventListener(SQLErrorEvent.ERROR, errorHandler);
-    dbStatement.execute();
-}
-
-function resultHandler(event:SQLEvent):void
-{
-    var result:SQLResult = dbStatement.getResult();
-    if (result != null)
-    {
-		var numRows:int = result.data.length;
-        for (var i:int = 0; i < numRows; i++)
-        {
-            var row:Object = result.data[i];
-            trace("id:", row.id, ", name:", row.name, ", ssn:", row.ssn);
-        }
-    }
-}
-
-function errorHandler(event:SQLErrorEvent):void
-{
-    trace("An error occured while executing the statement.");
-}
-
-

The following example demonstrates executing a SQLStatement, - using a Responder object to indicate which functions are called when the statement - execution completes or fails. -
-
-var conn:SQLConnection;
-var dbStatement:SQLStatement;
-var employeeResponder:Responder;
-
-function init():void
-{
-    conn = new SQLConnection();
-    conn.addEventListener(SQLEvent.OPEN, connOpenHandler);
-	
-	dbStatement = new SQLStatement();
-    dbStatement.sqlConnection = conn;
-    dbStatement.text = "SELECT id, name, ssn FROM employees";
-	
-    var dbFile:File = new File(File.separator + "employee.db");
-    conn.open(dbFile);
-}
-
-function connOpenHandler(event:SQLEvent):void
-{
-	employeeResponder = new Responder(resultHandler, errorHandler);
-    dbStatement.execute(-1, employeeResponder);
-}
-
-function resultHandler(result:SQLResult):void
-{
-    if (result != null)
-    {
-		var numRows:int = result.data.length;
-        for (var i:int = 0; i < numRows; i++)
-        {
-            var row:Object = result.data[i];
-            trace("id:", row.id, ", name:", row.name, ", ssn:", row.ssn);
-        }
-    }
-}
-
-function errorHandler(error:SQLError):void
-{
-    trace("An error occured while executing the statement.");
-}
-
-

-
- - - - - -
getResult()method 
-
-public function getResult():SQLResult -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Provides access to a SQLResult object containing the results of the statement - execution, including any result rows from a SELECT statement, and other - information about the statement execution for all executed statements. - In asynchronous execution mode, the result information is not available until the - result event is dispatched. -

When a SELECT statement is executed, if the execute() - method is called with the default prefetch argument of -1, the returned - SQLResult object contains the entire result set of the query.

-

When a prefetch argument is specified for an execute() or next() - method call, the getResult() method behaves as a first-in, first-out queue - of results. Each time the result event is dispatched, a new SQLResult object - is added to the queue. Each time the getResult() method is called, the earliest - SQLResult object (the one that was added to the queue first) is returned and removed - from the queue. When there are no more SQLResult objects left in the queue, getResult() - returns null.

-

Note that unless they are removed by calling getResult(), - SQLResult objects remain in the queue. For example, if the execute() - method is called multiple times without calling getResult(), the - SQLResult objects associated with each execute() call remains in - the queue.

-

-Returns - - - - -
SQLResult — - A SQLResult object containing the result of a call to the execute() - or next() method. - - -
-

-See also -

-
-execute() -
-next() -
-result event -
-
- - - - - -
next()method 
-
-public function next(prefetch:int = -1, responder:Responder = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Retrieves the next portion of a SELECT statement's result set. - If there are no more rows in the result set, a result event is dispatched but - no additional SQLResult object is added to the getResult() queue. -

In asynchronous execution mode, if the responder argument is not - null the specified - Responder object indicates the methods that are called to handle the results - of the operation. - If the responder argument is null, a - result event is dispatched if the operation is successful, or an - error event is dispatched if the operation fails.

-

This method can only be called when the statement is still executing. - When the statement is a SELECT query and a prefetch - argument greater than zero is specified, the statement is considered to be executing - until the entire result set is returned or either the - SQLStatement.cancel() or SQLConnection.cancel() - method is called.

- Parameters - - - - - - - - - - -
prefetch:int (default = -1) — When the statement's text property is a SELECT - statement, this value indicates how many rows are returned at one time by - the statement. - The default value is -1, indicating that all the result rows are returned - at one time. This can improve - a user's perception of application performance by returning initial results more - quickly and dividing result-processing operations. -
 
responder:Responder (default = null) — An object that designates methods to be called when - the operation succeeds or fails. If the responder argument is null - a result or error event is dispatched when execution completes. -
-
-Events - - - - - - - - - - -
result:SQLEvent — Dispatched when the statement execution completes - successfully, or when a prefetch argument value is specified and the - next() call returns one or more rows of data.
 
error:SQLErrorEvent — Dispatched when the operation fails in asynchronous execution mode.
-
-Throws - - - - - - - - - - -
Error — When the method is called while the statement is not - currently executing (the executing property is false). -
 
SQLError — if the operation fails in synchronous execution mode. -
-

-See also -

-
-execute() -
-
-Example -
The following example demonstrates executing a SQLStatement, - explicitly indicating that only the first 10 rows of the result set are - to be returned the first time the result returns. The code checks the - complete property of the SQLResult and, if not all the rows - have been retrieved, calls the next() method. -
-
-var conn:SQLConnection;
-var dbStatement:SQLStatement;
-
-function init():void
-{
-    conn = new SQLConnection();
-    conn.addEventListener(SQLEvent.OPEN, connOpenHandler);
-	
-	dbStatement = new SQLStatement();
-    dbStatement.sqlConnection = conn;
-    dbStatement.text = "SELECT id, name, ssn FROM employees";
-	
-    var dbFile:File = new File(File.separator + "employee.db");
-    conn.open(dbFile);
-}
-
-function connOpenHandler(event:SQLEvent):void
-{
-    dbStatement.addEventListener(SQLEvent.RESULT, resultHandler);
-    dbStatement.addEventListener(SQLErrorEvent.ERROR, errorHandler);
-    dbStatement.execute(10);
-}
-
-function resultHandler(event:SQLEvent):void
-{
-    var result:SQLResult = dbStatement.getResult();
-    if (result != null)
-    {
-		var numRows:int = result.data.length;
-        for (var i:int = 0; i < numRows; i++)
-        {
-            var row:Object = result.data[i];
-            trace("id:", row.id, ", name:", row.name, ", ssn:", row.ssn);
-        }
-        if (!result.complete)
-        {
-            dbStatement.next(10);
-        }
-    }
-}
-
-function errorHandler(event:SQLErrorEvent):void
-{
-    trace("An error occured while executing the statement.");
-}
-
-

-
-
Event detail
- - - - - -
errorevent 
-
-Event object type: flash.events.SQLErrorEvent -
-SQLErrorEvent.type property = flash.events.SQLErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when an error occurs during an operation. -

- The SQLErrorEvent.ERROR constant defines the value of the - type property of an error event dispatched when a call - to a method of a SQLConnection or SQLStatement instance completes - with an error. - The error event has the following properties: - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
errorA SQLError object containing information about the type of error that occurred and the operation that caused the error.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection or SQLStatement object reporting the error.
-

-See also -

-
-execute() -
-next() -
-
- - - - - -
resultevent  
-
-Event object type: flash.events.SQLEvent -
-SQLEvent.type property = flash.events.SQLEvent.RESULT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when an execute() or - next() method call's operation completes successfully. Once the - result event is dispatched the getResult() - method can be called to retrieve statement results. -

- The SQLEvent.RESULT constant defines the value of the - type property of a result event object. - Dispatched when either the SQLStatement.execute() method or - SQLStatement.next() method completes successfully. Once the - SQLEvent.RESULT event is dispatched the SQLStatement.getResult() - method can be called to access the result data. - The result event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLStatement object that performed the operation.
-

-See also -

-
-execute() -
-next() -
-getResult() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLTableSchema.html b/html-docs/flash/data/SQLTableSchema.html deleted file mode 100644 index 071947c..0000000 --- a/html-docs/flash/data/SQLTableSchema.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - -flash.data.SQLTableSchema (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.data
Classpublic class SQLTableSchema
InheritanceSQLTableSchema Inheritance SQLSchema Inheritance Object
SubclassesSQLViewSchema
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A SQLTableSchema instance provides information describing a specific table - in a database. - It contains the name of the table (the name property), the - SQL statement used to create the table (the sql property), and - information about the table's columns (the columns property). -

To obtain table schema information for a database, use the - SQLConnection.loadSchema() method to load the schema information, making certain to - use null or SQLTableSchema for the type argument's value. - In the resulting SQLSchemaResult instance, the tables property contains an array - of SQLTableSchema instances representing the tables in the database.

-

Generally, developer code does not construct SQLTableSchema instances directly.

-

-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-flash.data.SQLColumnSchema -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  columns : Array -
[read-only] - An array of SQLColumnSchema instances containing schema information for this table's columns.
-		SQLTableSchema
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheriteddatabase : String -
- The name of the database to which this schema object belongs.
-		SQLSchema
 Inheritedname : String -
- The name of this schema object.
-		SQLSchema
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedsql : String -
- Returns the entire text of the SQL statement that was used to create this schema object.
-		SQLSchema
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLTableSchema(database:String, name:String, sql:String, columns:Array)
-
- Creates a SQLTableSchema instance.
-		SQLTableSchema
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
columnsproperty
-
-columns:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An array of SQLColumnSchema instances containing schema information for this table's columns. - If the SQlConnection.loadSchema() call indicates that column information - is excluded from the result, the columns property is an empty array - (an array whose length property is 0). -

Implementation -
-    public function get columns():Array -
-

-See also -

-
-flash.data.SQLColumnSchema -
-flash.data.SQLConnection.loadSchema() -
-
- -
Constructor detail
- - - - - -
SQLTableSchema()constructor
-
-public function SQLTableSchema(database:String, name:String, sql:String, columns:Array) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLTableSchema instance. Generally, developer code does not call the SQLTableSchema - constructor directly. To obtain schema information for a database, call the - SQLConnection.loadSchema() method. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
database:String — The name of the associated database. -
 
name:String — The name of the table. -
 
sql:String — The SQL statement used to create the table. -
 
columns:Array — Array of SQLColumnSchema instances describing this table's columns. -
-

-See also -

-
-flash.data.SQLConnection.getSchemaResult() -
-flash.data.SQLSchemaResult.tables -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLTransactionLockType.html b/html-docs/flash/data/SQLTransactionLockType.html deleted file mode 100644 index ba96cc7..0000000 --- a/html-docs/flash/data/SQLTransactionLockType.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - - - -flash.data.SQLTransactionLockType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLTransactionLockType
InheritanceSQLTransactionLockType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- This class contains the constants that represent the possible values for the - option parameter of the SQLConnection.begin() method. -

-

-See also -

-
-flash.data.SQLConnection.begin() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  DEFERRED : String = "deferred"
[static] - Specifies the deferred locking transaction option.
-		SQLTransactionLockType
  EXCLUSIVE : String = "exclusive"
[static] - Specifies the exclusive locking transaction option.
-		SQLTransactionLockType
  IMMEDIATE : String = "immediate"
[static] - Specifies the immediate locking transaction option.
-		SQLTransactionLockType
-
- -
- -
Constant detail
- - - - - -
DEFERREDconstant
-
-public static const DEFERRED:String = "deferred" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the deferred locking transaction option. - A deferred-lock transaction does not acquire a lock on the database - until the database is first accessed. With a deferred - transaction, a lock is not acquired until the first read or write - operation. -

-See also -

-
-flash.data.SQLConnection.begin() -
-
- - - - - -
EXCLUSIVEconstant 
-
-public static const EXCLUSIVE:String = "exclusive" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the exclusive locking transaction option. - An exclusive-locked transaction acquires a lock on the database immediately. - Other SQLStatement objects executing against the same database through a - different SQLConnection (in the same AIR application or a different one) - can't read data from or write data to the database. -

-See also -

-
-flash.data.SQLConnection.begin() -
-
- - - - - -
IMMEDIATEconstant 
-
-public static const IMMEDIATE:String = "immediate" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the immediate locking transaction option. - An immediate-locked transaction acquires a lock on the database immediately. - SQLStatement objects executing against the same database through a - different SQLConnection (in the same AIR application or a different one) - can read data from the database but can't write data to it. However, for those - other connections reading data from the database, the initial state of the data - in the database is identical to the state of the database before the - in-transaction SQLConnection instance's begin() method was called. - Any uncommitted data changes made within the immediate-locked transaction are - not available to the other connections. -

-See also -

-
-flash.data.SQLConnection.begin() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLTriggerSchema.html b/html-docs/flash/data/SQLTriggerSchema.html deleted file mode 100644 index cc99a7e..0000000 --- a/html-docs/flash/data/SQLTriggerSchema.html +++ /dev/null @@ -1,336 +0,0 @@ - - - - - - - - -flash.data.SQLTriggerSchema (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLTriggerSchema
InheritanceSQLTriggerSchema Inheritance SQLSchema Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A SQLTriggerSchema instance provides information describing a specific trigger - in a database. - It contains the name of the trigger (the name property), - the name of the associated table (the table property), and the - SQL statement used to create the trigger (the sql property). -

To obtain trigger schema information for a database, use the - SQLConnection.loadSchema() method to load the schema information, making certain to - use null or SQLTriggerSchema for the type argument's value. - In the resulting SQLSchemaResult instance, the triggers property contains an array - of SQLTriggerSchema instances representing the triggers in the database.

-

Generally, developer code does not construct SQLTriggerSchema instances directly.

-

-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheriteddatabase : String -
- The name of the database to which this schema object belongs.
-		SQLSchema
 Inheritedname : String -
- The name of this schema object.
-		SQLSchema
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedsql : String -
- Returns the entire text of the SQL statement that was used to create this schema object.
-		SQLSchema
  table : String -
[read-only] - The name of the table on which this trigger is defined, or the name of the view if - the trigger is defined on a view.
-		SQLTriggerSchema
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLTriggerSchema(database:String, name:String, sql:String, table:String)
-
- Creates a SQLTriggerSchema instance.
-		SQLTriggerSchema
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
tableproperty
-
-table:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The name of the table on which this trigger is defined, or the name of the view if - the trigger is defined on a view. -

Implementation -
-    public function get table():String -
-
- -
Constructor detail
- - - - - -
SQLTriggerSchema()constructor
-
-public function SQLTriggerSchema(database:String, name:String, sql:String, table:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLTriggerSchema instance. Generally, developer code does not call the SQLTriggerSchema - constructor directly. To obtain schema information for a database, call the - SQLConnection.loadSchema() method. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
database:String — The name of the associated database. -
 
name:String — The name of the trigger. -
 
sql:String — The SQL used to create the trigger. -
 
table:String — The name of the trigger's associated table. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/SQLViewSchema.html b/html-docs/flash/data/SQLViewSchema.html deleted file mode 100644 index d9dc53d..0000000 --- a/html-docs/flash/data/SQLViewSchema.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - - - - -flash.data.SQLViewSchema (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.data
Classpublic class SQLViewSchema
InheritanceSQLViewSchema Inheritance SQLTableSchema Inheritance SQLSchema Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A SQLViewSchema instance provides information describing a specific view - in a database. - It contains the name of the view (the name property), the - SQL statement used to create the view (the sql property), and - information about the view's columns (the columns property). -

To obtain view schema information for a database, use the - SQLConnection.loadSchema() method to load the schema information, making certain to - use null or SQLViewSchema for the type argument's value. - In the resulting SQLSchemaResult instance, the views property contains an array - of SQLViewSchema instances representing the views in the database.

-

Generally, developer code does not construct SQLViewSchema instances directly.

-

-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-flash.data.SQLColumnSchema -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedcolumns : Array -
- An array of SQLColumnSchema instances containing schema information for this table's columns.
-		SQLTableSchema
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheriteddatabase : String -
- The name of the database to which this schema object belongs.
-		SQLSchema
 Inheritedname : String -
- The name of this schema object.
-		SQLSchema
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedsql : String -
- Returns the entire text of the SQL statement that was used to create this schema object.
-		SQLSchema
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLViewSchema(database:String, name:String, sql:String, columns:Array)
-
- Creates a SQLViewSchema instance.
-		SQLViewSchema
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
SQLViewSchema()constructor
-
-public function SQLViewSchema(database:String, name:String, sql:String, columns:Array) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLViewSchema instance. Generally, developer code does not call the SQLViewSchema - constructor directly. To obtain schema information for a database, call the - SQLConnection.loadSchema() method. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
database:String — The name of the associated database. -
 
name:String — The name of the view. -
 
sql:String — The SQL statement used to create the view. -
 
columns:Array — Array of SQLColumnSchema instances describing this view's columns. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/data/package-detail.html b/html-docs/flash/data/package-detail.html deleted file mode 100644 index a127ab7..0000000 --- a/html-docs/flash/data/package-detail.html +++ /dev/null @@ -1,129 +0,0 @@ - - - - - - - -flash.data Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.data package contains classes used for working with Adobe AIR local SQL databases. Adobe AIR includes a SQL database engine that supports the creation and use of local databases from within AIR applications. For information about SQL language and data type support in the runtime, see the appendix SQL support in local databases.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 EncryptedLocalStore - The EncryptedLocalStore class (ELS) provides an encrypted local storage mechanism - that can be used as a small cache for an application's private data.
 SQLCollationType - This class contains the constants that represent the possible values for the - defaultCollationType parameter of the SQLColumnSchema constructor, as well as the - SQLColumnSchema.defaultCollationType property.
 SQLColumnNameStyle - This class contains the constants that represent the possible values for the - SQLConnection.columnNameStyle property.
 SQLColumnSchema - The SQLColumnSchema class provides information describing the characteristics of a specific column - within a table in a database.
 SQLConnection - A SQLConnection instance is used to manage the creation of and connection to local SQL database files - (local databases).
 SQLIndexSchema - A SQLIndexSchema instance provides information describing a specific index - in a database.
 SQLMode - This class contains the constants that represent the possible values for the - openMode parameter of the SQLConnection.open() and - SQLConnection.openAsync() methods.
 SQLResult - The SQLResult class provides access to data returned in response to the execution of a - SQL statement (a SQLStatement instance).
 SQLSchema - The SQLSchema class is the base class for schema information for database objects - such as tables, views, and indices.
 SQLSchemaResult - A SQLSchemaResult instance contains the information resulting from a call to - the SQLConnection.loadSchema() method.
 SQLStatement - A SQLStatement instance is used to execute a SQL statement against a local SQL database - that is open through a SQLConnection instance.
 SQLTableSchema - A SQLTableSchema instance provides information describing a specific table - in a database.
 SQLTransactionLockType - This class contains the constants that represent the possible values for the - option parameter of the SQLConnection.begin() method.
 SQLTriggerSchema - A SQLTriggerSchema instance provides information describing a specific trigger - in a database.
 SQLViewSchema - A SQLViewSchema instance provides information describing a specific view - in a database.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/desktop/Clipboard.html b/html-docs/flash/desktop/Clipboard.html deleted file mode 100644 index 9e523f0..0000000 --- a/html-docs/flash/desktop/Clipboard.html +++ /dev/null @@ -1,1205 +0,0 @@ - - - - - - - - -flash.desktop.Clipboard (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic class Clipboard
InheritanceClipboard Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The Clipboard class provides a container for transferring data and objects through the clipboard. - The operating system clipboard can be accessed through the static generalClipboard property. - -

A Clipboard object can contain the same information in more than one format. - By supplying information in multiple formats, you increase the chances that another - application will be able to use that information. Add data to a Clipboard object - with the setData() or setDataHandler() method.

- -

The standard formats are:

-
    -
  • BITMAP_FORMAT: a BitmapData object (AIR only)
    • -
  • FILE_LIST_FORMAT: an array of File objects (AIR only)
    • -
  • HTML_FORMAT: HTML-formatted string data
    • -
  • TEXT_FORMAT: string data
    • -
  • RICH_TEXT_FORMAT: a ByteArray containing Rich Text Format data
    • -
  • URL_FORMAT: a URL string (AIR only)
    • -
-

These constants for the names of the standard formats are defined in the ClipboardFormats class.

- -

When a transfer to or from the operating system occurs, - the standard formats are automatically translated between JavaScript - ActionScript data types and the native operating system clipboard types.

- -

You can use application-defined formats to add JavaScript - ActionScript objects to a - Clipboard object. If an object is serializable, both a reference and a clone - of the object can be made available. Object references are valid only within the - originating application.

- -

When it is computationally expensive to convert the information to be transferred into a - particular format, you can supply the name of a function that performs the conversion. - The function is called if and only if that format is read by the receiving component or application. - Add a deferred rendering function to a Clipboard object with the setDataHandler() method. - Note that in some cases, - the operating system calls the function before a drop occurs. For example, when you use a handler function to - provide the data for a file dragged from an AIR application to the file system, the operating - system calls the data handler function as soon as the drag gesture leaves the AIR application—typically resulting - in an undesireable pause as the file data is downloaded or created.

- -

Note for AIR applications: The clipboard object referenced by the event objects dispatched for HTML - drag-and-drop and copy-and-paste events are not the same type as the AIR Clipboard object. - The JavaScript clipboard object is described in the AIR developer's guide.

-

Note for Flash Player applications: In Flash Player 10, a paste operation from the clipboard first - requires a user event (such as a keyboard shortcut for the Paste command or a mouse click on the Paste command - in a context menu). Clipboard.getData() - will return the contents of the clipboard only if the InteractiveObject has received - and is acting on a paste event. Calling Clipboard.getData() under any other circumstances - will be unsuccessful. The same restriction applies in AIR for content outside the - application sandbox.

- -

On Linux, clipboard data does not persist when an AIR application closes.

- -

-

-View the examples. -

-

-See also -

-
-flash.desktop.NativeDragManager -
-flash.desktop.ClipboardFormats -
-flash.desktop.ClipboardTransferMode -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  formats : Array -
[read-only] - An array of strings containing the names of the data formats available - in this Clipboard object.
-		Clipboard
  generalClipboard : Clipboard -
[static][read-only] - The operating system clipboard.
-		Clipboard
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  supportsFilePromise : Boolean -
[read-only] - Indicates whether the file promise clipboard format is supported on the client system.
-		Clipboard
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Clipboard()
-
- Creates an empty Clipboard object.
-		Clipboard
   -
-clear():void -
-
- Deletes all data representations from this Clipboard object.
-		Clipboard
   -
-clearData(format:String):void -
-
- Deletes the data representation for the specified format.
-		Clipboard
   -
-getData(format:String, transferMode:String = "originalPreferred"):Object -
-
- Gets the clipboard data if data in the specified format is present.
-		Clipboard
   -
-hasFormat(format:String):Boolean -
-
- Checks whether data in the specified format exists in this Clipboard object.
-		Clipboard
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-setData(format:String, data:Object, serializable:Boolean = true):Boolean -
-
- Adds a representation of the information to be transferred in the specified data format.
-		Clipboard
   -
-setDataHandler(format:String, handler:Function, serializable:Boolean = true):Boolean -
-
- Adds a reference to a handler function that produces the data to be transfered.
-		Clipboard
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
formatsproperty
-
-formats:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An array of strings containing the names of the data formats available - in this Clipboard object. - -

String constants for the names of the standard formats are defined in the - ClipboardFormats class. Other, application-defined, strings may also be used as format - names to transfer data as an object.

- - Implementation -
-    public function get formats():Array -
-

-See also -

-
-flash.desktop.ClipboardFormats -
-
-Example -
The following example reads the formats array of the system clipboard: -
-
- var availableFormats:Array = Clipboard.generalClipboard.formats;
-
-

-
- - - - - -
generalClipboardproperty 
-
-generalClipboard:Clipboard  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The operating system clipboard. - -

Any data pasted to the system clipboard is available to other - applications. This may include insecure remote code running in - a web browser.

-

Note: In Flash Player 10 applications, a paste operation from the clipboard first - requires a user event (such as a keyboard shortcut for the Paste command or a mouse click on the Paste command - in a context menu). Clipboard.getData() - will return the contents of the clipboard only if the InteractiveObject has received - and is acting on a paste event. Calling Clipboard.getData() under any other circumstances - will be unsuccessful. The same restriction applies in AIR for content outside the - application sandbox.

- -

The generalClipboard object is created automatically. - You cannot assign another instance of a Clipboard to this property. - Instead, you use the getData() and setData() - methods to read and write data to the existing object.

- -

You should always clear the clipboard before writing new data to it - to ensure that old data in all formats is erased.

- -

The generalClipboard object cannot be passed to the AIR NativeDragManager. - Create a new Clipboard object for native drag-and-drop operations in an AIR application.

- - Implementation -
-    public static function get generalClipboard():Clipboard -
-
-Example -
To write to the operating system clipboard: -
-
- import flash.desktop.ClipboardFormats;
- 
- var copy:String = "A string to copy to the system clipboard.";
- Clipboard.generalClipboard.clear();
- Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, copy);
-
-

To read from the operating system clipboard: -
-
- import flash.desktop.ClipboardFormats;
- 
- var pasteData:String  = Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT) as String;
-
-

-
- - - - - -
supportsFilePromiseproperty 
-
-supportsFilePromise:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the file promise clipboard format is supported on the client system. - -

Implementation -
-    public function get supportsFilePromise():Boolean -
-
- -
Constructor detail
- - - - - -
Clipboard()constructor
-
-public function Clipboard() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates an empty Clipboard object. - -

Create Clipboard objects to hold the data of a native drag-and-drop gesture in Adobe AIR. Clipboard - objects can be used for only one drag-and-drop gesture; they cannot be reused.

- -

Do not create a Clipboard object for copy-and-paste operations. Use the single - Clipboard.generalClipboard object instead.

- -
-Throws - - - - -
Error — new Clipboard() is not supported in Flash Player, since only the operating system clipboard can be used in Flash Player. For copy-and-paste operations involving the operating system clipboard, use the Clipboard.generalClipboard object rather than creating a new Clipboard object. Does not throw an error in an AIR application. - -
-

-See also -

-
-generalClipboard -
-
-Example -
The following example creates a new clipboard for use with the NativeDragManager - class. - -

Note: For copy-and-paste operations involving the operating system clipboard, - use the Clipboard.generalClipboard object rather than creating a new clipboard.

-
-
- import flash.desktop.Clipboard;
- 
- var clipboard:Clipboard = new Clipboard();
-
-

-
- -
Method detail
- - - - - -
clear()method
-
-public function clear():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Deletes all data representations from this Clipboard object. - -


-Throws - - - - -
SecurityError — Call to generalClipboard.clear() is not permitted in this context. - In Flash Player, you can only call this method successfully during the processing of a user event - (as in a key press or mouse click). In AIR, this restriction only applies to content outside of the - application security sandbox. -
-
-Example -
The following example clears the system clipboard: -
-
- Clipboard.generalClipboard.clear();
-
-

-
- - - - - -
clearData()method 
-
-public function clearData(format:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Deletes the data representation for the specified format. - -

Parameters - - - - -
format:String — The data format to remove. -
-
-Throws - - - - -
SecurityError — Call to generalClipboard.clearData() is not permitted in this context. - In Flash Player, you can only call this method successfully during the processing of a user event - (as in a key press or mouse click). In AIR, this restriction only applies to content outside of the - application security sandbox. -
-
-Example -
The following example clears any data having the format - ClipboardFormats.TEXT_FORMAT from the system clipboard: -
-
- import flash.desktop.ClipboardFormats;
- 
- Clipboard.generalClipboard.clearData(ClipboardFormats.TEXT_FORMAT);
-
-

-
- - - - - -
getData()method 
-
-public function getData(format:String, transferMode:String = "originalPreferred"):Object -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Gets the clipboard data if data in the specified format is present. -

Flash Player requires that the getData() be called in a paste event handler. - In AIR, this restriction only applies to content outside of the application security sandbox.

- -

When a standard data format is accessed, the data is returned as a new - object of the corresponding Flash data type.

- -

When an application-defined format is accessed, the value of the - transferMode parameter determines whether a reference to the original - object or an anonymous object containing a serialized copy of the original - object is returned. When an originalPreferred or clonePreferred mode is specified, - Flash Player or AIR returns the alternate version if the preferred version is not available. - When an originalOnly or cloneOnly mode is specified, Flash Player or AIR returns - null if the requested version is not available.

- - Parameters - - - - - - - - - - -
format:String — The data format to return. The format string can contain one of the standard - names defined in the ClipboardFormats class, or an application-defined name. -
 
transferMode:String (default = "originalPreferred") — Specifies whether to return a reference or serialized copy - when an application-defined data format is accessed. The value must be one - of the names defined in the ClipboardTransferMode class. This value is - ignored for the standard data formats; a copy is always returned. -
-

-Returns - - - - -
Object — - An object of the type corresponding to the data format. - - -
-
-Throws - - - - - - - - - - - - - - - - -
Error — transferMode is not one of the names defined in the ClipboardTransferMode class. -
 
Error — The Clipboard object requested is no longer in scope (AIR only). -
 
SecurityError — Reading from or writing to the clipboard is not permitted in this context. - In Flash Player, you can only call this method successfully during the processing of a paste event. - In AIR, this restriction only applies to content outside of the application security sandbox. - -
-

-See also -

-
-setData() -
-flash.desktop.ClipboardFormats -
-flash.desktop.ClipboardTransferMode -
-
-Example -
The following example reads text from the system clipboard, if available: -
-
- import flash.desktop.ClipboardFormats;
-
- var pasteData:String = Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT) as String;
-
-

-
- - - - - -
hasFormat()method 
-
-public function hasFormat(format:String):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Checks whether data in the specified format exists in this Clipboard object. - -

Use the constants in the ClipboardFormats class to reference the standard format names.

- - Parameters - - - - -
format:String — The format type to check. -
-

-Returns - - - - -
Boolean — - true, if data in the specified format is present. - - -
-
-Throws - - - - - - - - - - -
Error — The Clipboard object requested is no longer in scope. -
 
SecurityError — Reading from or writing to the clipboard is not permitted in this context. - -
-

-See also -

-
-flash.desktop.ClipboardFormats -
-
-Example -
The following example tests the system clipboard to determine - whether text-formatted data is available: -
-
-if(Clipboard.generalClipboard.hasFormat(ClipboardFormats.TEXT_FORMAT)){
-    //do something 
-}
-
-

-
- - - - - -
setData()method 
-
-public function setData(format:String, data:Object, serializable:Boolean = true):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Adds a representation of the information to be transferred in the specified data format. - -

In the application sandbox of Adobe AIR, setData() can be called anytime. In other - contexts, setData() can only be called in response to a user-generated event such as - a key press or mouse click.

- -

Different representations of the same information can be added to the clipboard as - different formats, which increases the ability of other components or applications to - make use of the available data. - For example, an image could be added as bitmap data for use by image editing applications, - as a URL, and as an encoded PNG file for transfer to the native file system.

- -

The data parameter must be the appropriate data type for the specified format:

- - - - - - - - - -
FormatTypeDescription
ClipboardFormats.TEXT_FORMATStringstring data
ClipboardFormats.HTML_FORMATStringHTML string data
ClipboardFormats.URL_FORMATStringURL string (AIR only)
ClipboardFormats.RICH_TEXT_FORMATByteArrayRich Text Format data
ClipboardFormats.BITMAP_FORMATBitmapDatabitmap data (AIR only)
ClipboardFormats.FILE_LIST_FORMATarray of Filean array of files (AIR only)
Custom format nameanyobject reference and serialized clone
- -

Custom format names cannot begin with "air:" or "flash:". To prevent name collisions - when using custom formats, you may want to use your application ID or a package name as a - prefix to the format, such as "com.example.applicationName.dataPacket".

- -

When transferring within or between applications, the serializable parameter - determines whether both a reference and a copy are available, or whether only a reference to - an object is available. Set serializable to true to make both the reference - and a copy of the data object available. Set serializable to false - to make only the object reference available. Object references are valid only within the current - application so setting serializable to false also means that the data - in that format is not available to other Flash Player or AIR applications. A component can choose to get - the reference or the copy of the object by setting the appropriate clipboard transfer mode - when accessing the data for that format.

- -

Note: The standard formats are always converted to native formats when data is pasted or - dragged outside a supported application, so the value of the serializable - parameter does not affect the availability of data in the standard formats to non-Flash-based applications.

- -

To defer rendering of the data for a format, use the setDataHandler() method instead. - If both the setData() and the setDataHandler() methods are used to add a - data representation with the same format name, then the handler function will never be called.

-

Note: On Mac OS, when you set the format parameter to ClipboardFormats.URL_FORMAT, - the URL is transferred only if it is a valid URL. Otherwise, the Clipboard object is emptied (and calling - getData() returns null).

- Parameters - - - - - - - - - - - - - - - - -
format:String — The format of the data. -
 
data:Object — The information to add. -
 
serializable:Boolean (default = true) — Specify true for objects that can be serialized (and deserialized). - -
-

-Returns - - - - -
Boolean — - true if the data was succesfully set; - false otherwise. In Flash Player, returns false when format is an - unsupported member of ClipboardFormats. (Flash Player does not support ClipboardFormats.URL_FORMAT, - ClipboardFormats.FILE_LIST_FORMAT, ClipboardFormats.FILE_PROMISE_LIST_FORMAT, - or ClipboardFormats.BITMAP_FORMAT). - - - -
-
-Throws - - - - - - - - - - - - - - - - -
Error — The Clipboard object requested is no longer in scope (which can occur - with clipboards created for drag-and-drop operations). -
 
SecurityError — Reading from or writing to the clipboard is not permitted in this context. - In Flash Player, you can only call this method successfully during the processing of a user event - (as in a key press or mouse click). In AIR, this restriction only applies to content outside of the - application security sandbox. -
 
TypeError — format or data is null. - -
-

-See also -

-
-setDataHandler() -
-getData() -
-flash.desktop.ClipboardFormats -
-flash.desktop.ClipboardTransferMode -
-
-Example -
The following example adds content to the system clipboard in both - text and HTML formats: -
-
- import flash.desktop.ClipboardFormats;
- 
- var htmlString:String = "<html><body>Body content</body></html>";
- Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, urlString);
- Clipboard.generalClipboard.setData(ClipboardFormats.HTML_FORMAT, urlString);
-
-

-
- - - - - -
setDataHandler()method 
-
-public function setDataHandler(format:String, handler:Function, serializable:Boolean = true):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Adds a reference to a handler function that produces the data to be transfered. - -

Use a handler function to defer creation or rendering of the data until it is actually accessed.

- -

The handler function must return the appropriate data type for the specified format:

- - - - - - - - - - -
FormatReturn Type
ClipboardFormats.TEXT_FORMATString
ClipboardFormats.HTML_FORMATString
ClipboardFormats.URL_FORMATString (AIR only)
ClipboardFormats.RICH_TEXT_FORMATByteArray
ClipboardFormats.BITMAP_FORMATBitmapData (AIR only)
ClipboardFormats.FILE_LIST_FORMATArray of File (AIR only)
ClipboardFormats.FILE_PROMISE_LIST_FORMATArray of File (AIR only)
Custom format nameNon-void
- -

The handler function is called when and only when the data in the specified format is read. Note that in some cases, - the operating system calls the function before a drop occurs. For example, when you use a handler function to - provide the data for a file dragged from an AIR application to the file system, the operating - system calls the data handler function as soon as the drag gesture leaves the AIR application—typically resulting - in an undesireable pause as the file data is downloaded or created. You can use a URLFilePromise for this purpose instead.

- -

Note that the underlying data can change between the time the handler is added and the time the data is - read unless your application takes steps to protect the data. - The behavior that occurs when data on the clipboard represented by a handler function is read more than once - is not guaranteed. The clipboard might return the data produced by the first function call or it might call the - function again. Do not rely on either behavior.

- - -

In the application sandbox of Adobe AIR, setDataHandler() can be called anytime. In other - contexts, setDataHandler() can only be called in response to a user-generated event such as - a key press or mouse click.

- -

To add data directly to this Clipboard object, use the setData() method instead. - If both the setData() and the setDataHandler() methods are called with the same - format name, then the handler function is never called.

- -

Note: On Mac OS, when you set the format parameter to ClipboardFormats.URL_FORMAT, - the URL is transferred only if the handler function returns a valid URL. Otherwise, the Clipboard object is emptied - (and calling getData() returns null).

- Parameters - - - - - - - - - - - - - - - - -
format:String — A function that returns the data to be transferred. -
 
handler:Function — The format of the data. -
 
serializable:Boolean (default = true) — Specify true if the object returned by handler - can be serialized (and deserialized). - -
-

-Returns - - - - -
Boolean — - true if the handler was succesfully set; - false otherwise. - - - -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — format or handler is null. -
 
Error — The Clipboard object requested is no longer in scope (AIR only). -
 
SecurityError — Reading from or writing to the clipboard is not permitted in this context. - In Flash Player, you can only call this method successfully during the processing of a user event - (such as a key press or mouse click). In AIR, this restriction only applies to content outside of the - application security sandbox. - -
-

-See also -

-
-setData() -
-flash.desktop.ClipboardFormats -
flash.desktop.URLFilePromise
-
-Example -
The following example adds a random number to the system clipboard - through a deferred data function: -
-
- import flash.desktop.ClipboardFormats;
- 
- Clipboard.generalClipboard.setDataHandler(ClipboardFormats.TEXT_FORMAT, randomNumberGenerator);
-
- public function randomNumberGenerator():String{
-     return Math.random().toString();
- }
-
-

-
- -
Examples
-
examples\ClipboardExample
-
The following example, for Adobe AIR, uses the ClipboardExample class to - copy a string from one variable to another via the system clipboard. - This task is accomplished by performing the following steps: - -
    -
  1. Write the data, in this case a string, to Clipboard.generalClipboard.
    2. -
  2. Read the clipboard contents from Clipboard.generalClipboard.
    3. -
- -

Note: Because of security restrictions on accessing clipboard data, this example - does not work in Flash Player. In Flash Player, you can only call the getData() - method of the Clipboard object in a paste event handler.

-
-
-package
-{
-	import flash.display.Sprite;
-	import flash.desktop.Clipboard;
-	import flash.desktop.ClipboardFormats;
-	import flash.desktop.ClipboardTransferMode;
-
-	public class ClipboardExample extends Sprite
-	{
-		public function ClipboardExample()
-		{
-			var sally:String = "Sally";
-			var person:String;
-			
-			copy(sally);
-			person = paste();
-			trace(person); //traces: "Sally"
-		}
-
-		private function copy(text:String):void 
-		{
-			Clipboard.generalClipboard.clear();
-			Clipboard.generalClipboard.setData(ClipboardFormats.TEXT_FORMAT, text);
-		}
-		
-		private function paste():String
-		{
-			if(Clipboard.generalClipboard.hasFormat(ClipboardFormats.TEXT_FORMAT))
-			{
-				return String(Clipboard.generalClipboard.getData(ClipboardFormats.TEXT_FORMAT));
-			} 
-			else 
-			{
-				return null;
-			}
-		}
-		
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/ClipboardFormats.html b/html-docs/flash/desktop/ClipboardFormats.html deleted file mode 100644 index 2145fd5..0000000 --- a/html-docs/flash/desktop/ClipboardFormats.html +++ /dev/null @@ -1,425 +0,0 @@ - - - - - - - - -flash.desktop.ClipboardFormats (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic class ClipboardFormats
InheritanceClipboardFormats Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

-The ClipboardFormats class defines constants for the names of the standard data formats used with the Clipboard class. -Flash Player 10 only supports TEXT_FORMAT, RICH_TEXT_FORMAT, and HTML_FORMAT. - -

-

-See also -

-
-flash.desktop.Clipboard -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  BITMAP_FORMAT : String = "air:bitmap"
[static] - Image data (AIR only).
-		ClipboardFormats
  FILE_LIST_FORMAT : String = "air:file list"
[static] - An array of files (AIR only).
-		ClipboardFormats
  FILE_PROMISE_LIST_FORMAT : String = "air:file promise list"
[static] - File promise list (AIR only).
-		ClipboardFormats
  HTML_FORMAT : String = "air:html"
[static] - HTML data.
-		ClipboardFormats
  RICH_TEXT_FORMAT : String = "air:rtf"
[static] - Rich Text Format data.
-		ClipboardFormats
  TEXT_FORMAT : String = "air:text"
[static] - String data.
-		ClipboardFormats
  URL_FORMAT : String = "air:url"
[static] - A URL string (AIR only).
-		ClipboardFormats
-
- -
- -
Constant detail
- - - - - -
BITMAP_FORMATconstant
-
-public static const BITMAP_FORMAT:String = "air:bitmap" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Image data (AIR only). - -

- - - - - -
FILE_LIST_FORMATconstant 
-
-public static const FILE_LIST_FORMAT:String = "air:file list" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An array of files (AIR only). - -

- - - - - -
FILE_PROMISE_LIST_FORMATconstant 
-
-public static const FILE_PROMISE_LIST_FORMAT:String = "air:file promise list" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- File promise list (AIR only). - -

- - - - - -
HTML_FORMATconstant 
-
-public static const HTML_FORMAT:String = "air:html" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- HTML data. - -

- - - - - -
RICH_TEXT_FORMATconstant 
-
-public static const RICH_TEXT_FORMAT:String = "air:rtf" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.1 -
-

- Rich Text Format data. - -

- - - - - -
TEXT_FORMATconstant 
-
-public static const TEXT_FORMAT:String = "air:text" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- String data. - -

- - - - - -
URL_FORMATconstant 
-
-public static const URL_FORMAT:String = "air:url" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A URL string (AIR only). - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/ClipboardTransferMode.html b/html-docs/flash/desktop/ClipboardTransferMode.html deleted file mode 100644 index dbfdd49..0000000 --- a/html-docs/flash/desktop/ClipboardTransferMode.html +++ /dev/null @@ -1,341 +0,0 @@ - - - - - - - - -flash.desktop.ClipboardTransferMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic class ClipboardTransferMode
InheritanceClipboardTransferMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The ClipboardTransferMode class defines constants for the modes used as values of the transferMode - parameter of the Clipboard.getData() method. - -

The transfer mode provides a hint about whether to return a reference or a - copy when accessing an object contained on a clipboard.

- -

-

-See also -

-
-flash.desktop.Clipboard.getData() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  CLONE_ONLY : String = "cloneOnly"
[static] - The Clipboard object should only return a copy.
-		ClipboardTransferMode
  CLONE_PREFERRED : String = "clonePreferred"
[static] - The Clipboard object should return a copy if available and a reference if not.
-		ClipboardTransferMode
  ORIGINAL_ONLY : String = "originalOnly"
[static] - The Clipboard object should only return a reference.
-		ClipboardTransferMode
  ORIGINAL_PREFERRED : String = "originalPreferred"
[static] - The Clipboard object should return a reference if available and a copy if not.
-		ClipboardTransferMode
-
- -
- -
Constant detail
- - - - - -
CLONE_ONLYconstant
-
-public static const CLONE_ONLY:String = "cloneOnly" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Clipboard object should only return a copy. - -

- - - - - -
CLONE_PREFERREDconstant 
-
-public static const CLONE_PREFERRED:String = "clonePreferred" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Clipboard object should return a copy if available and a reference if not. - -

- - - - - -
ORIGINAL_ONLYconstant 
-
-public static const ORIGINAL_ONLY:String = "originalOnly" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Clipboard object should only return a reference. - -

- - - - - -
ORIGINAL_PREFERREDconstant 
-
-public static const ORIGINAL_PREFERRED:String = "originalPreferred" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Clipboard object should return a reference if available and a copy if not. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/DockIcon.html b/html-docs/flash/desktop/DockIcon.html deleted file mode 100644 index c57a767..0000000 --- a/html-docs/flash/desktop/DockIcon.html +++ /dev/null @@ -1,627 +0,0 @@ - - - - - - - - -flash.desktop.DockIcon (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic class DockIcon
InheritanceDockIcon Inheritance InteractiveIcon Inheritance Icon Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The DockIcon class represents the Mac OS X®-style dock icon. -

AIR profile support: This feature is supported on - all desktop operating systems, but it is not supported on mobile devices or AIR for TV devices. You can test - for support at run time using the NativeApplication.supportsDockIcon property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

You can use the DockIcon class to change the appearance of the standard - icon; for example, to animate the icon or add informational graphics. - You can also add items to the dock icon menu. The menu items that you add are displayed above - the standard menu items.

-

An instance of the DockIcon class cannot be created. Get the object - representing the operating system dock icon from NativeApplication.icon. -

-

Not all operating systems have dock icons. Check NativeApplication.supportsDockIcon - to determine whether dock icons are supported on the current system. If dock - icons are supported, the NativeApplication.icon property is of type - DockIcon. Otherwise, the type of NativeApplication.icon is another - subclass of InteractiveIcon, typically SystemTrayIcon.

-

Important: Attempting to call a DockIcon class method on the - NativeApplication.icon object on an operating system for which AIR does not support dock icons - generates a run-time exception.

-

-

-View the examples. -

-

-See also -

-
-flash.desktop.NativeApplication.icon -
-flash.desktop.NativeApplication.supportsDockIcon -
-flash.desktop.SystemTrayIcon -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bitmaps : Array -
-		DockIcon
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  height : int -
[read-only] - The current display height of the icon in pixels.
-		DockIcon
  menu : NativeMenu -
- The system-supplied menu of this dock icon.
-		DockIcon
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  width : int -
[read-only] - The current display width of the icon in pixels.
-		DockIcon
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-bounce(priority:String = "informational"):void -
-
- Notifies the user that an event has occurred that may require attention.
-		DockIcon
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
bitmapsproperty
-
-bitmaps:Array  [read-write]Implementation -
-    public function get bitmaps():Array -
-    public function set bitmaps(value:Array):void -
-
- - - - - -
heightproperty 
-
-height:int  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The current display height of the icon in pixels. -

Some icon contexts support dynamic sizes. - The height property indicates the height of the icon chosen from the bitmaps array - for the current context. The actual display height may be different if the operating system - has scaled the icon.

- Implementation -
-    public function get height():int -
-
- - - - - -
menuproperty 
-
-menu:NativeMenu  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The system-supplied menu of this dock icon. -

Any items in the menu are displayed above the standard items. - The standard items cannot be modified or removed.

- Implementation -
-    public function get menu():NativeMenu -
-    public function set menu(value:NativeMenu):void -
-
-Example -
The following example adds an item to the dock icon menu: -
-
- import flash.desktop.NativeApplication;
- import flash.events.Event;
- 
-private function createDockIconMenu():void{
-    if(NativeApplication.supportsDockIcon){				
-		var dockIcon:DockIcon = NativeApplication.nativeApplication.icon as DockIcon;
-		
-		var dockMenu:NativeMenu = new NativeMenu();
-		var command:NativeMenuItem = dockMenu.addItem(new NativeMenuItem("Command"));
-		command.addEventListener(Event.SELECT, onCommand);
-		
-		dockIcon.menu = dockMenu;
-	}
-}
-
- private function onCommand(event:Event):void{
- 	//do command...
- }
-
-

-
- - - - - -
widthproperty 
-
-width:int  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The current display width of the icon in pixels. -

Some icon contexts support dynamic sizes. - The width property indicates the width of the icon chosen from the bitmaps array - for the current context. The actual display width may be different if the operating system - has scaled the icon.

- Implementation -
-    public function get width():int -
-
- -
Method detail
- - - - - -
bounce()method
-
-public function bounce(priority:String = "informational"):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Notifies the user that an event has occurred that may require attention. -

Calling this method bounces the dock icon if, and only if, the - application is in the background. If the priority is - NotificationType.Informational then the icon bounces once. - If the priority is NotificationType.Critical then the - icon bounces until the application is brought to the foreground.

- Parameters - - - - -
priority:String (default = "informational") — The urgency with which to bounce the dock. -
-

-See also -

-
-flash.desktop.NotificationType -
-flash.display.NativeWindow.notifyUser() -
-
-Example -
The following example bounces the dock icon until the user - activates the application: -
-
- import flash.display.DockIcon;
- import flash.display.NotificationType;
- import flash.desktop.NativeApplication;
-
- if(NativeApplication.supportsDockIcon){
-     var dockIcon:DockIcon = NativeApplication.nativeApplication.icon As DockIcon;
- 	dockIcon.bounce(NotificationType.CRITICAL);
- }
-
-

-
- -
Examples
-
examples\DockIconExample
-
The following example loads a sequence of images and, - when the timer is started with the dock icon menu, animates the - icon image. (For the example to work, you must supply a set of icon - images and change the URLs in the imageURLs array.) -
-
-
- package {
-    import flash.desktop.DockIcon;
-	import flash.desktop.NativeApplication;
-	import flash.display.Loader;
-	import flash.display.NativeMenu;
-	import flash.display.NativeMenuItem;
-	import flash.display.Sprite;
-	import flash.events.Event;
-	import flash.events.TimerEvent;
-	import flash.net.URLRequest;
-	import flash.utils.Timer;
-
-	public class AnimatedDockIcon extends Sprite
-	{
-		private var imageURLs:Array =  ['gfx/frame01.png',
-										'gfx/frame02.png',
-										'gfx/frame03.png',
-										'gfx/frame04.png'];
-		
-		private var images:Array = new Array();
-		private var animTimer:Timer = new Timer(100);
-										
-		public function AnimatedDockIcon()
-		{
-			NativeApplication.nativeApplication.autoExit = false;
-			
-			addEventListener(Event.COMPLETE, loadImages);
-			loadImages();
-			
-			animTimer.addEventListener(TimerEvent.TIMER,advanceFrame);
-			addMenu();
-			stage.nativeWindow.close();
-		}
-		
-		private function addMenu():void{
-			var menu:NativeMenu = new NativeMenu();
-			var start:NativeMenuItem = menu.addItem(new NativeMenuItem("Start animation"));
-			var stop:NativeMenuItem = menu.addItem(new NativeMenuItem("Stop animation"));
-			start.addEventListener(Event.SELECT, startTimer);
-			stop.addEventListener(Event.SELECT, stopTimer);
-			
-			var dockIcon:DockIcon =	NativeApplication.nativeApplication.icon as DockIcon;
-			dockIcon.menu = menu;
-		}
-		
-		private function startTimer(event:Event):void{
-			animTimer.start();
-		}
-
-		private function stopTimer(event:Event):void{
-			animTimer.stop();
-		}
-
-		private var currentFrame:int = 0;
-		private function advanceFrame(event:Event):void{
-			if(currentFrame < images.length){
-				currentFrame++;
-			} else {
-				currentFrame = 0;
-			}
-			NativeApplication.nativeApplication.icon.bitmaps = [images[currentFrame]];
-		}
-		
-
-		private function loadImages(event:Event = null):void{
-        	if(event != null){
-        		images.push(event.target.content.bitmapData);
-        	}
-        	if(imageURLs.length > 0){
-        		var urlString:String = imageURLs.pop();
-        		var loader:Loader = new Loader();
-        		loader.contentLoaderInfo.addEventListener(Event.COMPLETE, loadImages, false, 0, true);
-				loader.load(new URLRequest(urlString));
-        	} else {
-        		var complete:Event = new Event(Event.COMPLETE,false,false);
-        		dispatchEvent(complete);
-        	}
-        }
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/IFilePromise.html b/html-docs/flash/desktop/IFilePromise.html deleted file mode 100644 index 3ab5c4b..0000000 --- a/html-docs/flash/desktop/IFilePromise.html +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - - - -flash.desktop.IFilePromise (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Interfacepublic interface IFilePromise
ImplementorsMediaPromise
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The IFilePromise interface defines the interface used by the AIR runtime to read data for a file promise. - -

A file promise is a drag-and-drop clipboard format that allows a user to drag a file that does not yet - exist out of an AIR application. AIR uses the methods and properties defined by the IFilePromise interface - to access the data to be written when the file promise is dropped.

- -

When a file promise is dropped on a suitable target, AIR calls the IFilePromise open() - method. The implementation of this method must return the data provider as an object that implements the IDataInput interface. - The provider object can be one of the built-in classes, such as ByteArray, FileStream, Socket, and URLStream, or - it can be a custom class.

- -

If the data from the data provider is accessed synchronously, such as with a ByteArray, AIR reads the amount of data indicated by the IDataInput - bytesAvailable property and writes it to the destination file.

- -

If the data from the data provider is accessed asynchronously, such as with a Socket, AIR uses events dispatched by the provider to regulate - the process of reading the data and writing it to the file. Data is read at each progress event until a complete or a close - event is received. The runtime listens for the following events (but a data provider does not need to dispatch every event):

-
    -
  • Event.OPEN
    • -
  • ProgressEvent.PROGRESS
    • -
  • ProgressEvent.SOCKET_DATA
    • -
  • Event.COMPLETE
    • -
  • Event.CLOSE
    • -
  • IOErrorEvent.IOERROR
    • -
  • SecurityErrorEvent.SECURITY_ERROR
    • -
  • HTTPStatusEvent.HTTP_STATUS
    • -
  • HTTPStatusEvent.HTTP_RESPONSE_STATUS
    • -
- -

Custom data provider classes should dispatch either a progress event or a socketData - event when data is available. Likewise, either a complete or a close event should be - dispatched when all the requested data has been read. The error events inform the runtime that the data transfer - has failed and should be aborted. The other events should be dispatched as appropriate to - aid in error handling and in debugging application logic.

- -

The methods defined by IFilePromise are only intended to be called by the AIR runtime after a drag and drop operation has completed. - Developers should not typically call these methods from their own code.

- -

Note: The URLFilePromise class, available in the air.desktop library implements the IFilePromise interface and uses the URLStream as - a data provider. The air.desktop library is included as separate SWF and SWC files in the AIR SDK.

- -

-

-See also -

-
-flash.desktop.Clipboard -
-flash.desktop.ClipboardFormats -
-flash.desktop.NativeDragManager -
-
-
-
- -
-
Public Properties
- - - - - - - - - - -
 PropertyDefined by
  isAsync : Boolean -
[read-only] - Indicates whether asynchronous data transfer is supported.
-		IFilePromise
  relativePath : String -
[read-only] - The relative path and file name of the file that will be created by this file promise.
-		IFilePromise
-
- -
-
Public Methods
- - - - - - - - - - - - - -
 MethodDefined by
   -
-close():void -
-
- Called by the AIR runtime when it has finished reading all data.
-		IFilePromise
   -
-open():IDataInput -
-
- Returns the data provider object.
-		IFilePromise
   -
-reportError(e:ErrorEvent):void -
-
- Called by the AIR runtime to inform the IFilePromise implementation of errors - that occur when reading data from the data provider object.
-		IFilePromise
-
- -
- -
Property detail
- - - - - -
isAsyncproperty
-
-isAsync:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether asynchronous data transfer is supported. - -

If true, then the data provider object returned by the open() method must implement the - IEventDispatcher interface (or extend a class implementing this interface). The data transfer is driven by - progress or socketData events. AIR waits for these data progress events until a - complete or a close event is dispatched.

- -

If isAsync returns false, then the AIR runtime assumes that all data is available immediately. - In this case, the runtime reads the bytesAvailable property of the data provider object - to determine the amount of data available and synchronously reads that amount of data.

- - Implementation -
-    public function get isAsync():Boolean -
-
- - - - - -
relativePathproperty 
-
-relativePath:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The relative path and file name of the file that will be created by this file promise. - -

This property must provide a valid path or an argument error is thrown when the file promise is dropped.

- -

The path can include subdirectories, which are resolved based on the drop location. The subdirectories are created, - if needed. When including subdirectories, use the File.separator constant to insert the - proper path separator character for the current operating system. Using the .. shortcut to navigate to a parent directory - is not allowed. If attempted, an argument error is thrown. Invalid file system characters are stripped from the path - without throwing an error.

- -

Note: To allow client code to set the path, you can implement a setter function with the signature: - function set relativePath( value:String ):void.

- - Implementation -
-    public function get relativePath():String -
-
-Throws -
- - - - -
ArgumentError — if the relative path uses .. shortcuts to traverse one or more parent directories - of the drop target. - -
-
- -
Method detail
- - - - - -
close()method
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Called by the AIR runtime when it has finished reading all data. - -

No methods will be called on the object reference returned by open() after close() has been called. - The data provider object can be safely destroyed.

-
- - - - - -
open()method 
-
-public function open():IDataInput -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns the data provider object. - -

The data provider object must implement the IDataInput interface, which defines methods for reading - data. If the IFilePromise isAsync property returns true, then the data - provider object must also implement the IEventDispatcher interface. The following built-in classes can - be used as a data provider:

-
    -
  • ByteArray (synchronous)
    • -
  • FileStream (synchronous or asynchronous)
    • -
  • Socket (asynchronous)
    • -
  • URLStream (asynchronous)
    • -
-

You can also provide an object of a custom class that implements the required interfaces (or extends - another class that implements them).

- -

-Returns - - - - -
IDataInput — - IDataInput An object implementing the IDataInput interface. If the data is provided asynchronously, - the returned object must also implement the IEventDispatcher interface. - - - -
-
- - - - - -
reportError()method 
-
-public function reportError(e:ErrorEvent):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Called by the AIR runtime to inform the IFilePromise implementation of errors - that occur when reading data from the data provider object. - -

Parameters - - - - -
e:ErrorEvent — The error event containing detailed error information. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/Icon.html b/html-docs/flash/desktop/Icon.html deleted file mode 100644 index 5a845e2..0000000 --- a/html-docs/flash/desktop/Icon.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - -flash.desktop.Icon (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.desktop
Classpublic class Icon
InheritanceIcon Inheritance EventDispatcher Inheritance Object
SubclassesInteractiveIcon
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The Icon class represents an operating system icon. - -

An Icon object has one property, bitmaps, which is an array - of BitmapData objects. Only one image is displayed at a time. The operating - system selects the image closest in size to the icon's current display size, - scaling if necessary.

- -

-

-See also -

-
-flash.filesystem.File.icon -
-flash.display.BitmapData -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
  bitmaps : Array -
- The icon image as an array of BitmapData objects of different sizes.
-		Icon
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
bitmapsproperty
-
-bitmaps:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The icon image as an array of BitmapData objects of different sizes. - -

When an icon is displayed in a given operating system context, the bitmap - in the array closest to the displayed size is used (and - scaled if necessary). Common sizes include 16x16, 32x32, 48x48, and - 128x128. (512x512 pixel icons may be used for some operating system - icons in the near future.)

-

In some contexts, the operating system may use a default system icon - if nothing has been assigned to the bitmaps property. - In other contexts, no icon appears.

- -

To set or change the icon appearance, assign an array of - BitmapData objects to the bitmaps property:

- - 
-	 icon.bitmaps = new Array(icon16x16.bitmapData, icon128x128.bitmapData);
-
- -

Modifying the bitmaps array directly has no effect.

- -

To clear the icon image, assign an empty array to the - bitmaps property.

-

- Note: When loading image files for an icon, the PNG file format - generally provides the best alpha blending. The GIF format supports only - on or off transparency (no blending). The JPG format does not support - transparency at all. -

- - Implementation -
-    public function get bitmaps():Array -
-    public function set bitmaps(value:Array):void -
-

-See also -

-
-flash.filesystem.File.icon -
-flash.display.BitmapData -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/InteractiveIcon.html b/html-docs/flash/desktop/InteractiveIcon.html deleted file mode 100644 index f3c1b79..0000000 --- a/html-docs/flash/desktop/InteractiveIcon.html +++ /dev/null @@ -1,438 +0,0 @@ - - - - - - - - -flash.desktop.InteractiveIcon (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.desktop
Classpublic class InteractiveIcon
InheritanceInteractiveIcon Inheritance Icon Inheritance EventDispatcher Inheritance Object
SubclassesDockIcon, SystemTrayIcon
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The InteractiveIcon class is the base class for the operating - system icons associated with applications. -

Use the icon property of the NativeApplication object to get an instance of the application - icon. The icon type will be one of the subclasses of InteractiveIcon, - either DockIcon on Mac OS X® or SystemTrayIcon on Windows® and Linux.

- -

You cannot instantiate the InteractiveIcon class directly. Calls to - the new InteractiveIcon() constructor will throw an - ArgumentError exception.

-

-

-See also -

-
-flash.desktop.NativeApplication.icon -
-flash.desktop.NativeApplication.supportsDockIcon -
-flash.desktop.NativeApplication.supportsSystemTrayIcon -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bitmaps : Array -
- The icon image as an array of BitmapData objects of different sizes.
-		InteractiveIcon
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  height : int -
[read-only] - The current display height of the icon in pixels.
-		InteractiveIcon
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  width : int -
[read-only] - The current display width of the icon in pixels.
-		InteractiveIcon
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
bitmapsproperty
-
-bitmaps:Array  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The icon image as an array of BitmapData objects of different sizes. - -

When an icon is displayed in a given operating system context, the bitmap - in the array closest to the displayed size is used (and - scaled if necessary). Common sizes include 16x16, 32x32, 48x48, and - 128x128. (512x512 pixel icons may be used for some operating system - icons in the near future.)

-

In some contexts, the operating system may use a default system icon - if nothing has been assigned to the bitmaps property. - In other contexts, no icon appears.

- -

To set or change the icon appearance, assign an array of - BitmapData objects to the bitmaps property:

- - 
-	 icon.bitmaps = new Array(icon16x16.bitmapData, icon128x128.bitmapData);
-
- -

Modifying the bitmaps array directly has no effect.

- -

To clear the icon image, assign an empty array to the - bitmaps property.

-

- Note: When loading image files for an icon, the PNG file format - generally provides the best alpha blending. The GIF format supports only - on or off transparency (no blending). The JPG format does not support - transparency at all. -

- - Implementation -
-    public function get bitmaps():Array -
-    public function set bitmaps(value:Array):void -
-
- - - - - -
heightproperty 
-
-height:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The current display height of the icon in pixels. -

Some icon contexts support dynamic sizes. - The height property indicates the height of the icon chosen from the bitmaps array - for the current context. The actual display height may be different if the operating system - has scaled the icon.

- Implementation -
-    public function get height():int -
-
- - - - - -
widthproperty 
-
-width:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The current display width of the icon in pixels. -

Some icon contexts support dynamic sizes. - The width property indicates the width of the icon chosen from the bitmaps array - for the current context. The actual display width may be different if the operating system - has scaled the icon.

- Implementation -
-    public function get width():int -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/InvokeEventReason.html b/html-docs/flash/desktop/InvokeEventReason.html deleted file mode 100644 index fc9ddf5..0000000 --- a/html-docs/flash/desktop/InvokeEventReason.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - - - -flash.desktop.InvokeEventReason (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic final class InvokeEventReason
InheritanceInvokeEventReason Inheritance Object
-

- - - - -
Runtime version: AIR 1.5.1 -
-

-

- The InvokeEventReason class enumerates values returned by the - reason property of an InvokeEvent object. - -

-

-See also -

-
-flash.events.InvokeEvent.reason -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  LOGIN : String = "login"
[static] - Desktop only; indicates that the InvokeEvent event occurred due to the user logging in.
-		InvokeEventReason
  NOTIFICATION : String = "notification"
[static] - iOS only; indicates that the InvokeEvent occurred because the application was invoked on receiving a remote notification - -
-		InvokeEventReason
  OPEN_URL : String = "openUrl"
[static] - Mobile only; indicates that the InvokeEvent occurred because the application was invoked by another application or by the system.
-		InvokeEventReason
  STANDARD : String = "standard"
[static] - Indicates that the InvokeEvent occured for any reason other than login or open url.
-		InvokeEventReason
-
- -
- -
Constant detail
- - - - - -
LOGINconstant
-
-public static const LOGIN:String = "login" -

- - - - -
Runtime version: AIR 1.5.1 -
-

- Desktop only; indicates that the InvokeEvent event occurred due to the user logging in. - -

- - - - - -
NOTIFICATIONconstant 
-
-public static const NOTIFICATION:String = "notification" -

- - - - -
Runtime version: AIR 3.5 -
-

- iOS only; indicates that the InvokeEvent occurred because the application was invoked on receiving a remote notification - -

- - - - - -
OPEN_URLconstant 
-
-public static const OPEN_URL:String = "openUrl" -

- - - - -
Runtime version: AIR 3.5 -
-

- Mobile only; indicates that the InvokeEvent occurred because the application was invoked by another application or by the system. - -

- - - - - -
STANDARDconstant 
-
-public static const STANDARD:String = "standard" -

- - - - -
Runtime version: AIR 1.5.1 -
-

- Indicates that the InvokeEvent occured for any reason other than login or open url. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/NativeApplication.html b/html-docs/flash/desktop/NativeApplication.html deleted file mode 100644 index 18755be..0000000 --- a/html-docs/flash/desktop/NativeApplication.html +++ /dev/null @@ -1,3475 +0,0 @@ - - - - - - - - -flash.desktop.NativeApplication (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic final class NativeApplication
InheritanceNativeApplication Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The NativeApplication class represents this AIR application. - - - -

- - The NativeApplication class provides application information, - - application-wide functions, and dispatches application-level events. - -

- -

- - The NativeApplication object is a singleton object, created automatically at startup. - - Get the NativeApplication instance of an application with the static property - - NativeApplication.nativeApplication. - -

- - - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  activeWindow : NativeWindow -
[read-only] - - The active application window.
-		NativeApplication
  applicationDescriptor : XML -
[read-only] - - The contents of the application descriptor file for this AIR application.
-		NativeApplication
  applicationID : String -
[read-only] - - The application ID of this application.
-		NativeApplication
  autoExit : Boolean -
- - Specifies whether the application should automatically terminate when - - all windows have been closed.
-		NativeApplication
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  executeInBackground : Boolean -
- - Specifies whether the application will run in background or not.
-		NativeApplication
  icon : InteractiveIcon -
[read-only] - - The application icon.
-		NativeApplication
  idleThreshold : int -
- - The number of seconds that must elapse without user input - - before a userIdle event is dispatched.
-		NativeApplication
  isActive : Boolean -
[read-only] - - Is the application currently active (having operating system focus).
-		NativeApplication
  isCompiledAOT : Boolean -
[read-only] - - Specifies whether the application is compiled or interpreted for the desired platform.
-		NativeApplication
  menu : NativeMenu -
- - The application menu.
-		NativeApplication
  nativeApplication : NativeApplication -
[static][read-only] - - The singleton instance of the NativeApplication object.
-		NativeApplication
  openedWindows : Array -
[read-only] - - An array containing all the open native windows of this application.
-		NativeApplication
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  publisherID : String -
[read-only] - - The publisher ID of this application.
-		NativeApplication
  runtimePatchLevel : uint -
[read-only] - - The patch level of the runtime hosting this application.
-		NativeApplication
  runtimeVersion : String -
[read-only] - - The version number of the runtime hosting this application.
-		NativeApplication
  startAtLogin : Boolean -
- - Specifies whether this application is automatically launched whenever the - - current user logs in.
-		NativeApplication
  supportsDefaultApplication : Boolean -
[static][read-only] - - Indicates whether setAsDefaultApplication(), removeAsDefaultApplication(), and - - isSetAsDefaultApplication() are supported on the current platform.
-		NativeApplication
  supportsDockIcon : Boolean -
[static][read-only] - - Indicates whether AIR supports dock-style application icons on the current operating system.
-		NativeApplication
  supportsMenu : Boolean -
[static][read-only] - - Specifies whether the current operating system supports a global application menu bar.
-		NativeApplication
  supportsStartAtLogin : Boolean -
[static][read-only] - - Indicates whether startAtLogin is supported on the current platform.
-		NativeApplication
  supportsSystemTrayIcon : Boolean -
[static][read-only] - - Specifies whether AIR supports system tray icons on the current operating system.
-		NativeApplication
  systemIdleMode : String -
- - Provides a way for applications to prevent the user interface from going into "idle" mode.
-		NativeApplication
  timeSinceLastUserInput : int -
[read-only] - - The time, in seconds, since the last user input.
-		NativeApplication
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-activate(window:NativeWindow = null):void -
-
- - Activates this application.
-		NativeApplication
   -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		NativeApplication
   -
-clear():Boolean -
-
- - Invokes an internal delete command on the focused display object.
-		NativeApplication
   -
-copy():Boolean -
-
- - Invokes an internal copy command on the focused display object.
-		NativeApplication
   -
-cut():Boolean -
-
- - Invokes an internal cut command on the focused display object.
-		NativeApplication
   -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		NativeApplication
   -
-exit(errorCode:int = 0):void -
-
- - Terminates this application.
-		NativeApplication
   -
-getDefaultApplication(extension:String):String -
-
- - Gets the default application for opening files with the specified extension.
-		NativeApplication
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-isSetAsDefaultApplication(extension:String):Boolean -
-
- - Specifies whether this application is currently the default application - - for opening files with the specified extension.
-		NativeApplication
   -
-paste():Boolean -
-
- - Invokes an internal paste command on the focused display object.
-		NativeApplication
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-removeAsDefaultApplication(extension:String):void -
-
- - Removes this application as the default for opening files with the specified extension.
-		NativeApplication
   -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		NativeApplication
   -
-selectAll():Boolean -
-
- - Invokes an internal selectAll command on the focused display object.
-		NativeApplication
   -
-setAsDefaultApplication(extension:String):void -
-
- - Sets this application as the default application for opening files with the specified extension.
-		NativeApplication
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
   -
-activate -
-		 - - Dispatched when this application becomes the active desktop application.NativeApplication
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-browserInvoke -
-		 - - Dispatched when an application is invoked by a SWF file running in the user's browser.NativeApplication
   -
-deactivate -
-		 - - Dispatched when the desktop focus is switched to a different application.NativeApplication
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-exiting -
-		 - - Dispatched when the application exit sequence is started.NativeApplication
   -
-invoke -
-		 - - Dispatched when an application is invoked.NativeApplication
   -
-keyDown -
-		 - - Dispatched when the user presses a key.NativeApplication
   -
-keyUp -
-		 - - Dispatched when the user releases a key.NativeApplication
   -
-networkChange -
-		 - - Dispatched when either a new network connection becomes available or - - an existing network connection is lost.NativeApplication
   -
-suspend -
-		 - - Dispatched when the application is about to be suspended by the operating system.NativeApplication
   -
-userIdle -
-		 - - Dispatched when the user has been idle.NativeApplication
   -
-userPresent -
-		 - - Dispatched when the operating system detects mouse or keyboard activity after an idle period.NativeApplication
-
- -
- -
Property detail
- - - - - -
activeWindowproperty
-
-activeWindow:NativeWindow  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The active application window. - - - -

If the active desktop window does not belong - - to this application, or there is no active window, activeWindow is - - null.

- - -

This property is not supported on platforms that do not support the NativeWindow class.

- - - Implementation -
-    public function get activeWindow():NativeWindow -
-
- - - - - -
applicationDescriptorproperty 
-
-applicationDescriptor:XML  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The contents of the application descriptor file for this AIR application. - - - -

ActionScript 3.0 code in SWF files supports E4X syntax for - - for working with XML data. However in HTML-based AIR applications, you will want to - - convert the XML value of this property to a DOMParser object, using the - - parseFromString() method of a DOMParser object.

- - - -

Implementation -
-    public function get applicationDescriptor():XML -
-
-Example -
The following example reads the copyright and version - elements from the application descriptor file. Note that you must use the default namespace - defined in the application descriptor XML. -
-
-var appDescriptor:XML = NativeApplication.nativeApplication.applicationDescriptor;
-var ns:Namespace = appDescriptor.namespace();
-var appCopyright:String = appDescriptor.ns::copyright;
-var appVersion:String = appDescriptor.ns::version;
-trace("appId:", appCopyright);
-trace("version:", appVersion);
-
- -

-
- - - - - -
applicationIDproperty 
-
-applicationID:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The application ID of this application. - - - -

The value of this ID is set in the - - application descriptor file.

- - - Implementation -
-    public function get applicationID():String -
-
- - - - - -
autoExitproperty 
-
-autoExit:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Specifies whether the application should automatically terminate when - - all windows have been closed. - - - -

When autoExit is true, which is the default, - - the application terminates when all windows are closed. Both - - exiting and exit events are dispatched. - - When autoExit is false, you must call - - NativeApplication.nativeApplication.exit() to terminate the application.

- - -

This property is not supported on platforms that do not support the NativeWindow class.

- - - - Implementation -
-    public function get autoExit():Boolean -
-    public function set autoExit(value:Boolean):void -
-
- - - - - -
executeInBackgroundproperty 
-
-executeInBackground:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.3 - -
-

- - Specifies whether the application will run in background or not. - - -

When executeInBackground is false, which is the default, - - the application remains in suspended state when it goes to background. - - When executeInBackground is true, the application may execute in background. - -

- -

Note: With swf-version 21 and its earlier versions, AIR does not support background - - execution on iOS and Android when render mode direct is set. Due to this restriction, Stage3D - - based apps cannot execute background tasks like audio playback, location updates, network - - upload or download, etc. iOS does not allow OpenGLES or rendering of calls in the background. - - Applications which attempt to make OpenGL calls in the background are terminated by iOS. Android - - does not restrict applications from either making OpenGLES calls in the background or performing - - other background tasks like audio playback. With swf-version 22 and later, AIR mobile - - applications can execute in the background when renderMode direct is set. The AIR iOS runtime - - results in an ActionScript error (3768 - The Stage3D API may not be used during background - - execution) if OpenGLES calls are made in the background. However, there are no errors on Android - - because its native applications are allowed to make OpenGLES calls in the background. For optimal - - utilization of mobile resource, do not make rendering calls while an application is executing in - - the background.

- -

This property is supported on AIR iOS and Android.

- - - Implementation -
-    public function get executeInBackground():Boolean -
-    public function set executeInBackground(value:Boolean):void -
-
- - - - - -
iconproperty 
-
-icon:InteractiveIcon  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The application icon. - - - -

Use NativeApplication.supportsDockIcon and NativeApplication.supportsSystemTrayIcon - - to determine the icon class. The type will be one - - of the subclasses of InteractiveIcon. On Mac® OS X, NativeApplication.icon - - is an object of type DockIcon. On Windows®, NativeApplication.icon - - is an object of type SystemTrayIcon. When an application icon is not supported, - - NativeApplication.supportsDockIcon and NativeApplication.supportsSystemTrayIcon are - - both false and the icon property is null.

- - - -

The icon object is automatically created, but it is not initialized - - with image data. On some operating systems, such as Mac OS X, a default image is supplied. - - On others, such as Windows, the icon is not displayed unless image data is assigned to it. - - To assign an icon image, set the icon.bitmaps property with an array - - containing at least one BitmapData object. If more than one BitmapData object is included - - in the array, then the operating system chooses the image that is closest in size to the icon's - - display dimensions, scaling the image if necessary.

- - - Implementation -
-    public function get icon():InteractiveIcon -
-

-See also -

-
-supportsDockIcon -
-flash.desktop.DockIcon -
-supportsSystemTrayIcon -
-flash.desktop.SystemTrayIcon -
-
- - - - - -
idleThresholdproperty 
-
-idleThreshold:int  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The number of seconds that must elapse without user input - - before a userIdle event is dispatched. - - - -

By default, the idle threshold is 300 seconds (5 minutes). The acceptable - - range of values is from 5 (5 seconds) through 86,400 (1 day), inclusive.

- - - Implementation -
-    public function get idleThreshold():int -
-    public function set idleThreshold(value:int):void -
-
-Throws -
- - - - -
ArgumentError — If you attempt to set the property to an invalid value. - - The acceptable range of values is from 5 (5 seconds) through 86,400 (1 day), inclusive. - - -
-

-See also -

-
-userIdle -
-userPresent -
-
- - - - - -
isActiveproperty 
-
-isActive:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Is the application currently active (having operating system focus). This property changes immediately prior to the dispatch - - of the activate and deactivate events. - - -

Implementation -
-    public function get isActive():Boolean -
-
- - - - - -
isCompiledAOTproperty 
-
-isCompiledAOT:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 25.0 - -
-

- - Specifies whether the application is compiled or interpreted for the desired platform. - - This API returns (true) only for iOS for targets(ipa-app-store, ipa-test, ipa-debug, ipa-ad-hoc). - - For other AIR platforms, this API returns (false). - - -

Implementation -
-    public function get isCompiledAOT():Boolean -
-
- - - - - -
menuproperty 
-
-menu:NativeMenu  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The application menu. - - - -

Application menus are supported when NativeApplication.supportsMenu - - is true. Not all operating systems support application - - menus. For example, application menus are supported on Mac OS X, but not on Windows or Linux. - - Assigning a NativeMenu object to this property when NativeApplication.supportsMenu - - is false is allowed, but does nothing. Be sure to use the - - NativeApplication.supportsMenu property to determine whether the - - operating system supports application menus. Using other means (such as Capabilities.os) - - to determine support can lead to programming errors (if some possible target operating systems - - are not considered).

- - - -

AIR profile support: This feature is not supported - - on mobile devices or AIR for TV devices. See - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - - -

Note: On Mac OS X, the menu property references the - - operating-system-supplied default application menu. You can modify the - - existing menu structure by adding and removing items and submenus, and - - by adding event listeners. You can also replace the default menus entirely by - - assigning a new NativeMenu object to this menu property.

- - - - Implementation -
-    public function get menu():NativeMenu -
-    public function set menu(value:NativeMenu):void -
-

-See also -

-
-flash.display.NativeMenu -
-flash.display.NativeWindow.supportsMenu -
-
- - - - - -
nativeApplicationproperty 
-
-nativeApplication:NativeApplication  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The singleton instance of the NativeApplication object. - - - -

Implementation -
-    public static function get nativeApplication():NativeApplication -
-
-Throws -
- - - - -
Error — If accessed by content outside the application - - security sandbox. - - -
-
- - - - - -
openedWindowsproperty 
-
-openedWindows:Array  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - An array containing all the open native windows of this application. - - -

This property is not supported on platforms that do not support the NativeWindow class.

- - Implementation -
-    public function get openedWindows():Array -
-
- - - - - -
publisherIDproperty 
-
-publisherID:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The publisher ID of this application. - - - -

The value of this ID is set in the - - application's publisherid file, which is generated at installation from the - - certificate chain used to sign the application.

- - - Implementation -
-    public function get publisherID():String -
-
- - - - - -
runtimePatchLevelproperty 
-
-runtimePatchLevel:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The patch level of the runtime hosting this application. - - -

Implementation -
-    public function get runtimePatchLevel():uint -
-
- - - - - -
runtimeVersionproperty 
-
-runtimeVersion:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The version number of the runtime hosting this application. - - -

Implementation -
-    public function get runtimeVersion():String -
-
- - - - - -
startAtLoginproperty 
-
-startAtLogin:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Specifies whether this application is automatically launched whenever the - - current user logs in. - - -

AIR profile support: This feature is supported - - on all desktop operating systems, but is not supported on mobile devices or AIR for TV devices. You can test - - for support at run time using the NativeApplication.supportsStartAtLogin property. See - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - - -

- - The startAtLogin property reflects the status of the operating-system-defined mechanism for - - designating that an application should start automatically when a user logs in. The - - user can change the status manually by using the operating system user interface. This - - property reflects the current status, whether the status was last changed - - by the AIR application or by the operating system. - -

- - Implementation -
-    public function get startAtLogin():Boolean -
-    public function set startAtLogin(value:Boolean):void -
-
-Throws -
- - - - - - - - - - -
Error — On Windows when another application with the same name - - (but with a different path to the executable) is already set to - - launch when this user logs in. - - -
 
Error — If this application is not installed, which - - may be the case when launched by the AIR Debug Launcher (ADL). - - - -
-

-See also -

-
-supportsStartAtLogin -
-
- - - - - -
supportsDefaultApplicationproperty 
-
-supportsDefaultApplication:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Indicates whether setAsDefaultApplication(), removeAsDefaultApplication(), and - - isSetAsDefaultApplication() are supported on the current platform. - - - -

If true, then the above methods will work as documented. - - If false, then setAsDefaultApplication() and removeDefaultApplication() - - do nothing and isSetAsDefaultApplication() returns false.

- - - Implementation -
-    public static function get supportsDefaultApplication():Boolean -
-

-See also -

-
-setAsDefaultApplication() -
-removeAsDefaultApplication() -
-isSetAsDefaultApplication() -
-
- - - - - -
supportsDockIconproperty 
-
-supportsDockIcon:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether AIR supports dock-style application icons on the current operating system. - - - -

If true, the NativeApplication.icon property is of type - - DockIcon.

- - - -

The Mac OS X user interface provides an application - - "dock" containing icons for applications that are running or are frequently used.

- - -

Be sure to use the NativeApplication.supportsDockIcon property to determine whether the - - operating system supports application dock icons. Using other means (such as Capabilities.os) - - to determine support can lead to programming errors (if some possible target operating systems - - are not considered).

- - - Implementation -
-    public static function get supportsDockIcon():Boolean -
-

-See also -

-
-icon -
-flash.desktop.DockIcon -
-
- - - - - -
supportsMenuproperty 
-
-supportsMenu:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Specifies whether the current operating system supports a global application menu bar. - - - -

When true, the NativeApplication.menu property can be used to define (or access) a native - - application menu.

- - -

Be sure to use the NativeApplication.supportsMenu property to determine whether the - - operating system supports the application menu bar. Using other means (such as Capabilities.os) - - to determine support can lead to programming errors (if some possible target operating systems - - are not considered).

- - - Implementation -
-    public static function get supportsMenu():Boolean -
-

-See also -

-
-menu -
-flash.display.NativeWindow.supportsMenu -
-
- - - - - -
supportsStartAtLoginproperty 
-
-supportsStartAtLogin:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Indicates whether startAtLogin is supported on the current platform. - - - -

If true, then startAtLogin works as documented. - - If false, then startAtLogin has no effect.

- - - Implementation -
-    public static function get supportsStartAtLogin():Boolean -
-

-See also -

-
-startAtLogin -
-
- - - - - -
supportsSystemTrayIconproperty 
-
-supportsSystemTrayIcon:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Specifies whether AIR supports system tray icons on the current operating system. - - - -

If true, the NativeApplication.icon property is of type - - SystemTrayIcon.

- - -

The Windows user interface provides the "system tray" region of the task bar, officially called - - the Notification Area, in which application icons can be displayed. No default icon is shown. You - - must set the bitmaps array of the icon object to display an icon.

- - - -

Be sure to use the NativeApplication.supportsSystemTrayIcon property to determine whether the - - operating system supports system tray icons. Using other means (such as Capabilities.os) - - to determine support can lead to programming errors (if some possible target operating systems - - are not considered).

- - - Implementation -
-    public static function get supportsSystemTrayIcon():Boolean -
-

-See also -

-
-icon -
-flash.desktop.SystemTrayIcon -
-
- - - - - -
systemIdleModeproperty 
-
-systemIdleMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Provides a way for applications to prevent the user interface from going into "idle" mode. - - -

A value from the SystemIdleMode class to influence the host system's idle mode behavior. - - This property is only effective for the application with input focus and can only be accessed from - - content running in the application sandbox.

- - -

AIR profile support: This feature is supported - - on mobile devices, but it is not supported on desktop operating systems or AIR for TV devices. See - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - - Implementation -
-    public function get systemIdleMode():String -
-    public function set systemIdleMode(value:String):void -
-

-See also -

-
-flash.desktop.SystemIdleMode -
-
- - - - - -
timeSinceLastUserInputproperty 
-
-timeSinceLastUserInput:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The time, in seconds, since the last user input. - - -

Implementation -
-    public function get timeSinceLastUserInput():int -
-

-See also -

-
-userIdle -
-userPresent -
-
- -
Method detail
- - - - - -
activate()method
-
-public function activate(window:NativeWindow = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Activates this application. - - -

This method is not supported on platforms that do not support the NativeWindow class.

- - - -

Under some circumstances determined by the operating system, this method does not - - activate an application. Most operating systems restrict the ability of an application - - to activate itself to prevent it from accidentally or maliciously making it impossible - - for a user to use other applications.

- - - -

If the window parameter is specified and the operating system allows activation, - - then the specified window is activated, this will:

- -
    - -
  • Make the window visible
    • - -
  • Bring the window to the desktop foreground; that is, in front of the windows of other applications
    • - -
  • Give the window keyboard and mouse focus
    • - -
- - -

If the window parameter is null, then any - - visible window of this application is activated.

- - -

If the window parameter is null and the application has no visible windows - - then the activate() method has no effect.

- - - -

The activate operation is synchronous.

- - - - Parameters - - - - -
window:NativeWindow (default = null) — The NativeWindow object of the window to activate along with the application. - -
-
-Events - - - - -
activate:Event — Dispatched if the activation state changes.
-
- - - - - -
addEventListener()method 
-
-public override function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -

- - - - -
Runtime version: AIR 1.0 - -
-

- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event. You can register event listeners on all nodes in the - display list for a specific type of event, phase, and priority. - -

JavaScript code in the AIR runtime uses this method to register - event listeners for events defined by the AIR APIs. For other JavaScript events (such as the onload - event of the DOM body object), you can use standard event handling techniques, as you would - for content running in the browser.

- -

After you successfully register an event listener, you cannot change its priority - through additional calls to addEventListener(). To change a listener's - priority, you must first call removeListener(). Then you can register the - listener again with the new priority level.

- -

Keep in mind that after the listener is registered, subsequent calls to - addEventListener() with a different type or - useCapture value result in the creation of a separate listener registration. - For example, if you first register a listener with useCapture set to - true, it listens only during the capture phase. If you call - addEventListener() again using the same listener object, but with - useCapture set to false, you have two separate listeners: one - that listens during the capture phase and another that listens during the target and - bubbling phases. -

- -

You cannot register an event listener for only the target phase or the bubbling - phase. Those phases are coupled during registration because bubbling - applies only to the ancestors of the target node.

- -

If you no longer need an event listener, remove it by calling - removeEventListener(), or memory problems could result. Event listeners are not automatically - removed from memory because the garbage - collector does not remove the listener as long as the dispatching object exists (unless the useWeakReference - parameter is set to true).

- -

Copying an EventDispatcher instance does not copy the event listeners attached to it. - (If your newly created node needs an event listener, you must attach the listener after - creating the node.) However, if you move an EventDispatcher instance, the event listeners - attached to it move along with it.

- - -

If the event listener is being registered on a node while an event is being processed - on this node, the event listener is not triggered during the current phase but can be - triggered during a later phase in the event flow, such as the bubbling phase.

- -

If an event listener is removed from a node while an event is being processed on the node, - it is still triggered by the current actions. After it is removed, the event listener is - never invoked again (unless registered again for future processing).

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener function that processes the event. This function must accept - an Event object as its only parameter and must return nothing, as this example shows: - . - - 
function(evt:Event):void
- -

The function can have any name.

- -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Determines whether the listener works in the capture phase or the - target and bubbling phases. If useCapture is set to true, - the listener processes the event only during the capture phase and not in the - target or bubbling phase. If useCapture is false, the - listener processes the event only during the target or bubbling phase. To listen for - the event in all three phases, call addEventListener twice, once with - useCapture set to true, then again with - useCapture set to false. - -
 
priority:int (default = 0) — The priority level of the event listener. The priority is designated by - a signed 32-bit integer. The higher the number, the higher the priority. All listeners - with priority n are processed before listeners of priority n-1. If two - or more listeners share the same priority, they are processed in the order in which they - were added. The default priority is 0. - -
 
useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or - weak. A strong reference (the default) prevents your listener from being garbage-collected. - A weak reference does not.

Class-level member functions are not subject to garbage - collection, so you can set useWeakReference to true for - class-level member functions without subjecting them to garbage collection. If you set - useWeakReference to true for a listener that is a nested inner - function, the function will be garbage-collected and no longer persistent. If you create - references to the inner function (save it in another variable) then it is not - garbage-collected and stays persistent.

-
-
- - - - - -
clear()method 
-
-public function clear():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Invokes an internal delete command on the focused display object. - - -

This function call is ignored if the - - focused object does not implement the - - command. Only display objects descending from the TextField or HTMLLoader - - classes currently implement this command.

- - - -

Note: The clear() command deletes - - selected text. If nothing is selected, it does not clear all text.

- - - -

-Returns - - - - -
Boolean — - true. - - - - - -
-
- - - - - -
copy()method 
-
-public function copy():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Invokes an internal copy command on the focused display object. - - - -

This function call is ignored if the component does not implement the - - command. Only display objects descending from the TextField or HTMLLoader - - classes currently implement this command.

- - -

-Returns - - - - -
Boolean
-
- - - - - -
cut()method 
-
-public function cut():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Invokes an internal cut command on the focused display object. - - -

This function call is ignored if the component does not implement the - - command. Only display objects descending from the TextField or HTMLLoader - - classes currently implement this commands.

- - - -

-Returns - - - - -
Boolean — - true. - - - - - -
-
- - - - - -
dispatchEvent()method 
-
-public override function dispatchEvent(event:Event):Boolean -

- - - - -
Runtime version: AIR 1.0 - -
-

- Dispatches an event into the event flow. The event target is the EventDispatcher - object upon which the dispatchEvent() method is called. -

Parameters - - - - -
event:Event — The Event object that is dispatched into the event flow. - If the event is being redispatched, a clone of the event is created automatically. - After an event is dispatched, its target property cannot be changed, so you - must create a new copy of the event for redispatching to work. - -
-

-Returns - - - - -
Boolean — - A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called - on the event. - - -
-
- - - - - -
exit()method 
-
-public function exit(errorCode:int = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Terminates this application. - - - - - -

The call to the exit() method will return; - - the shutdown sequence does not begin until the currently executing code - - (such as a current event handler) has completed. Pending asynchronous - - operations are canceled and may or may not complete.

- - - -

Note that an exiting event is not dispatched. If an exiting event is required - - by application logic, call NativeApplication.nativeApplication.dispatchEvent(), passing - - in an Event object of type exiting. For any open windows, NativeWindow objects do dispatch - - closing and close events. Calling the preventDefault() method of - - closing event object prevents the application from exiting.

- - -

Note: This method is not supported on the iOS operating system.

- - - Parameters - - - - -
errorCode:int (default = 0) — The exit code reported to the operating system when this application exits. - - - -
-
- - - - - -
getDefaultApplication()method 
-
-public function getDefaultApplication(extension:String):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Gets the default application for opening files with the specified extension. - - - -

Note: This method can only be used with file types declared in the - - fileTypes statement of the application descriptor.

- - - -

This method is not applicable for AIR for TV devices. If you call it with a file type - - declared in the application descriptor, it returns null.

- - - Parameters - - - - -
extension:String — A String containing the extension of the file type of interest (without the "."). - - - -
-

-Returns - - - - -
String — - The path of the default application. - - - - - -
-
-Throws - - - - -
Error — If the extension parameter does not contain one of the - - file extensions declared in the application descriptor. - - -
-

-See also -

-
-applicationDescriptor -
-
- - - - - -
isSetAsDefaultApplication()method 
-
-public function isSetAsDefaultApplication(extension:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Specifies whether this application is currently the default application - - for opening files with the specified extension. - - - -

AIR profile support: This feature is supported - - on all desktop operating systems, but is not supported on mobile devices or AIR for TV devices. You can test - - for support at run time using the NativeApplication.supportsDefaultApplication property. See - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - - -

Parameters - - - - -
extension:String — A String containing the extension of the file type of interest (without the "."). - - - -
-

-Returns - - - - -
Boolean — - true if this application is the default. - - - - - -
-
-Throws - - - - -
Error — If the extension parameter does not contain one of the - - file extensions declared in the application descriptor. - - - -
-

-See also -

-
-applicationDescriptor -
-supportsDefaultApplication -
-
- - - - - -
paste()method 
-
-public function paste():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Invokes an internal paste command on the focused display object. - - -

This function call is ignored if the component does not implement the - - command. Only display objects descending from the TextField or HTMLLoader - - classes currently implement this command.

- - - -

-Returns - - - - -
Boolean — - true. - - - - - -
-
- - - - - -
removeAsDefaultApplication()method 
-
-public function removeAsDefaultApplication(extension:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Removes this application as the default for opening files with the specified extension. - - - -

Note: This method can only be used with file types listed in the - - fileTypes statement in the application descriptor.

- - - - Parameters - - - - -
extension:String — A String containing the extension of the file type of interest - - (without the "."). - - - -
-
-Throws - - - - -
Error — If the extension parameter does not contain one of the - - file extensions declared in the application descriptor. - - - -
-

-See also -

-
-applicationDescriptor -
-supportsDefaultApplication -
-
- - - - - -
removeEventListener()method 
-
-public override function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -

- - - - -
Runtime version: AIR 1.0 - -
-

- Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect. - -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener object to remove. - -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Specifies whether the listener was registered for the capture phase or the - target and bubbling phases. If the listener was registered for both the capture phase and the - target and bubbling phases, two calls to removeEventListener() are required - to remove both, one call with useCapture() set to true, and another - call with useCapture() set to false. - -
-
- - - - - -
selectAll()method 
-
-public function selectAll():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Invokes an internal selectAll command on the focused display object. - - -

This function call is ignored if the component does not implement the - - command. Only display objects descending from the TextField or HTMLLoader - - classes currently implement this command.

- - - -

-Returns - - - - -
Boolean — - true. - - - - - -
-
- - - - - -
setAsDefaultApplication()method 
-
-public function setAsDefaultApplication(extension:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Sets this application as the default application for opening files with the specified extension. - - - -

Note: This method can only be used with file types declared in the - - fileTypes statement in the application descriptor.

- - - - Parameters - - - - -
extension:String — A String containing the extension of the file type of interest (without the "."). - - - -
-
-Throws - - - - -
Error — If the extension parameter does not contain one of the - - file extensions declared in the application descriptor. - - - -
-

-See also -

-
-applicationDescriptor -
-supportsDefaultApplication -
-
-
Event detail
- - - - - -
activateevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.ACTIVATE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when this application becomes the active desktop application. - - - -

- The ACTIVATE constant defines the value of the type property of an activate event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the activate event.
- -
- - - - - -
browserInvokeevent  
-
-Event object type: flash.events.BrowserInvokeEvent -
-

-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when an application is invoked by a SWF file running in the user's browser. - - - -

Browser invocation is permitted only if an application specifies the following in - - the application descriptor file:

- - - - 
<allowBrowserInvocation>true</allowBrowserInvocation>
- - - -
- - - - - -
deactivateevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.DEACTIVATE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when the desktop focus is switched to a different application. - - - -

- The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the deactivate event.
- -
- - - - - -
exitingevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.EXITING -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when the application exit sequence is started. - - -

The exiting event is dispatched when application exit is initiated by - - the operating system; for example, when a user issues the Cmd-Q - - key sequence on Mac OS X, or when the autoExit property of - - the NativeApplication object is true and the last - - application window is closed. - - Canceling this event prevents the application from exiting.

- - -

AIR for TV devices never dispatch the exiting event. - -

- - -

Note: Calling the NativeApplication exit() method does not cause an - - exiting event to be dispatched. To warn components of an impending exit, - - dispatch the exiting event before calling exit().

- - - - -

- The Event.EXITING constant defines the value of the type property of an exiting event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelabletrue; canceling this event object stops the exit operation.
currentTargetThe NativeApplication object.
targetThe NativeApplication object.
- -
- - - - - -
invokeevent  
-
-Event object type: flash.events.InvokeEvent -
-InvokeEvent.type property = flash.events.InvokeEvent.INVOKE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when an application is invoked. - - - -

When an application is invoked a second time, - - another instance of the application is not started. Instead, the first instance - - receives an additional invoke event. It is the responsibility of the - - application to handle subsequent invoke events appropriately.

- - - -

Note: All invoke events are queued. When a listener for this - - event is registered, it receives all events in the queue as well as any new events. - - Queued events may be delivered before or after any new invoke events.

- - - -

- The InvokeEvent.INVOKE constant defines the value of the type - property of an InvokeEvent object. - -

The InvokeEvent object has the following properties:

- - - - - - - - - -
PropertiesValues
argumentsThe array of string arguments passed - during this invocation.
currentDirectorya File object representing the - directory that should be used to resolve any relative paths in the arguments array.
reasona code indicating whether the invoke event was dispatched - because the application started automatically at login (InvokeEventReason.LOGIN), started - as a response to a remote notification (InvokeEventReason.NOTIFICATION - iOS only), - because the application was invoked by another application (InvokeEventReason.OPEN_URL), or - for another reason (InvokeEventReason.STANDARD). Available as of AIR version 1.5.1.
bubblesfalse.
cancelablefalse; - there is no default behavior to cancel.
currentTargetIndicates the object that is - actively processing this InvokeEvent object with an event listener.
targetAlways the NativeApplication object. -
- -
- - - - - -
keyDownevent  
-
-Event object type: flash.events.KeyboardEvent -
-KeyboardEvent.type property = flash.events.KeyboardEvent.KEY_DOWN -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when the user presses a key. The NativeApplication instance provides this event to - - support keyboard accelerators. This keyboard event is dispatched first to the NativeApplication. - - Canceling this event also cancels NativeWindow menu accelerators. - - This event occurs before the keyUp event. - -

- - The KeyboardEvent.KEY_DOWN constant defines the value of the type property of a keyDown event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblestrue
cancelabletrue in AIR, false in Flash Player; - - in AIR, canceling this event prevents the character from being entered into a text field.
charCodeThe character code value of the key pressed or released.
commandKeytrue on Mac if the Command key is active. Otherwise, false
controlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Control key is active. Otherwise, false
ctrlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
keyCodeThe key code value of the key pressed or released.
keyLocationThe location of the key on the keyboard.
shiftKeytrue if the Shift key is active; false if it is inactive.
functionKeytrue if the Function key is active (Mac only); false if it is inactive.
targetThe InteractiveObject instance with focus. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.keyDown -
-
- - - - - -
keyUpevent  
-
-Event object type: flash.events.KeyboardEvent -
-KeyboardEvent.type property = flash.events.KeyboardEvent.KEY_UP -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when the user releases a key. The NativeApplication instance provides this event to - - support keyboard accelerators. This keyboard event is dispatched first to the NativeApplication. - - Canceling this event has no effects on other objects (such as NativeWindow menu accelerators). - - This event occurs after a keyDown event. - -

- - The KeyboardEvent.KEY_UP constant defines the value of the type property of a keyUp event object. - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
charCodeContains the character code value of the key pressed or released.
commandKeytrue on Mac if the Command key is active. Otherwise, false
controlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Control key is active. Otherwise, false
ctrlKeytrue on Windows if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
keyCodeThe key code value of the key pressed or released.
keyLocationThe location of the key on the keyboard.
shiftKeytrue if the Shift key is active; false if it is inactive.
functionKeytrue if the Function key is active (Mac only); false if it is inactive.
targetThe InteractiveObject instance with focus. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.keyUp -
-
- - - - - -
networkChangeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.NETWORK_CHANGE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when either a new network connection becomes available or - - an existing network connection is lost. - - - -

A networkChange event does not necessarily mean that the host computer has - - gone online or offline; it may just be transitioning from one type of - - connection to another. Applications can use this event to help optimize the - - task of monitoring remote resource availability. The dispatch of a - - networkChange event is often a good time to verify the availability of any remote resources. - -

- -

Notes:

- -
    - -
  • There may be a short delay between - - a network change and the delivery of this event.
    • - -
  • On Android, the NativeApplication object may dispatch more than one networkChange - - event for each change in a network connection.
    • - -
- - - -

- The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe NativeApplication object.
- -
- - - - - -
suspendevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.SUSPEND -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.3 - -
-

- - Dispatched when the application is about to be suspended by the operating system. - - - -

- The Event.SUSPEND constant defines the value of the type property of an suspend event object. - This event is dispatched only on AIR iOS. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe NativeApplication object.
targetThe NativeApplication object.
-
- - - - - -
userIdleevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.USER_IDLE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when the user has been idle. - - - -

Specify the period of time for which a user must be idle before this event is dispatched using the - - idleThreshold property. The amount of time that the user has been idle can be - - determined from the timeSinceLastUserInput property.

- - -

Note: This event is not dispatched on mobile devices or AIR for TV devices.

- - - - -

- The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. - -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe NativeApplication object.
- -

-See also -

-
-idleThreshold -
-timeSinceLastUserInput -
-
- - - - - -
userPresentevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.USER_PRESENT -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when the operating system detects mouse or keyboard activity after an idle period. - - - -

Note: This event is not dispatched on mobile devices or AIR for TV devices.

- - -

The period of time that is considered idle is configurable with the idleThreshold - - property. The amount of time that the user has been idle can be determined from - - the timeSinceLastUserInput property.

- - - -

-See also -

-
-idleThreshold -
-timeSinceLastUserInput -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Nov 16 2022, 12:39 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/NativeDragActions.html b/html-docs/flash/desktop/NativeDragActions.html deleted file mode 100644 index da5db5b..0000000 --- a/html-docs/flash/desktop/NativeDragActions.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - - - -flash.desktop.NativeDragActions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic class NativeDragActions
InheritanceNativeDragActions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

-

-The NativeDragActions class defines string constants for the names of the drag-and-drop actions. - -

The NativeDragActions constants are used as values for the - dropAction property of the NativeDragManager and NativeDragEvent classes.

- -

-

-See also -

-
-flash.desktop.NativeDragManager -
-flash.events.NativeDragEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  COPY : String = "copy"
[static] - Defines the string to use for the copy action.
-		NativeDragActions
  LINK : String = "link"
[static] - Defines the string to use for the link action.
-		NativeDragActions
  MOVE : String = "move"
[static] - Defines the string to use for the move action.
-		NativeDragActions
  NONE : String = "none"
[static] - Defines the string to use when no action is specified.
-		NativeDragActions
-
- -
- -
Constant detail
- - - - - -
COPYconstant
-
-public static const COPY:String = "copy" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the string to use for the copy action. - -

- - - - - -
LINKconstant 
-
-public static const LINK:String = "link" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the string to use for the link action. - -

- - - - - -
MOVEconstant 
-
-public static const MOVE:String = "move" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the string to use for the move action. - -

- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the string to use when no action is specified. - -

In a nativeDragComplete event, an action of none - indicates that the drag-and-drop operation was abandoned by the user.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/NativeDragManager.html b/html-docs/flash/desktop/NativeDragManager.html deleted file mode 100644 index 76eaf6d..0000000 --- a/html-docs/flash/desktop/NativeDragManager.html +++ /dev/null @@ -1,643 +0,0 @@ - - - - - - - - -flash.desktop.NativeDragManager (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic class NativeDragManager
InheritanceNativeDragManager Inheritance Object
-

- - - - -
Runtime version: AIR 1.0 -
-

-

- The NativeDragManager class coordinates drag-and-drop operations. With the native drag-and-drop API, - you can allow a user to drag data between an AIR application and the native operating system, - between two applications, or between components within a single application. - -

The following kinds of data can be transferred:

-
    -
  • Bitmaps
    • -
  • Files
    • -
  • Text
    • -
  • URL strings
    • -
  • Serialized objects
    • -
  • Object references (valid only within the originating application)
    • -
- -

Note: all NativeDragManager members are static. An instance of this class does not need to be created.

- -

A drag-and-drop operation is a user interface gesture that begins with the user clicking a visible item and - dragging it elsewhere. During the drag gesture, interactive objects on the display list dispatch native drag events - as the gesture moves across the AIR application window. Handlers for these events can call - the methods of the NativeDragManager class to indicate whether a dragged item - can be dropped on an object. In response, the NativeDragManager changes the mouse pointer to provide - feedback to the user.

-

AIR profile support: This feature is not supported - on AIR for TV devices. Also, it is not supported on all mobile devices. You can test - for support at run time using the NativeDragManager.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles. -

-

Drag actions

-

Drag-and-drop gestures are typically used for three types of operations, called actions. - Since the meaning of these actions depends on the application context, - the runtime does not enforce any particular behavior with respect to actions. - However, properly implementing the actions improves the user experience with your application. -

- -

The possible actions are:

-
    -
  • Copy — A copy of the data is made, leaving the original untouched. - (When dragging objects within an application, care should be taken to copy the - original object itself rather than the reference to that object.)
    • -
  • Move — The data is moved from its original context into the context defined by the drop target, - such as when moving an item from one list to another.
    • -
  • Link — A reference or shortcut to the original data is created, - leaving the item in its original context.
    • -
- -

The allowed actions can be set for a drag gesture by supplying an allowedActions parameter - in the NativeDragManager.doDrag() call that starts the drag operation. - If no allowedActions parameter is provided, all - of the actions are allowed. Potential drag targets can check which actions are allowed by using the - allowedActions property of a NativeDragEvent object, and should not accept a drop - that allows only incompatible actions (this is not enforced by the runtime, however).

- -

If a drop target only implements a single action, the object can set the - dropAction property of the NativeDragManager in the handlers for both - the nativeDragEnter and nativeDragOver events. Setting the - property before the drop, allows the drag manager to update the mouse pointer to - indicate the supported action and also prevents - a user from choosing an incompatible action using modifier keys. If the specified action - is not one of the allowed actions, then a drop is not allowed, even if the target calls the - acceptDrop() method.

- -

When accepting a drop, a potential drop target should specify the action chosen - by setting the NativeDragManager.dropAction property in response to the - nativeDragDrop event. This action is reported back to the initiating - display object in the nativeDragComplete event. If no action is set by a drop target, - then a default action is chosen from the allowed actions in this order of - precedence: copy, move, link. The initiating object is responsible - for updating its internal state in response to the chosen action.

- -

String constants for the action names are defined in the NativeDragActions class.

- -

Sequence of events

-

A drag gesture is begun by calling the NativeDragManager.doDrag() method - within a mouseDown or mouseMove event handler and - proceeds through the following event sequence in response to user actions:

-
    -
  • nativeDragStart event — When NativeDragManager.doDrag() is called, - the interactive object passed as a paramter to the method becomes the initiator - object and dispatches a nativeDragStart event.
    • - -
  • nativeDragUpdate event — While the drag is in progress, the initiator object continually - dispatches nativeDragUpdate events.
    • - -
  • nativeDragEnter, nativeDragOver events — When a drag - gesture passes over an interactive object, that object dispatches a nativeDragEnter event. - While the drag gesture remains over the interactive object, - it continually dispatches nativeDragOver events. In response to either of these events, - an object that serves as a potential drop target should check the properties of the event object - to decide whether it can accept the drop. If the data format and allowed - actions are appropriate, then the event handler for these events must call - NativeDragManager.acceptDrop(), passing in a reference to the - display object to serve as the drag target (typically the object that - dispatched the nativeDragEnter or nativeDragOver event). - The user can then drop the dragged item onto the target.
    • - -
  • nativeDragExit event — When a drag gesture passes out of an - interactive object, the object dispatches a nativeDragExit event. - If the object had been designated as the drag target by an earlier call to the - NativeDragManager.acceptDrop() method, that call is no longer valid - and acceptDrop() must be called again if the gesture re-enters the interactive object.
    • - -
  • nativeDragDrop event — The target display object dispatches a - nativeDragDrop event when the user releases the mouse button over the object. - The handler for this event can access the data in the transferable - property of the event object and should set the NativeDragManager.dropAction property to - signal which action should be taken by the initiator object.
    • - -
  • nativeDragComplete — When the user releases the mouse button at the end of a drag gesture, - the initiator object dispatches a nativeDragComplete event (whether or not the drop itself was consumated). - The handler for this event can check the dropAction property of the event object to determine what, - if any, modification should be made to its internal data state, such as removing a dragged-out item from a list. - If dropAction is NativeDragActions.NONE, then the dragged item was not dropped on an eligible target.
    • -
- -

Gestures between applications

-

When a drag gesture enters an AIR application window from a non-AIR application, - there is no initiator object to dispatch the nativeDragStart or nativeDragComplete - event. The events dispatched during the gesture will otherwise follow the same - pattern as that of a gesture starting and ending within the same AIR application.

- -

When a drag gesture leaves an AIR application window, there is no target object to dispatch - nativeDragEnter, nativeDragOver, or nativeDragDrop events. The initiator object - still dispatches a nativeDragComplete event, which reports the drag action set - by the native operating system (or none, if the drop was not accepted).

- -

When a drag gesture moves from one AIR application to another, the initiator - and target display objects dispatch events within their separate applications - as usual.

- -

Transfering information

-

The data transfered during a drag-and-drop gesture is contained in a Clipboard object. - This data object is added to the drag operation with the - NativeDragManager.doDrag() method that starts the drag gesture. - Potential drop targets can access the Clipboard object through the - clipboard property of the native drag event - object. Once a drag operation has started, the Clipboard object can - only be accessed in the event handler of a NativeDragEvent. Any other attempt - to access the object generates a run-time error.

- -

Security considerations

-

The security sandboxes of the initiator and potential target objects determine how the - the data being dragged can be accessed. If both objects are in the same sandbox, - then the data can be accessed from any NativeDragEvent object. However, - if the initiator and target objects are in different sandboxes, the data can - only be accessed in the target sandbox within the event - handler for the nativeDragDrop event. Other native drag event handlers can still - still access the Clipboard object referenced in the event clipboard - property to determine which data formats are available, but calling the - clipboard.getData() method generates a security error.

- -

-

-See also -

-
-flash.events.NativeDragEvent -
-flash.desktop.NativeDragActions -
-flash.desktop.NativeDragOptions -
-flash.desktop.Clipboard -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  dragInitiator : InteractiveObject -
[static][read-only] - The interactive object passed to the NativeDragManager.doDrag() call that initiated the drag operation.
-		NativeDragManager
  dropAction : String -
[static] - The drag action specified by the drop target.
-		NativeDragManager
  isDragging : Boolean -
[static][read-only] - Reports whether a drag operation is currently in progress.
-		NativeDragManager
  isSupported : Boolean -
[static][read-only] - The isSupported property is set to true if the - NativeDragManager class is supported on the current platform, otherwise it is - set to false.
-		NativeDragManager
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-acceptDragDrop(target:InteractiveObject):void -
-
[static] - Informs the NativeDragManager object that the specified target interactive object can accept a drop - corresponding to the current drag event.
-		NativeDragManager
   -
-doDrag(dragInitiator:InteractiveObject, clipboard:Clipboard, dragImage:BitmapData = null, offset:Point = null, allowedActions:NativeDragOptions = null):void -
-
[static] - Starts a drag-and-drop operation.
-		NativeDragManager
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
dragInitiatorproperty
-
-dragInitiator:InteractiveObject  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The interactive object passed to the NativeDragManager.doDrag() call that initiated the drag operation. - -

Implementation -
-    public static function get dragInitiator():InteractiveObject -
-
- - - - - -
dropActionproperty 
-
-dropAction:String  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The drag action specified by the drop target. - -

The dropAction property - should be set in the handler for the nativeDragDrop event. - If dropAction is not set before the nativeDragComplete, - the NativeDragManager sets the value with the first - allowed action from the list: copy, move, or link (in that order).

- - Implementation -
-    public static function get dropAction():String -
-    public function set dropAction(value:String):void -
-

-See also -

-
-flash.desktop.NativeDragActions -
-
- - - - - -
isDraggingproperty 
-
-isDragging:Boolean  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- Reports whether a drag operation is currently in progress. - -

Implementation -
-    public static function get isDragging():Boolean -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The isSupported property is set to true if the - NativeDragManager class is supported on the current platform, otherwise it is - set to false. -

Implementation -
-    public static function get isSupported():Boolean -
-
- -
Method detail
- - - - - -
acceptDragDrop()method
-
-public static function acceptDragDrop(target:InteractiveObject):void -

- - - - -
Runtime version: AIR 1.0 -
-

- Informs the NativeDragManager object that the specified target interactive object can accept a drop - corresponding to the current drag event. - -

This method should be called only when there is a nativeDragDrop - handler on the specified target object that can handle at least one of the - data formats in the dragged item and at least one of the allowed actions.

- -

This function can be called only within a nativeDragEnter or nativeDragOver - event handler.

- - Parameters - - - - -
target:InteractiveObject
-
- - - - - -
doDrag()method 
-
-public static function doDrag(dragInitiator:InteractiveObject, clipboard:Clipboard, dragImage:BitmapData = null, offset:Point = null, allowedActions:NativeDragOptions = null):void -

- - - - -
Runtime version: AIR 1.0 -
-

- Starts a drag-and-drop operation. - -

To start a drag operation:

-
    -
  1. Create a new Clipboard object.
    2. -
  2. Add the data to be transferred in one or more formats.
    3. -
  3. Optionally, create a BitmapData object to serve as a proxy image during the drag.
    4. -
  4. Optionally, create a NativeDragOptions object to restrict the actions allowed in this operation. - (If the allowedActions parameter is left null, all actions are allowed.)
    5. -
  5. Call NativeDragManager.doDrag().
    6. -
- -

The initiator object dispatches a nativeDragStart event after this method is called, - nativeDragStart events while the drag is in progress, and a - nativeDragComplete event when the user releases the mouse button to end the drag gesture. - The handler for the nativeDragComplete event can check the dropAction property of the - event to determine whether the drag-and-drop operation was successfully completed. - If dropAction is NativeDragActions.NONE, then the dragged item was not dropped - on an eligible target.

- -

This method can be called only from within a mouseDown or - mouseMove event handler. (If called in response to a - mouseMove event, the mouse button must also be down.)

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
dragInitiator:InteractiveObject — Typically the object from which the drag gesture began. Receives the nativeDragStart - and nativeDragComplete events. - -
 
clipboard:Clipboard — The container object for data being dragged. - -
 
dragImage:BitmapData (default = null) — An optional proxy image displayed under the mouse pointer - during the drag gesture. If null, no image is displayed. - -
 
offset:Point (default = null) — The offset between the mouse hotspot and the top left - corner of the drag image. Negative coordinates move the image up and - to the left in relation to the hotspot. If null, the top - left corner of the drag image is positioned at the mouse hotspot. - -
 
allowedActions:NativeDragOptions (default = null) — Restricts the drag-and-drop actions allowed for - this operation. If null, all actions are allowed. - -
-

-See also -

-
-flash.desktop.NativeDragActions -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/NativeDragOptions.html b/html-docs/flash/desktop/NativeDragOptions.html deleted file mode 100644 index c0cb58d..0000000 --- a/html-docs/flash/desktop/NativeDragOptions.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - - -flash.desktop.NativeDragOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic class NativeDragOptions
InheritanceNativeDragOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The NativeDragOptions class defines constants for the names of drag-and-drop actions allowed in a drag-and-drop operation. - -

Drag actions are part of a feedback mechanism to allow the initiating and - target objects to cooperate in the drag-and-drop exchange. The actions are only - a hint to the operating system. It is up to the drag initiator and target objects - involved in the transaction to implement the proper behavior.

- -

An initiating object should only allow the actions that it supports. For example, - an initiating object should allow the move action only if that object's internal - logic removes the source data when a target accepts a drop with a move action.

- - -

A new NativeDragOptions object has all properties initialized to - true (all actions allowed).

- -

-

-See also -

-
-flash.desktop.NativeDragManager -
-flash.events.NativeDragEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  allowCopy : Boolean = true
- A drop target is allowed to copy the dragged data.
-		NativeDragOptions
  allowLink : Boolean = true
- A drop target is allowed to create a link to the dragged data.
-		NativeDragOptions
  allowMove : Boolean = true
- A drop target is allowed to move the dragged data.
-		NativeDragOptions
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Constructs a string containing the current settings of this NativeDragOptions object.
-		NativeDragOptions
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
allowCopyproperty
-
-public var allowCopy:Boolean = true -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A drop target is allowed to copy the dragged data. - -

- - - - - -
allowLinkproperty 
-
-public var allowLink:Boolean = true -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A drop target is allowed to create a link to the dragged data. - -

- - - - - -
allowMoveproperty 
-
-public var allowMove:Boolean = true -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A drop target is allowed to move the dragged data. - -

- -
Method detail
- - - - - -
toString()method
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Constructs a string containing the current settings of this NativeDragOptions object. - -

-Returns - - - - -
String — - String The current settings of this object in a string. - - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/NativeProcess.html b/html-docs/flash/desktop/NativeProcess.html deleted file mode 100644 index 7610b99..0000000 --- a/html-docs/flash/desktop/NativeProcess.html +++ /dev/null @@ -1,1255 +0,0 @@ - - - - - - - - -flash.desktop.NativeProcess (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic class NativeProcess
InheritanceNativeProcess Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The NativeProcess class provides command line integration and general launching capabilities. The NativeProcess - class lets an AIR application execute native processes on the host operating system. The AIR applcation - can monitor the standard input (stdin) and standard output (stdout) stream of the process as well as the - process's standard error (stderr) stream. -

The NativeProcess class and its capabilities are only available to AIR applications installed with a - native installer (extended desktop profile applications). When debugging, you can pass the - -profile extendedDesktop argument to ADL to enable the NativeProcess functionality. - At runtime, you can check the NativeProcess.isSupported property to to determine whether - native process communication is supported.

-

AIR profile support: This feature is supported - on applications that are deployed to desktop operating systems via native installers. - The feature is not supported on mobile devices or on AIR for TV devices. You can test - for support at run time using the NativeProcess.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

AIR applications installed with a native installer (extended desktop profile applications) can also use the - File.openWithDefaultApplication to open an application. However, the NativeProcess class - provides direct access to the standard input, standard output, and standard error pipes.

-

Note: AIR for TV applications using the extendedTV profile can use native extensions - to execute native processes. Similarly, mobile devices can use native extensions.

-

-

-View the examples. -

-

-See also -

-
-flash.external.ExtensionContext -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - Indicates if running native processes is supported in the current profile.
-		NativeProcess
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  running : Boolean -
[read-only] - Indicates if this native process is currently running.
-		NativeProcess
  standardError : IDataInput -
[read-only] - Provides access to the standard error output from this native process.
-		NativeProcess
  standardInput : IDataOutput -
[read-only] - Provides access to the standard input of this native process.
-		NativeProcess
  standardOutput : IDataInput -
[read-only] - Provides access to the standard output pipe of this native process.
-		NativeProcess
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NativeProcess()
-
- Constructs an uninitialized NativeProcess object.
-		NativeProcess
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-closeInput():void -
-
- Closes the input stream on this process.
-		NativeProcess
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-exit(force:Boolean = false):void -
-
- Attempts to exit the native process.
-		NativeProcess
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-start(info:NativeProcessStartupInfo):void -
-
- Starts the native process identified by the start up info specified.
-		NativeProcess
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-exit -
-		 - Signals the native process has exited.NativeProcess
   -
-standardErrorClose -
-		 - Signals that the NativeProcess has closed its error stream.NativeProcess
   -
-standardErrorData -
-		 - Signals that the native process has data available to read on the standard error (stderror) stream.NativeProcess
   -
-standardErrorIoError -
-		 - Signals that reading from the standard error (stderror) stream has failed.NativeProcess
   -
-standardInputClose -
-		 - Signals that the NativeProcess object has closed its input stream by calling the closeInput() - method.NativeProcess
   -
-standardInputIoError -
-		 - Signals that writing to the standard input (stdin) stream has failed.NativeProcess
   -
-standardInputProgress -
-		 - Signals that the NativeProcess has written data to the input stream for the child process.NativeProcess
   -
-standardOutputClose -
-		 - Signals that the NativeProcess has closed its output stream.NativeProcess
   -
-standardOutputData -
-		 - Signals that the native process has data available to read on the output stream.NativeProcess
   -
-standardOutputIoError -
-		 - Signals that reading from the stdout stream has failed.NativeProcess
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates if running native processes is supported in the current profile. This property returns - true only when running in the extendedDesktop profile. In addition, - NativeProcess.isSupported is always false for applications installed - as an AIR file. You must package an AIR application using the ADT -target native flag - in order to use the NativeProcess class. -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
runningproperty 
-
-running:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates if this native process is currently running. The process is running if you have called - the start() method and the NativeProcess object has not yet dispatched an exit - event. A NativeProcess instance corresponds to a single process on the underlying operating system. - This property remains true as long as the underlying operating system process is executing - (while the native process is starting and until the process returns an exit code to the operating system.) -

Implementation -
-    public function get running():Boolean -
-
- - - - - -
standardErrorproperty 
-
-standardError:IDataInput  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Provides access to the standard error output from this native process. As data - becomes available on this pipe, the NativeProcess object dispatches a ProgressEvent - object. If you attempt to read data from this stream when no data is - available, the NativeProcess object throw an EOFError exception. -

The type is IDataInput because data is input from the perspective of the - current process, even though it is an output stream of the child process.

- Implementation -
-    public function get standardError():IDataInput -
-
-Throws -
- - - - -
Error — if no data is present and a read operation is attempted. - -
-

-See also -

-
-flash.events.ProgressEvent -
-flash.utils.IDataInput -
-
- - - - - -
standardInputproperty 
-
-standardInput:IDataOutput  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Provides access to the standard input of this native process. Use this pipe to - send data to this process. Each time data is written to the input property - that data is written to the native process's input pipe as soon as possible. -

The type is IDataOutput because data is output from the perspective of the current process, - even though it is an input stream of the child process.

- - Implementation -
-    public function get standardInput():IDataOutput -
-
-Throws -
- - - - -
Error — when writing to this value when running returns false or - when attempting to write data to a closed input stream. -
-

-See also -

-
-closeInput() -
-IDataOutput -
-
- - - - - -
standardOutputproperty 
-
-standardOutput:IDataInput  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Provides access to the standard output pipe of this native process. Use this pipe to - read data from the native process's standard output. When data is present on this pipe, - the NativeProcess object dispatches a ProgressEvent. If you attempt to read data from this stream - when no data is available, the NativeProcess object throws an EOFError. -

The type is IDataInput because data is input from the perspective of the - current process even though it is an output stream of the child process.

- Implementation -
-    public function get standardOutput():IDataInput -
-
-Throws -
- - - - -
Error — if no data is present and a read operation is attempted. -
-

-See also -

-
-flash.utils.IDataInput -
-flash.events.ProgressEvent -
-
- -
Constructor detail
- - - - - -
NativeProcess()constructor
-
-public function NativeProcess() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs an uninitialized NativeProcess object. Call the start() method - to start the process. -

-See also -

-
-start() -
-
- -
Method detail
- - - - - -
closeInput()method
-
-public function closeInput():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Closes the input stream on this process. Some command line applications - wait until the input stream is closed to start some operations. Once - the stream is closed it cannot be re-opened until the process exits and - is started again. -


-Events - - - - - - - - - - -
ioErrorStandardInput:IOErrorEvent — There is a problem closing the input stream to the process
 
standardInputClose:Event — The input stream has been closed.
-
- - - - - -
exit()method 
-
-public function exit(force:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Attempts to exit the native process. - -

Parameters - - - - -
force:Boolean (default = false) — Whether the application should attempt to forcibly exit the native process, if necessary. -

If the force parameter is set to false, this method attempts to gracefully exit the native process. - This method "asks" the native process to exit. This request may be ignored by the native process, and as a result this method - is not guaranteed to actually cause the native process to exit. The NativeProcess object only dispatches a - NativeProcessExitEvent event if the native process exits.

- -

If the force parameter is set to true, this method attempts to forcibly exit the native process. - Calling this method with the force parameter is set to true should be a last resort. - Calling this method with the force parameter is set to true may have adverse affects on the state of system - resources associated with the native process. For example, opened files may be left in an inconsistent state. The runtime will - make its best effort to try to force the native process to exit. However, it is not guaranteed that the native process - will exit. The NativeProcess object only dispatches a NativeProcessExitEvent event if the native process exits.

- -

If the NativeProcess does successfully exit, it dispatches a NativeProcessExitEvent event.

- -
-
- - - - - -
start()method 
-
-public function start(info:NativeProcessStartupInfo):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Starts the native process identified by the start up info specified. Once the process starts, - all of the input and output streams will be opened. This method returns immediately after the request - to start the specified process has been made to the operating system. The NativeProcess object throws an - IllegalOperationError exception if the process is currently running. The process is running - if the running property of the NativeProcess object returns true. - If the operating system is unable to start the process, an Error is thrown. - -

- A NativeProcess instance corresponds to a single process on the underlying operating system. If you want to execute more than - one instance of the same operating system process concurrently, you can create one NativeProcess instance per child - process.

-

- You can call this method whenever the running property of the NativeProcess object returns false. - This means that the NativeProcess object can be reused. In other words you can construct a NativeProcess instance, - call the start() method, wait for the exit event, and then call the start() - method again. You may use a different NativeProcessStartupInfo object as the info parameter value in - the subsequent call to the start() method.

-

The NativeProcess class and its capabilities are only available to AIR applications installed with a - native installer. When debugging, you can pass the -profile extendedDesktop argument to ADL - to enable the NativeProcess functionality. Check the NativeProcess.isSupported property to - to determine whether native process communication is supported.

-

Important security considerations:

-

The native process API can run any executable on the user's system. Take extreme care when constructing - and executing commands. If any part of a command to be executed originates from an external source, - carefully validate that the command is safe to execute. Likewise, your AIR application should - validate data passed to a running process.

- -

However, validating input can be difficult. To avoid such difficulties, it is best - to write a native application (such as an EXE file on Windows) that has specific APIs. These APIs should - process only those commands specifically required by the AIR application. For example, the native - application may accept only a limited set of instructions via the standard input stream.

- -

AIR on Windows does not allow you to run .bat files directly. Windows .bat files are executed by - the command interpreter application (cmd.exe). When you invoke a .bat file, this command application - can interpret arguments passed to the command as additional applications to launch. A malicious injection - of extra characters in the argument string could cause cmd.exe to execute a harmful or insecure application. - For example, without proper data validation, your AIR application may call - myBat.bat myArguments c:/evil.exe. The command application would launch the evil.exe - application in addition to running your batch file.

-

If you call the start() method with a .bat file, the NativeProcess object - throws an exception. The message property of the Error object contains the string - "Error #3219: The NativeProcess could not be started."

- Parameters - - - - -
info:NativeProcessStartupInfo — NativeProcessStartupInfo Defines information about how to start the native process. -
-
-Throws - - - - - - - - - - - - - - - - -
Error — if the NativeProcess is currently running. -
 
ArgumentError — if the nativePath property of the NativeProcessStartupInfo does not exist. -
 
Error — if the NativeProcess did not start successfully. -
-

-See also -

-
-NativeProcessStartupInfo -
-
-
Event detail
- - - - - -
exitevent 
-
-Event object type: flash.events.NativeProcessExitEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals the native process has exited. The exitCode property - contains the value the process returns to the host operating system on exit. - If the AIR application terminates the process by calling the exit() - method of the NativeProcess object, the exitCode property is set - to NaN. -

- - - - - -
standardErrorCloseevent  
-
-Event object type: flash.events.Event -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that the NativeProcess has closed its error stream. -

- - - - - -
standardErrorDataevent  
-
-Event object type: flash.events.ProgressEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that the native process has data available to read on the standard error (stderror) stream. The NativeProcess - object dispatches this event when the child process flushes its standard error stream or when the internal - buffer used to communicate between the processes is full. Do not write code that depend on - the size of this internal buffer; it varies between versions and operating systems. -

- - - - - -
standardErrorIoErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that reading from the standard error (stderror) stream has failed. The NativeProcess object can dispatch - this event when the runtime - cannot read data from the native process's standard error pipe. -

- - - - - -
standardInputCloseevent  
-
-Event object type: flash.events.Event -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that the NativeProcess object has closed its input stream by calling the closeInput() - method. The NativeProcess object does not dispatch this event when the actual native process itself - closes the input stream. -

- - - - - -
standardInputIoErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that writing to the standard input (stdin) stream has failed. The NativeProcess - object dispatches this event when the closeInput() method fails or when the runtime - cannot write data to the native process's standard input pipe. -

- - - - - -
standardInputProgressevent  
-
-Event object type: flash.events.ProgressEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that the NativeProcess has written data to the input stream for the child process. - The NativeProcess object dispatches this event when data is written to the stream. This event - does not indicate whether or not the child process has read any of the data. -

- - - - - -
standardOutputCloseevent  
-
-Event object type: flash.events.Event -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that the NativeProcess has closed its output stream. -

- - - - - -
standardOutputDataevent  
-
-Event object type: flash.events.ProgressEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that the native process has data available to read on the output stream. The NativeProcess - object dispatches this event when the child process flushes its stdout stream or when the internal - buffer used to communicate between the processes is full. Do not write code that depend on - the size of this internal buffer; it varies between versions and operating systems. -

- - - - - -
standardOutputIoErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that reading from the stdout stream has failed. The NativeProcess object can dispatch - this event when the runtime - cannot read data from the native process's standard output pipe. -

- -
Examples
-
examples\NativeProcessExample
-
The following example checks to see if native process communication is supported on - the machine. If it is, the application sets up event listeners for the native process and launches - the test.py file in the main application directory). : -
-
-package
-{
-    import flash.display.Sprite;
-    import flash.desktop.NativeProcess;
-    import flash.desktop.NativeProcessStartupInfo;
-    import flash.events.Event;
-    import flash.events.ProgressEvent;
-    import flash.events.IOErrorEvent;
-    import flash.events.NativeProcessExitEvent;
-    import flash.filesystem.File;
-    
-    public class NativeProcessExample extends Sprite
-    {
-        public var process:NativeProcess;
-
-        public function NativeProcessExample()
-        {
-            if(NativeProcess.isSupported)
-            {
-                setupAndLaunch();
-            }
-            else
-            {
-                trace("NativeProcess not supported.");
-            }
-        }
-        
-        public function setupAndLaunch():void
-        {     
-            var nativeProcessStartupInfo:NativeProcessStartupInfo = new NativeProcessStartupInfo();
-            var file:File = File.applicationDirectory.resolvePath("test.py");
-            nativeProcessStartupInfo.executable = file;
-
-            var processArgs:Vector.<String> = new Vector.<String>();
-            processArgs[0] = "foo";
-            nativeProcessStartupInfo.arguments = processArgs;
-
-            process = new NativeProcess();
-            process.start(nativeProcessStartupInfo);
-            process.addEventListener(ProgressEvent.STANDARD_OUTPUT_DATA, onOutputData);
-            process.addEventListener(ProgressEvent.STANDARD_ERROR_DATA, onErrorData);
-            process.addEventListener(NativeProcessExitEvent.EXIT, onExit);
-            process.addEventListener(IOErrorEvent.STANDARD_OUTPUT_IO_ERROR, onIOError);
-            process.addEventListener(IOErrorEvent.STANDARD_ERROR_IO_ERROR, onIOError);
-        }
-
-        public function onOutputData(event:ProgressEvent):void
-        {
-            trace("Got: ", process.standardOutput.readUTFBytes(process.standardOutput.bytesAvailable)); 
-        }
-        
-        public function onErrorData(event:ProgressEvent):void
-        {
-            trace("ERROR -", process.standardError.readUTFBytes(process.standardError.bytesAvailable)); 
-        }
-        
-        public function onExit(event:NativeProcessExitEvent):void
-        {
-            trace("Process exited with ", event.exitCode);
-        }
-        
-        public function onIOError(event:IOErrorEvent):void
-        {
-             trace(event.toString());
-        }
-    }
-}
-
-
Add the following Python script to a file named test.py in your - application directory (and the ensure that Python is installed): - - 
 #!/usr/bin/python
- # ------------------------------------------------------------------------------
- # Sample Python script
- # ------------------------------------------------------------------------------
- 
- import sys
- 
- for word in sys.argv: #echo the command line arguments
-     print word
- 
- print "HI FROM PYTHON"
- print "Enter user name" 
- line = sys.stdin.readline()
- 
- sys.stdout.write("hello," + line)
-
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/NativeProcessStartupInfo.html b/html-docs/flash/desktop/NativeProcessStartupInfo.html deleted file mode 100644 index 184bb17..0000000 --- a/html-docs/flash/desktop/NativeProcessStartupInfo.html +++ /dev/null @@ -1,379 +0,0 @@ - - - - - - - - -flash.desktop.NativeProcessStartupInfo (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic class NativeProcessStartupInfo
InheritanceNativeProcessStartupInfo Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- This class provides the basic information used to start a process on the host operating system. - It is constructed and passed to the start() method of a NativeProcess object. -

Native process access is only available to AIR applications installed with native installers - (applications in the extended desktop profile).

-

-

-See also -

-
-NativeProcess.html#start() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  arguments : Vector.<String>
- The command line arguments that will be passed to the process on startup.
-		NativeProcessStartupInfo
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  executable : File -
- The File object that references an executable on the host operating system.
-		NativeProcessStartupInfo
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  workingDirectory : File -
- The File object that references the initial working directory for the - new native process.
-		NativeProcessStartupInfo
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NativeProcessStartupInfo()
-
- Constructs an empty NativeProcessStartupInfo object.
-		NativeProcessStartupInfo
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
argumentsproperty
-
-arguments:Vector.<String>  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The command line arguments that will be passed to the process on startup. -

Each string in the arguments Vector will be passed as a separate argument - to the executable, regardless of what characters the string contains. In other words, - there is an exact one-to-one correspondence; no re-interpretation occurs. AIR automatically - escapes any characters in the string that need to be escaped (such as space characters).

- - Implementation -
-    public function get arguments():Vector.<String> -
-    public function set arguments(value:Vector.<String>):void -
-
- - - - - -
executableproperty 
-
-executable:File  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The File object that references an executable on the host operating system. - This should be the full path to the executable including any extension required. -

Note: On Mac OS, to launch an executable within an application - bundle, be sure to have the path of the File object include the full path the the - executable (within the bundle), not just the path to the app file.

- Implementation -
-    public function get executable():File -
-    public function set executable(value:File):void -
-
-Throws -
- - - - -
ArgumentError — if the value specified is null, if it references - a directory, or if it references a file that does not exist. -
-
- - - - - -
workingDirectoryproperty 
-
-workingDirectory:File  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The File object that references the initial working directory for the - new native process. If assigned a value where isDirectory is false, an ArgumentError - is thrown. -

Implementation -
-    public function get workingDirectory():File -
-    public function set workingDirectory(value:File):void -
-
-Throws -
- - - - -
ArgumentError — if the value doesn't exist or is not a directory -
-
- -
Constructor detail
- - - - - -
NativeProcessStartupInfo()constructor
-
-public function NativeProcessStartupInfo() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs an empty NativeProcessStartupInfo object. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/NotificationType.html b/html-docs/flash/desktop/NotificationType.html deleted file mode 100644 index d69f58c..0000000 --- a/html-docs/flash/desktop/NotificationType.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - -flash.desktop.NotificationType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic final class NotificationType
InheritanceNotificationType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The NotificationType class defines constants for use in the priority - parameter of the DockIcon bounce() method and the type - parameter of the NativeWindow notifyUser() method. - -

-

-See also -

-
-flash.desktop.DockIcon.bounce() -
-flash.display.NativeWindow.notifyUser() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  CRITICAL : String = "critical"
[static] - Specifies that a notification alert is critical in nature and the user should attend to it promptly.
-		NotificationType
  INFORMATIONAL : String = "informational"
[static] - Specifies that a notification alert is informational in nature and the user can safely ignore it.
-		NotificationType
-
- -
- -
Constant detail
- - - - - -
CRITICALconstant
-
-public static const CRITICAL:String = "critical" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies that a notification alert is critical in nature and the user should attend to it promptly. -

- - - - - -
INFORMATIONALconstant 
-
-public static const INFORMATIONAL:String = "informational" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies that a notification alert is informational in nature and the user can safely ignore it. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/SystemIdleMode.html b/html-docs/flash/desktop/SystemIdleMode.html deleted file mode 100644 index 819ac91..0000000 --- a/html-docs/flash/desktop/SystemIdleMode.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - - - - -flash.desktop.SystemIdleMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic final class SystemIdleMode
InheritanceSystemIdleMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The SystemIdleMode class provides constant values for system idle behaviors. These constants are used in - the systemIdleMode property of the NativeApplication class. - -

-

-See also -

-
-flash.desktop.NativeApplication.systemIdleMode -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  KEEP_AWAKE : String = "keepAwake"
[static] - Prevents the system from dropping into an idle mode.
-		SystemIdleMode
  NORMAL : String = "normal"
[static] - The system follows the normal "idle user" behavior.
-		SystemIdleMode
-
- -
- -
Constant detail
- - - - - -
KEEP_AWAKEconstant
-
-public static const KEEP_AWAKE:String = "keepAwake" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Prevents the system from dropping into an idle mode. - -

On Android, the application must specify the Android permissions for DISABLE_KEYGUARD and WAKE_LOCK in the application descriptor or the - operating system will not honor this setting.

- -
- - - - - -
NORMALconstant 
-
-public static const NORMAL:String = "normal" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The system follows the normal "idle user" behavior. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/SystemTrayIcon.html b/html-docs/flash/desktop/SystemTrayIcon.html deleted file mode 100644 index bc25fc7..0000000 --- a/html-docs/flash/desktop/SystemTrayIcon.html +++ /dev/null @@ -1,839 +0,0 @@ - - - - - - - - -flash.desktop.SystemTrayIcon (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic class SystemTrayIcon
InheritanceSystemTrayIcon Inheritance InteractiveIcon Inheritance Icon Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The SystemTrayIcon class represents the Windows® taskbar notification - area (system tray)-style icon. -

AIR profile support: This feature is supported on - desktop operating systems, but it is not supported on mobile devices or AIR for TV devices. See - - AIR Profile Support for more information regarding API support across multiple profiles.

-

Not all desktop operating systems have system tray icons. Check NativeApplication.supportsSystemTrayIcon - to determine whether system tray icons are supported on the current system.

- -

An instance of the SystemTrayIcon class cannot be created. Get the object representing the system tray - icon from the icon property of the "global" NativeApplication object. -

- -

When system tray icons are supported, the icon will be of type SystemTrayIcon. - Otherwise, the type of icon will be another - subclass of InteractiveIcon, typically DockIcon.

-

Important: Attempting to call a SystemTrayIcon class method on the - NativeApplication.icon object on an operating system for which AIR does not support - system tray icons will generate a run-time exception.

-

-

-See also -

-
-flash.desktop.NativeApplication.icon -
-flash.desktop.NativeApplication.supportsSystemTrayIcon -
-flash.desktop.DockIcon -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bitmaps : Array -
- The icon image as an array of BitmapData objects of different sizes.
-		SystemTrayIcon
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  height : int -
[read-only] - The current display height of the icon in pixels.
-		SystemTrayIcon
  menu : NativeMenu -
- The system tray icon menu.
-		SystemTrayIcon
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  tooltip : String -
- The tooltip that pops up for the system tray icon.
-		SystemTrayIcon
  width : int -
[read-only] - The current display width of the icon in pixels.
-		SystemTrayIcon
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-click -
-		 - Dispatched by this SystemTrayIcon object on mouse click.SystemTrayIcon
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-mouseDown -
-		 - Dispatched by this SystemTrayIcon object on mouse down.SystemTrayIcon
   -
-mouseUp -
-		 - Dispatched by this SystemTrayIcon object on mouse up.SystemTrayIcon
   -
-rightClick -
-		 - Dispatched by this SystemTrayIcon object on right mouse click.SystemTrayIcon
   -
-rightMouseDown -
-		 - Dispatched by this SystemTrayIcon object on right mouse down.SystemTrayIcon
   -
-rightMouseUp -
-		 - Dispatched by this SystemTrayIcon object on right mouse up.SystemTrayIcon
-
- -
-
Public Constants
- - - - - - - -
 ConstantDefined by
  MAX_TIP_LENGTH : Number = 63
[static] - The permitted length of the system tray icon tooltip.
-		SystemTrayIcon
-
- -
- -
Property detail
- - - - - -
bitmapsproperty
-
-bitmaps:Array  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The icon image as an array of BitmapData objects of different sizes. - -

When an icon is displayed in a given operating system context, the bitmap - in the array closest to the displayed size is used (and - scaled if necessary). Common sizes include 16x16, 32x32, 48x48, and - 128x128. (512x512 pixel icons may be used for some operating system - icons in the near future.)

-

In some contexts, the operating system may use a default system icon - if nothing has been assigned to the bitmaps property. - In other contexts, no icon appears.

- -

To set or change the icon appearance, assign an array of - BitmapData objects to the bitmaps property:

- - 
-	 icon.bitmaps = new Array(icon16x16.bitmapData, icon128x128.bitmapData);
-
- -

Modifying the bitmaps array directly has no effect.

- -

To clear the icon image, assign an empty array to the - bitmaps property.

-

- Note: When loading image files for an icon, the PNG file format - generally provides the best alpha blending. The GIF format supports only - on or off transparency (no blending). The JPG format does not support - transparency at all. -

- - Implementation -
-    public function get bitmaps():Array -
-    public function set bitmaps(value:Array):void -
-
- - - - - -
heightproperty 
-
-height:int  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The current display height of the icon in pixels. -

Some icon contexts support dynamic sizes. - The height property indicates the height of the icon chosen from the bitmaps array - for the current context. The actual display height may be different if the operating system - has scaled the icon.

- Implementation -
-    public function get height():int -
-
- - - - - -
menuproperty 
-
-menu:NativeMenu  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The system tray icon menu. -

Implementation -
-    public function get menu():NativeMenu -
-    public function set menu(value:NativeMenu):void -
-
- - - - - -
tooltipproperty 
-
-tooltip:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The tooltip that pops up for the system tray icon. If the string is - longer than SystemTrayIcon.MAX_TIP_LENGTH, the tip will - be truncated. -

Implementation -
-    public function get tooltip():String -
-    public function set tooltip(value:String):void -
-
- - - - - -
widthproperty 
-
-width:int  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The current display width of the icon in pixels. -

Some icon contexts support dynamic sizes. - The width property indicates the width of the icon chosen from the bitmaps array - for the current context. The actual display width may be different if the operating system - has scaled the icon.

- Implementation -
-    public function get width():int -
-
-
Event detail
- - - - - -
clickevent 
-
-Event object type: flash.events.ScreenMouseEvent -
-ScreenMouseEvent.type property = flash.events.ScreenMouseEvent.CLICK -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched by this SystemTrayIcon object on mouse click. -

- The ScreenMouseEvent.CLICK constant defines the value of the type - property of a click event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- - - - - -
mouseDownevent  
-
-Event object type: flash.events.ScreenMouseEvent -
-ScreenMouseEvent.type property = flash.events.ScreenMouseEvent.MOUSE_DOWN -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched by this SystemTrayIcon object on mouse down. -

- The ScreenMouseEvent.MOUSE_DOWN constant defines the value of the type - property of a mouseDown event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- - - - - -
mouseUpevent  
-
-Event object type: flash.events.ScreenMouseEvent -
-ScreenMouseEvent.type property = flash.events.ScreenMouseEvent.MOUSE_UP -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched by this SystemTrayIcon object on mouse up. -

- The ScreenMouseEvent.MOUSE_UP constant defines the value of the type - property of a mouseUp event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- - - - - -
rightClickevent  
-
-Event object type: flash.events.ScreenMouseEvent -
-ScreenMouseEvent.type property = flash.events.ScreenMouseEvent.RIGHT_CLICK -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched by this SystemTrayIcon object on right mouse click. -

- The ScreenMouseEvent.RIGHT_CLICK constant defines the value of the type - property of a rightClick event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- - - - - -
rightMouseDownevent  
-
-Event object type: flash.events.ScreenMouseEvent -
-ScreenMouseEvent.type property = flash.events.ScreenMouseEvent.RIGHT_MOUSE_DOWN -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched by this SystemTrayIcon object on right mouse down. -

- The ScreenMouseEvent.RIGHT_MOUSE_DOWN constant defines the value of the type - property of a rightMouseDown event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- - - - - -
rightMouseUpevent  
-
-Event object type: flash.events.ScreenMouseEvent -
-ScreenMouseEvent.type property = flash.events.ScreenMouseEvent.RIGHT_MOUSE_UP -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched by this SystemTrayIcon object on right mouse up. -

- The ScreenMouseEvent.RIGHT_MOUSE_UP constant defines the value of the type - property of a rightMouseUp event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- -
Constant detail
- - - - - -
MAX_TIP_LENGTHconstant
-
-public static const MAX_TIP_LENGTH:Number = 63 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The permitted length of the system tray icon tooltip. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/desktop/Updater.html b/html-docs/flash/desktop/Updater.html deleted file mode 100644 index 4df1f84..0000000 --- a/html-docs/flash/desktop/Updater.html +++ /dev/null @@ -1,413 +0,0 @@ - - - - - - - - -flash.desktop.Updater (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.desktop
Classpublic final class Updater
InheritanceUpdater Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The Updater class is used to update the currently running application - with a different version. To use it, instantiate an Updater object and then call - its update() method. -

The Updater class is only supported in the desktop profile. It is not supported for - extended desktop applications (applications installed with a native installer), and it is not - supported on the AIR mobile profile or AIR for TV profiles. Check the Updater.isSupported property.

-

Extended desktop application (applications installed with a native installer) - can download a new version of the native installer and launch it using the - File.openWithDefaultApplication() method.

- -

-

-See also -

-
-air.update.ApplicationUpdater -
-air.update.ApplicationUpdaterUI -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - The isSupported property is set to true if the Updater class is - available on the current platform, otherwise it is set to false.
-		Updater
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Updater()
-
- The constructor function for the Updater class.
-		Updater
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-update(airFile:File, version:String):void -
-
- Updates the currently running application with the version of the - application contained in the specified AIR file.
-		Updater
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The isSupported property is set to true if the Updater class is - available on the current platform, otherwise it is set to false. -

Implementation -
-    public static function get isSupported():Boolean -
-
- -
Constructor detail
- - - - - -
Updater()constructor
-
-public function Updater() -

- - - - -
Runtime version: AIR 1.0 -
-

- The constructor function for the Updater class. Note that the update() - method is not a static member of the class. You must instantiate an Updater object - and call the update() method on it. - -

- -
Method detail
- - - - - -
update()method
-
-public function update(airFile:File, version:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Updates the currently running application with the version of the - application contained in the specified AIR file. The application in - the AIR file must have the same application identifier - (appID) as the currently running application. - -

Calling this method causes the current application to exit (as if the - NativeApplication.exit() method had been called). This is necessary - because Adobe AIR cannot fully update an application while - the application is running. Upon successfully installing the new version of - the application, the application launches. If the runtime cannot successfully - install the new version (for example, if its application ID does not match - the existing version), the AIR installer presents an error message to - the user, and then the old version relaunches.

- -

The update process relaunches the application whether or not the - update is successful. Updates can fail for a variety of reasons, including - some that the application cannot control (such as the user having insufficient - privileges to install the application). Applications should take care to - detect failures and avoid reattempting the same failed update repeatedly. - The resulting infinite loop would effectively disable the application. - One way to check for a successful update is to write the current - version number to a file before starting the update, and then compare - that to the version number when the application is relaunched.

- -

When testing an application using the AIR Debug Launcher (ADL) application, - calling the update() method results in an IllegalOperationError exception.

- -

On Mac OS, to install an updated version of an application, the user needs to - have adequate system privileges to install to the application directory. - On Windows or Linux, the user needs to have adminstrative privileges.

- -

If the updated version of the application requires an updated version of - the runtime, the new runtime version is installed. To update the runtime, - a user needs to have administrative privileges for the computer.

- -

Note: Specifying the version parameter is required for - security reasons. By requiring the application to verify the version number in - the AIR file, the application will not inadvertantly install an older version, - which might contain a security vulnerability that has been fixed.

- - Parameters - - - - - - - - - - -
airFile:File — The File object pointing to the AIR file that contains the - update version of the application. - -
 
version:String — The required version in the new AIR file. The string in the - version attribute of the main application element of the - application descriptor file for the AIR file must match this value in order for the - update to succeed. - -
-
-Throws - - - - -
Error — The method was called when running in ADL. - -
-

-See also -

-
-air.update.ApplicationUpdater -
-air.update.ApplicationUpdaterUI -
-
-Example -
Note that the update() method is not - a static method of the class. You instantiate an Updater object and call the - update() method of that object. -
-
-import flash.fileSystem.File;
-import flash.desktop.Updater;
- 
-var updater:Updater = new Updater();
-var airFile:File = File.applicationStorageDirectory.resolvePath("Example Application.air");
-var version:String = "2.01";
-updater.update(airFile, version);
-
-

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/desktop/package-detail.html b/html-docs/flash/desktop/package-detail.html deleted file mode 100644 index fad01d2..0000000 --- a/html-docs/flash/desktop/package-detail.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - - -flash.desktop Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.desktop package contains classes used for copy-and-paste and drag-and-drop operations, as well as the Icon class, used to define system icons used by a file.

-
-
- -
Interfaces
- - - - - - - -
 InterfaceDescription
 IFilePromise - The IFilePromise interface defines the interface used by the AIR runtime to read data for a file promise.
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 Clipboard - The Clipboard class provides a container for transferring data and objects through the clipboard.
 ClipboardFormats -The ClipboardFormats class defines constants for the names of the standard data formats used with the Clipboard class.
 ClipboardTransferMode - The ClipboardTransferMode class defines constants for the modes used as values of the transferMode - parameter of the Clipboard.getData() method.
 DockIcon - The DockIcon class represents the Mac OS X®-style dock icon.
 Icon - The Icon class represents an operating system icon.
 InteractiveIcon - The InteractiveIcon class is the base class for the operating - system icons associated with applications.
 InvokeEventReason - The InvokeEventReason class enumerates values returned by the - reason property of an InvokeEvent object.
 NativeApplication - The NativeApplication class represents this AIR application.
 NativeDragActions -The NativeDragActions class defines string constants for the names of the drag-and-drop actions.
 NativeDragManager - The NativeDragManager class coordinates drag-and-drop operations.
 NativeDragOptions - The NativeDragOptions class defines constants for the names of drag-and-drop actions allowed in a drag-and-drop operation.
 NativeProcess - The NativeProcess class provides command line integration and general launching capabilities.
 NativeProcessStartupInfo - This class provides the basic information used to start a process on the host operating system.
 NotificationType - The NotificationType class defines constants for use in the priority - parameter of the DockIcon bounce() method and the type - parameter of the NativeWindow notifyUser() method.
 SystemIdleMode - The SystemIdleMode class provides constant values for system idle behaviors.
 SystemTrayIcon - The SystemTrayIcon class represents the Windows® taskbar notification - area (system tray)-style icon.
 Updater - The Updater class is used to update the currently running application - with a different version.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/display/AVM1Movie.html b/html-docs/flash/display/AVM1Movie.html deleted file mode 100644 index 6c6b278..0000000 --- a/html-docs/flash/display/AVM1Movie.html +++ /dev/null @@ -1,674 +0,0 @@ - - - - - - - - -flash.display.AVM1Movie (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class AVM1Movie
InheritanceAVM1Movie Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- AVM1Movie is a simple class that represents AVM1 movie clips, which use ActionScript 1.0 or 2.0. - (AVM1 is the ActionScript virtual machine used to run ActionScript 1.0 and 2.0. - AVM2 is the ActionScript virtual machine used to run ActionScript 3.0.) - When a Flash Player 8, or older, SWF file is loaded by a Loader object, an AVM1Movie - object is created. The AVM1Movie object can use methods and properties inherited from the - DisplayObject class (such as x, y, width, and so on). - However, no interoperability (such as calling methods or using parameters) between the AVM1Movie object - and AVM2 objects is allowed. - -

There are several restrictions on an AVM1 SWF file loaded by an AVM2 SWF file:

- -
    - -
  • The loaded AVM1Movie object operates as a psuedo-root object for the AVM1 SWF file and all AVM1 SWF files - loaded by it (as if the ActionScript 1.0 lockroot property were set to true). - The AVM1 movie is always the top of any ActionScript 1.0 or 2.0 code execution in any children. - The _root property for loaded children is always this AVM1 SWF file, unless the - lockroot property is set in a loaded AVM1 SWF file.
    • - -
  • The AVM1 content cannot load files into levels. For example, it cannot load files by calling - loadMovieNum("url", levelNum).
    • - -
  • The AVM1 SWF file that is loaded by an AVM2 SWF file cannot load another SWF file into this. - That is, it cannot load another SWF file over itself. However, child Sprite objects, MovieClip objects, or other AVM1 - SWF files loaded by this SWF file can load into this.
    • -
- -

-

-See also -

-
-DisplayObject -
-Loader -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
-
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/ActionScriptVersion.html b/html-docs/flash/display/ActionScriptVersion.html deleted file mode 100644 index b888cc3..0000000 --- a/html-docs/flash/display/ActionScriptVersion.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - - - - -flash.display.ActionScriptVersion (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class ActionScriptVersion
InheritanceActionScriptVersion Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The ActionScriptVersion class is an enumeration of constant values that - indicate the language version of a loaded SWF file. - The language version constants are provided for use in checking the - actionScriptVersion property of a flash.display.LoaderInfo object. - -

-

-See also -

-
-flash.display.LoaderInfo.actionScriptVersion -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  ACTIONSCRIPT2 : uint = 2
[static] - ActionScript language version 2.0 and earlier.
-		ActionScriptVersion
  ACTIONSCRIPT3 : uint = 3
[static] - ActionScript language version 3.0.
-		ActionScriptVersion
-
- -
- -
Constant detail
- - - - - -
ACTIONSCRIPT2constant
-
-public static const ACTIONSCRIPT2:uint = 2 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- ActionScript language version 2.0 and earlier. - -

- - - - - -
ACTIONSCRIPT3constant 
-
-public static const ACTIONSCRIPT3:uint = 3 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- ActionScript language version 3.0. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/Bitmap.html b/html-docs/flash/display/Bitmap.html deleted file mode 100644 index a7606a4..0000000 --- a/html-docs/flash/display/Bitmap.html +++ /dev/null @@ -1,1045 +0,0 @@ - - - - - - - - -flash.display.Bitmap (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class Bitmap
InheritanceBitmap Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The Bitmap class represents display objects that represent bitmap images. These can be images - that you load with the flash.display.Loader class, or they can be images that you create with - the Bitmap() constructor. -

The Bitmap() constructor allows you to create a Bitmap object that - contains a reference to a BitmapData object. After you create a Bitmap object, use the - addChild() or addChildAt() method of the parent DisplayObjectContainer - instance to place the bitmap on the display list.

-

A Bitmap object can share its BitmapData reference among several Bitmap objects, - independent of translation or rotation properties. Because you can create multiple Bitmap - objects that reference the same BitmapData object, multiple display objects can use the - same complex BitmapData object without incurring the memory overhead of a BitmapData - object for each display object instance.

-

A BitmapData object can be drawn to the screen by a Bitmap object in one of two ways: - by using the vector renderer as a fill-bitmap shape, or by using a faster pixel-copying routine. - The pixel-copying routine is substantially faster than the vector renderer, but the Bitmap object - must meet certain conditions to use it:

-
    -
  • No stretching, rotation, or skewing can be applied to the Bitmap object.
    • -
  • No color transform can be applied to the Bitmap object.
    • -
  • No blend mode can be applied to the Bitmap object.
    • -
  • No clipping can be done through mask layers or setMask() methods.
    • -
  • The image itself cannot be a mask.
    • -
  • The destination coordinates must be on a whole pixel boundary.
    • -
- -

If you load a Bitmap object from a domain other than that of the Loader object used to - load the image, and there is no URL policy file that permits access to the domain of - the Loader object, then a script in that domain cannot access the Bitmap - object or its properties and methods. For more information, see the Flash Player Developer Center Topic: - Security.

- -

Note: The Bitmap class is not a subclass of the InteractiveObject class, so - it cannot dispatch mouse events. However, you can use the addEventListener() method - of the display object container that contains the Bitmap object.

-

-

-View the examples. -

-

-See also -

-
-flash.display.Loader -
-flash.display.BitmapData -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
  bitmapData : BitmapData -
- The BitmapData object being referenced.
-		Bitmap
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
  pixelSnapping : String -
- Controls whether or not the Bitmap object is snapped to the nearest pixel.
-		Bitmap
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
  smoothing : Boolean -
- Controls whether or not the bitmap is smoothed when scaled.
-		Bitmap
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Bitmap(bitmapData:BitmapData = null, pixelSnapping:String = "auto", smoothing:Boolean = false)
-
- Initializes a Bitmap object to refer to the specified BitmapData object.
-		Bitmap
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
-
- -
- -
Property detail
- - - - - -
bitmapDataproperty
-
-bitmapData:BitmapData  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The BitmapData object being referenced. -

Implementation -
-    public function get bitmapData():BitmapData -
-    public function set bitmapData(value:BitmapData):void -
-
- - - - - -
pixelSnappingproperty 
-
-pixelSnapping:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Controls whether or not the Bitmap object is snapped to the nearest pixel. The PixelSnapping - class includes possible values: -

    -
  • PixelSnapping.NEVER—No pixel snapping occurs.
    • -
  • PixelSnapping.ALWAYS—The image is always snapped to the nearest - pixel, independent of transformation.
    • -
  • PixelSnapping.AUTO—The image is snapped - to the nearest pixel if it is drawn with no rotation - or skew and it is drawn at a scale factor of 99.9% to 100.1%. If these conditions are satisfied, - the bitmap image is drawn at 100% scale, snapped to the nearest pixel. Internally, this value allows the image - to be drawn as fast as possible using the vector renderer.
    • -
-

Implementation -
-    public function get pixelSnapping():String -
-    public function set pixelSnapping(value:String):void -
-
- - - - - -
smoothingproperty 
-
-smoothing:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Controls whether or not the bitmap is smoothed when scaled. If true, the bitmap is - smoothed when scaled. If false, the bitmap is not smoothed when scaled. -

Implementation -
-    public function get smoothing():Boolean -
-    public function set smoothing(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
Bitmap()constructor
-
-public function Bitmap(bitmapData:BitmapData = null, pixelSnapping:String = "auto", smoothing:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Initializes a Bitmap object to refer to the specified BitmapData object. - -

Parameters - - - - - - - - - - - - - - - - -
bitmapData:BitmapData (default = null) — The BitmapData object being referenced. - -
 
pixelSnapping:String (default = "auto") — Whether or not the Bitmap object is snapped to the nearest pixel. - -
 
smoothing:Boolean (default = false) — Whether or not the bitmap is smoothed when scaled. For example, the - following examples show the same bitmap scaled by a factor of 3, with - smoothing set to false (left) and true (right): - -

- - - - - - -
A bitmap without smoothing.A bitmap with smoothing.
-

-
-
-Example -
The following example shows how you can dynamically load an image at runtime using the ActionScript 3.0 Loader class and then copy the image's pixels into four separate Bitmap object instances on the display list by using the Loader instance's content property and bitmapData properties. - Example provided by - ActionScriptExamples.com. -
-
-const IMAGE_URL:String = "http://www.helpexamples.com/flash/images/logo.png";
- 
-var ldr:Loader = new Loader();
-ldr.contentLoaderInfo.addEventListener(Event.COMPLETE, ldr_complete);
-ldr.load(new URLRequest(IMAGE_URL));
- 
-var bitmap1:Bitmap;
-var bitmap2:Bitmap;
-var bitmap3:Bitmap;
-var bitmap4:Bitmap;
- 
-function ldr_complete(evt:Event):void {
-    var bmp:Bitmap = ldr.content as Bitmap;
- 
-    bitmap1 = new Bitmap(bmp.bitmapData);
-    bitmap1.x = 100;
-    bitmap1.y = 100;
-    bitmap1.rotation = 0;
-    addChild(bitmap1);
- 
-    bitmap2 = new Bitmap(bmp.bitmapData);
-    bitmap2.x = 200;
-    bitmap2.y = 100;
-    bitmap2.rotation = 90;
-    addChild(bitmap2);
- 
-    bitmap3 = new Bitmap(bmp.bitmapData);
-    bitmap3.x = 300;
-    bitmap3.y = 100;
-    bitmap3.rotation = 180;
-    addChild(bitmap3);
- 
-    bitmap4 = new Bitmap(bmp.bitmapData);
-    bitmap4.x = 400;
-    bitmap4.y = 100;
-    bitmap4.rotation = 270;
-    addChild(bitmap4);
-}
-
-

-
- -
Examples
-
examples\BitmapExample
-
The following example uses the BitmapExample class to load the - "Image.gif" image into a DisplayObject in the default location (x = 0, y = 0). A copy - of Image.gif is then placed to the right of the original, which has new colors applied to pixels - that pass a test using the threshold() method. - This task is accomplished using the following steps: -
    -
  1. A property url is created, which is the location and name of the image file
    2. -
  2. The class constructor calls the configureAssets() method, which, in turn, calls the - completeHandler() method.
    3. -
  3. configureAssets() creates a Loader object, which then instantiates an event listener, - which is dispatched when completeHandler() completes the image manipulation.
    4. -
  4. Next, the buildChild() method creates a new instance of a URLRequest object, - request, with url passed so the file name and location are known.
    5. -
  5. The request object is passed to the loader.load() method, which loads the image - into memory via a display object.
    6. -
  6. The image is then placed on the display list, which promptly displays the image on screen at - coordinates x = 0, y = 0.
    7. -
  7. The completeHandler() method then performs the following tasks: -
      -
    1. Creates a second Loader object, along with a Bitmap object, which is initialized with the - Loader object.
      2. -
    2. Creates a second Bitmap object, duplicate, which in turn calls the - duplicateImage() method, which creates a duplicate of the original image.
      3. -
    3. Creates a BitmapData object, which is assigned to the duplicate object's - BitmapData object.
      4. -
    4. Creates a new Rectangle object initialized with the same coordinates, width, and height - as the original image.
      5. -
    5. Creates a new Point object, which defaults to x = 0, y = 0.
      6. -
    6. Creates the following variables: -
        -
      • operation: applies the new color when the threshold - value is >= the original.
        • -
      • threshold: the value against which each pixel is compared is set to - light gray with an alpha of 0xCC.
        • -
      • color: the color that the pixels will be set to that pass the threshold - test, which is solid yellow in this case.
        • -
      • mask: set to the exact opposite of color, (transparent blue).
        • -
      • copySource: set to false, indicating that the pixel values are not copied - in the event the threshold value does not pass. This value has no meaning because - the image is duplicated and only pixels that pass the threshold test are changed.
        • -
      7. -
    7. Calls the threshold() method by using the preceding variables. The resulting threshold - equation is as follows: if (current pixel Value & 0x000000FF) >= - (0xCCCCCCCC & 0x000000FF) then set pixel to 0xFFFFFF00.
      8. -
    8. -
- -

Notes: -

    -
  • You will need to compile the SWF file with "Local playback security" set to "Access local files only". -
    • -
  • This example requires that a file named Image.gif be placed in the same directory as your SWF file. -
    • -
  • It is recommended that you use an image up to 80 pixels wide.
    • -
-

-
-
-
-package {
-    import flash.display.Bitmap;
-    import flash.display.BitmapData;
-    import flash.display.Loader;
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.geom.Point;
-    import flash.geom.Rectangle;
-    import flash.net.URLRequest;
-
-    public class BitmapExample extends Sprite {
-        private var url:String = "Image.gif";
-        private var size:uint = 80;
-
-        public function BitmapExample() {
-            configureAssets();
-        }
-
-        private function configureAssets():void {
-            var loader:Loader = new Loader();
-            loader.contentLoaderInfo.addEventListener(Event.COMPLETE, completeHandler);
-            loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-
-            var request:URLRequest = new URLRequest(url);
-            loader.x = size * numChildren;
-            loader.load(request);
-            addChild(loader);
-        }
-
-        private function duplicateImage(original:Bitmap):Bitmap {
-            var image:Bitmap = new Bitmap(original.bitmapData.clone());
-            image.x = size * numChildren;
-            addChild(image);
-            return image;
-        }
-
-        private function completeHandler(event:Event):void {
-            var loader:Loader = Loader(event.target.loader);
-            var image:Bitmap = Bitmap(loader.content);
-
-            var duplicate:Bitmap = duplicateImage(image);
-            var bitmapData:BitmapData = duplicate.bitmapData;
-            var sourceRect:Rectangle = new Rectangle(0, 0, bitmapData.width, bitmapData.height);
-            var destPoint:Point = new Point();
-            var operation:String = ">=";
-            var threshold:uint = 0xCCCCCCCC;
-            var color:uint = 0xFFFFFF00;
-            var mask:uint = 0x000000FF;
-            var copySource:Boolean = true;
-
-            bitmapData.threshold(bitmapData,
-                                 sourceRect,
-                                 destPoint,
-                                 operation,
-                                 threshold,
-                                 color,
-                                 mask,
-                                 copySource);
-        }
-        
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("Unable to load image: " + url);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/BitmapData.html b/html-docs/flash/display/BitmapData.html deleted file mode 100644 index 6308d70..0000000 --- a/html-docs/flash/display/BitmapData.html +++ /dev/null @@ -1,5889 +0,0 @@ - - - - - - - - -flash.display.BitmapData (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic class BitmapData
InheritanceBitmapData Inheritance Object
ImplementsIBitmapDrawable
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The BitmapData class lets you work with the data (pixels) of a Bitmap object - - bitmap image. You can use the methods of the BitmapData class - - to create arbitrarily sized transparent or opaque bitmap images and manipulate them in various - - ways at runtime. You can also access the BitmapData for a bitmap image - - that you load with the flash.display.Loader class. - - - -

This class lets you separate bitmap rendering operations from the - - internal display updating routines of Flash Player. By manipulating - - a BitmapData object directly, you can create complex images without incurring the - - per-frame overhead of constantly redrawing the content from vector data.

- - -

The methods of the BitmapData class support - - effects that are not available through the filters available to non-bitmap display objects.

- - -

A BitmapData object contains an array of pixel data. This data can represent either - - a fully opaque bitmap or a transparent bitmap that contains alpha channel data. - - Either type of BitmapData object is stored as a buffer of 32-bit integers. - - Each 32-bit integer determines the properties of a single pixel in the bitmap.

- - -

Each 32-bit integer is a combination of four 8-bit channel values (from 0 to 255) that - - describe the alpha transparency and the red, green, and blue (ARGB) values of the pixel. - - (For ARGB values, the most significant byte represents the alpha channel value, followed by red, - - green, and blue.)

- - - -

The four channels (alpha, red, green, and blue) are represented as numbers - - when you use them with the BitmapData.copyChannel() method or the - - DisplacementMapFilter.componentX - - and DisplacementMapFilter.componentY properties, and these numbers - - are represented by the following constants in the BitmapDataChannel class:

- - - -
    - -
  • BitmapDataChannel.ALPHA
    • - -
  • BitmapDataChannel.RED
    • - -
  • BitmapDataChannel.GREEN
    • - -
  • BitmapDataChannel.BLUE
    • - -
- - - -

You can attach BitmapData objects to a Bitmap object by using the - - bitmapData property of the Bitmap object.

- - -

You can use a BitmapData object to fill a Graphics object by using the - - Graphics.beginBitmapFill() method.

- - - -

In the AIR runtime, the DockIcon, Icon, InteractiveIcon, and SystemTrayIcon classes each include - - a bitmaps property that is an array of BitmapData objects that define the bitmap images - - for an icon.

- - - -

In AIR 1.5 and Flash Player 10, the maximum size for a BitmapData object is 8,191 pixels in width or height, - - and the total number of pixels cannot exceed 16,777,215 pixels. (So, if a BitmapData object is 8,191 pixels - - wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, the limitation is - - 2,880 pixels in height and 2,880 in width.

- - -

Starting with AIR 3 and Flash player 11, the size limits for a BitmapData object have been removed. - - The maximum size of a bitmap is now dependent on the operating system.

- - -

Calls to any method or property of a BitmapData object throw an ArgumentError error if - - the BitmapData object is invalid (for example, if it has height == 0 and - - width == 0) or it has been disposed of via dispose().

- - - -

-

-View the examples. -

-

-See also -

-
-flash.display.Bitmap.bitmapData -
-flash.desktop.DockIcon.bitmaps -
-flash.display.Graphics.beginBitmapFill() -
-flash.desktop.Icon.bitmaps -
-flash.desktop.InteractiveIcon.bitmaps -
-flash.display.Loader -
-flash.desktop.SystemTrayIcon.bitmaps -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  height : int -
[read-only] - - The height of the bitmap image in pixels.
-		BitmapData
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rect : Rectangle -
[read-only] - - The rectangle that defines the size and location of the bitmap image.
-		BitmapData
  transparent : Boolean -
[read-only] - - Defines whether the bitmap image supports per-pixel transparency.
-		BitmapData
  width : int -
[read-only] - - The width of the bitmap image in pixels.
-		BitmapData
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-BitmapData(width:int, height:int, transparent:Boolean = true, fillColor:uint = 0xFFFFFFFF)
-
- - Creates a BitmapData object with a specified width and height.
-		BitmapData
   -
-applyFilter(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, filter:BitmapFilter):void -
-
- - Takes a source image and a filter object and generates the - - filtered image.
-		BitmapData
   -
-clone():BitmapData -
-
- - Returns a new BitmapData object that is a clone of the original instance - - with an exact copy of the contained bitmap.
-		BitmapData
   -
-colorTransform(rect:Rectangle, colorTransform:ColorTransform):void -
-
- - Adjusts the color values in a specified area of a bitmap image by using a - - ColorTransform object.
-		BitmapData
   -
-compare(otherBitmapData:BitmapData):Object -
-
- - - Compares two BitmapData objects.
-		BitmapData
   -
-convertColorProfile(source:Screen, destination:Screen):BitmapData -
-
- - Create a copy of the image data, converting between color profiles based on the provided - - Screen objects.
-		BitmapData
   -
-copyChannel(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, sourceChannel:uint, destChannel:uint):void -
-
- - Transfers data from one channel of another BitmapData object or the current - - BitmapData object into a channel of the current BitmapData object.
-		BitmapData
   -
-copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, alphaBitmapData:BitmapData = null, alphaPoint:Point = null, mergeAlpha:Boolean = false):void -
-
- - Provides a fast routine to perform pixel manipulation - - between images with no stretching, rotation, or color effects.
-		BitmapData
   -
-copyPixelsToByteArray(rect:Rectangle, data:ByteArray):void -
-
- - Fills a byte array from a rectangular region of pixel data.
-		BitmapData
   -
-decode(data:ByteArray):BitmapData -
-
[static] - - Decompresses encoded image data (PNG/GIF89a/JPEG) into a new BitmapData object using data - - provided in a ByteArray.
-		BitmapData
   -
-dispose():void -
-
- - Frees memory that is used to store the BitmapData object.
-		BitmapData
   -
-draw(source:IBitmapDrawable, matrix:Matrix = null, colorTransform:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false):void -
-
- - Draws the source display object onto the bitmap image, using the - - Flash runtime vector renderer.
-		BitmapData
   -
-drawWithQuality(source:IBitmapDrawable, matrix:Matrix = null, colorTransform:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false, quality:String = null):void -
-
- - Draws the source display object onto the bitmap image, using the - - Flash runtime vector renderer.
-		BitmapData
   -
-encode(rect:Rectangle, compressor:Object, byteArray:ByteArray = null):ByteArray -
-
- - Compresses this BitmapData object using the selected compressor algorithm - - and returns a new ByteArray object.
-		BitmapData
   -
-fillRect(rect:Rectangle, color:uint):void -
-
- - Fills a rectangular area of pixels with a specified ARGB color.
-		BitmapData
   -
-floodFill(x:int, y:int, color:uint):void -
-
- - Performs a flood fill operation on an image starting - - at an (x, y) coordinate and filling with a certain color.
-		BitmapData
   -
-generateFilterRect(sourceRect:Rectangle, filter:BitmapFilter):Rectangle -
-
- - Determines the destination rectangle that the applyFilter() method call affects, given a - - BitmapData object, a source rectangle, and a filter object.
-		BitmapData
   -
-getColorBoundsRect(mask:uint, color:uint, findColor:Boolean = true):Rectangle -
-
- - Determines a rectangular region that either fully encloses all pixels of a specified color within the - - bitmap image (if the findColor parameter is set to true) or fully encloses - - all pixels that do not include the specified color (if the findColor parameter is set - - to false).
-		BitmapData
   -
-getPixel(x:int, y:int):uint -
-
- - Returns an integer that represents an RGB pixel value from a BitmapData object at - - a specific point (x, y).
-		BitmapData
   -
-getPixel32(x:int, y:int):uint -
-
- - Returns an ARGB color value that contains alpha channel data and RGB - - data.
-		BitmapData
   -
-getPixels(rect:Rectangle):ByteArray -
-
- - Generates a byte array from a rectangular region of pixel data.
-		BitmapData
   -
-getVector(rect:Rectangle):Vector.<uint>
-
- - Generates a vector array from a rectangular region of pixel data.
-		BitmapData
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-histogram(hRect:Rectangle = null):Vector.<Vector.<Number>>
-
- - Computes a 256-value binary number histogram of a BitmapData object.
-		BitmapData
   -
-hitTest(firstPoint:Point, firstAlphaThreshold:uint, secondObject:Object, secondBitmapDataPoint:Point = null, secondAlphaThreshold:uint = 1):Boolean -
-
- - Performs pixel-level hit detection between one bitmap image - - and a point, rectangle, or other bitmap image.
-		BitmapData
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-lock():void -
-
- - Locks an image so that any objects that reference the BitmapData object, such as Bitmap objects, - - are not updated when this BitmapData object changes.
-		BitmapData
   -
-merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:uint, greenMultiplier:uint, blueMultiplier:uint, alphaMultiplier:uint):void -
-
- - Performs per-channel blending from a source image to a destination image.
-		BitmapData
   -
-noise(randomSeed:int, low:uint = 0, high:uint = 255, channelOptions:uint = 7, grayScale:Boolean = false):void -
-
- - Fills an image with pixels representing random noise.
-		BitmapData
   -
-paletteMap(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redArray:Array = null, greenArray:Array = null, blueArray:Array = null, alphaArray:Array = null):void -
-
- - Remaps the color channel values in an image that has up to four arrays of color palette data, one - - for each channel.
-		BitmapData
   -
-perlinNoise(baseX:Number, baseY:Number, numOctaves:uint, randomSeed:int, stitch:Boolean, fractalNoise:Boolean, channelOptions:uint = 7, grayScale:Boolean = false, offsets:Array = null):void -
-
- - Generates a Perlin noise image.
-		BitmapData
   -
-pixelDissolve(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, randomSeed:int = 0, numPixels:int = 0, fillColor:uint = 0):int -
-
- - Performs a pixel dissolve either from a source image to a destination image or by using the same image.
-		BitmapData
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-scroll(x:int, y:int):void -
-
- - Scrolls an image by a certain (x, y) pixel amount.
-		BitmapData
   -
-setPixel(x:int, y:int, color:uint):void -
-
- - Sets a single pixel of a BitmapData object.
-		BitmapData
   -
-setPixel32(x:int, y:int, color:uint):void -
-
- - Sets the color and alpha transparency values of a single pixel of a BitmapData - - object.
-		BitmapData
   -
-setPixels(rect:Rectangle, inputByteArray:ByteArray):void -
-
- - Converts a byte array into a rectangular region of pixel data.
-		BitmapData
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setVector(rect:Rectangle, inputVector:Vector.<uint>):void -
-
- - Converts a Vector into a rectangular region of pixel data.
-		BitmapData
   -
-threshold(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, operation:String, threshold:uint, color:uint = 0, mask:uint = 0xFFFFFFFF, copySource:Boolean = false):uint -
-
- - Tests pixel values in an image against a specified threshold and sets pixels that pass the test to new color values.
-		BitmapData
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-unlock(changeRect:Rectangle = null):void -
-
- - Unlocks an image so that any objects that reference the BitmapData object, such as Bitmap objects, - - are updated when this BitmapData object changes.
-		BitmapData
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
heightproperty
-
-height:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - The height of the bitmap image in pixels. - - -

Implementation -
-    public function get height():int -
-
- - - - - -
rectproperty 
-
-rect:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - The rectangle that defines the size and location of the bitmap image. The top and left of the - - rectangle are 0; the width and height are equal to the width and height in pixels of the - - BitmapData object. - - -

Implementation -
-    public function get rect():Rectangle -
-
- - - - - -
transparentproperty 
-
-transparent:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Defines whether the bitmap image supports per-pixel transparency. You can set this value only when you construct - - a BitmapData object by passing in true for the transparent parameter of the constructor. Then, after you create - - a BitmapData object, you can check whether it supports per-pixel transparency by determining if the value of the - - transparent property is true. - - - -

Implementation -
-    public function get transparent():Boolean -
-
- - - - - -
widthproperty 
-
-width:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - The width of the bitmap image in pixels. - - -

Implementation -
-    public function get width():int -
-
- -
Constructor detail
- - - - - -
BitmapData()constructor
-
-public function BitmapData(width:int, height:int, transparent:Boolean = true, fillColor:uint = 0xFFFFFFFF) -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Creates a BitmapData object with a specified width and height. - - If you specify a value for the fillColor parameter, every pixel in the bitmap is set - - to that color. - - -

By default, the bitmap is created as transparent, unless you pass the value false - - for the transparent parameter. After you create an opaque bitmap, you cannot change it to - - a transparent bitmap. Every pixel in an opaque bitmap uses only 24 bits of color channel information. - - If you define the bitmap as transparent, every pixel uses 32 bits of color channel information, - - including an alpha transparency channel.

- - -

In AIR 1.5 and Flash Player 10, the maximum size for a BitmapData object is 8,191 pixels in width or height, - - and the total number of pixels cannot exceed 16,777,215 pixels. (So, if a BitmapData object is 8,191 pixels - - wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, the limitation is - - 2,880 pixels in height and 2,880 pixels in width. - - If you specify a width or height value that is greater than 2880, a new instance is not created.

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
width:int — The width of the bitmap image in pixels. - - -
 
height:int — The height of the bitmap image in pixels. - - -
 
transparent:Boolean (default = true) — Specifies whether the bitmap image supports per-pixel transparency. - - The default value is true (transparent). To create a fully transparent bitmap, set the value - - of the transparent parameter to true and the value of the fillColor - - parameter to 0x00000000 (or to 0). Setting the transparent property to false - - can result in minor improvements in rendering performance. - - -
 
fillColor:uint (default = 0xFFFFFFFF) — A 32-bit ARGB color value that you use to fill the bitmap image area. - - The default value is 0xFFFFFFFF (solid white). - - -
-
-Throws - - - - -
ArgumentError — width and/or height exceed the maximum dimensions. - - - -
-
- -
Method detail
- - - - - -
applyFilter()method
-
-public function applyFilter(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, filter:BitmapFilter):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Takes a source image and a filter object and generates the - - filtered image. - - -

This method relies on the behavior of built-in filter - - objects, which determine the destination - - rectangle that is affected by an input source rectangle.

- - -

After a filter is applied, the resulting image can be larger than the input image. - - For example, if you use a BlurFilter class - - to blur a source rectangle of (50,50,100,100) and a - - destination point of (10,10), the area that changes in the - - destination image is larger than (10,10,60,60) because of - - the blurring. This happens internally during the applyFilter() - - call.

- - -

If the sourceRect parameter of the sourceBitmapData parameter is - - an interior region, such as (50,50,100,100) in a 200 x 200 image, the filter uses the source - - pixels outside the sourceRect parameter to generate - - the destination rectangle.

- - - -

If the BitmapData object and the object specified as the sourceBitmapData - - parameter are the same object, the application uses a temporary copy of the object to - - perform the filter. For best performance, avoid this situation.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
sourceBitmapData:BitmapData — The input bitmap image to use. The source image can be a different - - BitmapData object or it can refer to the current BitmapData instance. - - - - -
 
sourceRect:Rectangle — A rectangle that defines the area of the source image to use as input. - - -
 
destPoint:Point — The point within the destination image (the current BitmapData - - instance) that corresponds to the upper-left corner of the source rectangle. - - -
 
filter:BitmapFilter — The filter object that you use to perform the filtering operation. Each type - - of filter has certain requirements, as follows: - - -
  • BlurFilter — - - This filter can use source and destination images - - that are either opaque or transparent. If the formats of the images do - - not match, the copy of the source image that is made during the - - filtering matches the format of the destination image.
    • - - -
  • BevelFilter, DropShadowFilter, GlowFilter — - - The destination image of these filters must be a transparent - - image. Calling DropShadowFilter or GlowFilter creates an image that - - contains the alpha channel data of the drop shadow or glow. It does not - - create the drop shadow onto the destination image. If you use any of these - - filters with an opaque destination image, an exception - - is thrown.
    • - - -
  • ConvolutionFilter — This filter can use source and - - destination images that are either opaque or transparent.
    • - - -
  • ColorMatrixFilter — This filter can use source and - - destination images that are either opaque or transparent.
    • - - -
  • DisplacementMapFilter — This filter can use source and - - destination images that are either opaque or transparent, but the - - source and destination image formats must be the same.
- - - -
-
-Throws - - - - - - - - - - -
TypeError — The sourceBitmapData, sourceRect, destPoint or filter are null. - -
 
Error — The transparency of the BitmapData objects are not - - compatible with the filter operation. - - -
-

-See also -

-
-flash.filters.BevelFilter -
-flash.filters.BlurFilter -
-flash.filters.ColorMatrixFilter -
-flash.filters.ConvolutionFilter -
-flash.filters.DisplacementMapFilter -
-flash.filters.DropShadowFilter -
-flash.filters.GlowFilter -
-flash.display.DisplayObject.filters -
-
-Example -
The following example shows how to apply a blur filter to a BitmapData instance: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Point;
-import flash.geom.Rectangle;
-import flash.filters.BlurFilter;
-
-var bmd:BitmapData = new BitmapData(80, 30, false, 0xFFCC00);
-var rect:Rectangle = new Rectangle(10, 10, 40, 10);
-bmd.fillRect(rect, 0xFF0000);
-
-var pt:Point = new Point(10, 10);
-var filter:BlurFilter = new BlurFilter();
-bmd.applyFilter(bmd, rect, pt, filter);
-
-var bm:Bitmap = new Bitmap(bmd);
-addChild(bm);
-
-

-
- - - - - -
clone()method 
-
-public function clone():BitmapData -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a new BitmapData object that is a clone of the original instance - - with an exact copy of the contained bitmap. - - - -

-Returns - - - - -
BitmapData — - A new BitmapData object that is identical to the original. - - - - - -
-
-Example -
The following example shows how to clone a BitmapData instance, and it shows that when you modify the - cloned BitmapData instance, the original remains unmodified: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-
-var bmd1:BitmapData = new BitmapData(100, 80, false, 0x00000000);
-var bmd2:BitmapData = bmd1.clone();
-
-bmd1.setPixel32(1, 1, 0xFFFFFFFF);
-
-trace(bmd1.getPixel32(1, 1).toString(16)); // ffffffff
-trace(bmd2.getPixel32(1, 1).toString(16)); // ff000000
-
-var bm1:Bitmap = new Bitmap(bmd1);
-this.addChild(bm1);
-
-var bm2:Bitmap = new Bitmap(bmd2);
-bm2.x = 110;
-this.addChild(bm2);
-
-

-
- - - - - -
colorTransform()method 
-
-public function colorTransform(rect:Rectangle, colorTransform:ColorTransform):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Adjusts the color values in a specified area of a bitmap image by using a - - ColorTransform object. If the rectangle - - matches the boundaries of the bitmap image, this method transforms the color values of - - the entire image. - - - -

Parameters - - - - - - - - - - -
rect:Rectangle — A Rectangle object that defines the area of the image in which the - - ColorTransform object is applied. - - - -
 
colorTransform:ColorTransform — A ColorTransform object that describes the color transformation - - values to apply. - - -
-
-Throws - - - - -
TypeError — The rect or colorTransform are null. - - - -
-

-See also -

-
-flash.geom.ColorTransform -
-flash.geom.Rectangle -
-
-Example -
The following example shows how to apply a color transform to the left half (rectangle) of a - BitmapData object: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-import flash.geom.ColorTransform;
-
-var bmd:BitmapData = new BitmapData(80, 30, false, 0xFF0000);
-
-var cTransform:ColorTransform = new ColorTransform();
-cTransform.alphaMultiplier = 0.5
-var rect:Rectangle = new Rectangle(0, 0, 40, 30);
-bmd.colorTransform(rect, cTransform);
-
-var bm:Bitmap = new Bitmap(bmd);
-addChild(bm);
-
-

-
- - - - - -
compare()method 
-
-public function compare(otherBitmapData:BitmapData):Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - - Compares two BitmapData objects. If the two BitmapData objects have the same dimensions - - (width and height), the method returns a new BitmapData object, in which each pixel is - - the "difference" between the pixels in the two source objects: - - - -

    - - - -
  • If two pixels are equal, the difference pixel is 0x00000000.
    • - - - -
  • If two pixels have different RGB values (ignoring the alpha value), the difference - - pixel is 0xRRGGBB where RR/GG/BB are the individual difference values between red, green, - - and blue channels (the pixel value in the source object minus the pixel value in the - - otherBitmapData object). Alpha channel differences are ignored in this case.
    • - - - -
  • If only the alpha channel value is different, the pixel value is 0xZZFFFFFF, - - where ZZ is the difference in the alpha values (the alpha value in the source object - - minus the alpha value in the otherBitmapData object).
    • - - - -
- - - -

For example, consider the following two BitmapData objects:

- - - - 
-
-     var bmd1:BitmapData = new BitmapData(50, 50, true, 0xFFFF8800);
-
-     var bmd2:BitmapData = new BitmapData(50, 50, true, 0xCCCC6600);
-
-     var diffBmpData:BitmapData = bmd1.compare(bmd2) as BitmapData;
-
-     trace ("0x" + diffBmpData.getPixel(0,0).toString(16); // 0x332200
-
-
- - - - 
-
-     var bmd1 = new air.BitmapData(50, 50, true, 0xFFFF0000);
-
-     var bmd2 = new air.BitmapData(50, 50, true, 0xCCFFAA00);
-
-     var diffBmpData = bmd1.compare(bmd2);
-
-
- - - -

Note: The colors used to fill the two BitmapData objects have slightly different RGB values - - (0xFF0000 and 0xFFAA00). The result of the compare() method is a new BitmapData - - object with each pixel showing the difference in the RGB values between the two bitmaps.

- - - -

Consider the following two BitmapData objects, in which the RGB colors are the same, - - but the alpha values are different:

- - - - 
-
-     var bmd1:BitmapData = new BitmapData(50, 50, true, 0xFFFFAA00);
-
-     var bmd2:BitmapData = new BitmapData(50, 50, true, 0xCCFFAA00);
-
-     var diffBmpData:BitmapData = bmd1.compare(bmd2) as BitmapData;
-
-     trace ("0x" + diffBmpData.getPixel32(0,0).toString(16); // 0x33ffffff
-
-
- - - - 
-
-     var bmd1 = new air.BitmapData(50, 50, true, 0xFFFFAA00);
-
-     var bmd2 = new air.BitmapData(50, 50, true, 0xCCFFAA00);
-
-     var diffBmpData = bmd1.compare(bmd2);
-
-
- - - -

The result of the compare() method is a new BitmapData - - object with each pixel showing the difference in the alpha values between the two bitmaps.

- - - -

If the BitmapData objects are equivalent (with the same width, height, and identical pixel values), - - the method returns the number 0.

- - - -

If the widths of the BitmapData objects are not equal, the method returns the number -3.

- - - -

If the heights of the BitmapData objects are not equal, but the widths are the same, - - the method returns the number -4.

- - - -

The following example compares two Bitmap objects with different widths (50 and 60):

- - - - 
-
-     var bmd1:BitmapData = new BitmapData(100, 50, false, 0xFFFF0000);
-
-     var bmd2:BitmapData = new BitmapData(100, 60, false, 0xFFFFAA00);
-
-     trace(bmd1.compare(bmd2)); // -4
-
-
- - - - 
-
-     var bmd1 = new air.BitmapData(100, 50, false, 0xFFFF0000);
-
-     var bmd2 = new air.BitmapData(100, 60, false, 0xFFFFAA00);
-
-     trace(bmd1.compare(bmd2)); // -4
-
-
- - - - Parameters - - - - -
otherBitmapData:BitmapData — The BitmapData object to compare with the source BitmapData object. - - - -
-

-Returns - - - - -
Object — - If the two BitmapData objects have the same dimensions (width and height), the - - method returns a new BitmapData object that has the difference between the two objects (see the - - main discussion). If the BitmapData objects are equivalent, the method returns the number 0. - - If the widths of the BitmapData objects are not equal, the method returns the number -3. - - If the heights of the BitmapData objects are not equal, the method returns the number -4. - - - - -
-
-Throws - - - - -
TypeError — The otherBitmapData is null. - - - -
-
-Example -
The following example shows the value of a pixel in the BitmapData object that results from - comparing two BitmapData objects of the same dimensions: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-
-var bmd1:BitmapData = new BitmapData(50, 50, true, 0xFFFFAA00);
-var bmd2:BitmapData = new BitmapData(50, 50, true, 0xCCFFAA00);
-var diffBmpData:BitmapData = BitmapData(bmd1.compare(bmd2));
-var diffValue:String = diffBmpData.getPixel32(1, 1).toString(16);
-trace (diffValue); // 33ffffff
-
-var bm1:Bitmap = new Bitmap(bmd1);
-addChild(bm1);
-var bm2:Bitmap = new Bitmap(bmd2);
-addChild(bm2);
-bm2.x = 60;
-
-

-
- - - - - -
convertColorProfile()method 
-
-public function convertColorProfile(source:Screen, destination:Screen):BitmapData -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Create a copy of the image data, converting between color profiles based on the provided - - Screen objects. - - -

To convert a normal/loaded image (in sRGB color profile) so that it is displayed properly on a - - display, pass in null for the source screen and the application's display - - location as the destination screen. This would be the normal use case for this feature.

- - - Parameters - - - - - - - - - - -
source:Screen — A Screen object that will be used to obtain the source color profile. If null, - - sRGB will be assumed. - -
 
destination:Screen — A Screen object that will be used to obtain the destination color profile. If null, - - sRGB will be assumed. - -
-

-Returns - - - - -
BitmapData — - A new BitmapData object with the appropriate color transformation. - - - - -
-
- - - - - -
copyChannel()method 
-
-public function copyChannel(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, sourceChannel:uint, destChannel:uint):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Transfers data from one channel of another BitmapData object or the current - - BitmapData object into a channel of the current BitmapData object. - - All of the data in the other channels in the destination BitmapData object are - - preserved. - - -

The source channel value and destination channel value can be - - one of following values:

- -
    - -
  • BitmapDataChannel.RED
    • - -
  • BitmapDataChannel.GREEN
    • - -
  • BitmapDataChannel.BLUE
    • - -
  • BitmapDataChannel.ALPHA
    • - -
- - - - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
sourceBitmapData:BitmapData — The input bitmap image to use. The source image can be a different BitmapData object - - or it can refer to the current BitmapData object. - - - -
 
sourceRect:Rectangle — The source Rectangle object. To copy only channel data from a smaller area - - within the bitmap, specify a source rectangle that is smaller than the overall size of the - - BitmapData object. - - - -
 
destPoint:Point — The destination Point object that represents the upper-left corner of the rectangular area - - where the new channel data is placed. - - To copy only channel data - - from one area to a different area in the destination image, specify a point other than (0,0). - - - -
 
sourceChannel:uint — The source channel. Use a value from the BitmapDataChannel class - - (BitmapDataChannel.RED, BitmapDataChannel.BLUE, - - BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA). - - - -
 
destChannel:uint — The destination channel. Use a value from the BitmapDataChannel class - - (BitmapDataChannel.RED, BitmapDataChannel.BLUE, - - BitmapDataChannel.GREEN, BitmapDataChannel.ALPHA). - - -
-
-Throws - - - - -
TypeError — The sourceBitmapData, sourceRect or destPoint are null. - - - -
-

-See also -

-
-flash.geom.Rectangle -
-
-Example -
The following example shows how to copy the red channel in a BitmapData object to its own - blue channel in a 20 x 20 pixel region: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-import flash.geom.Point;
-
-var bmd:BitmapData = new BitmapData(100, 80, false, 0x00FF0000);
-
-var rect:Rectangle = new Rectangle(0, 0, 20, 20);
-var pt:Point = new Point(10, 10);
-bmd.copyChannel(bmd, rect, pt, BitmapDataChannel.RED, BitmapDataChannel.BLUE);
-
-var bm:Bitmap = new Bitmap(bmd);
-this.addChild(bm);
-
-

-
- - - - - -
copyPixels()method 
-
-public function copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, alphaBitmapData:BitmapData = null, alphaPoint:Point = null, mergeAlpha:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Provides a fast routine to perform pixel manipulation - - between images with no stretching, rotation, or color effects. This method copies a - - rectangular area of a source image to a - - rectangular area of the same size at the destination point of the destination - - BitmapData object. - - -

If you include the alphaBitmap and alphaPoint parameters, you can use a secondary - - image as an alpha source for the source image. If the source - - image has alpha data, both sets of alpha data are used to - - composite pixels from the source image to the destination image. The - - alphaPoint parameter is the point in the alpha image that - - corresponds to the upper-left corner of the source - - rectangle. Any pixels outside the intersection of the source - - image and alpha image are not copied to the destination image.

- - -

The mergeAlpha property controls whether or not the alpha - - channel is used when a transparent image is copied onto - - another transparent image. To copy - - pixels with the alpha channel data, set the mergeAlpha - - property to true. By default, the mergeAlpha property is - - false.

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
sourceBitmapData:BitmapData — The input bitmap image from which to copy pixels. The source image can be a - - different BitmapData instance, or it can refer to the current BitmapData - - instance. - - - -
 
sourceRect:Rectangle — A rectangle that defines the area of the source image to use as input. - - - -
 
destPoint:Point — The destination point that represents the upper-left corner of the rectangular - - area where the new pixels are placed. - - - -
 
alphaBitmapData:BitmapData (default = null) — A secondary, alpha BitmapData object source. - - - -
 
alphaPoint:Point (default = null) — The point in the alpha BitmapData object source that corresponds to - - the upper-left corner of the sourceRect parameter. - - - -
 
mergeAlpha:Boolean (default = false) — To use the alpha channel, set the value to - - true. To copy pixels with no alpha channel, set the value to - - false. - - -
-
-Throws - - - - -
TypeError — The sourceBitmapData, sourceRect, destPoint are null. - - - -
-
-Example -
The following example shows how to copy pixels from a 20 x 20 pixel region in one BitmapData object - to another BitmapData object: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-import flash.geom.Point;
-
-var bmd1:BitmapData = new BitmapData(40, 40, false, 0x000000FF);
-var bmd2:BitmapData = new BitmapData(80, 40, false, 0x0000CC44);
-
-var rect:Rectangle = new Rectangle(0, 0, 20, 20);
-var pt:Point = new Point(10, 10);
-bmd2.copyPixels(bmd1, rect, pt);
-
-var bm1:Bitmap = new Bitmap(bmd1);
-this.addChild(bm1);
-var bm2:Bitmap = new Bitmap(bmd2);
-this.addChild(bm2);
-bm2.x = 50;
-
-

-
- - - - - -
copyPixelsToByteArray()method 
-
-public function copyPixelsToByteArray(rect:Rectangle, data:ByteArray):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Fills a byte array from a rectangular region of pixel data. - - Starting at the position index of the ByteArray, this method - - writes an unsigned integer (a 32-bit unmultiplied pixel value) - - for each pixel into the byte array. If necessary, the byte array's size is - - increased to the necessary number of bytes to hold all the pixel data. - - - -

Parameters - - - - - - - - - - -
rect:Rectangle — A rectangular area in the current BitmapData object - -
 
data:ByteArray — the destination ByteArray object - - - - - -
-
-Throws - - - - -
TypeError — if the rect argument is null - - or the data argument is null - - - -
-

-See also -

-
-flash.utils.ByteArray -
-
- - - - - -
decode()method 
-
-public static function decode(data:ByteArray):BitmapData -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Decompresses encoded image data (PNG/GIF89a/JPEG) into a new BitmapData object using data - - provided in a ByteArray. The image format is determined by the runtime and supports the - - same formats as can be provided within a SWF file's DefineBitsJPEG2 tag. - - -

Parameters - - - - -
data:ByteArray — The ByteArray object containing the compressed image data - -
-

-Returns - - - - -
BitmapData — - A BitmapData containing the decoded image. - - - - -
-
- - - - - -
dispose()method 
-
-public function dispose():void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Frees memory that is used to store the BitmapData object. - - -

When the dispose() method is called on an image, the width and height of the image are set to 0. - - All subsequent calls to methods or properties of this BitmapData instance fail, and an - - exception is thrown.

- -

BitmapData.dispose() releases the memory occupied by the actual bitmap data, immediately (a bitmap can consume up to 64 MB of memory). - - After using BitmapData.dispose(), the BitmapData object is no longer usable and the Flash runtime throws an exception if you call - - functions on the BitmapData object. - - However, BitmapData.dispose() does not garbage collect the BitmapData object (approximately 128 bytes); the memory occupied by the actual - - BitmapData object is released at the time the BitmapData object is collected by the garbage collector.

- - - -

-See also -

-
-flash.system.System.gc() -
-
-Example -
The following example shows the effect of calling a method of a BitmapData object after a call to the - dispose() method (an exception is thrown): -
-
-import flash.display.BitmapData;
-
-var myBitmapData:BitmapData = new BitmapData(100, 80, false, 0x000000FF);
-trace(myBitmapData.getPixel(1, 1)); // 255 == 0xFF
-
-myBitmapData.dispose();
-try {
-    trace(myBitmapData.getPixel(1, 1));
-} catch (error:Error) {
-	trace(error); // ArgumentError
-}
-
-

-
- - - - - -
draw()method 
-
-public function draw(source:IBitmapDrawable, matrix:Matrix = null, colorTransform:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Draws the source display object onto the bitmap image, using the - - Flash runtime vector renderer. - - You can specify matrix, colorTransform, - - blendMode, and a destination clipRect parameter to control - - how the rendering performs. Optionally, you can specify whether the bitmap - - should be smoothed when scaled (this works only if the source object - - is a BitmapData object). - - -

Note: The drawWithQuality() method works exactly - - like the draw() method, but instead of using the Stage.quality property - - to determine the quality of vector rendering, you specify the quality parameter - - to the drawWithQuality() method.

- - - -

This method directly corresponds to how objects are drawn - - with the standard vector renderer for objects in the authoring tool - - interface.

- - -

The source display object does not use any of its applied transformations - - for this call. It is treated as it exists in the library or - - file, with no matrix transform, no color transform, and no blend - - mode. To draw a display object (such as a movie clip) by using its own transform properties, - - you can copy its transform property object to the transform property - - of the Bitmap object that uses the BitmapData object.

- - - -

This method is supported over RTMP in Flash Player 9.0.115.0 - - and later and in Adobe AIR. You can control access to streams on - - Flash Media Server in a server-side script. For more information, see the Client.audioSampleAccess - - and Client.videoSampleAccess properties in - - Server-Side ActionScript Language Reference for Adobe Flash Media Server.

- - - -

If the source object and (in the case of a Sprite or MovieClip object) all - - of its child objects do not come from the same domain as the caller, or are not in a content that is - - accessible to the caller by having called the Security.allowDomain() method, a call to - - the draw() throws a SecurityError exception. This restriction does not apply - - to AIR content in the application security sandbox.

- - - -

There are also restrictions on using a loaded bitmap image as the source. - - A call to the draw() method is successful if the loaded image comes from the same domain as the caller. - - Also, a cross-domain policy file on the image's server can grant permission to the domain of the SWF content - - calling the draw() method. In this case, you must set the checkPolicyFile property - - of a LoaderContext object, and use this object as the context parameter when calling the load() - - method of the Loader object used to load the image. These restrictions do not apply to AIR content in the - - application security sandbox.

- - - -

On Windows, the draw() method cannot capture SWF content embedded in an HTML - - page in an HTMLLoader object in Adobe AIR.

- - - -

The draw() method cannot capture PDF content in Adobe AIR. - - Nor can it capture or SWF content embedded in HTML in which the wmode attribute is set - - to "window" in Adobe AIR.

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
source:IBitmapDrawable — The display object or BitmapData object to draw to the BitmapData object. - - (The DisplayObject and BitmapData classes implement the IBitmapDrawable interface.) - - - -
 
matrix:Matrix (default = null) — A Matrix object used to scale, rotate, or translate the coordinates - - of the bitmap. If you do not want to apply a matrix transformation to the image, - - set this parameter to an identity matrix, created with the default - - new Matrix() constructor, or pass a null value. - - -
 
colorTransform:ColorTransform (default = null) — A ColorTransform object that you use to adjust the color values of - - the bitmap. If no object is supplied, the bitmap image's colors are not transformed. - - If you must pass this parameter but you do not want to transform the image, set this - - parameter to a ColorTransform object created with the default new ColorTransform() - - constructor. - - -
 
blendMode:String (default = null) — A string value, from the flash.display.BlendMode class, specifying the - - blend mode to be applied to the resulting bitmap. - - - -
 
clipRect:Rectangle (default = null) — A Rectangle object that defines the area of the source object to draw. - - If you do not supply this value, no clipping occurs and the entire source object is drawn. - - - -
 
smoothing:Boolean (default = false) — A Boolean value that determines whether a BitmapData object is - - smoothed when scaled or rotated, due to a scaling or rotation in the matrix - - parameter. The smoothing parameter only applies if the source - - parameter is a BitmapData object. With smoothing set to false, - - the rotated or scaled BitmapData image can appear pixelated or jagged. For example, the following - - two images use the same BitmapData object for the source parameter, but the - - smoothing parameter is set to true on the left and false - - on the right: - - - -

Two images: the left one with smoothing and the right one without smoothing.

- - - -

Drawing a bitmap with smoothing set to true takes longer - - than doing so with smoothing set to false.

- - - -
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — The source parameter is not a BitmapData - - or DisplayObject object. - - - -
 
SecurityError — The source object and (in the case of - - a Sprite or MovieClip object) all of its child objects do not come from the same domain as - - the caller, or are not in a content that is accessible to the caller by having called the - - Security.allowDomain() method. This restriction does not apply - - to AIR content in the application security sandbox. - - -
 
ArgumentError — The source is null or not a valid IBitmapDrawable object. - - - -
-

-See also -

-
-flash.display.BitmapData.drawWithQuality() -
-flash.display.Stage.quality -
-flash.display.StageQuality -
-flash.display.BlendMode -
-flash.geom.ColorTransform -
-flash.geom.Matrix -
-flash.system.JPEGLoaderContext -
-
-Example -
The following example shows how to draw a TextField object to a BitmapData object: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.text.TextField;
-
-var tf:TextField = new TextField();
-tf.text = "bitmap text";
-
-var myBitmapData:BitmapData = new BitmapData(80, 20);
-myBitmapData.draw(tf);
-var bmp:Bitmap = new Bitmap(myBitmapData);
-this.addChild(bmp);
-
-

-
- - - - - -
drawWithQuality()method 
-
-public function drawWithQuality(source:IBitmapDrawable, matrix:Matrix = null, colorTransform:ColorTransform = null, blendMode:String = null, clipRect:Rectangle = null, smoothing:Boolean = false, quality:String = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.3
-

- - Draws the source display object onto the bitmap image, using the - - Flash runtime vector renderer. - - You can specify matrix, colorTransform, - - blendMode, and a destination clipRect parameter to control - - how the rendering performs. Optionally, you can specify whether the bitmap - - should be smoothed when scaled (this works only if the source object - - is a BitmapData object). - - -

Note: The drawWithQuality() method works exactly - - like the draw() method, but instead of using the Stage.quality property - - to determine the quality of vector rendering, you specify the quality parameter - - to the drawWithQuality() method.

- - - -

This method directly corresponds to how objects are drawn - - with the standard vector renderer for objects in the authoring tool - - interface.

- - -

The source display object does not use any of its applied transformations - - for this call. It is treated as it exists in the library or - - file, with no matrix transform, no color transform, and no blend - - mode. To draw a display object (such as a movie clip) by using its own transform properties, - - you can copy its transform property object to the transform property - - of the Bitmap object that uses the BitmapData object.

- - - -

This method is supported over RTMP in Flash Player 9.0.115.0 - - and later and in Adobe AIR. You can control access to streams on - - Flash Media Server in a server-side script. For more information, see the Client.audioSampleAccess - - and Client.videoSampleAccess properties in - - Server-Side ActionScript Language Reference for Adobe Flash Media Server.

- - - -

If the source object and (in the case of a Sprite or MovieClip object) all - - of its child objects do not come from the same domain as the caller, or are not in a content that is - - accessible to the caller by having called the Security.allowDomain() method, a call to - - the drawWithQuality() throws a SecurityError exception. This restriction does not apply - - to AIR content in the application security sandbox.

- - - -

There are also restrictions on using a loaded bitmap image as the source. - - A call to the drawWithQuality() method is successful if the loaded image comes from the same domain as the caller. - - Also, a cross-domain policy file on the image's server can grant permission to the domain of the SWF content - - calling the drawWithQuality() method. In this case, you must set the checkPolicyFile property - - of a LoaderContext object, and use this object as the context parameter when calling the load() - - method of the Loader object used to load the image. These restrictions do not apply to AIR content in the - - application security sandbox.

- - - -

On Windows, the drawWithQuality() method cannot capture SWF content embedded in an HTML - - page in an HTMLLoader object in Adobe AIR.

- - - -

The drawWithQuality() method cannot capture PDF content in Adobe AIR. - - Nor can it capture or SWF content embedded in HTML in which the wmode attribute is set - - to "window" in Adobe AIR.

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
source:IBitmapDrawable — The display object or BitmapData object to draw to the BitmapData object. - - (The DisplayObject and BitmapData classes implement the IBitmapDrawable interface.) - - - -
 
matrix:Matrix (default = null) — A Matrix object used to scale, rotate, or translate the coordinates - - of the bitmap. If you do not want to apply a matrix transformation to the image, - - set this parameter to an identity matrix, created with the default - - new Matrix() constructor, or pass a null value. - - -
 
colorTransform:ColorTransform (default = null) — A ColorTransform object that you use to adjust the color values of - - the bitmap. If no object is supplied, the bitmap image's colors are not transformed. - - If you must pass this parameter but you do not want to transform the image, set this - - parameter to a ColorTransform object created with the default new ColorTransform() - - constructor. - - -
 
blendMode:String (default = null) — A string value, from the flash.display.BlendMode class, specifying the - - blend mode to be applied to the resulting bitmap. - - - -
 
clipRect:Rectangle (default = null) — A Rectangle object that defines the area of the source object to draw. - - If you do not supply this value, no clipping occurs and the entire source object is drawn. - - - -
 
smoothing:Boolean (default = false) — A Boolean value that determines whether a BitmapData object is - - smoothed when scaled or rotated, due to a scaling or rotation in the matrix - - parameter. The smoothing parameter only applies if the source - - parameter is a BitmapData object. With smoothing set to false, - - the rotated or scaled BitmapData image can appear pixelated or jagged. For example, the following - - two images use the same BitmapData object for the source parameter, but the - - smoothing parameter is set to true on the left and false - - on the right: - - -

Two images: the left one with smoothing and the right one without smoothing.

- - - -

Drawing a bitmap with smoothing set to true takes longer - - than doing so with smoothing set to false.

- - - -
 
quality:String (default = null) — Any of one of the StageQuality values. Selects the antialiasing quality to be used - - when drawing vectors graphics. - - - -
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — The source parameter is not a BitmapData - - or DisplayObject object. - - - -
 
SecurityError — The source object and (in the case of - - a Sprite or MovieClip object) all of its child objects do not come from the same domain as - - the caller, or are not in a content that is accessible to the caller by having called the - - Security.allowDomain() method. This restriction does not apply - - to AIR content in the application security sandbox. - - -
 
ArgumentError — The source is null or not a valid IBitmapDrawable object. - - -
-

-See also -

-
-flash.display.BitmapData.draw() -
-flash.display.StageQuality -
-flash.display.BlendMode -
-flash.geom.ColorTransform -
-flash.geom.Matrix -
-flash.system.JPEGLoaderContext -
-
-Example -
The following example shows how to draw a TextField object to a BitmapData object: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.text.TextField;
-
-var tf:TextField = new TextField();
-tf.text = "bitmap text";
-
-var myBitmapData:BitmapData = new BitmapData(80, 20);
-myBitmapData.drawWithQuality(tf, , , , , , StageQuality.LOW);
-var bmp:Bitmap = new Bitmap(myBitmapData);
-this.addChild(bmp);
-
-

-
- - - - - -
encode()method 
-
-public function encode(rect:Rectangle, compressor:Object, byteArray:ByteArray = null):ByteArray -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.3 - -
-

- - Compresses this BitmapData object using the selected compressor algorithm - - and returns a new ByteArray object. - - Optionally, writes the resulting data to the specified ByteArray. - - The compressor argument specifies the encoding algorithm, and can be - - PNGEncoderOptions, JPEGEncoderOptions, or JPEGXREncoderOptions. - - -

The following example compresses a BitmapData object using the JPEGEncoderOptions:

- - - 
-
-     // Compress a BitmapData object as a JPEG file.
-
-     var bitmapData:BitmapData = new BitmapData(640,480,false,0x00FF00);
-
-     var byteArray:ByteArray = new ByteArray();
-
-     bitmapData.encode(new Rectangle(0,0,640,480), new flash.display.JPEGEncoderOptions(), byteArray);
- - - - Parameters - - - - - - - - - - - - - - - - -
rect:Rectangle — The area of the BitmapData object to compress. - - - -
 
compressor:Object — The compressor type to use. - - Valid values are: flash.display.PNGEncoderOptions, - - flash.display.JPEGEncoderOptions, and flash.display.JPEGXREncoderOptions. - - - -
 
byteArray:ByteArray (default = null) — The output ByteArray to hold the encoded image. - - -
-

-Returns - - - - -
ByteArray — - A ByteArray containing the encoded image. - - - - -
-

-See also -

-
-flash.display.JPEGEncoderOptions -
-flash.display.JPEGXREncoderOptions -
-flash.display.PNGEncoderOptions -
-
- - - - - -
fillRect()method 
-
-public function fillRect(rect:Rectangle, color:uint):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Fills a rectangular area of pixels with a specified ARGB color. - - - -

Parameters - - - - - - - - - - -
rect:Rectangle — The rectangular area to fill. - -
 
color:uint — The ARGB color value that fills the area. ARGB colors are often - - specified in hexadecimal format; for example, 0xFF336699. - - -
-
-Throws - - - - -
TypeError — The rect is null. - - - -
-

-See also -

-
-flash.geom.Rectangle -
-
-Example -
The following example shows how to fill a rectangular region of a BitmapData object with blue: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-
-var myBitmapData:BitmapData = new BitmapData(40, 40, false, 0x0000FF00);
-
-var rect:Rectangle = new Rectangle(0, 0, 20, 20);
-myBitmapData.fillRect(rect, 0x0000FF);
-
-var bm:Bitmap = new Bitmap(myBitmapData);
-addChild(bm);
-
-

-
- - - - - -
floodFill()method 
-
-public function floodFill(x:int, y:int, color:uint):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Performs a flood fill operation on an image starting - - at an (x, y) coordinate and filling with a certain color. The - - floodFill() method is similar to the paint bucket tool in various paint - - programs. The color is an ARGB color that contains alpha information and - - color information. - - - -

Parameters - - - - - - - - - - - - - - - - -
x:int — The x coordinate of the image. - -
 
y:int — The y coordinate of the image. - -
 
color:uint — The ARGB color to use as a fill. - - -
-
-Example -
The following example shows how to fill a region of a BitmapData object — that is, the region - surrounding the pixel defined by the point (10, 10) in which all colors match the color at that - point — with red -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-
-var myBitmapData:BitmapData = new BitmapData(40, 40, false, 0x0000FF00);
-
-var rect:Rectangle = new Rectangle(0, 0, 20, 20);
-myBitmapData.fillRect(rect, 0x000000FF);
-rect = new Rectangle(15, 15, 25, 25);
-myBitmapData.fillRect(rect, 0x000000FF);
-
-myBitmapData.floodFill(10, 10, 0x00FF0000);
-
-var bm:Bitmap = new Bitmap(myBitmapData);
-addChild(bm);
-
-

-
- - - - - -
generateFilterRect()method 
-
-public function generateFilterRect(sourceRect:Rectangle, filter:BitmapFilter):Rectangle -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Determines the destination rectangle that the applyFilter() method call affects, given a - - BitmapData object, a source rectangle, and a filter object. - - -

For example, a blur filter normally affects an area larger than the size of the original - - image. A 100 x 200 pixel image that is being filtered by a default BlurFilter - - instance, where blurX = blurY = 4 generates a destination rectangle of - - (-2,-2,104,204). - - The generateFilterRect() method lets you find out the size of this destination - - rectangle in advance so that you can size the destination image appropriately before you perform a filter - - operation.

- - - -

Some filters clip their destination rectangle based on the source image size. - - For example, an inner DropShadow does not generate a larger result than its source - - image. In this API, the BitmapData object is used as the source bounds and not the - - source rect parameter.

- - - - Parameters - - - - - - - - - - -
sourceRect:Rectangle — A rectangle defining the area of the source image to use as input. - -
 
filter:BitmapFilter — A filter object that you use to calculate the destination rectangle. - - -
-

-Returns - - - - -
Rectangle — - A destination rectangle computed by using an image, the sourceRect parameter, - - and a filter. - - - - -
-
-Throws - - - - -
TypeError — The sourceRect or filter are null. - - - -
-
-Example -
The following example shows how you can use the generateFilterRect() method to - determine the rectangular area that the result of a blur filter will occupy. The results of the - generateFilterRect() method are output by the trace() function: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Point;
-import flash.geom.Rectangle;
-import flash.filters.BlurFilter;
-
-var bmd:BitmapData = new BitmapData(80, 30, false, 0xFFCC00);
-var rect:Rectangle = new Rectangle(10, 10, 40, 10);
-bmd.fillRect(rect, 0xFF0000);
-
-var pt:Point = new Point(10, 10);
-var filter:BlurFilter = new BlurFilter();
-
-trace(bmd.generateFilterRect(rect, filter));
-// (x=8, y=8, w=44, h=14)
-
-bmd.applyFilter(bmd, rect, pt, filter);
-var bm:Bitmap = new Bitmap(bmd);
-addChild(bm);
-
-
Note that the generateFilterRect() method does not apply the filter. Call the applyFilter() method - to apply the filter. -
-
-

-
- - - - - -
getColorBoundsRect()method 
-
-public function getColorBoundsRect(mask:uint, color:uint, findColor:Boolean = true):Rectangle -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Determines a rectangular region that either fully encloses all pixels of a specified color within the - - bitmap image (if the findColor parameter is set to true) or fully encloses - - all pixels that do not include the specified color (if the findColor parameter is set - - to false). - - -

For example, if you have a source image and you want to determine the rectangle of - - the image that contains a nonzero alpha channel, pass - - {mask: 0xFF000000, color: 0x00000000} as parameters. If the findColor - - parameter is set to true, the entire image is searched for the bounds of pixels - - for which (value & mask) == color (where value is the color value - - of the pixel). If the findColor parameter is set to false, the entire - - image is searched for the bounds of pixels for which (value & mask) != color - - (where value is the color value of the pixel). To determine white space around an - - image, pass {mask: 0xFFFFFFFF, color: 0xFFFFFFFF} - - to find the bounds of nonwhite pixels.

- - - - Parameters - - - - - - - - - - - - - - - - -
mask:uint — A hexadecimal value, specifying the bits of the ARGB color to consider. The color - - value is combined with this hexadecimal value, by using the & (bitwise AND) operator. - - - -
 
color:uint — A hexadecimal value, specifying the ARGB color to match (if findColor - - is set to true) or not to match (if findColor - - is set to false). - - - -
 
findColor:Boolean (default = true) — If the value is set to true, returns the bounds of a color value in an image. - - If the value is set to false, returns the bounds of where this color doesn't exist in an image. - - - -
-

-Returns - - - - -
Rectangle — - The region of the image that is the specified color. - - - - - -
-
-Example -
The following example creates a BitmapData object with red in the top half of its pixels. It then calls - the getColorBoundsRect() method to determine the rectangle in which pixels are red (0xFF0000), and - then it calls the same method to determine the rectangle in which pixels are not red (by setting the - findColor parameter to false: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-
-var bmd:BitmapData = new BitmapData(80, 40, false, 0xFFFFFF);
-var rect:Rectangle = new Rectangle(0, 0, 80, 20);
-bmd.fillRect(rect, 0xFF0000);
-
-var maskColor:uint = 0xFFFFFF; 
-var color:uint = 0xFF0000;  
-var redBounds:Rectangle = bmd.getColorBoundsRect(maskColor, color, true);
-trace(redBounds); // (x=0, y=0, w=80, h=20)
-
-var notRedBounds:Rectangle = bmd.getColorBoundsRect(maskColor, color, false);
-trace(notRedBounds); // (x=0, y=20, w=80, h=20)
-
-var bm:Bitmap = new Bitmap(bmd);
-addChild(bm);
-
-

-
- - - - - -
getPixel()method 
-
-public function getPixel(x:int, y:int):uint -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns an integer that represents an RGB pixel value from a BitmapData object at - - a specific point (x, y). The getPixel() method returns an - - unmultiplied pixel value. No alpha information is returned. - - -

All pixels in a BitmapData object are stored as premultiplied color values. - - A premultiplied image pixel has the red, green, and blue - - color channel values already multiplied by the alpha data. For example, if the - - alpha value is 0, the values for the RGB channels are also 0, independent of their unmultiplied - - values. This loss of data can cause some problems when you perform operations. All BitmapData - - methods take and return unmultiplied values. The internal pixel representation is converted - - from premultiplied to unmultiplied before it is returned as a value. During a set operation, - - the pixel value is premultiplied before the raw image pixel is set.

- - - Parameters - - - - - - - - - - -
x:int — The x position of the pixel. - -
 
y:int — The y position of the pixel. - - -
-

-Returns - - - - -
uint — - A number that represents an RGB pixel value. If the (x, y) coordinates are - - outside the bounds of the image, the method returns 0. - - - - - -
-

-See also -

-
-getPixel32() -
-setPixel() -
-
-Example -
The following example creates a BitmapData object filled with red, then uses the - getPixel() method to determine the color value in the upper-left pixel: -
-
-import flash.display.BitmapData;
-
-var bmd:BitmapData = new BitmapData(80, 40, false, 0xFF0000);
-
-var pixelValue:uint = bmd.getPixel(0, 0);
-trace(pixelValue.toString(16)); // ff0000;
-
-

-
- - - - - -
getPixel32()method 
-
-public function getPixel32(x:int, y:int):uint -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Returns an ARGB color value that contains alpha channel data and RGB - - data. This method is similar to the getPixel() method, which returns an - - RGB color without alpha channel data. - - - -

All pixels in a BitmapData object are stored as premultiplied color values. - - A premultiplied image pixel has the red, green, and blue - - color channel values already multiplied by the alpha data. For example, if the - - alpha value is 0, the values for the RGB channels are also 0, independent of their unmultiplied - - values. This loss of data can cause some problems when you perform operations. All BitmapData - - methods take and return unmultiplied values. The internal pixel representation is converted - - from premultiplied to unmultiplied before it is returned as a value. During a set operation, - - the pixel value is premultiplied before the raw image pixel is set.

- - - Parameters - - - - - - - - - - -
x:int — The x position of the pixel. - -
 
y:int — The y position of the pixel. - - -
-

-Returns - - - - -
uint — - A number representing an ARGB pixel value. If the (x, y) coordinates are - - outside the bounds of the image, 0 is returned. - - - - -
-

-See also -

-
-getPixel() -
-setPixel32() -
-
-Example -
The following example creates a BitmapData object filled with a color, then uses the - getPixel32() method to determine the color value in the upper-left pixel, and then - determines the hexidecimal values for each color component (alpha, red, green, and blue): -
-
-
-import flash.display.BitmapData;
-
-var bmd:BitmapData = new BitmapData(80, 40, true, 0xFF44AACC);
-
-var pixelValue:uint = bmd.getPixel32(0, 0);
-var alphaValue:uint = pixelValue >> 24 & 0xFF;
-var red:uint = pixelValue >> 16 & 0xFF;
-var green:uint = pixelValue >> 8 & 0xFF;
-var blue:uint = pixelValue & 0xFF;
-
-trace(alphaValue.toString(16)); // ff
-trace(red.toString(16)); // 44
-trace(green.toString(16)); // aa
-trace(blue.toString(16)); // cc
-
-

-
- - - - - -
getPixels()method 
-
-public function getPixels(rect:Rectangle):ByteArray -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Generates a byte array from a rectangular region of pixel data. - - Writes an unsigned integer (a 32-bit unmultiplied pixel value) - - for each pixel into the byte array. - - - -

Parameters - - - - -
rect:Rectangle — A rectangular area in the current BitmapData object. - - -
-

-Returns - - - - -
ByteArray — - A ByteArray representing the pixels in the given Rectangle. - - - - - -
-
-Throws - - - - -
TypeError — The rect is null. - - - -
-

-See also -

-
-flash.utils.ByteArray -
-
-Example -
The following example creates a BitmapData object filled with random noise pixels, then uses the - getPixels() method to fill a ByteArray object with the pixel values of the BitmapData object -
-
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-import flash.utils.ByteArray;
-
-var bmd:BitmapData = new BitmapData(80, 40, true);
-var seed:int = int(Math.random() * int.MAX_VALUE);
-bmd.noise(seed);
-
-var bounds:Rectangle = new Rectangle(0, 0, bmd.width, bmd.height);
-var pixels:ByteArray = bmd.getPixels(bounds);
-
-

-
- - - - - -
getVector()method 
-
-public function getVector(rect:Rectangle):Vector.<uint> -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Generates a vector array from a rectangular region of pixel data. - - Returns a Vector object of unsigned integers (a 32-bit unmultiplied pixel value) - - for the specified rectangle. - - - - - -

Parameters - - - - -
rect:Rectangle — A rectangular area in the current BitmapData object. - - -
-

-Returns - - - - -
Vector.<uint> — A Vector representing the given Rectangle. - -
-
-Throws - - - - -
TypeError — The rect is null. - - - -
-
- - - - - -
histogram()method 
-
-public function histogram(hRect:Rectangle = null):Vector.<Vector.<Number>> -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Computes a 256-value binary number histogram of a BitmapData object. This method returns a Vector object - - containing four Vector.<Number> instances (four Vector objects that contain Number objects). - - The four Vector instances represent the red, green, blue and alpha components - - in order. Each Vector instance contains 256 values that represent the population - - count of an individual component value, from 0 to 255. - - - -

Parameters - - - - -
hRect:Rectangle (default = null) — The area of the BitmapData object to use. - - - -
-

-Returns - - - - -
Vector.<Vector.<Number>>
-
- - - - - -
hitTest()method 
-
-public function hitTest(firstPoint:Point, firstAlphaThreshold:uint, secondObject:Object, secondBitmapDataPoint:Point = null, secondAlphaThreshold:uint = 1):Boolean -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Performs pixel-level hit detection between one bitmap image - - and a point, rectangle, or other bitmap image. A hit is defined as - - an overlap of a point or rectangle over an opaque pixel, or two - - overlapping opaque pixels. No stretching, - - rotation, or other transformation of either object is considered when - - the hit test is performed. - - -

If an image is an opaque image, it is considered a fully opaque rectangle for this - - method. Both images must be transparent images to perform pixel-level hit testing that - - considers transparency. When you are testing two transparent images, the alpha threshold - - parameters control what alpha channel values, from 0 to 255, are considered opaque.

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
firstPoint:Point — A position of the upper-left corner of the BitmapData image in an arbitrary coordinate space. - - The same coordinate space is used in defining the secondBitmapPoint parameter. - - - -
 
firstAlphaThreshold:uint — The smallest alpha channel value that is considered opaque for this hit test. - - - -
 
secondObject:Object — A Rectangle, Point, Bitmap, or BitmapData object. - - - -
 
secondBitmapDataPoint:Point (default = null) — A point that defines a pixel location in the second BitmapData object. - - Use this parameter only when the value of secondObject is a - - BitmapData object. - - - -
 
secondAlphaThreshold:uint (default = 1) — The smallest alpha channel value that is considered opaque in the second BitmapData object. - - Use this parameter only when the value of secondObject is a - - BitmapData object and both BitmapData objects are transparent. - - -
-

-Returns - - - - -
Boolean — - A value of true if a hit occurs; otherwise, false. - - - - - -
-
-Throws - - - - - - - - - - -
ArgumentError — The secondObject parameter is not a Point, Rectangle, - - Bitmap, or BitmapData object. - - - -
 
TypeError — The firstPoint is null. - - - -
-
-Example -
The following example creates a BitmapData object that is only opaque in a rectangular region - (20, 20, 40, 40) and calls the hitTest() method with a Point object as the secondObject. - In the first call, the Point object defines the upper-left corner of the BitmapData object, which is not opaque, and - in the second call, the Point object defines the center of the BitmapData object, which is opaque. -
-
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-import flash.geom.Point;
-
-var bmd1:BitmapData = new BitmapData(80, 80, true, 0x00000000);
-var rect:Rectangle = new Rectangle(20, 20, 40, 40);
-bmd1.fillRect(rect, 0xFF0000FF);
-
-var pt1:Point = new Point(1, 1);
-trace(bmd1.hitTest(pt1, 0xFF, pt1)); // false
-var pt2:Point = new Point(40, 40);
-trace(bmd1.hitTest(pt1, 0xFF, pt2)); // true
-
-

-
- - - - - -
lock()method 
-
-public function lock():void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Locks an image so that any objects that reference the BitmapData object, such as Bitmap objects, - - are not updated when this BitmapData object changes. To improve performance, use this method - - along with the unlock() method before and after numerous calls to the - - setPixel() or setPixel32() method. - - - -

-See also -

-
-setPixel() -
-setPixel32() -
-unlock() -
-
-Example -
The following example creates a BitmapData object based on the - bitmapData property of a Bitmap object, picture. - It then calls the lock() method before calling a complicated custom function, - complexTransformation(), that modifies the BitmapData object. (The picture object - and the complexTransformation() function are not defined in this example.) Even if the - complexTransformation() function updates the bitmapData property of - the picture object, changes are not reflected until the code calls the - unlock() method on the bitmapData object: -
-
-import flash.display.BitmapData;
-
-var bitmapData:BitmapData = picture.bitmapData;
-bitmapData.lock();
-bitmapData = complexTransformation(bitmapData);
-bitmapData.unlock();
-picture.bitmapData = bitmapData;
-
-

-
- - - - - -
merge()method 
-
-public function merge(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redMultiplier:uint, greenMultiplier:uint, blueMultiplier:uint, alphaMultiplier:uint):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Performs per-channel blending from a source image to a destination image. For each channel - - and each pixel, a new value is computed based on the channel values of the source and destination - - pixels. For example, in the red channel, the new value is computed as follows (where redSrc - - is the red channel value for a pixel in the source image and redDest is the red channel - - value at the corresponding pixel of the destination image): - -

- - - - new redDest = [(redSrc * redMultiplier) + (redDest * (256 - redMultiplier))] / 256; - - - -

- - -

The redMultiplier, greenMultiplier, blueMultiplier, and - - alphaMultiplier values are the multipliers used for each color channel. Use a hexadecimal - - value ranging from 0 to 0x100 (256) where 0 specifies the full - - value from the destination is used in the result, 0x100 specifies the full value from the - - source is used, and numbers in between specify a blend is used (such as 0x80 for 50%).

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
sourceBitmapData:BitmapData — The input bitmap image to use. The source image can be a different - - BitmapData object, or it can refer to the current BitmapData object. - -
 
sourceRect:Rectangle — A rectangle that defines the area of the source image to use as input. - -
 
destPoint:Point — The point within the destination image (the current BitmapData - - instance) that corresponds to the upper-left corner of the source rectangle. - -
 
redMultiplier:uint — A hexadecimal uint value by which to multiply the red channel value. - -
 
greenMultiplier:uint — A hexadecimal uint value by which to multiply the green channel value. - -
 
blueMultiplier:uint — A hexadecimal uint value by which to multiply the blue channel value. - -
 
alphaMultiplier:uint — A hexadecimal uint value by which to multiply the alpha transparency value. - - - -
-
-Throws - - - - -
TypeError — The sourceBitmapData, sourceRect or destPoint are null. - - - -
-
-Example -
The following example creates two BitmapData objects. Both are 100 x 80 pixels in size. The first - is filled with green and the second is filled with red. The code calls the merge() method, merging - the second BitmapData pixels into the first BitmapData object, but only on a specified rectangular area: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-import flash.geom.Point;
-
-var bmd1:BitmapData = new BitmapData(100, 80, true, 0xFF00FF00);
-var bmd2:BitmapData = new BitmapData(100, 80, true, 0xFFFF0000);
-var rect:Rectangle = new Rectangle(0, 0, 20, 20);
-var pt:Point = new Point(20, 20);
-var mult:uint = 0x80; // 50% 
-bmd1.merge(bmd2, rect, pt, mult, mult, mult, mult);
-
-var bm1:Bitmap = new Bitmap(bmd1);
-addChild(bm1);
-var bm2:Bitmap = new Bitmap(bmd2);
-addChild(bm2);
-bm2.x = 110;
-
-

-
- - - - - -
noise()method 
-
-public function noise(randomSeed:int, low:uint = 0, high:uint = 255, channelOptions:uint = 7, grayScale:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Fills an image with pixels representing random noise. - - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
randomSeed:int — The random seed number to use. If you keep all other parameters - - the same, you can generate different pseudo-random results by varying the random seed value. The noise - - function is a mapping function, not a true random-number generation function, so it creates the same - - results each time from the same random seed. - - -
 
low:uint (default = 0) — The lowest value to generate for each channel (0 to 255). - -
 
high:uint (default = 255) — The highest value to generate for each channel (0 to 255). - -
 
channelOptions:uint (default = 7) — A number that can be a combination of any of - - the four color channel values (BitmapDataChannel.RED, - - BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, and - - BitmapDataChannel.ALPHA). You can use the logical OR - - operator (|) to combine channel values. - - - -
 
grayScale:Boolean (default = false) — A Boolean value. If the value is true, a grayscale image is created by setting - - all of the color channels to the same value. - - The alpha channel selection is not affected by - - setting this parameter to true. - - - -
-

-See also -

-
-flash.display.BitmapDataChannel.RED -
-flash.display.BitmapDataChannel.BLUE -
-flash.display.BitmapDataChannel.GREEN -
-flash.display.BitmapDataChannel.ALPHA -
-
-Example -
The following example creates two BitmapData objects and calls the noise() - method on both. However, the grayscale parameter is set to false for the - call to the noise() method of the first object, and it is set to true for the - call to the noise() method of the second object: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.display.BitmapDataChannel;
-
-var bmd1:BitmapData = new BitmapData(80, 80);
-var bmd2:BitmapData = new BitmapData(80, 80);
-
-var seed:int = int(Math.random() * int.MAX_VALUE);
-bmd1.noise(seed, 0, 0xFF, BitmapDataChannel.RED, false);
-bmd2.noise(seed, 0, 0xFF, BitmapDataChannel.RED, true);
-
-var bm1:Bitmap = new Bitmap(bmd1);
-this.addChild(bm1);
-var bm2:Bitmap = new Bitmap(bmd2);
-this.addChild(bm2);
-bm2.x = 90;
-
-

-
- - - - - -
paletteMap()method 
-
-public function paletteMap(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, redArray:Array = null, greenArray:Array = null, blueArray:Array = null, alphaArray:Array = null):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Remaps the color channel values in an image that has up to four arrays of color palette data, one - - for each channel. - - -

Flash runtimes use the following steps to - - generate the resulting image:

- - - -
    - - - -
  1. After the red, green, blue, and alpha - - values are computed, they are added together using standard 32-bit-integer arithmetic.
    2. - - - -
  2. The red, green, blue, and alpha channel values of each pixel are extracted into separate 0 to 255 values. - - These values are used to look up new color values in the appropriate array: redArray, - - greenArray, blueArray, and alphaArray. - - Each of these four arrays should contain 256 values.
    3. - - - -
  3. After all four of the new channel values are retrieved, they are combined into a standard - - ARGB value that is applied to the pixel.
    4. - - -
- - - -

Cross-channel effects can be supported with this method. - - Each input array can contain full 32-bit values, and no shifting occurs when the - - values are added together. This routine does not support per-channel - - clamping.

- - -

If no array is specified for a channel, - - the color channel is copied from the source image to the - - destination image.

- - -

You can use this method for a variety of effects such as - - general palette mapping (taking one channel and converting it - - to a false color image). You can also use this method for a variety of advanced color - - manipulation algorithms, such as gamma, curves, levels, and quantizing.

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
sourceBitmapData:BitmapData — The input bitmap image to use. The source image can be a different - - BitmapData object, or it can refer to the current BitmapData instance. - -
 
sourceRect:Rectangle — A rectangle that defines the area of the source image to use as input. - -
 
destPoint:Point — The point within the destination image (the current BitmapData - - object) that corresponds to the upper-left corner of the source rectangle. - -
 
redArray:Array (default = null) — If redArray is not null, red = redArray[source red value] - - else red = source rect value. - -
 
greenArray:Array (default = null) — If greenArray is not null, green = greenArray[source - - green value] else green = source green value. - -
 
blueArray:Array (default = null) — If blueArray is not null, blue = blueArray[source blue - - value] else blue = source blue value. - -
 
alphaArray:Array (default = null) — If alphaArray is not null, alpha = alphaArray[source - - alpha value] else alpha = source alpha value. - - - - - -
-
-Throws - - - - -
TypeError — The sourceBitmapData, sourceRect or destPoint are null. - - - -
-
-Example -
The following example creates a green BitmapData object with a red center square, and then - uses the paletteMap() method to swap red with green in the bottom rectangular half of the - BitmapData object: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-import flash.geom.Point;
-
-var myBitmapData:BitmapData = new BitmapData(80, 80, false, 0x00FF0000);
-myBitmapData.fillRect(new Rectangle(20, 20, 40, 40), 0x0000FF00);
-
-var redArray:Array = new Array(256);
-var greenArray:Array = new Array(256);
-
-for(var i:uint = 0; i < 255; i++) {
-    redArray[i] = 0x00000000;
-	greenArray[i] = 0x00000000;
-}
-
-redArray[0xFF] = 0x0000FF00;
-greenArray[0xFF] = 0x00FF0000;
-
-var bottomHalf:Rectangle = new Rectangle(0, 0, 100, 40);
-var pt:Point = new Point(0, 0);
-myBitmapData.paletteMap(myBitmapData, bottomHalf, pt, redArray, greenArray);
-
-var bm1:Bitmap = new Bitmap(myBitmapData);
-addChild(bm1);
-
-

-
- - - - - -
perlinNoise()method 
-
-public function perlinNoise(baseX:Number, baseY:Number, numOctaves:uint, randomSeed:int, stitch:Boolean, fractalNoise:Boolean, channelOptions:uint = 7, grayScale:Boolean = false, offsets:Array = null):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Generates a Perlin noise image. - - -

The Perlin noise generation algorithm interpolates and combines individual random noise functions (called octaves) - - into a single function that generates more natural-seeming random noise. Like musical octaves, each octave function is twice the - - frequency of the one before it. Perlin noise has been described as a "fractal sum of noise" because it combines multiple sets of noise data - - with different levels of detail.

- - -

You can use Perlin noise functions to simulate natural - - phenomena and landscapes, such as wood grain, clouds, and mountain ranges. In most cases, the output of a Perlin noise function - - is not displayed directly but is used to enhance other images and give them pseudo-random variations.

- - -

Simple digital random noise functions often produce images with harsh, contrasting points. This kind of harsh contrast - - is not often found in nature. The Perlin noise algorithm blends multiple noise functions that operate at different levels of detail. - - This algorithm results in smaller variations among neighboring pixel values.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
baseX:Number — Frequency to use in the x direction. For example, to generate a noise that - - is sized for a 64 x 128 image, pass 64 for the baseX value. - - -
 
baseY:Number — Frequency to use in the y direction. For example, to generate a noise that - - is sized for a 64 x 128 image, pass 128 for the baseY value. - - -
 
numOctaves:uint — Number of octaves or individual noise functions to combine to create this noise. Larger numbers of octaves create - - images with greater detail. Larger numbers of octaves also require more processing time. - - -
 
randomSeed:int — The random seed number to use. If you keep all other parameters the same, you can generate different - - pseudo-random results by varying the random seed value. The Perlin noise function is a mapping function, not a - - true random-number generation function, so it creates the same results each time from the same random seed. - - -
 
stitch:Boolean — A Boolean value. If the value is true, the method attempts to smooth the transition edges of the image to create seamless textures for - - tiling as a bitmap fill. - - -
 
fractalNoise:Boolean — A Boolean value. If the value is true, the method generates fractal noise; otherwise, - - it generates turbulence. An image with turbulence has visible discontinuities in the gradient - - that can make it better approximate sharper visual effects like flames and ocean waves. - - -
 
channelOptions:uint (default = 7) — A number that can be a combination of any of - - the four color channel values (BitmapDataChannel.RED, - - BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, and - - BitmapDataChannel.ALPHA). You can use the logical OR - - operator (|) to combine channel values. - - -
 
grayScale:Boolean (default = false) — A Boolean value. If the value is true, a grayscale image is created by setting - - each of the red, green, and blue color channels to - - identical values. The alpha channel value is not affected if this value is - - set to true. - - -
 
offsets:Array (default = null) — An array of points that correspond to x and y offsets for each octave. - - By manipulating the offset values you can smoothly scroll the layers of a perlinNoise image. - - Each point in the offset array affects a specific octave noise function. - - - - - -
-
-Example -
The following example creates a 200 x 200 pixel BitmapData object that calls the - perlinNoise() method to generate a red and blue watercolor effect: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-
-var bmd:BitmapData = new BitmapData(200, 200, false, 0x00CCCCCC);
-
-var seed:Number = Math.floor(Math.random() * 10);
-var channels:uint = BitmapDataChannel.RED | BitmapDataChannel.BLUE;
-bmd.perlinNoise(100, 80, 6, seed, false, true, channels, false, null);
-
-var bm:Bitmap = new Bitmap(bmd);
-addChild(bm);
-
-

-
- - - - - -
pixelDissolve()method 
-
-public function pixelDissolve(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, randomSeed:int = 0, numPixels:int = 0, fillColor:uint = 0):int -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Performs a pixel dissolve either from a source image to a destination image or by using the same image. - - Flash runtimes use a randomSeed value - - to generate a random pixel dissolve. The return value - - of the function must be passed in on subsequent calls to - - continue the pixel dissolve until it is finished. - - -

If the source image does not equal the destination image, - - pixels are copied from the source to the destination by using all of the - - properties. This process allows dissolving from a blank image into a - - fully populated image.

- - -

If the source and destination images are equal, pixels are - - filled with the color parameter. This process allows dissolving away - - from a fully populated image. In this mode, the destination - - point parameter is ignored.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
sourceBitmapData:BitmapData — The input bitmap image to use. The source image can be a different - - BitmapData object, or it can refer to the current BitmapData instance. - - -
 
sourceRect:Rectangle — A rectangle that defines the area of the source image to use as input. - - -
 
destPoint:Point — The point within the destination image (the current BitmapData - - instance) that corresponds to the upper-left corner of the source rectangle. - - -
 
randomSeed:int (default = 0) — The random seed to use to start the pixel dissolve. - - -
 
numPixels:int (default = 0) — The default is 1/30 of the source area (width x height). - - -
 
fillColor:uint (default = 0) — An ARGB color value that you use to fill pixels whose - - source value equals its destination value. - - - -
-

-Returns - - - - -
int — - The new random seed value to use for subsequent calls. - - - - - -
-
-Throws - - - - - - - - - - -
TypeError — The sourceBitmapData, sourceRect or destPoint are null. - -
 
TypeError — The numPixels value is negative - - - -
-
-Example -
The following example uses the pixelDissolve() - method to convert a grey BitmapData object to a red one by dissolving - 40 pixels at a time until all pixels have changed colors: -
-
-import flash.display.BitmapData;
-import flash.display.Bitmap;
-import flash.geom.Point;
-import flash.geom.Rectangle;
-import flash.utils.Timer;
-import flash.events.TimerEvent;
-
-var bmd:BitmapData = new BitmapData(100, 80, false, 0x00CCCCCC);
-var bitmap:Bitmap = new Bitmap(bmd);
-addChild(bitmap);
-
-var tim:Timer = new Timer(20);
-tim.start();
-tim.addEventListener(TimerEvent.TIMER, timerHandler);
- 
-function timerHandler(event:TimerEvent):void {
-    var randomNum:Number = Math.floor(Math.random() * int.MAX_VALUE);
-    dissolve(randomNum);
-}
-
-function dissolve(randomNum:Number):void {
-    var rect:Rectangle = bmd.rect;
-	var pt:Point = new Point(0, 0);
-	var numberOfPixels:uint = 100;
-	var red:uint = 0x00FF0000;
-	bmd.pixelDissolve(bmd, rect, pt, randomNum, numberOfPixels, red);
-	var grayRegion:Rectangle = bmd.getColorBoundsRect(0xFFFFFFFF, 0x00CCCCCC, true);
-	if(grayRegion.width == 0 && grayRegion.height == 0 ) {
-		tim.stop();
-	}
-}
-
-

-
- - - - - -
scroll()method 
-
-public function scroll(x:int, y:int):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Scrolls an image by a certain (x, y) pixel amount. Edge - - regions outside the scrolling area are left unchanged. - - - -

Parameters - - - - - - - - - - -
x:int — The amount by which to scroll horizontally. - -
 
y:int — The amount by which to scroll vertically. - - - -
-
-Example -
The following example shows the effect of scrolling a Bitmap data object 40 pixels to the right: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.geom.Rectangle;
-
-var bmd:BitmapData = new BitmapData(80, 80, true, 0xFFCCCCCC);
-var rect:Rectangle = new Rectangle(0, 0, 40, 40);
-bmd.fillRect(rect, 0xFFFF0000);
-    		
-var bm:Bitmap = new Bitmap(bmd);
-addChild(bm);
-
-trace (bmd.getPixel32(50, 20).toString(16)); // ffcccccccc
-
-bmd.scroll(30, 0); 
-
-trace (bmd.getPixel32(50, 20).toString(16)); // ffff0000
-
-

-
- - - - - -
setPixel()method 
-
-public function setPixel(x:int, y:int, color:uint):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets a single pixel of a BitmapData object. The current - - alpha channel value of the image pixel is preserved during this - - operation. The value of the RGB color parameter is treated as an unmultiplied color value. - - - -

Note: To increase performance, when you use the setPixel() or - - setPixel32() method repeatedly, call the lock() method before - - you call the setPixel() or setPixel32() method, and then call - - the unlock() method when you have made all pixel changes. This process prevents objects - - that reference this BitmapData instance from updating until you finish making - - the pixel changes.

- - - - Parameters - - - - - - - - - - - - - - - - -
x:int — The x position of the pixel whose value changes. - -
 
y:int — The y position of the pixel whose value changes. - - -
 
color:uint — The resulting RGB color for the pixel. - - -
-

-See also -

-
-getPixel() -
-setPixel32() -
-lock() -
-unlock() -
-
-Example -
The following example uses the setPixel() - method to draw a red line in a BitmapData object: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-
-var bmd:BitmapData = new BitmapData(80, 80, false, 0xCCCCCC);
-
-for (var i:uint = 0; i < 80; i++) {
-    var red:uint = 0xFF0000;
-	bmd.setPixel(i, 40, red);
-}
-
-var bm:Bitmap = new Bitmap(bmd);
-addChild(bm);
-
-

-
- - - - - -
setPixel32()method 
-
-public function setPixel32(x:int, y:int, color:uint):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Sets the color and alpha transparency values of a single pixel of a BitmapData - - object. This method is similar to the setPixel() method; the main difference is - - that the setPixel32() method takes an - - ARGB color value that contains alpha channel information. - - - -

All pixels in a BitmapData object are stored as premultiplied color values. - - A premultiplied image pixel has the red, green, and blue - - color channel values already multiplied by the alpha data. For example, if the - - alpha value is 0, the values for the RGB channels are also 0, independent of their unmultiplied - - values. This loss of data can cause some problems when you perform operations. All BitmapData - - methods take and return unmultiplied values. The internal pixel representation is converted - - from premultiplied to unmultiplied before it is returned as a value. During a set operation, - - the pixel value is premultiplied before the raw image pixel is set.

- - -

Note: To increase performance, when you use the setPixel() or - - setPixel32() method repeatedly, call the lock() method before - - you call the setPixel() or setPixel32() method, and then call - - the unlock() method when you have made all pixel changes. This process prevents objects - - that reference this BitmapData instance from updating until you finish making - - the pixel changes.

- - - - Parameters - - - - - - - - - - - - - - - - -
x:int — The x position of the pixel whose value changes. - -
 
y:int — The y position of the pixel whose value changes. - -
 
color:uint — The resulting ARGB color for the pixel. If the bitmap is opaque - - (not transparent), the alpha transparency portion of this color value is ignored. - - -
-

-See also -

-
-setPixel() -
-getPixel32() -
-lock() -
-unlock() -
-
-Example -
The following example uses the setPixel32() - method to draw a transparent (alpha == 0x60) red line in a BitmapData object: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-
-var bmd:BitmapData = new BitmapData(80, 80, true, 0xFFCCCCCC);
-
-for (var i:uint = 0; i < 80; i++) {
-    var red:uint = 0x60FF0000;
-	bmd.setPixel32(i, 40, red);
-}
-
-var bm:Bitmap = new Bitmap(bmd);
-addChild(bm);
-
-

-
- - - - - -
setPixels()method 
-
-public function setPixels(rect:Rectangle, inputByteArray:ByteArray):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Converts a byte array into a rectangular region of pixel data. For each - - pixel, the ByteArray.readUnsignedInt() method is called and the return value is - - written into the pixel. If the byte array ends before the full rectangle - - is written, the function returns. The data in the byte array is - - expected to be 32-bit ARGB pixel values. No seeking is performed - - on the byte array before or after the pixels are read. - - - -

Parameters - - - - - - - - - - -
rect:Rectangle — Specifies the rectangular region of the BitmapData object. - - - -
 
inputByteArray:ByteArray — A ByteArray object that consists of 32-bit unmultiplied pixel values - - to be used in the rectangular region. - - - -
-
-Throws - - - - - - - - - - -
Error — The inputByteArray object does not include enough data - - to fill the area of the rect rectangle. The method fills as many pixels as - - possible before throwing the exception. - - - -
 
TypeError — The rect or inputByteArray are null. - - - -
-

-See also -

-
-flash.utils.ByteArray.readUnsignedInt() -
-
-Example -
The following example uses the getPixels() and - setPixels() methods to copy pixels from one BitmapData object to another: -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.utils.ByteArray;
-import flash.geom.Rectangle;
-
-var bmd1:BitmapData = new BitmapData(100, 100, true, 0xFFCCCCCC);
-var bmd2:BitmapData = new BitmapData(100, 100, true, 0xFFFF0000);
-
-var rect:Rectangle = new Rectangle(0, 0, 100, 100);
-var bytes:ByteArray = bmd1.getPixels(rect);
-
-bytes.position = 0;
-bmd2.setPixels(rect, bytes);
-
-var bm1:Bitmap = new Bitmap(bmd1);
-addChild(bm1);
-var bm2:Bitmap = new Bitmap(bmd2);
-addChild(bm2);
-bm2.x = 110;
-
-

-
- - - - - -
setVector()method 
-
-public function setVector(rect:Rectangle, inputVector:Vector.<uint>):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Converts a Vector into a rectangular region of pixel data. For each pixel, a Vector element is read - - and written into the BitmapData pixel. The data in the Vector is expected to be 32-bit ARGB pixel values. - - - -

Parameters - - - - - - - - - - -
rect:Rectangle — Specifies the rectangular region of the BitmapData object. - - - -
 
inputVector:Vector.<uint> — A Vector object that consists of 32-bit unmultiplied pixel values to be used - - in the rectangular region. - - - -
-
-Throws - - - - -
RangeError — The vector array is not large enough to read all the pixel data. - -
-
- - - - - -
threshold()method 
-
-public function threshold(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, operation:String, threshold:uint, color:uint = 0, mask:uint = 0xFFFFFFFF, copySource:Boolean = false):uint -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0
-

- - Tests pixel values in an image against a specified threshold and sets pixels that pass the test to new color values. - - Using the threshold() method, you can isolate and replace color ranges in an image and perform other - - logical operations on image pixels. - - - -

The threshold() method's test logic is as follows:

- - - -
    - - - -
  1. If ((pixelValue & mask) operation (threshold & mask)), then - - set the pixel to color;
    2. - - - -
  2. Otherwise, if copySource == true, then - - set the pixel to corresponding pixel value from sourceBitmap.
    3. - -
- - - -

The operation parameter specifies the comparison operator to use for the threshold test. - - For example, by using "==" as the operation parameter, you - - can isolate a specific color value in an image. Or by using {operation: - - "<", mask: 0xFF000000, threshold: 0x7F000000, color: - - 0x00000000}, you can set all destination pixels to be fully transparent - - when the source image pixel's alpha is less than 0x7F. You can use this technique - - for animated transitions and other effects.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
sourceBitmapData:BitmapData — The input bitmap image to use. The source image can be a different - - BitmapData object or it can refer to the current BitmapData instance. - - -
 
sourceRect:Rectangle — A rectangle that defines the area of the source image to use as input. - - -
 
destPoint:Point — The point within the destination image (the current BitmapData - - instance) that corresponds to the upper-left corner of the source rectangle. - - -
 
operation:String — One of the following comparison operators, passed as a String: "<", "<=", ">", ">=", "==", "!=" - - -
 
threshold:uint — The value that each pixel is tested against to see if it meets or exceeds the threshhold. - - -
 
color:uint (default = 0) — The color value that a pixel is set to if the threshold test succeeds. The default value is 0x00000000. - - -
 
mask:uint (default = 0xFFFFFFFF) — The mask to use to isolate a color component. - - -
 
copySource:Boolean (default = false) — If the value is true, pixel values from the source image are copied to the destination - - when the threshold test fails. If the value is false, the source image is not copied when the - - threshold test fails. - - - -
-

-Returns - - - - -
uint — - The number of pixels that were changed. - - - -
-
-Throws - - - - - - - - - - -
TypeError — The sourceBitmapData, sourceRect destPoint or operation are null. - -
 
ArgumentError — The operation string is not a valid operation - - - -
-
-Example -
The following example uses the perlinNoise() method to - add a blue and red pattern to one BitmapData object, and then uses the threshold() - method to copy those pixels from the first BitmapData object to a second one, replacing those pixels - in which the red value is greater than 0x80 (50%) with a pixel set to transparent red (0x20FF0000): -
-
-
-import flash.display.Bitmap;
-import flash.display.BitmapData;
-import flash.display.BitmapDataChannel;
-import flash.geom.Point;
-import flash.geom.Rectangle;
-
-var bmd1:BitmapData = new BitmapData(200, 200, true, 0xFFCCCCCC);
-
-var seed:int = int(Math.random() * int.MAX_VALUE);
-var channels:uint = BitmapDataChannel.RED | BitmapDataChannel.BLUE;
-bmd1.perlinNoise(100, 80, 12, seed, false, true, channels, false, null);
-
-var bitmap1:Bitmap = new Bitmap(bmd1);
-addChild(bitmap1);
-
-var bmd2:BitmapData = new BitmapData(200, 200, true, 0xFFCCCCCC);
-var pt:Point = new Point(0, 0);
-var rect:Rectangle = new Rectangle(0, 0, 200, 200);
-var threshold:uint =  0x00800000; 
-var color:uint = 0x20FF0000;
-var maskColor:uint = 0x00FF0000;
-bmd2.threshold(bmd1, rect, pt, ">", threshold, color, maskColor, true);
-
-var bitmap2:Bitmap = new Bitmap(bmd2);
-bitmap2.x = bitmap1.x + bitmap1.width + 10;
-addChild(bitmap2);
-
-

-
- - - - - -
unlock()method 
-
-public function unlock(changeRect:Rectangle = null):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Unlocks an image so that any objects that reference the BitmapData object, such as Bitmap objects, - - are updated when this BitmapData object changes. To improve performance, use this method - - along with the lock() method before and after numerous calls to the - - setPixel() or setPixel32() method. - - - -

Parameters - - - - -
changeRect:Rectangle (default = null) — The area of the BitmapData object that has changed. If you do not specify a value for - - this parameter, the entire area of the BitmapData object is considered - - changed. This parameter requires Flash Player version 9.0.115.0 or later. - - - -
-

-See also -

-
-lock() -
-setPixel() -
-setPixel32() -
-
-Example -
The following example creates a BitmapData object based on the - bitmapData property of a Bitmap object, picture. - It then calls the lock() method before calling a complicated custom function, - complexTransformation(), that modifies the BitmapData object. (The picture object - and the complexTransformation() function are not defined in this example.) Even if the - complexTransformation() function updates the bitmapData property of - the picture object, changes are not reflected until the code calls the - unlock() method on the bitmapData object: -
-
-import flash.display.BitmapData;
-
-var bitmapData:BitmapData = picture.bitmapData;
-bitmapData.lock();
-bitmapData = complexTransformation(bitmapData);
-bitmapData.unlock();
-picture.bitmapData = bitmapData;
-
-

-
- -
Examples
-
examples\BitmapDataExample
-
The following example uses the class BitmapDataExample to load the - image Image.gif into a DisplayObject in the default location (0, 0). A copy - of Image.gif is then placed to the right of the original, which has new colors applied to pixels - that pass a test using the threshold() method. - The task is accomplished using the following steps: -
    -
  1. A url property is created, which is the location and name of the image file
    2. -
  2. The class constructor creates a Loader object, which then instantiates an event listener, - which is dispatched when the completeHandler() method completes the image manipulation.
    3. -
  3. The request URLRequest object is then passed to loader.load(), which loads the image - into memory by using a display object.
    4. -
  4. The image is then placed on the display list, which displays the image on screen at - coordinates x = 0, y = 0.
    5. -
  5. The completeHandler() method then does the following: -
      -
    • Creates a second Loader, along with a Bitmap object, which is initialized with the - Loader object.
      • -
    • Creates a second Bitmap object, duplicate, which in turn calls the - duplicateImage() method, which creates a duplicate of the original image.
      • -
    • Creates a BitmapData object that is assigned to the duplicate object's - BitmapData object.
      • -
    • Creates a new Rectangle object initialized with the same coordinates, width, and height - as the original image.
      • -
    • Creates a new Point object, which defaults to x = 0, y = 0.
      • -
    • Creates the following variables: -
        -
      • operation — Applies the new color when the threshold - value is greater than or equal to the original.
        • -
      • threshold — The value against which each pixel is compared (in this example, - light gray with an alpha of 0xCC).
        • -
      • color — The color that the pixels are set to that pass the threshold - test, which is solid yellow in this case.
        • -
      • mask — The exact opposite of color (transparent blue).
        • -
      • copySource — Set to false, indicating the pixel values are - not copied if the threshold value does not pass. This value has no meaning because - the image is duplicated and only pixels that pass the threshold test are changed.
        • -
      • -
    • Calls the threshold() method using the preceding variables. The resulting threshold - equation is as follows: if (current pixel Value & 0x000000FF) >= - (0xCCCCCCCC & 0x000000FF) then set pixel to 0xFFFFFF00.
      • -
    6. -
- -

Notes: -

    -
  • You will need to compile the SWF file with Local Playback Security set to Access Local Files Only. -
    • -
  • This example requires that a file named Image.gif be placed in the same directory as your SWF file. -
    • -
  • It is recommended that you use an image of up to approximately 80 pixels in width.
    • -
-

-
-
-
-package {
-    import flash.display.Bitmap;
-    import flash.display.BitmapData;
-    import flash.display.Loader;
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.geom.Point;
-    import flash.geom.Rectangle;
-    import flash.net.URLRequest;
-
-    public class BitmapDataExample extends Sprite {
-        private var url:String = "Image.gif";
-        private var size:uint = 80;
-
-        public function BitmapDataExample() {
-            configureAssets();
-        }
-
-        private function configureAssets():void {
-            var loader:Loader = new Loader();
-            loader.contentLoaderInfo.addEventListener(Event.COMPLETE, completeHandler);
-            loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-
-            var request:URLRequest = new URLRequest(url);
-            loader.x = size * numChildren;
-            loader.load(request);
-            addChild(loader);
-        }
-
-        private function duplicateImage(original:Bitmap):Bitmap {
-            var image:Bitmap = new Bitmap(original.bitmapData.clone());
-            image.x = size * numChildren;
-            addChild(image);
-            return image;
-        }
-
-        private function completeHandler(event:Event):void {
-            var loader:Loader = Loader(event.target.loader);
-            var image:Bitmap = Bitmap(loader.content);
-
-            var duplicate:Bitmap = duplicateImage(image);
-            var bitmapData:BitmapData = duplicate.bitmapData;
-            var sourceRect:Rectangle = new Rectangle(0, 0, bitmapData.width, bitmapData.height);
-            var destPoint:Point = new Point();
-            var operation:String = ">=";
-            var threshold:uint = 0xCCCCCCCC;
-            var color:uint = 0xFFFFFF00;
-            var mask:uint = 0x000000FF;
-            var copySource:Boolean = true;
-
-            bitmapData.threshold(bitmapData,
-                                 sourceRect,
-                                 destPoint,
-                                 operation,
-                                 threshold,
-                                 color,
-                                 mask,
-                                 copySource);
-        }
-        
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("Unable to load image: " + url);
-        }
-    }
-}
-
-
-
examples\BitmapDataExample2
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Jul 3 2024, 9:16 AM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/BitmapDataChannel.html b/html-docs/flash/display/BitmapDataChannel.html deleted file mode 100644 index 9044bf8..0000000 --- a/html-docs/flash/display/BitmapDataChannel.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - - - - -flash.display.BitmapDataChannel (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class BitmapDataChannel
InheritanceBitmapDataChannel Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The BitmapDataChannel class is an enumeration of constant values that indicate which channel to -use: red, blue, green, or alpha transparency. -

When you call some methods, you can use the bitwise OR operator (|) -to combine BitmapDataChannel constants to indicate multiple color channels.

- -

The BitmapDataChannel constants are provided for use as values in the following:

- -
    - -
  • The sourceChannel and destChannel parameters of the - flash.display.BitmapData.copyChannel() method
    • - -
  • The channelOptions parameter of the - flash.display.BitmapData.noise() method
    • - -
  • The flash.filters.DisplacementMapFilter.componentX and - flash.filters.DisplacementMapFilter.componentY properties
    • - -
- -

-

-See also -

-
-flash.display.BitmapData.copyChannel() -
-flash.display.BitmapData.noise() -
-flash.filters.DisplacementMapFilter.componentX -
-flash.filters.DisplacementMapFilter.componentY -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  ALPHA : uint = 8
[static] - The alpha channel.
-		BitmapDataChannel
  BLUE : uint = 4
[static] - The blue channel.
-		BitmapDataChannel
  GREEN : uint = 2
[static] - The green channel.
-		BitmapDataChannel
  RED : uint = 1
[static] - The red channel.
-		BitmapDataChannel
-
- -
- -
Constant detail
- - - - - -
ALPHAconstant
-
-public static const ALPHA:uint = 8 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The alpha channel. - -

- - - - - -
BLUEconstant 
-
-public static const BLUE:uint = 4 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The blue channel. - -

- - - - - -
GREENconstant 
-
-public static const GREEN:uint = 2 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The green channel. - -

- - - - - -
REDconstant 
-
-public static const RED:uint = 1 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The red channel. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/BitmapEncodingColorSpace.html b/html-docs/flash/display/BitmapEncodingColorSpace.html deleted file mode 100644 index 01caa83..0000000 --- a/html-docs/flash/display/BitmapEncodingColorSpace.html +++ /dev/null @@ -1,342 +0,0 @@ - - - - - - - - -flash.display.BitmapEncodingColorSpace (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class BitmapEncodingColorSpace
InheritanceBitmapEncodingColorSpace Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

-

- The BitmapEncodingColorSpace class defines the constants that specify how color channels are sampled - by the flash.display.BitmapData.encode() method when specifying the compressor as - flash.display.JPEGXREncoderOptions. -

For more information on these constants, see - http://en.wikipedia.org/wiki/Chroma_subsampling.

-

-

-See also -

-
-flash.display.BitmapData -
-flash.display.BitmapData.encode() -
-flash.display.JPEGXREncoderOptions -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  COLORSPACE_4_2_0 : String = "4:2:0"
[static] - Specifies a subsampling scheme of 4:2:0.
-		BitmapEncodingColorSpace
  COLORSPACE_4_2_2 : String = "4:2:2"
[static] - Specifies a subsampling scheme of 4:2:2.
-		BitmapEncodingColorSpace
  COLORSPACE_4_4_4 : String = "4:4:4"
[static] - Specifies a subsampling scheme of 4:4:4.
-		BitmapEncodingColorSpace
  COLORSPACE_AUTO : String = "auto"
[static] - Specifies a subsampling scheme of auto.
-		BitmapEncodingColorSpace
-
- -
- -
Constant detail
- - - - - -
COLORSPACE_4_2_0constant
-
-public static const COLORSPACE_4_2_0:String = "4:2:0" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Specifies a subsampling scheme of 4:2:0. -

- - - - - -
COLORSPACE_4_2_2constant 
-
-public static const COLORSPACE_4_2_2:String = "4:2:2" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Specifies a subsampling scheme of 4:2:2. -

- - - - - -
COLORSPACE_4_4_4constant 
-
-public static const COLORSPACE_4_4_4:String = "4:4:4" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Specifies a subsampling scheme of 4:4:4. -

- - - - - -
COLORSPACE_AUTOconstant 
-
-public static const COLORSPACE_AUTO:String = "auto" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Specifies a subsampling scheme of auto. - The auto scheme depends on the image that you are compressing, - but has a default of 4:2:0. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/BlendMode.html b/html-docs/flash/display/BlendMode.html deleted file mode 100644 index 9c0affa..0000000 --- a/html-docs/flash/display/BlendMode.html +++ /dev/null @@ -1,745 +0,0 @@ - - - - - - - - -flash.display.BlendMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class BlendMode
InheritanceBlendMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-A class that provides constant values for visual blend mode effects. These constants are used in the following: - -
    - -
  • The blendMode property of the flash.display.DisplayObject class.
    • - -
  • The blendMode parameter of the draw() method of the - flash.display.BitmapData class
    • -
- -

-

-See also -

-
-flash.display.DisplayObject.blendMode -
-flash.display.BitmapData.draw() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ADD : String = "add"
[static] -Adds the values of the constituent colors of the display object to the colors of its background, applying a -ceiling of 0xFF.
-		BlendMode
  ALPHA : String = "alpha"
[static] -Applies the alpha value of each pixel of the display object to the background.
-		BlendMode
  DARKEN : String = "darken"
[static] -Selects the darker of the constituent colors of the display object and the colors of the background (the -colors with the smaller values).
-		BlendMode
  DIFFERENCE : String = "difference"
[static] -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.
-		BlendMode
  ERASE : String = "erase"
[static] -Erases the background based on the alpha value of the display object.
-		BlendMode
  HARDLIGHT : String = "hardlight"
[static] -Adjusts the color of each pixel based on the darkness of the display object.
-		BlendMode
  INVERT : String = "invert"
[static] -Inverts the background.
-		BlendMode
  LAYER : String = "layer"
[static] -Forces the creation of a transparency group for the display object.
-		BlendMode
  LIGHTEN : String = "lighten"
[static] -Selects the lighter of the constituent colors of the display object and the colors of the background (the -colors with the larger values).
-		BlendMode
  MULTIPLY : String = "multiply"
[static] -Multiplies the values of the display object constituent colors by the constituent colors of -the background color, and normalizes by dividing by 0xFF, -resulting in darker colors.
-		BlendMode
  NORMAL : String = "normal"
[static] -The display object appears in front of the background.
-		BlendMode
  OVERLAY : String = "overlay"
[static] -Adjusts the color of each pixel based on the darkness of the background.
-		BlendMode
  SCREEN : String = "screen"
[static] -Multiplies the complement (inverse) of the display object color by the complement of the background -color, resulting in a bleaching effect.
-		BlendMode
  SHADER : String = "shader"
[static] -Uses a shader to define the blend between objects.
-		BlendMode
  SUBTRACT : String = "subtract"
[static] -Subtracts the values of the constituent colors in the display object from the values of the background -color, applying a floor of 0.
-		BlendMode
-
- -
- -
Constant detail
- - - - - -
ADDconstant
-
-public static const ADD:String = "add" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-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. - -

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).

-
- - - - - -
ALPHAconstant 
-
-public static const ALPHA:String = "alpha" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Applies the alpha value of each pixel of the display object to the background. -This requires the blendMode property of the parent display object be set to -flash.display.BlendMode.LAYER. - -

Not supported under GPU rendering.

- -
- - - - - -
DARKENconstant 
-
-public static const DARKEN:String = "darken" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-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. - -

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.

- -
- - - - - -
DIFFERENCEconstant 
-
-public static const DIFFERENCE:String = "difference" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-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. - -

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).

-
- - - - - -
ERASEconstant 
-
-public static const ERASE:String = "erase" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Erases the background based on the alpha value of the display object. This process requires -that the blendMode property of the parent display object be set to -flash.display.BlendMode.LAYER. - -

Not supported under GPU rendering.

- -
- - - - - -
HARDLIGHTconstant 
-
-public static const HARDLIGHT:String = "hardlight" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-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.

- -
- - - - - -
INVERTconstant 
-
-public static const INVERT:String = "invert" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Inverts the background. -

- - - - - -
LAYERconstant 
-
-public static const LAYER:String = "layer" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Forces the creation of a transparency group for the display object. This means that the display -object is precomposed in a temporary buffer before it is processed further. The precomposition is done -automatically if the display object is precached by means of bitmap caching or if the display object is -a display object container that has at least one child object with a blendMode -setting other than "normal". - -

Not supported under GPU rendering.

- -
- - - - - -
LIGHTENconstant 
-
-public static const LIGHTEN:String = "lighten" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Selects the lighter of the constituent colors of the display object and the colors of the background (the -colors with the larger values). This setting is commonly used for superimposing type. - -

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.

- -
- - - - - -
MULTIPLYconstant 
-
-public static const MULTIPLY:String = "multiply" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Multiplies the values of the display object constituent colors by the constituent colors of -the background color, and normalizes by dividing by 0xFF, -resulting in darker colors. This setting is commonly used for shadows and depth effects. -

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.

-
- - - - - -
NORMALconstant 
-
-public static const NORMAL:String = "normal" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-The display object appears in front of the background. Pixel values of the display object -override the pixel values of the background. Where the display object is transparent, the -background is visible. - -

- - - - - -
OVERLAYconstant 
-
-public static const OVERLAY:String = "overlay" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-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.

- -
- - - - - -
SCREENconstant 
-
-public static const SCREEN:String = "screen" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-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. -

- - - - - -
SHADERconstant 
-
-public static const SHADER:String = "shader" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-Uses a shader to define the blend between objects. - -

Setting the blendShader property to a Shader instance -automatically sets the display object's blendMode property to -BlendMode.SHADER. If the blendMode property is set to -BlendMode.SHADER without first setting the blendShader property, -the blendMode property is set to BlendMode.NORMAL instead. -If the blendShader property is set (which sets the -blendMode property to BlendMode.SHADER), then later the value of the -blendMode property is changed, the blend mode can be reset to use the blend -shader simply by setting the blendMode property to BlendMode.SHADER. -The blendShader property does not need to be set again except to change the -shader that's used to define the blend mode.

- -

Not supported under GPU rendering.

- - -

-See also -

-
-flash.display.DisplayObject.blendMode -
-flash.display.DisplayObject.blendShader -
-flash.display.Shader -
-
- - - - - -
SUBTRACTconstant 
-
-public static const SUBTRACT:String = "subtract" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-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. - -

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).

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/CapsStyle.html b/html-docs/flash/display/CapsStyle.html deleted file mode 100644 index 000cb2a..0000000 --- a/html-docs/flash/display/CapsStyle.html +++ /dev/null @@ -1,423 +0,0 @@ - - - - - - - - -flash.display.CapsStyle (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class CapsStyle
InheritanceCapsStyle Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The CapsStyle class is an enumeration of constant values that specify the caps style to use in drawing lines. - The constants are provided for use as values in the caps parameter of the - flash.display.Graphics.lineStyle() method. You can specify the following three types of caps: - -

The three types of caps: NONE, ROUND, and SQUARE.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.Graphics.lineStyle() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  NONE : String = "none"
[static] - - Used to specify no caps in the caps parameter of the - flash.display.Graphics.lineStyle() method.
-		CapsStyle
  ROUND : String = "round"
[static] - - Used to specify round caps in the caps parameter of the - flash.display.Graphics.lineStyle() method.
-		CapsStyle
  SQUARE : String = "square"
[static] - - Used to specify square caps in the caps parameter of the - flash.display.Graphics.lineStyle() method.
-		CapsStyle
-
- -
- -
Constant detail
- - - - - -
NONEconstant
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- - Used to specify no caps in the caps parameter of the - flash.display.Graphics.lineStyle() method. - -

- - - - - -
ROUNDconstant 
-
-public static const ROUND:String = "round" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- - Used to specify round caps in the caps parameter of the - flash.display.Graphics.lineStyle() method. - -

- - - - - -
SQUAREconstant 
-
-public static const SQUARE:String = "square" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- - Used to specify square caps in the caps parameter of the - flash.display.Graphics.lineStyle() method. - -

- -
Examples
-
examples\CapsStyleExample
-
The following example uses the CapsStyleExample class to draw three - parallel lines, each with a different line cap style. -
    -
  1. The properties of each line are set as follows: -
      -
    • The line length is set to 80 pixels.
      • -
    • The border color is set to orange.
      • -
    • The border size is set to 30 pixels.
      • -
    • The highlight color is set to gray.
      • -
    • The highlight size is set to 0 pixels.
      • -
    • The alpha is set to 1, making it solid.
      • -
    • The pixel hinting is set to false (strokes not hinted to full pixels).
      • -
    • The line scale mode is set to normal, which scales the thickness.
      • -
    • The joint style of the border caps are set to MITER.
      • -
    • The miter limit is set to 1, indicating that the miter is cut off close to the line.
      • -
    2. -
  2. The class constructor creates three vertical lines, starting at x = 0, y = 0 by calling - the drawLine() method three times using the three different line cap styles (none, - round, and square). Each of the three calls to the drawLine() method uses the cap style and - properties listed previously to draw a vertical line and associated line highlight. The calls - first create a new child Shape object and then use methods of the Graphics - class to set the line style and draw the lines and highlights. Each instance of child - is added to the display list and drawn on the stage.
    3. -
  3. The connected line segments are redrawn by using the refreshLayout() method at y = 80 - pixels and starting at x = 80 pixels, with a 25-pixel separation between the line segments.
    4. -
-
-
-package {
-    import flash.display.CapsStyle;
-    import flash.display.DisplayObject;
-    import flash.display.Graphics;
-    import flash.display.JointStyle;
-    import flash.display.LineScaleMode;
-    import flash.display.Shape;
-    import flash.display.Sprite;
-
-    public class CapsStyleExample extends Sprite {
-        private var lineLength:uint            = 80;
-        private var borderColor:uint           = 0xFFCC00;
-        private var borderSize:uint            = 30;
-        private var highlightColor:uint        = 0x666666;
-        private var highlightSize:uint         = 0;
-        private var gutter:uint                = 25;
-        private var borderAlpha:uint           = 1;
-        private var borderPixelHinting:Boolean = false;
-        private var borderScaleMode:String     = LineScaleMode.NORMAL;
-        private var borderJointStyle:String    = JointStyle.MITER;
-        private var borderMiterLimit:uint      = 1;
-
-        public function CapsStyleExample() {
-            drawLine(CapsStyle.NONE);
-            drawLine(CapsStyle.ROUND);
-            drawLine(CapsStyle.SQUARE);
-            refreshLayout();
-        }
-
-        private function drawLine(capsStyle:String):void {
-            var child:Shape = new Shape();
-            child.graphics.lineStyle(borderSize,
-                                     borderColor,
-                                     borderAlpha,
-                                     borderPixelHinting,
-                                     borderScaleMode,
-                                     capsStyle,
-                                     borderJointStyle,
-                                     borderMiterLimit);
-            child.graphics.lineTo(0, 0);
-            child.graphics.lineTo(0, lineLength);
-            child.graphics.endFill();
-
-            child.graphics.moveTo(0, 0);
-            child.graphics.lineStyle(highlightSize, highlightColor);
-            child.graphics.lineTo(0, 0);
-            child.graphics.lineTo(0, lineLength);
-
-            addChild(child);
-        }
-
-        private function refreshLayout():void {
-            var ln:uint = numChildren;
-            var child:DisplayObject;
-            var lastChild:DisplayObject = getChildAt(0);
-            lastChild.x = lineLength;
-            lastChild.y = lineLength;
-            for (var i:uint = 1; i < ln; i++) {
-                child = getChildAt(i);
-                child.x = gutter + lastChild.x + lastChild.width;
-                child.y = lineLength;
-                lastChild = child;
-            }
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/ColorCorrection.html b/html-docs/flash/display/ColorCorrection.html deleted file mode 100644 index 971ac3d..0000000 --- a/html-docs/flash/display/ColorCorrection.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - - - -flash.display.ColorCorrection (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class ColorCorrection
InheritanceColorCorrection Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-

-The ColorCorrection class provides values for the flash.display.Stage.colorCorrection property. - -

-

-See also -

-
-flash.display.Stage.colorCorrection -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  DEFAULT : String = "default"
[static] -Uses the host's default color correction.
-		ColorCorrection
  OFF : String = "off"
[static] -Turns off color correction regardless of the player host environment.
-		ColorCorrection
  ON : String = "on"
[static] -Turns on color correction regardless of the player host environment, if available.
-		ColorCorrection
-
- -
- -
Constant detail
- - - - - -
DEFAULTconstant
-
-public static const DEFAULT:String = "default" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-Uses the host's default color correction. For the web player the host is usually a browser, and Flash Player -tries to use the same color correction as the web page hosting the SWF file. - -

- - - - - -
OFFconstant 
-
-public static const OFF:String = "off" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-Turns off color correction regardless of the player host environment. -This setting provides faster performance. -

- - - - - -
ONconstant 
-
-public static const ON:String = "on" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-Turns on color correction regardless of the player host environment, if available. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/ColorCorrectionSupport.html b/html-docs/flash/display/ColorCorrectionSupport.html deleted file mode 100644 index c6a4525..0000000 --- a/html-docs/flash/display/ColorCorrectionSupport.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - - - -flash.display.ColorCorrectionSupport (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class ColorCorrectionSupport
InheritanceColorCorrectionSupport Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-

-The ColorCorrectionSupport class provides values for the flash.display.Stage.colorCorrectionSupport property. - -

-

-See also -

-
-flash.display.Stage.colorCorrectionSupport -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  DEFAULT_OFF : String = "defaultOff"
[static] -Color correction is supported, but off by default.
-		ColorCorrectionSupport
  DEFAULT_ON : String = "defaultOn"
[static] -Color correction is supported, and on by default.
-		ColorCorrectionSupport
  UNSUPPORTED : String = "unsupported"
[static] -Color correction is not supported by the host environment.
-		ColorCorrectionSupport
-
- -
- -
Constant detail
- - - - - -
DEFAULT_OFFconstant
-
-public static const DEFAULT_OFF:String = "defaultOff" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-Color correction is supported, but off by default. -

- - - - - -
DEFAULT_ONconstant 
-
-public static const DEFAULT_ON:String = "defaultOn" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-Color correction is supported, and on by default. - -

- - - - - -
UNSUPPORTEDconstant 
-
-public static const UNSUPPORTED:String = "unsupported" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-Color correction is not supported by the host environment. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/DisplayObject.html b/html-docs/flash/display/DisplayObject.html deleted file mode 100644 index 459708d..0000000 --- a/html-docs/flash/display/DisplayObject.html +++ /dev/null @@ -1,5970 +0,0 @@ - - - - - - - - -flash.display.DisplayObject (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - -
Packageflash.display
Classpublic class DisplayObject
InheritanceDisplayObject Inheritance EventDispatcher Inheritance Object
ImplementsIBitmapDrawable
SubclassesAVM1Movie, Bitmap, InteractiveObject, MorphShape, Shape, StaticText, Video
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - 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. - - -

The DisplayObject class supports basic functionality like the x and y position of - - an object, as well as more advanced properties of the object such as its transformation matrix. - -

- - -

DisplayObject is an abstract base class; therefore, you cannot call DisplayObject directly. Invoking - - new DisplayObject() throws an ArgumentError exception.

- - - -

All display objects inherit from the DisplayObject class.

- - - -

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.

- - - -

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 added 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: activate and deactivate.

- - -

Some properties previously used in the ActionScript 1.0 and 2.0 MovieClip, TextField, and Button - - classes (such as _alpha, _height, _name, _width, - - _x, _y, and others) have equivalents in the ActionScript 3.0 - - DisplayObject class that are renamed so that they no longer begin with the underscore (_) character.

- - - -

For more information, see the "Display Programming" chapter of the ActionScript 3.0 Developer's Guide.

- - -

-

-View the examples. -

-

-See also -

-
-flash.display.DisplayObjectContainer -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  accessibilityProperties : AccessibilityProperties -
- - The current accessibility options for this display object.
-		DisplayObject
  alpha : Number -
- - Indicates the alpha transparency value of the object specified.
-		DisplayObject
  blendMode : String -
- - A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
  blendShader : Shader -
[write-only] - - Sets a shader that is used for blending the foreground and background.
-		DisplayObject
  cacheAsBitmap : Boolean -
- - If set to true, Flash runtimes cache an internal bitmap representation of the - - display object.
-		DisplayObject
  cacheAsBitmapMatrix : Matrix -
- - If non-null, this Matrix object defines how a display object is rendered when - - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  filters : Array -
- - An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
  height : Number -
- - Indicates the height of the display object, in pixels.
-		DisplayObject
  loaderInfo : LoaderInfo -
[read-only] - - Returns a LoaderInfo object containing information about loading the file - - to which this display object belongs.
-		DisplayObject
  mask : DisplayObject -
- - The calling display object is masked by the specified mask object.
-		DisplayObject
  metaData : Object -
- - Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
  mouseX : Number -
[read-only] - - Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
  mouseY : Number -
[read-only] - - Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
  name : String -
- - Indicates the instance name of the DisplayObject.
-		DisplayObject
  opaqueBackground : Object -
- - Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
  parent : DisplayObjectContainer -
[read-only] - - Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  root : DisplayObject -
[read-only] - - For a display object in a loaded SWF file, the root property is the - - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
  rotation : Number -
- - Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
  rotationX : Number -
- - Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
  rotationY : Number -
- - Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
  rotationZ : Number -
- - Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
  scale9Grid : Rectangle -
- - The current scaling grid that is in effect.
-		DisplayObject
  scaleX : Number -
- - Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
  scaleY : Number -
- - Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
  scaleZ : Number -
- - Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
  scrollRect : Rectangle -
- - The scroll rectangle bounds of the display object.
-		DisplayObject
  stage : Stage -
[read-only] - - The Stage of the display object.
-		DisplayObject
  transform : Transform -
- - An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
  visible : Boolean -
- - Whether or not the display object is visible.
-		DisplayObject
  width : Number -
- - Indicates the width of the display object, in pixels.
-		DisplayObject
  x : Number -
- - Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - - the parent DisplayObjectContainer.
-		DisplayObject
  y : Number -
- - Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - - the parent DisplayObjectContainer.
-		DisplayObject
  z : Number -
- - Indicates the z coordinate position along the z-axis of the DisplayObject - - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- - Returns a rectangle that defines the area of the display object relative to the coordinate system - - of the targetCoordinateSpace object.
-		DisplayObject
   -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- - Returns a rectangle that defines the boundary of the display object, - - based on the coordinate system defined by the targetCoordinateSpace - - parameter, excluding any strokes on shapes.
-		DisplayObject
   -
-globalToLocal(point:Point):Point -
-
- - Converts the point object from the Stage (global) coordinates - - to the display object's (local) coordinates.
-		DisplayObject
   -
-globalToLocal3D(point:Point):Vector3D -
-
- - Converts a two-dimensional point from the Stage (global) coordinates to a - - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-hitTestObject(obj:DisplayObject):Boolean -
-
- - Evaluates the bounding box of the display object to see if it overlaps or intersects with the - - bounding box of the obj display object.
-		DisplayObject
   -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- - Evaluates the display object to see if it overlaps or intersects with the - - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-local3DToGlobal(point3d:Vector3D):Point -
-
- - Converts a three-dimensional point of the three-dimensional display - - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
   -
-localToGlobal(point:Point):Point -
-
- - Converts the point object from the display object's (local) coordinates to the - - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-added -
-		 - - Dispatched when a display object is added to the display list.DisplayObject
   -
-addedToStage -
-		 - - Dispatched when a display object is added to the on stage display list, - - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-enterFrame -
-		 - - [broadcast event] Dispatched when the playhead is entering a new - - frame.DisplayObject
   -
-exitFrame -
-		 - - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
   -
-frameConstructed -
-		 - - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
   -
-removed -
-		 - - Dispatched when a display object is about to be removed from the display list.DisplayObject
   -
-removedFromStage -
-		 - - Dispatched when a display object is about to be removed from the display list, - - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
   -
-render -
-		 - - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
-
- -
- -
Property detail
- - - - - -
accessibilityPropertiesproperty
-
-accessibilityProperties:AccessibilityProperties  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - The current accessibility options for this display object. If you modify the accessibilityProperties - - property or any of the fields within accessibilityProperties, you must call - - the Accessibility.updateProperties() method to make your changes take effect. - - -

Note: For an object created in the Flash authoring environment, the value of accessibilityProperties - - is prepopulated with any information you entered in the Accessibility panel for - - that object.

- - -

Implementation -
-    public function get accessibilityProperties():AccessibilityProperties -
-    public function set accessibilityProperties(value:AccessibilityProperties):void -
-

-See also -

-
-flash.accessibility.Accessibility.updateProperties() -
-flash.accessibility.AccessibilityProperties -
-
-Example -
The following example shows how the to attach a simple AccessibilityProperties - object to a TextField instance: -
-
-
-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
-
-

-
- - - - - -
alphaproperty 
-
-alpha:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - 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 alpha - - set to 0 are active, even though they are invisible. - - -

Implementation -
-    public function get alpha():Number -
-    public function set alpha(value:Number):void -
-
-Example -
The following code sets the alpha property of a sprite - to 50% when the mouse rolls over the sprite: -
-
-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;
-}
-
-

-
- - - - - -
blendModeproperty 
-
-blendMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 BlendMode.NORMAL. - - -

The blendMode 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 blendMode - - is set to BlendMode.LIGHTEN, 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.

- - -

The following table describes the blendMode settings. - - The BlendMode class defines string values you can use. - - The illustrations in the table show blendMode values applied to a circular - - display object (2) superimposed on another display object (1).

- - - -

- - Square Number 1 - - - Circle Number 2 - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BlendMode ConstantIllustrationDescription
BlendMode.NORMALblend mode NORMALThe 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.
BlendMode.LAYERblend mode LAYERForces 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 blendMode - - setting other than BlendMode.NORMAL. Not supported under GPU rendering. - -
BlendMode.MULTIPLYblend mode MULTIPLYMultiplies 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. - - -

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.

BlendMode.SCREENblend mode SCREENMultiplies 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.
BlendMode.LIGHTENblend mode LIGHTENSelects 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. - - -

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.

BlendMode.DARKENblend mode DARKENSelects 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. - - -

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.

BlendMode.DIFFERENCEblend mode DIFFERENCECompares 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. - - -

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).

BlendMode.ADDblend mode ADDAdds 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. - - -

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).

BlendMode.SUBTRACTblend mode SUBTRACTSubtracts 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. - - -

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).

BlendMode.INVERTblend mode INVERTInverts the background.
BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. - - This requires the blendMode setting of the parent display object to be set to - - BlendMode.LAYER. - - For example, in the illustration, the parent display object, which is a white background, - - has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the - - blendMode of the parent display object to be set to - - BlendMode.LAYER. For example, in the - - illustration, the parent display object, which is a white background, has - - blendMode = BlendMode.LAYER. Not supported under GPU rendering.
BlendMode.OVERLAYblend mode OVERLAYAdjusts 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.
BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts 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.
BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified - - as the Shader instance assigned to the blendShader property. Setting the - - blendShader property of a display object to a Shader instance - - automatically sets the display object's blendMode property to - - BlendMode.SHADER. If the blendMode property is set to - - BlendMode.SHADER without first setting the blendShader property, - - the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.
- - - Implementation -
-    public function get blendMode():String -
-    public function set blendMode(value:String):void -
-

-See also -

-
-flash.display.BlendMode -
-blendShader -
-
-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 BlendMode.SUBTRACT - when the pointer rolls over the circle: -
-
-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;
-}
-
-

-
- - - - - -
blendShaderproperty 
-
-blendShader:Shader  [write-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Sets a shader that is used for blending the foreground and background. When the - - blendMode property is set to BlendMode.SHADER, the specified - - Shader is used to create the blend mode output for the display object. - - - -

Setting the blendShader property of a display object to a Shader instance - - automatically sets the display object's blendMode property to - - BlendMode.SHADER. If the blendShader property is set (which sets the - - blendMode property to BlendMode.SHADER), then the value of the - - blendMode property is changed, the blend mode can be reset to use the blend - - shader simply by setting the blendMode property to BlendMode.SHADER. - - The blendShader property does not need to be set again except to change the - - shader that's used for the blend mode.

- - - -

The Shader assigned to the blendShader property must specify at least two - - image4 inputs. The inputs do not need to be specified in code using the - - associated ShaderInput objects' input properties. The background display object - - is automatically - - used as the first input (the input with index 0). The foreground display object - - is used as the second input (the input with index 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 input property.

- - -

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.

- - - - Implementation -
-    public function set blendShader(value:Shader):void -
-
-Throws -
- - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — When the shader output type is not compatible with this operation - - (the shader must specify a pixel4 - - output). - - - -
 
ArgumentError — When the shader specifies fewer than two image inputs or the first - - two inputs are not image4 inputs. - - - -
 
ArgumentError — When the shader specifies an image input that isn't provided. - - - -
 
ArgumentError — When a ByteArray or Vector.<Number> instance is used as - - an input and the width - - and height properties aren't specified for the - - ShaderInput, or the specified values don't match the amount of - - data in the input object. See the ShaderInput.input - - property for more information. - - - -
-

-See also -

-
-flash.display.BlendMode -
-flash.display.Shader -
-flash.display.ShaderInput -
-
- - - - - -
cacheAsBitmapproperty 
-
-cacheAsBitmap:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - If set to true, Flash runtimes cache an internal bitmap representation of the - - display object. This caching can increase performance for display objects that contain complex - - vector content. - - -

All vector data for a display object that has a cached bitmap is drawn to the bitmap - - instead of the main display. If cacheAsBitmapMatrix 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.

- - -

If cacheAsBitmapMatrix 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.

- - -

No internal bitmap is created unless the cacheAsBitmap property is set to - - true.

- - -

After you set the cacheAsBitmap property to true, - - 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. - -

- - -

The cacheAsBitmap property is automatically set to true - - whenever you apply a filter to a display object (when its filter array is not empty), - - and if a display object has a filter applied to it, cacheAsBitmap is reported as - - true for that display object, even if you set the property to false. - - If you clear all filters for a display object, the cacheAsBitmap setting changes to - - what it was last set to.

- - -

A display object does not use a bitmap even if the cacheAsBitmap - - property is set to true and instead renders from vector data in the following cases:

- - -
    - - -
  • 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.
    • - - -
  • The bitmap fails to allocate (out of memory error).
    • - - -
- - -

The cacheAsBitmap property is best used with movie clips that have - - mostly static content and that do not scale and rotate frequently. With such movie - - clips, cacheAsBitmap can lead to performance increases when the - - movie clip is translated (when its x and y position is changed).

- - - Implementation -
-    public function get cacheAsBitmap():Boolean -
-    public function set cacheAsBitmap(value:Boolean):void -
-

-See also -

-
-cacheAsBitmapMatrix -
-opaqueBackground -
-
-Example -
The following example applies a drop shadow to a Shape instance. - It then traces the value of the cacheAsBitmap property, which is set to - true when the filter is applied: -
-
-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
-
-

-
- - - - - -
cacheAsBitmapMatrixproperty 
-
-cacheAsBitmapMatrix:Matrix  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2.0 - -
-

- - If non-null, this Matrix object defines how a display object is rendered when - - cacheAsBitmap is set to true. The application uses - - this matrix as a transformation matrix that is applied when rendering the bitmap version of - - the display object. - - - -

AIR profile support: 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 - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - -

With cacheAsBitmapMatrix 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.

- - - -

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 renderMode property to gpu in the - - application descriptor file. Note that AIR for TV devices automatically - - use hardware acceleration if it is available.

- - -

For example, the following code sends an untransformed bitmap representation - - of the display object to the GPU:

- - - - 
matrix:Matrix = new Matrix(); // creates an identity matrix 
-
-     mySprite.cacheAsBitmapMatrix = matrix; 
-
-     mySprite.cacheAsBitmap = true;
- - - -

Usually, the identity matrix (new Matrix()) 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 cacheAsBitmapMatrix 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:

- - - - 
matrix:Matrix = new Matrix(); // creates an identity matrix 
-
-     matrix.scale(0.5, 0.5); // scales the matrix 
-
-     mySprite.cacheAsBitmapMatrix = matrix; 
-
-     mySprite.cacheAsBitmap = true;
- - - -

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.

- - -

Note: The cacheAsBitmapMatrix 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 - - transform.matrix3D property. If the application is packaged - - using GPU mode, this allows the 3D transforms to be applied to - - the object by the GPU. The cacheAsBitmapMatrix is ignored - - for 3D objects.

- - - Implementation -
-    public function get cacheAsBitmapMatrix():Matrix -
-    public function set cacheAsBitmapMatrix(value:Matrix):void -
-

-See also -

-
-cacheAsBitmap -
-flash.geom.Matrix3D -
-
-Example -
The following example applies uses the cacheAsBitmapMatrix property to apply transformations - to a bitmap version of the movie clip my_shape. -
-
-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;
-    }
-    
-}
-
-

-
- - - - - -
filtersproperty 
-
-filters:Array  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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. - - -

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 filters array, modify the temporary array, then assign the value - - of the temporary array back to the filters array. You cannot directly - - add a new filter object to the filters array.

- - -

To add a filter by using ActionScript, perform the following steps (assume that the - - target display object is named myDisplayObject):

- - -
    - - -
  1. Create a new filter object by using the constructor method of your chosen filter - - class.
    2. - - -
  2. Assign the value of the myDisplayObject.filters array to a temporary array, such - - as one named myFilters.
    3. - - -
  3. Add the new filter object to the myFilters temporary array.
    4. - - -
  4. Assign the value of the temporary array to the myDisplayObject.filters array.
    5. - - -
- - -

If the filters 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 filters arrays.

- - -

To modify an existing filter object, - - you must use the technique of modifying a copy of the filters array:

- - -
    - - -
  1. Assign the value of the filters array to a temporary array, such as one - - named myFilters.
    2. - - -
  2. Modify the property by using the temporary array, myFilters. For example, - - to set the quality property of the first filter in the array, you could use the - - following code: myFilters[0].quality = 1;
    3. - - -
  3. Assign the value of the temporary array to the filters array.
    4. - - -
- - -

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.

- - -

The flash.filters package includes classes for filters. For example, to create a DropShadow - - filter, you would write:

- - - 
-
-     import flash.filters.DropShadowFilter
-
-     var myFilter:DropShadowFilter = new DropShadowFilter (distance, angle, color, alpha, blurX, blurY, quality, inner, knockout)
-
-
- - -

You can use the is operator to determine the type of filter assigned to - - each index position in the filter array. For example, the following code shows - - how to determine the position of the first filter in the filters array that - - is a DropShadowFilter: - -

- - - - 
-
-     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;
-
-     }
-
-
- -

Note: Since you cannot directly add a new filter object to the - - DisplayObject.filters array, the following code has no - - effect on the target display object, named myDisplayObject:

- - - 
-
-     myDisplayObject.filters.push(myDropShadow);
-
-
- - - Implementation -
-    public function get filters():Array -
-    public function set filters(value:Array):void -
-
-Throws -
- - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — When filters includes a ShaderFilter and the shader - - output type is not compatible with this operation - - (the shader must specify a pixel4 - - output). - - - -
 
ArgumentError — When filters includes a ShaderFilter and the shader - - doesn't specify any image input or the first - - input is not an image4 input. - - - -
 
ArgumentError — When filters includes a ShaderFilter and the shader - - specifies an image input that isn't provided. - - - -
 
ArgumentError — When filters includes a ShaderFilter, a - - ByteArray or Vector.<Number> instance as - - a shader input, and the width - - and height 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 ShaderInput.input - - property for more information. - - - -
-

-See also -

-
-flash.filters package -
-flash.display.ShaderInput.input -
-
- - - - - -
heightproperty 
-
-height:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - 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 height property, the scaleY property is adjusted accordingly, as shown in the - - following code: - - - - 

-
-    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;
- - - -

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 height to a different value.

- - - Implementation -
-    public function get height():Number -
-    public function set height(value:Number):void -
-
-Example -
The following code creates two TextField objects and adjusts the - height property of each based on the textHeight property of - each; it also positions the second text field by setting its y property: -
-
-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);
-
-

-
- - - - - -
loaderInfoproperty 
-
-loaderInfo:LoaderInfo  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a LoaderInfo object containing information about loading the file - - to which this display object belongs. The loaderInfo 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 loaderInfo object associated with the SWF file that contains - - a display object named myDisplayObject, use myDisplayObject.root.loaderInfo. - - - -

A large SWF file can monitor its download by calling - - this.root.loaderInfo.addEventListener(Event.COMPLETE, func).

- - - Implementation -
-    public function get loaderInfo():LoaderInfo -
-

-See also -

-
-LoaderInfo class -
-
-Example -
The following code assumes that this refers to - a display object. The code outputs the URL of the root SWF file for the - display object: -
-
- trace (this.loaderInfo.url);
- 
-
-
-

-
- - - - - -
maskproperty 
-
-mask:DisplayObject  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - The calling display object is masked by the specified mask object. - - To ensure that masking works when the Stage is scaled, the mask display object - - must be in an active part of the display list. The mask object itself is not drawn. - - Set mask to null to remove the mask. - - - -

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 startDrag() method), it must be on the display list. To call the - - startDrag() method for a mask sprite based on a mouseDown event - - being dispatched by the sprite, set the sprite's buttonMode property to true.

- - -

When display objects are cached by setting the cacheAsBitmap property to - - true an the cacheAsBitmapMatrix 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.

- - - -

Note: A single mask object cannot be used to mask more than one calling display object. - - When the mask is assigned to a second display object, it is removed as the mask of the first - - object, and that object's mask property becomes null.

- - - Implementation -
-    public function get mask():DisplayObject -
-    public function set mask(value:DisplayObject):void -
-
-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 drag() event listener function calls the startDrag() - method of the mask Sprite object: -
-
-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();
-}
-
-

-
- - - - - -
metaDataproperty 
-
-metaData:Object  [read-write]

- - Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. - -

Implementation -
-    public function get metaData():Object -
-    public function set metaData(value:Object):void -
-
- - - - - -
mouseXproperty 
-
-mouseX:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - Indicates the x coordinate of the mouse or user input device position, in pixels. - - -

Note: For a DisplayObject that has been rotated, the returned x coordinate will reflect the - - non-rotated object.

- - - Implementation -
-    public function get mouseX():Number -
-
-Example -
The following code creates a Sprite object and traces the mouseX - and mouseY positions when the user clicks the sprite: -
-
-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);
-}
-
-

-
- - - - - -
mouseYproperty 
-
-mouseY:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - Indicates the y coordinate of the mouse or user input device position, in pixels. - - -

Note: For a DisplayObject that has been rotated, the returned y coordinate will reflect the - - non-rotated object.

- - - Implementation -
-    public function get mouseY():Number -
-
-Example -
The following code creates a Sprite object and traces the mouseX - and mouseY positions when the user clicks the sprite: -
-
-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);
-}
-
-

-
- - - - - -
nameproperty 
-
-name:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - 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 - - getChildByName() method of the display object container. - - -

Implementation -
-    public function get name():String -
-    public function set name(value:String):void -
-
-Throws -
- - - - -
Error — If you are attempting to set this property on an object that was - - placed on the timeline in the Flash authoring tool. - - - -
-
-Example -
The following code creates two Sprite object and traces the - associated name property when the user clicks either of the objects: -
-
-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);
-}
-
-

-
- - - - - -
opaqueBackgroundproperty 
-
-opaqueBackground:Object  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - 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. - - -

If set to a number value, the surface is opaque (not transparent) with the RGB background - - color that the number specifies. If set to null (the default value), the display - - object has a transparent background.

- - - -

The opaqueBackground property is intended mainly for use with the - - cacheAsBitmap property, for rendering optimization. For display objects in which the - - cacheAsBitmap property is set to true, setting opaqueBackground can - - improve rendering performance.

- - - -

The opaque background region is not matched when calling the hitTestPoint() - - method with the shapeFlag parameter set to true.

- - - -

The opaque background region does not respond to mouse events.

- - - - Implementation -
-    public function get opaqueBackground():Object -
-    public function set opaqueBackground(value:Object):void -
-

-See also -

-
-cacheAsBitmap -
-hitTestPoint() -
-
-Example -
The following code creates a Shape object with a blue circle - and sets its opaqueBackground property to red (0xFF0000): -
-
-import flash.display.Shape;
-
-var circle:Shape = new Shape();
-circle.graphics.beginFill(0x0000FF);
-circle.graphics.drawCircle(40, 40, 40);
-circle.opaqueBackground = 0xFF0000;
-addChild(circle);
-
-

-
- - - - - -
parentproperty 
-
-parent:DisplayObjectContainer  [read-only]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - Indicates the DisplayObjectContainer object that contains this display object. Use the parent - - property to specify a relative path to display objects that are above the - - current display object in the display list hierarchy. - - -

You can use parent to move up multiple levels in the display list as in the following:

- - - 
-
-     this.parent.parent.alpha = 20;
-
-
- - - Implementation -
-    public function get parent():DisplayObjectContainer -
-
-Throws -
- - - - -
SecurityError — 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 Security.allowDomain() method. - - -
-
-Example -
The following code creates three Sprite objects and shows how - the parent property reflects the display list hierarchy: -
-
-
-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
-
-

-
- - - - - -
rootproperty 
-
-root:DisplayObject  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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. - - For a Bitmap object representing a loaded image file, the root property is the Bitmap object - - itself. For the instance of the main class of the first SWF file loaded, the root property is the - - display object itself. The root property of the Stage object is the Stage object itself. The root - - property is set to null 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. - - - -

For example, if you create a new Sprite object by calling the Sprite() constructor method, - - its root property is null 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).

- - - -

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 root property set to itself. The Loader object - - does not have its root property set until it is added as a child of a display object for which the - - root property is set.

- - - - Implementation -
-    public function get root():DisplayObject -
-
-Example -
The following code shows the difference between the root - 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): -
-
-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]
-}
-
-

-
- - - - - -
rotationproperty 
-
-rotation:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - 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 my_video.rotation = 450 is the - - same as my_video.rotation = 90. - - -

Implementation -
-    public function get rotation():Number -
-    public function set rotation(value:Number):void -
-
-Example -
The following code creates a Sprite object and rotates - the object when the user clicks it: -
-
-
-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;
-}
-
-

-
- - - - - -
rotationXproperty 
-
-rotationX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - 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. - - -

Implementation -
-    public function get rotationX():Number -
-    public function set rotationX(value:Number):void -
-
-Example -
In this example, two ellipses rotate using their rotationX and - rotationY properties. The first ellipse's registration point is set - to its center. It rotates around itself. The second ellipse rotates around - an external point. -
-
-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;
-        }
-    }
-}
-
-

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 - ActionScriptExamples.com. -
-
-//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;
-}
-
-

-
- - - - - -
rotationYproperty 
-
-rotationY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - 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. - - - -

Implementation -
-    public function get rotationY():Number -
-    public function set rotationY(value:Number):void -
-
-Example -
In this example, two ellipses rotate using their rotationX and - rotationY properties. The first ellipse's registration point is set - to its center. It rotates around itself. The second ellipse rotates around - an external point. -
-
-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;
-        }
-    }
-}
-
-

-
- - - - - -
rotationZproperty 
-
-rotationZ:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - 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. - - - - -

Implementation -
-    public function get rotationZ():Number -
-    public function set rotationZ(value:Number):void -
-
- - - - - -
scale9Gridproperty 
-
-scale9Grid:Rectangle  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The current scaling grid that is in effect. If set to null, - - the entire display object is scaled normally when any scale transformation is - - applied. - - -

When you define the scale9Grid property, the display object is divided into a - - grid with nine regions based on the scale9Grid rectangle, which defines the - - center region of the grid. The eight other regions of the grid are the following areas:

- - -
    - -
  • The upper-left corner outside of the rectangle
    • - -
  • The area above the rectangle
    • - -
  • The upper-right corner outside of the rectangle
    • - -
  • The area to the left of the rectangle
    • - -
  • The area to the right of the rectangle
    • - -
  • The lower-left corner outside of the rectangle
    • - -
  • The area below the rectangle
    • - -
  • The lower-right corner outside of the rectangle
    • - -
- - -

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.

- - -

When the scale9Grid 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:

- - -
    - -
  • Content in the center region is scaled normally.
    • - -
  • Content in the corners is not scaled.
    • - -
  • Content in the top and bottom regions is scaled horizontally only. Content in the - - left and right regions is scaled vertically only.
    • - -
  • All fills (including bitmaps, video, and gradients) are stretched to fit their shapes.
    • - -
- - -

If a display object is rotated, all subsequent scaling is normal (and the - - scale9Grid property is ignored).

- - -

For example, consider the following display object and a rectangle that is applied as the display - - object's scale9Grid:

- - - - - - - - - - - - - - - -
display object image - -

The display object.

display object scale 9 region - -

The red rectangle shows the scale9Grid.

- - -

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 - - scale9Grid rules:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Scaled to 75%:display object at 75%
Scaled to 50%:display object at 50%
Scaled to 25%:display object at 25%
Stretched horizontally 150%: display stretched 150%
- - -

A common use for setting scale9Grid 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.

- - - Implementation -
-    public function get scale9Grid():Rectangle -
-    public function set scale9Grid(value:Rectangle):void -
-
-Throws -
- - - - -
ArgumentError — If you pass an invalid argument to the method. - - - -
-

-See also -

-
-flash.geom.Rectangle -
-
-Example -
The following code creates a Shape object with a rectangle drawn in its - graphics property. The rectangle has a 20-pixel-thick line as the border and - it is filled with a gradient. The timer event calls the scale() function, which - scales the Shape object by adjusting the scaleX and scaleY properties. - The scale9Grid applied to the Shape object prevents the rectangle's border line - from scaling — only the gradient fill scales: -
-
-
-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;
-	}
-}
-
-

-
- - - - - -
scaleXproperty 
-
-scaleX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - 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. - - -

Scaling the local coordinate system changes the x and y property values, which are defined in - - whole pixels.

- - - Implementation -
-    public function get scaleX():Number -
-    public function set scaleX(value:Number):void -
-
-Example -
The following code creates a Sprite object with a rectangle drawn in its - graphics property. When the user clicks the sprite, it scales by 10%: -
-
-
-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;
-}
-
-

-
- - - - - -
scaleYproperty 
-
-scaleY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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. - - -

Scaling the local coordinate system changes the x and y property values, which are defined in - - whole pixels.

- - - Implementation -
-    public function get scaleY():Number -
-    public function set scaleY(value:Number):void -
-
-Example -
The following code creates a Sprite object with a rectangle drawn in its - graphics property. When the user clicks the sprite, it scales by 10%: -
-
-
-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;
-}
-
-

-
- - - - - -
scaleZproperty 
-
-scaleZ:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - 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. - - -

Scaling the local coordinate system changes the x, y and z property values, which are defined in - - whole pixels.

- - - - - Implementation -
-    public function get scaleZ():Number -
-    public function set scaleZ(value:Number):void -
-

-See also -

-
-z -
-
- - - - - -
scrollRectproperty 
-
-scrollRect:Rectangle  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 - - x and y properties of the scrollRect object. - - - -

The properties of the scrollRect 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.

- - - -

You can scroll an object left and right by setting the x property of the - - scrollRect Rectangle object. You can scroll an object up and down by setting - - the y property of the scrollRect Rectangle object. If the display object - - is rotated 90° and you scroll it left and right, the display object actually scrolls up and down.

- - -

Note that changes to the scrollRect property are only processed when the object is rendered. - - Thus methods like localToGlobal may not produce the expected result if called immediately - - after modifying scrollRect.

- - -

Note: Starting with Flash Player 11.4/AIR 3.4, negative values for the width or the height of the rectangle - - are changed to 0.

- - - - Implementation -
-    public function get scrollRect():Rectangle -
-    public function set scrollRect(value:Rectangle):void -
-

-See also -

-
-flash.geom.Rectangle -
-
-Example -
The following example shows how the scrollRect property defines the - scrolling area for a display object, circle. When you click the circle object, - the clicked() event handler method adjusts the y property of the - scrollRect property of the circle object, causing the object to scroll down: -
-
-
-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;
-}
-
-

-
- - - - - -
stageproperty 
-
-stage:Stage  [read-only]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - 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 - - stage property of each display object refers to the same Stage object (even if the - - display object belongs to a loaded SWF file). - - - -

If a display object is not added to the display list, its stage property is set to - - null.

- - - Implementation -
-    public function get stage():Stage -
-
-Example -
The following code creates two TextField objects and uses the - width property of the Stage object to position the text fields: -
-
-
-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);
-
-

-
- - - - - -
transformproperty 
-
-transform:Transform  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - 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 - - (concatenatedMatrix, concatenatedColorTransform, - - and pixelBounds) — are described in the entry for the Transform class. - - - -

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.

- - - -

For example, to increase the tx 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:

- - - - 

-
-    var myMatrix:Matrix = myDisplayObject.transform.matrix;  
-
-    myMatrix.tx += 10; 
-
-    myDisplayObject.transform.matrix = myMatrix;  
-
-
- - - -

You cannot directly set the tx property. The following code has - - no effect on myDisplayObject:

- - - - 

-
-    myDisplayObject.transform.matrix.tx += 10;
-
-
- - - -

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 myOldDisplayObj to - - myNewDisplayObj:

- - myNewDisplayObj.transform = myOldDisplayObj.transform; - -

The resulting display object, myNewDisplayObj, now has the same values for its - - matrix, color transform, and pixel bounds as the old display object, myOldDisplayObj.

- - - -

Note that AIR for TV devices use hardware acceleration, if it is available, for color transforms.

- - - Implementation -
-    public function get transform():Transform -
-    public function set transform(value:Transform):void -
-

-See also -

-
-Transform class -
-
-Example -
The following code sets up a square Sprite object. - When the user clicks the sprite, the transformer() method adjusts - the colorTransform and matrix properties of the - transform property of the sprite: -
-
-
-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;
-}
-
-

-
- - - - - -
visibleproperty 
-
-visible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - Whether or not the display object is visible. Display objects that are not visible - - are disabled. For example, if visible=false for an InteractiveObject instance, - - it cannot be clicked. - - -

Implementation -
-    public function get visible():Boolean -
-    public function set visible(value:Boolean):void -
-
-Example -
The following code uses a Timer object to call a function that - periodically changes the visible property of a display object, - resulting in a blinking effect: -
-
-
-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;
-}
-
-

-
- - - - - -
widthproperty 
-
-width:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - 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 width property, the scaleX property is adjusted accordingly, as shown in the - - following code: - - - - 

-
-    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;
- - - -

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 width to a different value.

- - - Implementation -
-    public function get width():Number -
-    public function set width(value:Number):void -
-
-Example -
The following code sets up a square Sprite object. - When the user clicks the sprite, the widen() method increases - the width property of the sprite: -
-
-
-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;
-}
-
-

-
- - - - - -
xproperty 
-
-x:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - Indicates the x 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. - - -

Implementation -
-    public function get x():Number -
-    public function set x(value:Number):void -
-
-Example -
The following code sets up a circle Sprite object. - A Timer object is used to change the x property of the sprite - every 50 milliseconds: -
-
-
-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;
-	}
-}
-
-

-
- - - - - -
yproperty 
-
-y:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - Indicates the y 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. - - -

Implementation -
-    public function get y():Number -
-    public function set y(value:Number):void -
-
-Example -
The following code creates two TextField objects and adjusts the - height property of each based on the textHeight property of - each; it also positions the second text field by setting its y property: -
-
-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);
-
-

-
- - - - - -
zproperty 
-
-z:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - 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. - -

When you set a z property for a display object to something other than the default - - value of 0, 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.

- -

For example, a child of the _root 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:

- -

(x*cameraFocalLength/cameraRelativeZPosition, y*cameraFocalLength/cameraRelativeZPosition)

- - - - - Implementation -
-    public function get z():Number -
-    public function set z(value:Number):void -
-

-See also -

-
-flash.geom.PerspectiveProjection -
-flash.geom.Matrix3D -
-transform -
-
-Example -
This example draws two ellipses and has them go back and forth (down and up the - z axis) toward the vanishing point. One ellipse is set to move faster - than the other. -
-
-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;
-        }
-    }
-}
-
-

-
- -
Method detail
- - - - - -
getBounds()method
-
-public function getBounds(targetCoordinateSpace:DisplayObject):Rectangle -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Returns a rectangle that defines the area of the display object relative to the coordinate system - - of the targetCoordinateSpace object. - - Consider the following code, which shows how the rectangle returned can vary depending on the - - targetCoordinateSpace parameter that you pass to the method: - - - 

-
-     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)
-
-
- - - -

Note: Use the localToGlobal() and - - globalToLocal() methods to convert the display object's local coordinates - - to display coordinates, or display coordinates to local coordinates, respectively.

- - - -

The getBounds() method is similar to the getRect() method; - - however, the Rectangle returned by the getBounds() method includes any strokes - - on shapes, whereas the Rectangle returned by the getRect() method does not. - - For an example, see the description of the getRect() method.

- - - Parameters - - - - -
targetCoordinateSpace:DisplayObject — The display object that defines the coordinate system to use. - - -
-

-Returns - - - - -
Rectangle — - The rectangle that defines the area of the display object relative to - - the targetCoordinateSpace object's coordinate system. - - - - -
-

-See also -

-
-getRect() -
-globalToLocal() -
-localToGlobal() -
-
- - - - - -
getRect()method 
-
-public function getRect(targetCoordinateSpace:DisplayObject):Rectangle -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - 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. The values that the getRect() method - - returns are the same or smaller than those returned by the getBounds() method. - - - -

Note: Use localToGlobal() and globalToLocal() methods - - to convert the display object's local coordinates to Stage coordinates, or Stage coordinates to - - local coordinates, respectively.

- - - - Parameters - - - - -
targetCoordinateSpace:DisplayObject — The display object that defines the coordinate system to use. - - - -
-

-Returns - - - - -
Rectangle — - The rectangle that defines the area of the display object relative to - - the targetCoordinateSpace object's coordinate system. - - - - - -
-

-See also -

-
-getBounds() -
-
-Example -
The following example shows how the getBounds() method can return a larger - rectangle than the getRect() method does, because of the additional area taken up by - strokes. In this case, the triangle sprite includes extra strokes because of the - width and jointStyle parameters of the lineStyle() - method. The trace() output (in the last two lines) shows the differences between - the getRect() and getBounds() rectangles: -
-
-
-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)
-
-

-
- - - - - -
globalToLocal()method 
-
-public function globalToLocal(point:Point):Point -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Converts the point object from the Stage (global) coordinates - - to the display object's (local) coordinates. - - -

To use this method, first create an instance of the Point class. The - - x and y 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 globalToLocal() method. The method returns a new Point object with - - x and y values that relate to the origin of the display object - - instead of the origin of the Stage.

- - - Parameters - - - - -
point:Point — An object created with the Point class. The Point object - - specifies the x and y coordinates as properties. - - -
-

-Returns - - - - -
Point — - A Point object with coordinates relative to the display object. - - - - -
-

-See also -

-
-localToGlobal() -
-flash.geom.Point class -
-
-Example -
The following code creates a Shape object and shows the - result of calling the hitTestPoint() method, using different - points as parameters. The globalToLocal() method converts the - point from Stage coordinates to the coordinate space of the shape: -
-
-
-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]
-
-

-
- - - - - -
globalToLocal3D()method 
-
-public function globalToLocal3D(point:Point):Vector3D -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Converts a two-dimensional point from the Stage (global) coordinates to a - - three-dimensional display object's (local) coordinates. - - -

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 globalToLocal3D() - - method as the point parameter. The method returns three-dimensional - - coordinates as a Vector3D object containing x, y, and - - z values that are relative to the origin - - of the three-dimensional display object.

- - - Parameters - - - - -
point:Point — A two dimensional Point object representing global x and y coordinates. - - -
-

-Returns - - - - -
Vector3D — - A Vector3D object with coordinates relative to the three-dimensional - - display object. - - - - -
-
- - - - - -
hitTestObject()method 
-
-public function hitTestObject(obj:DisplayObject):Boolean -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Evaluates the bounding box of the display object to see if it overlaps or intersects with the - - bounding box of the obj display object. - - -

Parameters - - - - -
obj:DisplayObject — The display object to test against. - - -
-

-Returns - - - - -
Boolean — - true if the bounding boxes of the display objects intersect; false if not. - - - - - - -
-
-Example -
The following code creates three Shape objects and shows the - result of calling the hitTestObject() method. Note that although - circle2 and circle3 do not overlap, their bounding boxes do. Thus, the hit test - of circle2 and circle3 returns true. -
-
-
-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
-
-

-
- - - - - -
hitTestPoint()method 
-
-public function hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Evaluates the display object to see if it overlaps or intersects with the - - point specified by the x and y parameters. - - The x and y 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). - - -

Parameters - - - - - - - - - - - - - - - - -
x:Number — The x coordinate to test against this object. - - -
 
y:Number — The y coordinate to test against this object. - - -
 
shapeFlag:Boolean (default = false) — Whether to check against the actual pixels of the object (true) - - or the bounding box (false). - - -
-

-Returns - - - - -
Boolean — - true if the display object overlaps or intersects with the specified point; - - false otherwise. - - - - -
-

-See also -

-
-opaqueBackground -
-
-Example -
The following code creates a Shape object and shows the - result of calling the hitTestPoint() method, using different - points as parameters. The globalToLocal() method converts the - point from Stage coordinates to the coordinate space of the shape: -
-
-
-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]
-
-

-
- - - - - -
local3DToGlobal()method 
-
-public function local3DToGlobal(point3d:Vector3D):Point -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Converts a three-dimensional point of the three-dimensional display - - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. - - -

For example, you can only use two-dimensional coordinates (x,y) to - - draw with the display.Graphics 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 local3DToGlobal() - - method as the point3d parameter. The method returns a two-dimensional Point - - object that can be used - - with the Graphics API to draw the three-dimensional object.

- - - - Parameters - - - - -
point3d:Vector3D — A Vector3D object containing either a three-dimensional point or - - the coordinates of the three-dimensional display object. - - -
-

-Returns - - - - -
Point — - A two-dimensional point representing a three-dimensional point - - in two-dimensional space. - - - - -
-
-Example -
This example draws a simple three-dimensional cube in a two dimensional space - using display.Graphics methods. The location of this 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 local3DToGlobal() method. - -
-
-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);
-        }
-    }
-}
-
-

-
- - - - - -
localToGlobal()method 
-
-public function localToGlobal(point:Point):Point -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Converts the point object from the display object's (local) coordinates to the - - Stage (global) coordinates. - - -

This method allows you to convert any given x and y 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).

- - -

To use this method, first create an instance of the Point class. The - - x and y values that you assign represent local coordinates because they - - relate to the origin of the display object.

- - -

You then pass the Point instance that you created as the parameter to - - the localToGlobal() method. The method returns a new Point object with - - x and y values that relate to the origin of the Stage - - instead of the origin of the display object.

- - - Parameters - - - - -
point:Point — The name or identifier of a point created with the Point class, specifying the - - x and y coordinates as properties. - - -
-

-Returns - - - - -
Point — - A Point object with coordinates relative to the Stage. - - - - -
-

-See also -

-
-globalToLocal() -
-flash.geom.Point class -
-
-Example -
The following code creates a Sprite object. The mouseX and - mouseY properties of the sprite are in the coordinate space of the display - object. This code uses the localToGlobal() method to translate these - properties to the global (Stage) coordinates: -
-
-
-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));
-}
-
-

-
-
Event detail
- - - - - -
addedevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.ADDED -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched when a display object is added to the display list. The - - following methods trigger this event: DisplayObjectContainer.addChild(), - - DisplayObjectContainer.addChildAt(). - -

- The Event.ADDED constant defines the value of the type property of - an added event object. - -

The added event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe DisplayObject instance being added to the display list. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.DisplayObjectContainer.addChild() -
-flash.display.DisplayObjectContainer.addChildAt() -
-
- - - - - -
addedToStageevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.ADDED_TO_STAGE -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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: DisplayObjectContainer.addChild(), - - DisplayObjectContainer.addChildAt(). - -

- The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object. - -

The addedToStage event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe DisplayObject instance being added to the on stage display list, - either directly or through the addition of a sub tree in which the DisplayObject instance is contained. - If the DisplayObject instance is being directly added, the added event occurs before this event.
- -

-See also -

-
-flash.display.DisplayObjectContainer.addChild() -
-flash.display.DisplayObjectContainer.addChildAt() -
-
- - - - - -
enterFrameevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.ENTER_FRAME -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - [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. - -

- The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the enterFrame event.
- -
- - - - - -
exitFrameevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.EXIT_FRAME -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 2 - -
-

- - [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. - -

- The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the enterFrame event.
- -
- - - - - -
frameConstructedevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.FRAME_CONSTRUCTED -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 2 - -
-

- - [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. - -

- The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. - -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the frameConstructed event.
- -
- - - - - -
removedevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.REMOVED -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched when a display object is about to be removed from the display list. - - Three methods of the DisplayObjectContainer class generate this event: - - removeChild(), removeChildren(), and removeChildAt(). - - - -

The following methods of a DisplayObjectContainer object also generate this event if an object must be removed - - to make room for the new object: addChild(), addChildAt(), and - - setChildIndex().

- -

- The Event.REMOVED constant defines the value of the type property of - a removed event object. - -

The removed event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe DisplayObject instance to be removed from the display list. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
- - - - - -
removedFromStageevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.REMOVED_FROM_STAGE -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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. - - Three methods of the DisplayObjectContainer class generate this event: - - removeChild(), removeChildren(), and removeChildAt(). - - - -

The following methods of a DisplayObjectContainer object also generate this event if an object must be removed - - to make room for the new object: addChild(), addChildAt(), and - - setChildIndex().

- -

- The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object. - -

The removedFromStage event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe DisplayObject instance being removed from the on stage display list, - either directly or through the removal of a sub tree in which the DisplayObject instance is contained. - If the DisplayObject instance is being directly removed, the removed event occurs before this event.
- -
- - - - - -
renderevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.RENDER -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - [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 invalidate() method - - of the Stage object - - each time you want a render event to be dispatched. Render events - - are dispatched to an object only if there is mutual trust between it and the object that called - - Stage.invalidate(). - - This event is a broadcast event, which means that it is dispatched - - by all display objects with a listener registered for this event. - - -

Note: This event is not dispatched if the display is - - not rendering. This is the case when the content is either minimized or obscured.

- -

- The Event.RENDER constant defines the value of the type property of a render event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; the default behavior cannot be canceled.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the render event.
- -
- -
Examples
-
examples\DisplayObjectExample
-
The following example uses the DisplayObjectExample 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: -
    -
  1. Class properties are declared for the color and size of the square.
    2. -
  2. The constructor calls the draw() method, which draws an orange square on - the Stage at the default coordinates of x = 0, y = 0.
    3. -
  3. The following event listener methods are attached to the square: -
      -
    • addedHandler() listens for added events, dispatched when the - square is added to the display list.
      • -
    • enterFrameHandler() listens for enterFrame events, which have no - real meaning in this example.
      • -
    • removedHandler() listens for removed events, dispatched when - the square is removed from the display list, which happens when the square is clicked.
      • -
    • clickHandler() listens for click events, dispatched when the - orange square is clicked.
      • -
    • renderHandler() listens for render events after the display - list is updated.
      • -
    4. -
-
-
-
-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);
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/display/DisplayObjectContainer.html b/html-docs/flash/display/DisplayObjectContainer.html deleted file mode 100644 index d819e37..0000000 --- a/html-docs/flash/display/DisplayObjectContainer.html +++ /dev/null @@ -1,3143 +0,0 @@ - - - - - - - - -flash.display.DisplayObjectContainer (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic class DisplayObjectContainer
InheritanceDisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
SubclassesLoader, Sprite, Stage, TextLine
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The DisplayObjectContainer class is the base class for all objects that can serve as display object containers 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. - Each DisplayObjectContainer object has its own child list for organizing the z-order of the objects. - The z-order is the front-to-back order that determines which object is drawn in front, which is behind, - and so on. -

DisplayObject is an abstract base class; therefore, you cannot call DisplayObject directly. Invoking - new DisplayObject() throws an ArgumentError exception.

- The DisplayObjectContainer class is an abstract base class for all objects that can contain child objects. - It cannot be instantiated directly; calling the new DisplayObjectContainer() constructor - throws an ArgumentError exception. - -

For more information, see the "Display Programming" chapter of the ActionScript 3.0 Developer's Guide.

-

-

-View the examples. -

-

-See also -

-
-flash.display.DisplayObject -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityImplementation : AccessibilityImplementation -
- The current accessibility implementation (AccessibilityImplementation) - for this InteractiveObject instance.
-		InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcontextMenu : NativeMenu -
- Specifies the context menu associated with this object.
-		InteractiveObject
 InheriteddoubleClickEnabled : Boolean -
- Specifies whether the object receives doubleClick events.
-		InteractiveObject
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 InheritedfocusRect : Object -
- Specifies whether this object displays a focus rectangle.
-		InteractiveObject
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
  mouseChildren : Boolean -
- Determines whether or not the children of the object are mouse, or user input device, enabled.
-		DisplayObjectContainer
 InheritedmouseEnabled : Boolean -
- Specifies whether this object receives mouse, or other user input, messages.
-		InteractiveObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedneedsSoftKeyboard : Boolean -
- Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - when this InteractiveObject instance receives focus.
-		InteractiveObject
  numChildren : int -
[read-only] - Returns the number of children of this object.
-		DisplayObjectContainer
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
 InheritedsoftKeyboard : String -
- Controls the appearance of the soft keyboard.
-		InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle -
- Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
-		InteractiveObject
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
  tabChildren : Boolean -
- Determines whether the children of the object are tab enabled.
-		DisplayObjectContainer
 InheritedtabEnabled : Boolean -
- Specifies whether this object is in the tab order.
-		InteractiveObject
 InheritedtabIndex : int -
- Specifies the tab ordering of objects in a SWF file.
-		InteractiveObject
  textSnapshot : TextSnapshot -
[read-only] - Returns a TextSnapshot object for this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DisplayObjectContainer()
-
- Calling the new DisplayObjectContainer() constructor throws an - ArgumentError exception.
-		DisplayObjectContainer
   -
-addChild(child:DisplayObject):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer instance.
-		DisplayObjectContainer
   -
-addChildAt(child:DisplayObject, index:int):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer - instance.
-		DisplayObjectContainer
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-areInaccessibleObjectsUnderPoint(point:Point):Boolean -
-
- Indicates whether the security restrictions - would cause any display objects to be omitted from the list returned by calling - the DisplayObjectContainer.getObjectsUnderPoint() method - with the specified point point.
-		DisplayObjectContainer
   -
-contains(child:DisplayObject):Boolean -
-
- Determines whether the specified display object is a child of the DisplayObjectContainer instance or - the instance itself.
-		DisplayObjectContainer
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
   -
-getChildAt(index:int):DisplayObject -
-
- Returns the child display object instance that exists at the specified index.
-		DisplayObjectContainer
   -
-getChildByName(name:String):DisplayObject -
-
- Returns the child display object that exists with the specified name.
-		DisplayObjectContainer
   -
-getChildIndex(child:DisplayObject):int -
-
- Returns the index position of a child DisplayObject instance.
-		DisplayObjectContainer
   -
-getObjectsUnderPoint(point:Point):Array -
-
- Returns an array of objects that lie under the specified point and are children - (or grandchildren, and so on) of this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-removeChild(child:DisplayObject):DisplayObject -
-
- Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
   -
-removeChildAt(index:int):DisplayObject -
-
- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer.
-		DisplayObjectContainer
   -
-removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void -
-
- Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-requestSoftKeyboard():Boolean -
-
- Raises a virtual keyboard.
-		InteractiveObject
   -
-setChildIndex(child:DisplayObject, index:int):void -
-
- Changes the position of an existing child in the display object container.
-		DisplayObjectContainer
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-stopAllMovieClips():void -
-
- Recursively stops the timeline execution of all MovieClips rooted at this object.
-		DisplayObjectContainer
   -
-swapChildren(child1:DisplayObject, child2:DisplayObject):void -
-
- Swaps the z-order (front-to-back order) of the two specified child objects.
-		DisplayObjectContainer
   -
-swapChildrenAt(index1:int, index2:int):void -
-
- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list.
-		DisplayObjectContainer
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-clear -
-		 - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 Inherited -
-click -
-		 - Dispatched when a user presses and releases the main button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-contextMenu -
-		 - Dispatched when a user gesture triggers the context menu associated with this interactive - object in an AIR application.InteractiveObject
 Inherited -
-copy -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - or selects 'Copy' from the text context menu.InteractiveObject
 Inherited -
-cut -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - or selects 'Cut' from the text context menu.InteractiveObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-doubleClick -
-		 - Dispatched when a user presses and releases the main button of a pointing device twice in - rapid succession over the same InteractiveObject when that object's - doubleClickEnabled flag is set to true.InteractiveObject
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-focusIn -
-		 - Dispatched after a display object gains focus.InteractiveObject
 Inherited -
-focusOut -
-		 - Dispatched after a display object loses focus.InteractiveObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-gestureDirectionalTap -
-		 - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 Inherited -
-gestureLongPress -
-		 - Dispatched when the user presses two points of contact over the same InteractiveObject instance - on a touch-enabled device (such as presses and releases two fingers over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gesturePan -
-		 - Dispatched when the user moves a point of contact over the InteractiveObject instance - on a touch-enabled device (such as moving a finger from left to right over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureRotate -
-		 - Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers - and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureSwipe -
-		 - Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three - fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureTap -
-		 - Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps - on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureZoom -
-		 - Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two - fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-imeStartComposition -
-		 - This event is dispatched to any client app that supports inline input with an IME - - InteractiveObject
 Inherited -
-keyDown -
-		 - Dispatched when the user presses a key.InteractiveObject
 Inherited -
-keyFocusChange -
-		 - Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited -
-keyUp -
-		 - Dispatched when the user releases a key.InteractiveObject
 Inherited -
-middleClick -
-		 - Dispatched when a user presses and releases the middle button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-middleMouseDown -
-		 - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-middleMouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseDown -
-		 - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseFocusChange -
-		 - Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 Inherited -
-mouseMove -
-		 - Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited -
-mouseOut -
-		 - Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseOver -
-		 - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheel -
-		 - Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheelHorizontal -
-		 - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-nativeDragComplete -
-		 - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited -
-nativeDragDrop -
-		 - Dispatched by the target InteractiveObject when a dragged object is - dropped on it and the drop has been accepted with a call to - DragManager.acceptDragDrop().InteractiveObject
 Inherited -
-nativeDragEnter -
-		 - Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited -
-nativeDragExit -
-		 - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited -
-nativeDragOver -
-		 - Dispatched by an InteractiveObject continually while a drag gesture remains within its - boundary.InteractiveObject
 Inherited -
-nativeDragStart -
-		 - Dispatched at the beginning of a drag operation by the InteractiveObject that is - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-nativeDragUpdate -
-		 - Dispatched during a drag operation by the InteractiveObject that is - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-paste -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - or selects 'Paste' from the text context menu.InteractiveObject
 Inherited -
-proximityBegin -
-		 - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityEnd -
-		 - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityMove -
-		 - Dispatched when the user moves an active stylus over the screen while remaining within - the proximity detection threshold.InteractiveObject
 Inherited -
-proximityOut -
-		 - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityOver -
-		 - Dispatched when the user moves an active stylus directly above this InteractiveObject - while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOut -
-		 - Dispatched when the user moves an active stylus away from this InteractiveObject - and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOver -
-		 - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - object's tree of descendents in the display list - (while remaining within the proximity detection threshold of the screen).InteractiveObject
 Inherited -
-releaseOutside -
-		 - Dispatched when a user releases the button on the pointing device after the - user first pressed the button over an InteractiveObject instance - and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 Inherited -
-rightClick -
-		 - Dispatched when a user presses and releases the right button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-rightMouseDown -
-		 - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-rightMouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-rollOut -
-		 - Dispatched when the user moves a pointing device away from an InteractiveObject - instance.InteractiveObject
 Inherited -
-rollOver -
-		 - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-selectAll -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a select all operation - or selects 'Select All' from the text context menu.InteractiveObject
 Inherited -
-softKeyboardActivate -
-		 - Dispatched immediately after the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardActivating -
-		 - Dispatched immediately before the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardDeactivate -
-		 - Dispatched immediately after the soft keyboard is lowered.InteractiveObject
 Inherited -
-tabChildrenChange -
-		 - Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited -
-tabEnabledChange -
-		 - Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited -
-tabIndexChange -
-		 - Dispatched when the value of the object's tabIndex property changes.InteractiveObject
 Inherited -
-textInput -
-		 - Dispatched when a user enters one or more - characters of text.InteractiveObject
 Inherited -
-touchBegin -
-		 - Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchEnd -
-		 - Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchMove -
-		 - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 Inherited -
-touchOut -
-		 - Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device - (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchOver -
-		 - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOut -
-		 - Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device - (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOver -
-		 - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchTap -
-		 - Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated - on a touch-enabled device (such as presses and releases a finger from a single point over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
-
- -
- -
Property detail
- - - - - -
mouseChildrenproperty
-
-mouseChildren:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Determines whether or not the children of the object are mouse, or user input device, enabled. - If an object is enabled, a user can interact with it by using a mouse or user input device. The default is true. - -

This property is useful when you create a button with an instance of the Sprite class - (instead of using the SimpleButton class). When you use a Sprite instance to create a button, - you can choose to decorate the button by using the addChild() method to add additional - Sprite instances. This process can cause unexpected behavior with mouse events because - the Sprite instances you add as children can become the target object of a mouse event - when you expect the parent instance to be the target object. To ensure that the parent - instance serves as the target objects for mouse events, you can set the - mouseChildren property of the parent instance to false.

-

No event is dispatched by setting this property. You must use the - addEventListener() method to create interactive functionality.

- Implementation -
-    public function get mouseChildren():Boolean -
-    public function set mouseChildren(value:Boolean):void -
-

-See also -

-
-flash.display.Sprite.buttonMode -
-flash.events.EventDispatcher.addEventListener() -
-
-Example -
The following example sets up a Sprite object (a type of display object container) named - container and shows that when you set its mouseChildren property to - false, the target of a mouseClick event is the container - object, not any one of its child objects: -
-
-import flash.display.Sprite;
-import flash.events.MouseEvent;
-
-var container:Sprite = new Sprite();
-container.name = "container";
-addChild(container);
-
-var circle:Sprite = new Sprite();
-circle.name = "circle";
-circle.graphics.beginFill(0xFFCC00);
-circle.graphics.drawCircle(40, 40, 40);
-
-container.addChild(circle);
-
-container.mouseChildren = false;
-
-container.addEventListener(MouseEvent.CLICK, clicked);
-
-function clicked(event:MouseEvent):void {
-    trace(event.target.name); // container
-}
-
-

-
- - - - - -
numChildrenproperty 
-
-numChildren:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns the number of children of this object. -

Implementation -
-    public function get numChildren():int -
-
-Example -
The following example sets up two Sprite objects named container1 and - container2. A Sprite is a type of display object container. The example calls the - addChild() method to set up the display hierarchy: container1 is a child of - container2, and two other display objects, circle1 and circle2, - are children of container1. The calls to the trace() method show the number - of children of each object. Note that grandchildren are not included in the numChildren count: -
-
-import flash.display.Sprite;
-
-var container1:Sprite = new Sprite();
-var container2:Sprite = new Sprite();
-
-var circle1:Sprite = new Sprite();
-circle1.graphics.beginFill(0xFFCC00);
-circle1.graphics.drawCircle(40, 40, 40);
-
-var circle2:Sprite = new Sprite();
-circle2.graphics.beginFill(0x00CCFF);
-circle2.graphics.drawCircle(80, 40, 40);
-
-container2.addChild(container1);
-container1.addChild(circle1);
-container1.addChild(circle2);
-
-trace(container1.numChildren); // 2
-trace(container2.numChildren); // 1
-trace(circle1.numChildren); // 0
-trace(circle2.numChildren); // 0
-
-

-
- - - - - -
tabChildrenproperty 
-
-tabChildren:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether the children of the object are tab enabled. Enables or disables tabbing for the - children of the object. The default is true. -

Note: Do not use the tabChildren property with Flex. - Instead, use the mx.core.UIComponent.hasFocusableChildren property.

- Implementation -
-    public function get tabChildren():Boolean -
-    public function set tabChildren(value:Boolean):void -
-
-Throws -
- - - - -
Error — Calling this property of the Stage object - throws an exception. The Stage object does not implement this property. - -
-
-Example -
The following example creates a container1 display object container and - adds two display objects, circle1 and circle2, - to its child list. The example sets tabChildren to false for the children so it can - manage its own tab order using tabIndex: -
-
-import flash.display.Sprite;
-
-var container:Sprite = new Sprite();
-container.tabChildren = false;
-
-var circle1:Sprite = new Sprite();
-circle1.graphics.beginFill(0xFFCC00);
-circle1.graphics.drawCircle(40, 40, 40);
-circle1.tabIndex = 1;
-
-var circle2:Sprite = new Sprite();
-circle2.graphics.beginFill(0x00CCFF);
-circle2.graphics.drawCircle(120, 40, 40);
-circle2.tabIndex = 0;
-
-container.addChild(circle1);
-container.addChild(circle2);
-
-
To see the results of this example, compile and run the file. When you select one of the circles, - you can press the TAB key to switch the display object that has focus (indicated by a yellow highlight rectangle). -
-
-

-
- - - - - -
textSnapshotproperty 
-
-textSnapshot:TextSnapshot  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a TextSnapshot object for this DisplayObjectContainer instance. -

Implementation -
-    public function get textSnapshot():TextSnapshot -
-

-See also -

-
-flash.text.TextSnapshot -
-
-Example -
The following example works only in the Flash authoring environment. Flex does not include any - ways of adding static text to a file. To prepare the Flash file for this example, add one or more static text fields - in the first frame of a movie. Then insert the following script into the first frame and run the file. The output - will be the static text that you added: -
-
-trace(this.textSnapshot.getText(0, this.textSnapshot.charCount));
-
-

-
- -
Constructor detail
- - - - - -
DisplayObjectContainer()constructor
-
-public function DisplayObjectContainer() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Calling the new DisplayObjectContainer() constructor throws an - ArgumentError exception. You can, however, call constructors for - the following subclasses of DisplayObjectContainer: - -

    - -
  • new Loader()
    • -
  • new Sprite()
    • -
  • new MovieClip()
    • - -
- -

- -
Method detail
- - - - - -
addChild()method
-
-public function addChild(child:DisplayObject):DisplayObject -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Adds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added - to the front (top) of all other children in this DisplayObjectContainer instance. (To add a child to a - specific index position, use the addChildAt() method.) -

If you add a child object that already has a different display object container as - a parent, the object is removed from the child list of the other display object container.

-

Note: The command stage.addChild() can cause problems with a published SWF file, - including security problems and conflicts with other loaded SWF files. There is only one Stage within a Flash runtime instance, - no matter how many SWF files you load into the runtime. So, generally, objects - should not be added to the Stage, directly, at all. The only object the Stage should - contain is the root object. Create a DisplayObjectContainer to contain all of the items on the - display list. Then, if necessary, add that DisplayObjectContainer instance to the Stage.

- Parameters - - - - -
child:DisplayObject — The DisplayObject instance to add as a child of this DisplayObjectContainer instance. -
-

-Returns - - - - -
DisplayObject — - The DisplayObject instance that you pass in the - child parameter. - - -
-
-Events - - - - -
added:Event — Dispatched when a display object is added to the display list.
-
-Throws - - - - -
ArgumentError — Throws if the child is the same as the parent. Also throws if - the caller is a child (or grandchild etc.) of the child being added. -
-

-See also -

-
-addChildAt() -
-
-Example -
The following example sets up two Sprite objects named container1 and - container2. A Sprite is a type of display object container. The example calls the - addChild() method to set up the display hierarchy: container1 is a child of - container2, and two other display objects, circle1 and circle2, - are children of container1. The calls to the trace() method show the number - of children of each object. Note that grandchildren are not included in the numChildren count: -
-
-import flash.display.Sprite;
-
-var container1:Sprite = new Sprite();
-var container2:Sprite = new Sprite();
-
-var circle1:Sprite = new Sprite();
-circle1.graphics.beginFill(0xFFCC00);
-circle1.graphics.drawCircle(40, 40, 40);
-
-var circle2:Sprite = new Sprite();
-circle2.graphics.beginFill(0x00CCFF);
-circle2.graphics.drawCircle(80, 40, 40);
-
-container2.addChild(container1);
-container1.addChild(circle1);
-container1.addChild(circle2);
-
-trace(container1.numChildren); // 2
-trace(container2.numChildren); // 1
-trace(circle1.numChildren); // 0
-trace(circle2.numChildren); // 0
-
-

-
- - - - - -
addChildAt()method 
-
-public function addChildAt(child:DisplayObject, index:int):DisplayObject -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Adds a child DisplayObject instance to this DisplayObjectContainer - instance. The child is added - at the index position specified. An index of 0 represents the back (bottom) - of the display list for this DisplayObjectContainer object. - -

For example, the following example shows three display objects, labeled a, b, and c, at - index positions 0, 2, and 1, respectively:

- -

b over c over a

- -

If you add a child object that already has a different display object container as - a parent, the object is removed from the child list of the other display object container.

- Parameters - - - - - - - - - - -
child:DisplayObject — The DisplayObject instance to add as a child of this - DisplayObjectContainer instance. - -
 
index:int — The index position to which the child is added. If you specify a - currently occupied index position, the child object that exists at that position and all - higher positions are moved up one position in the child list. -
-

-Returns - - - - -
DisplayObject — - The DisplayObject instance that you pass in the - child parameter. - - -
-
-Events - - - - -
added:Event — Dispatched when a display object is added to the display list.
-
-Throws - - - - - - - - - - -
RangeError — Throws if the index position does not exist in the child list. -
 
ArgumentError — Throws if the child is the same as the parent. Also throws if - the caller is a child (or grandchild etc.) of the child being added. -
-

-See also -

-
-addChild() -
-
-Example -
The following example creates a container display object container and - adds a display objects circle1 to its display list. Then, by calling - container.addChildAt(circle2, 0), it adds the circle2 object to index position - zero (the back), and moves the circle1 object to index position 1: -
-
-import flash.display.Sprite;
-
-var container:Sprite = new Sprite();
-
-var circle1:Sprite = new Sprite();
-var circle2:Sprite = new Sprite();
-
-container.addChild(circle1);
-container.addChildAt(circle2, 0);
-
-trace(container.getChildAt(0) == circle2); // true
-trace(container.getChildAt(1) == circle1); // true
-
-

-
- - - - - -
areInaccessibleObjectsUnderPoint()method 
-
-public function areInaccessibleObjectsUnderPoint(point:Point):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether the security restrictions - would cause any display objects to be omitted from the list returned by calling - the DisplayObjectContainer.getObjectsUnderPoint() method - with the specified point point. By default, content from one domain cannot - access objects from another domain unless they are permitted to do so with a call to the - Security.allowDomain() method. For more information, related to security, - see the Flash Player Developer Center Topic: - Security. -

The point parameter is in the coordinate space of the Stage, - which may differ from the coordinate space of the display object container (unless the - display object container is the Stage). You can use the globalToLocal() and - the localToGlobal() methods to convert points between these coordinate - spaces.

- - Parameters - - - - -
point:Point — The point under which to look. -
-

-Returns - - - - -
Boolean — - true if the point contains child display objects with security restrictions. - - - -
-

-See also -

-
-flash.system.Security.allowDomain() -
-getObjectsUnderPoint() -
-DisplayObject.globalToLocal() -
-DisplayObject.localToGlobal() -
-
-Example -
The following code creates a display object container named container. - The next block of code uses a Loader object to load a JPEG file named "test.jpg" from a remote file server. - Note that the checkPolicyFile property of the LoaderContext object used as a parameter in the - load() method is set to false. Once the file is loaded, the code calls - the loaded() method, which in turn calls container.areInaccessibleObjectsUnderPoint(), - which returns a value of true because the loaded content is assumed to be from an - inaccessible domain: -
-
-import flash.display.Sprite;
-import flash.display.Loader;
-import flash.system.LoaderContext;
-import flash.net.URLRequest;
-import flash.events.Event;
-import flash.geom.Point;
-
-var container:Sprite = new Sprite();
-
-var urlReq:URLRequest = new URLRequest("http://localhost/RemoteFile.swf");
-var ldr:Loader = new Loader();
-var context:LoaderContext = new LoaderContext();
-context.checkPolicyFile = false;
-ldr.load(urlReq, context);
-
-ldr.contentLoaderInfo.addEventListener(Event.COMPLETE, loaded);
-ldr.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, urlNotFound);
-
-function loaded(event:Event):void {
-    var pt:Point = new Point(1, 1);
-	trace(container.areInaccessibleObjectsUnderPoint(pt)); // true
-}
-
-function urlNotFound(event:Event):void {
-	trace("The URL was not found."); 
-}
-
-
This example assumes that the SWF file produced by this code is loaded from a different domain - than that of the JPEG file, and that the loaded JPEG file occupies the point (1, 1). -
-
-

-
- - - - - -
contains()method 
-
-public function contains(child:DisplayObject):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Determines whether the specified display object is a child of the DisplayObjectContainer instance or - the instance itself. - The search includes the entire display list including this DisplayObjectContainer instance. Grandchildren, - great-grandchildren, and so on each return true. -

Parameters - - - - -
child:DisplayObject — The child object to test. -
-

-Returns - - - - -
Boolean — - true if the child object is a child of the DisplayObjectContainer - or the container itself; otherwise false. - - - -
-
-Example -
The following example sets up a number of Sprite objects and adds some to the child list - of others. (A Sprite object is a type of display object container.) The relationship between various objects is - shown by calling the contains() method: -
-
-import flash.display.Sprite;
-
-var sprite1:Sprite = new Sprite();
-var sprite2:Sprite = new Sprite();
-var sprite3:Sprite = new Sprite();
-var sprite4:Sprite = new Sprite();
-
-sprite1.addChild(sprite2);
-sprite2.addChild(sprite3);
-
-trace(sprite1.contains(sprite1)); // true
-trace(sprite1.contains(sprite2)); // true
-trace(sprite1.contains(sprite3)); // true
-trace(sprite1.contains(sprite4)); // false
-
-

-
- - - - - -
getChildAt()method 
-
-public function getChildAt(index:int):DisplayObject -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns the child display object instance that exists at the specified index. -

Parameters - - - - -
index:int — The index position of the child object. -
-

-Returns - - - - -
DisplayObject — - The child display object at the specified index position. - - -
-
-Throws - - - - - - - - - - -
RangeError — Throws if the index does not exist in the child list. -
 
SecurityError — This child display object belongs to a sandbox - to which you do not have access. You can avoid this situation by having - the child movie call Security.allowDomain(). -
-

-See also -

-
-getChildByName() -
-
-Example -
The following example creates a display object container named container - and then adds a three display objects to the child list of the container object. The calls to the - getChildAt() method then reveal the positions of the child objects: -
-
-import flash.display.Sprite;
-
-var container:Sprite = new Sprite();
-
-var sprite1:Sprite = new Sprite();
-var sprite2:Sprite = new Sprite();
-var sprite3:Sprite = new Sprite();
-
-container.addChild(sprite1);
-container.addChild(sprite2);
-container.addChildAt(sprite3, 0);
-
-trace(container.getChildAt(0) == sprite3); // true
-trace(container.getChildAt(1) == sprite1); // true
-trace(container.getChildAt(2) == sprite2); // true
-
-

-
- - - - - -
getChildByName()method 
-
-public function getChildByName(name:String):DisplayObject -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns the child display object that exists with the specified name. - If more that one child display object has the specified name, - the method returns the first object in the child list. -

The getChildAt() method is faster than the - getChildByName() method. The getChildAt() method accesses - a child from a cached array, whereas the getChildByName() method - has to traverse a linked list to access a child.

- - Parameters - - - - -
name:String — The name of the child to return. - -
-

-Returns - - - - -
DisplayObject — - The child display object with the specified name. - - -
-
-Throws - - - - -
SecurityError — This child display object belongs to a sandbox - to which you do not have access. You can avoid this situation by having - the child movie call the Security.allowDomain() method. -
-

-See also -

-
-getChildAt() -
-flash.display.DisplayObject.name -
-
-Example -
The following example creates a display object container named - container and then adds two child display objects to the container. - Then, the code calls the getChildByName() and getChildIndex() - methods to return the index position of the child of the container object that - has the name "sprite1". -
-
-import flash.display.Sprite;
-import flash.display.DisplayObject;
-
-var container:Sprite = new Sprite();
-
-var sprite1:Sprite = new Sprite();
-sprite1.name = "sprite1";
-var sprite2:Sprite = new Sprite();
-sprite2.name = "sprite2";
-
-container.addChild(sprite1);
-container.addChild(sprite2);
-
-var target:DisplayObject = container.getChildByName("sprite1"); 
-trace(container.getChildIndex(target)); // 0
-
-

-
- - - - - -
getChildIndex()method 
-
-public function getChildIndex(child:DisplayObject):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns the index position of a child DisplayObject instance. -

Parameters - - - - -
child:DisplayObject — The DisplayObject instance to identify. - -
-

-Returns - - - - -
int — - The index position of the child display object to identify. - - -
-
-Throws - - - - -
ArgumentError — Throws if the child parameter is not a child of this object. - -
-
-Example -
The following example creates a display object container named - container and then adds two child display objects to the container. - Then, the code calls the getChildByName() and getChildIndex() - methods to return the index position of the child of the container object that - has the name "sprite1". -
-
-import flash.display.Sprite;
-import flash.display.DisplayObject;
-
-var container:Sprite = new Sprite();
-
-var sprite1:Sprite = new Sprite();
-sprite1.name = "sprite1";
-var sprite2:Sprite = new Sprite();
-sprite2.name = "sprite2";
-
-container.addChild(sprite1);
-container.addChild(sprite2);
-
-var target:DisplayObject = container.getChildByName("sprite1"); 
-trace(container.getChildIndex(target)); // 0
-
-

-
- - - - - -
getObjectsUnderPoint()method 
-
-public function getObjectsUnderPoint(point:Point):Array -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns an array of objects that lie under the specified point and are children - (or grandchildren, and so on) of this DisplayObjectContainer instance. Any child objects that - are inaccessible for security reasons are omitted from the returned array. To determine whether - this security restriction affects the returned array, call the - areInaccessibleObjectsUnderPoint() method. - -

The point parameter is in the coordinate space of the Stage, - which may differ from the coordinate space of the display object container (unless the - display object container is the Stage). You can use the globalToLocal() and - the localToGlobal() methods to convert points between these coordinate - spaces.

- Parameters - - - - -
point:Point — The point under which to look. - -
-

-Returns - - - - -
Array — - An array of objects that lie under the specified point and are children - (or grandchildren, and so on) of this DisplayObjectContainer instance. - - - -
-

-See also -

-
-areInaccessibleObjectsUnderPoint() -
-DisplayObject.globalToLocal() -
-DisplayObject.localToGlobal() -
-
-Example -
The following example creates a display object container named container - and then adds two overlapping child display objects to the container. Then the code calls the - getObjectsUnderPoint() twice — first using a point that touches only one object, - then using a point where the objects overlap — and the length of the return - Array shows the number of objects at each point in the container: -
-
-import flash.display.Sprite;
-import flash.geom.Point;
-
-var container:Sprite = new Sprite();
-
-var square1:Sprite = new Sprite();
-square1.graphics.beginFill(0xFFCC00);
-square1.graphics.drawRect(0, 0, 40, 40);
-
-var square2:Sprite = new Sprite();
-square2.graphics.beginFill(0x00CCFF);
-square2.graphics.drawRect(20, 0, 30, 40);
-
-container.addChild(square1);
-container.addChild(square2);
-
-var pt:Point = new Point(10, 20);
-var objects:Array = container.getObjectsUnderPoint(pt); 
-trace(objects.length); // 1
-
-pt = new Point(35, 20);
-objects = container.getObjectsUnderPoint(pt);
-trace(objects.length);  // 2
-
-

-
- - - - - -
removeChild()method 
-
-public function removeChild(child:DisplayObject):DisplayObject -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. - The parent property of the removed child is set to null - , and the object is garbage collected if no other - references to the child exist. The index positions of any display objects above the child in the - DisplayObjectContainer are decreased by 1. -

The garbage collector reallocates unused memory space. When a variable - or object is no longer actively referenced or stored somewhere, the garbage collector sweeps - through and wipes out the memory space it used to occupy if no other references to it exist.

- Parameters - - - - -
child:DisplayObject — The DisplayObject instance to remove. -
-

-Returns - - - - -
DisplayObject — - The DisplayObject instance that you pass in the - child parameter. - - -
-
-Throws - - - - -
ArgumentError — Throws if the child parameter is not a child of this object. - -
-
-Example -
The following example creates a display object container named - container and then adds two child display objects to the container. - An event listener is added to the container object, so that when the - user clicks a child object of the container, the removeChild() method - removes the child clicked from the child list of the container: -
-
- 
-import flash.display.DisplayObject;
-import flash.display.Sprite;
-import flash.events.MouseEvent;
-
-var container:Sprite = new Sprite();
-addChild(container);
-
-var circle1:Sprite = new Sprite();
-circle1.graphics.beginFill(0xFFCC00);
-circle1.graphics.drawCircle(40, 40, 40);
-
-var circle2:Sprite = new Sprite();
-circle2.graphics.beginFill(0x00CCFF);
-circle2.graphics.drawCircle(120, 40, 40);
-
-container.addChild(circle1);
-container.addChild(circle2);
-
-container.addEventListener(MouseEvent.CLICK, clicked);
-
-function clicked(event:MouseEvent):void {
-    container.removeChild(DisplayObject(event.target)); 
-}
-
-

-
- - - - - -
removeChildAt()method 
-
-public function removeChildAt(index:int):DisplayObject -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer. The parent property of the removed child is set to - null, and the object is garbage collected if no other references to the child exist. The index - positions of any display objects above the child in the DisplayObjectContainer are decreased by 1. - -

The garbage collector reallocates unused memory space. When a variable or - object is no longer actively referenced or stored somewhere, the garbage collector sweeps - through and wipes out the memory space it used to occupy if no other references to it exist.

- Parameters - - - - -
index:int — The child index of the DisplayObject to remove. -
-

-Returns - - - - -
DisplayObject — - The DisplayObject instance that was removed. - - - -
-
-Throws - - - - - - - - - - -
SecurityError — This child display object belongs to a sandbox - to which the calling object does not have access. You can avoid this situation by having - the child movie call the Security.allowDomain() method. - -
 
RangeError — Throws if the index does not exist in the child list. - -
-
-Example -
The following example creates a display object container named - container and then adds two child display objects to the container. - The code then shows that when you call the removeChildAt() method - to remove the child at the lowest index position (0), any other child object in the list - moves down one position: -
-
-import flash.display.Sprite;
-
-var container:Sprite = new Sprite();
-
-var sprite1:Sprite = new Sprite();
-sprite1.name = "sprite1";
-var sprite2:Sprite = new Sprite();
-sprite2.name = "sprite2";
-
-container.addChild(sprite1);
-container.addChild(sprite2);
-
-trace(container.numChildren) // 2
-container.removeChildAt(0); 
-trace(container.numChildren) // 1
-trace(container.getChildAt(0).name); // sprite2
-
-

-
- - - - - -
removeChildren()method 
-
-public function removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. - The parent property of the removed children is set to null - , and the objects are garbage collected if no other references to the children exist. -

The garbage collector reallocates unused memory space. When a variable - or object is no longer actively referenced or stored somewhere, the garbage collector sweeps - through and wipes out the memory space it used to occupy if no other references to it exist.

- Parameters - - - - - - - - - - -
beginIndex:int (default = 0) — The beginning position. A value smaller than 0 throws a RangeError. - -
 
endIndex:int (default = 0x7fffffff) — The ending position. A value smaller than 0 throws a RangeError. -
-
-Throws - - - - -
RangeError — Throws if the beginIndex or endIndex positions do not exist in the child list. -
-
- - - - - -
setChildIndex()method 
-
-public function setChildIndex(child:DisplayObject, index:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Changes the position of an existing child in the display object container. - This affects the layering of child objects. For example, the following example shows three - display objects, labeled a, b, and c, at index positions 0, 1, and 2, respectively: - -

c over b over a

-

When you use the setChildIndex() method and specify an index position - that is already occupied, the only positions that change are those in between the display object's former and new position. - All others will stay the same. - If a child is moved to an index LOWER than its current index, all children in between will INCREASE by 1 for their index reference. - If a child is moved to an index HIGHER than its current index, all children in between will DECREASE by 1 for their index reference. - For example, if the display object container - in the previous example is named container, you can swap the position - of the display objects labeled a and b by calling the following code:

- - 
container.setChildIndex(container.getChildAt(1), 0);
- -

This code results in the following arrangement of objects:

- -

c over a over b

- Parameters - - - - - - - - - - -
child:DisplayObject — The child DisplayObject instance for which you want to change - the index number. - -
 
index:int — The resulting index number for the child display object. -
-
-Throws - - - - - - - - - - -
RangeError — Throws if the index does not exist in the child list. -
 
ArgumentError — Throws if the child parameter is not a child of this object. -
-

-See also -

-
-addChildAt() -
-getChildIndex() -
-
-Example -
The following example creates a display object container named - container and then adds three slightly overlapping child display - objects to the container. When the user clicks any of these objects, the - clicked() method calls the setChildIndex() - method to move the clicked object to the top-most position in the child list of - the container object: -
-
-import flash.display.Sprite;
-import flash.events.MouseEvent;
-
-var container:Sprite = new Sprite();
-addChild(container);
-
-var circle1:Sprite = new Sprite();
-circle1.graphics.beginFill(0xFF0000);
-circle1.graphics.drawCircle(40, 40, 40);
-circle1.addEventListener(MouseEvent.CLICK, clicked);
- 
-var circle2:Sprite = new Sprite();
-circle2.graphics.beginFill(0x00FF00);
-circle2.graphics.drawCircle(100, 40, 40);
-circle2.addEventListener(MouseEvent.CLICK, clicked);
- 
-var circle3:Sprite = new Sprite();
-circle3.graphics.beginFill(0x0000FF);
-circle3.graphics.drawCircle(70, 80, 40);
-circle3.addEventListener(MouseEvent.CLICK, clicked);
- 
-container.addChild(circle1);
-container.addChild(circle2);
-container.addChild(circle3);
-addChild(container);
- 
-function clicked(event:MouseEvent):void {
-    var circle:Sprite = Sprite(event.target);
-    var topPosition:uint = container.numChildren - 1;
-    container.setChildIndex(circle, topPosition);
-}
-
-

-
- - - - - -
stopAllMovieClips()method 
-
-public function stopAllMovieClips():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- Recursively stops the timeline execution of all MovieClips rooted at this object. -

Child display objects belonging to a sandbox to which the excuting code does not have access are ignored.

-

Note: Streaming media playback controlled via a NetStream object will not be stopped.

- -
- - - - - -
swapChildren()method 
-
-public function swapChildren(child1:DisplayObject, child2:DisplayObject):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Swaps the z-order (front-to-back order) of the two specified child objects. All other child - objects in the display object container remain in the same index positions. -

Parameters - - - - - - - - - - -
child1:DisplayObject — The first child object. - -
 
child2:DisplayObject — The second child object. -
-
-Throws - - - - -
ArgumentError — Throws if either child parameter is not a child of this object. - -
-
-Example -
The following example creates a display object container named - container, then adds two child display objects to the container, - and then shows the effect of a call to the swapChildren() method: -
-
-import flash.display.Sprite;
-
-var container:Sprite = new Sprite();
-
-var sprite1:Sprite = new Sprite();
-sprite1.name = "sprite1";
-var sprite2:Sprite = new Sprite();
-sprite2.name = "sprite2";
-
-container.addChild(sprite1);
-container.addChild(sprite2);
-
-trace(container.getChildAt(0).name); // sprite1
-trace(container.getChildAt(1).name); // sprite2
-
-container.swapChildren(sprite1, sprite2);
-
-trace(container.getChildAt(0).name); // sprite2
-trace(container.getChildAt(1).name); // sprite1
-
-

-
- - - - - -
swapChildrenAt()method 
-
-public function swapChildrenAt(index1:int, index2:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list. All other child objects in the display object container remain in the same index positions. -

Parameters - - - - - - - - - - -
index1:int — The index position of the first child object. - -
 
index2:int — The index position of the second child object. -
-
-Throws - - - - -
RangeError — If either index does not exist in the child list. -
-
-Example -
The following example creates a display object container named - container, then adds three child display objects to the container, - and then shows how a call to the swapChildrenAt() method rearranges - the child list of the display object container: -
-
-import flash.display.Sprite;
-
-var container:Sprite = new 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";
-
-container.addChild(sprite1);
-container.addChild(sprite2);
-container.addChild(sprite3);
-
-trace(container.getChildAt(0).name); // sprite1
-trace(container.getChildAt(1).name); // sprite2
-trace(container.getChildAt(2).name); // sprite3
-
-container.swapChildrenAt(0, 2);
-
-trace(container.getChildAt(0).name); // sprite3
-trace(container.getChildAt(1).name); // sprite2
-trace(container.getChildAt(2).name); // sprite1
-
-

-
- -
Examples
-
examples\DisplayObjectContainerExample
-
The following example uses the class DisplayObjectContainerExample to - create five orange squares in succession. This task is accomplished by performing the following steps: - -
    -
  1. The constructor calls the configureAssets() method.
    2. - -
  2. The configureAssets() method creates child and - lastChild Sprite objects.
    3. - -
  3. A for loop creates the five orange squares and positions - them one after another.
    4. - -
  4. Each time a CustomSprite object is created, its constructor calls the draw() - method of the CustomSprite object, which creates a 50-by-50-pixel square - by calling the beginFill(), drawRect(), and endFill() - methods of the Graphics class. The addChild() method adds each square to the - display list.
    5. -
-
-
-
-package {
-    import flash.display.DisplayObject;
-    import flash.display.Sprite;
-
-    public class DisplayObjectContainerExample extends Sprite {
-        private var gutter:uint     = 5;
-        private var childCount:uint = 5;
-
-        public function DisplayObjectContainerExample() {
-            configureAssets();
-        }
-
-        private function configureAssets():void {
-            var child:Sprite = new CustomSprite();
-            var lastChild:Sprite = child;
-            for (var i:uint = 1; i <= childCount; i++) {
-                child = new CustomSprite();
-                child.x = lastChild.x + lastChild.width + gutter;
-                addChild(child);
-                lastChild = child;
-            }
-        }
-    }
-}
-
-import flash.display.Sprite;
-
-class CustomSprite extends Sprite {
-    private var size:uint = 50;
-    private var bgColor:uint = 0xFFCC00;
-
-    public function CustomSprite() {
-        draw(size, size);
-    }
-
-    private function draw(w:uint, h:uint):void {
-        graphics.beginFill(bgColor);
-        graphics.drawRect(0, 0, w, h);
-        graphics.endFill();
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/FocusDirection.html b/html-docs/flash/display/FocusDirection.html deleted file mode 100644 index 649d6e0..0000000 --- a/html-docs/flash/display/FocusDirection.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - -flash.display.FocusDirection (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class FocusDirection
InheritanceFocusDirection Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

-

- The FocusDirection class enumerates values to be used for the - direction parameter of the assignFocus() method - of a Stage object and for the direction property of a FocusEvent object. - -

-

-See also -

-
-flash.events.FocusEvent.direction -
-flash.display.Stage.assignFocus() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  BOTTOM : String = "bottom"
[static] - Indicates that focus should be given to the object at the end of the reading order.
-		FocusDirection
  NONE : String = "none"
[static] - Indicates that focus object within the interactive object should not change.
-		FocusDirection
  TOP : String = "top"
[static] - Indicates that focus should be given to the object at the beginning of the reading order.
-		FocusDirection
-
- -
- -
Constant detail
- - - - - -
BOTTOMconstant
-
-public static const BOTTOM:String = "bottom" -

- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that focus should be given to the object at the end of the reading order. - -

- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that focus object within the interactive object should not change. - -

- - - - - -
TOPconstant 
-
-public static const TOP:String = "top" -

- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that focus should be given to the object at the beginning of the reading order. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/FrameLabel.html b/html-docs/flash/display/FrameLabel.html deleted file mode 100644 index ff592d8..0000000 --- a/html-docs/flash/display/FrameLabel.html +++ /dev/null @@ -1,485 +0,0 @@ - - - - - - - - -flash.display.FrameLabel (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class FrameLabel
InheritanceFrameLabel Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - The FrameLabel object contains properties that specify a frame number and the - corresponding label name. - -

The MovieClip class includes a currentLabels property, which is an Array - of FrameLabel objects for the current scene. - If the MovieClip instance does not use scenes, the Array includes all - frame labels from the entire MovieClip instance.

- -

The Scene class includes a labels property, which is an Array - of FrameLabel objects for the scene.

- -

-

-See also -

-
-Scene.labels -
-MovieClip.currentLabel -
-MovieClip.currentLabels -
-MovieClip.currentScene -
-MovieClip.scenes -
-MovieClip.gotoAndPlay() -
-MovieClip.gotoAndStop() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  frame : int -
[read-only] - The frame number containing the label.
-		FrameLabel
  name : String -
[read-only] - The name of the label.
-		FrameLabel
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-FrameLabel(name:String, frame:int)
-
- Constructor.
-		FrameLabel
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-frameLabel -
-		 - Dispatched when the playhead enter a new frame, and the frame has - a FrameLabel object defined with a listener registered for the event.FrameLabel
-
- -
- -
Property detail
- - - - - -
frameproperty
-
-frame:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The frame number containing the label. -

Implementation -
-    public function get frame():int -
-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The name of the label. -

Implementation -
-    public function get name():String -
-
- -
Constructor detail
- - - - - -
FrameLabel()constructor
-
-public function FrameLabel(name:String, frame:int) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Constructor. -

Parameters - - - - - - - - - - -
name:String — The label name. -
 
frame:int — The frame number associated with the label name. - -
-
-
Event detail
- - - - - -
frameLabelevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.FRAME_LABEL -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Dispatched when the playhead enter a new frame, and the frame has - a FrameLabel object defined with a listener registered for the event. - If the playhead is not moving, or if there is only one frame, - this event is dispatched continuously based on the frame rate. -

The frameLabel event is dispatched after the - frameConstructed event.

- -

- The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to FrameLabel objects.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe FrameLabel object that is actively processing the Event - object with an event listener.
targetAny FrameLabel instance with a listener registered for the frameLabel event.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GradientType.html b/html-docs/flash/display/GradientType.html deleted file mode 100644 index f7ff7fc..0000000 --- a/html-docs/flash/display/GradientType.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - -flash.display.GradientType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class GradientType
InheritanceGradientType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The GradientType class provides values for the type parameter in the -beginGradientFill() and lineGradientStyle() methods of the flash.display.Graphics class. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  LINEAR : String = "linear"
[static] - Value used to specify a linear gradient fill.
-		GradientType
  RADIAL : String = "radial"
[static] - Value used to specify a radial gradient fill.
-		GradientType
-
- -
- -
Constant detail
- - - - - -
LINEARconstant
-
-public static const LINEAR:String = "linear" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Value used to specify a linear gradient fill. - -

- - - - - -
RADIALconstant 
-
-public static const RADIAL:String = "radial" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Value used to specify a radial gradient fill. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/Graphics.html b/html-docs/flash/display/Graphics.html deleted file mode 100644 index 2d3be13..0000000 --- a/html-docs/flash/display/Graphics.html +++ /dev/null @@ -1,3213 +0,0 @@ - - - - - - - - -flash.display.Graphics (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class Graphics
InheritanceGraphics Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The Graphics class contains a set of methods that you can use to create a vector shape. - Display objects that support drawing include Sprite and Shape objects. - Each of these classes includes a graphics property that is a Graphics object. - The following are among those helper functions provided for ease of use: - drawRect(), drawRoundRect(), - drawCircle(), and drawEllipse(). -

You cannot create a Graphics object directly from ActionScript code. - If you call new Graphics(), an exception is thrown.

-

The Graphics class is final; it cannot be subclassed.

- - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-beginBitmapFill(bitmap:BitmapData, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = false):void -
-
- Fills a drawing area with a bitmap image.
-		Graphics
   -
-beginFill(color:uint, alpha:Number = 1.0):void -
-
- Specifies a simple one-color fill that subsequent calls to other - Graphics methods (such as lineTo() or drawCircle()) use when drawing.
-		Graphics
   -
-beginGradientFill(type:String, colors:Array, alphas:Array, ratios:Array, matrix:Matrix = null, spreadMethod:String = "pad", interpolationMethod:String = "rgb", focalPointRatio:Number = 0):void -
-
- Specifies a gradient fill used by subsequent calls to other - Graphics methods (such as lineTo() or drawCircle()) for the object.
-		Graphics
   -
-beginShaderFill(shader:Shader, matrix:Matrix = null):void -
-
- Specifies a shader fill used by subsequent calls to other Graphics methods - (such as lineTo() or drawCircle()) for the object.
-		Graphics
   -
-clear():void -
-
- Clears the graphics that were drawn to this Graphics object, and resets fill and - line style settings.
-		Graphics
   -
-copyFrom(sourceGraphics:Graphics):void -
-
- Copies all of drawing commands from the source Graphics object into the - calling Graphics object.
-		Graphics
   -
-cubicCurveTo(controlX1:Number, controlY1:Number, controlX2:Number, controlY2:Number, anchorX:Number, anchorY:Number):void -
-
- Draws a cubic Bezier curve from the current drawing position to the specified anchor point.
-		Graphics
   -
-curveTo(controlX:Number, controlY:Number, anchorX:Number, anchorY:Number):void -
-
- Draws a quadratic Bezier curve using the current line style from the current drawing position - to (anchorX, anchorY) and using the control point that (controlX, - controlY) specifies.
-		Graphics
   -
-drawCircle(x:Number, y:Number, radius:Number):void -
-
- Draws a circle.
-		Graphics
   -
-drawEllipse(x:Number, y:Number, width:Number, height:Number):void -
-
- Draws an ellipse.
-		Graphics
   -
-drawGraphicsData(graphicsData:Vector.<IGraphicsData>):void -
-
- Submits a series of IGraphicsData instances for drawing.
-		Graphics
   -
-drawPath(commands:Vector.<int>, data:Vector.<Number>, winding:String = "evenOdd"):void -
-
- Submits a series of commands for drawing.
-		Graphics
   -
-drawRect(x:Number, y:Number, width:Number, height:Number):void -
-
- Draws a rectangle.
-		Graphics
   -
-drawRoundRect(x:Number, y:Number, width:Number, height:Number, ellipseWidth:Number, ellipseHeight:Number):void -
-
- Draws a rounded rectangle.
-		Graphics
   -
-drawTriangles(vertices:Vector.<Number>, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none"):void -
-
- Renders a set of triangles, typically to distort bitmaps and give them a three-dimensional appearance.
-		Graphics
   -
-endFill():void -
-
- Applies a fill to the lines and curves that were added since the last call to the - beginFill(), beginGradientFill(), or - beginBitmapFill() method.
-		Graphics
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-lineBitmapStyle(bitmap:BitmapData, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = false):void -
-
- Specifies a bitmap to use for the line stroke when drawing lines.
-		Graphics
   -
-lineGradientStyle(type:String, colors:Array, alphas:Array, ratios:Array, matrix:Matrix = null, spreadMethod:String = "pad", interpolationMethod:String = "rgb", focalPointRatio:Number = 0):void -
-
- Specifies a gradient to use for the stroke when drawing lines.
-		Graphics
   -
-lineShaderStyle(shader:Shader, matrix:Matrix = null):void -
-
- Specifies a shader to use for the line stroke when drawing lines.
-		Graphics
   -
-lineStyle(thickness:Number, color:uint = 0, alpha:Number = 1.0, pixelHinting:Boolean = false, scaleMode:String = "normal", caps:String = null, joints:String = null, miterLimit:Number = 3):void -
-
- Specifies a line style used for subsequent calls to - Graphics methods such as the lineTo() method or the drawCircle() method.
-		Graphics
   -
-lineTo(x:Number, y:Number):void -
-
- Draws a line using the current line style from the current drawing position to (x, y); - the current drawing position is then set to (x, y).
-		Graphics
   -
-moveTo(x:Number, y:Number):void -
-
- Moves the current drawing position to (x, y).
-		Graphics
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-readGraphicsData(recurse:Boolean = true):Vector.<IGraphicsData>
-
- Queries a Sprite or Shape object (and optionally, its children) for its vector - graphics content.
-		Graphics
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Method detail
- - - - - -
beginBitmapFill()method
-
-public function beginBitmapFill(bitmap:BitmapData, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Fills a drawing area with a bitmap image. The bitmap can be repeated or tiled to fill - the area. The fill remains in effect until you call the beginFill(), - beginBitmapFill(), beginGradientFill(), or beginShaderFill() method. - Calling the clear() method clears the fill. -

The application renders the fill whenever three or more points are drawn, or when - the endFill() method is called.

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
bitmap:BitmapData — A transparent or opaque bitmap image that contains the bits to be displayed. - -
 
matrix:Matrix (default = null) — A matrix object (of the flash.geom.Matrix class), which you can use to - define transformations on the bitmap. For example, you can use the following matrix - to rotate a bitmap by 45 degrees (pi/4 radians): - - 
-	 matrix = new flash.geom.Matrix(); 
-	 matrix.rotate(Math.PI / 4);
-
- -
 
repeat:Boolean (default = true) — If true, the bitmap image repeats in a tiled pattern. If - false, the bitmap image does not repeat, and the edges of the bitmap are - used for any fill area that extends beyond the bitmap. - -

For example, consider the following bitmap (a 20 x 20-pixel checkerboard pattern):

- -

20 by 20 pixel checkerboard

- -

When repeat is set to true (as in the following example), the bitmap fill - repeats the bitmap:

- -

60 by 60 pixel checkerboard

- -

When repeat is set to false, the bitmap fill uses the edge - pixels for the fill area outside the bitmap:

- -

60 by 60 pixel image with no repeating

- -
 
smooth:Boolean (default = false) — If false, upscaled bitmap images are rendered by using a - nearest-neighbor algorithm and look pixelated. If true, upscaled - bitmap images are rendered by using a bilinear algorithm. Rendering by using the nearest - neighbor algorithm is faster. -
-

-See also -

-
-endFill() -
-beginFill() -
-beginGradientFill() -
-
-Example -
The following example uses an image (image1.jpg) that is rotated and repeated to fill in a rectangle. - -
    -
  1. The image file (image1.jpg) is loaded using the Loader and URLRequest objects. - Here the file is in the same directory as the SWF file. The SWF file needs to be compiled with Local Playback - Security set to Access Local Files Only.
    2. -
  2. When the image is loaded (Event is complete), the drawImage() method is called. - The ioErrorHandler() method writes a trace comment if the image was not loaded properly.
    3. -
  3. In drawImage() method, a BitmapData object is instantiated and its width and height - are set to the image (image1.jpg). Then the source image is drawn into the BitmapData - object. Next, a rectangle is drawn in the mySprite Sprite object and the BitmapData object is used to - fill it. Using a Matrix object, the beginBitmapFill() method rotates the image 45 degrees, - then it begins filling the rectangle with the image until it is finished.
    4. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.display.BitmapData;
-    import flash.display.Loader;
-    import flash.net.URLRequest;
-    import flash.events.Event;
-    import flash.events.IOErrorEvent;
-    import flash.geom.Matrix;
-
-    public class Graphics_beginBitmapFillExample extends Sprite {
- 
-        private var url:String = "image1.jpg";
-        private var loader:Loader = new Loader();
-
-        public function Graphics_beginBitmapFillExample() {
-
-            var request:URLRequest = new URLRequest(url);
-            
-            loader.load(request);
-            loader.contentLoaderInfo.addEventListener(Event.COMPLETE, drawImage);
-            loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-        }
-
-        private function drawImage(event:Event):void {
-
-            var mySprite:Sprite = new Sprite();
-            var myBitmap:BitmapData = new BitmapData(loader.width, loader.height, false);
-  
-            myBitmap.draw(loader, new Matrix());
-            
-            var matrix:Matrix = new Matrix();
-            matrix.rotate(Math.PI/4);
-            
-            mySprite.graphics.beginBitmapFill(myBitmap, matrix, true);
-            mySprite.graphics.drawRect(100, 50, 200, 90);
-            mySprite.graphics.endFill();
-            
-            addChild(mySprite);
-        }
- 
-         private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("Unable to load image: " + url);
-        }
-    }   
-}
-
-

-
- - - - - -
beginFill()method 
-
-public function beginFill(color:uint, alpha:Number = 1.0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies a simple one-color fill that subsequent calls to other - Graphics methods (such as lineTo() or drawCircle()) use when drawing. - The fill remains in effect until you call the beginFill(), - beginBitmapFill(), beginGradientFill(), or beginShaderFill() method. - Calling the clear() method clears the fill. - -

The application renders the fill whenever three or more points are drawn, or when - the endFill() method is called.

- Parameters - - - - - - - - - - -
color:uint — The color of the fill (0xRRGGBB). -
 
alpha:Number (default = 1.0) — The alpha value of the fill (0.0 to 1.0). -
-

-See also -

-
-endFill() -
-beginBitmapFill() -
-beginGradientFill() -
-
-Example -

-
- - - - - -
beginGradientFill()method 
-
-public function beginGradientFill(type:String, colors:Array, alphas:Array, ratios:Array, matrix:Matrix = null, spreadMethod:String = "pad", interpolationMethod:String = "rgb", focalPointRatio:Number = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies a gradient fill used by subsequent calls to other - Graphics methods (such as lineTo() or drawCircle()) for the object. - The fill remains in effect until you call the beginFill(), - beginBitmapFill(), beginGradientFill(), or beginShaderFill() method. - Calling the clear() method clears the fill. -

The application renders the fill whenever three or more points are drawn, or when - the endFill() method is called.

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — A value from the GradientType class that - specifies which gradient type to use: GradientType.LINEAR or - GradientType.RADIAL. - -
 
colors:Array — An array of RGB hexadecimal color values used in the gradient; for example, - red is 0xFF0000, blue is 0x0000FF, and so on. You can specify up to 15 colors. - For each color, specify a corresponding value in the alphas and ratios parameters. - -
 
alphas:Array — An array of alpha values for the corresponding colors in the colors array; - valid values are 0 to 1. If the value is less than 0, the default is 0. If the value is - greater than 1, the default is 1. - -
 
ratios:Array — An array of color distribution ratios; valid values are 0-255. This value - defines the percentage of the width where the color is sampled at 100%. The value 0 represents - the left position in the gradient box, and 255 represents the right position in the - gradient box. - -

Note: This value represents positions in the gradient box, not the - coordinate space of the final gradient, which can be wider or thinner than the gradient box. - Specify a value for each value in the colors parameter.

- -

For example, for a linear gradient that includes two colors, blue and green, the - following example illustrates the placement of the colors in the gradient based on different values - in the ratios array:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ratiosGradient
[0, 127]linear gradient blue to green with ratios 0 and 127
[0, 255]linear gradient blue to green with ratios 0 and 255
[127, 255]linear gradient blue to green with ratios 127 and 255
- -

The values in the array must increase sequentially; for example, - [0, 63, 127, 190, 255].

- -
 
matrix:Matrix (default = null) — A transformation matrix as defined by the - flash.geom.Matrix class. The flash.geom.Matrix class includes a - createGradientBox() method, which lets you conveniently set up - the matrix for use with the beginGradientFill() method. - -
 
spreadMethod:String (default = "pad") — A value from the SpreadMethod class that - specifies which spread method to use, either: SpreadMethod.PAD, - SpreadMethod.REFLECT, or SpreadMethod.REPEAT. - -

For example, consider a simple linear gradient between two colors:

- - 
-	 import flash.geom.*
-	 import flash.display.*
-	 var fillType:String = GradientType.LINEAR;
-	 var colors:Array = [0xFF0000, 0x0000FF];
-	 var alphas:Array = [1, 1];
-	 var ratios:Array = [0x00, 0xFF];
-	 var matr:Matrix = new Matrix();
-	 matr.createGradientBox(20, 20, 0, 0, 0);
-	 var spreadMethod:String = SpreadMethod.PAD;
-	 this.graphics.beginGradientFill(fillType, colors, alphas, ratios, matr, spreadMethod);		
-	 this.graphics.drawRect(0,0,100,100);
-
- -

This example uses SpreadMethod.PAD for the spread method, and - the gradient fill looks like the following:

- -

linear gradient with SpreadMethod.PAD

-

If you use SpreadMethod.REFLECT for the spread method, the gradient fill - looks like the following:

- -

linear gradient with SpreadMethod.REFLECT

-

If you use SpreadMethod.REPEAT for the spread method, the gradient fill - looks like the following:

- -

linear gradient with SpreadMethod.REPEAT

- -
 
interpolationMethod:String (default = "rgb") — A value from the InterpolationMethod class that - specifies which value to use: InterpolationMethod.LINEAR_RGB or - InterpolationMethod.RGB - -

For example, consider a simple linear gradient between two colors (with the spreadMethod - parameter set to SpreadMethod.REFLECT). The different interpolation methods affect - the appearance as follows:

- - - - - - - - - - - - -
linear gradient with InterpolationMethod.LINEAR_RGB linear gradient with InterpolationMethod.RGB
InterpolationMethod.LINEAR_RGBInterpolationMethod.RGB
- -
 
focalPointRatio:Number (default = 0) — A number that controls the - location of the focal point of the gradient. 0 means that the focal point is in the center. 1 - means that the focal point is at one border of the gradient circle. -1 means that the focal point - is at the other border of the gradient circle. A value less than -1 or greater than - 1 is rounded to -1 or 1. For example, the following example - shows a focalPointRatio set to 0.75: - -

radial gradient with focalPointRatio set to 0.75

-
-
-Throws - - - - -
ArgumentError — If the type parameter is not valid. - -
-

-See also -

-
-endFill() -
-beginFill() -
-beginBitmapFill() -
-flash.geom.Matrix.createGradientBox() -
-flash.display.GradientType -
-flash.display.SpreadMethod -
-
- - - - - -
beginShaderFill()method 
-
-public function beginShaderFill(shader:Shader, matrix:Matrix = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a shader fill used by subsequent calls to other Graphics methods - (such as lineTo() or drawCircle()) for the object. - The fill remains in effect until you call the beginFill(), - beginBitmapFill(), beginGradientFill(), or beginShaderFill() method. - Calling the clear() method clears the fill. - -

The application renders the fill whenever three or more points are drawn, or when - the endFill() method is called.

- -

Shader fills are not supported under GPU rendering; filled areas will be colored cyan.

- - Parameters - - - - - - - - - - -
shader:Shader — The shader to use for the fill. This Shader instance is not required to - specify an image input. However, if an image input is specified in the shader, the input - must be provided manually. To specify the input, set the input property - of the corresponding ShaderInput - property of the Shader.data property. - -

When you pass a Shader instance as an argument the shader is copied internally. The - drawing fill 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 fill.

-
 
matrix:Matrix (default = null) — A matrix object (of the flash.geom.Matrix class), which you can use to - define transformations on the shader. For example, you can use the following matrix - to rotate a shader by 45 degrees (pi/4 radians): - - 
-	 matrix = new flash.geom.Matrix(); 
-	 matrix.rotate(Math.PI / 4);
-
- -

The coordinates received in the shader are based on the matrix that is specified - for the matrix parameter. For a default (null) matrix, the - coordinates in the shader are local pixel coordinates which can be used to sample an - input.

- -
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — When the shader output type is not compatible with this operation - (the shader must specify a pixel3 or pixel4 - output). - -
 
ArgumentError — When the shader specifies an image input that isn't provided. - -
 
ArgumentError — When a ByteArray or Vector.<Number> instance is used as - an input and the width - and height properties aren't specified for the - ShaderInput, or the specified values don't match the amount of - data in the input object. See the ShaderInput.input - property for more information. - -
-

-See also -

-
-endFill() -
-beginFill() -
-beginBitmapFill() -
-beginGradientFill() -
-flash.display.ShaderInput -
-
- - - - - -
clear()method 
-
-public function clear():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Clears the graphics that were drawn to this Graphics object, and resets fill and - line style settings. -

- - - - - -
copyFrom()method 
-
-public function copyFrom(sourceGraphics:Graphics):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Copies all of drawing commands from the source Graphics object into the - calling Graphics object. - -

Parameters - - - - -
sourceGraphics:Graphics — The Graphics object from which to copy the drawing commands. - -
-
- - - - - -
cubicCurveTo()method 
-
-public function cubicCurveTo(controlX1:Number, controlY1:Number, controlX2:Number, controlY2:Number, anchorX:Number, anchorY:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Draws a cubic Bezier curve from the current drawing position to the specified anchor point. - Cubic Bezier curves consist of two anchor points and two control points. The curve - interpolates the two anchor points and curves toward the two control points. -

cubic bezier

-

- The four points you use to draw a cubic Bezier curve with the cubicCurveTo() - method are as follows: -

    -
  • The current drawing position is the first anchor point.
    • -
  • The anchorX and anchorY parameters specify the second anchor point.
    • -
  • The controlX1 and controlY1 parameters specify the first control point.
    • -
  • The controlX2 and controlY2 parameters specify the second control point.
    • -
-

-

- If you call the cubicCurveTo() method before calling the moveTo() method, - your curve starts at position (0, 0). -

-

- If the cubicCurveTo() method succeeds, the Flash runtime sets the current drawing position to - (anchorX, anchorY). If the cubicCurveTo() method fails, the current - drawing position remains unchanged. -

-

- If your movie clip contains content created with the Flash drawing tools, the results of calls to the - cubicCurveTo() method are drawn underneath that content. -

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
controlX1:Number — Specifies the horizontal position of the first control - point relative to the registration point of the parent display object. -
 
controlY1:Number — Specifies the vertical position of the first control - point relative to the registration point of the parent display object. -
 
controlX2:Number — Specifies the horizontal position of the second control - point relative to the registration point of the parent display object. -
 
controlY2:Number — Specifies the vertical position of the second control - point relative to the registration point of the parent display object. -
 
anchorX:Number — Specifies the horizontal position of the anchor - point relative to the registration point of the parent display object. -
 
anchorY:Number — Specifies the vertical position of the anchor - point relative to the registration point of the parent display object. -
-
-Example -
-
-
**
- * @exampleText The following example draws a blue circular object with a width and height of 100
- * pixels, 250 pixels to the right from the registration point (0, 0) of Sprite display object. 
- *
- * <p>Draw four curves to produce a circle and fill it blue.</p>
- *   
- * <p>Note that due to the nature of the cubic Bezier equation, this is not a perfect circle.
- * The best way to draw a circle is to use the Graphics class's <code>drawCircle()</code> method.</p>
-*/
-package {
-    import flash.display.Sprite;
-    import flash.display.Shape;
-    
-    public class Graphics_cubicCurveToExample extends Sprite
-    {
-        public function Graphics_cubicCurveToExample():void
-        {
-            var rounderObject:Shape = new Shape();
-
-            rounderObject.graphics.beginFill(0x0000FF);
-            rounderObject.graphics.moveTo(250, 0);
-            rounderObject.graphics.cubicCurveTo(275, 0, 300, 25, 300, 50);
-            rounderObject.graphics.cubicCurveTo(300, 75, 275, 100, 250, 100);
-            rounderObject.graphics.cubicCurveTo(225, 100, 200, 75, 200, 50);
-            rounderObject.graphics.cubicCurveTo(200, 25, 225, 0, 250, 0);
-            rounderObject.graphics.endFill();
-            
-            this.addChild(rounderObject);
-        }
-    }
-}
-
-

-
- - - - - -
curveTo()method 
-
-public function curveTo(controlX:Number, controlY:Number, anchorX:Number, anchorY:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Draws a quadratic Bezier curve using the current line style from the current drawing position - to (anchorX, anchorY) and using the control point that (controlX, - controlY) specifies. The current drawing position is then set to - (anchorX, anchorY). If the movie clip in which you are - drawing contains content created with the Flash drawing tools, calls to the - curveTo() method are drawn underneath this content. If you call the - curveTo() method before any calls to the moveTo() method, - the default of the current drawing position is (0, 0). If any of the parameters are - missing, this method fails and the current drawing position is not changed. - -

The curve drawn is a quadratic Bezier curve. Quadratic Bezier curves - consist of two anchor points and one control point. The curve interpolates the two anchor - points and curves toward the control point.

- -

quadratic bezier

- - Parameters - - - - - - - - - - - - - - - - - - - - - - -
controlX:Number — A number that specifies the horizontal position of the control - point relative to the registration point of the parent display object. -
 
controlY:Number — A number that specifies the vertical position of the control - point relative to the registration point of the parent display object. -
 
anchorX:Number — A number that specifies the horizontal position of the next anchor - point relative to the registration point of the parent display object. -
 
anchorY:Number — A number that specifies the vertical position of the next anchor - point relative to the registration point of the parent display object. -
-
-Example -
The following example draws a green circular object with a width and height of 100 - pixels, 250 pixels to the right from the registration point (0, 0) of Sprite display object. - -

Draw four curves to produce a circle and fill it green.

- -

Note that due to the nature of the quadratic Bezier equation, this is not a perfect circle. - The best way to draw a circle is to use the Graphics class's drawCircle() method.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.display.Shape;
-    
-    public class Graphics_curveToExample1 extends Sprite
-    {
-        public function Graphics_curveToExample1():void
-        {
-            var roundObject:Shape = new Shape();
-
-            roundObject.graphics.beginFill(0x00FF00);
-            roundObject.graphics.moveTo(250, 0);
-            roundObject.graphics.curveTo(300, 0, 300, 50);
-            roundObject.graphics.curveTo(300, 100, 250, 100);
-            roundObject.graphics.curveTo(200, 100, 200, 50);
-            roundObject.graphics.curveTo(200, 0, 250, 0);
-            roundObject.graphics.endFill();
-            
-            this.addChild(roundObject);
-        }
-    }
-}
-
-

The following example draws a new moon using curveTo() method. - -

Two curve lines of 1 pixel are drawn and the space in between is filled white. The moveTo() - method is used to position the current drawing position to coordinates (100, 100). The first curve moves the drawing - position to (100, 200), its destination point. The second curve returns the position back to - the starting position (100, 100), its destination point. The horizontal control points determine - the different curve sizes.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.display.Shape;
-
-    public class Graphics_curveToExample2 extends Sprite
-    {
-        public function Graphics_curveToExample2() {
-            var newMoon:Shape = new Shape();
-            
-            newMoon.graphics.lineStyle(1, 0);
-            newMoon.graphics.beginFill(0xFFFFFF);
-            newMoon.graphics.moveTo(100, 100); 
-            newMoon.graphics.curveTo(30, 150, 100, 200);    
-            newMoon.graphics.curveTo(50, 150, 100, 100);
-            graphics.endFill();
-            
-            this.addChild(newMoon);
-        }
-    }
-}
-
-

-
- - - - - -
drawCircle()method 
-
-public function drawCircle(x:Number, y:Number, radius:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Draws a circle. Set the line style, fill, or both before - you call the drawCircle() method, by calling the linestyle(), - lineGradientStyle(), beginFill(), beginGradientFill(), - or beginBitmapFill() method. -

Parameters - - - - - - - - - - - - - - - - -
x:Number — The x location of the center of the circle relative to the - registration point of the parent display object (in pixels). - -
 
y:Number — The y location of the center of the circle relative to the - registration point of the parent display object (in pixels). - -
 
radius:Number — The radius of the circle (in pixels). -
-

-See also -

-
-drawEllipse() -
-lineStyle() -
-lineGradientStyle() -
-beginFill() -
-beginGradientFill() -
-beginBitmapFill() -
-
-Example -

-
- - - - - -
drawEllipse()method 
-
-public function drawEllipse(x:Number, y:Number, width:Number, height:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Draws an ellipse. Set the line style, fill, or both before - you call the drawEllipse() method, by calling the linestyle(), - lineGradientStyle(), beginFill(), beginGradientFill(), - or beginBitmapFill() method. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
x:Number — The x location of the top-left of the bounding-box of the ellipse relative to the - registration point of the parent display object (in pixels). - -
 
y:Number — The y location of the top left of the bounding-box of the ellipse relative to the - registration point of the parent display object (in pixels). - -
 
width:Number — The width of the ellipse (in pixels). - -
 
height:Number — The height of the ellipse (in pixels). -
-

-See also -

-
-drawCircle() -
-lineStyle() -
-lineGradientStyle() -
-beginFill() -
-beginGradientFill() -
-beginBitmapFill() -
-
-Example -
The following example uses the function drawEgg() to draw three different sized eggs - (three sizes of ellipses), depending on the eggSize parameter. -
    -
  1. The constructor calls the function drawEgg() and passes the horizontal and vertical parameters for - where the egg should be drawn, plus the type of egg (eggSize). (The height and width of the - eggs (the ellipses) can be used to decide where to display them.)
    2. -
  2. Function drawEgg() draws the different size ellipses and fills them white using - beginFill() method. There is no advance error handling written for his function.
    3. -
- -
-
-package {
-    import flash.display.Sprite;
-    import flash.display.Shape;
-
-    public class Graphics_drawEllipseExample extends Sprite
-    {
-        public static const SMALL:uint = 0;
-        public static const MEDIUM:uint = 1;
-        public static const LARGE:uint = 2;
-
-        public function Graphics_drawEllipseExample()
-        {
-            drawEgg(SMALL, 0, 100);
-            drawEgg(MEDIUM, 100, 60);
-            drawEgg(LARGE, 250, 35);    
-        }
-
-        public function drawEgg(eggSize:uint, x:Number, y:Number):void  {
-            
-            var myEgg:Shape = new Shape();
-            
-            myEgg.graphics.beginFill(0xFFFFFF);
-            myEgg.graphics.lineStyle(1);
-
-            switch(eggSize) {
-                case SMALL:
-                    myEgg.graphics.drawEllipse(x, y, 60, 70);
-                    break;
-                case MEDIUM:
-                    myEgg.graphics.drawEllipse(x, y, 120, 150);    
-                    break;
-                case LARGE:
-                    myEgg.graphics.drawEllipse(x, y, 150, 200);
-                    break;
-                default:
-                    trace ("Wrong size! There is no egg.");
-                break;            
-            }
-            
-            myEgg.graphics.endFill();
-    
-            this.addChild(myEgg);
-        }
-    }
-}
-
-

-
- - - - - -
drawGraphicsData()method 
-
-public function drawGraphicsData(graphicsData:Vector.<IGraphicsData>):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Submits a series of IGraphicsData instances for drawing. This method accepts a Vector containing objects - including paths, fills, and strokes - that implement the IGraphicsData interface. A - Vector of IGraphicsData instances can refer to a part of a shape, or a complex fully defined - set of data for rendering a complete shape. - - -

- Graphics paths can contain other graphics paths. If the graphicsData Vector - includes a path, that path and all its sub-paths are rendered during this operation. -

- Parameters - - - - -
graphicsData:Vector.<IGraphicsData> — A Vector containing graphics objects, each of which much implement the IGraphicsData interface. -
-

-See also -

-
-IGraphicsData interface -
-GraphicsBitmapFill class -
-GraphicsEndFill class -
-GraphicsGradientFill class -
-GraphicsPath class -
-GraphicsShaderFill class -
-GraphicsSolidFill class -
-GraphicsStroke class -
-GraphicsTrianglePath class -
-readGraphicsData() method -
-
-Example -
The following example creates a GraphicsGradientFill object to establish the fill properties - for a square. Then, the example creates a GraphicsStroke object (for the line thickness) and a GraphicsSolidFill - object (for the line color) to set the properties for the border line of the square. The example then creates a - GraphicsPath object to contain the values for drawing the shape. All of these objects are stored in an IGraphicsData object - and passed to the drawGraphicsData() command to render the shape. -
-
-package
-{
-    import flash.display.*;
-    import flash.geom.*;
-
-    public class DrawGraphicsDataExample extends Sprite
-    {
-        public function DrawGraphicsDataExample()
-        {
-            // establish the fill properties
-            var myFill:GraphicsGradientFill = new GraphicsGradientFill();
-            myFill.colors = [0xEEFFEE, 0x0000FF];
-            myFill.matrix = new Matrix();
-            myFill.matrix.createGradientBox(100, 100, 0);
-            
-            // establish the stroke properties
-            var myStroke:GraphicsStroke = new GraphicsStroke(2);
-            myStroke.fill = new GraphicsSolidFill(0x000000);
-            
-            // establish the path properties
-            var pathCommands = new Vector.<int>(5, true);
-            pathCommands[0] = GraphicsPathCommand.MOVE_TO;
-            pathCommands[1] = GraphicsPathCommand.LINE_TO;
-            pathCommands[2] = GraphicsPathCommand.LINE_TO;
-            pathCommands[3] = GraphicsPathCommand.LINE_TO;
-            pathCommands[4] = GraphicsPathCommand.LINE_TO;
-            
-            var pathCoordinates:Vector.<Number> = new Vector.<Number>(10, true);
-            pathCoordinates.push(10,10, 10,100, 100,100, 100,10, 10,10);
-            
-            var myPath:GraphicsPath = new GraphicsPath(pathCommands, pathCoordinates);
-            
-            // populate the IGraphicsData Vector array
-            var myDrawing:Vector.<IGraphicsData> = new Vector.<IGraphicsData>(3, true);
-            myDrawing[0] = myFill;
-            myDrawing[1] = myStroke;
-            myDrawing[2] = myPath;
-            
-            // render the drawing
-            graphics.drawGraphicsData(myDrawing);
-        }
-    }
-}
-
-

-
- - - - - -
drawPath()method 
-
-public function drawPath(commands:Vector.<int>, data:Vector.<Number>, winding:String = "evenOdd"):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Submits a series of commands for drawing. The drawPath() method accepts a Vector of - individual moveTo(), lineTo(), and curveTo() drawing commands, - combining them into a single call. The drawPath() method parameters combine drawing commands with x- and y-coordinate - value pairs and a drawing direction. The drawing commands are integers, represented as constants defined in the GraphicsPathCommand class. The - x- and y-coordinate value pairs are Numbers in an array where each pair defines a coordinate location. The drawing - direction is a value from the GraphicsPathWinding class. -

Generally, drawings render faster with drawPath() than with - a series of individual lineTo() and curveTo() method calls.

-

The drawPath() method uses a uses a floating computation so rotation and scaling - of shapes is more accurate and gives better results. However, curves submitted using the - drawPath() method can have small sub-pixel alignment errors when used in conjunction - with the lineTo() and curveTo() methods.

-

The drawPath() method also uses slightly different rules for filling and drawing lines. - They are:

-
    -
  • When a fill is applied to rendering a path: -
      -
    • A sub-path of less than 3 points is not rendered. (But note that the stroke rendering will - still occur, consistent with the rules for strokes below.)
      • -
    • A sub-path that isn't closed (the end point is not equal to the begin point) is implicitly - closed.
      • -
    -
    • -
  • When a stroke is applied to rendering a path: -
      -
    • The sub-paths can be composed of any number of points.
      • -
    • The sub-path is never implicitly closed.
      • -
    -
    • -
- Parameters - - - - - - - - - - - - - - - - -
commands:Vector.<int> — A Vector of integers representing drawing commands. The set - of accepted values is defined by the constants in the GraphicsPathCommand class. - -
 
data:Vector.<Number> — A Vector of Number instances where each pair of numbers is treated as a coordinate location (an x, y pair). - The x- and y-coordinate value pairs are not Point objects; the data vector is - a series of numbers where each group of two numbers represents a coordinate location. - -
 
winding:String (default = "evenOdd") — Specifies the winding rule using a value defined in the GraphicsPathWinding class. -
-

-See also -

-
-flash.display.GraphicsPathCommand -
-flash.display.GraphicsPathWinding -
-
-Example -
The following example populates two Vector objects, then passes them to the - drawPath() method to render a blue star. The first Vector, star_commands, contains a series of - constants representing drawing commands from the GraphicsPathCommand class. The second Vector, star_coord, contains 5 sets of x- and y-coordinate pairs. - The drawPath() method matches the commands with the positions to draw a star. -
-
-package
-{
-    import flash.display.*;
-        
-    public class DrawPathExample extends Sprite
-    {
-        public function DrawPathExample()
-        {
-            var star_commands:Vector.<int> = new Vector.<int>(5, true);
-            
-            star_commands[0] = GraphicsPathCommand.MOVE_TO;
-            star_commands[1] = GraphicsPathCommand.LINE_TO;
-            star_commands[2] = GraphicsPathCommand.LINE_TO;
-            star_commands[3] = GraphicsPathCommand.LINE_TO;
-            star_commands[4] = GraphicsPathCommand.LINE_TO;
-            
-            var star_coord:Vector.<Number> = new Vector.<Number>(10, true);
-            star_coord[0] = 66; //x
-            star_coord[1] = 10; //y 
-            star_coord[2] = 23; 
-            star_coord[3] = 127; 
-            star_coord[4] = 122; 
-            star_coord[5] = 50; 
-            star_coord[6] = 10; 
-            star_coord[7] = 49; 
-            star_coord[8] = 109; 
-            star_coord[9] = 127;
-            
-            graphics.beginFill(0x003366);
-            graphics.drawPath(star_commands, star_coord);
-        }
-    }
-}
-
-
-
Note: By default, the drawPath() method uses the even-odd winding type. So, - the center of the star is not filled. Specify the non-zero winding type for the third parameter - to fill the center of the star: - 
- graphics.drawPath(star_commands, star_coord, GraphicsPathWinding.NON_ZERO);
-
- -
-
-

-
- - - - - -
drawRect()method 
-
-public function drawRect(x:Number, y:Number, width:Number, height:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Draws a rectangle. Set the line style, fill, or both before - you call the drawRect() method, by calling the linestyle(), - lineGradientStyle(), beginFill(), beginGradientFill(), - or beginBitmapFill() method. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
x:Number — A number indicating the horizontal position relative to the - registration point of the parent display object (in pixels). - -
 
y:Number — A number indicating the vertical position relative to the - registration point of the parent display object (in pixels). - -
 
width:Number — The width of the rectangle (in pixels). - -
 
height:Number — The height of the rectangle (in pixels). -
-
-Throws - - - - -
ArgumentError — If the width or height parameters - are not a number (Number.NaN). - -
-

-See also -

-
-lineStyle() -
-lineGradientStyle() -
-beginFill() -
-beginGradientFill() -
-beginBitmapFill() -
-drawRoundRect() -
-
-Example -
The following example shows how you can draw shapes in ActionScript 3.0. - Example provided by - ActionScriptExamples.com. -
-
-var movieClip:MovieClip = new MovieClip();
-movieClip.graphics.beginFill(0xFF0000);
-movieClip.graphics.drawRect(0, 0, 100, 80);
-movieClip.graphics.endFill();
-movieClip.x = 10;
-movieClip.y = 10;
-addChild(movieClip);
-
-

-
- - - - - -
drawRoundRect()method 
-
-public function drawRoundRect(x:Number, y:Number, width:Number, height:Number, ellipseWidth:Number, ellipseHeight:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Draws a rounded rectangle. Set the line style, fill, or both before - you call the drawRoundRect() method, by calling the linestyle(), - lineGradientStyle(), beginFill(), beginGradientFill(), or - beginBitmapFill() method. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
x:Number — A number indicating the horizontal position relative to the - registration point of the parent display object (in pixels). - -
 
y:Number — A number indicating the vertical position relative to the - registration point of the parent display object (in pixels). - -
 
width:Number — The width of the round rectangle (in pixels). - -
 
height:Number — The height of the round rectangle (in pixels). - -
 
ellipseWidth:Number — The width of the ellipse used to draw the rounded corners (in pixels). -
 
ellipseHeight:Number — The height of the ellipse used to draw the rounded corners (in pixels). - Optional; if no value is specified, the default value matches that provided for the - ellipseWidth parameter. -
-
-Throws - - - - -
ArgumentError — If the width, height, ellipseWidth - or ellipseHeight parameters are not a number (Number.NaN). - -
-

-See also -

-
-lineStyle() -
-lineGradientStyle() -
-beginFill() -
-beginGradientFill() -
-beginBitmapFill() -
-drawRect() -
-
-Example -

-
- - - - - -
drawTriangles()method 
-
-public function drawTriangles(vertices:Vector.<Number>, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none"):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Renders a set of triangles, typically to distort bitmaps and give them a three-dimensional appearance. The - drawTriangles() method maps either the current fill, or a bitmap fill, to the - triangle faces using a set of (u,v) coordinates. -

- Any type of fill can be used, but if the fill has a transform matrix that - transform matrix is ignored. -

- -

- A uvtData parameter improves texture mapping when a bitmap fill is used. -

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
vertices:Vector.<Number> — A Vector of Numbers where each pair of numbers is treated as a coordinate location (an x, y pair). The - vertices parameter is required. -
 
indices:Vector.<int> (default = null) — 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 indexes[1] refers to (vertices[2], vertices[3]). - The indexes parameter is optional, but indexes generally reduce the amount of data submitted - and the amount of data computed. -
 
uvtData:Vector.<Number> (default = null) — A Vector of normalized coordinates used to apply texture mapping. - Each coordinate refers to a point on the bitmap used for the fill. - You must have one UV or one UVT coordinate per vertex. - In UV coordinates, (0,0) is the upper left of the bitmap, and (1,1) is the lower right of the bitmap. -

If the length of this vector is twice the length of the vertices vector then normalized - coordinates are used without perspective correction.

-

If the length of this vector is three times the length of the vertices 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 three dimensions.

-

If the uvtData parameter is null, then normal fill rules (and any fill type) apply.

- -
 
culling:String (default = "none") — Specifies whether to render triangles that face in a specified direction. This parameter prevents - the rendering of triangles that cannot be seen in the current view. - This parameter can be set to any value defined by the TriangleCulling class. -
-

-See also -

-
-flash.display.TriangleCulling -
-flash.display.GraphicsTrianglePath -
-
- - - - - -
endFill()method 
-
-public function endFill():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Applies a fill to the lines and curves that were added since the last call to the - beginFill(), beginGradientFill(), or - beginBitmapFill() method. Flash uses the fill that was specified in the previous - call to the beginFill(), beginGradientFill(), or beginBitmapFill() - method. If the current drawing position does not equal the previous position specified in a - moveTo() method and a fill is defined, the path is closed with a line and then - filled. -

-See also -

-
-beginFill() -
-beginBitmapFill() -
-beginGradientFill() -
-
- - - - - -
lineBitmapStyle()method 
-
-public function lineBitmapStyle(bitmap:BitmapData, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a bitmap to use for the line stroke when drawing lines. -

The bitmap line style is used for subsequent calls to Graphics - methods such as the lineTo() method or the drawCircle() method. - The line style remains in effect until you call the lineStyle() or - lineGradientStyle() methods, or the lineBitmapStyle() method - again with different parameters.

-

You can call the lineBitmapStyle() method in the middle of drawing a path - to specify different styles for different line segments within a path.

- -

Call the lineStyle() method before you call the - lineBitmapStyle() method to enable a stroke, or else the value of the line style - is undefined.

- -

Calls to the clear() method set the line style back to undefined. -

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
bitmap:BitmapData — The bitmap to use for the line stroke. -
 
matrix:Matrix (default = null) — An optional transformation matrix as defined by the flash.geom.Matrix class. - The matrix can be used to scale or otherwise manipulate the bitmap before - applying it to the line style. -
 
repeat:Boolean (default = true) — Whether to repeat the bitmap in a tiled fashion. -
 
smooth:Boolean (default = false) — Whether smoothing should be applied to the bitmap. -
-

-See also -

-
-lineStyle() -
-lineGradientStyle() -
-flash.geom.Matrix -
-
- - - - - -
lineGradientStyle()method 
-
-public function lineGradientStyle(type:String, colors:Array, alphas:Array, ratios:Array, matrix:Matrix = null, spreadMethod:String = "pad", interpolationMethod:String = "rgb", focalPointRatio:Number = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies a gradient to use for the stroke when drawing lines. -

The gradient line style is used for subsequent calls to Graphics - methods such as the lineTo() methods or the drawCircle() method. - The line style remains in effect until you call the lineStyle() or - lineBitmapStyle() methods, or the lineGradientStyle() method - again with different parameters.

-

You can call the lineGradientStyle() method in the middle of drawing a path - to specify different styles for different line segments within a path.

- -

Call the lineStyle() method before you call the - lineGradientStyle() method to enable a stroke, or else the value of the line style - is undefined.

- -

Calls to the clear() method set the line style back to undefined. -

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — A value from the GradientType class that - specifies which gradient type to use, either GradientType.LINEAR or GradientType.RADIAL. - -
 
colors:Array — An array of RGB hex color values to be used in the gradient (for example, - red is 0xFF0000, blue is 0x0000FF, and so on). - -
 
alphas:Array — An array of alpha values for the corresponding colors in the colors array; - valid values are 0 to 1. If the value is less than 0, the default is 0. If the value is - greater than 1, the default is 1. - -
 
ratios:Array — An array of color distribution ratios; valid values are from 0 to 255. This value - defines the percentage of the width where the color is sampled at 100%. The value 0 represents - the left position in the gradient box, and 255 represents the right position in the - gradient box. This value represents positions in the gradient box, not the - coordinate space of the final gradient, which can be wider or thinner than the gradient box. - Specify a value for each value in the colors parameter. - -

For example, for a linear gradient that includes two colors, blue and green, the - following figure illustrates the placement of the colors in the gradient based on different values - in the ratios array:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ratiosGradient
[0, 127]linear gradient blue to green with ratios 0 and 127
[0, 255]linear gradient blue to green with ratios 0 and 255
[127, 255]linear gradient blue to green with ratios 127 and 255
- -

The values in the array must increase, sequentially; for example, - [0, 63, 127, 190, 255].

- - -
 
matrix:Matrix (default = null) — A transformation matrix as defined by the - flash.geom.Matrix class. The flash.geom.Matrix class includes a - createGradientBox() method, which lets you conveniently set up - the matrix for use with the lineGradientStyle() method. - -
 
spreadMethod:String (default = "pad") — A value from the SpreadMethod class that - specifies which spread method to use: - -

- - - - - - - - - - - - - -
linear gradient with SpreadMethod.PADlinear gradient with SpreadMethod.REFLECTlinear gradient with SpreadMethod.REPEAT
SpreadMethod.PADSpreadMethod.REFLECTSpreadMethod.REPEAT
-

- -
 
interpolationMethod:String (default = "rgb") — A value from the InterpolationMethod class that - specifies which value to use. For example, consider a simple linear gradient between two colors (with the spreadMethod - parameter set to SpreadMethod.REFLECT). The different interpolation methods affect - the appearance as follows: - -

- - - - - - - - - - - -
linear gradient with InterpolationMethod.LINEAR_RGBlinear gradient with InterpolationMethod.RGB
InterpolationMethod.LINEAR_RGBInterpolationMethod.RGB
-

- -
 
focalPointRatio:Number (default = 0) — A number that controls the location of the focal - point of the gradient. The value 0 means the focal point is in the center. The value 1 means the focal - point is at one border of the gradient circle. The value -1 means that the focal point is - at the other border of the gradient circle. Values less than -1 or greater than 1 are - rounded to -1 or 1. The following image shows a gradient with a - focalPointRatio of -0.75: - -

radial gradient with focalPointRatio set to 0.75

- -
-

-See also -

-
-lineStyle() -
-lineBitmapStyle() -
-flash.geom.Matrix.createGradientBox() -
-flash.display.GradientType -
-flash.display.SpreadMethod -
-
-Example -
The following example draws a rectangle and a circle that use - a gradient stroke from red to green to blue. - -

The method createGradientBox() from the Matrix class is used to define the - gradient box to 200 width and 40 height. The thickness of line is set to 5 pixels. Thickness of the stroke - must be defined for lineGradientStyle() method. The gradient is set to linear. Colors for the - gradient are set to red, green, and blue. Transparency (alpha value) for the colors is set to 1 (opaque). - The distribution of gradient is even, where the colors are sampled at 100% at 0 (left-hand position in the - gradient box), 128 (middle in the box) and 255 (right-hand position in the box). The width of the rectangle - encompasses all the spectrum of the gradient, while the circle encompasses 50% from the middle of the spectrum.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.display.Shape;
-    import flash.geom.Matrix; 
-    import flash.display.GradientType;
-    
-    public class Graphics_lineGradientStyleExample extends Sprite
-    {
-        public function Graphics_lineGradientStyleExample()
-        {
-            var myShape:Shape = new Shape();
-            var gradientBoxMatrix:Matrix = new Matrix();
-  
-            gradientBoxMatrix.createGradientBox(200, 40, 0, 0, 0);  
-            
-            myShape.graphics.lineStyle(5);
-  
-            myShape.graphics.lineGradientStyle(GradientType.LINEAR, [0xFF0000,
-            0x00FF00, 0x0000FF], [1, 1, 1], [0, 128, 255], gradientBoxMatrix);
-            
-            myShape.graphics.drawRect(0, 0, 200, 40);
-            myShape.graphics.drawCircle(100, 120, 50);  
-             
-            this.addChild(myShape);
-    
-        }
-    }
-}
-
-

-
- - - - - -
lineShaderStyle()method 
-
-public function lineShaderStyle(shader:Shader, matrix:Matrix = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a shader to use for the line stroke when drawing lines. -

The shader line style is used for subsequent calls to Graphics - methods such as the lineTo() method or the drawCircle() method. - The line style remains in effect until you call the lineStyle() or - lineGradientStyle() methods, or the lineBitmapStyle() method - again with different parameters.

-

You can call the lineShaderStyle() method in the middle of drawing a path - to specify different styles for different line segments within a path.

- -

Call the lineStyle() method before you call the - lineShaderStyle() method to enable a stroke, or else the value of the line style - is undefined.

- -

Calls to the clear() method set the line style back to undefined. -

- Parameters - - - - - - - - - - -
shader:Shader — The shader to use for the line stroke. -
 
matrix:Matrix (default = null) — An optional transformation matrix as defined by the flash.geom.Matrix class. - The matrix can be used to scale or otherwise manipulate the bitmap before - applying it to the line style. -
-

-See also -

-
-lineStyle() -
-lineBitmapStyle() -
-flash.geom.Matrix -
-
- - - - - -
lineStyle()method 
-
-public function lineStyle(thickness:Number, color:uint = 0, alpha:Number = 1.0, pixelHinting:Boolean = false, scaleMode:String = "normal", caps:String = null, joints:String = null, miterLimit:Number = 3):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies a line style used for subsequent calls to - Graphics methods such as the lineTo() method or the drawCircle() method. - The line style remains in effect until you call the lineGradientStyle() - method, the lineBitmapStyle() method, or the lineStyle() method with different parameters. - -

You can call the lineStyle() method in the middle of drawing a path to specify different - styles for different line segments within the path.

- -

Note: Calls to the clear() method set the line style back to - undefined.

-

Note: Flash Lite 4 supports only the first three parameters (thickness, color, and alpha).

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
thickness:Number — An integer that indicates the thickness of the line in - points; valid values are 0-255. If a number is not specified, or if the - parameter is undefined, a line is not drawn. If a value of less than 0 is passed, - the default is 0. The value 0 indicates hairline thickness; the maximum thickness - is 255. If a value greater than 255 is passed, the default is 255. - -
 
color:uint (default = 0) — A hexadecimal color value of the line; for example, red is 0xFF0000, blue is - 0x0000FF, and so on. If a value is not indicated, the default is 0x000000 (black). Optional. - - -
 
alpha:Number (default = 1.0) — A number that indicates the alpha value of the color of the line; - valid values are 0 to 1. If a value is not indicated, the default is 1 (solid). If - the value is less than 0, the default is 0. If the value is greater than 1, the default is 1. - - -
 
pixelHinting:Boolean (default = false) — (Not supported in Flash Lite 4) A Boolean value that specifies whether to hint strokes - to full pixels. This affects both the position of anchors of a curve and the line stroke size - itself. With pixelHinting set to true, line widths are adjusted - to full pixel widths. With pixelHinting set to false, disjoints can - appear for curves and straight lines. For example, the following illustrations show how - Flash Player or Adobe AIR renders two rounded rectangles that are identical, except that the - pixelHinting parameter used in the lineStyle() method is set - differently (the images are scaled by 200%, to emphasize the difference): - -

pixelHinting false and pixelHinting true

- -

If a value is not supplied, the line does not use pixel hinting.

- -
 
scaleMode:String (default = "normal") — (Not supported in Flash Lite 4) A value from the LineScaleMode class that - specifies which scale mode to use: - -
    - -
  • - LineScaleMode.NORMAL—Always scale the line thickness when the object is scaled - (the default). -
    • - -
  • - LineScaleMode.NONE—Never scale the line thickness. -
    • - - -
  • - LineScaleMode.VERTICAL—Do not scale the line thickness if the object is scaled vertically - only. For example, consider the following circles, drawn with a one-pixel line, and each with the - scaleMode parameter set to LineScaleMode.VERTICAL. The circle on the left - is scaled vertically only, and the circle on the right is scaled both vertically and horizontally: - -

    A circle scaled vertically, and a circle scaled both vertically and horizontally.

    - -
    • - - -
  • - LineScaleMode.HORIZONTAL—Do not scale the line thickness if the object is scaled horizontally - only. For example, consider the following circles, drawn with a one-pixel line, and each with the - scaleMode parameter set to LineScaleMode.HORIZONTAL. The circle on the left - is scaled horizontally only, and the circle on the right is scaled both vertically and horizontally: - -

    A circle scaled horizontally, and a circle scaled both vertically and horizontally.

    - -
    • - - -
- - -
 
caps:String (default = null) — (Not supported in Flash Lite 4) A value from the CapsStyle class that specifies the type of caps at the end - of lines. Valid values are: CapsStyle.NONE, CapsStyle.ROUND, and CapsStyle.SQUARE. - If a value is not indicated, Flash uses round caps. -

For example, the following illustrations show the different capsStyle - settings. For each setting, the illustration shows a blue line with a thickness of 30 (for - which the capsStyle applies), and a superimposed black line with a thickness of 1 - (for which no capsStyle applies): -

-

NONE, ROUND, and SQUARE

- -
 
joints:String (default = null) — (Not supported in Flash Lite 4) A value from the JointStyle class that specifies the type of joint appearance - used at angles. Valid - values are: JointStyle.BEVEL, JointStyle.MITER, and JointStyle.ROUND. - If a value is not indicated, Flash uses round joints. - -

For example, the following illustrations show the different joints - settings. For each setting, the illustration shows an angled blue line with a thickness of - 30 (for which the jointStyle applies), and a superimposed angled black line with a - thickness of 1 (for which no jointStyle applies): -

- -

MITER, ROUND, and BEVEL

- -

Note: For joints set to JointStyle.MITER, - you can use the miterLimit parameter to limit the length of the miter.

- -
 
miterLimit:Number (default = 3) — (Not supported in Flash Lite 4) A number that indicates the limit at which a miter is cut off. - Valid values range from 1 to 255 (and values outside that range are rounded to 1 or 255). - This value is only used if the jointStyle - is set to "miter". The - miterLimit value represents the length that a miter can extend beyond the point - at which the lines meet to form a joint. The value expresses a factor of the line - thickness. For example, with a miterLimit factor of 2.5 and a - thickness of 10 pixels, the miter is cut off at 25 pixels. - -

For example, consider the following angled lines, each drawn with a thickness - of 20, but with miterLimit set to 1, 2, and 4. Superimposed are black reference - lines showing the meeting points of the joints:

- -

lines with miterLimit set to 1, 2, and 4

- -

Notice that a given miterLimit value has a specific maximum angle - for which the miter is cut off. The following table lists some examples:

- - - - - - - - - - - - - -
miterLimit value: Angles smaller than this are cut off:
1.414 90 degrees
2 60 degrees
4 30 degrees
8 15 degrees
- -
-

-See also -

-
-lineBitmapStyle() -
-lineGradientStyle() -
-LineScaleMode -
-CapsStyle -
-JointStyle -
-
-Example -

-
- - - - - -
lineTo()method 
-
-public function lineTo(x:Number, y:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Draws a line using the current line style from the current drawing position to (x, y); - the current drawing position is then set to (x, y). - If the display object in which you are drawing contains content that was created with - the Flash drawing tools, calls to the lineTo() method are drawn underneath the content. If - you call lineTo() before any calls to the moveTo() method, the - default position for the current drawing is (0, 0). If any of the parameters are missing, this - method fails and the current drawing position is not changed. -

Parameters - - - - - - - - - - -
x:Number — A number that indicates the horizontal position relative to the - registration point of the parent display object (in pixels). - -
 
y:Number — A number that indicates the vertical position relative to the - registration point of the parent display object (in pixels). -
-
-Example -
The following example draws a trapezoid using lineTo() method, starting at - pixels (100, 100). - -

The line thickness is set to 10 pixels, color is gold and opaque, caps at the end of lines - is set to none (since all lines are jointed), and the joint between the lines is set to - MITER with miter limit set to 10, to have sharp, pointed corners.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.display.LineScaleMode;
-    import flash.display.CapsStyle;
-    import flash.display.JointStyle;
-    import flash.display.Shape;
-
-
-    public class Graphics_lineToExample extends Sprite {
-
-        public function Graphics_lineToExample() {
-
-            var trapezoid:Shape = new Shape();    
-
-            trapezoid.graphics.lineStyle(10, 0xFFD700, 1, false, LineScaleMode.VERTICAL,
-                               CapsStyle.NONE, JointStyle.MITER, 10);
-
-            trapezoid.graphics.moveTo(100, 100);
- 
-            trapezoid.graphics.lineTo(120, 50);
-            trapezoid.graphics.lineTo(200, 50);
-            trapezoid.graphics.lineTo(220, 100);
-            trapezoid.graphics.lineTo(100, 100); 
-
-            this.addChild(trapezoid);
-        }
-    }
-}
-
-

-
- - - - - -
moveTo()method 
-
-public function moveTo(x:Number, y:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Moves the current drawing position to (x, y). If any of the parameters - are missing, this method fails and the current drawing position is not changed. -

Parameters - - - - - - - - - - -
x:Number — A number that indicates the horizontal position relative to the - registration point of the parent display object (in pixels). - -
 
y:Number — A number that indicates the vertical position relative to the - registration point of the parent display object (in pixels). -
-
-Example -
The following example draws a dashed line of three pixels thickness - using moveTo() and lineTo() methods. - -

Using the lineStyle() method, the line thickness is set to 3 pixels. It is also set not - to scale. Color is set to red with 25 percent opacity. The CapsStyle property is set to - square (the default is round).

- -

Since Graphics_moveToExample is an instance of the Sprite class, it has access - to all the Graphics class methods. The Graphics class methods can be used to directly draw on the - Graphic_moveToExample Sprite object. However, not putting the vector drawing object in a - Shape limits the way they can be managed, moved, or changed.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.display.CapsStyle;
-    import flash.display.LineScaleMode;
-
-    public class Graphics_moveToExample extends Sprite
-    {
-        public function Graphics_moveToExample() {
-            
-            graphics.lineStyle(3, 0x990000, 0.25, false, 
-                            LineScaleMode.NONE, CapsStyle.SQUARE);
-
-            graphics.moveTo(10, 20);
-            graphics.lineTo(20, 20);
-            graphics.moveTo(30, 20);
-            graphics.lineTo(50, 20);
-            graphics.moveTo(60, 20);
-            graphics.lineTo(80, 20);
-            graphics.moveTo(90, 20);
-            graphics.lineTo(110, 20);            
-            graphics.moveTo(120, 20);
-            graphics.lineTo(130, 20);           
-        }
-    }
-}
-
-

-
- - - - - -
readGraphicsData()method 
-
-public function readGraphicsData(recurse:Boolean = true):Vector.<IGraphicsData> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

- Queries a Sprite or Shape object (and optionally, its children) for its vector - graphics content. The result is a Vector of IGraphicsData objects. Transformations - are applied to the display object before the query, so the returned paths - are all in the same coordinate space. Coordinates in the result data set - are relative to the stage, not the display object being sampled. - -

The result includes the following types of objects, with the specified - limitations:

- -
    -
  • GraphicsSolidFill
    • -
  • GraphicsGradientFill -
      -
    • All properties of the gradient fill are returned by - readGraphicsData().
      • -
    • The matrix returned is close to, but not exactly the same as, - the input matrix.
      • -
    -
    • -
  • GraphicsEndFill
    • -
  • GraphicsBitmapFill -
      -
    • The matrix returned is close to, but not exactly the same as, - the input matrix.
      • -
    • repeat is always true.
      • -
    • smooth is always false.
      • -
    -
    • -
  • GraphicsStroke -
      -
    • thickness is supported.
      • -
    • fill supports GraphicsSolidFill, - GraphicsGradientFill, and GraphicsBitmapFill as described - previously
      • -
    • All other properties have default values.
      • -
    -
    • -
  • GraphicsPath -
      -
    • The only supported commands are MOVE_TO, CURVE_TO, and LINE_TO.
      • -
    -
    • -
- -

The following visual elements and transformations can't be represented - and are not included in the result:

- -
    -
  • Masks
    • -
  • Text, with one exception: Static text that is defined with anti-alias - type "anti-alias for animation" is rendered as vector shapes so it is included in the result.
    • -
  • Shader fills
    • -
  • Blend modes
    • -
  • 9-slice scaling
    • -
  • Triangles (created with the drawTriangles() method)
    • -
  • Opaque background
    • -
  • scrollrect settings
    • -
  • 2.5D transformations
    • -
  • Non-visible objects (objects whose visible property is - false)
    • -
- - Parameters - - - - -
recurse:Boolean (default = true) — whether the runtime should also query display object children - of the current display object. A recursive query can take more time and memory - to execute. The results are returned in a single flattened result set, not - separated by display object. -
-

-Returns - - - - -
Vector.<IGraphicsData> — A Vector of IGraphicsData objects representing the vector graphics - content of the related display object - -
-

-See also -

-
-IGraphicsData interface -
-GraphicsSolidFille class -
-GraphicsGradientFill class -
-GraphicsEndFill class -
-GraphicsStroke class -
-GraphicsBitmapFill class -
-GraphicsPath class -
-drawGraphicsData() method -
-
-Example -
The following example uses the readGraphicsData() - method to retrieve the vector graphics content of a display object. It then - redraws that content into another object on the stage when the user clicks - the stage with the mouse. - -

Note that although the original vector content is drawn using the - drawGraphicsData() method, the vector data objects retrieved by the - readGraphicsData() method do not exactly match the ones passed - in to the drawGraphicsData() method. For example, the result - data includes GraphicsSolidFill and GraphicsEndFill commands, both of which - are implied but not actually present in the original graphics data.

-
-
-package
-{
-    import flash.display.GraphicsPathCommand;
-    import flash.display.IGraphicsData;
-    import flash.display.Shape;
-    import flash.display.Sprite;
-    import flash.events.MouseEvent;
-    
-    public class ReadGraphicsDataExample extends Sprite
-    {
-        private var original:Shape;
-        private var copy:Shape;
-        
-        public function ReadGraphicsDataExample()
-        {
-            original = new Shape();
-            original.x = 50;
-            original.y = 100;
-            addChild(original);
-            
-            drawSquare();
-            
-            copy = new Shape();
-            copy.x = 250;
-            copy.y = 100;
-            addChild(copy);
-            
-            stage.addEventListener(MouseEvent.CLICK, drawCopyOnClick);
-        }
-        
-        private function drawCopyOnClick(event:MouseEvent):void
-        {
-            // reset
-            copy.graphics.clear();
-            
-            // Sample the vector data. Move the original to 0,0
-            // before sampling so that the coordinates match the 
-            // relative coordinates of the original.
-            var xPos:Number = original.x;
-            var yPos:Number = original.y;
-            original.x = 0;
-            original.y = 0;
-            var result:Vector.<IGraphicsData> = original.graphics.readGraphicsData(false);
-            original.x = xPos;
-            original.y = yPos;
-            
-            // re-draw
-            copy.graphics.drawGraphicsData(result);
-        }
-        
-        private function drawSquare():void
-        {
-            var squareCommands:Vector.<int> = new Vector.<int>(5, true);
-            
-            squareCommands[0] = GraphicsPathCommand.MOVE_TO;
-            squareCommands[1] = GraphicsPathCommand.LINE_TO;
-            squareCommands[2] = GraphicsPathCommand.LINE_TO;
-            squareCommands[3] = GraphicsPathCommand.LINE_TO;
-            
-            var squareCoordinates:Vector.<Number> = new Vector.<Number>(8, true);
-            squareCoordinates[0] = 0;
-            squareCoordinates[1] = 0; 
-            squareCoordinates[2] = 50; 
-            squareCoordinates[3] = 0; 
-            squareCoordinates[4] = 50; 
-            squareCoordinates[5] = 50; 
-            squareCoordinates[6] = 0; 
-            squareCoordinates[7] = 50; 
-            
-            original.graphics.beginFill(0x003366);
-            original.graphics.drawPath(squareCommands, squareCoordinates);
-        }
-    }
-}
-
-

-
- -
Examples
-
examples\GraphicsExample
-
The following example uses the GraphicsExample class to draw a circle, - a rounded rectangle, and a square. This task is accomplished by using the following steps: -
    -
  1. Declare a size property for later use in determining the size of each shape.
    2. -
  2. Declare properties that set the background color to orange, the border color to - dark gray, the border size to 0 pixels, the corner radius to 9 pixels, and set the space - between the stage edge and the other objects to be 5 pixels.
    3. -
  3. Use the properties declared in the preceding steps along with the built in methods of the - Graphics class to draw the circle, rounded rectangle, and square at coordinates x = 0, y = 0.
    4. -
  4. Redraw each of the shapes along the top of the stage, starting at x = 5, y = 5, with - a 5-pixel spacing between shapes.
    5. -
-
-
-
-package {
-    import flash.display.DisplayObject;
-    import flash.display.Graphics;
-    import flash.display.Shape;
-    import flash.display.Sprite;
-
-    public class GraphicsExample extends Sprite {
-        private var size:uint         = 80;
-        private var bgColor:uint      = 0xFFCC00;
-        private var borderColor:uint  = 0x666666;
-        private var borderSize:uint   = 0;
-        private var cornerRadius:uint = 9;
-        private var gutter:uint       = 5;
-
-        public function GraphicsExample() {
-            doDrawCircle();
-            doDrawRoundRect();
-            doDrawRect();
-            refreshLayout();
-        }
-
-        private function refreshLayout():void {
-            var ln:uint = numChildren;
-            var child:DisplayObject;
-            var lastChild:DisplayObject = getChildAt(0);
-            lastChild.x = gutter;
-            lastChild.y = gutter;
-            for (var i:uint = 1; i < ln; i++) {
-                child = getChildAt(i);
-                child.x = gutter + lastChild.x + lastChild.width;
-                child.y = gutter;
-                lastChild = child;
-            }
-        }
-
-        private function doDrawCircle():void {
-            var child:Shape = new Shape();
-            var halfSize:uint = Math.round(size / 2);
-            child.graphics.beginFill(bgColor);
-            child.graphics.lineStyle(borderSize, borderColor);
-            child.graphics.drawCircle(halfSize, halfSize, halfSize);
-            child.graphics.endFill();
-            addChild(child);
-        }
-
-        private function doDrawRoundRect():void {
-            var child:Shape = new Shape();
-            child.graphics.beginFill(bgColor);
-            child.graphics.lineStyle(borderSize, borderColor);
-            child.graphics.drawRoundRect(0, 0, size, size, cornerRadius);
-            child.graphics.endFill();
-            addChild(child);
-        }
-
-        private function doDrawRect():void {
-            var child:Shape = new Shape();
-            child.graphics.beginFill(bgColor);
-            child.graphics.lineStyle(borderSize, borderColor);
-            child.graphics.drawRect(0, 0, size, size);
-            child.graphics.endFill();
-            addChild(child);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GraphicsBitmapFill.html b/html-docs/flash/display/GraphicsBitmapFill.html deleted file mode 100644 index 1fa01ee..0000000 --- a/html-docs/flash/display/GraphicsBitmapFill.html +++ /dev/null @@ -1,457 +0,0 @@ - - - - - - - - -flash.display.GraphicsBitmapFill (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic final class GraphicsBitmapFill
InheritanceGraphicsBitmapFill Inheritance Object
ImplementsIGraphicsData, IGraphicsFill
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- Defines a bitmap fill. The bitmap can be smoothed, repeated or tiled to fill - the area; or manipulated using a transformation matrix. -

- Use a GraphicsBitmapFill object with the Graphics.drawGraphicsData() method. - Drawing a GraphicsBitmapFill object is the equivalent of calling the Graphics.beginBitmapFill() method. -

-

-

-See also -

-
-flash.display.Graphics.drawGraphicsData() -
-flash.display.Graphics.beginBitmapFill() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bitmapData : BitmapData -
- A transparent or opaque bitmap image.
-		GraphicsBitmapFill
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  matrix : Matrix -
- A matrix object (of the flash.geom.Matrix class) that - defines transformations on the bitmap.
-		GraphicsBitmapFill
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  repeat : Boolean -
- Specifies whether to repeat the bitmap image in a tiled pattern.
-		GraphicsBitmapFill
  smooth : Boolean -
- Specifies whether to apply a smoothing algorithm to the bitmap image.
-		GraphicsBitmapFill
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GraphicsBitmapFill(bitmapData:BitmapData = null, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = false)
-
- Creates a new GraphicsBitmapFill object.
-		GraphicsBitmapFill
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
bitmapDataproperty
-
-public var bitmapData:BitmapData -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A transparent or opaque bitmap image. -

-See also -

-
-flash.display.BitmapData -
-
- - - - - -
matrixproperty 
-
-public var matrix:Matrix -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A matrix object (of the flash.geom.Matrix class) that - defines transformations on the bitmap. For example, the following matrix - rotates a bitmap by 45 degrees (pi/4 radians): - - 

-     matrix = new flash.geom.Matrix(); 
-     matrix.rotate(Math.PI / 4);
-
-

-See also -

-
-flash.geom.Matrix -
-
- - - - - -
repeatproperty 
-
-public var repeat:Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies whether to repeat the bitmap image in a tiled pattern. -

- If true, the bitmap image repeats in a tiled pattern. If - false, the bitmap image does not repeat, and the outermost pixels along - the edges of the bitmap are used for any fill area that extends beyond the bounds of the bitmap.

- -

For example, consider the following bitmap (a 20 x 20-pixel checkerboard pattern):

- -

20 by 20 pixel checkerboard

- -

When repeat is set to true (as in the following example), the bitmap fill - repeats the bitmap:

- -

60 by 60 pixel checkerboard

- -

When repeat is set to false, the bitmap fill uses the edge - pixels for the fill area outside the bitmap:

- -

60 by 60 pixel image with no repeating

-
- - - - - -
smoothproperty 
-
-public var smooth:Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies whether to apply a smoothing algorithm to the bitmap image. -

- If false, upscaled bitmap images are rendered by using a - nearest-neighbor algorithm and look pixelated. If true, upscaled - bitmap images are rendered by using a bilinear algorithm. Rendering by using the nearest - neighbor algorithm is usually faster. -

-
- -
Constructor detail
- - - - - -
GraphicsBitmapFill()constructor
-
-public function GraphicsBitmapFill(bitmapData:BitmapData = null, matrix:Matrix = null, repeat:Boolean = true, smooth:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new GraphicsBitmapFill object. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
bitmapData:BitmapData (default = null) — A transparent or opaque bitmap image that contains the bits to display. - -
 
matrix:Matrix (default = null) — A matrix object (of the flash.geom.Matrix class), which you use to - define transformations on the bitmap. - -
 
repeat:Boolean (default = true) — If true, the bitmap image repeats in a tiled pattern. If - false, the bitmap image does not repeat, and the edges of the bitmap are - used for any fill area that extends beyond the bitmap. - -
 
smooth:Boolean (default = false) — If false, upscaled bitmap images are rendered using a - nearest-neighbor algorithm and appear pixelated. If true, upscaled - bitmap images are rendered using a bilinear algorithm. Rendering that uses the nearest-neighbor - algorithm is usually faster. -
-

-See also -

-
-flash.display.Graphics.beginBitmapFill() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GraphicsEndFill.html b/html-docs/flash/display/GraphicsEndFill.html deleted file mode 100644 index 8df2906..0000000 --- a/html-docs/flash/display/GraphicsEndFill.html +++ /dev/null @@ -1,263 +0,0 @@ - - - - - - - - -flash.display.GraphicsEndFill (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic final class GraphicsEndFill
InheritanceGraphicsEndFill Inheritance Object
ImplementsIGraphicsData, IGraphicsFill
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- Indicates the end of a graphics fill. Use a GraphicsEndFill object with the Graphics.drawGraphicsData() method. - -

- Drawing a GraphicsEndFill object is the equivalent of calling the Graphics.endFill() method. -

-

-

-See also -

-
-flash.display.Graphics.drawGraphicsData() -
-flash.display.Graphics.endFill() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GraphicsEndFill()
-
- Creates an object to use with the Graphics.drawGraphicsData() method to end - the fill, explicitly.
-		GraphicsEndFill
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
GraphicsEndFill()constructor
-
-public function GraphicsEndFill() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates an object to use with the Graphics.drawGraphicsData() method to end - the fill, explicitly. - - -

-See also -

-
-flash.display.Graphics.drawGraphicsData() -
-flash.display.Graphics.endFill() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GraphicsGradientFill.html b/html-docs/flash/display/GraphicsGradientFill.html deleted file mode 100644 index f746225..0000000 --- a/html-docs/flash/display/GraphicsGradientFill.html +++ /dev/null @@ -1,739 +0,0 @@ - - - - - - - - -flash.display.GraphicsGradientFill (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic final class GraphicsGradientFill
InheritanceGraphicsGradientFill Inheritance Object
ImplementsIGraphicsData, IGraphicsFill
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- Defines a gradient fill. -

- Use a GraphicsGradientFill object with the Graphics.drawGraphicsData() method. - Drawing a GraphicsGradientFill object is the equivalent of calling the Graphics.beginGradientFill() method. -

-

-

-See also -

-
-flash.display.Graphics.beginGradientFill() -
-flash.display.Graphics.drawGraphicsData() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  alphas : Array -
- An array of alpha values for the corresponding colors in the colors array.
-		GraphicsGradientFill
  colors : Array -
- An array of RGB hexadecimal color values to use in the gradient.
-		GraphicsGradientFill
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  focalPointRatio : Number -
- A number that controls the - location of the focal point of the gradient.
-		GraphicsGradientFill
  interpolationMethod : String -
- A value from the InterpolationMethod class that - specifies which value to use.
-		GraphicsGradientFill
  matrix : Matrix -
- A transformation matrix as defined by the - Matrix class.
-		GraphicsGradientFill
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  ratios : Array -
- An array of color distribution ratios.
-		GraphicsGradientFill
  spreadMethod : String -
- A value from the SpreadMethod class that - specifies which spread method to use.
-		GraphicsGradientFill
  type : String -
- A value from the GradientType class that - specifies which gradient type to use.
-		GraphicsGradientFill
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GraphicsGradientFill(type:String = "linear", colors:Array = null, alphas:Array = null, ratios:Array = null, matrix:* = null, spreadMethod:* = pad, interpolationMethod:String = "rgb", focalPointRatio:Number = 0.0)
-
- Creates a new GraphicsGradientFill object.
-		GraphicsGradientFill
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alphasproperty
-
-public var alphas:Array -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- An array of alpha values for the corresponding colors in the colors array. - Valid values are between 0 and 1. If the value is less than 0, 0 is used. If the value is - greater than 1, 1 is used. -

- - - - - -
colorsproperty 
-
-public var colors:Array -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- An array of RGB hexadecimal color values to use in the gradient. For example, - red is 0xFF0000, blue is 0x0000FF, and so on. You can specify up to 15 colors. - For each color, specify a corresponding value in the alphas and ratios properties. -

- - - - - -
focalPointRatioproperty 
-
-public var focalPointRatio:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A number that controls the - location of the focal point of the gradient. A value of 0 sets the focal point in the center. A value of 1 - means that the focal point is at one border of the gradient circle.A value of -1 sets the focal point - at the other border of the gradient circle. A value of less than -1 or greater than - 1 is rounded to -1 or 1, respectively. For example, the following - shows a focalPointRatio set to 0.75: - -

radial gradient with focalPointRatio set to 0.75

-
- - - - - -
interpolationMethodproperty 
-
-interpolationMethod:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A value from the InterpolationMethod class that - specifies which value to use. Valid values are: InterpolationMethod.LINEAR_RGB or - InterpolationMethod.RGB - -

For example, the following shows a simple linear gradient between two colors (with the spreadMethod - parameter set to SpreadMethod.REFLECT). The different interpolation methods change - the appearance as follows:

- - - - - - - - - - - - -
linear gradient with InterpolationMethod.LINEAR_RGB linear gradient with InterpolationMethod.RGB
InterpolationMethod.LINEAR_RGBInterpolationMethod.RGB
- Implementation -
-    public function get interpolationMethod():String -
-    public function set interpolationMethod(value:String):void -
-

-See also -

-
-flash.display.InterpolationMethod -
-
- - - - - -
matrixproperty 
-
-public var matrix:Matrix -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A transformation matrix as defined by the - Matrix class. The flash.geom.Matrix class includes a - createGradientBox() method to set up - the matrix for use with the beginGradientFill() method. -

-See also -

-
-flash.geom.Matrix.createGradientBox() -
-
- - - - - -
ratiosproperty 
-
-public var ratios:Array -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- An array of color distribution ratios. Valid values are between 0 and 255. This value - defines the percentage of the width where the color is sampled at 100%. The value 0 represents - the left position in the gradient box, and the value 255 represents the right position in the - gradient box. - -

Note: This value represents positions in the gradient box, not the - coordinate space of the final gradient which can be wider or thinner than the gradient box. - Specify a value for corresponding to each value in the colors property.

- -

For example, for a linear gradient that includes two colors (blue and green) the - following example illustrates the placement of the colors in the gradient based on different values - in the ratios array:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ratiosGradient
[0, 127]linear gradient blue to green with ratios 0 and 127
[0, 255]linear gradient blue to green with ratios 0 and 255
[127, 255]linear gradient blue to green with ratios 127 and 255
- -

The values in the array must increase sequentially; for example, - [0, 63, 127, 190, 255].

-
- - - - - -
spreadMethodproperty 
-
-spreadMethod:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A value from the SpreadMethod class that - specifies which spread method to use. Valid values are: SpreadMethod.PAD, - SpreadMethod.REFLECT, or SpreadMethod.REPEAT. - -

For example, the following shows a simple linear gradient between two colors:

- - 
-     import flash.geom.*
-     import flash.display.*
-     var fillType:String = GradientType.LINEAR;
-     var colors:Array = [0xFF0000, 0x0000FF];
-     var alphas:Array = [1, 1];
-     var ratios:Array = [0x00, 0xFF];
-     var matr:Matrix = new Matrix();
-     matr.createGradientBox(20, 20, 0, 0, 0);
-     var spreadMethod:String = SpreadMethod.PAD;
-     this.graphics.beginGradientFill(fillType, colors, alphas, ratios, matr, spreadMethod);       
-     this.graphics.drawRect(0,0,100,100);
-
- -

This example uses SpreadMethod.PAD for the spread method, and - the gradient fill looks like the following:

- -

linear gradient with SpreadMethod.PAD

-

If you use SpreadMethod.REFLECT for the spread method, the gradient fill - looks like the following:

- -

linear gradient with SpreadMethod.REFLECT

-

If you use SpreadMethod.REPEAT for the spread method, the gradient fill - looks like the following:

- -

linear gradient with SpreadMethod.REPEAT

- Implementation -
-    public function get spreadMethod():String -
-    public function set spreadMethod(value:String):void -
-

-See also -

-
-flash.display.SpreadMethod -
-
- - - - - -
typeproperty 
-
-type:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A value from the GradientType class that - specifies which gradient type to use. Values are GradientType.LINEAR or - GradientType.RADIAL. -

Implementation -
-    public function get type():String -
-    public function set type(value:String):void -
-

-See also -

-
-flash.display.GradientType -
-
- -
Constructor detail
- - - - - -
GraphicsGradientFill()constructor
-
-public function GraphicsGradientFill(type:String = "linear", colors:Array = null, alphas:Array = null, ratios:Array = null, matrix:* = null, spreadMethod:* = pad, interpolationMethod:String = "rgb", focalPointRatio:Number = 0.0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new GraphicsGradientFill object. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String (default = "linear") — A value from the GradientType class that - specifies which gradient type to use: GradientType.LINEAR or - GradientType.RADIAL. - -
 
colors:Array (default = null) — An array of RGB hexadecimal color values used in the gradient; for example, - red is 0xFF0000, blue is 0x0000FF, and so on. You can specify up to 15 colors. - For each color, specify a corresponding value in the alphas and ratios parameters. - -
 
alphas:Array (default = null) — An array of alpha values for the corresponding colors in the colors array; - valid values are 0 to 1. If the value is less than 0, 0 is used. If the value is - greater than 1, 1 is used. - -
 
ratios:Array (default = null) — An array of color distribution ratios; valid values are 0-255. This value - defines the percentage of the width where the color is sampled at 100%. The value 0 represents - the left position in the gradient box, and 255 represents the right position in the - gradient box. - -
 
matrix:* (default = null) — A transformation matrix as defined by the - flash.geom.Matrix class. The flash.geom.Matrix class includes a - createGradientBox() method, which lets you conveniently set up - the matrix for use with the beginGradientFill() method. - -
 
spreadMethod:* (default = pad) — A value from the SpreadMethod class that - specifies which spread method to use, either: SpreadMethod.PAD, - SpreadMethod.REFLECT, or SpreadMethod.REPEAT. - -
 
interpolationMethod:String (default = "rgb") — A value from the InterpolationMethod class that - specifies which value to use: InterpolationMethod.LINEAR_RGB or - InterpolationMethod.RGB - -
 
focalPointRatio:Number (default = 0.0) — A number that controls the - location of the focal point of the gradient. A value of 0 sets the focal point in the center. A value of 1 - sets the focal point at one border of the gradient circle. A value of -1 sets the focal point - at the other border of the gradient circle. A value less than -1 or greater than - 1 is rounded to -1 or 1, respectively. -
-

-See also -

-
-flash.display.Graphics.beginGradientFill() -
-flash.display.GradientType -
-flash.geom.Matrix -
-flash.display.SpreadMethod -
-flash.display.InterpolationMethod -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GraphicsPath.html b/html-docs/flash/display/GraphicsPath.html deleted file mode 100644 index f66d891..0000000 --- a/html-docs/flash/display/GraphicsPath.html +++ /dev/null @@ -1,780 +0,0 @@ - - - - - - - - -flash.display.GraphicsPath (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic final class GraphicsPath
InheritanceGraphicsPath Inheritance Object
ImplementsIGraphicsData, IGraphicsPath
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- A collection of drawing commands and the coordinate parameters for those commands. -

- Use a GraphicsPath object with the Graphics.drawGraphicsData() method. - Drawing a GraphicsPath object is the equivalent of calling the Graphics.drawPath() method. -

-

The GraphicsPath class also has its own set of methods (curveTo(), lineTo(), moveTo() - wideLineTo() and wideMoveTo()) similar to those in the Graphics class - for making adjustments to the GraphicsPath.commands and GraphicsPath.data vector arrays.

-

-

-See also -

-
-flash.display.Graphics.drawGraphicsData() -
-flash.display.Graphics.drawPath() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  commands : Vector.<int>
- The Vector of drawing commands as integers representing the path.
-		GraphicsPath
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  data : Vector.<Number>
- The Vector of Numbers containing the parameters used with the drawing commands.
-		GraphicsPath
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  winding : String -
- Specifies the winding rule using a value defined in the GraphicsPathWinding class.
-		GraphicsPath
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GraphicsPath(commands:Vector.<int> = null, data:Vector.<Number> = null, winding:String = "evenOdd")
-
- Creates a new GraphicsPath object.
-		GraphicsPath
   -
-cubicCurveTo(controlX1:Number, controlY1:Number, controlX2:Number, controlY2:Number, anchorX:Number, anchorY:Number):void -
-
- Adds a new "cubicCurveTo" command to the commands vector and - new coordinates to the data vector.
-		GraphicsPath
   -
-curveTo(controlX:Number, controlY:Number, anchorX:Number, anchorY:Number):void -
-
- Adds a new "curveTo" command to the commands vector and - new coordinates to the data vector.
-		GraphicsPath
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-lineTo(x:Number, y:Number):void -
-
- Adds a new "lineTo" command to the commands vector and - new coordinates to the data vector.
-		GraphicsPath
   -
-moveTo(x:Number, y:Number):void -
-
- Adds a new "moveTo" command to the commands vector and - new coordinates to the data vector.
-		GraphicsPath
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
   -
-wideLineTo(x:Number, y:Number):void -
-
- Adds a new "wideLineTo" command to the commands vector and - new coordinates to the data vector.
-		GraphicsPath
   -
-wideMoveTo(x:Number, y:Number):void -
-
- Adds a new "wideMoveTo" command to the commands vector and - new coordinates to the data vector.
-		GraphicsPath
-
- -
- -
Property detail
- - - - - -
commandsproperty
-
-public var commands:Vector.<int> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The Vector of drawing commands as integers representing the path. Each command can be one of the values defined - by the GraphicsPathCommand class. -

-See also -

-
-flash.display.GraphicsPathCommand -
-
- - - - - -
dataproperty 
-
-public var data:Vector.<Number> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The Vector of Numbers containing the parameters used with the drawing commands. -

- - - - - -
windingproperty 
-
-winding:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the winding rule using a value defined in the GraphicsPathWinding class. -

Implementation -
-    public function get winding():String -
-    public function set winding(value:String):void -
-

-See also -

-
-flash.display.GraphicsPathWinding -
-
- -
Constructor detail
- - - - - -
GraphicsPath()constructor
-
-public function GraphicsPath(commands:Vector.<int> = null, data:Vector.<Number> = null, winding:String = "evenOdd") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new GraphicsPath object. -

Parameters - - - - - - - - - - - - - - - - -
commands:Vector.<int> (default = null) — A Vector of integers representing commands defined by the GraphicsPathCommand class. -
 
data:Vector.<Number> (default = null) — A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair). -
 
winding:String (default = "evenOdd") — Specifies the winding rule using a value defined in the GraphicsPathWinding class. -
-

-See also -

-
-flash.display.GraphicsPathCommand -
-flash.display.GraphicsPathWinding -
-
- -
Method detail
- - - - - -
cubicCurveTo()method
-
-public function cubicCurveTo(controlX1:Number, controlY1:Number, controlX2:Number, controlY2:Number, anchorX:Number, anchorY:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Adds a new "cubicCurveTo" command to the commands vector and - new coordinates to the data vector. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
controlX1:Number — A number that specifies the horizontal position of the first control - point relative to the registration point of the parent display object. -
 
controlY1:Number — A number that specifies the vertical position of the first control - point relative to the registration point of the parent display object. -
 
controlX2:Number — A number that specifies the horizontal position of the second control - point relative to the registration point of the parent display object. -
 
controlY2:Number — A number that specifies the vertical position of the second control - point relative to the registration point of the parent display object. -
 
anchorX:Number — A number that specifies the horizontal position of the next anchor - point relative to the registration point of the parent display object. -
 
anchorY:Number — A number that specifies the vertical position of the next anchor - point relative to the registration point of the parent display object. - -
-

-See also -

-
-flash.display.GraphicsPathCommand.CUBIC_CURVE_TO -
-flash.display.Graphics.curveTo() -
-
- - - - - -
curveTo()method 
-
-public function curveTo(controlX:Number, controlY:Number, anchorX:Number, anchorY:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Adds a new "curveTo" command to the commands vector and - new coordinates to the data vector. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
controlX:Number — A number that specifies the horizontal position of the control - point relative to the registration point of the parent display object. -
 
controlY:Number — A number that specifies the vertical position of the control - point relative to the registration point of the parent display object. -
 
anchorX:Number — A number that specifies the horizontal position of the next anchor - point relative to the registration point of the parent display object. -
 
anchorY:Number — A number that specifies the vertical position of the next anchor - point relative to the registration point of the parent display object. - -
-

-See also -

-
-flash.display.GraphicsPathCommand.CURVE_TO -
-flash.display.Graphics.curveTo() -
-
- - - - - -
lineTo()method 
-
-public function lineTo(x:Number, y:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Adds a new "lineTo" command to the commands vector and - new coordinates to the data vector. -

Parameters - - - - - - - - - - -
x:Number — The x coordinate of the destination point for the line. -
 
y:Number — The y coordinate of the destination point for the line. - -
-

-See also -

-
-flash.display.GraphicsPathCommand.LINE_TO -
-flash.display.Graphics.lineTo() -
-
- - - - - -
moveTo()method 
-
-public function moveTo(x:Number, y:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Adds a new "moveTo" command to the commands vector and - new coordinates to the data vector. - -

Parameters - - - - - - - - - - -
x:Number — The x coordinate of the destination point. -
 
y:Number — The y coordinate of the destination point. -
-

-See also -

-
-flash.display.GraphicsPathCommand.MOVE_TO -
-flash.display.Graphics.moveTo() -
-
- - - - - -
wideLineTo()method 
-
-public function wideLineTo(x:Number, y:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Adds a new "wideLineTo" command to the commands vector and - new coordinates to the data vector. -

Parameters - - - - - - - - - - -
x:Number — The x-coordinate of the destination point for the line. -
 
y:Number — The y-coordinate of the destination point for the line. - -
-

-See also -

-
-flash.display.GraphicsPathCommand.WIDE_LINE_TO -
-
- - - - - -
wideMoveTo()method 
-
-public function wideMoveTo(x:Number, y:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Adds a new "wideMoveTo" command to the commands vector and - new coordinates to the data vector. -

Parameters - - - - - - - - - - -
x:Number — The x-coordinate of the destination point. -
 
y:Number — The y-coordinate of the destination point. - -
-

-See also -

-
-flash.display.GraphicsPathCommand.WIDE_MOVE_TO -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GraphicsPathCommand.html b/html-docs/flash/display/GraphicsPathCommand.html deleted file mode 100644 index d2f0d14..0000000 --- a/html-docs/flash/display/GraphicsPathCommand.html +++ /dev/null @@ -1,482 +0,0 @@ - - - - - - - - -flash.display.GraphicsPathCommand (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class GraphicsPathCommand
InheritanceGraphicsPathCommand Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- Defines the values to use for specifying path-drawing commands. - -

The values in this class are used by the Graphics.drawPath() method, - or stored in the commands vector of a GraphicsPath object.

-

-

-See also -

-
-flash.display.Graphics.drawPath() -
-flash.display.GraphicsPath.commands -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  CUBIC_CURVE_TO : int = 6
[static] - Specifies a drawing command that draws a curve from the current drawing position to the x- and y-coordinates - specified in the data vector, using a 2 control points.
-		GraphicsPathCommand
  CURVE_TO : int = 3
[static] - Specifies a drawing command that draws a curve from the current drawing position to the x- and y-coordinates - specified in the data vector, using a control point.
-		GraphicsPathCommand
  LINE_TO : int = 2
[static] - Specifies a drawing command that draws a line from the current drawing position to the x- and y-coordinates - specified in the data vector.
-		GraphicsPathCommand
  MOVE_TO : int = 1
[static] - Specifies a drawing command that moves the current drawing position to the x- and y-coordinates specified in the data vector.
-		GraphicsPathCommand
  NO_OP : int = 0
[static] - Represents the default "do nothing" command.
-		GraphicsPathCommand
  WIDE_LINE_TO : int = 5
[static] - Specifies a "line to" drawing command, but uses two sets of coordinates (four values) instead of one set.
-		GraphicsPathCommand
  WIDE_MOVE_TO : int = 4
[static] - Specifies a "move to" drawing command, but uses two sets of coordinates (four values) instead of one set.
-		GraphicsPathCommand
-
- -
- -
Constant detail
- - - - - -
CUBIC_CURVE_TOconstant
-
-public static const CUBIC_CURVE_TO:int = 6 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a drawing command that draws a curve from the current drawing position to the x- and y-coordinates - specified in the data vector, using a 2 control points. -

-See also -

-
-flash.display.Graphics.cubicCurveTo() -
-
- - - - - -
CURVE_TOconstant 
-
-public static const CURVE_TO:int = 3 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a drawing command that draws a curve from the current drawing position to the x- and y-coordinates - specified in the data vector, using a control point. - This command produces the same effect as the Graphics.lineTo() method, and - uses two points in the data vector control and anchor: (cx, cy, ax, ay ). -

-See also -

-
-flash.display.Graphics.curveTo() -
-
- - - - - -
LINE_TOconstant 
-
-public static const LINE_TO:int = 2 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a drawing command that draws a line from the current drawing position to the x- and y-coordinates - specified in the data vector. - This command produces the same effect as the Graphics.lineTo() method, and - uses one point in the data vector: (x,y). -

-See also -

-
-flash.display.Graphics.lineTo() -
-
- - - - - -
MOVE_TOconstant 
-
-public static const MOVE_TO:int = 1 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a drawing command that moves the current drawing position to the x- and y-coordinates specified in the data vector. - This command produces the same effect as the Graphics.moveTo() method, and - uses one point in the data vector: (x,y). -

-See also -

-
-flash.display.Graphics.moveTo() -
-
- - - - - -
NO_OPconstant 
-
-public static const NO_OP:int = 0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Represents the default "do nothing" command. -

- - - - - -
WIDE_LINE_TOconstant 
-
-public static const WIDE_LINE_TO:int = 5 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a "line to" drawing command, but uses two sets of coordinates (four values) instead of one set. - This command allows you to switch between "line to" and "curve to" commands without changing the number of data values used per command. - This command uses two sets in the data vector: one dummy location and one (x,y) location. - -

The WIDE_LINE_TO and WIDE_MOVE_TO command variants consume the same number of parameters - as does the CURVE_TO command.

-

-See also -

-
-LINE_TO -
-flash.display.Graphics.lineTo() -
-
- - - - - -
WIDE_MOVE_TOconstant 
-
-public static const WIDE_MOVE_TO:int = 4 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a "move to" drawing command, but uses two sets of coordinates (four values) instead of one set. - This command allows you to switch between "move to" and "curve to" commands without changing the number of data values used per command. - This command uses two sets in the data vector: one dummy location and one (x,y) location. -

The WIDE_LINE_TO and WIDE_MOVE_TO command variants consume the same number of parameters - as does the CURVE_TO command.

-

-See also -

-
-MOVE_TO -
-flash.display.Graphics.moveTo() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GraphicsPathWinding.html b/html-docs/flash/display/GraphicsPathWinding.html deleted file mode 100644 index 74ad3ec..0000000 --- a/html-docs/flash/display/GraphicsPathWinding.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - - - - -flash.display.GraphicsPathWinding (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class GraphicsPathWinding
InheritanceGraphicsPathWinding Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-

-The GraphicsPathWinding class provides values for the flash.display.GraphicsPath.winding property -and the flash.display.Graphics.drawPath() method -to determine the direction to draw a path. -A clockwise path is positively wound, and -a counter-clockwise path is negatively wound: -

positive and negative winding directions

-

When paths intersect or overlap, the winding -direction determines the rules for filling the areas created by the intersection or overlap:

-

a comparison of even-odd and non-zero winding rules

-

-

-See also -

-
-flash.display.GraphicsPath.winding -
-flash.display.Graphics.drawPath() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  EVEN_ODD : String = "evenOdd"
[static] -Establishes the even-odd winding type.
-		GraphicsPathWinding
  NON_ZERO : String = "nonZero"
[static] -Establishes the non-zero winding type.
-		GraphicsPathWinding
-
- -
- -
Constant detail
- - - - - -
EVEN_ODDconstant
-
-public static const EVEN_ODD:String = "evenOdd" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-Establishes the even-odd winding type. The even-odd winding type is the rule used by all of the -original drawing API and is the default type for the flash.display.Graphics.drawPath() method. -Any overlapping paths will alternate between open and closed fills. If two squares drawn with the same fill -intersect, the area of the intersection is not filled. Adjacent areas are not the same (neither both filled nor both unfilled). - -

- - - - - -
NON_ZEROconstant 
-
-public static const NON_ZERO:String = "nonZero" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-Establishes the non-zero winding type. The non-zero winding type determines that -when paths of opposite winding intersect, the intersection area is unfilled (as with the even-odd winding type). -For paths of the same winding, the intersection area is filled. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GraphicsShaderFill.html b/html-docs/flash/display/GraphicsShaderFill.html deleted file mode 100644 index e135a98..0000000 --- a/html-docs/flash/display/GraphicsShaderFill.html +++ /dev/null @@ -1,366 +0,0 @@ - - - - - - - - -flash.display.GraphicsShaderFill (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic final class GraphicsShaderFill
InheritanceGraphicsShaderFill Inheritance Object
ImplementsIGraphicsData, IGraphicsFill
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-

- Defines a shader fill. -

- Use a GraphicsShaderFill object with the Graphics.drawGraphicsData() method. - Drawing a GraphicsShaderFill object is the equivalent of calling the Graphics.beginShaderFill() method. -

-

-

-See also -

-
-flash.display.Graphics.beginShaderFill() -
-flash.display.Graphics.drawGraphicsData() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  matrix : Matrix -
- A matrix object (of the flash.geom.Matrix class), which you can use to - define transformations on the shader.
-		GraphicsShaderFill
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  shader : Shader -
- The shader to use for the fill.
-		GraphicsShaderFill
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GraphicsShaderFill(shader:Shader = null, matrix:Matrix = null)
-
- Creates a new GraphicsShaderFill object.
-		GraphicsShaderFill
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
matrixproperty
-
-public var matrix:Matrix -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- A matrix object (of the flash.geom.Matrix class), which you can use to - define transformations on the shader. For example, you can use the following matrix - to rotate a shader by 45 degrees (pi/4 radians): - - 

-     matrix = new flash.geom.Matrix(); 
-     matrix.rotate(Math.PI / 4);
-
- -

The coordinates received in the shader are based on the matrix that is specified - for the matrix parameter. For a default (null) matrix, the - coordinates in the shader are local pixel coordinates which can be used to sample an - input.

-

-See also -

-
-flash.geom.Matrix -
-
- - - - - -
shaderproperty 
-
-public var shader:Shader -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- The shader to use for the fill. This Shader instance is not required to - specify an image input. However, if an image input is specified in the shader, the input - must be provided manually by setting the input property of the corresponding ShaderInput - property of the Shader.data property. - -

When you pass a Shader instance as an argument the shader is copied internally and the - drawing fill 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 fill.

-

-See also -

-
-flash.display.Shader -
-
- -
Constructor detail
- - - - - -
GraphicsShaderFill()constructor
-
-public function GraphicsShaderFill(shader:Shader = null, matrix:Matrix = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Creates a new GraphicsShaderFill object. -

Parameters - - - - - - - - - - -
shader:Shader (default = null) — The shader to use for the fill. This Shader instance is not required to - specify an image input. However, if an image input is specified in the shader, the input - must be provided manually by setting the input property of the corresponding ShaderInput - property of the Shader.data property. -
 
matrix:Matrix (default = null) — A matrix object (of the flash.geom.Matrix class), which you can use to - define transformations on the shader. -
-

-See also -

-
-flash.geom.Matrix -
-flash.display.Shader -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GraphicsSolidFill.html b/html-docs/flash/display/GraphicsSolidFill.html deleted file mode 100644 index 0f03b30..0000000 --- a/html-docs/flash/display/GraphicsSolidFill.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - - - - - -flash.display.GraphicsSolidFill (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic final class GraphicsSolidFill
InheritanceGraphicsSolidFill Inheritance Object
ImplementsIGraphicsData, IGraphicsFill
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- Defines a solid fill. -

- Use a GraphicsSolidFill object with the Graphics.drawGraphicsData() method. - Drawing a GraphicsSolidFill object is the equivalent of calling the Graphics.beginFill() method. -

-

-

-See also -

-
-flash.display.Graphics.beginFill() -
-flash.display.Graphics.drawGraphicsData() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
  alpha : Number = 1.0
- Indicates the alpha transparency value of the fill.
-		GraphicsSolidFill
  color : uint = 0
- The color of the fill.
-		GraphicsSolidFill
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GraphicsSolidFill(color:uint = 0, alpha:Number = 1.0)
-
- Creates a new GraphicsSolidFill object.
-		GraphicsSolidFill
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alphaproperty
-
-public var alpha:Number = 1.0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Indicates the alpha transparency value of the fill. Valid values are 0 (fully transparent) to 1 (fully opaque). - The default value is 1. Display objects with alpha set to 0 are active, even though they are invisible. -

- - - - - -
colorproperty 
-
-public var color:uint = 0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- The color of the fill. Valid values are in the hexadecimal format 0xRRGGBB. The default value is 0xFF0000 (or the uint 0). -

- -
Constructor detail
- - - - - -
GraphicsSolidFill()constructor
-
-public function GraphicsSolidFill(color:uint = 0, alpha:Number = 1.0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Creates a new GraphicsSolidFill object. -

Parameters - - - - - - - - - - -
color:uint (default = 0) — The color value. Valid values are in the hexadecimal format 0xRRGGBB. -
 
alpha:Number (default = 1.0) — The alpha transparency value. Valid values are 0 (fully transparent) to 1 (fully opaque). -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GraphicsStroke.html b/html-docs/flash/display/GraphicsStroke.html deleted file mode 100644 index 3c0e18c..0000000 --- a/html-docs/flash/display/GraphicsStroke.html +++ /dev/null @@ -1,770 +0,0 @@ - - - - - - - - -flash.display.GraphicsStroke (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic final class GraphicsStroke
InheritanceGraphicsStroke Inheritance Object
ImplementsIGraphicsData, IGraphicsStroke
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-

- Defines a line style or stroke. -

- Use a GraphicsStroke object with the Graphics.drawGraphicsData() method. - Drawing a GraphicsStroke object is the equivalent of calling one of the methods of the Graphics - class that sets the line style, such as the Graphics.lineStyle() method, the - Graphics.lineBitmapStyle() method, or the Graphics.lineGradientStyle() - method. -

-

-

-See also -

-
-flash.display.Graphics.lineStyle() -
-flash.display.Graphics.lineBitmapStyle() -
-flash.display.Graphics.lineGradientStyle() -
-flash.display.Graphics.drawGraphicsData() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  caps : String -
- Specifies the type of caps at the end - of lines.
-		GraphicsStroke
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fill : IGraphicsFill -
- Specifies the instance containing data for filling a stroke.
-		GraphicsStroke
  joints : String -
- Specifies the type of joint appearance - used at angles.
-		GraphicsStroke
  miterLimit : Number -
- Indicates the limit at which a miter is cut off.
-		GraphicsStroke
  pixelHinting : Boolean -
- Specifies whether to hint strokes - to full pixels.
-		GraphicsStroke
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  scaleMode : String -
- Specifies the stroke thickness scaling.
-		GraphicsStroke
  thickness : Number -
- Indicates the thickness of the line in - points; valid values are 0-255.
-		GraphicsStroke
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GraphicsStroke(thickness:Number, pixelHinting:Boolean = false, scaleMode:String = "normal", caps:String = "none", joints:String = "round", miterLimit:Number = 3.0, fill:IGraphicsFill = null)
-
- Creates a new GraphicsStroke object.
-		GraphicsStroke
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
capsproperty
-
-caps:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Specifies the type of caps at the end - of lines. Valid values are: CapsStyle.NONE, CapsStyle.ROUND, and CapsStyle.SQUARE. - If a value is not indicated, Flash uses round caps. -

For example, the following illustrations show the different capsStyle - settings. For each setting, the illustration shows a blue line with a thickness of 30 (for - which the capsStyle applies), and a superimposed black line with a thickness of 1 - (for which no capsStyle applies): -

-

NONE, ROUND, and SQUARE

- Implementation -
-    public function get caps():String -
-    public function set caps(value:String):void -
-

-See also -

-
-flash.display.CapsStyle -
-
- - - - - -
fillproperty 
-
-public var fill:IGraphicsFill -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Specifies the instance containing data for filling a stroke. An IGraphicsFill - instance can represent a series of fill commands. -

-See also -

-
-flash.display.IGraphicsFill -
-
- - - - - -
jointsproperty 
-
-joints:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Specifies the type of joint appearance - used at angles. Valid - values are: JointStyle.BEVEL, JointStyle.MITER, and JointStyle.ROUND. - If a value is not indicated, Flash uses round joints. - -

For example, the following illustrations show the different joints - settings. For each setting, the illustration shows an angled blue line with a thickness of - 30 (for which the jointStyle applies), and a superimposed angled black line with a - thickness of 1 (for which no jointStyle applies): -

- -

MITER, ROUND, and BEVEL

- -

Note: For joints set to JointStyle.MITER, - you can use the miterLimit parameter to limit the length of the miter.

- Implementation -
-    public function get joints():String -
-    public function set joints(value:String):void -
-

-See also -

-
-flash.display.JointStyle -
-
- - - - - -
miterLimitproperty 
-
-public var miterLimit:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Indicates the limit at which a miter is cut off. - Valid values range from 1 to 255 (and values outside that range are rounded to 1 or 255). - This value is only used if the jointStyle - is set to "miter". The - miterLimit value represents the length that a miter can extend beyond the point - at which the lines meet to form a joint. The value expresses a factor of the line - thickness. For example, with a miterLimit factor of 2.5 and a - thickness of 10 pixels, the miter is cut off at 25 pixels. - -

For example, consider the following angled lines, each drawn with a thickness - of 20, but with miterLimit set to 1, 2, and 4. Superimposed are black reference - lines showing the meeting points of the joints:

- -

lines with miterLimit set to 1, 2, and 4

- -

Notice that a given miterLimit value has a specific maximum angle - for which the miter is cut off. The following table lists some examples:

- - - - - - - - - - - - - -
miterLimit value: Angles smaller than this are cut off:
1.414 90 degrees
2 60 degrees
4 30 degrees
8 15 degrees
-
- - - - - -
pixelHintingproperty 
-
-public var pixelHinting:Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Specifies whether to hint strokes - to full pixels. This affects both the position of anchors of a curve and the line stroke size - itself. With pixelHinting set to true, Flash Player hints line widths - to full pixel widths. With pixelHinting set to false, disjoints can - appear for curves and straight lines. For example, the following illustrations show how - Flash Player renders two rounded rectangles that are identical, except that the - pixelHinting parameter used in the lineStyle() method is set - differently (the images are scaled by 200%, to emphasize the difference): - -

pixelHinting false and pixelHinting true

-
- - - - - -
scaleModeproperty 
-
-scaleMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Specifies the stroke thickness scaling. Valid values are: - -

    - -
  • - LineScaleMode.NORMAL—Always scale the line thickness when the object is scaled - (the default). -
    • - -
  • - LineScaleMode.NONE—Never scale the line thickness. -
    • - - -
  • - LineScaleMode.VERTICAL—Do not scale the line thickness if the object is scaled vertically - only. For example, consider the following circles, drawn with a one-pixel line, and each with the - scaleMode parameter set to LineScaleMode.VERTICAL. The circle on the left - is scaled vertically only, and the circle on the right is scaled both vertically and horizontally: - -

    A circle scaled vertically, and a circle scaled both vertically and horizontally.

    - -
    • - - -
  • - LineScaleMode.HORIZONTAL—Do not scale the line thickness if the object is scaled horizontally - only. For example, consider the following circles, drawn with a one-pixel line, and each with the - scaleMode parameter set to LineScaleMode.HORIZONTAL. The circle on the left - is scaled horizontally only, and the circle on the right is scaled both vertically and horizontally: - -

    A circle scaled horizontally, and a circle scaled both vertically and horizontally.

    - -
    • - - -
- Implementation -
-    public function get scaleMode():String -
-    public function set scaleMode(value:String):void -
-

-See also -

-
-flash.display.LineScaleMode -
-
- - - - - -
thicknessproperty 
-
-public var thickness:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Indicates the thickness of the line in - points; valid values are 0-255. If a number is not specified, or if the - parameter is undefined, a line is not drawn. If a value of less than 0 is passed, - the default is 0. The value 0 indicates hairline thickness; the maximum thickness - is 255. If a value greater than 255 is passed, the default is 255. -

- -
Constructor detail
- - - - - -
GraphicsStroke()constructor
-
-public function GraphicsStroke(thickness:Number, pixelHinting:Boolean = false, scaleMode:String = "normal", caps:String = "none", joints:String = "round", miterLimit:Number = 3.0, fill:IGraphicsFill = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Creates a new GraphicsStroke object. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
thickness:Number — An integer that indicates the thickness of the line in - points; valid values are 0-255. If a number is not specified, or if the - parameter is undefined, a line is not drawn. If a value of less than 0 is passed, - the default is 0. The value 0 indicates hairline thickness; the maximum thickness - is 255. If a value greater than 255 is passed, the default is 255. -
 
pixelHinting:Boolean (default = false) — A Boolean value that specifies whether to hint strokes - to full pixels. This affects both the position of anchors of a curve and the line stroke size - itself. With pixelHinting set to true, Flash Player hints line widths - to full pixel widths. With pixelHinting set to false, disjoints can - appear for curves and straight lines. For example, the following illustrations show how - Flash Player renders two rounded rectangles that are identical, except that the - pixelHinting parameter used in the lineStyle() method is set - differently (the images are scaled by 200%, to emphasize the difference): - -

pixelHinting false and pixelHinting true

- -

If a value is not supplied, the line does not use pixel hinting.

- -
 
scaleMode:String (default = "normal") — A value from the LineScaleMode class that - specifies which scale mode to use: - -
    - -
  • - LineScaleMode.NORMAL—Always scale the line thickness when the object is scaled - (the default). -
    • - -
  • - LineScaleMode.NONE—Never scale the line thickness. -
    • - - -
  • - LineScaleMode.VERTICAL—Do not scale the line thickness if the object is scaled vertically - only. For example, consider the following circles, drawn with a one-pixel line, and each with the - scaleMode parameter set to LineScaleMode.VERTICAL. The circle on the left - is scaled vertically only, and the circle on the right is scaled both vertically and horizontally: - -

    A circle scaled vertically, and a circle scaled both vertically and horizontally.

    - -
    • - - -
  • - LineScaleMode.HORIZONTAL—Do not scale the line thickness if the object is scaled horizontally - only. For example, consider the following circles, drawn with a one-pixel line, and each with the - scaleMode parameter set to LineScaleMode.HORIZONTAL. The circle on the left - is scaled horizontally only, and the circle on the right is scaled both vertically and horizontally: - -

    A circle scaled horizontally, and a circle scaled both vertically and horizontally.

    - -
    • - - -
- - -
 
caps:String (default = "none") — A value from the CapsStyle class that specifies the type of caps at the end - of lines. Valid values are: CapsStyle.NONE, CapsStyle.ROUND, and CapsStyle.SQUARE. - If a value is not indicated, Flash uses round caps. -

For example, the following illustrations show the different capsStyle - settings. For each setting, the illustration shows a blue line with a thickness of 30 (for - which the capsStyle applies), and a superimposed black line with a thickness of 1 - (for which no capsStyle applies): -

-

NONE, ROUND, and SQUARE

- -
 
joints:String (default = "round") — A value from the JointStyle class that specifies the type of joint appearance - used at angles. Valid - values are: JointStyle.BEVEL, JointStyle.MITER, and JointStyle.ROUND. - If a value is not indicated, Flash uses round joints. - -

For example, the following illustrations show the different joints - settings. For each setting, the illustration shows an angled blue line with a thickness of - 30 (for which the jointStyle applies), and a superimposed angled black line with a - thickness of 1 (for which no jointStyle applies): -

- -

MITER, ROUND, and BEVEL

- -

Note: For joints set to JointStyle.MITER, - you can use the miterLimit parameter to limit the length of the miter.

- -
 
miterLimit:Number (default = 3.0) — A number that indicates the limit at which a miter is cut off. - Valid values range from 1 to 255 (and values outside that range are rounded to 1 or 255). - This value is only used if the jointStyle - is set to "miter". The - miterLimit value represents the length that a miter can extend beyond the point - at which the lines meet to form a joint. The value expresses a factor of the line - thickness. For example, with a miterLimit factor of 2.5 and a - thickness of 10 pixels, the miter is cut off at 25 pixels. - -

For example, consider the following angled lines, each drawn with a thickness - of 20, but with miterLimit set to 1, 2, and 4. Superimposed are black reference - lines showing the meeting points of the joints:

- -

lines with miterLimit set to 1, 2, and 4

- -

Notice that a given miterLimit value has a specific maximum angle - for which the miter is cut off. The following table lists some examples:

- - - - - - - - - - - - - -
miterLimit value: Angles smaller than this are cut off:
1.414 90 degrees
2 60 degrees
4 30 degrees
8 15 degrees
-
 
fill:IGraphicsFill (default = null) — An IGraphicsFill instance containing data for filling a stroke. An IGraphicsFill - instance can represent a series of fill commands. -
-

-See also -

-
-flash.display.LineScaleMode -
-flash.display.CapsStyle -
-flash.display.JointStyle -
-flash.display.IGraphicsFill -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/GraphicsTrianglePath.html b/html-docs/flash/display/GraphicsTrianglePath.html deleted file mode 100644 index 890e872..0000000 --- a/html-docs/flash/display/GraphicsTrianglePath.html +++ /dev/null @@ -1,438 +0,0 @@ - - - - - - - - -flash.display.GraphicsTrianglePath (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic final class GraphicsTrianglePath
InheritanceGraphicsTrianglePath Inheritance Object
ImplementsIGraphicsData, IGraphicsPath
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- 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. -

- 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. -

-

-

-See also -

-
-flash.display.Graphics.drawTriangles() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  culling : String -
- Specifies whether to render triangles that face in a given direction.
-		GraphicsTrianglePath
  indices : Vector.<int>
- A Vector of integers or indexes, where every three indexes define a triangle.
-		GraphicsTrianglePath
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  uvtData : Vector.<Number>
- A Vector of normalized coordinates used to apply texture mapping.
-		GraphicsTrianglePath
  vertices : Vector.<Number>
- A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair).
-		GraphicsTrianglePath
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GraphicsTrianglePath(vertices:Vector.<Number> = null, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none")
-
- Creates a new GraphicsTrianglePath object.
-		GraphicsTrianglePath
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
cullingproperty
-
-culling:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- 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. -

- Implementation -
-    public function get culling():String -
-    public function set culling(value:String):void -
-

-See also -

-
-flash.display.TriangleCulling -
-
- - - - - -
indicesproperty 
-
-public var indices:Vector.<int> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- 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 indexes[1] refers to (vertices[2], vertices[3]). -

- - - - - -
uvtDataproperty 
-
-public var uvtData:Vector.<Number> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- 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. - -

- In UV coordinates, (0,0) is the upper left of the bitmap, and (1,1) is the lower right of the bitmap. -

- -

- If the length of this vector is twice the length of the vertices vector then normalized - coordinates are used without perspective correction. -

- -

- If the length of this vector is three times the length of the vertices 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. -

-
- - - - - -
verticesproperty 
-
-public var vertices:Vector.<Number> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair). -

- -
Constructor detail
- - - - - -
GraphicsTrianglePath()constructor
-
-public function GraphicsTrianglePath(vertices:Vector.<Number> = null, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

- Creates a new GraphicsTrianglePath object. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
vertices:Vector.<Number> (default = null) — A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair). Required. -
 
indices:Vector.<int> (default = null) — A Vector of integers or indexes, where every three indexes define a triangle. -
 
uvtData:Vector.<Number> (default = null) — A Vector of normalized coordinates used to apply texture mapping. - -
 
culling:String (default = "none") — 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. - -
-

-See also -

-
-culling -
-flash.display.TriangleCulling -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/IBitmapDrawable.html b/html-docs/flash/display/IBitmapDrawable.html deleted file mode 100644 index d95d94a..0000000 --- a/html-docs/flash/display/IBitmapDrawable.html +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - -flash.display.IBitmapDrawable (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Interfacepublic interface IBitmapDrawable
ImplementorsBitmapData, DisplayObject
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The IBitmapDrawable interface is implemented by objects that can be passed as the source - parameter of the draw() method of the BitmapData class. These objects are of type BitmapData - or DisplayObject. - -

-

-See also -

-
-flash.display.BitmapData.draw() -
-flash.display.BitmapData -
-flash.display.DisplayObject -
-
-
-
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/IGraphicsData.html b/html-docs/flash/display/IGraphicsData.html deleted file mode 100644 index 1067097..0000000 --- a/html-docs/flash/display/IGraphicsData.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - - -flash.display.IGraphicsData (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Interfacepublic interface IGraphicsData
ImplementorsGraphicsBitmapFill, GraphicsEndFill, GraphicsGradientFill, GraphicsPath, GraphicsShaderFill, GraphicsSolidFill, GraphicsStroke, GraphicsTrianglePath
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- This interface is used to define objects that can be used as parameters in the flash.display.Graphics - methods, including fills, strokes, and paths. Use the implementor classes of this interface to - create and manage drawing property data, and to reuse the same data for different instances. - Then, use the methods of the Graphics class to render the drawing - objects. -

-

-See also -

-
-flash.display.Graphics.drawGraphicsData() -
-flash.display.Graphics.readGraphicsData() -
-
-
-
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/IGraphicsFill.html b/html-docs/flash/display/IGraphicsFill.html deleted file mode 100644 index 7cc15c7..0000000 --- a/html-docs/flash/display/IGraphicsFill.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - -flash.display.IGraphicsFill (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Interfacepublic interface IGraphicsFill
ImplementorsGraphicsBitmapFill, GraphicsEndFill, GraphicsGradientFill, GraphicsShaderFill, GraphicsSolidFill
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- This interface is used to define objects that can be used as fill parameters in the flash.display.Graphics - methods and drawing classes. Use the implementor classes of this interface to - create and manage fill property data, and to reuse the same data for different instances. -

-

-See also -

-
-flash.display.Graphics.drawGraphicsData() -
-flash.display.GraphicsStroke.fill -
-
-
-
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/IGraphicsPath.html b/html-docs/flash/display/IGraphicsPath.html deleted file mode 100644 index 8d9f972..0000000 --- a/html-docs/flash/display/IGraphicsPath.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - - -flash.display.IGraphicsPath (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Interfacepublic interface IGraphicsPath
ImplementorsGraphicsPath, GraphicsTrianglePath
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- This interface is used to define objects that can be used as path parameters in the flash.display.Graphics - methods and drawing classes. Use the implementor classes of this interface to - create and manage path property data, and to reuse the same data for different instances. -

-

-See also -

-
-flash.display.Graphics.drawGraphicsData() -
-flash.display.Graphics.drawPath() -
-
-
-
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/IGraphicsStroke.html b/html-docs/flash/display/IGraphicsStroke.html deleted file mode 100644 index 7af13d9..0000000 --- a/html-docs/flash/display/IGraphicsStroke.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - -flash.display.IGraphicsStroke (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Interfacepublic interface IGraphicsStroke
ImplementorsGraphicsStroke
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- This interface is used to define objects that can be used as stroke parameters in the flash.display.Graphics - methods and drawing classes. Use the implementor classes of this interface to - create and manage stroke property data, and to reuse the same data for different instances. -

-

-See also -

-
-flash.display.Graphics.drawGraphicsData() -
-
-
-
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/InteractiveObject.html b/html-docs/flash/display/InteractiveObject.html deleted file mode 100644 index d86ceb6..0000000 --- a/html-docs/flash/display/InteractiveObject.html +++ /dev/null @@ -1,7875 +0,0 @@ - - - - - - - - -flash.display.InteractiveObject (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic class InteractiveObject
InheritanceInteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
SubclassesDisplayObjectContainer, SimpleButton, TextField
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - 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. - - - -

You cannot instantiate the InteractiveObject class directly. A call to the new - - InteractiveObject() constructor throws an ArgumentError exception.

- - - -

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.

- - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  accessibilityImplementation : AccessibilityImplementation -
- - The current accessibility implementation (AccessibilityImplementation) - - for this InteractiveObject instance.
-		InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  contextMenu : NativeMenu -
- - Specifies the context menu associated with this object.
-		InteractiveObject
  doubleClickEnabled : Boolean -
- - Specifies whether the object receives doubleClick events.
-		InteractiveObject
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
  focusRect : Object -
- - Specifies whether this object displays a focus rectangle.
-		InteractiveObject
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
  mouseEnabled : Boolean -
- - Specifies whether this object receives mouse, or other user input, messages.
-		InteractiveObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
  needsSoftKeyboard : Boolean -
- - Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - - when this InteractiveObject instance receives focus.
-		InteractiveObject
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
  softKeyboard : String -
- - Controls the appearance of the soft keyboard.
-		InteractiveObject
  softKeyboardInputAreaOfInterest : Rectangle -
- - Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
-		InteractiveObject
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
  tabEnabled : Boolean -
- - Specifies whether this object is in the tab order.
-		InteractiveObject
  tabIndex : int -
- - Specifies the tab ordering of objects in a SWF file.
-		InteractiveObject
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-InteractiveObject()
-
- - Calling the new InteractiveObject() constructor - - throws an ArgumentError exception.
-		InteractiveObject
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-requestSoftKeyboard():Boolean -
-
- - Raises a virtual keyboard.
-		InteractiveObject
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
   -
-clear -
-		 - - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
   -
-click -
-		 - - Dispatched when a user presses and releases the main button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
   -
-contextMenu -
-		 - - Dispatched when a user gesture triggers the context menu associated with this interactive - - object in an AIR application.InteractiveObject
   -
-copy -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - - or selects 'Copy' from the text context menu.InteractiveObject
   -
-cut -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - - or selects 'Cut' from the text context menu.InteractiveObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-doubleClick -
-		 - - Dispatched when a user presses and releases the main button of a pointing device twice in - - rapid succession over the same InteractiveObject when that object's - - doubleClickEnabled flag is set to true.InteractiveObject
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
   -
-focusIn -
-		 - - Dispatched after a display object gains focus.InteractiveObject
   -
-focusOut -
-		 - - Dispatched after a display object loses focus.InteractiveObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
   -
-gestureDirectionalTap -
-		 - - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - - Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
   -
-gestureLongPress -
-		 - - Dispatched when the user presses two points of contact over the same InteractiveObject instance - - on a touch-enabled device (such as presses and releases two fingers over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-gesturePan -
-		 - - Dispatched when the user moves a point of contact over the InteractiveObject instance - - on a touch-enabled device (such as moving a finger from left to right over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-gestureRotate -
-		 - - Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers - - and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-gestureSwipe -
-		 - - Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three - - fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-gestureTap -
-		 - - Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps - - on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item - - on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-gestureZoom -
-		 - - Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two - - fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-imeStartComposition -
-		 - - This event is dispatched to any client app that supports inline input with an IME - - - - InteractiveObject
   -
-keyDown -
-		 - - Dispatched when the user presses a key.InteractiveObject
   -
-keyFocusChange -
-		 - - Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
   -
-keyUp -
-		 - - Dispatched when the user releases a key.InteractiveObject
   -
-middleClick -
-		 - - Dispatched when a user presses and releases the middle button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
   -
-middleMouseDown -
-		 - - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
   -
-middleMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
   -
-mouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
   -
-mouseFocusChange -
-		 - - Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
   -
-mouseMove -
-		 - - Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
   -
-mouseOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
   -
-mouseOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
   -
-mouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
   -
-mouseWheel -
-		 - - Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
   -
-mouseWheelHorizontal -
-		 - - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
   -
-nativeDragComplete -
-		 - - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
   -
-nativeDragDrop -
-		 - - Dispatched by the target InteractiveObject when a dragged object is - - dropped on it and the drop has been accepted with a call to - - DragManager.acceptDragDrop().InteractiveObject
   -
-nativeDragEnter -
-		 - - Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
   -
-nativeDragExit -
-		 - - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
   -
-nativeDragOver -
-		 - - Dispatched by an InteractiveObject continually while a drag gesture remains within its - - boundary.InteractiveObject
   -
-nativeDragStart -
-		 - - Dispatched at the beginning of a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
   -
-nativeDragUpdate -
-		 - - Dispatched during a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
   -
-paste -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - - or selects 'Paste' from the text context menu.InteractiveObject
   -
-proximityBegin -
-		 - - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
   -
-proximityEnd -
-		 - - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
   -
-proximityMove -
-		 - - Dispatched when the user moves an active stylus over the screen while remaining within - - the proximity detection threshold.InteractiveObject
   -
-proximityOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - - the proximity detection threshold of the screen.InteractiveObject
   -
-proximityOver -
-		 - - Dispatched when the user moves an active stylus directly above this InteractiveObject - - while remaining within the proximity detection threshold of the screen.InteractiveObject
   -
-proximityRollOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject - - and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
   -
-proximityRollOver -
-		 - - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - - object's tree of descendents in the display list - - (while remaining within the proximity detection threshold of the screen).InteractiveObject
   -
-releaseOutside -
-		 - - Dispatched when a user releases the button on the pointing device after the - - user first pressed the button over an InteractiveObject instance - - and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
   -
-rightClick -
-		 - - Dispatched when a user presses and releases the right button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
   -
-rightMouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
   -
-rightMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
   -
-rollOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject - - instance.InteractiveObject
   -
-rollOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
   -
-selectAll -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a select all operation - - or selects 'Select All' from the text context menu.InteractiveObject
   -
-softKeyboardActivate -
-		 - - Dispatched immediately after the soft keyboard is raised.InteractiveObject
   -
-softKeyboardActivating -
-		 - - Dispatched immediately before the soft keyboard is raised.InteractiveObject
   -
-softKeyboardDeactivate -
-		 - - Dispatched immediately after the soft keyboard is lowered.InteractiveObject
   -
-tabChildrenChange -
-		 - - Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
   -
-tabEnabledChange -
-		 - - Dispatched when the object's tabEnabled flag changes.InteractiveObject
   -
-tabIndexChange -
-		 - - Dispatched when the value of the object's tabIndex property changes.InteractiveObject
   -
-textInput -
-		 - - Dispatched when a user enters one or more - - characters of text.InteractiveObject
   -
-touchBegin -
-		 - - Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
   -
-touchEnd -
-		 - - Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
   -
-touchMove -
-		 - - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
   -
-touchOut -
-		 - - Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device - - (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-touchOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-touchRollOut -
-		 - - Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-touchRollOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-touchTap -
-		 - - Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated - - on a touch-enabled device (such as presses and releases a finger from a single point over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
-
- -
- -
Property detail
- - - - - -
accessibilityImplementationproperty
-
-accessibilityImplementation:AccessibilityImplementation  [read-write]

- - - - -
Language version: ActionScript 3.0 -
-

- - The current accessibility implementation (AccessibilityImplementation) - - for this InteractiveObject instance. - -

Implementation -
-    public function get accessibilityImplementation():AccessibilityImplementation -
-    public function set accessibilityImplementation(value:AccessibilityImplementation):void -
-

-See also -

-
-flash.accessibility.AccessibilityImplementation -
-
- - - - - -
contextMenuproperty 
-
-contextMenu:NativeMenu  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Specifies the context menu associated with this object. - - -

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. - -

- - -

Note: 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 clear, - - copy, cut, paste, or selectAll events.

- - - Implementation -
-    public function get contextMenu():NativeMenu -
-    public function set contextMenu(value:NativeMenu):void -
-
-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 - ActionScriptExamples.com. -
-
-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();
-}
-
-

-
- - - - - -
doubleClickEnabledproperty 
-
-doubleClickEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies whether the object receives doubleClick events. The default value - - is false, which means that by default an InteractiveObject instance does not receive - - doubleClick events. If the doubleClickEnabled property is set to - - true, the instance receives doubleClick events within its bounds. - - The mouseEnabled property of the InteractiveObject instance must also be - - set to true for the object to receive doubleClick events. - - - -

No event is dispatched by setting this property. You must use the - - addEventListener() method to add an event listener - - for the doubleClick event.

- - - - Implementation -
-    public function get doubleClickEnabled():Boolean -
-    public function set doubleClickEnabled(value:Boolean):void -
-

-See also -

-
-doubleClick -
-mouseEnabled -
-flash.display.DisplayObjectContainer.mouseChildren -
-
- - - - - -
focusRectproperty 
-
-focusRect:Object  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies whether this object displays a focus rectangle. It can take one of three - - values: true, false, or null. Values of true - - and false work as expected, specifying whether or not the focus rectangle - - appears. A value of null indicates that this object obeys the - - stageFocusRect property of the Stage. - - -

Implementation -
-    public function get focusRect():Object -
-    public function set focusRect(value:Object):void -
-
- - - - - -
mouseEnabledproperty 
-
-mouseEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies whether this object receives mouse, or other user input, messages. The default value is true, - - which means that by default any InteractiveObject instance that is on the display list - - receives mouse events or other user input events. - - If mouseEnabled is set to false, 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 mouseEnabled behavior for all children of an object on the display list, use - - flash.display.DisplayObjectContainer.mouseChildren. - -

No event is dispatched by setting this property. You must use the - - addEventListener() method to create interactive functionality.

- - - Implementation -
-    public function get mouseEnabled():Boolean -
-    public function set mouseEnabled(value:Boolean):void -
-

-See also -

-
-flash.display.DisplayObjectContainer.mouseChildren -
-
- - - - - -
needsSoftKeyboardproperty 
-
-needsSoftKeyboard:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 2.6 - -
-

- - Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - - when this InteractiveObject instance receives focus. - - - -

By default, the value is false and focusing an InteractiveObject instance does - - not raise a soft keyboard. If the needsSoftKeyboard property is set to true, - - 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 - - focus 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.

- - - -

The InteractiveObject instance dispatches softKeyboardActivating, - - softKeyboardActivate, and softKeyboardDeactivate events - - when the soft keyboard raises and lowers.

- - - -

Note: This property is not supported in AIR applications on iOS.

- - - - Implementation -
-    public function get needsSoftKeyboard():Boolean -
-    public function set needsSoftKeyboard(value:Boolean):void -
-

-See also -

-
-softKeyboardActivating -
-softKeyboardActivate -
-softKeyboardDeactivate -
-
- - - - - -
softKeyboardproperty 
-
-softKeyboard:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 21.0 - -
-

- - Controls the appearance of the soft keyboard. - -

- - Devices with soft keyboards can customize the keyboard's buttons - - to match the type of input expected. For example, if numeric - - input is expected, a device can use SoftKeyboardType.NUMBER to - - display only numbers on the soft keyboard. - - Valid values are defined as constants in the SoftKeyboardType class: - -

- -
    - -
  • - - "default" - -
    • - -
  • - - "punctuation" - -
    • - -
  • - - "url" - -
    • - -
  • - - "number" - -
    • - -
  • - - "contact" - -
    • - -
  • - - "email" - -
    • - -
  • - - "phone" - -
    • - -
  • - - "decimalpad" - -
    • - -
- -

- - These values serve as hints, to help a device display the best keyboard for the current operation. - -

- - -

The default value is SoftKeyboardType.DEFAULT.

-Implementation -
-    public function get softKeyboard():String -
-    public function set softKeyboard(value:String):void -
-
-Throws -
- - - - -
ArgumentError — If set to any value which is not a member of SoftKeyboardType - - -
-

-See also -

-
-flash.text.SoftKeyboardType -
-
- - - - - -
softKeyboardInputAreaOfInterestproperty 
-
-softKeyboardInputAreaOfInterest:Rectangle  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 2.6 - -
-

- - Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). - - - -

If the needsSoftKeyboard property of this InteractiveObject is - - true, 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 DisplayObject.getBounds() method. You can - - specify a different area using this softKeyboardInputAreaOfInterest - - property.

- - - -

Specify the softKeyboardInputAreaOfInterest in stage coordinates.

- - - -

Note: On Android, the softKeyboardInputAreaOfInterest is not - - respected in landscape orientations.

- - - -

Note: softKeyboardInputAreaOfInterest is not - - supported on iOS.

- - - - Implementation -
-    public function get softKeyboardInputAreaOfInterest():Rectangle -
-    public function set softKeyboardInputAreaOfInterest(value:Rectangle):void -
-

-See also -

-
-flash.display.DisplayObject.getBounds() -
-
- - - - - -
tabEnabledproperty 
-
-tabEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies whether this object is in the tab order. If this object is in the tab order, - - the value is true; otherwise, the value is false. By default, - - the value is false, except for the following: - -

  • For a SimpleButton object, the value is true.
    • - -
  • For a TextField object with type = "input", the value is true.
    • - -
  • For a Sprite object or MovieClip object with buttonMode = true, the value is true.
- - - -

Implementation -
-    public function get tabEnabled():Boolean -
-    public function set tabEnabled(value:Boolean):void -
-
- - - - - -
tabIndexproperty 
-
-tabIndex:int  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies the tab ordering of objects in a SWF file. The tabIndex - - property is -1 by default, meaning no tab index is set for the object. - - - -

If any currently displayed object in the SWF file contains a tabIndex property, automatic - - tab ordering is disabled, and the tab ordering is calculated from the tabIndex properties of - - objects in the SWF file. The custom tab ordering includes only objects that have tabIndex - - properties.

- - - -

The tabIndex property can be a non-negative integer. The objects are ordered according to - - their tabIndex properties, in ascending order. An object with a tabIndex - - value of 1 precedes an object with a tabIndex value of 2. Do not use the same tabIndex - - - - value for multiple objects.

- - - -

The custom tab ordering that the tabIndex property defines is flat. - - This means that no attention is paid to the hierarchical relationships of objects in the SWF file. - - All objects in the SWF file with tabIndex properties are placed in the tab order, and the - - tab order is determined by the order of the tabIndex values.

- -

Note: To set the tab order for TLFTextField instances, cast the display object child - - of the TLFTextField as an InteractiveObject, then set the tabIndex property. For example:
- - 

-
-	 InteractiveObject(tlfInstance.getChildAt(1)).tabIndex = 3;
-
-
- - To reverse the tab order from the default setting for three instances of a TLFTextField object - - (tlfInstance1, tlfInstance2 and tlfInstance3), use:
- - 
-
-	 InteractiveObject(tlfInstance1.getChildAt(1)).tabIndex = 3;
-
-	 InteractiveObject(tlfInstance2.getChildAt(1)).tabIndex = 2;
-
-	 InteractiveObject(tlfInstance3.getChildAt(1)).tabIndex = 1;
-
-
- -

- - - Implementation -
-    public function get tabIndex():int -
-    public function set tabIndex(value:int):void -
-
- -
Constructor detail
- - - - - -
InteractiveObject()constructor
-
-public function InteractiveObject() -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Calling the new InteractiveObject() constructor - - throws an ArgumentError exception. - - You can, however, call constructors for the following subclasses of InteractiveObject: - - - -

    - - - -
  • new SimpleButton()
    • - -
  • new TextField()
    • - -
  • new Loader()
    • - -
  • new Sprite()
    • - -
  • new MovieClip()
    • - - - -
- - - - - -

- -
Method detail
- - - - - -
requestSoftKeyboard()method
-
-public function requestSoftKeyboard():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 - -
-

- - Raises a virtual keyboard. - - - -

Calling this method focuses the InteractiveObject instance and raises the soft keyboard, if necessary. - - The needsSoftKeyboard must also be true. A keyboard is not raised - - if a hardware keyboard is available, or if the client system does not support virtual keyboards.

- - - -

Note: This method is not supported in AIR applications on iOS.

- - - -

-Returns - - - - -
Boolean — - A value of true means that the soft keyboard request was granted; false means that the soft keyboard was not raised. - - - - - -
-

-See also -

-
-needsSoftKeyboard -
-
-
Event detail
- - - - - -
clearevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLEAR -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - 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. - -

- - - - - -
clickevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.CLICK -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 click event does not - - occur. Any number of other mouse events can occur at any time between the - - mouseDown or mouseUp events; the click event - - still occurs. - -

- - Defines the value of the type property of a click event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor click events, this value is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
contextMenuevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.CONTEXT_MENU -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when a user gesture triggers the context menu associated with this interactive - - object in an AIR application. - - - -

- - The MouseEvent.CONTEXT_MENU constant defines the value of the - - type property of a contextMenu event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the right mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-contextMenu -
-
- - - - - -
copyevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COPY -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - 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. - -

- Defines the value of the type property of a copy event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny InteractiveObject instance with a listener registered for the copy event.
-

Note: TextField objects do not dispatch clear, copy, cut, paste, - or selectAll events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. - 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 clear, copy, cut, paste, - or selectAll events. However, other classes that extend the InteractiveObject class, including components built - using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.

- -
- - - - - -
cutevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CUT -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - 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. - -

- Defines the value of the type property of a cut event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny InteractiveObject instance with a listener registered for the cut event.
-

Note: TextField objects do not dispatch clear, copy, cut, paste, - or selectAll events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. - 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 clear, copy, cut, paste, - or selectAll events. However, other classes that extend the InteractiveObject class, including components built - using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.

- -
- - - - - -
doubleClickevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.DOUBLE_CLICK -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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. - - For a doubleClick event to occur, it must immediately follow the following - - series of events: mouseDown, mouseUp, click, - - mouseDown, mouseUp. All of these events must share the same - - target as the doubleClick event. The second click, represented by - - the second mouseDown and mouseUp events, must occur within - - a specific period of time after the click 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 - - doubleClickEnabled flag set to true it receives two - - click events. - - - -

The doubleClickEnabled property defaults - - to false.

- - - -

The double-click text selection behavior of a TextField object - - is not related to the doubleClick event. Use - - TextField.doubleClickEnabled to control TextField selections.

- -

- - Defines the value of the type property of a doubleClick event object. The doubleClickEnabled property - - must be true for an object to generate the doubleClick event. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor double-click events, this value is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-doubleClickEnabled -
-
- - - - - -
focusInevent  
-
-Event object type: flash.events.FocusEvent -
-FocusEvent.type property = flash.events.FocusEvent.FOCUS_IN -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched after 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 relatedObject property. - - The shiftKey property is not used. - - This event follows the dispatch of the previous object's focusOut event. - -

- Defines the value of the type property of a focusIn event object. -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
keyCode0; applies only to keyFocusChange events.
relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
shiftKeyfalse; applies only to keyFocusChange events.
targetThe InteractiveObject instance that has just received focus. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event. -
directionThe direction from which focus was assigned. This property reports - the value of the direction parameter of the assignFocus() method of the stage. - If the focus changed through some other means, the value will always be FocusDirection.NONE. - Applies only to focusIn events. For all other focus events the value will be - FocusDirection.NONE.
- -
- - - - - -
focusOutevent  
-
-Event object type: flash.events.FocusEvent -
-FocusEvent.type property = flash.events.FocusEvent.FOCUS_OUT -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched after 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 - - relatedObject property. The shiftKey property is not used. This event precedes the dispatch - - of the focusIn event by the related object. - -

- Defines the value of the type property of a focusOut event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
keyCode0; applies only to keyFocusChange events.
relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
shiftKeyfalse; applies only to keyFocusChange events.
targetThe InteractiveObject instance that has just lost focus. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event. -
- -
- - - - - -
gestureDirectionalTapevent  
-
-Event object type: flash.events.TransformGestureEvent -
-TransformGestureEvent.type property = flash.events.TransformGestureEvent.GESTURE_DIRECTIONAL_TAP -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - - Some devices might also interpret this contact as a combination of several touch events, as well. - -

Specifically, if a user touches a finger over an InteractiveObject, and then moves the fingers away, the InteractiveObject instance can - - dispatch a touchBegin event and a touchEnd event (among others), as well as the gestureDirectionalTap 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 touchBegin event, then the same event handler will run on a touch-enabled device. However, if you choose to handle - - the gestureDirectionalTap 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 gesture event than a touch - - event. But flash.ui.Multitouch class decides whether touch event or gesture event will get triggered.

- -

When handling the properties of the event object, note that the localX and localY properties are set to the primary point of - - contact(For Apple TV it is centre of the screen). The offsetX and offsetY properties correspond to the direction of the gesture.

- -

Note: This API only supports a single-finger directional tap.

- -

- Defines the value of the type property of a GESTURE_DIRECTIONAL_TAP touch event object. - -

The dispatched TransformGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow. For swipe events, - this value is always all corresponding to the value GesturePhase.ALL once the event is dispatched.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.For directional tap gestures this value is centre of the screen.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.For directional tap gestures this value is centre of the screen.
scaleXThe horizontal scale of the display object. For directional tap gestures this value is 1
scaleYThe vertical scale of the display object. For directional tap gestures this value is 1
rotationThe current rotation angle, in degrees, of the display object along the z-axis. For directional tap gestures this value is 0
offsetXIndicates horizontal direction: 1 for right and -1 for left.
offsetYIndicates vertical direction: 1 for down and -1 for up.
velocityIndicates velocity of the swipe gesture in pixels per second (AIR only).
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.ui.Multitouch -
-
- - - - - -
gestureLongPressevent  
-
-Event object type: flash.events.TapGestureEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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 doubleClick event. - -

Specifically, if a user taps two fingers over an InteractiveObject, the InteractiveObject instance can dispatch a doubleClick - - event or a gestureTwoFingerTap 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 doubleClick 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 gestureTwoFingerTap 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.

- -

Note: See the Multitouch class for environment compatibility information.

- -

-See also -

-
-doubleClick event -
-flash.ui.Multitouch -
-
- - - - - -
gesturePanevent  
-
-Event object type: flash.events.TransformGestureEvent -
-TransformGestureEvent.type property = flash.events.TransformGestureEvent.GESTURE_PAN -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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 mouseOver event and as a touchOver event. - -

Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a mouseOver - - event or a touchOver event or a gesturePan 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 mouseOver 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 gesturePan 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.

- -

Note: See the Multitouch class for environment compatibility information.

- -

- Defines the value of the type property of a GESTURE_PAN touch event object. - -

The dispatched TransformGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow; a value from the GesturePhase class.
localXThe horizontal coordinate at which the event occurred relative to the containing display object.
localYThe vertical coordinate at which the event occurred relative to the containing display object.
scaleXThe horizontal scale of the display object since the previous gesture event. For pan gestures this value is 1.
scaleYThe vertical scale of the display object since the previous gesture event. For pan gestures this value is 1.
rotationThe current rotation angle, in degrees, of the display object along the z-axis, since the previous gesture event. - For pan gestures this value is 0.
offsetXThe horizontal translation of the display object from its position at the previous gesture event.
offsetYThe vertical translation of the display object from its position at the previous gesture event.
velocityThe velocity of the gesture event in pixels per second (AIR only). For pan gesture this value is 0
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
-Example -
The following example shows event handling for the GESTURE_PAN events. - While the user performs a pan gesture on the touch-enabled device, myTextField populates with the current phase. -
-
-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";
-	}
-}
-
-

-

-See also -

-
-mouseOver event -
-touchOver event -
-flash.ui.Multitouch -
-
- - - - - -
gestureRotateevent  
-
-Event object type: flash.events.TransformGestureEvent -
-TransformGestureEvent.type property = flash.events.TransformGestureEvent.GESTURE_ROTATE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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. - -

Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can - - dispatch a mouseOver - - event and a click event (among others), in addition to the gestureRotate 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 mouseOver 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 gestureRotate 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.

- -

When handling the properties of the event object, note that the localX and localY properties are set to the - - primary point of contact. The offsetX and offsetY properties are the distance to the point of contact where the rotation gesture - - is complete.

- -

Note: See the Multitouch class for environment compatibility information.

- -

- Defines the value of the type property of a GESTURE_ROTATE touch event object. - -

During this event, the rotation property contains the rotation angle. - The rotation values are as follows:

-
    -
  • 0 to 180 degrees for clockwise direction
    • -
  • - 180 to 0 degrees for counter-clockwise direction
    • -
- -

The dispatched TransformGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow; a value from the GesturePhase class.
localXThe horizontal coordinate at which the event occurred relative to the containing display object.
localYThe vertical coordinate at which the event occurred relative to the containing display object.
scaleXThe horizontal scale of the display object since the previous gesture event.
scaleYThe vertical scale of the display object since the previous gesture event.
rotationThe current rotation angle, in degrees, of the display object along the z-axis, since the previous gesture event.
offsetXThe horizontal translation of the display object from its position at the previous gesture event.
offsetYThe vertical translation of the display object from its position at the previous gesture event.
velocityThe velocity of the gesture event in pixels per second (AIR only). For rotate gesture this value is 0
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
-Example -
The following example shows event handling for the GESTURE_ROTATE events. - While the user performs a rotation gesture on the touch-enabled device, mySprite rotates and myTextField populates with the current phase. -
-
-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";
-	}
-}
-
-

-

-See also -

-
-mouseOver event -
-touchOver event -
-flash.ui.Multitouch -
-
- - - - - -
gestureSwipeevent  
-
-Event object type: flash.events.TransformGestureEvent -
-TransformGestureEvent.type property = flash.events.TransformGestureEvent.GESTURE_SWIPE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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. - -

Specifically, if a user moves a finger over an InteractiveObject, and then moves the fingers together, the InteractiveObject instance can - - dispatch a rollOver - - event and a rollOut event (among others), in addition to the gestureSwipe event, or all if the current environment supports it. - - Choose how you want to handle the user interaction. - - If you choose to handle the rollOver 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 gestureSwipe 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.

- -

When handling the properties of the event object, note that the localX and localY properties are set to the - - primary point of contact. The offsetX and offsetY properties are the distance to the point of contact where the swipe gesture - - is complete.

- -

Note: While some devices using the Mac OS operating system can - - interpret a four-finger swipe, this API only supports a three-finger swipe.

- -

- Defines the value of the type property of a GESTURE_SWIPE touch event object. - -

The dispatched TransformGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow. For swipe events, - this value is always all corresponding to the value GesturePhase.ALL once the event is dispatched.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
scaleXThe horizontal scale of the display object. For swipe gestures this value is 1
scaleYThe vertical scale of the display object. For swipe gestures this value is 1
rotationThe current rotation angle, in degrees, of the display object along the z-axis. For swipe gestures this value is 0
offsetXIndicates horizontal direction: 1 for right and -1 for left.
offsetYIndicates vertical direction: 1 for down and -1 for up.
velocityIndicates velocity of the swipe gesture in pixels per second (AIR only). For rest, this value is 0
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
-Example -
The following example shows event handling for the GESTURE_SWIPE events. - While the user performs a swipe gesture on the touch-enabled device, myTextField populates with the phase all, - which is the only phase for swipe events. -
-
-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;
-
-}
-
-

-

-See also -

-
-rollOver event -
-touchOver event -
-flash.ui.Multitouch -
-
- - - - - -
gestureTapevent  
-
-Event object type: flash.events.TapGestureEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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. - -

Specifically, if a user moves a finger over an InteractiveObject, and then provides a secondary tap, the InteractiveObject instance can - - dispatch a mouseOver - - event and a click event (among others) as well as the gesturePressAndTap 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 mouseOver 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 gesturePressAndTap 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.

- -

When handling the properties of the event object, note that the localX and localY properties are set to the - - primary point of contact (the "push"). The offsetX and offsetY properties are the distance to the secondary point of - - contact (the "tap").

- -

-See also -

-
-mouseOver event -
-touchOver event -
-flash.ui.Multitouch -
-
- - - - - -
gestureZoomevent  
-
-Event object type: flash.events.TransformGestureEvent -
-TransformGestureEvent.type property = flash.events.TransformGestureEvent.GESTURE_ZOOM -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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. - -

Specifically, if a user moves a finger over an InteractiveObject, and then moves the fingers apart, the InteractiveObject instance can - - dispatch a mouseOver - - event and a click event (among others), in addition to the gestureZoom 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 mouseOver 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 gestureZoom 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.

- -

When handling the properties of the event object, note that the localX and localY properties are set to the - - primary point of contact. The offsetX and offsetY properties are the distance to the point of contact where the zoom gesture - - is complete.

- -

Note: See the Multitouch class for environment compatibility information.

- -

- Defines the value of the type property of a GESTURE_ZOOM touch event object. - -

The dispatched TransformGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow; a value from the GesturePhase class.
localXThe horizontal coordinate at which the event occurred relative to the containing display object.
localYThe vertical coordinate at which the event occurred relative to the containing display object.
scaleXThe horizontal scale of the display object since the previous gesture event.
scaleYThe vertical scale of the display object since the previous gesture event.
rotationThe current rotation angle, in degrees, of the display object along the z-axis, since the previous gesture event.
offsetXThe horizontal translation of the display object from its position at the previous gesture event.
offsetYThe vertical translation of the display object from its position at the previous gesture event.
velocityThe velocity of the gesture event in pixels per second (AIR only). For zoom gesture this value is 0
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
-Example -
The following example shows event handling for the GESTURE_ZOOM events. - While the user performs a zoom gesture on the touch-enabled device, myTextField populates with the current phase. -
-
-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";
-	}
-}
-
-

-

-See also -

-
-mouseOver event -
-touchOver event -
-flash.ui.Multitouch -
-
- - - - - -
imeStartCompositionevent  
-
-Event object type: flash.events.IMEEvent -
-

-

- - - - -
Runtime version: 
-

- - This event is dispatched to any client app that supports inline input with an IME - - - -

- - - - - -
keyDownevent  
-
-Event object type: flash.events.KeyboardEvent -
-KeyboardEvent.type property = flash.events.KeyboardEvent.KEY_DOWN -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 keyUp event. - - -

In AIR, canceling this event prevents the character from being entered into a text field.

- - -

- - The KeyboardEvent.KEY_DOWN constant defines the value of the type property of a keyDown event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblestrue
cancelabletrue in AIR, false in Flash Player; - - in AIR, canceling this event prevents the character from being entered into a text field.
charCodeThe character code value of the key pressed or released.
commandKeytrue on Mac if the Command key is active. Otherwise, false
controlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Control key is active. Otherwise, false
ctrlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
keyCodeThe key code value of the key pressed or released.
keyLocationThe location of the key on the keyboard.
shiftKeytrue if the Shift key is active; false if it is inactive.
functionKeytrue if the Function key is active (Mac only); false if it is inactive.
targetThe InteractiveObject instance with focus. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
keyFocusChangeevent  
-
-Event object type: flash.events.FocusEvent -
-FocusEvent.type property = flash.events.FocusEvent.KEY_FOCUS_CHANGE -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 focusIn and focusOut events. - - - -

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 preventDefault() method - - in an event listener that is properly registered with the target object. - - Focus changes and focusIn and focusOut - - events are dispatched by default.

- -

- Defines the value of the type property of a keyFocusChange event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblestrue
cancelabletrue; call the preventDefault() method - to cancel default behavior.
currentTargetThe object that is actively processing - the Event - object with an event listener.
keyCodeThe key code value of the key pressed to trigger a keyFocusChange event.
relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
shiftKeytrue if the Shift key modifier is activated; false otherwise.
targetThe InteractiveObject instance that currently has focus. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event. -
- -
- - - - - -
keyUpevent  
-
-Event object type: flash.events.KeyboardEvent -
-KeyboardEvent.type property = flash.events.KeyboardEvent.KEY_UP -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 keyDown event and has - - the following characteristics: - -

- - The KeyboardEvent.KEY_UP constant defines the value of the type property of a keyUp event object. - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
charCodeContains the character code value of the key pressed or released.
commandKeytrue on Mac if the Command key is active. Otherwise, false
controlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Control key is active. Otherwise, false
ctrlKeytrue on Windows if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
keyCodeThe key code value of the key pressed or released.
keyLocationThe location of the key on the keyboard.
shiftKeytrue if the Shift key is active; false if it is inactive.
functionKeytrue if the Function key is active (Mac only); false if it is inactive.
targetThe InteractiveObject instance with focus. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
middleClickevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.MIDDLE_CLICK -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when a user presses and releases the middle button of the user's - - pointing device over the same InteractiveObject. For a middleClick event to occur, it must always follow this series of - - events in the order of occurrence: middleMouseDown event, then middleMouseUp. The target object - - must be identical for both of these events; otherwise the middleClick event does not - - occur. Any number of other mouse events can occur at any time between the - - middleMouseDown or middleMouseUp events; the middleClick event - - still occurs. - -

- - Defines the value of the type property of a middleClick event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor middle-click events, this property is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
middleMouseDownevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.MIDDLE_MOUSE_DOWN -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. - -

- - Defines the value of the type property of a middleMouseDown event object. - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the middle mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - -
- - - - - -
middleMouseUpevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.MIDDLE_MOUSE_UP -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance. - -

- - Defines the value of the type property of a middleMouseUp event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the middle mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
mouseDownevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.MOUSE_DOWN -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 - - downState display object as the default behavior. If the target is a - - selectable text field, the text field begins selection as the default behavior. - -

- - Defines the value of the type property of a mouseDown event object. - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
mouseFocusChangeevent  
-
-Event object type: flash.events.FocusEvent -
-FocusEvent.type property = flash.events.FocusEvent.MOUSE_FOCUS_CHANGE -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 - - focusIn and focusOut events. - - -

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 preventDefault() in an event listener that is properly registered with the target object. - - The shiftKey property is not used. Focus changes and - - focusIn and focusOut events are dispatched by default.

- -

- Defines the value of the type property of a mouseFocusChange event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblestrue
cancelabletrue; call the preventDefault() method - to cancel default behavior.
currentTargetThe object that is actively processing the Event - object with an event listener.
keyCode0; applies only to keyFocusChange events.
relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
shiftKeyfalse; applies only to keyFocusChange events.
targetThe InteractiveObject instance that currently has focus. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event. -
- - -
- - - - - -
mouseMoveevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.MOUSE_MOVE -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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. - -

- - Defines the value of the type property of a mouseMove event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
mouseOutevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.MOUSE_OUT -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 relatedObject - - is the object the pointing device has moved to. - - If the target is a SimpleButton instance, the button displays the upState - - display object as the default behavior. - -

The mouseOut 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 rollOut 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 rollOut event.The rollOut 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 relatedObject.

- -

- - Defines the value of the type property of a mouseOut event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
relatedObjectThe display list object to which the pointing device now points.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
mouseOverevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.MOUSE_OVER -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched when the user moves a pointing device over an InteractiveObject instance. - - The relatedObject is the object that was previously under - - the pointing device. - - If the target is a SimpleButton instance, the object displays the overState - - or upState display object, depending on whether the mouse button is down, as the default behavior. - -

The mouseOver 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 rollOver 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 rollOver event. - - The rollOver 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 relatedObject and ending with the object.

- -

- - Defines the value of the type property of a mouseOver event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
relatedObjectThe display list object to which the pointing device was pointing.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
mouseUpevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.MOUSE_UP -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance. - - If the target is a SimpleButton instance, the object displays the upState - - display object. - - If the target is a selectable text field, the text field ends selection as the default - - behavior. - -

- - Defines the value of the type property of a mouseUp event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
mouseWheelevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.MOUSE_WHEEL -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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. - -

- - Defines the value of the type property of a mouseWheel event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
deltaThe number of lines that that each notch on the mouse wheel represents.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
mouseWheelHorizontalevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.MOUSE_WHEEL_HORIZONTAL -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 51 - -
-

- - Dispatched when a horizontal 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. - -

- - Defines the value of the type property of a mouseWheelHorizontal event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
deltaThe number of lines that that each notch on the mouse wheel represents.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - -
- - - - - -
nativeDragCompleteevent  
-
-Event object type: flash.events.NativeDragEvent -
-NativeDragEvent.type property = flash.events.NativeDragEvent.NATIVE_DRAG_COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. - - - -

The event's dropAction property indicates the action set - - by the drag target object; a value of "none" (DragActions.NONE) - - indicates that the drop was canceled or was not accepted.

- - - -

The nativeDragComplete 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.

- - -

- NativeDragEvent.NATIVE_DRAG_COMPLETE defines the value of the - type property of a nativeDragComplete event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelablefalse; there is no default behavior to cancel.
clipboardThe Clipboard object containing the dragged data.
dropActionThe action chosen by the drop target (or none if no action was set).
- -
- - - - - -
nativeDragDropevent  
-
-Event object type: flash.events.NativeDragEvent -
-NativeDragEvent.type property = flash.events.NativeDragEvent.NATIVE_DRAG_DROP -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - 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(). - - -

Access the dropped data using the event object clipboard - - property.

- - - -

The handler for this event should set the DragManager.dropAction - - 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.

- - -

- NativeDragEvent.NATIVE_DRAG_DROP defines the value of the type - property of a nativeDragDrop event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelabletrue; canceling this event cancels the drag operation.
clipboardThe Clipboard object containing the dragged data. The clipboard can be read even if the object dispatching this event is not in the same security domain as the initiator.
dropActionThe action chosen by the drop target (or none if no action was set).
- -
- - - - - -
nativeDragEnterevent  
-
-Event object type: flash.events.NativeDragEvent -
-NativeDragEvent.type property = flash.events.NativeDragEvent.NATIVE_DRAG_ENTER -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by an InteractiveObject when a drag gesture enters its boundary. - - - -

Handle either the nativeDragEnter or nativeDragOver - - events to allow the display object to become the drop target.

- - - -

To determine whether the dispatching display object can accept the drop, - - check the suitability of the data in clipboard property of - - the event object, and the allowed drag actions in the allowedActions - - property.

- - -

- NativeDragEvent.NATIVE_DRAG_ENTER defines the value of the - type property of a nativeDragEnter event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelablefalse; there is no default behavior to cancel.
clipboardThe Clipboard object containing the dragged data. The clipboard can be read only if the object dispatching this event is in the same security domain as the initiator.
dropActionThe action chosen by the drop target (or none if no action was set).
- -
- - - - - -
nativeDragExitevent  
-
-Event object type: flash.events.NativeDragEvent -
-NativeDragEvent.type property = flash.events.NativeDragEvent.NATIVE_DRAG_EXIT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by an InteractiveObject when a drag gesture leaves its boundary. - - -

- NativeDragEvent.NATIVE_DRAG_EXIT defines the value of the type - property of a nativeDragExit event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelablefalse; there is no default behavior to cancel.
clipboardThe Clipboard object containing the dragged data. The clipboard can be read only if the object dispatching this event is in the same security domain as the initiator.
dropActionThe action chosen by the drop target (or none if no action was set).
- -
- - - - - -
nativeDragOverevent  
-
-Event object type: flash.events.NativeDragEvent -
-NativeDragEvent.type property = flash.events.NativeDragEvent.NATIVE_DRAG_OVER -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by an InteractiveObject continually while a drag gesture remains within its - - boundary. - - - -

nativeDragOver 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.

- - - -

Handle either the nativeDragOver or nativeDragEnter - - events to allow the display object to become the drop target.

- - - -

To determine whether the dispatching display object can accept the drop, - - check the suitability of the data in clipboard property of - - the event object, and the allowed drag actions in the allowedActions - - property.

- - - -

- NativeDragEvent.NATIVE_DRAG_OVER defines the value of the type - property of a nativeDragOver event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelabletrue; canceling this event cancels the drag operation.
clipboardThe Clipboard object containing the dragged data. The clipboard can be read only if the object dispatching this event is in the same security domain as the initiator.
dropActionThe action chosen by the drop target (or none if no action was set).
- -
- - - - - -
nativeDragStartevent  
-
-Event object type: flash.events.NativeDragEvent -
-NativeDragEvent.type property = flash.events.NativeDragEvent.NATIVE_DRAG_START -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched at the beginning of a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call. - - -

- NativeDragEvent.NATIVE_DRAG_START defines the value of the type - property of a nativeDragStart event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelabletrue; canceling this event cancels the drag operation.
clipboardThe Clipboard object containing the dragged data.
dropActionThe action chosen by the drop target (or none if no action was set).
- -
- - - - - -
nativeDragUpdateevent  
-
-Event object type: flash.events.NativeDragEvent -
-NativeDragEvent.type property = flash.events.NativeDragEvent.NATIVE_DRAG_UPDATE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched during a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call. - - -

nativeDragUpdate events are not dispatched on Linux.

- - - -

- NativeDragEvent.NATIVE_DRAG_UPDATE defines the value of the - type property of a nativeDragUpdate event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelablefalse; there is no default behavior to cancel.
clipboardThe Clipboard object containing the dragged data.
dropActionThe action chosen by the drop target (or none if no action was set).
- -
- - - - - -
pasteevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.PASTE -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - 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. - -

- The Event.PASTE constant defines the value of the type property of a paste event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue (false for AIR runtime.)
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny InteractiveObject instance with a listener registered for the paste event.
-

Note: TextField objects do not dispatch clear, copy, cut, paste, - or selectAll events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. - 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 clear, copy, cut, paste, - or selectAll events. However, other classes that extend the InteractiveObject class, including components built - using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.

- -
- - - - - -
proximityBeginevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.PROXIMITY_BEGIN -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. - - - -

The typical sequence of events that occurs when a user lowers a stylus to the screen, - - moves it across the screen, and lifts it away is:

- -
    - -
  • proximityBegin
    • - -
  • proximityMove
    • - -
  • touchBegin
    • - -
  • touchMove
    • - -
  • touchEnd
    • - -
  • proximityMove
    • - -
  • proximityEnd
    • - -
- -

Note: See the Multitouch class for environment compatibility information.

- - - -

- Defines the value of the type property of a PROXIMITY_BEGIN - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.ui.Multitouch -
-
- - - - - -
proximityEndevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.PROXIMITY_END -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. - - - -

A proximityEnd event is not dispatched when the stylus touches the screen.

- - - -

The typical sequence of events that occurs when a user lowers a stylus to the screen, - - moves it across the screen, and lifts it away is:

- -
    - -
  • proximityBegin
    • - -
  • proximityMove
    • - -
  • touchBegin
    • - -
  • touchMove
    • - -
  • touchEnd
    • - -
  • proximityMove
    • - -
  • proximityEnd
    • - -
- -

Note: See the Multitouch class for environment compatibility information.

- - - -

- Defines the value of the type property of a PROXIMITY_END - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.ui.Multitouch -
-
- - - - - -
proximityMoveevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.PROXIMITY_MOVE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched when the user moves an active stylus over the screen while remaining within - - the proximity detection threshold. - - - -

The typical sequence of events that occurs when a user lowers a stylus to the screen, - - moves it across the screen, and lifts it away is:

- -
    - -
  • proximityBegin
    • - -
  • proximityMove
    • - -
  • touchBegin
    • - -
  • touchMove
    • - -
  • touchEnd
    • - -
  • proximityMove
    • - -
  • proximityEnd
    • - -
- -

Note: See the Multitouch class for environment compatibility information.

- - - -

- Defines the value of the type property of a PROXIMITY_MOVE - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.ui.Multitouch -
-
- - - - - -
proximityOutevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.PROXIMITY_OUT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - - the proximity detection threshold of the screen. - - - -

Note: See the Multitouch class for environment compatibility information.

- - - -

-See also -

-
-flash.ui.Multitouch -
-
- - - - - -
proximityOverevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.PROXIMITY_OVER -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched when the user moves an active stylus directly above this InteractiveObject - - while remaining within the proximity detection threshold of the screen. - - - -

Note: See the Multitouch class for environment compatibility information.

- - - -

- Defines the value of the type property of a PROXIMITY_OVER - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.ui.Multitouch -
-
- - - - - -
proximityRollOutevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.PROXIMITY_ROLL_OUT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched when the user moves an active stylus away from this InteractiveObject - - and any of its children while remaining within the proximity detection threshold of the screen. - - - -

The event target is the object previously under the stylus or a parent of - - that object. The relatedObject is the object that the stylus has moved above. - - The proximityRollOut 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 relatedObject.

- - - -

The purpose of the proximityRollOut event is to simplify the - - coding of rollover behaviors for display object containers with children. When the stylus leaves - - the area of a display object, including the area of any of its children, to go to an object that is not - - one of its children, the display object dispatches the proximityRollOut event. This is different behavior - - than that of the proximityOut 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.

- - - -

Note: See the Multitouch class for environment compatibility information.

- - - -

- Defines the value of the type property of a PROXIMITY_ROLL_OUT - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.ui.Multitouch -
-
- - - - - -
proximityRollOverevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.PROXIMITY_ROLL_OVER -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - - object's tree of descendents in the display list - - (while remaining within the proximity detection threshold of the screen). - - - -

The event target is the object under the stylus or a parent of that object. - - The relatedObject is the object that was previously under the stylus. - - The proximityRollOver 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 relatedObject and ending with the object.

- - - -

The purpose of the proximityRollOver event is to simplify the coding of rollout behaviors for - - display object containers with children. When the stylus enters the area above a display - - object or above any of its children from an object that is not one of its - - children, the display object dispatches the proximityRollOver event. This is different behavior - - than that of the proximityOver 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.

- - - -

Note: See the Multitouch class for environment compatibility information.

- - - -

- Defines the value of the type property of a PROXIMITY_ROLL_OVER - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.ui.Multitouch -
-
- - - - - -
releaseOutsideevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.RELEASE_OUTSIDE -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 3.3 - -
-

- - Dispatched when a user releases the button on the pointing device after the - - user first pressed the button over an InteractiveObject instance - - and then moved the pointing device off of the InteractiveObject instance. - - If the target is a SimpleButton instance, the object displays the upState - - display object. - - If the target is a selectable text field, the text field ends selection as the default - - behavior. - - - -

- - - - - -
rightClickevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.RIGHT_CLICK -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when a user presses and releases the right button of the user's - - pointing device over the same InteractiveObject. For a rightClick event to occur, it must always follow this series of - - events in the order of occurrence: rightMouseDown event, then rightMouseUp. The target object - - must be identical for both of these events; otherwise the rightClick event does not - - occur. Any number of other mouse events can occur at any time between the - - rightMouseDown or rightMouseUp events; the rightClick event - - still occurs. - -

- - Defines the value of the type property of a rightClick event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor right-click events, this property is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
rightMouseDownevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.RIGHT_MOUSE_DOWN -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when a user presses the pointing device button over an InteractiveObject instance. - -

- - - - - -
rightMouseUpevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.RIGHT_MOUSE_UP -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance. - -

- - Defines the value of the type property of a rightMouseUp event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the right mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
rollOutevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.ROLL_OUT -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 relatedObject is the object that the pointing device has moved to. - - The rollOut 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 relatedObject. - -

The purpose of the rollOut 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 rollOut event. This is different behavior - - than that of the mouseOut 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.

- -

- - Defines the value of the type property of a rollOut event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblesfalse
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
relatedObjectThe display list object to which the pointing device now points.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
rollOverevent  
-
-Event object type: flash.events.MouseEvent -
-MouseEvent.type property = flash.events.MouseEvent.ROLL_OVER -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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 relatedObject is the object that was previously under the pointing - - device. The rollOver 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 relatedObject and ending with the object. - -

The purpose of the rollOver 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 rollOver event. This is different behavior - - than that of the mouseOver 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.

- -

- - Defines the value of the type property of a rollOver event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblesfalse
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
relatedObjectThe display list object to which the pointing device was pointing.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
selectAllevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.SELECT_ALL -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - 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. - -

- The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny InteractiveObject instance with a listener registered for the selectAll event.
-

Note: TextField objects do not dispatch clear, copy, cut, paste, - or selectAll events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. - 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 clear, copy, cut, paste, - or selectAll events. However, other classes that extend the InteractiveObject class, including components built - using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.

- -
- - - - - -
softKeyboardActivateevent  
-
-Event object type: flash.events.SoftKeyboardEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 - -
-

- - Dispatched immediately after the soft keyboard is raised. - -

-See also -

-
-flash.events.SoftKeyboardEvent -
-
- - - - - -
softKeyboardActivatingevent  
-
-Event object type: flash.events.SoftKeyboardEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 - -
-

- - Dispatched immediately before the soft keyboard is raised. - -

-See also -

-
-flash.events.SoftKeyboardEvent -
-
- - - - - -
softKeyboardDeactivateevent  
-
-Event object type: flash.events.SoftKeyboardEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6
-

- - Dispatched immediately after the soft keyboard is lowered. - -

-See also -

-
-flash.events.SoftKeyboardEvent -
-
- - - - - -
tabChildrenChangeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.TAB_CHILDREN_CHANGE -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched when the value of the object's tabChildren flag changes. - -

- The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose tabChildren flag has changed. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
- - - - - -
tabEnabledChangeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.TAB_ENABLED_CHANGE -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched when the object's tabEnabled flag changes. - -

- The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object. - -

The tabEnabledChange event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe InteractiveObject whose tabEnabled flag has changed. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
- - - - - -
tabIndexChangeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.TAB_INDEX_CHANGE -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched when the value of the object's tabIndex property changes. - -

- The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object. - -

The tabIndexChange event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose tabIndex has changed. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
- - - - - -
textInputevent  
-
-Event object type: flash.events.TextEvent -
-TextEvent.type property = flash.events.TextEvent.TEXT_INPUT -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - 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. - -

- Defines the value of the type property of a textInput event object. -

Note: This event is not dispatched for the Delete or Backspace keys.

-

This event has the following properties:

- - - - - - - -
PropertyValue
bubblestrue
cancelabletrue; call the preventDefault() method - to cancel default behavior.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe text field into which characters are being entered. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
textThe character or sequence of characters entered by the user.
- -
- - - - - -
touchBeginevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.TOUCH_BEGIN -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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 mouseDown event. - -

Specifically, if a user touches a finger to a touch screen, the InteractiveObject instance can dispatch a mouseDown - - event or a touchBegin 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 mouseDown 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 touchBegin 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.

- -

Note: See the Multitouch class for environment compatibility information.

- -

- Defines the value of the type property of a TOUCH_BEGIN touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -
-Example -
The following example shows event handling for the TOUCH_BEGIN, TOUCH_MOVE, and TOUCH_END events. - While the point of contact moves across the screen (onTouchMove), the x-coordinate relative to the stage is traced to output. - For the Sprite.startTouchDrag parameters in the onTouchBegin 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). -
-
-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");
-}
-
-

-

-See also -

-
-mouseDown event -
-flash.ui.Multitouch -
-
- - - - - -
touchEndevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.TOUCH_END -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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 mouseUp event. - -

Specifically, if a user lifts a finger from a touch screen, the InteractiveObject instance can dispatch a mouseUp - - event or a touchEnd 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 mouseUp 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 touchEnd 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.

- -

Note: See the Multitouch class for environment compatibility information.

- -

- Defines the value of the type property of a TOUCH_END touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -
-Example -
The following example shows event handling for the TOUCH_BEGIN, TOUCH_MOVE, and TOUCH_END events. - While the point of contact moves across the screen (onTouchMove), the x-coordinate relative to the stage is traced to output. - For the Sprite.startTouchDrag parameters in the onTouchBegin 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). -
-
-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");
-}
-
-

-

-See also -

-
-mouseUp event -
-flash.ui.Multitouch -
-
- - - - - -
touchMoveevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.TOUCH_MOVE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. - - Note that this event does not require actual movement of the point of contact to be dispatched. - - -

Some devices might interpret this contact as a mouseMove event. - - Specifically, if a user moves a finger across a touch screen, the InteractiveObject instance can dispatch a mouseMove - - event or a touchMove 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 mouseMove 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 touchMove 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.

- - -

Note: See the Multitouch class for environment compatibility information.

- - - -

- Defines the value of the type property of a TOUCH_MOVE touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -
-Example -
The following example shows event handling for the TOUCH_BEGIN, TOUCH_MOVE, and TOUCH_END events. - While the point of contact moves across the screen (onTouchMove), the x-coordinate relative to the stage is traced to output. - For the Sprite.startTouchDrag parameters in the onTouchBegin 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). -
-
-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");
-}
-
-

-

-See also -

-
-mouseMove event -
-flash.ui.Multitouch -
-
- - - - - -
touchOutevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.TOUCH_OUT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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 mouseOut event. - -

Specifically, if a user moves a finger across a touch screen, the InteractiveObject instance can dispatch a mouseOut - - event or a touchOut 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 mouseOut 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 touchOut 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.

- -

Note: See the Multitouch class for environment compatibility information.

- -

- Defines the value of the type property of a TOUCH_OUT touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-mouseOut event -
-flash.ui.Multitouch -
-
- - - - - -
touchOverevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.TOUCH_OVER -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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 mouseOver event. - -

Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a mouseOver - - event or a touchOver 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 mouseOver 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 touchOver 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.

- -

Note: See the Multitouch class for environment compatibility information.

- -

- Defines the value of the type property of a TOUCH_OVER touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-mouseOver event -
-flash.ui.Multitouch -
-
- - - - - -
touchRollOutevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.TOUCH_ROLL_OUT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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 rollOut event. - -

Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a rollOut - - event or a touchRollOut 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 rollOut 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 touchRollOut 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.

- -

Note: See the Multitouch class for environment compatibility information.

- -

- Defines the value of the type property of a TOUCH_ROLL_OUT touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-rollOut event -
-flash.ui.Multitouch -
-
- - - - - -
touchRollOverevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.TOUCH_ROLL_OVER -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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 rollOver event. - -

Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a rollOver - - event or a touchRollOver 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 rollOver 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 touchRollOver 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.

- -

Note: See the Multitouch class for environment compatibility information.

- -

- Defines the value of the type property of a TOUCH_ROLL_OVER touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-rollOver event -
-flash.ui.Multitouch -
-
- - - - - -
touchTapevent  
-
-Event object type: flash.events.TouchEvent -
-TouchEvent.type property = flash.events.TouchEvent.TOUCH_TAP -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - 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 click event. - -

Specifically, if a user taps a finger over an InteractiveObject, the InteractiveObject instance can dispatch a click - - event or a touchTap 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 click 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 touchTap 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.

- -

Note: See the Multitouch class for environment compatibility information.

- -

- Defines the value of the type property of a TOUCH_TAP touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -
-Example -
The following example displays a message when the - square drawn on mySprite is tapped on a touch-enabled screen: -
-
-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);
-}
-
-

-

-See also -

-
-click event -
-flash.ui.Multitouch -
-
- -
Examples
-
examples\InteractiveObjectExample
-
The following example uses the InteractiveObjectExample class, which in - turn uses the ChildSprite class to draw a rectangle and then manipulate that rectangle - based on various mouse events. This task is accomplished by performing the following steps: -
    -
  1. In the InteractiveObjectExample constructor, a new ChildSprite object of type Sprite - called child 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 child - object is added to the top of the display list at coordinates x = 0, y = 0.
    2. - -
  2. In the ChildSprite class, declare the size and - overSize properties that are used later in the draw() method and - MouseEvent methods.
    3. - -
  3. Declare properties that set the background color to orange, the mouse-over color to - dark yellow, and the mouse-down color to light blue.
    4. - -
  4. In the ChildSprite constructor, an orange square is drawn by using methods from - the Graphics class and the draw() method.
    5. - -
  5. The constructor adds four MouseEvent event listener methods: - -
      -
    • mouseOverHandler: redraws a larger 60 x 60 pixel square with a dark-yellow color - at the original coordinates.
      • -
    • mouseOutHandler: returns the square to its original size and color.
      • -
    • mouseDownHandler: redraws a larger 60 x 60 pixel square with a light-blue color - at the original coordinates.
      • -
    • mouseUpHandler: same as mouseOverHandler.
      • -
    -
    6. -
-
-
-
-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);
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/InterpolationMethod.html b/html-docs/flash/display/InterpolationMethod.html deleted file mode 100644 index 77cc156..0000000 --- a/html-docs/flash/display/InterpolationMethod.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - - - -flash.display.InterpolationMethod (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class InterpolationMethod
InheritanceInterpolationMethod Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The InterpolationMethod class provides values for the interpolationMethod -parameter in the Graphics.beginGradientFill() and -Graphics.lineGradientStyle() methods. This parameter determines -the RGB space to use when rendering the gradient. - - -

-

-See also -

-
-flash.display.Graphics.beginGradientFill() -
-flash.display.Graphics.lineGradientStyle() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  LINEAR_RGB : String = "linearRGB"
[static] - Specifies that the linear RGB interpolation method should be used.
-		InterpolationMethod
  RGB : String = "rgb"
[static] - Specifies that the RGB interpolation method should be used.
-		InterpolationMethod
-
- -
- -
Constant detail
- - - - - -
LINEAR_RGBconstant
-
-public static const LINEAR_RGB:String = "linearRGB" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies that the linear RGB interpolation method should be used. This means that - an RGB color space based on a linear RGB color model is used. - - -

-See also -

-
-RGB -
-
- - - - - -
RGBconstant 
-
-public static const RGB:String = "rgb" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies that the RGB interpolation method should be used. This means that the gradient is rendered with - exponential sRGB (standard RGB) space. - The sRGB space is a W3C-endorsed standard that defines a non-linear conversion between - red, green, and blue component values and the actual intensity of the visible component color. - -

For example, consider a simple linear gradient between two colors (with the spreadMethod - parameter set to SpreadMethod.REFLECT). The different interpolation methods affect - the appearance as follows:

- - - - - - - - - - - - -
linear gradient with InterpolationMethod.LINEAR_RGBlinear gradient with InterpolationMethod.RGB
InterpolationMethod.LINEAR_RGBInterpolationMethod.RGB
- -

-See also -

-
-LINEAR_RGB -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/JPEGEncoderOptions.html b/html-docs/flash/display/JPEGEncoderOptions.html deleted file mode 100644 index 7d23997..0000000 --- a/html-docs/flash/display/JPEGEncoderOptions.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - - - - -flash.display.JPEGEncoderOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class JPEGEncoderOptions
InheritanceJPEGEncoderOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

-

- The JPEGEncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method. -

-

-See also -

-
-flash.display.BitmapData -
-flash.display.BitmapData.encode() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : uint -
- A value between 1 and 100, where 1 means the lowest quality and 100 means the highest quality.
-		JPEGEncoderOptions
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-JPEGEncoderOptions(quality:uint = 80)
-
- Creates a JPEGEncoderOptions object with the specified setting.
-		JPEGEncoderOptions
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
qualityproperty
-
-public var quality:uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- A value between 1 and 100, where 1 means the lowest quality and 100 means the highest quality. - The higher the value, the larger the size of the output of the compression, - and the smaller the compression ratio. -

- -
Constructor detail
- - - - - -
JPEGEncoderOptions()constructor
-
-public function JPEGEncoderOptions(quality:uint = 80) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Creates a JPEGEncoderOptions object with the specified setting. -

Parameters - - - - -
quality:uint (default = 80) — The initial quality value. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/JPEGXREncoderOptions.html b/html-docs/flash/display/JPEGXREncoderOptions.html deleted file mode 100644 index 437a319..0000000 --- a/html-docs/flash/display/JPEGXREncoderOptions.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - - - - -flash.display.JPEGXREncoderOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class JPEGXREncoderOptions
InheritanceJPEGXREncoderOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

-

- The JPEGXREncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method. -

-

-See also -

-
-flash.display.BitmapData -
-flash.display.BitmapData.encode() -
-flash.display.BitmapEncodingColorSpace -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  colorSpace : String -
- Specifies how color channels are sampled.
-		JPEGXREncoderOptions
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quantization : uint -
- Specifies the amount of lossy in the compression.
-		JPEGXREncoderOptions
  trimFlexBits : uint -
- Determines the amount of extra entropy data that is cut after quantization.
-		JPEGXREncoderOptions
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-JPEGXREncoderOptions(quantization:uint = 20, colorSpace:String = "auto", trimFlexBits:uint = 0)
-
- Creates a JPEGEXREncoderOptions object with the specified settings.
-		JPEGXREncoderOptions
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
colorSpaceproperty
-
-public var colorSpace:String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Specifies how color channels are sampled. - For more information, see flash.display.BitmapEncodingColorSpace. -

-See also -

-
-flash.display.BitmapEncodingColorSpace -
-
- - - - - -
quantizationproperty 
-
-public var quantization:uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Specifies the amount of lossy in the compression. - The range of values is 0 to 100, where a value of 0 means lossless compression. - Larger values increase the lossy value and the resultant image becomes more grainy. - A common value is 10. - For values of 20 or larger, the image can become very grainy. -

- - - - - -
trimFlexBitsproperty 
-
-public var trimFlexBits:uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Determines the amount of extra entropy data that is cut after quantization. - This property can affect image quality, and is typically left at the default value. -

- -
Constructor detail
- - - - - -
JPEGXREncoderOptions()constructor
-
-public function JPEGXREncoderOptions(quantization:uint = 20, colorSpace:String = "auto", trimFlexBits:uint = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Creates a JPEGEXREncoderOptions object with the specified settings. -

Parameters - - - - - - - - - - - - - - - - -
quantization:uint (default = 20) — The amount of lossy in the compression. -
 
colorSpace:String (default = "auto") — Specifies how color channels are sampled. -
 
trimFlexBits:uint (default = 0) — Determines the amount of extra entropy data - that is cut after quantization. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/JointStyle.html b/html-docs/flash/display/JointStyle.html deleted file mode 100644 index e86df37..0000000 --- a/html-docs/flash/display/JointStyle.html +++ /dev/null @@ -1,427 +0,0 @@ - - - - - - - - -flash.display.JointStyle (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class JointStyle
InheritanceJointStyle Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The JointStyle class is an enumeration of constant values that specify the joint style to use in drawing lines. -These constants are provided for use as values in the joints parameter of the -flash.display.Graphics.lineStyle() method. The method supports three types of joints: -miter, round, and bevel, as the following example shows: - -

MITER, ROUND, and BEVEL

- - -

-

-View the examples. -

-

-See also -

-
-flash.display.Graphics.lineStyle() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  BEVEL : String = "bevel"
[static] - - Specifies beveled joints in the joints parameter of the - flash.display.Graphics.lineStyle() method.
-		JointStyle
  MITER : String = "miter"
[static] - - Specifies mitered joints in the joints parameter of the - flash.display.Graphics.lineStyle() method.
-		JointStyle
  ROUND : String = "round"
[static] - - Specifies round joints in the joints parameter of the - flash.display.Graphics.lineStyle() method.
-		JointStyle
-
- -
- -
Constant detail
- - - - - -
BEVELconstant
-
-public static const BEVEL:String = "bevel" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- - Specifies beveled joints in the joints parameter of the - flash.display.Graphics.lineStyle() method. - -

- - - - - -
MITERconstant 
-
-public static const MITER:String = "miter" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- - Specifies mitered joints in the joints parameter of the - flash.display.Graphics.lineStyle() method. - -

- - - - - -
ROUNDconstant 
-
-public static const ROUND:String = "round" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- - Specifies round joints in the joints parameter of the - flash.display.Graphics.lineStyle() method. - -

- -
Examples
-
examples\JointStyleExample
-
The following example uses the JointStyleExample class to show the result - of three different joint styles applied to three sets of joined lines. This task is accomplished by performing - the following steps: -
    -
  1. The properties of each line are set as follows: -
      -
    • The line length is set to 80 pixels.
      • -
    • The border color is set to orange.
      • -
    • The border size is set to 30 pixels.
      • -
    • The highlight color is set to gray.
      • -
    • The highlight size is set to zero pixels.
      • -
    • The alpha is set to 1, making it solid.
      • -
    • The pixel hinting is set to false (strokes not hinted to full pixels).
      • -
    • The line scale mode is set to normal, which scales the thickness.
      • -
    • The border caps and miter limit are declared but not set, so the default values are used.
      • -
    2. -
  2. The class constructor creates three sets of two connected line segments. The segments start at x = 0, y = 0 - by calling the doDrawCorner() method three times using the three joint styles (miter, - round, and bevel). Each of the three calls to doDrawCorner() uses the joint style and - properties previously listed to draw two connected line segments and associated line highlights. This is done by - first creating a new Shape object child and then using methods of the Graphics - class to set the line style and draw the lines and highlights. Each instance of child - is added to the display list and promptly drawn on the stage.
    3. -
  3. The connected line segments are then redrawn by using the refreshLayout() method - at y = 80 pixels and starting at x = 80 pixels, with a 25-pixel separation between the line segments.
    4. -
-
-
-package {
-    import flash.display.DisplayObject;
-    import flash.display.Graphics;
-    import flash.display.JointStyle;
-    import flash.display.LineScaleMode;
-    import flash.display.Shape;
-    import flash.display.Sprite;
-
-    public class JointStyleExample extends Sprite {
-        private var size:uint                  = 80;
-        private var borderColor:uint           = 0xFFCC00;
-        private var borderSize:uint            = 30;
-        private var highlightColor:uint        = 0x666666;
-        private var highlightSize:uint         = 0;
-        private var gutter:uint                = 25;
-        private var borderAlpha:uint           = 1;
-        private var borderPixelHinting:Boolean = false;
-        private var borderScaleMode:String     = LineScaleMode.NORMAL;
-        private var borderCaps:String;
-        private var borderMiterLimit:uint;
-
-        public function JointStyleExample() {
-            doDrawCorner(JointStyle.MITER);
-            doDrawCorner(JointStyle.ROUND);
-            doDrawCorner(JointStyle.BEVEL);
-            refreshLayout();
-        }
-
-        private function doDrawCorner(jointStyle:String):void {
-            var halfSize:uint = Math.round(size / 2);
-            var child:Shape = new Shape();
-            child.graphics.lineStyle(borderSize,
-                                     borderColor,
-                                     borderAlpha,
-                                     borderPixelHinting,
-                                     borderScaleMode,
-                                     borderCaps,
-                                     jointStyle,
-                                     borderMiterLimit);
-            child.graphics.lineTo(0, 0);
-            child.graphics.lineTo(size, 0);
-            child.graphics.lineTo(halfSize, size);
-            child.graphics.endFill();
-
-            child.graphics.moveTo(0, 0);
-            child.graphics.lineStyle(highlightSize, highlightColor);
-            child.graphics.lineTo(0, 0);
-            child.graphics.lineTo(size, 0);
-            child.graphics.lineTo(halfSize, size);
-
-            addChild(child);
-        }
-
-        private function refreshLayout():void {
-            var ln:uint = numChildren;
-            var child:DisplayObject;
-            var lastChild:DisplayObject = getChildAt(0);
-            lastChild.x = size;
-            lastChild.y = size;
-            for (var i:uint = 1; i < ln; i++) {
-                child = getChildAt(i);
-                child.x = gutter + lastChild.x + lastChild.width;
-                child.y = size;
-                lastChild = child;
-            }
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/LineScaleMode.html b/html-docs/flash/display/LineScaleMode.html deleted file mode 100644 index b7451a0..0000000 --- a/html-docs/flash/display/LineScaleMode.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - -flash.display.LineScaleMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class LineScaleMode
InheritanceLineScaleMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The LineScaleMode class provides values for the scaleMode -parameter in the Graphics.lineStyle() method. - - -

-

-See also -

-
-flash.display.Graphics.lineStyle() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  HORIZONTAL : String = "horizontal"
[static] - With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line scales only horizontally.
-		LineScaleMode
  NONE : String = "none"
[static] - With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line never scales.
-		LineScaleMode
  NORMAL : String = "normal"
[static] - With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line always scales when the object is scaled (the default).
-		LineScaleMode
  VERTICAL : String = "vertical"
[static] - With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line scales only vertically.
-		LineScaleMode
-
- -
- -
Constant detail
- - - - - -
HORIZONTALconstant
-
-public static const HORIZONTAL:String = "horizontal" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line scales only horizontally. For example, - consider the following circles, drawn with a one-pixel line, and each with the - scaleMode parameter set to LineScaleMode.HORIZONTAL. The circle on the left - is scaled only horizontally, and the circle on the right is scaled both vertically and horizontally. - -

A circle scaled horizontally, and a circle scaled both vertically and horizontally.

- -
- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line never scales. - -

- - - - - -
NORMALconstant 
-
-public static const NORMAL:String = "normal" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line always scales when the object is scaled (the default). - -

- - - - - -
VERTICALconstant 
-
-public static const VERTICAL:String = "vertical" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- With this setting used as the scaleMode parameter of the lineStyle() - method, the thickness of the line scales only vertically. For example, - consider the following circles, drawn with a one-pixel line, and each with the - scaleMode parameter set to LineScaleMode.VERTICAL. The circle on the left - is scaled only vertically, and the circle on the right is scaled both vertically and horizontally. - -

A circle scaled vertically, and a circle scaled both vertically and horizontally.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/Loader.html b/html-docs/flash/display/Loader.html deleted file mode 100644 index 16bf16a..0000000 --- a/html-docs/flash/display/Loader.html +++ /dev/null @@ -1,3718 +0,0 @@ - - - - - - - - -flash.display.Loader (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class Loader
InheritanceLoader Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

-

- - The Loader class is used to load SWF files or image (JPG, PNG, or GIF) files. Use the - - load() method to initiate loading. The loaded display object is added as a child - - of the Loader object. - - -

Use the URLLoader class to load text or binary data.

- - - -

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: addChild(), addChildAt(), removeChild(), - - removeChildAt(), and setChildIndex(). To remove a loaded display object, - - you must remove the Loader object from its parent DisplayObjectContainer child array.

- - - -

iOS notes

- -

In AIR applications on iOS, you can only - - load a SWF file containing ActionScript from the application package. This - - restriction includes any ActionScript, such as assets with class names - - exported for ActionScript. For loading any SWF file, you must load the - - SWF using the same application domain as the parent SWF, as shown in the - - following example:

- - - 
-
- var loader:Loader = new Loader();
-
- var url:URLRequest = new URLRequest("swfs/SecondarySwf.swf");
-
- var loaderContext:LoaderContext = new LoaderContext(false, ApplicationDomain.currentDomain, null);
-
- loader.load(url, loaderContext);
- - -

In addition, on iOS you can't load a SWF file that contains any ActionScript ByteCode (ABC) - - then unload it and reload it. If you attempt to do this, the runtime throws error 3764.

- - - -

Prior to AIR 3.6, only SWF files that do not contain ActionScript bytecode - - can be loaded, regardless of whether they're loaded from the application package - - or over a network. As an alternative to using an external SWF file with - - ActionScript, create a SWC library and link it in to your main SWF.

- - - -

AIR 3.7 and higher supports loading of externally hosted secondary SWFs. - - The detailed description about this feature can be found - - here. - -

- - -

These iOS restrictions restrictions do not apply when an application is running in the iOS - - Simulator (ipa-test-interpreter-simulator or ipa-debug-interpreter-simulator) - - or interpreter mode (ipa-test-interpreter or ipa-debug-interpreter.)

- - -

Loader security

- - - -

When you use the Loader class, consider the Flash Player and Adobe AIR security model:

- - -
    - -
  • You can load content from any accessible source.
    • - - - -
  • Loading is not allowed if the calling SWF file is in a network sandbox and the file - - to be loaded is local.
    • - - - -
  • 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 System.allowDomain() or - - the System.allowInsecureDomain() method in the loaded content file.
    • - - - -
  • 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.
    • - - - -
  • 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.
    • - - - -
  • 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.
    • - - - -
  • You cannot connect to commonly reserved ports. For a complete list of blocked ports, - - see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.
    • - - - - - -
- - - -

However, in AIR, content in the application security sandbox (content - - installed with the AIR application) are not restricted by these security limitations.

- - - -

For more information related to security, see the Flash Player Developer Center Topic: - - Security.

- - -

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:

- - - - 
-
- 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);
-
-
- - - -

Note: App Transport Security is being introduced from Apple in iOS9, which doesn’t allow unsecure connections between App and Web services. - - Due to this change all the connections which are made to Unsecure web sites via Loader, URLLoader will discontinue and not work due to App Transport Security. - - Please specify exceptions to the default behaviour by adding keys to Info.plist in your app.

- - -

To turn off the feature completely you can add following in your Info.plist and it will work as before.

- - 
-
-     <key>NSAppTransportSecurity</key>
-
-               <dict>
-
-                   <key>NSAllowsArbitraryLoads</key><true/>
-
-               </dict>
-
-
- - -

Please specify exceptions to the default behavior by adding keys to InfoAdditions tag of application descriptor of your app.

- - 
-
-  <iPhone>
-
-  <InfoAdditions>
-
-                   <![CDATA[
-
-                          <key>NSAppTransportSecurity</key>
-
-                              <dict>
-
-                                        <key>NSExceptionDomains</key>
-
-                              <dict>
-
-                                       <key>www.example.com</key>
-
-                              <dict>
-
-                                     <!--Include to allow subdomains-->
-
-                                     <key>NSIncludesSubdomains</key>
-
-                                     <true/>
-
-                                     <!--Include to allow HTTP requests-->
-
-                                     <key>NSTemporaryExceptionAllowsInsecureHTTPLoads</key>
-
-                                     <true/>
-
-                                      <!--Include to specify minimum TLS version-->
-
-                                      <key>NSTemporaryExceptionMinimumTLSVersion</key>
-
-                                      <string>TLSv1.1</string>
-
-                              </dict>
-
-                              </dict>
-
-                              </dict>
-
-                  ]]>
-
-         </InfoAdditions>
-
-  </iPhone>
-
-
- - - - - -

-

-View the examples. -

-

-See also -

-
-flash.display.LoaderInfo -
-flash.net.URLLoader -
-flash.display.DisplayObject -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityImplementation : AccessibilityImplementation -
- - The current accessibility implementation (AccessibilityImplementation) - - for this InteractiveObject instance.
-		InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  content : DisplayObject -
[read-only] - - Contains the root display object of the SWF file or image (JPG, PNG, or GIF) - - file that was loaded by using the load() or loadBytes() methods.
-		Loader
  contentLoaderInfo : LoaderInfo -
[read-only] - - Returns a LoaderInfo object corresponding to the object being loaded.
-		Loader
 InheritedcontextMenu : NativeMenu -
- - Specifies the context menu associated with this object.
-		InteractiveObject
 InheriteddoubleClickEnabled : Boolean -
- - Specifies whether the object receives doubleClick events.
-		InteractiveObject
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 InheritedfocusRect : Object -
- - Specifies whether this object displays a focus rectangle.
-		InteractiveObject
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseChildren : Boolean -
- Determines whether or not the children of the object are mouse, or user input device, enabled.
-		DisplayObjectContainer
 InheritedmouseEnabled : Boolean -
- - Specifies whether this object receives mouse, or other user input, messages.
-		InteractiveObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedneedsSoftKeyboard : Boolean -
- - Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - - when this InteractiveObject instance receives focus.
-		InteractiveObject
 InheritednumChildren : int -
- Returns the number of children of this object.
-		DisplayObjectContainer
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
 InheritedsoftKeyboard : String -
- - Controls the appearance of the soft keyboard.
-		InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle -
- - Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
-		InteractiveObject
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
 InheritedtabChildren : Boolean -
- Determines whether the children of the object are tab enabled.
-		DisplayObjectContainer
 InheritedtabEnabled : Boolean -
- - Specifies whether this object is in the tab order.
-		InteractiveObject
 InheritedtabIndex : int -
- - Specifies the tab ordering of objects in a SWF file.
-		InteractiveObject
 InheritedtextSnapshot : TextSnapshot -
- Returns a TextSnapshot object for this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
  uncaughtErrorEvents : UncaughtErrorEvents -
[read-only] - - An object that dispatches an uncaughtError event when an unhandled error - - occurs in the SWF that's loaded by this Loader object.
-		Loader
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Loader()
-
- - Creates a Loader object that you can use to load files, such as SWF, JPEG, GIF, or PNG files.
-		Loader
 Inherited -
-addChild(child:DisplayObject):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-addChildAt(child:DisplayObject, index:int):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer - instance.
-		DisplayObjectContainer
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-areInaccessibleObjectsUnderPoint(point:Point):Boolean -
-
- Indicates whether the security restrictions - would cause any display objects to be omitted from the list returned by calling - the DisplayObjectContainer.getObjectsUnderPoint() method - with the specified point point.
-		DisplayObjectContainer
   -
-close():void -
-
- - Cancels a load() method operation that is currently in progress for the Loader instance.
-		Loader
 Inherited -
-contains(child:DisplayObject):Boolean -
-
- Determines whether the specified display object is a child of the DisplayObjectContainer instance or - the instance itself.
-		DisplayObjectContainer
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getChildAt(index:int):DisplayObject -
-
- Returns the child display object instance that exists at the specified index.
-		DisplayObjectContainer
 Inherited -
-getChildByName(name:String):DisplayObject -
-
- Returns the child display object that exists with the specified name.
-		DisplayObjectContainer
 Inherited -
-getChildIndex(child:DisplayObject):int -
-
- Returns the index position of a child DisplayObject instance.
-		DisplayObjectContainer
 Inherited -
-getObjectsUnderPoint(point:Point):Array -
-
- Returns an array of objects that lie under the specified point and are children - (or grandchildren, and so on) of this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-load(request:URLRequest, context:LoaderContext = null):void -
-
- - Loads a SWF, JPEG, progressive JPEG, unanimated GIF, or PNG file into an object that is a child of - - this Loader object.
-		Loader
   -
-loadBytes(bytes:ByteArray, context:LoaderContext = null):void -
-
- - Loads from binary data stored in a ByteArray object.
-		Loader
   -
-loadFilePromise(promise:IFilePromise, context:LoaderContext = null):void -
-
- - Loads an IFilePromise instance.
-		Loader
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeChild(child:DisplayObject):DisplayObject -
-
- Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeChildAt(index:int):DisplayObject -
-
- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer.
-		DisplayObjectContainer
 Inherited -
-removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void -
-
- Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-requestSoftKeyboard():Boolean -
-
- - Raises a virtual keyboard.
-		InteractiveObject
 Inherited -
-setChildIndex(child:DisplayObject, index:int):void -
-
- Changes the position of an existing child in the display object container.
-		DisplayObjectContainer
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopAllMovieClips():void -
-
- Recursively stops the timeline execution of all MovieClips rooted at this object.
-		DisplayObjectContainer
 Inherited -
-swapChildren(child1:DisplayObject, child2:DisplayObject):void -
-
- Swaps the z-order (front-to-back order) of the two specified child objects.
-		DisplayObjectContainer
 Inherited -
-swapChildrenAt(index1:int, index2:int):void -
-
- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list.
-		DisplayObjectContainer
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-unload():void -
-
- - Removes a child of this Loader object that was loaded by using the load() method.
-		Loader
   -
-unloadAndStop(gc:Boolean = true):void -
-
- - Attempts to unload child SWF file contents and stops the execution of commands from loaded SWF files.
-		Loader
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-clear -
-		 - - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 Inherited -
-click -
-		 - - Dispatched when a user presses and releases the main button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-contextMenu -
-		 - - Dispatched when a user gesture triggers the context menu associated with this interactive - - object in an AIR application.InteractiveObject
 Inherited -
-copy -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - - or selects 'Copy' from the text context menu.InteractiveObject
 Inherited -
-cut -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - - or selects 'Cut' from the text context menu.InteractiveObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-doubleClick -
-		 - - Dispatched when a user presses and releases the main button of a pointing device twice in - - rapid succession over the same InteractiveObject when that object's - - doubleClickEnabled flag is set to true.InteractiveObject
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-focusIn -
-		 - - Dispatched after a display object gains focus.InteractiveObject
 Inherited -
-focusOut -
-		 - - Dispatched after a display object loses focus.InteractiveObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-gestureDirectionalTap -
-		 - - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - - Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 Inherited -
-gestureLongPress -
-		 - - Dispatched when the user presses two points of contact over the same InteractiveObject instance - - on a touch-enabled device (such as presses and releases two fingers over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gesturePan -
-		 - - Dispatched when the user moves a point of contact over the InteractiveObject instance - - on a touch-enabled device (such as moving a finger from left to right over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureRotate -
-		 - - Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers - - and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureSwipe -
-		 - - Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three - - fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureTap -
-		 - - Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps - - on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureZoom -
-		 - - Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two - - fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-imeStartComposition -
-		 - - This event is dispatched to any client app that supports inline input with an IME - - - - InteractiveObject
 Inherited -
-keyDown -
-		 - - Dispatched when the user presses a key.InteractiveObject
 Inherited -
-keyFocusChange -
-		 - - Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited -
-keyUp -
-		 - - Dispatched when the user releases a key.InteractiveObject
 Inherited -
-middleClick -
-		 - - Dispatched when a user presses and releases the middle button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-middleMouseDown -
-		 - - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-middleMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseFocusChange -
-		 - - Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 Inherited -
-mouseMove -
-		 - - Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited -
-mouseOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheel -
-		 - - Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheelHorizontal -
-		 - - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-nativeDragComplete -
-		 - - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited -
-nativeDragDrop -
-		 - - Dispatched by the target InteractiveObject when a dragged object is - - dropped on it and the drop has been accepted with a call to - - DragManager.acceptDragDrop().InteractiveObject
 Inherited -
-nativeDragEnter -
-		 - - Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited -
-nativeDragExit -
-		 - - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited -
-nativeDragOver -
-		 - - Dispatched by an InteractiveObject continually while a drag gesture remains within its - - boundary.InteractiveObject
 Inherited -
-nativeDragStart -
-		 - - Dispatched at the beginning of a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-nativeDragUpdate -
-		 - - Dispatched during a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-paste -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - - or selects 'Paste' from the text context menu.InteractiveObject
 Inherited -
-proximityBegin -
-		 - - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityEnd -
-		 - - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityMove -
-		 - - Dispatched when the user moves an active stylus over the screen while remaining within - - the proximity detection threshold.InteractiveObject
 Inherited -
-proximityOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - - the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityOver -
-		 - - Dispatched when the user moves an active stylus directly above this InteractiveObject - - while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject - - and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOver -
-		 - - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - - object's tree of descendents in the display list - - (while remaining within the proximity detection threshold of the screen).InteractiveObject
 Inherited -
-releaseOutside -
-		 - - Dispatched when a user releases the button on the pointing device after the - - user first pressed the button over an InteractiveObject instance - - and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 Inherited -
-rightClick -
-		 - - Dispatched when a user presses and releases the right button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-rightMouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-rightMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-rollOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject - - instance.InteractiveObject
 Inherited -
-rollOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-selectAll -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a select all operation - - or selects 'Select All' from the text context menu.InteractiveObject
 Inherited -
-softKeyboardActivate -
-		 - - Dispatched immediately after the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardActivating -
-		 - - Dispatched immediately before the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardDeactivate -
-		 - - Dispatched immediately after the soft keyboard is lowered.InteractiveObject
 Inherited -
-tabChildrenChange -
-		 - - Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited -
-tabEnabledChange -
-		 - - Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited -
-tabIndexChange -
-		 - - Dispatched when the value of the object's tabIndex property changes.InteractiveObject
 Inherited -
-textInput -
-		 - - Dispatched when a user enters one or more - - characters of text.InteractiveObject
 Inherited -
-touchBegin -
-		 - - Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchEnd -
-		 - - Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchMove -
-		 - - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 Inherited -
-touchOut -
-		 - - Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device - - (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOut -
-		 - - Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchTap -
-		 - - Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated - - on a touch-enabled device (such as presses and releases a finger from a single point over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
-
- -
- -
Property detail
- - - - - -
contentproperty
-
-content:DisplayObject  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Contains the root display object of the SWF file or image (JPG, PNG, or GIF) - - file that was loaded by using the load() or loadBytes() methods. - - -

Implementation -
-    public function get content():DisplayObject -
-
-Throws -
- - - - -
SecurityError — The loaded SWF file or image file belongs to a security - - sandbox to which you do not have access. For a loaded SWF file, you can avoid this situation by having - - the file call the Security.allowDomain() method or by having the loading file specify a - - loaderContext parameter with its securityDomain property set to - - SecurityDomain.currentDomain when you call the load() or - - loadBytes() method. - - - -
-

-See also -

-
-flash.display.DisplayObject -
-flash.display.Loader.load() -
-
- - - - - -
contentLoaderInfoproperty 
-
-contentLoaderInfo:LoaderInfo  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Returns a LoaderInfo object corresponding to the object being loaded. LoaderInfo objects - - are shared between the Loader object and the loaded content object. The LoaderInfo object - - supplies loading progress information and statistics about the loaded file. - - - -

Events related to the load are dispatched by the LoaderInfo object referenced by the - - contentLoaderInfo property of the Loader object. The contentLoaderInfo - - property is set to a valid LoaderInfo object, even before the content is loaded, so that you can add - - event listeners to the object prior to the load.

- - - -

To detect uncaught errors that happen in a loaded SWF, use the - - Loader.uncaughtErrorEvents property, not the - - Loader.contentLoaderInfo.uncaughtErrorEvents property.

- - - - Implementation -
-    public function get contentLoaderInfo():LoaderInfo -
-

-See also -

-
-flash.display.LoaderInfo -
-
-Example -
The following example shows how you can load and position an image in ActionScript 3.0 using the Loader class and the complete event on the Loader object's contentLoaderInfo property. - Example provided by - ActionScriptExamples.com. -
-
-var url:String = "http://www.helpexamples.com/flash/images/image2.jpg";
-var urlRequest:URLRequest = new URLRequest(url);
-var loader:Loader = new Loader();
-loader.contentLoaderInfo.addEventListener(Event.COMPLETE, loader_complete);
-loader.load(urlRequest);
-addChild(loader);
- 
-function loader_complete(evt:Event):void {
-    var target_mc:Loader = evt.currentTarget.loader as Loader;
-    target_mc.x = (stage.stageWidth - target_mc.width) / 2;
-    target_mc.y = (stage.stageHeight - target_mc.height) / 2;
-}
-
-

-
- - - - - -
uncaughtErrorEventsproperty 
-
-uncaughtErrorEvents:UncaughtErrorEvents  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 2 - -
-

- - An object that dispatches an uncaughtError event when an unhandled error - - occurs in the SWF that's loaded by this Loader object. - - An uncaught error happens when an error is - - thrown outside of any try..catch blocks or when an ErrorEvent - - object is dispatched with no registered listeners. - - - -

Note that a Loader object's uncaughtErrorEvents property - - dispatches events that bubble through it, not events that it dispatches directly. - - It never dispatches an uncaughtErrorEvent in the target phase. It only - - dispatches the event in the capture and bubbling phases. To detect an uncaught error - - in the current SWF (the SWF in which the Loader object - - is defined) use the LoaderInfo.uncaughtErrorEvents property instead.

- - - -

If the content loaded by the Loader object is an AVM1 (ActionScript 2) SWF file, - - uncaught errors in the AVM1 SWF file do not result in an uncaughtError - - event.

- - - - Implementation -
-    public function get uncaughtErrorEvents():UncaughtErrorEvents -
-

-See also -

-
-UncaughtErrorEvent -
-LoaderInfo.uncaughtErrorEvents -
-
-Example -
The following example demonstrates the use of an uncaught error event - handler to detect uncaught errors in a loaded SWF. The example defines - an uncaughtError event handler to detect uncaught errors. - -

In the constructor, the code creates a Loader object and registers a listener for - the uncaughtError event dispatched by the Loader object's - uncaughtErrorEvents property.

- -

In the uncaughtErrorHandler() method, the code checks the data type of - the error property and responds accordingly.

-
-
-package
-{
-    import flash.display.Loader;
-    import flash.display.Sprite;
-	import flash.events.ErrorEvent;
-	import flash.events.UncaughtErrorEvent;
-	import flash.net.URLRequest;
-
-    public class LoaderUncaughtErrorEventExample extends Sprite
-    {
-		private var ldr:Loader;
-		
-        public function LoaderUncaughtErrorEventExample()
-        {
-			ldr = new Loader();
-			ldr.load(new URLRequest("child.swf"));
-            ldr.uncaughtErrorEvents.addEventListener(UncaughtErrorEvent.UNCAUGHT_ERROR, uncaughtErrorHandler);
-        }
-		
-        private function uncaughtErrorHandler(event:UncaughtErrorEvent):void
-        {
-            if (event.error is Error)
-            {
-                var error:Error = event.error as Error;
-				// do something with the error
-            }
-            else if (event.error is ErrorEvent)
-            {
-                var errorEvent:ErrorEvent = event.error as ErrorEvent;
-				// do something with the error
-            }
-            else
-            {
-                // a non-Error, non-ErrorEvent type was thrown and uncaught
-            }
-        }
-    }
-}
-
-

-
- -
Constructor detail
- - - - - -
Loader()constructor
-
-public function Loader() -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates a Loader object that you can use to load files, such as SWF, JPEG, GIF, or PNG files. - - Call the load() 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 - - addChild() method of a DisplayObjectContainer instance). - - The asset appears on the Stage as it loads. - - - -

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.

- - - -

To detect when the SWF file is finished loading, you can use the events of the LoaderInfo - - object associated with the contentLoaderInfo 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.

- - - -

To determine the status of a Loader object, monitor the following events that the LoaderInfo - - object associated with the contentLoaderInfo property of the Loader object:

- - - -
    - - - -
  • The open event is dispatched when loading begins.
    • - - - -
  • The ioError, securityError or certificateError event is - - dispatched if the file cannot be loaded or if an error occured during the load process.
    • - - - -
  • The progress event fires continuously while the file is being loaded.
    • - - - -
  • The complete event is dispatched when a file completes downloading, but before - - the loaded movie clip's methods and properties are available.
    • - - - -
  • The init 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 complete handler. In streaming SWF files, - - the init event can occur significantly earlier than the complete event. - - For most purposes, use the init handler.
    • - - - -
- - -

Notes (iOS only): In AIR applications on iOS, you can only - - load a SWF file containing ActionScript from the application package. This - - restriction includes any ActionScript, such as assets with class names - - exported for ActionScript. For loading any SWF file, you must load the - - SWF using the same application domain as the parent SWF.

- - - -

Prior to AIR 3.6, only SWF files that do not contain ActionScript bytecode - - can be loaded, regardless of whether they're loaded from the application package - - or over a network. As an alternative to using an external SWF file with - - ActionScript, create a SWC library and link it in to your main SWF.

- - - -

These restrictions do not apply when an application is running in the iOS - - Simulator (ipa-test-interpreter-simulator or ipa-debug-interpreter-simulator) - - or interpreter mode (ipa-test-interpreter or ipa-debug-interpreter.)

- - -

-See also -

-
-flash.display.Loader.load() -
-flash.display.LoaderInfo -
-
- -
Method detail
- - - - - -
close()method
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Cancels a load() method operation that is currently in progress for the Loader instance. - - - -

-See also -

-
-flash.display.Loader.load() -
-
- - - - - -
load()method 
-
-public function load(request:URLRequest, context:LoaderContext = null):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Loads a SWF, JPEG, progressive JPEG, unanimated GIF, or PNG file into an object that is a child of - - this Loader object. If you load an animated GIF file, only the first frame is displayed. - - As the Loader object can contain only a single child, issuing a subsequent load() - - request terminates the previous request, if still pending, and commences a new load. - - -

Note: - - In AIR 1.5 and Flash Player 10, the maximum size for a loaded image is 8,191 pixels in width or height, - - and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an loaded image is 8,191 pixels - - wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, the limitation - - is 2,880 pixels in height and 2,880 pixels in width.

- - - -

A SWF file or image loaded into a Loader object inherits the position, rotation, and scale - - properties of the parent display objects of the Loader object.

- - - -

Use the unload() method to remove movies or images loaded with this - - method, or to cancel a load operation that is in progress.

- - -

You can prevent a SWF file from using this method by setting the allowNetworking - - parameter of the the object and embed tags in the HTML - - page that contains the SWF content.

- - -

iOS notes

- -

In AIR applications on iOS, you can only - - load a SWF file containing ActionScript from the application package. This - - restriction includes any ActionScript, such as assets with class names - - exported for ActionScript. For loading any SWF file, you must load the - - SWF using the same application domain as the parent SWF, as shown in the - - following example:

- - - 
-
-     var loader:Loader = new Loader();
-
-     var url:URLRequest = new URLRequest("swfs/SecondarySwf.swf");
-
-     var loaderContext:LoaderContext = new LoaderContext(false, ApplicationDomain.currentDomain, null);
-
-     loader.load(url, loaderContext);
- - -

In addition, on iOS you can't load a SWF file that contains any ActionScript ByteCode (ABC) - - then unload it and reload it. If you attempt to do this, the runtime throws error 3764.

- - - -

Prior to AIR 3.6, only SWF files that do not contain ActionScript bytecode - - can be loaded, regardless of whether they're loaded from the application package - - or over a network. As an alternative to using an external SWF file with - - ActionScript, create a SWC library and link it in to your main SWF.

- - - -

These restrictions do not apply when an application is running in the iOS - - Simulator (ipa-test-interpreter-simulator or ipa-debug-interpreter-simulator) - - or interpreter mode (ipa-test-interpreter or ipa-debug-interpreter.)

- - -

Loader security

- - - -

When you use this method, consider the Flash Player security model, - - which is described in the Loader class description.

- - - -

In Flash Player 10 and later, if you use a multipart Content-Type (for example "multipart/form-data") - - that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), - - the POST operation is subject to the security rules applied to uploads:

- -
    - -
  • The POST operation must be performed in response to a user-initiated action, such as a mouse click or key press.
    • - -
  • If the POST operation is cross-domain (the POST target is not on the same server as the SWF file - - that is sending the POST request), - - the target server must provide a URL policy file that permits cross-domain access.
    • - -
- -

Also, for any multipart Content-Type, the syntax must be valid (according to the RFC2046 standard). - - If the syntax appears to be invalid, the POST operation is subject to the security rules applied to uploads.

- - -

For more information related to security, see the Flash Player Developer Center Topic: - - Security.

- - - Parameters - - - - - - - - - - -
request:URLRequest — The absolute or relative URL of the SWF, JPEG, GIF, or PNG file to be loaded. A - - relative path must be relative to the main SWF file. Absolute URLs must include the - - protocol reference, such as http:// or file:///. Filenames cannot include disk drive - - specifications. - - - -
 
context:LoaderContext (default = null) — A LoaderContext object, which has properties that define the following: - - - -
    - - - -
  • Whether or not to check for the existence of a policy file - - upon loading the object
    • - - - -
  • The ApplicationDomain for the loaded object
    • - - - -
  • The SecurityDomain for the loaded object
    • - - -
  • The ImageDecodingPolicy for the loaded image object
    • - - - -
- -

If the context parameter is not specified or refers to a null object, - - the loaded content remains in its own security domain.

- - -

iOS only: When calling the load() method - - in AIR for iOS, the LoaderContext instance must specify the main application - - domain (ApplicationDomain.currentDomain).

- - - -

For complete details, see the description of the properties in the - - LoaderContext class.

- - -
-
-Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
asyncError:AsyncErrorEvent — Dispatched by the contentLoaderInfo object if the - - LoaderContext.requestedContentParent property has been specified and it is not possible to add the - - loaded content as a child to the specified DisplayObjectContainer. This could happen if the loaded content is a - - flash.display.AVM1Movie or if the addChild() call to the requestedContentParent throws - - an error.
 
complete:Event — Dispatched by the contentLoaderInfo object when the file has - - completed loading. The complete event is always dispatched after the init event.
 
httpStatus:HTTPStatusEvent — Dispatched by the contentLoaderInfo object when a network - - request is made over HTTP and Flash Player can detect the HTTP status code.
 
init:Event — Dispatched by the contentLoaderInfo object when the properties and methods - - of the loaded SWF file are accessible. The init event always precedes the complete - - event.
 
ioError:IOErrorEvent — Dispatched by the contentLoaderInfo object when an input or output - - error occurs that causes a load operation to fail.
 
open:Event — Dispatched by the contentLoaderInfo object when the loading operation starts.
 
progress:ProgressEvent — Dispatched by the contentLoaderInfo object as data is received - - while load operation progresses.
 
securityError:SecurityErrorEvent — Dispatched by the contentLoaderInfo object if a SWF file - - in the local-with-filesystem sandbox attempts to load content in the local-with-networking sandbox, or vice versa.
 
certificateError:SecurityErrorEvent — Dispatched by the contentLoaderInfo object if a load request - - is made to a secure server that has an invalid (e.g. self-signed) certificate. Listening for this event will override - - any default OS-specific behaviour and cause the connection to be rejected, unless the preventDefault() method - - is called on the event.
 
securityError:SecurityErrorEvent — Dispatched by the contentLoaderInfo object if the - - LoaderContext.requestedContentParent property has been specified and the security sandbox - - of the LoaderContext.requestedContentParent does not have access to the loaded SWF.
 
unload:Event — Dispatched by the contentLoaderInfo object when a loaded object is removed.
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — The digest property of the request object is not - - null. You should only set the digest property of a URLRequest object - - when calling the URLLoader.load() method when loading a SWZ file (an Adobe - - platform component). - - -
 
SecurityError — The value of LoaderContext.securityDomain must be either null - - or SecurityDomain.currentDomain. This reflects the fact that you can only - - place the loaded media in its natural security sandbox or your own (the latter requires a - - policy file). - - -
 
SecurityError — Local SWF files may not set LoaderContext.securityDomain to anything - - other than null. It is not permitted to import non-local media into a local - - sandbox, or to place other local media in anything other than its natural sandbox. - - -
 
SecurityError — You cannot connect to commonly reserved ports. - - For a complete list of blocked ports, see "Restricting Networking APIs" in the - - ActionScript 3.0 Developer's Guide. - - -
 
SecurityError — If the applicationDomain or securityDomain - - properties of the context parameter are from a disallowed domain. - - - -
 
SecurityError — If a local SWF file is attempting to use the securityDomain property - - of the context parameter. - - -
 
Error — If the requestedContentParent property of the context parameter - - is a Loader. - - - -
 
Error — If the LoaderContext.parameters parameter is - - set to non-null and has some values which are not Strings. - - -
 
Error — On iOS, if the application attempts to load - - a SWF file in an application domain other than the main application domain. - - -
 
Error — On iOS, if the application attempts to reload - - a SWF that has been loaded and unloaded and the SWF contains ABC code. - - - -
 
Error — On iOS, if the application attempts to load a SWF file from - - outside the application package that contains ActionScript code. This error - - can't be caught. It appears as a dialog box on the app screen with the - - title "Uncompiled ActionScript." Prior to AIR 3.6, this error occurs when - - you attempt to load any SWF file containing ActionScript, whether it is - - external or included in the application package. - - - -
-

-See also -

-
-contentLoaderInfo -
-flash.net.URLRequest -
-flash.display.DisplayObject -
-flash.display.Loader.unload() -
-flash.display.LoaderInfo -
-flash.system.LoaderContext -
-
- - - - - -
loadBytes()method 
-
-public function loadBytes(bytes:ByteArray, context:LoaderContext = null):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Loads from binary data stored in a ByteArray object. - - -

The loadBytes() method is asynchronous. You must wait for the "init" event before - - accessing the properties of a loaded object.

- - - -

When you use this method, consider the Flash Player security model, - - which is described in the Loader class description.

- - - - -

Note (iOS only): In AIR applications on iOS, you can only - - load a SWF file containing ActionScript from the application package. This - - restriction includes any ActionScript, such as assets with class names - - exported for ActionScript. For loading any SWF file, you must load the - - SWF using the same application domain as the parent SWF.

- - - -

Prior to AIR 3.6, calling this method has no effect on iOS.

- - - - Parameters - - - - - - - - - - -
bytes:ByteArray — 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. - - - -
 
context:LoaderContext (default = null) — A LoaderContext object. Only the applicationDomain property - - of the LoaderContext object applies; the checkPolicyFile and securityDomain - - properties of the LoaderContext object do not apply. - - -

If the context parameter is not - - specified or refers to a null object, the content is loaded into the current security domain— a - - process referred to as "import loading" in Flash Player security documentation. Specifically, - - if the loading SWF file trusts the remote SWF by incorporating the remote SWF into its code, - - then the loading SWF can import it directly into its own security domain.

- - -

For more information related to security, see the Flash Player Developer Center Topic: - - Security.

- - -
-
-Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
asyncError:AsyncErrorEvent — Dispatched by the contentLoaderInfo object if the - - LoaderContext.requestedContentParent property has been specified and it is not possible to add the - - loaded content as a child to the specified DisplayObjectContainer. This could happen if the loaded content is a - - flash.display.AVM1Movie or if the addChild() call to the requestedContentParent throws - - an error.
 
complete:Event — Dispatched by the contentLoaderInfo object when the operation is - - complete. The complete event is always dispatched after the init event.
 
init:Event — Dispatched by the contentLoaderInfo object when the properties and methods - - of the loaded data are accessible. The init event always precedes the complete - - event.
 
ioError:IOErrorEvent — Dispatched by the contentLoaderInfo object when the runtime cannot parse - - the data in the byte array.
 
open:Event — Dispatched by the contentLoaderInfo object when the operation starts.
 
progress:ProgressEvent — Dispatched by the contentLoaderInfo object as data is transfered in memory.
 
securityError:SecurityErrorEvent — Dispatched by the contentLoaderInfo object if the - - LoaderContext.requestedContentParent property has been specified and the security sandbox - - of the LoaderContext.requestedContentParent does not have access to the loaded SWF.
 
unload:Event — Dispatched by the contentLoaderInfo object when a loaded object is removed.
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — If the length property of the ByteArray object is not - - greater than 0. - - - -
 
Error — If the checkPolicyFile or securityDomain - - property of the context parameter are non-null. - - -
 
Error — If the requestedContentParent property of the context parameter - - is a Loader. - - - -
 
Error — If the LoaderContext.parameters parameter is - - set to non-null and has some values which are not Strings. - - - -
 
Error — On iOS, if the application attempts to load - - a SWF file in an application domain other than the main application domain. - - -
 
Error — On iOS, if the application attempts to reload - - a SWF that has been loaded and unloaded and that contains ABC code. - - -
 
Error — On iOS, if the application attempts to load a SWF file from - - outside the application package that contains ActionScript code. This error - - can't be caught. It appears as a dialog box on the app screen with the - - message "Uncompiled ActionScript." Prior to AIR 3.6, this error occurs when - - you attempt to load any SWF file containing ActionScript, whether it is - - external or included in the application package. - -
 
SecurityError — If the provided applicationDomain property of the - - context property is from a disallowed domain. - - - -
 
SecurityError — You cannot connect to commonly reserved ports. - - For a complete list of blocked ports, see "Restricting Networking APIs" in the - - ActionScript 3.0 Developer's Guide. - - -
-

-See also -

-
-flash.utils.ByteArray -
-flash.system.LoaderContext.applicationDomain -
-
- - - - - -
loadFilePromise()method 
-
-public function loadFilePromise(promise:IFilePromise, context:LoaderContext = null):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Loads an IFilePromise instance. - - - -

The loadFilePromise method takes an IFilePromise object and - - loads the binary data. If the data is a progressive stream, such as a video wait for the "init" - - or progress events before accessing the properties of the loaded object. Otherwise, wait for - - the complete event to make sure that the data is fully loaded.

- - - -

When you use this method, consider the Flash Player security model, - - which is described in the Loader class description.

- - - - Parameters - - - - - - - - - - -
promise:IFilePromise — An IFilePromise object. The data source of the object can be - - any of the file formats supported by the Loader class: SWF, GIF, JPEG, or PNG. - - - -
 
context:LoaderContext (default = null) — A LoaderContext object. Only the applicationDomain property - - of the LoaderContext object applies; the checkPolicyFile and securityDomain - - properties of the LoaderContext object do not apply. - - -

If the context parameter is not - - specified or refers to a null object, the content is loaded into the current security domain— a - - process referred to as "import loading" in Flash Player security documentation. Specifically, - - if the loading SWF file trusts the remote SWF by incorporating the remote SWF into its code, - - then the loading SWF can import it directly into its own security domain.

- - -

For more information related to security, see the Flash Player Developer Center Topic: - - Security.

- - -
-
-Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
asyncError:AsyncErrorEvent — Dispatched by the contentLoaderInfo object if the - - LoaderContext.requestedContentParent property has been specified and it is not possible to add the - - loaded content as a child to the specified DisplayObjectContainer. This could happen if the loaded content is a - - flash.display.AVM1Movie or if the addChild() call to the requestedContentParent throws - - an error.
 
complete:Event — Dispatched by the contentLoaderInfo object when the operation is - - complete. The complete event is always dispatched after the init event.
 
init:Event — Dispatched by the contentLoaderInfo object when the properties and methods - - of the loaded data are accessible. The init event always precedes the complete - - event.
 
ioError:IOErrorEvent — Dispatched by the contentLoaderInfo object when the runtime cannot parse - - the data in the data source or if the data source stream is not readable.
 
open:Event — Dispatched by the contentLoaderInfo object when the operation starts.
 
progress:ProgressEvent — Dispatched by the contentLoaderInfo object as data is transfered in memory.
 
securityError:SecurityErrorEvent — Dispatched by the contentLoaderInfo object if the - - LoaderContext.requestedContentParent property has been specified and the security sandbox - - of the LoaderContext.requestedContentParent does not have access to the loaded SWF.
 
unload:Event — Dispatched by the contentLoaderInfo object when a loaded object is removed.
-
-Throws - - - - - - - - - - - - - - - - -
Error — If the requestedContentParent property of the context parameter - - is a Loader. - - - -
 
Error — If the LoaderContext.parameters parameter is - - set to non-null and has some values which are not Strings. - - - -
 
ArgumentError — If the IFilePromise object passed as parameter is null - - -
-

-See also -

-
-MediaPromise -
-CameraRoll.browseForImage() -
-CameraUI -
-
- - - - - -
unload()method 
-
-public function unload():void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Removes a child of this Loader object that was loaded by using the load() method. - - The property of the associated LoaderInfo object is reset to null. - - The child is not necessarily destroyed because other objects might have references to it; however, - - it is no longer a child of the Loader object. - - -

When you call the unload() method, the Loader object's - - contentLoaderInfo property is set to null. Any - - visual assets that were loaded with the SWF are unloaded and removed from - - memory. ActionScript class definitions in the loaded SWF remain in memory, - - and code in the same application domain as the loaded SWF can access - - instances of those classes and create new instances.

- - - -

Note (iOS only): Prior to AIR 3.6, this method has no effect on iOS.

- - - -

As a best practice, before you unload a child SWF file, you should explicitly - - close any streams in the child SWF file's objects, such as LocalConnection, NetConnection, - - NetStream, and Sound objects. Otherwise, audio in the child SWF file might continue to play, even - - though the child SWF file was unloaded. To close streams in the child SWF file, add an event listener - - to the child that listens for the unload event. When the parent calls - - Loader.unload(), the unload event is dispatched to the child. - - The following code shows how you might do this:

- -
-
-function closeAllStreams(evt:Event) { 
-
-    myNetStream.close();
-
-    mySound.close();
-
-    myNetConnection.close();
-
-    myLocalConnection.close();
-
-}
-
-
-
-myMovieClip.loaderInfo.addEventListener(Event.UNLOAD, closeAllStreams);
- - -

-See also -

-
-Loader.load() -
-flash.media.Sound.close() -
-flash.net.LocalConnection.close() -
-flash.net.NetConnection.close() -
-flash.net.NetStream.close() -
-delete operator -
-
- - - - - -
unloadAndStop()method 
-
-public function unloadAndStop(gc:Boolean = true):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Attempts to unload child SWF file contents and stops the execution of commands from loaded SWF files. - - This method attempts to unload SWF files - - that were loaded using Loader.load() or Loader.loadBytes() by removing references to EventDispatcher, - - NetConnection, Timer, Sound, or Video objects of the child SWF file. As a result, the following occurs for the child SWF file - - and the child SWF file's display list: - - - -

  • Sounds are stopped.
    • - -
  • Stage event listeners are removed.
    • - -
  • Event listeners for enterFrame, frameConstructed, exitFrame, - - activate and deactivate are removed.
    • - -
  • Timers are stopped.
    • - -
  • Camera and Microphone instances are detached
    • - -
  • Movie clips are stopped.
- - -

When you call the unloadAndStop() method, the Loader object's - - contentLoaderInfo property is set to null. Any - - visual assets that were loaded with the SWF are unloaded and removed from - - memory. ActionScript class definitions in the loaded SWF remain in memory, - - and code in the same application domain as the loaded SWF can access - - instances of those classes and create new instances.

- - - -

Note (iOS only): Prior to AIR 3.6, this method has no effect on iOS.

- - - - Parameters - - - - -
gc:Boolean (default = true) — Provides a hint to the garbage collector to run on the child SWF objects (true) or not (false). - - If you are unloading many objects asynchronously, setting the gc paramter to false might improve - - application performance. However, if the parameter is set to - - false, media and display objects of the child SWF file might persist in memory after running the - - unloadAndStop() command. - - - -
-

-See also -

-
-flash.display.DisplayObject -
-flash.display.Loader.load() -
-
- -
Examples
-
examples\LoaderExample
-
The following example uses the LoaderExample class to illustrate how various - event listeners are used. This task is accomplished by performing the following steps: -
    -
  1. A url property is created, which is the location and name of the image file
    2. -
  2. In the LoaderExample constructor, a new Loader object named loader is - created, which is then passed to the configureListeners() method, described in step 3.
    3. -
  3. The constructor creates a new instance of a URLRequest object, - request, with url passed so that the file name and location are known.
    4. -
  4. The request object is passed to the loader object's - load() method, which loads the image onto the display list.
    5. -
  5. A clickHandler event listener is registered for the click event on the loader. - After a mouse click, the loaded image is unloaded.
    6. -
  6. The configureListeners() method adds seven event listeners by using the following methods: -
      -
    • The completeHandler() method executes when the image finishes loading.
      • - -
    • The httpStatusHandler() 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.
      • - -
    • The initHandler() method executes before the completeHandler() - method and after the progressHandler() method. Generally, the init - event is more useful when loading SWF files.
      • - -
    • The ioErrorHandler() method executes if the image file is not available or not - accessible.
      • - -
    • The openHandler() method executes when the image file is first opened.
      • - -
    • The progressHandler() method executes when the image file starts to load and - again when the image is finished loading.
      • - -
    • The unLoadHandler() method executes when the image is unloaded by using the - unload() method when the user clicks the image.
      • - -
    -
    7. -
- -

Keep in mind the following requirements:

- -
    -
  • 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.
    • - -
  • 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 complete event - (and perhaps the ioError event) are sufficient when loading a local image.
    • - -
- -
-
-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();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Sat Jan 11 2025, 8:30 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/display/LoaderInfo.html b/html-docs/flash/display/LoaderInfo.html deleted file mode 100644 index a7b7b74..0000000 --- a/html-docs/flash/display/LoaderInfo.html +++ /dev/null @@ -1,2100 +0,0 @@ - - - - - - - - -flash.display.LoaderInfo (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class LoaderInfo
InheritanceLoaderInfo Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The LoaderInfo class provides information about a loaded SWF file or a loaded image file - (JPEG, GIF, or PNG). LoaderInfo objects are available for any display object. - The information provided includes load progress, the URLs of the loader and - loaded content, the number of bytes total for the media, and the nominal height and width of the - media. -

You can access LoaderInfo objects in two ways:

-
    -
  • The contentLoaderInfo property of a flash.display.Loader object— - The contentLoaderInfo property is always available for any Loader object. - For a Loader object that has not called the load() or loadBytes() - method, or that has not sufficiently loaded, attempting to access many of the properties of the - contentLoaderInfo property throws an error.
    • -
  • The loaderInfo property of a display object.
    • -
-

The contentLoaderInfo property of a Loader object provides information about - the content that the Loader object is loading, whereas the loaderInfo property of - a DisplayObject provides information about the root SWF file for that display object.

-

When you use a Loader object to load a display object (such as a SWF file or a bitmap), the - loaderInfo property of the display object is the same as the contentLoaderInfo - property of the Loader object (DisplayObject.loaderInfo = Loader.contentLoaderInfo). - Because the instance of the main class of the SWF file has - no Loader object, the loaderInfo property is the only way to - access the LoaderInfo for the instance of the main class of the SWF file.

-

The following diagram shows the different uses of the LoaderInfo object—for the instance of the main class of - the SWF file, for the contentLoaderInfo property of a Loader object, and for the loaderInfo - property of a loaded object:

- -

- An image of different LoaderInfo situations -

-

When a loading operation is not complete, some properties of the contentLoaderInfo - property of a Loader object are not available. You can obtain some properties, such as - bytesLoaded, bytesTotal, url, loaderURL, - and applicationDomain. When the loaderInfo object dispatches the - init event, you can access all properties of the loaderInfo object and - the loaded image or SWF file.

-

Note: All properties of LoaderInfo objects are read-only.

-

The EventDispatcher.dispatchEvent() method - - is not applicable to LoaderInfo objects. If you call dispatchEvent() - on a LoaderInfo object, an IllegalOperationError exception is thrown.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.Loader -
-flash.display.Loader.content -
-flash.display.DisplayObject -
-flash.display.DisplayObject.loaderInfo -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  actionScriptVersion : uint -
[read-only] - The ActionScript version of the loaded SWF file.
-		LoaderInfo
  applicationDomain : ApplicationDomain -
[read-only] - When an external SWF file is loaded, all ActionScript 3.0 definitions contained in the loaded - class are stored in the applicationDomain property.
-		LoaderInfo
  bytes : ByteArray -
[read-only] - The bytes associated with a LoaderInfo object.
-		LoaderInfo
  bytesLoaded : uint -
[read-only] - The number of bytes that are loaded for the media.
-		LoaderInfo
  bytesTotal : uint -
[read-only] - The number of compressed bytes in the entire media file.
-		LoaderInfo
  childAllowsParent : Boolean -
[read-only] - Expresses the trust relationship from content (child) to the Loader (parent).
-		LoaderInfo
  childSandboxBridge : Object -
- A object that can be set by the loaded content's code to expose properties and methods that can be accessed - by code in the Loader object's sandbox.
-		LoaderInfo
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  content : DisplayObject -
[read-only] - The loaded object associated with this LoaderInfo object.
-		LoaderInfo
  contentType : String -
[read-only] - The MIME type of the loaded file.
-		LoaderInfo
  frameRate : Number -
[read-only] - The nominal frame rate, in frames per second, of the loaded SWF file.
-		LoaderInfo
  height : int -
[read-only] - The nominal height of the loaded file.
-		LoaderInfo
  isURLInaccessible : Boolean -
[read-only] - Indicates if the LoaderInfo.url property has been - truncated.
-		LoaderInfo
  loader : Loader -
[read-only] - The Loader object associated with this LoaderInfo object.
-		LoaderInfo
  loaderURL : String -
[read-only] - The URL of the SWF file that initiated the loading of the media - described by this LoaderInfo object.
-		LoaderInfo
  parameters : Object -
[read-only] - An object that contains name-value pairs that represent the parameters provided - to the loaded SWF file.
-		LoaderInfo
  parentAllowsChild : Boolean -
[read-only] - Expresses the trust relationship from Loader (parent) to the content (child).
-		LoaderInfo
  parentSandboxBridge : Object -
- A object that can be set by code in the Loader object's sandbox to expose properties and methods that can be accessed - by the loaded content's code.
-		LoaderInfo
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  sameDomain : Boolean -
[read-only] - Expresses the domain relationship between the loader and the content: true if they have - the same origin domain; false otherwise.
-		LoaderInfo
  sharedEvents : EventDispatcher -
[read-only] - An EventDispatcher instance that can be used to exchange events across security boundaries.
-		LoaderInfo
  swfVersion : uint -
[read-only] - The file format version of the loaded SWF file.
-		LoaderInfo
  uncaughtErrorEvents : UncaughtErrorEvents -
[read-only] - An object that dispatches an uncaughtError event when an unhandled error - occurs in code in this LoaderInfo object's SWF file.
-		LoaderInfo
  url : String -
[read-only] - The URL of the media being loaded.
-		LoaderInfo
  width : int -
[read-only] - The nominal width of the loaded content.
-		LoaderInfo
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-getLoaderInfoByDefinition(object:Object):LoaderInfo -
-
[static] - Returns the LoaderInfo object associated with a SWF file defined as an object.
-		LoaderInfo
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-complete -
-		 - Dispatched when data has loaded successfully.LoaderInfo
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-httpStatus -
-		 - Dispatched when a network request is made over HTTP and an HTTP status code can be detected.LoaderInfo
   -
-init -
-		 - Dispatched when the properties and methods of a loaded SWF file are - accessible and ready for use.LoaderInfo
   -
-ioError -
-		 - Dispatched when an input or output error occurs that causes a load operation to fail.LoaderInfo
   -
-open -
-		 - Dispatched when a load operation starts.LoaderInfo
   -
-progress -
-		 - Dispatched when data is received as the download operation progresses.LoaderInfo
   -
-unload -
-		 - Dispatched by a LoaderInfo object whenever a loaded object is removed by using the unload() - method of the Loader object, or when a second load is performed by the same Loader object and the - original content is removed prior to the load beginning.LoaderInfo
-
- -
- -
Property detail
- - - - - -
actionScriptVersionproperty
-
-actionScriptVersion:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The ActionScript version of the loaded SWF file. - The language version is specified by using the enumerations in the - ActionScriptVersion class, such as ActionScriptVersion.ACTIONSCRIPT2 - and ActionScriptVersion.ACTIONSCRIPT3. -

Note: This property always has a value of either ActionScriptVersion.ACTIONSCRIPT2 or - ActionScriptVersion.ACTIONSCRIPT3. ActionScript 1.0 and 2.0 are - both reported as ActionScriptVersion.ACTIONSCRIPT2 (version 2.0). This property - only distinguishes ActionScript 1.0 and 2.0 from ActionScript 3.0.

- Implementation -
-    public function get actionScriptVersion():uint -
-
-Throws -
- - - - - - - - - - -
Error — If the file is not downloaded sufficiently to retrieve the requested information. - -
 
Error — If the file is not a SWF file. - -
-

-See also -

-
-flash.display.ActionScriptVersion -
-
- - - - - -
applicationDomainproperty 
-
-applicationDomain:ApplicationDomain  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- When an external SWF file is loaded, all ActionScript 3.0 definitions contained in the loaded - class are stored in the applicationDomain property. - -

All code in a SWF file is defined to exist in an application domain. The current application - domain is where your main application runs. The system domain contains all application domains, - including the current domain and all classes used by Flash Player or Adobe AIR.

-

All application domains, except the system domain, have an associated parent domain. - The parent domain of your main application's applicationDomain is the system domain. - Loaded classes are defined only when their parent doesn't already define them. - You cannot override a loaded class definition with a newer definition.

-

For usage examples of application domains, see the "Client System Environment" chapter - in the ActionScript 3.0 Developer's Guide.

- Implementation -
-    public function get applicationDomain():ApplicationDomain -
-
-Throws -
- - - - -
SecurityError — This security sandbox of the caller is not allowed to access this ApplicationDomain. - -
-

-See also -

-
-flash.system.ApplicationDomain -
-
- - - - - -
bytesproperty 
-
-bytes:ByteArray  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The bytes associated with a LoaderInfo object. - -

Implementation -
-    public function get bytes():ByteArray -
-
-Throws -
- - - - -
SecurityError — If the object accessing this API is prevented from - accessing the loaded object due to security restrictions. This situation can occur, - for instance, when a Loader object attempts to access the contentLoaderInfo.content - property and it is not granted security permission to access the loaded content. - -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- -
-
- - - - - -
bytesLoadedproperty 
-
-bytesLoaded:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The number of bytes that are loaded for the media. When this number equals - the value of bytesTotal, all of the bytes are loaded. - -

Implementation -
-    public function get bytesLoaded():uint -
-
- - - - - -
bytesTotalproperty 
-
-bytesTotal:uint  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of compressed bytes in the entire media file. -

Before the first progress event is dispatched by - this LoaderInfo object's corresponding Loader object, bytesTotal is 0. - After the first progress event from the Loader object, bytesTotal - reflects the actual number of bytes to be downloaded.

- -

Note (iOS only): When running an application on iOS, the value returned is not the same as on other platforms. -

- Implementation -
-    public function get bytesTotal():uint -
-

-See also -

-
-flash.events.ProgressEvent -
-flash.display.Loader -
-
- - - - - -
childAllowsParentproperty 
-
-childAllowsParent:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Expresses the trust relationship from content (child) to the Loader (parent). - If the child has allowed the parent access, true; otherwise, - false. This property is set to true if the child object - has called the allowDomain() method to grant permission to the parent domain - or if a URL policy is loaded at the child domain that grants permission - to the parent domain. If child and parent are in - the same domain, this property is set to true. - -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- - Implementation -
-    public function get childAllowsParent():Boolean -
-
-Throws -
- - - - -
Error — Thrown if the file is not downloaded sufficiently - to retrieve the requested information. -
-
- - - - - -
childSandboxBridgeproperty 
-
-childSandboxBridge:Object  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- A object that can be set by the loaded content's code to expose properties and methods that can be accessed - by code in the Loader object's sandbox. This sandbox bridge lets content from a non-application domain have - controlled access to scripts in the application sandbox, and vice versa. The sandbox bridge serves as a gateway between - the sandboxes, providing explicit interaction between application and non-application security sandboxes. - -

Implementation -
-    public function get childSandboxBridge():Object -
-    public function set childSandboxBridge(value:Object):void -
-
-Throws -
- - - - -
SecurityError — Only content in the loaded content's sandbox can set this property. - -
-

-See also -

-
-parentSandboxBridge -
-
- - - - - -
contentproperty 
-
-content:DisplayObject  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The loaded object associated with this LoaderInfo object. - -

Implementation -
-    public function get content():DisplayObject -
-
-Throws -
- - - - -
SecurityError — If the object accessing this API is prevented from - accessing the loaded object due to security restrictions. This situation can occur, - for instance, when a Loader object attempts to access the contentLoaderInfo.content - property and it is not granted security permission to access the loaded content. - -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- -
-
- - - - - -
contentTypeproperty 
-
-contentType:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The MIME type of the loaded file. The value is null if not enough of the file has loaded - in order to determine the type. The following list gives the possible values: - -

    - -
  • "application/x-shockwave-flash"
    • - -
  • "image/jpeg"
    • - -
  • "image/gif"
    • - -
  • "image/png"
    • - -
-

Implementation -
-    public function get contentType():String -
-
- - - - - -
frameRateproperty 
-
-frameRate:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The nominal frame rate, in frames per second, of the loaded SWF file. This - number is often an integer, but need not be. -

This value may differ from the actual frame rate in use. - Flash Player or Adobe AIR only uses a single frame rate for all loaded SWF files at - any one time, and this frame rate is determined by the nominal - frame rate of the main SWF file. Also, the main frame rate may not be able to be achieved, depending on hardware, sound synchronization, - and other factors.

- - Implementation -
-    public function get frameRate():Number -
-
-Throws -
- - - - - - - - - - -
Error — If the file is not downloaded sufficiently to retrieve the requested information. - -
 
Error — If the file is not a SWF file. -
-
- - - - - -
heightproperty 
-
-height:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The nominal height of the loaded file. This value might differ from the actual - height at which the content is displayed, since the loaded content or its parent - display objects might be scaled. - -

Implementation -
-    public function get height():int -
-
-Throws -
- - - - -
Error — If the file is not downloaded sufficiently to retrieve the requested information. -
-
- - - - - -
isURLInaccessibleproperty 
-
-isURLInaccessible:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates if the LoaderInfo.url property has been - truncated. When the isURLInaccessible value is true the - LoaderInfo.url value is only the domain of the final URL from which the content loaded. - For example, the property is truncated if the content is loaded from http://www.adobe.com/assets/hello.swf, - and the LoaderInfo.url property has the value http://www.adobe.com. The isURLInaccessible - value is true only when all of the following are also true: -

    -
  • An HTTP redirect occurred while loading the content.
    • -
  • The SWF file calling Loader.load() is from a different domain than - the content's final URL.
    • -
  • The SWF file calling Loader.load() does not have permission to access - the content. Permission is granted to access the content the same way permission is granted for - BitmapData.draw(): - call Security.allowDomain() to access a SWF file - (or for non-SWF file content, establish a policy file and use the LoaderContext.checkPolicyFile - property).
    • -
-

Note: The isURLInaccessible property was added for Flash Player 10.1 and AIR 2.0. - However, this property is made available to SWF files of all versions when the - Flash runtime supports it. So, using some authoring tools in "strict mode" causes a compilation error. To work around the error - use the indirect syntax myLoaderInfo["isURLInaccessible"], or disable strict mode. If you are using Flash Professional CS5 - or Flex SDK 4.1, you can use and compile this API for runtimes released before Flash Player 10.1 and AIR 2.

-

For application content in AIR, the value of this property is always false.

- Implementation -
-    public function get isURLInaccessible():Boolean -
-

-See also -

-
-url -
-BitmapData.draw() -
-flash.system.Security.allowDomain() -
-flash.system.LoaderContext.checkPolicyFile -
-
- - - - - -
loaderproperty 
-
-loader:Loader  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Loader object associated with this LoaderInfo object. If this LoaderInfo object - is the loaderInfo property of the instance of the main class of the SWF file, no - Loader object is associated. - -

Implementation -
-    public function get loader():Loader -
-
-Throws -
- - - - -
SecurityError — If the object accessing this API is prevented from - accessing the Loader object because of security restrictions. This can occur, - for instance, when a loaded SWF file attempts to access its loaderInfo.loader - property and it is not granted security permission to access the loading SWF file. - -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- -
-
- - - - - -
loaderURLproperty 
-
-loaderURL:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The URL of the SWF file that initiated the loading of the media - described by this LoaderInfo object. For the instance of the main class of the SWF file, this - URL is the same as the SWF file's own URL. -

Implementation -
-    public function get loaderURL():String -
-
- - - - - -
parametersproperty 
-
-parameters:Object  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An object that contains name-value pairs that represent the parameters provided - to the loaded SWF file. -

You can use a for-in loop to extract all the names and values - from the parameters object.

-

The two sources of parameters are: the query string in the - URL of the main SWF file, and the value of the FlashVars HTML parameter (this affects - only the main SWF file).

-

The parameters property replaces the ActionScript 1.0 and 2.0 technique of - providing SWF file parameters as properties of the main timeline.

-

The value of the parameters property is null for Loader objects - that contain SWF files that use ActionScript 1.0 or 2.0. It is only - non-null for Loader objects that contain SWF files that use ActionScript 3.0.

- - Implementation -
-    public function get parameters():Object -
-
- - - - - -
parentAllowsChildproperty 
-
-parentAllowsChild:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Expresses the trust relationship from Loader (parent) to the content (child). - If the parent has allowed the child access, true; otherwise, - false. This property is set to true if the parent object - called the allowDomain() method to grant permission to the child domain - or if a URL policy file is loaded at the parent domain granting permission - to the child domain. If child and parent are in - the same domain, this property is set to true. - -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- - Implementation -
-    public function get parentAllowsChild():Boolean -
-
-Throws -
- - - - -
Error — Thrown if the file is not downloaded sufficiently - to retrieve the requested information. -
-
- - - - - -
parentSandboxBridgeproperty 
-
-parentSandboxBridge:Object  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- A object that can be set by code in the Loader object's sandbox to expose properties and methods that can be accessed - by the loaded content's code. This sandbox bridge lets content from a non-application domain have controlled - access to scripts in the application sandbox, and vice versa. The sandbox bridge serves as a gateway between - the sandboxes, providing explicit interaction between application and non-application security sandboxes. - -

Implementation -
-    public function get parentSandboxBridge():Object -
-    public function set parentSandboxBridge(value:Object):void -
-
-Throws -
- - - - -
SecurityError — Only content in the Loader object's sandbox can set this property. - -
-

-See also -

-
-childSandboxBridge -
-
- - - - - -
sameDomainproperty 
-
-sameDomain:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Expresses the domain relationship between the loader and the content: true if they have - the same origin domain; false otherwise. - -

Implementation -
-    public function get sameDomain():Boolean -
-
-Throws -
- - - - -
Error — Thrown if the file is not downloaded sufficiently - to retrieve the requested information. -
-
- - - - - -
sharedEventsproperty 
-
-sharedEvents:EventDispatcher  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An EventDispatcher instance that can be used to exchange events across security boundaries. - Even when the Loader object and the loaded content originate from security domains that do not trust - one another, both can access sharedEvents and send and receive events via this object. -

Implementation -
-    public function get sharedEvents():EventDispatcher -
-
- - - - - -
swfVersionproperty 
-
-swfVersion:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The file format version of the loaded SWF file. - The file format is specified using the enumerations in the - SWFVersion class, such as SWFVersion.FLASH7 and SWFVersion.FLASH9. -

Implementation -
-    public function get swfVersion():uint -
-
-Throws -
- - - - - - - - - - -
Error — If the file is not downloaded sufficiently to retrieve the requested information. - -
 
Error — If the file is not a SWF file. - -
-

-See also -

-
-flash.display.SWFVersion -
-
- - - - - -
uncaughtErrorEventsproperty 
-
-uncaughtErrorEvents:UncaughtErrorEvents  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- An object that dispatches an uncaughtError event when an unhandled error - occurs in code in this LoaderInfo object's SWF file. An uncaught error happens when - an error is thrown outside of any try..catch blocks or when an ErrorEvent - object is dispatched with no registered listeners. -

For example, if in a try block, there is an event dispatcher that calls its event handler, - the catch block doesn't catch the error if thrown in event handler. Any error thrown thereafter - can be caught by listening to LoaderInfo.uncaughtErrorEvents

-

This property is created when the SWF associated with this LoaderInfo has finished - loading. Until then the uncaughtErrorEvents property is null. - In an ActionScript-only project, you can access this property during or after the execution - of the constructor function of the main class of the SWF file. For a Flex project, - the uncaughtErrorEvents property is available after the - applicationComplete event is dispatched.

- - Implementation -
-    public function get uncaughtErrorEvents():UncaughtErrorEvents -
-

-See also -

-
-UncaughtErrorEvent -
-Loader.uncaughtErrorEvents -
-
-Example -
The following example demonstrates the use of an uncaught error event - handler to detect uncaught errors in an ActionScript project. The example defines - an uncaughtError event handler to detect uncaught errors. It also - provides a button that, when clicked, throws an error that is caught by the - uncaught error handler. - -

In the constructor, the code registers a listener for the uncaughtError - event dispatched by the LoaderInfo object's uncaughtErrorEvents property.

- -

In the uncaughtErrorHandler() method, the code checks the data type of - the error property and responds accordingly.

-
-
-package
-{
-    import flash.display.Sprite;
-    import flash.events.ErrorEvent;
-	import flash.events.MouseEvent;
-	import flash.events.UncaughtErrorEvent;
-
-    public class UncaughtErrorEventExample extends Sprite
-    {
-        public function UncaughtErrorEventExample()
-        {
-            loaderInfo.uncaughtErrorEvents.addEventListener(UncaughtErrorEvent.UNCAUGHT_ERROR, uncaughtErrorHandler);
-			
-			drawUI();
-        }
-		
-        private function uncaughtErrorHandler(event:UncaughtErrorEvent):void
-        {
-            if (event.error is Error)
-            {
-                var error:Error = event.error as Error;
-				// do something with the error
-            }
-            else if (event.error is ErrorEvent)
-            {
-                var errorEvent:ErrorEvent = event.error as ErrorEvent;
-				// do something with the error
-            }
-            else
-            {
-                // a non-Error, non-ErrorEvent type was thrown and uncaught
-            }
-        }
-		
-		private function drawUI():void
-		{
-			var btn:Sprite = new Sprite();
-			btn.graphics.clear();
-			btn.graphics.beginFill(0xFFCC00);
-			btn.graphics.drawRect(0, 0, 100, 50);
-			btn.graphics.endFill();
-			addChild(btn);
-			btn.addEventListener(MouseEvent.CLICK, clickHandler);
-		}
-		
-		private function clickHandler(event:MouseEvent):void
-		{
-			throw new Error("Gak!");
-		}
-    }
-}
-
-
-
-
-

The following example is the Flex equivalent of the previous example, - using an MXML document instead of an ActionScript class as the root content. -
-
-<?xml version="1.0" encoding="utf-8"?>
-<s:WindowedApplication xmlns:fx="http://ns.adobe.com/mxml/2009" 
-    				   xmlns:s="library://ns.adobe.com/flex/spark" 
-					   xmlns:mx="library://ns.adobe.com/flex/halo"
-                       applicationComplete="applicationCompleteHandler();">
-    
-    <fx:Script>
-        <![CDATA[
-		    import flash.events.ErrorEvent;
-			import flash.events.MouseEvent;
-		    import flash.events.UncaughtErrorEvent;
-            
-			private function applicationCompleteHandler():void
-            {
-                loaderInfo.uncaughtErrorEvents.addEventListener(UncaughtErrorEvent.UNCAUGHT_ERROR, uncaughtErrorHandler);
-            }
-    
-            private function uncaughtErrorHandler(event:UncaughtErrorEvent):void
-            {
-                if (event.error is Error)
-                {
-                    var error:Error = event.error as Error;
-                    // do something with the error
-                }
-                else if (event.error is ErrorEvent)
-                {
-                    var errorEvent:ErrorEvent = event.error as ErrorEvent;
-                    // do something with the error
-                }
-                else
-                {
-                    // a non-Error, non-ErrorEvent type was thrown and uncaught
-                }
-            }
-            
-            private function clickHandler(event:MouseEvent):void
-            {
-                throw new Error("Gak!");
-            }
-        ]]>
-    </fx:Script>
-      
-    <s:Button label="Cause Error" click="clickHandler(event);"/>
-</s:WindowedApplication>
-
-

-
- - - - - -
urlproperty 
-
-url:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The URL of the media being loaded. -

Before the first progress event is dispatched by this LoaderInfo - object's corresponding Loader object, the value of the url property - might reflect only the initial URL specified in the call to the load() - method of the Loader object. After the first progress event, the - url property reflects the media's final URL, after any redirects and relative - URLs are resolved.

-

In some cases, the value of the url property is truncated; see the - isURLInaccessible property for details.

- Implementation -
-    public function get url():String -
-

-See also -

-
-isURLInaccessible -
-flash.display.Loader.load() -
-
- - - - - -
widthproperty 
-
-width:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The nominal width of the loaded content. This value might differ from the actual - width at which the content is displayed, since the loaded content or its parent - display objects might be scaled. - -

Implementation -
-    public function get width():int -
-
-Throws -
- - - - -
Error — If the file is not downloaded sufficiently to retrieve the requested information. -
-
- -
Method detail
- - - - - -
getLoaderInfoByDefinition()method
-
-public static function getLoaderInfoByDefinition(object:Object):LoaderInfo -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the LoaderInfo object associated with a SWF file defined as an object. -

Parameters - - - - -
object:Object — The object for which you want to get an associated LoaderInfo object. -
-

-Returns - - - - -
LoaderInfo — - The associated LoaderInfo object. Returns null when called - in non-debugger builds (or when debugging is not enabled) or if the referenced object - does not have an associated LoaderInfo object (such as some objects used by the AIR runtime). - - -
-
-Throws - - - - -
SecurityError — The caller is not running in the local trusted sandbox. -
-
-
Event detail
- - - - - -
completeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when data has loaded successfully. In other words, it is dispatched when all the content - has been downloaded and the loading has finished. The complete event is always dispatched - after the init event. The init event is dispatched when the object - is ready to access, though the content may still be downloading. -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -

-See also -

-
-Loader.load() -
-
- - - - - -
httpStatusevent  
-
-Event object type: flash.events.HTTPStatusEvent -
-HTTPStatusEvent.type property = flash.events.HTTPStatusEvent.HTTP_STATUS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when a network request is made over HTTP and an HTTP status code can be detected. -

- The HTTPStatusEvent.HTTP_STATUS constant defines the value of the - type property of a httpStatus event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
statusThe HTTP status code returned by the server.
targetThe network object receiving an HTTP status code.
- -

-See also -

-
-Loader.load() -
-
- - - - - -
initevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.INIT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when the properties and methods of a loaded SWF file are - accessible and ready for use. The content, however, can still be downloading. A LoaderInfo object - dispatches the init event when the following conditions exist: -

    -
  • All properties and methods associated with the loaded object and those associated - with the LoaderInfo object are accessible.
    • -
  • The constructors for all child objects have completed.
    • -
  • All ActionScript code in the first frame of the loaded SWF's main timeline has been executed.
    • -
-

For example, an Event.INIT is dispatched when the first frame of a movie or animation is loaded. - The movie is then accessible and can be added to the display list. The complete movie, however, can - take longer to download. The Event.COMPLETE is only dispatched once the full movie is loaded.

-

The init event always precedes the complete event.

-

- The Event.INIT constant defines the value of the type property of an init event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe LoaderInfo object associated with the SWF file being loaded.
- -

-See also -

-
-Loader.load() -
-
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when an input or output error occurs that causes a load operation to fail. -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -

-See also -

-
-Loader.load() -
-
- - - - - -
openevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.OPEN -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a load operation starts. -

- The Event.OPEN constant defines the value of the type property of an open event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has opened a connection.
- -

-See also -

-
-Loader.load() -
-
- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when data is received as the download operation progresses. -

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -

-See also -

-
-Loader.load() -
-
- - - - - -
unloadevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.UNLOAD -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched by a LoaderInfo object whenever a loaded object is removed by using the unload() - method of the Loader object, or when a second load is performed by the same Loader object and the - original content is removed prior to the load beginning. -

- The Event.UNLOAD constant defines the value of the type property of an unload event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe LoaderInfo object associated with the SWF file being unloaded or replaced.
- -

-See also -

-
-Loader.load() -
-Loader.unload() -
-
- -
Examples
-
examples\LoaderInfoExample
-
The following example uses the LoaderInfoExample class to display an image on - the stage. This is accomplished by performing the following steps: -
    -
  1. A property url is created, which is the location and name of the image.
    2. - -
  2. The class constructor creates a Loader object named loader.
    3. - -
  3. The loader object instantiates an event listener to ensure that the image loads properly.
    4. - -
  4. The constructor creates a new instance of a URLRequest object, request, - with url passed so that the file name and location are known.
    5. - -
  5. The request object is then passed to the load() method of the - loader object, which loads the image onto the display list.
    6. - -
- -

Important: This example requires that you add 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.

-
-
-package {
-    import flash.display.Loader;
-    import flash.display.LoaderInfo;
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.URLRequest;
-
-    public class LoaderInfoExample extends Sprite {
-        private var url:String = "Image.gif";
-
-        public function LoaderInfoExample() {
-            var loader:Loader = new Loader();
-            loader.contentLoaderInfo.addEventListener(Event.INIT, initHandler);
-            loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            var request:URLRequest = new URLRequest(url);
-            loader.load(request);
-            addChild(loader);
-        }
-
-        private function initHandler(event:Event):void {
-            var loader:Loader = Loader(event.target.loader);
-            var info:LoaderInfo = LoaderInfo(loader.contentLoaderInfo);
-            trace("initHandler: loaderURL=" + info.loaderURL + " url=" + info.url);
-        }
-
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("ioErrorHandler: " + event);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/MorphShape.html b/html-docs/flash/display/MorphShape.html deleted file mode 100644 index e784cdd..0000000 --- a/html-docs/flash/display/MorphShape.html +++ /dev/null @@ -1,641 +0,0 @@ - - - - - - - - -flash.display.MorphShape (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class MorphShape
InheritanceMorphShape Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The MorphShape class represents MorphShape objects on the display list. - You cannot create MorphShape objects directly in ActionScript; they are created when you create a shape tween - in the Flash authoring tool. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
-
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/MovieClip.html b/html-docs/flash/display/MovieClip.html deleted file mode 100644 index 8a0aea1..0000000 --- a/html-docs/flash/display/MovieClip.html +++ /dev/null @@ -1,2660 +0,0 @@ - - - - - - - - -flash.display.MovieClip (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic dynamic class MovieClip
InheritanceMovieClip Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The MovieClip class inherits from the following classes: Sprite, DisplayObjectContainer, - InteractiveObject, DisplayObject, and EventDispatcher. - -

Unlike the Sprite object, a MovieClip object has a timeline.

-

>In Flash Professional, the methods for the MovieClip class provide the same functionality - as actions that target movie clips. Some additional methods do not have equivalent - actions in the Actions toolbox in the Actions panel in the Flash authoring tool.

- -

Children instances placed on the Stage in Flash Professional cannot be accessed by code from within the - constructor of a parent instance since they have not been created at that point in code execution. - Before accessing the child, the parent must instead either create the child instance - by code or delay access to a callback function that listens for the child to dispatch - its Event.ADDED_TO_STAGE event.

- -

If you modify any of the following properties of a MovieClip object that contains a motion tween, - the playhead is stopped in that MovieClip object: alpha, blendMode, - filters, height, opaqueBackground, rotation, - scaleX, scaleY, scale9Grid, scrollRect, - transform, visible, width, x, - or y. However, it does not stop the playhead in any child MovieClip objects of that - MovieClip object.

-

Note:Flash Lite 4 supports the MovieClip.opaqueBackground property only if - FEATURE_BITMAPCACHE is defined. The default configuration of Flash Lite 4 does not define - FEATURE_BITMAPCACHE. To enable the MovieClip.opaqueBackground property for a suitable device, - define FEATURE_BITMAPCACHE in your project.

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityImplementation : AccessibilityImplementation -
- The current accessibility implementation (AccessibilityImplementation) - for this InteractiveObject instance.
-		InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedbuttonMode : Boolean -
- Specifies the button mode of this sprite.
-		Sprite
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcontextMenu : NativeMenu -
- Specifies the context menu associated with this object.
-		InteractiveObject
  currentFrame : int -
[read-only] - Specifies the number of the frame in which the playhead is located in the timeline of - the MovieClip instance.
-		MovieClip
  currentFrameLabel : String -
[read-only] - The label at the current frame in the timeline of the MovieClip instance.
-		MovieClip
  currentLabel : String -
[read-only] - The current label in which the playhead is located in the timeline of the MovieClip instance.
-		MovieClip
  currentLabels : Array -
[read-only] - Returns an array of FrameLabel objects from the current scene.
-		MovieClip
  currentScene : Scene -
[read-only] - The current scene in which the playhead is located in the timeline of the MovieClip instance.
-		MovieClip
 InheriteddoubleClickEnabled : Boolean -
- Specifies whether the object receives doubleClick events.
-		InteractiveObject
 InheriteddropTarget : DisplayObject -
- Specifies the display object over which the sprite is being dragged, or on - which the sprite was dropped.
-		Sprite
  enabled : Boolean -
- A Boolean value that indicates whether a movie clip is enabled.
-		MovieClip
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 InheritedfocusRect : Object -
- Specifies whether this object displays a focus rectangle.
-		InteractiveObject
  framesLoaded : int -
[read-only] - The number of frames that are loaded from a streaming SWF file.
-		MovieClip
 Inheritedgraphics : Graphics -
- Specifies the Graphics object that belongs to this sprite where vector - drawing commands can occur.
-		Sprite
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedhitArea : Sprite -
- Designates another sprite to serve as the hit area for a sprite.
-		Sprite
  isPlaying : Boolean -
[read-only] - A Boolean value that indicates whether a movie clip is curently playing.
-		MovieClip
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseChildren : Boolean -
- Determines whether or not the children of the object are mouse, or user input device, enabled.
-		DisplayObjectContainer
 InheritedmouseEnabled : Boolean -
- Specifies whether this object receives mouse, or other user input, messages.
-		InteractiveObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedneedsSoftKeyboard : Boolean -
- Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - when this InteractiveObject instance receives focus.
-		InteractiveObject
 InheritednumChildren : int -
- Returns the number of children of this object.
-		DisplayObjectContainer
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
  scenes : Array -
[read-only] - An array of Scene objects, each listing the name, the number of frames, - and the frame labels for a scene in the MovieClip instance.
-		MovieClip
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
 InheritedsoftKeyboard : String -
- Controls the appearance of the soft keyboard.
-		InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle -
- Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
-		InteractiveObject
 InheritedsoundTransform : SoundTransform -
- Controls sound within this sprite.
-		Sprite
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
 InheritedtabChildren : Boolean -
- Determines whether the children of the object are tab enabled.
-		DisplayObjectContainer
 InheritedtabEnabled : Boolean -
- Specifies whether this object is in the tab order.
-		InteractiveObject
 InheritedtabIndex : int -
- Specifies the tab ordering of objects in a SWF file.
-		InteractiveObject
 InheritedtextSnapshot : TextSnapshot -
- Returns a TextSnapshot object for this DisplayObjectContainer instance.
-		DisplayObjectContainer
  totalFrames : int -
[read-only] - The total number of frames in the MovieClip instance.
-		MovieClip
  trackAsMenu : Boolean -
- Indicates whether other display objects that are SimpleButton or MovieClip objects can receive - mouse release events or other user input release events.
-		MovieClip
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
 InheriteduseHandCursor : Boolean -
- A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls - over a sprite in which the buttonMode property is set to true.
-		Sprite
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-MovieClip()
-
- Creates a new MovieClip instance.
-		MovieClip
 Inherited -
-addChild(child:DisplayObject):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-addChildAt(child:DisplayObject, index:int):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer - instance.
-		DisplayObjectContainer
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-areInaccessibleObjectsUnderPoint(point:Point):Boolean -
-
- Indicates whether the security restrictions - would cause any display objects to be omitted from the list returned by calling - the DisplayObjectContainer.getObjectsUnderPoint() method - with the specified point point.
-		DisplayObjectContainer
 Inherited -
-contains(child:DisplayObject):Boolean -
-
- Determines whether the specified display object is a child of the DisplayObjectContainer instance or - the instance itself.
-		DisplayObjectContainer
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getChildAt(index:int):DisplayObject -
-
- Returns the child display object instance that exists at the specified index.
-		DisplayObjectContainer
 Inherited -
-getChildByName(name:String):DisplayObject -
-
- Returns the child display object that exists with the specified name.
-		DisplayObjectContainer
 Inherited -
-getChildIndex(child:DisplayObject):int -
-
- Returns the index position of a child DisplayObject instance.
-		DisplayObjectContainer
 Inherited -
-getObjectsUnderPoint(point:Point):Array -
-
- Returns an array of objects that lie under the specified point and are children - (or grandchildren, and so on) of this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
   -
-gotoAndPlay(frame:Object, scene:String = null):void -
-
- Starts playing the SWF file at the specified frame.
-		MovieClip
   -
-gotoAndStop(frame:Object, scene:String = null):void -
-
- Brings the playhead to the specified frame of the movie clip and stops it there.
-		MovieClip
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
   -
-nextFrame():void -
-
- Sends the playhead to the next frame and stops it.
-		MovieClip
   -
-nextScene():void -
-
- Moves the playhead to the next scene of the MovieClip instance.
-		MovieClip
   -
-play():void -
-
- Moves the playhead in the timeline of the movie clip.
-		MovieClip
   -
-prevFrame():void -
-
- Sends the playhead to the previous frame and stops it.
-		MovieClip
   -
-prevScene():void -
-
- Moves the playhead to the previous scene of the MovieClip instance.
-		MovieClip
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeChild(child:DisplayObject):DisplayObject -
-
- Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeChildAt(index:int):DisplayObject -
-
- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer.
-		DisplayObjectContainer
 Inherited -
-removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void -
-
- Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-requestSoftKeyboard():Boolean -
-
- Raises a virtual keyboard.
-		InteractiveObject
 Inherited -
-setChildIndex(child:DisplayObject, index:int):void -
-
- Changes the position of an existing child in the display object container.
-		DisplayObjectContainer
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void -
-
- Lets the user drag the specified sprite.
-		Sprite
 Inherited -
-startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void -
-
- Lets the user drag the specified sprite on a touch-enabled device.
-		Sprite
   -
-stop():void -
-
- Stops the playhead in the movie clip.
-		MovieClip
 Inherited -
-stopAllMovieClips():void -
-
- Recursively stops the timeline execution of all MovieClips rooted at this object.
-		DisplayObjectContainer
 Inherited -
-stopDrag():void -
-
- Ends the startDrag() method.
-		Sprite
 Inherited -
-stopTouchDrag(touchPointID:int):void -
-
- Ends the startTouchDrag() method, for use with touch-enabled devices.
-		Sprite
 Inherited -
-swapChildren(child1:DisplayObject, child2:DisplayObject):void -
-
- Swaps the z-order (front-to-back order) of the two specified child objects.
-		DisplayObjectContainer
 Inherited -
-swapChildrenAt(index1:int, index2:int):void -
-
- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list.
-		DisplayObjectContainer
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-clear -
-		 - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 Inherited -
-click -
-		 - Dispatched when a user presses and releases the main button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-contextMenu -
-		 - Dispatched when a user gesture triggers the context menu associated with this interactive - object in an AIR application.InteractiveObject
 Inherited -
-copy -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - or selects 'Copy' from the text context menu.InteractiveObject
 Inherited -
-cut -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - or selects 'Cut' from the text context menu.InteractiveObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-doubleClick -
-		 - Dispatched when a user presses and releases the main button of a pointing device twice in - rapid succession over the same InteractiveObject when that object's - doubleClickEnabled flag is set to true.InteractiveObject
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-focusIn -
-		 - Dispatched after a display object gains focus.InteractiveObject
 Inherited -
-focusOut -
-		 - Dispatched after a display object loses focus.InteractiveObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-gestureDirectionalTap -
-		 - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 Inherited -
-gestureLongPress -
-		 - Dispatched when the user presses two points of contact over the same InteractiveObject instance - on a touch-enabled device (such as presses and releases two fingers over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gesturePan -
-		 - Dispatched when the user moves a point of contact over the InteractiveObject instance - on a touch-enabled device (such as moving a finger from left to right over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureRotate -
-		 - Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers - and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureSwipe -
-		 - Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three - fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureTap -
-		 - Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps - on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureZoom -
-		 - Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two - fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-imeStartComposition -
-		 - This event is dispatched to any client app that supports inline input with an IME - - InteractiveObject
 Inherited -
-keyDown -
-		 - Dispatched when the user presses a key.InteractiveObject
 Inherited -
-keyFocusChange -
-		 - Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited -
-keyUp -
-		 - Dispatched when the user releases a key.InteractiveObject
 Inherited -
-middleClick -
-		 - Dispatched when a user presses and releases the middle button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-middleMouseDown -
-		 - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-middleMouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseDown -
-		 - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseFocusChange -
-		 - Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 Inherited -
-mouseMove -
-		 - Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited -
-mouseOut -
-		 - Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseOver -
-		 - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheel -
-		 - Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheelHorizontal -
-		 - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-nativeDragComplete -
-		 - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited -
-nativeDragDrop -
-		 - Dispatched by the target InteractiveObject when a dragged object is - dropped on it and the drop has been accepted with a call to - DragManager.acceptDragDrop().InteractiveObject
 Inherited -
-nativeDragEnter -
-		 - Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited -
-nativeDragExit -
-		 - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited -
-nativeDragOver -
-		 - Dispatched by an InteractiveObject continually while a drag gesture remains within its - boundary.InteractiveObject
 Inherited -
-nativeDragStart -
-		 - Dispatched at the beginning of a drag operation by the InteractiveObject that is - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-nativeDragUpdate -
-		 - Dispatched during a drag operation by the InteractiveObject that is - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-paste -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - or selects 'Paste' from the text context menu.InteractiveObject
 Inherited -
-proximityBegin -
-		 - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityEnd -
-		 - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityMove -
-		 - Dispatched when the user moves an active stylus over the screen while remaining within - the proximity detection threshold.InteractiveObject
 Inherited -
-proximityOut -
-		 - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityOver -
-		 - Dispatched when the user moves an active stylus directly above this InteractiveObject - while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOut -
-		 - Dispatched when the user moves an active stylus away from this InteractiveObject - and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOver -
-		 - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - object's tree of descendents in the display list - (while remaining within the proximity detection threshold of the screen).InteractiveObject
 Inherited -
-releaseOutside -
-		 - Dispatched when a user releases the button on the pointing device after the - user first pressed the button over an InteractiveObject instance - and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 Inherited -
-rightClick -
-		 - Dispatched when a user presses and releases the right button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-rightMouseDown -
-		 - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-rightMouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-rollOut -
-		 - Dispatched when the user moves a pointing device away from an InteractiveObject - instance.InteractiveObject
 Inherited -
-rollOver -
-		 - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-selectAll -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a select all operation - or selects 'Select All' from the text context menu.InteractiveObject
 Inherited -
-softKeyboardActivate -
-		 - Dispatched immediately after the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardActivating -
-		 - Dispatched immediately before the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardDeactivate -
-		 - Dispatched immediately after the soft keyboard is lowered.InteractiveObject
 Inherited -
-tabChildrenChange -
-		 - Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited -
-tabEnabledChange -
-		 - Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited -
-tabIndexChange -
-		 - Dispatched when the value of the object's tabIndex property changes.InteractiveObject
 Inherited -
-textInput -
-		 - Dispatched when a user enters one or more - characters of text.InteractiveObject
 Inherited -
-touchBegin -
-		 - Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchEnd -
-		 - Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchMove -
-		 - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 Inherited -
-touchOut -
-		 - Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device - (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchOver -
-		 - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOut -
-		 - Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device - (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOver -
-		 - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchTap -
-		 - Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated - on a touch-enabled device (such as presses and releases a finger from a single point over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
-
- -
- -
Property detail
- - - - - -
currentFrameproperty
-
-currentFrame:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies the number of the frame in which the playhead is located in the timeline of - the MovieClip instance. If the movie clip has multiple scenes, this value is the - frame number in the current scene. -

Implementation -
-    public function get currentFrame():int -
-
-Example -
The following code uses the gotoAndStop() method and the - currentFrame property to direct the playhead of the mc1 movie clip to - advance five frames ahead of its current location and stop: -
-
-mc1.gotoAndStop(mc1.currentFrame + 5);
-
-

-
- - - - - -
currentFrameLabelproperty 
-
-currentFrameLabel:String  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- The label at the current frame in the timeline of the MovieClip instance. - If the current frame has no label, currentLabel is null. - -

Implementation -
-    public function get currentFrameLabel():String -
-
- - - - - -
currentLabelproperty 
-
-currentLabel:String  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- The current label in which the playhead is located in the timeline of the MovieClip instance. - If the current frame has no label, currentLabel is set to the name of the previous frame - that includes a label. If the current frame and previous frames do not include a label, - currentLabel returns null. - -

Implementation -
-    public function get currentLabel():String -
-
-Example -
The following code illustrates how to access the currentLabel - property of a MovieClip object named mc1: -
-
-trace(mc1.currentLabel);
-
-

-
- - - - - -
currentLabelsproperty 
-
-currentLabels:Array  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Returns an array of FrameLabel objects from the current scene. If the MovieClip instance does - not use scenes, the array includes all frame labels from the entire MovieClip instance. - -

Implementation -
-    public function get currentLabels():Array -
-

-See also -

-
-flash.display.FrameLabel -
-
-Example -
The following code illustrates how to use the currentLabels - property of a MovieClip object named mc1: -
-
-import flash.display.FrameLabel;
- 
-var labels:Array = mc1.currentLabels;
-
-for (var i:uint = 0; i < labels.length; i++) {
-    var label:FrameLabel = labels[i];
-	trace("frame " + label.frame + ": " + label.name);
-}
-
-

-
- - - - - -
currentSceneproperty 
-
-currentScene:Scene  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- The current scene in which the playhead is located in the timeline of the MovieClip instance. - -

Implementation -
-    public function get currentScene():Scene -
-

-See also -

-
-Scene -
-
-Example -
The following code illustrates how to use the currentScene - property of a MovieClip object named mc1: -
-
-import flash.display.Scene;
- 
-var scene:Scene = mc1.currentScene;
-trace(scene.name + ": " + scene.numFrames + " frames");
-
-

-
- - - - - -
enabledproperty 
-
-enabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A Boolean value that indicates whether a movie clip is enabled. The default value of enabled - is true. If enabled is set to false, the movie clip's - Over, Down, and Up frames are disabled. The movie clip - continues to receive events (for example, mouseDown, - mouseUp, keyDown, and keyUp). -

The enabled property governs only the button-like properties of a movie clip. You - can change the enabled property at any time; the modified movie clip is immediately - enabled or disabled. If enabled is set to false, the object is not - included in automatic tab ordering.

- - Implementation -
-    public function get enabled():Boolean -
-    public function set enabled(value:Boolean):void -
-
-Example -
The following code illustrates how to use the enabled property - to disable the button-like properties of a MovieClip object named mc1: -
-
-mc1.enabled = false;
-
-

-
- - - - - -
framesLoadedproperty 
-
-framesLoaded:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of frames that are loaded from a streaming SWF file. You can use the framesLoaded - property to determine whether the contents of a specific frame and all the frames before it - loaded and are available locally in the browser. You can also use it to monitor the downloading - of large SWF files. For example, you might want to display a message to users indicating that - the SWF file is loading until a specified frame in the SWF file finishes loading. - -

If the movie clip contains multiple scenes, the framesLoaded property returns the number - of frames loaded for all scenes in the movie clip.

- Implementation -
-    public function get framesLoaded():int -
-

-See also -

-
-Loader class -
-
-Example -
The following code illustrates how to use the framesLoaded - property and the totalFrames property to determine if a streaming MovieClip - object named mc1 is fully loaded: -
-
-if (mc1.framesLoaded == mc1.totalFrames) {
-    trace("OK.");
-}
-
-

-
- - - - - -
isPlayingproperty 
-
-isPlaying:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- A Boolean value that indicates whether a movie clip is curently playing. - -

Implementation -
-    public function get isPlaying():Boolean -
-
- - - - - -
scenesproperty 
-
-scenes:Array  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- An array of Scene objects, each listing the name, the number of frames, - and the frame labels for a scene in the MovieClip instance. - -

Implementation -
-    public function get scenes():Array -
-

-See also -

-
-Scene -
-
-Example -
The following code illustrates how to use the scenes - property of a MovieClip object named mc1: -
-
-import flash.display.Scene;
- 
-for (var i:uint = 0; i < mc1.scenes.length; i++) {
-    var scene:Scene = mc1.scenes[i];
-	trace("scene " + scene.name + ": " + scene.numFrames + " frames");
-}
-
-

-
- - - - - -
totalFramesproperty 
-
-totalFrames:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The total number of frames in the MovieClip instance. -

If the movie clip contains multiple frames, the totalFrames property returns - the total number of frames in all scenes in the movie clip.

- Implementation -
-    public function get totalFrames():int -
-
-Example -
The following code illustrates the use of the totalFrames - property of a MovieClip object named mc1: -
-
- trace(mc1.totalFrames);
-
-

-
- - - - - -
trackAsMenuproperty 
-
-trackAsMenu:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Indicates whether other display objects that are SimpleButton or MovieClip objects can receive - mouse release events or other user input release events. The trackAsMenu property lets you create menus. You - can set the trackAsMenu property on any SimpleButton or MovieClip object. - The default value of the trackAsMenu property is false. - -

You can change the trackAsMenu property at any time; the modified movie - clip immediately uses the new behavior.

- - Implementation -
-    public function get trackAsMenu():Boolean -
-    public function set trackAsMenu(value:Boolean):void -
-
-Example -
The following code illustrates how to use the trackAsMenu - property to enable mouse release events for a MovieClip object named mc1: -
-
- mc1.trackAsMenu = true;
-
-

-
- -
Constructor detail
- - - - - -
MovieClip()constructor
-
-public function MovieClip() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a new MovieClip instance. After creating the MovieClip, call the - addChild() or addChildAt() method of a - display object container that is onstage. - -

- -
Method detail
- - - - - -
gotoAndPlay()method
-
-public function gotoAndPlay(frame:Object, scene:String = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Starts playing the SWF file at the specified frame. This happens after all - remaining actions in the frame have finished executing. To specify a scene - as well as a frame, specify a value for the scene parameter. - -

Parameters - - - - - - - - - - -
frame:Object — A number representing the frame number, or a string representing the label of the - frame, to which the playhead is sent. If you specify a number, it is relative to the - scene you specify. If you do not specify a scene, the current scene determines the global frame number to play. If you do specify a scene, the playhead - jumps to the frame number in the specified scene. -
 
scene:String (default = null) — The name of the scene to play. This parameter is optional. - -
-
-Example -
The following code uses the gotoAndPlay() method to direct the playhead of - the mc1 movie clip to advance five frames ahead of its current location: -
-
-mc1.gotoAndPlay(mc1.currentFrame + 5);
-
-

The following code uses the gotoAndPlay() method to direct the playhead of - the mc1 movie clip to the frame labeled "intro" in the scene named - "Scene 12": -
-
-mc1.gotoAndPlay("intro", "Scene 12");
-
-

-
- - - - - -
gotoAndStop()method 
-
-public function gotoAndStop(frame:Object, scene:String = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Brings the playhead to the specified frame of the movie clip and stops it there. This happens after all - remaining actions in the frame have finished executing. If you want to specify a scene in addition to a frame, - specify a scene parameter. - -

Parameters - - - - - - - - - - -
frame:Object — A number representing the frame number, or a string representing the label of the - frame, to which the playhead is sent. If you specify a number, it is relative to the - scene you specify. If you do not specify a scene, the current scene determines the global frame number at which to go to and stop. If you do specify a scene, - the playhead goes to the frame number in the specified scene and stops. - -
 
scene:String (default = null) — The name of the scene. This parameter is optional. -
-
-Throws - - - - -
ArgumentError — If the scene or frame specified are - not found in this movie clip. - -
-
-Example -
The following code uses the gotoAndStop() method and the - currentFrame property to direct the playhead of the mc1 movie clip to - advance five frames ahead of its current location and stop: -
-
-mc1.gotoAndStop(mc1.currentFrame + 5);
-
-

The following code uses the gotoAndStop() to direct the playhead of - the mc1 movie clip to the frame labeled "finale" in the scene named - "Scene 12" and stop the playhead: -
-
-mc1.gotoAndStop("finale", "Scene 12");
-
-

-
- - - - - -
nextFrame()method 
-
-public function nextFrame():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Sends the playhead to the next frame and stops it. This happens after all - remaining actions in the frame have finished executing. -

-See also -

-
-prevFrame() -
-
-Example -
In the following example, two SimpleButton objects control the timeline. The prev - button moves the playhead to the previous frame, and the nextBtn button moves the playhead - to the next frame: -
-
-
-import flash.events.MouseEvent;
-
-mc1.stop();
-prevBtn.addEventListener(MouseEvent.CLICK, goBack);
-nextBtn.addEventListener(MouseEvent.CLICK, goForward);
-
-function goBack(event:MouseEvent):void {
-    mc1.prevFrame();
-}
-
-function goForward(event:MouseEvent):void {
-	mc1.nextFrame();
-}
-
-

-
- - - - - -
nextScene()method 
-
-public function nextScene():void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Moves the playhead to the next scene of the MovieClip instance. This happens after all - remaining actions in the frame have finished executing. - -


-Example -
In the following example, two SimpleButton objects control the timeline. The prevBtn - button moves the playhead to the previous scene, and the nextBtn button moves the playhead - to the next scene: -
-
-
-import flash.events.MouseEvent;
-
-mc1.stop();
-prevBtn.addEventListener(MouseEvent.CLICK, goBack);
-nextBtn.addEventListener(MouseEvent.CLICK, goForward);
-
-function goBack(event:MouseEvent):void {
-    mc1.prevScene();
-}
-
-function goForward(event:MouseEvent):void {
-	mc1.nextScene();
-}
-
-

-
- - - - - -
play()method 
-
-public function play():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Moves the playhead in the timeline of the movie clip. -

-See also -

-
-gotoAndPlay() -
-
-Example -
The following code uses the stop() method to stop a movie clip - named mc1 and to resume playing when the user clicks the text field named - continueText: -
-
-
-import flash.text.TextField;
-import flash.events.MouseEvent;
-
-var continueText:TextField = new TextField();
-continueText.text = "Play movie...";
-addChild(continueText);
-
-mc1.stop();
-continueText.addEventListener(MouseEvent.CLICK, resumeMovie);
-
-function resumeMovie(event:MouseEvent):void {
-    mc1.play();
-}
-
-

-
- - - - - -
prevFrame()method 
-
-public function prevFrame():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sends the playhead to the previous frame and stops it. This happens after all - remaining actions in the frame have finished executing. - -


-Example -
In the following example, two SimpleButton objects control the timeline. The prev - button moves the playhead to the previous frame, and the nextBtn button moves the playhead - to the next frame: -
-
-
-import flash.events.MouseEvent;
-
-mc1.stop();
-prevBtn.addEventListener(MouseEvent.CLICK, goBack);
-nextBtn.addEventListener(MouseEvent.CLICK, goForward);
-
-function goBack(event:MouseEvent):void {
-    mc1.prevFrame();
-}
-
-function goForward(event:MouseEvent):void {
-	mc1.nextFrame();
-}
-
-

-
- - - - - -
prevScene()method 
-
-public function prevScene():void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Moves the playhead to the previous scene of the MovieClip instance. This happens after all - remaining actions in the frame have finished executing. - -


-Example -
In the following example, two SimpleButton objects control the timeline. The prevBtn - button moves the playhead to the previous scene, and the nextBtn button moves the playhead - to the next scene: -
-
-
-import flash.events.MouseEvent;
-
-mc1.stop();
-prevBtn.addEventListener(MouseEvent.CLICK, goBack);
-nextBtn.addEventListener(MouseEvent.CLICK, goForward);
-
-function goBack(event:MouseEvent):void {
-    mc1.prevScene();
-}
-
-function goForward(event:MouseEvent):void {
-	mc1.nextScene();
-}
-
-

-
- - - - - -
stop()method 
-
-public function stop():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Stops the playhead in the movie clip. - -

- -
Examples
-
examples\MovieClipExample
-
The following example uses the MovieClipExample class to illustrate how - to monitor various properties of a MovieClip. This task is accomplished by performing the following steps: - -
    - -
  1. The constructor function defines a text field, which is used to display values of properties - of the MovieClipExample object (which extends MovieClip).
    2. - -
  2. The return value of the getPropertiesString() method is used as text for the - outputText text field. The getPropertiesString() method returns - a string that is populated with values of the following properties of the movie clip: - currentFrame, currentLabel, currentScene, - framesLoaded, totalFrames, and trackAsMenu.
    3. - -
  3. Two lines of code in the constructor function adjust the width and - height properties of the outputText text field.
    4. - -
  4. The last line of the constructor function adds the outputText text field - to the display list.
    5. - -
-
-
-
-package {
-    import flash.display.MovieClip;
-    import flash.text.TextField;
-
-    public class MovieClipExample extends MovieClip {
-
-        public function MovieClipExample() {
-            var outputText:TextField = new TextField();
-            outputText.text = getPropertiesString();
-            outputText.width = stage.stageWidth;
-            outputText.height = outputText.textHeight;
-            addChild(outputText);
-        }
-
-        private function getPropertiesString():String {
-            var str:String = ""
-                + "currentFrame: " + currentFrame + "\n"
-                + "currentLabel: " + currentLabel + "\n"
-                + "currentScene: " + currentScene + "\n"
-                + "framesLoaded: " + framesLoaded + "\n"
-                + "totalFrames: " + totalFrames + "\n"
-                + "trackAsMenu: " + trackAsMenu + "\n";
-            return str;
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/NativeMenu.html b/html-docs/flash/display/NativeMenu.html deleted file mode 100644 index 80f5b83..0000000 --- a/html-docs/flash/display/NativeMenu.html +++ /dev/null @@ -1,1908 +0,0 @@ - - - - - - - - -flash.display.NativeMenu (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic class NativeMenu
InheritanceNativeMenu Inheritance EventDispatcher Inheritance Object
SubclassesContextMenu
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The NativeMenu class contains methods and properties for defining native menus. - - - -

AIR profile support: This feature is supported - - on all desktop operating systems, but is not supported on mobile devices or AIR for TV devices. You can test - - for support at run time using the NativeMenu.isSupported property. See - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - - -

A native menu is a menu that is controlled and drawn by the operating system rather than by your application. - - AIR supports the following types of native menus:

- - - -
    - -
  • Application menus are supported on OS X. Use the NativeApplication.supportsMenu property to test whether - - application menus are supported on the host operating system. An application menu is displayed on the Menu bar at the top of the - - Mac desktop. OS X provides a default menu for every application, but many of the menu commands are not functional. You can add - - event listeners to the default items, replace individual menus and items, or even replace the default menu entirely. - - Access the application menu object using the NativeApplication menu property.
    • - - - -
  • Window menus are supported on Windows and Linux. Use the NativeWindow.supportsMenu property to - - test whether window menus are supported on the host operating system. A window menu is displayed below the window title bar. The area - - occupied by the menu is not part of the window stage. Applications cannot draw into this area. Assign a menu to a window using the - - NativeWindow menu property.
    • - - - -
  • Dock icon menus are supported on OS X. Use the NativeApplication.supportsDockIcon property to test whether - - dock icons are supported on the host operating system. Items in a dock icon menu are displayed above the default items provided by - - the operating system. The default items cannot be accessed by application code. Assign a menu to the menu property of - - the application's DockIcon object.
    • - - - -
  • System tray icon menus are supported on Windows and most Linux operating systems. Use the - - NativeApplication.supportsSystemTrayIcon property to test whether system tray icons are supported on the host - - operating system. A system tray icon menu is displayed in response to a right-click on the icon, in much the same fashion as - - a context menu. Assign a menu to the menu property of the application's SystemTrayIcon object.
    • - - - -
  • Context menus are supported on all operating systems. Context menus are displayed in response to a user interface event, - - such as a right-click or a command-click on an InteractiveObject displayed in the application. The UI mechanism for showing the menu - - varies by host operating system and hardware. Assign a menu to the contextMenu property of an - - InteractiveObject. In AIR, a context menu can be created with either the NativeMenu class or the ContextMenu class. In - - Flash Player, only the ContextMenu class can be used. ContextMenus in AIR do not have built-in items; a default context menu is - - not displayed.
    • - - - -
  • Pop-up menus are supported on all operating systems. Pop-up menus are functionally the same as context menus, but - - are displayed using the menu display() method rather than as a response to a user interface event. A pop-up - - menu is not attached to any other object. Simply create the native menu and call the display() method.
    • - -
- - - -

A menu object contains menu items. A menu item can represent a command, a submenu, or a separator line. - - Add menu items to a menu using the addItem() or addItemAt() method. The display order of the menu items - - matches the order of the items in the menu's items array.

- - - -

To create a submenu, add a menu item to the parent menu object. Assign the menu object representing - - the submenu to the submenu property of the matching menu item in the parent menu.

- - - -

Note: The root menu of window and application menus must contain only submenu items; items - - that do not represent submenus may not be displayed and are contrary to user expectation for - - these types of menus.

- - - -

Menus dispatch select events when a command item in the menu or one of its - - submenus is selected. (Submenu and separator items are not selectable.) The - - target property of the event object references the - - selected item.

- - - -

Menus dispatch preparing events just before the menu is displayed and when a key equivalent attached - - to one of the items in the menu is pressed. You - - can use this event to update the contents of the menu based on the current - - state of the application.

- - - -

Note: If you are using the Flex Framework, consider using the FlexNativeMenu class. - - It is typically easier to define menus declaratively in MXML than it is to write ActionScript code to create the menu - - structure item-by-item.

- - - -

Note: The AIR SDK includes the MenuBuilder framework (AIRMenuBuilder.js)for defining menus - - using XML or JSON notation. It is typically easier to define menus declaratively than it is to write JavaScript - - code to create the menu structure item-by-item.

- - - -

-

-See also -

-
-flash.display.InteractiveObject.contextMenu -
-flash.display.NativeMenuItem -
-flash.display.NativeWindow.menu -
-flash.desktop.DockIcon -
-flash.desktop.SystemTrayIcon -
-flash.desktop.NativeApplication.menu -
-flash.desktop.NativeApplication.icon -
mx.controls.FlexNativeMenu
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - - Indicates whether any form of native menu is supported on the client system.
-		NativeMenu
  items : Array -
- - The array of NativeMenuItem objects in this menu.
-		NativeMenu
  numItems : int -
[read-only] - - The number of NativeMenuItem objects in this menu.
-		NativeMenu
  parent : NativeMenu -
[read-only] - - The parent menu.
-		NativeMenu
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NativeMenu()
-
- - Creates a new NativeMenu object.
-		NativeMenu
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-addItem(item:NativeMenuItem):NativeMenuItem -
-
- - Adds a menu item at the bottom of the menu.
-		NativeMenu
   -
-addItemAt(item:NativeMenuItem, index:int):NativeMenuItem -
-
- - Inserts a menu item at the specified position.
-		NativeMenu
   -
-addSubmenu(submenu:NativeMenu, label:String):NativeMenuItem -
-
- - Adds a submenu to the menu by inserting a new menu item.
-		NativeMenu
   -
-addSubmenuAt(submenu:NativeMenu, index:int, label:String):NativeMenuItem -
-
- - Adds a submenu to the menu by inserting a new menu item at the - - specified position.
-		NativeMenu
   -
-clone():NativeMenu -
-
- - - Creates a copy of the menu and all items.
-		NativeMenu
   -
-containsItem(item:NativeMenuItem):Boolean -
-
- - Reports whether this menu contains the specified menu item.
-		NativeMenu
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-display(stage:Stage, stageX:Number, stageY:Number):void -
-
- - Pops up this menu at the specified location.
-		NativeMenu
   -
-getItemAt(index:int):NativeMenuItem -
-
- - Gets the menu item at the specified index.
-		NativeMenu
   -
-getItemByName(name:String):NativeMenuItem -
-
- - Gets the menu item with the specified name.
-		NativeMenu
   -
-getItemIndex(item:NativeMenuItem):int -
-
- - Gets the position of the specified item.
-		NativeMenu
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-removeAllItems():void -
-
- - Removes all items from the menu.
-		NativeMenu
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-removeItem(item:NativeMenuItem):NativeMenuItem -
-
- - Removes the specified menu item.
-		NativeMenu
   -
-removeItemAt(index:int):NativeMenuItem -
-
- - Removes and returns the menu item at the specified index.
-		NativeMenu
   -
-setItemIndex(item:NativeMenuItem, index:int):void -
-
- - Moves a menu item to the specified position.
-		NativeMenu
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-displaying -
-		 - - Dispatched by this NativeMenu object immediately before the - - menu is displayed.NativeMenu
   -
-preparing -
-		 - - Dispatched by the NativeMenu object when a key equivalent is pressed and immediately before the menu is displayed.NativeMenu
   -
-select -
-		 - - Dispatched by this NativeMenu object when one of its menu items or an item - - in one of its descendant submenus is selected.NativeMenu
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.0 - -
-

- - Indicates whether any form of native menu is supported on the client system. - - - -

Implementation -
-    public static function get isSupported():Boolean -
-

-See also -

-
-flash.display.NativeWindow.supportsMenu -
-flash.desktop.NativeApplication -
-
- - - - - -
itemsproperty 
-
-items:Array  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - The array of NativeMenuItem objects in this menu. - - -

The array is sorted in display order.

- - -

Note: This property is read-only in AIR 1.0. It became read/write in AIR 1.1.

- - - - Implementation -
-    public function get items():Array -
-    public function set items(value:Array):void -
-
- - - - - -
numItemsproperty 
-
-numItems:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The number of NativeMenuItem objects in this menu. - - -

Implementation -
-    public function get numItems():int -
-
- - - - - -
parentproperty 
-
-parent:NativeMenu  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The parent menu. - - - -

The parent of the root (top-level) menu object is - - null.

- - - Implementation -
-    public function get parent():NativeMenu -
-
- -
Constructor detail
- - - - - -
NativeMenu()constructor
-
-public function NativeMenu() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new NativeMenu object. - - - -

- -
Method detail
- - - - - -
addItem()method
-
-public function addItem(item:NativeMenuItem):NativeMenuItem -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Adds a menu item at the bottom of the menu. - - -

When creating a context menu, you can add either NativeMenuItem or - - ContextMenuItem objects. However, it is advisable to use only one type of object in a context - - menu so that all items in the menu have the same properties.

- - -

Note: Adding an item to a menu can cause an application to hang if the item's - - submenu is set to the menu itself (causing a circular reference).

- - - - Parameters - - - - -
item:NativeMenuItem — The NativeMenuItem object to add at the bottom of the menu. - -
-

-Returns - - - - -
NativeMenuItem — - The input NativeMenuItem if successful, or null if the item could not be added. - - - - -
-
-Throws - - - - - - - - - - -
ArgumentError — If item is null. - -
 
ArgumentError — If item is a member of another menu. - - -
-
- - - - - -
addItemAt()method 
-
-public function addItemAt(item:NativeMenuItem, index:int):NativeMenuItem -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Inserts a menu item at the specified position. The position is indexed from the top. - - Set the index parameter to zero to insert the item at the top of the menu. - - All types of menus: window, application, system tray icon, dock icon, context, and pop-up, - - index the menu position from the top. - - -

Parameters - - - - - - - - - - -
item:NativeMenuItem — The NativeMenuItem object to insert. - -
 
index:int — The (zero-based) position in menu - - at which to insert the menu item. - - -

Note: Adding an item to a menu can cause an application to hang if the item's - - submenu is set to the menu itself (causing a circular reference).

- - - -
-

-Returns - - - - -
NativeMenuItem — - The input NativeMenuItem if successful, or null if the item could not be added. - - - - -
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — If item is null. - -
 
ArgumentError — If item is a member of another menu. - -
 
RangeError — If the index is outside the bounds of the menu's - - items array. - - -
-
- - - - - -
addSubmenu()method 
-
-public function addSubmenu(submenu:NativeMenu, label:String):NativeMenuItem -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Adds a submenu to the menu by inserting a new menu item. - - - -

Calling the addSubMenu() method is equivalent to creating a new menu - - item, adding it to the menu, and assigning a NativeMenu object to the - - item's submenu property.

- - - -

Note: Adding a menu as a submenu of itself (in a circular reference) - - can cause an application to hang.

- - - - Parameters - - - - - - - - - - -
submenu:NativeMenu — The NativeMenu object that defines the submenu to be added. - -
 
label:String — The display label for the menu item to be added. - - - -
-

-Returns - - - - -
NativeMenuItem — - The NativeMenuItem object created for the submenu. - - - -
-
- - - - - -
addSubmenuAt()method 
-
-public function addSubmenuAt(submenu:NativeMenu, index:int, label:String):NativeMenuItem -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Adds a submenu to the menu by inserting a new menu item at the - - specified position. - - - -

Calling the addSubMenuAt() method is equivalent to creating a new menu - - item, inserting it at the desired position in the menu, and assigning - - a NativeMenu object to the item's submenu property.

- - - -

Note: Adding a menu as a submenu of itself (in a circular reference) - - can cause an application to hang.

- - - - Parameters - - - - - - - - - - - - - - - - -
submenu:NativeMenu — The NativeMenu object that defines the submenu to be added. - -
 
index:int — The position in the items array of this - - menu at which to insert the menu item to be added. - -
 
label:String — The display label for the menu item to be added. - - - -
-

-Returns - - - - -
NativeMenuItem — - The NativeMenuItem object created for the submenu. - - - -
-
- - - - - -
clone()method 
-
-public function clone():NativeMenu -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - - Creates a copy of the menu and all items. - - -

-Returns - - - - -
NativeMenu
-
- - - - - -
containsItem()method 
-
-public function containsItem(item:NativeMenuItem):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Reports whether this menu contains the specified menu item. - - -

Parameters - - - - -
item:NativeMenuItem — The NativeMenuItem object to look up. - - - -
-

-Returns - - - - -
Boolean — - true if item is in this menu. - - - - - -
-
- - - - - -
display()method 
-
-public function display(stage:Stage, stageX:Number, stageY:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Pops up this menu at the specified location. - - - -

Parameters - - - - - - - - - - - - - - - - -
stage:Stage — The Stage object on which to display this menu. - - - -
 
stageX:Number — The number of horizontal pixels, relative to the origin - - of stage, at which to display this menu. - - - -
 
stageY:Number — The number of vertical pixels, relative to the origin - - of stage, at which to display this menu. - - - -
-
- - - - - -
getItemAt()method 
-
-public function getItemAt(index:int):NativeMenuItem -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Gets the menu item at the specified index. - - -

Parameters - - - - -
index:int — The (zero-based) position of the item to return. - - - -
-

-Returns - - - - -
NativeMenuItem — - The NativeMenuItem object at the specified position in the menu. - - - - - -
-
-Throws - - - - -
RangeError — If index is outside the bounds of the menu's - - items array. - - -
-
- - - - - -
getItemByName()method 
-
-public function getItemByName(name:String):NativeMenuItem -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Gets the menu item with the specified name. - - - -

Note: The name property of menu items is not assigned by - - default.

- - - - Parameters - - - - -
name:String — The string to look up. - -
-

-Returns - - - - -
NativeMenuItem — - The NativeMenuItem object with the specified name or - - null, if no such item exists in the menu. - - - - -
-
- - - - - -
getItemIndex()method 
-
-public function getItemIndex(item:NativeMenuItem):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Gets the position of the specified item. - - -

Parameters - - - - -
item:NativeMenuItem — The NativeMenuItem object to look up. - - - -
-

-Returns - - - - -
int — - The (zero-based) position of the specified item in this menu - - or -1, if the item is not in this menu. - - - - - -
-
- - - - - -
removeAllItems()method 
-
-public function removeAllItems():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Removes all items from the menu. - - - - - - - -

- - - - - -
removeItem()method 
-
-public function removeItem(item:NativeMenuItem):NativeMenuItem -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Removes the specified menu item. - - - -

Parameters - - - - -
item:NativeMenuItem — The NativeMenuItem object to remove from this menu. - - - -
-

-Returns - - - - -
NativeMenuItem
-
-Throws - - - - -
RangeError — If the item is not in this menu - - -
-
- - - - - -
removeItemAt()method 
-
-public function removeItemAt(index:int):NativeMenuItem -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Removes and returns the menu item at the specified index. - - - -

Parameters - - - - -
index:int — The (zero-based) position of the item to remove. - - - -
-

-Returns - - - - -
NativeMenuItem — - The NativeMenuItem object removed. - - - - - -
-
-Throws - - - - -
RangeError — If index is outside the bounds of - - this menu's items array. - - -
-
- - - - - -
setItemIndex()method 
-
-public function setItemIndex(item:NativeMenuItem, index:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Moves a menu item to the specified position. If the item is not already in the menu, - - calling this method adds the item to the menu. - - - -

Parameters - - - - - - - - - - -
item:NativeMenuItem — The NativeMenuItem object to move. - -
 
index:int — The (zero-based) position in the menu to which to move the - - item. - - - -
-
-Throws - - - - -
RangeError — If index is outside the bounds of the - - menu's items array. - - -
-
-
Event detail
- - - - - -
displayingevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.DISPLAYING -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeMenu object immediately before the - - menu is displayed. - - - -

Listen to this event to update the menu before it is displayed. - - A displaying event is also dispatched by the items in a menu.

- - - -

The preparing event supersedes the displaying event and provides additional functionality. Listen for the - - preparing event or the displaying event, but not both.

- - - -

Note: On Mac OS X, prior to AIR 2.6, menus and menu items dispatched a displaying event when the user pressed a key - - equivalent. (This event was not dispatched for key equivalent interaction on other operating systems.) As of AIR 2.6, displaying - - events are no longer dispatched when the user presses a key equivalent. Use the preparing event instead.

- - - -

- The Event.DISPLAYING constant defines the value of the type property of a displaying event object. -

Note: This event does not go through a "capture phase" - and is dispatched directly to the target, whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object that is about to be displayed.
- -
- - - - - -
preparingevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.PREPARING -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 - -
-

- - Dispatched by the NativeMenu object when a key equivalent is pressed and immediately before the menu is displayed. - - - -

Listen to this event to update the menu either before it is displayed, or when a key - - equivalent is pressed by the user. The preparing event is dispatched before the key equivalent - - is fully evaluated. You can enable, disable, add, or remove items from the menu in the preparing event handler - - and those changes will be in effect when the key equivalent is processed. For example, if you remove or disable the - - menu item assigned to the triggering key equivalent, then the sequence of events is effectively canceled - - and no select event is dispatched. - - A preparing event is also dispatched by the items in a menu.

- - -

The preparing event supersedes the displaying event and provides additional functionality. Listen for the - - preparing event or the displaying event, but not both.

- - - -
- - - - - -
selectevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.SELECT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeMenu object when one of its menu items or an item - - in one of its descendant submenus is selected. - - - -

A select event bubbles from a menu item to its containing menu and on up - - through the parent menu chain to the root menu object. The target - - property of the event object references the selected NativeMenuItem object; - - the currentTarget property references this NativeMenu object.

- - -

- The Event.SELECT constant defines the value of the type property of a select event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object on which an item has been selected.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Sat Jan 11 2025, 8:30 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/display/NativeMenuItem.html b/html-docs/flash/display/NativeMenuItem.html deleted file mode 100644 index 5658b3d..0000000 --- a/html-docs/flash/display/NativeMenuItem.html +++ /dev/null @@ -1,1286 +0,0 @@ - - - - - - - - -flash.display.NativeMenuItem (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic class NativeMenuItem
InheritanceNativeMenuItem Inheritance EventDispatcher Inheritance Object
SubclassesContextMenuItem
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The NativeMenuItem class represents a single item in a menu. - - - -

A menu item can be a command, a submenu, or a separator line:

- - - -
    - -
  • To create a command item, call the NativeMenuItem constructor, passing in a - - string for the label and false for the isSeparator - - parameter.
    • - - - -
  • To create a submenu, create a command item for the parent menu and - - assign the NativeMenu object of the submenu to the item's submenu - - property. You can also call the addSubmenu() method of the - - parent NativeMenu object to create the item and set the submenu - - property at the same time.
    • - - - -
  • To create a separator, call the NativeMenuItem constructor, passing in an empty - - string for the label and true for the isSeparator - - parameter.
    • - -
- - - -

Listen for select events on an item or a parent menu to detect when a - - menu command is selected. Neither submenus nor separators dispatch - - select events. Listen for preparing events to determine when - - a menu item is about to be displayed or activated through a key equivalent.

- - -

-

-See also -

-
-flash.display.NativeMenu -
-flash.display.NativeMenu.addSubmenu() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  checked : Boolean -
- - Controls whether this menu item displays a checkmark.
-		NativeMenuItem
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  data : Object -
- - An arbitrary data object associated with this menu item.
-		NativeMenuItem
  enabled : Boolean -
- - Controls whether this menu item is enabled.
-		NativeMenuItem
  isSeparator : Boolean -
[read-only] - - Reports whether this item is a menu separator line.
-		NativeMenuItem
  keyEquivalent : String -
- - The key equivalent for this menu item.
-		NativeMenuItem
  keyEquivalentModifiers : Array -
- - The array of key codes for the key equivalent modifiers.
-		NativeMenuItem
  label : String -
- - The display string of this menu item.
-		NativeMenuItem
  menu : NativeMenu -
[read-only] - - The menu that contains this item.
-		NativeMenuItem
  mnemonicIndex : int -
- - The position of the mnemonic character in the menu item label.
-		NativeMenuItem
  name : String -
- - The name of this menu item.
-		NativeMenuItem
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  submenu : NativeMenu -
- - The submenu associated with this menu item.
-		NativeMenuItem
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NativeMenuItem(label:String = "", isSeparator:Boolean = false)
-
- - Creates a new NativeMenuItem object.
-		NativeMenuItem
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-clone():NativeMenuItem -
-
- - Creates a copy of the NativeMenuItem object.
-		NativeMenuItem
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string containing all the properties of the NativeMenuItem object.
-		NativeMenuItem
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-displaying -
-		 - - Dispatched by this NativeMenuItem object immediately before the - - menu containing the item is displayed.NativeMenuItem
   -
-preparing -
-		 - - Dispatched by this NativeMenuItem object when its key equivalent is pressed and immediately before the containing menu is displayed.NativeMenuItem
   -
-select -
-		 - - Dispatched whenever a menu item is selected by the user.NativeMenuItem
-
- -
- -
Property detail
- - - - - -
checkedproperty
-
-checked:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Controls whether this menu item displays a checkmark. - - -

Implementation -
-    public function get checked():Boolean -
-    public function set checked(value:Boolean):void -
-
- - - - - -
dataproperty 
-
-data:Object  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - An arbitrary data object associated with this menu item. - - -

You can assign any object to this property. The assigned object is - - not used by the menu system, but is available to event handling code - - (through the target property of the event object). - - By default, the value of this property is null.

- - - - Implementation -
-    public function get data():Object -
-    public function set data(value:Object):void -
-
- - - - - -
enabledproperty 
-
-enabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Controls whether this menu item is enabled. - - -

Implementation -
-    public function get enabled():Boolean -
-    public function set enabled(value:Boolean):void -
-
- - - - - -
isSeparatorproperty 
-
-isSeparator:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Reports whether this item is a menu separator line. - - - -

Create a separator line by setting the isSeparator - - parameter in the NativeMenuItem constructor to true.

- - - Implementation -
-    public function get isSeparator():Boolean -
-
- - - - - -
keyEquivalentproperty 
-
-keyEquivalent:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The key equivalent for this menu item. - - - -

Set the keyEquivalent with a lowercase letter to assign - - a shortcut without a Shift-key modifier. Set with an uppercase letter - - to assign a shortcut with the Shift-key modifier.

- - - -

By default, a key equivalent modifier (Ctrl on Windows or Linux and - - Command on Mac OS X) is included as part of the key equivalent. - - If you want the key equivalent to be a key with no modifier, - - set the keyEquivalentModifiers property to an - - empty array.

- - - Implementation -
-    public function get keyEquivalent():String -
-    public function set keyEquivalent(value:String):void -
-
- - - - - -
keyEquivalentModifiersproperty 
-
-keyEquivalentModifiers:Array  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The array of key codes for the key equivalent modifiers. - - -

Use the constants defined in the Keyboard class to specify the - - modifier key codes. Valid modifier keys include:

- -
    - -
  • Keyboard.ALTERNATE
    • - -
  • Keyboard.COMMAND
    • - -
  • Keyboard.CONTROL
    • - -
- - - -

If you do not assign any modifiers, then by default the Keyboard.CONTROL key is - - assigned on Windows or Linux and the Keyboard.COMMAND key is assigned on Mac OS X. If you - - do not want the key equivalent to include these modifiers, set this property to an empty array.

- - - -

If you assign an uppercase letter to the keyEquivalent property, the Shift key is - - used as a modifier automatically. Setting keyEquivalentModifier to an empty array - - does not remove the Shift key as a modifier.

- - - - Implementation -
-    public function get keyEquivalentModifiers():Array -
-    public function set keyEquivalentModifiers(value:Array):void -
-

-See also -

-
-flash.ui.Keyboard -
-
- - - - - -
labelproperty 
-
-label:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The display string of this menu item. - - -

Implementation -
-    public function get label():String -
-    public function set label(value:String):void -
-
- - - - - -
menuproperty 
-
-menu:NativeMenu  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The menu that contains this item. - - -

Implementation -
-    public function get menu():NativeMenu -
-
- - - - - -
mnemonicIndexproperty 
-
-mnemonicIndex:int  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The position of the mnemonic character in the menu item label. - - -

The character at the specified position is the mnemonic - - character for the menu item. The index is zero-based, so the first - - character has an index of 0.

- - - -

This property is ignored on operating systems that do not use - - menu mnemonics.

- - - - Implementation -
-    public function get mnemonicIndex():int -
-    public function set mnemonicIndex(value:int):void -
-
- - - - - -
nameproperty 
-
-name:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The name of this menu item. - - - -

The name value is not displayed and can be used as a - - locale-independent identifier. A name is not assigned automatically.

- - - Implementation -
-    public function get name():String -
-    public function set name(value:String):void -
-
- - - - - -
submenuproperty 
-
-submenu:NativeMenu  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The submenu associated with this menu item. - - - -

Assigning a NativeMenu object to this property changes the - - appearance and behavior of the menu item. A submenu item displays - - the submenu icon and no longer dispatches select events.

- - -

Note: Adding a menu as a submenu of itself (in a circular reference) - - can cause an application to hang.

- - - - Implementation -
-    public function get submenu():NativeMenu -
-    public function set submenu(value:NativeMenu):void -
-

-See also -

-
-flash.display.NativeMenu.addSubmenu() -
-
- -
Constructor detail
- - - - - -
NativeMenuItem()constructor
-
-public function NativeMenuItem(label:String = "", isSeparator:Boolean = false) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new NativeMenuItem object. - - - -

To create a menu command, set the label parameter to a - - string containing the display label and set isSeparator - - to false.

- - -

To create a submenu command, create a command item and then assign the - - NativeMenu object for the submenu to the item's submenu - - property. Add the item to the parent menu.

- - - -

To create a separator, set the label parameter to an empty - - string and set isSeparator to true.

- - -

Add and remove items from a menu using the NativeMenu addItem() - - and removeItem() methods.

- - - - Parameters - - - - - - - - - - -
label:String (default = "") — The display label for the item, or an empty string for separators. - -
 
isSeparator:Boolean (default = false) — Set to true to create a separator; set to - - false otherwise. - - - -
-

-See also -

-
-flash.display.NativeMenu.addSubmenu() -
-
- -
Method detail
- - - - - -
clone()method
-
-public function clone():NativeMenuItem -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a copy of the NativeMenuItem object. - - -

-Returns - - - - -
NativeMenuItem
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns a string containing all the properties of the NativeMenuItem object. - - - -

-Returns - - - - -
String — - A string containing all the properties of the Event object. - - - -
-
-
Event detail
- - - - - -
displayingevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.DISPLAYING -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeMenuItem object immediately before the - - menu containing the item is displayed. - - - -

The preparing event supersedes the displaying event and provides additional functionality. Listen for the - - preparing event or the displaying event, but not both.

- - - -

- The Event.DISPLAYING constant defines the value of the type property of a displaying event object. -

Note: This event does not go through a "capture phase" - and is dispatched directly to the target, whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object that is about to be displayed.
- -
- - - - - -
preparingevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.PREPARING -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 - -
-

- - Dispatched by this NativeMenuItem object when its key equivalent is pressed and immediately before the containing menu is displayed. - - - -

Listen to this event to update the item either before the containing menu is displayed, or when its key - - equivalent is pressed by the user. The preparing event is dispatched before the key equivalent - - is fully evaluated. You can enable, disable, or remove the item from the menu in the preparing event handler - - and those changes will be in effect when the key equivalent is processed. For example, if you remove or disable this - - menu item, then the sequence of events is effectively canceled - - and no select event is dispatched. - - A preparing event is also dispatched by the other items in a menu.

- - - -

The preparing event supersedes the displaying event and provides additional functionality. Listen for the - - preparing event or the displaying event, but not both.

- - - -
- - - - - -
selectevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.SELECT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched whenever a menu item is selected by the user. - - - -

A select event bubbles from this item to its containing menu and on up - - through the parent menu chain to the root menu object. The target - - property of the event object references this NativeMenuItem object; - - the currentTarget property references the dispatching - - object (either this NativeMenuItem or an ancestral NativeMenu object).

- - - -

Note: If the window containing the menu is in fullscreen mode - - (stage.displayState == StageDisplayState.FULL_SCREEN), - - the NativeMenuItem object does not dispatch a select event - - when the user enters a keyboard equivalent for a menu item.

- - - -

- The Event.SELECT constant defines the value of the type property of a select event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object on which an item has been selected.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/NativeWindow.html b/html-docs/flash/display/NativeWindow.html deleted file mode 100644 index fdab3fa..0000000 --- a/html-docs/flash/display/NativeWindow.html +++ /dev/null @@ -1,5582 +0,0 @@ - - - - - - - - -flash.display.NativeWindow (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class NativeWindow
InheritanceNativeWindow Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The NativeWindow class provides an interface for creating and controlling native desktop windows. - - - -

AIR profile support: This feature is supported fully - - on desktop operating systems, has some limited (single-window) support on mobile devices, - - and is not supported on AIR for TV devices. You can test for support - - at run time on desktop devices using the NativeWindow.isSupported property. See - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - - -

On desktop operating systems, a reference to a new NativeWindow instance - - is returned by the window constructor. On mobile operating systems, attempting to create a new - - NativeWindow instance will throw an error - the only NativeWindow that exists is the initial application - - window with properties set via the application descriptor file, and accessed from the stage. - - The reference to the initial NativeWindow instance for an application can be accessed using the - - stage.nativeWindow property of any display object on that window's stage:

- - - - 
var window:NativeWindow = displayObject.stage.nativeWindow;
- - -

On mobile operating systems, the window object cannot be modified, but can be used to listen - - for resize events (for example, on screen orientation changes) and for focus (activate/deactive) - - events. These can be separate from the NativeApplication events that describe the - - foreground/background mode of the application itself, and can be used to determine when other - - elements are hiding part of the window's display.

- - - -

The properties of a NativeWindow instance can only be accessed by application - - content. If non-application content attempts to access the NativeWindow object, a - - security error will be thrown.

- - - -

Content can be added to a window using the - - DisplayObjectContainer methods of the Stage object such as addChild().

- - - -

You cannot not add Flex components directly to the display list of a - - NativeWindow instance. Instead, use the Flex mx:WindowedApplication - - and mx:Window components to create your windows and add the other Flex - - components as children of those objects. You can add Flex-based SWF content directly - - to a NativeWindow window as long as the SWF file is loaded into its own - - application domain and is application content. - -

- - - -

- - The following operations on NativeWindow objects are asynchronous: close(), - - maximize(), minimize(), restore(), and bounds changes. - - An application can detect when these operations have completed by listening - - for the appropriate events. - -

- - - -

- - If the NativeApplication.autoExit property is true, which is the default, - - the application will close when its last window is closed (and all close event - - handlers have returned). - - If autoExit is false, then NativeApplication.nativeApplication.exit() - - must be called to terminate the application. - -

- -

- - NativeWindow objects will not be garbage collected after the window constructor has been called - - and before close() - - has been called. It is the responsibility of the application to close its own windows. - -

- - -

-

-See also -

-
-flash.display.Stage.nativeWindow -
-flash.display.NativeWindowInitOptions -
-flash.desktop.NativeApplication -
-flash.system.ApplicationDomain -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  active : Boolean -
[read-only] - - Indicates whether this window is the active application window.
-		NativeWindow
  alwaysInFront : Boolean -
- - Specifies whether this window will always be in front of other windows (including - - those of other applications).
-		NativeWindow
  bounds : Rectangle -
- - The size and location of this window.
-		NativeWindow
  closed : Boolean -
[read-only] - - Indicates whether this window has been closed.
-		NativeWindow
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  displayState : String -
[read-only] - - The display state of this window.
-		NativeWindow
  height : Number -
- - The height of this window in pixels.
-		NativeWindow
  isSupported : Boolean -
[static][read-only] - - Indicates whether native windows are supported on the client system.
-		NativeWindow
  maximizable : Boolean -
[read-only] - - Reports the maximizable setting used to create this window.
-		NativeWindow
  maxSize : Point -
- - The maximum size for this window.
-		NativeWindow
  menu : NativeMenu -
- - The native menu for this window.
-		NativeWindow
  minimizable : Boolean -
[read-only] - - Reports the minimizable setting used to create this window.
-		NativeWindow
  minSize : Point -
- - The minimum size for this window.
-		NativeWindow
  owner : NativeWindow -
[read-only] - - The NativeWindow object that owns this window.
-		NativeWindow
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  renderMode : String -
[read-only] - - Reports the window renderMode setting used to create this window.
-		NativeWindow
  resizable : Boolean -
[read-only] - - Reports the resizable setting used to create this window.
-		NativeWindow
  stage : Stage -
[read-only] - - The Stage object for this window.
-		NativeWindow
  supportsMenu : Boolean -
[static][read-only] - - Indicates whether AIR supports native window menus on the current computer system.
-		NativeWindow
  supportsNotification : Boolean -
[static][read-only] - - Indicates whether AIR supports window notification cueing on the current computer system.
-		NativeWindow
  supportsTransparency : Boolean -
[static][read-only] - - Indicates whether AIR supports native windows with transparent pixels.
-		NativeWindow
  systemChrome : String -
[read-only] - - Reports the system chrome setting used to create this window.
-		NativeWindow
  systemMaxSize : Point -
[static][read-only] - - The largest window size allowed by the operating system.
-		NativeWindow
  systemMinSize : Point -
[static][read-only] - - The smallest window size allowed by the operating system.
-		NativeWindow
  title : String -
- - The window title.
-		NativeWindow
  transparent : Boolean -
[read-only] - - Reports the transparency setting used to create this window.
-		NativeWindow
  type : String -
[read-only] - - Reports the window type setting used to create this window.
-		NativeWindow
  visible : Boolean -
- - Specifies whether this window is visible.
-		NativeWindow
  width : Number -
- - The width of this window in pixels.
-		NativeWindow
  x : Number -
- - The horizontal axis coordinate of this window's top left corner relative to the - - origin of the operating system desktop.
-		NativeWindow
  y : Number -
- - The vertical axis coordinate of this window's top left corner relative to the - - upper left corner of the operating system's desktop.
-		NativeWindow
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NativeWindow(initOptions:NativeWindowInitOptions)
-
- - Creates a new NativeWindow instance and a corresponding operating system window.
-		NativeWindow
   -
-activate():void -
-
- - Activates this window.
-		NativeWindow
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-close():void -
-
- - Closes this window.
-		NativeWindow
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-globalToScreen(globalPoint:Point):Point -
-
- - Converts a point in pixel coordinates relative to the origin of the window stage - - (a global point in terms of the display list), to a point on the virtual desktop.
-		NativeWindow
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-listOwnedWindows():Vector.<NativeWindow>
-
- - Returns a list of the NativeWindow objects that are owned by this window.
-		NativeWindow
   -
-maximize():void -
-
- - Maximizes this window.
-		NativeWindow
   -
-minimize():void -
-
- - Minimizes this window.
-		NativeWindow
   -
-notifyUser(type:String):void -
-
- - Triggers a visual cue through the operating system that an event of - - interest has occurred.
-		NativeWindow
   -
-orderInBackOf(window:NativeWindow):Boolean -
-
- - Sends this window directly behind the specified window.
-		NativeWindow
   -
-orderInFrontOf(window:NativeWindow):Boolean -
-
- - Brings this window directly in front of the specified window.
-		NativeWindow
   -
-orderToBack():Boolean -
-
- - Sends this window behind any other visible windows.
-		NativeWindow
   -
-orderToFront():Boolean -
-
- - Brings this window in front of any other visible windows.
-		NativeWindow
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-resizeToScreen(target:Screen):void -
-
- - Move and resize this window to match the full size of the target Screen.
-		NativeWindow
   -
-restore():void -
-
- - Restores this window from either a minimized or a maximized state.
-		NativeWindow
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-startMove():Boolean -
-
- - Starts a system-controlled move of this window.
-		NativeWindow
   -
-startResize(edgeOrCorner:String = "BR"):Boolean -
-
- - Starts a system-controlled resize operation of this window.
-		NativeWindow
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
   -
-activate -
-		 - - Dispatched by this NativeWindow object after the window has been activated.NativeWindow
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-close -
-		 - - Dispatched by this NativeWindow object after the window has been closed.NativeWindow
   -
-closing -
-		 - - Dispatched by this NativeWindow object immediately before the window is to be closed.NativeWindow
   -
-deactivate -
-		 - - Dispatched by this NativeWindow object after the window has been deactivated.NativeWindow
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-displayStateChange -
-		 - - Dispatched by this NativeWindow object after the window's displayState property has changed.NativeWindow
   -
-displayStateChanging -
-		 - - Dispatched by this NativeWindow object immediately before the window changes its display state.NativeWindow
   -
-move -
-		 - - Dispatched by this NativeWindow object after the window has been moved on the desktop.NativeWindow
   -
-moving -
-		 - - Dispatched by the NativeWindow object immediately before the window is to be moved on - - the desktop.NativeWindow
   -
-resize -
-		 - - Dispatched by this NativeWindow object after the window has been resized.NativeWindow
   -
-resizing -
-		 - - Dispatched by this NativeWindow object immediately before the window is to be resized on - - the desktop.NativeWindow
-
- -
- -
Property detail
- - - - - -
activeproperty
-
-active:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether this window is the active application window. - - -

Use the activate() method to make a window active.

- - - - Implementation -
-    public function get active():Boolean -
-

-See also -

-
-flash.display.NativeWindow.activate() -
-flash.desktop.NativeApplication.activate() -
-
- - - - - -
alwaysInFrontproperty 
-
-alwaysInFront:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Specifies whether this window will always be in front of other windows (including - - those of other applications). - - -

There are two groups of windows in the system depth order. Windows in the - - alwaysInFront group are always displayed in front of all other - - windows. Depth ordering between windows within the same group is determined normally. - - In other words, activating a window will bring it in front of other windows - - in its group.

- - - -

Changing alwaysInFront from false to true will - - bring the window to the top of all other windows. Changing the property from true - - to false will send the window to the back of "alwaysInFront" windows, but still - - in front of other windows. Setting the property to its current value will not change the window - - depth order. Setting the alwaysInFront property of a window that has an owner - - has no effect.

- - - -

The alwaysInFront property should rarely be set to true since - - windows with this setting will appear in front of the windows of other applications - - even when the other application is active.

- - - -

OS behavior notes:

- -
    - -
  • Some Linux window managers do not display windows that have the alwaysInFront - - property set to in front of fullscreen windows.
    • - - - -
  • On Mac® OS X, setting alwaysInFront to true will - - have no effect when the displayState property of the window stage - - is fullScreen or fullScreenInteractive.
    • - -
- - - - Implementation -
-    public function get alwaysInFront():Boolean -
-    public function set alwaysInFront(value:Boolean):void -
-
-Example -
The following examples force a window to be displayed in front - of all other windows (that are not similarly forced to the front): -
-
-windowObj.alwaysInFront = true;
-
-

With a reference to a display object on the window stage: -
-
-displayObject.stage.nativeWindow.alwaysInFront=true;
-
-

From a JavaScript routine running in an HTMLLoader object in the - window (or a root HTML window): -
-
-window.nativeWindow.alwaysInFront = true;
-
-

-
- - - - - -
boundsproperty 
-
-bounds:Rectangle  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The size and location of this window. - -

- - The dimensions of a window include any system chrome. The dimensions of a window's stage are equal to the - - dimensions of the window, minus the size of any system chrome. Changing - - the width and height of the window will change the stage's stageWidth and stageHeight. - - The reverse also applies; changing the stage dimensions will change the window size. - -

- -

In a root HTML window, the outerWidth and outerHeight properties - - are equivalent to the window height and width properties. - - The innerWidth and innerHeight properties equal - - the stage.stageWidth and stage.stageHeight - - properties minus the thickness of any automatic scrollbars displayed - - by the window.

- -

- - A resize event is dispatched whenever the width or height of this window - - changes. Likewise, a move event is dispatched whenever the origin (x,y) of this window - - changes. On Mac OS and Windows, setting the bounds property directly will not - - dispatch a moving or resizing event. However, on Linux the NativeWindow - - does dispatch a moving and resizing events when you set - - the bounds property. - -

- -

- - Setting the bounds property of a window is equivalent to setting its - - x, y, width, and height properties. - - Likewise, setting any of the individual dimensions is equivalent to setting the - - bounds property. When you set all the dimensions at the same time by using the - - bounds property, fewer events are dispatched. - -

- -

The order in which the individual dimensions are set is not guaranteed. On Linux - - window managers that do not allow windows to extend off the desktop area, a change to an individual - - property may be blocked even though the net affect of applying all the property changes would - - have resulted in a legal window.

- - - -

If the width or height specified is less than the minimum or greater than the maximum allowed - - width or height, then the window width or height is set to the closest legal size. The factors that - - determine the minimum and maximum width and height are the following:

- - -
    - - -
  • The minSize and maxSize properties of the - - NativeWindow object
    • - -
  • The minimum and maximum operating system limits, which are the values of - - NativeWindow.systemMinSize and NativeWindow.systemMaxSize.
    • - -
  • The maximum width and height of a window in Adobe AIR, which are each 4095 pixels. - - (In AIR 1.5 and earlier, the maximum width and height of a window is 2880 pixels each.)
    • - -
  • The minimum width and height required by any displayed system chrome.
    • - - -
- - -

Pixel values are rounded to the nearest integer when the position or dimensions of - - a window are changed.

- - - - Implementation -
-    public function get bounds():Rectangle -
-    public function set bounds(value:Rectangle):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If the rectangle is null or contains invalid values. - -
 
Error — If the bounds property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowInitOptions.resizable -
-
-Example -
The following examples set the bounds of a window with a - reference to a NativeWindow object: -
-
-windowObj.bounds = new Rectangle(200, 200, 1000, 800);
-
-

With a reference to a display object on the window stage: -
-
-displayObject.stage.nativeWindow.bounds = new Rectangle(20, 20, 800, 600);
-
-

From a JavaScript routine running in an HTMLLoader object in the window (or a root HTML window): -
-
-window.nativeWindow.bounds = new air.Rectangle(20, 20, 800, 600);
-
-

-
- - - - - -
closedproperty 
-
-closed:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether this window has been closed. - - -

Accessing the following properties on a closed window will - - throw an illegal operation error:

- -
    - -
  • title
    • - -
  • bounds
    • - -
  • x, y, width, height
    • - -
  • displayState
    • - -
  • visible
    • - -
- -

Likewise, calling the following methods on a closed window will - - also throw an illegal operation error:

- -
    - -
  • minimize()
    • - -
  • maximize()
    • - -
  • restore()
    • - -
  • startResize()
    • - -
  • startMove()
    • - -
- - - - Implementation -
-    public function get closed():Boolean -
-
-Example -
The following examples show how to access the closed property - of a window: -
-
-var isWindowClosed:Boolean = windowObj.closed;
-
-

With a reference to a display object on the window stage: -
-
-var isWindowClosed:Boolean = displayObject.stage.nativeWindow.closed;
-
-

From a JavaScript routine running in an HTMLLoader object in the window - (or root HTML window): -
-
-var isWindowClosed = window.nativeWindow.closed;
-
-

-
- - - - - -
displayStateproperty 
-
-displayState:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The display state of this window. - -

- - Constants for the possible values are defined in the NativeWindowDisplayState class: - -

- -
    - -
  • NativeWindowDisplayState.NORMAL
    • - -
  • NativeWindowDisplayState.MINIMIZED
    • - -
  • NativeWindowDisplayState.MAXIMIZED
    • - -
- - - - Implementation -
-    public function get displayState():String -
-
-Throws -
- - - - -
Error — If the displayState property is accessed - - after this window has been closed. - -
-

-See also -

-
-flash.display.NativeWindowDisplayState -
-
-Example -
The following example shows how to get the current window - display state given a reference to the window object: -
-
-var state:String = windowObj.displayState;
-
-

-
- - - - - -
heightproperty 
-
-height:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The height of this window in pixels. - - -

The dimensions of a window include any system window chrome that is displayed. - - The height of the usable display area inside a window is available from the - - Stage.stageHeight property.

- - -

Changing the height property of a window is equivalent to changing the - - height through the bounds property.

- - - -

If the height specified is less than the minimum or greater than the maximum allowed height, - - then the window height is set to the closest legal size. The factors that determine the minimum - - and maximum height are the following:

- - -
    - - -
  • The minSize.x and maxSize.x properties of the - - NativeWindow object
    • - -
  • The minimum and maximum operating system limits, which are the values of - - NativeWindow.systemMinSize.x and NativeWindow.systemMaxSize.x.
    • - -
  • The maximum height of a window in Adobe AIR, which is 4095 pixels - - (2880 pixels in AIR 1.5 and earlier).
    • - - -
- - -

On Linux, setting the height property is an asynchronous operation.

- - - -

- - To detect the completion of the height change, listen for - - the resize event, which is dispatched on all platforms. - -

- - - -

Pixel values are rounded to the nearest integer when the height of - - a window is changed.

- - - - Implementation -
-    public function get height():Number -
-    public function set height(value:Number):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If the value set is null or invalid. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindow.bounds -
-flash.display.Stage.stageHeight -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.0 - -
-

- - Indicates whether native windows are supported on the client system. - - - -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
maximizableproperty 
-
-maximizable:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Reports the maximizable setting used to create this window. - - - -

The maximizable setting cannot be changed after a window is created.

- - - -

Note: Some Linux window managers allow windows to be maximized by the user even when the - - maximizable property is set to false.

- - - - Implementation -
-    public function get maximizable():Boolean -
-
-Throws -
- - - - - - - - - - -
SecurityError — When trying to set to false without sufficient privilege. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowInitOptions.maximizable -
-
- - - - - -
maxSizeproperty 
-
-maxSize:Point  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The maximum size for this window. - - - -

The size limit is specified as the coordinates of a Point object. - - The point x property corresponds to the window width, - - the y property to the window height.

- - -

- - The maxSize restriction is enforced for window resizing operations - - invoked both through ActionScript - - JavaScript code and through the operating system. - -

- -

- - Setting maxSize will change the window bounds if the - - current bounds are larger than the new maximum size. - -

- - -

If the width or height specified is greater than the maximum allowed width or height, - - then the window width is set to the closest legal size. The factors that determine the minimum - - and maximum width and height are the following:

- - -
    - - -
  • The maximum operating system limit, which is the value NativeWindow.systemMaxSize.
    • - -
  • The maximum width and height of a window in Adobe AIR, which is 4095 pixels for each. - - (In AIR 1.5 and earlier, the maximum width and height of a window is 2880 pixels each.)
    • - - -
- - -

- - Note: On some operating systems, such as Mac OS X, maximizing a window will only enlarge the window to the maxSize - - value even if the maximized window will be smaller than the operating system screen. The window will still be - - in the maximized display state. - -

- - - - Implementation -
-    public function get maxSize():Point -
-    public function set maxSize(value:Point):void -
-
-Throws -
- - - - - - - - - - - - - - - - - - - - - - -
Error — If assigned size is not within the - - operating system minimum and maximum window sizes. - -
 
SecurityError — If size is forbidden for the content's current privilege. - -
 
ArgumentError — If the size is null or contains invalid values. - -
 
Error — If the maxSize property is accessed after this window has been closed. - - -
-

-See also -

-
-flash.display.NativeWindow.systemMinSize -
-flash.display.NativeWindow.systemMaxSize -
-
-Example -
The following examples show how to set the maximum allowed - size for a window. -
-
-windowObj.maxSize = new Point(1040,920);
-
-

With a reference to a display object on the window stage: -
-
-displayObject.stage.nativeWindow.maxSize = new Point(800,600);
-
-

From a JavaScript routine running in an HTMLLoader object in a window - (or in a root HTML window): -
-
-window.nativeWindow.maxSize = new air.Point(960,960);
-
-

-
- - - - - -
menuproperty 
-
-menu:NativeMenu  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The native menu for this window. - - -

When a NativeMenu object is assigned to the window menu - - property, a native menu will be displayed for a window if - - NativeWindow.supportsMenu is true, unless the window - - systemChrome property is NativeWindowSystemChrome.NONE.

- - - -

Note: Assigning a menu to a window when NativeWindow.supportsMenu - - is false or when the window systemChrome property is - - NativeWindowSystemChrome.NONE is allowed, but does nothing. Be sure to - - use the NativeWindow.supportsMenu property to determine whether the - - operating system supports window menus. Using other means (such as Capabilities.os) - - to determine support can lead to programming errors (if some possible target operating systems - - are not considered).

- - - - Implementation -
-    public function get menu():NativeMenu -
-    public function set menu(value:NativeMenu):void -
-

-See also -

-
-flash.display.NativeWindow.supportsMenu -
-
- - - - - -
minimizableproperty 
-
-minimizable:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Reports the minimizable setting used to create this window. - - - -

The minimizable setting cannot be changed after a window is created.

- - - -

Note: Some Linux window managers allow windows to be minimizable by the user even when the - - minimizable property is set to false.

- - - - Implementation -
-    public function get minimizable():Boolean -
-
-Throws -
- - - - - - - - - - -
SecurityError — When trying to set to false without sufficient privilege. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowInitOptions.minimizable -
-
- - - - - -
minSizeproperty 
-
-minSize:Point  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The minimum size for this window. - - - -

The size limit is specified as the coordinates of a Point object. - - The point x property corresponds to the window width, - - the y property to the window height.

- -

- - Setting minSize, will change the window bounds if the - - current bounds are smaller than the new minimum size. - -

- -

- - The minSize restriction is enforced for window resizing operations - - invoked both through ActionScript - - JavaScript code and through the operating system. - -

- -

- - Note: The width and height of any displayed system chrome may - - make it impossible to set a window as small as the specified minimum size. - -

- - - - Implementation -
-    public function get minSize():Point -
-    public function set minSize(value:Point):void -
-
-Throws -
- - - - - - - - - - - - - - - - - - - - - - -
Error — If the assigned size is not within the - - operating system minimum and maximum window sizes. - -
 
SecurityError — If size is forbidden for the content's current privilege. - -
 
ArgumentError — If the size is null or contains invalid values. - -
 
Error — if the minSize property is accessed after this window has been closed. - - -
-

-See also -

-
-flash.display.NativeWindow.systemMinSize -
-flash.display.NativeWindow.systemMaxSize -
-
-Example -
The following examples show how to set the minimum allowed - size for a window: -
-
-windowObj.minSize = new Point(200,80);
-
-

With a reference to a display object on the window stage: -
-
-displayObject.stage.nativeWindow.minSize = new Point(120,60);
-
-

From a JavaScript routine running in an HTMLLoader object in a window - (or in a root HTML window): -
-
-window.nativeWindow.minSize = new air.Point(80,60);
-
-

-
- - - - - -
ownerproperty 
-
-owner:NativeWindow  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 - -
-

- - The NativeWindow object that owns this window. - - - -

Window ownership is established when a window is created and cannot be changed. - - To create a window that has an owner, set the owning NativeWindow object as the - - owner property of the NativeWindowInitOptions object used to create - - the owned window.

- - -

Note: On Linux, some window managers do not display owned windows in front of the - - owning window when the owner is in fullscreen mode.

- - - - Implementation -
-    public function get owner():NativeWindow -
-

-See also -

-
-flash.display.NativeWindowInitOptions.owner -
-
- - - - - -
renderModeproperty 
-
-renderMode:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Reports the window renderMode setting used to create this window. - - - -

The value returned by NativeWindow.renderMode will be - - one of the constants defined in the NativeWindowRenderMode class.

- - - -

The renderMode setting cannot be changed after a window is created.

- - - - Implementation -
-    public function get renderMode():String -
-
-Throws -
- - - - -
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowRenderMode -
-flash.display.NativeWindowInitOptions.renderMode -
-
- - - - - -
resizableproperty 
-
-resizable:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Reports the resizable setting used to create this window. - - - -

The resizable setting cannot be changed after a window is created.

- - - - Implementation -
-    public function get resizable():Boolean -
-
-Throws -
- - - - - - - - - - -
SecurityError — When trying to set to false without sufficient privilege. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowInitOptions.resizable -
-
- - - - - -
stageproperty 
-
-stage:Stage  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Stage object for this window. The - - Stage object is the root object in the display list architecture used in ActionScript - - 3.0-based SWF content. - - - -

- - The stage is the root of the display list for the window. Add visual display objects to a window by - - adding them to the stage or to another object already in the display list of this stage. The stage - - dimensions are those of the window client area when the window uses system chrome. The stage - - dimensions are equal to the dimensions of the window if system chrome is not used. - -

- - - -

The HTMLLoader, which renders HTML content, - - is a single leaf in the display list tree. ActionScript-defined display objects can be - - both above and below the HTMLLoader in the drawing order, but not - - in between the visual elements rendered by the HTMLLoader.

- - - - Implementation -
-    public function get stage():Stage -
-

-See also -

-
-flash.display.Stage -
-
-Example -
The following example shows how to set stage properties for a - NativeWindow instance: -
-
-import flash.display.StageAlign;
-
-windowObj.stage.align = StageAlign.TOP_LEFT;
-
-

-
- - - - - -
supportsMenuproperty 
-
-supportsMenu:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether AIR supports native window menus on the current computer system. - - - -

When NativeWindow.supportsMenu is true, - - a native menu will be displayed for a window when a NativeMenu - - object is assigned to the window menu property (unless the window - - systemChrome property is NativeWindowSystemChrome.NONE). - - Be sure to use the NativeWindow.supportsMenu property to determine whether the - - operating system native window menus. Using other means (such as Capabilities.os) - - to determine support can lead to programming errors (if some possible target operating systems - - are not considered).

- - - -

Note: Assigning a menu to a window when NativeWindow.supportsMenu - - is false or when the window systemChrome property is - - NativeWindowSystemChrome.NONE is allowed, but does nothing.

- - - - Implementation -
-    public static function get supportsMenu():Boolean -
-

-See also -

-
-flash.display.NativeMenu -
-flash.desktop.NativeApplication.supportsMenu -
-
- - - - - -
supportsNotificationproperty 
-
-supportsNotification:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether AIR supports window notification cueing on the current computer system. - - - -

When NativeWindow.supportsNotification is true, - - calling the window's notifyUser() method will result in a - - visual cue to the user that an event of interest has occurred. This visual - - cue will conform to the operating system convention of the native system. - - For example, on Windows®, the task bar icon will flash.

- - - -

Note: Calling notifyUser() when - - NativeWindow.supportsNotification is false - - is allowed, but does nothing.

- - - - Implementation -
-    public static function get supportsNotification():Boolean -
-

-See also -

-
-flash.display.NativeWindow.notifyUser() -
-
- - - - - -
supportsTransparencyproperty 
-
-supportsTransparency:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.1 - -
-

- - Indicates whether AIR supports native windows with transparent pixels. - - - -

When NativeWindow.supportsTransparency is true, - - transparency in pixels of a native window will be honored, if the window - - transparent property is set to true. Opacity of - - all pixels will be set to 1 if NativeWindow.supportsTransparency - - is false, regardless of the value of the window transparent - - property. Fully transparent pixels will render as black when - - NativeWindow.supportsTransparency is false. - - Be sure to use the NativeWindow.supportsTransparency property to determine whether the - - operating system supports transparency. Using other means (such as Capabilities.os) - - to determine support can lead to programming errors (if some possible target operating systems - - are not considered).

- - - -

Note: The value of this property might change while an application - - is running, based on user preferences set for the operating system.

- - - - Implementation -
-    public static function get supportsTransparency():Boolean -
-

-See also -

-
-flash.display.NativeWindow.transparent -
-
- - - - - -
systemChromeproperty 
-
-systemChrome:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Reports the system chrome setting used to create this window. - - - -

The values returned by NativeWindow.systemChrome will be - - one of the constants defined in the NativeWindowSystemChrome class.

- - - -

The system chrome setting cannot be changed after a window is created.

- - - - Implementation -
-    public function get systemChrome():String -
-
-Throws -
- - - - - - - - - - -
SecurityError — When trying to set to false without sufficient privilege. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowSystemChrome -
-flash.display.NativeWindowInitOptions.systemChrome -
-
-Example -
The following example shows how to get the system chrome type for a window: -
-
-var sysChromeType:String = windowObj.systemChrome;
-
-

With a reference to a display object on the window stage: -
-
-var sysChromeType:String = displayObject.stage.nativeWindow.systemChrome;
-
-

From a JavaScript routine running in an HTMLLoader object in the window - (or root HTML window): -
-
-var sysChromeType = window.nativeWindow.systemChrome;
-
-

The following example shows how to change the apparent - system chrome and transparency settings by creating a new window and moving all child - display objects to the new window: -
-
-import flash.display.NativeWindow;
-import flash.display.NativeWindowSystemChrome;
-import flash.display.NativeWindowInitOptions;
-
-public function deChromeWindow(oldWindow:NativeWindow):NativeWindow{
-    if(oldWindow.systemChrome != NativeWindowSystemChrome.NONE){
-		var newOptions:NativeWindowInitOptions = new NativeWindowInitOptions();
-		newOptions.systemChrome = NativeWindowSystemChrome.NONE;
-		newOptions.transparent = true;
-		
-		var newWindow:NativeWindow = new NativeWindow(newOptions);
-		newWindow.stage.stageWidth = oldWindow.stage.stageWidth;
-		newWindow.stage.stageHeight = oldWindow.stage.stageHeight;
-		newWindow.stage.align = oldWindow.stage.align;
-		newWindow.stage.scaleMode = oldWindow.stage.scaleMode;
-		
-		for(var i:int = 0; i < oldWindow.stage.numChildren; i++){
-			newWindow.stage.addChild(oldWindow.stage.getChildAt(i));
-		}
-		newWindow.activate();
-		oldWindow.close();
-		
-		return newWindow;
-	}
-	return oldWindow;
-}
-
-

-
- - - - - -
systemMaxSizeproperty 
-
-systemMaxSize:Point  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The largest window size allowed by the operating system. - - - -

The size limit is specified as the coordinates of a Point object. - - The point x property corresponds to the window width, - - the y property to the window height.

- - -

In addition to the operating system size limit, AIR has a maximum - - window size limit of 4095 by 4095 pixels (2880 pixels by 2880 pixels - - in AIR 1.5 and earlier). And an application can set - - a limit using the maxSize property of the NativeWindow object.

- - - - Implementation -
-    public static function get systemMaxSize():Point -
-
- - - - - -
systemMinSizeproperty 
-
-systemMinSize:Point  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The smallest window size allowed by the operating system. - - - -

The size limit is specified as the coordinates of a Point object. - - The point x property corresponds to the window width, - - the y property to the window height.

- - - - Implementation -
-    public static function get systemMinSize():Point -
-
- - - - - -
titleproperty 
-
-title:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The window title. - -

- - The title will appear in the system chrome for the window, if displayed, as well as in other system-dependent - - locations (such as the task bar). - -

- - - - Implementation -
-    public function get title():String -
-    public function set title(value:String):void -
-
-Throws -
- - - - -
Error — If the property is accessed after this window has been closed. - -
-
-Example -
The following example sets the title of a window object: -
-
-windowObj.title = "Window Title";
-
-

-
- - - - - -
transparentproperty 
-
-transparent:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Reports the transparency setting used to create this window. - - - -

The transparent property cannot be changed after a window is created. - - Transparency affects both the visual appearance and the mouse behavior of - - the window. On Windows and Mac OS X, the window will not capture mouse events when the alpha value - - of the pixel is below a certain threshold, which varies between about .06 and .01 depending on the operating - - system. On Linux, the the window will capture mouse events above completely transparent areas and - - therefore will prevent users from accessing other windows and items on the desktop.

- - - - - -

Note: Window transparency cannot always be supported. If the user's - - operating system configuration is such that transparency is not available, the - - window will be created without transparency. Areas that would have been transparent - - are composited against black. Use the NativeWindow.supportsTransparency - - property to determine whether window transparency is supported.

- - - - Implementation -
-    public function get transparent():Boolean -
-
-Throws -
- - - - - - - - - - -
SecurityError — When trying to set to false without sufficient privilege. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowInitOptions.transparent -
-
- - - - - -
typeproperty 
-
-type:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Reports the window type setting used to create this window. - - - -

The values returned by NativeWindow.type will be - - one of the constants defined in the NativeWindowType class.

- - - -

The type setting cannot be changed after a window is created.

- - - - Implementation -
-    public function get type():String -
-
-Throws -
- - - - - - - - - - -
SecurityError — When trying to set to false without sufficient privilege. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowType -
-flash.display.NativeWindowInitOptions.type -
-
- - - - - -
visibleproperty 
-
-visible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Specifies whether this window is visible. - - - -

- - An invisible window is not displayed on the desktop, but all window - - properties and methods are valid. - -

- -

- - By default, visible is set to false. To display - - a window, set visible to true or call - - NativeWindow.activate(). - -

- -

If this window has an owner, the visible state of that owning window determines - - whether this window is displayed. If the owning window is not displayed, then - - any owned windows are not displayed, even if their visible properties - - are true.

- -

- - Note: On Mac OS X, setting visible=false on a - - minimized window will not remove the window icon from the dock. If a - - user subsequently clicks the dock icon, the window will return to the - - visible state and be displayed on the desktop. - -

- - - - Implementation -
-    public function get visible():Boolean -
-    public function set visible(value:Boolean):void -
-
-Throws -
- - - - - - - - - - -
SecurityError — When trying to set to false without sufficient privilege. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-activate() -
-
-Example -
The following examples show how to access the visible property - of a window: -
-
-windowObj.visible = true;
-
-

With a reference to a display object on the window stage: -
-
-displayObj.stage.nativeWindow.visible = true;
-
-

From a JavaScript routine running in an HTMLLoader object in the window - (or root HTML window): -
-
-window.nativeWindow.visible = true;
-
-

-
- - - - - -
widthproperty 
-
-width:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The width of this window in pixels. - - -

The dimensions reported for a native window include any system window chrome - - that is displayed. - - The width of the usable display area inside a window is available from the - - Stage.stageWidth property.

- - -

Changing the width property of a window is equivalent to changing the - - width through the bounds property.

- - - -

If the width specified is less than the minimum or greater than the maximum allowed width, - - then the window width is set to the closest legal size. The factors that determine the minimum - - and maximum width are the following:

- - -
    - - -
  • The minSize.y and maxSize.y properties of the - - NativeWindow object
    • - -
  • The minimum and maximum operating system limits, which are the values of - - NativeWindow.systemMinSize.y and NativeWindow.systemMaxSize.y.
    • - -
  • The maximum width of a window in Adobe AIR, which is 4095 pixels - - (2880 pixels in AIR 1.5 and earlier).
    • - - -
- - -

On Linux, setting the width property is an asynchronous operation.

- - - -

- - To detect the completion of the width change, listen for - - the resize event, which is dispatched on all platforms. - -

- - - -

Pixel values are rounded to the nearest integer when the width of - - a window is changed.

- - - - Implementation -
-    public function get width():Number -
-    public function set width(value:Number):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If the value set is null or invalid. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindow.bounds -
-flash.display.Stage.stageWidth -
-
- - - - - -
xproperty 
-
-x:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The horizontal axis coordinate of this window's top left corner relative to the - - origin of the operating system desktop. - - - -

On systems with more than one monitor, x can be negative. If you - - save the value, perhaps to reposition a window at its previous location, you - - should always verify that the window is placed in a usable location when the - - position is restored. Changes in screen resolution or monitor arrangement can - - can result in a window being placed off screen. Use the Screen class to obtain - - information about the desktop geometry.

- - - -

Changing the x property of a window is equivalent to changing the - - location through the bounds property.

- - -

On Linux, setting the x property is an asynchronous operation.

- - - -

- - To detect the completion of the position change, listen for - - the move event, which is dispatched on all platforms. - -

- - - -

Pixel values are rounded to the nearest integer when the x-coordinate of - - a window is changed.

- - - - Implementation -
-    public function get x():Number -
-    public function set x(value:Number):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If the value set is null or invalid. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindow.bounds -
-flash.display.Screen -
-
- - - - - -
yproperty 
-
-y:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The vertical axis coordinate of this window's top left corner relative to the - - upper left corner of the operating system's desktop. - - - -

On systems with more than one monitor, y can be negative. If you - - save the value, perhaps to reposition a window at its previous location, you - - should always verify that the window is placed in a usable location when the - - position is restored. Changes in screen resolution or monitor arrangement can - - can result in a window being placed off screen. Use the Screen class to obtain - - information about the desktop geometry.

- - - -

Changing the y property of a window is equivalent to changing the - - location through the bounds property.

- - -

On Linux, setting the y property is an asynchronous operation.

- - - -

- - To detect the completion of the position change, listen for - - the move event, which is dispatched on all platforms. - -

- - - -

Pixel values are rounded to the nearest integer when the y-coordinate of - - a window is changed.

- - - - Implementation -
-    public function get y():Number -
-    public function set y(value:Number):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If the value set is null or invalid. - -
 
Error — If the property is accessed after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindow.bounds -
-flash.display.Screen -
-
- -
Constructor detail
- - - - - -
NativeWindow()constructor
-
-public function NativeWindow(initOptions:NativeWindowInitOptions) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new NativeWindow instance and a corresponding operating system window. - -

- - The settings defined in the initOptions parameter cannot be changed after the - - window is created. Invalid initOptions settings will cause an illegal operation error - - to be thrown. Settings that are valid but not available on the current system will not throw an exception. - - The window capabilities specific to the current operating system can be - - detected, if desired, using the static NativeWindow members - - such as systemMaxSize. - -

- - - -

The default window size is determined by the operating system, and windows are created in an invisible state. - - To prevent changes to the window from being visible, do not change the - - window visible property to true or call activate() until the - - window changes are finished.

- - - - Parameters - - - - -
initOptions:NativeWindowInitOptions — An object containing the initialization properties for this window. - -
-
-Throws - - - - - - - - - - -
Error — If the initOptions parameter is invalid. - -
 
Error — If an attempt is made to create a new NativeWindow on a mobile operating system. - - - -
-

-See also -

-
-flash.display.NativeWindowInitOptions -
-
-Example -
The following example creates and activates a new NativeWindow instance: -
-
-import flash.display.NativeWindowInitOptions;
-import flash.display.NativeWindowSystemChrome;
-import flash.display.NativeWindowType;
-import flash.display.NativeWindow;
-import flash.display.StageAlign;
-import flash.display.StageScaleMode;
-import flash.geom.Rectangle;
-
-var windowOptions:NativeWindowInitOptions = new NativeWindowInitOptions();
-windowOptions.systemChrome = NativeWindowSystemChrome.STANDARD;
-windowOptions.type = NativeWindowType.NORMAL;
-
-var newWindow:NativeWindow = new NativeWindow(windowOptions);
-newWindow.stage.scaleMode = StageScaleMode.NO_SCALE;
-newWindow.stage.align = StageAlign.TOP_LEFT;
-newWindow.bounds = new Rectangle(100, 100, 800, 800);
-
-newWindow.activate();
-
-

-
- -
Method detail
- - - - - -
activate()method
-
-public function activate():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Activates this window. - - - -

Activating a window will:

- -
    - -
  • Make the window visible
    • - -
  • Bring the window to the front
    • - -
  • Give the window keyboard and mouse focus
    • - -
- - - -

On Linux, activate() is an asynchronous operation.

- - - -

The NativeWindow object dispatches an activate event on all platforms.

- - - -

-See also -

-
-visible -
-orderToFront() -
-
-Example -
The following examples show how to activate a window. - -

With a reference to a display object on the window stage:

-
-
-displayObject.stage.nativeWindow.activate();
-
-

With a reference to an instance of the NativeWindow class: -
-
-windowObj.activate();
-
-

From JavaScript in an HTML page rendered in the window - (where window is the global JavaScript window object): -
-
-window.nativeWindow.activate();
-
-

-
- - - - - -
close()method 
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Closes this window. - - - -

A close event is dispatched as soon as the close operation is complete. - - A closing event will not be dispatched. If cancellation of the close operation should - - be allowed, dispatch a closing event and check whether any registered listeners cancel - - the default behavior before calling the close() method. - -

- -

When a window is closed, any windows that it owns are also closed. The owned windows - - do not dispatch closing events.

- -

- - If display object instances that are currently in the window are not referenced elsewhere - - they will be garbage collected and destroyed, except on the initial application window - - created by AIR. To allow display objects on the initial window to be garbage collected, - - remove them from the window stage. - -

- -

- - After being closed, the NativeWindow object is still a valid reference, but accessing most - - properties and methods will throw an illegal operation error. - -

- -

- - Closed windows cannot be reopened. If the window is already closed, no action is taken and - - no events are dispatched. - -

- - - -

Note: to hide a window without closing it, set the window's visible property to - - false. - -

- - - -

-See also -

-
-flash.display.NativeWindow.closed -
-flash.html.HTMLLoader -
-flash.html.HTMLHost -
-
-Example -
The following examples show how to close a window: - -

With a reference to the NativeWindow instance (windowObj):

-
-
-windowObj.close();
-
-

With a reference to a display object on the window stage: -
-
-displayObj.stage.nativeWindow.close();
-
-

From a JavaScript routine running in an HTMLLoader object - (or HTML root window): -
-
-window.close(); //overriddable in HTMLHost
-
-

Or: -
-
-window.nativeWindow.close(); //not overriddable
-
-

- - The following example illustrates how to allow cancellation of a close operation - (where windowObj is the NativeWindow instance to be closed): -
-
-public function closeCommand():Boolean{
-    var closeEvent:Event = new Event(Event.CLOSING,true,true);
-    windowObj.dispatchEvent(closeEvent);
-    if(!closeEvent.isDefaultPrevented()){
-        windowObj.close();
-        return true;
-    } else {
-      return false;
-    }
-}
-
-

The following example illustrates how to close a window from a - JavaScript routine running in an HTMLLoader object (or HTML root window), while - allowing the operation to be canceled: -
-
-<script src="AIRAliases.js" type="text/javascript"></script>
-<script type="text/javascript">
-    var dirtyData = false;
-	function closeWindow(){
-			var closingEvent = new air.Event(air.Event.CLOSING,true,true);
-    		window.nativeWindow.dispatchEvent(closingEvent);
-   			if(!closingEvent.isDefaultPrevented()){
-       			window.nativeWindow.close();
-				//or use: window.close(); 
-       		return true;
-   		} else {
-	   		return false;
-    	}
-	}
-		
-	function onClosing(event){
-		if(dirtyData){
-			event.preventDefault();
-			//Save data...
-		}
-	}	
-
-	window.nativeWindow.addEventListener(air.Event.CLOSING,onClosing);		
-</script>
-
-

-
- - - - - -
globalToScreen()method 
-
-public function globalToScreen(globalPoint:Point):Point -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Converts a point in pixel coordinates relative to the origin of the window stage - - (a global point in terms of the display list), to a point on the virtual desktop. - - - -

Virtual desktop coordinates are relative to the upper, lefthand corner of the primary - - monitor.

- - - Parameters - - - - -
globalPoint:Point — The point on the stage to convert to a point on the screen. - -
-

-Returns - - - - -
Point — - The specified global point relative to the desktop. - - - - -
-

-See also -

-
-flash.display.Screen -
-
- - - - - -
listOwnedWindows()method 
-
-public function listOwnedWindows():Vector.<NativeWindow> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 - -
-

- - Returns a list of the NativeWindow objects that are owned by this window. - - -

You cannot change ownership of NativeWindows by adding or removing objects from - - the returned vector. Window ownership cannot be changed after a window is created.

- - -

-Returns - - - - -
Vector.<NativeWindow> — an Vector.<NativeWindow> object containing zero or more NativeWindow objects that - - are owned by this instance. - - -
-

-See also -

-
-flash.display.NativeWindowInitOptions.owner -
-
- - - - - -
maximize()method 
-
-public function maximize():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Maximizes this window. - -

- - Calling maximize() method dispatches a displayStateChange - - event, and, if applicable, a move and a resize event. - - Whereas system chrome will dispatch a displayStateChanging event - - that can be canceled when a maximize command is initiated by a user, your maximize - - logic must implement this behavior, if desired. - -

- -

- - The maximize() method executes asynchronously. To detect the completion - - of the state change, listen for the displayStateChange event. If the window - - is already maximized, no action is taken and no events are dispatched.

- - - -

OS behavior notes:

- -
    - -
  • On operating systems, such as Mac OS X, in which maximizing - - a window does not also prevent resizing, calling maximize() will zoom the window - - to fill the screen, but will not prevent subsequent resizing of the window. - - Resizing a zoomed window will also restore the display state.
    • - - - -
  • On some operating systems, such as Mac OS X, as well as on some Linux window managers, - - maximizing a window will not expand the window beyond - - the width and height specified in the maxSize property. On others, the window will expand - - to fill the screen even if the screen is larger than the maxSize.
    • - - - -
  • Some Linux window managers do not allow utility windows to be maximized.
    • - - - -
- - -
-Throws - - - - -
Error — If this method is called after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowDisplayState -
-flash.events.NativeWindowDisplayStateEvent -
-
-Example -
- - The following example illustrates how to allow cancelation of a maximize operation: -
-
-public function maximizeWindow(nativeWin:NativeWindow):Boolean{
-  if(nativeWin.displayState != NativeWindowDisplayState.MAXIMIZED){
-    var beforeState:String = nativeWin.displayState;
-    var afterState:String = NativeWindowDisplayState.MAXIMIZED;
-    var displayStateEvent:NativeWindowDisplayStateEvent = 
-	    new NativeWindowDisplayStateEvent(NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
-	                                          true,true,beforeState,afterState);
-	nativeWin.dispatchEvent(displayStateEvent);
-	if(!displayStateEvent.isDefaultPrevented()){
-	    nativeWin.maximize();
-	    return true;
-	} else {
-	  return false;
-	}
-  }
-  return false;
-}
-
-

- - The following example illustrates how to allow cancelation of a maximize operation - from a JavaScript routine running in an HTMLLoader object on the window (or an HTML window): -
-
-function maximizeWindow(nativeWin){
-    if(nativeWin.displayState != air.NativeWindowDisplayState.MAXIMIZED){
-	    var beforeState = nativeWin.displayState;
-	    var afterState = air.NativeWindowDisplayState.MAXIMIZED;
-	    var displayStateEvent = 
-	        new air.NativeWindowDisplayStateEvent(air.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
-	                                          true,true,beforeState,afterState);
-	    nativeWin.dispatchEvent(displayStateEvent);
-	    if(!displayStateEvent.isDefaultPrevented()){
-	        nativeWin.maximize();
-	        return true;
-	    } else {
-	      return false;
-	    }
- 	}
- 	return false;
-}
-
-

-
- - - - - -
minimize()method 
-
-public function minimize():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Minimizes this window. - -

- - Calling minimize() dispatches a displayStateChange event, - - and, if applicable, a move and a resize event. - - Whereas system chrome will dispatch a displayStateChanging event - - that can be canceled when a minimize command is initiated by a user, - - calling minimize() directly does not. Your minimize logic may - - implement this behavior, if desired. - -

- - -

The minimize() method executes asynchronously. To detect the completion - - of the state change, listen for the displayStateChange event, which is dispatched on all platforms. - - If the window is already minimized, no action is taken and no events are dispatched.

- - - -

Any windows owned by this window are hidden when it is minimized. The owned windows do not dispatch - - displayStateChanging or displayStateChange events.

- - - -

Notes:

- -
    - -
  • On Windows, minimizing an invisible window (visible == false), will make the - - window visible.
    • - -
  • Some Linux window managers - - do not allow utility windows to be minimized.
    • - -
- -
-Throws - - - - -
Error — If this method is called after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowDisplayState -
-flash.events.NativeWindowDisplayStateEvent -
-
-Example -
- The following example illustrates how to allow cancelation of a call to - minimize() by dispatching a displayStateChanging event: -
-
-public function minimizeWindow(nativeWin:NativeWindow):Boolean{
-    if(nativeWin.displayState != NativeWindowDisplayState.MINIMIZED){
-	    var beforeState:String = nativeWin.displayState;
-	    var afterState:String = NativeWindowDisplayState.MINIMIZED;
-	    var displayStateEvent:NativeWindowDisplayStateEvent = 
-	        new NativeWindowDisplayStateEvent(NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
-	                                          true,true,beforeState,afterState);
-	    nativeWin.dispatchEvent(displayStateEvent);
-	    if(!displayStateEvent.isDefaultPrevented()){
-	        nativeWin.minimize();
-	        return true;
-	    } else {
-	      return false;
-	    }
- 	}
- 	return false;
-}
-
-

- The following example illustrates how to allow cancelation of a call to - minimize() in JavaScript running in an HTMLLoader object (or HTML window): -
-
 
-function minimizeWindow(){
-    if(window.nativeWindow.displayState != air.NativeWindowDisplayState.MINIMIZED){
-	    var beforeState = window.nativeWindow.displayState;
-	    var afterState = air.NativeWindowDisplayState.MINIMIZED;
-	    var displayStateEvent = 
-	        new air.NativeWindowDisplayStateEvent(air.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
-	                                          true,true,beforeState,afterState);
-	    window.nativeWindow.dispatchEvent(displayStateEvent);
-	    if(!displayStateEvent.isDefaultPrevented()){
-	        window.nativeWindow.minimize();
-	        return true;
-	    } else {
-	      return false;
-	    }
- 	}
- 	return false;
-}
-
-

-
- - - - - -
notifyUser()method 
-
-public function notifyUser(type:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Triggers a visual cue through the operating system that an event of - - interest has occurred. - - - -

When NativeWindow.supportsNotification is true, - - the visual cue will conform to the operating system convention of the - - native system. For example, on Windows, the task bar icon will flash.

- - - -

The type parameter determines the intensity of the cue. - - Constants for the permitted values are defined in the NotificationType - - class, and may be:

- -
    - -
  • NotificationType.INFORMATIONAL
    • - -
  • NotificationType.CRITICAL
    • - -
- -

The cues provided for informational notifications are of short duration; - - those provided for critical notifications will last until the user activates - - this window. Not all Linux window managers support two levels of notification. - - For such window managers, notifyUser() will have the same affect - - no matter which option is specified.

- - - -

Note: Calling notifyUser() when - - NativeWindow.supportsNotification is false - - is allowed, but does nothing.

- - - - Parameters - - - - -
type:String — A string representing the urgency of the notification. - -
-
- - - - - -
orderInBackOf()method 
-
-public function orderInBackOf(window:NativeWindow):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Sends this window directly behind the specified window. - - - -

Does not activate or acquire the focus for the window or the application. - - Minimized or hidden (visible is false) windows cannot be - - reordered.

- - - -

An owned window can never be moved behind its owner. If this window has an owner, - - then the owner and its other owned windows are also ordered behind the target. If the target - - window has an owner, then this window is ordered behind the owner of the target instead.

- - - -

Some Linux window managers do not allow utility windows to be ordered behind normal windows.

- - - - Parameters - - - - -
window:NativeWindow — An application window. - - - -
-

-Returns - - - - -
Boolean — - true if this window was successfully sent to the - - back; false if this window is invisible or minimized. - - - - - -
-
-Example -
The following examples show how to move a window just below another - window with references to the NativeWindow instances: -
-
-windowBehind.orderInBackOf(windowFront);
-
-

With references to display objects on the window stages: -
-
-displayObjBehind.stage.nativeWindow.orderInBackOf(displayObjectFront.stage.nativeWindow);
-
-

From a JavaScript routine running in an HTMLLoader object (or HTML root window) - using references to two JavaScript Window objects: -
-
-jsWindowObjBehind.nativeWindow.orderInBackOf(jsWindowObjFront.nativeWindow);
-
-

-
- - - - - -
orderInFrontOf()method 
-
-public function orderInFrontOf(window:NativeWindow):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Brings this window directly in front of the specified window. - - - -

Does not activate or acquire the focus for the window or the application. - - Minimized or hidden (visible is false) windows cannot be - - reordered.

- - - -

A window can never be moved in front of a window that it owns. If this window has an owner, - - then the owner and its other owned windows are also ordered in front of the target. If the target - - window has an owner, then this window is also ordered in front of any other windows that have the - - same owner as the target.

- - - -

Some Linux window managers do not allow normal windows to be ordered in front of utility windows.

- - - - Parameters - - - - -
window:NativeWindow — An application window. - - - -
-

-Returns - - - - -
Boolean — - true if this window was successfully brought to the - - front; false if this window is invisible or minimized. - - - - - -
-
-Example -
The following examples show how to move a window just above another - window with references to the NativeWindow instances: -
-
-windowFront.orderInFrontOf(windowBehind);
-
-

With references to display objects on the window stages: -
-
-displayObjFront.stage.nativeWindow.orderInFrontOf(displayObjectBehind.stage.nativeWindow);
-
-

From a JavaScript routine running in an HTMLLoader object (or HTML root window) - using references to two JavaScript window objects: -
-
-jsWindowObjFront.nativeWindow.orderInFrontOf(jsWindowObjBehind.nativeWindow);
-
-

-
- - - - - -
orderToBack()method 
-
-public function orderToBack():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Sends this window behind any other visible windows. - - - -

Does not activate or acquire the focus for this window or the application. - - Minimized or hidden (visible is false) windows cannot be - - reordered.

- - - -

If alwaysInFront is true, then calling this method will not - - send this window behind any windows which have - - alwaysInFront set to false.

- - -

An owned window can never be moved behind its owner. If this window has an owner, - - then the owner and its other owned windows are also ordered to the bottom of window display list. - - This window will move behind any other windows owned by the same window. If this window owns other - - windows, then those windows are also moved to the back, maintaining their current order - - relative to each other.

- - - -

Some Linux window managers do not allow utility windows to be ordered behind normal windows.

- - - -

-Returns - - - - -
Boolean — - true if this window was successfully sent to the - - back; false if this window is invisible or minimized. - - - - - -
-
-Example -
The following examples show how to move a window behind all other - windows in the application (with the same alwaysInFront setting): -
-
-windowObj.orderToBack();
-
-

With a reference to a display object on the window stage: -
-
-displayObj.stage.nativeWindow.orderToBack();
-
-

From a JavaScript routine running in an HTMLLoader object in the window - (or a root HTML window): -
-
-window.nativeWindow.orderToBack();
-
-

-
- - - - - -
orderToFront()method 
-
-public function orderToFront():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Brings this window in front of any other visible windows. - - - -

Does not activate or acquire the focus for this window or the application. - - Minimized or hidden (visible is false) windows cannot be - - reordered.

- - - -

If alwaysInFront is false, then calling this method will not - - send this window in front of any windows which have - - alwaysInFront set to true.

- - - -

A window can never be moved in front of a window that it owns. If this window owns other - - windows, then those windows are also moved to the front, maintaining their current order - - relative to each other. If this window has an owner, - - then the owner and its other owned windows are also ordered to the front of the window display order. - - This window is moved in front of other windows that have the same owner.

- - - -

Some Linux window managers do not allow normal windows to be ordered in front of utility windows.

- - - -

-Returns - - - - -
Boolean — - true if this window was successfully brought to the - - front; false if this window is invisible or minimized. - - - - - -
-
-Example -
The following examples show how to move a window in front of all other - windows in the application (with the same alwaysInFront setting): -
-
-windowObj.orderToFront();
-
-

With a reference to a display object on the window stage: -
-
-displayObj.stage.nativeWindow.orderToFront();
-
-

From a JavaScript routine running in an HTMLLoader object in the window - (or a root HTML window): -
-
-window.nativeWindow.orderToFront();
-
-

-
- - - - - -
resizeToScreen()method 
-
-public function resizeToScreen(target:Screen):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Move and resize this window to match the full size of the target Screen. - - -

This method is a utility that first moves the NativeWindow object - - onto the target screen, and then resizes it (taking account of any scaling) so that - - it covers the full screen area.

- - -

Note: This does not put the window/stage into the FULL_SCREEN display state.

- - - Parameters - - - - -
target:Screen
-

-See also -

-
-flash.display.Screen -
-
- - - - - -
restore()method 
-
-public function restore():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Restores this window from either a minimized or a maximized state. - - - -

Calling restore() dispatches a displayStateChange event, - - and, if applicable, a move and a resize event. - - Whereas system chrome will dispatch a displayStateChanging event that can - - be canceled when a restore command is initiated by a user, your restore logic must - - implement this behavior, if desired. - -

- - - -

If the window is already in the NativeWindowDisplayState.NORMAL state, - - no action is taken and no events are dispatched.

- - - -

- - To detect the completion of the state change, listen for - - the displayStateChange event, which is dispatched on all platforms. - -

- - - -
-Throws - - - - -
Error — If the method is called after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowDisplayState -
-flash.events.NativeWindowDisplayStateEvent -
-
-Example -
- - The following example illustrates how to allow cancelation of a restore operation: -
-
-public function restoreWindow(nativeWin:NativeWindow):Boolean{
-    if(nativeWin.displayState != NativeWindowDisplayState.NORMAL){
-	    var beforeState:String = nativeWin.displayState;
-	    var afterState:String = NativeWindowDisplayState.NORMAL;
-	    var displayStateChangingEvent:NativeWindowDisplayStateEvent = 
-	        new NativeWindowDisplayStateEvent(NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
-	                                          true,true,beforeState,afterState);
-	    nativeWin.dispatchEvent(displayStateChangingEvent);
-	    if(!displayStateChangingEvent.isDefaultPrevented()){
-	        nativeWin.restore();
-	        return true;
-	    } else {
-	      return false;
-	    }
- 	}
- 	return false;
-}
-
-

- The following example illustrates how to allow cancelation of a restore operation from - a JavaScript routine running in an HTMLLoader object on the window (or an HTML window): -
-
-function restoreWindow(nativeWin){
-    if(window.nativeWindow.displayState != air.NativeWindowDisplayState.NORMAL){
-	    var beforeState = window.nativeWindow.displayState;
-	    var afterState = air.NativeWindowDisplayState.NORMAL;
-	    var displayStateEvent = 
-	        new air.NativeWindowDisplayStateEvent(air.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING,
-	                                          true,true,beforeState,afterState);
-	    window.nativeWindow.dispatchEvent(displayStateEvent);
-	    if(!displayStateEvent.isDefaultPrevented()){
-	        window.nativeWindow.restore();
-	        return true;
-	    } else {
-	      return false;
-	    }
- 	}
- 	return false;
-}
-
-

-
- - - - - -
startMove()method 
-
-public function startMove():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Starts a system-controlled move of this window. - -

- - When called from a mouseDown event, this method begins a mouse-driven move - - sequence that continues until a mouseUp event occurs. - -

- -

- - When called from other code this method begins a keyboard- or mouse-driven move sequence - - consistent with the operating system's default sequence. - -

- - - -

During a move sequence, a series of events will be dispatched as the window origin moves. For - - each incremental move, first a moving event is dispatched and then, if the - - moving event is not canceled, the window location is updated and a - - move event is dispatched. If a moving event is - - canceled, the move sequence is immediately terminated.

- - - -

-Returns - - - - -
Boolean — - true if the move was successfully initiated and - - false if the window is maximized. - - - -
-
-Throws - - - - -
Error — If the method is called after this window has been closed. - - - -
-
-Example -
The following example shows how to move a window in response to a - mouseDown event: -
-
-var initOpts:NativeWindowInitOptions = new NativeWindowInitOptions();
-var win:NativeWindow = new NativeWindow(initOpts);
-win.activate();
-win.stage.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
-
-function mouseDownHandler(event:MouseEvent):void
-{
-    win.startMove();
-}
-
-

-
- - - - - -
startResize()method 
-
-public function startResize(edgeOrCorner:String = "BR"):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Starts a system-controlled resize operation of this window. - -

- - When called from a mouseDown event handler this method begins a mouse-driven resizing - - sequence that continues until a mouseUp event occurs. - -

- -

- - When called from other code this method begins a keyboard- or mouse-driven resizing sequence consistent - - with the operating system's default sequence. - -

- -

During the resize sequence, a series of events will be dispatched as the - - window dimensions change. For each incremental change, first a resizing - - event is dispatched and then, if the resizing event is not - - canceled, the window dimensions are updated and a resize event is dispatched. - - If a resizing event is canceled, the the sequence is immediately terminated.

- - - - Parameters - - - - -
edgeOrCorner:String (default = "BR") — A constant from the NativeWindowResize class that specifies - - which edge or corner of this window to resize. The following are - - valid values: - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ValueVertical alignmentHorizontal alignment
NativeWindowResize.TOPTopCenter
NativeWindowResize.BOTTOMBottomCenter
NativeWindowResize.LEFTCenterLeft
NativeWindowResize.RIGHTCenterRight
NativeWindowResize.TOP_LEFTTopLeft
NativeWindowResize.TOP_RIGHTTopRight
NativeWindowResize.BOTTOM_LEFTBottomLeft
NativeWindowResize.BOTTOM_RIGHTBottomRight
NativeWindowResize.NONE----
- -

- - - -
-

-Returns - - - - -
Boolean — - true if the resize was successfully initiated and - - false if the window is maximized. - - - - - -
-
-Throws - - - - -
Error — If the method is called after this window has been closed. - - - -
-

-See also -

-
-flash.display.NativeWindowResize -
-
-Example -
The following example shows how to resize a window in response to a - mouseDown event: -
-
-stage.addEventListener(MouseEvent.MOUSE_DOWN, onResizeCommand);
-
-function onResizeCommand(event:MouseEvent):void
-{
-    var win:NativeWindow = event.target.nativeWindow;
-	var resizeFrom:String = "";
-	if (event.stageY < win.height * .33)
-	{
-		resizeFrom = NativeWindowResize.TOP;
-	}
-	else if (event.stageY > win.height * .66)
-	{
-		resizeFrom = NativeWindowResize.BOTTOM;
-	}
-	if (event.stageX < win.width * .33)
-	{
-		resizeFrom += NativeWindowResize.LEFT;
-	}
-	else if (event.stageX > win.width * .66)
-	{
-		resizeFrom += NativeWindowResize.RIGHT;
-	}
-	win.startResize(resizeFrom);	
-}
-
-

-
-
Event detail
- - - - - -
activateevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.ACTIVATE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeWindow object after the window has been activated. - - - -

- The ACTIVATE constant defines the value of the type property of an activate event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the activate event.
- -
- - - - - -
closeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLOSE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeWindow object after the window has been closed. - - -

- The Event.CLOSE constant defines the value of the type property of a close event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection has been closed.
- -
- - - - - -
closingevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLOSING -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeWindow object immediately before the window is to be closed. - - This event can be canceled to prevent the window from being closed. - - -

- The Event.CLOSING constant defines the value of the - type property of a closing event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelabletrue; canceling this event object stops the close operation.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection is to be closed.
- -
- - - - - -
deactivateevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.DEACTIVATE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeWindow object after the window has been deactivated. - - -

- The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the deactivate event.
- -
- - - - - -
displayStateChangeevent  
-
-Event object type: flash.events.NativeWindowDisplayStateEvent -
-NativeWindowDisplayStateEvent.type property = flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeWindow object after the window's displayState property has changed. - - -

Do not resize the window or change its display state in the displayStateChange - - event handler.

- - -

- Defines the value of the type property of a displayStateChange event object. -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterDisplayStateThe old display state of the window.
beforeDisplayStateThe new display state of the window.
targetThe NativeWindow instance that has just changed state. -
bubblesNo.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelablefalse; There is no default behavior to cancel.
- -
- - - - - -
displayStateChangingevent  
-
-Event object type: flash.events.NativeWindowDisplayStateEvent -
-NativeWindowDisplayStateEvent.type property = flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeWindow object immediately before the window changes its display state. - - This event can be canceled to prevent the change. - - - -

- Defines the value of the type property of a displayStateChanging event object. - -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterDisplayStateThe display state of the window before the pending change.
beforeDisplayStateThe display state of the window after the pending change.
targetThe NativeWindow instance that has just changed state. -
bubblesNo.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelabletrue; canceling the event will prevent the change.
- -
-Example -
- The following example demonstrates how to cancel a displayStateChanging event. -
-
-function displayStateChanging_handler(displayStateEvent:NativeWindowDisplayStateEvent):void
-{
-  //shouldStopStateChange is an application-defined Boolean indicating 
-  //that display state changes should be canceled
-  if (displayStateEvent.type == NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING 
-      							&&	shouldStopStateChange)
-  {
-    displayStateEvent.preventDefault();
-  }
-}
-
-

-
- - - - - -
moveevent  
-
-Event object type: flash.events.NativeWindowBoundsEvent -
-NativeWindowBoundsEvent.type property = flash.events.NativeWindowBoundsEvent.MOVE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeWindow object after the window has been moved on the desktop. - -

- - A move event is dispatched whenever the origin (x or y properties) of the window - - changes, which can occur because of a system-controlled window move; minimizing, maximizing, - - or restoring the window; or changing the window location by setting the x, - - y, or bounds properties. - -

- -

Note: Avoid actions that may open simultaneous operating system dialogs boxes - - in the handler functions for both the moving and move events - - of a NativeWindow object. This may occur, for example, if both handler functions throw an error. - - If it does occur, the second dialog box opened will not - - register mouse clicks and must be closed using the keyboard.

- - - -

- Defines the value of the type property of a move event object. -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterBoundsThe new bounds of the window.
beforeBoundsThe old bounds of the window.
targetThe NativeWindow object that has just changed state. -
bubblesNo.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelablefalse; There is no default behavior to cancel.
- -
- - - - - -
movingevent  
-
-Event object type: flash.events.NativeWindowBoundsEvent -
-NativeWindowBoundsEvent.type property = flash.events.NativeWindowBoundsEvent.MOVING -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by the NativeWindow object immediately before the window is to be moved on - - the desktop. This event can be canceled to prevent or modify the move. - - -

Note: Avoid actions that may open simultaneous operating system dialogs boxes - - in the handler functions for both the moving and move events - - of a NativeWindow object. This may occur, for example, if both handler functions throw an error. - - If it does occur, the second dialog box opened will not - - register mouse clicks and must be closed using the keyboard.

- - - -

- Defines the value of the type property of a moving event object. -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterBoundsThe bounds of the window after the pending change.
beforeBoundsThe bounds of the window before the pending change.
bubblesNo.
cancelabletrue; cancelling the event will prevent the window move.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
targetThe NativeWindow object that has just changed state.
-

Note: On Linux, the preventDefault() method is not supported for this event.

- -
- - - - - -
resizeevent  
-
-Event object type: flash.events.NativeWindowBoundsEvent -
-NativeWindowBoundsEvent.type property = flash.events.NativeWindowBoundsEvent.RESIZE -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeWindow object after the window has been resized. - - - A resize event is dispatched whenever the size (width or height properties) of the window - - changes, which can occur because of a system-controlled window resize; minimizing, maximizing, - - or restoring the window; or changing the window size by setting the width, - - height, or bounds properties. - - - - NativeWindow resize events are dispatched during system-controled resize loops. In contrast, - - Stage object resize events are dispatched when the Stage is ready for drawing. - - - -

- Defines the value of the type property of a resize event object. -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterBoundsThe new bounds of the window.
beforeBoundsThe old bounds of the window.
targetThe NativeWindow object that has just changed state. -
bubblesNo.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelablefalse; There is no default behavior to cancel.
-

-See also -

-
-Stage resize event -
-
- - - - - -
resizingevent  
-
-Event object type: flash.events.NativeWindowBoundsEvent -
-NativeWindowBoundsEvent.type property = flash.events.NativeWindowBoundsEvent.RESIZING -
-

- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched by this NativeWindow object immediately before the window is to be resized on - - the desktop. This event can be canceled to prevent or modify the resize. - - - -

- Defines the value of the type property of a resizing event object. -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterBoundsThe bounds of the window after the pending change.
beforeBoundsThe bounds of the window before the pending change.
targetThe NativeWindow object that has just changed state. -
bubblesNo.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelabletrue; cancelling the event will prevent the window move.
- -

Note: On Linux, the preventDefault() method is not supported for this event.

- -
-Example -
- The following example demonstrates how to cancel a resizing event. -
-
-function boundsChanging_handler(boundsEvent:NativeWindowBoundsEvent):void
-{
-  //shouldStopResize is an application-defined Boolean indicating 
-  //that resize operations should be canceled
-  if (boundsEvent.type == NativeWindowBoundsEvent.RESIZING && shouldStopResize)
-  {
-    boundsEvent.preventDefault();
-  }
-}
-
-

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jul 8 2024, 8:50 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/NativeWindowDisplayState.html b/html-docs/flash/display/NativeWindowDisplayState.html deleted file mode 100644 index c51e75c..0000000 --- a/html-docs/flash/display/NativeWindowDisplayState.html +++ /dev/null @@ -1,312 +0,0 @@ - - - - - - - - -flash.display.NativeWindowDisplayState (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class NativeWindowDisplayState
InheritanceNativeWindowDisplayState Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The NativeWindowDisplayState class defines constants for the names of the window display states. -

Note: The fullscreen modes are set using the Stage object displayState property, - not the window displaySate.

- -

-

-See also -

-
-flash.display.Stage.displayState -
-flash.display.StageDisplayState -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  MAXIMIZED : String = "maximized"
[static] - The maximized display state.
-		NativeWindowDisplayState
  MINIMIZED : String = "minimized"
[static] - The minimized display state.
-		NativeWindowDisplayState
  NORMAL : String = "normal"
[static] - The normal display state.
-		NativeWindowDisplayState
-
- -
- -
Constant detail
- - - - - -
MAXIMIZEDconstant
-
-public static const MAXIMIZED:String = "maximized" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The maximized display state. - -

- - - - - -
MINIMIZEDconstant 
-
-public static const MINIMIZED:String = "minimized" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The minimized display state. - -

- - - - - -
NORMALconstant 
-
-public static const NORMAL:String = "normal" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The normal display state. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/NativeWindowInitOptions.html b/html-docs/flash/display/NativeWindowInitOptions.html deleted file mode 100644 index e40bc2f..0000000 --- a/html-docs/flash/display/NativeWindowInitOptions.html +++ /dev/null @@ -1,727 +0,0 @@ - - - - - - - - -flash.display.NativeWindowInitOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class NativeWindowInitOptions
InheritanceNativeWindowInitOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The NativeWindowInitOptions class defines the initialization options - used to construct a new NativeWindow instance. -

The properties defined in the - initialization options cannot be changed after a window is created.

-

Note: For the initial application window created automatically - by AIR, all of these properties (except type) are - set in the application descriptor. The initial window is always type NativeWindowType.NORMAL.

- -

-

-See also -

-
-flash.display.NativeWindow -
-flash.display.NativeWindowType -
-flash.display.NativeWindowSystemChrome -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  maximizable : Boolean -
- Specifies whether the window can be maximized by the user.
-		NativeWindowInitOptions
  minimizable : Boolean -
- Specifies whether the window can be minimized by the user.
-		NativeWindowInitOptions
  owner : NativeWindow -
- Specifies the NativeWindow object that should own any windows created with - this NativeWindowInitOptions.
-		NativeWindowInitOptions
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  renderMode : String -
- Specifies the render mode of the NativeWindow object created with this NativeWindowInitOptions.
-		NativeWindowInitOptions
  resizable : Boolean -
- Specifies whether the window can be resized by the user.
-		NativeWindowInitOptions
  systemChrome : String -
- Specifies whether system chrome is provided for the window.
-		NativeWindowInitOptions
  transparent : Boolean -
- Specifies whether the window supports transparency and alpha blending against the desktop.
-		NativeWindowInitOptions
  type : String -
- Specifies the type of the window to be created.
-		NativeWindowInitOptions
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NativeWindowInitOptions()
-
- Creates a new NativeWindowInitOptions object.
-		NativeWindowInitOptions
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
maximizableproperty
-
-maximizable:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether the window can be maximized by the user. - -

- For windows with system chrome, this setting will affect the appearance of the window - maximize button. It will also affect other parts of the system-managed - user interface, such as the window menu on Microsoft Windows. -

- -

- When set to false, the window cannot be maximized by the user. Calling the - NativeWindow maximize() method directly will maximize the window. -

- -

OS behavior notes:

-
    -
  • On operating systems, such as Mac OS X, in which maximizing - a window does not also prevent resizing, both maximizable and - resizable must be set to false to prevent - the window from being zoomed or resized.
    • - -
  • Some Linux window managers allow windows to be maximized by the user even when the - maximizable property is set to false.
    • -
- -

The default value is true.

-Implementation -
-    public function get maximizable():Boolean -
-    public function set maximizable(value:Boolean):void -
-

-See also -

-
-flash.display.NativeWindow.displayState -
-
- - - - - -
minimizableproperty 
-
-minimizable:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether the window can be minimized by the user. - -

- For windows with system chrome, this setting will affect the appearance of the - window minimize button. It will also affect other parts of the system-managed - user interface, such as the window menu on Microsoft Windows. -

- -

- When set to false, the window cannot be minimized by the user. Calling the - NativeWindow minimize() method directly will minimize the window. -

- -

Note: Some Linux window managers allow windows to be minimized by the user even when the - minimizable property is set to false.

- -

The default value is true.

-Implementation -
-    public function get minimizable():Boolean -
-    public function set minimizable(value:Boolean):void -
-

-See also -

-
-flash.display.NativeWindow.displayState -
-
- - - - - -
ownerproperty 
-
-owner:NativeWindow  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- Specifies the NativeWindow object that should own any windows created with - this NativeWindowInitOptions. -

When a window has an owner, that window is always displayed in front of its owner, - is minimized and hidden along with its owner, and closes when its owner closes.

- -

The default value is <code>null</code>.

-Implementation -
-    public function get owner():NativeWindow -
-    public function set owner(value:NativeWindow):void -
-

-See also -

-
-flash.display.NativeWindow.owner -
-flash.display.NativeWindow.listOwnedWindows() -
-
- - - - - -
renderModeproperty 
-
-renderMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Specifies the render mode of the NativeWindow object created with this NativeWindowInitOptions. - -

Constants for the valid values of this property are defined in the - NativeWindowRenderMode class -

- -

- If not specified, the default value for renderMode is - NativeWindowRenderMode.AUTO. -

- -

The default value is NativeWindowRenderMode.AUTO.

-Implementation -
-    public function get renderMode():String -
-    public function set renderMode(value:String):void -
-

-See also -

-
-flash.display.NativeWindowRenderMode -
-
- - - - - -
resizableproperty 
-
-resizable:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether the window can be resized by the user. -

- When set to false, the window cannot be resized by the user using system chrome. - Calling the NativeWindow startResize() method in response to a mouse event will - allow the user to resize the window. Setting the window bounds directly will also change the window size. -

- -

OS behavior notes:

-
    -
  • On operating systems, such as Mac OS X, in which - maximizing windows is a resizing operation, both maximizable and - resizable must be set to false to prevent - the window from being zoomed or resized.
    • - -
  • Some Linux window managers allow windows to be resized by the user even when the - resizable property is set to false.
    • -
- -

The default value is true.

-Implementation -
-    public function get resizable():Boolean -
-    public function set resizable(value:Boolean):void -
-

-See also -

-
-flash.display.NativeWindow.bounds -
-
- - - - - -
systemChromeproperty 
-
-systemChrome:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether system chrome is provided for the window. - -

Chrome refers to the window controls that allow a user to control the desktop - properties of a window. System chrome uses the standard controls for the desktop - environment in which the AIR application is run and conforms to the standard - look-and-feel of the native operating system.

-

- To use chrome provided by a framework (such as Flex), or to provide your own window - chrome, set systemChrome to NativeWindowSystemChrome.NONE. -

-

Constants for the valid values of this property are defined in the - NativeWindowSystemChrome class: -

-
    -
  • NativeWindowSystemChrome.NONE
    • -
  • NativeWindowSystemChrome.STANDARD
    • -
- -

If not specified, the default value for systemChrome is - NativeWindowSystemChrome.STANDARD. -

- -

Setting the transparent property to true for a window - with system chrome is not supported.

- -

The default value is NativeWindowSystemChrome.STANDARD.

-Implementation -
-    public function get systemChrome():String -
-    public function set systemChrome(value:String):void -
-

-See also -

-
-flash.display.NativeWindowSystemChrome -
-
- - - - - -
transparentproperty 
-
-transparent:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether the window supports transparency and alpha blending against the desktop. - -

- If true, the window display is composited against the desktop. Areas of the window - not covered by a display object, or covered by display objects with an alpha setting near zero, - are effectively invisible and will not intercept mouse events (which will be received by the - desktop object below the window). The alpha value at which an object will no longer - intercepting mouse events varies between about .06 and .01, depending on the operating system. -

- -

Setting the transparent property to true for a window - with system chrome is not supported.

- -

Note: Not all Linux window managers support transparency. On such systems, transparent - areas of a window are composited against black.

- -

The default value is false.

-Implementation -
-    public function get transparent():Boolean -
-    public function set transparent(value:Boolean):void -
-
- - - - - -
typeproperty 
-
-type:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the type of the window to be created. - -

Constants for the valid values of this property are defined in the - NativeWindowType class: -

- -
    -
  • NativeWindowType.NORMAL — A typical window. - Normal windows use full-size chrome and appear on the Windows or Linux - task bar.
    • - -
  • NativeWindowType.UTILITY — A tool palette. Utility - windows use a slimmer version of the system chrome and do not appear - on the Windows task bar.
    • - -
  • NativeWindowType.LIGHTWEIGHT — lightweight windows cannot have - system chrome and do not appear on the Windows or Linux task bar. In addition, lightweight - windows do not have the System (Alt-Space) menu on Windows. Lightweight windows - are suitable for notification bubbles and controls such as combo-boxes - that open a short-lived display area. When the lightweight type is - used, systemChrome must be set to NativeWindowSystemChrome.NONE.
    • -
- -

- If not specified, the default value for type is - NativeWindowType.NORMAL. -

- -

The default value is NativeWindowType.NORMAL.

-Implementation -
-    public function get type():String -
-    public function set type(value:String):void -
-

-See also -

-
-flash.display.NativeWindowType -
-
- -
Constructor detail
- - - - - -
NativeWindowInitOptions()constructor
-
-public function NativeWindowInitOptions() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a new NativeWindowInitOptions object. - -

The default values of the newly created object are:

-
    -
  • systemChrome = NativeWindowSystemChrome.STANDARD
    • -
  • type = NativeWindowType.NORMAL
    • -
  • transparent = false
    • -
  • owner = null
    • -
  • resizable = true
    • -
  • maximizable = true
    • -
  • minimizable = true
    • -
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/NativeWindowRenderMode.html b/html-docs/flash/display/NativeWindowRenderMode.html deleted file mode 100644 index 893a1f3..0000000 --- a/html-docs/flash/display/NativeWindowRenderMode.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - -flash.display.NativeWindowRenderMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class NativeWindowRenderMode
InheritanceNativeWindowRenderMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

-

- The NativeWindowRenderMode class defines constants for the renderMode property of the - NativeWindowInitOptions object used to create a native window. - -

Note: The renderMode value is specified when a window is - created and cannot be changed.

- -

-

-See also -

-
-flash.display.NativeWindow -
-flash.display.NativeWindowInitOptions -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  AUTO : String = "auto"
[static] - A typical window.
-		NativeWindowRenderMode
  CPU : String = "cpu"
[static] - A cpu mode window.
-		NativeWindowRenderMode
  DIRECT : String = "direct"
[static] - A direct mode window.
-		NativeWindowRenderMode
  GPU : String = "gpu"
[static] - A gpu mode window.
-		NativeWindowRenderMode
-
- -
- -
Constant detail
- - - - - -
AUTOconstant
-
-public static const AUTO:String = "auto" -

- - - - -
Runtime version: AIR 3.0 -
-

- A typical window. - The rendermode will be set to whatever is most appropriate on the underlying device. - Compositing with StageVideo or Stage3D may or may not be supported. - - This is the default. - -

- - - - - -
CPUconstant 
-
-public static const CPU:String = "cpu" -

- - - - -
Runtime version: AIR 3.0 -
-

- A cpu mode window. - Vectors are rendered using the software renderer and blitting is done with the CPU, - so compositing with StageVideo or Stage3D is not supported. - -

Note: Currently, to specify this mode for a new NativeWindow, the <renderMode> tag in the - application descriptor must be "cpu", "auto" or "direct", otherwise an IllegalOperationError exception - will be thrown.

- -
- - - - - -
DIRECTconstant 
-
-public static const DIRECT:String = "direct" -

- - - - -
Runtime version: AIR 3.0 -
-

- A direct mode window. - Direct mode windows render vectors using the software renderer, but blit using the GPU to allow - compositing with StageVideo or Stage3D. - -

Note: Currently, to specify this mode for a new NativeWindow, the <renderMode> tag in the - application descriptor must be "cpu" or "auto" or "direct", otherwise an IllegalOperationError exception - will be thrown.

- -
- - - - - -
GPUconstant 
-
-public static const GPU:String = "gpu" -

- - - - -
Runtime version: AIR 3.0 -
-

- A gpu mode window. - Vectors are rendered using the GPU and blitting is done with the GPU, so - compositing with StageVideo or Stage3D is supported. - -

Note: Currently, to specify this mode for a new NativeWindow, the <renderMode> tag in the - application descriptor must also be "gpu", otherwise an IllegalOperationError exception - will be thrown.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/NativeWindowResize.html b/html-docs/flash/display/NativeWindowResize.html deleted file mode 100644 index e4add6a..0000000 --- a/html-docs/flash/display/NativeWindowResize.html +++ /dev/null @@ -1,433 +0,0 @@ - - - - - - - - -flash.display.NativeWindowResize (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class NativeWindowResize
InheritanceNativeWindowResize Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

-The NativeWindowResize class defines constants for the possible values - of the edgeOrCorner parameter of the NativeWindow - startResize() method. -

A constant is defined to name each edge and corner of a window.

-

-

-See also -

-
-flash.display.NativeWindow.startResize() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  BOTTOM : String = "B"
[static] -The bottom edge of the window.
-		NativeWindowResize
  BOTTOM_LEFT : String = "BL"
[static] -The bottom-left corner of the window.
-		NativeWindowResize
  BOTTOM_RIGHT : String = "BR"
[static] -The bottom-right corner of the window.
-		NativeWindowResize
  LEFT : String = "L"
[static] -The left edge of the window.
-		NativeWindowResize
  NONE : String = ""
[static] -Used for keyboard resizing on systems (such as Windows) that support keyboard resizing.
-		NativeWindowResize
  RIGHT : String = "R"
[static] -The right edge of the window.
-		NativeWindowResize
  TOP : String = "T"
[static] -The top edge of the window.
-		NativeWindowResize
  TOP_LEFT : String = "TL"
[static] -The top-left corner of the window.
-		NativeWindowResize
  TOP_RIGHT : String = "TR"
[static] -The top-right corner of the window.
-		NativeWindowResize
-
- -
- -
Constant detail
- - - - - -
BOTTOMconstant
-
-public static const BOTTOM:String = "B" -

- - - - -
Runtime version: AIR 1.0
-

-The bottom edge of the window. - -

- - - - - -
BOTTOM_LEFTconstant 
-
-public static const BOTTOM_LEFT:String = "BL" -

- - - - -
Runtime version: AIR 1.0
-

-The bottom-left corner of the window. - -

- - - - - -
BOTTOM_RIGHTconstant 
-
-public static const BOTTOM_RIGHT:String = "BR" -

- - - - -
Runtime version: AIR 1.0
-

-The bottom-right corner of the window. - -

- - - - - -
LEFTconstant 
-
-public static const LEFT:String = "L" -

- - - - -
Runtime version: AIR 1.0
-

-The left edge of the window. - -

- - - - - -
NONEconstant 
-
-public static const NONE:String = "" -

- - - - -
Runtime version: AIR 1.0
-

-Used for keyboard resizing on systems (such as Windows) that support keyboard resizing. -On Windows, this is similar to choosing the Size command from the Alt+Space menu. -When calling NativeWindow.startResize(NativeWindowResize.NONE), -a Windows user can resize the window using the keyboard arrow keys. - -

- - - - - -
RIGHTconstant 
-
-public static const RIGHT:String = "R" -

- - - - -
Runtime version: AIR 1.0
-

-The right edge of the window. - -

- - - - - -
TOPconstant 
-
-public static const TOP:String = "T" -

- - - - -
Runtime version: AIR 1.0
-

-The top edge of the window. - -

- - - - - -
TOP_LEFTconstant 
-
-public static const TOP_LEFT:String = "TL" -

- - - - -
Runtime version: AIR 1.0
-

-The top-left corner of the window. - -

- - - - - -
TOP_RIGHTconstant 
-
-public static const TOP_RIGHT:String = "TR" -

- - - - -
Runtime version: AIR 1.0
-

-The top-right corner of the window. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/NativeWindowSystemChrome.html b/html-docs/flash/display/NativeWindowSystemChrome.html deleted file mode 100644 index f35122b..0000000 --- a/html-docs/flash/display/NativeWindowSystemChrome.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - - - -flash.display.NativeWindowSystemChrome (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class NativeWindowSystemChrome
InheritanceNativeWindowSystemChrome Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The NativeWindowSystemChrome class defines constants for the systemChrome - property of the NativeWindowInitOptions object used to create a native window. - -

System chrome refers to the operating system-specific elements of a window - such as a title bar, minimize, maximize, and close buttons.

- -

Note: The type of system chrome used is specified when a window is - created and cannot be changed.

-

-

-See also -

-
-flash.display.NativeWindow -
-flash.display.NativeWindowInitOptions -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  NONE : String = "none"
[static] - No system chrome.
-		NativeWindowSystemChrome
  STANDARD : String = "standard"
[static] - The standard chrome for the host operating system.
-		NativeWindowSystemChrome
-
- -
- -
Constant detail
- - - - - -
NONEconstant
-
-public static const NONE:String = "none" -

- - - - -
Runtime version: AIR 1.0 -
-

- No system chrome. - -

- - - - - -
STANDARDconstant 
-
-public static const STANDARD:String = "standard" -

- - - - -
Runtime version: AIR 1.0 -
-

- The standard chrome for the host operating system. - -

Use this setting to emulate the look and feel of the native operating system.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/NativeWindowType.html b/html-docs/flash/display/NativeWindowType.html deleted file mode 100644 index f5ae8dc..0000000 --- a/html-docs/flash/display/NativeWindowType.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - - - -flash.display.NativeWindowType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class NativeWindowType
InheritanceNativeWindowType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The NativeWindowType class defines constants for the type property of the - NativeWindowInitOptions object used to create a native window. - -

Note: The type value is specified when a window is - created and cannot be changed.

- -

-

-See also -

-
-flash.display.NativeWindow -
-flash.display.NativeWindowInitOptions -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  LIGHTWEIGHT : String = "lightweight"
[static] - A minimal window.
-		NativeWindowType
  NORMAL : String = "normal"
[static] - A typical window.
-		NativeWindowType
  UTILITY : String = "utility"
[static] - A utility window.
-		NativeWindowType
-
- -
- -
Constant detail
- - - - - -
LIGHTWEIGHTconstant
-
-public static const LIGHTWEIGHT:String = "lightweight" -

- - - - -
Runtime version: AIR 1.0 -
-

- A minimal window. - -

- - - - - -
NORMALconstant 
-
-public static const NORMAL:String = "normal" -

- - - - -
Runtime version: AIR 1.0 -
-

- A typical window. - -

- - - - - -
UTILITYconstant 
-
-public static const UTILITY:String = "utility" -

- - - - -
Runtime version: AIR 1.0 -
-

- A utility window. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/PNGEncoderOptions.html b/html-docs/flash/display/PNGEncoderOptions.html deleted file mode 100644 index ff7f141..0000000 --- a/html-docs/flash/display/PNGEncoderOptions.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - - - - -flash.display.PNGEncoderOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class PNGEncoderOptions
InheritancePNGEncoderOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

-

- The PNGEncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method. -

-

-See also -

-
-flash.display.BitmapData -
-flash.display.BitmapData.encode() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fastCompression : Boolean -
- Chooses compression speed over file size.
-		PNGEncoderOptions
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-PNGEncoderOptions(fastCompression:Boolean = false)
-
- Creates a PNGEncoderOptions object, optionally specifying compression settings.
-		PNGEncoderOptions
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
fastCompressionproperty
-
-public var fastCompression:Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Chooses compression speed over file size. Setting this property to true - improves compression speed but creates larger files. -

- -
Constructor detail
- - - - - -
PNGEncoderOptions()constructor
-
-public function PNGEncoderOptions(fastCompression:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Creates a PNGEncoderOptions object, optionally specifying compression settings. -

Parameters - - - - -
fastCompression:Boolean (default = false) — The initial compression mode. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/PixelSnapping.html b/html-docs/flash/display/PixelSnapping.html deleted file mode 100644 index ee6fb75..0000000 --- a/html-docs/flash/display/PixelSnapping.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - - -flash.display.PixelSnapping (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class PixelSnapping
InheritancePixelSnapping Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- -The PixelSnapping class is an enumeration of constant values for setting the pixel snapping options -by using the pixelSnapping property of a Bitmap object. - - -

-

-See also -

-
-flash.display.Bitmap.pixelSnapping -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  ALWAYS : String = "always"
[static] - A constant value used in the pixelSnapping property of a Bitmap object - to specify that the bitmap image is always snapped to the nearest - pixel, independent of any transformation.
-		PixelSnapping
  AUTO : String = "auto"
[static] - A constant value used in the pixelSnapping property of a Bitmap object - to specify that the bitmap image is snapped to the nearest pixel if it is drawn with no rotation - or skew and it is drawn at a scale factor of 99.9% to 100.1%.
-		PixelSnapping
  NEVER : String = "never"
[static] - A constant value used in the pixelSnapping property of a Bitmap object - to specify that no pixel snapping occurs.
-		PixelSnapping
-
- -
- -
Constant detail
- - - - - -
ALWAYSconstant
-
-public static const ALWAYS:String = "always" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A constant value used in the pixelSnapping property of a Bitmap object - to specify that the bitmap image is always snapped to the nearest - pixel, independent of any transformation. - -

- - - - - -
AUTOconstant 
-
-public static const AUTO:String = "auto" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A constant value used in the pixelSnapping property of a Bitmap object - to specify that the bitmap image is snapped to the nearest pixel if it is drawn with no rotation - or skew and it is drawn at a scale factor of 99.9% to 100.1%. If these conditions are satisfied, - the image is drawn at 100% scale, snapped to the nearest pixel. Internally, this setting allows the image - to be drawn as fast as possible by using the vector renderer. -

- - - - - -
NEVERconstant 
-
-public static const NEVER:String = "never" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A constant value used in the pixelSnapping property of a Bitmap object - to specify that no pixel snapping occurs. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/SWFVersion.html b/html-docs/flash/display/SWFVersion.html deleted file mode 100644 index 9fa3aa0..0000000 --- a/html-docs/flash/display/SWFVersion.html +++ /dev/null @@ -1,570 +0,0 @@ - - - - - - - - -flash.display.SWFVersion (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class SWFVersion
InheritanceSWFVersion Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The SWFVersion class is an enumeration of constant values that indicate the - file format version of a loaded SWF file. - The SWFVersion constants are provided for use in checking the - swfVersion property of a flash.display.LoaderInfo object. - -

-

-See also -

-
-flash.display.LoaderInfo.swfVersion -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  FLASH1 : uint = 1
[static] - SWF file format version 1.0.
-		SWFVersion
  FLASH10 : uint = 10
[static] - SWF file format version 10.0.
-		SWFVersion
  FLASH11 : uint = 11
[static] - SWF file format version 11.0.
-		SWFVersion
  FLASH12 : uint = 12
[static] - SWF file format version 12.0.
-		SWFVersion
  FLASH2 : uint = 2
[static] - SWF file format version 2.0.
-		SWFVersion
  FLASH3 : uint = 3
[static] - SWF file format version 3.0.
-		SWFVersion
  FLASH4 : uint = 4
[static] - SWF file format version 4.0.
-		SWFVersion
  FLASH5 : uint = 5
[static] - SWF file format version 5.0.
-		SWFVersion
  FLASH6 : uint = 6
[static] - SWF file format version 6.0.
-		SWFVersion
  FLASH7 : uint = 7
[static] - SWF file format version 7.0.
-		SWFVersion
  FLASH8 : uint = 8
[static] - SWF file format version 8.0.
-		SWFVersion
  FLASH9 : uint = 9
[static] - SWF file format version 9.0.
-		SWFVersion
-
- -
- -
Constant detail
- - - - - -
FLASH1constant
-
-public static const FLASH1:uint = 1 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- SWF file format version 1.0. - -

- - - - - -
FLASH10constant 
-
-public static const FLASH10:uint = 10 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- SWF file format version 10.0. - -

- - - - - -
FLASH11constant 
-
-public static const FLASH11:uint = 11 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- SWF file format version 11.0. - -

- - - - - -
FLASH12constant 
-
-public static const FLASH12:uint = 12 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- SWF file format version 12.0. - -

- - - - - -
FLASH2constant 
-
-public static const FLASH2:uint = 2 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- SWF file format version 2.0. - -

- - - - - -
FLASH3constant 
-
-public static const FLASH3:uint = 3 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- SWF file format version 3.0. - -

- - - - - -
FLASH4constant 
-
-public static const FLASH4:uint = 4 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- SWF file format version 4.0. - -

- - - - - -
FLASH5constant 
-
-public static const FLASH5:uint = 5 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- SWF file format version 5.0. - -

- - - - - -
FLASH6constant 
-
-public static const FLASH6:uint = 6 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- SWF file format version 6.0. - -

- - - - - -
FLASH7constant 
-
-public static const FLASH7:uint = 7 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- SWF file format version 7.0. - -

- - - - - -
FLASH8constant 
-
-public static const FLASH8:uint = 8 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- SWF file format version 8.0. - -

- - - - - -
FLASH9constant 
-
-public static const FLASH9:uint = 9 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- SWF file format version 9.0. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/Scene.html b/html-docs/flash/display/Scene.html deleted file mode 100644 index 6b19148..0000000 --- a/html-docs/flash/display/Scene.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - - - -flash.display.Scene (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class Scene
InheritanceScene Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The Scene class includes properties for identifying the name, labels, and number of frames - in a scene. A Scene object instance is created in Flash Professional, not by - writing ActionScript code. - The MovieClip class includes a currentScene property, which is - a Scene object that identifies the scene in which the playhead is located in the - timeline of the MovieClip instance. The scenes property of the - MovieClip class is an array of Scene objects. Also, the gotoAndPlay() - and gotoAndStop() methods of the MovieClip class use Scene objects as - parameters. - -

-

-See also -

-
-MovieClip.currentScene -
-MovieClip.scenes -
-MovieClip.gotoAndPlay() -
-MovieClip.gotoAndStop() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  labels : Array -
[read-only] - An array of FrameLabel objects for the scene.
-		Scene
  name : String -
[read-only] - The name of the scene.
-		Scene
  numFrames : int -
[read-only] - The number of frames in the scene.
-		Scene
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
labelsproperty
-
-labels:Array  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An array of FrameLabel objects for the scene. Each FrameLabel object contains - a frame property, which specifies the frame number corresponding to the - label, and a name property. - -

Implementation -
-    public function get labels():Array -
-

-See also -

-
-FrameLabel -
-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The name of the scene. -

Implementation -
-    public function get name():String -
-
- - - - - -
numFramesproperty 
-
-numFrames:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The number of frames in the scene. -

Implementation -
-    public function get numFrames():int -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/Screen.html b/html-docs/flash/display/Screen.html deleted file mode 100644 index 845d9a6..0000000 --- a/html-docs/flash/display/Screen.html +++ /dev/null @@ -1,1050 +0,0 @@ - - - - - - - - -flash.display.Screen (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class Screen
InheritanceScreen Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The Screen class provides information about the display screens available to this application. - - -

Screens are independent desktop areas within a possibly larger - - "virtual desktop." The origin of the virtual desktop is the top-left corner - - of the operating-system-designated main screen. Thus, the coordinates for the - - bounds of an individual display screen may be negative. There may also be areas - - of the virtual desktop that are not within any of the display screens.

- - - -

The Screen class includes static class members for accessing the available - - screen objects and instance members for accessing the properties of an - - individual screen. Screen information should not be cached since - - it can be changed by a user at any time.

- - - -

Note that there is not necessarily a one-to-one correspondance between - - screens and the physical monitors attached to a computer. For example, two monitors - - may display the same screen.

- - - -

You cannot instantiate the Screen class directly. Calls to - - the new Screen() constructor throw an - - ArgumentError exception.

- - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bounds : Rectangle -
[read-only] - - The bounds of this screen.
-		Screen
  colorDepth : int -
[read-only] - - The color depth of this screen (expressed in number of bits).
-		Screen
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  contentsScaleFactor : Number -
[read-only] - - The scale factor of the screen - - -
-		Screen
  mainScreen : Screen -
[static][read-only] - - The primary display.
-		Screen
  mode : ScreenMode -
- - The current screen mode of the Screen object.
-		Screen
  modes : Array -
[read-only] - - The array of ScreenMode objects of the Screen object.
-		Screen
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  safeArea : Rectangle -
[read-only] - - The bounds of the 'safe' area on this screen in which content will always be visible.
-		Screen
  screens : Array -
[static][read-only] - - The array of the currently available screens.
-		Screen
  visibleBounds : Rectangle -
[read-only] - - The bounds of the area on this screen in which windows can be visible.
-		Screen
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-getScreensForRectangle(rect:Rectangle):Array -
-
[static] - - Returns the (possibly empty) set of screens that intersect - - the provided rectangle.
-		Screen
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
boundsproperty
-
-bounds:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The bounds of this screen. - - - -

The screen location is relative to the virtual desktop.

- - -

On Linux systems that use certain window managers, this property returns - - the desktop bounds, not the screen's visible bounds.

- - - Implementation -
-    public function get bounds():Rectangle -
-
-Example -
The following example shows how to get the bounds of a screen - (in this case, the primary display screen): -
-
-import flash.display.Screen;
-import flash.geom.Rectangle;
-
-var mainScreen:Screen = Screen.mainScreen;
-var screenBounds:Rectangle = mainScreen.bounds;
-
-

-
- - - - - -
colorDepthproperty 
-
-colorDepth:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The color depth of this screen (expressed in number of bits). - - -

Implementation -
-    public function get colorDepth():int -
-
-Example -
The following example shows how to get the color depth of a screen - (in this case, the primary display screen): -
-
-
-var mainScreen:Screen = Screen.mainScreen;
-var colors:uint = mainScreen.colorDepth;
-
-

-
- - - - - -
contentsScaleFactorproperty 
-
-contentsScaleFactor:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - The scale factor of the screen - - -

Implementation -
-    public function get contentsScaleFactor():Number -
-
- - - - - -
mainScreenproperty 
-
-mainScreen:Screen  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The primary display. - - -

Implementation -
-    public static function get mainScreen():Screen -
-
-Example -
The following example shows how to get the Screen object representing the - "main" screen of this computer: -
-
-
-var primaryScreen:Screen = Screen.mainScreen;
-
-

-
- - - - - -
modeproperty 
-
-mode:ScreenMode  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 31.0 - -
-

- - The current screen mode of the Screen object. - - - The mode property indicates the current screen mode of the specific Screen device - - and can be set to change the current screen mode. - - -

You can only set screen mode in full-screen mode. - - Setting it on applications not in full-screen mode throws an exception.

- -

On mobile platforms, this property is not supported and returns null - - (and trying to set the property has no effect).

- - - - Implementation -
-    public function get mode():ScreenMode -
-    public function set mode(value:ScreenMode):void -
-
-Example -
The following example shows how to set the mode of a screen - (in this case, the primary display screen): -
-
-import flash.display.Screen;
-import flash.display.ScreenMode;
-import flash.display.StageDisplayState;
-
-function FindBestModeIndex(modes:Array): int // this method is an example of an user defined function.
-{ 
-    return modes.length - 1; // algorithm for selection of the best mode is to be defined by the AS developer.
-}
-
-var primaryDisplay:Screen = Screen.mainScreen;
-var oldScreenMode:ScreenMode = primaryDisplay.mode;
-	
-var modes:Array = primaryDisplay.modes;
-var best_mode_index:uint = FindBestModeIndex(modes);
-
-try {
-	stage.displayState = StageDisplayState.FULL_SCREEN;
-	// Setting of screen mode not in full-screen mode throws the kInvalidPropertyOutsideFullScreen exception.  
-	primaryDisplay.mode = modes[best_mode_index]);
-}
-catch(error:Error){
-	stage.displayState = StageDisplayState.NORMAL;
-}
-
-

-
- - - - - -
modesproperty 
-
-modes:Array  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 31.0 - -
-

- - The array of ScreenMode objects of the Screen object. - - - The modes property indicates supported screen modes of the specific Screen device. - -

Note that on mobile devices where the mode property is not supported, this - - property will be null.

- - - Implementation -
-    public function get modes():Array -
-
- - - - - -
safeAreaproperty 
-
-safeArea:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - The bounds of the 'safe' area on this screen in which content will always be visible. - - -

The safeArea of a screen excludes any cut-out features such - - as cameras/speakers at the top of mobile devices, or the borders of screens that may - - be impacted by a curved edge of the screen. - - On devices with rectangular corners and no cut-outs, the safeArea property - - returns the same value as the visibleBounds property.

- - - Implementation -
-    public function get safeArea():Rectangle -
-
- - - - - -
screensproperty 
-
-screens:Array  [read-only]

- - - - -
Language version: ActionScript 3. -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The array of the currently available screens. - - - -

Modifying the returned array has no effect on - - the available screens.

- - - Implementation -
-    public static function get screens():Array -
-
-Example -
The following example shows how to get the array containing the available screens: -
-
-
-var screenArray:Array = Screen.screens;
-
-

-
- - - - - -
visibleBoundsproperty 
-
-visibleBounds:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The bounds of the area on this screen in which windows can be visible. - - - -

The visibleBounds of a screen excludes the task bar - - (and other docked desk bars) on Windows, and excludes the - - menu bar and, depending on system settings, the dock on Mac OS X. - - On some Linux configurations, it is not possible to determine the visible bounds. - - In these cases, the visibleBounds property returns the same - - value as the screenBounds property.

- - - Implementation -
-    public function get visibleBounds():Rectangle -
-
-Example -
The following example shows how to get the usable bounds of a screen - (in this case, the primary display screen): -
-
-import flash.display.Screen;
-import flash.geom.Rectangle;
-
-var mainScreen:Screen = Screen.mainScreen;
-var screenBounds:Rectangle = mainScreen.visibleBounds;
-
-

-
- -
Method detail
- - - - - -
getScreensForRectangle()method
-
-public static function getScreensForRectangle(rect:Rectangle):Array -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns the (possibly empty) set of screens that intersect - - the provided rectangle. - - - -

Parameters - - - - -
rect:Rectangle — A rectangle with coordinates relative to the origin of - - the virtual desktop, which is the top-left corner of the primary - - screen. - - - -
-

-Returns - - - - -
Array — - An array of Screen objects containing the screens that contain any - - part of the area defined by the rect parameter. - - - - - -
-
-Example -
The following example shows how to get the array of screens containing - at least part of a given rectangle: -
-
-import flash.display.Screen;
-import flash.geom.Rectangle;
-
-var rect:Rectangle = new Rectangle(-200, 100, 1000, 600);
-var intersectedScreens:Array = Screen.getScreensForRectangle(rect);
-
-

-
- -
Examples
-
examples\ScreenExample
-
The following example defines a DockingWindow class - to create a window that docks to the sides of the screen. - This task is accomplished by performing the following steps: - -
    -
  1. Responding to keyboard events to determine the side of the screen on which to - dock.
    2. - -
  2. Accessing the static Screen class method getScreensForRectangle() - to get the Screen object for the screen upon which the window is currently - displayed.
    3. - -
  3. Resetting the window bounds based on the screen dimensions.
    4. - -
  4. Redrawing the window content based on the new window dimensions.
    5. - -
- -

Note, this class is intended to be used as the root class of an AIR application - with the settings SystemChrome="none" and - transparent="true". To use this class in a window with system - chrome, you must take the chrome thickness and the minimum width of - the window into account when calculating window location and size.

-
-
-
-package
-{
-	import flash.display.Screen;
-	import flash.display.Sprite;
-	import flash.display.StageAlign;
-	import flash.display.StageScaleMode;
-	import flash.events.KeyboardEvent;
-	import flash.geom.Rectangle;
-	import flash.ui.Keyboard;
-
-	public class DockingWindow extends Sprite
-	{
-		private const dockedWidth:uint = 80;
-		private const dockedHeight:uint = 80;
-		
-		public function DockingWindow():void{
-			stage.align = StageAlign.TOP_LEFT;
-			stage.scaleMode = StageScaleMode.NO_SCALE;
-			stage.addEventListener(KeyboardEvent.KEY_DOWN,onKey);
-			dockLeft();
-		}
-		
-		private function onKey(event:KeyboardEvent):void{
-			switch(event.keyCode){
-				case Keyboard.LEFT :
-					dockLeft();
-					break;
-				case Keyboard.RIGHT :
-					dockRight();
-					break;
-				case Keyboard.UP :
-					dockTop();
-					break;
-				case Keyboard.DOWN :
-					dockBottom();
-					break;
-				case Keyboard.SPACE :
-					stage.nativeWindow.close();
-			}	
-		}
-		
-		public function dockLeft():void{
-			var screen:Screen = getCurrentScreen();
-			stage.nativeWindow.x = screen.visibleBounds.left;
-			stage.nativeWindow.y = screen.visibleBounds.top;
-			stage.nativeWindow.height = screen.visibleBounds.height;
-			stage.stageWidth = dockedWidth;
-			drawContent();
-		}
-		
-		public function dockRight():void{
-			var screen:Screen = getCurrentScreen();
-			stage.nativeWindow.x = screen.visibleBounds.width - dockedWidth;			
-			stage.nativeWindow.y = screen.visibleBounds.top;
-			stage.stageWidth = dockedWidth;
-			stage.nativeWindow.height = screen.visibleBounds.height;
-			drawContent();
-		}
-		
-		public function dockTop():void{
-			var screen:Screen = getCurrentScreen();
-			stage.nativeWindow.x = screen.visibleBounds.left;
-			stage.nativeWindow.y = screen.visibleBounds.top;
-			stage.nativeWindow.width = screen.visibleBounds.width;
-			stage.stageHeight = dockedHeight;
-			drawContent();
-		}
-		
-		public function dockBottom():void{
-			var screen:Screen = getCurrentScreen();
-			stage.nativeWindow.x = screen.visibleBounds.left;
-			stage.nativeWindow.y = screen.visibleBounds.height - dockedHeight;
-			stage.nativeWindow.width = screen.visibleBounds.width;
-			stage.stageHeight = dockedHeight;	
-			drawContent();		
-		}
-		
-		private function getCurrentScreen():Screen{
-			return Screen.getScreensForRectangle(stage.nativeWindow.bounds)[0];
-		}
-		
-		private function drawContent():void{
-			const size:int = 60;
-			const pad:int = 10;
-			var numHSquares:int = Math.floor(stage.stageWidth/(size + pad));
-			var numVSquares:int = Math.floor(stage.stageHeight/(size + pad));
-			with (graphics){
-				clear();
-				lineStyle(1);
-				beginFill(0x3462d5,.7);
-				for(var i:int = 0; i < numHSquares; i++){
-					for(var j:int = 0; j < numVSquares; j++){				
-							drawRect((i * (size + pad)) + pad, (j * (size + pad)) + pad, size, size);
-					}
-				}
-				endFill();
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Dec 21 2022, 3:05 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/ScreenMode.html b/html-docs/flash/display/ScreenMode.html deleted file mode 100644 index fecdbfa..0000000 --- a/html-docs/flash/display/ScreenMode.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - - - -flash.display.ScreenMode (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class ScreenMode
InheritanceScreenMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 31.0 -
-

-

- The ScreenMode object provides information about the width, height and refresh rate of a Screen. - -

Methods and properties of the following classes use ScreenMode objects:

- -
    - -
  • ScreenMode
    • - -
-

-

-View the examples. -

-

-See also -

-
-flash.display.ScreenMode -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  colorDepth : int -
[read-only] - The color depth of the ScreenMode in number of bits.
-		ScreenMode
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  height : int -
[read-only] - The screen height of the ScreenMode in pixels.
-		ScreenMode
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  refreshRate : int -
[read-only] - The screen refresh rate of the ScreenMode in hertz.
-		ScreenMode
  width : int -
[read-only] - The screen width of the ScreenMode in pixels.
-		ScreenMode
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
colorDepthproperty
-
-colorDepth:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 31.0 -
-

- The color depth of the ScreenMode in number of bits. - The color depth property indicates the color depth of the ScreenMode. - -

Implementation -
-    public function get colorDepth():int -
-
- - - - - -
heightproperty 
-
-height:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 31.0 -
-

- The screen height of the ScreenMode in pixels. - The height property indicates the height of the ScreenMode. -

Implementation -
-    public function get height():int -
-
- - - - - -
refreshRateproperty 
-
-refreshRate:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 31.0 -
-

- The screen refresh rate of the ScreenMode in hertz. - The refreshRate property indicates the refresh rate of the ScreenMode. - The return value is 0 when a display device does not support refresh rate. -

Implementation -
-    public function get refreshRate():int -
-
- - - - - -
widthproperty 
-
-width:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 31.0 -
-

- The screen width of the ScreenMode in pixels. - The width property indicates the width of the ScreenMode. -

Implementation -
-    public function get width():int -
-
- -
Examples
-
examples\Screen.mode.2
-
The following example shows how to use the properties of the ScreenMode - (in this case, the primary display screen): -
-
-import flash.display.ScreenMode;
-import flash.display.Screen;
-
-var primarymonitor:Screen = Screen.mainScreen;
-
-stage.displayState=StageDisplayState.FULL_SCREEN_INTERACTIVE;
-var r:ScreenMode = primarymonitor.mode;
-
-res_0.text = r.width + "*" + r.height + "*" + r.refreshRate +"*" + r.colorDepth ;
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/Shader.html b/html-docs/flash/display/Shader.html deleted file mode 100644 index bd29edd..0000000 --- a/html-docs/flash/display/Shader.html +++ /dev/null @@ -1,597 +0,0 @@ - - - - - - - - -flash.display.Shader (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class Shader
InheritanceShader Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- A Shader instance represents a Pixel Bender shader kernel in ActionScript. To use - a shader in your application, you create a Shader instance for it. You - then use that Shader instance in the appropriate way according to the effect - you want to create. For example, to use the shader as a filter, you - assign the Shader instance to the shader property of a - ShaderFilter object. - -

A shader defines a function that executes on all the pixels in an image, - one pixel at a time. The result of each call to the function is the output - color at that pixel coordinate in the image. A shader can specify one or more - input images, which are images whose content can be used in determining the - output of the function. A shader can also specify one or more parameters, - which are input values that can be used in calculating the function output. In - a single shader execution, the input and parameter values are constant. The only - thing that varies is the coordinate of the pixel whose color is the function result. - Shader function calls for multiple output - pixel coordinates execute in parallel to improve shader execution performance.

- -

The shader bytecode can be loaded at run time using a URLLoader instance. - The following example demonstrates loading a shader bytecode file at run time - and linking it to a Shader instance.

- - 
-	 var loader:URLLoader = new URLLoader();
-	 loader.dataFormat = URLLoaderDataFormat.BINARY;
-	 loader.addEventListener(Event.COMPLETE, onLoadComplete);
-	 loader.load(new URLRequest("myShader.pbj"));
-	  
-	 var shader:Shader;
-	  
-	 function onLoadComplete(event:Event):void {
-	     // Create a new shader and set the loaded data as its bytecode
-	     shader = new Shader();
-	     shader.byteCode = loader.data;
-	     
-	     // You can also pass the bytecode to the Shader() constructor like this:
-	     // shader = new Shader(loader.data);
-	     
-	     // do something with the shader
-	 }
-
- -

You can also embed the shader into the SWF at compile time using the - [Embed] metadata tag. The [Embed] metadata tag - is only available if you use the Flex SDK to compile the SWF. The - [Embed] tag's source parameter points to - the shader file, and its mimeType parameter is - "application/octet-stream", as in this example:

- - 
-	 [Embed(source="myShader.pbj", mimeType="application/octet-stream)]
-	 var MyShaderClass:Class;
-	  
-	 // ...
-	 
-	 // create a new shader and set the embedded shader as its bytecode
-	 var shaderShader = new Shader();
-	 shader.byteCode = new MyShaderClass();
-	  
-	 // You can also pass the bytecode to the Shader() constructor like this:
-	 // var shader:Shader = new Shader(new MyShaderClass());
-	  
-	 // do something with the shader
-
- -

In either case, you link the raw shader (the URLLoader.data property - or an instance of the [Embed] data class) to the Shader instance. As - the previous examples demonstrate, you can do this in two ways. You can - pass the shader bytecode as an argument - to the Shader() constructor. Alternatively, you can set it as the Shader - instance's byteCode property.

- -

Once a Shader instance is created, it can be used in one of several - ways:

- -
    -
  • A shader fill: The output of the shader is used as a fill for - content drawn with the drawing API. Pass the Shader instance as - an argument to the Graphics.beginShaderFill() method.
    • -
  • A shader filter: The output of the shader is used as a graphic filter - applied to a display object. Assign the Shader instance to the - shader property of a ShaderFilter instance.
    • -
  • A blend mode: The output of the shader is rendered as the blending - between two overlapping display objects. Assign the Shader instance - to the blendShader property of the upper of the - two display objects.
    • -
  • Background shader processing: The shader executes in the background, - avoiding the possibility of freezing the display, and dispatches an - event when processing is complete. Assign the Shader instance to - the shader property of a ShaderJob instance.
    • -
- -

Shader fills, filters, and blends are not supported under GPU rendering.

-

Mobile Browser Support: This feature is not supported in mobile browsers.

-

AIR profile support: This feature is supported - on all desktop operating systems, but it is not supported on all mobile devices. It is not supported on AIR - for TV devices. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.DisplayObject.blendShader -
-flash.display.Graphics.beginShaderFill() -
-flash.display.ShaderJob -
-flash.filters.ShaderFilter -
-flash.net.URLLoader -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  byteCode : ByteArray -
[write-only] - The raw shader bytecode for this Shader instance.
-		Shader
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  data : ShaderData -
- Provides access to parameters, input images, and metadata for the Shader instance.
-		Shader
  precisionHint : String -
- The precision of math operations performed by the shader.
-		Shader
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Shader(code:ByteArray = null)
-
- Creates a new Shader instance.
-		Shader
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
byteCodeproperty
-
-byteCode:ByteArray  [write-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The raw shader bytecode for this Shader instance. -

Implementation -
-    public function set byteCode(value:ByteArray):void -
-
- - - - - -
dataproperty 
-
-data:ShaderData  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Provides access to parameters, input images, and metadata for the Shader instance. - ShaderParameter objects representing parameters for the shader, ShaderInput objects - representing the input images for the shader, and other values representing the - shader's metadata are dynamically added as properties of the data - property object when the Shader instance is created. Those properties can be - used to introspect the shader and to set parameter and input values. - -

For information about accessing and manipulating the dynamic properties of - the data object, see the ShaderData class description.

- - Implementation -
-    public function get data():ShaderData -
-    public function set data(value:ShaderData):void -
-

-See also -

-
-flash.display.ShaderData -
-flash.display.ShaderInput -
-flash.display.ShaderParameter -
-
- - - - - -
precisionHintproperty 
-
-precisionHint:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The precision of math operations performed by the shader. - -

The set of possible values for the precisionHint property is defined - by the constants in the ShaderPrecision class.

- -

The default value is ShaderPrecision.FULL. Setting the precision - to ShaderPrecision.FAST can speed up math operations at the expense - of precision.

-

Full precision mode (ShaderPrecision.FULL) computes all math - operations to the full width of the IEEE 32-bit floating standard and provides - consistent behavior on all platforms. In this mode, some math operations such - as trigonometric and exponential functions can be slow.

-

Fast precision mode (ShaderPrecision.FAST) is designed for - maximum performance but does not work consistently on different platforms - and individual CPU configurations. In many cases, this level of precision - is sufficient to create graphic effects without visible artifacts.

- -

The precision mode selection affects the following shader operations. - These operations are faster on an Intel processor - with the SSE instruction set:

- -
    -
  • sin(x)
    • -
  • cos(x)
    • -
  • tan(x)
    • -
  • asin(x)
    • -
  • acos(x)
    • -
  • atan(x)
    • -
  • atan(x, y)
    • -
  • exp(x)
    • -
  • exp2(x)
    • -
  • log(x)
    • -
  • log2(x)
    • -
  • pow(x, y)
    • -
  • reciprocal(x)
    • -
  • sqrt(x)
    • -
- - Implementation -
-    public function get precisionHint():String -
-    public function set precisionHint(value:String):void -
-

-See also -

-
-flash.display.ShaderPrecision -
-
- -
Constructor detail
- - - - - -
Shader()constructor
-
-public function Shader(code:ByteArray = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new Shader instance. - -

Parameters - - - - -
code:ByteArray (default = null) — The raw shader bytecode to link to the Shader. - -
-
- -
Examples
-
examples\ShaderExample.1
-
The following example loads a shader bytecode file at run time and creates - a Shader instance linked to it. - -

Note that this example assumes there's a shader bytecode file named "donothing.pbj" in the same - directory as the output directory for the application. The Pixel Bender source code for the DoNothing shader - is available in the ShaderData class example.

-
-
-
-package {
-    import flash.display.Shader;
-	import flash.display.Sprite;
-	import flash.events.Event;
-	import flash.net.URLLoader;
-	import flash.net.URLLoaderDataFormat;
-	import flash.net.URLRequest;
-
-	public class LoadedShaderExample extends Sprite {
-		
-		private var loader:URLLoader;
-		
-		public function LoadedShaderExample() {
-			loader = new URLLoader();
-			loader.dataFormat = URLLoaderDataFormat.BINARY;
-			loader.addEventListener(Event.COMPLETE, loadCompleteHandler);
-			loader.load(new URLRequest("donothing.pbj"));
-		}
-		
-		private function loadCompleteHandler(event:Event):void {
-			var shader:Shader = new Shader();
-			shader.byteCode = loader.data;
-			
-			// do something with the Shader instance
-		}
-	}
-}
-
-
-
examples\ShaderExample.2
-
The following example embeds a shader bytecode file by compiling it - into the SWF, and creates a Shader instance linked to it. - -

Note that this example assumes there's a shader bytecode file named "donothing.pbj" in the same - directory as the source code for the application, and that the Flex SDK is used to compile the SWF. - The Pixel Bender source code for the DoNothing shader - is available in the ShaderData class example.

-
-
-
-package {
-    import flash.display.Shader;
-	import flash.display.Sprite;
-
-	public class EmbeddedShaderExample extends Sprite {
-		
-		[Embed(source="donothing.pbj", mimeType="application/octet-stream")]
-		private static var DoNothingShader:Class;
-		
-		public function EmbeddedShaderExample() {
-			var shader:Shader = new Shader();
-			shader.byteCode = new DoNothingShader();
-			
-			// do something with the Shader instance
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/ShaderData.html b/html-docs/flash/display/ShaderData.html deleted file mode 100644 index 4f66680..0000000 --- a/html-docs/flash/display/ShaderData.html +++ /dev/null @@ -1,467 +0,0 @@ - - - - - - - - -flash.display.ShaderData (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final dynamic class ShaderData
InheritanceShaderData Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- A ShaderData object contains properties representing any parameters and - inputs for a shader kernel, as well as properties containing any metadata - specified for the shader. - -

These properties are added to the ShaderData object when it is created. The properties' - names match the names specified in the shader's source code. The data type of each - property varies according to what aspect of the shader the property represents. The - properties that represent shader parameters are ShaderParameter instances, the properties - that represent input images are ShaderInput instances, and the properties that represent - shader metadata are instances of the ActionScript class corresponding to their data type - (for example, a String instance for textual metadata and a uint for uint metadata).

- -

For example, consider this shader, which is defined with one input image (src), - two parameters (size and radius), and three metadata values - (nameSpace, version, and description):

- - 
-	 <languageVersion : 1.0;>
-	 
-	 kernel DoNothing
-	 <
-	     namespace: "Adobe::Example";
-	     vendor: "Adobe examples";
-	     version: 1;
-	     description: "A shader that does nothing, but does it well.";
-	 >
-	 {
-	     input image4 src;
-	 
-	     output pixel4 dst;
-	     
-	     parameter float2 size
-	     <
-	         description: "The size of the image to which the kernel is applied";
-	         minValue: float2(0.0, 0.0);
-	         maxValue: float2(100.0, 100.0);
-	         defaultValue: float2(50.0, 50.0);
-	     >;
-	     
-	     parameter float radius
-	     <
-	         description: "The radius of the effect";
-	         minValue: 0.0;
-	         maxValue: 50.0;
-	         defaultValue: 25.0;
-	     >;
-	 
-	     void evaluatePixel()
-	     {
-	         float2 one = (radius / radius) ∗ (size / size);
-	         dst = sampleNearest(src, outCoord());
-	     }
-	 }
-
- -

If you create a Shader instance by loading the byte code for this shader, the ShaderData - instance in its data property contains these properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyData typeValue
nameString"DoNothing"
nameSpaceString"Adobe::Example"
versionString"1"
descriptionString"A shader that does nothing, but does it well."
srcShaderInput[A ShaderInput instance]
sizeShaderParameter[A ShaderParameter instance, with properties for the parameter metadata]
radiusShaderParameter[A ShaderParameter instance, with properties for the parameter metadata]
- -

Note that any input image or parameter that is defined in the shader source code - but not used in the shader's evaluatePixel() function is removed when the - shader is compiled to byte code. In that case, there is no corresponding ShaderInput - or ShaderParameter instance added as a property of the ShaderData instance.

- -

Generally, developer code does not create a ShaderData instance. - A ShaderData instance containing data, parameters, and inputs - for a shader is available as the Shader instance's data - property.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.Shader.data -
-flash.display.ShaderInput -
-flash.display.ShaderParameter -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ShaderData(byteCode:ByteArray)
-
- Creates a ShaderData instance.
-		ShaderData
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
ShaderData()constructor
-
-public function ShaderData(byteCode:ByteArray) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a ShaderData instance. Generally, developer code does not call - the ShaderData constructor directly. A ShaderData instance containing - data, parameters, and inputs for a Shader instance is accessed using - its data property. - -

Parameters - - - - -
byteCode:ByteArray — The shader's byte code. - -
-

-See also -

-
-flash.display.Shader.data -
-
- -
Examples
-
examples\ShaderDataExample.1
-
The following example loads a shader and enumerates the ShaderData instance - in its data property to display the input, parameters, and metadata properties of - the shader. - -

Note that this example assumes there's a shader bytecode file named "donothing.pbj" in the same - directory as the output directory for the application.

-
-
-
-//
-// Source code for the shader:
-//
-<languageVersion : 1.0;>
-
-kernel DoNothing
-<
-    namespace: "Adobe::Example";
-    vendor: "Adobe examples";
-    version: 1;
-    description: "A shader that does nothing, but does it well.";
->
-{
-    input image4 src;
-    
-    output pixel4 dst;
-    
-    parameter float2 size
-    <
-        description: "The size of the image to which the shader is applied";
-        minValue: float2(0.0, 0.0);
-        maxValue: float2(100.0, 100.0);
-        defaultValue: float2(50.0, 50.0);
-    >;
-    
-    parameter float radius
-    <
-        description: "The radius of the effect";
-        minValue: float(0.0);
-        maxValue: float(50.0);
-        defaultValue: float(25.0);
-    >;
-
-    void evaluatePixel()
-    {
-        float2 one = (radius / radius) * (size / size);
-        dst = sampleNearest(src, outCoord());
-    }
-}
-
-//
-// ActionScript source code:
-//
-package {
-	import flash.display.Shader;
-	import flash.display.Sprite;
-	import flash.events.Event;
-	import flash.net.URLLoader;
-	import flash.net.URLLoaderDataFormat;
-	import flash.net.URLRequest;
-
-	public class ShaderDataExample extends Sprite {
-		
-		private var loader:URLLoader;
-		
-		public function ShaderDataExample() {
-			loader = new URLLoader();
-			loader.dataFormat = URLLoaderDataFormat.BINARY;
-			loader.addEventListener(Event.COMPLETE, loadCompleteHandler);
-			loader.load(new URLRequest("donothing.pbj"));
-		}
-		
-		private function loadCompleteHandler(event:Event):void {
-			var shader:Shader = new Shader();
-			shader.byteCode = loader.data;
-			
-			for (var p:String in shader.data) {
-				trace(p, ":", shader.data[p]);
-				for (var d:String in shader.data[p]) {
-					trace("\t", d, ":", shader.data[p][d]);
-				}
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/ShaderInput.html b/html-docs/flash/display/ShaderInput.html deleted file mode 100644 index 6b9b815..0000000 --- a/html-docs/flash/display/ShaderInput.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - - - - - -flash.display.ShaderInput (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final dynamic class ShaderInput
InheritanceShaderInput Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- A ShaderInput instance represents a single input image for - a shader kernel. A kernel can be defined to accept zero, one, or more - source images that are used in the kernel execution. A ShaderInput - instance provides a mechanism for specifying the input image - that is used when the shader executes. To specify a value for the input, - create a BitmapData, ByteArray, or Vector.<Number> instance containing the image data - and assign it to the input property. - -

The ShaderInput instance representing a Shader instance's input image - is accessed as a property of the Shader instance's - data property. The ShaderInput property has the same name - as the input's name in the shader code. - For example, if a shader defines an input named src, - the ShaderInput instance representing the src input - is available as the src property, as this example shows:

- - 
myShader.data.src.input = new BitmapData(50, 50, true, 0xFF990000);
- -

For some uses of a Shader instance, you do not - need to specify an input image, because it is automatically specified by the - operation. You only need to specify an input when a Shader is used for the following:

- -
    -
  • Shader fill
    • -
  • ShaderFilter, only for the second or additional inputs - if the shader is defined to use more than one input. (The object to which the - filter is applied is automatically used as the first input.)
    • -
  • Shader blend mode, only for the third or additional inputs if the shader is - defined to use more than two inputs. (The objects being blended - are automatically used as the first and second inputs.)
    • -
  • ShaderJob background execution
    • -
- -

If the shader is being executed using a ShaderJob instance to process a - ByteArray containing a linear array of data, set the ShaderInput instance's - height to 1 and width to the number of 32-bit floating - point values in the ByteArray. In that case, the input in the shader must be defined with - the image1 data type.

- -

Generally, developer code does not create a ShaderInput instance - directly. A ShaderInput instance is created for each of a shader's inputs - when the Shader instance is created.

- -

-

-See also -

-
-flash.display.ShaderData -
-flash.display.Shader.data -
-flash.display.ShaderJob -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  channels : int -
[read-only] - The number of channels that a shader input expects.
-		ShaderInput
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  height : int -
- The height of the shader input.
-		ShaderInput
  index : int -
[read-only] - The zero-based index of the input in the shader, indicating the order - of the input definitions in the shader.
-		ShaderInput
  input : Object -
- - The input data that is used when the shader executes.
-		ShaderInput
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  width : int -
- The width of the shader input.
-		ShaderInput
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ShaderInput()
-
- Creates a ShaderInput instance.
-		ShaderInput
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
channelsproperty
-
-channels:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The number of channels that a shader input expects. This property must be - accounted for when the input data is a ByteArray or - Vector.<Number> instance. - -

Implementation -
-    public function get channels():int -
-
- - - - - -
heightproperty 
-
-height:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The height of the shader input. This property is only used when the input data - is a ByteArray or Vector.<Number> instance. When the input is a BitmapData - instance the height is automatically determined. -

Implementation -
-    public function get height():int -
-    public function set height(value:int):void -
-
- - - - - -
indexproperty 
-
-index:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The zero-based index of the input in the shader, indicating the order - of the input definitions in the shader. -

Implementation -
-    public function get index():int -
-
- - - - - -
inputproperty 
-
-input:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- - The input data that is used when the shader executes. This property can be - a BitmapData instance, a ByteArray instance, or a Vector.<Number> instance. - -

If a ByteArray value is assigned to the input property, the following - conditions must be met:

- -
    -
  • The height and width properties must be set.
    • -
  • The byte array's contents must only consist of 32-bit floating-point values. - These values can be written using the ByteArray.writeFloat() method.
    • -
  • The total length in bytes of the ByteArray must be exactly width times - height times channels times 4.
    • -
  • The byte array's endian property must be Endian.LITTLE_ENDIAN.
    • -
- -

If a Vector.<Number> instance is assigned to the input property, the - length of the Vector must be equal to width times height times - channels.

- - Implementation -
-    public function get input():Object -
-    public function set input(value:Object):void -
-
- - - - - -
widthproperty 
-
-width:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The width of the shader input. This property is only used when the input data - is a ByteArray or Vector.<Number> instance. When the input is a BitmapData - instance the width is automatically determined. -

Implementation -
-    public function get width():int -
-    public function set width(value:int):void -
-
- -
Constructor detail
- - - - - -
ShaderInput()constructor
-
-public function ShaderInput() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a ShaderInput instance. Developer code does - not call the ShaderInput constructor - directly. A ShaderInput instance is created for each of a shader's inputs - when the Shader instance is created. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/ShaderJob.html b/html-docs/flash/display/ShaderJob.html deleted file mode 100644 index 69618ed..0000000 --- a/html-docs/flash/display/ShaderJob.html +++ /dev/null @@ -1,837 +0,0 @@ - - - - - - - - -flash.display.ShaderJob (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class ShaderJob
InheritanceShaderJob Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- A ShaderJob instance is used to execute a shader operation in stand-alone mode. - The shader operation executes and returns its result data. It is up to the - developer to determine how to use the result. - -

There are two primary reasons for using a shader in stand-alone mode:

- -
    -
  • Processing non-image data: Using a ShaderJob instance you have control - over input values and over how the shader result is used. The shader can - return the result as binary data or number data instead of image data.
    • -
  • Background processing: Some shaders are complex and require a notable - amount of time to execute. Executing a complex shader in the main - execution of an application could slow down other parts of the application - such as user interaction or updating the screen. Using a ShaderJob instance, - you can execute the shader in the background. - When the shader is executed in this way, the shader operation runs separate - from the main execution of the application.
    • -
- -

The shader property (or constructor parameter) specifies the - Shader instance representing the shader that is used for the operation. You - provide any parameter or input that the shader expects using the - associated ShaderParameter or ShaderInput instance.

- -

Before execution a ShaderJob operation, you provide an object into which the - result is written, by setting it as the value of the target property. - When the shader operation completes the result is written into the target object.

- -

To begin a background shader operation, - call the start() method. When the operation finishes the result is - written into the target object. At that point the ShaderJob - instance dispatches a complete - event, notifying listeners that the result is available.

- -

To execute a shader synchronously (that is, not running in the background), call - the start() method and pass true as an argument. The shader - runs in the main execution thread and your code pauses until the operation completes. When - it finishes the result is written into the target object. At that point - the application continues running at the next line of code.

- -

-

-See also -

-
-Shader -
-ShaderInput -
-ShaderParameter -
-ShaderEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  height : int -
- The height of the result data in the target if it is - a ByteArray or Vector.<Number> instance.
-		ShaderJob
  progress : Number -
[read-only] - The progress of a running shader.
-		ShaderJob
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  shader : Shader -
- The shader that's used for the operation.
-		ShaderJob
  target : Object -
- The object into which the result of the shader operation is written.
-		ShaderJob
  width : int -
- The width of the result data in the target if it is - a ByteArray or Vector.<Number> instance.
-		ShaderJob
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ShaderJob(shader:Shader = null, target:Object = null, width:int = 0, height:int = 0)
-
- -
-		ShaderJob
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-cancel():void -
-
- Cancels the currently running shader operation.
-		ShaderJob
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-start(waitForCompletion:Boolean = false):void -
-
- Starts a shader operation in synchronous or asynchronous mode, according to the - value of the waitForCompletion parameter.
-		ShaderJob
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-complete -
-		 - Dispatched when a ShaderJob that executes asynchronously finishes processing - the data using the shader.ShaderJob
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
heightproperty
-
-height:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The height of the result data in the target if it is - a ByteArray or Vector.<Number> instance. The size of the - ByteArray or Vector.<Number> instance is enlarged - if necessary and existing data is overwritten. -

Implementation -
-    public function get height():int -
-    public function set height(value:int):void -
-
- - - - - -
progressproperty 
-
-progress:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The progress of a running shader. This property is a value from 0 through 1. - Zero is the initial value (0% complete). One indicates that the shader - has completed its operation. -

If the cancel() method is called this property becomes - undefined, and its value cannot be used reliably until the - shader operation starts again.

- Implementation -
-    public function get progress():Number -
-
- - - - - -
shaderproperty 
-
-shader:Shader  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The shader that's used for the operation. Any input or parameter that the - shader expects must be provided using the ShaderInput or ShaderParameter - property of the Shader instance's data property. An input must - be provided using its corresponding ShaderInput even if it is the same as - the target object. - -

To process a ByteArray containing a linear array of data (as opposed to - image data) set the corresponding ShaderInput instance's height - to 1 and width to the number of 32-bit floating-point values in - the ByteArray. In that case, the input in the shader must be defined with - the image1 data type.

- - Implementation -
-    public function get shader():Shader -
-    public function set shader(value:Shader):void -
-

-See also -

-
-flash.display.ShaderData -
-flash.display.ShaderInput -
-flash.display.ShaderParameter -
-
- - - - - -
targetproperty 
-
-target:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The object into which the result of the shader operation is written. - This object must be a BitmapData, ByteArray, or Vector.<Number> instance. -

Implementation -
-    public function get target():Object -
-    public function set target(value:Object):void -
-
- - - - - -
widthproperty 
-
-width:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The width of the result data in the target if it is - a ByteArray or Vector.<Number> instance. The size of the - ByteArray or Vector.<Number> instance is enlarged - if necessary and existing data is overwritten. -

Implementation -
-    public function get width():int -
-    public function set width(value:int):void -
-
- -
Constructor detail
- - - - - -
ShaderJob()constructor
-
-public function ShaderJob(shader:Shader = null, target:Object = null, width:int = 0, height:int = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
shader:Shader (default = null) — The shader to use for the operation. - -
 
target:Object (default = null) — The object into which the result of the shader operation - is written. This argument must be a BitmapData, ByteArray, or - Vector.<Number> instance. - -
 
width:int (default = 0) — The width of the result data in the target if it is - a ByteArray or Vector.<Number> instance. The size of the - ByteArray or Vector.<Number> instance is enlarged - if necessary and existing data is overwritten. - -
 
height:int (default = 0) — The height of the result data in the target if it is - a ByteArray or Vector.<Number> instance. The size of the - ByteArray or Vector.<Number> instance is enlarged - if necessary and existing data is overwritten. - -
-
- -
Method detail
- - - - - -
cancel()method
-
-public function cancel():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Cancels the currently running shader operation. Any result data that is already - computed is discarded. The complete event is not dispatched. -

Calling cancel() multiple times has no additional effect.

-
- - - - - -
start()method 
-
-public function start(waitForCompletion:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Starts a shader operation in synchronous or asynchronous mode, according to the - value of the waitForCompletion parameter. - -

In asynchronous mode (when waitForCompletion - is false), which is the default, the - ShaderJob execution runs in the background. The shader operation does not affect the - responsiveness of the display or other operations. In asynchronous mode the start() - call returns immediately and the program continues with the next line of code. When the asynchronous - shader operation finishes, the result is available and the complete - event is dispatched.

- -

Only one background ShaderJob operation - executes at a time. Shader operations are held in a queue until they execute. - If you call the start() method while a shader - operation is executing, the additional operation is added to the end of the queue. - Later, when its turn comes, it executes.

- -

To execute a shader operation in synchronous mode, call start() with a - true value for the waitForCompletion parameter (the only parameter). - Your code pauses at the point where start() is called until the shader operation - completes. At that point the result is available and execution continues with the next line - of code.

- -

When you call the start() method the Shader instance in the shader - property is copied internally. The - shader 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 shader processing. To incorporate shader changes - into the shader processing, call the cancel() method - (if necessary) and call the start() method again to restart the shader processing.

- -

While a shader operation is executing, the target object's value - is not changed. When the operation finishes (and the complete - event is dispatched in asynchronous mode) the entire result is written to the - target object at one time. If the target object is a - BitmapData instance and its dispose() method is called - before the operation finishes, the complete event is still - dispatched in asynchronous mode. However, the result data is not - written to the BitmapData object because it is in a disposed state.

- - Parameters - - - - -
waitForCompletion:Boolean (default = false) — whether to execute the shader in the background - (false, the default) or in the main program - execution (true). - -
-
-Events - - - - -
complete:ShaderEvent — Dispatched when the operation finishes, if the - start() method is called with a - waitForCompletion argument of true.
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — When the target property is null or is not - a BitmapData, ByteArray, or Vector.<Number> instance. - -
 
ArgumentError — When the shader specifies an image input that isn't provided. - -
 
ArgumentError — When a ByteArray or Vector.<Number> instance is used as - an input and the width - and height properties aren't specified for the - ShaderInput, or the specified values don't match the amount of - data in the input object. See the ShaderInput.input - property for more information. - -
-
-
Event detail
- - - - - -
completeevent 
-
-Event object type: flash.events.ShaderEvent -
-ShaderEvent.type property = flash.events.ShaderEvent.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Dispatched when a ShaderJob that executes asynchronously finishes processing - the data using the shader. A ShaderJob instance executes asynchronously when the - start() method is called with a false value for the - waitForCompletion parameter. - -

- Defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblesfalse
bitmapDataThe BitmapData object - containing the result of the operation that finished (or - null if the target wasn't a BitmapData object).
byteArrayThe ByteArray object containing - the result of the operation that finished (or null if - the target wasn't a ByteArray object).
cancelablefalse; there is - no default behavior to cancel.
currentTargetThe object that is - actively processing the event object with an event listener.
targetThe ShaderJob object reporting completion.
vectorThe Vector.<Number> instance - containing the result of the operation that finished (or null if - the target wasn't a Vector.<Number> instance).
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/ShaderParameter.html b/html-docs/flash/display/ShaderParameter.html deleted file mode 100644 index e1b2376..0000000 --- a/html-docs/flash/display/ShaderParameter.html +++ /dev/null @@ -1,588 +0,0 @@ - - - - - - - - -flash.display.ShaderParameter (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final dynamic class ShaderParameter
InheritanceShaderParameter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- A ShaderParameter instance represents a single input parameter of - a shader kernel. A kernel can be defined to accept zero, one, or more - parameters that are used in the kernel execution. A ShaderParameter - provides information about the parameter, such as the type of data - it expects. It also provides a mechanism for setting the parameter - value that is used when the shader executes. To specify a value or - values for the shader parameter, - create an Array containing the value or values and assign it to the - value property. - -

A ShaderParameter instance representing a parameter - for a Shader instance is accessed as a property of the Shader instance's - data property. The ShaderParameter property has the same name - as the parameter's name in the shader code. - For example, if a shader defines a parameter named radius, - the ShaderParameter instance representing the radius parameter - is available as the radius property, as shown here:

- - 
var radiusParam:ShaderParameter = myShader.data.radius;
- -

In addition to the defined properties of the ShaderParameter class, - each ShaderParameter instance has additional properties - corresponding to any metadata defined for the parameter. These properties - are added to the ShaderParameter object when it is created. The properties' - names match the metadata names specified in the shader's source code. - The data type of each property varies according to the data type of the - corresponding metadata. A text metadata value such as "description" is a String - instance. A metadata property with a non-string value (such as minValue - or defaultValue) is represented as an Array instance. The number of elements and - element data types correspond to the metadata values.

- -

For example, suppose a shader includes the following two parameter declarations:

- - 
-	 parameter float2 size
-	 <
-	     description: "The size of the image to which the kernel is applied";
-	     minValue: float2(0.0, 0.0);
-	     maxValue: float2(100.0, 100.0);
-	     defaultValue: float2(50.0, 50.0);
-	 >;
-	 
-	 parameter float radius
-	 <
-	     description: "The radius of the effect";
-	     minValue: 0.0;
-	     maxValue: 50.0;
-	     defaultValue: 25.0;
-	 >;
-
- -

The ShaderParameter instance - corresponding to the size parameter has the following metadata - properties in addition to its built-in properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Property nameData typeValue
nameString"size"
descriptionString"The size of the image to which the kernel is applied"
minValueArray[0, 0]
maxValueArray[100, 100]
defaultValueArray[50, 50]
- -

The ShaderParameter corresponding to the radius parameter - has the following additional properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Property nameData typeValue
nameString"radius"
descriptionString"The radius of the effect"
minValueArray[0]
maxValueArray[50]
defaultValueArray[25]
- -

Generally, developer code does not create a ShaderParameter instance - directly. A ShaderParameter instance is created for each of a shader's - parameters when the Shader instance is created.

- -

-

-See also -

-
-flash.display.ShaderData -
-flash.display.Shader.data -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  index : int -
[read-only] - The zero-based index of the parameter.
-		ShaderParameter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  type : String -
[read-only] - The data type of the parameter as defined in the shader.
-		ShaderParameter
  value : Array -
- The value or values that are passed in as the parameter value to the shader.
-		ShaderParameter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ShaderParameter()
-
- Creates a ShaderParameter instance.
-		ShaderParameter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
indexproperty
-
-index:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The zero-based index of the parameter. -

Implementation -
-    public function get index():int -
-
- - - - - -
typeproperty 
-
-type:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The data type of the parameter as defined in the shader. The set of - possible values for the type property is defined by the - constants in the ShaderParameterType class. - -

Implementation -
-    public function get type():String -
-

-See also -

-
-flash.display.ShaderParameterType -
-
- - - - - -
valueproperty 
-
-value:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The value or values that are passed in as the parameter value to the shader. - The value property is an indexed Array. The number and type of - the elements of the Array correspond to the data type of the parameter, which - can be determined using the type property. - -

The following table indicates the parameter type and corresponding - number and data type of the value Array's elements:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter type# ElementsElement data type
float (ShaderParameterType.FLOAT)1Number
float2 (ShaderParameterType.FLOAT2)2Number
float3 (ShaderParameterType.FLOAT3)3Number
float4 (ShaderParameterType.FLOAT4)4Number
int (ShaderParameterType.INT)1int or uint
int2 (ShaderParameterType.INT2)2int or uint
int3 (ShaderParameterType.INT3)3int or uint
int4 (ShaderParameterType.INT4)4int or uint
bool (ShaderParameterType.BOOL)1Boolean
bool2 (ShaderParameterType.BOOL2)2Boolean
bool3 (ShaderParameterType.BOOL3)3Boolean
bool4 (ShaderParameterType.BOOL4)4Boolean
float2x2 (ShaderParameterType.MATRIX2X2)4Number
float3x3 (ShaderParameterType.MATRIX3X3)9Number
float4x4 (ShaderParameterType.MATRIX4X4)16Number
- -

For the matrix parameter types, the array elements fill the rows of - the matrix, then the columns. For example, suppose the following line - of ActionScript is used to fill a float2x2 - parameter named myMatrix:

- - 
myShader.data.myMatrix.value = [.1, .2, .3, .4];
- -

Within the shader, the matrix elements have the following values:

- -
    -
  • myMatrix[0][0]: .1
    • -
  • myMatrix[0][1]: .2
    • -
  • myMatrix[1][0]: .3
    • -
  • myMatrix[1][1]: .4
    • -
- Implementation -
-    public function get value():Array -
-    public function set value(value:Array):void -
-
- -
Constructor detail
- - - - - -
ShaderParameter()constructor
-
-public function ShaderParameter() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a ShaderParameter instance. Developer code does - not call the ShaderParameter constructor - directly. A ShaderParameter instance is created for each of a - shader's parameters when the Shader instance is created. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/ShaderParameterType.html b/html-docs/flash/display/ShaderParameterType.html deleted file mode 100644 index 4e8ff8b..0000000 --- a/html-docs/flash/display/ShaderParameterType.html +++ /dev/null @@ -1,761 +0,0 @@ - - - - - - - - -flash.display.ShaderParameterType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class ShaderParameterType
InheritanceShaderParameterType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- This class defines the constants that represent the possible values for - the ShaderParameter class's type property. Each constant - represents one of the data types available in Flash Player for - parameters in the Pixel Bender shader language. - -

-

-See also -

-
-flash.display.ShaderParameter.type -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  BOOL : String = "bool"
[static] - Indicates that the shader parameter is defined as a - bool value, equivalent to a single Boolean instance - in ActionScript.
-		ShaderParameterType
  BOOL2 : String = "bool2"
[static] - Indicates that the shader parameter is defined as a - bool2 value, equivalent to an Array of two Boolean instances - in ActionScript.
-		ShaderParameterType
  BOOL3 : String = "bool3"
[static] - Indicates that the shader parameter is defined as a - bool3 value, equivalent to an Array of three Boolean instances - in ActionScript.
-		ShaderParameterType
  BOOL4 : String = "bool4"
[static] - Indicates that the shader parameter is defined as a - bool4 value, equivalent to an Array of four Boolean instances - in ActionScript.
-		ShaderParameterType
  FLOAT : String = "float"
[static] - Indicates that the shader parameter is defined as a - float value, equivalent to a single Number instance - in ActionScript.
-		ShaderParameterType
  FLOAT2 : String = "float2"
[static] - Indicates that the shader parameter is defined as a - float2 value, equivalent to an Array of two Number instances - in ActionScript.
-		ShaderParameterType
  FLOAT3 : String = "float3"
[static] - Indicates that the shader parameter is defined as a - float3 value, equivalent to an Array of three Number instances - in ActionScript.
-		ShaderParameterType
  FLOAT4 : String = "float4"
[static] - Indicates that the shader parameter is defined as a - float4 value, equivalent to an Array of four Number instances - in ActionScript.
-		ShaderParameterType
  INT : String = "int"
[static] - Indicates that the shader parameter is defined as an - int value, equivalent to a single int or uint instance - in ActionScript.
-		ShaderParameterType
  INT2 : String = "int2"
[static] - Indicates that the shader parameter is defined as an - int2 value, equivalent to an Array of two int or uint - instances in ActionScript.
-		ShaderParameterType
  INT3 : String = "int3"
[static] - Indicates that the shader parameter is defined as an - int3 value, equivalent to an Array of three int or uint - instances in ActionScript.
-		ShaderParameterType
  INT4 : String = "int4"
[static] - Indicates that the shader parameter is defined as an - int4 value, equivalent to an Array of four int or uint - instances in ActionScript.
-		ShaderParameterType
  MATRIX2X2 : String = "matrix2x2"
[static] - Indicates that the shader parameter is defined as a - float2x2 value, equivalent to a 2-by-2 matrix.
-		ShaderParameterType
  MATRIX3X3 : String = "matrix3x3"
[static] - Indicates that the shader parameter is defined as a - float3x3 value, equivalent to a 3-by-3 matrix.
-		ShaderParameterType
  MATRIX4X4 : String = "matrix4x4"
[static] - Indicates that the shader parameter is defined as a - float4x4 value, equivalent to a 4-by-4 matrix.
-		ShaderParameterType
-
- -
- -
Constant detail
- - - - - -
BOOLconstant
-
-public static const BOOL:String = "bool" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - bool value, equivalent to a single Boolean instance - in ActionScript. - -

Note that even though the parameter only expects a single value, - the ShaderParameter.value property is an Array, so the single value - must be the only element of an Array assigned to the - value property, like this:

- - 
-		 // assumes the shader has a parameter named "param"
-		 // whose data type is bool
-		 myShader.data.param.value = [true];
-
- -
- - - - - -
BOOL2constant 
-
-public static const BOOL2:String = "bool2" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - bool2 value, equivalent to an Array of two Boolean instances - in ActionScript. - -

- - - - - -
BOOL3constant 
-
-public static const BOOL3:String = "bool3" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - bool3 value, equivalent to an Array of three Boolean instances - in ActionScript. - -

- - - - - -
BOOL4constant 
-
-public static const BOOL4:String = "bool4" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - bool4 value, equivalent to an Array of four Boolean instances - in ActionScript. - -

- - - - - -
FLOATconstant 
-
-public static const FLOAT:String = "float" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - float value, equivalent to a single Number instance - in ActionScript. - -

Note that even though the parameter only expects a single value, - the ShaderParameter.value property is an Array, so the single value - must be the only element of an Array assigned to the - value property, like this:

- - 
-		 // assumes the shader has a parameter named "param"
-		 // whose data type is float
-		 myShader.data.param.value = [22.5];
-
- -

-See also -

-
-flash.display.ShaderParameter.type -
-
- - - - - -
FLOAT2constant 
-
-public static const FLOAT2:String = "float2" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - float2 value, equivalent to an Array of two Number instances - in ActionScript. - -

-See also -

-
-flash.display.ShaderParameter.type -
-
- - - - - -
FLOAT3constant 
-
-public static const FLOAT3:String = "float3" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - float3 value, equivalent to an Array of three Number instances - in ActionScript. - -

- - - - - -
FLOAT4constant 
-
-public static const FLOAT4:String = "float4" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - float4 value, equivalent to an Array of four Number instances - in ActionScript. - -

- - - - - -
INTconstant 
-
-public static const INT:String = "int" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as an - int value, equivalent to a single int or uint instance - in ActionScript. - -

Note that even though the parameter only expects a single value, - the ShaderParameter.value property is an Array, so the single value - must be the only element of an Array assigned to the - value property, like this:

- - 
-		 // assumes the shader has a parameter named "param"
-		 // whose data type is int
-		 myShader.data.param.value = [275];
-
- -
- - - - - -
INT2constant 
-
-public static const INT2:String = "int2" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as an - int2 value, equivalent to an Array of two int or uint - instances in ActionScript. - -

- - - - - -
INT3constant 
-
-public static const INT3:String = "int3" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as an - int3 value, equivalent to an Array of three int or uint - instances in ActionScript. - -

- - - - - -
INT4constant 
-
-public static const INT4:String = "int4" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as an - int4 value, equivalent to an Array of four int or uint - instances in ActionScript. - -

- - - - - -
MATRIX2X2constant 
-
-public static const MATRIX2X2:String = "matrix2x2" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - float2x2 value, equivalent to a 2-by-2 matrix. This matrix is represented as an - Array of four Number instances in ActionScript. - -

- - - - - -
MATRIX3X3constant 
-
-public static const MATRIX3X3:String = "matrix3x3" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - float3x3 value, equivalent to a 3-by-3 matrix. This matrix is represented as an - Array of nine Number instances in ActionScript. - -

- - - - - -
MATRIX4X4constant 
-
-public static const MATRIX4X4:String = "matrix4x4" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the shader parameter is defined as a - float4x4 value, equivalent to a 4-by-4 matrix. This matrix is represented as an - Array of 16 Number instances in ActionScript. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/ShaderPrecision.html b/html-docs/flash/display/ShaderPrecision.html deleted file mode 100644 index 5aeac34..0000000 --- a/html-docs/flash/display/ShaderPrecision.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - - -flash.display.ShaderPrecision (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class ShaderPrecision
InheritanceShaderPrecision Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- This class defines the constants that represent the possible values for - the Shader class's precisionHint property. Each constant - represents one of the precision modes for executing shader operations. - -

The precision mode selection affects the following shader operations. - These operations are faster on an Intel processor - with the SSE instruction set:

- -
    -
  • sin(x)
    • -
  • cos(x)
    • -
  • tan(x)
    • -
  • asin(x)
    • -
  • acos(x)
    • -
  • atan(x)
    • -
  • atan(x, y)
    • -
  • exp(x)
    • -
  • exp2(x)
    • -
  • log(x)
    • -
  • log2(x)
    • -
  • pow(x, y)
    • -
  • reciprocal(x)
    • -
  • sqrt(x)
    • -
- -

-

-See also -

-
-flash.display.Shader.precisionHint -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  FAST : String = "fast"
[static] - Represents fast precision mode.
-		ShaderPrecision
  FULL : String = "full"
[static] - Represents full precision mode.
-		ShaderPrecision
-
- -
- -
Constant detail
- - - - - -
FASTconstant
-
-public static const FAST:String = "fast" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Represents fast precision mode. - -

Fast precision mode is designed for - maximum performance but does not work consistently on different platforms - and individual CPU configurations. In many cases, this level of precision - is sufficient to create graphic effects without visible artifacts.

-

It is usually faster to use fast precision mode than to use lookup tables.

- -

-See also -

-
-flash.display.Shader.precisionHint -
-
- - - - - -
FULLconstant 
-
-public static const FULL:String = "full" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Represents full precision mode. - -

In full precision mode, the shader computes all math - operations to the full width of the IEEE 32-bit floating standard. This mode provides - consistent behavior on all platforms. In this mode, some math operations such - as trigonometric and exponential functions can be slow.

- -

-See also -

-
-flash.display.Shader.precisionHint -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/Shape.html b/html-docs/flash/display/Shape.html deleted file mode 100644 index 80286ce..0000000 --- a/html-docs/flash/display/Shape.html +++ /dev/null @@ -1,818 +0,0 @@ - - - - - - - - -flash.display.Shape (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class Shape
InheritanceShape Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- This class is used to create lightweight shapes using the ActionScript drawing application program interface (API). - The Shape class includes a graphics property, which lets you access methods from the Graphics class. - -

The Sprite class also includes a graphicsproperty, and it includes other features not available to the - Shape class. For example, a Sprite object is a display object container, whereas a Shape object is not (and cannot contain - child display objects). For this reason, Shape objects consume less memory than Sprite objects that contain the - same graphics. However, a Sprite object supports user input events, while a Shape object does not.

-

-

-View the examples. -

-

-See also -

-
-flash.display.Graphics -
-flash.display.Sprite -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
  graphics : Graphics -
[read-only] - Specifies the Graphics object belonging to this Shape object, where vector - drawing commands can occur.
-		Shape
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Shape()
-
- Creates a new Shape object.
-		Shape
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
-
- -
- -
Property detail
- - - - - -
graphicsproperty
-
-graphics:Graphics  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies the Graphics object belonging to this Shape object, where vector - drawing commands can occur. -

Implementation -
-    public function get graphics():Graphics -
-
- -
Constructor detail
- - - - - -
Shape()constructor
-
-public function Shape() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a new Shape object. -

- -
Examples
-
examples\ShapeExample
-
The following example uses the ShapeExample class to draw a circle, - a rounded rectangle, and a square. This task is accomplished by performing the following steps: - -
    -
  1. Declare a size property for later use in determining the size of each shape.
    2. - -
  2. Declare properties that set the background color to orange, the border color to - dark gray, the border size to 0 pixels, the corner radius to 9 pixels, and set the space - between the stage edge and the other objects to be 5 pixels.
    3. - -
  3. Use the properties declared in the preceding steps along with the built-in methods of the - Graphics class to draw the circle, rounded rectangle, and square at coordinates x = 0, y = 0.
    4. - -
  4. Redraw each of the shapes along the top of the stage, starting at x = 5, y = 5, with - a 5-pixel spacing between shapes by using the refreshLayout() method.
    5. - -
-
-
-
-package {
-	import flash.display.DisplayObject;
-	import flash.display.Graphics;
-	import flash.display.JointStyle;
-	import flash.display.LineScaleMode;
-	import flash.display.Shape;
-	import flash.display.Sprite;
-
-	public class ShapeExample extends Sprite {
-		private var size:uint 		  = 80;
-		private var bgColor:uint 	  = 0xFFCC00;
-		private var borderColor:uint  = 0x666666;
-		private var borderSize:uint   = 0;
-		private var cornerRadius:uint = 9;
-		private var gutter:uint 	  = 5;
-
-		public function ShapeExample() {
-			doDrawCircle();
-			doDrawRoundRect();
-			doDrawRect();
-			refreshLayout();
-		}
-
-		private function refreshLayout():void {
-			var ln:uint = numChildren;
-			var child:DisplayObject;
-			var lastChild:DisplayObject = getChildAt(0);
-			lastChild.x = gutter;
-			lastChild.y = gutter;
-			for (var i:uint = 1; i < ln; i++) {
-				child = getChildAt(i);
-				child.x = gutter + lastChild.x + lastChild.width;
-				child.y = gutter;
-				lastChild = child;
-			}
-		}
-
-		private function doDrawCircle():void {
-			var child:Shape = new Shape();
-			var halfSize:uint = Math.round(size/2);
-			child.graphics.beginFill(bgColor);
-			child.graphics.lineStyle(borderSize, borderColor);
-			child.graphics.drawCircle(halfSize, halfSize, halfSize);
-			child.graphics.endFill();
-			addChild(child);
-		}
-
-		private function doDrawRoundRect():void {
-			var child:Shape = new Shape();
-			child.graphics.beginFill(bgColor);
-			child.graphics.lineStyle(borderSize, borderColor);
-			child.graphics.drawRoundRect(0, 0, size, size, cornerRadius);
-			child.graphics.endFill();
-			addChild(child);
-		}
-
-		private function doDrawRect():void {
-			var child:Shape = new Shape();
-			child.graphics.beginFill(bgColor);
-			child.graphics.lineStyle(borderSize, borderColor);
-			child.graphics.drawRect(0, 0, size, size);
-			child.graphics.endFill();
-			addChild(child);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/SimpleButton.html b/html-docs/flash/display/SimpleButton.html deleted file mode 100644 index e16c446..0000000 --- a/html-docs/flash/display/SimpleButton.html +++ /dev/null @@ -1,1818 +0,0 @@ - - - - - - - - -flash.display.SimpleButton (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class SimpleButton
InheritanceSimpleButton Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The SimpleButton class lets you control all instances of button symbols in a SWF - file. -

In Flash Professional, you can give a button an instance name in the - Property inspector. SimpleButton instance names are displayed in the Movie - Explorer and in the Insert Target Path dialog box in the Actions - panel. After you create an instance of a button in Flash Professional, you can - use the methods and properties of the SimpleButton class to manipulate buttons - with ActionScript.

- -

In ActionScript 3.0, you use the new SimpleButton() constructor to create a - SimpleButton instance.

-

The SimpleButton class inherits from the InteractiveObject class.

-

Starting with Player version 11.2 / AIR version 3.2, the parent property - of the states of a SimpleButton object will report null if queried.

-

-

-View the examples. -

-

-See also -

-
-InteractiveObject class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityImplementation : AccessibilityImplementation -
- The current accessibility implementation (AccessibilityImplementation) - for this InteractiveObject instance.
-		InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcontextMenu : NativeMenu -
- Specifies the context menu associated with this object.
-		InteractiveObject
 InheriteddoubleClickEnabled : Boolean -
- Specifies whether the object receives doubleClick events.
-		InteractiveObject
  downState : DisplayObject -
- Specifies a display object that is used as the visual - object for the button "Down" state —the state that the button is in when the user - selects the hitTestState object.
-		SimpleButton
  enabled : Boolean -
- A Boolean value that specifies whether a button is enabled.
-		SimpleButton
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 InheritedfocusRect : Object -
- Specifies whether this object displays a focus rectangle.
-		InteractiveObject
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
  hitTestState : DisplayObject -
- Specifies a display object that is used as the hit testing object for the button.
-		SimpleButton
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseEnabled : Boolean -
- Specifies whether this object receives mouse, or other user input, messages.
-		InteractiveObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedneedsSoftKeyboard : Boolean -
- Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - when this InteractiveObject instance receives focus.
-		InteractiveObject
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
  overState : DisplayObject -
- Specifies a display object that is used as the visual - object for the button over state — the state that the button is in when - the pointer is positioned over the button.
-		SimpleButton
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
 InheritedsoftKeyboard : String -
- Controls the appearance of the soft keyboard.
-		InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle -
- Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
-		InteractiveObject
  soundTransform : SoundTransform -
- The SoundTransform object assigned to this button.
-		SimpleButton
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
 InheritedtabEnabled : Boolean -
- Specifies whether this object is in the tab order.
-		InteractiveObject
 InheritedtabIndex : int -
- Specifies the tab ordering of objects in a SWF file.
-		InteractiveObject
  trackAsMenu : Boolean -
- Indicates whether other display objects that are SimpleButton or MovieClip objects can receive - user input release events.
-		SimpleButton
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
  upState : DisplayObject -
- Specifies a display object that is used as the visual - object for the button up state — the state that the button is in when - the pointer is not positioned over the button.
-		SimpleButton
  useHandCursor : Boolean -
- A Boolean value that, when set to true, indicates whether - the hand cursor is shown when the pointer rolls over a button.
-		SimpleButton
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SimpleButton(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null)
-
- Creates a new SimpleButton instance.
-		SimpleButton
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-requestSoftKeyboard():Boolean -
-
- Raises a virtual keyboard.
-		InteractiveObject
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-clear -
-		 - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 Inherited -
-click -
-		 - Dispatched when a user presses and releases the main button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-contextMenu -
-		 - Dispatched when a user gesture triggers the context menu associated with this interactive - object in an AIR application.InteractiveObject
 Inherited -
-copy -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - or selects 'Copy' from the text context menu.InteractiveObject
 Inherited -
-cut -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - or selects 'Cut' from the text context menu.InteractiveObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-doubleClick -
-		 - Dispatched when a user presses and releases the main button of a pointing device twice in - rapid succession over the same InteractiveObject when that object's - doubleClickEnabled flag is set to true.InteractiveObject
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-focusIn -
-		 - Dispatched after a display object gains focus.InteractiveObject
 Inherited -
-focusOut -
-		 - Dispatched after a display object loses focus.InteractiveObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-gestureDirectionalTap -
-		 - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 Inherited -
-gestureLongPress -
-		 - Dispatched when the user presses two points of contact over the same InteractiveObject instance - on a touch-enabled device (such as presses and releases two fingers over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gesturePan -
-		 - Dispatched when the user moves a point of contact over the InteractiveObject instance - on a touch-enabled device (such as moving a finger from left to right over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureRotate -
-		 - Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers - and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureSwipe -
-		 - Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three - fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureTap -
-		 - Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps - on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureZoom -
-		 - Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two - fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-imeStartComposition -
-		 - This event is dispatched to any client app that supports inline input with an IME - - InteractiveObject
 Inherited -
-keyDown -
-		 - Dispatched when the user presses a key.InteractiveObject
 Inherited -
-keyFocusChange -
-		 - Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited -
-keyUp -
-		 - Dispatched when the user releases a key.InteractiveObject
 Inherited -
-middleClick -
-		 - Dispatched when a user presses and releases the middle button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-middleMouseDown -
-		 - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-middleMouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseDown -
-		 - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseFocusChange -
-		 - Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 Inherited -
-mouseMove -
-		 - Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited -
-mouseOut -
-		 - Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseOver -
-		 - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheel -
-		 - Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheelHorizontal -
-		 - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-nativeDragComplete -
-		 - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited -
-nativeDragDrop -
-		 - Dispatched by the target InteractiveObject when a dragged object is - dropped on it and the drop has been accepted with a call to - DragManager.acceptDragDrop().InteractiveObject
 Inherited -
-nativeDragEnter -
-		 - Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited -
-nativeDragExit -
-		 - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited -
-nativeDragOver -
-		 - Dispatched by an InteractiveObject continually while a drag gesture remains within its - boundary.InteractiveObject
 Inherited -
-nativeDragStart -
-		 - Dispatched at the beginning of a drag operation by the InteractiveObject that is - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-nativeDragUpdate -
-		 - Dispatched during a drag operation by the InteractiveObject that is - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-paste -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - or selects 'Paste' from the text context menu.InteractiveObject
 Inherited -
-proximityBegin -
-		 - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityEnd -
-		 - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityMove -
-		 - Dispatched when the user moves an active stylus over the screen while remaining within - the proximity detection threshold.InteractiveObject
 Inherited -
-proximityOut -
-		 - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityOver -
-		 - Dispatched when the user moves an active stylus directly above this InteractiveObject - while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOut -
-		 - Dispatched when the user moves an active stylus away from this InteractiveObject - and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOver -
-		 - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - object's tree of descendents in the display list - (while remaining within the proximity detection threshold of the screen).InteractiveObject
 Inherited -
-releaseOutside -
-		 - Dispatched when a user releases the button on the pointing device after the - user first pressed the button over an InteractiveObject instance - and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 Inherited -
-rightClick -
-		 - Dispatched when a user presses and releases the right button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-rightMouseDown -
-		 - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-rightMouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-rollOut -
-		 - Dispatched when the user moves a pointing device away from an InteractiveObject - instance.InteractiveObject
 Inherited -
-rollOver -
-		 - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-selectAll -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a select all operation - or selects 'Select All' from the text context menu.InteractiveObject
 Inherited -
-softKeyboardActivate -
-		 - Dispatched immediately after the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardActivating -
-		 - Dispatched immediately before the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardDeactivate -
-		 - Dispatched immediately after the soft keyboard is lowered.InteractiveObject
 Inherited -
-tabChildrenChange -
-		 - Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited -
-tabEnabledChange -
-		 - Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited -
-tabIndexChange -
-		 - Dispatched when the value of the object's tabIndex property changes.InteractiveObject
 Inherited -
-textInput -
-		 - Dispatched when a user enters one or more - characters of text.InteractiveObject
 Inherited -
-touchBegin -
-		 - Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchEnd -
-		 - Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchMove -
-		 - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 Inherited -
-touchOut -
-		 - Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device - (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchOver -
-		 - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOut -
-		 - Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device - (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOver -
-		 - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchTap -
-		 - Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated - on a touch-enabled device (such as presses and releases a finger from a single point over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
-
- -
- -
Property detail
- - - - - -
downStateproperty
-
-downState:DisplayObject  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies a display object that is used as the visual - object for the button "Down" state —the state that the button is in when the user - selects the hitTestState object. -

Implementation -
-    public function get downState():DisplayObject -
-    public function set downState(value:DisplayObject):void -
-

-See also -

-
-hitTestState -
-overState -
-upState -
-
- - - - - -
enabledproperty 
-
-enabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A Boolean value that specifies whether a button is enabled. When a - button is disabled (the enabled property is set to false), - the button is visible but cannot be clicked. The default value is - true. This property is useful if you want to - disable part of your navigation; for example, you might want to disable a - button in the currently displayed page so that it can't be clicked and - the page cannot be reloaded. -

Note: To prevent mouseClicks on a button, set both the enabled - and mouseEnabled properties to false.

- Implementation -
-    public function get enabled():Boolean -
-    public function set enabled(value:Boolean):void -
-
- - - - - -
hitTestStateproperty 
-
-hitTestState:DisplayObject  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies a display object that is used as the hit testing object for the button. For a basic button, set the - hitTestState property to the same display object as the overState - property. If you do not set the hitTestState property, the SimpleButton - is inactive — it does not respond to user input events. -

Implementation -
-    public function get hitTestState():DisplayObject -
-    public function set hitTestState(value:DisplayObject):void -
-

-See also -

-
-downState -
-overState -
-upState -
-
- - - - - -
overStateproperty 
-
-overState:DisplayObject  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies a display object that is used as the visual - object for the button over state — the state that the button is in when - the pointer is positioned over the button. -

Implementation -
-    public function get overState():DisplayObject -
-    public function set overState(value:DisplayObject):void -
-

-See also -

-
-downState -
-hitTestState -
-upState -
-
- - - - - -
soundTransformproperty 
-
-soundTransform:SoundTransform  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The SoundTransform object assigned to this button. A SoundTransform object - includes properties for setting volume, panning, left speaker assignment, and right - speaker assignment. This SoundTransform object applies to all states of the button. - This SoundTransform object affects only embedded sounds. - -

Implementation -
-    public function get soundTransform():SoundTransform -
-    public function set soundTransform(value:SoundTransform):void -
-

-See also -

-
-flash.media.SoundTransform -
-
- - - - - -
trackAsMenuproperty 
-
-trackAsMenu:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates whether other display objects that are SimpleButton or MovieClip objects can receive - user input release events. The trackAsMenu property lets you create menus. You - can set the trackAsMenu property on any SimpleButton or MovieClip object. - If the trackAsMenu property does not exist, the default behavior is - false. - -

You can change the trackAsMenu property at any time; the - modified button immediately takes on the new behavior.

- Implementation -
-    public function get trackAsMenu():Boolean -
-    public function set trackAsMenu(value:Boolean):void -
-
- - - - - -
upStateproperty 
-
-upState:DisplayObject  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies a display object that is used as the visual - object for the button up state — the state that the button is in when - the pointer is not positioned over the button. -

Implementation -
-    public function get upState():DisplayObject -
-    public function set upState(value:DisplayObject):void -
-

-See also -

-
-downState -
-hitTestState -
-overState -
-
- - - - - -
useHandCursorproperty 
-
-useHandCursor:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A Boolean value that, when set to true, indicates whether - the hand cursor is shown when the pointer rolls over a button. - If this property is set to false, the arrow pointer cursor is displayed - instead. The default is true. - -

You can change the useHandCursor property at any time; - the modified button immediately uses the new cursor behavior.

- Implementation -
-    public function get useHandCursor():Boolean -
-    public function set useHandCursor(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
SimpleButton()constructor
-
-public function SimpleButton(upState:DisplayObject = null, overState:DisplayObject = null, downState:DisplayObject = null, hitTestState:DisplayObject = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new SimpleButton instance. Any or all of the display objects that represent - the various button states can be set as parameters in the constructor. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
upState:DisplayObject (default = null) — The initial value for the SimpleButton up state. -
 
overState:DisplayObject (default = null) — The initial value for the SimpleButton over state. -
 
downState:DisplayObject (default = null) — The initial value for the SimpleButton down state. -
 
hitTestState:DisplayObject (default = null) — The initial value for the SimpleButton hitTest state. -
-
- -
Examples
-
examples\SimpleButtonExample
-
The following example uses the SimpleButtonExample class, which in - turn uses the CustomSimpleButton class, and this class then instantiates four - ButtonDisplayState objects. The result is a button that is created in the shape of - a square, whose background color changes based on the mouse state by overriding instance properties of - the SimpleButton class. This is accomplished by performing the following steps: -
    -
  1. In the SimpleButtonExample() constructor, a new CustomSimpleButton object of type - SimpleButton, called button, is created, which calls the CustomSimpleButton constructor - method. The button object is the added to the display list. The button's color and size are - determined in the steps that follow.
    2. - -
  2. In the CustomSimpleButton class, instance properties are declared that are later used - to control the size and background color of button, based on the state it is in (orange - in the normal state, dark yellow in the mouse over state, an light blue in the mouse down state). - In all of the button's states, the size of the square is set to 80 pixels by using the - size property.
    3. - -
  3. The constructor function for the CustomSimpleButton class sets the - downState, overState, upState, - hitTestState, and useHandCursor properties with - four instances of the ButtonDisplayState class.
    4. - -
  4. In the ButtonDisplayState class, the constructor sets the value of the - square's size and background color and calls the draw() method.
    5. - -
  5. The draw() method redraws the square with the size and background color set in - the constructor based on the button's state.
    6. -
-
-
-package {
-    import flash.display.Sprite;
-
-    public class SimpleButtonExample extends Sprite {
-        public function SimpleButtonExample() {
-            var button:CustomSimpleButton = new CustomSimpleButton();
-            addChild(button);
-        }
-    }
-}
-
-import flash.display.DisplayObject;
-import flash.display.Shape;
-import flash.display.SimpleButton;
-
-class CustomSimpleButton extends SimpleButton {
-    private var upColor:uint   = 0xFFCC00;
-    private var overColor:uint = 0xCCFF00;
-    private var downColor:uint = 0x00CCFF;
-    private var size:uint      = 80;
-
-    public function CustomSimpleButton() {
-        downState      = new ButtonDisplayState(downColor, size);
-        overState      = new ButtonDisplayState(overColor, size);
-        upState        = new ButtonDisplayState(upColor, size);
-        hitTestState   = new ButtonDisplayState(upColor, size * 2);
-        hitTestState.x = -(size / 4);
-        hitTestState.y = hitTestState.x;
-        useHandCursor  = true;
-    }
-}
-
-class ButtonDisplayState extends Shape {
-    private var bgColor:uint;
-    private var size:uint;
-
-    public function ButtonDisplayState(bgColor:uint, size:uint) {
-        this.bgColor = bgColor;
-        this.size    = size;
-        draw();
-    }
-
-    private function draw():void {
-        graphics.beginFill(bgColor);
-        graphics.drawRect(0, 0, size, size);
-        graphics.endFill();
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/SpreadMethod.html b/html-docs/flash/display/SpreadMethod.html deleted file mode 100644 index 79f28ee..0000000 --- a/html-docs/flash/display/SpreadMethod.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - - - -flash.display.SpreadMethod (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class SpreadMethod
InheritanceSpreadMethod Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The SpreadMethod class provides values for the spreadMethod parameter -in the beginGradientFill() and lineGradientStyle() methods of the Graphics class. - -

The following example shows the same gradient fill using various spread methods:

- - - - - - - - - - - - - - - - - - - - - -
linear gradient with SpreadMethod.PADlinear gradient with SpreadMethod.REFLECTlinear gradient with SpreadMethod.REPEAT
SpreadMethod.PADSpreadMethod.REFLECTSpreadMethod.REPEAT
- -

-

-See also -

-
-flash.display.Graphics.beginGradientFill() -
-flash.display.Graphics.lineGradientStyle() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  PAD : String = "pad"
[static] -Specifies that the gradient use the pad spread method.
-		SpreadMethod
  REFLECT : String = "reflect"
[static] -Specifies that the gradient use the reflect spread method.
-		SpreadMethod
  REPEAT : String = "repeat"
[static] -Specifies that the gradient use the repeat spread method.
-		SpreadMethod
-
- -
- -
Constant detail
- - - - - -
PADconstant
-
-public static const PAD:String = "pad" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Specifies that the gradient use the pad spread method. -

- - - - - -
REFLECTconstant 
-
-public static const REFLECT:String = "reflect" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Specifies that the gradient use the reflect spread method. -

- - - - - -
REPEATconstant 
-
-public static const REPEAT:String = "repeat" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Specifies that the gradient use the repeat spread method. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/Sprite.html b/html-docs/flash/display/Sprite.html deleted file mode 100644 index 2f85c84..0000000 --- a/html-docs/flash/display/Sprite.html +++ /dev/null @@ -1,2471 +0,0 @@ - - - - - - - - -flash.display.Sprite (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display
Classpublic class Sprite
InheritanceSprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
SubclassesHTMLLoader, MovieClip
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The Sprite class is a basic display list building block: a display list node that can display - graphics and can also contain children. -

A Sprite object is similar to a movie clip, but does not have a timeline. Sprite is an - appropriate base class for objects that do not require timelines. For example, Sprite would be a - logical base class for user interface (UI) components that typically do not use the timeline.

-

The Sprite class is new in ActionScript 3.0. It provides an alternative to the functionality of - the MovieClip class, which retains all the functionality of previous ActionScript releases to - provide backward compatibility.

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityImplementation : AccessibilityImplementation -
- The current accessibility implementation (AccessibilityImplementation) - for this InteractiveObject instance.
-		InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
  buttonMode : Boolean -
- Specifies the button mode of this sprite.
-		Sprite
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcontextMenu : NativeMenu -
- Specifies the context menu associated with this object.
-		InteractiveObject
 InheriteddoubleClickEnabled : Boolean -
- Specifies whether the object receives doubleClick events.
-		InteractiveObject
  dropTarget : DisplayObject -
[read-only] - Specifies the display object over which the sprite is being dragged, or on - which the sprite was dropped.
-		Sprite
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 InheritedfocusRect : Object -
- Specifies whether this object displays a focus rectangle.
-		InteractiveObject
  graphics : Graphics -
[read-only] - Specifies the Graphics object that belongs to this sprite where vector - drawing commands can occur.
-		Sprite
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
  hitArea : Sprite -
- Designates another sprite to serve as the hit area for a sprite.
-		Sprite
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseChildren : Boolean -
- Determines whether or not the children of the object are mouse, or user input device, enabled.
-		DisplayObjectContainer
 InheritedmouseEnabled : Boolean -
- Specifies whether this object receives mouse, or other user input, messages.
-		InteractiveObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedneedsSoftKeyboard : Boolean -
- Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - when this InteractiveObject instance receives focus.
-		InteractiveObject
 InheritednumChildren : int -
- Returns the number of children of this object.
-		DisplayObjectContainer
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
 InheritedsoftKeyboard : String -
- Controls the appearance of the soft keyboard.
-		InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle -
- Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
-		InteractiveObject
  soundTransform : SoundTransform -
- Controls sound within this sprite.
-		Sprite
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
 InheritedtabChildren : Boolean -
- Determines whether the children of the object are tab enabled.
-		DisplayObjectContainer
 InheritedtabEnabled : Boolean -
- Specifies whether this object is in the tab order.
-		InteractiveObject
 InheritedtabIndex : int -
- Specifies the tab ordering of objects in a SWF file.
-		InteractiveObject
 InheritedtextSnapshot : TextSnapshot -
- Returns a TextSnapshot object for this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
  useHandCursor : Boolean -
- A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls - over a sprite in which the buttonMode property is set to true.
-		Sprite
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Sprite()
-
- Creates a new Sprite instance.
-		Sprite
 Inherited -
-addChild(child:DisplayObject):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-addChildAt(child:DisplayObject, index:int):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer - instance.
-		DisplayObjectContainer
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-areInaccessibleObjectsUnderPoint(point:Point):Boolean -
-
- Indicates whether the security restrictions - would cause any display objects to be omitted from the list returned by calling - the DisplayObjectContainer.getObjectsUnderPoint() method - with the specified point point.
-		DisplayObjectContainer
 Inherited -
-contains(child:DisplayObject):Boolean -
-
- Determines whether the specified display object is a child of the DisplayObjectContainer instance or - the instance itself.
-		DisplayObjectContainer
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getChildAt(index:int):DisplayObject -
-
- Returns the child display object instance that exists at the specified index.
-		DisplayObjectContainer
 Inherited -
-getChildByName(name:String):DisplayObject -
-
- Returns the child display object that exists with the specified name.
-		DisplayObjectContainer
 Inherited -
-getChildIndex(child:DisplayObject):int -
-
- Returns the index position of a child DisplayObject instance.
-		DisplayObjectContainer
 Inherited -
-getObjectsUnderPoint(point:Point):Array -
-
- Returns an array of objects that lie under the specified point and are children - (or grandchildren, and so on) of this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeChild(child:DisplayObject):DisplayObject -
-
- Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeChildAt(index:int):DisplayObject -
-
- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer.
-		DisplayObjectContainer
 Inherited -
-removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void -
-
- Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-requestSoftKeyboard():Boolean -
-
- Raises a virtual keyboard.
-		InteractiveObject
 Inherited -
-setChildIndex(child:DisplayObject, index:int):void -
-
- Changes the position of an existing child in the display object container.
-		DisplayObjectContainer
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void -
-
- Lets the user drag the specified sprite.
-		Sprite
   -
-startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void -
-
- Lets the user drag the specified sprite on a touch-enabled device.
-		Sprite
 Inherited -
-stopAllMovieClips():void -
-
- Recursively stops the timeline execution of all MovieClips rooted at this object.
-		DisplayObjectContainer
   -
-stopDrag():void -
-
- Ends the startDrag() method.
-		Sprite
   -
-stopTouchDrag(touchPointID:int):void -
-
- Ends the startTouchDrag() method, for use with touch-enabled devices.
-		Sprite
 Inherited -
-swapChildren(child1:DisplayObject, child2:DisplayObject):void -
-
- Swaps the z-order (front-to-back order) of the two specified child objects.
-		DisplayObjectContainer
 Inherited -
-swapChildrenAt(index1:int, index2:int):void -
-
- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list.
-		DisplayObjectContainer
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-clear -
-		 - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 Inherited -
-click -
-		 - Dispatched when a user presses and releases the main button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-contextMenu -
-		 - Dispatched when a user gesture triggers the context menu associated with this interactive - object in an AIR application.InteractiveObject
 Inherited -
-copy -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - or selects 'Copy' from the text context menu.InteractiveObject
 Inherited -
-cut -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - or selects 'Cut' from the text context menu.InteractiveObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-doubleClick -
-		 - Dispatched when a user presses and releases the main button of a pointing device twice in - rapid succession over the same InteractiveObject when that object's - doubleClickEnabled flag is set to true.InteractiveObject
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-focusIn -
-		 - Dispatched after a display object gains focus.InteractiveObject
 Inherited -
-focusOut -
-		 - Dispatched after a display object loses focus.InteractiveObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-gestureDirectionalTap -
-		 - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 Inherited -
-gestureLongPress -
-		 - Dispatched when the user presses two points of contact over the same InteractiveObject instance - on a touch-enabled device (such as presses and releases two fingers over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gesturePan -
-		 - Dispatched when the user moves a point of contact over the InteractiveObject instance - on a touch-enabled device (such as moving a finger from left to right over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureRotate -
-		 - Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers - and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureSwipe -
-		 - Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three - fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureTap -
-		 - Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps - on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureZoom -
-		 - Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two - fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-imeStartComposition -
-		 - This event is dispatched to any client app that supports inline input with an IME - - InteractiveObject
 Inherited -
-keyDown -
-		 - Dispatched when the user presses a key.InteractiveObject
 Inherited -
-keyFocusChange -
-		 - Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited -
-keyUp -
-		 - Dispatched when the user releases a key.InteractiveObject
 Inherited -
-middleClick -
-		 - Dispatched when a user presses and releases the middle button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-middleMouseDown -
-		 - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-middleMouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseDown -
-		 - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseFocusChange -
-		 - Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 Inherited -
-mouseMove -
-		 - Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited -
-mouseOut -
-		 - Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseOver -
-		 - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheel -
-		 - Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheelHorizontal -
-		 - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-nativeDragComplete -
-		 - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited -
-nativeDragDrop -
-		 - Dispatched by the target InteractiveObject when a dragged object is - dropped on it and the drop has been accepted with a call to - DragManager.acceptDragDrop().InteractiveObject
 Inherited -
-nativeDragEnter -
-		 - Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited -
-nativeDragExit -
-		 - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited -
-nativeDragOver -
-		 - Dispatched by an InteractiveObject continually while a drag gesture remains within its - boundary.InteractiveObject
 Inherited -
-nativeDragStart -
-		 - Dispatched at the beginning of a drag operation by the InteractiveObject that is - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-nativeDragUpdate -
-		 - Dispatched during a drag operation by the InteractiveObject that is - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-paste -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - or selects 'Paste' from the text context menu.InteractiveObject
 Inherited -
-proximityBegin -
-		 - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityEnd -
-		 - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityMove -
-		 - Dispatched when the user moves an active stylus over the screen while remaining within - the proximity detection threshold.InteractiveObject
 Inherited -
-proximityOut -
-		 - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityOver -
-		 - Dispatched when the user moves an active stylus directly above this InteractiveObject - while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOut -
-		 - Dispatched when the user moves an active stylus away from this InteractiveObject - and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOver -
-		 - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - object's tree of descendents in the display list - (while remaining within the proximity detection threshold of the screen).InteractiveObject
 Inherited -
-releaseOutside -
-		 - Dispatched when a user releases the button on the pointing device after the - user first pressed the button over an InteractiveObject instance - and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 Inherited -
-rightClick -
-		 - Dispatched when a user presses and releases the right button of the user's - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-rightMouseDown -
-		 - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-rightMouseUp -
-		 - Dispatched when a user releases the pointing device button over an - InteractiveObject instance.InteractiveObject
 Inherited -
-rollOut -
-		 - Dispatched when the user moves a pointing device away from an InteractiveObject - instance.InteractiveObject
 Inherited -
-rollOver -
-		 - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-selectAll -
-		 - Dispatched when the user activates the platform-specific accelerator key combination for a select all operation - or selects 'Select All' from the text context menu.InteractiveObject
 Inherited -
-softKeyboardActivate -
-		 - Dispatched immediately after the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardActivating -
-		 - Dispatched immediately before the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardDeactivate -
-		 - Dispatched immediately after the soft keyboard is lowered.InteractiveObject
 Inherited -
-tabChildrenChange -
-		 - Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited -
-tabEnabledChange -
-		 - Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited -
-tabIndexChange -
-		 - Dispatched when the value of the object's tabIndex property changes.InteractiveObject
 Inherited -
-textInput -
-		 - Dispatched when a user enters one or more - characters of text.InteractiveObject
 Inherited -
-touchBegin -
-		 - Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchEnd -
-		 - Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchMove -
-		 - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 Inherited -
-touchOut -
-		 - Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device - (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchOver -
-		 - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOut -
-		 - Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device - (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOver -
-		 - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchTap -
-		 - Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated - on a touch-enabled device (such as presses and releases a finger from a single point over a display object - on a mobile phone or tablet with a touch screen).InteractiveObject
-
- -
- -
Property detail
- - - - - -
buttonModeproperty
-
-buttonMode:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the button mode of this sprite. If true, this - sprite behaves as a button, which means that it triggers the display - of the hand cursor when the pointer passes over the sprite and can - receive a click event if the enter or space keys are pressed - when the sprite has focus. You can suppress the display of the hand cursor - by setting the useHandCursor property to false, - in which case the pointer is displayed. -

Although it is better to use the SimpleButton class to create buttons, - you can use the buttonMode property to give a sprite - some button-like functionality. To include a sprite in the tab order, - set the tabEnabled property (inherited from the - InteractiveObject class and false by default) to - true. Additionally, consider whether you want - the children of your sprite to be user input enabled. Most buttons - do not enable user input interactivity for their child objects because - it confuses the event flow. To disable user input interactivity for all child - objects, you must set the mouseChildren property (inherited - from the DisplayObjectContainer class) to false.

-

If you use the buttonMode property with the MovieClip class (which is a - subclass of the Sprite class), your button might have some added - functionality. If you include frames labeled _up, _over, and _down, - Flash Player provides automatic state changes (functionality - similar to that provided in previous versions of ActionScript for movie - clips used as buttons). These automatic state changes are - not available for sprites, which have no timeline, and thus no frames - to label.

- Implementation -
-    public function get buttonMode():Boolean -
-    public function set buttonMode(value:Boolean):void -
-

-See also -

-
-SimpleButton -
-Sprite.useHandCursor -
-InteractiveObject.tabEnabled -
-DisplayObjectContainer.mouseChildren -
-
-Example -
The following example creates two sprites and sets the buttonMode - property to true for one and false for the other. When you compile - and run the application, both sprites respond to mouse events, but only the one in which - buttonMode is set to true uses the hand cursor and is included - in the tab order: -
-
-import flash.display.Sprite;
-import flash.events.MouseEvent;
-
-var circle1:Sprite = new Sprite();
-circle1.graphics.beginFill(0xFFCC00);
-circle1.graphics.drawCircle(40, 40, 40);
-circle1.buttonMode = true;
-circle1.addEventListener(MouseEvent.CLICK, clicked);
-
-var circle2:Sprite = new Sprite();
-circle2.graphics.beginFill(0xFFCC00);
-circle2.graphics.drawCircle(120, 40, 40);
-circle2.buttonMode = false;
-circle2.addEventListener(MouseEvent.CLICK, clicked);
-
-function clicked(event:MouseEvent):void {
-    trace ("Click!");
-}
-
-addChild(circle1);
-addChild(circle2);
-
-

-
- - - - - -
dropTargetproperty 
-
-dropTarget:DisplayObject  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the display object over which the sprite is being dragged, or on - which the sprite was dropped. -

Implementation -
-    public function get dropTarget():DisplayObject -
-

-See also -

-
-startDrag() -
-stopDrag() -
-
-Example -
The following example creates a circle sprite and two target - sprites. The startDrag() method is called on the circle sprite when the user - positions the cursor over the sprite and presses the mouse button, and the stopDrag() method - is called when the user releases the mouse button. This lets the user drag the sprite. On release of the mouse - button, the mouseRelease() method is called, which in turn traces the name - of the dropTarget object — the one to which the user dragged the - circle sprite: -
-
-import flash.display.Sprite;
-import flash.events.MouseEvent;
-
-var circle:Sprite = new Sprite();
-circle.graphics.beginFill(0xFFCC00);
-circle.graphics.drawCircle(0, 0, 40);
-
-var target1:Sprite = new Sprite();
-target1.graphics.beginFill(0xCCFF00);
-target1.graphics.drawRect(0, 0, 100, 100);
-target1.name = "target1";
-
-var target2:Sprite = new Sprite();
-target2.graphics.beginFill(0xCCFF00);
-target2.graphics.drawRect(0, 200, 100, 100);
-target2.name = "target2";
-
-addChild(target1);
-addChild(target2);
-addChild(circle);
-
-circle.addEventListener(MouseEvent.MOUSE_DOWN, mouseDown) 
-
-function mouseDown(event:MouseEvent):void {
-    circle.startDrag();
-}
-circle.addEventListener(MouseEvent.MOUSE_UP, mouseReleased);
-
-function mouseReleased(event:MouseEvent):void {
-	circle.stopDrag();
-	trace(circle.dropTarget.name);
-}
-
-

-
- - - - - -
graphicsproperty 
-
-graphics:Graphics  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the Graphics object that belongs to this sprite where vector - drawing commands can occur. -

Implementation -
-    public function get graphics():Graphics -
-
-Example -
The following example creates a circle sprite and uses its - graphics property to draw a circle with a yellow (0xFFCC00) fill: -
-
-import flash.display.Sprite;
-
-var circle:Sprite = new Sprite();
-circle.graphics.beginFill(0xFFCC00);
-circle.graphics.drawCircle(40, 40, 40);
-addChild(circle);
-
-

-
- - - - - -
hitAreaproperty 
-
-hitArea:Sprite  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Designates another sprite to serve as the hit area for a sprite. If the hitArea - property does not exist or the value is null or undefined, the - sprite itself is used as the hit area. The value of the hitArea property can - be a reference to a Sprite object. -

You can change the hitArea property at any time; the modified sprite immediately - uses the new hit area behavior. The sprite designated as the hit area does not need to be - visible; its graphical shape, although not visible, is still detected as the hit area.

-

Note: You must set to false the mouseEnabled - property of the sprite designated as the hit area. Otherwise, your sprite button might - not work because the sprite designated as the hit area receives the user input events instead - of your sprite button.

- Implementation -
-    public function get hitArea():Sprite -
-    public function set hitArea(value:Sprite):void -
-
-Example -
The following example creates a circle sprite and a square - sprite. The square sprite is the hitArea for the circle sprite. - So when the user clicks the square sprite, the circle sprite dispatches - a click event: -
-
-import flash.display.Sprite;
-import flash.events.MouseEvent;
-
-var circle:Sprite = new Sprite();
-circle.graphics.beginFill(0xFFCC00);
-circle.graphics.drawCircle(0, 0, 40);
-
-var square:Sprite = new Sprite();
-square.graphics.beginFill(0xCCFF00);
-square.graphics.drawRect(200, 0, 100, 100);
-
-circle.hitArea = square;
-square.mouseEnabled = false;
-
-circle.addEventListener(MouseEvent.CLICK, clicked);
-
-function clicked(event:MouseEvent):void{
-    trace(event.target == circle); // true
-	trace(event.target == square); // false
-}
-
-addChild(circle);
-addChild(square);
-
-

-
- - - - - -
soundTransformproperty 
-
-soundTransform:SoundTransform  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Controls sound within this sprite. -

Note: This property does not affect HTML content in an HTMLControl object (in Adobe AIR).

- Implementation -
-    public function get soundTransform():SoundTransform -
-    public function set soundTransform(value:SoundTransform):void -
-

-See also -

-
-flash.media.SoundTransform -
-
-Example -
The following example creates a sprite named container - and adds a Loader object to its child list. The Loader object loads a SWF file. - When the user clicks the link in the tf text field true, the - mute() method sets the volume property of the - soundTransform property of the container sprite: -
-
-import flash.display.Sprite;
-import flash.display.Loader;
-import flash.events.IOErrorEvent;
-import flash.events.MouseEvent;
-import flash.net.URLRequest;
-import flash.text.TextField;
-import flash.media.SoundTransform;
-
-var container:Sprite = new Sprite();
-addChild(container);
-
-var ldr:Loader = new Loader;
-var urlReq:URLRequest = new URLRequest("SoundPlayer.swf");
-ldr.load(urlReq);
-
-container.addChild(ldr);
-ldr.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, urlNotFound);
-    		
-var tf:TextField = new TextField();
-tf.htmlText = "<a href = 'event:Mute'>Mute / Unmute</a>";
-addChild(tf);
-
-var mySoundTransform:SoundTransform = new SoundTransform();
-mySoundTransform.volume = 1;
-
-tf.addEventListener(MouseEvent.CLICK, mute);
-
-function mute(event:MouseEvent):void {	
-	if (mySoundTransform.volume == 0) {
-		mySoundTransform.volume = 1;
-	} else {
-		mySoundTransform.volume = 0;		
-	}
-	container.soundTransform = mySoundTransform;
-}
-
-function urlNotFound(event:IOErrorEvent):void {
-	trace("The URL was not found."); 
-}
-
-

-
- - - - - -
useHandCursorproperty 
-
-useHandCursor:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls - over a sprite in which the buttonMode property is set to true. - The default value of the useHandCursor property is true. - If useHandCursor is set to true, the pointing hand used for buttons - appears when the pointer rolls over a button sprite. If useHandCursor is - false, the arrow pointer is used instead. -

You can change the useHandCursor property at any time; the modified sprite - immediately takes on the new cursor appearance.

-

Note: In Flex or Flash Builder, if your sprite has child sprites, you might want to - set the mouseChildren property to false. For example, if you want a hand - cursor to appear over a Flex <mx:Label> control, set the useHandCursor and - buttonMode properties to true, and the mouseChildren property - to false.

- Implementation -
-    public function get useHandCursor():Boolean -
-    public function set useHandCursor(value:Boolean):void -
-

-See also -

-
-buttonMode -
-DisplayObjectContainer.mouseChildren -
-
-Example -
The following example creates two sprites and sets the buttonMode - property to true for both, yet it sets the useHandCursor - property to true for one and false for the other. When you compile - and run the application, both sprites respond as buttons (and are included in the tab order), but - only the one in which useHandCursor is set to true uses the hand cursor: -
-
-import flash.display.Sprite;
-import flash.events.MouseEvent;
-
-var circle1:Sprite = new Sprite();
-circle1.graphics.beginFill(0xFFCC00);
-circle1.graphics.drawCircle(40, 40, 40);
-circle1.buttonMode = true;
-circle1.useHandCursor = true;
-circle1.addEventListener(MouseEvent.CLICK, clicked);
-
-var circle2:Sprite = new Sprite();
-circle2.graphics.beginFill(0xFFCC00);
-circle2.graphics.drawCircle(120, 40, 40);
-circle2.buttonMode = true;
-circle2.useHandCursor = false;
-circle2.addEventListener(MouseEvent.CLICK, clicked);
-
-function clicked(event:MouseEvent):void {
-    trace ("Click!");
-}
-
-addChild(circle1);
-addChild(circle2);
-
-

-
- -
Constructor detail
- - - - - -
Sprite()constructor
-
-public function Sprite() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a new Sprite instance. After you create the Sprite instance, call the - DisplayObjectContainer.addChild() or DisplayObjectContainer.addChildAt() - method to add the Sprite to a parent DisplayObjectContainer. -

- -
Method detail
- - - - - -
startDrag()method
-
-public function startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Lets the user drag the specified sprite. The sprite remains draggable until explicitly - stopped through a call to the Sprite.stopDrag() method, or until - another sprite is made draggable. Only one sprite is draggable at a time. -

Three-dimensional display objects follow the pointer and - Sprite.startDrag() moves the object within - the three-dimensional plane defined by the display object. Or, if the display object is a two-dimensional object - and the child of a three-dimensional object, the two-dimensional object - moves within the three dimensional plane defined by the three-dimensional parent object.

- Parameters - - - - - - - - - - -
lockCenter:Boolean (default = false) — Specifies whether the draggable sprite is locked to the center of - the pointer position (true), or locked to the point where the user first clicked the - sprite (false). -
 
bounds:Rectangle (default = null) — Value relative to the coordinates of the Sprite's parent that specify a constraint - rectangle for the Sprite. -
-

-See also -

-
-dropTarget -
-stopDrag() -
-
-Example -
The following example creates a circle sprite and two target - sprites. The startDrag() method is called on the circle sprite when the user - positions the cursor over the sprite and presses the mouse button, and the stopDrag() method - is called when the user releases the mouse button. This lets the user drag the sprite. On release of the mouse - button, the mouseRelease() method is called, which in turn traces the name - of the dropTarget object — the one to which the user dragged the - circle sprite: -
-
-import flash.display.Sprite;
-import flash.events.MouseEvent;
-
-var circle:Sprite = new Sprite();
-circle.graphics.beginFill(0xFFCC00);
-circle.graphics.drawCircle(0, 0, 40);
-
-var target1:Sprite = new Sprite();
-target1.graphics.beginFill(0xCCFF00);
-target1.graphics.drawRect(0, 0, 100, 100);
-target1.name = "target1";
-
-var target2:Sprite = new Sprite();
-target2.graphics.beginFill(0xCCFF00);
-target2.graphics.drawRect(0, 200, 100, 100);
-target2.name = "target2";
-
-addChild(target1);
-addChild(target2);
-addChild(circle);
-
-circle.addEventListener(MouseEvent.MOUSE_DOWN, mouseDown) 
-
-function mouseDown(event:MouseEvent):void {
-    circle.startDrag();
-}
-circle.addEventListener(MouseEvent.MOUSE_UP, mouseReleased);
-
-function mouseReleased(event:MouseEvent):void {
-	circle.stopDrag();
-	trace(circle.dropTarget.name);
-}
-
-

-
- - - - - -
startTouchDrag()method 
-
-public function startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Lets the user drag the specified sprite on a touch-enabled device. The sprite remains draggable until explicitly - stopped through a call to the Sprite.stopTouchDrag() method, or until - another sprite is made draggable. Only one sprite is draggable at a time. -

Three-dimensional display objects follow the pointer and - Sprite.startTouchDrag() moves the object within - the three-dimensional plane defined by the display object. Or, if the display object is a two-dimensional object - and the child of a three-dimensional object, the two-dimensional object - moves within the three dimensional plane defined by the three-dimensional parent object.

- Parameters - - - - - - - - - - - - - - - - -
touchPointID:int — An integer to assign to the touch point. -
 
lockCenter:Boolean (default = false) — Specifies whether the draggable sprite is locked to the center of - the pointer position (true), or locked to the point where the user first clicked the - sprite (false). -
 
bounds:Rectangle (default = null) — Value relative to the coordinates of the Sprite's parent that specify a constraint - rectangle for the Sprite. -
-

-See also -

-
-dropTarget -
-stopTouchDrag() -
-flash.ui.Multitouch -
-flash.events.TouchEvent -
-
-Example -
The following example shows functions using startTouchDrag and stopTouchDrag to handle the touchBegin and touchEnd events. - 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). -
-
-MySprite.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin);
-MySprite.addEventListener(TouchEvent.TOUCH_END, onTouchEnd);
-
-function onTouchBegin(e:TouchEvent) {
-     e.target.startTouchDrag(e.touchPointID, false, bg.getRect(this));
- 	trace("touch begin");
- 
- }
-function onTouchEnd(e:TouchEvent) {
- 	e.target.stopTouchDrag(e.touchPointID);
- 	trace("touch end");
-}
-
-

-
- - - - - -
stopDrag()method 
-
-public function stopDrag():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Ends the startDrag() method. A sprite that was made draggable with the - startDrag() method remains draggable until a - stopDrag() method is added, or until another - sprite becomes draggable. Only one sprite is draggable at a time. -

-See also -

-
-dropTarget -
-startDrag() -
-
-Example -
The following example creates a circle sprite and two target - sprites. The startDrag() method is called on the circle sprite when the user - positions the cursor over the sprite and presses the mouse button, and the stopDrag() method - is called when the user releases the mouse button. This lets the user drag the sprite. On release of the mouse - button, the mouseRelease() method is called, which in turn traces the name - of the dropTarget object — the one to which the user dragged the - circle sprite: -
-
-import flash.display.Sprite;
-import flash.events.MouseEvent;
-
-var circle:Sprite = new Sprite();
-circle.graphics.beginFill(0xFFCC00);
-circle.graphics.drawCircle(0, 0, 40);
-
-var target1:Sprite = new Sprite();
-target1.graphics.beginFill(0xCCFF00);
-target1.graphics.drawRect(0, 0, 100, 100);
-target1.name = "target1";
-
-var target2:Sprite = new Sprite();
-target2.graphics.beginFill(0xCCFF00);
-target2.graphics.drawRect(0, 200, 100, 100);
-target2.name = "target2";
-
-addChild(target1);
-addChild(target2);
-addChild(circle);
-
-circle.addEventListener(MouseEvent.MOUSE_DOWN, mouseDown) 
-
-function mouseDown(event:MouseEvent):void {
-    circle.startDrag();
-}
-circle.addEventListener(MouseEvent.MOUSE_UP, mouseReleased);
-
-function mouseReleased(event:MouseEvent):void {
-	circle.stopDrag();
-	trace(circle.dropTarget.name);
-}
-
-

-
- - - - - -
stopTouchDrag()method 
-
-public function stopTouchDrag(touchPointID:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Ends the startTouchDrag() method, for use with touch-enabled devices. A sprite that was made draggable with the - startTouchDrag() method remains draggable until a - stopTouchDrag() method is added, or until another - sprite becomes draggable. Only one sprite is draggable at a time. -

Parameters - - - - -
touchPointID:int — The integer assigned to the touch point in the startTouchDrag method. -
-

-See also -

-
-dropTarget -
-startTouchDrag() -
-flash.ui.Multitouch -
-flash.events.TouchEvent -
-
-Example -
The following example shows functions using startTouchDrag and stopTouchDrag to handle the touchBegin and touchEnd events. - 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). -
-
-MySprite.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin);
-MySprite.addEventListener(TouchEvent.TOUCH_END, onTouchEnd);
-
-function onTouchBegin(e:TouchEvent) {
-     e.target.startTouchDrag(e.touchPointID, false, bg.getRect(this));
- 	trace("touch begin");
- 
- }
-function onTouchEnd(e:TouchEvent) {
- 	e.target.stopTouchDrag(e.touchPointID);
- 	trace("touch end");
-}
-
-

-
- -
Examples
-
examples\SpriteExample
-
The following example uses the SpriteExample class to draw an - orange square on the stage, and then dispatches events whenever the user clicks or drags the - square. This task is accomplished by performing the following steps: -
    -
  1. Declare the size property (100 x 100 pixels) and the background color - (orange) for later use in drawing the square.
    2. - -
  2. The constructor then creates a new child Sprite object and uses it to add - two event listeners and their associated methods: mouseDownHandler() and - mouseUpHandler().
    3. - -
  3. The child Sprite object is then passed to the - draw() method, which draws the orange square.
    4. - -
  4. The child is then placed on the display list by a call to the addChild() - method.
    5. - -
  5. The event listeners work as follows: - -
      -
    • mouseDownHandler(): when the user clicks the Sprite object, - this method adds a mouseMove event listener, the mouseMoveHandler() method, - which processes the mouse moves. Then the startDrag() method is called, which - allows the Sprite object to be dragged.
      • - -
    • mouseUpHandler(): when the mouse button is released, the mouseMove event listener - is removed and the stopDrag() method is called, which freezes the orange square in - place.
      • - -
    • mouseMoveHandler: as long as the left mouse button is being held down, this - method instructs the player to continuously redraw the orange square.
      • - -
    -
    6. - -
- -

Note: Each of the event listener methods declares a local sprite - variable, which is assigned the target property of the event.

- -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-
-    public class SpriteExample extends Sprite {
-        private var size:uint    = 100;
-        private var bgColor:uint = 0xFFCC00;
-
-        public function SpriteExample() {
-            var child:Sprite = new Sprite();
-            child.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
-            child.addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);
-            draw(child);
-            addChild(child);
-        }
-
-        private function mouseDownHandler(event:MouseEvent):void {
-            trace("mouseDownHandler");
-            var sprite:Sprite = Sprite(event.target);
-            sprite.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
-            sprite.startDrag();
-        }
-
-        private function mouseUpHandler(event:MouseEvent):void {
-            trace("mouseUpHandler");
-            var sprite:Sprite = Sprite(event.target);
-            sprite.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
-            sprite.stopDrag();
-        }
-
-        private function mouseMoveHandler(event:MouseEvent):void {
-            trace("mouseMoveHandler");
-            event.updateAfterEvent();
-        }
-
-        private function draw(sprite:Sprite):void {
-            sprite.graphics.beginFill(bgColor);
-            sprite.graphics.drawRect(0, 0, size, size);
-            sprite.graphics.endFill();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/Stage.html b/html-docs/flash/display/Stage.html deleted file mode 100644 index ab25b9a..0000000 --- a/html-docs/flash/display/Stage.html +++ /dev/null @@ -1,5904 +0,0 @@ - - - - - - - - -flash.display.Stage (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class Stage
InheritanceStage Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The Stage class represents the main drawing area. - -

For SWF content running in the browser (in - Flash® Player), the Stage represents the entire area where Flash - content is shown. For content running in AIR on desktop operating systems, each NativeWindow object has a corresponding - Stage object.

- -

The Stage object is not globally accessible. You need to access it through the - stage property of a DisplayObject instance.

- -

The Stage class has several ancestor classes — DisplayObjectContainer, InteractiveObject, - DisplayObject, and EventDispatcher — from which it inherits properties and methods. - Many of these properties and methods are either inapplicable to Stage objects, - or require security checks when called on a Stage object. The properties and methods that - require security checks are documented as part of the Stage class.

-

In addition, the following inherited properties are inapplicable to Stage objects. If you - try to set them, an IllegalOperationError is thrown. These properties may always be read, but - since they cannot be set, they will always contain default values.

-
    -
  • accessibilityProperties
    • -
  • alpha
    • -
  • blendMode
    • -
  • cacheAsBitmap
    • -
  • contextMenu
    • -
  • filters
    • -
  • focusRect
    • -
  • loaderInfo
    • -
  • mask
    • -
  • mouseEnabled
    • -
  • name
    • -
  • opaqueBackground
    • -
  • rotation
    • -
  • scale9Grid
    • -
  • scaleX
    • -
  • scaleY
    • -
  • scrollRect
    • -
  • tabEnabled
    • -
  • tabIndex
    • -
  • transform
    • -
  • visible
    • -
  • x
    • -
  • y
    • -
- -

Some events that you might expect to be a part of the Stage class, - such as enterFrame, exitFrame, - frameConstructed, and render, - cannot be Stage events because a reference to the Stage object - cannot be guaranteed to exist in every situation where these events - are used. Because these events cannot be dispatched by the Stage - object, they are instead dispatched by every DisplayObject instance, - which means that you can add an event listener to - any DisplayObject instance to listen for these events. - These events, which are part of the DisplayObject class, - are called broadcast events to differentiate them from events - that target a specific DisplayObject instance. - Two other broadcast events, activate and deactivate, - belong to DisplayObject's superclass, EventDispatcher. - The activate and deactivate events - behave similarly to the DisplayObject broadcast events, except - that these two events are dispatched not only by all DisplayObject - instances, but also by all EventDispatcher instances and instances - of other EventDispatcher subclasses. - For more information on broadcast events, see the DisplayObject class.

- -

-

-See also -

-
-flash.display.DisplayObject -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityImplementation : AccessibilityImplementation -
- - The current accessibility implementation (AccessibilityImplementation) - - for this InteractiveObject instance.
-		InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
  align : String -
- A value from the StageAlign class that specifies the alignment of the stage in - Flash Player or the browser.
-		Stage
  allowsFullScreen : Boolean -
[read-only] - Specifies whether this stage allows the use of the full screen mode -
-		Stage
  allowsFullScreenInteractive : Boolean -
[read-only] - Specifies whether this stage allows the use of the full screen with text input mode -
-		Stage
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
  autoOrients : Boolean -
- Specifies whether the stage automatically changes orientation when the device orientation changes.
-		Stage
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
  browserZoomFactor : Number -
[read-only] - Specifies the browser zoom factor.
-		Stage
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
  color : uint -
- The SWF background color.
-		Stage
  colorCorrection : String -
- Controls Flash runtime color correction for displays.
-		Stage
  colorCorrectionSupport : String -
[read-only] - Specifies whether the Flash runtime is running on an operating system that supports - color correction and whether the color profile of the main (primary) - monitor can be read and understood by the Flash runtime.
-		Stage
  constructor : * -
-		Stage
  contentsScaleFactor : Number -
[read-only] - Specifies the effective pixel scaling factor of the stage.
-		Stage
 InheritedcontextMenu : NativeMenu -
- - Specifies the context menu associated with this object.
-		InteractiveObject
  deviceOrientation : String -
[read-only] - The physical orientation of the device.
-		Stage
  displayState : String -
- A value from the StageDisplayState class that specifies which display state to use.
-		Stage
 InheriteddoubleClickEnabled : Boolean -
- - Specifies whether the object receives doubleClick events.
-		InteractiveObject
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
  focus : InteractiveObject -
- The interactive object with keyboard focus; or null if focus is not set - or if the focused object belongs to a security sandbox to which the calling object does not - have access.
-		Stage
 InheritedfocusRect : Object -
- - Specifies whether this object displays a focus rectangle.
-		InteractiveObject
  frameRate : Number -
- Gets and sets the frame rate of the stage.
-		Stage
  fullScreenHeight : uint -
[read-only] - Returns the height of the monitor that will be used when going to full screen size, if that state - is entered immediately.
-		Stage
  fullScreenSourceRect : Rectangle -
- Sets the Flash runtime to scale a specific region of the stage to full-screen mode.
-		Stage
  fullScreenWidth : uint -
[read-only] - Returns the width of the monitor that will be used when going to full screen size, if that state - is entered immediately.
-		Stage
  height : Number -
- Indicates the height of the display object, in pixels.
-		Stage
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
  mouseChildren : Boolean -
- Determines whether or not the children of the object are mouse, or user input device, enabled.
-		Stage
 InheritedmouseEnabled : Boolean -
- - Specifies whether this object receives mouse, or other user input, messages.
-		InteractiveObject
  mouseLock : Boolean -
- Set to true to enable mouse locking.
-		Stage
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
  nativeWindow : NativeWindow -
[read-only] - A reference to the NativeWindow object containing this Stage.
-		Stage
 InheritedneedsSoftKeyboard : Boolean -
- - Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - - when this InteractiveObject instance receives focus.
-		InteractiveObject
  numChildren : int -
[read-only] - Returns the number of children of this object.
-		Stage
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
  orientation : String -
[read-only] - The current orientation of the stage.
-		Stage
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : String -
- A value from the StageQuality class that specifies which rendering quality is used.
-		Stage
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
  scaleMode : String -
- A value from the StageScaleMode class that specifies which scale mode to use.
-		Stage
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
  showDefaultContextMenu : Boolean -
- Specifies whether to show or hide the default items in the Flash runtime - context menu.
-		Stage
 InheritedsoftKeyboard : String -
- - Controls the appearance of the soft keyboard.
-		InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle -
- - Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
-		InteractiveObject
  softKeyboardRect : Rectangle -
[read-only] - A Rectangle specifying the area of the stage that is currently covered by a soft - keyboard.
-		Stage
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
  stage3Ds : Vector.<Stage3D>
[read-only] - A list of Stage3D objects available for displaying 3-dimensional content.
-		Stage
  stageFocusRect : Boolean -
- Specifies whether or not objects display a glowing border when they have focus.
-		Stage
  stageHeight : int -
- The current height, in pixels, of the Stage.
-		Stage
  stageVideos : Vector.<StageVideo>
[read-only] - - A list of StageVideo objects available for playing external videos.
-		Stage
  stageWidth : int -
- Specifies the current width, in pixels, of the Stage.
-		Stage
  supportedOrientations : Vector.<String>
[read-only] - The orientations supported by the current device.
-		Stage
  supportsOrientationChange : Boolean -
[static][read-only] - Whether the application supports changes in the stage orientation (and device rotation).
-		Stage
  tabChildren : Boolean -
- Determines whether the children of the object are tab enabled.
-		Stage
 InheritedtabEnabled : Boolean -
- - Specifies whether this object is in the tab order.
-		InteractiveObject
 InheritedtabIndex : int -
- - Specifies the tab ordering of objects in a SWF file.
-		InteractiveObject
  textSnapshot : TextSnapshot -
[read-only] - Returns a TextSnapshot object for this DisplayObjectContainer instance.
-		Stage
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
  vsyncEnabled : Boolean -
- This represents current state of vsync of underlying graphics solution - We can enable/disable vsync, so we would immediately render without waiting for next VSYNC'ed state.
-		Stage
  width : Number -
- Indicates the width of the display object, in pixels.
-		Stage
  wmodeGPU : Boolean -
[read-only] - Indicates whether GPU compositing is available and in use.
-		Stage
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-addChild(child:DisplayObject):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer instance.
-		Stage
   -
-addChildAt(child:DisplayObject, index:int):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer - instance.
-		Stage
   -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		Stage
 Inherited -
-areInaccessibleObjectsUnderPoint(point:Point):Boolean -
-
- Indicates whether the security restrictions - would cause any display objects to be omitted from the list returned by calling - the DisplayObjectContainer.getObjectsUnderPoint() method - with the specified point point.
-		DisplayObjectContainer
   -
-assignFocus(objectToFocus:InteractiveObject, direction:String):void -
-
- Sets keyboard focus to the interactive object specified by objectToFocus, with - the focus direction specified by the direction parameter.
-		Stage
 Inherited -
-contains(child:DisplayObject):Boolean -
-
- Determines whether the specified display object is a child of the DisplayObjectContainer instance or - the instance itself.
-		DisplayObjectContainer
   -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		Stage
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getChildAt(index:int):DisplayObject -
-
- Returns the child display object instance that exists at the specified index.
-		DisplayObjectContainer
 Inherited -
-getChildByName(name:String):DisplayObject -
-
- Returns the child display object that exists with the specified name.
-		DisplayObjectContainer
 Inherited -
-getChildIndex(child:DisplayObject):int -
-
- Returns the index position of a child DisplayObject instance.
-		DisplayObjectContainer
 Inherited -
-getObjectsUnderPoint(point:Point):Array -
-
- Returns an array of objects that lie under the specified point and are children - (or grandchildren, and so on) of this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
   -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		Stage
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
   -
-invalidate():void -
-
- Calling the invalidate() method signals Flash runtimes to alert display objects - on the next opportunity it has to render the display list (for example, when the playhead - advances to a new frame).
-		Stage
   -
-isFocusInaccessible():Boolean -
-
- Determines whether the Stage.focus property returns null for - security reasons.
-		Stage
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
   -
-preloadComplete(mainClass:String):Boolean -
-
- Notify to the runtime that a preloader is complete and request to load the main class.
-		Stage
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeChild(child:DisplayObject):DisplayObject -
-
- Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
   -
-removeChildAt(index:int):DisplayObject -
-
- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer.
-		Stage
 Inherited -
-removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void -
-
- Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-requestSoftKeyboard():Boolean -
-
- - Raises a virtual keyboard.
-		InteractiveObject
   -
-setAspectRatio(newAspectRatio:String):void -
-
- Sets the stage to an orientation with the specified aspect ratio.
-		Stage
   -
-setChildIndex(child:DisplayObject, index:int):void -
-
- Changes the position of an existing child in the display object container.
-		Stage
   -
-setOrientation(newOrientation:String):void -
-
- Sets the stage to the specified orientation.
-		Stage
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopAllMovieClips():void -
-
- Recursively stops the timeline execution of all MovieClips rooted at this object.
-		DisplayObjectContainer
 Inherited -
-swapChildren(child1:DisplayObject, child2:DisplayObject):void -
-
- Swaps the z-order (front-to-back order) of the two specified child objects.
-		DisplayObjectContainer
   -
-swapChildrenAt(index1:int, index2:int):void -
-
- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list.
-		Stage
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
   -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		Stage
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
   -
-browserZoomChange -
-		 - Dispatched when the browserZoomFactor property of the Stage object is changed.Stage
 Inherited -
-clear -
-		 - - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 Inherited -
-click -
-		 - - Dispatched when a user presses and releases the main button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-contextMenu -
-		 - - Dispatched when a user gesture triggers the context menu associated with this interactive - - object in an AIR application.InteractiveObject
 Inherited -
-copy -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - - or selects 'Copy' from the text context menu.InteractiveObject
 Inherited -
-cut -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - - or selects 'Cut' from the text context menu.InteractiveObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-doubleClick -
-		 - - Dispatched when a user presses and releases the main button of a pointing device twice in - - rapid succession over the same InteractiveObject when that object's - - doubleClickEnabled flag is set to true.InteractiveObject
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-focusIn -
-		 - - Dispatched after a display object gains focus.InteractiveObject
 Inherited -
-focusOut -
-		 - - Dispatched after a display object loses focus.InteractiveObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
   -
-fullScreen -
-		 - Dispatched when the Stage object enters, or leaves, full-screen mode.Stage
 Inherited -
-gestureDirectionalTap -
-		 - - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - - Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 Inherited -
-gestureLongPress -
-		 - - Dispatched when the user presses two points of contact over the same InteractiveObject instance - - on a touch-enabled device (such as presses and releases two fingers over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gesturePan -
-		 - - Dispatched when the user moves a point of contact over the InteractiveObject instance - - on a touch-enabled device (such as moving a finger from left to right over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureRotate -
-		 - - Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers - - and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureSwipe -
-		 - - Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three - - fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureTap -
-		 - - Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps - - on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureZoom -
-		 - - Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two - - fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-imeStartComposition -
-		 - - This event is dispatched to any client app that supports inline input with an IME - - - - InteractiveObject
 Inherited -
-keyDown -
-		 - - Dispatched when the user presses a key.InteractiveObject
 Inherited -
-keyFocusChange -
-		 - - Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited -
-keyUp -
-		 - - Dispatched when the user releases a key.InteractiveObject
 Inherited -
-middleClick -
-		 - - Dispatched when a user presses and releases the middle button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-middleMouseDown -
-		 - - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-middleMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseFocusChange -
-		 - - Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
   -
-mouseLeave -
-		 - Dispatched by the Stage object when the pointer moves out of the - stage area.Stage
 Inherited -
-mouseMove -
-		 - - Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited -
-mouseOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheel -
-		 - - Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheelHorizontal -
-		 - - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-nativeDragComplete -
-		 - - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited -
-nativeDragDrop -
-		 - - Dispatched by the target InteractiveObject when a dragged object is - - dropped on it and the drop has been accepted with a call to - - DragManager.acceptDragDrop().InteractiveObject
 Inherited -
-nativeDragEnter -
-		 - - Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited -
-nativeDragExit -
-		 - - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited -
-nativeDragOver -
-		 - - Dispatched by an InteractiveObject continually while a drag gesture remains within its - - boundary.InteractiveObject
 Inherited -
-nativeDragStart -
-		 - - Dispatched at the beginning of a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-nativeDragUpdate -
-		 - - Dispatched during a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
   -
-orientationChange -
-		 - Dispatched by the Stage object when the stage orientation changes.Stage
   -
-orientationChanging -
-		 - Dispatched by the Stage object when the stage orientation begins changing.Stage
 Inherited -
-paste -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - - or selects 'Paste' from the text context menu.InteractiveObject
 Inherited -
-proximityBegin -
-		 - - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityEnd -
-		 - - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityMove -
-		 - - Dispatched when the user moves an active stylus over the screen while remaining within - - the proximity detection threshold.InteractiveObject
 Inherited -
-proximityOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - - the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityOver -
-		 - - Dispatched when the user moves an active stylus directly above this InteractiveObject - - while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject - - and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOver -
-		 - - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - - object's tree of descendents in the display list - - (while remaining within the proximity detection threshold of the screen).InteractiveObject
 Inherited -
-releaseOutside -
-		 - - Dispatched when a user releases the button on the pointing device after the - - user first pressed the button over an InteractiveObject instance - - and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
   -
-resize -
-		 - Dispatched when the scaleMode property of the Stage object is set to - StageScaleMode.NO_SCALE and the SWF file is resized.Stage
 Inherited -
-rightClick -
-		 - - Dispatched when a user presses and releases the right button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-rightMouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-rightMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-rollOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject - - instance.InteractiveObject
 Inherited -
-rollOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-selectAll -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a select all operation - - or selects 'Select All' from the text context menu.InteractiveObject
 Inherited -
-softKeyboardActivate -
-		 - - Dispatched immediately after the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardActivating -
-		 - - Dispatched immediately before the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardDeactivate -
-		 - - Dispatched immediately after the soft keyboard is lowered.InteractiveObject
   -
-stageVideoAvailability -
-		 - Dispatched by the Stage object when the state of the stageVideos property changes.Stage
 Inherited -
-tabChildrenChange -
-		 - - Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited -
-tabEnabledChange -
-		 - - Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited -
-tabIndexChange -
-		 - - Dispatched when the value of the object's tabIndex property changes.InteractiveObject
 Inherited -
-textInput -
-		 - - Dispatched when a user enters one or more - - characters of text.InteractiveObject
 Inherited -
-touchBegin -
-		 - - Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchEnd -
-		 - - Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchMove -
-		 - - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 Inherited -
-touchOut -
-		 - - Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device - - (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOut -
-		 - - Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchTap -
-		 - - Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated - - on a touch-enabled device (such as presses and releases a finger from a single point over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
   -
-VsyncStateChangeAvailability -
-		 - Dispatched by the Stage object when the state of the vsync property is changed.Stage
-
- -
- -
Property detail
- - - - - -
alignproperty
-
-align:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A value from the StageAlign class that specifies the alignment of the stage in - Flash Player or the browser. The following are valid values: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ValueVertical AlignmentHorizontal
StageAlign.TOPTopCenter
StageAlign.BOTTOMBottomCenter
StageAlign.LEFTCenterLeft
StageAlign.RIGHTCenterRight
StageAlign.TOP_LEFTTopLeft
StageAlign.TOP_RIGHTTopRight
StageAlign.BOTTOM_LEFTBottomLeft
StageAlign.BOTTOM_RIGHTBottomRight
-

- -

The align property is only available to an object that is in the same security sandbox - as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the - calling object by calling the Security.allowDomain() method or the Security.alowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide.

- - Implementation -
-    public function get align():String -
-    public function set align(value:String):void -
-

-See also -

-
-flash.display.StageAlign -
-
- - - - - -
allowsFullScreenproperty 
-
-allowsFullScreen:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether this stage allows the use of the full screen mode -

Implementation -
-    public function get allowsFullScreen():Boolean -
-
- - - - - -
allowsFullScreenInteractiveproperty 
-
-allowsFullScreenInteractive:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether this stage allows the use of the full screen with text input mode -

Implementation -
-    public function get allowsFullScreenInteractive():Boolean -
-
- - - - - -
autoOrientsproperty 
-
-autoOrients:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether the stage automatically changes orientation when the device orientation changes. - -

The initial value of this property is derived from the autoOrients - element of the application descriptor and defaults to false. When changing the - property to false, the behavior is not guaranteed. On some devices, the - stage remains in the current orientation. On others, the stage orientation changes to - a device-defined "standard" orientation, after which, no further stage orientation changes occur.

-

AIR profile support: This feature is supported - on mobile devices, but it is not supported on desktop operating systems or AIR for TV devices. You can test - for support at run time using the Stage.supportsOrientantionChange property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- Implementation -
-    public function get autoOrients():Boolean -
-    public function set autoOrients(value:Boolean):void -
-

-See also -

-
-deviceOrientation -
-supportsOrientationChange -
-
- - - - - -
browserZoomFactorproperty 
-
-browserZoomFactor:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies the browser zoom factor. A change in browser zoom factor affects the scaling factor of the stage. - -

Implementation -
-    public function get browserZoomFactor():Number -
-
- - - - - -
colorproperty 
-
-color:uint  [read-write]

- - - - -
Runtime version: AIR 2.5 -
-

- The SWF background color. - -

Defaults to the stage background color, as set by the SWF tag SetBackgroundColor.

- Implementation -
-    public function get color():uint -
-    public function set color(value:uint):void -
-
- - - - - -
colorCorrectionproperty 
-
-colorCorrection:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Controls Flash runtime color correction for displays. - Color correction works only if the main monitor is assigned a valid ICC color profile, which specifies - the device's particular color attributes. - By default, the Flash runtime tries to match the color correction of its host (usually a browser). -

Use the Stage.colorCorrectionSupport property - to determine if color correction is available on the current system and the default state. -. If color correction is available, all colors on the stage are assumed to be in - the sRGB color space, which is the most standard color space. Source profiles of input devices are not considered during color correction. - No input color correction is applied; only the stage output is mapped to the main - monitor's ICC color profile.

- -

In general, the benefits of activating color management include predictable and consistent color, better conversion, - accurate proofing and more efficient cross-media output. Be aware, though, that color management does not provide - perfect conversions due to devices having a different gamut from each other or original images. - Nor does color management eliminate the need for custom or edited profiles. - Color profiles are dependent on browsers, operating systems (OS), OS extensions, output devices, and application support.

-

Applying color correction degrades the Flash runtime performance. - A Flash runtime's color correction is document style color correction because - all SWF movies are considered documents with implicit sRGB profiles. - Use the Stage.colorCorrectionSupport property to tell the Flash runtime - to correct colors when displaying the SWF file (document) to the display color space. - Flash runtimes only compensates for differences between monitors, not for differences between input devices (camera/scanner/etc.). -

-

The three possible values are strings with corresponding constants in the flash.display.ColorCorrection class:

-
  • "default": Use the same color correction as the host system.
    • -
  • "on": Always perform color correction.
    • -
  • "off": Never perform color correction.
    • -
- Implementation -
-    public function get colorCorrection():String -
-    public function set colorCorrection(value:String):void -
-

-See also -

-
-flash.display.ColorCorrection -
-colorCorrectionSupport -
-
-Example -
The following example shows an event handler that toggles color correction in the current - SWF file and populates a text field with - the current state of color correction. If the Stage.colorCorrection value is not a value - from the ColorCorrection class, then the handler reports an error. -
-
-function addHandler(add_event:Event) {
-    switch(stage.colorCorrection) {
-		case ColorCorrection.ON:
-			stage.colorCorrection = ColorCorrection.OFF;
-			lblCMEnableState.text = "State: " + stage.colorCorrection;
-			break;
-		case ColorCorrection.OFF:
-			stage.colorCorrection = ColorCorrection.DEFAULT;
-			lblCMEnableState.text = "State: " + stage.colorCorrection;
-			break;
-		case ColorCorrection.DEFAULT:
-			stage.colorCorrection = ColorCorrection.ON;
-			lblCMEnableState.text = "State: " + stage.colorCorrection;
-			break;
-		default:
-			lblCMEnableState.text = "Error.";
-			break;
-}
-
-

-
- - - - - -
colorCorrectionSupportproperty 
-
-colorCorrectionSupport:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies whether the Flash runtime is running on an operating system that supports - color correction and whether the color profile of the main (primary) - monitor can be read and understood by the Flash runtime. This property also returns the default state - of color correction on the host system (usually the browser). - Currently the return values can be: -

The three possible values are strings with corresponding constants in the flash.display.ColorCorrectionSupport class:

-
  • "unsupported": Color correction is not available.
    • -
  • "defaultOn": Always performs color correction.
    • -
  • "defaultOff": Never performs color correction.
    • -
- Implementation -
-    public function get colorCorrectionSupport():String -
-

-See also -

-
-flash.display.ColorCorrectionSupport -
-colorCorrection -
-
-Example -
The following example shows an event handler that populates a text field with - the current environment's ability to support color correction or not. First, it checks the value - of stage.colorCorrectionSupport to see if it is DEFAULT_ON or DEFAULT_OFF, - values from the ColorCorrectionSupport class. If the property is either value, then the text field displays the current value. - Otherwise, if the value is neither DEFAULT_ON nor DEFAULT_OFF, the text field displays "unsupported". -
-
-function addHandler(add_event:Event) {
-    if (stage.colorCorrectionSupport == ColorCorrectionSupport.DEFAULT_ON || stage.colorCorrectionSupport == ColorCorrectionSupport.DEFAULT_OFF) {
-   		lblHasCM.text = "stage.colorCorrectionSupport: " + stage.colorCorrectionSupport;
-	} 
-	else {
-	    lblHasCM.text = "stage.colorCorrectionSupport: unsupported";
-	}
-}
-
-

-
- - - - - -
constructorproperty 
-
-public var constructor:* -
- - - - - -
contentsScaleFactorproperty 
-
-contentsScaleFactor:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies the effective pixel scaling factor of the stage. This value is 1 on - standard screens and HiDPI (Retina display) screens. When the stage is rendered - on HiDPI screens the pixel resolution is doubled; even if the stage scaling mode - is set to StageScaleMode.NO_SCALE. Stage.stageWidth and Stage.stageHeight continue - to be reported in classic pixel units. - -

Implementation -
-    public function get contentsScaleFactor():Number -
-
- - - - - -
deviceOrientationproperty 
-
-deviceOrientation:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The physical orientation of the device. - -

On devices with slide-out keyboards, the state of the keyboard has a higher priority in determining the device orientation - than the rotation detected by the accelerometer. Thus on a portrait-aspect device with a side-mounted keyboard, - the deviceOrientation property will report ROTATED_LEFT when the keyboard is open - no matter how the user is holding the device.

-

Use the constants defined in the StageOrientation class when setting or comparing values for this property.

- -

AIR profile support: This feature is supported - on mobile devices, but it is not supported on desktop operating systems or AIR for TV devices. You can test - for support at run time using the Stage.supportsOrientationChange property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- - Implementation -
-    public function get deviceOrientation():String -
-

-See also -

-
-autoOrients -
-StageOrientation -
-
- - - - - -
displayStateproperty 
-
-displayState:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A value from the StageDisplayState class that specifies which display state to use. The following - are valid values: -

    - -
  • StageDisplayState.FULL_SCREEN Sets AIR application or content in Flash Player to expand the - stage over the user's entire screen. Keyboard input is disabled, with the exception of a limited set of non-printing keys.
    • - -
  • StageDisplayState.FULL_SCREEN_INTERACTIVE Sets the application to expand the - stage over the user's entire screen, with keyboard input allowed. - (Available in AIR and Flash Player, beginning with Flash Player 11.3.)
    • - -
  • StageDisplayState.NORMAL Sets the stage back to the standard stage display mode.
    • - -
- -

The scaling behavior of the movie in full-screen mode is determined by the scaleMode - setting (set using the Stage.scaleMode property or the SWF file's embed - tag settings in the HTML file). If the scaleMode property is set to noScale - while the application transitions to full-screen mode, the Stage width and height - properties are updated, and the Stage dispatches a resize event. If any other scale mode is set, - the stage and its contents are scaled to fill the new screen dimensions. The Stage object retains its original - width and height values and does not dispatch a resize event.

- -

The following restrictions apply to SWF files that play within an HTML page (not those using the stand-alone - Flash Player or AIR runtime):

- -
    - -
  • To enable full-screen mode, add the allowFullScreen parameter to the object - and embed tags in the HTML page that includes the SWF file, with allowFullScreen set - to "true", as shown in the following example: - - 
    <param name="allowFullScreen" value="true" />
-          ...
-    <embed src="example.swf" allowFullScreen="true" ... >
    - -

    An HTML page may also use a script to generate SWF-embedding tags. You need to alter the script - so that it inserts the proper allowFullScreen settings. HTML pages generated by Flash Professional and - Flash Builder use the AC_FL_RunContent() function to embed references to SWF files, and you - need to add the allowFullScreen parameter settings, as in the following:

    - - 
    AC_FL_RunContent( ... "allowFullScreen", "true", ... )
    • - -
  • Full-screen mode is initiated in response to a mouse click or key press by the user; the movie cannot change - Stage.displayState without user input. Flash runtimes restrict keyboard input in full-screen mode. - Acceptable keys include keyboard shortcuts that terminate full-screen mode and non-printing keys such as arrows, space, Shift, - and Tab keys. (Use full-screen interactive mode to support input from additional keys.) - Keyboard shortcuts that terminate full-screen mode are: Escape (Windows, Linux, and Mac), Control+W (Windows), - Command+W (Mac), and Alt+F4.
    • -
  • Starting with Flash Player 9.0.115.0, full-screen works the same in windowless mode as it does in window mode. - If you set the Window Mode (wmode in the HTML) to Opaque Windowless (opaque) - or Transparent Windowless (transparent), full-screen can be initiated, - but the full-screen window will always be opaque.
    • - -
  • To enable full-screen interactive mode, which supports keyboard interactivity, - add the allowFullScreenInteractive parameter to the object - and embed tags in the HTML page that includes the SWF file, with allowFullScreenInteractive set - to "true", as shown in the following example: - - 
    <param name="allowFullScreenInteractive" value="true" />
-          ...
    • - -
-

These restrictions are not present for SWF content running in the - stand-alone Flash Player or in AIR.

- -

When entering full-screen mode, the Flash runtime briefly displays a notification over the SWF content - to inform the users they are in full-screen mode and that they can press the Escape key to end full-screen mode. -

-

When entering full-screen interactive mode, Flash Player displays a confirmation prompt over the SWF - content, enabling users to allow access to extended keyboard input (including printing keys) and informing users - that they can press the Escape key to end full-screen interactive mode. You should not make assumptions about - the appearance/location of the confirmation prompt. You can determine if users have allowed access to extended - keyboard input by listening for the FullScreenEvent.FULL_SCREEN_INTERACTIVE_ACCEPTED event. -

-

For AIR content running in full-screen mode, the system screen saver - and power saving options are disabled while video content is playing and until either the video stops - or full-screen mode is exited.

- -

On Linux, setting displayState to StageDisplayState.FULL_SCREEN or - StageDisplayState.FULL_SCREEN_INTERACTIVE is an asynchronous operation.

-

Note that it is not possible to change the display state within an event handler that is dispatched due to - a change in the display state: this could lead to recursion and would also cause problems within the native - operating system handling for these mechanisms. A SecurityError is thrown if the displayState - property is changed within a FullScreenEvent event handler.

- Implementation -
-    public function get displayState():String -
-    public function set displayState(value:String):void -
-
-Throws -
- - - - -
SecurityError — Calling the displayState property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - Trying to set the displayState property while the settings dialog is displayed, without a user response, or - if the param or embed HTML tag's allowFullScreen attribute is not set to - true throws a security error. It is also forbidden to set the displayState property within a - FullScreenEvent handler. -
-

-See also -

-
-flash.display.StageDisplayState -
-Stage.scaleMode -
-flash.events.FullScreenEvent -
-flash.events.Event.RESIZE -
-
-Example -
The following example creates an interactive demonstration of - how to create a fullscreen experience by modifying the displayState - property.

Note: Fullscreen can only be triggered in certain situations, such as if the - user has clicked or pressed a key, due to security restrictions. When run in a - browser, the allowFullScreen property must be set to true.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.display.Stage;
-	import flash.events.*;
-	import flash.net.NetConnection;
-	import flash.net.NetStream;
-	import flash.media.Video;
-	
-	public class FullScreenExample extends Sprite
-	{
-		private var videoURL:String = "testVideo.flv";
-		private var connection:NetConnection;
-		private var stream:NetStream;
-		private var video:Video;		
-		
-		public function FullScreenExample() {
-			connection = new NetConnection();
-			connection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-			connection.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-			connection.connect(null);
-			
-			loaderInfo.addEventListener(Event.INIT, createMouseListener);			
-		}
-
-		private function createMouseListener(event:Event):void {
-			stage.addEventListener(MouseEvent.CLICK,toggleFullScreen);
-		}		
-		
-		private function toggleFullScreen(event:MouseEvent):void {
-			switch(stage.displayState) {
-				case "normal":
-					stage.displayState = "fullScreen";	
-					break;
-				case "fullScreen":
-				default:
-					stage.displayState = "normal";	
-					break;
-			}
-		}	
-		
-		// Video related:
-		private function netStatusHandler(event:NetStatusEvent):void {
-			switch (event.info.code) {
-				case "NetConnection.Connect.Success":
-					connectStream();
-					break;
-				case "NetStream.Play.StreamNotFound":
-					trace("Unable to locate video: " + videoURL);
-					break;
-			}
-		}
-		private function connectStream():void {
-			var stream:NetStream = new NetStream(connection);
-			stream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-			stream.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler);
-
-			video = new Video(stage.stageWidth,stage.stageHeight);
-			video.attachNetStream(stream);
-			stream.play(videoURL);
-			addChild(video);
-		}
-		private function securityErrorHandler(event:SecurityErrorEvent):void {
-			trace("securityErrorHandler: " + event);
-		}
-		private function asyncErrorHandler(event:AsyncErrorEvent):void {
-			// ignore AsyncErrorEvent events.
-		}			
-	}
-}
-
-

-
- - - - - -
focusproperty 
-
-focus:InteractiveObject  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The interactive object with keyboard focus; or null if focus is not set - or if the focused object belongs to a security sandbox to which the calling object does not - have access. -

Implementation -
-    public function get focus():InteractiveObject -
-    public function set focus(value:InteractiveObject):void -
-
-Throws -
- - - - -
Error — Throws an error if focus cannot be set to the target. -
-
-Example -
The following sets the initial focus to the text field myTF so the user can start typing without having to click anything. - On iOS, Android mobile devices and tvOS device, the user needs to click the text field to activate soft keyboard. - If you test this code within the authoring tool interface, you can only have access to a few keys because the host (browser or tool) interprets most - key presses first. To see this example work as intended, compile it and run the SWF file. -
-
-var myTF:TextField = new TextField();
-myTF.border =true;
-myTF.type = TextFieldType.INPUT;
-
-addChild(myTF);
-stage.focus= myTF;
-
-

-
- - - - - -
frameRateproperty 
-
-frameRate:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Gets and sets the frame rate of the stage. The frame rate is defined as frames per second. - By default the rate is set to the frame rate of the first SWF file loaded. Valid range for the frame rate - is from 0.01 to 1000 frames per second. - -

Note: An application might not be able to follow - high frame rate settings, either because the target platform is not fast enough or the player is - synchronized to the vertical blank timing of the display device (usually 60 Hz on LCD devices). - In some cases, a target platform might also choose to lower the maximum frame rate if it - anticipates high CPU usage.

- -

For content running in Adobe AIR, setting the frameRate property of one Stage - object changes the frame rate for all Stage objects (used by different NativeWindow objects). -

- - Implementation -
-    public function get frameRate():Number -
-    public function set frameRate(value:Number):void -
-
-Throws -
- - - - -
SecurityError — Calling the frameRate property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
fullScreenHeightproperty 
-
-fullScreenHeight:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the height of the monitor that will be used when going to full screen size, if that state - is entered immediately. If the user has multiple monitors, the monitor that's used is the - monitor that most of the stage is on at the time. - -

Note: If the user has the opportunity to move the browser from one - monitor to another between retrieving the value and going to full screen - size, the value could be incorrect. If you retrieve the value in an event handler that - sets Stage.displayState to StageDisplayState.FULL_SCREEN, the value will be - correct.

-

This is the pixel height of the monitor and is the same as the - stage height would be if Stage.align is set to StageAlign.TOP_LEFT - and Stage.scaleMode is set to StageScaleMode.NO_SCALE.

- Implementation -
-    public function get fullScreenHeight():uint -
-

-See also -

-
-displayState -
-fullScreenSourceRect -
-fullScreenWidth -
-scaleMode -
-StageDisplayState -
-flash.events.Event.RESIZE -
-flash.events.FullScreenEvent -
-
-Example -
This example creates a green rectangle the size of the stage and places a red square on it that - it activates as a button. Clicking the red square triggers the enterFullScreen() event handler, - which sets the fullScreenSourceRect property and enters full screen mode. To set the - fullScreenSourceRect property, the event handler starts with the location and dimensions of the - red square. It then compares the aspect ratio (width divided by height) of the red square to the - aspect ratio of the stage at full screen width and height so that it can expand the rectangle - (fullScreenSourceRect) to match the screen's aspect ratio. The result is that the red - square occupies the entire height of the monitor with the green background visible on each side. - If the aspect ratio was not matched, the stage background color, which is white by default, would show - on each side instead of the green background. - -

Note: Test this example in the browser. In the Flash Publish Settings dialog, on the HTML tab, - select the template Flash Only - Allow Full Screen. Specify the Flash Player version 9.0.115.0, and make sure - the Flash and HTML formats are selected on the Formats tab. Then publish and open the resulting HTML file in - the browser.

-
-
-
-import flash.display.Sprite;
-import flash.display.Stage;
-import flash.display.StageDisplayState;
-import flash.events.MouseEvent;
-import flash.geom.Rectangle;
- 
-// cover the stage with a green rectangle
-var greenRect:Sprite = new Sprite();
-greenRect.graphics.beginFill(0x00FF00);
-greenRect.graphics.drawRect(0, 0, stage.stageWidth, stage.stageHeight);
-addChild(greenRect);
- 
-// create red square on stage, turn it into a button for going to full screen
-var redSquare:Sprite = new Sprite();
-redSquare.graphics.beginFill(0xFF0000);
-redSquare.graphics.drawRect(0, 0, 300, 300);
-redSquare.x = 50;
-redSquare.y = 50;
-redSquare.addEventListener(MouseEvent.CLICK, enterFullScreen);
-redSquare.buttonMode = true;
-addChild(redSquare);
- 
-function enterFullScreen(e:MouseEvent):void
-{
-    // we will go to full screen zoomed in on the red square
-	var redSquare:Sprite = e.target as Sprite;
-	var fullScreenRect:Rectangle = new Rectangle(redSquare.x, redSquare.y, redSquare.width, redSquare.height);
- 
-	// calculate aspect ratio of the red square
-	var rectAspectRatio:Number = fullScreenRect.width / fullScreenRect.height;
- 
-	// calculate aspect ratio of the screen
-	var screenAspectRatio:Number = stage.fullScreenWidth / stage.fullScreenHeight;
-  
-	// change the fullScreenRect so that it covers the entire screen, keeping it centered on the redSquare
-	// try commenting out this section to see what happens if you do not fix the aspect ratio.
-	if (rectAspectRatio > screenAspectRatio) {
- 		var newHeight:Number = fullScreenRect.width / screenAspectRatio;
- 		fullScreenRect.y -= ((newHeight - fullScreenRect.height) / 2);
-		fullScreenRect.height = newHeight;
-	} else if (rectAspectRatio < screenAspectRatio) {
-		var newWidth:Number = fullScreenRect.height * screenAspectRatio;
-		fullScreenRect.x -= ((newWidth - fullScreenRect.width) / 2);
-		fullScreenRect.width = newWidth;
-	}
- 
-	// go to full screen
-	stage.fullScreenSourceRect = fullScreenRect;
-	stage.displayState = StageDisplayState.FULL_SCREEN;
-}
-
-

-
- - - - - -
fullScreenSourceRectproperty 
-
-fullScreenSourceRect:Rectangle  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Sets the Flash runtime to scale a specific region of the stage to full-screen mode. - If available, the Flash runtime scales in hardware, which uses the graphics and video card on a user's computer, - and generally displays content more quickly than software scaling. -

When this property is set to a valid rectangle and the displayState property is set to full-screen mode, - the Flash runtime scales the specified area. The actual Stage size in pixels within ActionScript does not change. - The Flash runtime enforces a minimum limit for the size of the rectangle to accommodate the standard "Press Esc to exit full-screen mode" message. - This limit is usually around 260 by 30 pixels but can vary on platform and Flash runtime version.

-

This property can only be set when the Flash runtime is not in full-screen mode. - To use this property correctly, set this property first, then set the displayState property to full-screen mode, as shown in the code examples. - Note: In Flash Player 15 and later, this property can be set even when the Flash runtime is in full-screen mode.

-

To enable scaling, set the fullScreenSourceRect property to a rectangle object:

- 
  
-     // valid, will enable hardware scaling
-     stage.fullScreenSourceRect = new Rectangle(0,0,320,240); 
-
-

To disable scaling, set the fullScreenSourceRect=null in ActionScript 3.0, and undefined in ActionScript 2.0.

- 
-     stage.fullScreenSourceRect = null;
-
-

The end user also can select within Flash Player Display Settings to turn off hardware scaling, which is enabled by default. - For more information, see www.adobe.com/go/display_settings.

- Implementation -
-    public function get fullScreenSourceRect():Rectangle -
-    public function set fullScreenSourceRect(value:Rectangle):void -
-

-See also -

-
-flash.display.StageDisplayState -
-Stage.displayState -
-Stage.scaleMode -
-flash.events.FullScreenEvent -
-flash.events.Event.RESIZE -
-
-Example -
To take advantage of hardware scaling, you set the whole stage or part of the stage to full-screen mode. - The following ActionScript 3.0 code sets the whole stage to full-screen mode: -
-
- 
-import flash.geom.*; 
-{
-  stage.fullScreenSourceRect = new Rectangle(0,0,320,240);
-  stage.displayState = StageDisplayState.FULL_SCREEN;
-}
-
-

In the following example, the user can switch between playing a video in full or normal - screen mode by clicking on the stage. If the SWF for this example is running in Flash Player 9.0.115.0 - or later, then it will use hardware acceleration to improve the full-screen scaling of the display. - -

Before using the full-screen mode with hardware scaling, the following conditions must be met:

- -
    -
  1. Flash Player version 9.0.115.0 or later is needed, - as well as an authoring tool that supports it.
    2. -
  2. HTML templates need to be modified to support full screen. The allowFullScreen - attribute must be set to true for the object and embed tag. - (The scripts that generate SWF-embedding tags must also allow for full screen.) For sample of - files that can be used for Flash Builder, see the article, - Exploring full-screen - mode in Flash Player 9.
    3. -
  3. Your application must have permission and access to an FLV video file. In this example, it is assumed - that Flash Video (FLV) file is in the same directory as the SWF file.
    4. -
  4. The user must allow access to full screen.
    5. -
  5. For additional information on hardware scaling, see the article - Exploring Flash Player support for high-definition H.264 video and AAC audio for Flash Player.
    6. -
- -

An FLV file is loaded using NetConnection and NetStream objects. Since the FLV file - is in the same directory as the SWF file and will connect via HTTP, the NetConnection.connect() - method's parameter is set to null. The connect NetConnection object - reports its status by dispatching a netStatus event which invokes - the netStatusHandler() method. The netStatusHandler() method - checks if the connection was successful and invokes connectStream() method, - which creates a NetStream object that takes the NetConnection object as a parameter. - It also creates a video object and attached the NetStream object to the video object. - The video object then is added to the display list and the stream is set to play. Since - the FLV video file does not contain metadata or cue point information, an AsyncError - event will be dispatched. A listener must be set up to handle the event. Here the listener - is set up and it ignores the event. Another listener for netStatus event is also - set up for the NetStream object. It will display an error message if the stream was not found. - (Note that netStatusHandler() could be used to handle any number of different - status information reported for the stream or connection.)

- -

When the properties and methods of a loaded SWF file are accessible, the - createMouseListener() method is invoked. It sets up an event listener for when - the mouse is clicked on the stage. The toggleFullScreen() method checks if - the display state is in the full or normal screen mode. If it is normal, the size of the video object - is set to the size of the video stream. The fullScreenSourceRect property is set - to a rectangle matching the dimensions of the video object. Then the Stage.displayMode - property is set to full screen, which causes the video in the source rectangle to expand to fill - the full screen area. If system requirements are met, the machine's graphics hardware will be - used to improve the performance of the full-screen video rendering and the display state is set - to full-screen mode. In order to catch any security error that may occur while switching to - the full-screen mode, a try...catch is used. (Note that the display state must be - set to full-screen mode after the fullScreenSourceRect property is set.) Before - switching to the normal-screen mode, the video object's width and height are set back to the saved - original video object's width and height. Otherwise, the changes made to the video object for - the full-screen mode will determine the width and height.

- -
-
-package {
-    import flash.display.Sprite;
-	import flash.display.StageDisplayState;
-	import flash.media.Video;
-	import flash.net.NetConnection;
-	import flash.net.NetStream;
-	import flash.events.NetStatusEvent;
-	import flash.events.AsyncErrorEvent;
-	import flash.events.SecurityErrorEvent;
-	import flash.events.MouseEvent;
-	import flash.events.Event;
-	import flash.geom.Rectangle;
-	
-	public class Stage_fullScreenSourceRectExample2 extends Sprite {
-        private var videoURL:String = "testVideo1.flv";
-        private var connection:NetConnection;
-        private var stream:NetStream;
-        private var myVideo:Video;        
-		private	var savedWidth:uint;
-		private	var savedHeight:uint;
- 
-		public function Stage_fullScreenSourceRectExample2() {
-	
-	        connection = new NetConnection();
- 			connection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);	
-            connection.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-			connection.connect(null);
-
-            loaderInfo.addEventListener(Event.INIT, createMouseListener);            
-		}
-
-        private function createMouseListener(event:Event):void {
-            stage.addEventListener(MouseEvent.CLICK, toggleFullScreen);
-        }        
-
-        private function toggleFullScreen(event:MouseEvent):void {
-
-			if(stage.displayState == StageDisplayState.NORMAL) {
-				myVideo.width = myVideo.videoWidth;
- 	 			myVideo.height = myVideo.videoHeight;
-
-				try {
-					stage.fullScreenSourceRect = new Rectangle(myVideo.x, myVideo.y, 
-													       myVideo.width, myVideo.height);
-                 	stage.displayState = StageDisplayState.FULL_SCREEN;
-
-			 	} catch (e:SecurityError) {
-			 		trace ("A security error occurred while switching to full screen: " + event);
-	                myVideo.width = savedWidth;
-				    myVideo.height = savedHeight;
-			 	}
-
-			}else {
-                myVideo.width = savedWidth;
-			    myVideo.height = savedHeight;
-                stage.displayState = StageDisplayState.NORMAL;
-			}
-        }    
-
-       private function netStatusHandler(event:NetStatusEvent):void {
-            switch (event.info.code) {
-                case "NetConnection.Connect.Success":
-                    connectStream();
-                    break;
-                case "NetStream.Play.StreamNotFound":
-                    trace ("Unable to locate video: " + videoURL);
-                    break;
-            }
-        }
-
-       private function connectStream():void {
-            var stream:NetStream = new NetStream(connection);
-            stream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            stream.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler); 	
-
- 	        myVideo = new Video();
-            myVideo.attachNetStream(stream);
-            stream.play(videoURL);
-
-    		savedWidth = myVideo.width;
-	    	savedHeight = myVideo.height;
-
-            addChild(myVideo);
-        }
-       
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-			trace("securityErrorHandler: " + event);	
-        }
-        
-        private function asyncErrorHandler(event:AsyncErrorEvent):void {
-            
-        }            
-	}
-}
-
-

-
- - - - - -
fullScreenWidthproperty 
-
-fullScreenWidth:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the width of the monitor that will be used when going to full screen size, if that state - is entered immediately. If the user has multiple monitors, the monitor that's used is the - monitor that most of the stage is on at the time. -

Note: If the user has the opportunity to move the browser from one - monitor to another between retrieving the value and going to full screen - size, the value could be incorrect. If you retrieve the value in an event handler that - sets Stage.displayState to StageDisplayState.FULL_SCREEN, the value will be - correct.

- -

This is the pixel width of the monitor and is the same as the stage width would be if - Stage.align is set to StageAlign.TOP_LEFT and - Stage.scaleMode is set to StageScaleMode.NO_SCALE.

- - Implementation -
-    public function get fullScreenWidth():uint -
-

-See also -

-
-displayState -
-fullScreenHeight -
-fullScreenSourceRect -
-scaleMode -
-StageDisplayState -
-flash.events.Event.RESIZE -
-flash.events.FullScreenEvent -
-
-Example -
This example creates a green rectangle the size of the stage and places a red square on it that - it activates as a button. Clicking the red square triggers the enterFullScreen() event handler, - which sets the fullScreenSourceRect property and enters full screen mode. To set the - fullScreenSourceRect property, the event handler starts with the location and dimensions of the - red square. It then compares the aspect ratio (width divided by height) of the red square to the - aspect ratio of the stage at full screen width and height so that it can expand the rectangle - (fullScreenSourceRect) to match the screen's aspect ratio. The result is that the red - square occupies the entire height of the monitor with the green background visible on each side. - If the aspect ratio was not matched, the stage background color, which is white by default, would show - on each side instead of the green background. - -

Note: Test this example in the browser. In the Flash Publish Settings dialog, on the HTML tab, - select the template Flash Only - Allow Full Screen. Specify the Flash Player version 9.0.115.0, and make sure - the Flash and HTML formats are selected on the Formats tab. Then publish and open the resulting HTML file in - the browser.

-
-
-
-import flash.display.Sprite;
-import flash.display.Stage;
-import flash.display.StageDisplayState;
-import flash.events.MouseEvent;
-import flash.geom.Rectangle;
- 
-// cover the stage with a green rectangle
-var greenRect:Sprite = new Sprite();
-greenRect.graphics.beginFill(0x00FF00);
-greenRect.graphics.drawRect(0, 0, stage.stageWidth, stage.stageHeight);
-addChild(greenRect);
- 
-// create red square on stage, turn it into a button for going to full screen
-var redSquare:Sprite = new Sprite();
-redSquare.graphics.beginFill(0xFF0000);
-redSquare.graphics.drawRect(0, 0, 300, 300);
-redSquare.x = 50;
-redSquare.y = 50;
-redSquare.addEventListener(MouseEvent.CLICK, enterFullScreen);
-redSquare.buttonMode = true;
-addChild(redSquare);
- 
-function enterFullScreen(e:MouseEvent):void
-{
-    // we will go to full screen zoomed in on the red square
-	var redSquare:Sprite = e.target as Sprite;
-	var fullScreenRect:Rectangle = new Rectangle(redSquare.x, redSquare.y, redSquare.width, redSquare.height);
- 
-	// calculate aspect ratio of the red square
-	var rectAspectRatio:Number = fullScreenRect.width / fullScreenRect.height;
- 
-	// calculate aspect ratio of the screen
-	var screenAspectRatio:Number = stage.fullScreenWidth / stage.fullScreenHeight;
-  
-	// change the fullScreenRect so that it covers the entire screen, keeping it centered on the redSquare
-	// try commenting out this section to see what happens if you do not fix the aspect ratio.
-	if (rectAspectRatio > screenAspectRatio) {
- 		var newHeight:Number = fullScreenRect.width / screenAspectRatio;
- 		fullScreenRect.y -= ((newHeight - fullScreenRect.height) / 2);
-		fullScreenRect.height = newHeight;
-	} else if (rectAspectRatio < screenAspectRatio) {
-		var newWidth:Number = fullScreenRect.height * screenAspectRatio;
-		fullScreenRect.x -= ((newWidth - fullScreenRect.width) / 2);
-		fullScreenRect.width = newWidth;
-	}
- 
-	// go to full screen
-	stage.fullScreenSourceRect = fullScreenRect;
-	stage.displayState = StageDisplayState.FULL_SCREEN;
-}
-
-

-
- - - - - -
heightproperty 
-
-height:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- 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 height property, the scaleY property is adjusted accordingly, as shown in the - following code: - - 

-    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;
- -

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 height to a different value.

- Implementation -
-    public function get height():Number -
-    public function set height(value:Number):void -
-
-Throws -
- - - - - - - - - - -
SecurityError — Referencing the height property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
 
Error — It is always illegal to set the height property of a Stage object, - even if the calling object is the Stage owner (the main SWF file). - -
-
- - - - - -
mouseChildrenproperty 
-
-mouseChildren:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether or not the children of the object are mouse, or user input device, enabled. - If an object is enabled, a user can interact with it by using a mouse or user input device. The default is true. - -

This property is useful when you create a button with an instance of the Sprite class - (instead of using the SimpleButton class). When you use a Sprite instance to create a button, - you can choose to decorate the button by using the addChild() method to add additional - Sprite instances. This process can cause unexpected behavior with mouse events because - the Sprite instances you add as children can become the target object of a mouse event - when you expect the parent instance to be the target object. To ensure that the parent - instance serves as the target objects for mouse events, you can set the - mouseChildren property of the parent instance to false.

-

No event is dispatched by setting this property. You must use the - addEventListener() method to create interactive functionality.

- Implementation -
-    public function get mouseChildren():Boolean -
-    public function set mouseChildren(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — Referencing the mouseChildren property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
mouseLockproperty 
-
-mouseLock:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.2 -
-

- Set to true to enable mouse locking. - Enabling mouse locking turns off the cursor, and allows mouse movement with no bounds. - You can only enable mouse locking in full-screen mode for desktop applications. - Setting it on applications not in full-screen mode, or for applications on mobile devices, - throws an exception. -

Mouse locking is disabled automatically and the mouse cursor is made visible again when:

- -
    -
  • The user exits full-screen mode by using the Esc key (all platforms), - Control-W (Windows), Command-W (Mac), or Alt-F4 (Windows).
    • -
  • The application window loses focus.
    • -
  • Any settings UI is visible, including all privacy dialog boxes.
    • -
  • A native dialog box is shown, such as a file upload dialog box.
    • -
-

When exiting full screen mode, this property is automatically set to false.

- -

Events associated with mouse movement, such as the mouseMove event, - use the MouseEvent class to represent the event object. - When mouse locking is disabled, use the MouseEvent.localX and - MouseEvent.localY properties to determine the location of the mouse. - When mouse locking is enabled, use the MouseEvent.movementX and - MouseEvent.movementY properties to determine the location of the mouse. - The movementX and movementY properties contain changes in the - position of the mouse since the last event, instead of absolute coordinates of the mouse location.

-

Note: When the application is in full-screen mode, mouse event listeners attached to display - objects other than the Stage are not dispatched. - Therefore, to receive mouse deltas and any other mouse events when mouseLock is true, - attach the mouse event listeners to the Stage object.

- Implementation -
-    public function get mouseLock():Boolean -
-    public function set mouseLock(value:Boolean):void -
-

-See also -

-
-flash.events.MouseEvent.movementX -
-flash.events.MouseEvent.movementY -
-
- - - - - -
nativeWindowproperty 
-
-nativeWindow:NativeWindow  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- A reference to the NativeWindow object containing this Stage. - -

The window represents the native operating system window; the Stage - represents the content contained by the window. This property is only - valid for content running in AIR on platforms that support the NativeWindow class. - On other platforms, this property will be null. - In Flash Player (content running in a - browser), this property will also be null.

- Implementation -
-    public function get nativeWindow():NativeWindow -
-
- - - - - -
numChildrenproperty 
-
-numChildren:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the number of children of this object. -

Implementation -
-    public function get numChildren():int -
-
-Throws -
- - - - -
SecurityError — Referencing the numChildren property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
orientationproperty 
-
-orientation:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The current orientation of the stage. This property is set to one of four values, - defined as constants in the StageOrientation class: - - - - - - - - - - - - - - - - - - - - - - - - - - -
StageOrientation constantStage orientation
StageOrientation.DEFAULTThe screen is in the default orientation (right-side up).
StageOrientation.ROTATED_RIGHTThe screen is rotated right.
StageOrientation.ROTATED_LEFTThe screen is rotated left.
StageOrientation.UPSIDE_DOWNThe screen is rotated upside down.
StageOrientation.UNKNOWNThe application has not yet determined the initial orientation of the screen. - You can add an event listener for the orientationChange event
-

To set the stage orientation, use the setOrientation() method.

-

Important: orientation property is supported on Android devices from 2.6 namespace onwards.

- Implementation -
-    public function get orientation():String -
-

-See also -

-
-StageOrientation -
-autoOrients -
-deviceOrientation -
-supportsOrientationChange -
-
- - - - - -
qualityproperty 
-
-quality:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- A value from the StageQuality class that specifies which rendering quality is used. - The following are valid values: -

    - -
  • StageQuality.LOW—Low rendering quality. Graphics are not - anti-aliased, and bitmaps are not smoothed, but runtimes still use mip-mapping.
    • -
  • StageQuality.MEDIUM—Medium rendering quality. Graphics are - anti-aliased using a 2 x 2 pixel grid, bitmap smoothing is dependent on the Bitmap.smoothing setting. - Runtimes use mip-mapping. This setting is suitable for movies that do not contain text.
    • -
  • StageQuality.HIGH—High rendering quality. Graphics are anti-aliased - using a 4 x 4 pixel grid, and bitmap smoothing is dependent on the Bitmap.smoothing setting. - Runtimes use mip-mapping. This is the default rendering quality setting that Flash Player uses.
    • -
  • StageQuality.BEST—Very high rendering quality. Graphics are - anti-aliased using a 4 x 4 pixel grid. If Bitmap.smoothing is true the runtime uses a high quality - downscale algorithm that produces fewer artifacts (however, using StageQuality.BEST with Bitmap.smoothing set to true - slows performance significantly and is not a recommended setting).
    • - -
- -

Higher quality settings produce better rendering of scaled bitmaps. However, higher - quality settings are computationally more expensive. In particular, when rendering scaled video, - using higher quality settings can reduce the frame rate. -

-

The BitmapData.draw() method uses the value of the Stage.quality property. - Alternatively, you can use the BitmapData.drawWithQuality() method, which lets you specify - the quality parameter to the method, ignoring the current value of Stage.quality.

- -

In the desktop profile of Adobe AIR, quality can be set - to StageQuality.BEST or StageQuality.HIGH (and the default value - is StageQuality.HIGH). Attempting to set it to another value has no effect - (and the property remains unchanged). In the moble profile of AIR, all four quality settings - are available. The default value on mobile devices is StageQuality.MEDIUM.

- -

For content running in Adobe AIR, setting the quality property of one Stage - object changes the rendering quality for all Stage objects (used by different NativeWindow objects). -

- - Note: The operating system draws the device fonts, - which are therefore unaffected by the quality property. - - Implementation -
-    public function get quality():String -
-    public function set quality(value:String):void -
-
-Throws -
- - - - -
SecurityError — Calling the quality property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-

-See also -

-
-flash.display.StageQuality -
-flash.display.Bitmap.smoothing -
-
- - - - - -
scaleModeproperty 
-
-scaleMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A value from the StageScaleMode class that specifies which scale mode to use. - The following are valid values: - -

    - -
  • StageScaleMode.EXACT_FIT—The entire application is visible - in the specified area without trying to preserve the original aspect ratio. Distortion can occur, and the application may appear stretched or compressed. -
    • - -
  • StageScaleMode.SHOW_ALL—The entire application is visible - in the specified area without distortion while maintaining the original aspect ratio of the application. - Borders can appear on two sides of the application. -
    • - -
  • StageScaleMode.NO_BORDER—The entire application fills the specified area, - without distortion but possibly with some cropping, while maintaining the original aspect ratio - of the application. -
    • - -
  • StageScaleMode.NO_SCALE—The entire application is fixed, so that - it remains unchanged even as the size of the player window changes. Cropping might - occur if the player window is smaller than the content. -
    • - -
- -

Implementation -
-    public function get scaleMode():String -
-    public function set scaleMode(value:String):void -
-
-Throws -
- - - - -
SecurityError — Calling the scaleMode property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-

-See also -

-
-flash.display.StageScaleMode -
-
- - - - - -
showDefaultContextMenuproperty 
-
-showDefaultContextMenu:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether to show or hide the default items in the Flash runtime - context menu. -

If the showDefaultContextMenu property is set to true (the - default), all context menu items appear. If the showDefaultContextMenu property - is set to false, only the Settings and About... menu items appear.

- Implementation -
-    public function get showDefaultContextMenu():Boolean -
-    public function set showDefaultContextMenu(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — Calling the showDefaultContextMenu property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
softKeyboardRectproperty 
-
-softKeyboardRect:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6
-

- A Rectangle specifying the area of the stage that is currently covered by a soft - keyboard. The Rect's components are (0,0,0,0) when the soft keyboard isn't raised. -

Implementation -
-    public function get softKeyboardRect():Rectangle -
-

-See also -

-
-flash.events.SoftKeyboardEvent -
-flash.geom.Rectangle -
-
- - - - - -
stage3Dsproperty 
-
-stage3Ds:Vector.<Stage3D>  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- A list of Stage3D objects available for displaying 3-dimensional content. -

You can use only a limited number of Stage3D objects at a time. - The number of available Stage3D objects depends on the platform - and on the available hardware. -

- -

A Stage3D object draws in front of a StageVideo object and behind the Flash display list.

- - Implementation -
-    public function get stage3Ds():Vector.<Stage3D> -
-

-See also -

-
-Stage3D -
-
- - - - - -
stageFocusRectproperty 
-
-stageFocusRect:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether or not objects display a glowing border when they have focus. - -

Implementation -
-    public function get stageFocusRect():Boolean -
-    public function set stageFocusRect(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — Calling the stageFocusRect property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
stageHeightproperty 
-
-stageHeight:int  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- The current height, in pixels, of the Stage. -

If the value of the Stage.scaleMode property is set to StageScaleMode.NO_SCALE - when the user resizes the window, the Stage content maintains its size while the - stageHeight property changes to reflect the new height size of the screen area occupied by - the SWF file. (In the other scale modes, the stageHeight property always reflects the original - height of the SWF file.) You can add an event listener for the resize event and then use the - stageHeight property of the Stage class to determine the actual pixel dimension of the resized - Flash runtime window. The event listener allows you to control how - the screen content adjusts when the user resizes the window.

-

Air for TV devices have slightly different behavior than desktop devices - when you set the stageHeight property. - If the Stage.scaleMode - property is set to StageScaleMode.NO_SCALE and you set the stageHeight - property, the stage height does not change until the next - frame of the SWF.

-

Note: In an HTML page hosting the SWF file, both the object and embed tags' height attributes must be set to a percentage (such as 100%), not pixels. If the - settings are generated by JavaScript code, the height parameter of the AC_FL_RunContent() - method must be set to a percentage, too. This percentage is applied to the stageHeight - value.

- Implementation -
-    public function get stageHeight():int -
-    public function set stageHeight(value:int):void -
-
-Throws -
- - - - -
SecurityError — Calling the stageHeight property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-

-See also -

-
-flash.display.StageScaleMode -
-
- - - - - -
stageVideosproperty 
-
-stageVideos:Vector.<StageVideo>  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- - A list of StageVideo objects available for playing external videos. -

You can use only a limited number of StageVideo objects at a time. - When a SWF begins to run, the number of available StageVideo objects depends on the platform - and on available hardware. -

-

To use a StageVideo object, assign a member of the stageVideos Vector object to a StageVideo variable. -

- -

All StageVideo objects are displayed on the stage behind any display objects. - The StageVideo objects are displayed on the stage in the order they appear in - the stageVideos Vector object. For example, if the stageVideos Vector object contains - three entries:

-
    - -
  1. The StageVideo object in the 0 index of the stageVideos Vector object is - displayed behind all StageVideo objects.
    2. - -
  2. The StageVideo object at index 1 is displayed in front - of the StageVideo object at index 0.
    3. -
  3. The StageVideo object at index 2 is displayed in front - of the StageVideo object at index 1.
    4. -
-

Use the StageVideo.depth property to change this ordering.

-

Note: AIR for TV devices support only one StageVideo object.

- Implementation -
-    public function get stageVideos():Vector.<StageVideo> -
-

-See also -

-
-flash.media.StageVideo -
-flash.events.StageVideoEvent -
-
-Example -
The following code illustrates how to get a StageVideo object: -
-
- 
-var stageVideo:StageVideo;
-
-if ( stage.stageVideos.length >= 1 ) {
-    stageVideo = stage.stageVideos[0];
-}
-
-

-
- - - - - -
stageWidthproperty 
-
-stageWidth:int  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies the current width, in pixels, of the Stage. - -

If the value of the Stage.scaleMode property is set to StageScaleMode.NO_SCALE - when the user resizes the window, the Stage content maintains its defined size while the stageWidth - property changes to reflect the new width size of the screen area occupied by the SWF file. (In the other scale - modes, the stageWidth property always reflects the original width of the SWF file.) You can add an event - listener for the resize event and then use the stageWidth property of the Stage class to - determine the actual pixel dimension of the resized Flash runtime window. The event listener allows you to control how - the screen content adjusts when the user resizes the window.

-

Air for TV devices have slightly different behavior than desktop devices - when you set the stageWidth property. - If the Stage.scaleMode - property is set to StageScaleMode.NO_SCALE and you set the stageWidth - property, the stage width does not change until the next - frame of the SWF.

-

Note: In an HTML page hosting the SWF file, both the object and embed tags' width attributes must be set to a percentage (such as 100%), not pixels. If the - settings are generated by JavaScript code, the width parameter of the AC_FL_RunContent() - method must be set to a percentage, too. This percentage is applied to the stageWidth - value.

- - Implementation -
-    public function get stageWidth():int -
-    public function set stageWidth(value:int):void -
-
-Throws -
- - - - -
SecurityError — Calling the stageWidth property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-

-See also -

-
-flash.display.StageScaleMode -
-
- - - - - -
supportedOrientationsproperty 
-
-supportedOrientations:Vector.<String>  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 -
-

- The orientations supported by the current device. - -

You can use the orientation strings included in this list as parameters for - the setOrientation() method. Setting an unsupported orientation fails without error.

- -

The possible orientations include:

- - - - - - - - - - - - - - - - - - - - - -
StageOrientation constantStage orientation
StageOrientation.DEFAULTSet the stage orientation to the default orientation (right-side up).
StageOrientation.ROTATED_RIGHTSet the stage orientation to be rotated right.
StageOrientation.ROTATED_LEFTSet the stage orientation to be rotated left.
StageOrientation.UPSIDE_DOWNSet the stage orientation to be rotated upside down.
- Implementation -
-    public function get supportedOrientations():Vector.<String> -
-

-See also -

-
-StageOrientation -
-autoOrients -
-setOrientation() -
-orientation -
-
- - - - - -
supportsOrientationChangeproperty 
-
-supportsOrientationChange:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Whether the application supports changes in the stage orientation (and device rotation). - Currently, this property is only true in AIR applications running on mobile - devices. -

Implementation -
-    public static function get supportsOrientationChange():Boolean -
-

-See also -

-
-autoOrients -
-deviceOrientation -
-supportsOrientationChange -
-
- - - - - -
tabChildrenproperty 
-
-tabChildren:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether the children of the object are tab enabled. Enables or disables tabbing for the - children of the object. The default is true. -

Note: Do not use the tabChildren property with Flex. - Instead, use the mx.core.UIComponent.hasFocusableChildren property.

- Implementation -
-    public function get tabChildren():Boolean -
-    public function set tabChildren(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — Referencing the tabChildren property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
textSnapshotproperty 
-
-textSnapshot:TextSnapshot  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a TextSnapshot object for this DisplayObjectContainer instance. -

Implementation -
-    public function get textSnapshot():TextSnapshot -
-
-Throws -
- - - - -
Error — Referencing the textSnapshot property of a Stage object throws an - exception because the Stage class does not implement this property. To avoid this, call the - textSnapshot property of a display object container other than the Stage object. - -
-
- - - - - -
vsyncEnabledproperty 
-
-vsyncEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 29.0 -
-

- This represents current state of vsync of underlying graphics solution - We can enable/disable vsync, so we would immediately render without waiting for next VSYNC'ed state. - Reading the property is valid at anytime. However, setting the property is valid only after the VsyncStateChangeAvailabilityEvent has fired. -

Implementation -
-    public function get vsyncEnabled():Boolean -
-    public function set vsyncEnabled(value:Boolean):void -
-
- - - - - -
widthproperty 
-
-width:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- 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 width property, the scaleX property is adjusted accordingly, as shown in the - following code: - - 

-    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;
- -

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 width to a different value.

- Implementation -
-    public function get width():Number -
-    public function set width(value:Number):void -
-
-Throws -
- - - - - - - - - - -
SecurityError — Referencing the width property of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. -
 
Error — It is always illegal to set the width property of a Stage object, - even if you are the Stage owner. - -
-
- - - - - -
wmodeGPUproperty 
-
-wmodeGPU:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5.2 -
-

- Indicates whether GPU compositing is available and in use. The wmodeGPU value is true only - when all three of the following conditions exist: -

  • GPU compositing has been requested.
    • -
  • GPU compositing is available.
    • -
  • GPU compositing is in use.

-

Specifically, the wmodeGPU property indicates one of the following:

-

  1. GPU compositing has not been requested or is unavailable. In this case, the wmodeGPU property value is false.
    2. -
  2. GPU compositing has been requested (if applicable and available), but the environment is operating in "fallback mode" - (not optimal rendering) due to limitations of the content. In this case, the wmodeGPU property value is true.
    3. -
  3. GPU compositing has been requested (if applicable and available), and the environment is operating in the best mode. In this case, the - wmodeGPU property value is also true.

-

In other words, the wmodeGPU property identifies the capability and state of the rendering environment. For runtimes - that do not support GPU compositing, such as AIR 1.5.2, the value is always false, because (as stated above) the value is - true only when GPU compositing has been requested, is available, and is in use.

-

The wmodeGPU property is useful to determine, at runtime, whether or not GPU compositing is in use. The value of - wmodeGPU indicates if your content is going to be scaled by hardware, or not, so you can present graphics at the correct size. - You can also determine if you're rendering in a fast path or not, so that you can adjust your content complexity accordingly.

-

For Flash Player in a browser, GPU compositing can be requested by the value of gpu for the wmode HTML - parameter in the page hosting the SWF file. For other configurations, GPU compositing can be requested in the header of a SWF file - (set using SWF authoring tools).

-

However, the wmodeGPU property does not identify the current rendering performance. Even if GPU compositing is "in use" the rendering - process might not be operating in the best mode. To adjust your content for optimal rendering, use a Flash runtime debugger version, - and set the DisplayGPUBlendsetting in your mm.cfg file.

-

Note: This property is always false when referenced - from ActionScript that runs before the runtime performs its first rendering - pass. For example, if you examine wmodeGPU from a script in Frame 1 of - Adobe Flash Professional, and your SWF file is the first SWF file loaded in a new - instance of the runtime, then the wmodeGPU value is false. - To get an accurate value, wait until at least one rendering pass - has occurred. If you write an event listener for the - exitFrame event of any DisplayObject, the wmodeGPU value at - is the correct value.

- Implementation -
-    public function get wmodeGPU():Boolean -
-

-See also -

-
-DisplayObject exitFrame event -
-
-Example -
The following example examines the wmodeGPU property after the display object mySprite - is rendered, so you can get an accurate value. -
-
-mySprite.addEventListener(EXIT_FRAME, exithandler):
-
-function exithandler(exiteventobject:Event):void {
-                trace(stage.wmodeGPU);
-}
-
-

-
- -
Method detail
- - - - - -
addChild()method
-
-public override function addChild(child:DisplayObject):DisplayObject -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Adds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added - to the front (top) of all other children in this DisplayObjectContainer instance. (To add a child to a - specific index position, use the addChildAt() method.) -

If you add a child object that already has a different display object container as - a parent, the object is removed from the child list of the other display object container.

-

Note: The command stage.addChild() can cause problems with a published SWF file, - including security problems and conflicts with other loaded SWF files. There is only one Stage within a Flash runtime instance, - no matter how many SWF files you load into the runtime. So, generally, objects - should not be added to the Stage, directly, at all. The only object the Stage should - contain is the root object. Create a DisplayObjectContainer to contain all of the items on the - display list. Then, if necessary, add that DisplayObjectContainer instance to the Stage.

- Parameters - - - - -
child:DisplayObject — The DisplayObject instance to add as a child of this DisplayObjectContainer instance. -
-

-Returns - - - - -
DisplayObject — - The DisplayObject instance that you pass in the - child parameter. - - -
-
-Throws - - - - -
SecurityError — Calling the addChild() method of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
addChildAt()method 
-
-public override function addChildAt(child:DisplayObject, index:int):DisplayObject -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Adds a child DisplayObject instance to this DisplayObjectContainer - instance. The child is added - at the index position specified. An index of 0 represents the back (bottom) - of the display list for this DisplayObjectContainer object. - -

For example, the following example shows three display objects, labeled a, b, and c, at - index positions 0, 2, and 1, respectively:

- -

b over c over a

- -

If you add a child object that already has a different display object container as - a parent, the object is removed from the child list of the other display object container.

- Parameters - - - - - - - - - - -
child:DisplayObject — The DisplayObject instance to add as a child of this - DisplayObjectContainer instance. - -
 
index:int — The index position to which the child is added. If you specify a - currently occupied index position, the child object that exists at that position and all - higher positions are moved up one position in the child list. -
-

-Returns - - - - -
DisplayObject — - The DisplayObject instance that you pass in the - child parameter. - - -
-
-Throws - - - - -
SecurityError — Calling the addChildAt() method of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
addEventListener()method 
-
-public override function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event. You can register event listeners on all nodes in the - display list for a specific type of event, phase, and priority. - -

JavaScript code in the AIR runtime uses this method to register - event listeners for events defined by the AIR APIs. For other JavaScript events (such as the onload - event of the DOM body object), you can use standard event handling techniques, as you would - for content running in the browser.

- -

After you successfully register an event listener, you cannot change its priority - through additional calls to addEventListener(). To change a listener's - priority, you must first call removeListener(). Then you can register the - listener again with the new priority level.

- -

Keep in mind that after the listener is registered, subsequent calls to - addEventListener() with a different type or - useCapture value result in the creation of a separate listener registration. - For example, if you first register a listener with useCapture set to - true, it listens only during the capture phase. If you call - addEventListener() again using the same listener object, but with - useCapture set to false, you have two separate listeners: one - that listens during the capture phase and another that listens during the target and - bubbling phases. -

- -

You cannot register an event listener for only the target phase or the bubbling - phase. Those phases are coupled during registration because bubbling - applies only to the ancestors of the target node.

- -

If you no longer need an event listener, remove it by calling - removeEventListener(), or memory problems could result. Event listeners are not automatically - removed from memory because the garbage - collector does not remove the listener as long as the dispatching object exists (unless the useWeakReference - parameter is set to true).

- -

Copying an EventDispatcher instance does not copy the event listeners attached to it. - (If your newly created node needs an event listener, you must attach the listener after - creating the node.) However, if you move an EventDispatcher instance, the event listeners - attached to it move along with it.

- - -

If the event listener is being registered on a node while an event is being processed - on this node, the event listener is not triggered during the current phase but can be - triggered during a later phase in the event flow, such as the bubbling phase.

- -

If an event listener is removed from a node while an event is being processed on the node, - it is still triggered by the current actions. After it is removed, the event listener is - never invoked again (unless registered again for future processing).

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener function that processes the event. This function must accept - an Event object as its only parameter and must return nothing, as this example shows: - . - - 
function(evt:Event):void
- -

The function can have any name.

- -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Determines whether the listener works in the capture phase or the - target and bubbling phases. If useCapture is set to true, - the listener processes the event only during the capture phase and not in the - target or bubbling phase. If useCapture is false, the - listener processes the event only during the target or bubbling phase. To listen for - the event in all three phases, call addEventListener twice, once with - useCapture set to true, then again with - useCapture set to false. - -
 
priority:int (default = 0) — The priority level of the event listener. The priority is designated by - a signed 32-bit integer. The higher the number, the higher the priority. All listeners - with priority n are processed before listeners of priority n-1. If two - or more listeners share the same priority, they are processed in the order in which they - were added. The default priority is 0. - -
 
useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or - weak. A strong reference (the default) prevents your listener from being garbage-collected. - A weak reference does not.

Class-level member functions are not subject to garbage - collection, so you can set useWeakReference to true for - class-level member functions without subjecting them to garbage collection. If you set - useWeakReference to true for a listener that is a nested inner - function, the function will be garbage-collected and no longer persistent. If you create - references to the inner function (save it in another variable) then it is not - garbage-collected and stays persistent.

-
-
-Throws - - - - -
SecurityError — Calling the addEventListener method of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this situation, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
assignFocus()method 
-
-public function assignFocus(objectToFocus:InteractiveObject, direction:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Sets keyboard focus to the interactive object specified by objectToFocus, with - the focus direction specified by the direction parameter. - -

The concept of focus direction must be defined by the application (or application framework). - No intrinsic focus sorting of interactive objects exists, although you could use other available - properties to establish an ordering principle. For example, you could sort interactive objects - according to their positions on the Stage or in the display list. Calling assignFocus() - is equivalent to setting the Stage.focus property, with the additional ability to - indicate the direction from which the focus is being set.

-

The objectToFocus will dispatch a focusIn event on receiving focus. - The direction property of the FocusEvent object will report the setting of the - direction parameter.

- -

If you assign an HTMLLoader object to the objectToFocus parameter, the HTMLLoader - object selects the appropriate focusable object in the HTML DOM, based on the direction - parameter value. If it is FocusDirection.BOTTOM, the focusable object in the HTML - DOM at the end of the reading order is given focus. If it is FocusDirection.TOP, - the focusable object in the HTML DOM at the beginning of the reading order is given focus. - If it is NONE, the HTMLLoader object receives focus without changing its - current focused element.

- - Parameters - - - - - - - - - - -
objectToFocus:InteractiveObject — The object to focus, or null to clear the focus from - any element on the Stage. - -
 
direction:String — The direction from which objectToFocus is being focused. - Valid values are enumerated as constants in the FocusDirection class. -
-
-Throws - - - - -
Error — If focus cannot be set to the target or direction is not a valid type. - -
-

-See also -

-
-flash.display.Stage.focus -
-flash.display.FocusDirection -
-flash.events.FocusEvent -
-
- - - - - -
dispatchEvent()method 
-
-public override function dispatchEvent(event:Event):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatches an event into the event flow. The event target is the EventDispatcher - object upon which the dispatchEvent() method is called. -

Parameters - - - - -
event:Event — The Event object that is dispatched into the event flow. - If the event is being redispatched, a clone of the event is created automatically. - After an event is dispatched, its target property cannot be changed, so you - must create a new copy of the event for redispatching to work. - -
-

-Returns - - - - -
Boolean — - A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called - on the event. - - -
-
-Throws - - - - -
SecurityError — Calling the dispatchEvent() method of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
hasEventListener()method 
-
-public override function hasEventListener(type:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event. This allows you to determine where an EventDispatcher object has altered - handling of an event type in the event flow hierarchy. To determine whether a specific - event type actually triggers an event listener, use willTrigger(). - -

The difference between hasEventListener() and willTrigger() - is that hasEventListener() examines only the object to - which it belongs, whereas willTrigger() examines the entire - event flow for the event specified by the type parameter. - The event flow applies to the ActionScript 3.0 - display list, used in SWF content. -

- -

When hasEventListener() is called from a LoaderInfo object, only the - listeners that the caller can access are considered.

- - Parameters - - - - -
type:String — The type of event. -
-

-Returns - - - - -
Boolean — - A value of true if a listener of the specified type is registered; - false otherwise. - - -
-
-Throws - - - - -
SecurityError — Calling the hasEventListener() method of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
invalidate()method 
-
-public function invalidate():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Calling the invalidate() method signals Flash runtimes to alert display objects - on the next opportunity it has to render the display list (for example, when the playhead - advances to a new frame). After you call the invalidate() method, when the display - list is next rendered, the Flash runtime sends a render event to each display object that has - registered to listen for the render event. You must call the invalidate() - method each time you want the Flash runtime to send render events. - -

The render event gives you an opportunity to make changes to the display list - immediately before it is actually rendered. This lets you defer updates to the display list until the - latest opportunity. This can increase performance by eliminating unnecessary screen updates.

- -

The render event is dispatched only to display objects that are in the same - security domain as the code that calls the stage.invalidate() method, - or to display objects from a security domain that has been granted permission via the - Security.allowDomain() method.

- -

-See also -

-
-flash.events.Event.RENDER -
-
- - - - - -
isFocusInaccessible()method 
-
-public function isFocusInaccessible():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether the Stage.focus property returns null for - security reasons. - In other words, isFocusInaccessible returns true if the - object that has focus belongs to a security sandbox to which the SWF file does not have access. -

-Returns - - - - -
Boolean — - true if the object that has focus belongs to a security sandbox to which - the SWF file does not have access. - - -
-
- - - - - -
preloadComplete()method 
-
-public function preloadComplete(mainClass:String):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 50.0 -
-

- Notify to the runtime that a preloader is complete and request to load the main class. -

If a preloader class has been defined as the default class for a SWF, then this will be created once it's - defined and the rest of the SWF can then be loaded in to memory and processed whilst the preloader is being - displayed. Once the rest of the SWF has finished loading, this method can be used to reset the runtime to - a stat as if the class definition given by mainClass was the default class for the SWF file.

- Parameters - - - - -
mainClass:String — The fully qualified class name to be created as the new 'main' SWF class. -
-

-Returns - - - - -
Boolean — - True if the definition of the class was found and instantiated. - - -
-
- - - - - -
removeChildAt()method 
-
-public override function removeChildAt(index:int):DisplayObject -

- - - - -
Runtime version: 
-

- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer. The parent property of the removed child is set to - null, and the object is garbage collected if no other references to the child exist. The index - positions of any display objects above the child in the DisplayObjectContainer are decreased by 1. - -

The garbage collector reallocates unused memory space. When a variable or - object is no longer actively referenced or stored somewhere, the garbage collector sweeps - through and wipes out the memory space it used to occupy if no other references to it exist.

- Parameters - - - - -
index:int — The child index of the DisplayObject to remove. -
-

-Returns - - - - -
DisplayObject — - The DisplayObject instance that was removed. - - - -
-
-Throws - - - - -
SecurityError — Calling the removeChildAt() method of a Stage object throws an exception for - any caller that is not in the same security sandbox as the object to be removed. To avoid this, - the owner of that object can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
setAspectRatio()method 
-
-public function setAspectRatio(newAspectRatio:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Sets the stage to an orientation with the specified aspect ratio. -

If the stage orientation changes as a result of the method call, the Stage object dispatches - an orientationChange event.

- -

To check whether device orientation is supported, check the value of the - Stage.supportsOrientantionChange property.

-

AIR profile support: This feature is supported - on mobile devices, but it is not supported on desktop operating systems or AIR for TV devices. You can test - for support at run time using the Stage.supportsOrientantionChange property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- - Parameters - - - - -
newAspectRatio:String — The type code for the desired aspect ratio (StageAspectRatio.PORTRAIT, - StageAspectRatio.LANDSCAPE, or StageAspectRatio.ANY). -
-
-Throws - - - - -
ArgumentError — The value passed as the newAspectRatio parameter is not valid. - The value must match one of the constants defined in the StageAspectRatio class. -
-

-See also -

-
-StageAspectRatio -
-supportsOrientationChange -
-
- - - - - -
setChildIndex()method 
-
-public override function setChildIndex(child:DisplayObject, index:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Changes the position of an existing child in the display object container. - This affects the layering of child objects. For example, the following example shows three - display objects, labeled a, b, and c, at index positions 0, 1, and 2, respectively: - -

c over b over a

-

When you use the setChildIndex() method and specify an index position - that is already occupied, the only positions that change are those in between the display object's former and new position. - All others will stay the same. - If a child is moved to an index LOWER than its current index, all children in between will INCREASE by 1 for their index reference. - If a child is moved to an index HIGHER than its current index, all children in between will DECREASE by 1 for their index reference. - For example, if the display object container - in the previous example is named container, you can swap the position - of the display objects labeled a and b by calling the following code:

- - 
container.setChildIndex(container.getChildAt(1), 0);
- -

This code results in the following arrangement of objects:

- -

c over a over b

- Parameters - - - - - - - - - - -
child:DisplayObject — The child DisplayObject instance for which you want to change - the index number. - -
 
index:int — The resulting index number for the child display object. -
-
-Throws - - - - -
SecurityError — Calling the setChildIndex() method of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
setOrientation()method 
-
-public function setOrientation(newOrientation:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Sets the stage to the specified orientation. - -

Set the newOrientation parameter - to one of the following four values defined as constants in the StageOrientation class:

- -

- - - - - - - - - - - - - - - - - - - - - -
StageOrientation constantStage orientation
StageOrientation.DEFAULTSet the stage orientation to the default orientation (right-side up).
StageOrientation.ROTATED_RIGHTSet the stage orientation to be rotated right.
StageOrientation.ROTATED_LEFTSet the stage orientation to be rotated left.
StageOrientation.UPSIDE_DOWNSet the stage orientation to be rotated upside down.
-

-

Do not set the parameter to StageOrientation.UNKNOWN or any - string value other than those listed in the table.

-

To check whether changing device orientation is supported, check the value of the - Stage.supportsOrientantionChange property. Check the list provided by - the supportedOrientations property to determine which orientations - are supported by the current device.

-

Setting the orientation is an asynchronous operation. It is not guaranteed - to be complete immediately after you call the setOrientation() method. - Add an event listener for the orientationChange event to determine when - the orientation change is complete.

-

Important: The setOrientation() method was not supported on Android - devices before AIR 2.6.

- Note: The setOrientation() method does not cause an - orientationChanging event to be dispatched. - Parameters - - - - -
newOrientation:String — The new orientation of the stage. -
-
-Events - - - - -
orientationChange:StageOrientationEvent — The stage has resized as a result of the - call to the setOrientation() method.
-
-Throws - - - - -
ArgumentError — The value passed as the newOrientation parameter is not valid. - The value must match one of the constants defined in the StageOriention class, except for the - StageOrientation.UNKNOWN constant. -
-

-See also -

-
-autoOrients -
-supportsOrientationChange -
-StageOrientationEvent -
-StageOrientation -
-
- - - - - -
swapChildrenAt()method 
-
-public override function swapChildrenAt(index1:int, index2:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list. All other child objects in the display object container remain in the same index positions. -

Parameters - - - - - - - - - - -
index1:int — The index position of the first child object. - -
 
index2:int — The index position of the second child object. -
-
-Throws - - - - -
SecurityError — Calling the swapChildrenAt() method of a Stage object throws an exception for - any caller that is not in the same security sandbox as the owner of either of the objects to be swapped. To avoid this, - the object owners can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
- - - - - -
willTrigger()method 
-
-public override function willTrigger(type:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type. This method returns true if an - event listener is triggered during any phase of the event flow when an event of the - specified type is dispatched to this EventDispatcher object or any of its descendants. - -

The difference between the hasEventListener() and the willTrigger() - methods is that hasEventListener() examines only the object to which it belongs, - whereas the willTrigger() method examines the entire event flow for the event specified by the - type parameter. The event flow applies to the ActionScript 3.0 - display list, used in SWF content.

- -

When willTrigger() is called from a LoaderInfo object, only the - listeners that the caller can access are considered.

- - Parameters - - - - -
type:String — The type of event. -
-

-Returns - - - - -
Boolean — - A value of true if a listener of the specified type will be triggered; false otherwise. - - -
-
-Throws - - - - -
SecurityError — Calling the willTrigger() method of a Stage object throws an exception for - any caller that is not in the same security sandbox as the Stage owner (the main SWF file). - To avoid this, the Stage owner can grant permission to the domain of the caller by calling - the Security.allowDomain() method or the Security.allowInsecureDomain() method. - For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. - -
-
-
Event detail
- - - - - -
browserZoomChangeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.BROWSER_ZOOM_CHANGE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when the browserZoomFactor property of the Stage object is changed. -

- The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object. - -

The browserZoomChange event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
target The Stage instance.
-
- - - - - -
fullScreenevent  
-
-Event object type: flash.events.FullScreenEvent -
-FullScreenEvent.type property = flash.events.FullScreenEvent.FULL_SCREEN -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when the Stage object enters, or leaves, full-screen mode. A change - in full-screen mode can be initiated through ActionScript, or the user invoking a keyboard shortcut, - or if the current focus leaves the full-screen window. -

- The FULL_SCREEN_INTERACTIVE_ACCEPTED:String constant defines the value of the type property of a fullScreenInteractiveAccepted event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
fullScreentrue if the display state is full screen or false if it is normal.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Stage object.
- -
- - - - - -
mouseLeaveevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.MOUSE_LEAVE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched by the Stage object when the pointer moves out of the - stage area. If the mouse button is pressed, the event is not dispatched. -

- The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Stage object. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
- - - - - -
orientationChangeevent  
-
-Event object type: flash.events.StageOrientationEvent -
-StageOrientationEvent.type property = flash.events.StageOrientationEvent.ORIENTATION_CHANGE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.0 -
-

- Dispatched by the Stage object when the stage orientation changes. -

Orientation changes can occur when the user rotates the device, opens a slide-out keyboard, - or when the setAspectRatio() is called.

-

Note: If the autoOrients property is false, then the stage orientation - does not change when a device is rotated. Thus, StageOrientationEvents are only dispatched for - device rotation when autoOrients is true.

-

- The ORIENTATION_CHANGE constant defines the value of the type property of - a orientationChange event object. - This event has the following properties: - - - - - - - - -
PropertiesValues
afterOrientationThe new orientation of the stage.
beforeOrientationThe old orientation of the stage.
targetThe Stage object that dispatched the orientation change. -
bubblestrue
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelablefalse; it is too late to cancel the change.
-

- - - - - -
orientationChangingevent  
-
-Event object type: flash.events.StageOrientationEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.0 -
-

- Dispatched by the Stage object when the stage orientation begins changing. - -

Important: orientationChanging events are not dispatched on Android devices.

- -

Notes: -

    -
  • - If the autoOrients property is false, then the stage orientation - does not change when a device is rotated. Thus, StageOrientationEvents are only dispatched for - device rotation when autoOrients is true. -
    • -
  • - When you set the orientation programatically with the setOrientation() method, the - orientationChanging event is not dispatched. -
    • -
-

-
- - - - - -
resizeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.RESIZE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when the scaleMode property of the Stage object is set to - StageScaleMode.NO_SCALE and the SWF file is resized. - Also dispatched when screen orientation changes while in full screen mode in Flash Player 15 and later. -

- The Event.RESIZE constant defines the value of the type property of a resize event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Stage object.
- -
- - - - - -
stageVideoAvailabilityevent  
-
-Event object type: flash.events.StageVideoAvailabilityEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched by the Stage object when the state of the stageVideos property changes. -


-Example -
The following example uses the StageExample class to dispatch - events whenever the stage is activated or resized. This is accomplished by performing the following steps: -
    -
  1. The class constructor first sets the Flash application to be fixed, regardless of the size of - the Flash Player window and then adds two event listeners with the - activateHandler() and resizeHandler() methods.
    2. - -
  2. The activateHandler() method runs when the left mouse button is clicked.
    3. - -
  3. The resizeHandler() method runs when the stage is resized.
    4. - -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.display.StageAlign;
-    import flash.display.StageScaleMode;
-    import flash.events.Event;
-
-    public class StageExample extends Sprite {
-
-        public function StageExample() {
-            stage.scaleMode = StageScaleMode.NO_SCALE;
-            stage.align = StageAlign.TOP_LEFT;
-            stage.addEventListener(Event.ACTIVATE, activateHandler);
-            stage.addEventListener(Event.RESIZE, resizeHandler);
-        }
-
-        private function activateHandler(event:Event):void {
-            trace("activateHandler: " + event);
-        }
-
-        private function resizeHandler(event:Event):void {
-            trace("resizeHandler: " + event);
-            trace("stageWidth: " + stage.stageWidth + " stageHeight: " + stage.stageHeight);
-        }
-    }
-}
-
-

-
- - - - - -
VsyncStateChangeAvailabilityevent  
-
-Event object type: flash.events.VsyncStateChangeAvailabilityEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 29.0 -
-

- Dispatched by the Stage object when the state of the vsync property is changed. -

Defines the value of the type property of a VsyncStateChangeAvailabilityEvent event object.

-
-Example -
The following example uses the VsyncExample class to dispatch events whenever the vsync state of the stage can be enabled or disabled. - - This is accomplished by performing the following steps: -
    -
  1. The constructor first fires the stage event VsyncStateChangeAvailabilityEvent
    2. -
  2. Then the method onVsyncStateChangeAvailability is called in which it is checked whether the VsyncStateChangeAvailabilityEvent is avalable or not.
    3. -
  3. If available one can toggle the vsync state of the stage or else the value of the vsyncEnable property remains read only.
    4. -
  4. The value of vsync enable can be triggered if and only if the event is fired.
    5. - -
-
-
-
-package {
-    import flash.display.Sprite;
-	import flash.events.VsyncStateChangeAvailabilityEvent
-	public class VsyncExample extends Sprite {
-		public function VsyncExample()
-		{ stage.addEventListener(VsyncStateChangeAvailabilityEvent.VSYNC_STATE_CHANGE_AVAILABILITY, onVsyncStateChangeAvailability); }
-		public function onVsyncStateChangeAvailability(event:VsyncStateChangeAvailabilityEvent):void
-		{
-			if (event.available)
-			{
-				// vsyncEnabled is now changeable and can be turned off.
-				stage.vsyncEnabled = false; // Now, AS can change VSYNC state because event.available is true
-				trace("vsyncEnabled of Stage object is changeable");
-			}
-			else
-			{
-				// vsyncEnabled is not changeable now. This could be due to fallback to software rendering, for example.
-				stage.vsyncEnabled = false; // This will be ignored because event.available is now false
-				trace("vsyncEnabled of Stage object is read-only");
-				trace("Current value of vsyncEnabled of Stage object is "+ stage.vsyncEnabled);
-			}
-		}
-	}
-}
-
-

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/Stage3D.html b/html-docs/flash/display/Stage3D.html deleted file mode 100644 index 071c729..0000000 --- a/html-docs/flash/display/Stage3D.html +++ /dev/null @@ -1,851 +0,0 @@ - - - - - - - - -flash.display.Stage3D (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic class Stage3D
InheritanceStage3D Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The Stage3D class provides a display area and a programmable rendering context for drawing 2D and 3D graphics. -

Stage3D provides a high-performance rendering surface for content rendered using the - Context3D class. This surface uses the graphics processing unit (GPU) when possible. - The runtime stage provides a fixed number of Stage3D objects. The number of instances - varies by the type of device. Desktop computers typically provide four Stage3D instances.

- -

Content drawn to the Stage3D viewport is composited with other visible - graphics objects in a predefined order. The most distant are all StageVideo surfaces. - Stage3D comes next, with traditional Flash display object content being rendered last, - on top of all others. StageVideo and Stage3D layers are rendered - with no transparency; thus a viewport completely obscures any other Stage3D or StageVideo viewports - positioned underneath it. Display list content is rendered with transparency.

- -

Note: You can use the visible property of a Stage3D object to remove it - from the display temporarily, such as when playing a video using the StageVideo class.

-

A Stage3D object is retrieved from the Player stage using its stage3Ds - member. Use the Stage3D instance to request an associated rendering context and to position the - display on the runtime stage.

-

-

-See also -

-
-Stage -
-flash.display3D.Context3D -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  context3D : Context3D -
[read-only] - The Context3D object associated with this Stage3D instance.
-		Stage3D
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  visible : Boolean -
- Specifies whether this Stage3D object is visible.
-		Stage3D
  x : Number -
- The horizontal coordinate of the Stage3D display on the stage, in pixels.
-		Stage3D
  y : Number -
- The vertical coordinate of the Stage3D display on the stage, in pixels.
-		Stage3D
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Stage3D()
-
-		Stage3D
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-requestContext3D(context3DRenderMode:String = "auto", profile:String = "baseline"):void -
-
- Request the creation of a Context3D object for this Stage3D instance.
-		Stage3D
   -
-requestContext3DMatchingProfiles(profiles:Vector.<String>):void -
-
- Request the creation of a Context3D object for this Stage3D instance.
-		Stage3D
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-context3DCreate -
-		 - Dispatched when a rendering context is created.Stage3D
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-error -
-		 - Dispatched when a request for a rendering context fails.Stage3D
-
- -
- -
Property detail
- - - - - -
context3Dproperty
-
-context3D:Context3D  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The Context3D object associated with this Stage3D instance. - -

This property is initially null. - To create the Context3D instance for this Stage3D object, add an event listener for the - context3DCreate event and then call the requestContext3D method. The listener is called - once the Context3D object has been created.

- Implementation -
-    public function get context3D():Context3D -
-

-See also -

-
-requestContext3D() -
-
- - - - - -
visibleproperty 
-
-visible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Specifies whether this Stage3D object is visible. - -

Use this property to temporarily hide a Stage3D object on the Stage. - This property defaults to true.

- - - Implementation -
-    public function get visible():Boolean -
-    public function set visible(value:Boolean):void -
-
- - - - - -
xproperty 
-
-x:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The horizontal coordinate of the Stage3D display on the stage, in pixels. -

This property defaults to zero.

- - Implementation -
-    public function get x():Number -
-    public function set x(value:Number):void -
-
-Throws -
- - - - -
ArgumentError — if the position is not in the interval [-8191..8191]. - - -
-
- - - - - -
yproperty 
-
-y:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The vertical coordinate of the Stage3D display on the stage, in pixels. -

This property defaults to zero.

- - Implementation -
-    public function get y():Number -
-    public function set y(value:Number):void -
-
-Throws -
- - - - -
ArgumentError — if the position is not in the interval [-8191..8191]. - -
-
- -
Constructor detail
- - - - - -
Stage3D()constructor
-
-public function Stage3D() -
- -
Method detail
- - - - - -
requestContext3D()method
-
-public function requestContext3D(context3DRenderMode:String = "auto", profile:String = "baseline"):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Request the creation of a Context3D object for this Stage3D instance. - -

Before calling this function, add an event listener for - the context3DCreate event. If you do not, the runtime throws an exception.

-

Important note on device loss: GPU device loss occurs when the GPU - hardware becomes unavailable to the application. The Context3D object is disposed when the - GPU device is lost. GPU device loss can happen for various reasons, such as, - when a mobile device runs out of battery power or a Windows device goes to a "lock screen." - When the GPU becomes available again, the runtime creates a new Context3D instance and dispatches - another context3DCreate event. Your application must reload all assets and reset the rendering - context state whenever device loss occurs.

- -

Design your application logic to handle the possibility of device loss and context regeneration. - Do not remove the context3DCreate event listener. Do not perform actions in response to the event - that should not be repeated in the application. For example, do not add anonymous functions to handle - timer events because they would be duplicated after device loss. - To test your application's handling - of device loss, you can simulate device loss by calling the dispose() method - of the Context3D object.

- -

The following example illustrates how to request a Context3d rendering context:

- 
-		if( stage.stage3Ds.length > 0 )
-		{
-			var stage3D:Stage3D = stage.stage3Ds[0];	
-			stage3D.addEventListener( Event.CONTEXT3D_CREATE, myContext3DHandler ); 
-			stage3D.requestContext3D( ); 
-		} 
-		
-		function myContext3DHandler ( event : Event ) : void 
-		{
-		    var targetStage3D : Stage3D = event.target as Stage3D; 
-		    InitAll3DResources( targetStage3D.context3D );
-		    StartRendering( targetStage3D.context3D ); 
-		}
-
- Parameters - - - - - - - - - - -
context3DRenderMode:String (default = "auto") — The type of rendering context to request. The default is - Context3DRenderMode.AUTO for which the runtime will create a hardware-accelerated - context if possible and fall back to software otherwise. Use - Context3DRenderMode.SOFTWARE to request a software rendering context. - Software rendering is not available on mobile devices. Software rendering is available only for - Context3DProfile.BASELINE and Context3DProfile.BASELINE_CONSTRAINED. -
 
profile:String (default = "baseline") — (AIR 3.4 and higher) Specifies the extent to which Flash Player supports lower-level GPUs. The default is - Context3DProfile.BASELINE, which returns a Context3D instance similar to that used in previous releases. - To get details of all available profiles, see flash.display3D.Context3DProfile. -
-
-Events - - - - - - - - - - -
context3DCreate:Event — Dispatched when the requested rendering context is successfully - completed.
 
error:ErrorEvent — Dispatched when the requested rendering context cannot be created.
-
-Throws - - - - - - - - - - -
Error — if no listeners for the context3DCreate event have been added to this Stage3D object. -
 
ArgumentError — if this method is called again with a different - context3DRenderMode before the previous call has completed. -
-

-See also -

-
-flash.display3D.Context3D -
-flash.display3D.Context3DRenderMode -
-flash.display3D.Context3DProfile -
-
- - - - - -
requestContext3DMatchingProfiles()method 
-
-public function requestContext3DMatchingProfiles(profiles:Vector.<String>):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 4 -
-

- Request the creation of a Context3D object for this Stage3D instance. -

Before calling this function, add an event listener for - the context3DCreate event. If you do not, the runtime throws an exception.

-

Important note on device loss: GPU device loss occurs when the GPU - hardware becomes unavailable to the application. The Context3D object is disposed when the - GPU device is lost. GPU device loss can happen for various reasons, such as, - when a mobile device runs out of battery power or a Windows device goes to a "lock screen." - When the GPU becomes available again, the runtime creates a new Context3D instance and dispatches - another context3DCreate event. Your application must reload all assets and reset the rendering - context state whenever device loss occurs.

- -

Design your application logic to handle the possibility of device loss and context regeneration. - Do not remove the context3DCreate event listener. Do not perform actions in response to the event - that should not be repeated in the application. For example, do not add anonymous functions to handle - timer events because they would be duplicated after device loss. - To test your application's handling - of device loss, you can simulate device loss by calling the dispose() method - of the Context3D object.

- -

The following example illustrates how to request a Context3d rendering context:

- 
-		if( stage.stage3Ds.length > 0 )
-		{
-		  var stage3D:Stage3D = stage.stage3Ds[0];   
-		  stage3D.addEventListener( Event.CONTEXT3D_CREATE, myContext3DHandler );
-		  stage3D.requestContext3DMatchingProfiles(Vector.<string>([Context3DProfile.BASELINE, Context3DProfile.BASELINE_EXTENDED]));
-		}
-				function myContext3DHandler ( event : Event ) : void
-		{
-         	  var targetStage3D : Stage3D = event.target as Stage3D;
-		    if(targetStage3D.context3D.profile.localeCompare(Context3DProfile.BASELINE) == 0)
-		    {
-                  InitAll3DResources( targetStage3D.context3D );  		
-		    }
-		    StartRendering( targetStage3D.context3D );		
-
- Parameters - - - - -
profiles:Vector.<String> — (AIR 3.4 and higher) a profile arrays that developer want to use in their flash - program. When developer pass profile array to Stage3D.requestContext3DMatchingProfiles, he will - get a Context3D based on the high level profile in that array according to their hardware capability. - The rendermode is setted to AUTO, so the param is omitted. -
-
-Events - - - - - - - - - - -
context3DCreate:Event — Dispatched when the requested rendering context is successfully - completed.
 
error:ErrorEvent — Dispatched when the requested rendering context cannot be created. If - the hardware is not available, it will not create a software context3d.
-
-Throws - - - - - - - - - - - - - - - - -
Error — if no listeners for the context3DCreate event have been added to this Stage3D object. -
 
ArgumentError — if this method is called before the previous call has completed. -
 
ArgumentError — if the item in array is not flash.display3D.Context3DProfile. -
-

-See also -

-
-flash.display3D.Context3D -
-flash.display3D.Context3DProfile -
-
-
Event detail
- - - - - -
context3DCreateevent 
-
-Event object type: flash.events.Event -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Dispatched when a rendering context is created. -

-See also -

-
-requestContext3D() -
-
- - - - - -
errorevent  
-
-Event object type: flash.events.ErrorEvent -
-ErrorEvent.type property = flash.events.ErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Dispatched when a request for a rendering context fails. -

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -

-See also -

-
-requestContext3D() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/StageAlign.html b/html-docs/flash/display/StageAlign.html deleted file mode 100644 index f4f4e54..0000000 --- a/html-docs/flash/display/StageAlign.html +++ /dev/null @@ -1,445 +0,0 @@ - - - - - - - - -flash.display.StageAlign (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class StageAlign
InheritanceStageAlign Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The StageAlign class provides constant values to use for the Stage.align property. - -

-

-See also -

-
-flash.display.Stage.align -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  BOTTOM : String = "B"
[static] -Specifies that the Stage is aligned at the bottom.
-		StageAlign
  BOTTOM_LEFT : String = "BL"
[static] -Specifies that the Stage is aligned in the bottom-left corner.
-		StageAlign
  BOTTOM_RIGHT : String = "BR"
[static] -Specifies that the Stage is aligned in the bottom-right corner.
-		StageAlign
  LEFT : String = "L"
[static] -Specifies that the Stage is aligned on the left.
-		StageAlign
  RIGHT : String = "R"
[static] -Specifies that the Stage is aligned to the right.
-		StageAlign
  TOP : String = "T"
[static] -Specifies that the Stage is aligned at the top.
-		StageAlign
  TOP_LEFT : String = "TL"
[static] -Specifies that the Stage is aligned in the top-left corner.
-		StageAlign
  TOP_RIGHT : String = "TR"
[static] -Specifies that the Stage is aligned in the top-right corner.
-		StageAlign
-
- -
- -
Constant detail
- - - - - -
BOTTOMconstant
-
-public static const BOTTOM:String = "B" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the Stage is aligned at the bottom. -

- - - - - -
BOTTOM_LEFTconstant 
-
-public static const BOTTOM_LEFT:String = "BL" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the Stage is aligned in the bottom-left corner. -

- - - - - -
BOTTOM_RIGHTconstant 
-
-public static const BOTTOM_RIGHT:String = "BR" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the Stage is aligned in the bottom-right corner. -

- - - - - -
LEFTconstant 
-
-public static const LEFT:String = "L" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the Stage is aligned on the left. -

- - - - - -
RIGHTconstant 
-
-public static const RIGHT:String = "R" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the Stage is aligned to the right. -

- - - - - -
TOPconstant 
-
-public static const TOP:String = "T" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the Stage is aligned at the top. -

- - - - - -
TOP_LEFTconstant 
-
-public static const TOP_LEFT:String = "TL" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the Stage is aligned in the top-left corner. -

- - - - - -
TOP_RIGHTconstant 
-
-public static const TOP_RIGHT:String = "TR" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the Stage is aligned in the top-right corner. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/StageAspectRatio.html b/html-docs/flash/display/StageAspectRatio.html deleted file mode 100644 index 047cc40..0000000 --- a/html-docs/flash/display/StageAspectRatio.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - - - -flash.display.StageAspectRatio (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class StageAspectRatio
InheritanceStageAspectRatio Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The StageAspectRatio class provides values for the Stage.setAspectRatio() method. - -

-

-See also -

-
-flash.display.Stage.setAspectRatio() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  ANY : String = "any"
[static] - Specifies a device orientation that supports both portrait and landscape UI.
-		StageAspectRatio
  LANDSCAPE : String = "landscape"
[static] - Specifies a device orientation that presents a landscape UI -
-		StageAspectRatio
  PORTRAIT : String = "portrait"
[static] - Specifies a device orientation that presents a portrait UI -
-		StageAspectRatio
-
- -
- -
Constant detail
- - - - - -
ANYconstant
-
-public static const ANY:String = "any" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Specifies a device orientation that supports both portrait and landscape UI. Requires SWF version 16 or higher. -

- - - - - -
LANDSCAPEconstant 
-
-public static const LANDSCAPE:String = "landscape" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies a device orientation that presents a landscape UI -

- - - - - -
PORTRAITconstant 
-
-public static const PORTRAIT:String = "portrait" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies a device orientation that presents a portrait UI -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/StageDisplayState.html b/html-docs/flash/display/StageDisplayState.html deleted file mode 100644 index 119aa36..0000000 --- a/html-docs/flash/display/StageDisplayState.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - - - -flash.display.StageDisplayState (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class StageDisplayState
InheritanceStageDisplayState Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The StageDisplayState class provides values for the Stage.displayState property. - -

-

-See also -

-
-flash.display.Stage.displayState -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  FULL_SCREEN : String = "fullScreen"
[static] -Specifies that the Stage is in full-screen mode.
-		StageDisplayState
  FULL_SCREEN_INTERACTIVE : String = "fullScreenInteractive"
[static] -Specifies that the Stage is in full-screen mode with keyboard interactivity enabled.
-		StageDisplayState
  NORMAL : String = "normal"
[static] -Specifies that the Stage is in normal mode.
-		StageDisplayState
-
- -
- -
Constant detail
- - - - - -
FULL_SCREENconstant
-
-public static const FULL_SCREEN:String = "fullScreen" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the Stage is in full-screen mode. In this mode, keyboard interactivity is enabled for mobile devices. - -

- - - - - -
FULL_SCREEN_INTERACTIVEconstant 
-
-public static const FULL_SCREEN_INTERACTIVE:String = "fullScreenInteractive" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

-Specifies that the Stage is in full-screen mode with keyboard interactivity enabled. -As of Flash Player 11.3, this capability is supported in both -AIR applications and browser-based applications. - -

-See also -

-
-Stage.allowsFullScreenInteractive -
-
- - - - - -
NORMALconstant 
-
-public static const NORMAL:String = "normal" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the Stage is in normal mode. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/StageOrientation.html b/html-docs/flash/display/StageOrientation.html deleted file mode 100644 index 2a523eb..0000000 --- a/html-docs/flash/display/StageOrientation.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - - - - -flash.display.StageOrientation (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class StageOrientation
InheritanceStageOrientation Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The StageOrientation class defines constants enumerating the possible orientations of the stage and the device. -

-

-See also -

-
-flash.display.Stage.orientation -
-flash.display.Stage.setOrientation() -
-flash.display.Stage.deviceOrientation -
-flash.events.StageOrientationEvent.afterOrientation -
-flash.events.StageOrientationEvent.beforeOrientation -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  DEFAULT : String = "default"
[static] - Specifies that the stage is currently in the default orientation of the device (right-side up).
-		StageOrientation
  ROTATED_LEFT : String = "rotatedLeft"
[static] - Specifies that the stage is currently rotated left relative to the default orientation.
-		StageOrientation
  ROTATED_RIGHT : String = "rotatedRight"
[static] - Specifies that the stage is currently rotated right relative to the default orientation.
-		StageOrientation
  UNKNOWN : String -
[static] - Specifies that the device has not determined an orientation.
-		StageOrientation
  UPSIDE_DOWN : String = "upsideDown"
[static] - Specifies that the stage is currently upside down relative to the default orientation.
-		StageOrientation
-
- -
- -
Constant detail
- - - - - -
DEFAULTconstant
-
-public static const DEFAULT:String = "default" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies that the stage is currently in the default orientation of the device (right-side up). - -

- - - - - -
ROTATED_LEFTconstant 
-
-public static const ROTATED_LEFT:String = "rotatedLeft" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies that the stage is currently rotated left relative to the default orientation. -

Note: When the orientation of the device is rotated left, the orientation of the - stage must be rotated right in order to remain upright.

- -
- - - - - -
ROTATED_RIGHTconstant 
-
-public static const ROTATED_RIGHT:String = "rotatedRight" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies that the stage is currently rotated right relative to the default orientation. - -

Note: When the orientation of the device is rotated right, the orientation of the - stage must be rotated left in order to remain upright.

-
- - - - - -
UNKNOWNconstant 
-
-public static const UNKNOWN:String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies that the device has not determined an orientation. This state can occur when - the device is lying flat on a table and also while the application is initializing. -

- - - - - -
UPSIDE_DOWNconstant 
-
-public static const UPSIDE_DOWN:String = "upsideDown" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies that the stage is currently upside down relative to the default orientation. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/StageQuality.html b/html-docs/flash/display/StageQuality.html deleted file mode 100644 index c05cc8e..0000000 --- a/html-docs/flash/display/StageQuality.html +++ /dev/null @@ -1,501 +0,0 @@ - - - - - - - - -flash.display.StageQuality (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class StageQuality
InheritanceStageQuality Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The StageQuality class provides values for the Stage.quality property -and for the value of the quality parameter to -the BitmapData.drawWithQuality() method. -

Higher quality settings produce better rendering of scaled bitmaps. However, higher -quality settings are computationally more expensive. In particular, when rendering scaled video, -using higher quality settings can reduce the frame rate.

- -

In the desktop profile of Adobe AIR, quality can be set -to StageQuality.BEST or StageQuality.HIGH (and the default value -is StageQuality.HIGH). Attempting to set it to another value has no effect -(and the property remains unchanged). In the moble profile of AIR, all four quality settings -are available. The default value on mobile devices is StageQuality.MEDIUM.

- -

For content running in Adobe AIR, setting the quality property of one Stage -object changes the rendering quality for all Stage objects (used by different NativeWindow objects). -

- -

Note: The operating system draws the device fonts, -which are therefore unaffected by the quality property.

- -

-

-See also -

-
-flash.display.Stage.quality -
-flash.display.BitmapData.drawWithQuality() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  BEST : String = "best"
[static] - Specifies very high rendering quality.
-		StageQuality
  HIGH : String = "high"
[static] - Specifies high rendering quality.
-		StageQuality
  HIGH_16X16 : String = "16x16"
[static] - Specifies very high rendering quality.
-		StageQuality
  HIGH_16X16_LINEAR : String = "16x16linear"
[static] - Specifies very high rendering quality.
-		StageQuality
  HIGH_8X8 : String = "8x8"
[static] - Specifies very high rendering quality.
-		StageQuality
  HIGH_8X8_LINEAR : String = "8x8linear"
[static] - Specifies very high rendering quality.
-		StageQuality
  LOW : String = "low"
[static] - Specifies low rendering quality.
-		StageQuality
  MEDIUM : String = "medium"
[static] - Specifies medium rendering quality.
-		StageQuality
-
- -
- -
Constant detail
- - - - - -
BESTconstant
-
-public static const BEST:String = "best" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies very high rendering quality. - Graphics are anti-aliased using a 4 x 4 pixel grid. - If Bitmap.smoothing is true the runtime uses a high quality - downscale algorithm that produces fewer artifacts (however, using StageQuality.BEST - with Bitmap.smoothing set to true - slows performance significantly and is not a recommended setting). - -

- - - - - -
HIGHconstant 
-
-public static const HIGH:String = "high" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies high rendering quality. - Graphics are anti-aliased using a 4 x 4 pixel grid, and bitmap smoothing is - dependent on the Bitmap.smoothing setting. - Runtimes use mip-mapping. - This is the default rendering quality setting that Flash Player uses. - -

- - - - - -
HIGH_16X16constant 
-
-public static const HIGH_16X16:String = "16x16" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies very high rendering quality. - Graphics are anti-aliased using a 16 x 16 pixel grid. - If Bitmap.smoothing is true the runtime uses a high quality - downscale algorithm that produces fewer artifacts (however, using StageQuality.BEST - with Bitmap.smoothing set to true - slows performance significantly and is not a recommended setting). - -

- - - - - -
HIGH_16X16_LINEARconstant 
-
-public static const HIGH_16X16_LINEAR:String = "16x16linear" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies very high rendering quality. - Graphics are anti-aliased using a 16 x 16 pixel grid. Antialiasing is generated in linear sRGB space. - If Bitmap.smoothing is true the runtime uses a high quality - downscale algorithm that produces fewer artifacts (however, using StageQuality.BEST - with Bitmap.smoothing set to true - slows performance significantly and is not a recommended setting). - -

- - - - - -
HIGH_8X8constant 
-
-public static const HIGH_8X8:String = "8x8" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies very high rendering quality. - Graphics are anti-aliased using a 8 x 8 pixel grid. - If Bitmap.smoothing is true the runtime uses a high quality - downscale algorithm that produces fewer artifacts (however, using StageQuality.BEST - with Bitmap.smoothing set to true - slows performance significantly and is not a recommended setting). - -

- - - - - -
HIGH_8X8_LINEARconstant 
-
-public static const HIGH_8X8_LINEAR:String = "8x8linear" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies very high rendering quality. - Graphics are anti-aliased using a 8 x 8 pixel grid. Antialiasing is generated in linear sRGB space. - If Bitmap.smoothing is true the runtime uses a high quality - downscale algorithm that produces fewer artifacts (however, using StageQuality.BEST - with Bitmap.smoothing set to true - slows performance significantly and is not a recommended setting). - -

- - - - - -
LOWconstant 
-
-public static const LOW:String = "low" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies low rendering quality. - Graphics are not anti-aliased, and bitmaps are not smoothed, but runtimes still use mip-mapping. - -

- - - - - -
MEDIUMconstant 
-
-public static const MEDIUM:String = "medium" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies medium rendering quality. - Graphics are anti-aliased using a 2 x 2 pixel grid, bitmap smoothing is dependent - on the Bitmap.smoothing setting. - Runtimes use mip-mapping. This setting is suitable for movies that do not contain text. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/StageScaleMode.html b/html-docs/flash/display/StageScaleMode.html deleted file mode 100644 index 6c25cc4..0000000 --- a/html-docs/flash/display/StageScaleMode.html +++ /dev/null @@ -1,342 +0,0 @@ - - - - - - - - -flash.display.StageScaleMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class StageScaleMode
InheritanceStageScaleMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The StageScaleMode class provides values for the Stage.scaleMode property. - -

-

-See also -

-
-flash.display.Stage.scaleMode -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  EXACT_FIT : String = "exactFit"
[static] -Specifies that the entire application be visible in the specified area without trying to preserve -the original aspect ratio.
-		StageScaleMode
  NO_BORDER : String = "noBorder"
[static] -Specifies that the entire application fill the specified area, without distortion but possibly with -some cropping, while maintaining the original aspect ratio of the application.
-		StageScaleMode
  NO_SCALE : String = "noScale"
[static] -Specifies that the size of the application be fixed, so that it remains unchanged even as the size -of the player window changes.
-		StageScaleMode
  SHOW_ALL : String = "showAll"
[static] -Specifies that the entire application be visible in the specified area without distortion while -maintaining the original aspect ratio of the application.
-		StageScaleMode
-
- -
- -
Constant detail
- - - - - -
EXACT_FITconstant
-
-public static const EXACT_FIT:String = "exactFit" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the entire application be visible in the specified area without trying to preserve -the original aspect ratio. Distortion can occur. -

- - - - - -
NO_BORDERconstant 
-
-public static const NO_BORDER:String = "noBorder" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the entire application fill the specified area, without distortion but possibly with -some cropping, while maintaining the original aspect ratio of the application. -

- - - - - -
NO_SCALEconstant 
-
-public static const NO_SCALE:String = "noScale" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the size of the application be fixed, so that it remains unchanged even as the size -of the player window changes. Cropping might occur if the player window is smaller than the content. -

- - - - - -
SHOW_ALLconstant 
-
-public static const SHOW_ALL:String = "showAll" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-Specifies that the entire application be visible in the specified area without distortion while -maintaining the original aspect ratio of the application. Borders can appear on two sides of the application. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/TriangleCulling.html b/html-docs/flash/display/TriangleCulling.html deleted file mode 100644 index 69d15ed..0000000 --- a/html-docs/flash/display/TriangleCulling.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - - - - -flash.display.TriangleCulling (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display
Classpublic final class TriangleCulling
InheritanceTriangleCulling Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- Defines codes for culling algorithms that determine which triangles not to render when drawing triangle paths. -

- The terms POSITIVE and NEGATIVE refer to the sign of a triangle's normal along the z-axis. - The normal is a 3D vector that is perpendicular to the surface of the triangle. -

-

- A triangle whose vertices 0, 1, and 2 are arranged in a clockwise order has a positive normal value. That is, - its normal points in a positive z-axis direction, away from the current view point. - When the TriangleCulling.POSITIVE algorithm is used, triangles with positive normals - are not rendered. Another term for this is backface culling. -

-

- A triangle whose vertices are arranged in a counter-clockwise order has a negative normal value. That is, - its normal points in a negative z-axis direction, toward the current view point. - When the TriangleCulling.NEGATIVE algorithm is used, triangles with negative normals will not - be rendered. -

-

-

-See also -

-
-flash.display.Graphics.drawTriangles() -
-flash.display.GraphicsTrianglePath -
-Introduction to 3D Vectors -
-3D Backface Culling -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  NEGATIVE : String = "negative"
[static] - Specifies culling of all triangles facing toward the current view point.
-		TriangleCulling
  NONE : String = "none"
[static] - Specifies no culling.
-		TriangleCulling
  POSITIVE : String = "positive"
[static] - Specifies culling of all triangles facing away from the current view point.
-		TriangleCulling
-
- -
- -
Constant detail
- - - - - -
NEGATIVEconstant
-
-public static const NEGATIVE:String = "negative"

- Specifies culling of all triangles facing toward the current view point. -

- - - - - -
NONEconstant 
-
-public static const NONE:String = "none"

- Specifies no culling. All triangles in the path are rendered. -

- - - - - -
POSITIVEconstant 
-
-public static const POSITIVE:String = "positive"

- Specifies culling of all triangles facing away from the current view point. - This is also known as backface culling. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display/package-detail.html b/html-docs/flash/display/package-detail.html deleted file mode 100644 index 0e6780a..0000000 --- a/html-docs/flash/display/package-detail.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - -flash.display Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.display package contains the core classes that the Flash Player uses to build visual displays.

-
-
- -
Interfaces
- - - - - - - - - - - - - - - - - - - -
 InterfaceDescription
 IBitmapDrawable - The IBitmapDrawable interface is implemented by objects that can be passed as the source - parameter of the draw() method of the BitmapData class.
 IGraphicsData - This interface is used to define objects that can be used as parameters in the flash.display.Graphics - methods, including fills, strokes, and paths.
 IGraphicsFill - This interface is used to define objects that can be used as fill parameters in the flash.display.Graphics - methods and drawing classes.
 IGraphicsPath - This interface is used to define objects that can be used as path parameters in the flash.display.Graphics - methods and drawing classes.
 IGraphicsStroke - This interface is used to define objects that can be used as stroke parameters in the flash.display.Graphics - methods and drawing classes.
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 ActionScriptVersion - The ActionScriptVersion class is an enumeration of constant values that - indicate the language version of a loaded SWF file.
 AVM1Movie - AVM1Movie is a simple class that represents AVM1 movie clips, which use ActionScript 1.0 or 2.0.
 Bitmap - The Bitmap class represents display objects that represent bitmap images.
 BitmapData - - The BitmapData class lets you work with the data (pixels) of a Bitmap object - - bitmap image.
 BitmapDataChannel -The BitmapDataChannel class is an enumeration of constant values that indicate which channel to -use: red, blue, green, or alpha transparency.
 BitmapEncodingColorSpace - The BitmapEncodingColorSpace class defines the constants that specify how color channels are sampled - by the flash.display.BitmapData.encode() method when specifying the compressor as - flash.display.JPEGXREncoderOptions.
 BlendMode -A class that provides constant values for visual blend mode effects.
 CapsStyle - The CapsStyle class is an enumeration of constant values that specify the caps style to use in drawing lines.
 ColorCorrection -The ColorCorrection class provides values for the flash.display.Stage.colorCorrection property.
 ColorCorrectionSupport -The ColorCorrectionSupport class provides values for the flash.display.Stage.colorCorrectionSupport property.
 DisplayObject - The DisplayObject class is the base class for all objects that can be placed on - the display list.
 DisplayObjectContainer -The DisplayObjectContainer class is the base class for all objects that can serve as display object containers on -the display list.
 FocusDirection - The FocusDirection class enumerates values to be used for the - direction parameter of the assignFocus() method - of a Stage object and for the direction property of a FocusEvent object.
 FrameLabel - - The FrameLabel object contains properties that specify a frame number and the - corresponding label name.
 GradientType -The GradientType class provides values for the type parameter in the -beginGradientFill() and lineGradientStyle() methods of the flash.display.Graphics class.
 Graphics - The Graphics class contains a set of methods that you can use to create a vector shape.
 GraphicsBitmapFill - Defines a bitmap fill.
 GraphicsEndFill - Indicates the end of a graphics fill.
 GraphicsGradientFill - Defines a gradient fill.
 GraphicsPath - A collection of drawing commands and the coordinate parameters for those commands.
 GraphicsPathCommand - Defines the values to use for specifying path-drawing commands.
 GraphicsPathWinding -The GraphicsPathWinding class provides values for the flash.display.GraphicsPath.winding property -and the flash.display.Graphics.drawPath() method -to determine the direction to draw a path.
 GraphicsShaderFill - Defines a shader fill.
 GraphicsSolidFill - Defines a solid fill.
 GraphicsStroke - Defines a line style or stroke.
 GraphicsTrianglePath - Defines an ordered set of triangles that can be rendered using - either (u,v) fill coordinates or a normal fill.
 InteractiveObject - 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.
 InterpolationMethod -The InterpolationMethod class provides values for the interpolationMethod -parameter in the Graphics.beginGradientFill() and -Graphics.lineGradientStyle() methods.
 JointStyle -The JointStyle class is an enumeration of constant values that specify the joint style to use in drawing lines.
 JPEGEncoderOptions - The JPEGEncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method.
 JPEGXREncoderOptions - The JPEGXREncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method.
 LineScaleMode -The LineScaleMode class provides values for the scaleMode -parameter in the Graphics.lineStyle() method.
 Loader - The Loader class is used to load SWF files or image (JPG, PNG, or GIF) files.
 LoaderInfo - The LoaderInfo class provides information about a loaded SWF file or a loaded image file - (JPEG, GIF, or PNG).
 MorphShape - The MorphShape class represents MorphShape objects on the display list.
 MovieClip - The MovieClip class inherits from the following classes: Sprite, DisplayObjectContainer, - InteractiveObject, DisplayObject, and EventDispatcher.
 NativeMenu - The NativeMenu class contains methods and properties for defining native menus.
 NativeMenuItem - - The NativeMenuItem class represents a single item in a menu.
 NativeWindow - - The NativeWindow class provides an interface for creating and controlling native desktop windows.
 NativeWindowDisplayState - The NativeWindowDisplayState class defines constants for the names of the window display states.
 NativeWindowInitOptions - The NativeWindowInitOptions class defines the initialization options - used to construct a new NativeWindow instance.
 NativeWindowRenderMode - The NativeWindowRenderMode class defines constants for the renderMode property of the - NativeWindowInitOptions object used to create a native window.
 NativeWindowResize -The NativeWindowResize class defines constants for the possible values - of the edgeOrCorner parameter of the NativeWindow - startResize() method.
 NativeWindowSystemChrome - The NativeWindowSystemChrome class defines constants for the systemChrome - property of the NativeWindowInitOptions object used to create a native window.
 NativeWindowType - The NativeWindowType class defines constants for the type property of the - NativeWindowInitOptions object used to create a native window.
 PixelSnapping - -The PixelSnapping class is an enumeration of constant values for setting the pixel snapping options -by using the pixelSnapping property of a Bitmap object.
 PNGEncoderOptions - The PNGEncoderOptions class defines a compression algorithm - for the flash.display.BitmapData.encode() method.
 Scene - The Scene class includes properties for identifying the name, labels, and number of frames - in a scene.
 Screen - - The Screen class provides information about the display screens available to this application.
 ScreenMode - The ScreenMode object provides information about the width, height and refresh rate of a Screen.
 Shader - A Shader instance represents a Pixel Bender shader kernel in ActionScript.
 ShaderData - A ShaderData object contains properties representing any parameters and - inputs for a shader kernel, as well as properties containing any metadata - specified for the shader.
 ShaderInput - A ShaderInput instance represents a single input image for - a shader kernel.
 ShaderJob - A ShaderJob instance is used to execute a shader operation in stand-alone mode.
 ShaderParameter - A ShaderParameter instance represents a single input parameter of - a shader kernel.
 ShaderParameterType - This class defines the constants that represent the possible values for - the ShaderParameter class's type property.
 ShaderPrecision - This class defines the constants that represent the possible values for - the Shader class's precisionHint property.
 Shape - This class is used to create lightweight shapes using the ActionScript drawing application program interface (API).
 SimpleButton - The SimpleButton class lets you control all instances of button symbols in a SWF - file.
 SpreadMethod -The SpreadMethod class provides values for the spreadMethod parameter -in the beginGradientFill() and lineGradientStyle() methods of the Graphics class.
 Sprite - The Sprite class is a basic display list building block: a display list node that can display - graphics and can also contain children.
 Stage - The Stage class represents the main drawing area.
 Stage3D - The Stage3D class provides a display area and a programmable rendering context for drawing 2D and 3D graphics.
 StageAlign -The StageAlign class provides constant values to use for the Stage.align property.
 StageAspectRatio - The StageAspectRatio class provides values for the Stage.setAspectRatio() method.
 StageDisplayState -The StageDisplayState class provides values for the Stage.displayState property.
 StageOrientation - The StageOrientation class defines constants enumerating the possible orientations of the stage and the device.
 StageQuality -The StageQuality class provides values for the Stage.quality property -and for the value of the quality parameter to -the BitmapData.drawWithQuality() method.
 StageScaleMode -The StageScaleMode class provides values for the Stage.scaleMode property.
 SWFVersion - The SWFVersion class is an enumeration of constant values that indicate the - file format version of a loaded SWF file.
 TriangleCulling - Defines codes for culling algorithms that determine which triangles not to render when drawing triangle paths.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/display3D/Context3D.html b/html-docs/flash/display3D/Context3D.html deleted file mode 100644 index 4082834..0000000 --- a/html-docs/flash/display3D/Context3D.html +++ /dev/null @@ -1,7234 +0,0 @@ - - - - - - - - -flash.display3D.Context3D (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3D
InheritanceContext3D Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

-

- - The Context3D class provides a context for rendering geometrically defined graphics. - - -

A rendering context includes a drawing surface and its associated resources and state. When possible, the - - rendering context uses the hardware graphics processing unit (GPU). Otherwise, the rendering context uses software. - - (If rendering through Context3D is not supported on a platform, the stage3Ds property of the Stage object contains - - an empty list.)

- - -

The Context3D rendering context is a programmable pipeline that is very similar to OpenGL ES 2, but is abstracted - - so that it is compatible with a range of hardware and GPU interfaces. Although designed for 3D graphics, - - the rendering pipeline does not mandate that the rendering is three dimensional. Thus, you can create a 2D - - renderer by supplying the appropriate vertex and pixel fragment programs. In both the 3D and 2D cases, the - - only geometric primitive supported is the triangle.

- - - -

Get an instance of the Context3D class by calling the requestContext3D() method of a Stage3D object. - - A limited number of Context3D objects can exist per stage; one for each Stage3D in the Stage.stage3Ds list. - - When the context is created, the Stage3D object dispatches a context3DCreate event. A rendering context can - - be destroyed and recreated at any time, such as when another application that uses the GPU gains focus. - - Your code should anticipate receiving multiple context3DCreate events. Position the rendering area on the stage - - using the x and y properties of the associated Stage3D instance.

- - - -

When the rendering context is attached to the stage of an HTML window, - - the default background of the HTMLLoader object obscures the 3D viewport. To turn off the - - default background, set the paintsDefaultBackground property to - - false:

- -

window.htmlLoader.paintsDefaultBackground = false;

- - - -

To render and display a scene (after getting a Context3D object), the following steps are typical:

- -
    - -
  1. Configure the main display buffer attributes by calling configureBackBuffer().
    2. - -
  2. Create and initialize your rendering resources, including: - -
      - -
    • Vertex and index buffers defining the scene geometry
      • - -
    • Vertex and pixel programs (shaders) for rendering the scene
      • - -
    • Textures
      • - -
    - -
    3. - -
  3. Render a frame: - -
      - -
    • Set the render state as appropriate for an object or collection of objects in the scene.
      • - -
    • Call the drawTriangles() method to render a set of triangles.
      • - -
    • Change the rendering state for the next group of objects.
      • - -
    • Call drawTriangles() to draw the triangles defining the objects.
      • - -
    • Repeat until the scene is entirely rendered.
      • - -
    • Call the present() method to display the rendered scene on the stage.
      • - -
    - -
    4. - -
- - - -

The following limits apply to rendering:

- -

Resource limits: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ResourceNumber allowedTotal memory
Vertex buffers4096256 MB
Index buffers4096128 MB
Programs409616 MB
Textures4096128 MB
Cube textures4096256 MB
- -

- -

AGAL limits: 200 opcodes per program.

- - - -

Draw call limits: 32,768 drawTriangles() calls for each present() call.

- -

The following limits apply to textures:

- -

Texture limits for AIR 32 bit: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TextureMaximum sizeTotal GPU memory
Normal Texture (below Baseline extended)2048x2048512 MB
Normal Texture (Baseline extended and above)4096x4096512 MB
Rectangular Texture (below Baseline extended)2048x2048512 MB
Rectangular Texture (Baseline extended and above)4096x4096512 MB
Cube Texture1024x1024256 MB
- -

- -

Texture limits for AIR 64 bit (Desktop): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TextureMaximum sizeTotal GPU memory
Normal Texture (below Baseline extended)2048x2048512 MB
Normal Texture (Baseline extended to Standard)4096x4096512 MB
Normal Texture (Standard extended and above)4096x40962048 MB
Rectangular Texture (below Baseline extended)2048x2048512 MB
Rectangular Texture (Baseline extended to Standard)4096x4096512 MB
Rectangular Texture (Standard extended and above)4096x40962048 MB
Cube Texture1024x1024256 MB
- -

- -

512 MB is the absolute limit for textures, including the texture memory required for mipmaps. - - However, for Cube Textures, the memory limit is 256 MB.

- - - -

You cannot create Context3D objects with the Context3D constructor. It is constructed and available as a property - - of a Stage3D instance. - - The Context3D class can be used on both desktop and mobile platforms, both when running in Flash Player and AIR.

- - - -

-

-View the examples. -

-

-See also -

-
-Context3DBlendFactor -
-Context3DClearMask -
-Context3DCompareMode -
-Context3DProgramType -
-Context3DRenderMode -
-Context3DStencilAction -
-Context3DTextureFormat -
-Context3DTriangleFace -
-Context3DVertexBufferFormat -
-flash.display3D.textures.Texture -
-flash.display3D.textures.CubeTexture -
-IndexBuffer3D -
-flash.geom.Matrix3D -
-Program3D -
-flash.display.Stage3D -
-VertexBuffer3D -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  backBufferHeight : int -
[read-only] - - Specifies the height of the back buffer, which can be changed by a successful call to the configureBackBuffer() method.
-		Context3D
  backBufferWidth : int -
[read-only] - - Specifies the width of the back buffer, which can be changed by a successful call to the configureBackBuffer() method.
-		Context3D
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  driverInfo : String -
[read-only] - - The type of graphics library driver used by this rendering context.
-		Context3D
  enableErrorChecking : Boolean -
- - Specifies whether errors encountered by the renderer are reported to the application.
-		Context3D
  ignoreResourceLimits : Boolean -
- - Specifies whether to ignore all 'soft' resource limits associated with a profile.
-		Context3D
  maxBackBufferHeight : int -
- - Specifies the maximum height of the back buffer.
-		Context3D
  maxBackBufferWidth : int -
- - Specifies the maximum width of the back buffer.
-		Context3D
  profile : String -
[read-only] - - The feature-support profile in use by this Context3D object.
-		Context3D
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  supportsVideoTexture : Boolean -
[static][read-only] - - Indicates if Context3D supports video texture.
-		Context3D
  totalGPUMemory : Number -
[read-only] - - Returns the total GPU memory allocated by Stage3D data structures of an application.
-		Context3D
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-clear(red:Number = 0.0, green:Number = 0.0, blue:Number = 0.0, alpha:Number = 1.0, depth:Number = 1.0, stencil:uint = 0, mask:uint = 0xffffffff):void -
-
- - Clears the color, depth, and stencil buffers associated with this Context3D object and - - fills them with the specified values.
-		Context3D
   -
-configureBackBuffer(width:int, height:int, antiAlias:int, enableDepthAndStencil:Boolean = true, wantsBestResolution:Boolean = false, wantsBestResolutionOnBrowserZoom:Boolean = false):void -
-
- - Sets the viewport dimensions and other attributes of the rendering buffer.
-		Context3D
   -
-createCubeTexture(size:int, format:String, optimizeForRenderToTexture:Boolean, streamingLevels:int = 0):CubeTexture -
-
- - Creates a CubeTexture object.
-		Context3D
   -
-createIndexBuffer(numIndices:int, bufferUsage:String = "staticDraw"):IndexBuffer3D -
-
- - Creates an IndexBuffer3D object.
-		Context3D
   -
-createProgram():Program3D -
-
- - Creates a Program3D object.
-		Context3D
   -
-createRectangleTexture(width:int, height:int, format:String, optimizeForRenderToTexture:Boolean):RectangleTexture -
-
- - Creates a Rectangle Texture object.
-		Context3D
   -
-createTexture(width:int, height:int, format:String, optimizeForRenderToTexture:Boolean, streamingLevels:int = 0):Texture -
-
- - Creates a Texture object.
-		Context3D
   -
-createVertexBuffer(numVertices:int, data32PerVertex:int, bufferUsage:String = "staticDraw"):VertexBuffer3D -
-
- - Creates a VertexBuffer3D object.
-		Context3D
   -
-createVertexBufferForInstances(numVertices:int, data32PerVertex:int, instancesPerElement:int, bufferUsage:String = "staticDraw"):VertexBuffer3D -
-
- - Creates a VertexBuffer3D object for instances data.
-		Context3D
   -
-createVideoTexture():VideoTexture -
-
- - Creates a VideoTexture object.
-		Context3D
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-dispose(recreate:Boolean = true):void -
-
- - Frees all resources and internal storage associated with this Context3D.
-		Context3D
   -
-drawToBitmapData(destination:BitmapData, srcRect:Rectangle = null, destPoint:Point = null):void -
-
- - Draws the current render buffer to a bitmap.
-		Context3D
   -
-drawTriangles(indexBuffer:IndexBuffer3D, firstIndex:int = 0, numTriangles:int = -1):void -
-
- - Render the specified triangles using the current buffers and state of this Context3D object.
-		Context3D
   -
-drawTrianglesInstanced(indexBuffer:IndexBuffer3D, numInstances:int, firstIndex:int = 0, numTriangles:int = -1):void -
-
- - Render the specified instanced triangles using the current buffers and state of this Context3D object.
-		Context3D
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-present():void -
-
- - Displays the back rendering buffer.
-		Context3D
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-setBlendFactors(sourceFactor:String, destinationFactor:String):void -
-
- - Specifies the factors used to blend the output color of a drawing operation with the existing color.
-		Context3D
   -
-setColorMask(red:Boolean, green:Boolean, blue:Boolean, alpha:Boolean):void -
-
- - Sets the mask used when writing colors to the render buffer.
-		Context3D
   -
-setCulling(triangleFaceToCull:String):void -
-
- - Sets triangle culling mode.
-		Context3D
   -
-setDepthTest(depthMask:Boolean, passCompareMode:String):void -
-
- - Sets type of comparison used for depth testing.
-		Context3D
   -
-setFillMode(fillMode:String):void -
-
- - Set fill mode used for render.
-		Context3D
   -
-setProgram(program:Program3D):void -
-
- - Sets vertex and fragment shader programs to use for subsequent rendering.
-		Context3D
   -
-setProgramConstantsFromByteArray(programType:String, firstRegister:int, numRegisters:int, data:ByteArray, byteArrayOffset:uint):void -
-
- - Set constants for use by shader programs using values stored in a ByteArray.
-		Context3D
   -
-setProgramConstantsFromFloatVector(programType:String, firstRegister:int, data:Vector.<float>, numRegisters:int = -1):void -
-
- - Sets the constant inputs for the shader programs.
-		Context3D
   -
-setProgramConstantsFromMatrix(programType:String, firstRegister:int, matrix:Matrix3D, transposedMatrix:Boolean = false):void -
-
- - Sets constants for use by shader programs using values stored in a Matrix3D.
-		Context3D
   -
-setProgramConstantsFromVector(programType:String, firstRegister:int, data:Vector.<Number>, numRegisters:int = -1):void -
-
- - Sets the constant inputs for the shader programs.
-		Context3D
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setRenderToBackBuffer():void -
-
- - Sets the back rendering buffer as the render target.
-		Context3D
   -
-setRenderToTexture(texture:TextureBase, enableDepthAndStencil:Boolean = false, antiAlias:int = 0, surfaceSelector:int = 0, colorOutputIndex:int = 0):void -
-
- - Sets the specified texture as the rendering target.
-		Context3D
   -
-setSamplerStateAt(sampler:int, wrap:String, filter:String, mipfilter:String):void -
-
- - Manually override texture sampler state.
-		Context3D
   -
-setScissorRectangle(rectangle:Rectangle):void -
-
- - Sets a scissor rectangle, which is type of drawing mask.
-		Context3D
   -
-setStencilActions(triangleFace:String = "frontAndBack", compareMode:String = "always", actionOnBothPass:String = "keep", actionOnDepthFail:String = "keep", actionOnDepthPassStencilFail:String = "keep"):void -
-
- - Sets stencil mode and operation.
-		Context3D
   -
-setStencilReferenceValue(referenceValue:uint, readMask:uint = 255, writeMask:uint = 255):void -
-
- - Sets the stencil comparison value used for stencil tests.
-		Context3D
   -
-setTextureAt(sampler:int, texture:TextureBase):void -
-
- - Specifies the texture to use for a texture input register of a fragment program.
-		Context3D
   -
-setVertexBufferAt(index:int, buffer:VertexBuffer3D, bufferOffset:int = 0, format:String = "float4"):void -
-
- - Specifies which vertex data components correspond to a single vertex shader program input.
-		Context3D
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
backBufferHeightproperty
-
-backBufferHeight:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 15 - -
-

- - Specifies the height of the back buffer, which can be changed by a successful call to the configureBackBuffer() method. - - The height may be modified when the browser zoom factor changes if the wantsBestResolutionOnBrowserZoom is set to true - - in the last successful call to the configureBackBuffer() method. The change in height can be detected by registering an event listener for the - - browser zoom change event. - - -

Implementation -
-    public function get backBufferHeight():int -
-

-See also -

-
-configureBackBuffer -
-flash.events.Event.BROWSER_ZOOM_CHANGE -
-
- - - - - -
backBufferWidthproperty 
-
-backBufferWidth:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 15 - -
-

- - Specifies the width of the back buffer, which can be changed by a successful call to the configureBackBuffer() method. - - The width may be modified when the browser zoom factor changes if the wantsBestResolutionOnBrowserZoom is set to true - - in the last successful call to the configureBackBuffer() method. The change in width can be detected by registering an event listener for the - - browser zoom change event. - - -

Implementation -
-    public function get backBufferWidth():int -
-

-See also -

-
-configureBackBuffer -
-flash.events.Event.BROWSER_ZOOM_CHANGE -
-
- - - - - -
driverInfoproperty 
-
-driverInfo:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - The type of graphics library driver used by this rendering context. Indicates whether the rendering is using - - software, a DirectX driver, or an OpenGL driver. Also indicates whether hardware rendering failed. - - - If hardware rendering fails, Flash Player uses software rendering for Stage3D and - - driverInfo contains one of the following values: - -

    - -
  • "Software Hw_disabled=userDisabled" - The Enable hardware acceleration checkbox in the Adobe Flash Player - - Settings UI is not selected.
    • - -
  • "Software Hw_disabled=oldDriver" - There are known problems with the hardware graphics driver. - - Updating the graphics driver may fix this problem.
    • - -
  • "Software Hw_disabled=unavailable" - Known problems with the hardware graphics driver - - or hardware graphics initialization failure.
    • - -
  • "Software Hw_disabled=explicit" - The content explicitly requested software rendering through - - requestContext3D.
    • - -
  • "Software Hw_disabled=domainMemory" - The content uses domainMemory, which requires a license when - - used with Stage3D hardware rendering. Visit adobe.com/go/fpl.
    • - -
- - - -

Implementation -
-    public function get driverInfo():String -
-
- - - - - -
enableErrorCheckingproperty 
-
-enableErrorChecking:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Specifies whether errors encountered by the renderer are reported to the application. - - - -

When enableErrorChecking is true, the clear(), - - and drawTriangles() methods are synchronous and can throw errors. When - - enableErrorChecking is false, the default, the clear(), - - and drawTriangles() methods are asynchronous and errors are not reported. - - Enabling error checking reduces rendering performance. You should only enable error checking when debugging.

- - - - Implementation -
-    public function get enableErrorChecking():Boolean -
-    public function set enableErrorChecking(value:Boolean):void -
-

-See also -

-
-clear() -
-drawTriangles() -
-
- - - - - -
ignoreResourceLimitsproperty 
-
-ignoreResourceLimits:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Specifies whether to ignore all 'soft' resource limits associated with a profile. - - -

This property should be used with caution. By default this is set to false and the - - GPU resources (number of and memory used by elements such as vertex and index buffers, programs and textures) - - are limited per the resource limits described in the Context3D documentation.

- - -

If this property is set to true, these limits are no longer applied and the program can - - continue to allocate GPU memory for new elements. Note that any subsequent error handling will be down to - - the application developers, but it may not be immediately obvious when resource failures occur due to the - - asynchronous nature of the Stage3D implementation within AIR.

- - - Implementation -
-    public function get ignoreResourceLimits():Boolean -
-    public function set ignoreResourceLimits(value:Boolean):void -
-
- - - - - -
maxBackBufferHeightproperty 
-
-maxBackBufferHeight:int  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 15 - -
-

- - Specifies the maximum height of the back buffer. The inital value is the system limit in the platform. The property can be set to a value smaller than - - or equal to, but not greater than, the system limit. The property can be set to a value greater than or equal to, but not smaller than, the minimum limit. - - The minimum limit is a constant value, 32, when the back buffer is not configured. The minimum limit will be the value of the height parameter in the last - - successful call to the configureBackBuffer() method after the back buffer is configured. - - -

Implementation -
-    public function get maxBackBufferHeight():int -
-    public function set maxBackBufferHeight(value:int):void -
-
- - - - - -
maxBackBufferWidthproperty 
-
-maxBackBufferWidth:int  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 15 - -
-

- - Specifies the maximum width of the back buffer. The inital value is the system limit in the platform. The property can be set to a value smaller than - - or equal to, but not greater than, the system limit. The property can be set to a value greater than or equal to, but not smaller than, the minimum limit. - - The minimum limit is a constant value, 32, when the back buffer is not configured. The minimum limit will be the value of the width parameter in the last - - successful call to the configureBackBuffer() method after the back buffer is configured. - - -

Implementation -
-    public function get maxBackBufferWidth():int -
-    public function set maxBackBufferWidth(value:int):void -
-
- - - - - -
profileproperty 
-
-profile:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 4 - -
-

- - The feature-support profile in use by this Context3D object. - -

Implementation -
-    public function get profile():String -
-

-See also -

-
-Context3DProfile -
-
- - - - - -
supportsVideoTextureproperty 
-
-supportsVideoTexture:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 17.0 - -
-

- - Indicates if Context3D supports video texture. - - -

Implementation -
-    public static function get supportsVideoTexture():Boolean -
-
- - - - - -
totalGPUMemoryproperty 
-
-totalGPUMemory:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 21 - -
-

- - Returns the total GPU memory allocated by Stage3D data structures of an application. - -

Whenever a GPU resource object is created, memory utilized is stored in Context3D. This memory includes index buffers, vertex buffers, - - textures(excluding video texture), and programs that were created through this Context3D.

- -

API totalGPUMemory returns the total memory consumed by the above resources to the user. Default value returned is 0.The total GPU memory returned is in bytes. - - The information is only provided in Direct mode on mobile, and in Direct and GPU modes on desktop. (On desktop, using <renderMode>gpu</renderMode> - - will fall back to <renderMode>direct</renderMode>)

- - - - This API can be used when the SWF version is 32 or later. - - - - - - Implementation -
-    public function get totalGPUMemory():Number -
-
- -
Method detail
- - - - - -
clear()method
-
-public function clear(red:Number = 0.0, green:Number = 0.0, blue:Number = 0.0, alpha:Number = 1.0, depth:Number = 1.0, stencil:uint = 0, mask:uint = 0xffffffff):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Clears the color, depth, and stencil buffers associated with this Context3D object and - - fills them with the specified values. - - -

Set the mask parameter to specify which buffers to clear. Use the constants defined in the - - Context3DClearMask class to set the mask parameter. Use the bitwise OR operator, "|", to add - - multiple buffers to the mask (or use Context3DClearMask.ALL). When rendering to the back buffer, - - the configureBackBuffer() method must be called before any clear() calls.

- - - -

Note: If you specify a parameter value outside the allowed range, Numeric parameter values are silently clamped to the range zero to one. - - Likewise, if stencil is greater than 0xff it is set to 0xff.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
red:Number (default = 0.0) — the red component of the color with which to clear the color buffer, in the range zero to one. - -
 
green:Number (default = 0.0) — the green component of the color with which to clear the color buffer, in the range zero to one. - -
 
blue:Number (default = 0.0) — the blue component of the color with which to clear the color buffer, in the range zero to one. - -
 
alpha:Number (default = 1.0) — the alpha component of the color with which to clear the color buffer, in the range zero to one. - - The alpha component is not used for blending. It is written to the buffer alpha directly. - -
 
depth:Number (default = 1.0) — the value with which to clear the depth buffer, in the range zero to one. - -
 
stencil:uint (default = 0) — the 8-bit value with which to clear the stencil buffer, in a range of 0x00 to 0xff. - -
 
mask:uint (default = 0xffffffff) — specifies which buffers to clear. - - -
-
-Throws - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - - -
-

-See also -

-
-Context3DClearMask -
-
- - - - - -
configureBackBuffer()method 
-
-public function configureBackBuffer(width:int, height:int, antiAlias:int, enableDepthAndStencil:Boolean = true, wantsBestResolution:Boolean = false, wantsBestResolutionOnBrowserZoom:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets the viewport dimensions and other attributes of the rendering buffer. - - -

Rendering is double-buffered. The back buffer is swapped with the visible, - - front buffer when the present() method is called. The minimum size of the buffer is 32x32 pixels. - - The maximum size of the back buffer is limited by the device capabilities and can also be set by the user - - through the properties maxBackBufferWidth and maxBackBufferHeight. - - Configuring the buffer is a slow operation. Avoid changing the buffer size or attributes during normal - - rendering operations.

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
width:int — width in pixels of the buffer. - -
 
height:int — height in pixels of the buffer. - -
 
antiAlias:int — an integer value specifying the requested antialiasing quality. - - The value correlates to the number of subsamples used when antialiasing. - - Using more subsamples requires more calculations to be performed, although - - the relative performance impact depends on the specific rendering hardware. The - - type of antialiasing and whether antialiasing is performed at all is dependent on the - - device and rendering mode. Antialiasing is not supported at all by the - - software rendering context. - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
0No antialiasing
2Minimal antialiasing.
4High-quality antialiasing.
16Very high-quality antialiasing.
- - - -
 
enableDepthAndStencil:Boolean (default = true) — false indicates no depth or stencil buffer is created, - - true creates a depth and a stencil buffer. - - For an AIR 3.2 or later application compiled with SWF version 15 or higher, - - if the renderMode element in the application descriptor file - - is direct, then the depthAndStencil element in the application descriptor file - - must have the same value as this argument. - - By default, the value of the depthAndStencil element is false. - - -
 
wantsBestResolution:Boolean (default = false) — true indicates that if the device supports HiDPI screens it - - will attempt to allocate a larger back buffer than indicated with the width and height parameters. Since - - this add more pixels and potentially changes the result of shader operations this is turned off by default. - - Use Stage.contentsScaleFactor to determine by how much the native back buffer was scaled up. - - -
 
wantsBestResolutionOnBrowserZoom:Boolean (default = false) — true indicates that the size of the back buffer should increase - - in proportion to the increase in the browser zoom factor. The setting of this value is persistent across multiple browser zooms. - - The default value of the parameter is false. Set maxBackBufferWidth and maxBackBufferHeight properties - - to limit the back buffer size increase. Use backBufferWidth and backBufferHeight to determine the current - - size of the back buffer. - - -
-
-Throws - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - - -
 
Error — Bad Input Size: The width or height parameter is either less than the minimum back buffer allowed size or greater than the maximum back buffer size allowed. - - -
 
Error — 3709: The depthAndStencil flag in the application descriptor must match the - - enableDepthAndStencil Boolean passed to configureBackBuffer() on the Context3D object. - - - -
-
- - - - - -
createCubeTexture()method 
-
-public function createCubeTexture(size:int, format:String, optimizeForRenderToTexture:Boolean, streamingLevels:int = 0):CubeTexture -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Creates a CubeTexture object. - - -

Use a CubeTexture object to upload cube texture bitmaps to the rendering context and to - - reference a cube texture during rendering. A cube texture consists of six equal-sized, square - - textures arranged in a cubic topology and are useful for describing environment maps.

- - - -

You cannot create CubeTexture objects with a CubeTexture constructor; use this method instead. After - - creating a CubeTexture object, upload the texture bitmap data using the CubeTexture uploadFromBitmapData(), - - uploadFromByteArray(), or uploadCompressedTextureFromByteArray() methods..

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
size:int — The texture edge length in texels. - - - -
 
format:String — The texel format, of the Context3DTextureFormat enumerated list. - -

Texture compression lets you store texture images in compressed format directly on the GPU, which saves GPU memory and - - memory bandwidth. Typically, compressed textures are compressed offline and uploaded to the GPU in compressed form using the - - Texture.uploadCompressedTextureFromByteArray method. - - Flash Player 11.4 and AIR 3.4 on desktop platforms added support for runtime texture compression, which may be useful - - in certain situations, such as when rendering dynamic textures from vector art. Note that this feature is not currently - - available on mobile platforms and an ArgumentError (Texture Format Mismatch) will be thrown instead. - - To use runtime texture compression, perform the following steps: - - 1. Create the texture object by calling the Context3D.createCubeTexture() method, passing either - - flash.display3D.Context3DTextureFormat.COMPRESSED or flash.display3D.Context3DTextureFormat.COMPRESSED_ALPHA as the format parameter. - - 2. Using the flash.display3D.textures.Texture instance returned by createCubeTexture(), call either - - flash.display3D.textures.CubeTexture.uploadFromBitmapData() or flash.display3D.textures.CubeTexture.uploadFromByteArray() to upload - - and compress the texture in one step. - -

- -
 
optimizeForRenderToTexture:Boolean — Set to true if the texture is likely to be used as a render target. - - -
 
streamingLevels:int (default = 0) — The MIP map level that must be loaded before the image is rendered. - - Texture streaming offers the ability to load and display the smallest mip levels first, progressively displaying higher quality images - - as the textures are loaded. End users can view lower-quality images in an application while the higher quality images load. - -

By default, streamingLevels is 0, meaning that the highest quality image in the MIP map must be loaded before the image is rendered. - - This parameter was added in Flash Player 11.3 and AIR 3.3. - - Using the default value maintains the behavior of the previous versions of Flash Player and AIR. - -

- -

Set streamingLevels to a value between 1 and the number of images in the MIP map to enable texture streaming. - - For example, you have a MIP map that includes at the highest quality a main image at 64x64 pixels. - - Lower quality images in the MIP map are 32x32, 16x16, 8x8, 4x4, 2x2, and 1x1 pixels, - - for 7 images in total, or 7 levels. Level 0 is the highest quality image. - - The maximum value of this property is log2(min(width,height)). - - Therefore, for a main image that is 64x64 pixels, the maximum value of streamingLevels is 7. - - Set this property to 3 to render the image after the 8x8 pixel image loads.

- - -

Note: Setting this property to a value > 0 can impact memory usage and performance.

- - -
-

-Returns - - - - -
CubeTexture
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - -
 
Error — Resource Limit Exceeded: if too many Texture objects are created or the amount of - - memory allocated to textures is exceeded. - -
 
ArgumentError — Depth Texture Not Implemented: if you attempt to create a depth texture. - -
 
ArgumentError — Texture Size Is Zero: if the size - - parameter is not greater than zero. - -
 
ArgumentError — Texture Not Power Of Two: if the size - - parameter is not a power of two. - -
 
ArgumentError — Texture Too Big: if the size - - parameter is greater than 1024. - -
 
Error — Texture Creation Failed: if the CubeTexture object could not be created by the - - rendering context (but information about the reason is not available). - -
 
ArgumentError — Invalid streaming level: if streamingLevels is greater or equal to log2(size). - - -
-

-See also -

-
-Context3DTextureFormat -
-flash.display3D.textures.Texture -
-
- - - - - -
createIndexBuffer()method 
-
-public function createIndexBuffer(numIndices:int, bufferUsage:String = "staticDraw"):IndexBuffer3D -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Creates an IndexBuffer3D object. - - -

Use an IndexBuffer3D object to upload a set of triangle indices to the rendering context and to - - reference that set of indices for rendering. Each index in the index buffer references a corresponding vertex - - in a vertex buffer. Each set of three indices identifies a triangle. Pass the IndexBuffer3D object to the - - drawTriangles() method to render one or more triangles defined in the index buffer.

- - - -

You cannot create IndexBuffer3D objects with the IndexBuffer3D class constructor; use this method instead. After - - creating a IndexBuffer3D object, upload the indices using the IndexBuffer3D uploadFromVector() - - or uploadFromByteArray() methods.

- - - Parameters - - - - - - - - - - -
numIndices:int — the number of vertices to be stored in the buffer. - -
 
bufferUsage:String (default = "staticDraw") — the expected buffer usage. Use one of the constants defined in Context3DBufferUsage. - - The hardware driver can do appropriate optimization when you set it correctly. - - This parameter is only available after Flash 12/AIR 4. - - - -
-

-Returns - - - - -
IndexBuffer3D
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - -
 
Error — Resource Limit Exceeded: if too many index buffers are created or the amount of - - memory allocated to index buffers is exceeded. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - -
 
ArgumentError — Buffer Too Big: when numIndices is greater than or equal to 0xf0000. - - - -
-

-See also -

-
-IndexBuffer3D -
-
- - - - - -
createProgram()method 
-
-public function createProgram():Program3D -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Creates a Program3D object. - - -

Use a Program3D object to upload shader programs to the rendering context and to - - reference uploaded programs during rendering. - - A Program3D object stores two programs, a vertex program and a fragment program (also known as a - - pixel program). The programs are written in a binary shader assembly language.

- - - -

You cannot create Program3D objects with a Program3D constructor; use this method instead. After - - creating a Program3D object, upload the programs using the Program3D upload() method.

- - -

-Returns - - - - -
Program3D
-
-Throws - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - -
 
Error — The number of programs exceeds 4096 or the total memory size exceeds 16MB - - (use dispose to free Program3D resources). - - - -
-

-See also -

-
-Program3D -
-Program3D.upload() -
-
-Example -
This example illustrates how to create, upload, and activate a - pair of vertex and pixel programs to a rendering context. Note that the - object, renderContext, is an instance of the Context3D class. - The programs in the example are written in Adobe Graphics Assembly Language (AGAL). -
-
-//A simple vertex program in AGAL
-const VERTEX_SHADER:String =
-    "m44 op, va0, vc0 \n" +	
-	"mov v0, va1"; 
-
-//A simple fragment (or pixel) program in AGAL		
-const FRAGMENT_SHADER:String = "mov oc, v0";  
-
-var vertexAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-var fragmentAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-var programPair:Program3D;
-
-//Compile shaders
-vertexAssembly.assemble( Context3DProgramType.VERTEX, VERTEX_SHADER, false );
-fragmentAssembly.assemble( Context3DProgramType.FRAGMENT, FRAGMENT_SHADER, false );			
-
-//Upload programs to render context
-programPair = renderContext.createProgram();
-programPair.upload( vertexAssembly.agalcode, fragmentAssembly.agalcode );
-renderContext.setProgram( programPair );
-
-

-
- - - - - -
createRectangleTexture()method 
-
-public function createRectangleTexture(width:int, height:int, format:String, optimizeForRenderToTexture:Boolean):RectangleTexture -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.8 - -
-

- - Creates a Rectangle Texture object. - - -

Use a RectangleTexture object to upload texture bitmaps to the rendering context and to - - reference a texture during rendering.

- - - -

You cannot create RectangleTexture objects with a RectangleTexture constructor; use this method instead. After - - creating a RectangleTexture object, upload the texture bitmaps using the Texture uploadFromBitmapData() or - - uploadFromByteArray() methods.

- - - -

Note that 32-bit integer textures are stored in a packed BGRA format to match the Flash BitmapData format. - - Floating point textures use a conventional RGBA format.

- - -

Rectangle textures are different from regular 2D textures in that their width and height do not have to be powers of two. - - Also, they do not contain mip maps. They are most useful for use in render to texture cases. If a rectangle texture is used with - - a sampler that uses mip map filtering or repeat wrapping the drawTriangles call will fail. Rectangle texture also do not allow streaming. The only texture formats supported by Rectangle textures are BGRA, BGR_PACKED, BGRA_PACKED. The compressed texture formats are not supported by Rectangle Textures. - -

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
width:int — The texture width in texels. - - -
 
height:int — The texture height in texels. - - -
 
format:String — The texel format, of the Context3DTextureFormat enumerated list. - - -
 
optimizeForRenderToTexture:Boolean — Set to true if the texture is likely to be used as a render target. - - - -
-

-Returns - - - - -
RectangleTexture
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - -
 
Error — Resource Limit Exceeded: if too many Texture objects are created or the amount of - - memory allocated to textures is exceeded. - -
 
ArgumentError — Texture Size Is Zero: if both the width or height - - parameters are not greater than zero. - -
 
ArgumentError — Texture Too Big: if either the width or the height - - parameter is greater than 2048. - -
 
Error — Texture Creation Failed: if the Texture object could not be created by the - - rendering context (but information about the reason is not available). - -
 
Error — Requires Baseline Profile Or Above: if rectangular texture is created with baseline constrained profile. - - -
-

-See also -

-
-Context3DTextureFormat -
-
- - - - - -
createTexture()method 
-
-public function createTexture(width:int, height:int, format:String, optimizeForRenderToTexture:Boolean, streamingLevels:int = 0):Texture -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Creates a Texture object. - - -

Use a Texture object to upload texture bitmaps to the rendering context and to - - reference a texture during rendering.

- - - -

You cannot create Texture objects with a Texture constructor; use this method instead. After - - creating a Texture object, upload the texture bitmaps using the Texture uploadFromBitmapData(), - - uploadFromByteArray(), or uploadCompressedTextureFromByteArray() methods.

- - - -

Note that 32-bit integer textures are stored in a packed BGRA format to match the Flash BitmapData format. - - Floating point textures use a conventional RGBA format.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
width:int — The texture width in texels. - - -
 
height:int — The texture height in texels. - - -
 
format:String — The texel format, of the Context3DTextureFormat enumerated list. - -

Texture compression lets you store texture images in compressed format directly on the GPU, which saves GPU memory and - - memory bandwidth. Typically, compressed textures are compressed offline and uploaded to the GPU in compressed form using the - - Texture.uploadCompressedTextureFromByteArray method. - - Flash Player 11.4 and AIR 3.4 on desktop platforms added support for runtime texture compression, which may be useful - - in certain situations, such as when rendering dynamic textures from vector art. Note that this feature is not currently - - available on mobile platforms and an ArgumentError (Texture Format Mismatch) will be thrown instead. - - To use runtime texture compression, perform the following steps: - - 1. Create the texture object by calling the Context3D.createTexture() method, passing either - - flash.display3D.Context3DTextureFormat.COMPRESSED or flash.display3D.Context3DTextureFormat.COMPRESSED_ALPHA as the format parameter. - - 2. Using the flash.display3D.textures.Texture instance returned by createTexture(), call either - - flash.display3D.textures.Texture.uploadFromBitmapData() or flash.display3D.textures.Texture.uploadFromByteArray() to upload - - and compress the texture in one step. - -

- -
 
optimizeForRenderToTexture:Boolean — Set to true if the texture is likely to be used as a render target. - - -
 
streamingLevels:int (default = 0) — The MIP map level that must be loaded before the image is rendered. - - - Texture streaming offers the ability to load and display the smallest mip levels first, progressively displaying higher quality images - - as the textures are loaded. End users can view lower-quality images in an application while the higher quality images load. - -

By default, streamingLevels is 0, meaning that the highest quality image in the MIP map must be loaded before the image is rendered. - - This parameter was added in Flash Player 11.3 and AIR 3.3. - - Using the default value maintains the behavior of the previous versions of Flash Player and AIR. - -

- -

Set streamingLevels to a value between 1 and the number of images in the MIP map to enable texture streaming. - - For example, you have a MIP map that includes at the highest quality a main image at 64x64 pixels. - - Lower quality images in the MIP map are 32x32, 16x16, 8x8, 4x4, 2x2, and 1x1 pixels, - - for 7 images in total, or 7 levels. Level 0 is the highest quality image. - - The maximum value of this property is log2(min(width,height)). - - Therefore, for a main image that is 64x64 pixels, the maximum value of streamingLevels is 7. - - Set this property to 3 to render the image after the 8x8 pixel image loads.

- - -

Note: Setting this property to a value > 0 can impact memory usage and performance.

- - - -
-

-Returns - - - - -
Texture
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - -
 
Error — Resource Limit Exceeded: if too many Texture objects are created or the amount of - - memory allocated to textures is exceeded. - -
 
ArgumentError — Depth Texture Not Implemented: if you attempt to create a depth texture. - -
 
ArgumentError — Texture Size Is Zero: if both the width or height - - parameters are not greater than zero. - -
 
ArgumentError — Texture Not Power Of Two: if both the width and height - - parameters are not a power of two. - -
 
ArgumentError — Texture Too Big: if either the width or the height - - parameter is greater than 2048 for baseline and baseline constrained profile or if either the - - width or the height parameter is greater than 4096 for profile baseline extended and above. - -
 
Error — Texture Creation Failed: if the Texture object could not be created by the - - rendering context (but information about the reason is not available). - -
 
ArgumentError — Invalid streaming level: if streamingLevels is greater or equal to log2(min(width,height)). - - -
-

-See also -

-
-Context3DTextureFormat -
-flash.display3D.textures.Texture -
-
- - - - - -
createVertexBuffer()method 
-
-public function createVertexBuffer(numVertices:int, data32PerVertex:int, bufferUsage:String = "staticDraw"):VertexBuffer3D -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Creates a VertexBuffer3D object. - - -

Use a VertexBuffer3D object to upload a set of vertex data to the rendering context. - - A vertex buffer contains the data needed to render each point in the scene geometry. - - The data attributes associated with each vertex typically includes position, color, and texture - - coordinates and serve as the input to the vertex shader program. Identify the data - - values that correspond to one of the inputs of the vertex program using the - - setVertexBufferAt() method. You can specify up to sixty-four 32-bit values - - for each vertex.

- - - -

You cannot create VertexBuffer3D objects with a VertexBuffer3D constructor; use this method instead. After - - creating a VertexBuffer3D object, upload the vertex data using the VertexBuffer3D uploadFromVector() - - or uploadFromByteArray() methods.

- - - - Parameters - - - - - - - - - - - - - - - - -
numVertices:int — the number of vertices to be stored in the buffer. The maximum number of - - vertices in a single buffer is 65535. - -
 
data32PerVertex:int — the number of 32-bit(4-byte) data values associated with each vertex. - - The maximum number of 32-bit data elements per vertex is 64 (or 256 bytes). - - Note that only eight attribute registers are - - accessible by a vertex shader program at any given time. Use SetVertextBufferAt() to select attributes from within - - a vertex buffer. - -
 
bufferUsage:String (default = "staticDraw") — the expected buffer usage. Use one of the constants defined in Context3DBufferUsage. - - The hardware driver can do appropriate optimization when you set it correctly. - - This parameter is only available after Flash 12/AIR 4 - - - -
-

-Returns - - - - -
VertexBuffer3D
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - -
 
Error — Resource Limit Exceeded: if too many vertex buffer objects are created or the amount of memory alloted to - - vertex buffers is exceeded. - -
 
ArgumentError — Buffer Too Big: when numVertices is greater than 0x10000 or data32PerVertex is greater than 64. - -
 
ArgumentError — Buffer Has Zero Size: when numVertices is zero or data32PerVertex is zero. - -
 
ArgumentError — Buffer Creation Failed: if the VertexBuffer3D object could not be created - - by the rendering context (but additional information about the reason is not available). - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - - -
-

-See also -

-
-VertexBuffer3D -
-setVertexBufferAt() -
-
-Example -
The following example illustrates how to create and load - a vertex data buffer. The buffer in the example contains two types of data for - each vertex: the position, as x, y, z coordinates; and the color, as rgb components. - After the vertex buffer is created, the example calls the setVertexBufferAt() - method to specify that the first three data points are passed to the vertex program - as 3 Floating point values in va0 and that the second three data points are passed - as va1. A vertex program can have up to 8 inputs, also known as vertex attribute registers, - defined in this way. -
-
-const dataPerVertex:int = 6;
-var vertexData:Vector.<Number> = Vector.<Number>(
-    [
-	  // x, y, z    r, g, b format
-	     0, 0, 0,   1, 1, 1,
-	    -1, 1, 0,   0, 0,.5,
-	     1, 1, 0,   0, 0, 1,
-	     1,-1, 0,  .5, 0, 0,
-	    -1,-1, 0,   1, 0, 0
-	]
-);
-var vertexes:VertexBuffer3D = renderContext.createVertexBuffer( vertexData.length/dataPerVertex, dataPerVertex );
-vertexes.uploadFromVector( vertexData, 0, vertexData.length/dataPerVertex );
-			
-//Identify vertex data inputs for vertex program
-renderContext.setVertexBufferAt( 0, vertexes, 0, Context3DVertexBufferFormat.FLOAT_3 ); //Defines shader input va0 as the position data
-renderContext.setVertexBufferAt( 1, vertexes, 3, Context3DVertexBufferFormat.FLOAT_3 ); //Defines shader input va1 as the color data
-
-

-
- - - - - -
createVertexBufferForInstances()method 
-
-public function createVertexBufferForInstances(numVertices:int, data32PerVertex:int, instancesPerElement:int, bufferUsage:String = "staticDraw"):VertexBuffer3D -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 20.0 - -
-

- - Creates a VertexBuffer3D object for instances data. - - -

Use a VertexBuffer3D object to upload a set of instance data to the rendering context. - - The vertex buffer contains the data needed to render each instance in the scene geometry. - - Vertex Buffers with instance data provide attributes that are common to all the vertices of an instance. - - and serve as the input to the vertex shader program. Identify the data values that correspond to one of - - the inputs of the vertex program using the setVertexBufferAt() method. You can specify up to sixty-four 32-bit values - - for each element of vertex buffer.

- - - -

You cannot create VertexBuffer3D objects with a VertexBuffer3D constructor; use this method instead. After - - creating a VertexBuffer3D object, upload the vertex data using the VertexBuffer3D uploadFromVector() - - or uploadFromByteArray() methods.

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
numVertices:int — the number of elements to be stored in the buffer. The maximum number of - - elements in a single buffer is 65535. - -
 
data32PerVertex:int — the number of 32-bit(4-byte) data values associated with each element. - - The maximum number of 32-bit data elements per vertex is 64 (or 256 bytes). - -
 
instancesPerElement:int — the number of instances which will use one element of the vertex buffer. - -
 
bufferUsage:String (default = "staticDraw") — the expected buffer usage. Use one of the constants defined in Context3DBufferUsage. - - The hardware driver can do appropriate optimization when you set it correctly. - - This parameter is only available after Flash 12/AIR 4 - - -
-

-Returns - - - - -
VertexBuffer3D
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - -
 
Error — Resource Limit Exceeded: if too many vertex buffer objects are created or the amount of memory alloted to - - vertex buffers is exceeded. - -
 
ArgumentError — Buffer Too Big: when numVertices is greater than 0x10000 or data32PerVertex is greater than 64. - -
 
ArgumentError — Buffer Has Zero Size: when numVertices is zero or data32PerVertex is zero. - -
 
ArgumentError — Buffer Creation Failed: if the VertexBuffer3D object could not be created - - by the rendering context (but additional information about the reason is not available). - -
 
Error — 3768: The Stage3D API may not be used during background execution. - -
 
Error — Requires Standard Extended Profile Or Above: if this method is called when the requested profile is less than standard extended profile. - -
 
Error — Invalid Instances Per Element: if the instancesPerElement is not greater than zero. - - - - - -
-

-See also -

-
-VertexBuffer3D -
-setVertexBufferAt() -
-
- - - - - -
createVideoTexture()method 
-
-public function createVideoTexture():VideoTexture -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 17.0 - -
-

- - Creates a VideoTexture object. - - -

Use a VideoTexture object to obtain video frames as texture from NetStream object or Camera - - object and to upload the video frames to the rendering context.

- - - -

The VideoTexture object cannot be created with the VideoTexture constructor; use this method instead. - - After creating a VideoTexture object, attach NetStream object or Camera Object to get the video frames - - with the VideoTexture attachNetStream() or attachCamera() methods.

- - - -

Note that this method returns null if the system doesn't support this feature.

- - -

VideoTexture does not contain mipmaps. If VideoTexture is used with - - a sampler that uses mip map filtering or repeat wrapping, the drawTriangles call will fail. VideoTexture - - can be treated as BGRA texture by the shaders. - - The attempt to instantiate the VideoTexture Object will fail if the Context3D was requested with sotfware rendering mode. - -

- - -

A maximum of 4 VideoTexture objects are available per Context3D instance. - - On mobile the actual number of supported VideoTexture objects may be less than 4 due to platform limitations.

- - - -

-Returns - - - - -
VideoTexture
-
-Throws - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - -
 
Error — Resource Limit Exceeded: if too many Texture objects are created or the amount of - - memory allocated to textures is exceeded. - -
 
Error — Texture Creation Failed: if the Texture object could not be created by the - - rendering context (but information about the reason is not available). - - -
-
- - - - - -
dispose()method 
-
-public function dispose(recreate:Boolean = true):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Frees all resources and internal storage associated with this Context3D. - - - -

All index buffers, vertex buffers, textures, and programs that were created through this Context3D are disposed - - just as if calling dispose() on each of them individually. - - In addition, the Context3D itself is disposed freeing all temporary buffers and the back buffer. - - If you call configureBackBuffer(), clear(), drawTriangles(), createCubeTexture(), createTexture(), createProgram(), - - createIndexBuffer(), createVertexBuffer(), or drawToBitmapData() after calling dispose(), the runtime throws an exception.

- - -

Warning: calling dispose() on a Context3D while there is still a event listener for Events.CONTEXT3D_CREATE set on the asociated Stage3D object the dispose() call - - will simulate a device loss. It will create a new Context3D on the Stage3D and issue the Events.CONTEXT3D_CREATE event again. - - If this is not desired remove the event listener from the Stage3D object before calling dispose() or set the recreate parameter to false.

- - - Parameters - - - - -
recreate:Boolean (default = true)
-

-See also -

-
Stage3D
-flash.display.Stage3D -
-
- - - - - -
drawToBitmapData()method 
-
-public function drawToBitmapData(destination:BitmapData, srcRect:Rectangle = null, destPoint:Point = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Draws the current render buffer to a bitmap. - - -

The current contents of the back render buffer are copied to a BitmapData object. This is potentially a very slow - - operation that can take up to a second. Use with care. - - Note that this function does not copy the front render buffer (the one shown on stage), but the buffer being drawn to. - - To capture the rendered image as it appears on the stage, call drawToBitmapData() - - immediately before you calling present().

- - - - - -

Beginning with AIR 25, two new parameters have been introduced in the API drawToBitmapData(). - - This API now takes three parameters. The first one is the existing parameter destination:BitmapData. - - The second parameter is srcRect:Rectangle, which is target rectangle on stage3D. - - The third parameter is destPoint:Point, which is the coordinate on the destination bitmap. - - The parameters srcRect and destPoint are optional and default to (0,0,bitmapWidth,bitmapHeight) and (0,0), respectively.

- - -

When the image is drawn, it is not scaled to fit the bitmap. Instead, the contents are - - clipped to the size of the destination bitmap.

- - -

Flash BitmapData objects store colors already multiplied by the alpha component. For example, if the "pure" rgb color - - components of a pixel are (0x0A, 0x12, 0xBB) and the alpha component is 0x7F (.5), then the pixel is stored in the - - BitmapData object with the rgba values: (0x05, 0x09, 0x5D, 0x7F). You can set the blend factors so that the colors - - rendered to the buffer are multiplied by alpha or perform the operation in the fragment shader. The rendering context - - does not validate that the colors are stored in premultiplied format.

- - - - Parameters - - - - - - - - - - - - - - - - -
destination:BitmapData
 
srcRect:Rectangle (default = null)
 
destPoint:Point (default = null)
-
-Throws - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - -
 
Error — 3802: If either one of the parameters destPoint:Point or srcRect:Rectangle - - is outside the bitmap/stage3D coordinate bound, or if non-Numeric(NaN) values are passed as input. - - -
-
-Example -
The following example renders two triangles to both the normal render buffer and - a BitmapData object. The BitmapData object is displayed using a Bitmap object added to the - normal display list. A drop shadow filter is applied to the bitmap rendering. -
-
-package
-{
-    import com.adobe.utils.AGALMiniAssembler;
-	
-	import flash.display.Bitmap;
-	import flash.display.BitmapData;
-	import flash.display.Sprite;
-	import flash.display.Stage3D;
-	import flash.display3D.Context3D;
-	import flash.display3D.Context3DProgramType;
-	import flash.display3D.Context3DRenderMode;
-	import flash.display3D.Context3DVertexBufferFormat;
-	import flash.display3D.IndexBuffer3D;
-	import flash.display3D.Program3D;
-	import flash.display3D.VertexBuffer3D;
-	import flash.events.Event;
-	import flash.filters.DropShadowFilter;
-	
-	public class Context3D_drawToBitmapData extends Sprite
-	{
-		public const viewWidth:Number = 320;
-		public const viewHeight:Number = 200;
-		
-		private var bitmap:Bitmap;
-		private var stage3D:Stage3D;
-		private var renderContext:Context3D;
-		private var indexList:IndexBuffer3D;
-		private var vertexes:VertexBuffer3D;
-		
-		private const VERTEX_SHADER:String =
-			"mov op, va0	\n" +	//copy position to output 
-			"mov v0, va1"; //copy color to varying variable v0
-		
-		private const FRAGMENT_SHADER:String = 
-			"mov oc, v0"; //Set the output color to the value interpolated from the three triangle vertices 
-
-		private var vertexAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var fragmentAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var programPair:Program3D;
-		
-		public function Context3D_drawToBitmapData()
-		{
-			stage3D = this.stage.stage3Ds[0];
-			stage3D.x = 0;
-			stage3D.y = 0;
-
-			//Add event listener before requesting the context
-			stage3D.addEventListener( Event.CONTEXT3D_CREATE, contextCreated );			
-			stage3D.requestContext3D( Context3DRenderMode.AUTO );
-			
-			//Compile shaders
-			vertexAssembly.assemble( Context3DProgramType.VERTEX, VERTEX_SHADER, false );
-			fragmentAssembly.assemble( Context3DProgramType.FRAGMENT, FRAGMENT_SHADER, false );			
-		}
-		
-		//Note, context3DCreate event can happen at any time, such as when the hardware resources are taken by another process
-		private function contextCreated( event:Event ):void
-		{
-			renderContext = Stage3D( event.target ).context3D;
-			trace( "3D driver: " + renderContext.driverInfo );
-
-			renderContext.enableErrorChecking = true; //Can slow rendering - only turn on when developing/testing
-			renderContext.configureBackBuffer( viewWidth, viewHeight, 2, false );
-			
-			//Create vertex index list for the triangles
-			var triangles:Vector.<uint> = Vector.<uint>( [ 0, 1, 2, 0, 3, 4 ] );
-			indexList = renderContext.createIndexBuffer( triangles.length );
-			indexList.uploadFromVector( triangles, 0, triangles.length );
-			
-			//Create vertexes
-			const dataPerVertex:int = 6;
-			var vertexData:Vector.<Number> = Vector.<Number>(
-				[
-				  // x, y, z    r, g, b format
-					 0, 0, 0,   1, 1, 1,
-					-1, 1, 0,   0, 0,.5,
-					 1, 1, 0,   0, 0, 1,
-					 1,-1, 0,  .5, 0, 0,
-					-1,-1, 0,   1, 0, 0
-				]
-			);
-			vertexes = renderContext.createVertexBuffer( vertexData.length/dataPerVertex, dataPerVertex );
-			vertexes.uploadFromVector( vertexData, 0, vertexData.length/dataPerVertex );
-			
-			//Identify vertex data inputs for vertex program
-			renderContext.setVertexBufferAt( 0, vertexes, 0, Context3DVertexBufferFormat.FLOAT_3 ); //va0 is position
-			renderContext.setVertexBufferAt( 1, vertexes, 3, Context3DVertexBufferFormat.FLOAT_3 ); //va1 is color
-			
-			//Upload programs to render context
-			programPair = renderContext.createProgram();
-			programPair.upload( vertexAssembly.agalcode, fragmentAssembly.agalcode );
-			renderContext.setProgram( programPair );
-			
-			//Clear required before first drawTriangles() call
-			renderContext.clear( .3,.3,.3 );
-			
-			
-			//Draw the 2 triangles
-			renderContext.drawTriangles( indexList, 0, 2 );
-			
-			var renderedBitmapData:BitmapData = new BitmapData( viewWidth, viewHeight, true );
-			renderContext.drawToBitmapData( renderedBitmapData );
-			
-			renderContext.present();
-			
-			//Add to stage
-			bitmap = new Bitmap( renderedBitmapData );
-			this.addChild( bitmap );
-			bitmap.x = 55;
-			bitmap.y = 25;
-			bitmap.filters = [new DropShadowFilter( 8, 235, .4 )];
-		}
-	}
-}
-
-

-
- - - - - -
drawTriangles()method 
-
-public function drawTriangles(indexBuffer:IndexBuffer3D, firstIndex:int = 0, numTriangles:int = -1):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Render the specified triangles using the current buffers and state of this Context3D object. - - -

For each triangle, the triangle vertices are processed by the vertex shader program and the - - triangle surface is processed by the pixel shader program. - - The output color from the pixel program for each pixel is drawn to the render target - - depending on the stencil operations, depth test, source and destination alpha, and the current blend mode. - - The render destination can be the main render buffer or a texture.

- - -

If culling is enabled, (with the setCulling() method), then triangles can be discarded from the - - scene before the pixel program is run. If stencil and depth testing are enabled, then output - - pixels from the pixel program can be discarded without updating the render destination. - - In addition, the pixel program can decide not to output a color for a pixel.

- - - -

The rendered triangles are not displayed in the viewport until you call the present() method. - - After each present() call, the clear() method must be called before the - - first drawTriangles() call or rendering fails.

- - - -

When enableErrorChecking is false, this function returns immediately, - - does not wait for results, and throws exceptions only if this Context3D instance has been disposed - - or there are too many draw calls. If the rendering context state is invalid - - rendering fails silently. When the enableErrorChecking property is true, - - this function returns after the triangles are drawn and throws exceptions for any drawing errors - - or invalid context state.

- - - Parameters - - - - - - - - - - - - - - - - -
indexBuffer:IndexBuffer3D — a set of vertex indices referencing the vertices to render. - -
 
firstIndex:int (default = 0) — the index of the first vertex index selected to render. Default 0. - -
 
numTriangles:int (default = -1) — the number of triangles to render. Each triangle consumes three indices. - - Pass -1 to draw all triangles in the index buffer. Default -1. - - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - - - -
 
Error — If this method is called too many times between calls to present(). - - The maximum number of calls is 32,768. - - - -

The following errors are only thrown when enableErrorChecking - - property is true:

- - - -
 
Error — Need To Clear Before Draw: If the buffer has not been cleared - - since the last present() call. - - - -
 
Error — If a valid Program3D object is not set. - - - -
 
Error — No Valid Index Buffer Set: If an IndexBuffer3D object is not set. - - - -
 
Error — Sanity Check On Parameters Failed: when the number of triangles to be drawn or the - - firstIndex exceed allowed values. - - - -
 
RangeError — Not Enough Indices In This Buffer: when there aren't enough indices in the buffer to - - define the number of triangles to be drawn. - - - -
 
Error — Sample Binds Texture Also Bound To Render: when the render target is a texture and that - - texture assigned to a texture input of the current fragment program. - - - -
 
Error — Sample Binds Invalid Texture: an invalid texture is specified as the input to the current - - fragment program. - - - -
 
Error — Sampler Format Does Not Match Texture Format: when the texture assigned as the input - - to the current fragment program has a different format than that specified for the sampler - - register. For example, a 2D texture is assigned to a cube texture sampler. - - - -
 
Error — Sample Binds Undefined Texture: The current fragment program accesses a texture - - register that has not been set (using setTextureAt()). - - - -
 
Error — Same Texture Needs Same Sampler Params: If a texture is used for more than one - - sampler register, all of the samplers must have the same settings. For example, you cannot - - set one sampler to clamp and another to wrap. - - - -
 
Error — Texture Bound But Not Used: A texture is set as a shader input, but - - it is not used. - - - -
 
Error — Stream Is Not Used: A vertex buffer is assigned to a vertex attribute input, - - but the vertex program does not reference the corresponding register. - - - -
 
Error — Stream Is Invalid: a VertexBuffer3D object assigned to a vertex program input - - is not a valid object. - - - -
 
RangeError — Stream Does Not Have Enough Vertices: A vertex buffer supplying data for drawing - - the specified triangles does not have enough data. - - - -
 
RangeError — Stream Vertex Offset Out Of Bounds: The offset specified in a - - setVertexBufferAt() call is negative or past the end of the buffer. - - - -
 
Error — Stream Read But Not Set: A vertex attribute used by the current vertex program - - is not set (using setVertexBufferAt()). - - -
-

-See also -

-
-enableErrorChecking -
-VertexBuffer3D.upload() -
-IndexBuffer3D.upload() -
-flash.display3D.textures.Texture -
-Program3D -
-
-Example -
The following class draws two triangles to a Stage3D viewport on the stage. - The triangles share one vertex, which is located at the origin (0,0,0). - -

The triangles are defined using the vertex buffer and the index buffer. The vertex buffer - contains the position and color information for each triangle vertex. The index buffer contains - indexes into the vertex buffer. Three indexes define a triangle. For example, a triangle that - consisted of the first three points in the vertex buffer is listed as 0,1,2 in the index buffer.

- -

In this simple example, no 3D transformation is performed. Only objects within the canonical - viewing area (a 2x2x1 unit volume) can be displayed and the coordinates of the triangles are - defined to be within this area. However, when rendering a typical - 3D scene, you project the objects to be rendered from the "world" coordinate system into this - viewing area using either a perspective or orthographic projection.

-
-
-package
-{
-    import com.adobe.utils.AGALMiniAssembler;
-	
-	import flash.display.Sprite;
-	import flash.display.Stage3D;
-	import flash.display3D.Context3D;
-	import flash.display3D.Context3DProgramType;
-	import flash.display3D.Context3DRenderMode;
-	import flash.display3D.Context3DVertexBufferFormat;
-	import flash.display3D.IndexBuffer3D;
-	import flash.display3D.Program3D;
-	import flash.display3D.VertexBuffer3D;
-	import flash.events.Event;
-	
-	public class Context3D_drawTriangles extends Sprite
-	{
-		public const viewWidth:Number = 320;
-		public const viewHeight:Number = 200;
-		
-		private var stage3D:Stage3D;
-		private var renderContext:Context3D;
-		private var indexList:IndexBuffer3D;
-		private var vertexes:VertexBuffer3D;
-		
-		private const VERTEX_SHADER:String =
-			"mov op, va0	\n" +	//copy position to output 
-			"mov v0, va1"; //copy color to varying variable v0
-		
-		private const FRAGMENT_SHADER:String = 
-			"mov oc, v0"; //Set the output color to the value interpolated from the three triangle vertices 
-
-		private var vertexAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var fragmentAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var programPair:Program3D;
-		
-		public function Context3D_drawTriangles()
-		{
-			stage3D = this.stage.stage3Ds[0];
-			stage3D.x = 10;
-			stage3D.y = 10;
-
-			//Add event listener before requesting the context
-			stage3D.addEventListener( Event.CONTEXT3D_CREATE, contextCreated );			
-			stage3D.requestContext3D( Context3DRenderMode.AUTO );
-			
-			//Compile shaders
-			vertexAssembly.assemble( Context3DProgramType.VERTEX, VERTEX_SHADER, false );
-			fragmentAssembly.assemble( Context3DProgramType.FRAGMENT, FRAGMENT_SHADER, false );			
-		}
-		
-		//Note, context3DCreate event can happen at any time, such as when the hardware resources are taken by another process
-		private function contextCreated( event:Event ):void
-		{
-			renderContext = Stage3D( event.target ).context3D;
-			trace( "3D driver: " + renderContext.driverInfo );
-
-			renderContext.enableErrorChecking = true; //Can slow rendering - only turn on when developing/testing
-			renderContext.configureBackBuffer( viewWidth, viewHeight, 2, false );
-			
-			//Create vertex index list for the triangles
-			var triangles:Vector.<uint> = Vector.<uint>( [ 0, 1, 2, 0, 3, 4 ] );
-			indexList = renderContext.createIndexBuffer( triangles.length );
-			indexList.uploadFromVector( triangles, 0, triangles.length );
-			
-			//Create vertexes
-			const dataPerVertex:int = 6;
-			var vertexData:Vector.<Number> = Vector.<Number>(
-				[
-				  // x, y, z    r, g, b format
-					 0, 0, 0,   1, 1, 1,
-					-1, 1, 0,   0, 0,.5,
-					 1, 1, 0,   0, 0, 1,
-					 1,-1, 0,  .5, 0, 0,
-					-1,-1, 0,   1, 0, 0
-				]
-			);
-			vertexes = renderContext.createVertexBuffer( vertexData.length/dataPerVertex, dataPerVertex );
-			vertexes.uploadFromVector( vertexData, 0, vertexData.length/dataPerVertex );
-			
-			//Identify vertex data inputs for vertex program
-			renderContext.setVertexBufferAt( 0, vertexes, 0, Context3DVertexBufferFormat.FLOAT_3 ); //va0 is position
-			renderContext.setVertexBufferAt( 1, vertexes, 3, Context3DVertexBufferFormat.FLOAT_3 ); //va1 is color
-			
-			//Upload programs to render context
-			programPair = renderContext.createProgram();
-			programPair.upload( vertexAssembly.agalcode, fragmentAssembly.agalcode );
-			renderContext.setProgram( programPair );
-			
-			//Clear required before first drawTriangles() call
-			renderContext.clear( .3,.3,.3 );
-			
-			//Draw the 2 triangles
-			renderContext.drawTriangles( indexList, 0, 2 );
-			
-			//Show the frame
-			renderContext.present();
-		}
-	}
-}
-
-

-
- - - - - -
drawTrianglesInstanced()method 
-
-public function drawTrianglesInstanced(indexBuffer:IndexBuffer3D, numInstances:int, firstIndex:int = 0, numTriangles:int = -1):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 20.0 - -
-

- - Render the specified instanced triangles using the current buffers and state of this Context3D object. - - -

For each triangle of each instance, the triangle vertices are processed by the vertex shader program and the - - triangle surface is processed by the pixel shader program. - - The output color from the pixel program for each pixel is drawn to the render target - - depending on the stencil operations, depth test, source and destination alpha, and the current blend mode. - - The render destination can be the main render buffer or a texture.

- - -

If culling is enabled, (with the setCulling() method), then triangles can be discarded from the - - scene before the pixel program is run. If stencil and depth testing are enabled, then output - - pixels from the pixel program can be discarded without updating the render destination. - - In addition, the pixel program can decide not to output a color for a pixel.

- - - -

The rendered instanced traingles are not displayed in the viewport until you call the present() method. - - After each present() call, the clear() method must be called before the - - first drawTrianglesInstanced() call or rendering fails.

- - - -

When enableErrorChecking is false, this function returns immediately, - - does not wait for results, and throws exceptions only if this Context3D instance has been disposed - - or there are too many draw calls. If the rendering context state is invalid - - rendering fails silently. When the enableErrorChecking property is true, - - this function returns after the triangles are drawn and throws exceptions for any drawing errors - - or invalid context state.

- - - -

This method may throw an exception if the instanced buffer is improperly sequenced with SetVertexAt(). - - With Direct 3D 9, for example, the indexed geometry data and the number of instances - - to draw must always be set in stream zero with SetStreamSourceFreq() API.

- - - -

This means that the vertex buffer created using CreateVertexBufferForInstance() should not be placed - - with the minimal index number when arranged with SetVertexBufferAt() as input to the vertex shader program. - - The vertex buffer generated using CreateVertexBuffer() must be placed with a smaller index number than that - - for CreateVertexBufferForInstance(). In general, the geometry data must be placed before per-instance data, - - with SetVertexBufferAt().

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
indexBuffer:IndexBuffer3D — a set of vertex indices referencing the vertices to render. - -
 
numInstances:int — number of instances to render. - -
 
firstIndex:int (default = 0) — the index of the first vertex index selected to render. Default 0. - -
 
numTriangles:int (default = -1) — the number of triangles to render. Each triangle consumes three indices. - - Pass -1 to draw all triangles in the index buffer. Default -1. - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - - - -
 
Error — If this method is called too many times between calls to present(). - - The maximum number of calls is 32,768. - - -
 
Error — Requires Standard Extended Profile Or Above: if this method is called when the requested profile is - - less than standard extended profile. - - -
 
Error — If this method is called with negative numInstances. - - - -

The following errors are only thrown when enableErrorChecking - - property is true:

- - - -
 
Error — Need To Clear Before Draw: If the buffer has not been cleared - - since the last present() call. - - - -
 
Error — If a valid Program3D object is not set. - - - -
 
Error — No Valid Index Buffer Set: If an IndexBuffer3D object is not set. - - - -
 
Error — Sanity Check On Parameters Failed: when the number of triangles to be drawn or the - - firstIndex exceed allowed values. - - - -
 
RangeError — Not Enough Indices In This Buffer: when there aren't enough indices in the buffer to - - define the number of triangles to be drawn. - - - -
 
Error — Sample Binds Texture Also Bound To Render: when the render target is a texture and that - - texture assigned to a texture input of the current fragment program. - - - -
 
Error — Sample Binds Invalid Texture: an invalid texture is specified as the input to the current - - fragment program. - - - -
 
Error — Sampler Format Does Not Match Texture Format: when the texture assigned as the input - - to the current fragment program has a different format than that specified for the sampler - - register. For example, a 2D texture is assigned to a cube texture sampler. - - - -
 
Error — Sample Binds Undefined Texture: The current fragment program accesses a texture - - register that has not been set (using setTextureAt()). - - - -
 
Error — Same Texture Needs Same Sampler Params: If a texture is used for more than one - - sampler register, all of the samplers must have the same settings. For example, you cannot - - set one sampler to clamp and another to wrap. - - - -
 
Error — Texture Bound But Not Used: A texture is set as a shader input, but - - it is not used. - - - -
 
Error — Stream Is Not Used: A vertex buffer is assigned to a vertex attribute input, - - but the vertex program does not reference the corresponding register. - - - -
 
Error — Stream Is Invalid: a VertexBuffer3D object assigned to a vertex program input - - is not a valid object. - - - -
 
RangeError — Stream Does Not Have Enough Vertices: A vertex buffer supplying data for drawing - - the specified triangles does not have enough data. - - - -
 
RangeError — Stream Vertex Offset Out Of Bounds: The offset specified in a - - setVertexBufferAt() call is negative or past the end of the buffer. - - - -
 
Error — Stream Read But Not Set: A vertex attribute used by the current vertex program - - is not set (using setVertexBufferAt()). - - -
 
Error — Vertex Buffer Stream Does Not Contain Enough Elements For Instances: If a vertex buffer stream - - does not contain enough elements for number of instances. - - -
 
Error — Vertex Buffer Stream For Instances Is Improperly Set With The Minimal Index Attribute Register: If the vertex - - buffer generated using CreateVertexBuffer() is given a larger index number than that for the vertex buffer generated - - using CreateVertexBufferForInstance(). - - -
-

-See also -

-
-enableErrorChecking -
-VertexBuffer3D.upload() -
-IndexBuffer3D.upload() -
-flash.display3D.textures.Texture -
-Program3D -
-
-Example -
The following class draws three triangles using the feature instanced drawing - using a single draw call instead of multiple draw calls. -
-
-package
-{
-    import com.adobe.utils.v3.AGALMiniAssembler;
-	
-	import flash.display.Sprite;
-	import flash.display.Stage3D;
-	import flash.display.StageAlign;
-	import flash.display.StageScaleMode;
-	import flash.display3D.Context3D;
-	import flash.display3D.Context3DProgramType;
-	import flash.display3D.Context3DTriangleFace;
-	import flash.display3D.Context3DVertexBufferFormat;
-	import flash.display3D.IndexBuffer3D;
-	import flash.display3D.Program3D;
-	import flash.display3D.VertexBuffer3D;
-	import flash.events.Event;
-	import flash.geom.Matrix3D;
-	import flash.utils.ByteArray;
-	
-	public class Context3D_HelloInstancedDrawing extends Sprite
-	{
-		private var W:int;
-		private var H:int;
-		
-		private var renderContext:Context3D;
-		private var program:Program3D;
-		private var vertexBuffer:VertexBuffer3D;
-		private var instanceBufferColor:VertexBuffer3D;
-		private var instanceBufferTranslation:VertexBuffer3D;
-		private var indexBuffer:IndexBuffer3D;
-		private var m:Matrix3D;
-		private var vertexShader:ByteArray;
-		private var fragmentShader:ByteArray;
-		
-		public function Context3D_HelloInstancedDrawing()
-		{
-			if (hasEventListener(Event.ADDED_TO_STAGE))
-				removeEventListener(Event.ADDED_TO_STAGE, init);
-			W = stage.stageWidth;
-			H = stage.stageHeight;
-			stage.scaleMode = StageScaleMode.NO_SCALE;
-			stage.align = StageAlign.TOP_LEFT;
-			stage.stage3Ds[0].addEventListener(Event.CONTEXT3D_CREATE, contextCreated);
-			//We need to request context3D in standard extended profile as instanced drawing requires standard extended profile.
-			stage.stage3Ds[0].requestContext3D("auto","standardExtended");			
-			
-		}
-		
-		//Note: <code>context3DCreate</code> event can happen at any time. For example, when the hardware resources are taken up by another process.
-		private function contextCreated( event:Event ):void
-		{
-			var t:Stage3D = event.target as Stage3D;
-			renderContext = t.context3D;
-			trace( "3D driver: " + renderContext.driverInfo );
-			setupScene();
-		}
-		
-		
-		private function setupScene():void
-		{
-			renderContext.enableErrorChecking = true;
-			renderContext.configureBackBuffer( W, H, 2, false );
-			renderContext.setCulling( Context3DTriangleFace.BACK );
-			
-			//create vertex buffer for geometry information of the instances (same geometry of the instances)
-			vertexBuffer = renderContext.createVertexBuffer(3, 3);
-			
-			//The color and translation information varies across the instances. Use <code>createVertexBufferForInstances</code> for color and translation information.
-			//the intancesPerElement parameter used is 1 which means that each instance will use unique element of the instances buffer
-			//if the intancesPerElement is 3 then sets of 3 instances will use the same element of the instances buffer
-			instanceBufferColor = renderContext.createVertexBufferForInstances(4,3,1);
-			instanceBufferTranslation = renderContext.createVertexBufferForInstances(4,3,1);
-			//create index buffer for the triangle
-			indexBuffer = renderContext.createIndexBuffer(3);
-			
-			//create and compile program
-			program = renderContext.createProgram();
-			var assembler:AGALMiniAssembler = new AGALMiniAssembler();
-			
-			// VERTEX SHADER
-			var code:String = "";
-			//The vertex shader code runs for every vertex of each instance.
-			//The vertex buffers uploaded for instance data (va1,va2) are used when the vertex shader for that particular instance is being executed.
-			code += "add vt0, va0, va2\n";
-			code += "mov op, vt0\n";
-			code += "mov v0, va1\n";
-			
-			vertexShader = assembler.assemble(Context3DProgramType.VERTEX, code);
-			
-			//FRAGMENT SHADER
-			code = "mov oc, v0\n"; 
-			
-			// Compile the agal code into bytecode using agalminiassembler
-			fragmentShader = assembler.assemble(Context3DProgramType.FRAGMENT, code);
-			
-			//upload program to gpu
-			program.upload(vertexShader, fragmentShader);
-			
-			//geometry data for the instances
-			var vertexData:Vector.<Number>=Vector.<Number>([
-				-0.3, -0.3, 0, 	// - 1st vertex x,y,z
-				0, 0.3, 1, 	    // - 2nd vertex x,y,z 
-				0.3, -0.3, 0    // - 3rd vertex x,y,z
-			]);
-			
-			//per instance color data
-			var instanceColorData:Vector.<Number>=Vector.<Number>([
-				1.0, 0.0, 0.0, 	// - 1st instance r,g,b
-				0.0, 1.0, 0.0,  // - 2nd instance r,g,b
-				1.0, 1.0, 1.0,	// - 3rd instance r,g,b
-				0.7, 0.0, 1.0   // - 4th instance r,g,b
-			]);
-			//per instance translation data
-			var instanceTranslationData:Vector.<Number>=Vector.<Number>([
-				-0.3, -0.3, 0.0, 	// - 1st instance x,y,z
-				0.3, 0.3, 0.0, 		// - 2nd instance x,y,z
-				-0.3, 0.3, 0.0,	    // - 3rd instance x,y,z
-				0.3, -0.3, 0.0      // - 4th instance x,y,z
-			]);
-			
-			vertexBuffer.uploadFromVector(vertexData, 0, 3);
-			instanceBufferColor.uploadFromVector(instanceColorData, 0, 4);
-			indexBuffer.uploadFromVector(Vector.<uint>([0, 1, 2]), 0, 3);
-			instanceBufferTranslation.uploadFromVector(instanceTranslationData, 0, 4);
-			
-			//pass data to program
-			renderContext.setVertexBufferAt(0, vertexBuffer, 0, Context3DVertexBufferFormat.FLOAT_3);
-			renderContext.setVertexBufferAt(1, instanceBufferColor, 0, Context3DVertexBufferFormat.FLOAT_3);
-			renderContext.setVertexBufferAt(2, instanceBufferTranslation, 0, Context3DVertexBufferFormat.FLOAT_3);
-			
-			//set active program
-			renderContext.setProgram(program);
-			renderContext.enableErrorChecking = true;
-			addEventListener(Event.ENTER_FRAME, render);
-			
-		}
-		
-		private function render( event:Event ):void
-		{
-			renderContext.clear(0.3, 0.2, 1, 1); // Clear the backbuffer by filling it with the given color
-			//Draw three instances of the same geometry but with varying instance data specified using <code>vertexBufferForInstances</code>.
-			renderContext.drawTrianglesInstanced(indexBuffer,4);
-			renderContext.present(); // render the backbuffer on screen.
-		}	
-	}
-}
-
-

The following class draws three triangles using the feature instanced drawing - using a single draw call instead of multiple draw calls. -
-
-package
-{
-    import com.adobe.utils.v3.AGALMiniAssembler;
-	
-	import flash.display.Sprite;
-	import flash.display.Stage3D;
-	import flash.display.StageAlign;
-	import flash.display.StageScaleMode;
-	import flash.display3D.Context3D;
-	import flash.display3D.Context3DProgramType;
-	import flash.display3D.Context3DTriangleFace;
-	import flash.display3D.Context3DVertexBufferFormat;
-	import flash.display3D.IndexBuffer3D;
-	import flash.display3D.Program3D;
-	import flash.display3D.VertexBuffer3D;
-	import flash.events.Event;
-	import flash.geom.Matrix3D;
-	import flash.utils.ByteArray;
-	
-	public class Context3D_HelloInstanceIdRegister extends Sprite
-	{
-		private var W:int;
-		private var H:int;
-		
-		private var renderContext:Context3D;
-		private var program:Program3D;
-		private var vertexBuffer:VertexBuffer3D;
-		private var instanceBufferColor:VertexBuffer3D;
-		private var instanceBufferTranslation:VertexBuffer3D;
-		private var indexBuffer:IndexBuffer3D;
-		private var m:Matrix3D;
-		private var vertexShader:ByteArray;
-		private var fragmentShader:ByteArray;
-		
-		public function Context3D_HelloInstanceIdRegister()
-		{
-			if (hasEventListener(Event.ADDED_TO_STAGE))
-				removeEventListener(Event.ADDED_TO_STAGE, init);
-			W = stage.stageWidth;
-			H = stage.stageHeight;
-			stage.scaleMode = StageScaleMode.NO_SCALE;
-			stage.align = StageAlign.TOP_LEFT;
-			stage.stage3Ds[0].addEventListener(Event.CONTEXT3D_CREATE, contextCreated);
-			//We need to request context3D in standard extended profile as instanced drawing requires standard extended profile.
-			stage.stage3Ds[0].requestContext3D("auto","standardExtended");			
-			
-		}
-		
-		//Note: <code>context3DCreate</code> event can happen at any time. For example, when the hardware resources are taken up by another process.
-		private function contextCreated( event:Event ):void
-		{
-			var t:Stage3D = event.target as Stage3D;
-			renderContext = t.context3D;
-			trace( "3D driver: " + renderContext.driverInfo );
-			setupScene();
-		}
-		
-		
-		private function setupScene():void
-		{
-			renderContext.enableErrorChecking = true;
-			renderContext.configureBackBuffer( W, H, 2, false );
-			renderContext.setCulling( Context3DTriangleFace.BACK );
-			
-			//create vertex buffer for geometry information of the instances (same geometry of the instances)
-			vertexBuffer = renderContext.createVertexBuffer(3, 3);
-			
-			//The color and translation information varies across the instances. Use <code>createVertexBufferForInstances</code> for color and translation information.
-			//the intancesPerElement parameter used is 1 which means that each instance will use unique element of the instances buffer
-			//if the intancesPerElement is 3 then sets of 3 instances will use the same element of the instances buffer
-			instanceBufferColor = renderContext.createVertexBufferForInstances(4,3,1);
-			instanceBufferTranslation = renderContext.createVertexBufferForInstances(4,3,1);
-			//create index buffer for the triangle
-			indexBuffer = renderContext.createIndexBuffer(3);
-			
-			//create and compile program
-			program = renderContext.createProgram();
-			//Note : for instance id support , use the latest AgalMiniAssembler from github - https://github.com/adobe-flash/graphicscorelib/blob/master/src/com/adobe/utils/v3/AGALMiniAssembler.as
-			var assembler:AGALMiniAssembler = new AGALMiniAssembler();
-			
-			// VERTEX SHADER
-			var code:String = "";
-			//the vertex shader code will run for every vertex of every instance , 
-			//the vertex buffers uploaded for instance data (va1,va2) will be used when vertex shader for that particular instance is being executed 
-			//the vertex shader code below indexes the program constants matrix using iid.x. iid is a new register introduced in vertex shader for instanced drawing
-			//it is a read only register , iid.x gives the current instance id whose shader is being executed
-			code += "add vt0, va0, va2\n";
-			code += "mul vt1, vt0, vc[iid.x]\n"
-			code += "mov op, vt1\n";
-			code += "mov v0, va1\n";
-			
-			vertexShader = assembler.assemble(Context3DProgramType.VERTEX, code, 3);
-			
-			//FRAGMENT SHADER
-			code = "mov oc, v0\n"; 
-			
-			// Compile the agal code into bytecode using agalminiassembler
-			fragmentShader = assembler.assemble(Context3DProgramType.FRAGMENT, code, 3);
-			
-			//upload program to gpu
-			program.upload(vertexShader, fragmentShader);
-			
-			//geometry data for the instances
-			var vertexData:Vector.<Number>=Vector.<Number>([
-				-0.3, -0.3, 0, 	// - 1st vertex x,y,z
-				0, 0.3, 1, 	    // - 2nd vertex x,y,z 
-				0.3, -0.3, 0    // - 3rd vertex x,y,z
-			]);
-			
-			//per instance color data
-			var instanceColorData:Vector.<Number>=Vector.<Number>([
-				1.0, 0.0, 0.0, 	// - 1st instance r,g,b
-				0.0, 1.0, 0.0,  // - 2nd instance r,g,b
-				1.0, 1.0, 1.0,	// - 3rd instance r,g,b
-				0.7, 0.0, 1.0   // - 4th instance r,g,b
-			]);
-			//per instance translation data
-			var instanceTranslationData:Vector.<Number>=Vector.<Number>([
-				-0.3, -0.3, 0.0, 	// - 1st instance x,y,z
-				0.3, 0.3, 0.0, 		// - 2nd instance x,y,z
-				-0.3, 0.3, 0.0,	    // - 3rd instance x,y,z
-				0.3, -0.3, 0.0      // - 4th instance x,y,z
-			]);
-			
-			vertexBuffer.uploadFromVector(vertexData, 0, 3);
-			instanceBufferColor.uploadFromVector(instanceColorData, 0, 4);
-			indexBuffer.uploadFromVector(Vector.<uint>([0, 1, 2]), 0, 3);
-			instanceBufferTranslation.uploadFromVector(instanceTranslationData, 0, 4);
-			
-			//pass data to program
-			renderContext.setVertexBufferAt(0, vertexBuffer, 0, Context3DVertexBufferFormat.FLOAT_3);
-			renderContext.setVertexBufferAt(1, instanceBufferColor, 0, Context3DVertexBufferFormat.FLOAT_3);
-			renderContext.setVertexBufferAt(2, instanceBufferTranslation, 0, Context3DVertexBufferFormat.FLOAT_3);
-			
-			//set active program
-			renderContext.setProgram(program);
-			renderContext.enableErrorChecking = true;
-			addEventListener(Event.ENTER_FRAME, render);
-			
-		}
-		
-		private function render( event:Event ):void
-		{
-			renderContext.clear(0.3, 0.2, 1, 1); // Clear the backbuffer by filling it with the given color
-			var instanceScalingData:Vector.<Number>=Vector.<Number>([
-				1.0, 1.0, 1.0, 1.0, 	// - 1st instance x,y,z,w
-				1.4, 1.4, 1.4, 1.0,		// - 2nd instance x,y,z,w
-				0.6, 0.6, 0.6, 1.0,		// - 3rd instance x,y,z,w
-				0.6, 0.6, 0.6, 1.0
-			]);
-			var m:Matrix3D = new Matrix3D();
-			m.copyRawDataFrom(instanceScalingData);
-			renderContext.setProgramConstantsFromMatrix("vertex",0,m,false);
-			
-			//Draw three instances of the same geometry but with varying instance data specified using <code>vertexBufferForInstances</code>.
-			renderContext.drawTrianglesInstanced(indexBuffer,4);
-			renderContext.present(); // render the backbuffer on screen.
-		}	
-	}
-}
-
-

-
- - - - - -
present()method 
-
-public function present():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Displays the back rendering buffer. - - - -

Calling the present() method makes the results of all - - rendering operations since the last present() call visible and starts a new rendering cycle. - - After calling present, you must call clear() before making another - - drawTriangles() call. Otherwise, this function will alternately clear the render buffer - - to yellow and green or, if enableErrorChecking has been set to true, - - an exception is thrown.

- - -

Calling present() also resets the render target, just like calling - - setRenderToBackBuffer().

- - -
-Throws - - - - - - - - - - -
Error — Need To Clear Before Draw: If the clear() has not been called since - - the previous call to present(). (Two consecutive present() calls are not allowed - - without calling clear() in between.) - - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - - -
-
- - - - - -
setBlendFactors()method 
-
-public function setBlendFactors(sourceFactor:String, destinationFactor:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Specifies the factors used to blend the output color of a drawing operation with the existing color. - - -

The output (source) color of the pixel shader program is combined with the existing (destination) color at that pixel - - according to the following formula:

- -

result color = (source color * sourceFactor) + (destination color * destinationFactor)

- -

The destination color is the current color in the render buffer for that pixel. Thus it is the result of the most recent - - clear() call and any intervening drawTriangles() calls.

- - - -

Use setBlendFactors() to set the factors used to multiply the source and destination colors before they are added together. - - The default blend factors are, sourceFactor = Context3DBlendFactor.ONE, and destinationFactor = Context3DBlendFactor.ZERO, which - - results in the source color overwriting the destination color (in other words, no blending of the two colors occurs). For normal - - alpha blending, use sourceFactor = Context3DBlendFactor.SOURCE_ALPHA and destinationFactor = Context3DBlendFactor.ONE_MINUS_SOURCE_ALPHA. - -

- - -

Use the constants defined in the Context3DBlendFactor class to set the parameters of this function.

- - - - Parameters - - - - - - - - - - -
sourceFactor:String — The factor with which to multiply the source color. Defaults to Context3DBlendFactor.ONE. - -
 
destinationFactor:String — The factor with which to multiply the destination color. Defaults to Context3DBlendFactor.ZERO. - - -
-
-Throws - - - - -
Error — Invalid Enum: when sourceFactor or destinationFactor - - is not one of the recognized values, which are defined in the Context3DBlendFactor class. - - - -
-

-See also -

-
-Context3DBlendFactor -
-
-Example -
The following class illustrates the various blend factors. The - example draws four different colored rectangles to the render buffer. This - set of rectangles is the blend "destination." Next, the source and destination - blend modes are set and a larger rectangle, the blend "source," is drawn. - Use the keys "1" and "2" to - cycle through the source blend modes. Use the "3" and "4" keys to - cycle through the destination blend modes. -
-
-package
-{
-    import com.adobe.utils.AGALMiniAssembler;
-	
-	import flash.display.Sprite;
-	import flash.display.Stage3D;
-	import flash.display3D.Context3D;
-	import flash.display3D.Context3DBlendFactor;
-	import flash.display3D.Context3DProgramType;
-	import flash.display3D.Context3DRenderMode;
-	import flash.display3D.Context3DVertexBufferFormat;
-	import flash.display3D.IndexBuffer3D;
-	import flash.display3D.Program3D;
-	import flash.display3D.VertexBuffer3D;
-	import flash.events.ErrorEvent;
-	import flash.events.Event;
-	import flash.events.KeyboardEvent;
-	import flash.ui.Keyboard;
-	
-	public class Context3D_setBlendMode extends Sprite
-	{
-		public const viewWidth:Number = 320;
-		public const viewHeight:Number = 200;
-		
-		private var stage3D:Stage3D;
-		private var renderContext:Context3D;
-		private var indexList:IndexBuffer3D;
-		private var vertexes:VertexBuffer3D;
-		
-		private const VERTEX_SHADER:String =
-			"mov op, va0	\n" +	//copy position to output 
-			"mov v0, va1"; //copy color to varying variable v0
-		
-		private const FRAGMENT_SHADER:String = 
-			"mov oc, v0"; //Set the output color to the value interpolated from the three triangle vertices 
-
-		private var vertexAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var fragmentAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var programPair:Program3D;
-		
-		private var sourceFactor:int = 6;
-		private var destinationFactor:int = 4;
-		private var blendFactors:Array = [Context3DBlendFactor.DESTINATION_ALPHA,
-										  Context3DBlendFactor.DESTINATION_COLOR,
-										  Context3DBlendFactor.ONE,
-										  Context3DBlendFactor.ONE_MINUS_DESTINATION_ALPHA,
-										  Context3DBlendFactor.ONE_MINUS_SOURCE_ALPHA,
-										  Context3DBlendFactor.ONE_MINUS_SOURCE_COLOR,
-										  Context3DBlendFactor.SOURCE_ALPHA,
-										  Context3DBlendFactor.SOURCE_COLOR,
-										  Context3DBlendFactor.ZERO];
-			
-		public function Context3D_setBlendMode()
-		{
-			this.stage.addEventListener( KeyboardEvent.KEY_DOWN, keyHandler );
-			
-			stage3D = this.stage.stage3Ds[0];
-			stage3D.x = 10;
-			stage3D.y = 10;
-
-			//Add event listener before requesting the context
-			stage3D.addEventListener( Event.CONTEXT3D_CREATE, contextCreated );
-			stage3D.addEventListener( ErrorEvent.ERROR, contextError );
-			stage3D.requestContext3D( Context3DRenderMode.AUTO );
-			
-			//Compile shaders
-			vertexAssembly.assemble( Context3DProgramType.VERTEX, VERTEX_SHADER, false );
-			fragmentAssembly.assemble( Context3DProgramType.FRAGMENT, FRAGMENT_SHADER, false );			
-		}
-		
-		//Note, context3DCreate event can happen at any time, such as when the hardware resources are taken by another process
-		private function contextCreated( event:Event ):void
-		{
-			renderContext = Stage3D( event.target ).context3D;
-			trace( "3D driver: " + renderContext.driverInfo );
-
-			renderContext.enableErrorChecking = true; //Can slow rendering - only turn on when developing/testing
-			renderContext.configureBackBuffer( viewWidth, viewHeight, 2, false );
-			
-			//Create vertex index list for the triangles
-			var triangles:Vector.<uint> = Vector.<uint>( [  0, 3 , 2, 
-															0, 1, 3,
-															6, 4, 5,
-															5, 7, 6,
-															10, 8, 9,
-															9, 11, 10,
-															12, 15, 14,
-															12, 13, 15,
-															16, 17, 19,
-															16, 19, 18
-														 ] );
-			indexList = renderContext.createIndexBuffer( triangles.length );
-			indexList.uploadFromVector( triangles, 0, triangles.length );
-			
-			//Create vertexes
-			const dataPerVertex:int = 7;
-			var vertexData:Vector.<Number> = Vector.<Number>(
-				[
-				  // x, y, z    r, g, b, a format
-					-1, 1, 0,   1, 1, 1, .5,
-					 0, 1, 0,   1, 1, 1, .5,
-					-1, 0, 0,   1, 1, 1, .5,
-					 0, 0, 0,   1, 1, 1, .5,
-					 
-					 0, 1, 0,  .8,.8,.8, .6,
-					 1, 1, 0,  .8,.8,.8, .6,
-					 0, 0, 0,  .8,.8,.8, .6,
-					 1, 0, 0,  .8,.8,.8, .6,
-					 
-					-1, 0, 0,   1, 0, 0, .5,
-					 0, 0, 0,   0, 1, 0, .5,
-					-1,-1, 0,   0, 0, 1, .5,
-					 0,-1, 0,   1, 0, 1, .5,
-					 
-					 0, 0, 0,   0, 0, 0, .5,
-					 1, 0, 0,   0, 0, 0, .5,
-					 0,-1, 0,   0, 0, 0, .5,
-					 1,-1, 0,   0, 0, 0, .5,
-					 
-				   -.8,.8, 0,  .6,.4,.2,.4,
-				    .8,.8, 0,  .6,.4,.2,.4,
-				  -.8,-.8, 0,  .6,.4,.2,.4,
-				   .8,-.8, 0,  .6,.4,.2,.4
-				]
-			);
-			vertexes = renderContext.createVertexBuffer( vertexData.length/dataPerVertex, dataPerVertex );
-			vertexes.uploadFromVector( vertexData, 0, vertexData.length/dataPerVertex );
-			
-			//Identify vertex data inputs for vertex program
-			renderContext.setVertexBufferAt( 0, vertexes, 0, Context3DVertexBufferFormat.FLOAT_3 ); //va0 is position
-			renderContext.setVertexBufferAt( 1, vertexes, 3, Context3DVertexBufferFormat.FLOAT_4 ); //va1 is color
-			
-			//Upload programs to render context
-			programPair = renderContext.createProgram();
-			programPair.upload( vertexAssembly.agalcode, fragmentAssembly.agalcode );
-			renderContext.setProgram( programPair );
-			
-			render();
-		}
-		
-		private function render():void
-		{
-			//Clear required before first drawTriangles() call
-			renderContext.clear( 1, 1, 1, 1 );
-			//Draw the back triangles
-			renderContext.setBlendFactors( Context3DBlendFactor.ONE, Context3DBlendFactor.ZERO ); //No blending
-			renderContext.drawTriangles( indexList, 0, 8 );
-
-			//Set blend
-			renderContext.setBlendFactors( blendFactors[sourceFactor], blendFactors[destinationFactor] );
-			
-			//Draw the front triangles
-			renderContext.drawTriangles( indexList, 24, 2 );
-			
-			//Show the frame
-			renderContext.present();
-		}
-		
-		private function contextError( error:ErrorEvent ):void
-		{
-			trace( error.errorID + ": " + error.text );
-		}
-		
-		private function keyHandler( event:KeyboardEvent ):void
-		{
-			switch ( event.keyCode )
-			{
-				case Keyboard.NUMBER_1:
-					if( --sourceFactor < 0 ) sourceFactor = blendFactors.length - 1; 
-					break;
-				case Keyboard.NUMBER_2:
-					if( ++sourceFactor > blendFactors.length - 1) sourceFactor = 0;
-					break;
-				case Keyboard.NUMBER_3:
-					if( --destinationFactor < 0 ) destinationFactor = blendFactors.length - 1; 
-					break;
-				case Keyboard.NUMBER_4:
-					if( ++destinationFactor > blendFactors.length - 1) destinationFactor = 0;
-					break;
-			}
-			trace( "Source blend factor: " + blendFactors[sourceFactor] + ", destination blend factor: " + blendFactors[destinationFactor] );
-			render();
-		}
-	}
-}
-
-

-
- - - - - -
setColorMask()method 
-
-public function setColorMask(red:Boolean, green:Boolean, blue:Boolean, alpha:Boolean):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets the mask used when writing colors to the render buffer. - - -

Only color components for which the corresponding color mask parameter is true are updated - - when a color is written to the render buffer. For example, if you call: - - setColorMask( true, false, false, false ), only the red component of a color is written to the - - buffer until you change the color mask again. The color mask does not affect the behavior of the - - clear() method.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
red:Boolean — set false to block changes to the red channel. - -
 
green:Boolean — set false to block changes to the green channel. - -
 
blue:Boolean — set false to block changes to the blue channel. - -
 
alpha:Boolean — set false to block changes to the alpha channel. - - - -
-
-Example -
The following example illustrates the effect of setting the color mask. The - example draws two triangles that are the same color. The top triangle is drawn before - the mask is set and so is rendered as white. The bottom triangle is drawn after - all the channels except the red channel are masked. Since only the red channel can be updated, - the white triangle is rendered as red. -
-
-package
-{
-    import com.adobe.utils.AGALMiniAssembler;
-	
-	import flash.display.Sprite;
-	import flash.display.Stage3D;
-	import flash.display3D.Context3D;
-	import flash.display3D.Context3DProgramType;
-	import flash.display3D.Context3DRenderMode;
-	import flash.display3D.Context3DVertexBufferFormat;
-	import flash.display3D.IndexBuffer3D;
-	import flash.display3D.Program3D;
-	import flash.display3D.VertexBuffer3D;
-	import flash.events.Event;
-	
-	public class Context3D_setColorMask extends Sprite
-	{
-		public const viewWidth:Number = 320;
-		public const viewHeight:Number = 200;
-		
-		private var stage3D:Stage3D;
-		private var renderContext:Context3D;
-		private var indexList:IndexBuffer3D;
-		private var vertexes:VertexBuffer3D;
-		
-		private const VERTEX_SHADER:String =
-			"mov op, va0	\n" +	//copy position to output 
-			"mov v0, va1"; //copy color to varying variable v0
-		
-		private const FRAGMENT_SHADER:String = 
-			"mov oc, v0"; //Set the output color to the value interpolated from the three triangle vertices 
-
-		private var vertexAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var fragmentAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var programPair:Program3D;
-		
-		public function Context3D_setColorMask()
-		{
-			stage3D = this.stage.stage3Ds[0];
-			stage3D.x = 10;
-			stage3D.y = 10;
-
-			//Add event listener before requesting the context
-			stage3D.addEventListener( Event.CONTEXT3D_CREATE, contextCreated );			
-			stage3D.requestContext3D( Context3DRenderMode.AUTO );
-			
-			//Compile shaders
-			vertexAssembly.assemble( Context3DProgramType.VERTEX, VERTEX_SHADER, false );
-			fragmentAssembly.assemble( Context3DProgramType.FRAGMENT, FRAGMENT_SHADER, false );			
-		}
-		
-		//Note, context3DCreate event can happen at any time, such as when the hardware resources are taken by another process
-		private function contextCreated( event:Event ):void
-		{
-			renderContext = Stage3D( event.target ).context3D;
-			trace( "3D driver: " + renderContext.driverInfo );
-
-			renderContext.enableErrorChecking = true; //Can slow rendering - only turn on when developing/testing
-			renderContext.configureBackBuffer( viewWidth, viewHeight, 2, false );
-			
-			//Create vertex index list for the triangles
-			var triangles:Vector.<uint> = Vector.<uint>( [ 0, 1, 2, 0, 3, 4 ] );
-			indexList = renderContext.createIndexBuffer( triangles.length );
-			indexList.uploadFromVector( triangles, 0, triangles.length );
-			
-			//Create vertexes
-			const dataPerVertex:int = 6;
-			var vertexData:Vector.<Number> = Vector.<Number>(
-				[
-				  // x, y, z    r, g, b format
-					 0, 0, 0,   1, 1, 1,
-					-1, 1, 0,   1, 1, 1,
-					 1, 1, 0,   1, 1, 1,
-					 1,-1, 0,   1, 1, 1,
-					-1,-1, 0,   1, 1, 1
-				]
-			);
-			vertexes = renderContext.createVertexBuffer( vertexData.length/dataPerVertex, dataPerVertex );
-			vertexes.uploadFromVector( vertexData, 0, vertexData.length/dataPerVertex );
-			
-			//Identify vertex data inputs for vertex program
-			renderContext.setVertexBufferAt( 0, vertexes, 0, Context3DVertexBufferFormat.FLOAT_3 ); //va0 is position
-			renderContext.setVertexBufferAt( 1, vertexes, 3, Context3DVertexBufferFormat.FLOAT_3 ); //va1 is color
-			
-			//Upload programs to render context
-			programPair = renderContext.createProgram();
-			programPair.upload( vertexAssembly.agalcode, fragmentAssembly.agalcode );
-			renderContext.setProgram( programPair );
-			
-			renderContext.clear( .3,.3,.3,1 );
-			renderContext.drawTriangles( indexList, 0, 1 ); //Top triangle draws all colors, so is white
-			renderContext.setColorMask( true, false, false, false ); //Mask all but red channel			
-			renderContext.drawTriangles( indexList, 3, 1 ); //Bottom triangle only updates red
-			
-			//Show the frame
-			renderContext.present();
-		}
-	}
-}
-
-

-
- - - - - -
setCulling()method 
-
-public function setCulling(triangleFaceToCull:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets triangle culling mode. - - -

Triangles may be excluded from the scene early in the rendering pipeline based on their orientation - - relative to the view plane. Specify vertex order consistently (clockwise or counter-clockwise) as - - seen from the outside of the model to cull correctly.

- - - Parameters - - - - -
triangleFaceToCull:String — the culling mode. Use one of the constants defined in the Context3DTriangleFace class. - - -
-
-Throws - - - - -
Error — Invalid Enum Error: when triangleFaceToCull is not one of the values - - defined in the Context3DTriangleFace class. - - - -
-

-See also -

-
-Context3DTriangleFace -
-
- - - - - -
setDepthTest()method 
-
-public function setDepthTest(depthMask:Boolean, passCompareMode:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets type of comparison used for depth testing. - - -

The depth of the source pixel output from the pixel shader program is compared to the current - - value in the depth buffer. If the comparison evaluates as false, then the source pixel - - is discarded. If true, then the source pixel is processed by the next step in - - the rendering pipeline, the stencil test. In addition, the depth buffer is updated with the depth of the source - - pixel, as long as the depthMask parameter is set to true.

- - - -

Sets the test used to compare depth values for source and destination pixels. The source - - pixel is composited with the destination pixel when the comparison is true. The comparison - - operator is applied as an infix operator between the source and destination pixel values, in - - that order.

- - - Parameters - - - - - - - - - - -
depthMask:Boolean — the destination depth value will be updated from the source pixel when true. - -
 
passCompareMode:String — the depth comparison test operation. One of the values of Context3DCompareMode. - - - -
-

-See also -

-
-Context3DCompareMode -
-
- - - - - -
setFillMode()method 
-
-public function setFillMode(fillMode:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 16 - -
-

- - Set fill mode used for render. The interface is only available in AIR desktop. - - -

Parameters - - - - -
fillMode:String — if the value is WIREFRAME, the object will be shown in a mesh of lines. - - if the value is SOLID, the object will be shown in solid shaded polygons. - - -
-

-See also -

-
-Context3DFillMode -
-
- - - - - -
setProgram()method 
-
-public function setProgram(program:Program3D):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets vertex and fragment shader programs to use for subsequent rendering. - - -

Parameters - - - - -
program:Program3D — the Program3D object representing the vertex and fragment programs to use. - - - -
-

-See also -

-
-drawTriangles() -
-Program3D -
-
-Example -
This example illustrates how to create, upload, and activate a - pair of vertex and pixel programs to a rendering context. Note that the - object, renderContext, is an instance of the Context3D class. - The programs in the example are written in Adobe Graphics Assembly Language (AGAL). -
-
-//A simple vertex program in AGAL
-const VERTEX_SHADER:String =
-    "m44 op, va0, vc0 \n" +	
-	"mov v0, va1"; 
-
-//A simple fragment (or pixel) program in AGAL		
-const FRAGMENT_SHADER:String = "mov oc, v0";  
-
-var vertexAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-var fragmentAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-var programPair:Program3D;
-
-//Compile shaders
-vertexAssembly.assemble( Context3DProgramType.VERTEX, VERTEX_SHADER, false );
-fragmentAssembly.assemble( Context3DProgramType.FRAGMENT, FRAGMENT_SHADER, false );			
-
-//Upload programs to render context
-programPair = renderContext.createProgram();
-programPair.upload( vertexAssembly.agalcode, fragmentAssembly.agalcode );
-renderContext.setProgram( programPair );
-
-

-
- - - - - -
setProgramConstantsFromByteArray()method 
-
-public function setProgramConstantsFromByteArray(programType:String, firstRegister:int, numRegisters:int, data:ByteArray, byteArrayOffset:uint):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.1 - -
-

- - Set constants for use by shader programs using values stored in a ByteArray. - - -

Sets constants that can be accessed from the vertex or fragment program.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
programType:String — one of Context3DProgramType. - -
 
firstRegister:int — the index of the first shader program constant to set. - -
 
numRegisters:int — the number of registers to set. Every register is read as four float values. - -
 
data:ByteArray — the source ByteArray object - -
 
byteArrayOffset:uint — an offset into the ByteArray for reading - -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — kNullPointerError when data is null. - -
 
RangeError — kConstantRegisterOutOfBounds when attempting to set more than the maximum number of shader constants. - -
 
RangeError — kBadInputSize if byteArrayOffset is greater than or equal to the length of data or - - no. of elements in data - byteArrayOffset is less than numRegisters*16 - - - -
-

-See also -

-
-Context3DProgramType -
-
- - - - - -
setProgramConstantsFromFloatVector()method 
-
-public function setProgramConstantsFromFloatVector(programType:String, firstRegister:int, data:Vector.<float>, numRegisters:int = -1):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Sets the constant inputs for the shader programs. - - -

Sets an array of constants to be accessed by a vertex or fragment shader program. - - Constants set in Program3D are accessed within the shader programs as constant registers. - - Each constant register is comprised of 4 floating point values (x, y, z, w). - - Therefore every register requires 4 entries in the data Vector. You can set 128 registers - - for a vertex program and 28 for a fragment program.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
programType:String — The type of shader program, either Context3DProgramType.VERTEX or - - Context3DProgramType.FRAGMENT. - -
 
firstRegister:int — the index of the first constant register to set. - -
 
data:Vector.<float> — the floating point constant values. There must be at least numRegisters 4 - - elements in data. - -
 
numRegisters:int (default = -1) — the number of constants to set. Specify -1, the default value, to set enough - - registers to use all of the available data. - - -
-
-Throws - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
RangeError — Constant Register Out Of Bounds: when attempting to set more - - than the maximum number of shader constant registers (128 for vertex programs; - - 28 for fragment programs). - - - -
-

-See also -

-
-Context3DProgramType -
-http://www.adobe.com/go/learn_as3_agal_bytecode_en -
-
- - - - - -
setProgramConstantsFromMatrix()method 
-
-public function setProgramConstantsFromMatrix(programType:String, firstRegister:int, matrix:Matrix3D, transposedMatrix:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets constants for use by shader programs using values stored in a Matrix3D. - - -

Use this function to pass a matrix to a shader program. The function sets 4 constant - - registers used by the vertex or fragment program. - - The matrix is assigned to registers row by row. The first constant register is assigned the - - top row of the matrix. You can set 128 registers for a vertex program and 28 for a - - fragment program.

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
programType:String — The type of shader program, either Context3DProgramType.VERTEX or - - Context3DProgramType.FRAGMENT. - -
 
firstRegister:int — the index of the first constant register to set. Since a Matrix3D has 16 values, - - four registers are set. - -
 
matrix:Matrix3D — the matrix containing the constant values. - -
 
transposedMatrix:Boolean (default = false) — if true the matrix entries are copied to registers in - - transposed order. The default value is false. - - - -
-
-Throws - - - - - - - - - - -
TypeError — Null Pointer Error: when matrix is null. - -
 
RangeError — Constant Register Out Of Bounds: when attempting to set more than - - the maximum number of shader constant registers. - - - -
-

-See also -

-
-Context3DProgramType -
-http://www.adobe.com/go/learn_as3_agal_bytecode_en -
-
- - - - - -
setProgramConstantsFromVector()method 
-
-public function setProgramConstantsFromVector(programType:String, firstRegister:int, data:Vector.<Number>, numRegisters:int = -1):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets the constant inputs for the shader programs. - - -

Sets an array of constants to be accessed by a vertex or fragment shader program. - - Constants set in Program3D are accessed within the shader programs as constant registers. - - Each constant register is comprised of 4 floating point values (x, y, z, w). - - Therefore every register requires 4 entries in the data Vector. The number of registers - - that you can set for vertex program and fragment program depends on the - - Context3DProfile.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
programType:String — The type of shader program, either Context3DProgramType.VERTEX or - - Context3DProgramType.FRAGMENT. - -
 
firstRegister:int — the index of the first constant register to set. - -
 
data:Vector.<Number> — the floating point constant values. There must be at least numRegisters 4 - - elements in data. - -
 
numRegisters:int (default = -1) — the number of constants to set. Specify -1, the default value, to set enough - - registers to use all of the available data. - - -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
RangeError — Constant Register Out Of Bounds: when attempting to set more - - than the maximum number of shader constant registers. - -
 
RangeError — Bad Input Size: When the number of elements in data is less - - than numRegisters*4 - - - -
-

-See also -

-
-Context3DProgramType -
-http://www.adobe.com/go/learn_as3_agal_bytecode_en -
-
- - - - - -
setRenderToBackBuffer()method 
-
-public function setRenderToBackBuffer():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets the back rendering buffer as the render target. Subsequent calls to drawTriangles() - - and clear() methods result in updates to the back buffer. Use this method to resume normal rendering - - after using the setRenderToTexture() method. - - - - -

- - - - - -
setRenderToTexture()method 
-
-public function setRenderToTexture(texture:TextureBase, enableDepthAndStencil:Boolean = false, antiAlias:int = 0, surfaceSelector:int = 0, colorOutputIndex:int = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets the specified texture as the rendering target. - - - -

Subsequent calls to drawTriangles() - - and clear() methods update the specified texture instead of the back buffer. Mip maps - - are created automatically. Use the setRenderToBackBuffer() to resume normal rendering - - to the back buffer.

- - -

No clear is needed before drawing. If there is no clear operation, the render content will be retained. - - depth buffer and stencil buffer will also not be cleared. But it is forced to clear when first drawing. - - Calling present() resets the target to the back buffer.

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
texture:TextureBase — the target texture to render into. Set to null to resume - - rendering to the back buffer (setRenderToBackBuffer() and - - present also reset the target to the back buffer). - -
 
enableDepthAndStencil:Boolean (default = false) — if true, depth and stencil testing are available. - - If false, all depth and stencil state is ignored for subsequent drawing operations. - -
 
antiAlias:int (default = 0) — the antialiasing quality. Use 0 to disable antialiasing; higher values improve - - antialiasing quality, but require more calculations. The value is currently ignored - - by mobile platform and software rendering context. - -
 
surfaceSelector:int (default = 0) — specifies which element of the texture to update. Texture objects have one surface, so you must - - specify 0, the default value. CubeTexture objects have six surfaces, so you can specify an integer from 0 through 5. - -
 
colorOutputIndex:int (default = 0) — The output color register. Must be 0 for constrained or baseline mode. Otherwise specifies the output color register. - - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — for a mismatched surfaceSelector parameter. The value must be 0 for 2D textures and 0..5 for cube maps. - -
 
ArgumentError — texture is not derived from the TextureBase class (either Texture or CubeTexture classes). - -
 
ArgumentError — colorOutputIndex must be an integer is from 0 through 3. - -
 
ArgumentError — this call requires a Context3D that is created with the standard profile or above. - - -
-

-See also -

-
-clear() -
-configureBackBuffer() -
-flash.display3D.textures.CubeTexture.uploadFromByteArray() -
-
- - - - - -
setSamplerStateAt()method 
-
-public function setSamplerStateAt(sampler:int, wrap:String, filter:String, mipfilter:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Manually override texture sampler state. - - -

Texture sampling state is typically set at the time setProgram is called. - - However, you can override texture sampler state with this function. - - If you do not want the program to change sampler state, set - - the ignoresamnpler bit in AGAL and use this function. - -

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
sampler:int — sampler The sampler register to use. Maps to the sampler register in AGAL. - -
 
wrap:String — Wrapping mode. Defined in Context3DWrapMode. The default is repeat. - -
 
filter:String — Texture filtering mode. Defined in Context3DTextureFilter. The default is nearest. - -
 
mipfilter:String — Mip map filter. Defined in Context3DMipFilter. The default is none. - - - -
-
-Throws - - - - - - - - - - - - - - - - -
Error — sampler out of range - -
 
Error — wrap, filter, mipfilter bad enum - -
 
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or - - because the underlying rendering hardware has been lost. - - -
-

-See also -

-
-Context3DWrapMode -
-Context3DTextureFilter -
-Context3DMipFilter -
-
- - - - - -
setScissorRectangle()method 
-
-public function setScissorRectangle(rectangle:Rectangle):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets a scissor rectangle, which is type of drawing mask. The renderer only draws to the area inside the - - scissor rectangle. Scissoring does not affect clear operations. - - -

Pass null to turn off scissoring.

- - - - Parameters - - - - -
rectangle:Rectangle — The rectangle in which to draw. Specify the rectangle position and dimensions in pixels. - - The coordinate system origin is the top left corner of the viewport, with positive values increasing down - - and to the right (the same as the normal Flash display coordinate system). - - - -
-
-Example -
The following class draws two triangles to a 640x480 pixel view port on the stage. - The triangles share one vertex, which is located at the origin (0,0,0). - -

The triangles are defined using the vertex buffer and the index buffer. The vertex buffer - contains the position and color information for each triangle vertex. The index buffer contains - indexes into the vertex buffer. Three indexes define a triangle. For example, a triangle that - consisted of the first three points in the vertex buffer is listed as 0,1,2 in the index buffer.

- -

In this simple example, no 3D transformation is performed. Only objects within the canonical - viewing area (a 2x2x2 cube volume centered on the origin) are displayed. However, when rendering a typical - 3D scene, you project the objects to be rendered into this viewing area using either a - perspective or orthographic projection.

-
-
-package
-{
-    import com.adobe.utils.AGALMiniAssembler;
-	
-	import flash.display.Sprite;
-	import flash.display.Stage3D;
-	import flash.display3D.Context3D;
-	import flash.display3D.Context3DBlendFactor;
-	import flash.display3D.Context3DProgramType;
-	import flash.display3D.Context3DRenderMode;
-	import flash.display3D.Context3DVertexBufferFormat;
-	import flash.display3D.IndexBuffer3D;
-	import flash.display3D.Program3D;
-	import flash.display3D.VertexBuffer3D;
-	import flash.events.Event;
-	import flash.events.KeyboardEvent;
-	import flash.events.TimerEvent;
-	import flash.geom.Rectangle;
-	import flash.ui.Keyboard;
-	import flash.utils.Timer;
-	
-	public class Context3D_ScissorRectangle extends Sprite
-	{
-		public const viewWidth:Number = 640;
-		public const viewHeight:Number = 480;
-		
-		private var stage3D:Stage3D;
-		private var renderContext:Context3D;
-		private var indexList:IndexBuffer3D;
-		private var vertexes:VertexBuffer3D;
-		
-		private const VERTEX_SHADER:String =
-			"mov op, va0	\n" +	//copy position to output 
-			"mov v0, va1"; //copy color to varying variable v0
-		
-		private const FRAGMENT_SHADER:String = 
-			"mov oc, v0"; //Set the output color to the value interpolated from the three triangle vertices 
-
-		private var vertexAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var fragmentAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var programPair:Program3D;
-		
-		private var scissorOn:Boolean = false;
-		private var toggler:Timer = new Timer( 750 );
-		
-		public function Context3D_ScissorRectangle()
-		{			
-			stage3D = this.stage.stage3Ds[0];
-			stage3D.x = 10;
-			stage3D.y = 10;
-
-			//Add event listener before requesting the context
-			stage3D.addEventListener( Event.CONTEXT3D_CREATE, contextCreated );			
-			stage3D.requestContext3D( Context3DRenderMode.AUTO );
-			
-			//Compile shaders
-			vertexAssembly.assemble( Context3DProgramType.VERTEX, VERTEX_SHADER, false );
-			fragmentAssembly.assemble( Context3DProgramType.FRAGMENT, FRAGMENT_SHADER, false );
-			
-			//Set up timer to turn scissoring on and off
-			toggler.addEventListener( TimerEvent.TIMER, toggleScissor );
-		}
-		
-		//Note, context3DCreate event can happen at any time, such as when the hardware resources are taken by another process
-		private function contextCreated( event:Event ):void
-		{
-			renderContext = Stage3D( event.target ).context3D;
-			trace( "3D driver: " + renderContext.driverInfo );
-
-			renderContext.enableErrorChecking = true; //Can slow rendering - only turn on when developing/testing
-			renderContext.configureBackBuffer( viewWidth, viewHeight, 2, false );
-			
-			//Create vertex index list for the triangles
-			var triangles:Vector.<uint> = Vector.<uint>( [  0, 3 , 2, 
-															0, 1, 3
-														 ] );
-			indexList = renderContext.createIndexBuffer( triangles.length );
-			indexList.uploadFromVector( triangles, 0, triangles.length );
-			
-			//Create vertexes
-			const dataPerVertex:int = 6;
-			var vertexData:Vector.<Number> = Vector.<Number>(
-				[
-				  // x, y, z    r, g, b, a format 
-				   -1, 1, 0,  1,0,0,
-				    1, 1, 0,  0,0,1,
-				   -1,-1, 0,  0,1,0,
-				    1,-1, 0,  1,0,1
-				]
-			);
-			vertexes = renderContext.createVertexBuffer( vertexData.length/dataPerVertex, dataPerVertex );
-			vertexes.uploadFromVector( vertexData, 0, vertexData.length/dataPerVertex );
-			
-			//Identify vertex data inputs for vertex program
-			renderContext.setVertexBufferAt( 0, vertexes, 0, Context3DVertexBufferFormat.FLOAT_3 ); //va0 is position
-			renderContext.setVertexBufferAt( 1, vertexes, 3, Context3DVertexBufferFormat.FLOAT_3 ); //va1 is color
-			
-			//Upload programs to render context
-			programPair = renderContext.createProgram();
-			programPair.upload( vertexAssembly.agalcode, fragmentAssembly.agalcode );
-			renderContext.setProgram( programPair );
-			
-			render();
-			toggler.start();
-		}
-		
-		private function render():void
-		{
-			//Clear required before first drawTriangles() call
-			renderContext.clear();
-
-			//Sciss a region excluding the outer 100 pixels of the viewport
-			var scissor:Rectangle = new Rectangle( 100, 100, viewWidth - 200, viewHeight - 200 );
-			if( scissorOn )	renderContext.setScissorRectangle( scissor ); //on
-			else renderContext.setScissorRectangle( null ); //off
-
-			//Draw the triangles
-			renderContext.drawTriangles( indexList, 0, 2 );
-			
-			//Show the frame
-			renderContext.present();
-		}
-		
-		private function toggleScissor( event:Event ):void
-		{
-			scissorOn = !scissorOn;
-			render();
-		}
-		
-	}
-}
-
-

-
- - - - - -
setStencilActions()method 
-
-public function setStencilActions(triangleFace:String = "frontAndBack", compareMode:String = "always", actionOnBothPass:String = "keep", actionOnDepthFail:String = "keep", actionOnDepthPassStencilFail:String = "keep"):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets stencil mode and operation. - - -

An 8-bit stencil reference value can be associated with each draw call. - - During rendering, the reference value can be tested against values stored previously - - in the frame buffer. The result of the test can control the draw action and - - whether or how the stored stencil value is updated. In addition, depth testing - - controls whether stencil testing is performed. A failed depth test can - - also be used to control the action taken on the stencil buffer.

- - - -

In the pixel processing pipeline, depth testing is performed first. - - If the depth test fails, a stencil buffer update action can be taken, - - but no further evaluation of the stencil buffer value can be made. If the - - depth test passes, then the stencil test is performed. Alternate actions - - can be taken depending on the outcome of the stencil test.

- - -

The stencil reference value is set using setStencilReferenceValue().

- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
triangleFace:String (default = "frontAndBack") — the triangle orientations allowed to contribute to the stencil operation. One of Context3DTriangleFace. - -
 
compareMode:String (default = "always") — the test operator used to compare the current stencil reference value and the destination pixel stencil value. Destination - - pixel color and depth update is performed when the comparison is true. The stencil actions are performed as requested in the following action - - parameters. The comparison operator is applied as an infix operator between the current and destination reference values, in - - that order (in pseudocode: if stencilReference OPERATOR stencilBuffer then pass). Use one of the constants defined in the - - Context3DCompareMode class. - -
 
actionOnBothPass:String (default = "keep") — action to be taken when both depth and stencil comparisons pass. Use one of the constants defined in the - - Context3DStencilAction class. - -
 
actionOnDepthFail:String (default = "keep") — action to be taken when depth comparison fails. Use one of the constants defined in the Context3DStencilAction class. - -
 
actionOnDepthPassStencilFail:String (default = "keep") — action to be taken when depth comparison passes and the stencil comparison fails. Use one of the constants - - defined in the Context3DStencilAction class. - - -
-
-Throws - - - - - - - - - - - - - - - - -
Error — Invalid Enum Error: when triangleFace is not one of the values defined in the Context3DTriangleFace class. - -
 
Error — Invalid Enum Error: when compareMode is not one of the values defined in the Context3DCompareMode class. - -
 
Error — Invalid Enum Error: when actionOnBothPass, actionOnDepthFail, or actionOnDepthPassStencilFail - - is not one of the values defined in the Context3DStencilAction class. - - - -
-

-See also -

-
-Context3DTriangleFace -
-Context3DCompareMode -
-Context3DStencilAction -
-setStencilReferenceValue() -
-
-Example -
The following class illustrates how to draw a stencil and use - it as a mask for subsequent drawing operations. The example performs the following steps: -
    -
  • Clear stencil buffer to 0.
    • -
  • Set stencil action to increment when the stencil test passes.
    • -
  • Set the stencil reference value to 0.
    • -
  • Draw the triangular mask. Wherever the triangle is drawn, the stencil - test passes because the stencil buffer has been cleared to 0 and the - reference value is 0. As a result, the stencil buffer is incremented to - 1 where the triangle mask is drawn.
    • -
  • Change the stencil action to keep so that subsequent draw operations do not change the stencil buffer.
    • -
  • Draw a full screen rectangle (multicolored). Because the stencil reference value is still 0, the stencil test fails - in the masked area. Thus, the rectangle draws everywhere except in the masked region.
    • -
  • Change the stencil reference value to 1.
    • -
  • Draw another full screen rectangle (red). Now the stencil test fails everywhere except the masked area, - which was incremented to 1. Thus the rectangle only draws in the masked region.
    • -
-

Mouse over the example to see the main steps in sequence.

-
-
-package
-{
-    import com.adobe.utils.AGALMiniAssembler;
-	
-	import flash.display.Sprite;
-	import flash.display.Stage3D;
-	import flash.display.StageAlign;
-	import flash.display.StageScaleMode;
-	import flash.display3D.Context3D;
-	import flash.display3D.Context3DBlendFactor;
-	import flash.display3D.Context3DCompareMode;
-	import flash.display3D.Context3DProgramType;
-	import flash.display3D.Context3DRenderMode;
-	import flash.display3D.Context3DStencilAction;
-	import flash.display3D.Context3DTriangleFace;
-	import flash.display3D.Context3DVertexBufferFormat;
-	import flash.display3D.IndexBuffer3D;
-	import flash.display3D.Program3D;
-	import flash.display3D.VertexBuffer3D;
-	import flash.events.Event;
-	import flash.events.KeyboardEvent;
-	import flash.events.MouseEvent;
-	import flash.events.TimerEvent;
-	import flash.geom.Rectangle;
-	import flash.text.TextField;
-	import flash.text.TextFormat;
-	import flash.ui.Keyboard;
-	import flash.utils.Timer;
-	
-	public class Context3D_Stencil extends Sprite
-	{
-		public const viewWidth:Number = 350;
-		public const viewHeight:Number = 240;
-		
-		private var stage3D:Stage3D;
-		private var renderContext:Context3D;
-		private var indexList:IndexBuffer3D;
-		private var vertexes:VertexBuffer3D;
-		
-		private const VERTEX_SHADER:String =
-			"mov op, va0	\n" +	//copy position to output 
-			"mov v0, va1"; //copy color to varying variable v0
-		
-		private const FRAGMENT_SHADER:String = 
-			"mov oc, v0"; //Set the output color to the value interpolated from the three triangle vertices 
-
-		private var vertexAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var fragmentAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var programPair:Program3D;
-				
-		public function Context3D_Stencil()
-		{			
-			stage3D = this.stage.stage3Ds[0];
-			stage3D.x = 10;
-			stage3D.y = 10;
-
-			//Add event listener before requesting the context
-			stage3D.addEventListener( Event.CONTEXT3D_CREATE, contextCreated );			
-			stage3D.requestContext3D( Context3DRenderMode.AUTO );
-			
-			//Compile shaders
-			vertexAssembly.assemble( Context3DProgramType.VERTEX, VERTEX_SHADER, false );
-			fragmentAssembly.assemble( Context3DProgramType.FRAGMENT, FRAGMENT_SHADER, false );
-		
-			non3DSetup();
-		}
-		
-		//Note, context3DCreate event can happen at any time, such as when the hardware resources are taken by another process
-		private function contextCreated( event:Event ):void
-		{
-			renderContext = Stage3D( event.target ).context3D;
-			trace( "3D driver: " + renderContext.driverInfo );
-
-			renderContext.enableErrorChecking = true; //Can slow rendering - only turn on when developing/testing
-			renderContext.configureBackBuffer( viewWidth, viewHeight, 2, true );
-			
-			//Create vertex index list for the triangles
-			var triangles:Vector.<uint> = Vector.<uint>( [  0, 3, 2, 
-															0, 1, 3,
-															4, 7, 6,
-															4, 5, 7,
-															8, 9, 10
-														 ] );
-			indexList = renderContext.createIndexBuffer( triangles.length );
-			indexList.uploadFromVector( triangles, 0, triangles.length );
-			
-			//Create vertexes
-			const dataPerVertex:int = 6;
-			var vertexData:Vector.<Number> = Vector.<Number>(
-				[
-				  //x, y, z  r,g,b format 
-				   -1, 1, 0,  1,0,0,
-				    1, 1, 0,  0,0,1,
-				   -1,-1, 0,  0,1,0,
-				    1,-1, 0,  1,0,1,
-
-				   -1, 1, 0,  .5,0,0,
-					1, 1, 0,  .5,0,0,
-				   -1,-1, 0,  .5,0,0,
-					1,-1, 0,  .5,0,0,
-					
-					0, .7,.1, 0,0,0,
-				  -.7,-.7,.1, 0,0,0,
-				   .7,-.7,.1, 0,0,0
-				]);
-			vertexes = renderContext.createVertexBuffer( vertexData.length/dataPerVertex, dataPerVertex );
-			vertexes.uploadFromVector( vertexData, 0, vertexData.length/dataPerVertex );
-			
-			//Identify vertex data inputs for vertex program
-			renderContext.setVertexBufferAt( 0, vertexes, 0, Context3DVertexBufferFormat.FLOAT_3 ); //va0 is position
-			renderContext.setVertexBufferAt( 1, vertexes, 3, Context3DVertexBufferFormat.FLOAT_3 ); //va1 is color
-			
-			//Upload programs to render context
-			programPair = renderContext.createProgram();
-			programPair.upload( vertexAssembly.agalcode, fragmentAssembly.agalcode );
-			renderContext.setProgram( programPair );
-			render();
-		}
-		private function render():void
-		{
-			//Clear, setting stencil to 0
-			renderContext.clear( .3, .3, .3, 1, 1, 0 );
-			
-			//Draw stencil, incrementing the stencil buffer value
-			renderContext.setStencilReferenceValue( 0 );
-			renderContext.setStencilActions( Context3DTriangleFace.FRONT_AND_BACK, 
-				Context3DCompareMode.EQUAL, Context3DStencilAction.INCREMENT_SATURATE );			
-			if( state > 0 ) renderContext.drawTriangles( indexList, 12, 1 );
-
-			//Change stencil action when stencil passes so stencil buffer is not changed
-			renderContext.setStencilActions( Context3DTriangleFace.FRONT_AND_BACK, 
-				Context3DCompareMode.EQUAL, Context3DStencilAction.KEEP );
-			
-			//Draw quad -- doesn't draw where stencil has already drawn
-			if( state > 1 ) renderContext.drawTriangles( indexList, 0, 2 );
-			
-			//Change the reference to 1 so this quad only draws into stenciled area
-			renderContext.setStencilReferenceValue( 1 );
-			if( state > 2 ) renderContext.drawTriangles( indexList, 6, 2 );
-			
-			//Show the frame
-			renderContext.present();
-		}
-		
-		//The rest of the code is for the example UI and timer 
-		private function doState( event:TimerEvent ):void
-		{
-			switch (state)
-			{
-				case 0:
-					description.text = "Draw triangle with stencil action == increment";
-					state = 1;
-					break;
-				case 1:
-					description.text = "Draw the first plane where stencil == 0";
-					state = 2;
-					break;
-				case 2:
-					description.text = "Draw second plane where stencil == 1";
-					state = 3;
-					break;
-				case 3:
-					description.text = "Clear, setting stencil to 0";
-					state = 0;
-					break;
-
-				default:
-					description.text = "";
-					state = 0;		
-			}
-			render();
-		}
-
-		private var state:int = 3;
-		private var stateTimer:Timer = new Timer( 1250 );
-		private var description:TextField = new TextField();
-		
-		private function non3DSetup():void
-		{
-			//Setup timer to animate the stages of drawing the scene
-			stateTimer.addEventListener( TimerEvent.TIMER, doState );
-			this.stage.addEventListener( MouseEvent.MOUSE_OVER, function(event:Event):void{stateTimer.start()} );
-			this.stage.addEventListener( MouseEvent.MOUSE_OUT, function(event:Event):void{stateTimer.stop()} );
-			
-			description.height = 30;
-			description.width = viewWidth;
-			this.addChild( description );
-			description.y = viewHeight + 15;
-			description.defaultTextFormat = new TextFormat( null, 18, 0xffffff );
-			description.text = "Mouse over to view.";
-			
-			//Allows mouse-over events
-			var coverSprite:Sprite = new Sprite();
-			coverSprite.graphics.beginFill( 0, .01 )
-			coverSprite.graphics.lineTo( stage.stageWidth, 0 );
-			coverSprite.graphics.lineTo( stage.stageWidth, stage.stageHeight );
-			coverSprite.graphics.lineTo( 0, stage.stageHeight );
-			coverSprite.graphics.lineTo( 0, 0 );
-			this.addChild( coverSprite );			
-		}
-	}
-}
-
-

-
- - - - - -
setStencilReferenceValue()method 
-
-public function setStencilReferenceValue(referenceValue:uint, readMask:uint = 255, writeMask:uint = 255):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Sets the stencil comparison value used for stencil tests. - - - -

Only the lower 8 bits of the reference value are used. The stencil buffer value is also 8 bits in length. - - Use the readMask and writeMask to use the stencil buffer as a bit field.

- - - Parameters - - - - - - - - - - - - - - - - -
referenceValue:uint — an 8-bit reference value used in reference value comparison tests. - -
 
readMask:uint (default = 255) — an 8-bit mask for applied to both the current stencil buffer value and the reference value before the comparison. - -
 
writeMask:uint (default = 255) — an 8-bit mask applied to the reference value before updating the stencil buffer. - - - -
-

-See also -

-
-setStencilActions() -
-
- - - - - -
setTextureAt()method 
-
-public function setTextureAt(sampler:int, texture:TextureBase):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Specifies the texture to use for a texture input register of a fragment program. - - - -

A fragment program can read information from up to eight texture objects. - - Use this function to assign a Texture or CubeTexture object to one - - of the sampler registers used by the fragment program.

- - - -

Note: if you change the active fragment program (with setProgram) - - to a shader that uses fewer textures, set the unused registers to null:

- - 
-
-         setTextureAt( 7, null );
-
-
- - - Parameters - - - - - - - - - - -
sampler:int — the sampler register index, a value from 0 through 7. - -
 
texture:TextureBase — the texture object to make available, either a Texture or a CubeTexture instance. - - - -
-

-See also -

-
Texture
CubeTexture
-http://www.adobe.com/go/learn_as3_agal_bytecode_en -
-
- - - - - -
setVertexBufferAt()method 
-
-public function setVertexBufferAt(index:int, buffer:VertexBuffer3D, bufferOffset:int = 0, format:String = "float4"):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Specifies which vertex data components correspond to a single vertex shader program input. - - -

Use the setVertexBufferAt method to identify which components of the data - - defined for each vertex in a VertexBuffer3D buffer belong to which inputs to the vertex program. The - - developer of the vertex program determines how much data is needed per vertex. That data is mapped from 1 or more - - VertexBuffer3D stream(s) to the attribute registers of the vertex shader program.

- - - -

The smallest unit of data consumed by the vertex shader is a 32-bit data. Offsets into the vertex stream - - are specified in multiples of 32-bits.

- - - As an example, a programmer might define each vertex with the following data: - -
-
-position:  x    float32
-
-           y    float32
-
-           z    float32
-
-color:     r    unsigned byte
-
-           g    unsigned byte
-
-           b    unsigned byte
-
-           a    unsigned byte
-
-
- - Assuming the vertex was defined in a VertexBuffer3D object named buffer, it would be assigned to a - - vertex shader with the following code: - -
-
-setVertexBufferAt( 0, buffer, 0, Context3DVertexBufferFormat.FLOAT_3 );   // attribute #0 will contain the position information
-
-setVertexBufferAt( 1, buffer, 3, Context3DVertexBufferFormat.BYTES_4 );    // attribute #1 will contain the color information
-
-
- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
index:int — the index of the attribute register in the vertex shader (0 through 7). - -
 
buffer:VertexBuffer3D — the buffer that contains the source vertex data to be fed to the vertex shader. - -
 
bufferOffset:int (default = 0) — an offset from the start of the data for a single vertex at which to start - - reading this attribute. In the example above, the position data has an offset of 0 because it is the - - first attribute; color has an offset of 3 because the color attribute follows the three 32-bit position values. - - The offset is specified in units of 32 bits. - -
 
format:String (default = "float4") — a value from the Context3DVertexBufferFormat class specifying the data type of this attribute. - - -
-
-Throws - - - - - - - - - - -
Error — Invalid Enum: when format is not one of the values defined in the - - Context3DVertexBufferFormat class. - -
 
RangeError — Attribute Register Out Of Bounds: when the index parameter - - is outside the range from 0 through 7. (A maximum of eight vertex attribute registers can be used by a shader.) - - - -
-

-See also -

-
-Context3DVertexBufferFormat -
-Program3D.upload() -
-http://www.adobe.com/go/learn_as3_agal_bytecode_en -
-
- -
Examples
-
examples\Context3DExample
-
The following class draws a rotating cube using a perspective projection. -
-
-package
-{
-    import com.adobe.utils.AGALMiniAssembler;
-	import com.adobe.utils.PerspectiveMatrix3D;
-	
-	import flash.display.Sprite;
-	import flash.display.Stage3D;
-	import flash.display.StageAlign;
-	import flash.display.StageScaleMode;
-	import flash.display3D.Context3D;
-	import flash.display3D.Context3DProgramType;
-	import flash.display3D.Context3DRenderMode;
-	import flash.display3D.Context3DTriangleFace;
-	import flash.display3D.Context3DVertexBufferFormat;
-	import flash.display3D.IndexBuffer3D;
-	import flash.display3D.Program3D;
-	import flash.display3D.VertexBuffer3D;
-	import flash.events.ErrorEvent;
-	import flash.events.Event;
-	import flash.geom.Matrix3D;
-	import flash.geom.Vector3D;
-	
-	public class Context3DExample extends Sprite
-	{
-		public const viewWidth:Number = 320;
-		public const viewHeight:Number = 200;
-		public const zNear:Number = 1;
-		public const zFar:Number = 500;
-		
-		public const fov:Number = 45;
-		
-		private var stage3D:Stage3D;
-		private var renderContext:Context3D;
-		private var indexList:IndexBuffer3D;
-		private var vertexes:VertexBuffer3D;
-		
-		private var projection:PerspectiveMatrix3D = new PerspectiveMatrix3D();
-		private var model:Matrix3D = new Matrix3D();
-		private var view:Matrix3D = new Matrix3D();
-		private var finalTransform:Matrix3D = new Matrix3D();
-		
-		//For rotating the cube
-		private const pivot:Vector3D = new Vector3D();
-		
-		private const VERTEX_SHADER:String =
-			"m44 op, va0, vc0	\n" +	// 4x4 matrix transform 
-			"mov v0, va1"; //copy color to varying variable v0
-		
-		private const FRAGMENT_SHADER:String = 
-			"mov oc, v0"; //Set the output color to the value interpolated from the three triangle vertices 
-
-		private var vertexAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var fragmentAssembly:AGALMiniAssembler = new AGALMiniAssembler();
-		private var programPair:Program3D;
-		
-		public function Context3DExample()
-		{
-			this.stage.scaleMode = StageScaleMode.NO_SCALE;
-			this.stage.align = StageAlign.TOP_LEFT;
-			this.stage.nativeWindow.activate(); //AIR only
-			 			
-			stage3D = this.stage.stage3Ds[0];
-			stage3D.x = 10;
-			stage3D.y = 10;
-
-			//Add event listener before requesting the context
-			stage3D.addEventListener( Event.CONTEXT3D_CREATE, contextCreated );
-			stage3D.addEventListener( ErrorEvent.ERROR, contextCreationError );
-			stage3D.requestContext3D( Context3DRenderMode.AUTO );
-			
-			//Compile shaders
-			vertexAssembly.assemble( Context3DProgramType.VERTEX, VERTEX_SHADER, false );
-			fragmentAssembly.assemble( Context3DProgramType.FRAGMENT, FRAGMENT_SHADER, false );			
-		}
-		
-		//Note, context3DCreate event can happen at any time, such as when the hardware resources are taken by another process
-		private function contextCreated( event:Event ):void
-		{
-				renderContext = Stage3D( event.target ).context3D;
-				trace( "3D driver: " + renderContext.driverInfo );
-				setupScene();
-		}
-		
-		private function setupScene():void
-		{
-			renderContext.enableErrorChecking = true; //Can slow rendering - only turn on when developing/testing
-			renderContext.configureBackBuffer( viewWidth, viewHeight, 2, false );
-			renderContext.setCulling( Context3DTriangleFace.BACK );
-			
-			//Create vertex index list for the triangles forming a cube
-			var triangles:Vector.<uint> = Vector.<uint>( [ 
-				2,1,0, //front face
-				3,2,0,
-				4,7,5, //bottom face
-				7,6,5,
-				8,11,9, //back face
-				9,11,10,
-				12,15,13, //top face
-				13,15,14,
-				16,19,17, //left face
-				17,19,18,
-				20,23,21, //right face
-				21,23,22
-			] );
-			indexList = renderContext.createIndexBuffer( triangles.length );
-			indexList.uploadFromVector( triangles, 0, triangles.length );
-			
-			//Create vertexes - cube faces do not share vertexes
-			const dataPerVertex:int = 6;
-			var vertexData:Vector.<Number> = Vector.<Number>(
-				[
-					// x,y,z r,g,b format
-					0,0,0, 1,0,0, //front face
-					0,1,0, 1,0,0,
-					1,1,0, 1,0,0,
-					1,0,0, 1,0,0,
-					
-					0,0,0, 0,1,0, //bottom face
-					1,0,0, 0,1,0,
-					1,0,1, 0,1,0,
-					0,0,1, 0,1,0,
-					
-					0,0,1, 1,0,0, //back face
-					1,0,1, 1,0,0,
-					1,1,1, 1,0,0,
-					0,1,1, 1,0,0,
-					
-					0,1,1, 0,1,0, //top face
-					1,1,1, 0,1,0,
-					1,1,0, 0,1,0,
-					0,1,0, 0,1,0,
-					
-					0,1,1, 0,0,1, //left face
-					0,1,0, 0,0,1,
-					0,0,0, 0,0,1,
-					0,0,1, 0,0,1,
-					
-					1,1,0, 0,0,1, //right face
-					1,1,1, 0,0,1,
-					1,0,1, 0,0,1,
-					1,0,0, 0,0,1
-				]
-			);
-			vertexes = renderContext.createVertexBuffer( vertexData.length/dataPerVertex, dataPerVertex );
-			vertexes.uploadFromVector( vertexData, 0, vertexData.length/dataPerVertex );
-			
-			//Identify vertex data inputs for vertex program
-			renderContext.setVertexBufferAt( 0, vertexes, 0, Context3DVertexBufferFormat.FLOAT_3 ); //va0 is position
-			renderContext.setVertexBufferAt( 1, vertexes, 3, Context3DVertexBufferFormat.FLOAT_3 ); //va1 is color
-			
-			//Upload programs to render context
-			programPair = renderContext.createProgram();
-			programPair.upload( vertexAssembly.agalcode, fragmentAssembly.agalcode );
-			renderContext.setProgram( programPair );
-			
-			//Set up 3D transforms
-			projection.perspectiveFieldOfViewRH( fov, viewWidth/viewHeight, zNear, zFar );			
-			view.appendTranslation( 0, 0, -2 );	//Move view back
-			model.appendTranslation( -.5, -.5, -.5 ); //center cube on origin
-			this.stage.addEventListener( Event.ENTER_FRAME, render );
-		}
-		
-		private function render( event:Event ):void
-		{
-			//Rotate model on each frame
-			model.appendRotation( .5, Vector3D.Z_AXIS, pivot );
-			model.appendRotation( .5, Vector3D.Y_AXIS, pivot );
-			model.appendRotation( .5, Vector3D.X_AXIS, pivot );
-			
-			//Combine transforms
-			finalTransform.identity();
-			finalTransform.append( model );
-			finalTransform.append( view );
-			finalTransform.append( projection );
-			
-			//Pass the final transform to the vertex shader as program constant, vc0
-			renderContext.setProgramConstantsFromMatrix( Context3DProgramType.VERTEX, 0, finalTransform, true );
-			
-			//Clear is required before drawTriangles on each frame
-			renderContext.clear( .3,.3,.3 );
-			
-			//Draw the 12 triangles that make up the cube
-			renderContext.drawTriangles( indexList, 0, 12 );
-			
-			//Show the frame
-			renderContext.present();
-		}
-		
-		private function contextCreationError( error:ErrorEvent ):void
-		{
-			trace( error.errorID + ": " + error.text );
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DBlendFactor.html b/html-docs/flash/display3D/Context3DBlendFactor.html deleted file mode 100644 index c89c1ef..0000000 --- a/html-docs/flash/display3D/Context3DBlendFactor.html +++ /dev/null @@ -1,550 +0,0 @@ - - - - - - - - -flash.display3D.Context3DBlendFactor (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DBlendFactor
InheritanceContext3DBlendFactor Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- Defines the values to use for specifying the source and destination blend factors. - -

A blend factor represents a particular four-value vector that is multiplied with the source or destination - color in the blending formula. The blending formula is:

-

result = source * sourceFactor + destination * destinationFactor

-

In the formuls, the source color is the output color of the pixel shader program. The destination color is the color that currently - exists in the color buffer, as set by previous clear and draw operations.

-

For example, if the source color is (.6, .6, .6, .4) and the source blend factor is Context3DBlendFactor.ONE_MINUS_SOURCE_ALPHA, - then the source part of the blending equation is calculated as:

-

(.6, .6, .6, .4) * (1-0.4, 1-0.4, 1-0.4, 1-0.4) = (.36, .36, .36, .24)

-

The final calculation is clamped to the range [0,1].

- -

Examples

-

The following examples demonstrate the blending math using source color = (.6,.4,.2,.4), - destination color = (.8,.8,.8,.5), and various blend factors.

- - - - - - - -
PurposeSource factorDestination factorBlend formulaResult
No blendingONEZERO (.6,.4,.2,.4) * ( 1, 1, 1, 1) + (.8,.8,.8,.5) * ( 0, 0, 0, 0)( .6, .4, .2, .4)
AlphaSOURCE_ALPHAONE_MINUS_SOURCE_ALPHA(.6,.4,.2,.4) * (.4,.4,.4,.4) + (.8,.8,.8,.5) * (.6,.6,.6,.6)(.72,.64,.56,.46)
AdditiveONEONE (.6,.4,.2,.4) * ( 1, 1, 1, 1) + (.8,.8,.8,.5) * ( 1, 1, 1, 1)( 1, 1, 1, .9)
MultiplyDESTINATION_COLORZERO (.6,.4,.2,.4) * (.8,.8,.8,.5) + (.8,.8,.8,.5) * ( 0, 0, 0, 0)(.48,.32,.16, .2)
ScreenONEONE_MINUS_SOURCE_COLOR (.6,.4,.2,.4) * ( 1, 1, 1, 1) + (.8,.8,.8,.5) * (.4,.6,.8,.6)(.92,.88,.68, .7)
- -

Note that not all combinations of blend factors are useful and that you can sometimes achieve the same effect in different ways.

- -

-

-See also -

-
-Context3D.setBlendFactors() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  DESTINATION_ALPHA : String = "destinationAlpha"
[static] - The blend factor is (Da,Da,Da,Da), where Da is - the alpha component of the fragment color computed by the pixel program.
-		Context3DBlendFactor
  DESTINATION_COLOR : String = "destinationColor"
[static] - The blend factor is (Dr,Dg,Db,Da), where Dr/g/b/a is - the corresponding component of the current color in the color buffer.
-		Context3DBlendFactor
  ONE : String = "one"
[static] - The blend factor is (1,1,1,1).
-		Context3DBlendFactor
  ONE_MINUS_DESTINATION_ALPHA : String = "oneMinusDestinationAlpha"
[static] - The blend factor is (1-Da,1-Da,1-Da,1-Da), where Da is - the alpha component of the current color in the color buffer.
-		Context3DBlendFactor
  ONE_MINUS_DESTINATION_COLOR : String = "oneMinusDestinationColor"
[static] - The blend factor is (1-Dr,1-Dg,1-Db,1-Da), where Dr/g/b/a is - the corresponding component of the current color in the color buffer.
-		Context3DBlendFactor
  ONE_MINUS_SOURCE_ALPHA : String = "oneMinusSourceAlpha"
[static] - The blend factor is (1-Sa,1-Sa,1-Sa,1-Sa), where Sa is - the alpha component of the fragment color computed by the pixel program.
-		Context3DBlendFactor
  ONE_MINUS_SOURCE_COLOR : String = "oneMinusSourceColor"
[static] - The blend factor is (1-Sr,1-Sg,1-Sb,1-Sa), where Sr/g/b/a is - the corresponding component of the fragment color computed by the pixel program.
-		Context3DBlendFactor
  SOURCE_ALPHA : String = "sourceAlpha"
[static] - The blend factor is (Sa,Sa,Sa,Sa), where Sa is - the alpha component of the fragment color computed by the pixel program.
-		Context3DBlendFactor
  SOURCE_COLOR : String = "sourceColor"
[static] - The blend factor is (Sr,Sg,Sb,Sa), where Sr/g/b/a is - the corresponding component of the fragment color computed by the pixel program.
-		Context3DBlendFactor
  ZERO : String = "zero"
[static] - The blend factor is (0,0,0,0).
-		Context3DBlendFactor
-
- -
- -
Constant detail
- - - - - -
DESTINATION_ALPHAconstant
-
-public static const DESTINATION_ALPHA:String = "destinationAlpha" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The blend factor is (Da,Da,Da,Da), where Da is - the alpha component of the fragment color computed by the pixel program. - -

- - - - - -
DESTINATION_COLORconstant 
-
-public static const DESTINATION_COLOR:String = "destinationColor" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The blend factor is (Dr,Dg,Db,Da), where Dr/g/b/a is - the corresponding component of the current color in the color buffer. - -

- - - - - -
ONEconstant 
-
-public static const ONE:String = "one" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The blend factor is (1,1,1,1). -

- - - - - -
ONE_MINUS_DESTINATION_ALPHAconstant 
-
-public static const ONE_MINUS_DESTINATION_ALPHA:String = "oneMinusDestinationAlpha" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The blend factor is (1-Da,1-Da,1-Da,1-Da), where Da is - the alpha component of the current color in the color buffer. - -

- - - - - -
ONE_MINUS_DESTINATION_COLORconstant 
-
-public static const ONE_MINUS_DESTINATION_COLOR:String = "oneMinusDestinationColor" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The blend factor is (1-Dr,1-Dg,1-Db,1-Da), where Dr/g/b/a is - the corresponding component of the current color in the color buffer. - -

- - - - - -
ONE_MINUS_SOURCE_ALPHAconstant 
-
-public static const ONE_MINUS_SOURCE_ALPHA:String = "oneMinusSourceAlpha" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The blend factor is (1-Sa,1-Sa,1-Sa,1-Sa), where Sa is - the alpha component of the fragment color computed by the pixel program. - -

- - - - - -
ONE_MINUS_SOURCE_COLORconstant 
-
-public static const ONE_MINUS_SOURCE_COLOR:String = "oneMinusSourceColor" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The blend factor is (1-Sr,1-Sg,1-Sb,1-Sa), where Sr/g/b/a is - the corresponding component of the fragment color computed by the pixel program. - -

- - - - - -
SOURCE_ALPHAconstant 
-
-public static const SOURCE_ALPHA:String = "sourceAlpha" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The blend factor is (Sa,Sa,Sa,Sa), where Sa is - the alpha component of the fragment color computed by the pixel program. - -

- - - - - -
SOURCE_COLORconstant 
-
-public static const SOURCE_COLOR:String = "sourceColor" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The blend factor is (Sr,Sg,Sb,Sa), where Sr/g/b/a is - the corresponding component of the fragment color computed by the pixel program. - -

- - - - - -
ZEROconstant 
-
-public static const ZERO:String = "zero" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The blend factor is (0,0,0,0). - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DBufferUsage.html b/html-docs/flash/display3D/Context3DBufferUsage.html deleted file mode 100644 index 3c498a6..0000000 --- a/html-docs/flash/display3D/Context3DBufferUsage.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - - - - -flash.display3D.Context3DBufferUsage (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DBufferUsage
InheritanceContext3DBufferUsage Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 4 -
-

-

- Defines the values to use for specifying the buffer usage type. - -

-

-See also -

-
and flash.display.Context3D.createVextexBuffer()
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  DYNAMIC_DRAW : String = "dynamicDraw"
[static] - Indicates the buffer will be used for drawing and be updated frequently - -
-		Context3DBufferUsage
  STATIC_DRAW : String = "staticDraw"
[static] - Indicates the buffer will be used for drawing and be updated once - -

This type is the default value for buffers in Stage3D.

- -
-		Context3DBufferUsage
-
- -
- -
Constant detail
- - - - - -
DYNAMIC_DRAWconstant
-
-public static const DYNAMIC_DRAW:String = "dynamicDraw" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 4 -
-

- Indicates the buffer will be used for drawing and be updated frequently - -

- - - - - -
STATIC_DRAWconstant 
-
-public static const STATIC_DRAW:String = "staticDraw" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 4 -
-

- Indicates the buffer will be used for drawing and be updated once - -

This type is the default value for buffers in Stage3D.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DClearMask.html b/html-docs/flash/display3D/Context3DClearMask.html deleted file mode 100644 index 0a3a79a..0000000 --- a/html-docs/flash/display3D/Context3DClearMask.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - - - -flash.display3D.Context3DClearMask (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DClearMask
InheritanceContext3DClearMask Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- Defines the values to use for specifying Context3D clear masks. -

-

-See also -

-
-Context3D.clear() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  ALL : int -
[static] - Clear all buffers.
-		Context3DClearMask
  COLOR : int -
[static] - Clear only the color buffer.
-		Context3DClearMask
  DEPTH : int -
[static] - Clear only the depth buffer.
-		Context3DClearMask
  STENCIL : int -
[static] - Clear only the stencil buffer.
-		Context3DClearMask
-
- -
- -
Constant detail
- - - - - -
ALLconstant
-
-public static const ALL:int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Clear all buffers. - -

- - - - - -
COLORconstant 
-
-public static const COLOR:int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Clear only the color buffer. - -

- - - - - -
DEPTHconstant 
-
-public static const DEPTH:int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Clear only the depth buffer. - -

- - - - - -
STENCILconstant 
-
-public static const STENCIL:int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Clear only the stencil buffer. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DCompareMode.html b/html-docs/flash/display3D/Context3DCompareMode.html deleted file mode 100644 index 9f75c5b..0000000 --- a/html-docs/flash/display3D/Context3DCompareMode.html +++ /dev/null @@ -1,450 +0,0 @@ - - - - - - - - -flash.display3D.Context3DCompareMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DCompareMode
InheritanceContext3DCompareMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- Defines the values to use for specifying 3D buffer comparisons in the setDepthTest() and setStencilAction() methods - of a Context3D instance. -

-

-See also -

-
-Context3D.setDepthTest() -
-Context3D.setStencilActions() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ALWAYS : String = "always"
[static] - The comparison always evaluates as true.
-		Context3DCompareMode
  EQUAL : String = "equal"
[static] - Equal (==).
-		Context3DCompareMode
  GREATER : String = "greater"
[static] - Greater than (>).
-		Context3DCompareMode
  GREATER_EQUAL : String = "greaterEqual"
[static] - Greater than or equal (>=).
-		Context3DCompareMode
  LESS : String = "less"
[static] - Less than (<).
-		Context3DCompareMode
  LESS_EQUAL : String = "lessEqual"
[static] - Less than or equal (<=).
-		Context3DCompareMode
  NEVER : String = "never"
[static] - The comparison never evaluates as true.
-		Context3DCompareMode
  NOT_EQUAL : String = "notEqual"
[static] - Not equal (!=).
-		Context3DCompareMode
-
- -
- -
Constant detail
- - - - - -
ALWAYSconstant
-
-public static const ALWAYS:String = "always" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The comparison always evaluates as true. -

- - - - - -
EQUALconstant 
-
-public static const EQUAL:String = "equal" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Equal (==). -

- - - - - -
GREATERconstant 
-
-public static const GREATER:String = "greater" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Greater than (>). -

- - - - - -
GREATER_EQUALconstant 
-
-public static const GREATER_EQUAL:String = "greaterEqual" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Greater than or equal (>=). -

- - - - - -
LESSconstant 
-
-public static const LESS:String = "less" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Less than (<). - -

- - - - - -
LESS_EQUALconstant 
-
-public static const LESS_EQUAL:String = "lessEqual" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Less than or equal (<=). - -

- - - - - -
NEVERconstant 
-
-public static const NEVER:String = "never" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The comparison never evaluates as true. - -

- - - - - -
NOT_EQUALconstant 
-
-public static const NOT_EQUAL:String = "notEqual" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Not equal (!=). -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DFillMode.html b/html-docs/flash/display3D/Context3DFillMode.html deleted file mode 100644 index 1c19869..0000000 --- a/html-docs/flash/display3D/Context3DFillMode.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - - - -flash.display3D.Context3DFillMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DFillMode
InheritanceContext3DFillMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 16 -
-

-

- Defines the values to use for specifying 3D render fill mode in the setFillMode() methods - of a Context3D instance. -

-

-See also -

-
-Context3D.setFillMode() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  SOLID : String = "solid"
[static] - The fill mode is solid mode.
-		Context3DFillMode
  WIREFRAME : String = "wireframe"
[static] - The fill mode is wireframe mode.
-		Context3DFillMode
-
- -
- -
Constant detail
- - - - - -
SOLIDconstant
-
-public static const SOLID:String = "solid" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 16 -
-

- The fill mode is solid mode. - -

- - - - - -
WIREFRAMEconstant 
-
-public static const WIREFRAME:String = "wireframe" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 16 -
-

- The fill mode is wireframe mode. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DMipFilter.html b/html-docs/flash/display3D/Context3DMipFilter.html deleted file mode 100644 index 84d63c1..0000000 --- a/html-docs/flash/display3D/Context3DMipFilter.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - - - -flash.display3D.Context3DMipFilter (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DMipFilter
InheritanceContext3DMipFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

-

- Defines the values to use for sampler mipmap filter mode - -

-

-See also -

-
-flash.display3D.Context3D.setSamplerStateAt() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  MIPLINEAR : String = "miplinear"
[static] - Select the two closest MIP levels and linearly blend between them - (the highest quality mode, but has some performance cost).
-		Context3DMipFilter
  MIPNEAREST : String = "mipnearest"
[static] - Use the nearest neighbor metric to select MIP levels - (the fastest rendering method).
-		Context3DMipFilter
  MIPNONE : String = "mipnone"
[static] - Always use the top level texture - (has a performance penalty when downscaling).
-		Context3DMipFilter
-
- -
- -
Constant detail
- - - - - -
MIPLINEARconstant
-
-public static const MIPLINEAR:String = "miplinear" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

- Select the two closest MIP levels and linearly blend between them - (the highest quality mode, but has some performance cost). - -

- - - - - -
MIPNEARESTconstant 
-
-public static const MIPNEAREST:String = "mipnearest" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

- Use the nearest neighbor metric to select MIP levels - (the fastest rendering method). - -

- - - - - -
MIPNONEconstant 
-
-public static const MIPNONE:String = "mipnone" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

- Always use the top level texture - (has a performance penalty when downscaling). - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DProfile.html b/html-docs/flash/display3D/Context3DProfile.html deleted file mode 100644 index ec87fd3..0000000 --- a/html-docs/flash/display3D/Context3DProfile.html +++ /dev/null @@ -1,445 +0,0 @@ - - - - - - - - -flash.display3D.Context3DProfile (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DProfile
InheritanceContext3DProfile Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

-

- Defines the values to use for specifying the Context3D profile. -

-

-See also -

-
-flash.display.Stage3D.requestContext3D() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  BASELINE : String = "baseline"
[static] - Use the default feature support profile.
-		Context3DProfile
  BASELINE_CONSTRAINED : String = "baselineConstrained"
[static] - Use a constrained feature support profile to target older GPUs -

This profile is primarily targeted at devices that only support PS_2.0 level shaders - like the Intel GMA 9xx series.

-		Context3DProfile
  BASELINE_EXTENDED : String = "baselineExtended"
[static] - Use an extended feature support profile to target newer GPUs which support larger textures -

This profile increases the maximum 2D Texture and RectangleTexture size to 4096x4096

-
-		Context3DProfile
  ENHANCED : String = "enhanced"
[static] - Use enhanced profile to target GPUs which support AGAL4.
-		Context3DProfile
  STANDARD : String = "standard"
[static] - Use an standard profile to target GPUs which support MRT, AGAL2 and float textures.
-		Context3DProfile
  STANDARD_CONSTRAINED : String = "standardConstrained"
[static] - Use an standard profile to target GPUs which support AGAL2 and float textures.
-		Context3DProfile
  STANDARD_EXTENDED : String = "standardExtended"
[static] - Use standard extended profile to target GPUs which support AGAL3 and instanced drawing feature.
-		Context3DProfile
-
- -
- -
Constant detail
- - - - - -
BASELINEconstant
-
-public static const BASELINE:String = "baseline" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Use the default feature support profile. -

This profile most closely resembles Stage3D support used in previous releases.

-
- - - - - -
BASELINE_CONSTRAINEDconstant 
-
-public static const BASELINE_CONSTRAINED:String = "baselineConstrained" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Use a constrained feature support profile to target older GPUs -

This profile is primarily targeted at devices that only support PS_2.0 level shaders - like the Intel GMA 9xx series. In addition, this mode tries to improve memory bandwidth - usage by rendering directly into the back buffer. There are several side effects:

-
    -
  • You are limited to 64 ALU and 32 texture instructions per shader.
    • -
  • Only four texture read instructions per shader.
    • -
  • No support for predicate register. This affects sln/sge/seq/sne, which you replace with - compound mov/cmp instructions, available with ps_2_0.
    • -
  • The Context3D back buffer must always be within the bounds of the stage.
    • -
  • Only one instance of a Context3D running in Constrained profile is allowed within a Flash Player instance.
    • -
  • Standard display list list rendering is driven by Context3D.present() instead - of being based on the SWF frame rate. That is, if a Context3D object is - active and visible you must call Context3D.present() to render the standard display - list.
    • -
  • Reading back from the back buffer through Context3D.drawToBitmapData() might include - parts of the display list content. Alpha information will be lost.
    • -
-
- - - - - -
BASELINE_EXTENDEDconstant 
-
-public static const BASELINE_EXTENDED:String = "baselineExtended" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- Use an extended feature support profile to target newer GPUs which support larger textures -

This profile increases the maximum 2D Texture and RectangleTexture size to 4096x4096

-
- - - - - -
ENHANCEDconstant 
-
-public static const ENHANCED:String = "enhanced" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 26.0 -
-

- Use enhanced profile to target GPUs which support AGAL4. -

This profile supports Vertex Texture Fetch

-

This profile is enabled from AIR 26.0 on mobile platforms and AIR 29.0 on Windows and Mac.

-
- - - - - -
STANDARDconstant 
-
-public static const STANDARD:String = "standard" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 14.0 -
-

- Use an standard profile to target GPUs which support MRT, AGAL2 and float textures. -

This profile supports 4 render targets. Increase AGAL commands and register count. Add float textures.

-
- - - - - -
STANDARD_CONSTRAINEDconstant 
-
-public static const STANDARD_CONSTRAINED:String = "standardConstrained" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 16.0 -
-

- Use an standard profile to target GPUs which support AGAL2 and float textures. -

This profile is an alternative to standard profile, which removes MRT and a few features in AGAL2 but can reach more GPUs.

-
- - - - - -
STANDARD_EXTENDEDconstant 
-
-public static const STANDARD_EXTENDED:String = "standardExtended" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 17.0 -
-

- Use standard extended profile to target GPUs which support AGAL3 and instanced drawing feature. -

This profile extends the standard profile.

-

This profile is enabled on mobile platforms from AIR 17.0 and on Windows and Mac from AIR 18.0.

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DProgramType.html b/html-docs/flash/display3D/Context3DProgramType.html deleted file mode 100644 index de2eaa1..0000000 --- a/html-docs/flash/display3D/Context3DProgramType.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - -flash.display3D.Context3DProgramType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DProgramType
InheritanceContext3DProgramType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- Defines the values to use for specifying whether a shader program is - a fragment or a vertex program. -

-

-See also -

-
-Context3D.setProgramConstantsFromMatrix() -
-Context3D.setProgramConstantsFromVector() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  FRAGMENT : String = "fragment"
[static] - A fragment (or pixel) program.
-		Context3DProgramType
  VERTEX : String = "vertex"
[static] - A vertex program.
-		Context3DProgramType
-
- -
- -
Constant detail
- - - - - -
FRAGMENTconstant
-
-public static const FRAGMENT:String = "fragment" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- A fragment (or pixel) program. - -

- - - - - -
VERTEXconstant 
-
-public static const VERTEX:String = "vertex" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- A vertex program. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DRenderMode.html b/html-docs/flash/display3D/Context3DRenderMode.html deleted file mode 100644 index 56d8a75..0000000 --- a/html-docs/flash/display3D/Context3DRenderMode.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - - - - - -flash.display3D.Context3DRenderMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DRenderMode
InheritanceContext3DRenderMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- Defines the values to use for specifying the Context3D render mode. - -

-

-See also -

-
-flash.display.Stage3D.requestContext3D() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  AUTO : String = "auto"
[static] - Automatically choose rendering engine.
-		Context3DRenderMode
  SOFTWARE : String = "software"
[static] - Use software 3D rendering.
-		Context3DRenderMode
-
- -
- -
Constant detail
- - - - - -
AUTOconstant
-
-public static const AUTO:String = "auto" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Automatically choose rendering engine. - -

A hardware-accelerated rendering engine is used if available - on the current device. Availability of hardware acceleration is - influenced by the device capabilites, the wmode when running under Flash Player, - and the render mode when running under AIR.

- -
- - - - - -
SOFTWAREconstant 
-
-public static const SOFTWARE:String = "software" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Use software 3D rendering. - -

Software rendering is not available on mobile devices.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DStencilAction.html b/html-docs/flash/display3D/Context3DStencilAction.html deleted file mode 100644 index afec677..0000000 --- a/html-docs/flash/display3D/Context3DStencilAction.html +++ /dev/null @@ -1,458 +0,0 @@ - - - - - - - - -flash.display3D.Context3DStencilAction (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DStencilAction
InheritanceContext3DStencilAction Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- Defines the values to use for specifying stencil actions. -

A stencil action specifies how the values in the stencil buffer should be changed.

- -

-

-See also -

-
-Context3D.setStencilActions() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  DECREMENT_SATURATE : String = "decrementSaturate"
[static] - Decrement the stencil buffer value, clamping at 0, the minimum value.
-		Context3DStencilAction
  DECREMENT_WRAP : String = "decrementWrap"
[static] - Decrement the stencil buffer value.
-		Context3DStencilAction
  INCREMENT_SATURATE : String = "incrementSaturate"
[static] - Increment the stencil buffer value, clamping at 255, the maximum value.
-		Context3DStencilAction
  INCREMENT_WRAP : String = "incrementWrap"
[static] - Increment the stencil buffer value.
-		Context3DStencilAction
  INVERT : String = "invert"
[static] - Invert the stencil buffer value, bitwise.
-		Context3DStencilAction
  KEEP : String = "keep"
[static] - Keep the current stencil buffer value.
-		Context3DStencilAction
  SET : String = "set"
[static] - Replace the stencil buffer value with the reference value.
-		Context3DStencilAction
  ZERO : String = "zero"
[static] - Set the stencil buffer value to 0.
-		Context3DStencilAction
-
- -
- -
Constant detail
- - - - - -
DECREMENT_SATURATEconstant
-
-public static const DECREMENT_SATURATE:String = "decrementSaturate" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Decrement the stencil buffer value, clamping at 0, the minimum value. - -

- - - - - -
DECREMENT_WRAPconstant 
-
-public static const DECREMENT_WRAP:String = "decrementWrap" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Decrement the stencil buffer value. If the result is less than 0, - the minimum value, then the buffer value is "wrapped around" to 255. -

- - - - - -
INCREMENT_SATURATEconstant 
-
-public static const INCREMENT_SATURATE:String = "incrementSaturate" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Increment the stencil buffer value, clamping at 255, the maximum value. - -

- - - - - -
INCREMENT_WRAPconstant 
-
-public static const INCREMENT_WRAP:String = "incrementWrap" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Increment the stencil buffer value. If the result exceeds 255, - the maximum value, then the buffer value is "wrapped around" to 0. - -

- - - - - -
INVERTconstant 
-
-public static const INVERT:String = "invert" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Invert the stencil buffer value, bitwise. - -

For example, if the 8-bit binary number in the stencil buffer is: 11110000, - then the value is changed to: 00001111.

- -
- - - - - -
KEEPconstant 
-
-public static const KEEP:String = "keep" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Keep the current stencil buffer value. - -

- - - - - -
SETconstant 
-
-public static const SET:String = "set" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Replace the stencil buffer value with the reference value. - -

- - - - - -
ZEROconstant 
-
-public static const ZERO:String = "zero" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Set the stencil buffer value to 0. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DTextureFilter.html b/html-docs/flash/display3D/Context3DTextureFilter.html deleted file mode 100644 index 2a2a648..0000000 --- a/html-docs/flash/display3D/Context3DTextureFilter.html +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - - - -flash.display3D.Context3DTextureFilter (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DTextureFilter
InheritanceContext3DTextureFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

-

- Defines the values to use for sampler filter mode. - -

-

-See also -

-
-flash.display3D.Context3D.setSamplerStateAt() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ANISOTROPIC16X : String = "anisotropic16x"
[static] - Use anisotropic filter with radio 16 when upsampling textures - -
-		Context3DTextureFilter
  ANISOTROPIC2X : String = "anisotropic2x"
[static] - Use anisotropic filter with radio 2 when upsampling textures - -
-		Context3DTextureFilter
  ANISOTROPIC4X : String = "anisotropic4x"
[static] - Use anisotropic filter with radio 4 when upsampling textures - -
-		Context3DTextureFilter
  ANISOTROPIC8X : String = "anisotropic8x"
[static] - Use anisotropic filter with radio 8 when upsampling textures - -
-		Context3DTextureFilter
  LINEAR : String = "linear"
[static] - Use linear interpolation when upsampling textures - (gives a smooth, blurry look).
-		Context3DTextureFilter
  NEAREST : String = "nearest"
[static] - Use nearest neighbor sampling when upsampling textures - (gives a pixelated, sharp mosaic look).
-		Context3DTextureFilter
-
- -
- -
Constant detail
- - - - - -
ANISOTROPIC16Xconstant
-
-public static const ANISOTROPIC16X:String = "anisotropic16x" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 14.0 -
-

- Use anisotropic filter with radio 16 when upsampling textures - -

- - - - - -
ANISOTROPIC2Xconstant 
-
-public static const ANISOTROPIC2X:String = "anisotropic2x" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 14.0 -
-

- Use anisotropic filter with radio 2 when upsampling textures - -

- - - - - -
ANISOTROPIC4Xconstant 
-
-public static const ANISOTROPIC4X:String = "anisotropic4x" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 14.0 -
-

- Use anisotropic filter with radio 4 when upsampling textures - -

- - - - - -
ANISOTROPIC8Xconstant 
-
-public static const ANISOTROPIC8X:String = "anisotropic8x" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 14.0 -
-

- Use anisotropic filter with radio 8 when upsampling textures - -

- - - - - -
LINEARconstant 
-
-public static const LINEAR:String = "linear" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

- Use linear interpolation when upsampling textures - (gives a smooth, blurry look). - -

- - - - - -
NEARESTconstant 
-
-public static const NEAREST:String = "nearest" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

- Use nearest neighbor sampling when upsampling textures - (gives a pixelated, sharp mosaic look). - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DTextureFormat.html b/html-docs/flash/display3D/Context3DTextureFormat.html deleted file mode 100644 index c434821..0000000 --- a/html-docs/flash/display3D/Context3DTextureFormat.html +++ /dev/null @@ -1,398 +0,0 @@ - - - - - - - - -flash.display3D.Context3DTextureFormat (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DTextureFormat
InheritanceContext3DTextureFormat Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- Defines the values to use for specifying a texture format. -

-

-See also -

-
-Context3D.createTexture() -
-Context3D.createCubeTexture() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  BGRA : String = "bgra"
[static] - -
-		Context3DTextureFormat
  BGRA_PACKED : String = "bgraPacked4444"
[static] - 16 bit, bgra packed as 4:4:4:4 - -
-		Context3DTextureFormat
  BGR_PACKED : String = "bgrPacked565"
[static] - 16 bit, bgr packed as 5:6:5 - -
-		Context3DTextureFormat
  COMPRESSED : String = "compressed"
[static] - -
-		Context3DTextureFormat
  COMPRESSED_ALPHA : String = "compressedAlpha"
[static] - -
-		Context3DTextureFormat
  RGBA_HALF_FLOAT : String = "rgbaHalfFloat"
[static] -
-		Context3DTextureFormat
-
- -
- -
Constant detail
- - - - - -
BGRAconstant
-
-public static const BGRA:String = "bgra" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

- - - - - -
BGRA_PACKEDconstant 
-
-public static const BGRA_PACKED:String = "bgraPacked4444" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- 16 bit, bgra packed as 4:4:4:4 - -

- - - - - -
BGR_PACKEDconstant 
-
-public static const BGR_PACKED:String = "bgrPacked565" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- 16 bit, bgr packed as 5:6:5 - -

- - - - - -
COMPRESSEDconstant 
-
-public static const COMPRESSED:String = "compressed" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

- - - - - -
COMPRESSED_ALPHAconstant 
-
-public static const COMPRESSED_ALPHA:String = "compressedAlpha" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- -

- - - - - -
RGBA_HALF_FLOATconstant 
-
-public static const RGBA_HALF_FLOAT:String = "rgbaHalfFloat" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 14 -
-

-

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DTriangleFace.html b/html-docs/flash/display3D/Context3DTriangleFace.html deleted file mode 100644 index 2cafdaa..0000000 --- a/html-docs/flash/display3D/Context3DTriangleFace.html +++ /dev/null @@ -1,338 +0,0 @@ - - - - - - - - -flash.display3D.Context3DTriangleFace (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DTriangleFace
InheritanceContext3DTriangleFace Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- Constants to specify the orientation of a triangle relative to the view point. -

-

-See also -

-
-Context3D.setCulling() -
-Context3D.setStencilActions() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  BACK : String = "back"
[static] - -
-		Context3DTriangleFace
  FRONT : String = "front"
[static] - -
-		Context3DTriangleFace
  FRONT_AND_BACK : String = "frontAndBack"
[static] - -
-		Context3DTriangleFace
  NONE : String = "none"
[static] - -
-		Context3DTriangleFace
-
- -
- -
Constant detail
- - - - - -
BACKconstant
-
-public static const BACK:String = "back" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

- - - - - -
FRONTconstant 
-
-public static const FRONT:String = "front" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

- - - - - -
FRONT_AND_BACKconstant 
-
-public static const FRONT_AND_BACK:String = "frontAndBack" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DVertexBufferFormat.html b/html-docs/flash/display3D/Context3DVertexBufferFormat.html deleted file mode 100644 index 66f1365..0000000 --- a/html-docs/flash/display3D/Context3DVertexBufferFormat.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - -flash.display3D.Context3DVertexBufferFormat (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DVertexBufferFormat
InheritanceContext3DVertexBufferFormat Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- Defines the values to use for specifying vertex buffers. -

-

-See also -

-
-Context3D.setVertexBufferAt() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  BYTES_4 : String = "bytes4"
[static] - -
-		Context3DVertexBufferFormat
  FLOAT_1 : String = "float1"
[static] - -
-		Context3DVertexBufferFormat
  FLOAT_2 : String = "float2"
[static] - -
-		Context3DVertexBufferFormat
  FLOAT_3 : String = "float3"
[static] - -
-		Context3DVertexBufferFormat
  FLOAT_4 : String = "float4"
[static] - -
-		Context3DVertexBufferFormat
-
- -
- -
Constant detail
- - - - - -
BYTES_4constant
-
-public static const BYTES_4:String = "bytes4" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

- - - - - -
FLOAT_1constant 
-
-public static const FLOAT_1:String = "float1" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

- - - - - -
FLOAT_2constant 
-
-public static const FLOAT_2:String = "float2" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

- - - - - -
FLOAT_3constant 
-
-public static const FLOAT_3:String = "float3" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

- - - - - -
FLOAT_4constant 
-
-public static const FLOAT_4:String = "float4" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Context3DWrapMode.html b/html-docs/flash/display3D/Context3DWrapMode.html deleted file mode 100644 index f46d8d7..0000000 --- a/html-docs/flash/display3D/Context3DWrapMode.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - - - -flash.display3D.Context3DWrapMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Context3DWrapMode
InheritanceContext3DWrapMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

-

- Defines the values to use for sampler wrap mode - -

-

-See also -

-
-flash.display3D.Context3D.setSamplerStateAt() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  CLAMP : String = "clamp"
[static] - Clamp texture coordinates outside the 0..1 range.
-		Context3DWrapMode
  CLAMP_U_REPEAT_V : String = "clamp_u_repeat_v"
[static] - Clamp in U axis but Repeat in V axis.
-		Context3DWrapMode
  REPEAT : String = "repeat"
[static] - Repeat (tile) texture coordinates outside the 0..1 range.
-		Context3DWrapMode
  REPEAT_U_CLAMP_V : String = "repeat_u_clamp_v"
[static] - Repeat in U axis but Clamp in V axis.
-		Context3DWrapMode
-
- -
- -
Constant detail
- - - - - -
CLAMPconstant
-
-public static const CLAMP:String = "clamp" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

- Clamp texture coordinates outside the 0..1 range. -

The function is x = max(min(x,0),1)

- -
- - - - - -
CLAMP_U_REPEAT_Vconstant 
-
-public static const CLAMP_U_REPEAT_V:String = "clamp_u_repeat_v"

- Clamp in U axis but Repeat in V axis. -

- - - - - -
REPEATconstant 
-
-public static const REPEAT:String = "repeat" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.6 -
-

- Repeat (tile) texture coordinates outside the 0..1 range. -

The function is x = x<0?1.0-frac(abs(x)):frac(x)

- -
- - - - - -
REPEAT_U_CLAMP_Vconstant 
-
-public static const REPEAT_U_CLAMP_V:String = "repeat_u_clamp_v"

- Repeat in U axis but Clamp in V axis. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/IndexBuffer3D.html b/html-docs/flash/display3D/IndexBuffer3D.html deleted file mode 100644 index 64e24f4..0000000 --- a/html-docs/flash/display3D/IndexBuffer3D.html +++ /dev/null @@ -1,417 +0,0 @@ - - - - - - - - -flash.display3D.IndexBuffer3D (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class IndexBuffer3D
InheritanceIndexBuffer3D Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- IndexBuffer3D is used to represent lists of vertex indices comprising graphic elements retained - by the graphics subsystem. -

Indices managed by an IndexBuffer3D object may be used to select vertices from a vertex stream. - Indices are 16-bit unsigned integers. The maximum allowable index value is 65535 (0xffff). - The graphics subsystem does not retain a reference - to vertices provided to this object. Data uploaded to this object may be modified or discarded - without affecting the stored values.

-

IndexBuffer3D cannot be instantiated directly. Create instances by using - Context3D::CreateIndexBuffer()

-

-

-See also -

-
flash.display.Context3D.createIndexBuffer()
flash.display.Context3D.drawTriangles()
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-dispose():void -
-
- Free all native GPU resources associated with this object.
-		IndexBuffer3D
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-uploadFromByteArray(data:ByteArray, byteArrayOffset:int, startOffset:int, count:int):void -
-
- Store in the graphics subsystem vertex indices.
-		IndexBuffer3D
   -
-uploadFromVector(data:Vector.<uint>, startOffset:int, count:int):void -
-
- Store in the graphics subsystem vertex indices.
-		IndexBuffer3D
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Method detail
- - - - - -
dispose()method
-
-public function dispose():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Free all native GPU resources associated with this object. - No upload() calls on this object will work and using the object in rendering will also fail. - -

- - - - - -
uploadFromByteArray()method 
-
-public function uploadFromByteArray(data:ByteArray, byteArrayOffset:int, startOffset:int, count:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Store in the graphics subsystem vertex indices. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
data:ByteArray — a ByteArray containing index data. Each index is represented by 16-bits (two bytes) in the array. The number of - bytes in data should be byteArrayOffset plus two times count. -
 
byteArrayOffset:int — offset, in bytes, into the data ByteArray from where to start reading. -
 
startOffset:int — The index in this IndexBuffer3D object of the first index to be loaded in this IndexBuffer3D object. A value for startIndex not equal to zero may be used to load a sub-region of the index data. -
 
count:int — The number of indices represented by data. -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — kNullPointerError when data is null. -
 
RangeError — kBadInputSize when any of count, byteArrayOffset, or startOffset is less than 0, - or if byteArrayOffset is greater than or equal to the length of data, - or if two times count plus byteArrayOffset is greater than the length of data, or - if startOffset + count is greater than numIndices given in Context3D::createIndexBuffer(). -
 
Error — 3768: The Stage3D API may not be used during background execution. - -
-
- - - - - -
uploadFromVector()method 
-
-public function uploadFromVector(data:Vector.<uint>, startOffset:int, count:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Store in the graphics subsystem vertex indices. -

Parameters - - - - - - - - - - - - - - - - -
data:Vector.<uint> — a vector of vertex indices. Only the low 16 bits of each index value are used. - The length of the vector must be greater than or equal to count. -
 
startOffset:int — The index in this IndexBuffer3D object of the first index to be loaded. A value for startOffset not equal to zero may be used to load a sub-region of the index data. -
 
count:int — The number of indices in data. -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — kNullPointerError when data is null. -
 
RangeError — kBadInputSize when count is less than 0 or greater than the length of data, or - when startOffset + count is greater than numIndices given in - Context3D::createIndexBuffer(). -
 
Error — 3768: The Stage3D API may not be used during background execution. - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/Program3D.html b/html-docs/flash/display3D/Program3D.html deleted file mode 100644 index aaf23d5..0000000 --- a/html-docs/flash/display3D/Program3D.html +++ /dev/null @@ -1,917 +0,0 @@ - - - - - - - - -flash.display3D.Program3D (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic final class Program3D
InheritanceProgram3D Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The Program3D class represents a pair of rendering programs (also called "shaders") - uploaded to the rendering context. -

Programs managed by a Program3D object control the entire rendering of triangles - during a Context3D drawTriangles() call. Upload the binary bytecode - to the rendering context using - the upload method. (Once uploaded, the program in the - original byte array is no longer referenced; changing or discarding the - source byte array does not change the program.)

-

Programs always consist of two linked parts: A vertex and a fragment program. -

    -
  1. The vertex program operates on data defined in VertexBuffer3D objects and is - responsible for projecting vertices into clip space and passing any required vertex data, - such as color, to the fragment shader.
    2. -
  2. The fragment shader operates on the attributes passed to it by the vertex program and - produces a color for every rasterized fragment of a triangle, resulting in pixel colors. - Note that fragment programs have several names in 3D programming literature, including - fragment shader and pixel shader.
    3. -
-

-

Designate which program pair to use for subsequent rendering operations by passing the - corresponding Program3D instance to the Context3D setProgram() method.

- -

You cannot create a Program3D object directly; use the - Context3D createProgram() method instead.

-

-

-See also -

-
-Context3D.createProgram() -
-Context3D.setProgram() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-dispose():void -
-
- Frees all resources associated with this object.
-		Program3D
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-upload(vertexProgram:ByteArray, fragmentProgram:ByteArray):void -
-
- Uploads a pair of rendering programs expressed in AGAL (Adobe Graphics Assembly Language) bytecode.
-		Program3D
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Method detail
- - - - - -
dispose()method
-
-public function dispose():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Frees all resources associated with this object. - After disposing a Program3D object, calling upload() and rendering using this object will fail. - -

- - - - - -
upload()method 
-
-public function upload(vertexProgram:ByteArray, fragmentProgram:ByteArray):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Uploads a pair of rendering programs expressed in AGAL (Adobe Graphics Assembly Language) bytecode. - -

Program bytecode can be created using the Pixel Bender 3D offline tools. It can - also be created dynamically. The AGALMiniAssembler class is a utility class that - compiles AGAL assembly language programs to AGAL bytecode. The class is not part of the runtime. - When you upload the shader programs, the bytecode is compiled into the native shader - language for the current device (for example, OpenGL or Direct3D). The runtime - validates the bytecode on upload.

- -

The programs run whenever the Context3D drawTriangles() method is invoked. - The vertex program is executed once for each vertex in the list of triangles to be drawn. - The fragment program is executed once for each pixel on a triangle surface.

- -

The "variables" used by a shader program are called registers. The following registers are defined:

-

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameNumber per Fragment programNumber per Vertex programPurpose
Attributen/a8Vertex shader input; read from a vertex buffer specified using Context3D.setVertexBufferAt().
Constant28128Shader input; set using the Context3D.setProgramConstants() family of functions.
Temporary88Temporary register for computation, not accessible outside program.
Output11Shader output: in a vertex program, the output is the clipspace position; in a fragment - program, the output is a color.
Varying88Transfer interpolated data between vertex and fragment shaders. The varying registers - from the vertex program are applied as input to the fragment program. Values are interpolated - according to the distance from the triangle vertices.
Sampler8n/aFragment shader input; read from a texture specified using Context3D.setTextureAt()

- -

A vertex program receives input from two sources: vertex buffers and constant registers. - Specify which vertex data to use for a particular vertex attribute register using the - Context3D setVertexBufferAt() method. You can define up to eight input registers for - vertex attributes. The vertex attribute values are read from the vertex buffer for each - vertex in the triangle list and placed in the attribute register. Specify constant registers using the Context3D - setProgramConstantsFromMatrix() or setProgramConstantsFromVector() - methods. Constant registers retain the same value for every vertex in the triangle list. - (You can only modify the constant values between calls to drawTriangles().) -

- -

The vertex program is responsible for projecting the triangle vertices into clip space - (the canonical viewing area within ±1 on the x and y axes and 0-1 on the z axis) and placing the transformed - coordinates in its output register. (Typically, the appropriate projection matrix is - provided to the shader in a set of constant registers.) The vertex program must also copy any vertex - attributes or computed values needed by the fragment program to a special set of variables called varying - registers. When a fragment shader runs, the value supplied in a varying register is - linearly interpolated according to the distance of the current fragment from each triangle vertex.

- -

A fragment program receives input from the varying registers and from a separate set - of constant registers (set with setProgramConstantsFromMatrix() - or setProgramConstantsFromVector()). You can also read texture data from textures - uploaded to the rendering context using sampler registers. Specify which texture to access with - a particular sampler register using the Context3D setTextureAt() method. The - fragment program is responsible for setting its output register to a color value.

- - Parameters - - - - - - - - - - -
vertexProgram:ByteArray — AGAL bytecode for the Vertex program. - The ByteArray object must use the little endian format. -
 
fragmentProgram:ByteArray — AGAL bytecode for the Fragment program. - The ByteArray object must use the little endian format. -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: if vertexProgram or fragmentProgram is null. -
 
Error — Object Disposed: if the Program3D object was disposed either directly by a call - to dispose(), or indirectly by calling the Context3D dispose() or - because the rendering context was disposed because of device loss. -
 
ArgumentError — Agal Program Too Small: when either program code array is smaller than - 31 bytes length. This is the size of the shader bytecode of a one-instruction program. -
 
ArgumentError — Program Must Be Little Endian: if either of the program byte code arrays - is not little endian. -
 
Error — Native Shader Compilation Failed: if the output of the AGAL translator is not - a compilable native shader language program. This error is only thrown in release players. -
 
Error — Native Shader Compilation Failed OpenGL: if the output of the AGAL translator - is not a compilable OpengGL shader language program, and includes compilation diagnostics. This error - is only thrown in debug players. -
 
Error — Native Shader Compilation Failed D3D9: if the output of the AGAL translator - is not a compilable Direct3D shader language program, and includes compilation diagnostics. This error - is only thrown in debug players. -

The following errors are thrown when the AGAL bytecode validation fails:

-
 
Error — Not An Agal Program: if the header "magic byte" is wrong. The first byte of the - bytecode must be 0xa0. This error can indicate that the byte array is set to the wrong endian order. - -
 
Error — Bad Agal Version: if the AGAL version is not supported by the current SWF version. - The AGAL version must be set to 1 for SWF version 13. - -
 
Error — Bad Agal Program Type: if the AGAL program type identifier is not valid. - The third byte in the byte code must be 0xa1. This error can indicates that the byte array - is set to the wrong endian order. - -
 
Error — Bad Agal Shader Type: if the shader type code is not either fragment or vertex (1 or 0). - -
 
Error — Invalid Agal Opcode Out Of Range: if an invalid opcode is encountered in the token stream. - -
 
Error — Invalid Agal Opcode Not Implemented: if an invalid opcode is encountered - in the token stream. - -
 
Error — Agal Opcode Only Allowed In Fragment Program: if an opcode is encountered in the token - stream of the vertex program that is only allowed in fragment programs, such as KIL or TEX. - -
 
Error — Bad Agal Source Operands: if both source operands are constant registers. - You must compute the result outside the shader program and pass it in using a single constant register. - -
 
Error — Both Operands Are Indirect Reads: if both operands are indirect reads. - -
 
Error — Opcode Destination Must Be All Zero: if a token with an opcode (such as KIL) - that has no destination sets a non-zero value for the destination register. - -
 
Error — Opcode Destination Must Use Mask: if an opcode that produces only a 3 component - result is used without masking. - -
 
Error — Too Many Tokens: if there are too many tokens (more than 200) in an AGAL program. - -
 
Error — Fragment Shader Type: if the fragment program type (byte 6 of fragmentProgram parameter) - is not set to 1. - -
 
Error — Vertex Shader Type: if the vertex program type (byte 6 of vertexProgram parameter) - is not set to 0. - -
 
Error — Varying Read But Not Written To: if the fragment shader reads a varying register - that was never written to by the vertex shader. - -
 
Error — Varying Partial Write: if a varying register is only partially written to. - All components of a varying register must be written to. - -
 
Error — Fragment Write All Components: if a fragment color output is only partially - written to. All four components of the color output must be written to. - -
 
Error — Vertex Write All Components: if a vertex clip space output is only partially written to. All components of the vertex clip space output must be written to. -
 
Error — Unused Operand: if an unused operand in a token is not set to all zero. -
 
Error — Sampler Register Only In Fragment: if a texture sampler register is used in a vertex program. -
 
Error — Sampler Register Second Operand: if a sampler register is used as a destination or - first operand of an AGAL token. -
 
Error — Indirect Only Allowed In Vertex: if indirect addressing is used in a fragment program. -
 
Error — Indirect Only Into Constant Registers: if indirect addressing is used on a - non-constant register. -
 
Error — Indirect Source Type: if the indirect source type is not attribute, constant or temporary register. -
 
Error — Indirect Addressing Fields Must Be Zero: if not all indirect addressing fields are - zero for direct addressing. -
 
Error — Varying Registers Only Read In Fragment: if a varying register is read in a vertex program. Varying registers - can only be written in vertex programs and read in fragment programs. -
 
Error — Attribute Registers Only Read In Vertex: if an attribute registers is read in a fragment - program. Attribute registers can only be read in vertex programs. -
 
Error — Can Not Read Output Register: if an output (position or color) register is read. Output - registers can only be written to, not read. -
 
Error — Temp Register Read Without Write: if a temporary register is read without being written - to earlier. -
 
Error — Temp Register Component Read Without Write: if a specific temporary register component is - read without being written to earlier. -
 
Error — Sampler Register Cannot Be Written To: if a sampler register is written to. Sampler registers can - only be read, not written to. -
 
Error — Varying Registers Write: if a varying register is written to in a fragment program. Varying registers - can only be written in vertex programs and read in fragment programs. -
 
Error — Attribute Register Cannot Be Written To: if an attribute register is written to. Attribute registers - are read-only. -
 
Error — Constant Register Cannot Be Written To: if a constant register is written to inside a shader program. -
 
Error — Destination Writemask Is Zero: if a destination writemask is zero. All components of an - output register must be set. -
 
Error — AGAL Reserved Bits Should Be Zero: if any reserved bits in a token are not zero. This indicates - an error in creating the bytecode (or malformed bytecode). -
 
Error — Unknown Register Type: if an invalid register type index is used. -
 
Error — Sampler Register Out Of Bounds: if an invalid sampler register index is used. -
 
Error — Varying Register Out Of Bounds: if an invalid varying register index is used. -
 
Error — Attribute Register Out Of Bounds: if an invalid attribute register index is used. -
 
Error — Constant Register Out Of Bounds: if an invalid constant register index is used. -
 
Error — Output Register Out Of Bounds: if an invalid output register index is used. -
 
Error — Temporary Register Out Of Bounds: if an invalid temporary register index is used. -
 
Error — Cube Map Sampler Must Use Clamp: if a cube map sampler does not set the wrap mode to clamp. -
 
Error — Unknown Sampler Dimension: if a sample uses an unknown sampler dimension. (Only 2D - and cube textures are supported.) -
 
Error — Unknown Filter Mode: if a sampler uses an unknown filter mode. (Only nearest neighbor - and linear filtering are supported.) -
 
Error — Unknown Mipmap Mode: if a sampler uses an unknown mipmap mode. (Only none, - nearest neighbor, and linear mipmap modes are supported.) -
 
Error — Unknown Wrapping Mode if a sampler uses an unknown wrapping mode. (Only clamp and - repeat wrapping modes are supported.) -
 
Error — Unknown Special Flag: if a sampler uses an unknown special flag. -
 
Error — Output Color Not Maskable: You cannot mask the color output register in a fragment program. - All components of the color register must be set. -
 
Error — Second Operand Must Be Sampler Register: The AGAL tex opcode must have a sampler as the second - source operand. -
 
Error — Indirect Not Allowed: indirect addressing used where not allowed. -
 
Error — Swizzle Must Be Scalar: swizzling error. -
 
Error — Cant Swizzle 2nd Source: swizzling error. -
 
Error — Second Use Of Sampler Must Have Same Params: all samplers that access the same texture must - use the same dimension, wrap, filter, special, and mipmap settings. -
 
Error — 3768: The Stage3D API may not be used during background execution. - -
-

-See also -

-
-Context3D.setVertexBufferAt() -
-Context3D.setProgramConstants() -
-http://www.adobe.com/go/learn_as3_agal_bytecode_en -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/VertexBuffer3D.html b/html-docs/flash/display3D/VertexBuffer3D.html deleted file mode 100644 index 48b216c..0000000 --- a/html-docs/flash/display3D/VertexBuffer3D.html +++ /dev/null @@ -1,664 +0,0 @@ - - - - - - - - -flash.display3D.VertexBuffer3D (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D
Classpublic class VertexBuffer3D
InheritanceVertexBuffer3D Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

-

- - The VertexBuffer3D class represents a set of vertex data uploaded to a rendering context. - - -

Use a VertexBuffer3D object to define the data associated with each point in a set of - - vertexes. You can upload the vertex data either from a Vector array or a ByteArray. (Once - - uploaded, the data in the original array is no longer referenced; changing or discarding the - - source array does not change the vertex data.)

- - - -

The data associated with each vertex is in an application-defined format and is used as the - - input for the vertex shader program. Identify which values belong - - to which vertex program input using the Context3D setVertexBufferAt() function. - - A vertex program can use up to eight inputs (also known as vertex attribute registers). Each - - input can require between one and four 32-bit values. For example, the [x,y,z] position - - coordinates of a vertex can be passed to a vertex program as a vector containing three 32 bit - - values. The Context3DVertexBufferFormat class defines constants for the supported - - formats for shader inputs. You can supply up to sixty-four 32-bit values (256 bytes) of data - - for each point (but a single vertex shader cannot use all of the data in this case).

- - - -

The setVertexBufferAt() function also identifies which vertex buffer to use - - for rendering any subsequent drawTriangles() calls. To render data from a different - - vertex buffer, call setVertexBufferAt() again with the appropriate arguments. - - (You can store data for the same point in multiple vertex buffers, - - say position data in one buffer and texture coordinates in another, but typically rendering is - - more efficient if all the data for a point comes from a single buffer.)

- - - -

The Index3DBuffer - - object passed to the Context3D drawTriangles() method organizes the vertex data into - - triangles. Each value in the index buffer is the index to a vertex in the vertex buffer. - - A set of three indexes, in sequence, defines a triangle.

- - - -

You cannot create a VertexBuffer3D object directly. Use the - - Context3D createVertexBuffer() method instead.

- - -

To free the render context resources associated with a vertex buffer, call the object's dispose() - - method.

- - - -

-

-View the examples. -

-

-See also -

-
-Context3D.createVertexBuffer() -
-Context3D.setVertexBufferAt() -
-Context3DVertexBufferFormat -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-dispose():void -
-
- - Frees all resources associated with this object.
-		VertexBuffer3D
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-uploadFromByteArray(data:ByteArray, byteArrayOffset:int, startVertex:int, numVertices:int):void -
-
- - Uploads the data for a set of points to the rendering context from a byte array.
-		VertexBuffer3D
   -
-uploadFromFloatVector(data:Vector.<float>, startVertex:int, numVertices:int):void -
-
- - Uploads the data for a set of points to the rendering context from a float vector array.
-		VertexBuffer3D
   -
-uploadFromVector(data:Vector.<Number>, startVertex:int, numVertices:int):void -
-
- - Uploads the data for a set of points to the rendering context from a vector array.
-		VertexBuffer3D
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Method detail
- - - - - -
dispose()method
-
-public function dispose():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Frees all resources associated with this object. - - After disposing a vertex buffer, calling upload() and rendering using this object will fail. - - - -

- - - - - -
uploadFromByteArray()method 
-
-public function uploadFromByteArray(data:ByteArray, byteArrayOffset:int, startVertex:int, numVertices:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Uploads the data for a set of points to the rendering context from a byte array. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
data:ByteArray — a byte array containing the vertex data. Each data value is four bytes long. The number of values in a vertex is specified at - - buffer creation using the data32PerVertex parameter to the Context3D createVertexBuffer3D() method. - - The length of the data in bytes must be byteArrayOffset plus four times the number of values per vertex times the number of vertices. - - The ByteArray object must use the little endian format. - -
 
byteArrayOffset:int — number of bytes to skip from the beginning of data - -
 
startVertex:int — The index of the first vertex to be loaded. A value for startVertex not equal to zero may be used to load a sub-region of the vertex data. - -
 
numVertices:int — The number of vertices to be loaded from data. - - -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
RangeError — Bad Input Size: if byteArrayOffset is less than 0, - - or if byteArrayOffset is greater than or equal to the length of data, - - or if no. of elements in data - byteArrayOffset is less than numVertices*data32pervertex*4 - - given in Context3D::createVertexBuffer(). - - - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - - -
-
- - - - - -
uploadFromFloatVector()method 
-
-public function uploadFromFloatVector(data:Vector.<float>, startVertex:int, numVertices:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Uploads the data for a set of points to the rendering context from a float vector array. - - -

Parameters - - - - - - - - - - - - - - - - -
data:Vector.<float> — a vector of 32-bit values. A single vertex is comprised of a number of values stored sequentially - - in the vector. The number of values in a vertex is specified at buffer creation using the data32PerVertex - - parameter to the Context3D createVertexBuffer3D() method. The length of the vector must - - be the number of values per vertex times the number of vertexes. - -
 
startVertex:int — The index of the first vertex to be loaded. A value for startVertex not equal to zero may be used to load a sub-region of the vertex data. - -
 
numVertices:int — The number of vertices represented by data. - - -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
RangeError — Bad Input Size: when there isn't enough data in the vector for the - - number of vertices uploaded. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - - -
-
- - - - - -
uploadFromVector()method 
-
-public function uploadFromVector(data:Vector.<Number>, startVertex:int, numVertices:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Uploads the data for a set of points to the rendering context from a vector array. - - -

Parameters - - - - - - - - - - - - - - - - -
data:Vector.<Number> — a vector of 32-bit values. A single vertex is comprised of a number of values stored sequentially - - in the vector. The number of values in a vertex is specified at buffer creation using the data32PerVertex - - parameter to the Context3D createVertexBuffer3D() method. The length of the vector must - - be the number of values per vertex times the number of vertexes. - -
 
startVertex:int — The index of the first vertex to be loaded. A value for startVertex not equal to zero may be used to load a sub-region of the vertex data. - -
 
numVertices:int — The number of vertices represented by data. - - -
-
-Throws - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
RangeError — Bad Input Size: when number of elements in data is less than numVertices - - * data32PerVertex given in Context3D::createVertexBuffer(), or when startVertex - - + numVertices is greater than numVertices given in Context3D::createVertexBuffer(). - - - -
-
- -
Examples
-
examples\Context3D_createVertex
-
The following example illustrates how to create and load - a vertex data buffer. The buffer in the example contains two types of data for - each vertex: the position, as x, y, z coordinates; and the color, as rgb components. - After the vertex buffer is created, the example calls the setVertexBufferAt() - method to specify that the first three data points are passed to the vertex program - as 3 Floating point values in va0 and that the second three data points are passed - as va1. A vertex program can have up to 8 inputs, also known as vertex attribute registers, - defined in this way. -
-
-const dataPerVertex:int = 6;
-var vertexData:Vector.<Number> = Vector.<Number>(
-    [
-	  // x, y, z    r, g, b format
-	     0, 0, 0,   1, 1, 1,
-	    -1, 1, 0,   0, 0,.5,
-	     1, 1, 0,   0, 0, 1,
-	     1,-1, 0,  .5, 0, 0,
-	    -1,-1, 0,   1, 0, 0
-	]
-);
-var vertexes:VertexBuffer3D = renderContext.createVertexBuffer( vertexData.length/dataPerVertex, dataPerVertex );
-vertexes.uploadFromVector( vertexData, 0, vertexData.length/dataPerVertex );
-			
-//Identify vertex data inputs for vertex program
-renderContext.setVertexBufferAt( 0, vertexes, 0, Context3DVertexBufferFormat.FLOAT_3 ); //Defines shader input va0 as the position data
-renderContext.setVertexBufferAt( 1, vertexes, 3, Context3DVertexBufferFormat.FLOAT_3 ); //Defines shader input va1 as the color data
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/package-detail.html b/html-docs/flash/display3D/package-detail.html deleted file mode 100644 index 10f8721..0000000 --- a/html-docs/flash/display3D/package-detail.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - -flash.display3D Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.display3D package contains the classes that the Flash Player uses to render geometrically defined graphics.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 Context3D - The Context3D class provides a context for rendering geometrically defined graphics.
 Context3DBlendFactor - Defines the values to use for specifying the source and destination blend factors.
 Context3DBufferUsage - Defines the values to use for specifying the buffer usage type.
 Context3DClearMask - Defines the values to use for specifying Context3D clear masks.
 Context3DCompareMode - Defines the values to use for specifying 3D buffer comparisons in the setDepthTest() and setStencilAction() methods - of a Context3D instance.
 Context3DFillMode - Defines the values to use for specifying 3D render fill mode in the setFillMode() methods - of a Context3D instance.
 Context3DMipFilter - Defines the values to use for sampler mipmap filter mode - -
 Context3DProfile - Defines the values to use for specifying the Context3D profile.
 Context3DProgramType - Defines the values to use for specifying whether a shader program is - a fragment or a vertex program.
 Context3DRenderMode - Defines the values to use for specifying the Context3D render mode.
 Context3DStencilAction - Defines the values to use for specifying stencil actions.
 Context3DTextureFilter - Defines the values to use for sampler filter mode.
 Context3DTextureFormat - Defines the values to use for specifying a texture format.
 Context3DTriangleFace - Constants to specify the orientation of a triangle relative to the view point.
 Context3DVertexBufferFormat - Defines the values to use for specifying vertex buffers.
 Context3DWrapMode - Defines the values to use for sampler wrap mode - -
 IndexBuffer3D - IndexBuffer3D is used to represent lists of vertex indices comprising graphic elements retained - by the graphics subsystem.
 Program3D - The Program3D class represents a pair of rendering programs (also called "shaders") - uploaded to the rendering context.
 VertexBuffer3D - The VertexBuffer3D class represents a set of vertex data uploaded to a rendering context.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/display3D/textures/CubeTexture.html b/html-docs/flash/display3D/textures/CubeTexture.html deleted file mode 100644 index ec4a924..0000000 --- a/html-docs/flash/display3D/textures/CubeTexture.html +++ /dev/null @@ -1,875 +0,0 @@ - - - - - - - - -flash.display3D.textures.CubeTexture (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D.textures
Classpublic final class CubeTexture
InheritanceCubeTexture Inheritance TextureBase Inheritance EventDispatcher Inheritance Object
-

- - The CubeTexture class represents a cube texture uploaded to a rendering context. - - -

Defines a cube map texture for use during rendering. Cube mapping is used for many - - rendering techniques, such as environment maps, skyboxes, and skylight illumination.

- - -

You cannot create a CubeTexture object directly; use the - - Context3D createCubeTexture() instead.

- - -

-

-See also -

-
-flash.display3D.Context3D.createCubeTexture() -
-flash.display3D.Context3D.setTextureAt() -
-http://en.wikipedia.org/wiki/Cube_mapping -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-dispose():void -
-
- Frees all GPU resources associated with this texture.
-		TextureBase
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-uploadCompressedTextureFromByteArray(data:ByteArray, byteArrayOffset:uint, async:Boolean = false):void -
-
- - Uploads a cube texture in Adobe Texture Format (ATF) from a byte array.
-		CubeTexture
   -
-uploadFromBitmapData(source:BitmapData, side:uint, miplevel:uint = 0):void -
-
- - Uploads a component of a cube map texture from a BitmapData object.
-		CubeTexture
   -
-uploadFromByteArray(data:ByteArray, byteArrayOffset:uint, side:uint, miplevel:uint = 0):void -
-
- - Uploads a component of a cube map texture from a ByteArray object.
-		CubeTexture
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-error -
-		 - - Dispatched by the CubeTexture object when an asynchronous texture upload - - operation fails in some way.CubeTexture
   -
-textureReady -
-		 - - Dispatched by the CubeTexture object when an asynchronous texture upload - - operation has completed successfully, and the texture can then be used.CubeTexture
-
- -
- -
Method detail
- - - - - -
uploadCompressedTextureFromByteArray()method
-
-public function uploadCompressedTextureFromByteArray(data:ByteArray, byteArrayOffset:uint, async:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Uploads a cube texture in Adobe Texture Format (ATF) from a byte array. - - -

The byte array must contain all faces and mipmaps for the texture.

- - - - Parameters - - - - - - - - - - - - - - - - -
data:ByteArray — a byte array that containing a compressed cube texture - - including mipmaps. The ByteArray object must use the little endian format. - -
 
byteArrayOffset:uint — an optional offset at which to start reading the - - texture data. - -
 
async:Boolean (default = false) — If true, this function returns immediately. Any draw method - - which attempts to use the texture will fail until the upload completes successfully. Upon successful - - upload, this CubeTexture object dispatches Event.TEXTURE_READY. - - Default value: false. - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
ArgumentError — Texture Decoding Failed: when the compression format of this object cannot be - - derived from the format of the compressed data in data. - -
 
ArgumentError — Texture Needs To Be Square: when the decompressed texture does not have - - equal width and height. - -
 
ArgumentError — Texture Size Does Not Match: when the width and height of the decompressed - - texture do not equal the length of the texture's edge. - -
 
ArgumentError — Miplevel Too Large: if the mip level of the decompressed texture is greater - - than that implied by the length of the texture's edge. - -
 
ArgumentError — Texture Format Mismatch: if the decoded ATF bytes don't contain a texture - - compatible with this texture's format or is not a cube texture. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - -
 
RangeError — Bad Input Size: when there is integer overflow of byteArrayOffset or - - if byteArrayOffset + 6 is greater than the length of data, or if the - - number of bytes available from byteArrayOffset to the end of the data byte array - - is less than the amount of data required for ATF texture. - - -
-

-See also -

-
-flash.events.Event.TEXTURE_READY -
-
- - - - - -
uploadFromBitmapData()method 
-
-public function uploadFromBitmapData(source:BitmapData, side:uint, miplevel:uint = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Uploads a component of a cube map texture from a BitmapData object. - - -

This function uploads one mip level of one side of the cube map. - - Call uploadFromBitmapData() as necessary to upload each mip level and face of the - - cube map.

- - - - Parameters - - - - - - - - - - - - - - - - -
source:BitmapData — a bitmap. - -
 
side:uint — A code indicating which side of the cube to upload: - -

    positive X : 0
- -
    negative X : 1
- -
    positive Y : 2
- -
    negative Y : 3
- -
    positive Z : 4
- -
    negative Z : 5

- -
 
miplevel:uint (default = 0) — the mip level to be loaded, level zero being the top-level - - full-resolution image. The default value is zero. - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: if source is null. - -
 
ArgumentError — Miplevel Too Large: if the specified mip level is greater than - - that implied by the the texture's dimensions. - -
 
ArgumentError — Invalid Cube Side: if side is greater than 5. - -
 
ArgumentError — Invalid BitmapData Error: if source if the BitmapData - - object does not contain a valid cube texture face. The image must be square, with sides - - equal to a power of two, and the correct size for the miplevel specified. - -
 
ArgumentError — Texture Format Mismatch: if the texture format is Context3DTextureFormat.COMPRESSED or - - Context3DTextureFormat.COMPRESSED_ALPHA and the code is executing on a mobile platform where runtime texture compression is not supported. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - -
-
- - - - - -
uploadFromByteArray()method 
-
-public function uploadFromByteArray(data:ByteArray, byteArrayOffset:uint, side:uint, miplevel:uint = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Uploads a component of a cube map texture from a ByteArray object. - - -

This function uploads one mip level of one side of the cube map. - - Call uploadFromByteArray() as neccessary to upload each mip level and face of the - - cube map.

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
data:ByteArray — a byte array containing the image in the format specified when this CubeTexture object - - was created. The ByteArray object must use the little endian format. - -
 
byteArrayOffset:uint — reading of the byte array starts there. - -
 
side:uint — A code indicating which side of the cube to upload: - -

    positive X : 0
- -
    negative X : 1
- -
    positive Y : 2
- -
    negative Y : 3
- -
    positive Z : 4
- -
    negative Z : 5

- -
 
miplevel:uint (default = 0) — the mip level to be loaded, level zero is the top-level, - - full-resolution image. - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
ArgumentError — Miplevel Too Large: if the specified mip level is greater than that - - implied by the Texture's dimensions. - -
 
RangeError — Bad Input Size: if the number of bytes available from byteArrayOffset - - to the end of the data byte array is less than the amount of data required - - for a texture of this mip level or if byteArrayOffset is greater than or equal to the length of data. - -
 
ArgumentError — Texture Format Mismatch: if the texture format is Context3DTextureFormat.COMPRESSED or - - Context3DTextureFormat.COMPRESSED_ALPHA and the code is executing on a mobile platform where runtime texture compression is not supported. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - -
-
-
Event detail
- - - - - -
errorevent 
-
-Event object type: flash.events.ErrorEvent -
-ErrorEvent.type property = flash.events.ErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Dispatched by the CubeTexture object when an asynchronous texture upload - - operation fails in some way. The failure code is provided in the - - errorID field of the error object. - -

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -
- - - - - -
textureReadyevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.TEXTURE_READY -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Dispatched by the CubeTexture object when an asynchronous texture upload - - operation has completed successfully, and the texture can then be used. - -

- The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object. - - This event is dispatched by Texture, RectangleTexture and CubeTexture objects to signal the completion of an asynchronous upload. Request an - asynchronous upload by using the uploadCompressedTextureFromByteArray() method with a true - value for the async argument, or using a method such as uploadFromBitmapDataAsync or - uploadFromByteArrayAsync. - This event neither bubbles nor is cancelable. -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe texture object that dispatched this event.
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/display3D/textures/RectangleTexture.html b/html-docs/flash/display3D/textures/RectangleTexture.html deleted file mode 100644 index 1103ac2..0000000 --- a/html-docs/flash/display3D/textures/RectangleTexture.html +++ /dev/null @@ -1,784 +0,0 @@ - - - - - - - - -flash.display3D.textures.RectangleTexture (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D.textures
Classpublic final class RectangleTexture
InheritanceRectangleTexture Inheritance TextureBase Inheritance EventDispatcher Inheritance Object
-

- - The Rectangle Texture class represents a 2-dimensional texture uploaded to a rendering context. - - -

Defines a 2D texture for use during rendering.

- - -

Texture cannot be instantiated directly. Create instances by using - - Context3D createRectangleTexture() method.

- - -

-

-See also -

-
-flash.display3D.Context3D.createRectangleTexture() -
-flash.display3D.Context3D.setTextureAt() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-dispose():void -
-
- Frees all GPU resources associated with this texture.
-		TextureBase
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-uploadFromBitmapData(source:BitmapData):void -
-
- - Uploads a texture from a BitmapData object.
-		RectangleTexture
   -
-uploadFromBitmapDataAsync(source:BitmapData):void -
-
- - Uploads a texture from a BitmapData object.
-		RectangleTexture
   -
-uploadFromByteArray(data:ByteArray, byteArrayOffset:uint):void -
-
- - Uploads a texture from a ByteArray.
-		RectangleTexture
   -
-uploadFromByteArrayAsync(data:ByteArray, byteArrayOffset:uint):void -
-
- - Uploads a texture from a ByteArray.
-		RectangleTexture
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-error -
-		 - - Dispatched by the RectangleTexture object when an asynchronous texture upload - - operation fails in some way.RectangleTexture
   -
-textureReady -
-		 - - Dispatched by the RectangleTexture object when an asynchronous texture upload - - operation has completed successfully, and the texture can then be used.RectangleTexture
-
- -
- -
Method detail
- - - - - -
uploadFromBitmapData()method
-
-public function uploadFromBitmapData(source:BitmapData):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.8 - -
-

- - Uploads a texture from a BitmapData object. - - -

Parameters - - - - -
source:BitmapData — a bitmap. - - -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when source is null. - -
 
ArgumentError — Invalid BitmapData Error: when source - - does not contain a valid texture. The maximum allowed size in any dimension is 4096 or the size - - of the backbuffer, whichever is greater. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - -
-
- - - - - -
uploadFromBitmapDataAsync()method 
-
-public function uploadFromBitmapDataAsync(source:BitmapData):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Uploads a texture from a BitmapData object. - -

Parameters - - - - -
source:BitmapData — a bitmap. - - This function asynchronously uploads texture data. - - Any draw method which attempts to use the texture will fail until the upload completes successfully. - - Upon successful upload, this RectangleTexture object dispatches Event.TEXTURE_READY. - - Event.TEXTURE_READY is a callback to indicate that the asynchronous call received for the texture object have been executed successfully. - - Upon any error during the background upload , this RectangleTexture object dispatches ErrorEvent.ERROR. - - -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when source is null. - -
 
ArgumentError — Invalid BitmapData Error: when source - - does not contain a valid texture. The maximum allowed size in any dimension is 4096 or the size - - of the backbuffer, whichever is greater. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - -
-

-See also -

-
-flash.events.Event.TEXTURE_READY -
-
- - - - - -
uploadFromByteArray()method 
-
-public function uploadFromByteArray(data:ByteArray, byteArrayOffset:uint):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.8 - -
-

- - Uploads a texture from a ByteArray. - - -

Parameters - - - - - - - - - - -
data:ByteArray — a byte array that is contains enough bytes in the textures internal format to fill the texture. - - rgba textures are read as bytes per texel component (1 or 4). - - float textures are read as floats per texel component (1 or 4). - - The ByteArray object must use the little endian format. - - -
 
byteArrayOffset:uint — the position in the byte array object at which to start reading the texture data. - - -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
RangeError — Bad Input Size: if the number of bytes available from byteArrayOffset - - to the end of data byte array is less than the amount of data required for a texture, or if byteArrayOffset - - is greater than or equal to the length of data. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - - -
-
- - - - - -
uploadFromByteArrayAsync()method 
-
-public function uploadFromByteArrayAsync(data:ByteArray, byteArrayOffset:uint):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Uploads a texture from a ByteArray. - - -

Parameters - - - - - - - - - - -
data:ByteArray — a byte array that is contains enough bytes in the textures internal format to fill the texture. - - rgba textures are read as bytes per texel component (1 or 4). - - float textures are read as floats per texel component (1 or 4). - - The ByteArray object must use the little endian format. - - -
 
byteArrayOffset:uint — the position in the byte array object at which to start reading the texture data. - - - This function asynchronously uploads texture data. - - Any draw method which attempts to use the texture will fail until the upload completes successfully. - - Upon successful upload, this RectangleTexture object dispatches Event.TEXTURE_READY. - - Event.TEXTURE_READY is a callback to indicate that the asynchronous call received for the texture object have been executed successfully. - - Upon any error during the background upload , this RectangleTexture object dispatches ErrorEvent.ERROR. - -
-
-Throws - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
RangeError — Bad Input Size: if the number of bytes available from byteArrayOffset - - to the end of data byte array is less than the amount of data required for a texture, or if byteArrayOffset - - is greater than or equal to the length of data. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - - -
-
-
Event detail
- - - - - -
errorevent 
-
-Event object type: flash.events.ErrorEvent -
-ErrorEvent.type property = flash.events.ErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Dispatched by the RectangleTexture object when an asynchronous texture upload - - operation fails in some way. The failure code is provided in the - - errorID field of the error object. - -

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -
- - - - - -
textureReadyevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.TEXTURE_READY -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Dispatched by the RectangleTexture object when an asynchronous texture upload - - operation has completed successfully, and the texture can then be used. - -

- The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object. - - This event is dispatched by Texture, RectangleTexture and CubeTexture objects to signal the completion of an asynchronous upload. Request an - asynchronous upload by using the uploadCompressedTextureFromByteArray() method with a true - value for the async argument, or using a method such as uploadFromBitmapDataAsync or - uploadFromByteArrayAsync. - This event neither bubbles nor is cancelable. -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe texture object that dispatched this event.
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/display3D/textures/Texture.html b/html-docs/flash/display3D/textures/Texture.html deleted file mode 100644 index 39f36f7..0000000 --- a/html-docs/flash/display3D/textures/Texture.html +++ /dev/null @@ -1,1061 +0,0 @@ - - - - - - - - -flash.display3D.textures.Texture (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D.textures
Classpublic final class Texture
InheritanceTexture Inheritance TextureBase Inheritance EventDispatcher Inheritance Object
-

- - The Texture class represents a 2-dimensional texture uploaded to a rendering context. - - -

Defines a 2D texture for use during rendering.

- - -

Texture cannot be instantiated directly. Create instances by using - - Context3D createTexture() method.

- - -

-

-See also -

-
-flash.display3D.Context3D.createTexture() -
-flash.display3D.Context3D.setTextureAt() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-dispose():void -
-
- Frees all GPU resources associated with this texture.
-		TextureBase
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-uploadCompressedTextureFromByteArray(data:ByteArray, byteArrayOffset:uint, async:Boolean = false):void -
-
- - Uploads a compressed texture in Adobe Texture Format (ATF) from a ByteArray object.
-		Texture
   -
-uploadFromBitmapData(source:BitmapData, miplevel:uint = 0):void -
-
- - Uploads a texture from a BitmapData object.
-		Texture
   -
-uploadFromBitmapDataAsync(source:BitmapData, miplevel:uint = 0):void -
-
- - Uploads miplevel 0 for a texture from a BitmapData object asynchronously.
-		Texture
   -
-uploadFromByteArray(data:ByteArray, byteArrayOffset:uint, miplevel:uint = 0):void -
-
- - Uploads a texture from a ByteArray.
-		Texture
   -
-uploadFromByteArrayAsync(data:ByteArray, byteArrayOffset:uint, miplevel:uint = 0):void -
-
- - Uploads miplevel 0 for a texture from a ByteArray asynchronously.
-		Texture
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-error -
-		 - - Dispatched by the Texture object when an asynchronous texture upload - - operation fails in some way.Texture
   -
-textureReady -
-		 - - Dispatched by the Texture object when an asynchronous texture upload - - operation has completed successfully, and the texture can then be used.Texture
-
- -
- -
Method detail
- - - - - -
uploadCompressedTextureFromByteArray()method
-
-public function uploadCompressedTextureFromByteArray(data:ByteArray, byteArrayOffset:uint, async:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Uploads a compressed texture in Adobe Texture Format (ATF) from a ByteArray object. - - ATF file version 2 requires SWF version 21 or newer and ATF file version 3 requires SWF version 29 or newer. - - For ATF files created with png image without alpha the format string given during Context3DObject::createTexture - - should be "COMPRESSED" and for ATF files created with png image with alpha the format string given during - - Context3DObject::createTexture should be "COMPRESSED_ALPHA". - - -

Parameters - - - - - - - - - - - - - - - - -
data:ByteArray — a byte array that contains a compressed texture - - including mipmaps. The ByteArray object must use the little endian format. - -
 
byteArrayOffset:uint — the position in the byte array at which to start reading the texture data. - -
 
async:Boolean (default = false) — If true, this function returns immediately. Any draw method - - which attempts to use the texture will fail until the upload completes successfully. Upon successful - - upload, this Texture object dispatches Event.TEXTURE_READY. - - Default value: false. - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
ArgumentError — Texture Decoding Failed: when the compression format of this object cannot be - - derived from the format of the compressed data in data or when the SWF version is - - incompatible with the ATF file version. - -
 
ArgumentError — Texture Size Does Not Match: when the width and height of the decompressed - - texture do not equal the dimensions of this Texture object. - -
 
ArgumentError — Miplevel Too Large: if the mip level of the decompressed texture is greater - - than that implied by the size of the texture. - -
 
ArgumentError — Texture Format Mismatch: if the decoded ATF bytes don't contain a texture - - compatible with this texture's format. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - -
 
RangeError — Bad Input Size: when there is integer overflow of byteArrayOffset or - - if byteArrayOffset + 6 is greater than the length of data, or if the - - number of bytes available from byteArrayOffset to the end of the data byte array - - is less than the amount of data required for ATF texture. - - - -
-

-See also -

-
-flash.events.Event.TEXTURE_READY -
-
- - - - - -
uploadFromBitmapData()method 
-
-public function uploadFromBitmapData(source:BitmapData, miplevel:uint = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Uploads a texture from a BitmapData object. - - -

Parameters - - - - - - - - - - -
source:BitmapData — a bitmap. - -
 
miplevel:uint (default = 0) — the mip level to be loaded, level zero being the top-level - - full-resolution image. - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when source is null. - -
 
ArgumentError — Miplevel Too Large: if the specified mip level is greater than that - - implied by the larger of the Texture's dimensions. - -
 
ArgumentError — Invalid BitmapData Error: if source if the BitmapData - - object does not contain a valid cube texture face. The image must have sides - - equal to a power of two, and the correct size for the miplevel specified. - -
 
ArgumentError — Texture Format Mismatch: if the texture format is Context3DTextureFormat.COMPRESSED or - - Context3DTextureFormat.COMPRESSED_ALPHA and the code is executing on a mobile platform where runtime texture compression is not supported. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - - -
-
- - - - - -
uploadFromBitmapDataAsync()method 
-
-public function uploadFromBitmapDataAsync(source:BitmapData, miplevel:uint = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Uploads miplevel 0 for a texture from a BitmapData object asynchronously. - - Any draw method which attempts to use the texture fails until the upload completes successfully. - - Upon successful upload, this Texture object dispatches Event.TEXTURE_READY. - - Event.TEXTURE_READY is a callback to indicate that the asynchronous call received for the texture object have been executed successfully. - - Upon any error during the background upload , this Texture object dispatches ErrorEvent.ERROR. - - -

Parameters - - - - - - - - - - -
source:BitmapData — a bitmap - -
 
miplevel:uint (default = 0)
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when source is null. - -
 
ArgumentError — Invalid BitmapData Error: if source if the BitmapData - - object does not contain a valid texture. The image must be - - equal to a power of two, and the correct size for the miplevel specified. - -
 
ArgumentError — Texture Format Mismatch: if the texture format is Context3DTextureFormat.COMPRESSED or - - Context3DTextureFormat.COMPRESSED_ALPHA and the code is executing on a mobile platform where runtime texture compression is not supported. - -
 
ArgumentError — Asynchronous upload supported for miplevel 0 only. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - -
-

-See also -

-
-flash.events.Event.TEXTURE_READY -
-
- - - - - -
uploadFromByteArray()method 
-
-public function uploadFromByteArray(data:ByteArray, byteArrayOffset:uint, miplevel:uint = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Uploads a texture from a ByteArray. - - -

Parameters - - - - - - - - - - - - - - - - -
data:ByteArray — a byte array that is contains enough bytes in the textures internal format to fill the texture. - - rgba textures are read as bytes per texel component (1 or 4). - - float textures are read as floats per texel component (1 or 4). - - The ByteArray object must use the little endian format. - - -
 
byteArrayOffset:uint — the position in the byte array object at which to start reading the texture data. - -
 
miplevel:uint (default = 0) — the mip level to be loaded, level zero is the top-level, - - full-resolution image. - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
ArgumentError — Miplevel Too Large: if the specified mip level is greater than - - that implied by the larger of the Texture's dimensions. - -
 
RangeError — Bad Input Size: if the number of bytes available from byteArrayOffset - - to the end of the data byte array is less than the amount of data required - - for a texture of this mip level or if byteArrayOffset is greater than or equal to the length of data. - -
 
ArgumentError — Texture Format Mismatch: if the texture format is Context3DTextureFormat.COMPRESSED or - - Context3DTextureFormat.COMPRESSED_ALPHA and the code is executing on a mobile platform where runtime texture compression is not supported. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - - - -
-
- - - - - -
uploadFromByteArrayAsync()method 
-
-public function uploadFromByteArrayAsync(data:ByteArray, byteArrayOffset:uint, miplevel:uint = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Uploads miplevel 0 for a texture from a ByteArray asynchronously. - - Any draw method which attempts to use the texture fails until the upload completes successfully. - - Upon successful upload, this Texture object dispatches Event.TEXTURE_READY. - - Event.TEXTURE_READY is a callback to indicate that the asynchronous calls received for the texture object have been executed successfully. - - Upon any error during the background upload, this Texture object dispatches ErrorEvent.ERROR. - - -

Parameters - - - - - - - - - - - - - - - - -
data:ByteArray — a byte array that contains enough bytes in the textures internal format to fill the texture. - - rgba textures are read as bytes per texel component (1 or 4). - - float textures are read as floats per texel component (1 or 4). - - The ByteArray object must use the little endian format. - - -
 
byteArrayOffset:uint — the position in the byte array object at which to start reading the texture data. - -
 
miplevel:uint (default = 0)
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeError — Null Pointer Error: when data is null. - -
 
RangeError — Bad Input Size: if the number of bytes available from byteArrayOffset - - to the end of the data byte array is less than the amount of data required - - for a texture of mip level 0 or if byteArrayOffset is greater than or equal to the length of data. - -
 
ArgumentError — Texture Format Mismatch: if the texture format is Context3DTextureFormat.COMPRESSED or - - Context3DTextureFormat.COMPRESSED_ALPHA and the code is executing on a mobile platform where runtime texture compression is not supported. - -
 
ArgumentError — Asynchronous upload supported for miplevel 0 only. - -
 
Error — 3768: The Stage3D API may not be used during background execution. - -
 
Error — if an async upload has been initiated on a texture object and there is another asynchronous upload call on the same texture object. - - - -
-

-See also -

-
-flash.events.Event.TEXTURE_READY -
-
-
Event detail
- - - - - -
errorevent 
-
-Event object type: flash.events.ErrorEvent -
-ErrorEvent.type property = flash.events.ErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Dispatched by the Texture object when an asynchronous texture upload - - operation fails in some way. The failure code is provided in the - - errorID field of the error object. - -

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -
- - - - - -
textureReadyevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.TEXTURE_READY -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Dispatched by the Texture object when an asynchronous texture upload - - operation has completed successfully, and the texture can then be used. - -

- The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object. - - This event is dispatched by Texture, RectangleTexture and CubeTexture objects to signal the completion of an asynchronous upload. Request an - asynchronous upload by using the uploadCompressedTextureFromByteArray() method with a true - value for the async argument, or using a method such as uploadFromBitmapDataAsync or - uploadFromByteArrayAsync. - This event neither bubbles nor is cancelable. -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe texture object that dispatched this event.
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/display3D/textures/TextureBase.html b/html-docs/flash/display3D/textures/TextureBase.html deleted file mode 100644 index 868c639..0000000 --- a/html-docs/flash/display3D/textures/TextureBase.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - - - -flash.display3D.textures.TextureBase (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.display3D.textures
Classpublic class TextureBase
InheritanceTextureBase Inheritance EventDispatcher Inheritance Object
SubclassesCubeTexture, RectangleTexture, Texture, VideoTexture
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The TextureBase class is the base class for Context3D texture objects. - -

Note: You cannot create your own texture classes using TextureBase. To - add functionality to a texture class, extend either Texture or CubeTexture instead.

- -

-

-See also -

-
-Texture -
-CubeTexture -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-dispose():void -
-
- Frees all GPU resources associated with this texture.
-		TextureBase
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Method detail
- - - - - -
dispose()method
-
-public function dispose():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Frees all GPU resources associated with this texture. - After disposal, calling upload() or rendering with this object fails. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/textures/VideoTexture.html b/html-docs/flash/display3D/textures/VideoTexture.html deleted file mode 100644 index 37967aa..0000000 --- a/html-docs/flash/display3D/textures/VideoTexture.html +++ /dev/null @@ -1,449 +0,0 @@ - - - - - - - - -flash.display3D.textures.VideoTexture (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.display3D.textures
Classpublic final class VideoTexture
InheritanceVideoTexture Inheritance TextureBase Inheritance EventDispatcher Inheritance Object
-

- Prior to Flash Player 21, the use of video in Stage3D required the use of the Video object - (which is not hardware accelerated), copying of video frame to a BitmapData object, - and loading of the data onto the GPU which is CPU intensive. Thus, Video texture object was - introduced. It allows hardware decoded video to be used in Stage 3D content. -

For Flash Player 22, video texture objects were added to support NetStream and Cameras - in a manner consistent/ similar to StageVideo. Such textures can be used as source textures - in the stage3D rendering pipeline. The textures can be used as rectangular, RGB, no mipmap - textures in the rendering of a scene. They are treated as ARGB texture by the shaders - (that is, the AGAL shaders do not have to bother about YUV->RGB conversion) and so the standard shaders - with static images can be used without change. The image used by the rendering pipeline is the - latest up-to-date frame at the time the rendering occurs using this texture. - There is no tearing in a video frame, however if the same texture is used several times, some of - the instances may be from different timestamps.

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  videoHeight : int -
[read-only] - An integer specifying the height of the video stream, in pixels.
-		VideoTexture
  videoWidth : int -
[read-only] - An integer specifying the width of the video stream, in pixels.
-		VideoTexture
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-attachCamera(theCamera:Camera):void -
-
- Specifies a video stream from a camera to be rendered within the texture of the VideoTexture object.
-		VideoTexture
   -
-attachNetStream(netStream:NetStream):void -
-
- Specifies a video stream to be rendered within the texture of the VideoTexture object.
-		VideoTexture
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-dispose():void -
-
- Frees all GPU resources associated with this texture.
-		TextureBase
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
videoHeightproperty
-
-videoHeight:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 17.0 -
-

- An integer specifying the height of the video stream, in pixels. -

For a live stream, this value is the same as the Camera.height property of the Camera object that is capturing the video stream. - For a recorded video file, this value is the height of the video. - The NetStream.Video.DimensionChange event is dispatched in the case of recorded videos when this value changes.

- Implementation -
-    public function get videoHeight():int -
-
- - - - - -
videoWidthproperty 
-
-videoWidth:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 17.0 -
-

- An integer specifying the width of the video stream, in pixels. -

For a live stream, this value is the same as the Camera.width property of the Camera object that is capturing the video stream. - For a recorded video file, this value is the width of the video. - The NetStream.Video.DimensionChange event is dispatched in the case of recorded videos when this value changes.

- Implementation -
-    public function get videoWidth():int -
-
- -
Method detail
- - - - - -
attachCamera()method
-
-public function attachCamera(theCamera:Camera):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 17.0 -
-

- Specifies a video stream from a camera to be rendered within the texture of the VideoTexture object. -

Use this method to attach live video captured by the user to the VideoTexture object. To drop the connection - to the VideoTexture object, set the value of the theCamera parameter to null.

- Parameters - - - - -
theCamera:Camera
-
- - - - - -
attachNetStream()method 
-
-public function attachNetStream(netStream:NetStream):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 17.0 -
-

- Specifies a video stream to be rendered within the texture of the VideoTexture object. -

A video file can be stored on the local file system or on Flash Media Server. - If the value of the netStream argument is null, the video is no longer played in the VideoTexture object.

- Parameters - - - - -
netStream:NetStream
-
-
Event detail
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/display3D/textures/package-detail.html b/html-docs/flash/display3D/textures/package-detail.html deleted file mode 100644 index b9ce51a..0000000 --- a/html-docs/flash/display3D/textures/package-detail.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - -flash.display3D.textures Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.display3D.textures package contains classes for textures.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - -
 ClassDescription
 CubeTexture - The CubeTexture class represents a cube texture uploaded to a rendering context.
 RectangleTexture - The Rectangle Texture class represents a 2-dimensional texture uploaded to a rendering context.
 Texture - The Texture class represents a 2-dimensional texture uploaded to a rendering context.
 TextureBase - The TextureBase class is the base class for Context3D texture objects.
 VideoTexture - Prior to Flash Player 21, the use of video in Stage3D required the use of the Video object - (which is not hardware accelerated), copying of video frame to a BitmapData object, - and loading of the data onto the GPU which is CPU intensive.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/errors/DRMManagerError.html b/html-docs/flash/errors/DRMManagerError.html deleted file mode 100644 index 12e8404..0000000 --- a/html-docs/flash/errors/DRMManagerError.html +++ /dev/null @@ -1,371 +0,0 @@ - - - - - - - - -flash.errors.DRMManagerError (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.errors
Classpublic class DRMManagerError
InheritanceDRMManagerError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The DRMManager dispatches a DRMManagerError event to report errors. - -

-

-See also -

-
-flash.net.drm.DRMManager -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  subErrorID : int -
[read-only] - The specific error number.
-		DRMManagerError
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMManagerError(message:String, id:int, subErrorID:int)
-
- Creates a new instance of the DRMManagerError class.
-		DRMManagerError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		DRMManagerError
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
subErrorIDproperty
-
-subErrorID:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The specific error number. - -

Implementation -
-    public function get subErrorID():int -
-
- -
Constructor detail
- - - - - -
DRMManagerError()constructor
-
-public function DRMManagerError(message:String, id:int, subErrorID:int) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new instance of the DRMManagerError class. - -

Parameters - - - - - - - - - - - - - - - - -
message:String — The error description -
 
id:int — The general error number -
 
subErrorID:int — The specific error number - -
-
- -
Method detail
- - - - - -
toString()method
-
-public function toString():String

- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined. - - -

-Returns - - - - -
String — - The error message. - - - - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/errors/InvalidSWFError.html b/html-docs/flash/errors/InvalidSWFError.html deleted file mode 100644 index 50acc99..0000000 --- a/html-docs/flash/errors/InvalidSWFError.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - - - -flash.errors.InvalidSWFError (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.errors
Classpublic dynamic class InvalidSWFError
InheritanceInvalidSWFError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

-

- - The Flash runtimes throw this exception when they encounter a corrupted SWF file. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-InvalidSWFError(message:String = "", id:int = 0)
-
- - Creates a new InvalidSWFError object.
-		InvalidSWFError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
InvalidSWFError()constructor
-
-public function InvalidSWFError(message:String = "", id:int = 0) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Creates a new InvalidSWFError object. - - - -

Parameters - - - - - - - - - - -
message:String (default = "") — A string associated with the error object. - - -
 
id:int (default = 0)
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Jul 3 2024, 9:16 AM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/errors/PermissionError.html b/html-docs/flash/errors/PermissionError.html deleted file mode 100644 index b0bd0bf..0000000 --- a/html-docs/flash/errors/PermissionError.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - - -flash.errors.PermissionError (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.errors
Classpublic class PermissionError
InheritancePermissionError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

-

- Permission error is dispatched when the application tries to access a resource - without requesting appropriate permissions. - - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-PermissionError(message:String, id:int)
-
- Creates a new instance of the PermissionError class.
-		PermissionError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		PermissionError
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
PermissionError()constructor
-
-public function PermissionError(message:String, id:int) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Creates a new instance of the PermissionError class. - -

Parameters - - - - - - - - - - -
message:String — The error description -
 
id:int — The general error number - -
-
- -
Method detail
- - - - - -
toString()method
-
-public function toString():String

- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined. - - -

-Returns - - - - -
String — - The error message. - - - - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/errors/SQLError.html b/html-docs/flash/errors/SQLError.html deleted file mode 100644 index 664eac1..0000000 --- a/html-docs/flash/errors/SQLError.html +++ /dev/null @@ -1,577 +0,0 @@ - - - - - - - - -flash.errors.SQLError (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.errors
Classpublic class SQLError
InheritanceSQLError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A SQLError instance provides detailed information about a failed operation. -

In asynchronous execution mode, when an error occurs - with a SQL database operation the SQLConnection or SQLStatement instance - dispatches a SQLErrorEvent object. Information about the error in the form of a - SQLError instance can be accessed from the SQLErrorEvent object's error - property.

-

In synchronous execution mode, when an error occurs with a SQL - database operation the SQLConnection or SQLStatement instance throws a - SQLError exception, which can be handled by enclosing the error-throwing code in - a try..catch block.

-

This class provides properties containing the error details (specifying the specific type of - error that occured), a text message - containing the details of the error, and the operation that caused the - error to occur.

-

-

-See also -

-
-flash.events.SQLErrorEvent -
-flash.data.SQLConnection -
-flash.data.SQLStatement -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  detailArguments : Array -
[read-only] - An array of String values that can be used to construct a locale specific - detail error message.
-		SQLError
  detailID : int -
[read-only] - A reference number associated with the specific detail message.
-		SQLError
  details : String -
[read-only] - Details of the current error.
-		SQLError
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
  operation : String -
[read-only] - A value indicating the operation that was being attempted when the error occurred.
-		SQLError
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLError(operation:String, details:String = "", message:String = "", id:int = 0, detailID:int = -1, detailArgs:Array = null)
-
- Creates a SQLError instance that can be thrown or used with a - SQLErrorEvent instance's error property.
-		SQLError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		SQLError
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
detailArgumentsproperty
-
-detailArguments:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.1 -
-

- An array of String values that can be used to construct a locale specific - detail error message. - -

This property contains the value or values that are substituted into - the details property error message to indicate the specific - database object or objects (table name, column name, and so forth) - associated with the error. For example, suppose an error with the following - details property error message occurs in an application:

- - 
there is already another table or index with this name: 'my_table'
- -

In that case, the SQLError instance's detailArguments - property would contain a single element with the value "my_table".

- -

Using the detailID property an - application can identify the specific details error message. The - application can provide alternate text for the end user in the language - of his or her locale. The argument values in the detailArguments array - can be substituted in the appropriate position in the error message string. This - is useful for applications that wish to display the details - property error message for this error directly to end users in a specific locale.

- -

For a list of the detailID values and their corresponding - English error details message and arguments, see - "SQL error detail messages, ids, and arguments."

- - Implementation -
-    public function get detailArguments():Array -
-
- - - - - -
detailIDproperty 
-
-detailID:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.1 -
-

- A reference number associated with the specific detail message. - This value is used to support locale specific translations of the - details property error message. - -

This property provides a unique identifier for each details - message. (For any type of error with a specific errorID there are - multiple errors with unique detailID values.) Using this - identifier together with the value or values in the - detailArguments array, an application can provide - locale specific detail error messages. This is useful for applications - that wish to display the details property error message for - this error directly to end users in a specific locale.

- -

For a list of the detailID values and their corresponding - English error details message and arguments, see - "SQL error detail messages, ids, and arguments."

- - Implementation -
-    public function get detailID():int -
-
- - - - - -
detailsproperty 
-
-details:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Details of the current error. This provides additional specific - information about the error that occurred. -

Implementation -
-    public function get details():String -
-
- - - - - -
operationproperty 
-
-operation:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A value indicating the operation that was being attempted when the error occurred. - This value is one of the constants defined in the SQLErrorOperation class. -

Implementation -
-    public function get operation():String -
-

-See also -

-
-flash.errors.SQLErrorOperation -
-
- -
Constructor detail
- - - - - -
SQLError()constructor
-
-public function SQLError(operation:String, details:String = "", message:String = "", id:int = 0, detailID:int = -1, detailArgs:Array = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLError instance that can be thrown or used with a - SQLErrorEvent instance's error property. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
operation:String — Indicates the specific operation that caused - the failure. The value is one of the constants defined in the - SQLErrorOperation class. -
 
details:String (default = "") — The details for the current error. -
 
message:String (default = "") — The description of the error that - occurred. -
 
id:int (default = 0) — A reference number associated with the specific error message. -
 
detailID:int (default = -1) — A reference number associated with the detail error message. - -
 
detailArgs:Array (default = null) — An ordered array of substitution values that can be used - to construct a locale specific detail error message. -
-

-See also -

-
-flash.errors.SQLErrorOperation -
-
- -
Method detail
- - - - - -
toString()method
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined. - - -

-Returns - - - - -
String — - The error message. - - - - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/errors/SQLErrorOperation.html b/html-docs/flash/errors/SQLErrorOperation.html deleted file mode 100644 index 77aa421..0000000 --- a/html-docs/flash/errors/SQLErrorOperation.html +++ /dev/null @@ -1,776 +0,0 @@ - - - - - - - - -flash.errors.SQLErrorOperation (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.errors
Classpublic class SQLErrorOperation
InheritanceSQLErrorOperation Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- This class contains the constants that represent the possible values for the - SQLError.operation property. These values indicate the attempted operation - that caused the error to occur. -

Each value represents one of the operations of the SQLConnection class - or the SQLStatement class.

-

-

-See also -

-
-flash.errors.SQLError.operation -
-flash.data.SQLConnection -
-flash.data.SQLStatement -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ANALYZE : String = "analyze"
[static] - Indicates that the SQLConnection.analyze() method was called.
-		SQLErrorOperation
  ATTACH : String = "attach"
[static] - Indicates that the SQLConnection.attach() method was called.
-		SQLErrorOperation
  BEGIN : String = "begin"
[static] - Indicates that the SQLConnection.begin() method was called.
-		SQLErrorOperation
  CLOSE : String = "close"
[static] - Indicates that the SQLConnection.close() method was called.
-		SQLErrorOperation
  COMMIT : String = "commit"
[static] - Indicates that the SQLConnection.commit() method was called.
-		SQLErrorOperation
  COMPACT : String = "compact"
[static] - Indicates that the SQLConnection.compact() method was called.
-		SQLErrorOperation
  DEANALYZE : String = "deanalyze"
[static] - Indicates that the SQLConnection.deanalyze() method was called.
-		SQLErrorOperation
  DETACH : String = "detach"
[static] - Indicates that the SQLConnection.detach() method was called.
-		SQLErrorOperation
  EXECUTE : String = "execute"
[static] - Indicates that either the SQLStatement.execute() method - or the SQLStatement.next() method was called.
-		SQLErrorOperation
  OPEN : String = "open"
[static] - Indicates that either the SQLConnection.open() method or the SQLConnection.openAsync() method was called.
-		SQLErrorOperation
  REENCRYPT : String = "reencrypt"
[static] - Indicates that the SQLConnection.reencrypt() method was called.
-		SQLErrorOperation
  RELEASE_SAVEPOINT : String = "releaseSavepoint"
[static] - Indicates that the SQLConnection.releaseSavepoint() method was called.
-		SQLErrorOperation
  ROLLBACK : String = "rollback"
[static] - Indicates that the SQLConnection.rollback() method was called.
-		SQLErrorOperation
  ROLLBACK_TO_SAVEPOINT : String = "rollbackToSavepoint"
[static] - Indicates that the SQLConnection.rollbackToSavepoint() method was called.
-		SQLErrorOperation
  SCHEMA : String = "schema"
[static] - Indicates that the SQLConnection.loadSchema() method was called.
-		SQLErrorOperation
  SET_SAVEPOINT : String = "setSavepoint"
[static] - Indicates that the SQLConnection.setSavepoint() method was called.
-		SQLErrorOperation
-
- -
- -
Constant detail
- - - - - -
ANALYZEconstant
-
-public static const ANALYZE:String = "analyze" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the SQLConnection.analyze() method was called. -

-See also -

-
-flash.data.SQLConnection.analyze() -
-
- - - - - -
ATTACHconstant 
-
-public static const ATTACH:String = "attach" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the SQLConnection.attach() method was called. -

-See also -

-
-flash.data.SQLConnection.attach() -
-
- - - - - -
BEGINconstant 
-
-public static const BEGIN:String = "begin" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the SQLConnection.begin() method was called. -

-See also -

-
-flash.data.SQLConnection.begin() -
-
- - - - - -
CLOSEconstant 
-
-public static const CLOSE:String = "close" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the SQLConnection.close() method was called. -

-See also -

-
-flash.data.SQLConnection.close() -
-
- - - - - -
COMMITconstant 
-
-public static const COMMIT:String = "commit" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the SQLConnection.commit() method was called. -

-See also -

-
-flash.data.SQLConnection.commit() -
-
- - - - - -
COMPACTconstant 
-
-public static const COMPACT:String = "compact" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the SQLConnection.compact() method was called. -

-See also -

-
-flash.data.SQLConnection.compact() -
-
- - - - - -
DEANALYZEconstant 
-
-public static const DEANALYZE:String = "deanalyze" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the SQLConnection.deanalyze() method was called. -

-See also -

-
-flash.data.SQLConnection.deanalyze() -
-
- - - - - -
DETACHconstant 
-
-public static const DETACH:String = "detach" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the SQLConnection.detach() method was called. -

-See also -

-
-flash.data.SQLConnection.detach() -
-
- - - - - -
EXECUTEconstant 
-
-public static const EXECUTE:String = "execute" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that either the SQLStatement.execute() method - or the SQLStatement.next() method was called. -

-See also -

-
-flash.data.SQLStatement.execute() -
-
- - - - - -
OPENconstant 
-
-public static const OPEN:String = "open" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that either the SQLConnection.open() method or the SQLConnection.openAsync() method was called. -

-See also -

-
-flash.data.SQLConnection.open() -
-flash.data.SQLConnection.openAsync() -
-
- - - - - -
REENCRYPTconstant 
-
-public static const REENCRYPT:String = "reencrypt" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that the SQLConnection.reencrypt() method was called. -

-See also -

-
-flash.data.SQLConnection.reencrypt() -
-
- - - - - -
RELEASE_SAVEPOINTconstant 
-
-public static const RELEASE_SAVEPOINT:String = "releaseSavepoint" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the SQLConnection.releaseSavepoint() method was called. -

-See also -

-
-flash.data.SQLConnection.releaseSavepoint() -
-
- - - - - -
ROLLBACKconstant 
-
-public static const ROLLBACK:String = "rollback" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the SQLConnection.rollback() method was called. -

-See also -

-
-flash.data.SQLConnection.rollback() -
-
- - - - - -
ROLLBACK_TO_SAVEPOINTconstant 
-
-public static const ROLLBACK_TO_SAVEPOINT:String = "rollbackToSavepoint" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the SQLConnection.rollbackToSavepoint() method was called. -

-See also -

-
-flash.data.SQLConnection.rollbackToSavepoint() -
-
- - - - - -
SCHEMAconstant 
-
-public static const SCHEMA:String = "schema" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the SQLConnection.loadSchema() method was called. -

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-
- - - - - -
SET_SAVEPOINTconstant 
-
-public static const SET_SAVEPOINT:String = "setSavepoint" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the SQLConnection.setSavepoint() method was called. -

-See also -

-
-flash.data.SQLConnection.setSavepoint() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/errors/ScriptTimeoutError.html b/html-docs/flash/errors/ScriptTimeoutError.html deleted file mode 100644 index 985b8a1..0000000 --- a/html-docs/flash/errors/ScriptTimeoutError.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - -flash.errors.ScriptTimeoutError (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.errors
Classpublic dynamic class ScriptTimeoutError
InheritanceScriptTimeoutError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - The ScriptTimeoutError exception is thrown when the script timeout interval is reached. - - The script timeout interval is 15 seconds. There are two XML attributes - - that you can add to the mx:Application tag: scriptTimeLimit - - (the number of seconds until script timeout) and scriptRecursionLimit - - (the depth of recursive calls permitted). - - - -

Two ScriptTimeoutError exceptions are thrown. The first exception you can catch and exit - - cleanly. If there is no exception handler, the uncaught exception terminates execution. The - - second exception is thrown but cannot be caught by user code; it goes to the uncaught - - exception handler. It is uncatchable to prevent the player from hanging - - indefinitely.

- - - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ScriptTimeoutError(message:String = "")
-
- - Creates a new ScriptTimeoutError object.
-		ScriptTimeoutError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
ScriptTimeoutError()constructor
-
-public function ScriptTimeoutError(message:String = "") -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Creates a new ScriptTimeoutError object. - - - -

Parameters - - - - -
message:String (default = "") — A string associated with the error object. - - -
-
- -
Examples
-
examples\ScriptTimeoutErrorExample
-
The following example uses the sample ScriptTimeoutErrorExample class to show - the error generated in the event of script timeout. This is accomplished with the following - steps: -
    -
  1. A keepLooking Boolean property is declared.
    2. -
  2. The constructor calls the lockMachine() method within an error handling code - segment that catches ScriptTimeoutError objects.
    3. -
  3. The lockMachine() method contains an endless while loop.
    4. -
  4. After awhile, the ScriptTimeoutError is thrown. The constructor catches it, - outputs an error message through the trace statement and resets the keepLooking - Boolean to false, which terminates the while loop in lockMachine().
    5. -
-
-
-package {
-	import flash.display.Sprite;
-	import flash.errors.ScriptTimeoutError;
-
-	public class ScriptTimeoutErrorExample extends Sprite {		
-		private var keepLooping:Boolean = true;
-
-		public function ScriptTimeoutErrorExample() {
-			try {
-				lockMachine();
-			} 
-			catch(e:ScriptTimeoutError) {
-				trace(e);	// ScriptTimeoutError: Error #1502: A script has executed for longer than 15 seconds
-				keepLooping = false;
-			}
-		}
-		
-		private function lockMachine():void {
-			while(keepLooping){		
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Jul 3 2024, 9:16 AM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/errors/StackOverflowError.html b/html-docs/flash/errors/StackOverflowError.html deleted file mode 100644 index 7f02d02..0000000 --- a/html-docs/flash/errors/StackOverflowError.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - - - -flash.errors.StackOverflowError (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.errors
Classpublic dynamic class StackOverflowError
InheritanceStackOverflowError Inheritance Error Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - ActionScript throws a StackOverflowError exception when the stack available to the script - - is exhausted. ActionScript uses a stack to store information about each method call made in - - a script, such as the local variables that the method uses. The amount of stack space - - available varies from system to system. - - - -

A StackOverflowError exception might indicate that infinite recursion has occurred, in - - which case a termination case needs to be added to the function. It also might indicate - - that the recursive algorithm has a proper terminating condition but has exhausted the stack - - anyway. In this case, try to express the algorithm iteratively instead.

- - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritederrorID : int -
- - Contains the reference number associated with the specific error message.
-		Error
 Inheritedmessage : String -
- - Contains the message associated with the Error object.
-		Error
 Inheritedname : String -
- - Contains the name of the Error object.
-		Error
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StackOverflowError(message:String = "")
-
- - Creates a new StackOverflowError object.
-		StackOverflowError
 Inherited -
-getStackTrace():String -
-
- - Returns the call stack for an error at the time of the error's - - construction as a string.
-		Error
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - - - Returns the string "Error" by default or the value contained in the Error.message property, - - if defined.
-		Error
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
StackOverflowError()constructor
-
-public function StackOverflowError(message:String = "") -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Creates a new StackOverflowError object. - -

Parameters - - - - -
message:String (default = "") — A string associated with the error object. - - -
-
- -
Examples
-
examples\StackOverflowErrorExample
-
The following example uses the sample StackOverflowErrorExample class to show - the error generated in the event of a stack overflow. This is accomplished using the following - steps: -
    -
  1. The constructor calls the method lockMachine() within an error handling code - segment that catches StackOverflowError objects.
    2. -
  2. The lockMachine() method calls itself until the stack overflows.
    3. -
  3. After the StackOverflowError is thrown, the constructor catches it and then outputs an - error message through the trace statement.
    4. -
-
-
-package {
-	import flash.display.Sprite;
-	import flash.errors.StackOverflowError;
-
-	public class StackOverflowErrorExample extends Sprite {		
-		public function StackOverflowErrorExample() {
-			try {
-				lockMachine();
-			} 
-			catch(e:StackOverflowError) {
-				trace(e);	// StackOverflowError: Error #1023: Stack overflow.
-			}
-		}
-		
-		private function lockMachine():void {
-			lockMachine();
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Jul 3 2024, 9:16 AM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/errors/package-detail.html b/html-docs/flash/errors/package-detail.html deleted file mode 100644 index 00b70c6..0000000 --- a/html-docs/flash/errors/package-detail.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - -flash.errors Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.error package contains error classes that are part of the Flash Player Application - Programming Interface (API), rather than part of the ActionScript core language. - -

The ActionScript core language is the part of the language that complies with the ECMAScript standard. - The Flash Player API is the part of the language that is specific to ActionScript. The flash.error package - relates to Flash Player specific functionality (Flash Player API).

- -

The error classes that are not part of the flash.error package are top level core classes that are based - on the ECMAScript standard.

- -

Note: In ActionScript 3.0, exceptions are the primary mechanism for reporting runtime errors. - Error events are a secondary mechanism that are used when errors are encountered during an asynchronous - operation, such as a call to the Loader.load() method.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 DRMManagerError - The DRMManager dispatches a DRMManagerError event to report errors.
 InvalidSWFError - - The Flash runtimes throw this exception when they encounter a corrupted SWF file.
 PermissionError - Permission error is dispatched when the application tries to access a resource - without requesting appropriate permissions.
 ScriptTimeoutError - - The ScriptTimeoutError exception is thrown when the script timeout interval is reached.
 SQLError - A SQLError instance provides detailed information about a failed operation.
 SQLErrorOperation - This class contains the constants that represent the possible values for the - SQLError.operation property.
 StackOverflowError - - ActionScript throws a StackOverflowError exception when the stack available to the script - - is exhausted.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Jul 3 2024, 9:16 AM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/events/AccelerometerEvent.html b/html-docs/flash/events/AccelerometerEvent.html deleted file mode 100644 index 078c6ed..0000000 --- a/html-docs/flash/events/AccelerometerEvent.html +++ /dev/null @@ -1,971 +0,0 @@ - - - - - - - - -flash.events.AccelerometerEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class AccelerometerEvent
InheritanceAccelerometerEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2
-

-

-The Accelerometer class dispatches AccelerometerEvent objects when acceleration updates are obtained from the Accelerometer sensor installed on the device. -

-

-See also -

-
-flash.sensors.Accelerometer -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  accelerationX : Number -
- Acceleration along the x-axis, measured in Gs.
-		AccelerometerEvent
  accelerationY : Number -
- Acceleration along the y-axis, measured in Gs.
-		AccelerometerEvent
  accelerationZ : Number -
- Acceleration along the z-axis, measured in Gs.
-		AccelerometerEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
  timestamp : Number -
- The number of milliseconds at the time of the event since the runtime was initialized.
-		AccelerometerEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-AccelerometerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, timestamp:Number = 0, accelerationX:Number = 0, accelerationY:Number = 0, accelerationZ:Number = 0)
-
- Creates an AccelerometerEvent object that contains information about acceleration along three dimensional axis.
-		AccelerometerEvent
   -
-clone():Event -
-
- Creates a copy of an AccelerometerEvent object and sets the value of each property to match that of - the original.
-		AccelerometerEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the AccelerometerEvent object.
-		AccelerometerEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
  UPDATE : String = "update"
[static] - Defines the value of the type property of a AccelerometerEvent event object.
-		AccelerometerEvent
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
accelerationXproperty
-
-accelerationX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Acceleration along the x-axis, measured in Gs. (1 G is roughly 9.8 m/sec/sec.) The x-axis runs from the left to the right of the device - when it is in the upright position. The acceleration is positive if the device moves towards the right. -

Implementation -
-    public function get accelerationX():Number -
-    public function set accelerationX(value:Number):void -
-
- - - - - -
accelerationYproperty 
-
-accelerationY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Acceleration along the y-axis, measured in Gs. (1 G is roughly 9.8 m/sec/sec.). - The y-axis runs from the bottom to the top of the device when it is in the upright position. - The acceleration is positive if the device moves up relative to this axis. -

Implementation -
-    public function get accelerationY():Number -
-    public function set accelerationY(value:Number):void -
-
- - - - - -
accelerationZproperty 
-
-accelerationZ:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Acceleration along the z-axis, measured in Gs. (1 G is roughly 9.8 m/sec/sec.). - The z-axis runs perpendicular to the face of the device. The acceleration is positive if you move the device - so that the face moves higher. -

Implementation -
-    public function get accelerationZ():Number -
-    public function set accelerationZ(value:Number):void -
-
- - - - - -
timestampproperty 
-
-timestamp:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The number of milliseconds at the time of the event since the runtime was initialized. - For example, if the device captures accelerometer data 4 seconds after the application initializes, - then the timestamp property of the event is set to 4000. -

Implementation -
-    public function get timestamp():Number -
-    public function set timestamp(value:Number):void -
-
- -
Constructor detail
- - - - - -
AccelerometerEvent()constructor
-
-public function AccelerometerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, timestamp:Number = 0, accelerationX:Number = 0, accelerationY:Number = 0, accelerationZ:Number = 0) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates an AccelerometerEvent object that contains information about acceleration along three dimensional axis. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of update event: AccelerometerEvent.UPDATE. -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
timestamp:Number (default = 0) — The timestamp of the Accelerometer update. -
 
accelerationX:Number (default = 0) — The acceleration value in Gs (9.8m/sec/sec) along the x-axis. -
 
accelerationY:Number (default = 0) — The acceleration value in Gs (9.8m/sec/sec) along the y-axis. -
 
accelerationZ:Number (default = 0) — The acceleration value in Gs (9.8m/sec/sec) along the z-axis. - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates a copy of an AccelerometerEvent object and sets the value of each property to match that of - the original. - -

-Returns - - - - -
Event — - A new AccelerometerEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that contains all the properties of the AccelerometerEvent object. The following - format is used: -

[AccelerometerEvent type=value bubbles=value cancelable=value - timestamp=value accelerationX=value accelerationY=value accelerationZ=value ]

- -

-Returns - - - - -
String — - A string that contains all the properties of the AccelerometerEvent object. - - -
-
- -
Constant detail
- - - - - -
UPDATEconstant
-
-public static const UPDATE:String = "update" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a AccelerometerEvent event object. -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
timestampThe timestamp of the Accelerometer update.
accelerationXThe acceleration value in Gs (9.8m/sec/sec) along the x-axis.
accelerationYThe acceleration value in Gs (9.8m/sec/sec) along the y-axis.
accelerationZThe acceleration value in Gs (9.8m/sec/sec) along the z-axis.
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/ActivityEvent.html b/html-docs/flash/events/ActivityEvent.html deleted file mode 100644 index 8519225..0000000 --- a/html-docs/flash/events/ActivityEvent.html +++ /dev/null @@ -1,890 +0,0 @@ - - - - - - - - -flash.events.ActivityEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.events
Classpublic class ActivityEvent
InheritanceActivityEvent Inheritance Event Inheritance Object
SubclassesFullScreenEvent
-

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-A Camera or Microphone object dispatches an ActivityEvent object whenever a camera or microphone reports that it has -become active or inactive. There is only one type of activity event: ActivityEvent.ACTIVITY. -

-

-View the examples. -

-

-See also -

-
-ActivityEvent.ACTIVITY -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  activating : Boolean -
- Indicates whether the device is activating (true) or deactivating - (false).
-		ActivityEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ActivityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, activating:Boolean = false)
-
- Creates an event object that contains information about activity events.
-		ActivityEvent
   -
-clone():Event -
-
- Creates a copy of an ActivityEvent object and sets the value of each property to match that of - the original.
-		ActivityEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the ActivityEvent object.
-		ActivityEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
  ACTIVITY : String = "activity"
[static] - The ActivityEvent.ACTIVITY constant defines the value of the type property of an activity event object.
-		ActivityEvent
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
activatingproperty
-
-activating:Boolean  [read-write]

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates whether the device is activating (true) or deactivating - (false). - -

Implementation -
-    public function get activating():Boolean -
-    public function set activating(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
ActivityEvent()constructor
-
-public function ActivityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, activating:Boolean = false) -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates an event object that contains information about activity events. - Event objects are passed as parameters to Event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the - inherited type property. There is only one type of activity event: - ActivityEvent.ACTIVITY. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling phase of the - event flow. Event listeners can access this information through the inherited - bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can - access this information through the inherited cancelable property. -
 
activating:Boolean (default = false) — Indicates whether the device is activating (true) or - deactivating (false). Event listeners can access this information through the - activating property. -
-

-See also -

-
-ActivityEvent.ACTIVITY -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of an ActivityEvent object and sets the value of each property to match that of - the original. - -

-Returns - - - - -
Event — - A new ActivityEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the ActivityEvent object. The following - format is used: -

[ActivityEvent type=value bubbles=value cancelable=value - activating=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the ActivityEvent object. - - -
-
- -
Constant detail
- - - - - -
ACTIVITYconstant
-
-public static const ACTIVITY:String = "activity" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- The ActivityEvent.ACTIVITY constant defines the value of the type property of an activity event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
activatingtrue if the device is activating or false if it is deactivating.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object beginning or ending a session, such as a Camera or - Microphone object.
- -

-See also -

-
-flash.media.Camera.activity -
-flash.media.Microphone.activity -
-
- -
Examples
-
examples\ActivityEventExample
-
The following example demonstrates the use of the ActivityEvent class by - attaching an event listener method named activityHandler() to the microphone and - generating text information every time the microphone generates an activity event. -
-
-
-package {
-    import flash.display.Sprite;
-	import flash.events.ActivityEvent;
-	import flash.media.Microphone;
-
-	public class ActivityEventExample extends Sprite {
-		public function ActivityEventExample() {
-			var mic:Microphone = Microphone.getMicrophone();
-			mic.addEventListener(ActivityEvent.ACTIVITY, activityHandler);
-		}
-
-		private function activityHandler(event:ActivityEvent):void {
-			trace("event: " + event);
-			trace("event.activating: " + event.activating);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/AsyncErrorEvent.html b/html-docs/flash/events/AsyncErrorEvent.html deleted file mode 100644 index cb31fba..0000000 --- a/html-docs/flash/events/AsyncErrorEvent.html +++ /dev/null @@ -1,886 +0,0 @@ - - - - - - - - -flash.events.AsyncErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class AsyncErrorEvent
InheritanceAsyncErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- An object dispatches an AsyncErrorEvent when an exception is thrown from native - asynchronous code, which could be from, for example, LocalConnection, NetConnection, - SharedObject, or NetStream. There is only one type of asynchronous error event: - AsyncErrorEvent.ASYNC_ERROR. -

-

-See also -

-
-ASYNC_ERROR -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  error : Error -
- The exception that was thrown.
-		AsyncErrorEvent
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-AsyncErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", error:Error = null)
-
- Creates an AsyncErrorEvent object that contains information about asyncError events.
-		AsyncErrorEvent
   -
-clone():Event -
-
- Creates a copy of the AsyncErrorEvent object and sets the value of each property to match - that of the original.
-		AsyncErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the AsyncErrorEvent object.
-		AsyncErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  ASYNC_ERROR : String = "asyncError"
[static] - The AsyncErrorEvent.ASYNC_ERROR constant defines the value of the - type property of an asyncError event object.
-		AsyncErrorEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
errorproperty
-
-public var error:Error -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- The exception that was thrown. - -

- -
Constructor detail
- - - - - -
AsyncErrorEvent()constructor
-
-public function AsyncErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", error:Error = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates an AsyncErrorEvent object that contains information about asyncError events. - AsyncErrorEvent objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through - the inherited type property. There is only one type of error event: - ErrorEvent.ERROR. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access - this information through the inherited bubbles property. - This property applies to display objects in SWF - content, which use the ActionScript 3.0 display architecture. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners - can access this information through the inherited cancelable property. - -
 
text:String (default = "") — Text to be displayed as an error message. Event listeners can access this - information through the text property. - -
 
error:Error (default = null) — The exception that occurred. - If error is non-null, the event's errorId property is set from the error's - errorId property. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of the AsyncErrorEvent object and sets the value of each property to match - that of the original. - -

-Returns - - - - -
Event — - A new AsyncErrorEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the AsyncErrorEvent object. The - string is in the following format: -

[AsyncErrorEvent type=value bubbles=value - cancelable=value ... error=value errorID=value] - The errorId is only available in Adobe AIR

-

-Returns - - - - -
String — - A string that contains all the properties of the AsyncErrorEvent object. - - - -
-
- -
Constant detail
- - - - - -
ASYNC_ERRORconstant
-
-public static const ASYNC_ERROR:String = "asyncError" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The AsyncErrorEvent.ASYNC_ERROR constant defines the value of the - type property of an asyncError event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse - This property applies to ActionScript 3.0 display objects (in SWF files).
cancelablefalse; there is no default - behavior to cancel. This property applies to display objects - in SWF content, which use the ActionScript 3.0 display architecture.
currentTargetThe object that is actively processing the - Event object with an event listener. This property applies to display - objects in SWF content, which use the ActionScript 3.0 display architecture.
target The object dispatching the event.
errorThe error that triggered the event.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/AudioOutputChangeEvent.html b/html-docs/flash/events/AudioOutputChangeEvent.html deleted file mode 100644 index bd38b31..0000000 --- a/html-docs/flash/events/AudioOutputChangeEvent.html +++ /dev/null @@ -1,703 +0,0 @@ - - - - - - - - -flash.events.AudioOutputChangeEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class AudioOutputChangeEvent
InheritanceAudioOutputChangeEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 28 -
-

-

-

This event fires when user selects a different audio output device from Flash Player's settings - UI, or an audio device gets added to / removed from the system.

- -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  reason : String -
[read-only] - Reports the reason that triggers this AudioOutputchangeEvent.
-		AudioOutputChangeEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-AudioOutputChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, reason:String = null)
-
-

Constructor.

-
-		AudioOutputChangeEvent
 Inherited -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		Event
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  AUDIO_OUTPUT_CHANGE : String = "audioOutputChange"
[static] - Defines the value of the type property of a AudioOutputchangeEvent event object.
-		AudioOutputChangeEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
reasonproperty
-
-reason:String  [read-only]

- Reports the reason that triggers this AudioOutputchangeEvent. -

Implementation -
-    public function get reason():String -
-
- -
Constructor detail
- - - - - -
AudioOutputChangeEvent()constructor
-
-public function AudioOutputChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, reason:String = null)

-

Constructor.

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. There is only one type of AudioOutputchangeEvent event: - AudioOutputchangeEvent.AUDIO_OUTPUT_CHANGE. -
 
bubbles:Boolean (default = false) — Indicates whether this Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Indicates whether you can cancel the action that triggers this event. -
 
reason:String (default = null) — The reason that triggers the audio output change event. - AudioOutputChangeReason.USER_SELECTION, indicates that the audio output change - is initiated by the user selecting a different device from Flash Player Settings UI. - AudioOutputChangeReason.DEVICE_CHANGE, indicates that audio device has either changed, - added or removed. -
-
- -
Constant detail
- - - - - -
AUDIO_OUTPUT_CHANGEconstant
-
-public static const AUDIO_OUTPUT_CHANGE:String = "audioOutputChange"

- Defines the value of the type property of a AudioOutputchangeEvent event object. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/BrowserInvokeEvent.html b/html-docs/flash/events/BrowserInvokeEvent.html deleted file mode 100644 index 611278c..0000000 --- a/html-docs/flash/events/BrowserInvokeEvent.html +++ /dev/null @@ -1,1050 +0,0 @@ - - - - - - - - -flash.events.BrowserInvokeEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class BrowserInvokeEvent
InheritanceBrowserInvokeEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The NativeApplication object of an AIR application dispatches a browserInvoke event when the - application is invoked as the result of a SWF file in the browser using the browser - invocation feature. The NativeApplication object also dispatches a browserInvoke event when - a user instantiates the seamless installation feature in the browser and the SWF file in - the browser passes an array to the arguments parameter of the - launchApplication() method of the air.swf file. (For details, see - "Distributing, installing and running AIR applications" in the AIR developer's guide.) - -

Browser invocation is permitted only if an application specifies the following in - the application descriptor file:

- - 
<allowBrowserInvocation>true</allowBrowserInvocation>
- -

If the application is not running, the NativeApplication object dispatches both an InvokeEvent - event and a browserInvoke event when launched from the browser. Otherwise, - if the application is already running, the NativeApplication object dispatches only - a browserInvoke event when launched from the browser.

- -

If the application is launched as the result of a seamless installation from the browser (with - the user choosing to launch upon installation), the NativeApplication object dispatches a BrowserInvoke - event only if arguments were passed (via the SWF file in the browser passing an array to - the arguments parameter of the installApplication() - method of the air.swf file). For details, see "Distributing, installing, and running AIR - applications" in the AIR developer's guide.

- -

Like the invokeEvent events, browserInvokeEvent events are dispatched by the - NativeApplication object (NativeApplication.nativeApplication). To receive browserInvoke - events, call the addEventListener() method of the NativeApplication object. When an event listener - registers for a browserInvoke event, it will also receive all browserInvoke events that - occurred before the registration. These are dispatched after the call to addEventListener() - returns, but not necessarily before other browserInvoke events that might be received after registration. - This allows you to handle browserInvoke events that have occurred before your initialization code - is executed (such as when the application was initially invoked from the browser). Keep in mind that if you - add an event listener later in execution (after application initialization), it still receives all - browserInvoke events that have occurred since the application started.

- -

-

-See also -

-
-flash.events.InvokeEvent -
-flash.desktop.NativeApplication -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  arguments : Array -
[read-only] - An array of arguments (strings) to pass to the application.
-		BrowserInvokeEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  isHTTPS : Boolean -
[read-only] - Whether the content in the browser uses the HTTPS - URL scheme (true) or not (false).
-		BrowserInvokeEvent
  isUserEvent : Boolean -
[read-only] - Whether the browser invocation resulted in a user event (such as - a mouse click).
-		BrowserInvokeEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  sandboxType : String -
[read-only] - The sandbox type for the content in the browser.
-		BrowserInvokeEvent
  securityDomain : String -
[read-only] - The security domain for the content in the browser, such as - "www.adobe.com" or "www.example.org".
-		BrowserInvokeEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-BrowserInvokeEvent(type:String, bubbles:Boolean, cancelable:Boolean, arguments:Array, sandboxType:String, securityDomain:String, isHTTPS:Boolean, isUserEvent:Boolean)
-
- The constructor function for the BrowserInvokeEvent class.
-		BrowserInvokeEvent
   -
-clone():Event -
-
- Creates a new copy of this event.
-		BrowserInvokeEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  BROWSER_INVOKE : String = "browserInvoke"
[static] - The BrowserInvokeEvent.BROWSER_INVOKE constant defines the value of the type - property of a BrowserInvokeEvent object.
-		BrowserInvokeEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
argumentsproperty
-
-arguments:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An array of arguments (strings) to pass to the application. - -

Implementation -
-    public function get arguments():Array -
-
- - - - - -
isHTTPSproperty 
-
-isHTTPS:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Whether the content in the browser uses the HTTPS - URL scheme (true) or not (false). - -

Implementation -
-    public function get isHTTPS():Boolean -
-
- - - - - -
isUserEventproperty 
-
-isUserEvent:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Whether the browser invocation resulted in a user event (such as - a mouse click). In AIR 1.0, this is always set to true; - AIR requires a user event to initiate a call to the browser invocation feature. - -

Implementation -
-    public function get isUserEvent():Boolean -
-
- - - - - -
sandboxTypeproperty 
-
-sandboxType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The sandbox type for the content in the browser. This can be set - to one of the following values: - -

    - -
  • Security.APPLICATION — The content is in - the application security sandbox.
    • - -
  • Security.LOCAL_TRUSTED — The content is in - the local-trusted security sandbox.
    • - -
  • Security.LOCAL_WITH_FILE — The content is in - the local-with-filesystem security sandbox.
    • - -
  • Security.LOCAL_WITH_NETWORK — The content is in - the local-with-networking security sandbox.
    • - -
  • Security.REMOTE — The content is in - a remote (network) domain
    • - -
- -

Implementation -
-    public function get sandboxType():String -
-

-See also -

-
-flash.system.Security.sandboxType -
-
- - - - - -
securityDomainproperty 
-
-securityDomain:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The security domain for the content in the browser, such as - "www.adobe.com" or "www.example.org". - This property is set only for content in the remote security - sandbox (for content from a network domain), not for content - in a local or application security sandbox. - -

Implementation -
-    public function get securityDomain():String -
-
- -
Constructor detail
- - - - - -
BrowserInvokeEvent()constructor
-
-public function BrowserInvokeEvent(type:String, bubbles:Boolean, cancelable:Boolean, arguments:Array, sandboxType:String, securityDomain:String, isHTTPS:Boolean, isUserEvent:Boolean) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The constructor function for the BrowserInvokeEvent class. - - Generally, developers do not call the BrowserInvokeEvent() constructor directly. - Only the runtime should create a BrowserInvokeEvent object. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event, accessible as Event.type. - -
 
bubbles:Boolean — Set to false for a BrowserInvokeEvent object. - -
 
cancelable:Boolean — Set to false for a BrowserInvokeEvent object. - -
 
arguments:Array — An array of arguments (strings) to pass to the application. - -
 
sandboxType:String — The sandbox type for the content in the browser. - -
 
securityDomain:String — The security domain for the content in the browser. - -
 
isHTTPS:Boolean — Whether the content in the browser uses the HTTPS URL scheme. - -
 
isUserEvent:Boolean — Whether the browser invocation was the result of a user event. - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Runtime version: AIR 1.0 -
-

- Creates a new copy of this event. - -

-Returns - - - - -
Event — - The copy of the event. - - -
-
- -
Constant detail
- - - - - -
BROWSER_INVOKEconstant
-
-public static const BROWSER_INVOKE:String = "browserInvoke" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The BrowserInvokeEvent.BROWSER_INVOKE constant defines the value of the type - property of a BrowserInvokeEvent object. - -

The BrowserInvokeEvent object has the following properties:

- - - - - - - - - - - -
PropertiesValues
argumentsThe array of string arguments passed - during this invocation.
sandBoxTypeA string representing the - the sandbox type for the content in the browser (either - Security.APPLICATION, Security.LOCAL_TRUSTED, Security.LOCAL_WITH_FILE, - Security.LOCAL_LOCAL_WITH_NETWORK, or Security.REMOTE).
securityDomainA string representing the - the security domain for the content in the browser (such as "www.example.com").
isHTTPSWhether the browser content uses the - HTTPS URL scheme (true) or not (false)
isUserEventWhether the browser invocation resulted - from a user event (always true in AIR 1.0).
bubblesNo.
cancelablefalse; - There is no default behavior to cancel.
currentTargetIndicates the object that is - actively processing this InvokeEvent object with an event listener.
targetAlways the NativeApplication object. -
- -

-See also -

-
-flash.desktop.NativeApplication -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/ContextMenuEvent.html b/html-docs/flash/events/ContextMenuEvent.html deleted file mode 100644 index 6552ff4..0000000 --- a/html-docs/flash/events/ContextMenuEvent.html +++ /dev/null @@ -1,1120 +0,0 @@ - - - - - - - - -flash.events.ContextMenuEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class ContextMenuEvent
InheritanceContextMenuEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- An InteractiveObject dispatches a ContextMenuEvent object when the user opens or interacts with - the context menu. There are two types of - ContextMenuEvent objects: -
    -
  • ContextMenuEvent.MENU_ITEM_SELECT
    • -
  • ContextMenuEvent.MENU_SELECT
    • -
-

-

-View the examples. -

-

-See also -

-
-ContextMenu class -
-ContextMenuItem class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  contextMenuOwner : InteractiveObject -
- The display list object to which the menu is attached.
-		ContextMenuEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  isMouseTargetInaccessible : Boolean -
- Indicates whether the mouseTarget property was set to null for security - reasons.
-		ContextMenuEvent
  mouseTarget : InteractiveObject -
- The display list object on which the user right-clicked to display the context menu.
-		ContextMenuEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ContextMenuEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, mouseTarget:InteractiveObject = null, contextMenuOwner:InteractiveObject = null)
-
- Creates an Event object that contains specific information about menu events.
-		ContextMenuEvent
   -
-clone():Event -
-
- Creates a copy of the ContextMenuEvent object and sets the value of each property to match that of the original.
-		ContextMenuEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the ContextMenuEvent object.
-		ContextMenuEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
  MENU_ITEM_SELECT : String = "menuItemSelect"
[static] - Defines the value of the type property of a menuItemSelect event object.
-		ContextMenuEvent
  MENU_SELECT : String = "menuSelect"
[static] - Defines the value of the type property of a menuSelect event object.
-		ContextMenuEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
contextMenuOwnerproperty
-
-contextMenuOwner:InteractiveObject  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The display list object to which the menu is attached. This could be the mouse target (mouseTarget) or one of its ancestors in the display list. - -

Implementation -
-    public function get contextMenuOwner():InteractiveObject -
-    public function set contextMenuOwner(value:InteractiveObject):void -
-
- - - - - -
isMouseTargetInaccessibleproperty 
-
-isMouseTargetInaccessible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether the mouseTarget property was set to null for security - reasons. If the nominal value of menuTarget would be a reference to a - DisplayObject in another security sandbox, then menuTarget is set to - null unless there is permission in both directions across this sandbox boundary. Permission is - established by calling Security.allowDomain() from a SWF file, or providing - a policy file from the server of an image file, and setting the LoaderContext.checkPolicyFile - flag when loading the image. -

Implementation -
-    public function get isMouseTargetInaccessible():Boolean -
-    public function set isMouseTargetInaccessible(value:Boolean):void -
-

-See also -

-
-ContextMenuEvent.mouseTarget -
-Security.allowDomain() -
-LoaderContext.checkPolicyFile -
-
- - - - - -
mouseTargetproperty 
-
-mouseTarget:InteractiveObject  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The display list object on which the user right-clicked to display the context menu. This could be the display list object to which the - menu is attached (contextMenuOwner) or one of its display list descendants. -

The value of this property can be null in two circumstances: if there no mouse target, - for example when you mouse over something from - the background; or there is a mouse target, but it is in a security sandbox to which you don't have access. - Use the isMouseTargetInaccessible() property to determine which of these reasons applies.

- - Implementation -
-    public function get mouseTarget():InteractiveObject -
-    public function set mouseTarget(value:InteractiveObject):void -
-

-See also -

-
-ContextMenuEvent.isMouseTargetInaccessible -
-
- -
Constructor detail
- - - - - -
ContextMenuEvent()constructor
-
-public function ContextMenuEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, mouseTarget:InteractiveObject = null, contextMenuOwner:InteractiveObject = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates an Event object that contains specific information about menu events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are: -
    -
  • ContextMenuEvent.MENU_ITEM_SELECT
    • -
  • ContextMenuEvent.MENU_SELECT
    • -
-
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
mouseTarget:InteractiveObject (default = null) — The display list object on which the user right-clicked to display the context menu. This could be the contextMenuOwner or one of its display list descendants. -
 
contextMenuOwner:InteractiveObject (default = null) — The display list object to which the menu is attached. This could be the mouseTarget or one of its ancestors in the display list. -
-

-See also -

-
-ContextMenuEvent.MENU_ITEM_SELECT -
-ContextMenuEvent.MENU_SELECT -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of the ContextMenuEvent object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event — - A new ContextMenuEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the ContextMenuEvent object. The string is in the following format: -

[ContextMenuEvent type=value bubbles=value cancelable=value ... contextMenuOwner=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the ContextMenuEvent object. - - -
-
- -
Constant detail
- - - - - -
MENU_ITEM_SELECTconstant
-
-public static const MENU_ITEM_SELECT:String = "menuItemSelect" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a menuItemSelect event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
contextMenuOwnerThe display list object to which the menu is attached.
currentTargetThe object that is actively processing the Event - object with an event listener.
mouseTargetThe display list object on which the user right-clicked to display the context menu.
targetThe ContextMenuItem object that has been selected. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.ui.ContextMenuItem.menuItemSelect -
-
- - - - - -
MENU_SELECTconstant 
-
-public static const MENU_SELECT:String = "menuSelect" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a menuSelect event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
contextMenuOwnerThe display list object to which the menu is attached.
currentTargetThe object that is actively processing the Event - object with an event listener.
mouseTargetThe display list object on which the user right-clicked to display the context menu.
targetThe ContextMenu object that is about to be displayed. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.ui.ContextMenu.menuSelect -
-
- -
Examples
-
examples\ContextMenuEventExample
-
The following example uses the ContextMenuEventExample class - to remove the default context menu items from the Stage and add a new menu item that changes - the color of a square on the Stage. The example carries out the following - tasks: - -
    -
  1. The myContextMenu property is declared and then assigned to a new ContextMenu - object and the redRectangle property (of type Sprite) is declared.
    2. -
  2. The removeDefaultItems() method is called. This method removes all built-in context - menu items except Print.
    3. - -
  3. The addCustomMenuItems() method is called. This method places a - Reverse Colors menu item in the defaultItems array by using the - push() method of Array. A menuItemSelect event listener is added to the - ContextMenuItem object and the associated method is called menuItemSelectHandler(). - This method prints some trace() statements whenever the user - selects Reverse Colors from the context menu. In addition the red square - becomes black and the black text becomes red.
    4. - -
  4. Back in the constructor, a menuSelect event listener is added, along with - the associated method menuSelectHandler(), which simply prints out three trace() statements - every time an item in the context menu is selected.
    5. - -
  5. The constructor calls addChildren(), which draws a red square and adds it - to the display list, which immediately displays the square.
    6. - -
  6. Finally, myContextMenu is assigned to the context menu of the redRectangle property, - so that the custom context menu is displayed only when the mouse pointer is over the square.
    7. -
-
-
-package {
-	import flash.ui.ContextMenu;
-	import flash.ui.ContextMenuItem;
-	import flash.ui.ContextMenuBuiltInItems;
-	import flash.events.ContextMenuEvent;
-	import flash.display.Sprite;
-	import flash.display.Shape;
-	import flash.text.TextField;
-
-	public class ContextMenuEventExample extends Sprite {
-		private var myContextMenu:ContextMenu;
-		private var menuLabel:String = "Reverse Colors";
-		private var textLabel:String = "Right Click";
-		private var redRectangle:Sprite;
-		private var label:TextField;
-		private var size:uint = 100;
-		private var black:uint = 0x000000;
-		private var red:uint = 0xFF0000;
-
-		public function ContextMenuEventExample() {
-			myContextMenu = new ContextMenu();
-			removeDefaultItems();
-			addCustomMenuItems();
-			myContextMenu.addEventListener(ContextMenuEvent.MENU_SELECT, menuSelectHandler);
-
-			addChildren();
-			redRectangle.contextMenu = myContextMenu;
-		}
-
-		private function addChildren():void {
-			redRectangle = new Sprite();
-			redRectangle.graphics.beginFill(red);
-			redRectangle.graphics.drawRect(0, 0, size, size);
-			addChild(redRectangle);
-			redRectangle.x = size;
-			redRectangle.y = size;
-			label = createLabel();
-			redRectangle.addChild(label);
-		}
-
-		private function removeDefaultItems():void {
-			myContextMenu.hideBuiltInItems();
-			var defaultItems:ContextMenuBuiltInItems = myContextMenu.builtInItems;
-			defaultItems.print = true;
-		}
-
-		private function addCustomMenuItems():void {
-			var item:ContextMenuItem = new ContextMenuItem(menuLabel);
-			myContextMenu.customItems.push(item);
-			item.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT, menuItemSelectHandler);
-		}
-
-		private function menuSelectHandler(event:ContextMenuEvent):void {
-			trace("menuSelectHandler: " + event);
-		}
-
-		private function menuItemSelectHandler(event:ContextMenuEvent):void {
-			trace("menuItemSelectHandler: " + event);
-			var textColor:uint = (label.textColor == black) ? red : black;
-			var bgColor:uint = (label.textColor == black) ? black : red;
-			redRectangle.graphics.clear();
-			redRectangle.graphics.beginFill(bgColor);
-			redRectangle.graphics.drawRect(0, 0, size, size);
-			label.textColor = textColor;
-		}
-
-		private function createLabel():TextField {
-			var txtField:TextField = new TextField();
-			txtField.text = textLabel;
-			return txtField;
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DNSResolverEvent.html b/html-docs/flash/events/DNSResolverEvent.html deleted file mode 100644 index f57ab7c..0000000 --- a/html-docs/flash/events/DNSResolverEvent.html +++ /dev/null @@ -1,870 +0,0 @@ - - - - - - - - -flash.events.DNSResolverEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DNSResolverEvent
InheritanceDNSResolverEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The DNSResolverEvent class represents the results of a Domain Name System (DNS) lookup operation. - -

Use the DNSResolver lookup() method to initiate a DNS query. Resource records - returned by the query are placed in the resourceRecords array of this DNSResolverEvent object.

-

-

-See also -

-
-DNSResolver -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  host : String -
- The query string, such as a host name, IP address, or service locator used in the call to - the lookup() method of the DNSResolver class for which this event is a response.
-		DNSResolverEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  resourceRecords : Array -
- An array containing the resource records returned by the DNS lookup operation.
-		DNSResolverEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DNSResolverEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, host:String = "", resourceRecords:Array = null)
-
- Creates an DNSResolverEvent object that contains the results of a DNS lookup operation.
-		DNSResolverEvent
   -
-clone():Event -
-
- Creates a copy of the DNSResolverEvent object and sets the value of each property to match that of the original.
-		DNSResolverEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the DNSResolverEvent object.
-		DNSResolverEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
  LOOKUP : String = "lookup"
[static] - Defines the value of the type property of a lookup event object.
-		DNSResolverEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
hostproperty
-
-host:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The query string, such as a host name, IP address, or service locator used in the call to - the lookup() method of the DNSResolver class for which this event is a response. - -

Implementation -
-    public function get host():String -
-    public function set host(value:String):void -
-
- - - - - -
resourceRecordsproperty 
-
-resourceRecords:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- An array containing the resource records returned by the DNS lookup operation. - -

Implementation -
-    public function get resourceRecords():Array -
-    public function set resourceRecords(value:Array):void -
-
- -
Constructor detail
- - - - - -
DNSResolverEvent()constructor
-
-public function DNSResolverEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, host:String = "", resourceRecords:Array = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates an DNSResolverEvent object that contains the results of a DNS lookup operation. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are:DNSResolverEvent.LOOKUP -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
 
host:String (default = "") — The query string, such as a host name, IP address, or service locator used in the call to - the lookup() method of the DNSResolver class for which the new event is a response. -
 
resourceRecords:Array (default = null) — A list of the returned DNS resource records. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates a copy of the DNSResolverEvent object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event — - A new ServerSocketConnectEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that contains all the properties of the DNSResolverEvent object. The string is in the following format: -

[DNSResolverEvent type=value bubbles=value cancelable=value host=value resourceRecords=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the ProgressEvent object. - - -
-
- -
Constant detail
- - - - - -
LOOKUPconstant
-
-public static const LOOKUP:String = "lookup" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a lookup event object. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DRMAuthenticateEvent.html b/html-docs/flash/events/DRMAuthenticateEvent.html deleted file mode 100644 index 2e96810..0000000 --- a/html-docs/flash/events/DRMAuthenticateEvent.html +++ /dev/null @@ -1,1243 +0,0 @@ - - - - - - - - -flash.events.DRMAuthenticateEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DRMAuthenticateEvent
InheritanceDRMAuthenticateEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 - -
-

-

- A NetStream object dispatchs a DRMAuthenticateEvent object when attempting to play digital rights management (DRM) encrypted - content that requires a user credential for authentication. -

- The DRMAuthenticateEvent handler is responsible for gathering the required credentials - (such as the user name, password, and type) and passing the values to the - NetStream.setDRMAuthenticationCredentials() method for authentication. Each - AIR application must provide some mechanism for obtaining user credentials. - For example, the application could provide a user with a simple user interface to enter the - username and password values, and optionally the type value as well. -

-

- If user authentication failed, the application will retry - authentication and dispatch a new DRMAuthenticateEvent event for the NetStream object. -

-

-

-View the examples. -

-

-See also -

-
-DRMAuthenticateEvent.DRM_AUTHENTICATE -
-flash.net.drm.DRMManager -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  authenticationType : String -
[read-only] - Indicates whether the supplied credentials are for authenticating against Flash Media Rights Management Server (FMRMS) - or a proxy server.
-		DRMAuthenticateEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  header : String -
[read-only] - The encrypted content file header provided by the server.
-		DRMAuthenticateEvent
  netstream : NetStream -
[read-only] - The NetStream object that initiated this event.
-		DRMAuthenticateEvent
  passwordPrompt : String -
[read-only] - A prompt for a password credential, provided by the server.
-		DRMAuthenticateEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
  urlPrompt : String -
[read-only] - A prompt for a URL string, provided by the server.
-		DRMAuthenticateEvent
  usernamePrompt : String -
[read-only] - A prompt for a user name credential, provided by the server.
-		DRMAuthenticateEvent
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMAuthenticateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, header:String = "", userPrompt:String = "", passPrompt:String = "", urlPrompt:String = "", authenticationType:String = "", netstream:NetStream = null)
-
- Creates an Event object that contains specific information about DRM authentication events.
-		DRMAuthenticateEvent
   -
-clone():Event -
-
- Creates a copy of the DRMAuthenticateEvent object and sets the value of each property to match - that of the original.
-		DRMAuthenticateEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the DRMAuthenticateEvent object.
-		DRMAuthenticateEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  AUTHENTICATION_TYPE_DRM : String = "drm"
[static] - The DRMAuthenticateEvent.AUTHENTICATION_TYPE_DRM constant defines the value of the - authenticationType property of a DRMAuthenticateEvent object.
-		DRMAuthenticateEvent
  AUTHENTICATION_TYPE_PROXY : String = "proxy"
[static] - The DRMAuthenticateEvent.AUTHENTICATION_TYPE_PROXY constant defines the value of the - authenticationType property of a DRMAuthenticateEvent object.
-		DRMAuthenticateEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
  DRM_AUTHENTICATE : String = "drmAuthenticate"
[static] - The DRMAuthenticateEvent.DRM_AUTHENTICATE constant defines the value of the - type property of a DRMAuthenticateEvent object.
-		DRMAuthenticateEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
authenticationTypeproperty
-
-authenticationType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether the supplied credentials are for authenticating against Flash Media Rights Management Server (FMRMS) - or a proxy server. For example, the "proxy" option allows the application to authenticate against a proxy server - if an enterprise requires such a step before the user can access the Internet. Unless anonymous authentication is used, - after the proxy authentication, the user still needs to authenticate against FMRMS in order to obtain the voucher - and play the content. You can use setDRMAuthenticationcredentials() a second time, with "drm" - option, to authenticate against FMRMS. - -

Implementation -
-    public function get authenticationType():String -
-
- - - - - -
headerproperty 
-
-header:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The encrypted content file header provided by the server. - It contains information about the context of the encrypted content. - -

Implementation -
-    public function get header():String -
-
- - - - - -
netstreamproperty 
-
-netstream:NetStream  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The NetStream object that initiated this event. - -

Implementation -
-    public function get netstream():NetStream -
-
- - - - - -
passwordPromptproperty 
-
-passwordPrompt:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A prompt for a password credential, provided by the server. - The string can include instruction for the type of password required. - -

Implementation -
-    public function get passwordPrompt():String -
-
- - - - - -
urlPromptproperty 
-
-urlPrompt:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A prompt for a URL string, provided by the server. - The string can provide the location where the username and password will be sent. - -

Implementation -
-    public function get urlPrompt():String -
-
- - - - - -
usernamePromptproperty 
-
-usernamePrompt:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A prompt for a user name credential, provided by the server. - The string can include instruction for the type of user name required. - For example, a content provider may require an e-mail address as the user name. - -

Implementation -
-    public function get usernamePrompt():String -
-
- -
Constructor detail
- - - - - -
DRMAuthenticateEvent()constructor
-
-public function DRMAuthenticateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, header:String = "", userPrompt:String = "", passPrompt:String = "", urlPrompt:String = "", authenticationType:String = "", netstream:NetStream = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates an Event object that contains specific information about DRM authentication events. - Event objects are passed as parameters to event listeners. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of DRMAuthenticate event: DRMAuthenticateEvent.DRM_AUTHENTICATE. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
header:String (default = "") — The encrypted content file header provided by the server. -
 
userPrompt:String (default = "") — A prompt for a user name credential, provided by the server. -
 
passPrompt:String (default = "") — A prompt for a password credential, provided by the server. -
 
urlPrompt:String (default = "") — A prompt for a URL to display, provided by the server. -
 
authenticationType:String (default = "") — Indicates whether the supplied credentials are for authenticating against the Flash Media Rights Management Server (FMRMS) or a proxy server. -
 
netstream:NetStream (default = null) — The NetStream object that initiated this event. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the DRMAuthenticateEvent object and sets the value of each property to match - that of the original. - -

-Returns - - - - -
Event — - A new DRMAuthenticateEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Runtime version: AIR 1.0 -
-

- Returns a string that contains all the properties of the DRMAuthenticateEvent object. - The string is in the following format: -

[DRMAuthenticateEvent type=value bubbles=value cancelable=value - eventPhase=value header=value usernamePrompt=value passwordPrompt=value - urlPrompt=value] authenticationType=value

- -

-Returns - - - - -
String — - A string that contains all the properties of the DRMAuthenticateEvent object. - - - -
-
- -
Constant detail
- - - - - -
AUTHENTICATION_TYPE_DRMconstant
-
-public static const AUTHENTICATION_TYPE_DRM:String = "drm" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The DRMAuthenticateEvent.AUTHENTICATION_TYPE_DRM constant defines the value of the - authenticationType property of a DRMAuthenticateEvent object. - -

This event has the following properties:

- - - - - - - - - - - - -
PropertyValue
authenticationTypeIndicates whether the supplied credentials are for - authenticating against the Flash Media Rights Management Server (FMRMS) or a proxy server.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
headerThe encrypted content file header provided by the server.
netstreamThe NetStream object that initiated this event.
passwordPromptA prompt for a password credential, provided by the server.
targetThe NetStream object.
urlPromptA prompt for a URL to display, provided by the server.
usernamePromptA prompt for a user name credential, provided by the server.
- -

-See also -

-
-flash.net.NetStream.drmAuthenticate -
-DRMAuthenticateEvent.authenticationType -
-
- - - - - -
AUTHENTICATION_TYPE_PROXYconstant 
-
-public static const AUTHENTICATION_TYPE_PROXY:String = "proxy" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The DRMAuthenticateEvent.AUTHENTICATION_TYPE_PROXY constant defines the value of the - authenticationType property of a DRMAuthenticateEvent object. - -

This event has the following properties:

- - - - - - - - - - - - -
PropertyValue
authenticationTypeIndicates whether the supplied credentials are for - authenticating against the Flash Media Rights Management Server (FMRMS) or a proxy server.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
headerThe encrypted content file header provided by the server.
netstreamThe NetStream object that initiated this event.
passwordPromptA prompt for a password credential, provided by the server.
targetThe NetStream object.
urlPromptA prompt for a URL to display, provided by the server.
usernamePromptA prompt for a user name credential, provided by the server.
- -

-See also -

-
-flash.net.NetStream.drmAuthenticate -
-DRMAuthenticateEvent.authenticationType -
-
- - - - - -
DRM_AUTHENTICATEconstant 
-
-public static const DRM_AUTHENTICATE:String = "drmAuthenticate" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The DRMAuthenticateEvent.DRM_AUTHENTICATE constant defines the value of the - type property of a DRMAuthenticateEvent object. - -

This event has the following properties:

- - - - - - - - - - - - -
PropertyValue
authenticationTypeIndicates whether the supplied credentials are for - authenticating against the Flash Media Rights Management Server (FMRMS) or a proxy server.
bubblesfalse
cancelablefalse there is no default behavior to cancel.
headerThe encrypted content file header provided by the server.
netstreamThe NetStream object that initiated this event.
passwordPromptA prompt for a password credential, provided by the server.
targetThe NetStream object.
urlPromptA prompt for a URL to display, provided by the server.
usernamePromptA prompt for a user name credential, provided by the server.
- -

-See also -

-
-flash.net.NetStream.drmAuthenticate -
-
- -
Examples
-
examples\DRMAuthenticateEventExample
-
-
-
package
-{
-    import flash.display.Sprite;
-	import flash.events.AsyncErrorEvent;
-	import flash.events.NetStatusEvent;
-	import flash.events.DRMAuthenticateEvent;
-	import flash.media.Video;
-	import flash.net.NetConnection;
-	import flash.net.NetStream;
-
-	public class DRMAuthenticateEventExample extends Sprite
-	{
-		var videoURL:String = "Video.flv";
-		var videoConnection:NetConnection;
-		var videoStream:NetStream;
-		var video:Video = new Video();			
-
-		public function DRMAuthenticateEventExample()
-		{
-            videoConnection = new NetConnection();
-            videoConnection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            videoConnection.connect(null);
-        }
-
-        private function connectStream():void {
-            videoStream = new NetStream(videoConnection);
-            videoStream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            videoStream.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler);
-			videoStream.addEventListener(DRMAuthenticateEvent.DRM_AUTHENTICATE, drmAuthenticateEventHandler);
-            video.attachNetStream(videoStream);
-            videoStream.play(videoURL);
-            addChild(video);
-        }
-
-        private function netStatusHandler(event:NetStatusEvent):void {
-            switch (event.info.code) {
-                case "NetConnection.Connect.Success":
-                    connectStream();
-                    break;
-                case "NetStream.Play.StreamNotFound":
-                    trace("Unable to locate video: " + videoURL);
-                    break;
-            }
-        }
-
-        private function asyncErrorHandler(event:AsyncErrorEvent):void {
-            // ignore AsyncErrorEvent events.
-        }
-
- 		private function drmAuthenticateEventHandler(event:DRMAuthenticateEvent):void {
-			videoStream.setDRMAuthenticationCredentials("User", "password", "drm");
-		}
- 	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DRMAuthenticationCompleteEvent.html b/html-docs/flash/events/DRMAuthenticationCompleteEvent.html deleted file mode 100644 index 1b1897e..0000000 --- a/html-docs/flash/events/DRMAuthenticationCompleteEvent.html +++ /dev/null @@ -1,886 +0,0 @@ - - - - - - - - -flash.events.DRMAuthenticationCompleteEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DRMAuthenticationCompleteEvent
InheritanceDRMAuthenticationCompleteEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The DRMManager dispatches a DRMAuthenticationCompleteEvent object when a call to the authenticate() - method of the DRMManager object succeeds. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  domain : String -
- The content domain of the media rights server.
-		DRMAuthenticationCompleteEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  serverURL : String -
- The URL of the media rights server.
-		DRMAuthenticationCompleteEvent
 Inheritedtarget : Object -
- The event target.
-		Event
  token : ByteArray -
- The authentication token.
-		DRMAuthenticationCompleteEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMAuthenticationCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inServerURL:String = null, inDomain:String = null, inToken:ByteArray = null)
-
- Creates a new instance of a DRMAuthenticationCompleteEvent object.
-		DRMAuthenticationCompleteEvent
   -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		DRMAuthenticationCompleteEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  AUTHENTICATION_COMPLETE : String = "authenticationComplete"
[static] - The string constant to use for the authentication complete event - in the type parameter when adding and removing event listeners.
-		DRMAuthenticationCompleteEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
domainproperty
-
-domain:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The content domain of the media rights server. Here, domain is not a network or Internet domain name. - -

Implementation -
-    public function get domain():String -
-    public function set domain(value:String):void -
-
- - - - - -
serverURLproperty 
-
-serverURL:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The URL of the media rights server. - -

Implementation -
-    public function get serverURL():String -
-    public function set serverURL(value:String):void -
-
- - - - - -
tokenproperty 
-
-token:ByteArray  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The authentication token. - -

The authentication is automatically added to the DRMManager session cache. You - can save the token and use it to authenticate the user in a future session. Reuse a - token with the setAuthenticationToken() method of the DRMManager. - Token expiration and other properties are determined by the server generating the token.

- - Implementation -
-    public function get token():ByteArray -
-    public function set token(value:ByteArray):void -
-

-See also -

-
-flash.net.drm.DRMManager.setAuthenticationToken() -
-
- -
Constructor detail
- - - - - -
DRMAuthenticationCompleteEvent()constructor
-
-public function DRMAuthenticationCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inServerURL:String = null, inDomain:String = null, inToken:ByteArray = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new instance of a DRMAuthenticationCompleteEvent object. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — the event type string -
 
bubbles:Boolean (default = false) — whether the event bubbles up the display list -
 
cancelable:Boolean (default = false) — whether the event can be canceled -
 
inServerURL:String (default = null) — the URL of the logged-in server -
 
inDomain:String (default = null) — the authenticated domain on the logged-in server -
 
inToken:ByteArray (default = null) — the authentication token - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event

- Duplicates an instance of an Event subclass. -

Returns a new Event object that is a copy of the original instance of the Event object. - You do not normally call clone(); the EventDispatcher class calls it automatically - when you redispatch an event—that is, when you call dispatchEvent(event) from a handler - that is handling event.

- -

The new Event object includes all the properties of the original.

-

When creating your own custom Event class, you must override the - inherited Event.clone() method in order for it to duplicate the - properties of your custom class. If you do not set all the properties that you add - in your event subclass, those properties will not have the correct values when listeners - handle the redispatched event.

- -

In this example, PingEvent is a subclass of Event - and therefore implements its own version of clone().

- - 
-	 class PingEvent extends Event {
-		 var URL:String;
-		 
-	 public override function clone():Event {
-	 	     return new PingEvent(type, bubbles, cancelable, URL);
-	    }
-	 }
-
- -

-Returns - - - - -
Event — - A new Event object that is identical to the original. - - -
-
- -
Constant detail
- - - - - -
AUTHENTICATION_COMPLETEconstant
-
-public static const AUTHENTICATION_COMPLETE:String = "authenticationComplete" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The string constant to use for the authentication complete event - in the type parameter when adding and removing event listeners. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DRMAuthenticationErrorEvent.html b/html-docs/flash/events/DRMAuthenticationErrorEvent.html deleted file mode 100644 index 36ba6d6..0000000 --- a/html-docs/flash/events/DRMAuthenticationErrorEvent.html +++ /dev/null @@ -1,894 +0,0 @@ - - - - - - - - -flash.events.DRMAuthenticationErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DRMAuthenticationErrorEvent
InheritanceDRMAuthenticationErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The DRMManager dispatches a DRMAuthenticationErrorEvent object when a call to the authenticate() - method of the DRMManager object fails. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  domain : String -
- The content domain of the media rights server.
-		DRMAuthenticationErrorEvent
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  serverURL : String -
- The URL of the media rights server that rejected the authentication attempt.
-		DRMAuthenticationErrorEvent
  subErrorID : int -
- A more detailed error code.
-		DRMAuthenticationErrorEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMAuthenticationErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inDetail:String = "", inErrorID:int = 0, inSubErrorID:int = 0, inServerURL:String = null, inDomain:String = null)
-
- Creates a new instance of a DRMAuthenticationErrorEvent object.
-		DRMAuthenticationErrorEvent
   -
-clone():Event -
-
- Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original.
-		DRMAuthenticationErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string that contains all the properties of the ErrorEvent object.
-		ErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  AUTHENTICATION_ERROR : String = "authenticationError"
[static] - The string constant to use for the authentication error event - in the type parameter when adding and removing event listeners.
-		DRMAuthenticationErrorEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
domainproperty
-
-domain:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The content domain of the media rights server. Here, domain is not a network or Internet domain name. - -

Implementation -
-    public function get domain():String -
-    public function set domain(value:String):void -
-
- - - - - -
serverURLproperty 
-
-serverURL:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The URL of the media rights server that rejected the authentication attempt. - -

Implementation -
-    public function get serverURL():String -
-    public function set serverURL(value:String):void -
-
- - - - - -
subErrorIDproperty 
-
-subErrorID:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A more detailed error code. - -

Implementation -
-    public function get subErrorID():int -
-    public function set subErrorID(value:int):void -
-
- -
Constructor detail
- - - - - -
DRMAuthenticationErrorEvent()constructor
-
-public function DRMAuthenticationErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inDetail:String = "", inErrorID:int = 0, inSubErrorID:int = 0, inServerURL:String = null, inDomain:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new instance of a DRMAuthenticationErrorEvent object. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — the event type string -
 
bubbles:Boolean (default = false) — whether the event bubbles up the display list -
 
cancelable:Boolean (default = false) — whether the event can be canceled -
 
inDetail:String (default = "") — The error description -
 
inErrorID:int (default = 0) — The ID of the general type of error -
 
inSubErrorID:int (default = 0) — The ID indicating the specific error within its type -
 
inServerURL:String (default = null) — the URL of the logged-in server -
 
inDomain:String (default = null) — the authenticated domain on the logged-in server - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event

- Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event — - A new ErrorEvent object with property values that match those of the original. - - - -
-
- -
Constant detail
- - - - - -
AUTHENTICATION_ERRORconstant
-
-public static const AUTHENTICATION_ERROR:String = "authenticationError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The string constant to use for the authentication error event - in the type parameter when adding and removing event listeners. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DRMDeviceGroupErrorEvent.html b/html-docs/flash/events/DRMDeviceGroupErrorEvent.html deleted file mode 100644 index 4e0b1ca..0000000 --- a/html-docs/flash/events/DRMDeviceGroupErrorEvent.html +++ /dev/null @@ -1,847 +0,0 @@ - - - - - - - - -flash.events.DRMDeviceGroupErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DRMDeviceGroupErrorEvent
InheritanceDRMDeviceGroupErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

-

-

Issued by the DRMManager when any error occurs during any device group related calls.

-

It is the application's responsibility to explicitly handle the error events.These events include cases - where the user inputs valid credentials, but the voucher protecting the encrypted content restricts the access - to the content. For example, an authenticated user cannot access content if the rights have not been - paid for. This error can also occur when two registered members of the same publisher attempt - to share content that only one of them has paid for.

- -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  deviceGroup : DRMDeviceGroup -
-		DRMDeviceGroupErrorEvent
  drmUpdateNeeded : Boolean -
[read-only]
-		DRMDeviceGroupErrorEvent
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  subErrorID : int -
-		DRMDeviceGroupErrorEvent
  systemUpdateNeeded : Boolean -
[read-only]
-		DRMDeviceGroupErrorEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMDeviceGroupErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, errorDetail:String = "", errorCode:int = 0, subErrorID:int = 0, deviceGroup:DRMDeviceGroup = null, systemUpdateNeeded:Boolean = false, drmUpdateNeeded:Boolean = false)
-
-		DRMDeviceGroupErrorEvent
   -
-clone():Event -
-
-		DRMDeviceGroupErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
-		DRMDeviceGroupErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  ADD_TO_DEVICE_GROUP_ERROR : String = "addToDeviceGroupError"
[static]
-		DRMDeviceGroupErrorEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
  REMOVE_FROM_DEVICE_GROUP_ERROR : String = "removeFromDeviceGroupError"
[static]
-		DRMDeviceGroupErrorEvent
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
deviceGroupproperty
-
-deviceGroup:DRMDeviceGroup  [read-write]Implementation -
-    public function get deviceGroup():DRMDeviceGroup -
-    public function set deviceGroup(value:DRMDeviceGroup):void -
-
- - - - - -
drmUpdateNeededproperty 
-
-drmUpdateNeeded:Boolean  [read-only]Implementation -
-    public function get drmUpdateNeeded():Boolean -
-
- - - - - -
subErrorIDproperty 
-
-subErrorID:int  [read-write]Implementation -
-    public function get subErrorID():int -
-    public function set subErrorID(value:int):void -
-
- - - - - -
systemUpdateNeededproperty 
-
-systemUpdateNeeded:Boolean  [read-only]Implementation -
-    public function get systemUpdateNeeded():Boolean -
-
- -
Constructor detail
- - - - - -
DRMDeviceGroupErrorEvent()constructor
-
-public function DRMDeviceGroupErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, errorDetail:String = "", errorCode:int = 0, subErrorID:int = 0, deviceGroup:DRMDeviceGroup = null, systemUpdateNeeded:Boolean = false, drmUpdateNeeded:Boolean = false)Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
errorDetail:String (default = "")
 
errorCode:int (default = 0)
 
subErrorID:int (default = 0)
 
deviceGroup:DRMDeviceGroup (default = null)
 
systemUpdateNeeded:Boolean (default = false)
 
drmUpdateNeeded:Boolean (default = false)
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

-Returns - - - - -
Event
-
- - - - - -
toString()method 
-
-public override function toString():String -

-Returns - - - - -
String
-
- -
Constant detail
- - - - - -
ADD_TO_DEVICE_GROUP_ERRORconstant
-
-public static const ADD_TO_DEVICE_GROUP_ERROR:String = "addToDeviceGroupError" -
- - - - - -
REMOVE_FROM_DEVICE_GROUP_ERRORconstant 
-
-public static const REMOVE_FROM_DEVICE_GROUP_ERROR:String = "removeFromDeviceGroupError" -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DRMDeviceGroupEvent.html b/html-docs/flash/events/DRMDeviceGroupEvent.html deleted file mode 100644 index f0da29f..0000000 --- a/html-docs/flash/events/DRMDeviceGroupEvent.html +++ /dev/null @@ -1,737 +0,0 @@ - - - - - - - - -flash.events.DRMDeviceGroupEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DRMDeviceGroupEvent
InheritanceDRMDeviceGroupEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

-

-

Issued by the DRMManager when a device group related call successfully completes. - Multiple devices can be registered to a device group using the DRMManager.addToDeviceGroup() - method. If there is a device with a valid domain-bound voucher for a given content, the application can then - extract the serialized DRM vouchers using the DRMVoucher.toByteArray() method.

-

If the content metadata specifies that domain registration is required, the application can invoke an API to join the - device group. This action triggers a domain registration request to be sent to the domain server. Once a license is issued to - a device group, the license can be exported and shared with other devices that have joined the device group.

- -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  deviceGroup : DRMDeviceGroup -
-		DRMDeviceGroupEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMDeviceGroupEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, deviceGroup:DRMDeviceGroup = null)
-
-		DRMDeviceGroupEvent
   -
-clone():Event -
-
-		DRMDeviceGroupEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
-		DRMDeviceGroupEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  ADD_TO_DEVICE_GROUP_COMPLETE : String = "addToDeviceGroupComplete"
[static]
-		DRMDeviceGroupEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
  REMOVE_FROM_DEVICE_GROUP_COMPLETE : String = "removeFromDeviceGroupComplete"
[static]
-		DRMDeviceGroupEvent
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
deviceGroupproperty
-
-deviceGroup:DRMDeviceGroup  [read-write]Implementation -
-    public function get deviceGroup():DRMDeviceGroup -
-    public function set deviceGroup(value:DRMDeviceGroup):void -
-
- -
Constructor detail
- - - - - -
DRMDeviceGroupEvent()constructor
-
-public function DRMDeviceGroupEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, deviceGroup:DRMDeviceGroup = null)Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
deviceGroup:DRMDeviceGroup (default = null)
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

-Returns - - - - -
Event
-
- - - - - -
toString()method 
-
-public override function toString():String -

-Returns - - - - -
String
-
- -
Constant detail
- - - - - -
ADD_TO_DEVICE_GROUP_COMPLETEconstant
-
-public static const ADD_TO_DEVICE_GROUP_COMPLETE:String = "addToDeviceGroupComplete" -
- - - - - -
REMOVE_FROM_DEVICE_GROUP_COMPLETEconstant 
-
-public static const REMOVE_FROM_DEVICE_GROUP_COMPLETE:String = "removeFromDeviceGroupComplete" -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DRMErrorEvent.html b/html-docs/flash/events/DRMErrorEvent.html deleted file mode 100644 index 7654e7a..0000000 --- a/html-docs/flash/events/DRMErrorEvent.html +++ /dev/null @@ -1,1109 +0,0 @@ - - - - - - - - -flash.events.DRMErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DRMErrorEvent
InheritanceDRMErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

-

- The DRMErrorEvent class provides information about errors that occur when playing digital rights management (DRM) - encrypted files. - -

The runtime dispatches a DRMErrorEvent object when a NetStream object, trying to play a digital rights management - (DRM) encrypted file, encounters a DRM-related error. For example, a DRMErrorEvent object is dispatched - when the content provider does not support the viewing application, - or when the user authorization fails, possibly because the user has not purchased the content.

-

- In the case of invalid user credentials, the DRMAuthenticateEvent object handles the error by repeatedly dispatching - until the user enters valid credentials, or the application denies further attempts. The application should listen - to any other DRM error events in order to detect, identify, and handle the DRM-related errors. -

-

- This class provides properties containing the object throwing the exception, the error code, and, - where applicable, a suberror code and text message containing information related to the error. For - a description of DRM-related error codes, see the Runtime error codes. - The DRM-related error codes start at error 3300. -

- -

-

-View the examples. -

-

-See also -

-
-flash.net.NetStream -
-DRMErrorEvent.DRM_ERROR -
-Runtime error codes -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  contentData : DRMContentData -
- The DRMContentData for the media file.
-		DRMErrorEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  drmUpdateNeeded : Boolean -
[read-only] - Indicates whether a DRM update is needed to play the DRM-protected content.
-		DRMErrorEvent
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  subErrorID : int -
[read-only] - An error ID that indicates more detailed information about the underlying problem.
-		DRMErrorEvent
  systemUpdateNeeded : Boolean -
[read-only] - Indicates whether a system update is needed to play the DRM-protected content.
-		DRMErrorEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inErrorDetail:String = "", inErrorCode:int = 0, insubErrorID:int = 0, inMetadata:DRMContentData = null, inSystemUpdateNeeded:Boolean = false, inDrmUpdateNeeded:Boolean = false)
-
- Creates an Event object that contains specific information about DRM error events.
-		DRMErrorEvent
   -
-clone():Event -
-
- Creates a copy of the DRMErrorEvent object and sets the value of each property to match - that of the original.
-		DRMErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the DRMErrorEvent object.
-		DRMErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
  DRM_ERROR : String = "drmError"
[static] - The DRMErrorEvent.DRM_ERROR constant defines the value of the - type property of a drmError event object.
-		DRMErrorEvent
  DRM_LOAD_DEVICEID_ERROR : String = "drmLoadDeviceIdError"
[static]
-		DRMErrorEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
contentDataproperty
-
-contentData:DRMContentData  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The DRMContentData for the media file. - -

You can use the object referenced by the contentData property - to retrieve the related DRM voucher from the DRMManager voucher cache. The voucher - properties describe the license available to the user and may explain why the - DRM-protected content cannot be viewed.

- - Implementation -
-    public function get contentData():DRMContentData -
-    public function set contentData(value:DRMContentData):void -
-
- - - - - -
drmUpdateNeededproperty 
-
-drmUpdateNeeded:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether a DRM update is needed to play the DRM-protected content. - -

Implementation -
-    public function get drmUpdateNeeded():Boolean -
-
- - - - - -
subErrorIDproperty 
-
-subErrorID:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An error ID that indicates more detailed information about the underlying problem. -

Implementation -
-    public function get subErrorID():int -
-
- - - - - -
systemUpdateNeededproperty 
-
-systemUpdateNeeded:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether a system update is needed to play the DRM-protected content. - -

Implementation -
-    public function get systemUpdateNeeded():Boolean -
-
- -
Constructor detail
- - - - - -
DRMErrorEvent()constructor
-
-public function DRMErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inErrorDetail:String = "", inErrorCode:int = 0, insubErrorID:int = 0, inMetadata:DRMContentData = null, inSystemUpdateNeeded:Boolean = false, inDrmUpdateNeeded:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates an Event object that contains specific information about DRM error events. - Event objects are passed as parameters to event listeners. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of DRMAuthenticate event: DRMAuthenticateEvent.DRM_AUTHENTICATE. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
inErrorDetail:String (default = "") — Where applicable, the specific syntactical details of the error. -
 
inErrorCode:int (default = 0) — The major error code. -
 
insubErrorID:int (default = 0) — The minor error ID. -
 
inMetadata:DRMContentData (default = null)
 
inSystemUpdateNeeded:Boolean (default = false)
 
inDrmUpdateNeeded:Boolean (default = false)
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the DRMErrorEvent object and sets the value of each property to match - that of the original. - -

-Returns - - - - -
Event — - A new DRMErrorEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Returns a string that contains all the properties of the DRMErrorEvent object. - The string is in the following format: -

[DRMErrorEvent type=value bubbles=value cancelable=value - eventPhase=value errroID=value subErrorID=value text=value

- -

-Returns - - - - -
String — - A string that contains all the properties of the DRMErrorEvent object. - - - -
-
- -
Constant detail
- - - - - -
DRM_ERRORconstant
-
-public static const DRM_ERROR:String = "drmError" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- The DRMErrorEvent.DRM_ERROR constant defines the value of the - type property of a drmError event object. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
errorIDA numerical error code assigned to the problem.
subErrorIDAn error code that indicates more detailed information about - the underlying problem.
targetThe NetStream object.
- -

-See also -

-
-flash.net.NetStream.drmError -
-
- - - - - -
DRM_LOAD_DEVICEID_ERRORconstant 
-
-public static const DRM_LOAD_DEVICEID_ERROR:String = "drmLoadDeviceIdError" -
- -
Examples
-
examples\DRMErrorEventExample
-
-
-
package
-{
-    import flash.display.Sprite;
-	import flash.events.AsyncErrorEvent;
-	import flash.events.NetStatusEvent;
-	import flash.events.DRMErrorEvent;
-	import flash.media.Video;
-	import flash.net.NetConnection;
-	import flash.net.NetStream;
-
-	public class DRMVideoExample extends Sprite
-	{
-		var videoURL:String = "Video.flv";
-		var videoConnection:NetConnection;
-		var videoStream:NetStream;
-		var video:Video = new Video();			
-
-		public function DRMVideoExample()
-		{
-            videoConnection = new NetConnection();
-            videoConnection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            videoConnection.connect(null);
-        }
-
-        private function connectStream():void {
-            videoStream = new NetStream(videoConnection);
-            videoStream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            videoStream.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler);
-			videoStream.addEventListener(DRMErrorEvent.DRM_ERROR, drmErrorEventHandler);
-            video.attachNetStream(videoStream);
-            videoStream.play(videoURL);
-            addChild(video);
-        }
-
-        private function netStatusHandler(event:NetStatusEvent):void {
-            switch (event.info.code) {
-                case "NetConnection.Connect.Success":
-                    connectStream();
-                    break;
-                case "NetStream.Play.StreamNotFound":
-                    trace("Unable to locate video: " + videoURL);
-                    break;
-            }
-        }
-
-        private function asyncErrorHandler(event:AsyncErrorEvent):void {
-            // ignore AsyncErrorEvent events.
-        }
-
-		private function drmErrorEventHandler(event:DRMErrorEvent):void {
-			trace(event.toString());
-		}
- 	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DRMLicenseRequestEvent.html b/html-docs/flash/events/DRMLicenseRequestEvent.html deleted file mode 100644 index c21085d..0000000 --- a/html-docs/flash/events/DRMLicenseRequestEvent.html +++ /dev/null @@ -1,794 +0,0 @@ - - - - - - - - -flash.events.DRMLicenseRequestEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DRMLicenseRequestEvent
InheritanceDRMLicenseRequestEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.9 -
-

-

- The DRMManager dispatches a DRMLicenseRequestEvent object before each call to the loadVoucher() - or loadPreviewVoucher() methods of the DRMManager object succeeds. This can also get called - during playback of protected video content. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  serverURL : String -
- The URL which will be used to communicate with the license server - -
-		DRMLicenseRequestEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMLicenseRequestEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inServerURL:String = null)
-
- Creates a new instance of a DRMLicenseRequestEvent object.
-		DRMLicenseRequestEvent
   -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		DRMLicenseRequestEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
  LICENSE_REQUEST : String = "licenseRequest"
[static] - The string constant to use for the license request event - in the type parameter when adding and removing event listeners.
-		DRMLicenseRequestEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
serverURLproperty
-
-serverURL:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.9 -
-

- The URL which will be used to communicate with the license server - -

Implementation -
-    public function get serverURL():String -
-    public function set serverURL(value:String):void -
-
- -
Constructor detail
- - - - - -
DRMLicenseRequestEvent()constructor
-
-public function DRMLicenseRequestEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inServerURL:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.9 -
-

- Creates a new instance of a DRMLicenseRequestEvent object. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — the event type string -
 
bubbles:Boolean (default = false) — whether the event bubbles up the display list -
 
cancelable:Boolean (default = false) — whether the event can be canceled -
 
inServerURL:String (default = null) — the URL of the license server - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event

- Duplicates an instance of an Event subclass. -

Returns a new Event object that is a copy of the original instance of the Event object. - You do not normally call clone(); the EventDispatcher class calls it automatically - when you redispatch an event—that is, when you call dispatchEvent(event) from a handler - that is handling event.

- -

The new Event object includes all the properties of the original.

-

When creating your own custom Event class, you must override the - inherited Event.clone() method in order for it to duplicate the - properties of your custom class. If you do not set all the properties that you add - in your event subclass, those properties will not have the correct values when listeners - handle the redispatched event.

- -

In this example, PingEvent is a subclass of Event - and therefore implements its own version of clone().

- - 
-	 class PingEvent extends Event {
-		 var URL:String;
-		 
-	 public override function clone():Event {
-	 	     return new PingEvent(type, bubbles, cancelable, URL);
-	    }
-	 }
-
- -

-Returns - - - - -
Event — - A new Event object that is identical to the original. - - -
-
- -
Constant detail
- - - - - -
LICENSE_REQUESTconstant
-
-public static const LICENSE_REQUEST:String = "licenseRequest" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.9 -
-

- The string constant to use for the license request event - in the type parameter when adding and removing event listeners. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DRMReturnVoucherCompleteEvent.html b/html-docs/flash/events/DRMReturnVoucherCompleteEvent.html deleted file mode 100644 index c32b6ac..0000000 --- a/html-docs/flash/events/DRMReturnVoucherCompleteEvent.html +++ /dev/null @@ -1,922 +0,0 @@ - - - - - - - - -flash.events.DRMReturnVoucherCompleteEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DRMReturnVoucherCompleteEvent
InheritanceDRMReturnVoucherCompleteEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

-

- The DRMManager dispatches a DRMVoucherReturnCompleteEvent object when a call to the returnVoucher() - method of the DRMManager object succeeds. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  licenseID : String -
- The license ID that was passed into the DRMManager.returnVoucher() call.
-		DRMReturnVoucherCompleteEvent
  numberOfVouchersReturned : int -
- The number of vouchers that matches the criterion passed into DRMManager.returnVoucher() and subsequently returned.
-		DRMReturnVoucherCompleteEvent
  policyID : String -
- The policyID that was passed into the DRMManager.returnVoucher() call.
-		DRMReturnVoucherCompleteEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  serverURL : String -
- The URL of the media rights server.
-		DRMReturnVoucherCompleteEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMReturnVoucherCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inServerURL:String = null, inLicenseID:String = null, inPolicyID:String = null, inNumberOfVouchersReturned:int = 0)
-
- Creates a new instance of a DRMReturnVoucherCompleteEvent object.
-		DRMReturnVoucherCompleteEvent
   -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		DRMReturnVoucherCompleteEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
  RETURN_VOUCHER_COMPLETE : String = "returnVoucherComplete"
[static] - The string constant to use for the return voucher complete event - in the type parameter when adding and removing event listeners.
-		DRMReturnVoucherCompleteEvent
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
licenseIDproperty
-
-licenseID:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- The license ID that was passed into the DRMManager.returnVoucher() call. - -

Implementation -
-    public function get licenseID():String -
-    public function set licenseID(value:String):void -
-
- - - - - -
numberOfVouchersReturnedproperty 
-
-numberOfVouchersReturned:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- The number of vouchers that matches the criterion passed into DRMManager.returnVoucher() and subsequently returned. - -

Implementation -
-    public function get numberOfVouchersReturned():int -
-    public function set numberOfVouchersReturned(value:int):void -
-

-See also -

-
-flash.net.drm.DRMManager.setAuthenticationToken() -
-
- - - - - -
policyIDproperty 
-
-policyID:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The policyID that was passed into the DRMManager.returnVoucher() call. - -

Implementation -
-    public function get policyID():String -
-    public function set policyID(value:String):void -
-
- - - - - -
serverURLproperty 
-
-serverURL:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- The URL of the media rights server. - -

Implementation -
-    public function get serverURL():String -
-    public function set serverURL(value:String):void -
-
- -
Constructor detail
- - - - - -
DRMReturnVoucherCompleteEvent()constructor
-
-public function DRMReturnVoucherCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inServerURL:String = null, inLicenseID:String = null, inPolicyID:String = null, inNumberOfVouchersReturned:int = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- Creates a new instance of a DRMReturnVoucherCompleteEvent object. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — the event type string -
 
bubbles:Boolean (default = false) — whether the event bubbles up the display list -
 
cancelable:Boolean (default = false) — whether the event can be canceled -
 
inServerURL:String (default = null) — the URL of the logged-in server -
 
inLicenseID:String (default = null) — the authenticated domain on the logged-in server -
 
inPolicyID:String (default = null) — the authentication token - -
 
inNumberOfVouchersReturned:int (default = 0)
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event

- Duplicates an instance of an Event subclass. -

Returns a new Event object that is a copy of the original instance of the Event object. - You do not normally call clone(); the EventDispatcher class calls it automatically - when you redispatch an event—that is, when you call dispatchEvent(event) from a handler - that is handling event.

- -

The new Event object includes all the properties of the original.

-

When creating your own custom Event class, you must override the - inherited Event.clone() method in order for it to duplicate the - properties of your custom class. If you do not set all the properties that you add - in your event subclass, those properties will not have the correct values when listeners - handle the redispatched event.

- -

In this example, PingEvent is a subclass of Event - and therefore implements its own version of clone().

- - 
-	 class PingEvent extends Event {
-		 var URL:String;
-		 
-	 public override function clone():Event {
-	 	     return new PingEvent(type, bubbles, cancelable, URL);
-	    }
-	 }
-
- -

-Returns - - - - -
Event — - A new Event object that is identical to the original. - - -
-
- -
Constant detail
- - - - - -
RETURN_VOUCHER_COMPLETEconstant
-
-public static const RETURN_VOUCHER_COMPLETE:String = "returnVoucherComplete" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- The string constant to use for the return voucher complete event - in the type parameter when adding and removing event listeners. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DRMReturnVoucherErrorEvent.html b/html-docs/flash/events/DRMReturnVoucherErrorEvent.html deleted file mode 100644 index b2f1f56..0000000 --- a/html-docs/flash/events/DRMReturnVoucherErrorEvent.html +++ /dev/null @@ -1,935 +0,0 @@ - - - - - - - - -flash.events.DRMReturnVoucherErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DRMReturnVoucherErrorEvent
InheritanceDRMReturnVoucherErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

-

- The DRMManager dispatches a DRMReturnVoucherErrorEvent object when a call to the returnVoucher() - method of the DRMManager object fails. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  licenseID : String -
- The license ID that was passed into the returnVoucher() call that resulted in this error.
-		DRMReturnVoucherErrorEvent
  policyID : String -
- The policy ID that was passed into the returnVoucher() call that resulted in this error.
-		DRMReturnVoucherErrorEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  serverURL : String -
- The URL of the media rights server for this return Voucher attempt.
-		DRMReturnVoucherErrorEvent
  subErrorID : int -
- A more detailed error code.
-		DRMReturnVoucherErrorEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMReturnVoucherErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inDetail:String = "", inErrorID:int = 0, inSubErrorID:int = 0, inServerURL:String = null, inLicenseID:String = null, inPolicyID:String = null)
-
- Creates a new instance of a DRMReturnVoucherErrorEvent object.
-		DRMReturnVoucherErrorEvent
   -
-clone():Event -
-
- Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original.
-		DRMReturnVoucherErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string that contains all the properties of the ErrorEvent object.
-		ErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
  RETURN_VOUCHER_ERROR : String = "returnVoucherError"
[static] - The string constant to use for the return voucher error event - in the type parameter when adding and removing event listeners.
-		DRMReturnVoucherErrorEvent
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
licenseIDproperty
-
-licenseID:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- The license ID that was passed into the returnVoucher() call that resulted in this error. - -

Implementation -
-    public function get licenseID():String -
-    public function set licenseID(value:String):void -
-
- - - - - -
policyIDproperty 
-
-policyID:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- The policy ID that was passed into the returnVoucher() call that resulted in this error. - -

Implementation -
-    public function get policyID():String -
-    public function set policyID(value:String):void -
-
- - - - - -
serverURLproperty 
-
-serverURL:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- The URL of the media rights server for this return Voucher attempt. - -

Implementation -
-    public function get serverURL():String -
-    public function set serverURL(value:String):void -
-
- - - - - -
subErrorIDproperty 
-
-subErrorID:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- A more detailed error code. - -

Implementation -
-    public function get subErrorID():int -
-    public function set subErrorID(value:int):void -
-
- -
Constructor detail
- - - - - -
DRMReturnVoucherErrorEvent()constructor
-
-public function DRMReturnVoucherErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inDetail:String = "", inErrorID:int = 0, inSubErrorID:int = 0, inServerURL:String = null, inLicenseID:String = null, inPolicyID:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new instance of a DRMReturnVoucherErrorEvent object. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — the event type string -
 
bubbles:Boolean (default = false) — whether the event bubbles up the display list -
 
cancelable:Boolean (default = false) — whether the event can be canceled -
 
inDetail:String (default = "") — The error description -
 
inErrorID:int (default = 0) — The ID of the general type of error -
 
inSubErrorID:int (default = 0) — The ID indicating the specific error within its type -
 
inServerURL:String (default = null) — the URL of the logged-in server -
 
inLicenseID:String (default = null) — the authenticated domain on the logged-in server - -
 
inPolicyID:String (default = null)
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event

- Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event — - A new ErrorEvent object with property values that match those of the original. - - - -
-
- -
Constant detail
- - - - - -
RETURN_VOUCHER_ERRORconstant
-
-public static const RETURN_VOUCHER_ERROR:String = "returnVoucherError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The string constant to use for the return voucher error event - in the type parameter when adding and removing event listeners. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DRMStatusEvent.html b/html-docs/flash/events/DRMStatusEvent.html deleted file mode 100644 index 3c4974e..0000000 --- a/html-docs/flash/events/DRMStatusEvent.html +++ /dev/null @@ -1,1148 +0,0 @@ - - - - - - - - -flash.events.DRMStatusEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DRMStatusEvent
InheritanceDRMStatusEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A NetStream object dispatches a DRMStatusEvent object when the content protected using - digital rights management (DRM) begins playing successfully (when the voucher is - verified, and when the user is authenticated and authorized to view the content). - The DRMStatusEvent object contains information related to the voucher, such as - whether the content can be made available offline or when the voucher will expire - and the content can no longer be viewed. The application can use this data to - inform the user of the status of her policy and permissions. - -

-

-See also -

-
-flash.net.NetStream -
-DRMStatusEvent.DRM_STATUS -
-flash.net.drm.DRMManager -
-flash.net.drm.DRMVoucher -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  contentData : DRMContentData -
- A DRMContentData object containing the information necessary - to obtain a voucher for viewing the DRM-protected content.
-		DRMStatusEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  detail : String -
[read-only] - A string explaining the context of the status event.
-		DRMStatusEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  isAnonymous : Boolean -
[read-only] - Indicates whether the content, protected with digital rights management (DRM) encryption, is available - without requiring a user to provide authentication credentials.
-		DRMStatusEvent
  isAvailableOffline : Boolean -
[read-only] - Indicates whether the content, protected with digital rights management (DRM) encryption, is available - offline.
-		DRMStatusEvent
  isLocal : Boolean -
- Indicates whether the voucher is cached in the local voucher store.
-		DRMStatusEvent
  offlineLeasePeriod : uint -
[read-only] - The remaining number of days that content can be viewed offline.
-		DRMStatusEvent
  policies : Object -
[read-only] - A custom object of the DRM status event.
-		DRMStatusEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
  voucher : DRMVoucher -
- A DRMVoucher object for the content.
-		DRMStatusEvent
  voucherEndDate : Date -
[read-only] - The absolute date on which the voucher expires and the content can no longer be viewed by users.
-		DRMStatusEvent
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inMetadata:DRMContentData = null, inVoucher:DRMVoucher = null, inLocal:Boolean = false)
-
- Creates an Event object that contains specific information about DRM status events.
-		DRMStatusEvent
   -
-clone():Event -
-
- Creates a copy of the DRMStatusEvent object and sets the value of each property to match - that of the original.
-		DRMStatusEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the DRMStatusEvent object.
-		DRMStatusEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
  DRM_STATUS : String = "drmStatus"
[static] - The DRMStatusEvent.DRM_STATUS constant defines the value of the - type property of a drmStatus event object.
-		DRMStatusEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
contentDataproperty
-
-contentData:DRMContentData  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A DRMContentData object containing the information necessary - to obtain a voucher for viewing the DRM-protected content. - -

Implementation -
-    public function get contentData():DRMContentData -
-    public function set contentData(value:DRMContentData):void -
-
- - - - - -
detailproperty 
-
-detail:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A string explaining the context of the status event. - -

Implementation -
-    public function get detail():String -
-
- - - - - -
isAnonymousproperty 
-
-isAnonymous:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether the content, protected with digital rights management (DRM) encryption, is available - without requiring a user to provide authentication credentials. If so, the value is - true. Otherwise, the value is false, and a user must provide a username - and password that matches the one known and expected by the content provider. - -

Implementation -
-    public function get isAnonymous():Boolean -
-
- - - - - -
isAvailableOfflineproperty 
-
-isAvailableOffline:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether the content, protected with digital rights management (DRM) encryption, is available - offline. If so, the value is true. Otherwise, the value is false. -

- In order for digitally protected content to be available offline, its voucher must be cached to the user's - local machine. (The application decides where to store the content locally in order for it to be available - offline.) -

- - Implementation -
-    public function get isAvailableOffline():Boolean -
-
- - - - - -
isLocalproperty 
-
-isLocal:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates whether the voucher is cached in the local voucher store. - -

Implementation -
-    public function get isLocal():Boolean -
-    public function set isLocal(value:Boolean):void -
-
- - - - - -
offlineLeasePeriodproperty 
-
-offlineLeasePeriod:uint  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The remaining number of days that content can be viewed offline. - -

Implementation -
-    public function get offlineLeasePeriod():uint -
-
- - - - - -
policiesproperty 
-
-policies:Object  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A custom object of the DRM status event. - -

Implementation -
-    public function get policies():Object -
-
- - - - - -
voucherproperty 
-
-voucher:DRMVoucher  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A DRMVoucher object for the content. - -

Implementation -
-    public function get voucher():DRMVoucher -
-    public function set voucher(value:DRMVoucher):void -
-
- - - - - -
voucherEndDateproperty 
-
-voucherEndDate:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The absolute date on which the voucher expires and the content can no longer be viewed by users. - -

Implementation -
-    public function get voucherEndDate():Date -
-
- -
Constructor detail
- - - - - -
DRMStatusEvent()constructor
-
-public function DRMStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inMetadata:DRMContentData = null, inVoucher:DRMVoucher = null, inLocal:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates an Event object that contains specific information about DRM status events. - Event objects are passed as parameters to event listeners. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of DRMAuthenticate event: DRMAuthenticateEvent.DRM_AUTHENTICATE. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
inMetadata:DRMContentData (default = null) — The custom object that contains custom DRM properties. -
 
inVoucher:DRMVoucher (default = null) — The context of the Event. -
 
inLocal:Boolean (default = false) — Indicates if content can be viewed offline. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the DRMStatusEvent object and sets the value of each property to match - that of the original. - -

-Returns - - - - -
Event — - A new DRMStatusEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Runtime version: AIR 1.0 -
-

- Returns a string that contains all the properties of the DRMStatusEvent object. -

-Returns - - - - -
String — - A string that contains all the properties of the DRMStatusEvent object. - - -
-
- -
Constant detail
- - - - - -
DRM_STATUSconstant
-
-public static const DRM_STATUS:String = "drmStatus" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The DRMStatusEvent.DRM_STATUS constant defines the value of the - type property of a drmStatus event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
detailA string explaining the context of the status event.
isAnonymousIndicates whether the content protected with DRM - encryption is available without requiring a user to provide authentication credentials.
isAvailableOfflineIndicates whether the content protected with DRM - encryption is available offline.
offlineLeasePeriodThe remaining number of days that content can be - viewed offline.
policiesA custom object of the DRM status event.
targetThe NetStream object.
voucherEndDateThe absolute date on which the voucher expires - and the content can no longer be viewed by users
contentDataThe DRMContentData for the content
voucherThe DRMVoucher object for the content.
isLocalIndicates whether the content is stored on the local file system
- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DataEvent.html b/html-docs/flash/events/DataEvent.html deleted file mode 100644 index 0add767..0000000 --- a/html-docs/flash/events/DataEvent.html +++ /dev/null @@ -1,1002 +0,0 @@ - - - - - - - - -flash.events.DataEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DataEvent
InheritanceDataEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

-

-An object dispatches a DataEvent object when raw data has completed loading. -There are three types of data event: -
  • DataEvent.DATA: dispatched for data sent or received.
    • -
  • DataEvent.UPLOAD_COMPLETE_DATA: dispatched when data is sent and the server has responded.
    • < -
  • DataEvent.WEBVIEW_MESSAGE: dispatched when a message is sent from a web page hosted by a StageWebView object.
-

-

-View the examples. -

-

-See also -

-
-flash.net.FileReference -
-flash.net.XMLSocket -
-flash.media.StageWebView -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  data : String -
- The raw data loaded into Flash Player or Adobe AIR.
-		DataEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:String = "")
-
- Creates an event object that contains information about data events.
-		DataEvent
   -
-clone():Event -
-
- Creates a copy of the DataEvent object and sets the value of each property to match that of the - original.
-		DataEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the DataEvent object.
-		DataEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
  DATA : String = "data"
[static] - Defines the value of the type property of a data event object.
-		DataEvent
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
  UPLOAD_COMPLETE_DATA : String = "uploadCompleteData"
[static] - Defines the value of the type property of an uploadCompleteData event object.
-		DataEvent
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
  WEBVIEW_MESSAGE : String = "webViewMessage"
[static] - Defines the value of the type property of an webViewMessage event object.
-		DataEvent
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
dataproperty
-
-data:String  [read-write]

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The raw data loaded into Flash Player or Adobe AIR. -

Implementation -
-    public function get data():String -
-    public function set data(value:String):void -
-
- -
Constructor detail
- - - - - -
DataEvent()constructor
-
-public function DataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:String = "") -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates an event object that contains information about data events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the - inherited type property. -
 
bubbles:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can - access this information through the inherited cancelable property. -
 
cancelable:Boolean (default = false) — The raw data loaded into Flash Player or Adobe AIR. Event listeners can access this information - through the data property. -
 
data:String (default = "")
-

-See also -

-
-flash.net.XMLSocket -
-DataEvent.DATA -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a copy of the DataEvent object and sets the value of each property to match that of the - original. -

-Returns - - - - -
Event — - A new DataEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the DataEvent object. The string is in - the following format: -

[DataEvent type=value bubbles=value cancelable=value - data=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the DataEvent object. - - - -
-
- -
Constant detail
- - - - - -
DATAconstant
-
-public static const DATA:String = "data" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a data event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe raw data loaded into Flash Player or Adobe AIR.
targetThe XMLSocket object receiving data.
- -

-See also -

-
-flash.net.XMLSocket.data -
-
- - - - - -
UPLOAD_COMPLETE_DATAconstant 
-
-public static const UPLOAD_COMPLETE_DATA:String = "uploadCompleteData" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of an uploadCompleteData event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe raw data returned from the server after a successful file upload.
targetThe FileReference object receiving data after a successful upload.
- -

-See also -

-
-flash.net.FileReference.uploadCompleteData -
-
- - - - - -
WEBVIEW_MESSAGEconstant 
-
-public static const WEBVIEW_MESSAGE:String = "webViewMessage" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 51.0 -
-

- Defines the value of the type property of an webViewMessage event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe string data posted by the HTML page hosted within the StageWebView object, potentially a JSON formatted string.
targetThe StageWebView object that was sent the postMessage request.
-

-See also -

-
-flash.media.StageWebView.webViewMessage -
-
- -
Examples
-
examples\DataEventExample
-
The following example creates an XMLSocket and connects it to a socket server - running on port 8080 of yourDomain. An event listener is attached to the XMLSocket - object that listens for data events, which are dispatched whenever raw data - is received. - -

Notes: -

    -
  • To generate a securityError event in this example, you need to compile the SWF file with "Local playback security" set - to "Access network only".
    • -
  • You need a server running on [yourDomain] using port 8080.
    • -
-

-
-
-package {
-	import flash.display.Sprite;
-	import flash.events.DataEvent;
-	import flash.net.XMLSocket;
-
-	public class DataEventExample extends Sprite {
-		private var hostName:String = "[yourDomain]";
-		private var port:uint = 8080;
-		private var socket:XMLSocket;
-
-		public function DataEventExample() {
-			socket = new XMLSocket();
-			socket.addEventListener(DataEvent.DATA, dataHandler);
-			socket.connect(hostName, port);
-		}
-
-		private function dataHandler(event:DataEvent):void {
-			trace("dataHandler: " + event.data);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DatagramSocketDataEvent.html b/html-docs/flash/events/DatagramSocketDataEvent.html deleted file mode 100644 index fb0bcaa..0000000 --- a/html-docs/flash/events/DatagramSocketDataEvent.html +++ /dev/null @@ -1,1002 +0,0 @@ - - - - - - - - -flash.events.DatagramSocketDataEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DatagramSocketDataEvent
InheritanceDatagramSocketDataEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- A DatagramSocketDataEvent object is dispatched when Datagram socket has received data. -

-

-See also -

-
-DatagramSocket class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  data : ByteArray -
- The datagram packet data.
-		DatagramSocketDataEvent
  dstAddress : String -
- The IP address of the DatagramSocket object that dispatched this event.
-		DatagramSocketDataEvent
  dstPort : int -
- The port of the DatagramSocket object that dispatched this event.
-		DatagramSocketDataEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  srcAddress : String -
- The IP address of the machine that sent the packet.
-		DatagramSocketDataEvent
  srcPort : int -
- The port on the machine that sent the packet.
-		DatagramSocketDataEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DatagramSocketDataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, srcAddress:String = "", srcPort:int = 0, dstAddress:String = "", dstPort:int = 0, data:ByteArray = null)
-
- Creates an Event object that contains information about datagram events.
-		DatagramSocketDataEvent
   -
-clone():Event -
-
- Creates a copy of the DatagramSocketDataEvent object and sets each property's value to match that of the original.
-		DatagramSocketDataEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the DatagramSocketDataEvent object.
-		DatagramSocketDataEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
  DATA : String = "data"
[static] - Defines the value of the type property of a data event object.
-		DatagramSocketDataEvent
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
dataproperty
-
-data:ByteArray  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The datagram packet data. - -

Implementation -
-    public function get data():ByteArray -
-    public function set data(value:ByteArray):void -
-
- - - - - -
dstAddressproperty 
-
-dstAddress:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The IP address of the DatagramSocket object that dispatched this event. - -

Note: If the socket is bound to the special address: 0.0.0.0, then this property - will return 0.0.0.0. In order to know the specific IP to which the datagram message is sent, - you must bind the socket to an explicit IP address.

- - Implementation -
-    public function get dstAddress():String -
-    public function set dstAddress(value:String):void -
-
- - - - - -
dstPortproperty 
-
-dstPort:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The port of the DatagramSocket object that dispatched this event. - -

Implementation -
-    public function get dstPort():int -
-    public function set dstPort(value:int):void -
-
- - - - - -
srcAddressproperty 
-
-srcAddress:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The IP address of the machine that sent the packet. - -

Implementation -
-    public function get srcAddress():String -
-    public function set srcAddress(value:String):void -
-
- - - - - -
srcPortproperty 
-
-srcPort:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The port on the machine that sent the packet. - -

Implementation -
-    public function get srcPort():int -
-    public function set srcPort(value:int):void -
-
- -
Constructor detail
- - - - - -
DatagramSocketDataEvent()constructor
-
-public function DatagramSocketDataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, srcAddress:String = "", srcPort:int = 0, dstAddress:String = "", dstPort:int = 0, data:ByteArray = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates an Event object that contains information about datagram events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are:DatagramSocketDataEvent.DATA -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. - -
 
srcAddress:String (default = "") — The IP address of the machine that sent the packet. -
 
srcPort:int (default = 0) — The port on the machine that sent the packet. -
 
dstAddress:String (default = "") — The IP address to which the packet is addressed. -
 
dstPort:int (default = 0) — The port to which the packet is addressed. -
 
data:ByteArray (default = null) — The datagram packet data. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates a copy of the DatagramSocketDataEvent object and sets each property's value to match that of the original. - -

-Returns - - - - -
Event — - A new DatagramSocketDataEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that contains all the properties of the DatagramSocketDataEvent object. - - The string is in the following format: -

[DatagramSocketDataEvent type=value bubbles=value cancelable=value srcAddress=value srcPort=value dstAddress=value dstPort=value data=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the ProgressEvent object. - - -
-
- -
Constant detail
- - - - - -
DATAconstant
-
-public static const DATA:String = "data" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a data event object. - -

-See also -

-
-flash.net.DatagramSocket.data -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/DeviceRotationEvent.html b/html-docs/flash/events/DeviceRotationEvent.html deleted file mode 100644 index b5a92cb..0000000 --- a/html-docs/flash/events/DeviceRotationEvent.html +++ /dev/null @@ -1,1010 +0,0 @@ - - - - - - - - -flash.events.DeviceRotationEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class DeviceRotationEvent
InheritanceDeviceRotationEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0
-

-

-The DeviceRotation class dispatches DeviceRotationEvent and returns roll, yaw, pitch and quaternion data when DeviceRotation updates are obtained from the combined readings from -Accelerometer and Gyroscope sensors' readings installed on the device. -

-

-See also -

-
-flash.sensors.DeviceRotation -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  pitch : Number -
- pitch along the x-axis, measured in degrees.
-		DeviceRotationEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quaternion : Array -
- Quaternion data for the device rotation in the [w, x, y, z] format.
-		DeviceRotationEvent
  roll : Number -
- Roll along the y-axis, measured in degrees.
-		DeviceRotationEvent
 Inheritedtarget : Object -
- The event target.
-		Event
  timestamp : Number -
- The number of milliseconds at the time of the event since the runtime was initialized.
-		DeviceRotationEvent
 Inheritedtype : String -
- The type of event.
-		Event
  yaw : Number -
- yaw along the z-axis, measured in degrees.
-		DeviceRotationEvent
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DeviceRotationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, timestamp:Number = 0, roll:Number = 0, pitch:Number = 0, yaw:Number = 0, quaternion:Array = null)
-
- Creates an DeviceRotationEvent object that contains information about roll, yaw, pitch along the three dimensional axis.
-		DeviceRotationEvent
   -
-clone():Event -
-
- Creates a copy of an DeviceRotationEvent object and sets the value of each property to match that of - the original.
-		DeviceRotationEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the DeviceRotationEvent object.
-		DeviceRotationEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
  UPDATE : String = "update"
[static] - Defines the value of the type property of a DeviceRotationEvent event object.
-		DeviceRotationEvent
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
pitchproperty
-
-pitch:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- pitch along the x-axis, measured in degrees. -

Implementation -
-    public function get pitch():Number -
-    public function set pitch(value:Number):void -
-
- - - - - -
quaternionproperty 
-
-quaternion:Array  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- Quaternion data for the device rotation in the [w, x, y, z] format. -

Implementation -
-    public function get quaternion():Array -
-    public function set quaternion(value:Array):void -
-
- - - - - -
rollproperty 
-
-roll:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- Roll along the y-axis, measured in degrees. -

Implementation -
-    public function get roll():Number -
-    public function set roll(value:Number):void -
-
- - - - - -
timestampproperty 
-
-timestamp:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- The number of milliseconds at the time of the event since the runtime was initialized. - For example, if the device captures DeviceRotation data 4 seconds after the application initializes, - then the timestamp property of the event is set to 4000. -

Implementation -
-    public function get timestamp():Number -
-    public function set timestamp(value:Number):void -
-
- - - - - -
yawproperty 
-
-yaw:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- yaw along the z-axis, measured in degrees. -

Implementation -
-    public function get yaw():Number -
-    public function set yaw(value:Number):void -
-
- -
Constructor detail
- - - - - -
DeviceRotationEvent()constructor
-
-public function DeviceRotationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, timestamp:Number = 0, roll:Number = 0, pitch:Number = 0, yaw:Number = 0, quaternion:Array = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- Creates an DeviceRotationEvent object that contains information about roll, yaw, pitch along the three dimensional axis. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of update event: AccelerometerEvent.UPDATE. -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
timestamp:Number (default = 0) — The timestamp of the DeviceRotation update. -
 
roll:Number (default = 0) — The roll value in degrees along the y-axis. -
 
pitch:Number (default = 0) — The pitch value in degrees along the x-axis. -
 
yaw:Number (default = 0) — The yaw value in degrees along the z-axis. -
 
quaternion:Array (default = null) — The quaternions for the device rotation in [w, x, y, z] format. - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- Creates a copy of an DeviceRotationEvent object and sets the value of each property to match that of - the original. - -

-Returns - - - - -
Event — - A new DeviceRotationEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- Returns a string that contains all the properties of the DeviceRotationEvent object. The following - format is used: -

[DeviceRotationEvent type=value bubbles=value cancelable=value - timestamp=value roll=value pitch=value yaw=value quaternion=value ]

- -

-Returns - - - - -
String — - A string that contains all the properties of the DeviceRotationEvent object. - - -
-
- -
Constant detail
- - - - - -
UPDATEconstant
-
-public static const UPDATE:String = "update" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- Defines the value of the type property of a DeviceRotationEvent event object. -

This event has the following properties:

- - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
timestampThe timestamp of the DeviceRotation update.
rollThe roll value in degrees.
pitchThe pitch value in degrees.
yawThe yaw value in degrees.
quaternion The quaternion data in [w, x, y, z] format
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/ErrorEvent.html b/html-docs/flash/events/ErrorEvent.html deleted file mode 100644 index 3d981b5..0000000 --- a/html-docs/flash/events/ErrorEvent.html +++ /dev/null @@ -1,930 +0,0 @@ - - - - - - - - -flash.events.ErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.events
Classpublic class ErrorEvent
InheritanceErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
SubclassesAsyncErrorEvent, DownloadErrorEvent, DRMAuthenticationErrorEvent, DRMDeviceGroupErrorEvent, DRMErrorEvent, DRMReturnVoucherErrorEvent, IOErrorEvent, SecurityErrorEvent, SQLErrorEvent, StatusFileUpdateErrorEvent, StatusUpdateErrorEvent, UncaughtErrorEvent
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

-

-An object dispatches an ErrorEvent object when an error causes an asynchronous operation -to fail. - -

The ErrorEvent class defines only one type of error event: -ErrorEvent.ERROR. The ErrorEvent class also serves as the base class for -several other error event classes, including the AsyncErrorEvent, IOErrorEvent, -SecurityErrorEvent, SQLErrorEvent, and UncaughtErrorEvent classes.

- -

You can check for error events that do not have any listeners by -registering a listener for the uncaughtError (UncaughtErrorEvent.UNCAUGHT_ERROR) -event.

- -

An uncaught error also causes an error dialog box displaying the error event to appear -when content is running in the debugger version of Flash -Player or the AIR Debug Launcher (ADL) application.

- -

-

-View the examples. -

-

-See also -

-
-UncaughtErrorEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  errorID : int -
[read-only] - Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0)
-
- Creates an Event object that contains information about error events.
-		ErrorEvent
   -
-clone():Event -
-
- Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original.
-		ErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the ErrorEvent object.
-		ErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
  ERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
errorIDproperty
-
-errorID:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Contains the reference number associated with the specific error. - For a custom ErrorEvent object, this number is the value from the id - parameter supplied in the constructor. -

Implementation -
-    public function get errorID():int -
-
- -
Constructor detail
- - - - - -
ErrorEvent()constructor
-
-public function ErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Creates an Event object that contains information about error events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of error event: ErrorEvent.ERROR. -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
text:String (default = "") — Text to be displayed as an error message. Event listeners can access this information through the text property. -
 
id:int (default = 0) — A reference number to associate with the specific error (supported in Adobe AIR only). -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event — - A new ErrorEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Returns a string that contains all the properties of the ErrorEvent object. The string is in the following format: -

[ErrorEvent type=value bubbles=value cancelable=value text=value errorID=value]

-

Note: The errorId value returned by the toString() method is only available for Adobe AIR. - While Flash Player 10.1 supports the errorID property, calling toString() on the ErrorEvent object does - not provide the errorId value in Flash Player.

- -

-Returns - - - - -
String — - A string that contains all the properties of the ErrorEvent object. - - - -
-
- -
Constant detail
- - - - - -
ERRORconstant
-
-public static const ERROR:String = "error" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -
- -
Examples
-
examples\ErrorEventExample
-
The following example demonstrates the use of a single error handler (errorHandler()) - that captures multiple types of error events. If there is an ioError event, the handler - attempts to load from the network, which then throws a securityError. - -

Note: This example does not work if you have a file named - MissingFile.xml in the same directory as your SWF file.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.net.URLLoader;
-    import flash.net.URLRequest;
-    import flash.events.*;
-
-    public class ErrorEventExample extends Sprite {
-        private var loader:URLLoader;
-    	private var request:URLRequest;
-    	
-        public function ErrorEventExample() {
-            loader = new URLLoader();
-            loader.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-            loader.addEventListener(SecurityErrorEvent.SECURITY_ERROR, errorHandler);
-
-            request = new URLRequest();
-            loadFromFileSystem();
-        }
-        
-        private function loadFromFileSystem():void {
-        	request.url = "MissingFile.xml";
-            loader.load(request);
-        }
-
-		private function loadFromNetwork():void {
-            request.url = "http://www.[yourDomain].com/MissingFile.xml";
-            loader.load(request);
-		}
-		
-        private function errorHandler(event:ErrorEvent):void {
-            trace("errorHandler: " + event);
-            if(event is IOErrorEvent) {
-            	loadFromNetwork();
-            }
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/events/Event.html b/html-docs/flash/events/Event.html deleted file mode 100644 index 15c8d6e..0000000 --- a/html-docs/flash/events/Event.html +++ /dev/null @@ -1,3755 +0,0 @@ - - - - - - - - -flash.events.Event (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.events
Classpublic class Event
InheritanceEvent Inheritance Object
SubclassesAccelerometerEvent, ActivityEvent, AudioOutputChangeEvent, BrowserInvokeEvent, ContextMenuEvent, DatagramSocketDataEvent, DeviceRotationEvent, DNSResolverEvent, DRMAuthenticateEvent, DRMAuthenticationCompleteEvent, DRMDeviceGroupEvent, DRMLicenseRequestEvent, DRMReturnVoucherCompleteEvent, DRMStatusEvent, FileListEvent, FocusEvent, GameInputEvent, GeolocationEvent, GestureEvent, HTMLUncaughtScriptExceptionEvent, HTTPStatusEvent, InvokeEvent, KeyboardEvent, LocationChangeEvent, MediaEvent, MouseEvent, NativeProcessExitEvent, NativeWindowBoundsEvent, NativeWindowDisplayStateEvent, NetDataEvent, NetMonitorEvent, NetStatusEvent, OutputProgressEvent, PermissionEvent, ProgressEvent, RemoteNotificationEvent, SampleDataEvent, ServerSocketConnectEvent, ShaderEvent, SoftKeyboardEvent, SQLEvent, SQLUpdateEvent, StageOrientationEvent, StageVideoAvailabilityEvent, StageVideoEvent, StatusEvent, StorageVolumeChangeEvent, SyncEvent, TextEvent, ThrottleEvent, TimerEvent, TouchEvent, UpdateEvent, VideoEvent, VideoTextureEvent, VsyncStateChangeAvailabilityEvent, WebSocketEvent, WebViewDrawEvent
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The Event class is used as the base class for the creation of Event objects, - which are passed as parameters to event listeners when an event occurs. - -

The properties of the Event class carry basic information about an event, such as - the event's type or whether the event's default behavior can be canceled. For many - events, such as the events represented by the Event class constants, this basic information - is sufficient. Other events, however, may require more detailed information. Events associated - with a mouse click, for example, need to include additional information about the location of - the click event and whether any keys were pressed during the click event. You can pass such additional - information to event listeners by extending the Event class, which is what - the MouseEvent class does. ActionScript 3.0The Adobe® - AIR™ API defines several Event subclasses for common - events that require additional information. Events associated with each of the Event - subclasses are described in the documentation for each class.

-

The methods of the Event class can be used in event listener functions to affect the - behavior of the event object. Some events have an associated default behavior. For example, - the doubleClick event has an associated default behavior that highlights - the word under the mouse pointer at the time of the event. - For example, the closing event dispatched by a NativeWindow object - has an associated default behavior that closes the window. Your event listener can cancel this - behavior by calling the preventDefault() method. - You can also make the current - event listener the last one to process an event by calling the stopPropagation() - or stopImmediatePropagation() method.

-

Other sources of information include:

- -

Note: Some of the constants in this class are used to define the type - property for events that are dispatched by ActionScript 3.0 display list, used in SWF content. However, some - constants in this class are used to define the type property for events that are not - related to the ActionScript 3.0 display list and are useful in JavaScript code running in the AIR runtime.

-

-

-View the examples. -

-

-See also -

-
-flash.events.EventDispatcher -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bubbles : Boolean -
[read-only] - Indicates whether an event is a bubbling event.
-		Event
  cancelable : Boolean -
[read-only] - Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentTarget : Object -
[read-only] - The object that is actively processing the Event object with an event listener.
-		Event
  eventPhase : uint -
[read-only] - The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  target : Object -
[read-only] - The event target.
-		Event
  type : String -
[read-only] - The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Event(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
-
- Creates an Event object to pass as a parameter to event listeners.
-		Event
   -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		Event
   -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
   -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
  ADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
  ADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  BROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
  CANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
  CHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
  CHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
  CHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
  CLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
  CLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
  CLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
  COMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
  CONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
  CONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
  COPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
  CUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
  DEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
  DISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
  ENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
  EXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
  EXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
  FRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
  FRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
  FULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
  HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
  HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
  HTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
  ID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
  INIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
  LOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
  MOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
  NETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
  OPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
  PASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
  PREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
  REMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
  REMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
  RENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
  RESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
  SCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
  SELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
  SELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
  SOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
  STANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
  STANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
  STANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
  SUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
  TAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
  TAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
  TAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
  TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
  TEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
  UNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
  USER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
  USER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
  VIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
  WORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
bubblesproperty
-
-bubbles:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates whether an event is a bubbling event. If the event can bubble, - this value is true; otherwise it is false. - -

Event bubbling is defined for display objects in SWF content, - which uses the ActionScript 3.0 display object model. The bubbles property - is only relavent in ActionScript 3.0 code.

- -

When an event occurs, it moves through the three phases of the event flow: the capture - phase, which flows from the top of the display list hierarchy to the node just before the - target node; the target phase, which comprises the target node; and the bubbling phase, - which flows from the node subsequent to the target node back up the display list hierarchy.

- -

Some events, such as the activate and unload events, do not - have a bubbling phase. The bubbles property has a value of - false for events that do not have a bubbling phase.

-

Implementation -
-    public function get bubbles():Boolean -
-
- - - - - -
cancelableproperty 
-
-cancelable:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether the behavior associated with the event can be prevented. - If the behavior can be canceled, this value is true; otherwise it is false. -

Implementation -
-    public function get cancelable():Boolean -
-

-See also -

-
-Event.preventDefault() -
-
- - - - - -
currentTargetproperty 
-
-currentTarget:Object  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The object that is actively processing the Event object with an event listener. For example, if a user clicks an OK button, the current target could be the node containing that button or one of its ancestors that has registered an event listener for that event. - -

Implementation -
-    public function get currentTarget():Object -
-
- - - - - -
eventPhaseproperty 
-
-eventPhase:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The current phase in the event flow. This property can contain the following numeric values: -

    -
  • The capture phase (EventPhase.CAPTURING_PHASE).
    • -
  • The target phase (EventPhase.AT_TARGET).
    • -
  • The bubbling phase (EventPhase.BUBBLING_PHASE).
-

The event flow is defined for display objects in SWF content, which use - the ActionScript 3.0 display object model. The eventPhase property - is only relavent in ActionScript 3.0 code.

-

Implementation -
-    public function get eventPhase():uint -
-
- - - - - -
targetproperty 
-
-target:Object  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button. -

Implementation -
-    public function get target():Object -
-
- - - - - -
typeproperty 
-
-type:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The type of event. The type is case-sensitive. -

Implementation -
-    public function get type():String -
-
- -
Constructor detail
- - - - - -
Event()constructor
-
-public function Event(type:String, bubbles:Boolean = false, cancelable:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates an Event object to pass as a parameter to event listeners. -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of the event, accessible as Event.type. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. The default value is false. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. The default values is false. -
-
- -
Method detail
- - - - - -
clone()method
-
-public function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Duplicates an instance of an Event subclass. -

Returns a new Event object that is a copy of the original instance of the Event object. - You do not normally call clone(); the EventDispatcher class calls it automatically - when you redispatch an event—that is, when you call dispatchEvent(event) from a handler - that is handling event.

- -

The new Event object includes all the properties of the original.

-

When creating your own custom Event class, you must override the - inherited Event.clone() method in order for it to duplicate the - properties of your custom class. If you do not set all the properties that you add - in your event subclass, those properties will not have the correct values when listeners - handle the redispatched event.

- -

In this example, PingEvent is a subclass of Event - and therefore implements its own version of clone().

- - 
-	 class PingEvent extends Event {
-		 var URL:String;
-		 
-	 public override function clone():Event {
-	 	     return new PingEvent(type, bubbles, cancelable, URL);
-	    }
-	 }
-
- -

-Returns - - - - -
Event — - A new Event object that is identical to the original. - - -
-
- - - - - -
formatToString()method 
-
-public function formatToString(className:String, ... arguments):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes. Overriding the - toString() method is recommended, but not required. - - 

-	 class PingEvent extends Event {
-	  var URL:String;
-	 
-	 public override function toString():String { 
-	  return formatToString("PingEvent", "type", "bubbles", "cancelable", "eventPhase", "URL"); 
-	    }
-	 }
-
- -

This method is used in creating ActionScript 3.0 classes - to be used in SWF content.

- -

Parameters - - - - - - - - - - -
className:String — The name of your custom Event class. In the previous example, - the className parameter is PingEvent. - -
 
... arguments — The properties of the Event class and the - properties that you add in your custom Event class. In the previous example, the ...arguments - parameter includes type, bubbles, cancelable, - eventPhase, and URL. - -
-

-Returns - - - - -
String — - The name of your custom Event class and the String value of your ...arguments - parameter. - - - -
-
- - - - - -
isDefaultPrevented()method 
-
-public function isDefaultPrevented():Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Checks whether the preventDefault() method has been called on the event. If the - preventDefault() method has been called, - returns true; otherwise, returns false. -

-Returns - - - - -
Boolean — - If preventDefault() has been called, returns true; otherwise, - returns false. - - - -
-

-See also -

-
-flash.events.Event.preventDefault() -
-
- - - - - -
preventDefault()method 
-
-public function preventDefault():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Cancels an event's default behavior if that behavior can be canceled. - -

Many events have associated behaviors that are carried out by default. - For example, if a user types a character - into a text field, the default behavior is that the character is - displayed in the text field. Because the TextEvent.TEXT_INPUT - event's default behavior can be canceled, you can use the preventDefault() - method to prevent the character from appearing. - For example, if a user clicks the close box of a window, - the default behavior is that the window closes. Because the closing - event's default behavior can be canceled, you can use the preventDefault() - method to prevent the window from closing. -

- -

An example of a behavior that is not cancelable is the default behavior associated with - the Event.REMOVED event, which is generated whenever Flash Player is about to - remove a display object from the display list. The default behavior (removing the element) - cannot be canceled, so the preventDefault() method has no effect on this - default behavior.

- -

You can use the Event.cancelable property to check whether you can prevent - the default behavior associated with a particular event. If the value of - Event.cancelable is true, then preventDefault() can - be used to cancel the event; otherwise, preventDefault() has no effect.

-

-See also -

-
-flash.events.Event.isDefaultPrevented() -
-Event.cancelable -
-
- - - - - -
stopImmediatePropagation()method 
-
-public function stopImmediatePropagation():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow. This method takes effect immediately, and it affects event listeners - in the current node. In contrast, the stopPropagation() method doesn't take - effect until all the event listeners in the current node finish processing. - -

Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

-

The event flow is defined for display objects in SWF content, which use - the ActionScript 3.0 display object model.

-

-See also -

-
-flash.events.Event.stopPropagation() -
-flash.events.Event.preventDefault() -
-
- - - - - -
stopPropagation()method 
-
-public function stopPropagation():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow. This method does not affect any event listeners in the current node - (currentTarget). In contrast, the stopImmediatePropagation() method - prevents processing of event listeners in both the current node and subsequent nodes. - Additional calls to this method have no effect. This method can be called in any phase - of the event flow. - -

Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

-

The event flow is defined for display objects in SWF content, which use - the ActionScript 3.0 display object model.

-

-See also -

-
-flash.events.Event.stopImmediatePropagation() -
-flash.events.Event.preventDefault() -
-
- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string containing all the properties of the Event object. The string is in the following format: -

[Event type=value bubbles=value cancelable=value]

-

-Returns - - - - -
String — - A string containing all the properties of the Event object. - - - -
-
- -
Constant detail
- - - - - -
ACTIVATEconstant
-
-public static const ACTIVATE:String = "activate" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The ACTIVATE constant defines the value of the type property of an activate event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the activate event.
- -

-See also -

-
-flash.events.EventDispatcher.activate -
-DEACTIVATE -
-
- - - - - -
ADDEDconstant 
-
-public static const ADDED:String = "added" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.ADDED constant defines the value of the type property of - an added event object. - -

The added event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe DisplayObject instance being added to the display list. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.DisplayObject.added -
-ADDED_TO_STAGE -
-REMOVED -
-REMOVED_FROM_STAGE -
-
- - - - - -
ADDED_TO_STAGEconstant 
-
-public static const ADDED_TO_STAGE:String = "addedToStage" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object. - -

The addedToStage event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe DisplayObject instance being added to the on stage display list, - either directly or through the addition of a sub tree in which the DisplayObject instance is contained. - If the DisplayObject instance is being directly added, the added event occurs before this event.
- -

-See also -

-
-flash.display.DisplayObject.addedToStage -
-ADDED -
-REMOVED -
-REMOVED_FROM_STAGE -
-
- - - - - -
BROWSER_ZOOM_CHANGEconstant 
-
-public static const BROWSER_ZOOM_CHANGE:String = "browserZoomChange" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 15 -
-

- The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object. - -

The browserZoomChange event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
target The Stage instance.
-

-See also -

-
-flash.display.Stage.browserZoomChange -
-
- - - - - -
CANCELconstant 
-
-public static const CANCEL:String = "cancel" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.CANCEL constant defines the value of the type property of a cancel event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetA reference to the object on which the operation is canceled.
-

-See also -

-
-flash.net.FileReference.cancel -
-
- - - - - -
CHANGEconstant 
-
-public static const CHANGE:String = "change" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.CHANGE constant defines the value of the type property of a change event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object that has had its value modified. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.text.TextField.change -
-flash.events.TextEvent.TEXT_INPUT -
-
- - - - - -
CHANNEL_MESSAGEconstant 
-
-public static const CHANNEL_MESSAGE:String = "channelMessage" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that dispatched this event.
-

-See also -

-
-flash.system.MessageChannel.channelMessage -
-
- - - - - -
CHANNEL_STATEconstant 
-
-public static const CHANNEL_STATE:String = "channelState" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that dispatched this event.
-

-See also -

-
-flash.system.Worker.channelState -
-
- - - - - -
CLEARconstant 
-
-public static const CLEAR:String = "clear" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The Event.CLEAR constant defines the value of the type property - of a clear event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny InteractiveObject instance with a listener registered for the clear event.
-

Note: TextField objects do not dispatch clear, copy, cut, paste, - or selectAll events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. - 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 clear, copy, cut, paste, - or selectAll events. However, other classes that extend the InteractiveObject class, including components built - using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.

- -

-See also -

-
-flash.display.InteractiveObject.clear -
-
- - - - - -
CLOSEconstant 
-
-public static const CLOSE:String = "close" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.CLOSE constant defines the value of the type property of a close event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection has been closed.
- -

-See also -

-
-flash.net.Socket.close -
-flash.net.XMLSocket.close -
-flash.display.NativeWindow.close -
-
- - - - - -
CLOSINGconstant 
-
-public static const CLOSING:String = "closing" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Event.CLOSING constant defines the value of the - type property of a closing event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelabletrue; canceling this event object stops the close operation.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection is to be closed.
- -

-See also -

-
-flash.display.NativeWindow.closing -
-
- - - - - -
COMPLETEconstant 
-
-public static const COMPLETE:String = "complete" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -

-See also -

-
-flash.display.LoaderInfo.complete -
-flash.html.HTMLLoader.complete -
-flash.media.Sound.complete -
-flash.net.FileReference.complete -
-flash.net.URLLoader.complete -
-flash.net.URLStream.complete -
-
- - - - - -
CONNECTconstant 
-
-public static const CONNECT:String = "connect" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.CONNECT constant defines the value of the type property of a connect event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Socket or XMLSocket object that has established a network connection.
- -

-See also -

-
-flash.net.Socket.connect -
-flash.net.XMLSocket.connect -
-
- - - - - -
CONTEXT3D_CREATEconstant 
-
-public static const CONTEXT3D_CREATE:String = "context3DCreate" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object. - - This event is raised only by Stage3D objects in response to either a call to Stage3D.requestContext3D or in response to an OS triggered reset of the - Context3D bound to the Stage3D object. Inspect the Stage3D.context3D property to get the newly created Context3D object. - -

-See also -

-
Stage3D
-
- - - - - -
COPYconstant 
-
-public static const COPY:String = "copy" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Defines the value of the type property of a copy event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny InteractiveObject instance with a listener registered for the copy event.
-

Note: TextField objects do not dispatch clear, copy, cut, paste, - or selectAll events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. - 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 clear, copy, cut, paste, - or selectAll events. However, other classes that extend the InteractiveObject class, including components built - using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.

- -

-See also -

-
-flash.display.InteractiveObject.copy -
-
- - - - - -
CUTconstant 
-
-public static const CUT:String = "cut" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Defines the value of the type property of a cut event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny InteractiveObject instance with a listener registered for the cut event.
-

Note: TextField objects do not dispatch clear, copy, cut, paste, - or selectAll events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. - 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 clear, copy, cut, paste, - or selectAll events. However, other classes that extend the InteractiveObject class, including components built - using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.

- -

-See also -

-
-flash.display.InteractiveObject.cut -
-
- - - - - -
DEACTIVATEconstant 
-
-public static const DEACTIVATE:String = "deactivate" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the deactivate event.
- -

-See also -

-
-flash.events.EventDispatcher.deactivate -
-ACTIVATE -
-
- - - - - -
DISPLAYINGconstant 
-
-public static const DISPLAYING:String = "displaying" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Event.DISPLAYING constant defines the value of the type property of a displaying event object. -

Note: This event does not go through a "capture phase" - and is dispatched directly to the target, whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object that is about to be displayed.
- -

-See also -

-
-flash.display.NativeMenu.displaying -
-flash.display.NativeMenuItem.displaying -
-
- - - - - -
ENTER_FRAMEconstant 
-
-public static const ENTER_FRAME:String = "enterFrame" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the enterFrame event.
- -

-See also -

-
-flash.display.DisplayObject.enterFrame -
-
- - - - - -
EXIT_FRAMEconstant 
-
-public static const EXIT_FRAME:String = "exitFrame" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the enterFrame event.
- -

-See also -

-
-flash.display.DisplayObject.exitFrame -
-
- - - - - -
EXITINGconstant 
-
-public static const EXITING:String = "exiting" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Event.EXITING constant defines the value of the type property of an exiting event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelabletrue; canceling this event object stops the exit operation.
currentTargetThe NativeApplication object.
targetThe NativeApplication object.
- -

-See also -

-
-flash.desktop.NativeApplication.exiting -
-
- - - - - -
FRAME_CONSTRUCTEDconstant 
-
-public static const FRAME_CONSTRUCTED:String = "frameConstructed" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. - -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the frameConstructed event.
- -

-See also -

-
-flash.display.DisplayObject.frameConstructed -
-
- - - - - -
FRAME_LABELconstant 
-
-public static const FRAME_LABEL:String = "frameLabel" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to FrameLabel objects.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe FrameLabel object that is actively processing the Event - object with an event listener.
targetAny FrameLabel instance with a listener registered for the frameLabel event.
- -

-See also -

-
-flash.display.FrameLabel.frameLabel -
-
- - - - - -
FULLSCREENconstant 
-
-public static const FULLSCREEN:String = "fullScreen" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Stage object.
- -

-See also -

-
-flash.display.Stage.fullScreen -
-
- - - - - -
HTML_BOUNDS_CHANGEconstant 
-
-public static const HTML_BOUNDS_CHANGE:String = "htmlBoundsChange" -

- - - - -
Runtime version: AIR 1.0 -
-

- The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe HTMLLoader object.
targetThe HTMLLoader object.
- -

-See also -

-
-htmlBoundsChange event -
-
- - - - - -
HTML_DOM_INITIALIZEconstant 
-
-public static const HTML_DOM_INITIALIZE:String = "htmlDOMInitialize" -

- - - - -
Runtime version: AIR 1.0 -
-

- The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe HTMLLoader object.
targetThe HTMLLoader object.
- -

-See also -

-
-htmlDOMInitialize event -
-
- - - - - -
HTML_RENDERconstant 
-
-public static const HTML_RENDER:String = "htmlRender" -

- - - - -
Runtime version: AIR 1.0 -
-

- The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe HTMLLoader object.
targetThe HTMLLoader object.
- -

-See also -

-
-htmlRender event -
-
- - - - - -
ID3constant 
-
-public static const ID3:String = "id3" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Event.ID3 constant defines the value of the type property of an id3 event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Sound object loading the MP3 for which ID3 data is now available. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.media.Sound.id3 -
-
- - - - - -
INITconstant 
-
-public static const INIT:String = "init" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.INIT constant defines the value of the type property of an init event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe LoaderInfo object associated with the SWF file being loaded.
- -

-See also -

-
-flash.display.LoaderInfo.init -
-
- - - - - -
LOCATION_CHANGEconstant 
-
-public static const LOCATION_CHANGE:String = "locationChange" -

- - - - -
Runtime version: AIR 1.0 -
-

- The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe HTMLLoader object.
targetThe HTMLLoader object.
- -

-See also -

-
-locationChange event -
-
- - - - - -
MOUSE_LEAVEconstant 
-
-public static const MOUSE_LEAVE:String = "mouseLeave" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Stage object. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.Stage.mouseLeave -
-flash.events.MouseEvent -
-
- - - - - -
NETWORK_CHANGEconstant 
-
-public static const NETWORK_CHANGE:String = "networkChange" -

- - - - -
Runtime version: AIR 1.0 -
-

- The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe NativeApplication object.
- -

-See also -

-
-flash.desktop.NativeApplication.networkChange -
-
- - - - - -
OPENconstant 
-
-public static const OPEN:String = "open" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.OPEN constant defines the value of the type property of an open event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has opened a connection.
- -

-See also -

-
-flash.display.LoaderInfo.open -
-flash.media.Sound.open -
-flash.net.FileReference.open -
-flash.net.URLLoader.open -
-flash.net.URLStream.open -
-
- - - - - -
PASTEconstant 
-
-public static const PASTE:String = "paste" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The Event.PASTE constant defines the value of the type property of a paste event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue (false for AIR runtime.)
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny InteractiveObject instance with a listener registered for the paste event.
-

Note: TextField objects do not dispatch clear, copy, cut, paste, - or selectAll events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. - 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 clear, copy, cut, paste, - or selectAll events. However, other classes that extend the InteractiveObject class, including components built - using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.

- -

-See also -

-
-flash.display.InteractiveObject.paste -
-
- - - - - -
PREPARINGconstant 
-
-public static const PREPARING:String = "preparing" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- The Event.PREPARING constant defines the value of the type property of a preparing event object. -

Note: This event does not go through a "capture phase" - and is dispatched directly to the target, whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that dispatched this event.
targetThe object that dispatched this event.
- -

-See also -

-
-flash.display.NativeMenu.preparing -
-flash.display.NativeMenuItem.preparing -
-
- - - - - -
REMOVEDconstant 
-
-public static const REMOVED:String = "removed" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.REMOVED constant defines the value of the type property of - a removed event object. - -

The removed event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe DisplayObject instance to be removed from the display list. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.DisplayObject.removed -
-ADDED -
-ADDED_TO_STAGE -
-REMOVED_FROM_STAGE -
-
- - - - - -
REMOVED_FROM_STAGEconstant 
-
-public static const REMOVED_FROM_STAGE:String = "removedFromStage" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object. - -

The removedFromStage event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe DisplayObject instance being removed from the on stage display list, - either directly or through the removal of a sub tree in which the DisplayObject instance is contained. - If the DisplayObject instance is being directly removed, the removed event occurs before this event.
- -

-See also -

-
-flash.display.DisplayObject.removedFromStage -
-ADDED -
-REMOVED -
-ADDED_TO_STAGE -
-
- - - - - -
RENDERconstant 
-
-public static const RENDER:String = "render" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.RENDER constant defines the value of the type property of a render event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; the default behavior cannot be canceled.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the render event.
- -

-See also -

-
-flash.display.DisplayObject.render -
-flash.display.Stage.invalidate() -
-
- - - - - -
RESIZEconstant 
-
-public static const RESIZE:String = "resize" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Event.RESIZE constant defines the value of the type property of a resize event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Stage object.
- -

-See also -

-
-flash.display.Stage.resize -
-
- - - - - -
SCROLLconstant 
-
-public static const SCROLL:String = "scroll" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Event.SCROLL constant defines the value of the type property of a scroll event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe TextField object that has been scrolled. - The target property is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.text.TextField.scroll -
-flash.html.HTMLLoader.scroll -
-
- - - - - -
SELECTconstant 
-
-public static const SELECT:String = "select" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Event.SELECT constant defines the value of the type property of a select event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object on which an item has been selected.
- -

-See also -

-
-flash.net.FileReference.select -
-flash.display.NativeMenu.select -
-flash.display.NativeMenuItem.select -
-
- - - - - -
SELECT_ALLconstant 
-
-public static const SELECT_ALL:String = "selectAll" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny InteractiveObject instance with a listener registered for the selectAll event.
-

Note: TextField objects do not dispatch clear, copy, cut, paste, - or selectAll events. TextField objects always include Cut, Copy, Paste, Clear, and Select All commands in the context menu. - 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 clear, copy, cut, paste, - or selectAll events. However, other classes that extend the InteractiveObject class, including components built - using the Flash Text Engine (FTE), will dispatch these events in response to user actions such as keyboard shortcuts and context menus.

- -

-See also -

-
-flash.display.InteractiveObject.selectAll -
-
- - - - - -
SOUND_COMPLETEconstant 
-
-public static const SOUND_COMPLETE:String = "soundComplete" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe SoundChannel object in which a sound has finished playing.
- -

-See also -

-
-flash.media.SoundChannel.soundComplete -
-
- - - - - -
STANDARD_ERROR_CLOSEconstant 
-
-public static const STANDARD_ERROR_CLOSE:String = "standardErrorClose" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. - -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe NativeProcess object.
- -
- - - - - -
STANDARD_INPUT_CLOSEconstant 
-
-public static const STANDARD_INPUT_CLOSE:String = "standardInputClose" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. - -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe NativeProcess object.
- -
- - - - - -
STANDARD_OUTPUT_CLOSEconstant 
-
-public static const STANDARD_OUTPUT_CLOSE:String = "standardOutputClose" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. - -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe NativeProcess object.
- -
- - - - - -
SUSPENDconstant 
-
-public static const SUSPEND:String = "suspend" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- The Event.SUSPEND constant defines the value of the type property of an suspend event object. - This event is dispatched only on AIR iOS. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe NativeApplication object.
targetThe NativeApplication object.
-

-See also -

-
-flash.desktop.NativeApplication.suspend -
-
- - - - - -
TAB_CHILDREN_CHANGEconstant 
-
-public static const TAB_CHILDREN_CHANGE:String = "tabChildrenChange" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose tabChildren flag has changed. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.InteractiveObject.tabChildrenChange -
-
- - - - - -
TAB_ENABLED_CHANGEconstant 
-
-public static const TAB_ENABLED_CHANGE:String = "tabEnabledChange" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object. - -

The tabEnabledChange event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe InteractiveObject whose tabEnabled flag has changed. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.InteractiveObject.tabEnabledChange -
-
- - - - - -
TAB_INDEX_CHANGEconstant 
-
-public static const TAB_INDEX_CHANGE:String = "tabIndexChange" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object. - -

The tabIndexChange event applies to the ActionScript 3.0 display list - and is not relevant to JavaScript code.

- -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose tabIndex has changed. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.InteractiveObject.tabIndexChange -
-
- - - - - -
TEXT_INTERACTION_MODE_CHANGEconstant 
-
-public static const TEXT_INTERACTION_MODE_CHANGE:String = "textInteractionModeChange" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe TextField object whose interaction mode property is changed. For example on Android, one can change the interaction mode to SELECTION via context menu. - The target property is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.text.TextField.textInteractionModeChange -
-
- - - - - -
TEXTURE_READYconstant 
-
-public static const TEXTURE_READY:String = "textureReady" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object. - - This event is dispatched by Texture, RectangleTexture and CubeTexture objects to signal the completion of an asynchronous upload. Request an - asynchronous upload by using the uploadCompressedTextureFromByteArray() method with a true - value for the async argument, or using a method such as uploadFromBitmapDataAsync or - uploadFromByteArrayAsync. - This event neither bubbles nor is cancelable. -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe texture object that dispatched this event.
-

-See also -

-
-flash.display3D.textures.Texture.uploadCompressedTextureFromByteArray() -
-flash.display3D.textures.CubeTexture.uploadCompressedTextureFromByteArray() -
-flash.display3D.textures.RectangleTexture.uploadFromBitmapDataAsync() -
-
- - - - - -
UNLOADconstant 
-
-public static const UNLOAD:String = "unload" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Event.UNLOAD constant defines the value of the type property of an unload event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe LoaderInfo object associated with the SWF file being unloaded or replaced.
- -

-See also -

-
-flash.display.LoaderInfo.unload -
-
- - - - - -
USER_IDLEconstant 
-
-public static const USER_IDLE:String = "userIdle" -

- - - - -
Runtime version: AIR 1.0 -
-

- The Event.USER_IDLE constant defines the value of the type property of a userIdle event object. - -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe NativeApplication object.
- -

-See also -

-
-flash.desktop.NativeApplication.userIdle -
-
- - - - - -
USER_PRESENTconstant 
-
-public static const USER_PRESENT:String = "userPresent" -

- - - - -
Runtime version: AIR 1.0 -
-

- The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. - -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe NativeApplication object.
- -

-See also -

-
-flash.desktop.NativeApplication.userPresent -
-
- - - - - -
VIDEO_FRAMEconstant 
-
-public static const VIDEO_FRAME:String = "videoFrame" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 -
-

- The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
targetThe Camera object that dispatched this event.
-

-See also -

-
-flash.media.Camera -
-
- - - - - -
WORKER_STATEconstant 
-
-public static const WORKER_STATE:String = "workerState" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- The Event.WORKER_STATE constant defines the value of the type property of a workerState event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that dispatched this event.
-

-See also -

-
-flash.system.Worker.workerState -
-
- -
Examples
-
examples\EventExample
-
The following example uses the EventExample class and the - Square custom class to demonstrate how to manage event bubbling. -
-
-package {
-    import flash.display.Sprite;
-	import flash.events.Event;
-	import flash.events.MouseEvent;
-
-	public class EventExample extends Sprite {
-    	
-		public function EventExample() {
-			var square_0:Square = new Square(300, 0x336633);
-			addChild(square_0);
-			
-			var square_1:Square = new Square(250, 0x669966);
-			square_0.addChild(square_1);
-
-			var square_2:Square = new Square(200, 0x66CC66);
-			square_1.addChild(square_2);
-
-			var square_3:Square = new Square(150, 0xAA0000);
-			square_3.shouldBubble = false;
-			square_2.addChild(square_3);
-
-			var square_4:Square = new Square(100, 0x66FF66);
-			square_3.addChild(square_4);
-
-			var square_5:Square = new Square(50, 0xCC0000);
-			square_5.shouldBubble = false;
-			square_4.addChild(square_5);
-
-			this.addEventListener(MouseEvent.CLICK, clickHandler);
-		}
-		
-		private function clickHandler(e:Event):void {
-			trace(">> stage: " + e.type + " event from " + e.target.name + " called on " + this.name);
-			trace(">> --------------------------------------------");
-		}
-	}
-}
-
-import flash.display.Sprite;
-import flash.events.Event;
-import flash.events.MouseEvent;
-
-class Square extends Sprite {
-	private var sideLen:int;
-	private var color:Number;
-	public var shouldBubble:Boolean = true;
-
-	public function Square(sideLen:int, color:Number) {
-		this.sideLen = sideLen;
-		this.color = color;
-		init();
-		draw();
-	}
-		
-	private function init():void {
-		buttonMode = true;
-		this.addEventListener(MouseEvent.CLICK, firstClickHandler);
-		this.addEventListener(MouseEvent.CLICK, secondClickHandler);
-		this.addEventListener(MouseEvent.CLICK, thirdClickHandler);
-	}
-		
-	private function draw():void {
-		this.graphics.beginFill(color);
-		this.graphics.drawRect(0, 0, sideLen, sideLen);
-	}
-		
-	private function firstClickHandler(e:Event):void {
-		trace(">> 1e: " + e.type + " event from " + e.target.name + " called on " + this.name);
-		if(!shouldBubble) {
-			e.stopPropagation();
-		}
-	}
-
-	private function secondClickHandler(e:Event):void {
-		trace(">> 2e: " + e.type + " event from " + e.target.name + " called on " + this.name);
-		if(!shouldBubble) {
-			e.stopImmediatePropagation();
-			trace(">> --------------------------------------------");
-		}
-	}
-
-	private function thirdClickHandler(e:Event):void {
-		trace(">> 3e: " + e.type + " event from " + e.target.name + " called on " + this.name);
-	}
-}
-
-
-
examples\EventExample2
-
The following example creates an interactive demonstration of - the difference between ADDED and ADDED_TO_STAGE events, - as well as the difference between REMOVED and REMOVED_FROM_STAGE - events. Clicking a sprite will remove it from the stage as well as everything nested within it. - For example, clicking the largest sprite will cause a REMOVED event - as well as three REMOVED_FROM_STAGE events to fire. -
-
- package {
-    import flash.display.Sprite;
-	import flash.events.*;
-
-	public class EventExample2 extends Sprite {
-		public function EventExample2():void {
-			var parentSprite:Sprite = createSprite("parentSprite",200);
-			var childSprite:Sprite = createSprite("childSprite",100);
-			var childOfChildSprite:Sprite = createSprite("childOfChildSprite",50);
-			
-			trace(":: Adding to Stage ::");
-			this.addChild(parentSprite);
-			trace(":: Adding to Stage ::");
-			parentSprite.addChild(childSprite);
-			trace(":: Adding to Stage ::");
-			childSprite.addChild(childOfChildSprite);
-		}
-		private function createSprite(name:String,size:uint):Sprite {
-			trace(":: Creating Sprite ::");
-			var newSprite:Sprite = new Sprite();
-			newSprite.name = name;
-			newSprite.graphics.beginFill(0xFFFFFF * Math.random(),1);
-			newSprite.graphics.drawRect(0,0,size,size);
-			newSprite.graphics.endFill();
-			newSprite.addEventListener(Event.ADDED, spriteAdded);
-			newSprite.addEventListener(Event.ADDED_TO_STAGE, spriteAddedToStage);
-			newSprite.addEventListener(Event.REMOVED, spriteRemoved);
-			newSprite.addEventListener(Event.REMOVED_FROM_STAGE, spriteRemovedFromStage);
-			newSprite.addEventListener(MouseEvent.CLICK, remove);
-			return newSprite;
-		}
-		private function remove(event:Event) {
-			if(event.target == event.currentTarget) {
-				trace(":: Removing Clicked Sprite ::");
-				var target:Sprite = Sprite(event.target);
-				target.parent.removeChild(target);
-			}
-		}
-		private function spriteRemovedFromStage(event:Event):void {
-			trace("REMOVED_FROM_STAGE: " + event.target.name + " : " + event.currentTarget.name);
-		}
-		private function spriteRemoved(event:Event):void {
-			trace("REMOVED: " + event.target.name + " from " + event.currentTarget.name);
-		}
-		private function spriteAddedToStage(event:Event):void {
-			trace("ADDED_TO_STAGE: " + event.target.name + " : " + event.currentTarget.name);
-		}
-		private function spriteAdded(event:Event):void {
-			trace("ADDED: " + event.target.name + " within " + event.currentTarget.name);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/events/EventDispatcher.html b/html-docs/flash/events/EventDispatcher.html deleted file mode 100644 index a6ab0f1..0000000 --- a/html-docs/flash/events/EventDispatcher.html +++ /dev/null @@ -1,892 +0,0 @@ - - - - - - - - -flash.events.EventDispatcher (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - -
Packageflash.events
Classpublic class EventDispatcher
InheritanceEventDispatcher Inheritance Object
ImplementsIEventDispatcher
SubclassesAccelerometer, ApplicationUpdater, ApplicationUpdaterUI, AudioDeviceManager, Camera, CameraRoll, CameraUI, Context3D, DatagramSocket, DeviceRotation, DisplayObject, DNSResolver, DRMManager, ExtensionContext, FileReference, FileReferenceList, FileStream, FrameLabel, GameInput, GameInputControl, Geolocation, HostObject, Icon, IME, License, LoaderInfo, LocalConnection, MediaPromise, MessageChannel, Microphone, NativeApplication, NativeMenu, NativeMenuItem, NativeProcess, NativeWindow, NetConnection, NetGroup, NetMonitor, NetStream, NetStreamPlayOptions, NetworkInfo, PermissionManager, PrintJob, RemoteNotifier, Screen, ServerSocket, ShaderJob, SharedObject, Socket, Sound, SoundChannel, SQLConnection, SQLStatement, Stage3D, StageText, StageVideo, StageWebView, StorageVolumeInfo, StyleSheet, SystemUpdater, TextureBase, Timer, UncaughtErrorEvents, URLLoader, URLStream, WebSocket, Worker, XMLSignatureValidator, XMLSocket, ZipArchive
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The EventDispatcher class is the base class for all runtime classes that dispatch events. -The EventDispatcher class implements the IEventDispatcher interface and is the base class for -the DisplayObject class. The EventDispatcher class allows any object on the display list to be -an event target and as such, to use the methods of the IEventDispatcher interface. - -

Event targets are an important part of the Flash® Player and -Adobe® AIR® event model. The event target serves -as the focal point for how events flow through the display list hierarchy. -When an event such as a mouse click or a keypress occurs, Flash Player or the AIR application dispatches an event -object into the event flow from the root of the display list. The event object then makes its -way through the display list until it reaches the event target, at which point it begins its -return trip through the display list. This round-trip journey to the event target is -conceptually divided into three phases: the capture phase comprises the journey from the -root to the last node before the event target's node, the target phase comprises only the -event target node, and the bubbling phase comprises any subsequent nodes encountered on -the return trip to the root of the display list.

- -

In general, the easiest way for a user-defined class to gain event dispatching -capabilities is to extend EventDispatcher. If this is impossible (that is, if the class is already extending -another class), you can instead implement the IEventDispatcher interface, create an EventDispatcher member, -and write simple hooks to route calls into the aggregated EventDispatcher.

- -

You can register functions to handle runtime events by calling the -addEventListener() method of the object dispatching the event.

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-EventDispatcher(target:IEventDispatcher = null)
-
- Aggregates an instance of the EventDispatcher class.
-		EventDispatcher
   -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
   -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
- - - - - - - - - - -
 EventSummaryDefined by
   -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Constructor detail
- - - - - -
EventDispatcher()constructor
-
-public function EventDispatcher(target:IEventDispatcher = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Aggregates an instance of the EventDispatcher class. - -

The EventDispatcher class is generally used as a base class in ActionScript 3.0 - code used in SWF content, which means that most - JavaScript developers do not need to use - this constructor function. However, advanced developers who are implementing - the IEventDispatcher interface need to use this constructor. - If you are unable to extend the EventDispatcher class and must - instead implement the IEventDispatcher interface, use this constructor to aggregate an instance of the EventDispatcher class.

- - Parameters - - - - -
target:IEventDispatcher (default = null) — The target object for events dispatched to the EventDispatcher object. - This parameter is used when the EventDispatcher instance is aggregated by a class that implements IEventDispatcher; it is necessary so that the containing object can be the target for events. - Do not use this parameter in simple cases in which a class extends EventDispatcher. - Target objects are only relavent in display objects in SWF content, which - use the ActionScript 3.0 display list architecture. - -
-
- -
Method detail
- - - - - -
addEventListener()method
-
-public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event. You can register event listeners on all nodes in the - display list for a specific type of event, phase, and priority. - -

JavaScript code in the AIR runtime uses this method to register - event listeners for events defined by the AIR APIs. For other JavaScript events (such as the onload - event of the DOM body object), you can use standard event handling techniques, as you would - for content running in the browser.

- -

After you successfully register an event listener, you cannot change its priority - through additional calls to addEventListener(). To change a listener's - priority, you must first call removeListener(). Then you can register the - listener again with the new priority level.

- -

Keep in mind that after the listener is registered, subsequent calls to - addEventListener() with a different type or - useCapture value result in the creation of a separate listener registration. - For example, if you first register a listener with useCapture set to - true, it listens only during the capture phase. If you call - addEventListener() again using the same listener object, but with - useCapture set to false, you have two separate listeners: one - that listens during the capture phase and another that listens during the target and - bubbling phases. -

- -

You cannot register an event listener for only the target phase or the bubbling - phase. Those phases are coupled during registration because bubbling - applies only to the ancestors of the target node.

- -

If you no longer need an event listener, remove it by calling - removeEventListener(), or memory problems could result. Event listeners are not automatically - removed from memory because the garbage - collector does not remove the listener as long as the dispatching object exists (unless the useWeakReference - parameter is set to true).

- -

Copying an EventDispatcher instance does not copy the event listeners attached to it. - (If your newly created node needs an event listener, you must attach the listener after - creating the node.) However, if you move an EventDispatcher instance, the event listeners - attached to it move along with it.

- - -

If the event listener is being registered on a node while an event is being processed - on this node, the event listener is not triggered during the current phase but can be - triggered during a later phase in the event flow, such as the bubbling phase.

- -

If an event listener is removed from a node while an event is being processed on the node, - it is still triggered by the current actions. After it is removed, the event listener is - never invoked again (unless registered again for future processing).

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener function that processes the event. This function must accept - an Event object as its only parameter and must return nothing, as this example shows: - . - - 
function(evt:Event):void
- -

The function can have any name.

- -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Determines whether the listener works in the capture phase or the - target and bubbling phases. If useCapture is set to true, - the listener processes the event only during the capture phase and not in the - target or bubbling phase. If useCapture is false, the - listener processes the event only during the target or bubbling phase. To listen for - the event in all three phases, call addEventListener twice, once with - useCapture set to true, then again with - useCapture set to false. - -
 
priority:int (default = 0) — The priority level of the event listener. The priority is designated by - a signed 32-bit integer. The higher the number, the higher the priority. All listeners - with priority n are processed before listeners of priority n-1. If two - or more listeners share the same priority, they are processed in the order in which they - were added. The default priority is 0. - -
 
useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or - weak. A strong reference (the default) prevents your listener from being garbage-collected. - A weak reference does not.

Class-level member functions are not subject to garbage - collection, so you can set useWeakReference to true for - class-level member functions without subjecting them to garbage collection. If you set - useWeakReference to true for a listener that is a nested inner - function, the function will be garbage-collected and no longer persistent. If you create - references to the inner function (save it in another variable) then it is not - garbage-collected and stays persistent.

-
-
-Throws - - - - -
ArgumentError — The listener specified is not a function. -
-
- - - - - -
dispatchEvent()method 
-
-public function dispatchEvent(event:Event):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatches an event into the event flow. The event target is the EventDispatcher - object upon which the dispatchEvent() method is called. -

Parameters - - - - -
event:Event — The Event object that is dispatched into the event flow. - If the event is being redispatched, a clone of the event is created automatically. - After an event is dispatched, its target property cannot be changed, so you - must create a new copy of the event for redispatching to work. - -
-

-Returns - - - - -
Boolean — - A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called - on the event. - - -
-
-Throws - - - - -
Error — The event dispatch recursion limit has been reached. -
-
- - - - - -
hasEventListener()method 
-
-public function hasEventListener(type:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event. This allows you to determine where an EventDispatcher object has altered - handling of an event type in the event flow hierarchy. To determine whether a specific - event type actually triggers an event listener, use willTrigger(). - -

The difference between hasEventListener() and willTrigger() - is that hasEventListener() examines only the object to - which it belongs, whereas willTrigger() examines the entire - event flow for the event specified by the type parameter. - The event flow applies to the ActionScript 3.0 - display list, used in SWF content. -

- -

When hasEventListener() is called from a LoaderInfo object, only the - listeners that the caller can access are considered.

- - Parameters - - - - -
type:String — The type of event. -
-

-Returns - - - - -
Boolean — - A value of true if a listener of the specified type is registered; - false otherwise. - - -
-

-See also -

-
-willTrigger() -
-
- - - - - -
removeEventListener()method 
-
-public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect. - -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener object to remove. - -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Specifies whether the listener was registered for the capture phase or the - target and bubbling phases. If the listener was registered for both the capture phase and the - target and bubbling phases, two calls to removeEventListener() are required - to remove both, one call with useCapture() set to true, and another - call with useCapture() set to false. - -
-
- - - - - -
willTrigger()method 
-
-public function willTrigger(type:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type. This method returns true if an - event listener is triggered during any phase of the event flow when an event of the - specified type is dispatched to this EventDispatcher object or any of its descendants. - -

The difference between the hasEventListener() and the willTrigger() - methods is that hasEventListener() examines only the object to which it belongs, - whereas the willTrigger() method examines the entire event flow for the event specified by the - type parameter. The event flow applies to the ActionScript 3.0 - display list, used in SWF content.

- -

When willTrigger() is called from a LoaderInfo object, only the - listeners that the caller can access are considered.

- - Parameters - - - - -
type:String — The type of event. -
-

-Returns - - - - -
Boolean — - A value of true if a listener of the specified type will be triggered; false otherwise. - - -
-
-
Event detail
- - - - - -
activateevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.ACTIVATE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active. This event is a broadcast event, which means that it is dispatched - by all EventDispatcher objects with a listener registered for this event. For more - information about broadcast events, see the DisplayObject class. -

- The ACTIVATE constant defines the value of the type property of an activate event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the activate event.
- -

-See also -

-
-flash.display.DisplayObject -
-
- - - - - -
deactivateevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.DEACTIVATE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive. This event is a broadcast event, which means that it is dispatched - by all EventDispatcher objects with a listener registered for this event. For more - information about broadcast events, see the DisplayObject class. -

- The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. -

Note: This event has neither a "capture phase" nor a "bubble phase", - which means that event listeners must be added directly to any potential targets, - whether the target is on the display list or not.

-

AIR for TV devices never automatically dispatch this event. You can, however, dispatch it manually.

-

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetAny DisplayObject instance with a listener registered for the deactivate event.
- -

-See also -

-
-flash.display.DisplayObject -
-
- -
Examples
-
examples\EventDispatcherExample
-
The following example uses the classes EventDispatcherExample and - CustomDispatcher, a subclass of EventDispatcher, to show how a - custom event is created and dispatched. The example carries out the following tasks: -
    -
  1. The constructor of EventDispatcherExample creates a local variable - dispatcher and assigns it to a new CustomDispatcher instance.
    2. -
  2. Inside CustomDispatcher, a string is set so that the event has - the name action, and the doAction() method is declared. When called, this method creates the action - event and dispatches it using EventDispatcher.dispatchEvent().
    3. -
  3. The dispatcher property is then used to add the action - event listener and associated subscriber method actionHandler(), which simply - prints information about the event when it is dispatched.
    4. -
  4. The doAction() method is invoked, dispatching the action - event.
    5. -
-
-
-package {
-	import flash.display.Sprite;
-	import flash.events.Event;
-
-	public class EventDispatcherExample extends Sprite {
-
-		public function EventDispatcherExample() {
-			var dispatcher:CustomDispatcher = new CustomDispatcher();
-			dispatcher.addEventListener(CustomDispatcher.ACTION, actionHandler);
-			dispatcher.doAction();
-		}
-
-		private function actionHandler(event:Event):void {
-			trace("actionHandler: " + event);
-		}
-	}
-}
-
-import flash.events.EventDispatcher;
-import flash.events.Event;
-
-class CustomDispatcher extends EventDispatcher {
-	public static var ACTION:String = "action";
-
-	public function doAction():void {
-		dispatchEvent(new Event(CustomDispatcher.ACTION));
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/events/EventPhase.html b/html-docs/flash/events/EventPhase.html deleted file mode 100644 index 88468bb..0000000 --- a/html-docs/flash/events/EventPhase.html +++ /dev/null @@ -1,306 +0,0 @@ - - - - - - - - -flash.events.EventPhase (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic final class EventPhase
InheritanceEventPhase Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The EventPhase class provides values for the eventPhase property of the Event class. -

-

-See also -

-
-Event class -
-EventDispatcher class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  AT_TARGET : uint = 2
[static] - The target phase, which is the second phase of the event flow.
-		EventPhase
  BUBBLING_PHASE : uint = 3
[static] - The bubbling phase, which is the third phase of the event flow.
-		EventPhase
  CAPTURING_PHASE : uint = 1
[static] - The capturing phase, which is the first phase of the event flow.
-		EventPhase
-
- -
- -
Constant detail
- - - - - -
AT_TARGETconstant
-
-public static const AT_TARGET:uint = 2 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The target phase, which is the second phase of the event flow. -

- - - - - -
BUBBLING_PHASEconstant 
-
-public static const BUBBLING_PHASE:uint = 3 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The bubbling phase, which is the third phase of the event flow. -

- - - - - -
CAPTURING_PHASEconstant 
-
-public static const CAPTURING_PHASE:uint = 1 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The capturing phase, which is the first phase of the event flow. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/FileListEvent.html b/html-docs/flash/events/FileListEvent.html deleted file mode 100644 index acae487..0000000 --- a/html-docs/flash/events/FileListEvent.html +++ /dev/null @@ -1,778 +0,0 @@ - - - - - - - - -flash.events.FileListEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class FileListEvent
InheritanceFileListEvent Inheritance Event Inheritance Object
-

- - - - -
Runtime version: AIR 1.0 -
-

-

- A File object dispatches a FileListEvent object when a call to the getDirectoryListingAsync() method - of a File object successfully enumerates a set of files and directories or when a user selects files after a - call to the browseForOpenMultiple() method. - -

-

-See also -

-
-File.getDirectoryListingAsync() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  files : Array -
- An array of File objects representing the files and directories found or selected.
-		FileListEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-FileListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, files:Array = null)
-
- The constructor function for a FileListEvent object.
-		FileListEvent
 Inherited -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		Event
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
  DIRECTORY_LISTING : String = "directoryListing"
[static] - The FileListEvent.DIRECTORY_LISTING constant defines the value of the - type property of the event object for a directoryListing event.
-		FileListEvent
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
  SELECT_MULTIPLE : String = "selectMultiple"
[static] - The FileListEvent.SELECT_MULTIPLE constant defines the value of the - type property of the event object for a selectMultiple event.
-		FileListEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
filesproperty
-
-public var files:Array -

- - - - -
Runtime version: AIR 1.0 -
-

- An array of File objects representing the files and directories found or selected. - -

For the File.getDirectoryListingAsync() method, this is the list of files and - directories found at the root level of the directory represented by the File object that called - the method. For the File.browseForOpenMultiple() method, this is the list of files - selected by the user.

- -
- -
Constructor detail
- - - - - -
FileListEvent()constructor
-
-public function FileListEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, files:Array = null) -

- - - - -
Runtime version: AIR 1.0 -
-

- The constructor function for a FileListEvent object. - -

The runtime uses this class to create FileListEvent objects. You will not use this - constructor directly in your code.

- - Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. - -
 
bubbles:Boolean (default = false) — Determines whether the event object bubbles (false for a FileListEvent object). - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled (false for a FileListEvent object). - -
 
files:Array (default = null) — An array of File objects. - -
-
- -
Constant detail
- - - - - -
DIRECTORY_LISTINGconstant
-
-public static const DIRECTORY_LISTING:String = "directoryListing" -

- - - - -
Runtime version: AIR 1.0 -
-

- The FileListEvent.DIRECTORY_LISTING constant defines the value of the - type property of the event object for a directoryListing event. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
filesAn array of File objects representing the files and directories found.
targetThe FileListEvent object.
-
- - - - - -
SELECT_MULTIPLEconstant 
-
-public static const SELECT_MULTIPLE:String = "selectMultiple" -

- - - - -
Runtime version: AIR 1.0 -
-

- The FileListEvent.SELECT_MULTIPLE constant defines the value of the - type property of the event object for a selectMultiple event. - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
filesAn array of File objects representing the files selected.
targetThe FileListEvent object.
-

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/FocusEvent.html b/html-docs/flash/events/FocusEvent.html deleted file mode 100644 index efc1188..0000000 --- a/html-docs/flash/events/FocusEvent.html +++ /dev/null @@ -1,1339 +0,0 @@ - - - - - - - - -flash.events.FocusEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class FocusEvent
InheritanceFocusEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- An object dispatches a FocusEvent object when the user changes the focus from one object - in the display list to another. There are four types of focus events: -
    -
  • FocusEvent.FOCUS_IN
    • -
  • FocusEvent.FOCUS_OUT
    • -
  • FocusEvent.KEY_FOCUS_CHANGE
    • -
  • FocusEvent.MOUSE_FOCUS_CHANGE
    • -
-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  direction : String -
- Specifies direction of focus for a focusIn event.
-		FocusEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  isRelatedObjectInaccessible : Boolean -
- If true, the relatedObject property is set to null for - reasons related to security sandboxes.
-		FocusEvent
  keyCode : uint -
- The key code value of the key pressed to trigger a keyFocusChange event.
-		FocusEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  relatedObject : InteractiveObject -
- A reference to the complementary InteractiveObject instance that is affected by the - change in focus.
-		FocusEvent
  shiftKey : Boolean -
- Indicates whether the Shift key modifier is activated, in which case the value is - true.
-		FocusEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-FocusEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, relatedObject:InteractiveObject = null, shiftKey:Boolean = false, keyCode:uint = 0, direction:String = "none")
-
- Creates an Event object with specific information relevant to focus events.
-		FocusEvent
   -
-clone():Event -
-
- Creates a copy of the FocusEvent object and sets the value of each property to match that of the original.
-		FocusEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the FocusEvent object.
-		FocusEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
  FOCUS_IN : String = "focusIn"
[static] - Defines the value of the type property of a focusIn event object.
-		FocusEvent
  FOCUS_OUT : String = "focusOut"
[static] - Defines the value of the type property of a focusOut event object.
-		FocusEvent
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
  KEY_FOCUS_CHANGE : String = "keyFocusChange"
[static] - Defines the value of the type property of a keyFocusChange event object.
-		FocusEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
  MOUSE_FOCUS_CHANGE : String = "mouseFocusChange"
[static] - Defines the value of the type property of a mouseFocusChange event object.
-		FocusEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
directionproperty
-
-direction:String  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies direction of focus for a focusIn event. - -

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

-See also -

-
-flash.display.FocusDirection -
-flash.display.Stage.assignFocus() -
-
- - - - - -
isRelatedObjectInaccessibleproperty 
-
-isRelatedObjectInaccessible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- If true, the relatedObject property is set to null for - reasons related to security sandboxes. If the nominal value of relatedObject is a reference to a - DisplayObject in another sandbox, relatedObject is set to - null unless there is permission in both directions across this sandbox boundary. Permission is - established by calling Security.allowDomain() from a SWF file, or by providing - a policy file from the server of an image file, and setting the LoaderContext.checkPolicyFile - property when loading the image. -

Implementation -
-    public function get isRelatedObjectInaccessible():Boolean -
-    public function set isRelatedObjectInaccessible(value:Boolean):void -
-

-See also -

-
-FocusEvent.relatedObject -
-Security.allowDomain() -
-LoaderContext.checkPolicyFile -
-
- - - - - -
keyCodeproperty 
-
-keyCode:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The key code value of the key pressed to trigger a keyFocusChange event. -

Implementation -
-    public function get keyCode():uint -
-    public function set keyCode(value:uint):void -
-
- - - - - -
relatedObjectproperty 
-
-relatedObject:InteractiveObject  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A reference to the complementary InteractiveObject instance that is affected by the - change in focus. For example, when a focusOut event occurs, the - relatedObject represents the InteractiveObject instance that has gained focus. -

The value of this property can be null in two circumstances: if there no related object, - or there is a related object, but it is in a security sandbox to which you don't have access. - Use the isRelatedObjectInaccessible() property to determine which of these reasons applies.

- Implementation -
-    public function get relatedObject():InteractiveObject -
-    public function set relatedObject(value:InteractiveObject):void -
-

-See also -

-
-FocusEvent.isRelatedObjectInaccessible -
-
- - - - - -
shiftKeyproperty 
-
-shiftKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates whether the Shift key modifier is activated, in which case the value is - true. Otherwise, the value is false. This property is - used only if the FocusEvent is of type keyFocusChange. -

Implementation -
-    public function get shiftKey():Boolean -
-    public function set shiftKey(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
FocusEvent()constructor
-
-public function FocusEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, relatedObject:InteractiveObject = null, shiftKey:Boolean = false, keyCode:uint = 0, direction:String = "none") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates an Event object with specific information relevant to focus events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are: - FocusEvent.FOCUS_IN, FocusEvent.FOCUS_OUT, FocusEvent.KEY_FOCUS_CHANGE, and FocusEvent.MOUSE_FOCUS_CHANGE. -
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
 
relatedObject:InteractiveObject (default = null) — Indicates the complementary InteractiveObject instance that is affected by the change in focus. For example, when a focusIn event occurs, relatedObject represents the InteractiveObject that has lost focus. -
 
shiftKey:Boolean (default = false) — Indicates whether the Shift key modifier is activated. -
 
keyCode:uint (default = 0) — Indicates the code of the key pressed to trigger a keyFocusChange event. -
 
direction:String (default = "none") — Indicates from which direction the target interactive object is being activated. Set to - FocusDirection.NONE (the default value) for all events other than focusIn. -
-

-See also -

-
-FOCUS_IN -
-FOCUS_OUT -
-KEY_FOCUS_CHANGE -
-MOUSE_FOCUS_CHANGE -
-flash.display.FocusDirection -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a copy of the FocusEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new FocusEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the FocusEvent object. The string is in the following format: -

[FocusEvent type=value bubbles=value cancelable=value relatedObject=value shiftKey=value] keyCode=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the FocusEvent object. - - - -
-
- -
Constant detail
- - - - - -
FOCUS_INconstant
-
-public static const FOCUS_IN:String = "focusIn" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a focusIn event object. -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
keyCode0; applies only to keyFocusChange events.
relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
shiftKeyfalse; applies only to keyFocusChange events.
targetThe InteractiveObject instance that has just received focus. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event. -
directionThe direction from which focus was assigned. This property reports - the value of the direction parameter of the assignFocus() method of the stage. - If the focus changed through some other means, the value will always be FocusDirection.NONE. - Applies only to focusIn events. For all other focus events the value will be - FocusDirection.NONE.
- -

-See also -

-
-flash.display.InteractiveObject.focusIn -
-
- - - - - -
FOCUS_OUTconstant 
-
-public static const FOCUS_OUT:String = "focusOut" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a focusOut event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
keyCode0; applies only to keyFocusChange events.
relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
shiftKeyfalse; applies only to keyFocusChange events.
targetThe InteractiveObject instance that has just lost focus. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event. -
- -

-See also -

-
-flash.display.InteractiveObject.focusOut -
-
- - - - - -
KEY_FOCUS_CHANGEconstant 
-
-public static const KEY_FOCUS_CHANGE:String = "keyFocusChange" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a keyFocusChange event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblestrue
cancelabletrue; call the preventDefault() method - to cancel default behavior.
currentTargetThe object that is actively processing - the Event - object with an event listener.
keyCodeThe key code value of the key pressed to trigger a keyFocusChange event.
relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
shiftKeytrue if the Shift key modifier is activated; false otherwise.
targetThe InteractiveObject instance that currently has focus. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event. -
- -

-See also -

-
-flash.display.InteractiveObject.keyFocusChange -
-
- - - - - -
MOUSE_FOCUS_CHANGEconstant 
-
-public static const MOUSE_FOCUS_CHANGE:String = "mouseFocusChange" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a mouseFocusChange event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblestrue
cancelabletrue; call the preventDefault() method - to cancel default behavior.
currentTargetThe object that is actively processing the Event - object with an event listener.
keyCode0; applies only to keyFocusChange events.
relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
shiftKeyfalse; applies only to keyFocusChange events.
targetThe InteractiveObject instance that currently has focus. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event. -
- - -

-See also -

-
-flash.display.InteractiveObject.mouseFocusChange -
-
- -
Examples
-
examples\FocusEventExample
-
The following example uses the FocusEventExample and - CustomSprite classes to show how focus can be used in conjunction with items drawn on the Stage to capture events and print information. - This example carries out the following tasks: -
    -
  1. It declares the properties child (of type Sprite) and childCount (of type uint).
    2. -
  2. A for loop creates five light blue squares at (0,0). It begins by - assigning child to a new CustomSprite instance. Each time a CustomSprite - object is created, the following happens: -
      -
    • The size property of type uint is set to 50 pixels and bgColor is set - to light blue.
      • -
    • The buttonMode and useHandCursor properties of the - Sprite class are set to true within the constructor.
      • -
    • An event listener of type click is instantiated, along with the associated subscriber - clickHandler(). The subscriber method creates a local variable target of - type Sprite and assigns it whichever box was clicked. The Stage's focus is then assigned to - target.
      • -
    • The draw() method is called, which creates a 50 x 50 pixel square by - calling the beginFill(), drawRect(), and endFill() methods of - the Graphics class and the instance properties.
      • -
    3. -
  3. In the for loop, the configureListeners() method is called, which instantiates three event - listeners/subscribers: -
      -
    • focusIn/focusInHandler() is dispatched after the click event - for whichever display list object (box) is clicked.
      • -
    • focusOut/focusOutHandler() is dispatched when another box is clicked or - if the focus leaves the Stage (for example, by clicking outside Flash Player).
      • -
    • keyFocusChange/keyFocusChangeHandler() is dispatched if you use the Tab key - or the left-arrow or right-arrow keys to select a display list object. The keyFocusChangeHandler() - method traps the left-arrow and right-arrow keys, however, and calls the preventDefault() method - to disable them.
      • - -
    4. -
  4. In the for loop, each square is added to the display list and displayed (all in - the same area) by means of addChild().
    5. -
  5. The constructor then calls refreshLayout(), which distributes the orange - squares across the top (y = 0) of the display with 5 pixels separating each square.
    6. -
-
-
-package {
-	import flash.display.Sprite;
-	import flash.display.DisplayObject;
-	import flash.events.FocusEvent;
-	import flash.events.IEventDispatcher;
-
-	public class FocusEventExample extends Sprite {
-		private var gutter:uint = 5;
-		private var childCount:uint = 5;
-
-		public function FocusEventExample() {
-			var child:Sprite;
-			for(var i:uint; i < childCount; i++) {
-				child = new CustomSprite();
-				configureListeners(child);
-				addChild(child);
-			}
-			refreshLayout();
-		}
-
-		private function configureListeners(dispatcher:IEventDispatcher):void {
-			dispatcher.addEventListener(FocusEvent.FOCUS_IN, focusInHandler);
-			dispatcher.addEventListener(FocusEvent.FOCUS_OUT, focusOutHandler);
-			dispatcher.addEventListener(FocusEvent.KEY_FOCUS_CHANGE, keyFocusChangeHandler);
-			dispatcher.addEventListener(FocusEvent.MOUSE_FOCUS_CHANGE, mouseFocusChangeHandler);
-		}
-
-		private function refreshLayout():void {
-			var ln:uint = numChildren;
-			var child:DisplayObject = getChildAt(0);
-			var lastChild:DisplayObject = child;
-			for(var i:uint = 1; i < ln; i++) {
-				child = getChildAt(i);
-				child.x = lastChild.x + lastChild.width + gutter;
-				lastChild = child;
-			}
-		}
-
-		private function focusInHandler(event:FocusEvent):void {
-			var target:CustomSprite = CustomSprite(event.target);
-			trace("focusInHandler: " + target.name);
-		}
-
-		private function focusOutHandler(event:FocusEvent):void {
-			var target:CustomSprite = CustomSprite(event.target);
-			trace("focusOutHandler: " + target.name);
-		}
-
-		private function keyFocusChangeHandler(event:FocusEvent):void {
-        	if(event.keyCode == 39 || event.keyCode == 37){
-        		event.preventDefault()
-        	}
-            var target:CustomSprite = CustomSprite(event.target);
-            trace("keyFocusChangeHandler: " + target.name);
-        }
-        private function mouseFocusChangeHandler(event:FocusEvent):void {
-            var target:CustomSprite = CustomSprite(event.target);
-            trace("mouseFocusChangeHandler: " + target.name);
-        }
-	}
-}
-
-import flash.display.Sprite;
-import flash.events.MouseEvent;
-
-class CustomSprite extends Sprite {
-	private var size:uint = 50;
-	private var bgColor:uint = 0x00CCFF;
-
-	public function CustomSprite() {
-		buttonMode = true;
-		useHandCursor = true;
-		addEventListener(MouseEvent.CLICK, clickHandler);
-		draw(size, size);
-	}
-
-	private function draw(w:uint, h:uint):void {
-		graphics.beginFill(bgColor);
-		graphics.drawRect(0, 0, w, h);
-		graphics.endFill();
-	}
-
-	private function clickHandler(event:MouseEvent):void {
-		var target:Sprite = Sprite(event.target);
-		trace("clickHandler: " + target.name);
-		stage.focus = target;
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/FullScreenEvent.html b/html-docs/flash/events/FullScreenEvent.html deleted file mode 100644 index 206f62d..0000000 --- a/html-docs/flash/events/FullScreenEvent.html +++ /dev/null @@ -1,950 +0,0 @@ - - - - - - - - -flash.events.FullScreenEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class FullScreenEvent
InheritanceFullScreenEvent Inheritance ActivityEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

-The Stage object dispatches a FullScreenEvent object whenever the Stage enters or leaves full-screen display mode. -There are two types of fullScreen events: FullScreenEvent.FULL_SCREEN and FullScreenEvent.FULL_SCREEN_INTERACTIVE_ACCEPTED. -

Note that when handling a FullScreenEvent, you must not try to change the full screen state i.e. Stage.displayState cannot be modified.

-

-

-See also -

-
-flash.display.Stage.displayState -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedactivating : Boolean -
- Indicates whether the device is activating (true) or deactivating - (false).
-		ActivityEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  fullScreen : Boolean -
[read-only] - Indicates whether the Stage object is in full-screen mode (true) or not (false).
-		FullScreenEvent
  interactive : Boolean -
[read-only] - Indicates whether the Stage object is in full-screen interactive mode (true) or not (false).
-		FullScreenEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-FullScreenEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, fullScreen:Boolean = false, interactive:Boolean = false)
-
- Creates an event object that contains information about fullScreen events.
-		FullScreenEvent
   -
-clone():Event -
-
- Creates a copy of a FullScreenEvent object and sets the value of each property to match that of - the original.
-		FullScreenEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the FullScreenEvent object.
-		FullScreenEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedACTIVITY : String = "activity"
[static] - The ActivityEvent.ACTIVITY constant defines the value of the type property of an activity event object.
-		ActivityEvent
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
  FULL_SCREEN : String = "fullScreen"
[static] - The FullScreenEvent.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		FullScreenEvent
  FULL_SCREEN_INTERACTIVE_ACCEPTED : String = "fullScreenInteractiveAccepted"
[static] - The FULL_SCREEN_INTERACTIVE_ACCEPTED:String constant defines the value of the type property of a fullScreenInteractiveAccepted event object.
-		FullScreenEvent
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
fullScreenproperty
-
-fullScreen:Boolean  [read-only]

- - - - -
Language version: ActionScript ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Indicates whether the Stage object is in full-screen mode (true) or not (false). - -

Implementation -
-    public function get fullScreen():Boolean -
-
- - - - - -
interactiveproperty 
-
-interactive:Boolean  [read-only]

- - - - -
Language version: ActionScript ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Indicates whether the Stage object is in full-screen interactive mode (true) or not (false). - -

Implementation -
-    public function get interactive():Boolean -
-
- -
Constructor detail
- - - - - -
FullScreenEvent()constructor
-
-public function FullScreenEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, fullScreen:Boolean = false, interactive:Boolean = false) -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates an event object that contains information about fullScreen events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the - inherited type property. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling phase of the - event flow. Event listeners can access this information through the inherited - bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can - access this information through the inherited cancelable property. -
 
fullScreen:Boolean (default = false) — Indicates whether the device is activating (true) or - deactivating (false). Event listeners can access this information through the - activating property. -
 
interactive:Boolean (default = false)
-

-See also -

-
-FullScreenEvent.FULL_SCREEN -
-FullScreenEvent.FULL_SCREEN_INTERACTIVE_ACCEPTED -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of a FullScreenEvent object and sets the value of each property to match that of - the original. - -

-Returns - - - - -
Event — - A new FullScreenEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the FullScreenEvent object. The following - format is used: -

[FullScreenEvent type=value bubbles=value cancelable=value - activating=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the FullScreenEvent object. - - - -
-
- -
Constant detail
- - - - - -
FULL_SCREENconstant
-
-public static const FULL_SCREEN:String = "fullScreen" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- The FullScreenEvent.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
fullScreentrue if the display state is full screen or false if it is normal.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Stage object.
- -

-See also -

-
-flash.display.Stage.displayState -
-
- - - - - -
FULL_SCREEN_INTERACTIVE_ACCEPTEDconstant 
-
-public static const FULL_SCREEN_INTERACTIVE_ACCEPTED:String = "fullScreenInteractiveAccepted" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- The FULL_SCREEN_INTERACTIVE_ACCEPTED:String constant defines the value of the type property of a fullScreenInteractiveAccepted event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
fullScreentrue if the display state is full screen or false if it is normal.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Stage object.
- -

-See also -

-
-flash.display.Stage.displayState -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/GameInputEvent.html b/html-docs/flash/events/GameInputEvent.html deleted file mode 100644 index 5ddb674..0000000 --- a/html-docs/flash/events/GameInputEvent.html +++ /dev/null @@ -1,806 +0,0 @@ - - - - - - - - -flash.events.GameInputEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic final class GameInputEvent
InheritanceGameInputEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

-

- The GameInputEvent class represents an event that is - dispatched when a game input device has either been added or removed - from the application platform. A game input device also dispatches events - when it is turned on or off. -

-

-See also -

-
-flash.ui.GameInput -
-flash.ui.GameInputDevice -
-flash.ui.GameInputControl -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  device : GameInputDevice -
[read-only] - Returns a reference to the device that was added or removed.
-		GameInputEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GameInputEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, device:GameInputDevice = null)
-
-
-		GameInputEvent
 Inherited -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		Event
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
  DEVICE_ADDED : String = "deviceAdded"
[static] - Indicates that a compatible device has been connected or turned on.
-		GameInputEvent
  DEVICE_REMOVED : String = "deviceRemoved"
[static] - Indicates that one of the enumerated devices has been disconnected or - turned off.
-		GameInputEvent
  DEVICE_UNUSABLE : String = "deviceUnusable"
[static] - Dispatched when a game input device is connected but is not usable.
-		GameInputEvent
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
deviceproperty
-
-device:GameInputDevice  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Returns a reference to the device that was added or removed. When a - device is added, use this property to get a reference to the new - device, instead of enumerating all of the devices to find the new one. -

Implementation -
-    public function get device():GameInputDevice -
-
- -
Constructor detail
- - - - - -
GameInputEvent()constructor
-
-public function GameInputEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, device:GameInputDevice = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

-

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
device:GameInputDevice (default = null)
-
- -
Constant detail
- - - - - -
DEVICE_ADDEDconstant
-
-public static const DEVICE_ADDED:String = "deviceAdded" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Indicates that a compatible device has been connected or turned on. - If a device was connected before startup and is not immediately available, - a DEVICE_ADDED event will be dispatched when the device - becomes available for use. -

- - - - - -
DEVICE_REMOVEDconstant 
-
-public static const DEVICE_REMOVED:String = "deviceRemoved" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Indicates that one of the enumerated devices has been disconnected or - turned off. -

- - - - - -
DEVICE_UNUSABLEconstant 
-
-public static const DEVICE_UNUSABLE:String = "deviceUnusable" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- Dispatched when a game input device is connected but is not usable. - For example, this happens in a Windows sandboxed browser when another - DirectInput based application is already using the device. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/GeolocationEvent.html b/html-docs/flash/events/GeolocationEvent.html deleted file mode 100644 index 82f9ef6..0000000 --- a/html-docs/flash/events/GeolocationEvent.html +++ /dev/null @@ -1,1144 +0,0 @@ - - - - - - - - -flash.events.GeolocationEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class GeolocationEvent
InheritanceGeolocationEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

-A Geolocation object dispatches GeolocationEvent objects when it receives updates from the location sensor installed on the device. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  altitude : Number -
- The altitude in meters.
-		GeolocationEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  heading : Number -
- The direction of movement (with respect to true north) in integer degrees.
-		GeolocationEvent
  horizontalAccuracy : Number -
- The horizontal accuracy in meters.
-		GeolocationEvent
  latitude : Number -
- The latitude in degrees.
-		GeolocationEvent
  longitude : Number -
- The longitude in degrees.
-		GeolocationEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  speed : Number -
- The speed in meters/second.
-		GeolocationEvent
 Inheritedtarget : Object -
- The event target.
-		Event
  timestamp : Number -
- The number of milliseconds at the time of the event since the runtime was initialized.
-		GeolocationEvent
 Inheritedtype : String -
- The type of event.
-		Event
  verticalAccuracy : Number -
- The vertical accuracy in meters.
-		GeolocationEvent
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GeolocationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, latitude:Number = 0, longitude:Number = 0, altitude:Number = 0, hAccuracy:Number = 0, vAccuracy:Number = 0, speed:Number = 0, heading:Number = 0, timestamp:Number = 0)
-
- Creates a GeolocationEvent object that contains information about the - location of the device.
-		GeolocationEvent
   -
-clone():Event -
-
- Creates a copy of the GeolocationEvent object and sets the value of each property to match that of the original.
-		GeolocationEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the GeolocationEvent object.
-		GeolocationEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
  UPDATE : String = "update"
[static] - Defines the value of the type property of a GeolocationEvent event object.
-		GeolocationEvent
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
altitudeproperty
-
-altitude:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- The altitude in meters. -

If altitude is not supported by the device, then this property is set to NaN.

- Implementation -
-    public function get altitude():Number -
-    public function set altitude(value:Number):void -
-
- - - - - -
headingproperty 
-
-heading:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- The direction of movement (with respect to true north) in integer degrees. This is not the same as - "bearing", which returns the direction of movement with respect to another point. -

Note: On Android devices, heading is not supported. The value of the heading - property is always NaN (Not a Number).

- - Implementation -
-    public function get heading():Number -
-    public function set heading(value:Number):void -
-
- - - - - -
horizontalAccuracyproperty 
-
-horizontalAccuracy:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- The horizontal accuracy in meters. -

Implementation -
-    public function get horizontalAccuracy():Number -
-    public function set horizontalAccuracy(value:Number):void -
-
- - - - - -
latitudeproperty 
-
-latitude:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- The latitude in degrees. The latitude values have the following range: (-90 <= latitude <= 90). Negative latitude is - south and positive latitude is north. -

Implementation -
-    public function get latitude():Number -
-    public function set latitude(value:Number):void -
-
- - - - - -
longitudeproperty 
-
-longitude:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- The longitude in degrees. The longitude values have the following range: (-180 <= longitude < 180). Negative longitude is - west and positive longitude is east. -

Implementation -
-    public function get longitude():Number -
-    public function set longitude(value:Number):void -
-
- - - - - -
speedproperty 
-
-speed:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- The speed in meters/second. -

Implementation -
-    public function get speed():Number -
-    public function set speed(value:Number):void -
-
- - - - - -
timestampproperty 
-
-timestamp:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- The number of milliseconds at the time of the event since the runtime was initialized. - For example, if the device captures geolocation data 4 seconds after the application initializes, - then the timestamp property of the event is set to 4000. -

Implementation -
-    public function get timestamp():Number -
-    public function set timestamp(value:Number):void -
-
- - - - - -
verticalAccuracyproperty 
-
-verticalAccuracy:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- The vertical accuracy in meters. -

Implementation -
-    public function get verticalAccuracy():Number -
-    public function set verticalAccuracy(value:Number):void -
-
- -
Constructor detail
- - - - - -
GeolocationEvent()constructor
-
-public function GeolocationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, latitude:Number = 0, longitude:Number = 0, altitude:Number = 0, hAccuracy:Number = 0, vAccuracy:Number = 0, speed:Number = 0, heading:Number = 0, timestamp:Number = 0) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- Creates a GeolocationEvent object that contains information about the - location of the device. Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — Specifies the type of the event. Event listeners can access this information - through the inherited type property. There is only one type of update - event: GeolocationEvent.UPDATE. -
 
bubbles:Boolean (default = false) — Indicates whether the event is a bubbling event. Event listeners can access - this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the event object can be canceled. Event listeners can access - this information through the inherited cancelable property. -
 
latitude:Number (default = 0) — Returns the latitude in degrees. The values have the following range: (-90 <= Lat <= +90). -
 
longitude:Number (default = 0) — Returns the longitude in degrees. The values have the following range: (-180 <= Long < +180). -
 
altitude:Number (default = 0) — Returns the altitude in meters. -
 
hAccuracy:Number (default = 0) — Returns the horizontal accuracy in meters. -
 
vAccuracy:Number (default = 0) — Returns the vertical accuracy in meters. -
 
speed:Number (default = 0) — Returns the speed in meters/second. -
 
heading:Number (default = 0) — Returns the direction of movement (with respect to True North) in integer degrees. -
 
timestamp:Number (default = 0) — Specifies the timestamp of the geolocation update. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- Creates a copy of the GeolocationEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new GeolocationEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- Returns a string that contains all the properties of the GeolocationEvent object. - The string is in the following format: -

[GeolocationEvent type=value bubbles=value cancelable=value status=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the GeolocationEvent object. - - -
-
- -
Constant detail
- - - - - -
UPDATEconstant
-
-public static const UPDATE:String = "update" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a GeolocationEvent event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe Geolocation object receiving data.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/GestureEvent.html b/html-docs/flash/events/GestureEvent.html deleted file mode 100644 index 8c73491..0000000 --- a/html-docs/flash/events/GestureEvent.html +++ /dev/null @@ -1,1330 +0,0 @@ - - - - - - - - -flash.events.GestureEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.events
Classpublic class GestureEvent
InheritanceGestureEvent Inheritance Event Inheritance Object
SubclassesPressAndTapGestureEvent, TransformGestureEvent
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The GestureEvent class lets you handle multi-touch events on devices that detect complex user contact with - the device (such as pressing two fingers on a touch screen at the same time). - When a user interacts with a device such as a mobile phone or tablet with a touch screen, the user typically - touches and moves across the screen with his or her fingers or a pointing device. You can develop applications that respond to - this user interaction with the GestureEvent and TransformGestureEvent classes. Create event listeners using the event types defined here, or in - the related TouchEvent and TransformGestureEvent classes. And, use the properties and methods of these classes - to construct event handlers that respond to the user touching the device. -

Use the Multitouch class to determine the current environment's support for touch interaction, and to - manage the support of touch interaction if the current environment supports it.

-

Note: When objects are nested on the display list, touch events target the deepest possible - nested object that is visible in the display list. This object is called the target node. To have a target node's - ancestor (an object containing the target node in the display list) receive notification of a touch event, use - EventDispatcher.addEventListener() on the ancestor node with the type parameter set to the specific - touch event you want to detect.

-

-

-View the examples. -

-

-See also -

-
-flash.ui.Multitouch -
-flash.events.TouchEvent -
-flash.events.TransformGestureEvent -
-flash.events.PressAndTapGestureEvent -
-flash.events.MouseEvent -
-flash.events.EventDispatcher.addEventListener() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  altKey : Boolean -
- Indicates whether the Alt key is active (true) or inactive (false).
-		GestureEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
  commandKey : Boolean -
- Indicates whether the command key is activated (Mac only).
-		GestureEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  controlKey : Boolean -
- Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
-		GestureEvent
  ctrlKey : Boolean -
- On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
-		GestureEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  localX : Number -
- The horizontal coordinate at which the event occurred relative to the containing sprite.
-		GestureEvent
  localY : Number -
- The vertical coordinate at which the event occurred relative to the containing sprite.
-		GestureEvent
  phase : String -
- A value from the GesturePhase class indicating the progress of the touch gesture.
-		GestureEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  shiftKey : Boolean -
- Indicates whether the Shift key is active (true) or inactive - (false).
-		GestureEvent
  stageX : Number -
[read-only] - The horizontal coordinate at which the event occurred in global Stage coordinates.
-		GestureEvent
  stageY : Number -
[read-only] - The vertical coordinate at which the event occurred in global Stage coordinates.
-		GestureEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GestureEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, phase:String = null, localX:Number = 0, localY:Number = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false)
-
- Creates an Event object that contains information about multi-touch events - (such as pressing two fingers on a touch screen at the same time).
-		GestureEvent
   -
-clone():Event -
-
- Creates a copy of the GestureEvent object and sets the value of each property to match that of the original.
-		GestureEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the GestureEvent object.
-		GestureEvent
   -
-updateAfterEvent():void -
-
- Refreshes the Flash runtime display after processing the gesture event, in case the display list has been modified by the event handler.
-		GestureEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
  GESTURE_TWO_FINGER_TAP : String = "gestureTwoFingerTap"
[static] - Defines the value of the type property of a GESTURE_TWO_FINGER_TAP gesture event object.
-		GestureEvent
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
altKeyproperty
-
-altKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the Alt key is active (true) or inactive (false). - Supported for Windows and Linux operating systems only. -

Implementation -
-    public function get altKey():Boolean -
-    public function set altKey(value:Boolean):void -
-
- - - - - -
commandKeyproperty 
-
-commandKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the command key is activated (Mac only). - -

On a Mac OS, the value of the commandKey property - is the same value as the ctrlKey property. - This property is always false on Windows or Linux.

- Implementation -
-    public function get commandKey():Boolean -
-    public function set commandKey(value:Boolean):void -
-
- - - - - -
controlKeyproperty 
-
-controlKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux. -

Implementation -
-    public function get controlKey():Boolean -
-    public function set controlKey(value:Boolean):void -
-
- - - - - -
ctrlKeyproperty 
-
-ctrlKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false). - On Macintosh, indicates whether either the Control key or the Command key is activated. -

Implementation -
-    public function get ctrlKey():Boolean -
-    public function set ctrlKey(value:Boolean):void -
-
- - - - - -
localXproperty 
-
-localX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

- The horizontal coordinate at which the event occurred relative to the containing sprite. -

Implementation -
-    public function get localX():Number -
-    public function set localX(value:Number):void -
-
- - - - - -
localYproperty 
-
-localY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

- The vertical coordinate at which the event occurred relative to the containing sprite. -

Implementation -
-    public function get localY():Number -
-    public function set localY(value:Number):void -
-
- - - - - -
phaseproperty 
-
-phase:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- A value from the GesturePhase class indicating the progress of the touch gesture. For most gestures, - the value is begin, update, or end. For the swipe and two-finger tap gestures, - the phase value is always all once the event is dispatched. - Use this value to determine when an event handler responds to a complex user interaction, or responds in - different ways depending on the current phase of a multi-touch gesture (such as expanding, moving, and "dropping" as - a user touches and drags a visual object across a screen). -

Implementation -
-    public function get phase():String -
-    public function set phase(value:String):void -
-

-See also -

-
-flash.events.GesturePhase -
-
- - - - - -
shiftKeyproperty 
-
-shiftKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the Shift key is active (true) or inactive - (false). -

Implementation -
-    public function get shiftKey():Boolean -
-    public function set shiftKey(value:Boolean):void -
-
- - - - - -
stageXproperty 
-
-stageX:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The horizontal coordinate at which the event occurred in global Stage coordinates. - This property is calculated when the localX property is set. -

Implementation -
-    public function get stageX():Number -
-
- - - - - -
stageYproperty 
-
-stageY:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The vertical coordinate at which the event occurred in global Stage coordinates. - This property is calculated when the localY property is set. -

Implementation -
-    public function get stageY():Number -
-
- -
Constructor detail
- - - - - -
GestureEvent()constructor
-
-public function GestureEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, phase:String = null, localX:Number = 0, localY:Number = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates an Event object that contains information about multi-touch events - (such as pressing two fingers on a touch screen at the same time). - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. The supported value is: GestureEvent.GESTURE_TWO_FINGER_TAP. - -
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling phase of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
 
phase:String (default = null) — A value from the GesturePhase class indicating the progress of the touch gesture (begin, update, end, or all). -
 
localX:Number (default = 0) — The horizontal coordinate at which the event occurred relative to the containing sprite. -
 
localY:Number (default = 0) — The vertical coordinate at which the event occurred relative to the containing sprite. -
 
ctrlKey:Boolean (default = false) — On Windows or Linux, indicates whether the Ctrl key is activated. On Mac, indicates whether either the Ctrl key or the Command key is activated. -
 
altKey:Boolean (default = false) — Indicates whether the Alt key is activated (Windows or Linux only). -
 
shiftKey:Boolean (default = false) — Indicates whether the Shift key is activated. -
 
commandKey:Boolean (default = false) — (AIR only) Indicates whether the Command key is activated (Mac only). This parameter is for Adobe AIR only; do not set it for Flash Player content. -
 
controlKey:Boolean (default = false) — (AIR only) Indicates whether the Control or Ctrl key is activated. This parameter is for Adobe AIR only; do not set it for Flash Player content. -
-

-See also -

-
-flash.events.GesturePhase -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a copy of the GestureEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new GestureEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that contains all the properties of the GestureEvent object. The string is in the following format: -

[GestureEvent type=value bubbles=value cancelable=value ... ]

-

-Returns - - - - -
String — - A string that contains all the properties of the GestureEvent object. - - - -
-
- - - - - -
updateAfterEvent()method 
-
-public function updateAfterEvent():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Refreshes the Flash runtime display after processing the gesture event, in case the display list has been modified by the event handler. -

- -
Constant detail
- - - - - -
GESTURE_TWO_FINGER_TAPconstant
-
-public static const GESTURE_TWO_FINGER_TAP:String = "gestureTwoFingerTap" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a GESTURE_TWO_FINGER_TAP gesture event object. - -

The dispatched GestureEvent object has the following properties:

- - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKey(AIR only) true on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow. For two-finger tap events, - this value is always all corresponding to the value GesturePhase.ALL once the event is dispatched.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.InteractiveObject.gestureTwoFingerTap -
-flash.events.GesturePhase -
-
- -
Examples
-
examples\GestureTwoFingerTap
-
The following example shows event handling for the GESTURE_TWO_FINGER_TAP event. - While the user performs a two-finger tap gesture, mySprite rotates and myTextField populates with the phase all, - which is the only phase for two-finger tap events. Other gestures from the TransformGestureEvent class support begin, update, - and end phases. -
-
-Multitouch.inputMode = MultitouchInputMode.GESTURE;
-
-var mySprite = new Sprite();
-mySprite.addEventListener(GestureEvent.GESTURE_TWO_FINGER_TAP , onTwoFingerTap );
-mySprite.graphics.beginFill(0x336699);
-mySprite.graphics.drawRect(0, 0, 100, 80);
-var myTextField = new TextField();
-myTextField.y = 200;
-addChild(mySprite);
-addChild(myTextField);
-
-function onTwoFingerTap(evt:GestureEvent):void {
-
-    evt.target.rotation -= 45;
-	myTextField.text = evt.phase; //"all"
-
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/GesturePhase.html b/html-docs/flash/events/GesturePhase.html deleted file mode 100644 index 176cd9c..0000000 --- a/html-docs/flash/events/GesturePhase.html +++ /dev/null @@ -1,419 +0,0 @@ - - - - - - - - -flash.events.GesturePhase (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic final class GesturePhase
InheritanceGesturePhase Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The GesturePhase class is an enumeration class of constant values for use with the GestureEvent, PressAndTapGestureEvent, and TransformGestureEvent - classes. Use these values to track the beginning, progress, and end of a touch gesture (such as moving several fingers across - a touch enabled screen) so your application can respond to individual stages of user contact. Some gestures (swipe and two-finger tap gestures) - do not have multiple phases, and set the event object phase property to all. -

-

-View the examples. -

-

-See also -

-
-flash.events.GestureEvent -
-flash.events.TransformGestureEvent -
-flash.events.PressAndTapGestureEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  ALL : String = "all"
[static] - A single value that encompasses all phases of simple gestures like two-finger-tap or swipe.
-		GesturePhase
  BEGIN : String = "begin"
[static] - The beginning of a new gesture (such as touching a finger to a touch enabled screen).
-		GesturePhase
  END : String = "end"
[static] - The completion of a gesture (such as lifting a finger off a touch enabled screen).
-		GesturePhase
  UPDATE : String = "update"
[static] - The progress of a gesture (such as moving a finger across a touch enabled screen).
-		GesturePhase
-
- -
- -
Constant detail
- - - - - -
ALLconstant
-
-public static const ALL:String = "all" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A single value that encompasses all phases of simple gestures like two-finger-tap or swipe. - For gestures that set the event object phase property to all (swipe and two-finger tap gestures), - the phase value is always all once the event is dispatched. -

-See also -

-
-flash.events.GestureEvent -
-flash.events.TransformGestureEvent -
-flash.events.PressAndTapGestureEvent -
-
- - - - - -
BEGINconstant 
-
-public static const BEGIN:String = "begin" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The beginning of a new gesture (such as touching a finger to a touch enabled screen). -

-See also -

-
-flash.events.GestureEvent -
-flash.events.TransformGestureEvent -
-flash.events.PressAndTapGestureEvent -
-
- - - - - -
ENDconstant 
-
-public static const END:String = "end" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The completion of a gesture (such as lifting a finger off a touch enabled screen). -

-See also -

-
-flash.events.GestureEvent -
-flash.events.TransformGestureEvent -
-flash.events.PressAndTapGestureEvent -
-
- - - - - -
UPDATEconstant 
-
-public static const UPDATE:String = "update" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The progress of a gesture (such as moving a finger across a touch enabled screen). -

-See also -

-
-flash.events.GestureEvent -
-flash.events.TransformGestureEvent -
-flash.events.PressAndTapGestureEvent -
-
- -
Examples
-
examples\TransformGestureEventExample
-
The following example shows event handling for the GESTURE_ROTATE events. - While the user performs a rotation gesture on the touch-enabled device, mySprite rotates and myTextField populates with the current phase. -
-
-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";
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/HTMLUncaughtScriptExceptionEvent.html b/html-docs/flash/events/HTMLUncaughtScriptExceptionEvent.html deleted file mode 100644 index a72771a..0000000 --- a/html-docs/flash/events/HTMLUncaughtScriptExceptionEvent.html +++ /dev/null @@ -1,807 +0,0 @@ - - - - - - - - -flash.events.HTMLUncaughtScriptExceptionEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class HTMLUncaughtScriptExceptionEvent
InheritanceHTMLUncaughtScriptExceptionEvent Inheritance Event Inheritance Object
-

- - - - -
Runtime version: AIR 1.0 -
-

-

- An HTMLLoader object dispatches an HTMLUncaughtScriptExceptionEvent object whenever a JavaScript exception - is thrown and not handled with a catch statement. - -

-

-See also -

-
-HTMLLoader -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  exceptionValue : * -
- The result of evaluating the expression in the throw statement that resulted in the - uncaught exception.
-		HTMLUncaughtScriptExceptionEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  stackTrace : Array -
- An array of objects that represent the stack trace at the time the throw statement - that resulted in the uncaught exception was executed.
-		HTMLUncaughtScriptExceptionEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-HTMLUncaughtScriptExceptionEvent(exceptionValue:*)
-
- Creates an HTMLUncaughtScriptExceptionEvent object to pass as a parameter to event listeners.
-		HTMLUncaughtScriptExceptionEvent
   -
-clone():Event -
-
- - Creates a copy of the HTMLUncaughtScriptExceptionEvent object and sets - the value of each property to match that of the original.
-		HTMLUncaughtScriptExceptionEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
  UNCAUGHT_SCRIPT_EXCEPTION : * = uncaughtScriptException
[static] - The HTMLUncaughtScriptExceptionEvent.UNCAUGHT_SCRIPT_EXCEPTION constant - defines the value of the type property of an - uncaughtScriptException event object.
-		HTMLUncaughtScriptExceptionEvent
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
exceptionValueproperty
-
-public var exceptionValue:* -

- - - - -
Runtime version: AIR 1.0 -
-

- The result of evaluating the expression in the throw statement that resulted in the - uncaught exception. The exceptionValue property can be a primitive - value, a reference to a JavaScript object, or a reference to an ActionScript object. - -

- - - - - -
stackTraceproperty 
-
-stackTrace:Array  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- An array of objects that represent the stack trace at the time the throw statement - that resulted in the uncaught exception was executed. Each object in the array has - three properties: - -

    - -
  • sourceURL (a string): The URL of the script of the call stack frame.
    • - -
  • line (a number): The line number in the sourceURL - resource of the call stack frame.
    • - -
  • functionName (a string): The name of the function for the call stack frame.
    • - -
- -

Implementation -
-    public function get stackTrace():Array -
-    public function set stackTrace(value:Array):void -
-
- -
Constructor detail
- - - - - -
HTMLUncaughtScriptExceptionEvent()constructor
-
-public function HTMLUncaughtScriptExceptionEvent(exceptionValue:*) -

- - - - -
Runtime version: AIR 1.0 -
-

- Creates an HTMLUncaughtScriptExceptionEvent object to pass as a parameter to event listeners. - -

Parameters - - - - -
exceptionValue:* — When a JavaScript process throws an uncaught exception, the - exceptionValue is the result of evaluating the expression in the throw - statement that resulted in the uncaught exception. The exceptionValue - property can be a primitive value, a reference to a JavaScript object, or a reference to an - ActionScript object. - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Runtime version: AIR 1.0 -
-

- - Creates a copy of the HTMLUncaughtScriptExceptionEvent object and sets - the value of each property to match that of the original. - -

-Returns - - - - -
Event — - The copy of the HTMLUncaughtScriptExceptionEvent object. - - - -
-
- -
Constant detail
- - - - - -
UNCAUGHT_SCRIPT_EXCEPTIONconstant
-
-public static const UNCAUGHT_SCRIPT_EXCEPTION:* = uncaughtScriptException -

- - - - -
Runtime version: AIR 1.0 -
-

- The HTMLUncaughtScriptExceptionEvent.UNCAUGHT_SCRIPT_EXCEPTION constant - defines the value of the type property of an - uncaughtScriptException event object. - - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
exceptionValueThe result of evaluating the expression in the throw - statement that resulted in the uncaught exception.
stackTraceAn array of objects that represent the stack trace - at the time the throw statement that resulted in the uncaught exception was executed.
targetThe HTMLLoader object.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/HTTPStatusEvent.html b/html-docs/flash/events/HTTPStatusEvent.html deleted file mode 100644 index 0e41b8a..0000000 --- a/html-docs/flash/events/HTTPStatusEvent.html +++ /dev/null @@ -1,1091 +0,0 @@ - - - - - - - - -flash.events.HTTPStatusEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class HTTPStatusEvent
InheritanceHTTPStatusEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The application dispatches HTTPStatusEvent objects when a network request returns an HTTP -status code. - -

HTTPStatusEvent objects are always sent before error or completion events. An -HTTPStatusEvent object does not necessarily indicate an error condition; it simply reflects -the HTTP status code (if any) that is provided by the networking stack. Some Flash -Player environments may be unable to detect HTTP status codes; a status code of 0 is always -reported in these cases.

- -

In Flash Player, there is only one type of HTTPStatus event: -httpStatus. In the AIR runtime, a FileReference, URLLoader, or URLStream -can register to listen for an httpResponseStatus, which includes responseURL -and responseHeaders properties. These properties are undefined in a httpStatus -event.

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  redirected : Boolean -
- Indicates whether the request was redirected.
-		HTTPStatusEvent
  responseHeaders : Array -
- The response headers that the response returned, as an array of URLRequestHeader objects.
-		HTTPStatusEvent
  responseURL : String -
- The URL that the response was returned from.
-		HTTPStatusEvent
  status : int -
[read-only] - The HTTP status code returned by the server.
-		HTTPStatusEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-HTTPStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:int = 0, redirected:Boolean = false)
-
- Creates an Event object that contains specific information about HTTP status events.
-		HTTPStatusEvent
   -
-clone():Event -
-
- Creates a copy of the HTTPStatusEvent object and sets the value of each property to match that of the original.
-		HTTPStatusEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the HTTPStatusEvent object.
-		HTTPStatusEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
  HTTP_RESPONSE_STATUS : String = "httpResponseStatus"
[static] - Unlike the httpStatus event, the httpResponseStatus event is - delivered before any response data.
-		HTTPStatusEvent
  HTTP_STATUS : String = "httpStatus"
[static] - The HTTPStatusEvent.HTTP_STATUS constant defines the value of the - type property of a httpStatus event object.
-		HTTPStatusEvent
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
redirectedproperty
-
-redirected:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- Indicates whether the request was redirected. -

Implementation -
-    public function get redirected():Boolean -
-    public function set redirected(value:Boolean):void -
-

-See also -

-
-flash.net.URLRequest.useRedirectedURL() -
-
- - - - - -
responseHeadersproperty 
-
-responseHeaders:Array  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- The response headers that the response returned, as an array of URLRequestHeader objects. -

Implementation -
-    public function get responseHeaders():Array -
-    public function set responseHeaders(value:Array):void -
-

-See also -

-
-flash.net.URLRequestHeader -
-
- - - - - -
responseURLproperty 
-
-responseURL:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- The URL that the response was returned from. In the case of redirects, this will be different - from the request URL. -

Implementation -
-    public function get responseURL():String -
-    public function set responseURL(value:String):void -
-
- - - - - -
statusproperty 
-
-status:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The HTTP status code returned by the server. For example, a value of 404 indicates that the server - has not found a match for the requested URI. HTTP status codes can be found in sections 10.4 and 10.5 - of the HTTP specification at - http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html. -

If Flash Player or AIR cannot get a status code from the - server, or if it cannot communicate with the server, the default value of 0 is passed to your code. - A value of 0 can be generated in any player (for example, - if a malformed URL is requested), and a value of 0 is always generated by the Flash Player plug-in - when it is run in the following browsers, which do not pass HTTP status codes to the player: - Netscape, Mozilla, Safari, Opera, and Internet Explorer for the Macintosh.

- Implementation -
-    public function get status():int -
-
- -
Constructor detail
- - - - - -
HTTPStatusEvent()constructor
-
-public function HTTPStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:int = 0, redirected:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates an Event object that contains specific information about HTTP status events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of HTTPStatus event: HTTPStatusEvent.HTTP_STATUS. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
status:int (default = 0) — Numeric status. Event listeners can access this information through the status property. -
 
redirected:Boolean (default = false) — Whether the request was redirected. Event listeners can access this information through the redirected property. -
-

-See also -

-
-HTTP_STATUS -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a copy of the HTTPStatusEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new HTTPStatusEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the HTTPStatusEvent object. The string is in the following format: -

[HTTPStatusEvent type=value bubbles=value cancelable=value status=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the HTTPStatusEvent object. - - - -
-
- -
Constant detail
- - - - - -
HTTP_RESPONSE_STATUSconstant
-
-public static const HTTP_RESPONSE_STATUS:String = "httpResponseStatus" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Unlike the httpStatus event, the httpResponseStatus event is - delivered before any response data. Also, the httpResponseStatus event includes - values for the responseHeaders and responseURL properties (which are - undefined for an httpStatus event. Note that the httpResponseStatus event - (if any) will be sent before (and in addition to) any complete or error - event. - -

The HTTPStatusEvent.HTTP_RESPONSE_STATUS constant defines the value of the - type property of a httpResponseStatus event object.

- - -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
responseURLThe URL from which the response was returned.
responseHeadersThe response headers that the response returned, - as an array of URLRequestHeader objects.
statusThe HTTP status code returned by the server.
redirectedWhether the reponse is the result of a redierct.
targetThe network object receiving an HTTP status code.
- -

-See also -

-
-flash.net.URLStream.httpResponseStatus -
-flash.net.FileReference.httpResponseStatus -
-
- - - - - -
HTTP_STATUSconstant 
-
-public static const HTTP_STATUS:String = "httpStatus" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The HTTPStatusEvent.HTTP_STATUS constant defines the value of the - type property of a httpStatus event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
statusThe HTTP status code returned by the server.
targetThe network object receiving an HTTP status code.
- -

-See also -

-
-flash.display.LoaderInfo.httpStatus -
-flash.net.FileReference.httpStatus -
-flash.net.URLLoader.httpStatus -
-flash.net.URLStream.httpStatus -
-
- -
Examples
-
examples\HTTPStatusEventExample
-
The following example attempts to load a nonexistent file from the root web directory - at http://www.[yourDomain].com, which should dispatch an httpStatusHandler event with a status of 404, indicating that - the file was not found. The httpStatusHandler event is handled by httpStatusHandler(), - which simply prints two lines of information about the event. - -

Notes: -

    -
  1. You need to compile the SWF file with "Local Playback Security" set - to "Access Network Only" to generate a securityError event in this example.
    2. -
  2. You need a server running on http://www.[yourDomain].com and listening on port 80 or you will receive - an httpStatusHandler event with status code 0 instead of 404.
    3. -
  3. You must not have a file named MissingFile.html at the root web directory - of http://www.[yourDomain].com or you will not receive the correct httpStatusHandler event.
    4. -
-

-
-
-package {
-	import flash.display.Sprite;
-	import flash.net.URLLoader;
-	import flash.net.URLRequest;
-	import flash.events.HTTPStatusEvent;
-
-	public class HTTPStatusEventExample extends Sprite {
-
-		public function HTTPStatusEventExample() {
-			var loader:URLLoader = new URLLoader();
-			loader.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
-
-			var request:URLRequest = new URLRequest("http://www.[yourDomain].com/MissingFile.html");
-			loader.load(request);
-		}
-
-		private function httpStatusHandler(event:HTTPStatusEvent):void {
-			trace("httpStatusHandler: " + event);
-			trace("status: " + event.status);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/IEventDispatcher.html b/html-docs/flash/events/IEventDispatcher.html deleted file mode 100644 index 1015022..0000000 --- a/html-docs/flash/events/IEventDispatcher.html +++ /dev/null @@ -1,515 +0,0 @@ - - - - - - - - -flash.events.IEventDispatcher (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Interfacepublic interface IEventDispatcher
ImplementorsEventDispatcher
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The IEventDispatcher interface defines methods for adding or removing event listeners, checks -whether specific types of event listeners are registered, and dispatches events. - -

Event targets are an important part of the Flash® Player and Adobe AIR event model. The event target -serves as the focal point for how events flow through the display list hierarchy. -When an event such as a mouse click or a keypress occurs, an event -object is dispatched into the event flow from the root of the display list. The event object makes a -round-trip journey to the event target, which is conceptually divided into three phases: -the capture phase includes the journey from the root to the last node before the event -target's node; the target phase includes only the event target node; and the bubbling -phase includes any subsequent nodes encountered on the return trip to the root of the -display list.

- -

In general, the easiest way for a user-defined class to gain event dispatching -capabilities is to extend EventDispatcher. If this is impossible (that is, if the class is -already extending another class), you can instead implement the IEventDispatcher interface, -create an EventDispatcher member, and write simple hooks to route calls into the aggregated -EventDispatcher.

- -

-

-View the examples. -

-
-
-
- -
-
Public Methods
- - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		IEventDispatcher
   -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		IEventDispatcher
   -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		IEventDispatcher
   -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		IEventDispatcher
   -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
-		IEventDispatcher
-
- -
- -
Method detail
- - - - - -
addEventListener()method
-
-public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event. You can register event listeners on all nodes in the - display list for a specific type of event, phase, and priority. -

After you successfully register an event listener, you cannot change its priority - through additional calls to addEventListener(). To change a listener's priority, you - must first call removeEventListener(). Then you can register the listener again with the new - priority level.

-

After the listener is registered, subsequent calls to - addEventListener() with a different value for either type or useCapture result in the - creation of a separate listener registration. For example, if you first register a - listener with useCapture set to true, it listens only during the capture phase. If you - call addEventListener() again using the same listener object, but with useCapture set to - false, you have two separate listeners: one that listens during the capture phase, and - another that listens during the target and bubbling phases.

-

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

-

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects - with registered event listeners are not automatically removed from memory because the - garbage collector does not remove objects that still have references.

-

Copying an EventDispatcher instance does not copy the event listeners attached to it. - (If your newly created node needs an event listener, you must attach the listener after - creating the node.) However, if you move an EventDispatcher instance, the event - listeners attached to it move along with it.

-

If the event listener is being registered on a node while an event is also being processed on - this node, the event listener is not triggered during the current phase but may be - triggered during a later phase in the event flow, such as the bubbling phase.

-

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again - (unless it is registered again for future processing).

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. -
 
listener:Function — The listener function that processes the event. This function must accept an event object - as its only parameter and must return nothing, as this example shows: -

function(evt:Event):void

- The function can have any name. -
 
useCapture:Boolean (default = false) — Determines whether the listener works in the capture phase or the target - and bubbling phases. If useCapture is set to true, the - listener processes the event only during the capture phase and not in the target or - bubbling phase. If useCapture is false, the listener processes the event only - during the target or bubbling phase. To listen for the event in all three phases, call - addEventListener() twice, once with useCapture set to true, - then again with useCapture set to false. -
 
priority:int (default = 0) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0. -
 
useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or weak. A strong - reference (the default) prevents your listener from being garbage-collected. A weak - reference does not.

Class-level member functions are not subject to garbage - collection, so you can set useWeakReference to true for - class-level member functions without subjecting them to garbage collection. If you set - useWeakReference to true for a listener that is a nested inner - function, the function will be garbge-collected and no longer persistent. If you create - references to the inner function (save it in another variable) then it is not - garbage-collected and stays persistent.

- -
-
- - - - - -
dispatchEvent()method 
-
-public function dispatchEvent(event:Event):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatches an event into the event flow. The event target is the - EventDispatcher object upon which dispatchEvent() is called. -

Parameters - - - - -
event:Event — The event object dispatched into the event flow. -
-

-Returns - - - - -
Boolean — - A value of true unless preventDefault() is called on the event, - in which case it returns false. - - - -
-
- - - - - -
hasEventListener()method 
-
-public function hasEventListener(type:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether - a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger(). -

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

- - Parameters - - - - -
type:String — The type of event. -
-

-Returns - - - - -
Boolean — - A value of true if a listener of the specified type is registered; false otherwise. - - -
-

-See also -

-
-willTrigger() -
-
- - - - - -
removeEventListener()method 
-
-public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Removes a listener from the EventDispatcher object. If there is no matching listener - registered with the EventDispatcher object, a call to this method has no effect. - -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of event. -
 
listener:Function — The listener object to remove. -
 
useCapture:Boolean (default = false) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false. - -
-
- - - - - -
willTrigger()method 
-
-public function willTrigger(type:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants. -

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

- - Parameters - - - - -
type:String — The type of event. -
-

-Returns - - - - -
Boolean — - A value of true if a listener of the specified type will be triggered; false otherwise. - - - -
-
- -
Examples
-
examples\IEventDispatcherExample
-
The following example uses the IEventDispatcherExample and - DecoratedDispatcher sample classes to show how the IEventDispatcher class can be - implemented and used. The example accomplishes this by implementing each method of - DecoratedDispatcher in the same manner as in EventDispatcher. - Within the constructor for IEventDispatcherExample, a new instance (named decorDispatcher) of the DecoratedDispatcher class is constructed - and the decorDispatcher variable is used to call - addEventListener() with the custom event doSomething, which is - then handled by didSomething(), which prints a line of text using - trace(). -
-
 
-package {
-        import flash.events.Event;
-        import flash.display.Sprite;
-       
-        public class IEventDispatcherExample extends Sprite {
-                public function IEventDispatcherExample() {
-                        var decorDispatcher:DecoratedDispatcher = new DecoratedDispatcher();
-                        decorDispatcher.addEventListener("doSomething", didSomething);
-                        decorDispatcher.dispatchEvent(new Event("doSomething"));
-                }
-               
-                public function didSomething(evt:Event):void {
-                        trace(">> didSomething");
-                }
-        }
-}
-
-import flash.events.IEventDispatcher;
-import flash.events.EventDispatcher;
-import flash.events.Event;
-               
-class DecoratedDispatcher implements IEventDispatcher {       
-    private var dispatcher:EventDispatcher;
-               
-	public function DecoratedDispatcher() {
-		dispatcher = new EventDispatcher(this);
-	}
-	       
-	public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void{
-		dispatcher.addEventListener(type, listener, useCapture, priority);
-	}
-	       
-	public function dispatchEvent(evt:Event):Boolean{
-		return dispatcher.dispatchEvent(evt);
-	}
-	
-	public function hasEventListener(type:String):Boolean{
-		return dispatcher.hasEventListener(type);
-	}
-	
-	public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void{
-		dispatcher.removeEventListener(type, listener, useCapture);
-	}
-	               
-	public function willTrigger(type:String):Boolean {
-		return dispatcher.willTrigger(type);
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/IMEEvent.html b/html-docs/flash/events/IMEEvent.html deleted file mode 100644 index 54f662f..0000000 --- a/html-docs/flash/events/IMEEvent.html +++ /dev/null @@ -1,922 +0,0 @@ - - - - - - - - -flash.events.IMEEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class IMEEvent
InheritanceIMEEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- An IMEEvent object is dispatched when the user enters text using an input method editor - (IME). IMEs are generally used to enter text from languages that have ideographs instead of - letters, such as Japanese, Chinese, and Korean. There are two IME events: - IMEEvent.IME_COMPOSITION and IMEEvent.IME_START_COMPOSITION. -

-

-See also -

-
-flash.system.IME -
-flash.events.IMEEvent.IME_COMPOSITION -
-flash.events.IMEEvent.IME_START_COMPOSITION -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  imeClient : IIMEClient -
- Specifies an object that implements the IMEClient interface.
-		IMEEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-IMEEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", imeClient:IIMEClient = null)
-
- Creates an Event object with specific information relevant to IME events.
-		IMEEvent
   -
-clone():Event -
-
- Creates a copy of the IMEEvent object and sets the value of each property to match that of the original.
-		IMEEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the IMEEvent object.
-		IMEEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
  IME_COMPOSITION : String = "imeComposition"
[static] - Defines the value of the type property of an imeComposition event object.
-		IMEEvent
  IME_START_COMPOSITION : String = "imeStartComposition"
[static] - To handle IME text input, the receiver must set the imeClient field of the event to an object - that implements the IIMEClient interface.
-		IMEEvent
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
imeClientproperty
-
-imeClient:IIMEClient  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Specifies an object that implements the IMEClient interface. Components based on the flash.text.engine - package must implement this interface to support editing text inline using an IME. - -

Implementation -
-    public function get imeClient():IIMEClient -
-    public function set imeClient(value:IIMEClient):void -
-
- -
Constructor detail
- - - - - -
IMEEvent()constructor
-
-public function IMEEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", imeClient:IIMEClient = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates an Event object with specific information relevant to IME events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one IME event: IMEEvent.IME_COMPOSITION. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
text:String (default = "") — The reading string from the IME. This is the initial string as typed by the user, before selection of any candidates. The final composition string is delivered to the object with keyboard focus in a TextEvent.TEXT_INPUT event. Event listeners can access this information through the text property. -
 
imeClient:IIMEClient (default = null) — A set of callbacks used by the text engine to communicate with the IME. Useful if your code has its own text engine and is rendering lines of text itself, rather than using TextField objects or the TextLayoutFramework. -
-

-See also -

-
-flash.system.IME -
-flash.events.IMEEvent.IME_COMPOSITION -
-flash.events.IMEEvent.IME_START_COMPOSITION -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of the IMEEvent object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event — - A new IMEEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the IMEEvent object. The string is in the following format: -

[IMEEvent type=value bubbles=value cancelable=value text=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the IMEEvent object. - - - -
-
- -
Constant detail
- - - - - -
IME_COMPOSITIONconstant
-
-public static const IME_COMPOSITION:String = "imeComposition" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of an imeComposition event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe IME object.
- -

-See also -

-
-flash.system.IME.imeComposition -
-
- - - - - -
IME_START_COMPOSITIONconstant 
-
-public static const IME_START_COMPOSITION:String = "imeStartComposition" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- To handle IME text input, the receiver must set the imeClient field of the event to an object - that implements the IIMEClient interface. If imeClient is unset, the runtime uses out-of-line - IME composition instead, and sends the final composition as a TEXT_INPUT event. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe IME object.
- -

-See also -

-
-flash.system.IME.imeComposition -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/IOErrorEvent.html b/html-docs/flash/events/IOErrorEvent.html deleted file mode 100644 index 55c27d7..0000000 --- a/html-docs/flash/events/IOErrorEvent.html +++ /dev/null @@ -1,1031 +0,0 @@ - - - - - - - - -flash.events.IOErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class IOErrorEvent
InheritanceIOErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-An IOErrorEvent object is dispatched when an error causes input or output operations to fail. - -

You can check for error events that do not have any listeners by using the debugger -version of Flash Player or the AIR Debug Launcher (ADL). The string defined by the -text parameter of the IOErrorEvent constructor is displayed.

-

-

-View the examples. -

-

-See also -

-
-IO_ERROR -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-IOErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0)
-
- Creates an Event object that contains specific information about ioError events.
-		IOErrorEvent
   -
-clone():Event -
-
- Creates a copy of the IOErrorEvent object and sets the value of each property to match that of the original.
-		IOErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the IOErrorEvent object.
-		IOErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
  IO_ERROR : String = "ioError"
[static] - Defines the value of the type property of an ioError event object.
-		IOErrorEvent
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
  STANDARD_ERROR_IO_ERROR : String = "standardErrorIoError"
[static] - The standardErrorIoError event is dispatched when an error occurs while - reading data from the standardError stream of a NativeProcess object.
-		IOErrorEvent
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
  STANDARD_INPUT_IO_ERROR : String = "standardInputIoError"
[static] - The standardInputIoError event is dispatched when an error occurs while - writing data to the standardInput of a NativeProcess object.
-		IOErrorEvent
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
  STANDARD_OUTPUT_IO_ERROR : String = "standardOutputIoError"
[static] - The standardOutputIoError event is dispatched when an error occurs while - reading data from the standardOutput stream of a NativeProcess object.
-		IOErrorEvent
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Constructor detail
- - - - - -
IOErrorEvent()constructor
-
-public function IOErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates an Event object that contains specific information about ioError events. - Event objects are passed as parameters to Event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of input/output error event: IOErrorEvent.IO_ERROR. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
text:String (default = "") — Text to be displayed as an error message. Event listeners can access this information through the text property. -
 
id:int (default = 0) — A reference number to associate with the specific error (supported in Adobe AIR only). -
-

-See also -

-
-IO_ERROR -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a copy of the IOErrorEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new IOErrorEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the IOErrorEvent object. The string is in the following format: -

[IOErrorEvent type=value bubbles=value cancelable=value text=value errorID=value] - The errorId is only available in Adobe AIR

-

-Returns - - - - -
String — - A string that contains all the properties of the IOErrorEvent object. - - - -
-
- -
Constant detail
- - - - - -
IO_ERRORconstant
-
-public static const IO_ERROR:String = "ioError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -

-See also -

-
-flash.display.LoaderInfo.ioError -
-flash.media.Sound.ioError -
-flash.net.SecureSocket.ioError -
-flash.net.Socket.ioError -
-flash.net.FileReference.ioError -
-flash.net.NetConnection.ioError -
-flash.net.NetStream.ioError -
-flash.net.URLLoader.ioError -
-flash.net.URLStream.ioError -
-flash.net.XMLSocket.ioError -
-
- - - - - -
STANDARD_ERROR_IO_ERRORconstant 
-
-public static const STANDARD_ERROR_IO_ERROR:String = "standardErrorIoError" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The standardErrorIoError event is dispatched when an error occurs while - reading data from the standardError stream of a NativeProcess object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesNo.
cancelableNo. There is no default behavior to cancel.
errorIDThe reference number associated with the specific error.
targetThe object on which the error occurred.
textText to be displayed as an error message.
- -
- - - - - -
STANDARD_INPUT_IO_ERRORconstant 
-
-public static const STANDARD_INPUT_IO_ERROR:String = "standardInputIoError" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The standardInputIoError event is dispatched when an error occurs while - writing data to the standardInput of a NativeProcess object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesNo.
cancelableNo. There is no default behavior to cancel.
errorIDThe reference number associated with the specific error.
targetThe object on which the error occurred.
textText to be displayed as an error message.
- -
- - - - - -
STANDARD_OUTPUT_IO_ERRORconstant 
-
-public static const STANDARD_OUTPUT_IO_ERROR:String = "standardOutputIoError" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The standardOutputIoError event is dispatched when an error occurs while - reading data from the standardOutput stream of a NativeProcess object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesNo.
cancelableNo. There is no default behavior to cancel.
errorIDThe reference number associated with the specific error.
targetThe object on which the error occurred.
textText to be displayed as an error message.
- -
- -
Examples
-
examples\IOErrorEventExample
-
The following example uses the IOErrorEventExample class to show how an error - event object is dispatched when an attempt is made to load a nonexistent file. The example carries out the following tasks: -
    -
  1. The class constructor creates a new instance of a URLLoader object and assigns it to the variable - loader.
    2. -
  2. The URLLoader instance instantiates an event listener of type ioError, which has - an associated subscriber method ioErrorHandler(), which simply prints information about - the event using trace().
    3. -
  3. Next, the constructor creates a new instance of a URLRequest object, request, - passing MissingFile.xml so that the name and location of the missing file are - known.
    4. -
  4. The request variable is then passed to loader.load(), which attempts to load the - missing file. Since the file is missing, the event handler dispatches an ioError event.
    5. -
- -

Notes: -

    -
  • You need to compile the SWF file with "Local Playback Security" set to "Access Local Files Only".
    • -
  • Make sure that you do not have a file named "MissingFile.xml" at the same level as your SWF file.
    • -
-

-
-
-package {
-	import flash.display.Sprite;
-	import flash.events.IOErrorEvent;
-	import flash.net.URLLoader;
-	import flash.net.URLRequest;
-
-	public class IOErrorEventExample extends Sprite {
-		public function IOErrorEventExample() {
-			var loader:URLLoader = new URLLoader();
-			loader.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-
-			var request:URLRequest = new URLRequest("MissingFile.xml");
-			loader.load(request);
-		}
-
-		private function ioErrorHandler(event:IOErrorEvent):void {
-			trace("ioErrorHandler: " + event);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/InvokeEvent.html b/html-docs/flash/events/InvokeEvent.html deleted file mode 100644 index 14e5435..0000000 --- a/html-docs/flash/events/InvokeEvent.html +++ /dev/null @@ -1,1044 +0,0 @@ - - - - - - - - -flash.events.InvokeEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class InvokeEvent
InheritanceInvokeEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The NativeApplication object of an AIR application dispatches an invoke event when the - application is invoked. - -

The NativeApplication object always dispatches an invoke event - when an application is launched, but the event may be dispatched - at other times as well. For example, a running application dispatches an - additional InvokeEvent when a user activates a file associated with the - application.

- -

Only a single instance of a particular application can be launched. Subsequent attempts to - launch the application will result in a new invoke event dispatched by - the NativeApplication object of the running instance. - It is an application's responsibility to handle this event and take the appropriate - action, such as opening a new application window to display the data in a file.

- -

InvokeEvent objects are dispatched by the NativeApplication object - (NativeApplication.nativeApplication). To receive invoke events, - call the addEventListener() method of the NativeApplication object. - When an event listener registers for an invoke event, it will also receive all - invoke events that occurred before the registration. These earlier events are dispatched - after the call to addEventListener() returns, but not necessarily before - a new invoke event that might be might be dispatched after registration. Thus, - you should not rely on dispatch order.

- -

-

-See also -

-
-flash.events.BrowserInvokeEvent -
-flash.desktop.NativeApplication -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  arguments : Array -
[read-only] - The array of string arguments passed during this invocation.
-		InvokeEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentDirectory : File -
[read-only] - The directory that should be used to resolve any relative paths in the arguments - array.
-		InvokeEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  reason : String -
[read-only] - The reason for this InvokeEvent.
-		InvokeEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-InvokeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dir:File = null, argv:Array = null, reason:String = "standard")
-
- The constructor function for the InvokeEvent class.
-		InvokeEvent
   -
-clone():Event -
-
- Creates a new copy of this event.
-		InvokeEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
  INVOKE : String = "invoke"
[static] - The InvokeEvent.INVOKE constant defines the value of the type - property of an InvokeEvent object.
-		InvokeEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
argumentsproperty
-
-arguments:Array  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The array of string arguments passed during this invocation. If this is a - command line invocation, the array contains the command line arguments - (excluding the process name). -

On mobile platforms, this property contains the array of options with which the application was launched, not the command-line arguments. - Additionally, on mobile platforms, when reason is InvokeEventReason.OPEN_URL, the contents of the arguments Array - vary, as follows:

-
    -
  • Another application or browser invokes the application with a custom URL (iOS and Android): - - - - - - - - - - - - - - - - - - - - - - - - - - -
    argumentsiOSAndroid
    InvokeEvent.arguments.length32
    InvokeEvent.arguments[0]urlurl
    InvokeEvent.arguments[1]source app idaction id
    InvokeEvent.arguments[2]nullNA
    -
    • -
    -
  • The system invokes the application to open an associated file type (iOS and Android): - - - - - - - - - - - - - - - - - - - - - - - - - - -
    argumentsiOSAndroid
    InvokeEvent.arguments.length32
    InvokeEvent.arguments[0]urlurl
    InvokeEvent.arguments[1]nullaction id
    InvokeEvent.arguments[2]nullNA
    -
    • -
    -
  • Another application invokes the application using the document interaction controller (iOS only): - - - - - - - - - - - - - - - - - - - - - -
    argumentsiOS
    InvokeEvent.arguments.length3
    InvokeEvent.arguments[0]url
    InvokeEvent.arguments[1]source app id
    InvokeEvent.arguments[2]annotation
    -
    • -
- -

Note: When multiple files are selected and opened on Mac® OS X, AIR - dispatches a single invoke event containing the names of all the - selected files in the arguments array. On Windows® and Linux, however, AIR - dispatches a separate invoke event for each selected file containing only that - filename in the arguments array. -

- - Implementation -
-    public function get arguments():Array -
-
- - - - - -
currentDirectoryproperty 
-
-currentDirectory:File  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The directory that should be used to resolve any relative paths in the arguments - array. - -

If an application is started from the command line, this property is - typically set to the current working directory of the command line shell from which - the application was started. If an application is launched from the GUI shell, - this is typically the file system root.

- - Implementation -
-    public function get currentDirectory():File -
-
- - - - - -
reasonproperty 
-
-reason:String  [read-only]

- - - - -
Runtime version: AIR 1.5.1 -
-

- The reason for this InvokeEvent. This property indicates whether the application was launched manually - by the user or automatically at login. Possible values are enumerated as constants in - the InvokeEventReason class: - - - - - - - - - - - - - - - - - - - - - -
InvokeEventReason constantMeaning
LOGINLaunched automatically at at login.
NOTIFICATIONLaunched in reponse to a notification (iOS only).
OPEN_URLLaunched because the application was invoked by another application.
STANDARDLaunched for any other reason.
-

Note: On mobile platforms, the reason property is never set to - LOGIN. -

- - Implementation -
-    public function get reason():String -
-

-See also -

-
-flash.desktop.InvokeEventReason -
-
- -
Constructor detail
- - - - - -
InvokeEvent()constructor
-
-public function InvokeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dir:File = null, argv:Array = null, reason:String = "standard") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The constructor function for the InvokeEvent class. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event, accessible as Event.type. -
 
bubbles:Boolean (default = false) — Set to false for an InvokeEvent object. -
 
cancelable:Boolean (default = false) — Set to false for an InvokeEvent object. -
 
dir:File (default = null) — The directory that should be used to resolve any relative paths in - the arguments array. -
 
argv:Array (default = null) — An array of arguments (strings) to pass to the application. -
 
reason:String (default = "standard") — the cause of the event: InvokeEventReason.LOGIN, InvokeEventReason.STANDARD, - InvokeEventReason.OPEN_URL, or InvokeEventReason.NOTIFICATION. - (This parameter is available as of AIR version 1.5.1. OPEN_URL and NOTIFICATION are available as of AIR version 3.5.) - -
-

-See also -

-
-flash.desktop.InvokeEventReason -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Runtime version: AIR 1.0 -
-

- Creates a new copy of this event. - -

-Returns - - - - -
Event — - The copy of the event. - - - -
-
- -
Constant detail
- - - - - -
INVOKEconstant
-
-public static const INVOKE:String = "invoke" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The InvokeEvent.INVOKE constant defines the value of the type - property of an InvokeEvent object. - -

The InvokeEvent object has the following properties:

- - - - - - - - - -
PropertiesValues
argumentsThe array of string arguments passed - during this invocation.
currentDirectorya File object representing the - directory that should be used to resolve any relative paths in the arguments array.
reasona code indicating whether the invoke event was dispatched - because the application started automatically at login (InvokeEventReason.LOGIN), started - as a response to a remote notification (InvokeEventReason.NOTIFICATION - iOS only), - because the application was invoked by another application (InvokeEventReason.OPEN_URL), or - for another reason (InvokeEventReason.STANDARD). Available as of AIR version 1.5.1.
bubblesfalse.
cancelablefalse; - there is no default behavior to cancel.
currentTargetIndicates the object that is - actively processing this InvokeEvent object with an event listener.
targetAlways the NativeApplication object. -
- -

-See also -

-
-flash.desktop.NativeApplication -
-flash.desktop.InvokeEventReason -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/KeyboardEvent.html b/html-docs/flash/events/KeyboardEvent.html deleted file mode 100644 index 0c8abb6..0000000 --- a/html-docs/flash/events/KeyboardEvent.html +++ /dev/null @@ -1,1576 +0,0 @@ - - - - - - - - -flash.events.KeyboardEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class KeyboardEvent
InheritanceKeyboardEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - A KeyboardEvent object id dispatched in response to user input through a keyboard. - - There are two types of keyboard events: KeyboardEvent.KEY_DOWN and - - KeyboardEvent.KEY_UP - - -

Because mappings between keys and specific characters vary by device - - and operating system, use the TextEvent event type for processing character input.

- - - -

To listen globally for key events, listen on the Stage for the capture and target - - or bubble phase.

- - -

-

-View the examples. -

-

-See also -

-
-KEY_DOWN -
-KEY_UP -
-KeyLocation -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  altKey : Boolean -
- - Indicates whether the Alt key is active (true) or inactive (false) on Windows; - - indicates whether the Option key is active on Mac OS.
-		KeyboardEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
  charCode : uint -
- - Contains the character code value of the key pressed or released.
-		KeyboardEvent
  commandKey : Boolean -
- - Indicates whether the Command key is active (true) or inactive (false).
-		KeyboardEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  controlKey : Boolean -
- - Indicates whether the Control key is active (true) or inactive (false).
-		KeyboardEvent
  ctrlKey : Boolean -
- - On Windows and Linux, indicates whether the Ctrl key is active (true) or inactive (false); - - On Mac OS, indicates whether either the Ctrl key or the Command key is active.
-		KeyboardEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  functionKey : Boolean -
- - Indicates whether the Function key is active (true) or inactive (false).
-		KeyboardEvent
  keyCode : uint -
- - The key code value of the key pressed or released.
-		KeyboardEvent
  keyLocation : uint -
- - Indicates the location of the key on the keyboard.
-		KeyboardEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  shiftKey : Boolean -
- - Indicates whether the Shift key modifier is active (true) or inactive - - (false).
-		KeyboardEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-KeyboardEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, charCodeValue:uint = 0, keyCodeValue:uint = 0, keyLocationValue:uint = 0, ctrlKeyValue:Boolean = false, altKeyValue:Boolean = false, shiftKeyValue:Boolean = false, controlKeyValue:Boolean = false, commandKeyValue:Boolean = false, functionKeyValue:Boolean = false)
-
- - Creates an Event object that contains specific information about keyboard events.
-		KeyboardEvent
   -
-clone():Event -
-
- - Creates a copy of the KeyboardEvent object and sets the value of each property to match that of the original.
-		KeyboardEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string that contains all the properties of the KeyboardEvent object.
-		KeyboardEvent
   -
-updateAfterEvent():void -
-
- - Indicates that the display should be rendered after processing of this event completes, if the display - - list has been modified - - -
-		KeyboardEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
  KEY_DOWN : String = "keyDown"
[static] - - The KeyboardEvent.KEY_DOWN constant defines the value of the type property of a keyDown event object.
-		KeyboardEvent
  KEY_UP : String = "keyUp"
[static] - - The KeyboardEvent.KEY_UP constant defines the value of the type property of a keyUp event object.
-		KeyboardEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
altKeyproperty
-
-altKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Indicates whether the Alt key is active (true) or inactive (false) on Windows; - - indicates whether the Option key is active on Mac OS. - - -

Implementation -
-    public function get altKey():Boolean -
-    public function set altKey(value:Boolean):void -
-
- - - - - -
charCodeproperty 
-
-charCode:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Contains the character code value of the key pressed or released. - - The character code values are English keyboard values. - - For example, if you press Shift+3, charCode is # on a Japanese keyboard, - - if you press Shift+2, charCode is @ on a German keyboard - - (and not "), just as it is on an English keyboard. - -

Note: When an input method editor (IME) is running, - - charCode does not report accurate character codes.

- - - Implementation -
-    public function get charCode():uint -
-    public function set charCode(value:uint):void -
-
- - - - - -
commandKeyproperty 
-
-commandKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether the Command key is active (true) or inactive (false). - - Supported for Mac OS only. On Mac OS, the commandKey property has the same - - value as the ctrlKey property. - - -

Implementation -
-    public function get commandKey():Boolean -
-    public function set commandKey(value:Boolean):void -
-
- - - - - -
controlKeyproperty 
-
-controlKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether the Control key is active (true) or inactive (false). - - On Windows and Linux, this is also true when the Ctrl key is active. - - -

Implementation -
-    public function get controlKey():Boolean -
-    public function set controlKey(value:Boolean):void -
-
- - - - - -
ctrlKeyproperty 
-
-ctrlKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - On Windows and Linux, indicates whether the Ctrl key is active (true) or inactive (false); - - On Mac OS, indicates whether either the Ctrl key or the Command key is active. - - -

Implementation -
-    public function get ctrlKey():Boolean -
-    public function set ctrlKey(value:Boolean):void -
-
- - - - - -
functionKeyproperty 
-
-functionKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Indicates whether the Function key is active (true) or inactive (false). - - Supported for Mac OS only. - - -

Implementation -
-    public function get functionKey():Boolean -
-    public function set functionKey(value:Boolean):void -
-
- - - - - -
keyCodeproperty 
-
-keyCode:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The key code value of the key pressed or released. - -

Note: When an input method editor (IME) is running, - - keyCode does not report accurate key codes.

- - - Implementation -
-    public function get keyCode():uint -
-    public function set keyCode(value:uint):void -
-

-See also -

-
-flash.system.IME -
-
- - - - - -
keyLocationproperty 
-
-keyLocation:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Indicates the location of the key on the keyboard. This is useful for differentiating keys - - that appear more than once on a keyboard. For example, you can differentiate between the - - left and right Shift keys by the value of this property: KeyLocation.LEFT - - for the left and KeyLocation.RIGHT for the right. Another example is - - differentiating between number keys pressed on the standard keyboard - - (KeyLocation.STANDARD) versus the numeric keypad (KeyLocation.NUM_PAD). - - -

Implementation -
-    public function get keyLocation():uint -
-    public function set keyLocation(value:uint):void -
-
- - - - - -
shiftKeyproperty 
-
-shiftKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Indicates whether the Shift key modifier is active (true) or inactive - - (false). - - -

Implementation -
-    public function get shiftKey():Boolean -
-    public function set shiftKey(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
KeyboardEvent()constructor
-
-public function KeyboardEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, charCodeValue:uint = 0, keyCodeValue:uint = 0, keyLocationValue:uint = 0, ctrlKeyValue:Boolean = false, altKeyValue:Boolean = false, shiftKeyValue:Boolean = false, controlKeyValue:Boolean = false, commandKeyValue:Boolean = false, functionKeyValue:Boolean = false) -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates an Event object that contains specific information about keyboard events. - - Event objects are passed as parameters to event listeners. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are: - - KeyboardEvent.KEY_DOWN and KeyboardEvent.KEY_UP - - - -
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling stage of the event flow. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. - -
 
charCodeValue:uint (default = 0) — The character code value of the key pressed or released. The character code values returned are English keyboard values. For example, if you press Shift+3, the Keyboard.charCode() property returns # on a Japanese or a German keyboard, just as it does on an English keyboard. - -
 
keyCodeValue:uint (default = 0) — The key code value of the key pressed or released. - -
 
keyLocationValue:uint (default = 0) — The location of the key on the keyboard. - -
 
ctrlKeyValue:Boolean (default = false) — On Windows, indicates whether the Ctrl key is activated. On Mac, indicates whether either the Ctrl key or the Command key is activated. - -
 
altKeyValue:Boolean (default = false) — Indicates whether the Alt key modifier is activated (Windows only). - -
 
shiftKeyValue:Boolean (default = false) — Indicates whether the Shift key modifier is activated. - -
 
controlKeyValue:Boolean (default = false) — Indicates whether the Control key is activated on Mac, and whether the Control or Ctrl keys are activated on WIndows and Linux. - -
 
commandKeyValue:Boolean (default = false) — Indicates whether the Command key is activated (Mac only). - -
 
functionKeyValue:Boolean (default = false) — Indicates whether the Function key is active (Mac only). - - - -
-

-See also -

-
-KEY_DOWN -
-KEY_UP -
-KeyboardEvent.charCode -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates a copy of the KeyboardEvent object and sets the value of each property to match that of the original. - - -

-Returns - - - - -
Event — - A new KeyboardEvent object with property values that match those of the original. - - - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a string that contains all the properties of the KeyboardEvent object. The string - - is in the following format: - -

[KeyboardEvent type=value bubbles=value cancelable=value ... shiftKey=value]

- - -

-Returns - - - - -
String — - A string that contains all the properties of the KeyboardEvent object. - - - - - -
-
- - - - - -
updateAfterEvent()method 
-
-public function updateAfterEvent():void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Indicates that the display should be rendered after processing of this event completes, if the display - - list has been modified - - -

- -
Constant detail
- - - - - -
KEY_DOWNconstant
-
-public static const KEY_DOWN:String = "keyDown" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The KeyboardEvent.KEY_DOWN constant defines the value of the type property of a keyDown event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblestrue
cancelabletrue in AIR, false in Flash Player; - - in AIR, canceling this event prevents the character from being entered into a text field.
charCodeThe character code value of the key pressed or released.
commandKeytrue on Mac if the Command key is active. Otherwise, false
controlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Control key is active. Otherwise, false
ctrlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
keyCodeThe key code value of the key pressed or released.
keyLocationThe location of the key on the keyboard.
shiftKeytrue if the Shift key is active; false if it is inactive.
functionKeytrue if the Function key is active (Mac only); false if it is inactive.
targetThe InteractiveObject instance with focus. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.keyDown -
-
- - - - - -
KEY_UPconstant 
-
-public static const KEY_UP:String = "keyUp" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The KeyboardEvent.KEY_UP constant defines the value of the type property of a keyUp event object. - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
charCodeContains the character code value of the key pressed or released.
commandKeytrue on Mac if the Command key is active. Otherwise, false
controlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Control key is active. Otherwise, false
ctrlKeytrue on Windows if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
keyCodeThe key code value of the key pressed or released.
keyLocationThe location of the key on the keyboard.
shiftKeytrue if the Shift key is active; false if it is inactive.
functionKeytrue if the Function key is active (Mac only); false if it is inactive.
targetThe InteractiveObject instance with focus. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.keyUp -
-
- -
Examples
-
examples\KeyboardEventExample
-
The following example uses the KeyboardEventExample class to show - keyboard events and their listener functions. The example carries out the following tasks: -
    -
  1. It creates a new Sprite instance named child.
    2. -
  2. It declares properties for later use in setting a square's background color and size.
    3. -
  3. Using methods of Sprite, it draws a light-blue square that it displays on the Stage - at default coordinates (0,0) by calling the addChild() method.
    4. -
  4. It adds one mouse event and two keyboard type event listeners: -
      -
    • click/clickHandler which is dispatched when you click on the square to set focus on the child sprite so it can listen for keyboard events.
      • -
    • keyDown/keyDownHandler which is dispatched whenever any key is pressed. The subscriber method prints information about the event - using the trace() statement.
      • -
    • keyUp/keyUpHandler which is dispatched when a key is - released.
      • -
    5. -
- -

When you test this example, you need to click the square first for the keyboard events to work.

-

Also, if you are using the Test Movie command in Flash, the authoring - interface may respond to certain keys instead of the event listeners attached to - the child sprite.

-
-
-package {
-	import flash.display.Sprite;
-	import flash.display.DisplayObject;
-	import flash.events.*;
-
-	public class KeyboardEventExample extends Sprite {
-        private var child:Sprite = new Sprite();
-		private var bgColor:uint = 0x00CCFF;
-		private var size:uint = 80;
-
-		public function KeyboardEventExample() {
-			child.graphics.beginFill(bgColor);
-			child.graphics.drawRect(0, 0, size, size);
-			child.graphics.endFill();
-			addChild(child);
-            child.addEventListener(MouseEvent.CLICK, clickHandler);
-			child.addEventListener(KeyboardEvent.KEY_DOWN, keyDownHandler);
-			child.addEventListener(KeyboardEvent.KEY_UP, keyUpHandler);
-            
-        }
-
-        private function clickHandler(event:MouseEvent):void {
-            stage.focus = child;
-		}
-
-		private function keyDownHandler(event:KeyboardEvent):void {
-			trace("keyDownHandler: " + event.keyCode);
-			trace("ctrlKey: " + event.ctrlKey);
-			trace("keyLocation: " + event.keyLocation);
-			trace("shiftKey: " + event.shiftKey);
-			trace("altKey: " + event.altKey);
-
-		}
-
-		private function keyUpHandler(event:KeyboardEvent):void {
-			trace("keyUpHandler: " + event.keyCode);
-		}
-        
-        
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/LocationChangeEvent.html b/html-docs/flash/events/LocationChangeEvent.html deleted file mode 100644 index f5e1b7e..0000000 --- a/html-docs/flash/events/LocationChangeEvent.html +++ /dev/null @@ -1,839 +0,0 @@ - - - - - - - - -flash.events.LocationChangeEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class LocationChangeEvent
InheritanceLocationChangeEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

-

- An HTMLLoader or StageWebView object dispatches a LocationChangeEvent object when a new page loads. - -

There are two types of LocationChangeEvent:

-
    -
  • LocationChangeEvent.LOCATION_CHANGING: dispatched before a change initiated via the - content displayed in a StageWebView object. Can be canceled.
    • -
  • LocationChangeEvent.LOCATION_CHANGE: dispatched after every location change. Cannot be canceled.
    • -
- -

-

-See also -

-
-StageWebView -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  location : String -
- The destination URL of the change.
-		LocationChangeEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-LocationChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, location:String = null)
-
- Creates a LocationChangeEvent object.
-		LocationChangeEvent
   -
-clone():Event -
-
-
-		LocationChangeEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the LocationChangeEvent object.
-		LocationChangeEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
  LOCATION_CHANGE : String = "locationChange"
[static] - Dispatched after every location change.
-		LocationChangeEvent
  LOCATION_CHANGING : String = "locationChanging"
[static] - The LOCATION_CHANGING constant defines the value of the type property LocationChangeEvent object - dispatched before a change in page location.
-		LocationChangeEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
locationproperty
-
-location:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The destination URL of the change. - -

Implementation -
-    public function get location():String -
-    public function set location(value:String):void -
-
- -
Constructor detail
- - - - - -
LocationChangeEvent()constructor
-
-public function LocationChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, location:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Creates a LocationChangeEvent object. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
location:String (default = null)
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

-

-Returns - - - - -
Event
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Returns a string that contains all the properties of the LocationChangeEvent object. - The string is in the following format: -

[LocationChangeEvent type=value bubbles=value cancelable=value - eventPhase=value location=value

- -

-Returns - - - - -
String
-
- -
Constant detail
- - - - - -
LOCATION_CHANGEconstant
-
-public static const LOCATION_CHANGE:String = "locationChange" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Dispatched after every location change. - -

- - - - - -
LOCATION_CHANGINGconstant 
-
-public static const LOCATION_CHANGING:String = "locationChanging" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The LOCATION_CHANGING constant defines the value of the type property LocationChangeEvent object - dispatched before a change in page location. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/MediaEvent.html b/html-docs/flash/events/MediaEvent.html deleted file mode 100644 index 83edf9a..0000000 --- a/html-docs/flash/events/MediaEvent.html +++ /dev/null @@ -1,874 +0,0 @@ - - - - - - - - -flash.events.MediaEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class MediaEvent
InheritanceMediaEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

-

- CameraRoll and CameraUI classes dispatch MediaEvent objects when a media stream - is available. - -

The CameraRoll class dispatches a select-type MediaEvent object when the user selects an image. - The CameraUI class dispatches a complete-type MediaEvent object when an image or video captured from the - device camera is returned.

-

-

-See also -

-
-CameraRoll -
-CameraUI -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  data : MediaPromise -
[read-only] - The MediaPromise object for the available media file.
-		MediaEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-MediaEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:MediaPromise = null)
-
- Creates an MediaEvent object that contains information about the available media file.
-		MediaEvent
   -
-clone():Event -
-
- Creates a copy of an MediaEvent object and sets the value of each property to match that of - the original.
-		MediaEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of MediaEvent object.
-		MediaEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
  COMPLETE : String = "complete"
[static] - A constant for the complete MediaEvent.
-		MediaEvent
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
  SELECT : String = "select"
[static] - A constant for the select MediaEvent.
-		MediaEvent
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
dataproperty
-
-data:MediaPromise  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- The MediaPromise object for the available media file. -

Implementation -
-    public function get data():MediaPromise -
-
- -
Constructor detail
- - - - - -
MediaEvent()constructor
-
-public function MediaEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:MediaPromise = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- Creates an MediaEvent object that contains information about the available media file. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
 
data:MediaPromise (default = null) — The MediaPromise object corresponding to the selected image. - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- Creates a copy of an MediaEvent object and sets the value of each property to match that of - the original. - -

-Returns - - - - -
Event — - a new MediaEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- Returns a string that contains all the properties of MediaEvent object. The following format is used: - -

[MediaEvent type=value bubbles=value cancelable=value - data=value ]

- -

-Returns - - - - -
String — - a new MediaEvent object with property values that match those of the original. - - -
-
- -
Constant detail
- - - - - -
COMPLETEconstant
-
-public static const COMPLETE:String = "complete" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- A constant for the complete MediaEvent. - -

Defines the value of the type property of a MediaEvent event object. - This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe MediaPromise object of the available media instance.
-
- - - - - -
SELECTconstant 
-
-public static const SELECT:String = "select" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- A constant for the select MediaEvent. - -

Defines the value of the type property of a MediaEvent event object. - This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe MediaPromise object of the available media instance.
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/MouseEvent.html b/html-docs/flash/events/MouseEvent.html deleted file mode 100644 index 368dfe0..0000000 --- a/html-docs/flash/events/MouseEvent.html +++ /dev/null @@ -1,3755 +0,0 @@ - - - - - - - - -flash.events.MouseEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.events
Classpublic class MouseEvent
InheritanceMouseEvent Inheritance Event Inheritance Object
SubclassesNativeDragEvent, ScreenMouseEvent
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - A MouseEvent object is dispatched into the event flow whenever mouse events occur. - - A mouse event is usually generated by a user input device, such as a mouse or a trackball, - - that uses a pointer. - - - -

When nested nodes are involved, mouse events target the deepest possible nested node that - - is visible in the display list. This node is called the target node. To have a - - target node's ancestor receive notification of a mouse event, use - - EventDispatcher.addEventListener() on the ancestor node with the - - type parameter set to the specific mouse event you want to detect.

- - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  altKey : Boolean -
- - Indicates whether the Alt key is active (true) or inactive (false).
-		MouseEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
  buttonDown : Boolean -
- - Indicates whether the primary mouse button is pressed (true) or not (false).
-		MouseEvent
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
  clickCount : int -
[read-only] - - Indicates whether or not the mouse down event is part of a multi-click sequence.
-		MouseEvent
  commandKey : Boolean -
- - Indicates whether the command key is activated (Mac only.) - - - -

The value of property commandKey - - will have the same value as property ctrlKey on the Mac.

-		MouseEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  controlKey : Boolean -
- - Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
-		MouseEvent
  ctrlKey : Boolean -
- - On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
-		MouseEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  delta : int -
- - Indicates how many lines should be scrolled for each unit the user rotates the - - mouse wheel.
-		MouseEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  isRelatedObjectInaccessible : Boolean -
- - If true, the relatedObject property is set to null for - - reasons related to security sandboxes.
-		MouseEvent
  localX : Number -
- - When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.
-		MouseEvent
  localY : Number -
- - When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.
-		MouseEvent
  movementX : Number -
- - When mouse locking is enabled, the change in mouse position - - in the X direction since the last mouse event.
-		MouseEvent
  movementY : Number -
- - When mouse locking is enabled, the change in mouse position - - in the Y direction since the last mouse event.
-		MouseEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  relatedObject : InteractiveObject -
- - A reference to a display list object that is related to the event.
-		MouseEvent
  shiftKey : Boolean -
- - Indicates whether the Shift key is active (true) or inactive - - (false).
-		MouseEvent
  stageX : Number -
[read-only] - - The horizontal coordinate at which the event occurred in global Stage coordinates.
-		MouseEvent
  stageY : Number -
[read-only] - - The vertical coordinate at which the event occurred in global Stage coordinates.
-		MouseEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-MouseEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, localX:Number, localY:Number, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0, commandKey:Boolean = false, controlKey:Boolean = false, clickCount:int = 0)
-
- - Creates an Event object that contains information about mouse events.
-		MouseEvent
   -
-clone():Event -
-
- - Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.
-		MouseEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a string that contains all the properties of the MouseEvent object.
-		MouseEvent
   -
-updateAfterEvent():void -
-
- - Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
-		MouseEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
  CLICK : String = "click"
[static] - - Defines the value of the type property of a click event object.
-		MouseEvent
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
  CONTEXT_MENU : String = "contextMenu"
[static] - - The MouseEvent.CONTEXT_MENU constant defines the value of the - - type property of a contextMenu event object.
-		MouseEvent
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
  DOUBLE_CLICK : String = "doubleClick"
[static] - - Defines the value of the type property of a doubleClick event object.
-		MouseEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
  MIDDLE_CLICK : String = "middleClick"
[static] - - Defines the value of the type property of a middleClick event object.
-		MouseEvent
  MIDDLE_MOUSE_DOWN : String = "middleMouseDown"
[static] - - Defines the value of the type property of a middleMouseDown event object.
-		MouseEvent
  MIDDLE_MOUSE_UP : String = "middleMouseUp"
[static] - - Defines the value of the type property of a middleMouseUp event object.
-		MouseEvent
  MOUSE_DOWN : String = "mouseDown"
[static] - - Defines the value of the type property of a mouseDown event object.
-		MouseEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
  MOUSE_MOVE : String = "mouseMove"
[static] - - Defines the value of the type property of a mouseMove event object.
-		MouseEvent
  MOUSE_OUT : String = "mouseOut"
[static] - - Defines the value of the type property of a mouseOut event object.
-		MouseEvent
  MOUSE_OVER : String = "mouseOver"
[static] - - Defines the value of the type property of a mouseOver event object.
-		MouseEvent
  MOUSE_UP : String = "mouseUp"
[static] - - Defines the value of the type property of a mouseUp event object.
-		MouseEvent
  MOUSE_WHEEL : String = "mouseWheel"
[static] - - Defines the value of the type property of a mouseWheel event object.
-		MouseEvent
  MOUSE_WHEEL_HORIZONTAL : String = "mouseWheelHorizontal"
[static] - - Defines the value of the type property of a mouseWheelHorizontal event object.
-		MouseEvent
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
  RELEASE_OUTSIDE : String = "releaseOutside"
[static] - - Defines the value of the type property of a releaseOutside event object.
-		MouseEvent
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
  RIGHT_CLICK : String = "rightClick"
[static] - - Defines the value of the type property of a rightClick event object.
-		MouseEvent
  RIGHT_MOUSE_DOWN : String = "rightMouseDown"
[static] - - Defines the value of the type property of a rightMouseDown event object.
-		MouseEvent
  RIGHT_MOUSE_UP : String = "rightMouseUp"
[static] - - Defines the value of the type property of a rightMouseUp event object.
-		MouseEvent
  ROLL_OUT : String = "rollOut"
[static] - - Defines the value of the type property of a rollOut event object.
-		MouseEvent
  ROLL_OVER : String = "rollOver"
[static] - - Defines the value of the type property of a rollOver event object.
-		MouseEvent
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
altKeyproperty
-
-altKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Indicates whether the Alt key is active (true) or inactive (false). - - Supported for Windows only. On other operating systems, this property is always set to false. - - -

Implementation -
-    public function get altKey():Boolean -
-    public function set altKey(value:Boolean):void -
-
- - - - - -
buttonDownproperty 
-
-buttonDown:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Indicates whether the primary mouse button is pressed (true) or not (false). - - -

Implementation -
-    public function get buttonDown():Boolean -
-    public function set buttonDown(value:Boolean):void -
-
- - - - - -
clickCountproperty 
-
-clickCount:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether or not the mouse down event is part of a multi-click sequence. - - This parameter will be zero for all mouse events other than MouseEvent.mouseDown, - - MouseEvent.mouseUp, MouseEvent.middleMouseDown, MouseEvent.middleMouseUp, - - MouseEvent.rightMouseDown, and MouseEvent.rightMouseUp. Listening - - for single clicks, double clicks, or any multi-click sequence is possible with the clickCount parameter. - - - For example, an initial MouseEvent.mouseDown and MouseEvent.mouseUp will have a - - clickCount of 1, and the second MouseEvent.mouseDown and MouseEvent.mouseUp - - in a double-click sequence will have a - - clickCount of 2. If the mouse moves sufficiently or the multi-click sequence is - - interrupted for some reason, then the next MouseEvent.mouseDown will have a clickCount of 1. - - - The doubleClick event will continue to fire as expected. - - -

Implementation -
-    public function get clickCount():int -
-
- - - - - -
commandKeyproperty 
-
-commandKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether the command key is activated (Mac only.) - - - -

The value of property commandKey - - will have the same value as property ctrlKey on the Mac. - - Always false on Windows or Linux.

- - - Implementation -
-    public function get commandKey():Boolean -
-    public function set commandKey(value:Boolean):void -
-
- - - - - -
controlKeyproperty 
-
-controlKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux. - - -

Implementation -
-    public function get controlKey():Boolean -
-    public function set controlKey(value:Boolean):void -
-
- - - - - -
ctrlKeyproperty 
-
-ctrlKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false). - - On Macintosh, indicates whether either the Control key or the Command key is activated. - - -

Implementation -
-    public function get ctrlKey():Boolean -
-    public function set ctrlKey(value:Boolean):void -
-
- - - - - -
deltaproperty 
-
-delta:int  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Indicates how many lines should be scrolled for each unit the user rotates the - - mouse wheel. A positive delta value indicates an upward scroll; a negative - - value indicates a downward scroll. Typical values are 1 to 3, but faster - - rotation may produce larger values. This setting depends on the device - - and operating system and is usually configurable by the user. This - - property applies only to the MouseEvent.mouseWheel event. - - -

Implementation -
-    public function get delta():int -
-    public function set delta(value:int):void -
-
- - - - - -
isRelatedObjectInaccessibleproperty 
-
-isRelatedObjectInaccessible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - If true, the relatedObject property is set to null for - - reasons related to security sandboxes. If the nominal value of relatedObject is a reference to a - - DisplayObject in another sandbox, relatedObject is set to - - null unless there is permission in both directions across this sandbox boundary. Permission is - - established by calling Security.allowDomain() from a SWF file, or by providing - - a policy file from the server of an image file, and setting the LoaderContext.checkPolicyFile - - property when loading the image. - - -

Implementation -
-    public function get isRelatedObjectInaccessible():Boolean -
-    public function set isRelatedObjectInaccessible(value:Boolean):void -
-

-See also -

-
-MouseEvent.relatedObject -
-Security.allowDomain() -
-LoaderContext.checkPolicyFile -
-
- - - - - -
localXproperty 
-
-localX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite. - - Disable mouse locking by setting Stage.mouseLock to false. - - -

When mouse locking is enabled, localX and localY are 0. - - Use movementX and movementY to determine the changes to mouse position - - when mouse locking is enabled.

- - - - Implementation -
-    public function get localX():Number -
-    public function set localX(value:Number):void -
-

-See also -

-
-flash.display.Stage.mouseLock -
-movementX -
-
-Example -

-
- - - - - -
localYproperty 
-
-localY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite. - - Disable mouse locking by setting Stage.mouseLock to false. - - -

When mouse locking is enabled, localX and localY are 0. - - Use movementX and movementY to determine the changes to mouse position - - when mouse locking is enabled.

- - - - Implementation -
-    public function get localY():Number -
-    public function set localY(value:Number):void -
-

-See also -

-
-flash.display.Stage.mouseLock -
-movementY -
-
-Example -

-
- - - - - -
movementXproperty 
-
-movementX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.2 - -
-

- - When mouse locking is enabled, the change in mouse position - - in the X direction since the last mouse event. - - Enable mouse locking by setting Stage.mouseLock to true. - - -

When mouse locking is enabled:

- - -
    - -
  • localX and localY contain 0.
    • - -
  • movementX and movementY contain delta values.
    • - -
  • movementX and movementY are never transformed based - - on stage transformation. That means they always remain in screen coordinates.
    • - -
- - - -

movementX and movementY are 0 when - - Stage.mouseLock is false.

- - - - Implementation -
-    public function get movementX():Number -
-    public function set movementX(value:Number):void -
-

-See also -

-
-flash.display.Stage.mouseLock -
-localX -
-
-Example -

-
- - - - - -
movementYproperty 
-
-movementY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.2 - -
-

- - When mouse locking is enabled, the change in mouse position - - in the Y direction since the last mouse event. - - Enable mouse locking by setting Stage.mouseLock to true. - - -

When mouse locking is enabled:

- - -
    - -
  • localX and localY contain 0.
    • - -
  • movementX and movementY contain delta values.
    • - -
  • movementX and movementY are never transformed based - - on stage transformation. That means they always remain in screen coordinates.
    • - -
- - - -

movementX and movementY are 0 when - - Stage.mouseLock is false.

- - - - Implementation -
-    public function get movementY():Number -
-    public function set movementY(value:Number):void -
-

-See also -

-
-flash.display.Stage.mouseLock -
-localY -
-
-Example -

-
- - - - - -
relatedObjectproperty 
-
-relatedObject:InteractiveObject  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A reference to a display list object that is related to the event. For example, when a mouseOut event occurs, - - relatedObject represents the display list object to which the pointing device now points. - - This property applies to the mouseOut, mouseOver, rollOut, and rollOver events. - -

The value of this property can be null in two circumstances: if there no related object, - - or there is a related object, but it is in a security sandbox to which you don't have access. - - Use the isRelatedObjectInaccessible() property to determine which of these reasons applies.

- - - Implementation -
-    public function get relatedObject():InteractiveObject -
-    public function set relatedObject(value:InteractiveObject):void -
-

-See also -

-
-MouseEvent.isRelatedObjectInaccessible -
-
- - - - - -
shiftKeyproperty 
-
-shiftKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Indicates whether the Shift key is active (true) or inactive - - (false). - - -

Implementation -
-    public function get shiftKey():Boolean -
-    public function set shiftKey(value:Boolean):void -
-
- - - - - -
stageXproperty 
-
-stageX:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The horizontal coordinate at which the event occurred in global Stage coordinates. - - This property is calculated when the localX property is set. - - -

Implementation -
-    public function get stageX():Number -
-
-Example -

-
- - - - - -
stageYproperty 
-
-stageY:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The vertical coordinate at which the event occurred in global Stage coordinates. - - This property is calculated when the localY property is set. - - -

Implementation -
-    public function get stageY():Number -
-
-Example -

-
- -
Constructor detail
- - - - - -
MouseEvent()constructor
-
-public function MouseEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, localX:Number, localY:Number, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0, commandKey:Boolean = false, controlKey:Boolean = false, clickCount:int = 0) -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates an Event object that contains information about mouse events. - - Event objects are passed as parameters to event listeners. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are: MouseEvent.CLICK, - - MouseEvent.DOUBLE_CLICK, MouseEvent.MOUSE_DOWN, - - MouseEvent.MOUSE_MOVE, MouseEvent.MOUSE_OUT, - - MouseEvent.MOUSE_OVER, MouseEvent.MOUSE_UP, - - MouseEvent.MIDDLE_CLICK, MouseEvent.MIDDLE_MOUSE_DOWN, MouseEvent.MIDDLE_MOUSE_UP, - - MouseEvent.RIGHT_CLICK, MouseEvent.RIGHT_MOUSE_DOWN, MouseEvent.RIGHT_MOUSE_UP, - - MouseEvent.MOUSE_WHEEL, MouseEvent.ROLL_OUT, and MouseEvent.ROLL_OVER. - - - -
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling phase of the event flow. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. - -
 
localX:Number — The horizontal coordinate at which the event occurred relative to the containing sprite. - -
 
localY:Number — The vertical coordinate at which the event occurred relative to the containing sprite. - -
 
relatedObject:InteractiveObject (default = null) — The complementary InteractiveObject instance that is affected by the event. For example, when a mouseOut event occurs, relatedObject represents the display list object to which the pointing device now points. - -
 
ctrlKey:Boolean (default = false) — On Windows or Linux, indicates whether the Ctrl key is activated. On Mac, indicates whether either the Ctrl key or the Command key is activated. - -
 
altKey:Boolean (default = false) — Indicates whether the Alt key is activated (Windows or Linux only). - -
 
shiftKey:Boolean (default = false) — Indicates whether the Shift key is activated. - -
 
buttonDown:Boolean (default = false) — Indicates whether the primary mouse button is pressed. - -
 
delta:int (default = 0) — Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are 1 to 3, but faster rotation may produce larger values. This parameter is used only for the MouseEvent.mouseWheel event. - -
 
commandKey:Boolean (default = false) — (AIR only) Indicates whether the Command key is activated (Mac only). This parameter is used only for the MouseEvent.click, - - MouseEvent.mouseDown, MouseEvent.mouseUp, MouseEvent.middleClick, MouseEvent.middleMouseDown, - - MouseEvent.middleMouseUp, MouseEvent.rightClick, MouseEvent.rightMouseDown, MouseEvent.rightMouseUp, - - and MouseEvent.doubleClick events. This parameter is for Adobe AIR only; do not set it for Flash Player content. - -
 
controlKey:Boolean (default = false) — (AIR only) Indicates whether the Control or Ctrl key is activated. This parameter is used only for the MouseEvent.click, - - MouseEvent.mouseDown, MouseEvent.mouseUp, MouseEvent.middleClick, MouseEvent.middleMouseDown, - - MouseEvent.middleMouseUp, MouseEvent.rightClick, MouseEvent.rightMouseDown, MouseEvent.rightMouseUp, - - and MouseEvent.doubleClick events. This parameter is for Adobe AIR only; do not set it for Flash Player content. - -
 
clickCount:int (default = 0) — (AIR only) Indicates whether or not the mouse event is part of a multi-click sequence. This parameter will be zero for all mouse events other than - - MouseEvent.mouseDown, MouseEvent.mouseUp, MouseEvent.middleMouseDown, MouseEvent.middleMouseUp, - - MouseEvent.rightMouseDown and MouseEvent.rightMouseUp. Listening for single clicks, double clicks, or any multi-click sequence - - is possible with the clickCount parameter. This parameter is for Adobe AIR only; do not set it for Flash Player content. - - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates a copy of the MouseEvent object and sets the value of each property to match that of the original. - - -

-Returns - - - - -
Event — - A new MouseEvent object with property values that match those of the original. - - - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a string that contains all the properties of the MouseEvent object. The string is in the following format: - -

[MouseEvent type=value bubbles=value cancelable=value ... delta=value]

- - -

-Returns - - - - -
String — - A string that contains all the properties of the MouseEvent object. - - - - - -
-
- - - - - -
updateAfterEvent()method 
-
-public function updateAfterEvent():void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified. - - -

- -
Constant detail
- - - - - -
CLICKconstant
-
-public static const CLICK:String = "click" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Defines the value of the type property of a click event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor click events, this value is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.click -
-
- - - - - -
CONTEXT_MENUconstant 
-
-public static const CONTEXT_MENU:String = "contextMenu" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The MouseEvent.CONTEXT_MENU constant defines the value of the - - type property of a contextMenu event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the right mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
DOUBLE_CLICKconstant 
-
-public static const DOUBLE_CLICK:String = "doubleClick" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Defines the value of the type property of a doubleClick event object. The doubleClickEnabled property - - must be true for an object to generate the doubleClick event. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor double-click events, this value is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.doubleClick -
-
- - - - - -
MIDDLE_CLICKconstant 
-
-public static const MIDDLE_CLICK:String = "middleClick" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Defines the value of the type property of a middleClick event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor middle-click events, this property is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.middleClick -
-
- - - - - -
MIDDLE_MOUSE_DOWNconstant 
-
-public static const MIDDLE_MOUSE_DOWN:String = "middleMouseDown" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Defines the value of the type property of a middleMouseDown event object. - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the middle mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - -

-See also -

-
-flash.display.InteractiveObject.middleMouseDown -
-
- - - - - -
MIDDLE_MOUSE_UPconstant 
-
-public static const MIDDLE_MOUSE_UP:String = "middleMouseUp" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Defines the value of the type property of a middleMouseUp event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the middle mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.middleMouseUp -
-
- - - - - -
MOUSE_DOWNconstant 
-
-public static const MOUSE_DOWN:String = "mouseDown" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Defines the value of the type property of a mouseDown event object. - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.mouseDown -
-
-Example -

-
- - - - - -
MOUSE_MOVEconstant 
-
-public static const MOUSE_MOVE:String = "mouseMove" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Defines the value of the type property of a mouseMove event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.mouseMove -
-
-Example -
The following example is a simple drawing program. The user can draw on the - main Sprite object or on a smaller rectangular Sprite object. - -

In the constructor, a rectangle innerRect Sprite object is created - and the line style is set to green. The line style for drawing on the - MouseEvent_MOUSE_MOVEExample Sprite container is set to red. Separate event - listeners for the MouseEvent.MOUSE_UP and MouseEvent.MOUSE_DOWN - events are added for the application's main Sprite object and innerRect - Sprite object. In both cases, the mouse down event listener methods move the current drawing - position to the mouse pointer's location and add a listener for the MouseEvent.MOUSE_MOVE - event. When the mouse pointer is moved, the invoked event listener methods follows the pointer and draw - a line using the graphics.LineTo() method. (Note: The innerRect - Sprite object obscures the red lines of the main Sprite object that are drawn behind the rectangle.) - When the MouseEvent.MOUSE_UP event occurs, the listener for the MOUSE_MOVE - event is removed and drawing is stopped.

- -
-
-package {
-    import flash.display.Sprite;
-	import flash.display.Graphics;
-	import flash.events.MouseEvent;
-
-	public class MouseEvent_MOUSE_MOVEExample extends Sprite {
-		private var innerRect:Sprite = new Sprite();
-		
-		public function MouseEvent_MOUSE_MOVEExample() {
-
-			graphics.lineStyle(3, 0xFF0000, 1);
-			stage.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
-			stage.addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);
-
-			innerRect.graphics.lineStyle(1, 0x00FF00, 1);
-			innerRect.graphics.beginFill(0xFFFFFF);
-			innerRect.graphics.drawRect(10, 10, 200, 200);
-			innerRect.graphics.endFill();
-			innerRect.addEventListener(MouseEvent.MOUSE_DOWN, innerRectMouseDownHandler);
-			innerRect.addEventListener(MouseEvent.MOUSE_UP, innerRectMouseUpHandler);
-			addChild(innerRect);
-		}
-
-		private function mouseDownHandler(event:MouseEvent):void {
-			graphics.moveTo(event.stageX, event.stageY);
-			stage.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
-		}
-	
-		private function mouseMoveHandler(event:MouseEvent):void {
-			graphics.lineTo(event.stageX, event.stageY);
-		}	
-	
-		private function mouseUpHandler(event:MouseEvent):void {
-			stage.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
-		}
-
-		private function innerRectMouseDownHandler(event:MouseEvent):void {
-			innerRect.graphics.moveTo(event.localX, event.localY);
-			innerRect.addEventListener(MouseEvent.MOUSE_MOVE, innerRectMouseMoveHandler);
-		}
-	
-		private function innerRectMouseMoveHandler(event:MouseEvent):void {
-			innerRect.graphics.lineTo(event.localX, event.localY);
-		}	
-	
-		private function innerRectMouseUpHandler(event:MouseEvent):void {
-			innerRect.removeEventListener(MouseEvent.MOUSE_MOVE, innerRectMouseMoveHandler);
-		}
-	}
-}
-
-

-
- - - - - -
MOUSE_OUTconstant 
-
-public static const MOUSE_OUT:String = "mouseOut" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Defines the value of the type property of a mouseOut event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
relatedObjectThe display list object to which the pointing device now points.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.mouseOut -
-
- - - - - -
MOUSE_OVERconstant 
-
-public static const MOUSE_OVER:String = "mouseOver" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Defines the value of the type property of a mouseOver event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
relatedObjectThe display list object to which the pointing device was pointing.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.mouseOver -
-
- - - - - -
MOUSE_UPconstant 
-
-public static const MOUSE_UP:String = "mouseUp" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Defines the value of the type property of a mouseUp event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.mouseUp -
-
-Example -

-
- - - - - -
MOUSE_WHEELconstant 
-
-public static const MOUSE_WHEEL:String = "mouseWheel" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Defines the value of the type property of a mouseWheel event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
deltaThe number of lines that that each notch on the mouse wheel represents.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.mouseWheel -
-
- - - - - -
MOUSE_WHEEL_HORIZONTALconstant 
-
-public static const MOUSE_WHEEL_HORIZONTAL:String = "mouseWheelHorizontal" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Defines the value of the type property of a mouseWheelHorizontal event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
deltaThe number of lines that that each notch on the mouse wheel represents.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - -

-See also -

-
-flash.display.InteractiveObject.mouseWheelHorizontal -
-
- - - - - -
RELEASE_OUTSIDEconstant 
-
-public static const RELEASE_OUTSIDE:String = "releaseOutside" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.3 - -
-

- - Defines the value of the type property of a releaseOutside event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownfalse
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject which pointing device button is pressed over previously and out from the instance and released. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.releaseOutside -
-
-Example -

-
- - - - - -
RIGHT_CLICKconstant 
-
-public static const RIGHT_CLICK:String = "rightClick" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Defines the value of the type property of a rightClick event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor right-click events, this property is always false.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.rightClick -
-
- - - - - -
RIGHT_MOUSE_DOWNconstant 
-
-public static const RIGHT_MOUSE_DOWN:String = "rightMouseDown" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Defines the value of the type property of a rightMouseDown event object. - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor right-click events, this property is always true.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - -

-See also -

-
-flash.display.InteractiveObject.rightMouseDown -
-
- - - - - -
RIGHT_MOUSE_UPconstant 
-
-public static const RIGHT_MOUSE_UP:String = "rightMouseUp" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Defines the value of the type property of a rightMouseUp event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the right mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.rightMouseUp -
-
- - - - - -
ROLL_OUTconstant 
-
-public static const ROLL_OUT:String = "rollOut" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Defines the value of the type property of a rollOut event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblesfalse
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
relatedObjectThe display list object to which the pointing device now points.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.rollOut -
-
- - - - - -
ROLL_OVERconstant 
-
-public static const ROLL_OVER:String = "rollOver" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Defines the value of the type property of a rollOver event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblesfalse
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
relatedObjectThe display list object to which the pointing device was pointing.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -

-See also -

-
-flash.display.InteractiveObject.rollOver -
-
- -
Examples
-
examples\MouseEventExample
-
The following example uses the MouseEventExample and - ChildSprite classes to show how mouse events are dispatched using a simple image. - This example carries out the following tasks: -
    -
  1. The example declares properties for the size (100 x 100 pixels) and the background color - (orange) for later use in drawing the square.
    2. -
  2. The constructor creates a new ChildSprite object child. Its constructor first - draws an orange 100 x 100 pixel square at coordinates (0,0) by calling its draw() - method and then adds seven event listeners/subscribers. -
      -
    • click/clickHandler(): Dispatched when the user single-clicks with the left mouse button - over the square.
      • -
    • doubleClick/doubleClickHandler(): Dispatched when the user double-clicks the left mouse button - over the square.
      • -
    • mouseDown/mouseDownHandler(): When the ChildSprite - object (the orange square) is clicked, a trace() message is printed to the screen, and then - ChildSprite.draw() is called, which draws a dark yellow square in place - of the light blue one drawn in mouseOverHandler(). The mouseDownHandler() method also adds a - mouseMoveevent listener and the mouseMoveHandler() subscriber (described below), - which processes the mouse moves. Then the startDrag() method is called, which - allows the Sprite object to be dragged.
      • -
    • mouseOut/mouseOutHandler(): Dispatched whenever the pointer leaves the - square area. The draw() method is called to return the square to its normal - size and color.
      • -
    • mouseOver/mouseOverHandler(): Dispatched when the mouse pointer is over the square. - This method redraws the square so that it is larger and its background color is dark yellow.
      • -
    • mouseUp/mouseUpHandler(): When the user releases the mouse button, the mouseMove - event listener is removed and stopDrag is called, which freezes the square in place.
      • -
    • mouseMove/mouseMoveHandler(): Called as part of the mouseDownHandler() function, and dispatched when the user is pressing the left mouse button and dragging the square.
      • -
    • mouseWheel/mouseWheelHandler(): Dispatched when the user rotates the mouse - wheel over the square.
      • -
    3. -
  3. The ChildSprite instance child is then added to the display list by means of - addChild(), which promptly draws the orange square.
    4. -
- -

Notes:

-
    -
  • The MouseEventExample class should be the document root.
    • -
  • Some of the event methods listed above declare a local variable sprite, which - is assigned the cast of event.target to type Sprite.
    • -
-
-
-package {
-	import flash.display.Sprite;
-
-	public class MouseEventExample extends Sprite {
-		private var size:uint = 100;
-		private var bgColor:uint = 0xFFCC00;
-
-		public function MouseEventExample() {
-			var child:ChildSprite = 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() {
-		draw(size, size, backgroundColor);
-            doubleClickEnabled = true;
-		addEventListener(MouseEvent.CLICK, clickHandler);
-		addEventListener(MouseEvent.DOUBLE_CLICK, doubleClickHandler);
-		addEventListener(MouseEvent.MOUSE_DOWN, mouseDownHandler);
-		addEventListener(MouseEvent.MOUSE_OUT, mouseOutHandler);
-		addEventListener(MouseEvent.MOUSE_OVER, mouseOverHandler);
-		addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);
-		addEventListener(MouseEvent.MOUSE_WHEEL, mouseWheelHandler);
-	}
-
-	private function draw(w:uint, h:uint, bgColor:uint):void {
-		graphics.clear();
-		graphics.beginFill(bgColor);
-		graphics.drawRect(0, 0, w, h);
-		graphics.endFill();
-	}
-
-	private function clickHandler(event:MouseEvent):void {
-		trace("clickHandler");
-	}
-
-	private function doubleClickHandler(event:MouseEvent):void {
-		trace("doubleClickHandler");
-	}
-
-	private function mouseDownHandler(event:MouseEvent):void {
-		trace("mouseDownHandler");
-		draw(overSize, overSize, downColor);
-
-		var sprite:Sprite = Sprite(event.target);
-		sprite.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
-		sprite.startDrag();
-	}
-
-	private function mouseMoveHandler(event:MouseEvent):void {
-		trace("mouseMoveHandler");
-		event.updateAfterEvent();
-	}
-
-	private function mouseOutHandler(event:MouseEvent):void {
-		trace("mouseOutHandler");
-		draw(size, size, backgroundColor);
-	}
-
-	private function mouseOverHandler(event:MouseEvent):void {
-		trace("mouseOverHandler");
-		draw(overSize, overSize, overColor);
-	}
-
-	private function mouseWheelHandler(event:MouseEvent):void {
-		trace("mouseWheelHandler delta: " + event.delta);
-	}
-
-	private function mouseUpHandler(event:MouseEvent):void {
-		trace("mouseUpHandler");
-		var sprite:Sprite = Sprite(event.target);
-		sprite.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
-		sprite.stopDrag();
-		draw(overSize, overSize, overColor);
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/NativeDragEvent.html b/html-docs/flash/events/NativeDragEvent.html deleted file mode 100644 index 3e8756b..0000000 --- a/html-docs/flash/events/NativeDragEvent.html +++ /dev/null @@ -1,1522 +0,0 @@ - - - - - - - - -flash.events.NativeDragEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class NativeDragEvent
InheritanceNativeDragEvent Inheritance MouseEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- Native drag events are dispatched by the interactive objects involved in a - drag-and-drop operation. - -

The initiating object dispatches:

-
    -
  • nativeDragStart — When the drag operation begins.
    • -
  • nativeDragUpdate — While the drag operation is in progress.
    • -
  • nativeDragComplete — When the user releases the dragged item (whether or not - the drop was accepted).
    • -
- -

The initiating object is the interactive object passed that is to the NativeDragManager object in the call - to NativeDragManager.doDrag() which began the drag operation.

- -

Potential target interactive objects dispatches:

-
    -
  • nativeDragEnter — When the drag gesture passes within the object boundary.
    • -
  • nativeDragOver — While the drag gesture remains within the object boundary.
    • -
  • nativeDragExit — When the drag gesture leaves the object boundary.
    • -
  • nativeDragDrop — When the user releases the dragged item over the object and the - object has accepted the drop with an earlier call to NativeDragManager.acceptDragDrop().
    • -
- -

Typically a handler for the nativeDragEnter or - nativeDragOver event evaluates the data being dragged, - along with the drag actions allowed, to determine whether an interactive object - can accept a drop. To specify that an interactive object is an eligible target, the - event handler must call the NativeDragManager.acceptDrop()function, - passing in a reference to the object. If the user releases - the mouse button over the designated object, the object becomes the drop target and dispatches - the nativeDragDrop event.

- -

Any InteractiveObject type object can be a drag initiator or a drop target.

- -

-

-See also -

-
-flash.desktop.NativeDragManager -
-flash.desktop.Clipboard -
-flash.desktop.NativeDragOptions -
-flash.desktop.NativeDragActions -
-flash.display.InteractiveObject -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  allowedActions : NativeDragOptions -
- The NativeDragOptions object specifying the actions that are allowed by the - display object that initiated this drag operation.
-		NativeDragEvent
 InheritedaltKey : Boolean -
- Indicates whether the Alt key is active (true) or inactive (false).
-		MouseEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 InheritedbuttonDown : Boolean -
- Indicates whether the primary mouse button is pressed (true) or not (false).
-		MouseEvent
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 InheritedclickCount : int -
- Indicates whether or not the mouse down event is part of a multi-click sequence.
-		MouseEvent
  clipboard : Clipboard -
- The Clipboard object containing the data in this drag operation.
-		NativeDragEvent
 InheritedcommandKey : Boolean -
- Indicates whether the command key is activated (Mac only.) - -

The value of property commandKey - will have the same value as property ctrlKey on the Mac.

-		MouseEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcontrolKey : Boolean -
- Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
-		MouseEvent
 InheritedctrlKey : Boolean -
- On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
-		MouseEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 Inheriteddelta : int -
- Indicates how many lines should be scrolled for each unit the user rotates the - mouse wheel.
-		MouseEvent
  dropAction : String -
- The current action.
-		NativeDragEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 InheritedisRelatedObjectInaccessible : Boolean -
- If true, the relatedObject property is set to null for - reasons related to security sandboxes.
-		MouseEvent
 InheritedlocalX : Number -
- When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.
-		MouseEvent
 InheritedlocalY : Number -
- When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.
-		MouseEvent
 InheritedmovementX : Number -
- When mouse locking is enabled, the change in mouse position - in the X direction since the last mouse event.
-		MouseEvent
 InheritedmovementY : Number -
- When mouse locking is enabled, the change in mouse position - in the Y direction since the last mouse event.
-		MouseEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 InheritedrelatedObject : InteractiveObject -
- A reference to a display list object that is related to the event.
-		MouseEvent
 InheritedshiftKey : Boolean -
- Indicates whether the Shift key is active (true) or inactive - (false).
-		MouseEvent
 InheritedstageX : Number -
- The horizontal coordinate at which the event occurred in global Stage coordinates.
-		MouseEvent
 InheritedstageY : Number -
- The vertical coordinate at which the event occurred in global Stage coordinates.
-		MouseEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NativeDragEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, localX:Number, localY:Number, relatedObject:InteractiveObject = null, clipboard:Clipboard = null, allowedActions:NativeDragOptions = null, dropAction:String = null, controlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false)
-
- Creates an Event object with specific information relevant to native drag-and-drop events.
-		NativeDragEvent
   -
-clone():Event -
-
- Creates a copy of this NativeDragEvent object.
-		NativeDragEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Formats the properties of this NativeDragEvent object as a string.
-		NativeDragEvent
 Inherited -
-updateAfterEvent():void -
-
- Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
-		MouseEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLICK : String = "click"
[static] - Defines the value of the type property of a click event object.
-		MouseEvent
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCONTEXT_MENU : String = "contextMenu"
[static] - The MouseEvent.CONTEXT_MENU constant defines the value of the - type property of a contextMenu event object.
-		MouseEvent
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedDOUBLE_CLICK : String = "doubleClick"
[static] - Defines the value of the type property of a doubleClick event object.
-		MouseEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMIDDLE_CLICK : String = "middleClick"
[static] - Defines the value of the type property of a middleClick event object.
-		MouseEvent
 InheritedMIDDLE_MOUSE_DOWN : String = "middleMouseDown"
[static] - Defines the value of the type property of a middleMouseDown event object.
-		MouseEvent
 InheritedMIDDLE_MOUSE_UP : String = "middleMouseUp"
[static] - Defines the value of the type property of a middleMouseUp event object.
-		MouseEvent
 InheritedMOUSE_DOWN : String = "mouseDown"
[static] - Defines the value of the type property of a mouseDown event object.
-		MouseEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedMOUSE_MOVE : String = "mouseMove"
[static] - Defines the value of the type property of a mouseMove event object.
-		MouseEvent
 InheritedMOUSE_OUT : String = "mouseOut"
[static] - Defines the value of the type property of a mouseOut event object.
-		MouseEvent
 InheritedMOUSE_OVER : String = "mouseOver"
[static] - Defines the value of the type property of a mouseOver event object.
-		MouseEvent
 InheritedMOUSE_UP : String = "mouseUp"
[static] - Defines the value of the type property of a mouseUp event object.
-		MouseEvent
 InheritedMOUSE_WHEEL : String = "mouseWheel"
[static] - Defines the value of the type property of a mouseWheel event object.
-		MouseEvent
 InheritedMOUSE_WHEEL_HORIZONTAL : String = "mouseWheelHorizontal"
[static] - Defines the value of the type property of a mouseWheelHorizontal event object.
-		MouseEvent
  NATIVE_DRAG_COMPLETE : String = "nativeDragComplete"
[static] - NativeDragEvent.NATIVE_DRAG_COMPLETE defines the value of the - type property of a nativeDragComplete event object.
-		NativeDragEvent
  NATIVE_DRAG_DROP : String = "nativeDragDrop"
[static] - NativeDragEvent.NATIVE_DRAG_DROP defines the value of the type - property of a nativeDragDrop event object.
-		NativeDragEvent
  NATIVE_DRAG_ENTER : String = "nativeDragEnter"
[static] - NativeDragEvent.NATIVE_DRAG_ENTER defines the value of the - type property of a nativeDragEnter event object.
-		NativeDragEvent
  NATIVE_DRAG_EXIT : String = "nativeDragExit"
[static] - NativeDragEvent.NATIVE_DRAG_EXIT defines the value of the type - property of a nativeDragExit event object.
-		NativeDragEvent
  NATIVE_DRAG_OVER : String = "nativeDragOver"
[static] - NativeDragEvent.NATIVE_DRAG_OVER defines the value of the type - property of a nativeDragOver event object.
-		NativeDragEvent
  NATIVE_DRAG_START : String = "nativeDragStart"
[static] - NativeDragEvent.NATIVE_DRAG_START defines the value of the type - property of a nativeDragStart event object.
-		NativeDragEvent
  NATIVE_DRAG_UPDATE : String = "nativeDragUpdate"
[static] - NativeDragEvent.NATIVE_DRAG_UPDATE defines the value of the - type property of a nativeDragUpdate event object.
-		NativeDragEvent
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedRELEASE_OUTSIDE : String = "releaseOutside"
[static] - Defines the value of the type property of a releaseOutside event object.
-		MouseEvent
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedRIGHT_CLICK : String = "rightClick"
[static] - Defines the value of the type property of a rightClick event object.
-		MouseEvent
 InheritedRIGHT_MOUSE_DOWN : String = "rightMouseDown"
[static] - Defines the value of the type property of a rightMouseDown event object.
-		MouseEvent
 InheritedRIGHT_MOUSE_UP : String = "rightMouseUp"
[static] - Defines the value of the type property of a rightMouseUp event object.
-		MouseEvent
 InheritedROLL_OUT : String = "rollOut"
[static] - Defines the value of the type property of a rollOut event object.
-		MouseEvent
 InheritedROLL_OVER : String = "rollOver"
[static] - Defines the value of the type property of a rollOver event object.
-		MouseEvent
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
allowedActionsproperty
-
-public var allowedActions:NativeDragOptions -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The NativeDragOptions object specifying the actions that are allowed by the - display object that initiated this drag operation. - -

-See also -

-
-flash.desktop.NativeDragOptions -
-
- - - - - -
clipboardproperty 
-
-public var clipboard:Clipboard -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Clipboard object containing the data in this drag operation. - -

If the object dispatching the event is not in the same security domain - as the initiating object, then the clipboard can be read only in the handler for - a nativeDragDrop event.

- -

-See also -

-
-flash.desktop.Clipboard -
-
- - - - - -
dropActionproperty 
-
-public var dropAction:String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The current action. In the nativeDragComplete event, the dropAction - property reports the final action. - -

- -
Constructor detail
- - - - - -
NativeDragEvent()constructor
-
-public function NativeDragEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, localX:Number, localY:Number, relatedObject:InteractiveObject = null, clipboard:Clipboard = null, allowedActions:NativeDragOptions = null, dropAction:String = null, controlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates an Event object with specific information relevant to native drag-and-drop events. - -

Event objects are passed as parameters to event listeners. Dispatching a native drag event - does not trigger the associated behavior.

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are: - NativeDragEvent.NATIVE_DRAG_START, - NativeDragEvent.NATIVE_DRAG_UPDATE, - NativeDragEvent.NATIVE_DRAG_ENTER, - NativeDragEvent.NATIVE_DRAG_OVER, - NativeDragEvent.NATIVE_DRAG_EXIT, - NativeDragEvent.NATIVE_DRAG_DROP, - and NativeDragEvent.NATIVE_DRAG_COMPLETE. - -
 
bubbles:Boolean (default = false) — Indicates whether the Event object participates in the bubbling phase of the event flow. -
 
cancelable:Boolean (default = true) — Indicates whether the Event object can be canceled. -
 
localX:Number — The horizontal coordinate at which the event occurred relative to the containing sprite. -
 
localY:Number — The vertical coordinate at which the event occurred relative to the containing sprite. -
 
relatedObject:InteractiveObject (default = null) — The related interactive display object. -
 
clipboard:Clipboard (default = null) — The Clipboard object containing the data to be transfered. -
 
allowedActions:NativeDragOptions (default = null) — The NativeDragOptions object defining the allowed actions (move, copy, and link). -
 
dropAction:String (default = null) — The current action. - -
 
controlKey:Boolean (default = false) — Indicates whether the Control key is activated. -
 
altKey:Boolean (default = false) — Indicates whether the Alt key is activated. -
 
shiftKey:Boolean (default = false) — Indicates whether the Shift key is activated. -
 
commandKey:Boolean (default = false) — Indicates whether the Command key is activated. - -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of this NativeDragEvent object. -

-Returns - - - - -
Event — - A new NativeDragEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Formats the properties of this NativeDragEvent object as a string. -

The string is in the following format:

-

[NativeDragEvent type=value bubbles=value cancelable=value ... commandKey=value]

- -

-Returns - - - - -
String — - The properties of this NativeDragEvent as a string. - - -
-
- -
Constant detail
- - - - - -
NATIVE_DRAG_COMPLETEconstant
-
-public static const NATIVE_DRAG_COMPLETE:String = "nativeDragComplete" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- NativeDragEvent.NATIVE_DRAG_COMPLETE defines the value of the - type property of a nativeDragComplete event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelablefalse; there is no default behavior to cancel.
clipboardThe Clipboard object containing the dragged data.
dropActionThe action chosen by the drop target (or none if no action was set).
- -

-See also -

-
-flash.display.InteractiveObject.nativeDragComplete -
-flash.desktop.NativeDragActions -
-
- - - - - -
NATIVE_DRAG_DROPconstant 
-
-public static const NATIVE_DRAG_DROP:String = "nativeDragDrop" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- NativeDragEvent.NATIVE_DRAG_DROP defines the value of the type - property of a nativeDragDrop event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelabletrue; canceling this event cancels the drag operation.
clipboardThe Clipboard object containing the dragged data. The clipboard can be read even if the object dispatching this event is not in the same security domain as the initiator.
dropActionThe action chosen by the drop target (or none if no action was set).
- -

-See also -

-
-flash.display.InteractiveObject.nativeDragDrop -
-
- - - - - -
NATIVE_DRAG_ENTERconstant 
-
-public static const NATIVE_DRAG_ENTER:String = "nativeDragEnter" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- NativeDragEvent.NATIVE_DRAG_ENTER defines the value of the - type property of a nativeDragEnter event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelablefalse; there is no default behavior to cancel.
clipboardThe Clipboard object containing the dragged data. The clipboard can be read only if the object dispatching this event is in the same security domain as the initiator.
dropActionThe action chosen by the drop target (or none if no action was set).
- -

-See also -

-
-flash.display.InteractiveObject.nativeDragEnter -
-
- - - - - -
NATIVE_DRAG_EXITconstant 
-
-public static const NATIVE_DRAG_EXIT:String = "nativeDragExit" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- NativeDragEvent.NATIVE_DRAG_EXIT defines the value of the type - property of a nativeDragExit event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelablefalse; there is no default behavior to cancel.
clipboardThe Clipboard object containing the dragged data. The clipboard can be read only if the object dispatching this event is in the same security domain as the initiator.
dropActionThe action chosen by the drop target (or none if no action was set).
- -

-See also -

-
-flash.display.InteractiveObject.nativeDragExit -
-
- - - - - -
NATIVE_DRAG_OVERconstant 
-
-public static const NATIVE_DRAG_OVER:String = "nativeDragOver" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- NativeDragEvent.NATIVE_DRAG_OVER defines the value of the type - property of a nativeDragOver event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelabletrue; canceling this event cancels the drag operation.
clipboardThe Clipboard object containing the dragged data. The clipboard can be read only if the object dispatching this event is in the same security domain as the initiator.
dropActionThe action chosen by the drop target (or none if no action was set).
- -

-See also -

-
-flash.display.InteractiveObject.nativeDragOver -
-
- - - - - -
NATIVE_DRAG_STARTconstant 
-
-public static const NATIVE_DRAG_START:String = "nativeDragStart" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- NativeDragEvent.NATIVE_DRAG_START defines the value of the type - property of a nativeDragStart event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelabletrue; canceling this event cancels the drag operation.
clipboardThe Clipboard object containing the dragged data.
dropActionThe action chosen by the drop target (or none if no action was set).
- -

-See also -

-
-flash.display.InteractiveObject.nativeDragStart -
-
- - - - - -
NATIVE_DRAG_UPDATEconstant 
-
-public static const NATIVE_DRAG_UPDATE:String = "nativeDragUpdate" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- NativeDragEvent.NATIVE_DRAG_UPDATE defines the value of the - type property of a nativeDragUpdate event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
allowedActionsThe NativeDragOptions object specifying the actions relevant to this drag operation.
bubblestrue
cancelablefalse; there is no default behavior to cancel.
clipboardThe Clipboard object containing the dragged data.
dropActionThe action chosen by the drop target (or none if no action was set).
- -

-See also -

-
-flash.display.InteractiveObject.nativeDragUpdate -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/NativeProcessExitEvent.html b/html-docs/flash/events/NativeProcessExitEvent.html deleted file mode 100644 index 3dd46dd..0000000 --- a/html-docs/flash/events/NativeProcessExitEvent.html +++ /dev/null @@ -1,829 +0,0 @@ - - - - - - - - -flash.events.NativeProcessExitEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class NativeProcessExitEvent
InheritanceNativeProcessExitEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- This event is dispatched by the NativeProcess object when the process exits. It is possible that - this event will never be dispatched. For example, if the child process outlives the AIR application that created it, - the event will not dispatch. -

-

-See also -

-
-flash.desktop.NativeProcess -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  exitCode : Number -
- The exit code that the native process returned to the host operating system when exiting.
-		NativeProcessExitEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NativeProcessExitEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, exitCode:Number)
-
- Creates a NativeProcessExitEvent which contains specific information regarding a NativeProcess's exit code -
-		NativeProcessExitEvent
   -
-clone():Event -
-
- Creates a copy of the NativeProcessExitEvent object and sets each property's value to match that of the original.
-		NativeProcessExitEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the NativeProcessExitEvent object.
-		NativeProcessExitEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
  EXIT : String = "exit"
[static] - Defines the value of the type property of a exit event object.
-		NativeProcessExitEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
exitCodeproperty
-
-exitCode:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The exit code that the native process returned to the host operating system when exiting. - If the AIR application terminates the process by calling the exit() - method of the NativeProcess object, the exitCode property is set to NaN. - NOTE: on windows operating systems if the process has not exited but the runtime is exiting or - an error occurred this value may be set to 259 (STILL_ACTIVE). To avoid confusion of this - condition, do not use 259 as a return code in a native process. -

Implementation -
-    public function get exitCode():Number -
-    public function set exitCode(value:Number):void -
-
- -
Constructor detail
- - - - - -
NativeProcessExitEvent()constructor
-
-public function NativeProcessExitEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, exitCode:Number) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a NativeProcessExitEvent which contains specific information regarding a NativeProcess's exit code -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event, accessible as Event.type. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage - of the event flow. The default value is false. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. The default values is false. -
 
exitCode:Number — Number that the process returned to the operating system during exit. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - AIR 2 -
-

- Creates a copy of the NativeProcessExitEvent object and sets each property's value to match that of the original. - -

-Returns - - - - -
Event — - A new NativeProcessExitEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - AIR 2 -
-

- Returns a string that contains all the properties of the NativeProcessExitEvent object. The string is in the following format: -

[NativeProcessExitEvent type=value bubbles=value cancelable=value exitCode=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the ProgressEvent object. - - -
-
- -
Constant detail
- - - - - -
EXITconstant
-
-public static const EXIT:String = "exit" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a exit event object. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/NativeWindowBoundsEvent.html b/html-docs/flash/events/NativeWindowBoundsEvent.html deleted file mode 100644 index c2a6914..0000000 --- a/html-docs/flash/events/NativeWindowBoundsEvent.html +++ /dev/null @@ -1,1041 +0,0 @@ - - - - - - - - -flash.events.NativeWindowBoundsEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class NativeWindowBoundsEvent
InheritanceNativeWindowBoundsEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A NativeWindow object dispatches a NativeWindowBoundsEvent object when the size or location - of the window changes. -

There are four types of events:

-
    -
  • NativeWindowBoundsEvent.MOVING
    • -
  • NativeWindowBoundsEvent.MOVE
    • -
  • NativeWindowBoundsEvent.RESIZING
    • -
  • NativeWindowBoundsEvent.RESIZE
    • -
-

-

-See also -

-
-flash.events.NativeWindowBoundsEvent.MOVING -
-flash.events.NativeWindowBoundsEvent.MOVE -
-flash.events.NativeWindowBoundsEvent.RESIZING -
-flash.events.NativeWindowBoundsEvent.RESIZE -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  afterBounds : Rectangle -
[read-only] - The bounds of the window after the change.
-		NativeWindowBoundsEvent
  beforeBounds : Rectangle -
[read-only] - The bounds of the window before the change.
-		NativeWindowBoundsEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NativeWindowBoundsEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, beforeBounds:Rectangle = null, afterBounds:Rectangle = null)
-
- Creates an Event object with specific information relevant to window bounds events.
-		NativeWindowBoundsEvent
   -
-clone():Event -
-
- Creates a copy of the NativeWindowBoundsEvent object and sets the value of each property - to match that of the original.
-		NativeWindowBoundsEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the NativeWindowBoundsEvent object.
-		NativeWindowBoundsEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
  MOVE : String = "move"
[static] - Defines the value of the type property of a move event object.
-		NativeWindowBoundsEvent
  MOVING : String = "moving"
[static] - Defines the value of the type property of a moving event object.
-		NativeWindowBoundsEvent
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
  RESIZE : String = "resize"
[static] - Defines the value of the type property of a resize event object.
-		NativeWindowBoundsEvent
  RESIZING : String = "resizing"
[static] - Defines the value of the type property of a resizing event object.
-		NativeWindowBoundsEvent
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
afterBoundsproperty
-
-afterBounds:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The bounds of the window after the change. - -

If the event is moving or resizing, the - bounds have not yet changed; afterBounds indicates the new bounds - if the event is not canceled. If the event is - move or resize, - afterBounds indicates the new bounds. -

- Implementation -
-    public function get afterBounds():Rectangle -
-
- - - - - -
beforeBoundsproperty 
-
-beforeBounds:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The bounds of the window before the change. - -

If the event is moving or resizing, the - bounds have not yet changed; beforeBounds reflects the current bounds. If the event is - move or resize, - beforeBounds indicates the original value. -

- Implementation -
-    public function get beforeBounds():Rectangle -
-
- -
Constructor detail
- - - - - -
NativeWindowBoundsEvent()constructor
-
-public function NativeWindowBoundsEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, beforeBounds:Rectangle = null, afterBounds:Rectangle = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates an Event object with specific information relevant to window bounds events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are: -
    -
  • NativeWindowBoundsEvent.MOVING
    • -
  • NativeWindowBoundsEvent.MOVE
    • -
  • NativeWindowBoundsEvent.RESIZING
    • -
  • NativeWindowBoundsEvent.RESIZE
    • -
-
 
bubbles:Boolean (default = false) — Indicates whether the Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Indicates whether the Event object can be canceled. -
 
beforeBounds:Rectangle (default = null) — Indicates the bounds before the most recent change or the pending change. -
 
afterBounds:Rectangle (default = null) — Indicates the bounds after the most recent change or the pending change. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the NativeWindowBoundsEvent object and sets the value of each property - to match that of the original. -

-Returns - - - - -
Event — - A new NativeWindowBoundsEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Returns a string that contains all the properties of the NativeWindowBoundsEvent object. The string has the following format: -

[NativeWindowBoundsEvent type=value bubbles=value cancelable=value previousDisplayState=value currentDisplayState=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the NativeWindowBoundsEvent object. - - -
-
- -
Constant detail
- - - - - -
MOVEconstant
-
-public static const MOVE:String = "move" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the value of the type property of a move event object. -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterBoundsThe new bounds of the window.
beforeBoundsThe old bounds of the window.
targetThe NativeWindow object that has just changed state. -
bubblesNo.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelablefalse; There is no default behavior to cancel.
- -

-See also -

-
-flash.display.NativeWindow -
-
- - - - - -
MOVINGconstant 
-
-public static const MOVING:String = "moving" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the value of the type property of a moving event object. -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterBoundsThe bounds of the window after the pending change.
beforeBoundsThe bounds of the window before the pending change.
bubblesNo.
cancelabletrue; cancelling the event will prevent the window move.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
targetThe NativeWindow object that has just changed state.
-

Note: On Linux, the preventDefault() method is not supported for this event.

- -

-See also -

-
-flash.display.NativeWindow -
-
- - - - - -
RESIZEconstant 
-
-public static const RESIZE:String = "resize" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the value of the type property of a resize event object. -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterBoundsThe new bounds of the window.
beforeBoundsThe old bounds of the window.
targetThe NativeWindow object that has just changed state. -
bubblesNo.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelablefalse; There is no default behavior to cancel.
-

-See also -

-
-flash.display.NativeWindow -
-
- - - - - -
RESIZINGconstant 
-
-public static const RESIZING:String = "resizing" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the value of the type property of a resizing event object. -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterBoundsThe bounds of the window after the pending change.
beforeBoundsThe bounds of the window before the pending change.
targetThe NativeWindow object that has just changed state. -
bubblesNo.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelabletrue; cancelling the event will prevent the window move.
- -

Note: On Linux, the preventDefault() method is not supported for this event.

- -

-See also -

-
-flash.display.NativeWindow -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/NativeWindowDisplayStateEvent.html b/html-docs/flash/events/NativeWindowDisplayStateEvent.html deleted file mode 100644 index b025742..0000000 --- a/html-docs/flash/events/NativeWindowDisplayStateEvent.html +++ /dev/null @@ -1,941 +0,0 @@ - - - - - - - - -flash.events.NativeWindowDisplayStateEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class NativeWindowDisplayStateEvent
InheritanceNativeWindowDisplayStateEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A NativeWindow object dispatches events of the NativeWindowDisplayStateEvent class when the window - display state changes. - There are two types of events: -
    -
  • NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING
    • -
  • NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGE
    • -
-

-

-See also -

-
-flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING -
-flash.events.NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGE -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  afterDisplayState : String -
[read-only] - The display state of the NativeWindow after the change.
-		NativeWindowDisplayStateEvent
  beforeDisplayState : String -
[read-only] - The display state of the NativeWindow before the change.
-		NativeWindowDisplayStateEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NativeWindowDisplayStateEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, beforeDisplayState:String = "", afterDisplayState:String = "")
-
- Creates an Event object with specific information relevant to window display state events.
-		NativeWindowDisplayStateEvent
   -
-clone():Event -
-
- Creates a copy of the NativeWindowDisplayStateEvent object and sets the - value of each property to match that of the original.
-		NativeWindowDisplayStateEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the NativeWindowDisplayStateEvent object.
-		NativeWindowDisplayStateEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
  DISPLAY_STATE_CHANGE : String = "displayStateChange"
[static] - Defines the value of the type property of a displayStateChange event object.
-		NativeWindowDisplayStateEvent
  DISPLAY_STATE_CHANGING : String = "displayStateChanging"
[static] - Defines the value of the type property of a displayStateChanging event object.
-		NativeWindowDisplayStateEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
afterDisplayStateproperty
-
-afterDisplayState:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The display state of the NativeWindow after the change. - -

If the event is displayStateChanging, the - display state has not yet changed; afterDisplayState indicates the new - display state if the event is not canceled. If the event is - displayStateChanged, afterDisplayState indicates the current value.

- Implementation -
-    public function get afterDisplayState():String -
-
- - - - - -
beforeDisplayStateproperty 
-
-beforeDisplayState:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The display state of the NativeWindow before the change. - -

If the event is displayStateChanging, the - display state has not yet changed; beforeDisplayState reflects the Window's - current display state. If the event is displayStateChanged, - beforeDisplayState indicates the previous value.

- Implementation -
-    public function get beforeDisplayState():String -
-
- -
Constructor detail
- - - - - -
NativeWindowDisplayStateEvent()constructor
-
-public function NativeWindowDisplayStateEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, beforeDisplayState:String = "", afterDisplayState:String = "") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates an Event object with specific information relevant to window display state events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are: -
    -
  • NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGING
    • -
  • NativeWindowDisplayStateEvent.DISPLAY_STATE_CHANGE
    • -
-
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be cancelled. -
 
beforeDisplayState:String (default = "") — The displayState before the change. -
 
afterDisplayState:String (default = "") — The displayState after the change. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the NativeWindowDisplayStateEvent object and sets the - value of each property to match that of the original. -

-Returns - - - - -
Event — - A new NativeWindowDisplayStateEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Returns a string that contains all the properties of the NativeWindowDisplayStateEvent object. The string has the following format: -

[NativeWindowDisplayStateEvent type=value bubbles=value cancelable=value beforeDisplayState=value afterDisplayState=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the NativeWindowDisplayStateEvent object. - - -
-
- -
Constant detail
- - - - - -
DISPLAY_STATE_CHANGEconstant
-
-public static const DISPLAY_STATE_CHANGE:String = "displayStateChange" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the value of the type property of a displayStateChange event object. -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterDisplayStateThe old display state of the window.
beforeDisplayStateThe new display state of the window.
targetThe NativeWindow instance that has just changed state. -
bubblesNo.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelablefalse; There is no default behavior to cancel.
- -

-See also -

-
-flash.display.NativeWindow -
-
- - - - - -
DISPLAY_STATE_CHANGINGconstant 
-
-public static const DISPLAY_STATE_CHANGING:String = "displayStateChanging" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the value of the type property of a displayStateChanging event object. - -

This event has the following properties:

- - - - - - - - -
PropertiesValues
afterDisplayStateThe display state of the window before the pending change.
beforeDisplayStateThe display state of the window after the pending change.
targetThe NativeWindow instance that has just changed state. -
bubblesNo.
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelabletrue; canceling the event will prevent the change.
- -

-See also -

-
-flash.display.NativeWindow -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/NetDataEvent.html b/html-docs/flash/events/NetDataEvent.html deleted file mode 100644 index 99c026f..0000000 --- a/html-docs/flash/events/NetDataEvent.html +++ /dev/null @@ -1,872 +0,0 @@ - - - - - - - - -flash.events.NetDataEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class NetDataEvent
InheritanceNetDataEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 2.7
-

-

-A NetStream object dispatches a NetDataEvent object when a data message is encountered in the media stream. -

A NetDataEvent is dispatched for the following messages:

-
    -
  • onCuePoint
    • -
  • onImageData
    • -
  • onMetaData
    • -
  • onPlayStatus (for code NetStream.Play.Complete)
    • -
  • onTextData
    • -
  • onXMPData
    • -
- -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  info : Object -
[read-only] - A data object describing the message.
-		NetDataEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
  timestamp : Number -
[read-only] - The timestamp of the data message in the media stream.
-		NetDataEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NetDataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, timestamp:Number = 0, info:Object = null)
-
- Creates an event object that contains information about media data events.
-		NetDataEvent
   -
-clone():Event -
-
- Creates a copy of an NetDataEvent object and sets the value of each property to match that of - the original.
-		NetDataEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the NetDataEvent object.
-		NetDataEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
  MEDIA_TYPE_DATA : String = "mediaTypeData"
[static] - The NetDataEvent.MEDIA_TYPE_DATA constant defines the value of the type property of the NetDataEvent object - dispatched when a data message in the media stream is encountered by the NetStream object.
-		NetDataEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
infoproperty
-
-info:Object  [read-only]

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- A data object describing the message. The info object has two properties: - info.handler and info.args. - info.handler is the handler name, such as "onMetaData" or "onXMPData". - info.args is an array of arguments. - -

Implementation -
-    public function get info():Object -
-
- - - - - -
timestampproperty 
-
-timestamp:Number  [read-only]

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- The timestamp of the data message in the media stream. -

Implementation -
-    public function get timestamp():Number -
-
- -
Constructor detail
- - - - - -
NetDataEvent()constructor
-
-public function NetDataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, timestamp:Number = 0, info:Object = null) -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.7 -
-

- Creates an event object that contains information about media data events. - Event objects are passed as parameters to Event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the - inherited type property. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling phase of the - event flow. Event listeners can access this information through the inherited - bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can - access this information through the inherited cancelable property. -
 
timestamp:Number (default = 0) — timestamp of the data message -
 
info:Object (default = null) — data message object -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.7 -
-

- Creates a copy of an NetDataEvent object and sets the value of each property to match that of - the original. - -

-Returns - - - - -
Event — - A new NetDataEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.7 -
-

- Returns a string that contains all the properties of the NetDataEvent object. The following - format is used: -

[NetDataEvent type=value bubbles=value cancelable=value - timestamp=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the NetMediaEvent object. - - -
-
- -
Constant detail
- - - - - -
MEDIA_TYPE_DATAconstant
-
-public static const MEDIA_TYPE_DATA:String = "mediaTypeData" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- The NetDataEvent.MEDIA_TYPE_DATA constant defines the value of the type property of the NetDataEvent object - dispatched when a data message in the media stream is encountered by the NetStream object. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/NetMonitorEvent.html b/html-docs/flash/events/NetMonitorEvent.html deleted file mode 100644 index 9e13123..0000000 --- a/html-docs/flash/events/NetMonitorEvent.html +++ /dev/null @@ -1,838 +0,0 @@ - - - - - - - - -flash.events.NetMonitorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class NetMonitorEvent
InheritanceNetMonitorEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

-

- A NetMonitor object dispatches NetMonitorEvent objects when a NetStream object is created. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  netStream : NetStream -
[read-only] - The new NetStream object.
-		NetMonitorEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NetMonitorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, netStream:NetStream = null)
-
- Creates an event object that contains information about netStreamCreate events.
-		NetMonitorEvent
   -
-clone():Event -
-
- Creates a copy of an NetMonitorEvent object and sets the value of each property to match that of - the original.
-		NetMonitorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the NetMonitorEvent object.
-		NetMonitorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
  NET_STREAM_CREATE : String = "netStreamCreate"
[static] - The NetMonitorEvent.NET_STREAM_CREATE constant defines the value of the type property of an netStreamCreate event object.
-		NetMonitorEvent
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
netStreamproperty
-
-netStream:NetStream  [read-only]

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- The new NetStream object. - -

Implementation -
-    public function get netStream():NetStream -
-
- -
Constructor detail
- - - - - -
NetMonitorEvent()constructor
-
-public function NetMonitorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, netStream:NetStream = null) -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.7 -
-

- Creates an event object that contains information about netStreamCreate events. - Event objects are passed as parameters to Event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the - inherited type property. There is only one type of event: - NetMonitorEvent.NET_STREAM_CREATE. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling phase of the - event flow. Event listeners can access this information through the inherited - bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can - access this information through the inherited cancelable property. -
 
netStream:NetStream (default = null) — The new NetStream object that has been created. Event listeners can access - this information through the netStream property. -
-

-See also -

-
-NetMonitorEvent.NET_STREAM_CREATE -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.7 -
-

- Creates a copy of an NetMonitorEvent object and sets the value of each property to match that of - the original. - -

-Returns - - - - -
Event — - A new NetMonitorEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.7 -
-

- Returns a string that contains all the properties of the NetMonitorEvent object. The following - format is used: -

[NetMonitorEvent type=value bubbles=value cancelable=value - netStream=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of NetMonitorEvent object. - - -
-
- -
Constant detail
- - - - - -
NET_STREAM_CREATEconstant
-
-public static const NET_STREAM_CREATE:String = "netStreamCreate" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- The NetMonitorEvent.NET_STREAM_CREATE constant defines the value of the type property of an netStreamCreate event object. -

The netStreamCreate event has the following properties:

- - - - - - - -
PropertyValue
netStreamNetStream object that has been created.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object beginning or ending a session.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/NetStatusEvent.html b/html-docs/flash/events/NetStatusEvent.html deleted file mode 100644 index 4ba0863..0000000 --- a/html-docs/flash/events/NetStatusEvent.html +++ /dev/null @@ -1,1340 +0,0 @@ - - - - - - - - -flash.events.NetStatusEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class NetStatusEvent
InheritanceNetStatusEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-A NetConnection, NetStream, or SharedObject object dispatches NetStatusEvent objects when a it reports its status. -There is only one type of status event: NetStatusEvent.NET_STATUS. -

-

-View the examples. -

-

-See also -

-
-flash.net.NetConnection -
-flash.net.NetStream -
-flash.net.SharedObject -
-NetStatusEvent.NET_STATUS -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  info : Object -
- An object with properties that describe the object's status or error condition.
-		NetStatusEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NetStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, info:Object = null)
-
- Creates an Event object that contains information about netStatus events.
-		NetStatusEvent
   -
-clone():Event -
-
- Creates a copy of the NetStatusEvent object and sets the value of each property to match that of the original.
-		NetStatusEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the NetStatusEvent object.
-		NetStatusEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
  NET_STATUS : String = "netStatus"
[static] - Defines the value of the type property of a netStatus event object.
-		NetStatusEvent
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
infoproperty
-
-info:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An object with properties that describe the object's status or error condition. -

The information object could have a code property containing a string - that represents a specific event or a level property containing a string - that is either "status" or "error".

-

The information object could also be something different. The code and - level properties might not work for some implementations and some servers - might send different objects.

-

P2P connections send messages to a NetConnection with a stream parameter - in the information object that indicates which NetStream the message pertains to.

-

For example, Flex Data Services sends Message - objects that cause coercion errors if you try to access the code or - level property.

-

The following table describes the possible string values of the code and level - properties.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Code propertyLevel propertyMeaning
"NetConnection.Call.BadVersion""error"Packet encoded in an unidentified format.
"NetConnection.Call.Failed""error"The NetConnection.call() method was not able to invoke the server-side - method or command.
"NetConnection.Call.Prohibited""error"An Action Message Format (AMF) operation is prevented for - security reasons. Either the AMF URL is not in the same domain as the file containing the code - calling the NetConnection.call() method, or the AMF server does not have a policy file - that trusts the domain of the the file containing the code calling the NetConnection.call() method.
"NetConnection.Connect.AppShutdown""error"The server-side application is shutting down.
"NetConnection.Connect.Closed""status"The connection was closed successfully.
"NetConnection.Connect.Failed""error"The connection attempt failed.
"NetConnection.Connect.IdleTimeout""status"Flash Media Server disconnected the client because the client was idle longer than the configured value for <MaxIdleTime>. On Flash Media Server, <AutoCloseIdleClients> is disabled by default. When enabled, the default timeout value is 3600 seconds (1 hour). For more information, see - Close idle connections.
"NetConnection.Connect.InvalidApp""error"The application name specified in the call to NetConnection.connect() is invalid.
"NetConnection.Connect.NetworkChange""status"

Flash Player has detected a network change, for example, a dropped wireless connection, a successful wireless connection,or a network cable loss.

-

Use this event to check for a network interface change. Don't use this event to implement your NetConnection reconnect logic. Use "NetConnection.Connect.Closed" to implement your NetConnection reconnect logic.

"NetConnection.Connect.Rejected""error"The connection attempt did not have permission to access the application.
"NetConnection.Connect.Success""status"The connection attempt succeeded.
"NetGroup.Connect.Failed""error"The NetGroup connection attempt failed. The info.group property indicates which NetGroup failed.
"NetGroup.Connect.Rejected""error"The NetGroup is not authorized to function. The info.group property indicates which NetGroup was denied.
"NetGroup.Connect.Success""status"The NetGroup is successfully constructed and authorized to function. The info.group property indicates which NetGroup has succeeded.
"NetGroup.LocalCoverage.Notify""status"Sent when a portion of the group address space for which this node is responsible changes.
"NetGroup.MulticastStream.PublishNotify""status"Sent when a new named stream is detected in NetGroup's Group. The info.name:String property is the name of the detected stream.
"NetGroup.MulticastStream.UnpublishNotify""status"Sent when a named stream is no longer available in the Group. The info.name:String property is name of the stream which has disappeared.
"NetGroup.Neighbor.Connect""status"Sent when a neighbor connects to this node. The info.neighbor:String property is the group address of the neighbor. The info.peerID:String property is the peer ID of the neighbor.
"NetGroup.Neighbor.Disconnect""status"Sent when a neighbor disconnects from this node. The info.neighbor:String property is the group address of the neighbor. The info.peerID:String property is the peer ID of the neighbor.
"NetGroup.Posting.Notify""status"Sent when a new Group Posting is received. The info.message:Object property is the message. The info.messageID:String property is this message's messageID.
"NetGroup.Replication.Fetch.Failed""status"Sent when a fetch request for an object (previously announced with NetGroup.Replication.Fetch.SendNotify) fails or is denied. A new attempt for the object will be made if it is still wanted. The info.index:Number property is the index of the object that had been requested.
"NetGroup.Replication.Fetch.Result""status"Sent when a fetch request was satisfied by a neighbor. The info.index:Number property is the object index of this result. The info.object:Object property is the value of this object. This index will automatically be removed from the Want set. If the object is invalid, this index can be re-added to the Want set with NetGroup.addWantObjects().
"NetGroup.Replication.Fetch.SendNotify""status"Sent when the Object Replication system is about to send a request for an object to a neighbor.The info.index:Number property is the index of the object that is being requested.
"NetGroup.Replication.Request""status"Sent when a neighbor has requested an object that this node has announced with NetGroup.addHaveObjects(). This request must eventually be answered with either NetGroup.writeRequestedObject() or NetGroup.denyRequestedObject(). Note that the answer may be asynchronous. The info.index:Number property is the index of the object that has been requested. The info.requestID:int property is the ID of this request, to be used by NetGroup.writeRequestedObject() or NetGroup.denyRequestedObject().
"NetGroup.SendTo.Notify""status"Sent when a message directed to this node is received. The info.message:Object property is the message. The info.from:String property is the groupAddress from which the message was received. The info.fromLocal:Boolean property is TRUE if the message was sent by this node (meaning the local node is the nearest to the destination group address), and FALSE if the message was received from a different node. To implement recursive routing, the message must be resent with NetGroup.sendToNearest() if info.fromLocal is FALSE.
"NetStream.Buffer.Empty""status"Flash Player is not receiving data quickly enough to fill the buffer. Data flow is interrupted until the buffer refills, at which time a NetStream.Buffer.Full message is sent and the stream begins playing again.
"NetStream.Buffer.Flush""status"Data has finished streaming, and the remaining buffer is emptied. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Buffer.Full""status"The buffer is full and the stream begins playing.
"NetStream.Connect.Closed""status"The P2P connection was closed successfully. The info.stream property indicates which stream has closed. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Connect.Failed""error"The P2P connection attempt failed. The info.stream property indicates which stream has failed. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Connect.Rejected""error"The P2P connection attempt did not have permission to access the other peer. The info.stream property indicates which stream was rejected. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Connect.Success""status"The P2P connection attempt succeeded. The info.stream property indicates which stream has succeeded. Note: Not supported in AIR 3.0 for iOS.
"NetStream.DRM.UpdateNeeded""status"A NetStream object is attempting to play protected content, but the required - Flash Access module is either not present, not permitted by the effective content policy, - or not compatible with the current player. To update the module or player, use the - update() method of flash.system.SystemUpdater. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Failed""error"(Flash Media Server) - An error has occurred for a reason other than those listed - in other event codes.
"NetStream.MulticastStream.Reset""status"A multicast subscription has changed focus to a different stream published with the same name in the same group. Local overrides of multicast stream parameters are lost. Reapply the local overrides or the new stream's default parameters will be used.
"NetStream.Pause.Notify""status"The stream is paused.
"NetStream.Play.Failed""error"An error has occurred in playback for a reason other than those listed elsewhere - in this table, such as the subscriber not having read access. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Play.FileStructureInvalid""error"(AIR and Flash Player 9.0.115.0) The application detects an invalid file structure and will not try to play this type of file. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Play.InsufficientBW""warning"(Flash Media Server) - The client does not have sufficient bandwidth to play - the data at normal speed. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Play.NoSupportedTrackFound""status"(AIR and Flash Player 9.0.115.0) The application does not detect any supported tracks (video, audio or data) and will not try to play the file. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Play.PublishNotify""status"The initial publish to a stream is sent to all subscribers.
"NetStream.Play.Reset""status"Caused by a play list reset. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Play.Start""status"Playback has started.
"NetStream.Play.Stop""status"Playback has stopped.
"NetStream.Play.StreamNotFound""error"The file passed to the NetStream.play() method can't be found.
"NetStream.Play.Transition""status"(Flash Media Server 3.5) The server received the command to transition to another stream as a result of bitrate stream switching. This code indicates a success status event for the NetStream.play2() call to initiate a stream switch. If the switch does not succeed, the server sends a NetStream.Play.Failed event instead. - When the stream switch occurs, an onPlayStatus event with a code of "NetStream.Play.TransitionComplete" is dispatched. For Flash Player 10 and later. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Play.UnpublishNotify""status"An unpublish from a stream is sent to all subscribers.
"NetStream.Publish.BadName""error"Attempt to publish a stream which is already being published by someone else.
"NetStream.Publish.Idle""status"The publisher of the stream is idle and not transmitting data.
"NetStream.Publish.Start""status"Publish was successful.
"NetStream.Record.AlreadyExists""status"The stream being recorded maps to a file that is already being recorded to by another stream. This can happen due to misconfigured virtual directories.
"NetStream.Record.Failed""error"An attempt to record a stream failed.
"NetStream.Record.NoAccess""error"Attempt to record a stream that is still playing or the client has no access right.
"NetStream.Record.Start""status"Recording has started.
"NetStream.Record.Stop""status"Recording stopped.
"NetStream.SecondScreen.Start""status"Sent when the PlayTo session starts. The description field attached to this event will contain the name of the device that will be getting the video. Applies only to Windows 8.1, IE11, modern mode.
"NetStream.SecondScreen.Stop""status"Sent when the PlayTo session ends. Applies only to Windows 8.1, IE11, modern mode.
"NetStream.Seek.Failed""error"The seek fails, which happens if the stream is not seekable.
"NetStream.Seek.InvalidTime""error"For video downloaded progressively, the user has tried to seek or play - past the end of the video data that has downloaded thus far, or past - the end of the video once the entire file has downloaded. The info.details property of the event object contains a time code - that indicates the last valid position to which the user can seek.
"NetStream.Seek.Notify""status"

The seek operation is complete.

-

Sent when NetStream.seek() is called on a stream in AS3 NetStream Data Generation Mode. The info object is extended to include info.seekPoint which is the same value passed to NetStream.seek().

"NetStream.Step.Notify""status"The step operation is complete. Note: Not supported in AIR 3.0 for iOS.
"NetStream.Unpause.Notify""status"The stream is resumed.
"NetStream.Unpublish.Success""status"The unpublish operation was successfuul.
"SharedObject.BadPersistence""error"A request was made for a shared object with persistence flags, but the request cannot be granted because the object has already been created with different flags.
"SharedObject.Flush.Failed""error"The "pending" status is resolved, but the SharedObject.flush() failed.
"SharedObject.Flush.Success""status"The "pending" status is resolved and the SharedObject.flush() call succeeded.
"SharedObject.UriMismatch""error"An attempt was made to connect to a NetConnection object that has a different URI (URL) than the shared object.
"NetStream.Video.DimensionChange""status"The video dimensions are available or have changed. Use the Video or StageVideo videoWidth/videoHeight property to query the new video dimensions. - New in Flash Player 11.4/AIR 3.4.
-

If you consistently see errors regarding the buffer, try changing the buffer using the NetStream.bufferTime property.

- - Implementation -
-    public function get info():Object -
-    public function set info(value:Object):void -
-

-See also -

-
-NetConnection class -
-NetStream class -
-NetGroup class -
-
-Example -
The following example shows an event handler function - that tests for the "NetStream.Seek.InvalidTime" error. - The "NetStream.Seek.InvalidTime" error - happens when the user attempts to seek beyond the end of the downloaded stream. The example - tests the value of the event object's info.code property. In case the error occurs, - the eventObj.info.details property is assigned to a variable - to use as a parameter for the stream's seek() method. The eventObj.info.details - contains the last valid position available to handle the error. So, the user goes to a valid location - at the end of the downloaded stream. -
-
-function videoStatus(eventObj:NetStatusEvent):Void
-{
-    switch(eventObj.info.code)
-	{
-		case "NetStream.Seek.InvalidTime":
-		{
-			var validSeekTime:Number = eventObj.info.details;
-			nStream.seek(validSeekTime);
-			break;
-		}
-	}
-}
-
-

-
- -
Constructor detail
- - - - - -
NetStatusEvent()constructor
-
-public function NetStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, info:Object = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates an Event object that contains information about netStatus events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of status event: NetStatusEvent.NET_STATUS. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
info:Object (default = null) — An object containing properties that describe the object's status. Event listeners can access this object through the info property. -
-

-See also -

-
-flash.events.NetStatusEvent.NET_STATUS -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a copy of the NetStatusEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new NetStatusEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the NetStatusEvent object. The string is in the following format: -

[NetStatusEvent type=value bubbles=value cancelable=value info=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the NetStatusEvent object. - - - -
-
- -
Constant detail
- - - - - -
NET_STATUSconstant
-
-public static const NET_STATUS:String = "netStatus" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a netStatus event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
infoAn object with properties that describe the object's status or error condition.
targetThe NetConnection or NetStream object reporting its status.
-

-See also -

-
-flash.events.NetStatusEvent.info -
-flash.net.NetConnection.netStatus -
-flash.net.NetStream.netStatus -
-flash.net.SharedObject.netStatus -
-
- -
Examples
-
examples\NetStatusEventExample
-
The following example uses a Video object with the NetConnection and - NetStream classes to load and play an FLV file. - -

In this example, the netStatusHandler method is registered as a listener for - the NetStatusEvent event NetConnection.netStatus. - When the status (success or failure) of the NetConnection.connect() attempt - is determined, the netStatus event triggers this method. If the - attempt to connect to the NetConnection object is successful (in other words, - if the info property of the NetStatusEvent object dispatched by the netStatus - event has a code property that indicates success), the code creates the Video and NetStream - objects and calls the Video.attachNetStream() and NetStream.play() methods.

- -

Note: To run this example, you need an FLV file - whose name and location match the variable passed to videoURL; - in this case, an FLV file called Video.flv that is in the same directory as the SWF file.

-
-
-
- package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.media.Video;
-    import flash.net.NetConnection;
-    import flash.net.NetStream;
-
-    public class NetStatusEventExample extends Sprite {
-        private var videoURL:String = "Video.flv";
-        private var connection:NetConnection;
-        private var stream:NetStream;
-
-        public function NetStatusEventExample() {
-            connection = new NetConnection();
-            connection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            connection.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            connection.connect(null);
-        }
-
-        private function netStatusHandler(event:NetStatusEvent):void {
-            switch (event.info.code) {
-                case "NetConnection.Connect.Success":
-                    connectStream();
-                    break;
-                case "NetStream.Play.StreamNotFound":
-                    trace("Unable to locate video: " + videoURL);
-                    break;
-            }
-        }
-
-        private function connectStream():void {
-            var stream:NetStream = new NetStream(connection);
-            stream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            stream.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler);
-            var video:Video = new Video();
-            video.attachNetStream(stream);
-            stream.play(videoURL);
-            addChild(video);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-        
-        private function asyncErrorHandler(event:AsyncErrorEvent):void {
-            // ignore AsyncErrorEvent events.
-        }
-
-    }
- }
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/OutputProgressEvent.html b/html-docs/flash/events/OutputProgressEvent.html deleted file mode 100644 index 4bc050e..0000000 --- a/html-docs/flash/events/OutputProgressEvent.html +++ /dev/null @@ -1,885 +0,0 @@ - - - - - - - - -flash.events.OutputProgressEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class OutputProgressEvent
InheritanceOutputProgressEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A FileStream object dispatches OutputProgressEvent objects as pending asynchronous file write operations are - performed. There is one type of output progress event: OutputProgressEvent.OUTPUT_PROGRESS. - -

-

-See also -

-
-flash.filesystem.FileStream -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
  bytesPending : Number -
- The number of bytes not yet written when the listener processes the event.
-		OutputProgressEvent
  bytesTotal : Number -
- The total number of bytes written so far, plus the number of pending bytes to be written.
-		OutputProgressEvent
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-OutputProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesPending:Number = 0, bytesTotal:Number = 0)
-
- Creates an Event object that contains information about output progress events.
-		OutputProgressEvent
   -
-clone():Event -
-
- Creates a copy of the OutputProgressEvent object and sets each property's value to match that of the original.
-		OutputProgressEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the OutputProgressEvent object.
-		OutputProgressEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
  OUTPUT_PROGRESS : String = "outputProgress"
[static] - Defines the value of the type property of an outputProgress event object.
-		OutputProgressEvent
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
bytesPendingproperty
-
-bytesPending:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The number of bytes not yet written when the listener processes the event. - -

Implementation -
-    public function get bytesPending():Number -
-    public function set bytesPending(value:Number):void -
-
- - - - - -
bytesTotalproperty 
-
-bytesTotal:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The total number of bytes written so far, plus the number of pending bytes to be written. - -

Implementation -
-    public function get bytesTotal():Number -
-    public function set bytesTotal(value:Number):void -
-
- -
Constructor detail
- - - - - -
OutputProgressEvent()constructor
-
-public function OutputProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesPending:Number = 0, bytesTotal:Number = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates an Event object that contains information about output progress events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. There is only one type of error event: - OutputProgressEvent.OUTPUT_PROGRESS. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
 
bytesPending:Number (default = 0) — The number of bytes not yet written. -
 
bytesTotal:Number (default = 0) — The total number of bytes written or with pending writes. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the OutputProgressEvent object and sets each property's value to match that of the original. - -

-Returns - - - - -
Event — - A new OutputProgressEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Returns a string that contains all the properties of the OutputProgressEvent object. The string is in the following format: - -

[OutputProgressEvent type=value bubbles=value cancelable=value eventPhase=value bytesPending=value bytesTotal=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the OutputProgressEvent object. - - -
-
- -
Constant detail
- - - - - -
OUTPUT_PROGRESSconstant
-
-public static const OUTPUT_PROGRESS:String = "outputProgress" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Defines the value of the type property of an outputProgress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesPendingThe number of bytes remaining to be written at the time the - listener processes the event.
bytesTotalThe total number of bytes that ultimately - will be written if the write process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe FileStream object reporting progress.
- -

-See also -

-
-flash.filesystem.FileStream -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/PermissionEvent.html b/html-docs/flash/events/PermissionEvent.html deleted file mode 100644 index cf8e64f..0000000 --- a/html-docs/flash/events/PermissionEvent.html +++ /dev/null @@ -1,780 +0,0 @@ - - - - - - - - -flash.events.PermissionEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic final class PermissionEvent
InheritancePermissionEvent Inheritance Event Inheritance Object
-

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  status : String -
[read-only] - Check whether the permission has been granted or denied.
-		PermissionEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-PermissionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = "denied")
-
- Creates an PermissionEvent object that contains information about the name of the permission and its status.
-		PermissionEvent
   -
-clone():Event -
-
- Creates a copy of an PermissionEvent object and sets the value of each property to match that of - the original.
-		PermissionEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the PermissionEvent object.
-		PermissionEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
  PERMISSION_STATUS : String = "permissionStatus"
[static]
-		PermissionEvent
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
statusproperty
-
-status:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Check whether the permission has been granted or denied. -

Implementation -
-    public function get status():String -
-

-See also -

-
flash.events.PermissionStatus.GRANTED
flash.events.PermissionStatus.DENIED
-
- -
Constructor detail
- - - - - -
PermissionEvent()constructor
-
-public function PermissionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = "denied") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Creates an PermissionEvent object that contains information about the name of the permission and its status. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
status:String (default = "denied")
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Creates a copy of an PermissionEvent object and sets the value of each property to match that of - the original. -

-Returns - - - - -
Event — - A new PermissionEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Returns a string that contains all the properties of the PermissionEvent object. The following - format is used: -

[PermissionEvent type=value bubbles=value cancelable=value - permission=value status=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the PermissionEvent object. - - -
-
- -
Constant detail
- - - - - -
PERMISSION_STATUSconstant
-
-public static const PERMISSION_STATUS:String = "permissionStatus" -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/PressAndTapGestureEvent.html b/html-docs/flash/events/PressAndTapGestureEvent.html deleted file mode 100644 index e5125ac..0000000 --- a/html-docs/flash/events/PressAndTapGestureEvent.html +++ /dev/null @@ -1,1171 +0,0 @@ - - - - - - - - -flash.events.PressAndTapGestureEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class PressAndTapGestureEvent
InheritancePressAndTapGestureEvent Inheritance GestureEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The PressAndTapGestureEvent class lets you handle press-and-tap gesture on touch-enabled devices. - Objects that inherit properties from the InteractiveObject class capture the primary touch point - (press) and a secondary point (tap) in the dispatched event object. - The press-and-tap gesture is typically used to raise a context-sensitive popup menu. -

-

-View the examples. -

-

-See also -

-
-flash.ui.Multitouch -
-flash.display.InteractiveObject -
-flash.events.TouchEvent -
-flash.events.GestureEvent -
-flash.events.MouseEvent -
-flash.events.EventDispatcher.addEventListener() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaltKey : Boolean -
- Indicates whether the Alt key is active (true) or inactive (false).
-		GestureEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 InheritedcommandKey : Boolean -
- Indicates whether the command key is activated (Mac only).
-		GestureEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcontrolKey : Boolean -
- Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
-		GestureEvent
 InheritedctrlKey : Boolean -
- On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
-		GestureEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 InheritedlocalX : Number -
- The horizontal coordinate at which the event occurred relative to the containing sprite.
-		GestureEvent
 InheritedlocalY : Number -
- The vertical coordinate at which the event occurred relative to the containing sprite.
-		GestureEvent
 Inheritedphase : String -
- A value from the GesturePhase class indicating the progress of the touch gesture.
-		GestureEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 InheritedshiftKey : Boolean -
- Indicates whether the Shift key is active (true) or inactive - (false).
-		GestureEvent
 InheritedstageX : Number -
- The horizontal coordinate at which the event occurred in global Stage coordinates.
-		GestureEvent
 InheritedstageY : Number -
- The vertical coordinate at which the event occurred in global Stage coordinates.
-		GestureEvent
  tapLocalX : Number -
- The horizontal coordinate at which the event occurred relative to the containing interactive object.
-		PressAndTapGestureEvent
  tapLocalY : Number -
- The vertical coordinate at which the event occurred relative to the containing interactive object.
-		PressAndTapGestureEvent
  tapStageX : Number -
[read-only] - The horizontal coordinate at which the tap touch occurred in global Stage coordinates.
-		PressAndTapGestureEvent
  tapStageY : Number -
[read-only] - The vertical coordinate at which the tap touch occurred in global Stage coordinates.
-		PressAndTapGestureEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-PressAndTapGestureEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, phase:String = null, localX:Number = 0, localY:Number = 0, tapLocalX:Number = 0, tapLocalY:Number = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false)
-
- Creates an Event object that contains information about complex multi-touch events, such as - a user raising a context-sensitive popup menu.
-		PressAndTapGestureEvent
   -
-clone():Event -
-
- Creates a copy of the PressAndTapGestureEvent object and sets the value of each property to match that of the original.
-		PressAndTapGestureEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the PressAndTapGestureEvent object.
-		PressAndTapGestureEvent
 Inherited -
-updateAfterEvent():void -
-
- Refreshes the Flash runtime display after processing the gesture event, in case the display list has been modified by the event handler.
-		GestureEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
  GESTURE_PRESS_AND_TAP : String = "gesturePressAndTap"
[static] - Defines the value of the type property of a GESTURE_PRESS_AND_TAP touch event object.
-		PressAndTapGestureEvent
 InheritedGESTURE_TWO_FINGER_TAP : String = "gestureTwoFingerTap"
[static] - Defines the value of the type property of a GESTURE_TWO_FINGER_TAP gesture event object.
-		GestureEvent
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
tapLocalXproperty
-
-tapLocalX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

- The horizontal coordinate at which the event occurred relative to the containing interactive object. -

Implementation -
-    public function get tapLocalX():Number -
-    public function set tapLocalX(value:Number):void -
-
- - - - - -
tapLocalYproperty 
-
-tapLocalY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

- The vertical coordinate at which the event occurred relative to the containing interactive object. -

Implementation -
-    public function get tapLocalY():Number -
-    public function set tapLocalY(value:Number):void -
-
- - - - - -
tapStageXproperty 
-
-tapStageX:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The horizontal coordinate at which the tap touch occurred in global Stage coordinates. - This property is calculated when the tapLocalX property is set. -

Implementation -
-    public function get tapStageX():Number -
-
- - - - - -
tapStageYproperty 
-
-tapStageY:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The vertical coordinate at which the tap touch occurred in global Stage coordinates. - This property is calculated when the tapLocalX property is set. -

Implementation -
-    public function get tapStageY():Number -
-
- -
Constructor detail
- - - - - -
PressAndTapGestureEvent()constructor
-
-public function PressAndTapGestureEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, phase:String = null, localX:Number = 0, localY:Number = 0, tapLocalX:Number = 0, tapLocalY:Number = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates an Event object that contains information about complex multi-touch events, such as - a user raising a context-sensitive popup menu. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event: PressAndTapGestureEvent.GESTURE_PRESS_AND_TAP. - -
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling phase of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
 
phase:String (default = null) — This values tracks the beginning, progress, and end of a touch gesture. Possible values are: GesturePhase.BEGIN, - GesturePhase.END, GesturePhase.UPDATE, or GesturePhase.ALL. -
 
localX:Number (default = 0) — The horizontal coordinate at which the event occurred relative to the containing display object. -
 
localY:Number (default = 0) — The vertical coordinate at which the event occurred relative to the containing display object. -
 
tapLocalX:Number (default = 0) — The horizontal coordinate at which the event occurred relative to the containing interactive object. -
 
tapLocalY:Number (default = 0) — The vertical coordinate at which the event occurred relative to the containing interactive object. -
 
ctrlKey:Boolean (default = false) — On Windows or Linux, indicates whether the Ctrl key is activated. On Mac, indicates whether either the Ctrl key or the Command key is activated. -
 
altKey:Boolean (default = false) — Indicates whether the Alt key is activated (Windows or Linux only). -
 
shiftKey:Boolean (default = false) — Indicates whether the Shift key is activated. -
 
commandKey:Boolean (default = false) — (AIR only) Indicates whether the Command key is activated (Mac only). This parameter is for Adobe AIR only; do not set it for Flash Player content. -
 
controlKey:Boolean (default = false) — (AIR only) Indicates whether the Control or Ctrl key is activated. This parameter is for Adobe AIR only; do not set it for Flash Player content. -
-

-See also -

-
-flash.ui.Multitouch -
-flash.events.TouchEvent -
-flash.events.GestureEvent -
-flash.events.GesturePhase -
-flash.events.MouseEvent -
-flash.events.EventDispatcher.addEventListener() -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a copy of the PressAndTapGestureEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new PressAndTapGestureEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that contains all the properties of the PressAndTapGestureEvent object. The string is in the following format: -

[PressAndTapGestureEvent type=value bubbles=value cancelable=value ... ]

-

-Returns - - - - -
String — - A string that contains all the properties of the PressAndTapGestureEvent object. - - - -
-
- -
Constant detail
- - - - - -
GESTURE_PRESS_AND_TAPconstant
-
-public static const GESTURE_PRESS_AND_TAP:String = "gesturePressAndTap" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a GESTURE_PRESS_AND_TAP touch event object. - -

The dispatched PressAndTapGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase as the event passes through the object hierarchy; a numeric value indicating the event is captured (1), at the target (2), or bubbling (3).
localXThe horizontal coordinate at which the event occurred relative to the containing display object.
localYThe vertical coordinate at which the event occurred relative to the containing display object.
phaseThe current phase in the event flow; a value from the GesturePhase class.Possible values are: - GesturePhase.BEGIN, GesturePhase.UPDATE, GesturePhase.END, or GesturePhase.ALL. - A press-and-tap gesture either generates a GesturePhase.BEGIN, GesturePhase.UPDATE, GesturePhase.END sequence - or the gesture generates a single GesturePhase.ALL phase.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
tapLocalXThe horizontal coordinate at which the event occurred relative to the containing interactive object.
tapLocalYThe vertical coordinate at which the event occurred relative to the containing interactive object.
tapStageXThe horizontal coordinate at which the tap touch occurred in global Stage coordinates.
tapStageYThe vertical coordinate at which the tap touch occurred in global Stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.InteractiveObject.gesturePressAndTap -
-flash.events.GesturePhase -
-
- -
Examples
-
examples\GesturePressAndTap
-
The following example shows event handling for the GESTURE_PRESS_AND_TAP event. - While the user performs a press-and-tap gesture, mySprite rotates and myTextField populates with the current phase. -
-
-Multitouch.inputMode = MultitouchInputMode.GESTURE;
-
-var mySprite = new Sprite();
-mySprite.addEventListener(PressAndTapGestureEvent.GESTURE_PRESS_AND_TAP , onPressAndTap );
-mySprite.graphics.beginFill(0x336699);
-mySprite.graphics.drawRect(0, 0, 100, 80);
-var myTextField = new TextField();
-myTextField.y = 200;
-addChild(mySprite);
-addChild(myTextField);
-
-function onPressAndTap(evt:PressAndTapGestureEvent):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";
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/ProgressEvent.html b/html-docs/flash/events/ProgressEvent.html deleted file mode 100644 index 1d41043..0000000 --- a/html-docs/flash/events/ProgressEvent.html +++ /dev/null @@ -1,1187 +0,0 @@ - - - - - - - - -flash.events.ProgressEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class ProgressEvent
InheritanceProgressEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- A ProgressEvent object is dispatched when a load operation has begun or a socket has received data. - These events are usually generated when SWF files, images or data are loaded into an application. - There are two types of progress events: - ProgressEvent.PROGRESS and ProgressEvent.SOCKET_DATA. - Additionally, in AIR ProgressEvent objects are dispatched - when a data is sent to or from a child process using the NativeProcess class. -

-

-View the examples. -

-

-See also -

-
-FileStream class -
-LoaderInfo class -
-Socket class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
  bytesLoaded : Number -
- The number of items or bytes loaded when the listener processes the event.
-		ProgressEvent
  bytesTotal : Number -
- The total number of items or bytes that will be loaded if the loading process succeeds.
-		ProgressEvent
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0)
-
- Creates an Event object that contains information about progress events.
-		ProgressEvent
   -
-clone():Event -
-
- Creates a copy of the ProgressEvent object and sets each property's value to match that of the original.
-		ProgressEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the ProgressEvent object.
-		ProgressEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
  PROGRESS : String = "progress"
[static] - Defines the value of the type property of a progress event object.
-		ProgressEvent
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
  SOCKET_DATA : String = "socketData"
[static] - Defines the value of the type property of a socketData event object.
-		ProgressEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
  STANDARD_ERROR_DATA : String = "standardErrorData"
[static] - Defines the value of the type property of a standardErrorData event object.
-		ProgressEvent
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
  STANDARD_INPUT_PROGRESS : String = "standardInputProgress"
[static] - Defines the value of the type property of a standardInputProgress event object.
-		ProgressEvent
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
  STANDARD_OUTPUT_DATA : String = "standardOutputData"
[static] - Defines the value of the type property of a standardOutputData event object.
-		ProgressEvent
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
bytesLoadedproperty
-
-bytesLoaded:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The number of items or bytes loaded when the listener processes the event. - -

Implementation -
-    public function get bytesLoaded():Number -
-    public function set bytesLoaded(value:Number):void -
-
- - - - - -
bytesTotalproperty 
-
-bytesTotal:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The total number of items or bytes that will be loaded if the loading process succeeds. - If the progress event is dispatched/attached to a Socket object, the bytesTotal will always be 0 - unless a value is specified in the bytesTotal parameter of the constructor. - The actual number of bytes sent back or forth is not set and is up to the application developer. - -

Implementation -
-    public function get bytesTotal():Number -
-    public function set bytesTotal(value:Number):void -
-
- -
Constructor detail
- - - - - -
ProgressEvent()constructor
-
-public function ProgressEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:Number = 0, bytesTotal:Number = 0) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates an Event object that contains information about progress events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are:ProgressEvent.PROGRESS, - ProgressEvent.SOCKET_DATA, ProgressEvent.STANDARD_ERROR_DATA, ProgressEvent.STANDARD_INPUT_PROGRESS, and ProgressEvent.STANDARD_OUTPUT_DATA. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
 
bytesLoaded:Number (default = 0) — The number of items or bytes loaded at the time the listener processes the event. -
 
bytesTotal:Number (default = 0) — The total number of items or bytes that will be loaded if the loading process succeeds. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of the ProgressEvent object and sets each property's value to match that of the original. - -

-Returns - - - - -
Event — - A new ProgressEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the ProgressEvent object. The string is in the following format: -

[ProgressEvent type=value bubbles=value cancelable=value bytesLoaded=value bytesTotal=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the ProgressEvent object. - - - -
-
- -
Constant detail
- - - - - -
PROGRESSconstant
-
-public static const PROGRESS:String = "progress" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -

-See also -

-
-flash.display.LoaderInfo.progress -
-flash.media.Sound.progress -
-flash.net.FileReference.progress -
-flash.net.URLLoader.progress -
-flash.net.URLStream.progress -
-
- - - - - -
SOCKET_DATAconstant 
-
-public static const SOCKET_DATA:String = "socketData" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a socketData event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event.
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotal0; this property is not used by socketData event objects.
targetThe socket reporting progress.
- -

-See also -

-
-flash.net.Socket.socketData -
-
- - - - - -
STANDARD_ERROR_DATAconstant 
-
-public static const STANDARD_ERROR_DATA:String = "standardErrorData" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a standardErrorData event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event.
bytesLoadedThe number of bytes of error data buffered by the NativeProcessObject.error due to this event.
bytesTotal0; this property is not used by standardErrorData event objects.
targetThe NativeProcess object reporting error data.
- -

-See also -

-
-flash.desktop.NativeProcess.standardErrorData -
-
- - - - - -
STANDARD_INPUT_PROGRESSconstant 
-
-public static const STANDARD_INPUT_PROGRESS:String = "standardInputProgress" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a standardInputProgress event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event.
bytesLoadedThe number of bytes of error data buffered by the NativeProcessObject.error due to this event.
bytesTotal0; this property is not used by standardInputProgress event objects.
targetThe NativeProcess object reporting error data.
- -

-See also -

-
-flash.desktop.NativeProcess.standardInputProgress -
-
- - - - - -
STANDARD_OUTPUT_DATAconstant 
-
-public static const STANDARD_OUTPUT_DATA:String = "standardOutputData" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a standardOutputData event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event.
bytesLoadedThe number of bytes of output data buffered by the NativeProcessObject.output due to this event.
bytesTotal0; this property is not used by standardOutputData event objects.
targetThe NativeProcess object reporting output data.
-

-See also -

-
-flash.desktop.NativeProcess.standardOutputData -
-
- -
Examples
-
examples\ProgressEventExample
-
The following example uses the ProgressEventExample class to illustrate how various - event listeners are used when a file is being downloaded. The example carries out the following tasks: -
    -
  1. The properties downloadURL and fileName are created, which indicate the location - and name of the download file.
    2. -
  2. In the ProgressEventExample constructor, a new FileReference object named file is - created and then passed to the configureListeners() method.
    3. -
  3. The downloadURL and fileName properties are then passed to file.download(), - which prompts for the location to download the file.
    4. -
  4. The configureListeners() method adds seven event listeners and their associated subscriber - methods: -
      -
    1. cancel/cancelHandler() is dispatched if the file download is canceled.
      2. -
    2. complete/complereHandler() is dispatched when the file download process is - finished.
      3. -
    3. ioError/ioErrorHandler() is dispatched if the download file is unavailable or - inaccessible.
      4. -
    4. open/openHandler() is dispatched when the download operation has started.
      5. -
    5. progress/progressHandler() is dispatched when the download process begins and again - when it ends.
      6. -
    6. securityError/securityErrorHandler is dispatched if the local playback - security setting does not match the type of data access for the download file (local versus network); - see the notes below.
      7. -
    7. select/selectHandler() is dispatched when the download object is selected.
      8. -
    -
    5. -
- -

Notes: -

    -
  • You need to compile the SWF file with Local Playback Security set to Access Network Files Only.
    • -
  • This example requires a file named SomeFile.pdf.
    • -
  • Although this example makes use of all events available to the FileReference object, most situations - require only a subset.
    • -
-

- -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.FileReference;
-    import flash.net.URLRequest;
-
-    public class ProgressEventExample extends Sprite {
-        private var downloadURL:String = "http://www.[yourDomain].com/SomeFile.pdf";
-        private var fileName:String = "SomeFile.pdf";
-        private var file:FileReference;
-
-        public function ProgressEventExample() {
-            var request:URLRequest = new URLRequest(downloadURL);
-            file = new FileReference();
-            configureListeners(file);
-            file.download(request, fileName);
-        }
-
-        private function configureListeners(dispatcher:IEventDispatcher):void {
-            dispatcher.addEventListener(Event.CANCEL, cancelHandler);
-            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            dispatcher.addEventListener(Event.OPEN, openHandler);
-            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            dispatcher.addEventListener(Event.SELECT, selectHandler);
-        }
-
-        private function cancelHandler(event:Event):void {
-            trace("cancelHandler: " + event);
-        }
-
-        private function completeHandler(event:Event):void {
-            trace("completeHandler: " + 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 {
-            var file:FileReference = FileReference(event.target);
-            trace("progressHandler: name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-
-        private function selectHandler(event:Event):void {
-            var file:FileReference = FileReference(event.target);
-            trace("selectHandler: name=" + file.name + " URL=" + downloadURL);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/RemoteNotificationEvent.html b/html-docs/flash/events/RemoteNotificationEvent.html deleted file mode 100644 index be9cddf..0000000 --- a/html-docs/flash/events/RemoteNotificationEvent.html +++ /dev/null @@ -1,830 +0,0 @@ - - - - - - - - -flash.events.RemoteNotificationEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic final class RemoteNotificationEvent
InheritanceRemoteNotificationEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

-

- Contains events that are dispatched by flash.notifications.RemoteNotifier in response to push notification events from APNs. -

The event fires, as follows:

-
    -
  • notification: upon receiving a new remote notification
    • -
  • token: upon receiving a new token from APNs that identifies this app and device.
    • -
- -

-

-See also -

-
-flash.notifications.RemoteNotifier -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  data : Object -
[read-only] - Contains a JSON-format notification payload.
-		RemoteNotificationEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
  tokenId : String -
[read-only] - Cotains the tokenId received from APNs, used to identify the application.
-		RemoteNotificationEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-RemoteNotificationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:Object = null, tokenId:String = null)
-
- Contains events that are dispatched by flash.notifications.RemoteNotifier in response to push notification events from APNs.
-		RemoteNotificationEvent
 Inherited -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		Event
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
  NOTIFICATION : String = "notification"
[static] - Defines the value of the type property of a RemoteNotificationEvent event object.
-		RemoteNotificationEvent
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
  TOKEN : String = "token"
[static] - Defines the value of the type property of a RemoteNotificationEvent event object.
-		RemoteNotificationEvent
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
dataproperty
-
-data:Object  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Contains a JSON-format notification payload. -

Implementation -
-    public function get data():Object -
-
- - - - - -
tokenIdproperty 
-
-tokenId:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Cotains the tokenId received from APNs, used to identify the application. -

Implementation -
-    public function get tokenId():String -
-
- -
Constructor detail
- - - - - -
RemoteNotificationEvent()constructor
-
-public function RemoteNotificationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:Object = null, tokenId:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Contains events that are dispatched by flash.notifications.RemoteNotifier in response to push notification events from APNs. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
data:Object (default = null)
 
tokenId:String (default = null)
-
- -
Constant detail
- - - - - -
NOTIFICATIONconstant
-
-public static const NOTIFICATION:String = "notification" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Defines the value of the type property of a RemoteNotificationEvent event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe data received in the notification.
tokenIdThe token id received from APNs that is to be sent to the application's remote - notification prvider
-
- - - - - -
TOKENconstant 
-
-public static const TOKEN:String = "token" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Defines the value of the type property of a RemoteNotificationEvent event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe data received in the notification.
tokenIdThe token id received from APNs that is to be sent to the application's remote - notification provider
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/SQLErrorEvent.html b/html-docs/flash/events/SQLErrorEvent.html deleted file mode 100644 index 372484d..0000000 --- a/html-docs/flash/events/SQLErrorEvent.html +++ /dev/null @@ -1,886 +0,0 @@ - - - - - - - - -flash.events.SQLErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class SQLErrorEvent
InheritanceSQLErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A SQLErrorEvent instance is dispatched by a SQLConnection instance or SQLStatement instance - when an error occurs while performing a database operation in asynchronous execution mode. - The SQLErrorEvent instance - that's passed as an event object to listeners provides access to - information about the cause of the error and the operation that was being attempted. -

The specific details of the failure can be found on the SQLError object - in the SQLErrorEvent instance's error property.

-

-

-See also -

-
-flash.errors.SQLError -
-flash.data.SQLConnection -
-flash.data.SQLStatement -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  error : SQLError -
[read-only] - A SQLError object containing detailed information about the cause of the error.
-		SQLErrorEvent
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, error:SQLError = null)
-
- Creates a SQLErrorEvent object to pass as an argument to event listeners.
-		SQLErrorEvent
   -
-clone():Event -
-
- Creates a copy of the SQLErrorEvent object and sets the value of each property - to match that of the original.
-		SQLErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the SQLErrorEvent object.
-		SQLErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
  ERROR : String = "error"
[static] - The SQLErrorEvent.ERROR constant defines the value of the - type property of an error event dispatched when a call - to a method of a SQLConnection or SQLStatement instance completes - with an error.
-		SQLErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
errorproperty
-
-error:SQLError  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- A SQLError object containing detailed information about the cause of the error. -

Implementation -
-    public function get error():SQLError -
-
- -
Constructor detail
- - - - - -
SQLErrorEvent()constructor
-
-public function SQLErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, error:SQLError = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLErrorEvent object to pass as an argument to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event, accessible in the type property. - The SQLErrorEvent defines one event type, the error event, - represented by the SQLErrorEvent.ERROR constant. -
 
bubbles:Boolean (default = false) — Determines whether the event object participates in the bubbling - stage of the event flow. The default value is false. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be cancelled. - The default value is false. -
 
error:SQLError (default = null) — The SQLError object that contains the details of the error. -
-

-See also -

-
flash.errors.SQLError;
-ERROR -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the SQLErrorEvent object and sets the value of each property - to match that of the original. -

-Returns - - - - -
Event — - A new SQLErrorEvent object with property values that match those of - the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Returns a string that contains all the properties of the SQLErrorEvent object. - The string is in the following format: -

[SQLErrorEvent type=value bubbles=value - cancelable=value error=value]

-

The error value has the following - format: SQLError : message value code=value operation=value

-

-Returns - - - - -
String — - A string that contains all the properties of the SQLErrorEvent object. - - -
-
- -
Constant detail
- - - - - -
ERRORconstant
-
-public static const ERROR:String = "error" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLErrorEvent.ERROR constant defines the value of the - type property of an error event dispatched when a call - to a method of a SQLConnection or SQLStatement instance completes - with an error. - The error event has the following properties: - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
errorA SQLError object containing information about the type of error that occurred and the operation that caused the error.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection or SQLStatement object reporting the error.
-

-See also -

-
-flash.data.SQLConnection -
-flash.data.SQLStatement -
-flash.errors.SQLError -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/SQLEvent.html b/html-docs/flash/events/SQLEvent.html deleted file mode 100644 index dd2fc5e..0000000 --- a/html-docs/flash/events/SQLEvent.html +++ /dev/null @@ -1,1506 +0,0 @@ - - - - - - - - -flash.events.SQLEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class SQLEvent
InheritanceSQLEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- Adobe AIR dispatches SQLEvent objects when one of the operations performed by - a SQLConnection or SQLStatement instance completes successfully. -

-

-See also -

-
-flash.data.SQLConnection -
-flash.data.SQLStatement -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
-
- Creates a SQLEvent object to pass as a parameter to event listeners.
-		SQLEvent
   -
-clone():Event -
-
- Creates a copy of the SQLEvent object and sets the value of each property to match - that of the original.
-		SQLEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
  ANALYZE : String = "analyze"
[static] - The SQLEvent.ANALYZE constant defines the value of the - type property of an analyze event object.
-		SQLEvent
  ATTACH : String = "attach"
[static] - The SQLEvent.ATTACH constant defines the value of the - type property of an attach event object.
-		SQLEvent
  BEGIN : String = "begin"
[static] - The SQLEvent.BEGIN constant defines the value of the - type property of a begin event object.
-		SQLEvent
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
  CANCEL : String = "cancel"
[static] - The SQLEvent.CANCEL constant defines the value of the - type property of a cancel event object.
-		SQLEvent
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
  CLOSE : String = "close"
[static] - The SQLEvent.CLOSE constant defines the value of the - type property of a close event object.
-		SQLEvent
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
  COMMIT : String = "commit"
[static] - The SQLEvent.COMMIT constant defines the value of the - type property of a commit event object.
-		SQLEvent
  COMPACT : String = "compact"
[static] - The SQLEvent.COMPACT constant defines the value of the - type property of a compact event object.
-		SQLEvent
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
  DEANALYZE : String = "deanalyze"
[static] - The SQLEvent.DEANALYZE constant defines the value of the - type property of a deanalyze event object.
-		SQLEvent
  DETACH : String = "detach"
[static] - The SQLEvent.DETACH constant defines the value of the - type property of a detach event object.
-		SQLEvent
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
  OPEN : String = "open"
[static] - The SQLEvent.OPEN constant defines the value of the - type property of a open event object.
-		SQLEvent
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
  REENCRYPT : String = "reencrypt"
[static] - The SQLEvent.REENCRYPT constant defines the value of the - type property of a reencrypt event object.
-		SQLEvent
  RELEASE_SAVEPOINT : String = "releaseSavepoint"
[static] - The SQLEvent.RELEASE_SAVEPOINT constant defines the value of the - type property of a releaseSavepoint event object.
-		SQLEvent
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
  RESULT : String = "result"
[static] - The SQLEvent.RESULT constant defines the value of the - type property of a result event object.
-		SQLEvent
  ROLLBACK : String = "rollback"
[static] - The SQLEvent.ROLLBACK constant defines the value of the - type property of a rollback event object.
-		SQLEvent
  ROLLBACK_TO_SAVEPOINT : String = "rollbackToSavepoint"
[static] - The SQLEvent.ROLLBACK_TO_SAVEPOINT constant defines the value of the - type property of a rollbackToSavepoint event object.
-		SQLEvent
  SCHEMA : String = "schema"
[static] - The SQLEvent.SCHEMA constant defines the value of the - type property of a schema event object.
-		SQLEvent
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
  SET_SAVEPOINT : String = "setSavepoint"
[static] - The SQLEvent.SET_SAVEPOINT constant defines the value of the - type property of a setSavepoint event object.
-		SQLEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Constructor detail
- - - - - -
SQLEvent()constructor
-
-public function SQLEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a SQLEvent object to pass as a parameter to event listeners. -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of the event, available in the type property. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling - stage of the event flow. The default value is false. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. - The default value is false. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the SQLEvent object and sets the value of each property to match - that of the original. -

-Returns - - - - -
Event — - A new SQLEvent object with property values that match those of the original. - - -
-
- -
Constant detail
- - - - - -
ANALYZEconstant
-
-public static const ANALYZE:String = "analyze" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.ANALYZE constant defines the value of the - type property of an analyze event object. - This type of event is dispatched when a - SQLConnection.analyze() method call completes successfully. - The analyze event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.analyze() -
-
- - - - - -
ATTACHconstant 
-
-public static const ATTACH:String = "attach" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.ATTACH constant defines the value of the - type property of an attach event object. - This type of event is dispatched when a - SQLConnection.attach() method call completes successfully. - The attach event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.attach() -
-
- - - - - -
BEGINconstant 
-
-public static const BEGIN:String = "begin" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.BEGIN constant defines the value of the - type property of a begin event object. - This type of event is dispatched when a - SQLConnection.begin() method call completes successfully. - The begin event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.begin() -
-
- - - - - -
CANCELconstant 
-
-public static const CANCEL:String = "cancel" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.CANCEL constant defines the value of the - type property of a cancel event object. - This type of event is dispatched when a SQLConnection.cancel() - method call completes successfully. - The cancel event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection or SQLStatement object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.cancel() -
-
- - - - - -
CLOSEconstant 
-
-public static const CLOSE:String = "close" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.CLOSE constant defines the value of the - type property of a close event object. - This type of event is dispatched when a - SQLConnection.close() method call completes successfully. - The close event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.close() -
-
- - - - - -
COMMITconstant 
-
-public static const COMMIT:String = "commit" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.COMMIT constant defines the value of the - type property of a commit event object. - This type of event is dispatched when a - SQLConnection.commit() method call completes successfully. - The commit event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.commit() -
-
- - - - - -
COMPACTconstant 
-
-public static const COMPACT:String = "compact" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.COMPACT constant defines the value of the - type property of a compact event object. - This type of event is dispatched when a - SQLConnection.compact() method call completes successfully. - The compact event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.compact() -
-
- - - - - -
DEANALYZEconstant 
-
-public static const DEANALYZE:String = "deanalyze" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.DEANALYZE constant defines the value of the - type property of a deanalyze event object. - This type of event is dispatched when a - SQLConnection.deanalyze() method call completes successfully. - The deanalyze event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.deanalyze() -
-
- - - - - -
DETACHconstant 
-
-public static const DETACH:String = "detach" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.DETACH constant defines the value of the - type property of a detach event object. - This type of event is dispatched when a - SQLConnection.detach() method call completes successfully. - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.detach() -
-
- - - - - -
OPENconstant 
-
-public static const OPEN:String = "open" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.OPEN constant defines the value of the - type property of a open event object. - This type of event is dispatched when a - SQLConnection.open() or SQLConnection.openAsync() method call completes successfully. - The open event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.open() -
-flash.data.SQLConnection.openAsync() -
-
- - - - - -
REENCRYPTconstant 
-
-public static const REENCRYPT:String = "reencrypt" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The SQLEvent.REENCRYPT constant defines the value of the - type property of a reencrypt event object. - This type of event is dispatched when a - SQLConnection.reencrypt() method call completes successfully. - The reencrypt event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.reencrypt() -
-
- - - - - -
RELEASE_SAVEPOINTconstant 
-
-public static const RELEASE_SAVEPOINT:String = "releaseSavepoint" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The SQLEvent.RELEASE_SAVEPOINT constant defines the value of the - type property of a releaseSavepoint event object. - This type of event is dispatched when a SQLConnection.releaseSavepoint() - method call completes successfully. - The releaseSavepoint event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.releaseSavepoint() -
-
- - - - - -
RESULTconstant 
-
-public static const RESULT:String = "result" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.RESULT constant defines the value of the - type property of a result event object. - Dispatched when either the SQLStatement.execute() method or - SQLStatement.next() method completes successfully. Once the - SQLEvent.RESULT event is dispatched the SQLStatement.getResult() - method can be called to access the result data. - The result event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLStatement object that performed the operation.
-

-See also -

-
-flash.data.SQLStatement.execute() -
-flash.data.SQLStatement.next() -
-flash.data.SQLStatement.getResult() -
-
- - - - - -
ROLLBACKconstant 
-
-public static const ROLLBACK:String = "rollback" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.ROLLBACK constant defines the value of the - type property of a rollback event object. - This type of event is dispatched when a - SQLConnection.rollback() method call completes successfully. - The rollback event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.rollback() -
-
- - - - - -
ROLLBACK_TO_SAVEPOINTconstant 
-
-public static const ROLLBACK_TO_SAVEPOINT:String = "rollbackToSavepoint" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The SQLEvent.ROLLBACK_TO_SAVEPOINT constant defines the value of the - type property of a rollbackToSavepoint event object. - This type of event is dispatched when a SQLConnection.rollbackToSavepoint() - method call completes successfully. - The rollbackToSavepoint event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.rollbackToSavepoint() -
-
- - - - - -
SCHEMAconstant 
-
-public static const SCHEMA:String = "schema" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLEvent.SCHEMA constant defines the value of the - type property of a schema event object. - Dispatched when the SQLConnection.loadSchema() method - completes successfully. Once the SQLEvent.SCHEMA event - is dispatched the SQLConnection.getSchemaResult() method can be - used to get the schema information. - The schema event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.loadSchema() -
-
- - - - - -
SET_SAVEPOINTconstant 
-
-public static const SET_SAVEPOINT:String = "setSavepoint" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The SQLEvent.SET_SAVEPOINT constant defines the value of the - type property of a setSavepoint event object. - This type of event is dispatched when a SQLConnection.setSavepoint() - method call completes successfully. - The setSavepoint event has the following properties: - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe SQLConnection object that performed the operation.
-

-See also -

-
-flash.data.SQLConnection.setSavepoint() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/SQLUpdateEvent.html b/html-docs/flash/events/SQLUpdateEvent.html deleted file mode 100644 index d9027f2..0000000 --- a/html-docs/flash/events/SQLUpdateEvent.html +++ /dev/null @@ -1,984 +0,0 @@ - - - - - - - - -flash.events.SQLUpdateEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class SQLUpdateEvent
InheritanceSQLUpdateEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- A SQLUpdateEvent object is dispatched by a SQLConnection object when a data change occurs - on any table associated with the SQLConnection instance. - A data change can result from the execution of a SQL INSERT, - UPDATE, or DELETE statement, either directly or as - a result of a trigger that fires in connection with the statement execution. -

-

-View the examples. -

-

-See also -

-
-flash.data.SQLConnection -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rowID : Number -
[read-only] - The unique row identifier of the row that was inserted, deleted, or updated.
-		SQLUpdateEvent
  table : String -
[read-only] - The name of the table whose data change caused the event to be dispatched.
-		SQLUpdateEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SQLUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, table:String = null, rowID:Number = 0)
-
- Creates a new SQLUpdateEvent instance.
-		SQLUpdateEvent
   -
-clone():Event -
-
- Creates a copy of the SQLUpdateEvent object and sets the value of each property to - match that of the original.
-		SQLUpdateEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
  DELETE : String = "delete"
[static] - The SQLUpdateEvent.DELETE constant defines the value of the - type property of a SQLConnection delete event.
-		SQLUpdateEvent
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
  INSERT : String = "insert"
[static] - The SQLUpdateEvent.INSERT constant defines the value of the - type property of a SQLConnection insert event.
-		SQLUpdateEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
  UPDATE : String = "update"
[static] - The SQLUpdateEvent.UPDATE constant defines the value of the - type property of a SQLConnection update event.
-		SQLUpdateEvent
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
rowIDproperty
-
-rowID:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The unique row identifier of the row that was inserted, deleted, or updated. - -

A row identifier is used to uniquely identify a row in a table within - the database. The value is frequently generated by the database.

- -

The row identifier for a single SQL INSERT statement execution - can be obtained through the lastInsertRowID property of the SQLResult object - returned by the SQLStatement object's getResult() method (when called after the - SQLStatement dispatches its result event).

- -

For more information about primary keys and generated row identifiers, - see the "CREATE TABLE" and - "Expressions" sections in the appendix - "SQL support in local databases."

- - Implementation -
-    public function get rowID():Number -
-

-See also -

-
-flash.data.SQLConnection.lastInsertRowID -
-flash.data.SQLResult.lastInsertRowID -
-
- - - - - -
tableproperty 
-
-table:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The name of the table whose data change caused the event to be dispatched. -

Implementation -
-    public function get table():String -
-
- -
Constructor detail
- - - - - -
SQLUpdateEvent()constructor
-
-public function SQLUpdateEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, table:String = null, rowID:Number = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a new SQLUpdateEvent instance. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event, available through the type property. - -
 
bubbles:Boolean (default = false) — Determines whether the event object participates in the bubbling - stage of the event flow. The default value is false. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be cancelled. - The default value is false. - -
 
table:String (default = null) — Indicates the name of the table whose data changed. - -
 
rowID:Number (default = 0) — The unique row identifier of the row that was inserted, deleted, or updated. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the SQLUpdateEvent object and sets the value of each property to - match that of the original. -

-Returns - - - - -
Event — - A new SQLUpdateEvent object with property values that match those of the original. - - -
-
- -
Constant detail
- - - - - -
DELETEconstant
-
-public static const DELETE:String = "delete" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLUpdateEvent.DELETE constant defines the value of the - type property of a SQLConnection delete event. - The delete event has the following properties: - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
rowIDThe unique row identifier of the row that was inserted, deleted, or updated.
targetThe SQLConnection object on which the operation was performed.
tableThe name of the table on which the change occurred.
-

- - - - - -
INSERTconstant 
-
-public static const INSERT:String = "insert" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLUpdateEvent.INSERT constant defines the value of the - type property of a SQLConnection insert event. - The insert event has the following properties: - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
rowIDThe unique row identifier of the row that was inserted, deleted, or updated.
targetThe SQLConnection object on which the operation was performed.
tableThe name of the table on which the change occurred.
-

- - - - - -
UPDATEconstant 
-
-public static const UPDATE:String = "update" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The SQLUpdateEvent.UPDATE constant defines the value of the - type property of a SQLConnection update event. - -

The update event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
rowIDThe unique row identifier of the row that was inserted, deleted, or updated.
targetThe SQLConnection object on which the operation was performed.
tableThe name of the table on which the change occurred.
-
- -
Examples
-
examples\SQLUpdateEvent.class.1
-
The following example shows the use of of a SQLUpdateEvent instance - in responding to an update event. -
-
-
-var dbStatement:SQLStatement;
-
-function initConnection():void
-{
-    var dbFile:File = new File(File.separator + "employee.db");
-    db.addEventListener(SQLEvent.OPEN, dbOpenHandler);
-    db.addEventListener(SQLUpdateEvent.UPDATE, dbUpdateHandler);
-
-    dbStatement.text = "UPDATE employees SET name = :name WHERE id = :id";
-    dbStatement.parameters[:name] = "Bruce";
-    dbStatement.parameters[:id] = 100;
-
-    dbStatement.sqlConnection = db;
-
-	db.open(dbFile);
-}
-
-function dbUpdateHandler(event:SQLUpdateEvent):void
-{
-    trace(event.type + " for table '" + event.table + "' was fired for row with ID:" + event.rowID);
-}
-
-function dbOpenHandler(event:SQLEvent):void
-{
-    dbStatement.execute();
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/SampleDataEvent.html b/html-docs/flash/events/SampleDataEvent.html deleted file mode 100644 index a6d1c4d..0000000 --- a/html-docs/flash/events/SampleDataEvent.html +++ /dev/null @@ -1,951 +0,0 @@ - - - - - - - - -flash.events.SampleDataEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class SampleDataEvent
InheritanceSampleDataEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- Dispatched when a Sound object requests new audio data or when a Microphone object - has new audio data to provide. -

This event has two uses:

-
    -
  • To provide dynamically generated audio data for a Sound object
    • -
  • To get audio data for a Microphone object
    • -
-

Dynamically generating audio using the Sound object Use the - sampleData event to play dynamically generated audio. In this environment, - the Sound object doesn't actually contain sound data. Instead, it acts as a socket for - sound data that is being streamed to it through the use of the function - you assign as the handler for the sampleData event.

-

In your function, you use the ByteArray.writeFloat() method to write to - the event's data) property, which contains the sampled data you - want to play.

-

If a Sound object has not loaded an MP3 file, when you call its play() method - the object starts dispatching sampleData events, requesting sound samples. - The Sound object continues to send events as the sound plays back until you stop providing data, - or until the stop() method of the SoundChannel object is called.

-

Thes latency of the event varies from platform to platform, and it could change in future - versions of Flash Player or AIR. Don't depend on a specific latency. - Instead calculate it using ((SampleDataEvent.position/44.1) - SoundChannelObject.position).

-

Provide between 2048 and 8192 samples to the data property of - the SampleDataEvent object. For best performance, provide as many samples as possible. - The fewer samples you provide, the more likely it is - that clicks and pops will occur during playback. This behavior can differ on various platforms - and can occur in various situations - for example, when resizing the browser. - You might write code that works on one platform when you provide only 2048 samples, but that same code - might not work as well when run on a different platform. If you require the lowest latency possible, - consider making the amount of data user-selectable.

-

If you provide fewer than 2048 samples, tha Sound object plays the remaining samples - and then stops the sound as if the end of a sound file was reached, generating - a complete event.

- -

You can use the extract() method of a Sound object to extract its sound data, - which you can then write to the dynamic stream for playback.

-

When you use the sampleData event with a Sound object, the only Sound methods that - are enabled are extract() and play(). Calling any other methods or properties - results in an "invalid call" exception. All methods and properties of the SoundChannel object - are still enabled.

-

Capturing Microphone audio Use the sampleData event - to capture audio data from a microphone. When you add an event listener for the - sampleData event, the Microphone dispatches the event as audio samples - become available.

-

In the event handler function, use the ByteArray.readFloat() method to read - the event's data) property, which contains the sampled data. The event will contain - multiple samples, so you should use a while loop to read the available data:

- 
var soundBytes:ByteArray = new ByteArray();
- while(event.data.bytesAvailable)
- {
-      var sample:Number = event.data.readFloat();
-      soundBytes.writeFloat(sample);
- }
-

-

-View the examples. -

-

-See also -

-
-flash.media.Sound -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  data : ByteArray -
- The data in the audio stream.
-		SampleDataEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  position : Number -
- The position of the data in the audio stream.
-		SampleDataEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SampleDataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, theposition:Number = 0, thedata:ByteArray = null)
-
- Creates an event object that contains information about audio data events.
-		SampleDataEvent
   -
-clone():Event -
-
- Creates a copy of the SampleDataEvent object and sets each property's value to match that of the original.
-		SampleDataEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the SampleDataEvent object.
-		SampleDataEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
  SAMPLE_DATA : String = "sampleData"
[static] - Defines the value of the type property of a SampleDataEvent event object.
-		SampleDataEvent
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
dataproperty
-
-data:ByteArray  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The data in the audio stream. -

Implementation -
-    public function get data():ByteArray -
-    public function set data(value:ByteArray):void -
-
- - - - - -
positionproperty 
-
-position:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The position of the data in the audio stream. -

Implementation -
-    public function get position():Number -
-    public function set position(value:Number):void -
-
- -
Constructor detail
- - - - - -
SampleDataEvent()constructor
-
-public function SampleDataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, theposition:Number = 0, thedata:ByteArray = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates an event object that contains information about audio data events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. This value is:Event.SAMPLE_DATA. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
 
theposition:Number (default = 0) — The position of the data in the audio stream. -
 
thedata:ByteArray (default = null) — A byte array of data. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a copy of the SampleDataEvent object and sets each property's value to match that of the original. - -

-Returns - - - - -
Event — - A new SampleDataEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a string that contains all the properties of the SampleDataEvent object. The string is in the following format: -

[SampleDataEvent type=value bubbles=value cancelable=value theposition=value thedata=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the SampleDataEvent object. - - -
-
- -
Constant detail
- - - - - -
SAMPLE_DATAconstant
-
-public static const SAMPLE_DATA:String = "sampleData" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Defines the value of the type property of a SampleDataEvent event object. -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
positionThe point from which audio data is provided.
- -

-See also -

-
-flash.media.Sound.sampleData -
-flash.events.SampleDataEvent -
-
- -
Examples
-
examples\Sound_sampleDataExample
-
The following example plays a simple sine wave. - -
-
-var mySound:Sound = new Sound();
-function sineWaveGenerator(event:SampleDataEvent):void {
-    for ( var c:int=0; c<8192; c++ ) {
-		event.data.writeFloat(Math.sin((Number(c+event.position)/Math.PI/2))*0.25);
-		event.data.writeFloat(Math.sin((Number(c+event.position)/Math.PI/2))*0.25);
-	}
-}
-
-mySound.addEventListener(SampleDataEvent.SAMPLE_DATA,sineWaveGenerator);
-mySound.play();
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/ScreenMouseEvent.html b/html-docs/flash/events/ScreenMouseEvent.html deleted file mode 100644 index de7e833..0000000 --- a/html-docs/flash/events/ScreenMouseEvent.html +++ /dev/null @@ -1,1345 +0,0 @@ - - - - - - - - -flash.events.ScreenMouseEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class ScreenMouseEvent
InheritanceScreenMouseEvent Inheritance MouseEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

-

-The SystemTrayIcon object dispatches events of type ScreenMouseEvent in response to mouse interaction. - -

The ScreenMouseEvent object extends the MouseEvent class to provide two additional properties, -screenX and screenY, that report the mouse coordinates -in relation to the primary desktop screen rather than an application window or -stage.

- -

-

-See also -

-
-flash.desktop.SystemTrayIcon -
-flash.display.Screen -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaltKey : Boolean -
- Indicates whether the Alt key is active (true) or inactive (false).
-		MouseEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 InheritedbuttonDown : Boolean -
- Indicates whether the primary mouse button is pressed (true) or not (false).
-		MouseEvent
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 InheritedclickCount : int -
- Indicates whether or not the mouse down event is part of a multi-click sequence.
-		MouseEvent
 InheritedcommandKey : Boolean -
- Indicates whether the command key is activated (Mac only.) - -

The value of property commandKey - will have the same value as property ctrlKey on the Mac.

-		MouseEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcontrolKey : Boolean -
- Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
-		MouseEvent
 InheritedctrlKey : Boolean -
- On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
-		MouseEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 Inheriteddelta : int -
- Indicates how many lines should be scrolled for each unit the user rotates the - mouse wheel.
-		MouseEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 InheritedisRelatedObjectInaccessible : Boolean -
- If true, the relatedObject property is set to null for - reasons related to security sandboxes.
-		MouseEvent
 InheritedlocalX : Number -
- When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.
-		MouseEvent
 InheritedlocalY : Number -
- When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.
-		MouseEvent
 InheritedmovementX : Number -
- When mouse locking is enabled, the change in mouse position - in the X direction since the last mouse event.
-		MouseEvent
 InheritedmovementY : Number -
- When mouse locking is enabled, the change in mouse position - in the Y direction since the last mouse event.
-		MouseEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 InheritedrelatedObject : InteractiveObject -
- A reference to a display list object that is related to the event.
-		MouseEvent
  screenX : Number -
[read-only] - The X position of the click in screen coordinates.
-		ScreenMouseEvent
  screenY : Number -
[read-only] - The Y position of the click in screen coordinates.
-		ScreenMouseEvent
 InheritedshiftKey : Boolean -
- Indicates whether the Shift key is active (true) or inactive - (false).
-		MouseEvent
 InheritedstageX : Number -
- The horizontal coordinate at which the event occurred in global Stage coordinates.
-		MouseEvent
 InheritedstageY : Number -
- The vertical coordinate at which the event occurred in global Stage coordinates.
-		MouseEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ScreenMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, screenX:Number, screenY:Number, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false)
-
- Creates a ScreenMouseEvent object that contains the mouse location in - screen coordinates.
-		ScreenMouseEvent
   -
-clone():Event -
-
- Creates a copy of the ScreenMouseEvent object and sets the value of each property to match that of the original.
-		ScreenMouseEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the ScreenMouseEvent object.
-		ScreenMouseEvent
 Inherited -
-updateAfterEvent():void -
-
- Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
-		MouseEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
  CLICK : String = "click"
[static] - The ScreenMouseEvent.CLICK constant defines the value of the type - property of a click event object.
-		ScreenMouseEvent
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCONTEXT_MENU : String = "contextMenu"
[static] - The MouseEvent.CONTEXT_MENU constant defines the value of the - type property of a contextMenu event object.
-		MouseEvent
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedDOUBLE_CLICK : String = "doubleClick"
[static] - Defines the value of the type property of a doubleClick event object.
-		MouseEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMIDDLE_CLICK : String = "middleClick"
[static] - Defines the value of the type property of a middleClick event object.
-		MouseEvent
 InheritedMIDDLE_MOUSE_DOWN : String = "middleMouseDown"
[static] - Defines the value of the type property of a middleMouseDown event object.
-		MouseEvent
 InheritedMIDDLE_MOUSE_UP : String = "middleMouseUp"
[static] - Defines the value of the type property of a middleMouseUp event object.
-		MouseEvent
  MOUSE_DOWN : String = "mouseDown"
[static] - The ScreenMouseEvent.MOUSE_DOWN constant defines the value of the type - property of a mouseDown event object.
-		ScreenMouseEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedMOUSE_MOVE : String = "mouseMove"
[static] - Defines the value of the type property of a mouseMove event object.
-		MouseEvent
 InheritedMOUSE_OUT : String = "mouseOut"
[static] - Defines the value of the type property of a mouseOut event object.
-		MouseEvent
 InheritedMOUSE_OVER : String = "mouseOver"
[static] - Defines the value of the type property of a mouseOver event object.
-		MouseEvent
  MOUSE_UP : String = "mouseUp"
[static] - The ScreenMouseEvent.MOUSE_UP constant defines the value of the type - property of a mouseUp event object.
-		ScreenMouseEvent
 InheritedMOUSE_WHEEL : String = "mouseWheel"
[static] - Defines the value of the type property of a mouseWheel event object.
-		MouseEvent
 InheritedMOUSE_WHEEL_HORIZONTAL : String = "mouseWheelHorizontal"
[static] - Defines the value of the type property of a mouseWheelHorizontal event object.
-		MouseEvent
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedRELEASE_OUTSIDE : String = "releaseOutside"
[static] - Defines the value of the type property of a releaseOutside event object.
-		MouseEvent
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
  RIGHT_CLICK : String = "rightClick"
[static] - The ScreenMouseEvent.RIGHT_CLICK constant defines the value of the type - property of a rightClick event object.
-		ScreenMouseEvent
  RIGHT_MOUSE_DOWN : String = "rightMouseDown"
[static] - The ScreenMouseEvent.RIGHT_MOUSE_DOWN constant defines the value of the type - property of a rightMouseDown event object.
-		ScreenMouseEvent
  RIGHT_MOUSE_UP : String = "rightMouseUp"
[static] - The ScreenMouseEvent.RIGHT_MOUSE_UP constant defines the value of the type - property of a rightMouseUp event object.
-		ScreenMouseEvent
 InheritedROLL_OUT : String = "rollOut"
[static] - Defines the value of the type property of a rollOut event object.
-		MouseEvent
 InheritedROLL_OVER : String = "rollOver"
[static] - Defines the value of the type property of a rollOver event object.
-		MouseEvent
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
screenXproperty
-
-screenX:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The X position of the click in screen coordinates. -

Implementation -
-    public function get screenX():Number -
-
- - - - - -
screenYproperty 
-
-screenY:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Y position of the click in screen coordinates. -

Implementation -
-    public function get screenY():Number -
-
- -
Constructor detail
- - - - - -
ScreenMouseEvent()constructor
-
-public function ScreenMouseEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, screenX:Number, screenY:Number, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a ScreenMouseEvent object that contains the mouse location in - screen coordinates. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information - through the inherited type property. -
 
bubbles:Boolean (default = false) — The X position of the click in screen coordinates. -
 
cancelable:Boolean (default = false) — The Y position of the click in screen coordinates. -
 
screenX:Number — Set to false since screen mouse events never bubble. -
 
screenY:Number — Set to false since there is no default behavior to cancel. -
 
ctrlKey:Boolean (default = false) — On Windows or Linux, indicates whether the Ctrl key was down when this event occurred. - On Mac, indicates whether the Ctrl key or the Command key was down. -
 
altKey:Boolean (default = false) — Set to true to indicate that the alt key was down when this event occured. -
 
shiftKey:Boolean (default = false) — Set to true to indicate that the shift key was down when this event occured. -
 
buttonDown:Boolean (default = false) — Set to true to indicate that a mouse button was down when this event occured. -
 
commandKey:Boolean (default = false) — Indicates whether the Command key was down (Mac only). -
 
controlKey:Boolean (default = false) — Indicates whether the Ctrl or Control key was down. - -
-

-See also -

-
-flash.events.MouseEvent -
-flash.display.Screen -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates a copy of the ScreenMouseEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new ScreenMouseEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Returns a string that contains all the properties of the ScreenMouseEvent object. - The string is in the following format: -

[ScreenMouseEvent type=value bubbles=value cancelable=value status=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the ScreenMouseEvent object. - - -
-
- -
Constant detail
- - - - - -
CLICKconstant
-
-public static const CLICK:String = "click" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The ScreenMouseEvent.CLICK constant defines the value of the type - property of a click event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- - - - - -
MOUSE_DOWNconstant 
-
-public static const MOUSE_DOWN:String = "mouseDown" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The ScreenMouseEvent.MOUSE_DOWN constant defines the value of the type - property of a mouseDown event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- - - - - -
MOUSE_UPconstant 
-
-public static const MOUSE_UP:String = "mouseUp" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The ScreenMouseEvent.MOUSE_UP constant defines the value of the type - property of a mouseUp event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- - - - - -
RIGHT_CLICKconstant 
-
-public static const RIGHT_CLICK:String = "rightClick" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The ScreenMouseEvent.RIGHT_CLICK constant defines the value of the type - property of a rightClick event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- - - - - -
RIGHT_MOUSE_DOWNconstant 
-
-public static const RIGHT_MOUSE_DOWN:String = "rightMouseDown" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The ScreenMouseEvent.RIGHT_MOUSE_DOWN constant defines the value of the type - property of a rightMouseDown event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
- - - - - -
RIGHT_MOUSE_UPconstant 
-
-public static const RIGHT_MOUSE_UP:String = "rightMouseUp" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The ScreenMouseEvent.RIGHT_MOUSE_UP constant defines the value of the type - property of a rightMouseUp event object. - -

This event has the following relevant properties:

- - - - - - - - - - - - -
PropertyValue
buttonDowntrue if the primary mouse button is pressed; false otherwise.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
shiftKeytrue if the Shift key is active; false if it is inactive.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
screenXThe horizontal coordinate at which the event occurred in screen coordinates.
screenYThe vertical coordinate at which the event occurred in screen coordinates.
targetThe SystemTrayIcon object under the pointing device.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/SecurityErrorEvent.html b/html-docs/flash/events/SecurityErrorEvent.html deleted file mode 100644 index b08c9da..0000000 --- a/html-docs/flash/events/SecurityErrorEvent.html +++ /dev/null @@ -1,941 +0,0 @@ - - - - - - - - -flash.events.SecurityErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class SecurityErrorEvent
InheritanceSecurityErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-An object dispatches a SecurityErrorEvent object to report the occurrence of a -security error. Security errors reported through this class are generally from asynchronous -operations, such as loading data, in which security violations may not manifest immediately. -Your event listener can access the object's text property to determine what operation was -attempted and any URLs that were involved. If there are no event listeners, the -debugger version of Flash Player or the AIR Debug Launcher (ADL) application -automatically displays an error message that contains the contents of the text -property. There is one type of security error event: SecurityErrorEvent.SECURITY_ERROR. - -

Security error events are the final events dispatched for any target object. -This means that any other events, including generic error events, are not dispatched for a target object -that experiences a security error.

-

-

-View the examples. -

-

-See also -

-
-Security class -
-SECURITY_ERROR -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SecurityErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0)
-
- Creates an Event object that contains information about security error events.
-		SecurityErrorEvent
   -
-clone():Event -
-
- Creates a copy of the SecurityErrorEvent object and sets the value of each property to match that of the original.
-		SecurityErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the SecurityErrorEvent object.
-		SecurityErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
  CERTIFICATE_ERROR : String = "certificateError"
[static] - The SecurityErrorEvent.CERTIFICATE_ERROR constant is used when the runtime detects a problem with a server's security certificate.
-		SecurityErrorEvent
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
  SECURITY_ERROR : String = "securityError"
[static] - The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object.
-		SecurityErrorEvent
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Constructor detail
- - - - - -
SecurityErrorEvent()constructor
-
-public function SecurityErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates an Event object that contains information about security error events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. The error event type can be SecurityErrorEvent.SECURITY_ERROR or SecurityErrorEvent.CERTIFICATE_ERROR. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
text:String (default = "") — Text to be displayed as an error message. Event listeners can access this information through the text property. -
 
id:int (default = 0) — A reference number to associate with the specific error. -
-

-See also -

-
-SECURITY_ERROR -
-CERTIFICATE_ERROR -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a copy of the SecurityErrorEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new securityErrorEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the SecurityErrorEvent object. The string is in the following format: -

[securityErrorEvent type=value bubbles=value cancelable=value text=value errorID=value] - The errorId is only available in Adobe AIR

-

-Returns - - - - -
String — - A string that contains all the properties of the SecurityErrorEvent object. - - - -
-
- -
Constant detail
- - - - - -
CERTIFICATE_ERRORconstant
-
-public static const CERTIFICATE_ERROR:String = "certificateError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51 -
-

- The SecurityErrorEvent.CERTIFICATE_ERROR constant is used when the runtime detects a problem with a server's security certificate. This event - is then dispatched, giving the application the chance to handle this and determine whether to allow the connection or to block it (which is the default - behaviour). To allow it, call preventDefault() on the error object. Note that not handling this error type will result in the default operating system - behaviour - typically, a message will be displayed to the end user to allow them to choose the action. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelabletrue; default behavior is to close the connection, use preventDefault() to allow it.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
-
- - - - - -
SECURITY_ERRORconstant 
-
-public static const SECURITY_ERROR:String = "securityError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- -

-See also -

-
-flash.net.FileReference.securityError -
-flash.net.LocalConnection.securityError -
-flash.net.NetConnection.securityError -
-flash.net.Socket.securityError -
-flash.net.URLLoader.securityError -
-flash.net.URLStream.securityError -
-flash.net.XMLSocket.securityError -
-
- -
Examples
-
examples\SecurityErrorEventExample
-
The following example uses the SecurityErrorEventExample class to show how a - listener method securityErrorHandler() can be instantiated and set to listen for securityError - events to be dispatched. This event will occur when a URLRequest location is not in exactly - the same domain as the calling SWF, and the requested domain has not authorized cross-domain access by way of - a cross-domain policy file. - -

To create a SecurityErrorEvent, replace http://www.[yourdomain].com with a path that has not been authorized for - cross domain access.

-
-
-package {
-    import flash.display.Sprite;
-	import flash.net.URLLoader;
-	import flash.net.URLRequest;
-	import flash.events.SecurityErrorEvent;
-
-	public class SecurityErrorEventExample extends Sprite {
-		public function SecurityErrorEventExample() {
-			var loader:URLLoader = new URLLoader();
-			loader.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-
-			var request:URLRequest = new URLRequest("http://www.[yourDomain].com");
-			loader.load(request);
-		}
-
-		private function securityErrorHandler(event:SecurityErrorEvent):void {
-			trace("securityErrorHandler: " + event);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/ServerSocketConnectEvent.html b/html-docs/flash/events/ServerSocketConnectEvent.html deleted file mode 100644 index 5e45947..0000000 --- a/html-docs/flash/events/ServerSocketConnectEvent.html +++ /dev/null @@ -1,839 +0,0 @@ - - - - - - - - -flash.events.ServerSocketConnectEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class ServerSocketConnectEvent
InheritanceServerSocketConnectEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- A ServerSocket object dispatches a ServerSocketConnectEvent object when a client attempts - to connect to the server socket. - -

The socket property of the ServerSocketConnectEvent object provides the - Socket object to use for subsequent communication between the server and the client. To - deny the connection, call the Socket close() method.

-

-

-See also -

-
-ServerSocket class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  socket : Socket -
- The socket for the new connection.
-		ServerSocketConnectEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ServerSocketConnectEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, socket:Socket = null)
-
- Creates a ServerSocketConnectEvent object that contains information about a client connection.
-		ServerSocketConnectEvent
   -
-clone():Event -
-
- Creates a copy of the ServerSocketConnectEvent object and sets each property's value to match that of the original.
-		ServerSocketConnectEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the ServerSocketConnectEvent object.
-		ServerSocketConnectEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
  CONNECT : String = "connect"
[static] - Defines the value of the type property of a ServerSocketConnectEvent event object.
-		ServerSocketConnectEvent
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
socketproperty
-
-socket:Socket  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The socket for the new connection. - -

Use this Socket object for all communication with the client. Your application is responsible for - maintaining a reference to the Socket object. If you don't, the object is eligible for garbage collection and may be - destroyed by the runtime without warning.

- - Implementation -
-    public function get socket():Socket -
-    public function set socket(value:Socket):void -
-
- -
Constructor detail
- - - - - -
ServerSocketConnectEvent()constructor
-
-public function ServerSocketConnectEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, socket:Socket = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates a ServerSocketConnectEvent object that contains information about a client connection. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Must be: ServerSocketConnectEvent.CONNECT. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Always false -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Always false. -
 
socket:Socket (default = null) — The socket for the new connection. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates a copy of the ServerSocketConnectEvent object and sets each property's value to match that of the original. - -

-Returns - - - - -
Event — - A new ServerSocketConnectEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that contains all the properties of the ServerSocketConnectEvent object. - -

The string is in the following format:

-

[ServerSocketConnectEvent type=value bubbles=value cancelable=value - socket=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the ServerSocketConnectEvent object. - - -
-
- -
Constant detail
- - - - - -
CONNECTconstant
-
-public static const CONNECT:String = "connect" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a ServerSocketConnectEvent event object. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse.
cancelablefalse, there is no default behavior to cancel.
currentTargetThis ServerSocket object.
targetThis ServerSocket object.
socketThe Socket object representing the new connection.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/ShaderEvent.html b/html-docs/flash/events/ShaderEvent.html deleted file mode 100644 index ccf4697..0000000 --- a/html-docs/flash/events/ShaderEvent.html +++ /dev/null @@ -1,968 +0,0 @@ - - - - - - - - -flash.events.ShaderEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class ShaderEvent
InheritanceShaderEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- A ShaderEvent is dispatched when a shader operation launched from - a ShaderJob finishes. - -

-

-See also -

-
-flash.display.ShaderJob -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bitmapData : BitmapData -
- The BitmapData object that was passed to the ShaderJob.start() method.
-		ShaderEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
  byteArray : ByteArray -
- - The ByteArray object that was passed to the ShaderJob.start() method.
-		ShaderEvent
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
  vector : Vector.<Number>
- - The Vector.<Number> object that was passed to the ShaderJob.start() method.
-		ShaderEvent
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ShaderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bitmap:BitmapData = null, array:ByteArray = null, vector:Vector.<Number> = null)
-
- Creates a ShaderEvent object to pass to event listeners.
-		ShaderEvent
   -
-clone():Event -
-
- Creates a copy of the ShaderEvent object and sets the value of each property - to match that of the original.
-		ShaderEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the ShaderEvent object.
-		ShaderEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
  COMPLETE : String = "complete"
[static] - Defines the value of the type property of a complete event object.
-		ShaderEvent
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
bitmapDataproperty
-
-bitmapData:BitmapData  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The BitmapData object that was passed to the ShaderJob.start() method. - If a ByteArray or Vector.<Number> was passed to the start() method - this property is null. - -

Implementation -
-    public function get bitmapData():BitmapData -
-    public function set bitmapData(value:BitmapData):void -
-

-See also -

-
-flash.display.ShaderJob.start() -
-
- - - - - -
byteArrayproperty 
-
-byteArray:ByteArray  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- - The ByteArray object that was passed to the ShaderJob.start() method. - If a BitmapData or Vector.<Number> object was passed to the start() method - this property is null. -

Implementation -
-    public function get byteArray():ByteArray -
-    public function set byteArray(value:ByteArray):void -
-

-See also -

-
-flash.display.ShaderJob.start() -
-
- - - - - -
vectorproperty 
-
-vector:Vector.<Number>  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- - The Vector.<Number> object that was passed to the ShaderJob.start() method. - If a BitmapData or ByteArray object was passed to the start() method - this property is null. -

Implementation -
-    public function get vector():Vector.<Number> -
-    public function set vector(value:Vector.<Number>):void -
-

-See also -

-
-flash.display.ShaderJob.start() -
-
- -
Constructor detail
- - - - - -
ShaderEvent()constructor
-
-public function ShaderEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bitmap:BitmapData = null, array:ByteArray = null, vector:Vector.<Number> = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a ShaderEvent object to pass to event listeners. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event, available in the - type property. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates - in the bubbling stage of the event flow. The default value - is false. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be - canceled. The default value is false. - -
 
bitmap:BitmapData (default = null) — The BitmapData object containing the result of the - operation that finished (or null if - the target wasn't a BitmapData object). - -
 
array:ByteArray (default = null) — The ByteArray object containing the result of the - operation that finished (or null if - the target wasn't a ByteArray object). - -
 
vector:Vector.<Number> (default = null) — The Vector.<Number> instance containing the result of the - operation that finished (or null if - the target wasn't a Vector.<Number> instance). -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a copy of the ShaderEvent object and sets the value of each property - to match that of the original. -

-Returns - - - - -
Event — - A new ShaderEvent object with property values that match the values of - the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a string that contains all the properties of the ShaderEvent object. - The string is in the following format: -

[ShaderEvent type=value bubbles=value - cancelable=value eventPhase=value - bitmapData=value byteArray=value vector=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the ShaderEvent object. - - -
-
- -
Constant detail
- - - - - -
COMPLETEconstant
-
-public static const COMPLETE:String = "complete" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblesfalse
bitmapDataThe BitmapData object - containing the result of the operation that finished (or - null if the target wasn't a BitmapData object).
byteArrayThe ByteArray object containing - the result of the operation that finished (or null if - the target wasn't a ByteArray object).
cancelablefalse; there is - no default behavior to cancel.
currentTargetThe object that is - actively processing the event object with an event listener.
targetThe ShaderJob object reporting completion.
vectorThe Vector.<Number> instance - containing the result of the operation that finished (or null if - the target wasn't a Vector.<Number> instance).
-

-See also -

-
-flash.display.ShaderJob.complete -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/SoftKeyboardEvent.html b/html-docs/flash/events/SoftKeyboardEvent.html deleted file mode 100644 index a497da6..0000000 --- a/html-docs/flash/events/SoftKeyboardEvent.html +++ /dev/null @@ -1,974 +0,0 @@ - - - - - - - - -flash.events.SoftKeyboardEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class SoftKeyboardEvent
InheritanceSoftKeyboardEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 2.6
-

-

-A SoftKeyboardEvent object is dispatched when a software-driven keyboard is activated or de-activated on a device or operating system. -A SoftKeyboardEvent object is dispatched by a TextField or InteractiveObject that has the needsSoftKeyboardproperty -set to true. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  relatedObject : InteractiveObject -
- A reference to a display list object that is related to the event.
-		SoftKeyboardEvent
 Inheritedtarget : Object -
- The event target.
-		Event
  triggerType : String -
[read-only] - Indicates whether the change in keyboard status has been triggered by - an application (such as programmatic use of requestSoftKeyboard()) or by the user - (such as selecting a text field).
-		SoftKeyboardEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SoftKeyboardEvent(type:String, bubbles:Boolean, cancelable:Boolean, relatedObjectVal:InteractiveObject, triggerTypeVal:String)
-
- Creates an event object that contains information about soft keyboard activation and de-activation events.
-		SoftKeyboardEvent
   -
-clone():Event -
-
- Creates a copy of a SoftKeyboardEvent object and sets the value of each property to match that of - the original.
-		SoftKeyboardEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the SoftKeyboardEvent object.
-		SoftKeyboardEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
  SOFT_KEYBOARD_ACTIVATE : String = "softKeyboardActivate"
[static] - The SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE constant defines the value of the type property SoftKeyboardEvent - object when a soft keyboard is displayed.
-		SoftKeyboardEvent
  SOFT_KEYBOARD_ACTIVATING : String = "softKeyboardActivating"
[static] - The SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING constant defines the value of the type property SoftKeyboardEvent - object immediately before a soft keyboard is displayed.
-		SoftKeyboardEvent
  SOFT_KEYBOARD_DEACTIVATE : String = "softKeyboardDeactivate"
[static] - The SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE constant defines the value of the type property SoftKeyboardEvent - object when a soft keyboard is lowered or hidden.
-		SoftKeyboardEvent
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
relatedObjectproperty
-
-relatedObject:InteractiveObject  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- A reference to a display list object that is related to the event. -

Implementation -
-    public function get relatedObject():InteractiveObject -
-    public function set relatedObject(value:InteractiveObject):void -
-
- - - - - -
triggerTypeproperty 
-
-triggerType:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 -
-

- Indicates whether the change in keyboard status has been triggered by - an application (such as programmatic use of requestSoftKeyboard()) or by the user - (such as selecting a text field). - -

Implementation -
-    public function get triggerType():String -
-
- -
Constructor detail
- - - - - -
SoftKeyboardEvent()constructor
-
-public function SoftKeyboardEvent(type:String, bubbles:Boolean, cancelable:Boolean, relatedObjectVal:InteractiveObject, triggerTypeVal:String) -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 -
-

- Creates an event object that contains information about soft keyboard activation and de-activation events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event as a constant value (such as SOFT_KEYBOARD_ACTIVATE). - Event listeners can access this information through the - inherited type property. -
 
bubbles:Boolean — Determines whether the Event object participates in the bubbling phase of the - event flow. Event listeners can access this information through the inherited - bubbles property. -
 
cancelable:Boolean — Determines whether the Event object can be canceled. Event listeners can - access this information through the inherited cancelable property. -
 
relatedObjectVal:InteractiveObject — A reference to a display list object that is related to the event. -
 
triggerTypeVal:String — Indicates whether the keyboard event was triggered by an application or user. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 -
-

- Creates a copy of a SoftKeyboardEvent object and sets the value of each property to match that of - the original. - -

-Returns - - - - -
Event — - A new SoftKeyboardEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 -
-

- Returns a string that contains all the properties of the SoftKeyboardEvent object. The following - format is used: -

[SoftKeyboardEvent type=value bubbles=value cancelable=value relatedObjectVal=value - triggerTypeVal=value activating=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the SoftKeyboardEvent object. - - - -
-
- -
Constant detail
- - - - - -
SOFT_KEYBOARD_ACTIVATEconstant
-
-public static const SOFT_KEYBOARD_ACTIVATE:String = "softKeyboardActivate" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2.6 -
-

- The SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATE constant defines the value of the type property SoftKeyboardEvent - object when a soft keyboard is displayed. For this event, cancellable = false. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
typeSOFT_KEYBOARD_ACTIVATE
bubblestrue
cancelablefalse; there is no default behavior to cancel.
relatedObjectValA reference to a display list object that is related to the event.
triggerTypeValIndicates whether the keyboard event was triggered by an application or user.
currentTargetThe object that is actively processing the Event - object with an event listener.
-
- - - - - -
SOFT_KEYBOARD_ACTIVATINGconstant 
-
-public static const SOFT_KEYBOARD_ACTIVATING:String = "softKeyboardActivating" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2.6 -
-

- The SoftKeyboardEvent.SOFT_KEYBOARD_ACTIVATING constant defines the value of the type property SoftKeyboardEvent - object immediately before a soft keyboard is displayed. For this event, cancellable = true. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
typeSOFT_KEYBOARD_ACTIVATING
bubblestrue
cancelabletrue unless the event is dispatched by a StageText object. - For StageText objects, the event is not cancellable.
relatedObjectValA reference to a display list object that is related to the event.
triggerTypeValIndicates whether the keyboard event was triggered by an application or user.
currentTargetThe object that is actively processing the Event - object with an event listener.
-
- - - - - -
SOFT_KEYBOARD_DEACTIVATEconstant 
-
-public static const SOFT_KEYBOARD_DEACTIVATE:String = "softKeyboardDeactivate" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2.6 -
-

- The SoftKeyboardEvent.SOFT_KEYBOARD_DEACTIVATE constant defines the value of the type property SoftKeyboardEvent - object when a soft keyboard is lowered or hidden. For this event, cancellable = false. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
typeSOFT_KEYBOARD_DEACTIVATE
bubblestrue
cancelablefalse; there is no default behavior to cancel.
relatedObjectValA reference to a display list object that is related to the event.
triggerTypeValIndicates whether the keyboard event was triggered by an application or user.
currentTargetThe object that is actively processing the Event - object with an event listener.
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/SoftKeyboardTrigger.html b/html-docs/flash/events/SoftKeyboardTrigger.html deleted file mode 100644 index 8ea7b67..0000000 --- a/html-docs/flash/events/SoftKeyboardTrigger.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - - - -flash.events.SoftKeyboardTrigger (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class SoftKeyboardTrigger
InheritanceSoftKeyboardTrigger Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

-

- The SoftKeyboardTrigger class provides enumerator values for the triggerType property - of the SoftKeyboardEvent class. These values indicate what type of action triggered a SoftKeyboard - activation event. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  CONTENT_TRIGGERED : String = "contentTriggered"
[static] - Indicates that ActionScript invoked the event.
-		SoftKeyboardTrigger
  USER_TRIGGERED : String = "userTriggered"
[static] - Indicates that user action invoked the event.
-		SoftKeyboardTrigger
-
- -
- -
Constant detail
- - - - - -
CONTENT_TRIGGEREDconstant
-
-public static const CONTENT_TRIGGERED:String = "contentTriggered" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- Indicates that ActionScript invoked the event. -

- - - - - -
USER_TRIGGEREDconstant 
-
-public static const USER_TRIGGERED:String = "userTriggered" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- Indicates that user action invoked the event. Typical user actions that can trigger this event include - explicitly closing the keyboard, or pressing the Back key. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/StageOrientationEvent.html b/html-docs/flash/events/StageOrientationEvent.html deleted file mode 100644 index 25af13d..0000000 --- a/html-docs/flash/events/StageOrientationEvent.html +++ /dev/null @@ -1,937 +0,0 @@ - - - - - - - - -flash.events.StageOrientationEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class StageOrientationEvent
InheritanceStageOrientationEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- A Stage object dispatches a StageOrientationEvent object when the orientation - of the stage changes. This can occur when the - device is rotated, - when the user opens a slide-out keyboard, or when the setAspectRatio() - method of the Stage is called. -

There are two types of StageOrientationEvent event: - The orientationChanging - (StageOrientationEvent.ORIENTATION_CHANGING), is dispatched - before the screen changes to a new orientation. Calling the preventDefault() - method of the event object dispatched for orientationChanging prevents the stage from - changing orientation. - The orientationChange - (StageOrientationEvent.ORIENTATION_CHANGE), is dispatched - after the screen changes to a new orientation.

- -

Note: If the autoOrients property is false, then the stage orientation - does not change when a device is rotated. Thus, StageOrientationEvents are only dispatched for - device rotation when autoOrients is true.

-

-

-See also -

-
-Stage.deviceOrientation -
-Stage.autoOrients -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  afterOrientation : String -
[read-only] - The orientation of the stage after the change.
-		StageOrientationEvent
  beforeOrientation : String -
[read-only] - The orientation of the stage before the change.
-		StageOrientationEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StageOrientationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, beforeOrientation:String = null, afterOrientation:String = null)
-
- Creates a StageOrientationEvent object with specific information relevant to stage orientation events.
-		StageOrientationEvent
   -
-clone():Event -
-
- Creates a copy of the StageOrientationEvent object and sets the value of each property to match that of the original.
-		StageOrientationEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the StageOrientationEvent object.
-		StageOrientationEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
  ORIENTATION_CHANGE : String = "orientationChange"
[static] - The ORIENTATION_CHANGE constant defines the value of the type property of - a orientationChange event object.
-		StageOrientationEvent
  ORIENTATION_CHANGING : String = "orientationChanging"
[static] - The ORIENTATION_CHANGING constant defines the value of the type property of - a orientationChanging event object.
-		StageOrientationEvent
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
afterOrientationproperty
-
-afterOrientation:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The orientation of the stage after the change. - -

Implementation -
-    public function get afterOrientation():String -
-
- - - - - -
beforeOrientationproperty 
-
-beforeOrientation:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The orientation of the stage before the change. - -

Implementation -
-    public function get beforeOrientation():String -
-
- -
Constructor detail
- - - - - -
StageOrientationEvent()constructor
-
-public function StageOrientationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, beforeOrientation:String = null, afterOrientation:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a StageOrientationEvent object with specific information relevant to stage orientation events. - Event objects are passed as parameters to event listeners. Generally you do not create - this event using the constructor function. Instead, you add an event listener on the - Stage object to detect these events as they occur. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event: StageOrientationEvent.ORIENTATION_CHANGE -
 
bubbles:Boolean (default = false) — Indicates whether the Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Indicates whether the Event object can be canceled. -
 
beforeOrientation:String (default = null) — Indicates the orientation before the change. -
 
afterOrientation:String (default = null) — Indicates the orientation after the change. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a copy of the StageOrientationEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new StageOrientationEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that contains all the properties of the StageOrientationEvent object. The string has the following format: -

[StageOrientationEvent type=value bubbles=value cancelable=value beforeDisplayState=value afterDisplayState=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the StageOrientationEvent object. - - -
-
- -
Constant detail
- - - - - -
ORIENTATION_CHANGEconstant
-
-public static const ORIENTATION_CHANGE:String = "orientationChange" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The ORIENTATION_CHANGE constant defines the value of the type property of - a orientationChange event object. - This event has the following properties: - - - - - - - - -
PropertiesValues
afterOrientationThe new orientation of the stage.
beforeOrientationThe old orientation of the stage.
targetThe Stage object that dispatched the orientation change. -
bubblestrue
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelablefalse; it is too late to cancel the change.
-

-See also -

-
-flash.display.Stage -
-deviceOrientation -
-
- - - - - -
ORIENTATION_CHANGINGconstant 
-
-public static const ORIENTATION_CHANGING:String = "orientationChanging" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The ORIENTATION_CHANGING constant defines the value of the type property of - a orientationChanging event object. - This event has the following properties: - - - - - - - - -
PropertiesValues
afterOrientationThe new orientation of the stage.
beforeOrientationThe old orientation of the stage.
targetThe Stage object that dispatched the orientation change. -
bubblestrue
currentTargetIndicates the object that is actively processing the Event - object with an event listener.
cancelabletrue.
-

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/StageVideoAvailabilityEvent.html b/html-docs/flash/events/StageVideoAvailabilityEvent.html deleted file mode 100644 index d23a622..0000000 --- a/html-docs/flash/events/StageVideoAvailabilityEvent.html +++ /dev/null @@ -1,807 +0,0 @@ - - - - - - - - -flash.events.StageVideoAvailabilityEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class StageVideoAvailabilityEvent
InheritanceStageVideoAvailabilityEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

-

This event fires when the state of the Stage.stageVideos property changes. - This property can change when a user expands a video to full screen display from a wmode - that does not support StageVideo (for example, wmode=normal, wmode=opaque, or - wmode=transparent). Expanding to full screen can cause the Stage.stageVideos - vector to become populated. Conversely, exiting full screen display can cause the Stage.stageVideos - vector to become empty.

-

NOTE: This notification occurs only when the state of the Stage.stageVideos property changes. - As a result, behavior may vary according to platform and browser. On Windows, for example, - the stageVideoAvailability event is not dispatched when you go into full screen mode while - wmode is set to direct. On some other platforms, however, the same behavior causes Flash Player - to reallocate resources. In those cases, the Stage.stageVideos property state changes, and the event fires. - You can detect changes to full screen mode by listening to the flash.events.FullScreenEvent event. This event is dispatched - by the Stage object.

- -

-

-See also -

-
-flash.events.StageVideoEvent -
-flash.media.StageVideoAvailability -
-flash.events.VideoEvent -
-flash.events.FullScreenEvent -
-flash.display.Stage.stageVideos -
-flash.events.FullScreenEvent -
-flash.media.Video -
-flash.net.NetStream -
-Working with Video -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  availability : String -
[read-only] -

Reports the current availability of stage video using a constant of the flash.media.StageVideoAvailability class.

-
-		StageVideoAvailabilityEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StageVideoAvailabilityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, availability:String = null)
-
-

Constructor.

-
-		StageVideoAvailabilityEvent
 Inherited -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		Event
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
  driver : String -
-		StageVideoAvailabilityEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
  reason : String -
-		StageVideoAvailabilityEvent
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
  STAGE_VIDEO_AVAILABILITY : String = "stageVideoAvailability"
[static] - Defines the value of the type property of a stageVideoAvailability event object.
-		StageVideoAvailabilityEvent
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
availabilityproperty
-
-availability:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

Reports the current availability of stage video using a constant of the flash.media.StageVideoAvailability class.

- Implementation -
-    public function get availability():String -
-
- -
Constructor detail
- - - - - -
StageVideoAvailabilityEvent()constructor
-
-public function StageVideoAvailabilityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, availability:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

Constructor.

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. Possible values are: StageVideoAvailabilityEvent.STAGE_VIDEO_AVAILABILITY. -
 
bubbles:Boolean (default = false) — Indicates whether this Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Indicates whether you can cancel the action that triggers this event. -
 
availability:String (default = null) — The current availability of stage video. -
-
- -
Constant detail
- - - - - -
driverconstant
-
-public const driver:String -
- - - - - -
reasonconstant 
-
-public const reason:String -
- - - - - -
STAGE_VIDEO_AVAILABILITYconstant 
-
-public static const STAGE_VIDEO_AVAILABILITY:String = "stageVideoAvailability" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Defines the value of the type property of a stageVideoAvailability event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
availabilityThe status reported by the event.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event.
targetThe Stage object reporting on the availability of stage video.
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/StageVideoEvent.html b/html-docs/flash/events/StageVideoEvent.html deleted file mode 100644 index d07790c..0000000 --- a/html-docs/flash/events/StageVideoEvent.html +++ /dev/null @@ -1,846 +0,0 @@ - - - - - - - - -flash.events.StageVideoEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class StageVideoEvent
InheritanceStageVideoEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

-

- A StageVideo object dispatches a StageVideoEvent object after the attachNetStream() method - of the StageVideo object and the play() method of - the attached NetStream object have both been called. Also, depending on the platform, - any change in the playing status can result in dispatching the event. - The one type of StageVideoEvent is StageVideoEvent.RENDER_STATE. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
  colorSpace : String -
[read-only] - The color space used by the video being displayed in the StageVideo object.
-		StageVideoEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  status : String -
[read-only] - The status of the StageVideo object.
-		StageVideoEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StageVideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null, colorSpace:String = null)
-
- Creates an Event object that contains information about StageVideo events.
-		StageVideoEvent
 Inherited -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		Event
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
  codecInfo : String -
-		StageVideoEvent
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
  RENDER_STATE : String = "renderState"
[static] - The StageVideoEvent.RENDER_STATE constant defines the value of the type property of a renderState event object.
-		StageVideoEvent
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
colorSpaceproperty
-
-colorSpace:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- The color space used by the video being displayed in the StageVideo object. - -

Implementation -
-    public function get colorSpace():String -
-

-See also -

-
-flash.media.StageVideo -
-
- - - - - -
statusproperty 
-
-status:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- The status of the StageVideo object. - -

Implementation -
-    public function get status():String -
-

-See also -

-
-flash.events.StageVideoEvent.RENDER_STATUS_UNAVAILABLE -
-flash.events.StageVideoEvent.RENDER_STATUS_SOFTWARE -
-flash.events.StageVideoEvent.RENDER_STATUS_ACCELERATED -
-
- -
Constructor detail
- - - - - -
StageVideoEvent()constructor
-
-public function StageVideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null, colorSpace:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Creates an Event object that contains information about StageVideo events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. The one type of StageVideoEvent is StageVideoEvent.RENDER_STATE. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
status:String (default = null) — Indicates the status of the target StageVideo object. -
 
colorSpace:String (default = null) — The color space used by the video being displayed. -
-

-See also -

-
-flash.media.StageVideo -
-flash.display.Stage.stageVideos -
-flash.events.StageVideoEvent.RENDER_STATE -
-
- -
Constant detail
- - - - - -
codecInfoconstant
-
-public const codecInfo:String -
- - - - - -
RENDER_STATEconstant 
-
-public static const RENDER_STATE:String = "renderState" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The StageVideoEvent.RENDER_STATE constant defines the value of the type property of a renderState event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
colorSpaceThe available color spaces for displaying the video.
currentTargetThe object that is actively processing the StageVideoEvent - object with an event listener.
statusIndicates whether the video is being rendered (decoded and displayed) by hardware or software, or not at all.
targetThe StageVideo object that changed state.
- -

-See also -

-
-flash.events.StageVideoEvent.RENDER_STATE -
-flash.events.StageVideoEvent.RENDER_STATUS_UNAVAILABLE -
-flash.events.StageVideoEvent.RENDER_STATUS_SOFTWARE -
-flash.events.StageVideoEvent.RENDER_STATUS_ACCELERATED -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/StatusEvent.html b/html-docs/flash/events/StatusEvent.html deleted file mode 100644 index 16867bf..0000000 --- a/html-docs/flash/events/StatusEvent.html +++ /dev/null @@ -1,926 +0,0 @@ - - - - - - - - -flash.events.StatusEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class StatusEvent
InheritanceStatusEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- An object dispatches a StatusEvent object when a device, such as a camera or microphone, or an object such as a LocalConnection object reports its status. There is only one type of status event: StatusEvent.STATUS. - -

-

-See also -

-
-flash.media.Camera -
-flash.media.Microphone -
-flash.net.LocalConnection -
-flash.sensors.Accelerometer -
-flash.sensors.Geolocation -
-flash.sensors.DeviceRotation -
air.net.ServiceMonitor
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
  code : String -
- A description of the object's status.
-		StatusEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  level : String -
- The category of the message, such as "status", "warning" or "error".
-		StatusEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, code:String = "", level:String = "")
-
- Creates an Event object that contains information about status events.
-		StatusEvent
   -
-clone():Event -
-
- Creates a copy of the StatusEvent object and sets the value of each property to match that of the original.
-		StatusEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the StatusEvent object.
-		StatusEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
  STATUS : String = "status"
[static] - Defines the value of the type property of a status event object.
-		StatusEvent
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
codeproperty
-
-code:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A description of the object's status. - -

Implementation -
-    public function get code():String -
-    public function set code(value:String):void -
-

-See also -

-
-flash.media.Camera -
-flash.media.Microphone -
-flash.net.LocalConnection -
-
- - - - - -
levelproperty 
-
-level:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The category of the message, such as "status", "warning" or "error". - -

Implementation -
-    public function get level():String -
-    public function set level(value:String):void -
-

-See also -

-
-flash.media.Camera -
-flash.media.Microphone -
-flash.net.LocalConnection -
-
- -
Constructor detail
- - - - - -
StatusEvent()constructor
-
-public function StatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, code:String = "", level:String = "") -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates an Event object that contains information about status events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of status event: StatusEvent.STATUS. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
code:String (default = "") — A description of the object's status. Event listeners can access this information through the code property. -
 
level:String (default = "") — The category of the message, such as "status", "warning" or "error". Event listeners can access this information through the level property. -
-

-See also -

-
-STATUS -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of the StatusEvent object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event — - A new StatusEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the StatusEvent object. The string is in the following format: -

[StatusEvent type=value bubbles=value cancelable=value code=value level=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the StatusEvent object. - - - -
-
- -
Constant detail
- - - - - -
STATUSconstant
-
-public static const STATUS:String = "status" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a status event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
codeA description of the object's status.
currentTargetThe object that is actively processing the Event - object with an event listener.
levelThe category of the message, such as "status", "warning" or "error".
targetThe object reporting its status.
- -

-See also -

-
-flash.media.Camera.status -
-flash.media.Microphone.status -
-flash.net.LocalConnection.status -
-flash.net.NetStream.status -
-flash.sensors.Geolocation.status -
-flash.sensors.Accelerometer.status -
-flash.sensors.DeviceRotation.status -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/StorageVolumeChangeEvent.html b/html-docs/flash/events/StorageVolumeChangeEvent.html deleted file mode 100644 index ff4f603..0000000 --- a/html-docs/flash/events/StorageVolumeChangeEvent.html +++ /dev/null @@ -1,1007 +0,0 @@ - - - - - - - - -flash.events.StorageVolumeChangeEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class StorageVolumeChangeEvent
InheritanceStorageVolumeChangeEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The StorageVolumeInfo.storageVolumeInfo object dispatches a StorageVolumeChangeEvent event - object when a storage volume is mounted or unmounted. There are two types of StorageVolumeChangeEvent: - storageVolumeMount and storageVolumeUnmount. -

On Linux, the StorageVolumeInfo object only dispatches storageVolumeMount and - storageVolumeUnmount events for physical devices. It does not dispatch events when - the user mounts or unmounts volumes over a network.

-

Some devices, such as some digital cameras and phones, appear in the - StorageVolumeInfo.getStorageVolumes() array, but they do not dispatch StorageVolumeChangeEvent - objects when mounted or unmounted.

- -

-

-See also -

-
-flash.filesystem.StorageVolumeInfo -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rootDirectory : File -
[read-only] - A File object corresponding to the root directory of the mounted volume.
-		StorageVolumeChangeEvent
  storageVolume : StorageVolume -
[read-only] - A StorageVolume object containing information about a mounted volume.
-		StorageVolumeChangeEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StorageVolumeChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, path:File = null, volume:StorageVolume = null)
-
- Creates a StorageVolumeChangeEvent object to pass as an argument to event listeners.
-		StorageVolumeChangeEvent
   -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		StorageVolumeChangeEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		StorageVolumeChangeEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
  STORAGE_VOLUME_MOUNT : String = "storageVolumeMount"
[static] - The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the - type property of a StorageVolumeChangeEvent when a volume is mounted.
-		StorageVolumeChangeEvent
  STORAGE_VOLUME_UNMOUNT : String = "storageVolumeUnmount"
[static] - The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the - type property of a StorageVolumeChangeEvent when a volume is unmounted.
-		StorageVolumeChangeEvent
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
rootDirectoryproperty
-
-rootDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A File object corresponding to the root directory of the mounted volume. - If the volume has been unmounted (if the event type is storageVolumeUnmount, - this property is set to null. -

Implementation -
-    public function get rootDirectory():File -
-

-See also -

-
-flash.filesystem.File -
-
- - - - - -
storageVolumeproperty 
-
-storageVolume:StorageVolume  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A StorageVolume object containing information about a mounted volume. This property is null - for an unmounted volume (for an storageVolumeUnmount event). -

Implementation -
-    public function get storageVolume():StorageVolume -
-

-See also -

-
-flash.filesystem.StorageVolume -
-
- -
Constructor detail
- - - - - -
StorageVolumeChangeEvent()constructor
-
-public function StorageVolumeChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, path:File = null, volume:StorageVolume = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a StorageVolumeChangeEvent object to pass as an argument to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event, accessible in the type property. - The StorageVolumeChangeEvent class defines two event types, the storageVolumeMount event, - represented by the StorageVolumeChangeEvent.STORAGE_VOLUME_MOUNT constant, and the - storageVolumeUnmount event, represented by the StorageVolumeChangeEvent.STORAGE_VOLUME_UNMOUNT - constant, - -
 
bubbles:Boolean (default = false) — Determines whether the event object participates in the bubbling - stage of the event flow. The default value is false. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be cancelled. - The default value is false. -
 
path:File (default = null) — The name of the storage volume. -
 
volume:StorageVolume (default = null) — The File object representing the storage volume. -
-

-See also -

-
-flash.errors.SQLError -
-flash.events.ErrorEvent.ERROR -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Duplicates an instance of an Event subclass. -

Returns a new Event object that is a copy of the original instance of the Event object. - You do not normally call clone(); the EventDispatcher class calls it automatically - when you redispatch an event—that is, when you call dispatchEvent(event) from a handler - that is handling event.

- -

The new Event object includes all the properties of the original.

-

When creating your own custom Event class, you must override the - inherited Event.clone() method in order for it to duplicate the - properties of your custom class. If you do not set all the properties that you add - in your event subclass, those properties will not have the correct values when listeners - handle the redispatched event.

- -

In this example, PingEvent is a subclass of Event - and therefore implements its own version of clone().

- - 
-	 class PingEvent extends Event {
-		 var URL:String;
-		 
-	 public override function clone():Event {
-	 	     return new PingEvent(type, bubbles, cancelable, URL);
-	    }
-	 }
-
- -

-Returns - - - - -
Event — - A new Event object that is identical to the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a string containing all the properties of the Event object. The string is in the following format: -

[Event type=value bubbles=value cancelable=value]

-

-Returns - - - - -
String — - A string containing all the properties of the Event object. - - - -
-
- -
Constant detail
- - - - - -
STORAGE_VOLUME_MOUNTconstant
-
-public static const STORAGE_VOLUME_MOUNT:String = "storageVolumeMount" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the - type property of a StorageVolumeChangeEvent when a volume is mounted. -

The event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe StorageVolumeChangeEvent object.
fileA File object representing the storage volume.
nameThe name of the storage volume.
targetThe StorageVolumeChangeEvent object.
type"storageVolumeMount"
-

-See also -

-
-flash.filesystem.StorageVolumeInfo -
-
- - - - - -
STORAGE_VOLUME_UNMOUNTconstant 
-
-public static const STORAGE_VOLUME_UNMOUNT:String = "storageVolumeUnmount" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the - type property of a StorageVolumeChangeEvent when a volume is unmounted. -

The event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe StorageVolumeChangeEvent object.
fileA File object representing the storage volume.
nameThe name of the storage volume.
targetThe StorageVolumeChangeEvent object.
type"storageVolumeUnmount"
-

-See also -

-
-flash.filesystem.StorageVolumeInfo -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/SyncEvent.html b/html-docs/flash/events/SyncEvent.html deleted file mode 100644 index 6202095..0000000 --- a/html-docs/flash/events/SyncEvent.html +++ /dev/null @@ -1,867 +0,0 @@ - - - - - - - - -flash.events.SyncEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class SyncEvent
InheritanceSyncEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- An SharedObject object representing a remote shared object dispatches a SyncEvent object when the remote - shared object has been updated by the server. There is only one type of sync event: - SyncEvent.SYNC. - -

-

-See also -

-
-SharedObject class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
  changeList : Array -
- An array of objects; each object contains properties that describe the changed members of a remote shared object.
-		SyncEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SyncEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, changeList:Array = null)
-
- Creates an Event object that contains information about sync events.
-		SyncEvent
   -
-clone():Event -
-
- Creates a copy of the SyncEvent object and sets the value of each property to match that of the original.
-		SyncEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the SyncEvent object.
-		SyncEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
  SYNC : String = "sync"
[static] - Defines the value of the type property of a sync event object.
-		SyncEvent
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
changeListproperty
-
-changeList:Array  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An array of objects; each object contains properties that describe the changed members of a remote shared object. - The properties of each object are code, name, and oldValue. -

When you initially connect to a remote shared object that is persistent locally and/or on the server, all the - properties of this object are set to empty strings.

Otherwise, Flash sets code to "clear", - "success", "reject", "change", or "delete".

-
  • A value of "clear" means either that you have successfully connected to a remote shared object - that is not persistent on the server or the client, or that all the properties of the object have been deleted--for - example, when the client and server copies of the object are so far out of sync that Flash Player resynchronizes the client - object with the server object. In the latter case, SyncEvent.SYNC is dispatched and the "code" value - is set to "change".
    • -
  • A value of "success" means the client changed the shared object.
    • -
  • A value of "reject" means the client tried unsuccessfully to change the object; instead, another client changed the object.
    • -
  • A value of "change" means another client changed the object or the server resynchronized the object.
    • -
  • A value of "delete" means the attribute was deleted.
-

The name property contains the name of the property that has been changed.

-

The oldValue property contains the former value of the changed property. This parameter is - null unless code has a value of "reject" or "change".

- - Implementation -
-    public function get changeList():Array -
-    public function set changeList(value:Array):void -
-

-See also -

-
-NetConnection class -
-NetStream class -
-
- -
Constructor detail
- - - - - -
SyncEvent()constructor
-
-public function SyncEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, changeList:Array = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates an Event object that contains information about sync events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of sync event: SyncEvent.SYNC. -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
changeList:Array (default = null) — An array of objects that describe the synchronization with the remote SharedObject. Event listeners can access this object through the changeList property. -
-

-See also -

-
-changeList -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of the SyncEvent object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event — - A new SyncEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the SyncEvent object. The string is in the following format: -

[SyncEvent type=value bubbles=value cancelable=value list=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the SyncEvent object. - - - -
-
- -
Constant detail
- - - - - -
SYNCconstant
-
-public static const SYNC:String = "sync" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a sync event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
changeListAn array with properties that describe the array's status.
targetThe SharedObject instance that has been updated by the server.
- -

-See also -

-
-flash.net.SharedObject.sync -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/TextEvent.html b/html-docs/flash/events/TextEvent.html deleted file mode 100644 index d872b97..0000000 --- a/html-docs/flash/events/TextEvent.html +++ /dev/null @@ -1,1211 +0,0 @@ - - - - - - - - -flash.events.TextEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.events
Classpublic class TextEvent
InheritanceTextEvent Inheritance Event Inheritance Object
SubclassesDataEvent, ErrorEvent, IMEEvent
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- An object dispatches a TextEvent object when a user enters text in a text field or clicks - a hyperlink in an HTML-enabled text field. There are two types of text events: TextEvent.LINK - and TextEvent.TEXT_INPUT. - -

-

-View the examples. -

-

-See also -

-
-flash.text.TextField -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
  text : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TextEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "")
-
- Creates an Event object that contains information about text events.
-		TextEvent
   -
-clone():Event -
-
- Creates a copy of the TextEvent object and sets the value of each property to match that of the original.
-		TextEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the TextEvent object.
-		TextEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
  LINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
  TEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
textproperty
-
-text:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- For a textInput event, the character or sequence of characters - entered by the user. For a link event, the text - of the event attribute of the href attribute of the - <a> tag. - -

Implementation -
-    public function get text():String -
-    public function set text(value:String):void -
-
-Example -

-
- -
Constructor detail
- - - - - -
TextEvent()constructor
-
-public function TextEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates an Event object that contains information about text events. - Event objects are passed as parameters to event listeners. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. Possible values are: - TextEvent.LINK and TextEvent.TEXT_INPUT. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
text:String (default = "") — One or more characters of text entered by the user. Event listeners can access this information through the text property. -
-

-See also -

-
-flash.text.TextField -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of the TextEvent object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event — - A new TextEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the TextEvent object. The string is in the following format: -

[TextEvent type=value bubbles=value cancelable=value text=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the TextEvent object. - - - -
-
- -
Constant detail
- - - - - -
LINKconstant
-
-public static const LINK:String = "link" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a link event object. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe text field containing the hyperlink that has been clicked. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
textThe remainder of the URL after "event:"
- -

-See also -

-
-text -
-flash.text.TextField.link -
-
-Example -
In this example, when a user clicks a hyperlink in HTML text, it triggers a text event. - Depending on the link, the user is sent to a designated website based on the - system's operating system, or a circle is drawn based on the user's selected radius. - -

A text field is created and its content is set to an HTML-formatted string by - using the htmlText property. The links are underlined for - easier identification by the user. (Adobe Flash Player changes the mouse - pointer only after the pointer is over the link.) To make sure that the user's click - invokes an ActionScript method, the URL of the link begins with the "event:" string - and a listener is added for the TextEvent.LINK event.

- -

The linkHandler() method that is triggered after the user clicks a - link manages all the link events for the text field. The first if statement checks the - text property of the event, which holds the remainder of the URL after the - "event:" string. If the user clicked the link for the operating system, the - name of the user's current operating system, taken from the system's Capabilities.os - property, is used to send the user to the designated website. Otherwise, the selected radius - size, passed by the event's text property, is used to draw a circle below the text - field. Each time the user clicks the radius link, the previously drawn circle is cleared and a new - red circle with the selected radius size is drawn.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.TextEvent;
-    import flash.errors.IOError;
-    import flash.events.IOErrorEvent;
-    import flash.system.Capabilities;
-    import flash.net.navigateToURL;
-    import flash.net.URLRequest;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.display.Shape;
-    import flash.display.Graphics;
-
-    public class TextEvent_LINKExample extends Sprite {
-        private  var myCircle:Shape = new Shape();
-        
-        public function TextEvent_LINKExample() {
-            var myTextField:TextField = new TextField();
-            myTextField.autoSize = TextFieldAutoSize.LEFT;
-            myTextField.multiline = true;
-            myTextField.background = true;
-            myTextField.htmlText = "Draw a circle with the radius of <u><a href=\"event:20\">20 pixels</a></u>.<br>" 
-                         +  "Draw a circle with the radius of <u><a href=\"event:50\">50 pixels</a></u>.<br><br>"
-                         +  "<u><a href=\"event:os\">Learn about your operating system.</a></u><br>";
-
-            myTextField.addEventListener(TextEvent.LINK, linkHandler);
-
-            this.addChild(myTextField);
-            this.addChild(myCircle);
-        }
-        
-        private function linkHandler(e:TextEvent):void {
-            var osString:String = Capabilities.os;
-            
-            if(e.text == "os") {
-       
-                if (osString.search(/Windows/) != -1 ){
-                    navigateToURL(new URLRequest("http://www.microsoft.com/"), "_self");
-                }else if (osString.search(/Mac/) != -1 ) {
-                    navigateToURL(new URLRequest("http://www.apple.com/"), "_self");
-                } else if (osString.search(/linux/i)!= -1) {
-                    navigateToURL(new URLRequest("http://www.tldp.org/"), "_self");
-                }
-            
-            } else {
-                myCircle.graphics.clear();    
-                myCircle.graphics.beginFill(0xFF0000);
-                myCircle.graphics.drawCircle(100, 150, Number(e.text));
-                myCircle.graphics.endFill();
-            }             
-        }
-    }
-}
-
-

-
- - - - - -
TEXT_INPUTconstant 
-
-public static const TEXT_INPUT:String = "textInput" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the value of the type property of a textInput event object. -

Note: This event is not dispatched for the Delete or Backspace keys.

-

This event has the following properties:

- - - - - - - -
PropertyValue
bubblestrue
cancelabletrue; call the preventDefault() method - to cancel default behavior.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe text field into which characters are being entered. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
textThe character or sequence of characters entered by the user.
- -

-See also -

-
-flash.text.TextField.textInput -
-text -
-
-Example -
The following example guides the user in generating a special combination - key (similar to a password). This combination key has seven alphanumeric - characters, where the second and fifth characters are numeric. - -

Three text fields for the preliminary instructions, the user input, and the - warning (error) messages are created. An event listener is added to respond to - the user's text input by triggering the textInputHandler() method. - (Every time the user enters text, a TextEvent.TEXT_INPUT event is - dispatched.

-

Note: The text events are dispatched when a user enters characters - and not as a response to any keyboard input, such as backspace. To catch all - keyboard events, use a listener for the KeyboardEvent event.)

- -

The textInputHandler() method controls and manages the user - input. The preventDefault() method is used to prevent Adobe Flash Player - from immediately displaying the text in the input text field. The application is - responsible for updating the field. To undo the user's deletion or modification - to the characters already entered (the result string), the content of the - input text field is reassigned to the result string when a user enters - new characters. Also, to produce a consistent user experience, the setSelection() - method places the insertion point (a caret) after the last selected character in the text field.

- -

The first if statement in the textInputHandler() method checks - the input for the second and fifth character positions of the combination key, - which must be numbers. If the user input is correct, the updateCombination() - method is called and the (result) combination key string is appended - with the user input. The updateCombination() method also moves the insertion - point after the selected character. After the seven characters are entered, - the last if statement in the textInputHandler() method changes type of the - inputTextField text field from INPUT to DYNAMIC, - which means that the user can no longer enter or change any characters.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldType;
-    import flash.text.TextFieldAutoSize;
-    import flash.events.TextEvent;
-
-    public class TextEvent_TEXT_INPUTExample extends Sprite {
-        private var instructionTextField:TextField = new TextField();
-        private var inputTextField:TextField = new TextField(); 
-        private var warningTextField:TextField = new TextField();
-        private var result:String = "";
-
-        public function TextEvent_TEXT_INPUTExample() {
-            instructionTextField.x = 10;
-            instructionTextField.y = 10;
-            instructionTextField.background = true; 
-            instructionTextField.autoSize = TextFieldAutoSize.LEFT;
-            instructionTextField.text = "Please enter a value in the format A#AA#AA,\n" 
-                                        + "where 'A' represents a letter and '#' represents a number.\n" +
-                                        "(Note that once you input a character you can't change it.)" ;
-        
-            inputTextField.x = 10;
-            inputTextField.y = 70;
-            inputTextField.height = 20;
-            inputTextField.width = 75;
-            inputTextField.background = true;
-            inputTextField.border = true;
-            inputTextField.type = TextFieldType.INPUT; 
-            
-            warningTextField.x = 10;
-            warningTextField.y = 100;
-            warningTextField.autoSize = TextFieldAutoSize.LEFT;
- 
-            inputTextField.addEventListener(TextEvent.TEXT_INPUT, textInputHandler);   
-           
-            this.addChild(instructionTextField);
-            this.addChild(inputTextField);
-            this.addChild(warningTextField);
-        }
-
-        private function textInputHandler(event:TextEvent):void {
-            var charExp:RegExp = /[a-zA-z]/;   
-            var numExp:RegExp = /[0-9]/;
-
-            event.preventDefault();  
-            
-            inputTextField.text = result;                
-            inputTextField.setSelection(result.length + 1, result.length + 1);
- 
-            if (inputTextField.text.length == 1 || inputTextField.text.length == 4) {
-            
-                if(numExp.test(event.text) == true) {
-                    updateCombination(event.text);
-                } else {
-                    warningTextField.text = "You need a single digit number.";
-                }
-               
-            }else {
-                
-                if(charExp.test(event.text) == true) { 
-                    updateCombination(event.text);
-                } else {
-                    warningTextField.text = "You need an alphabet character.";
-                }
-            }
- 
-            if(inputTextField.text.length == 7) {
-                inputTextField.type = TextFieldType.DYNAMIC;
-                instructionTextField.text = "CONGRATULATIONS. You've done.";                
-            }          
-        }
-
-        private function updateCombination(s:String):void {
-                    warningTextField.text = "";
-                    result += s;           
-                    inputTextField.text = result;
-                    inputTextField.setSelection(result.length + 1, result.length + 1);
-        }
-    }
-}
-
-

-
- -
Examples
-
examples\TextEventExample
-
The following example uses the TextEventExample class to create text fields and to - listen for various text events on them. The example carries out the following tasks: -
    -
  1. The example declares constants for two URLs to be used later.
    2. -
  2. The example declares two variables of type TextField to be used later.
    3. -
  3. The class constructor calls the following two methods: -
      -
    • init() initializes the TextField objects and add event listeners to them.
      • -
    • draw() adds the TextFields to the display list and assigns the text to be displayed.
      • -
    4. -
  4. The listeners linkHandler() and textInputHandler() react to the events - according to their event type. The linkHandler() method opens a web browser if one is not open already - and navigates to the clicked URL. The textInputHandler() method simply displays information every time - a key is pressed in the associated text field.
    5. -
- -

Note: The domain shown in this example is fictitious and [yourDomain] - should be replaced with a real domain.

-
-
-package {
-	import flash.display.Sprite;
-	import flash.text.TextField;
-	import flash.text.TextFieldType;
-	import flash.text.TextFieldAutoSize;
-	import flash.events.TextEvent;
-	import flash.events.TextEvent;
-	import flash.net.URLRequest;
-	import flash.net.navigateToURL;
-	
-	public class TextEventExample extends Sprite {
-		private const DOMAIN_1_URL:String = "http://www.[yourDomain].com";
-		private const DOMAIN_2_URL:String = "http://www.[yourDomain].com";
-		private var linkTxt:TextField;
-		private var textInputTxt:TextField;
-		
-		public function TextEventExample() {
-			init();
-			draw();
-		}
-		
-		private function init():void {
-			linkTxt = new TextField();
-			linkTxt.addEventListener(TextEvent.LINK, linkHandler);
-			linkTxt.height = 60;
-			linkTxt.autoSize = TextFieldAutoSize.LEFT;			
-			linkTxt.multiline = true;
-				
-			textInputTxt = new TextField();
-			textInputTxt.addEventListener(TextEvent.TEXT_INPUT, textInputHandler);
-			textInputTxt.type = TextFieldType.INPUT;
-			textInputTxt.background = true;
-			textInputTxt.border = true;
-			textInputTxt.height = 20;			
-		}
-		
-		private function draw():void {
-			addChild(linkTxt);
-			linkTxt.htmlText += createLink(DOMAIN_1_URL, "Click to go to first domain");
-			linkTxt.htmlText += "<br />";
-			linkTxt.htmlText += createLink(DOMAIN_2_URL, "Click to go to second domain");
-
-			addChild(textInputTxt);
-			textInputTxt.y = linkTxt.height;
-			textInputTxt.text = "type here";
-		}
-		
-		private function createLink(url:String, text:String):String {
-			var link:String = "";
-			link += "<font color='#0000FF'>";
-			link += "<u>";
-			link += "<b>";
-			link += "<a href='event:" + url + "'>" + text + "</a>";
-			link += "</b>";
-			link += "</u>";
-			link += "</font>";
-			return link;
-		}
-		
-		private function linkHandler(e:TextEvent):void {
-			var request:URLRequest = new URLRequest(e.text);
-			navigateToURL(request);
-		}
-		
-		private function textInputHandler(e:TextEvent):void {
-			trace(">> ============================");
-			trace(">> e.text: " + e.text);
-			trace(">> textInputTxt.text: " + textInputTxt.text);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/ThrottleEvent.html b/html-docs/flash/events/ThrottleEvent.html deleted file mode 100644 index 1be956e..0000000 --- a/html-docs/flash/events/ThrottleEvent.html +++ /dev/null @@ -1,958 +0,0 @@ - - - - - - - - -flash.events.ThrottleEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class ThrottleEvent
InheritanceThrottleEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.2 -
-

-

- A ThrottleEvent is dispatched when the Flash Player throttles, pauses, or resumes content. - There is only one type of ThrottleEvent event: ThrottleEvent.THROTTLE. -

This event is a broadcast event, which means that it is dispatched by all EventDispatcher - objects with a listener registered for this event. For more information about broadcast - events, see the DisplayObject class.

-

Note: This event has neither a "capture phase" nor a "bubble phase", which means that event - listeners must be added directly to any potential targets, whether the target is on the display list or not.

-

The Flash Player can throttle the content to a low frame rate (meaning the frame rate is reduced - to a value typically between 2 and 8 fps). Content can be throttled when its tab is hidden or minimized. - On a mobile device, content can be throttled when the backlight goes off or screensaver mode - comes on. Prior to throttling the content, a ThrottleEvent is dispatched with - ThrottleEvent.state=ThrottleType.THROTTLE. - The ThrottleEvent.targetFrameRate property contains the value - of the new target frame rate.

-

The content can run code in the event listener to prepare for the throttle. - This is an opportunity to alert external content that the throttled content is much less - responsive. For instance, an active FileReference.upload() - or FileReference.download() method could be - canceled. Or, if content is communicating using LocalConnection with another SWF, this is an - opportunity to inform that SWF to expect less responsiveness. Note that the throttled content may - not be able to complete asynchronous actions prior to entering the throttle. Content enters - the throttled state when the event listener returns.

-

The Flash Player can pause content. For example, content can be paused when it is scrolled - offscreen on a mobile device at a time when no audio or video is playing. Prior to pausing the - content, a ThrottleEvent is dispatched with ThrottleEvent.state=ThrottleType.PAUSE and - ThrottleEvent.targetFrameRate=0. - Similar to when the content receives a ThrottleType.THROTTLE event, - the content can run code in the event listener to prepare for the pause. When the event listener - returns, the content enters the paused state. While paused, the content does not respond - to user interaction, such as mouse clicks or keyboard entry. However, ActionScript network events - can still be received.

-

When the Flash Player resumes the content from a throttled or paused state, a - ThrottleEvent is dispatched with ThrottleEvent.state=ThrottleType.RESUME. - ThrottleEvent.targetFrameRate describes the frame rate and is normally equal to Stage.frameRate. - Content may be resumed when any part of the stage becomes visible or when the user makes a request for - the content to be resumed.

-

The platforms that support throttling and pausing are currently the following: Flash Player Desktop Mac - and Windows, AIR Mobile, and Flash Player Android. The following platforms do not dispatch the ThrottleEvent - automatically because they do not yet support pausing or throttling: AIR for TV devices, AIR for - desktop, and Flash Player Linux Desktop.

-

-

-See also -

-
-flash.display.DisplayObject -
-flash.display.Stage -
-flash.events.ThrottleType -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  state : String -
[read-only] - Describes the state that the player is entering: - ThrottleType.THROTTLE, ThrottleType.PAUSE, or ThrottleType.RESUME.
-		ThrottleEvent
 Inheritedtarget : Object -
- The event target.
-		Event
  targetFrameRate : Number -
[read-only] - The frame rate that Flash Player or AIR targets after the ThrottleEvent is dispatched.
-		ThrottleEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ThrottleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, state:String = null, targetFrameRate:Number = 0)
-
- Creates an Event object that contains information about the ThrottleEvent.
-		ThrottleEvent
   -
-clone():Event -
-
- Creates a copy of the ThrottleEvent object and sets the value of each property to match that of the original.
-		ThrottleEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the ThrottleEvent object.
-		ThrottleEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
  THROTTLE : String = "throttle"
[static] - Defines the value of the type property of a ThrottleEvent event object.
-		ThrottleEvent
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
stateproperty
-
-state:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.2 -
-

- Describes the state that the player is entering: - ThrottleType.THROTTLE, ThrottleType.PAUSE, or ThrottleType.RESUME. -

Implementation -
-    public function get state():String -
-

-See also -

-
-flash.events.ThrottleType -
-
- - - - - -
targetFrameRateproperty 
-
-targetFrameRate:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.2 -
-

- The frame rate that Flash Player or AIR targets after the ThrottleEvent is dispatched. - -

For example, if the content is being paused, targetFrameRate is 0. - If the content is being throttled, then targetFrameRate is typically between - 2 and 8, depending on which platform the content is running on, - whether audio is playing, and other factors. - If the content is returned to the expected frame rate after being paused or throttled, - targetFrameRate equals Stage.frameRate.

- Implementation -
-    public function get targetFrameRate():Number -
-

-See also -

-
-flash.display.Stage -
-
- -
Constructor detail
- - - - - -
ThrottleEvent()constructor
-
-public function ThrottleEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, state:String = null, targetFrameRate:Number = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.2 -
-

- Creates an Event object that contains information about the ThrottleEvent. - Event objects are passed as parameters to event listeners. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. - There is only one type of ThrottleEvent event: ThrottleEvent.THROTTLE. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access - this information through the inherited bubbles property. - -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited - cancelable property. - -
 
state:String (default = null) — ThrottleType.THROTTLE, ThrottleType.PAUSE, or ThrottleType.RESUME. -
 
targetFrameRate:Number (default = 0) — Describes the frame rate that Flash Player or AIR will target after the - ThrottleEvent is dispatched. For example, if the content is being paused, targetFrameRate is 0. If the content is - being throttled, then targetFrameRate is typically between 2 and 8, depending on which platform the content is running on, - whether audio is playing, and other factors. If the content is returned to the expected frame rate after being paused or throttled, - targetFrameRate equals Stage.frameRate. -
-

-See also -

-
-flash.display.Stage -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.2 -
-

- Creates a copy of the ThrottleEvent object and sets the value of each property to match that of the original. - -

-Returns - - - - -
Event — - A new ThrottleEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.2 -
-

- Returns a string that contains all the properties of the ThrottleEvent object. - The string is in the following format: - -

[ThrottleEvent type=value bubbles=value cancelable=value state=value targetFrameRate=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the ThrottleEvent object. - - -
-
- -
Constant detail
- - - - - -
THROTTLEconstant
-
-public static const THROTTLE:String = "throttle" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.2 -
-

- Defines the value of the type property of a ThrottleEvent event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetAny DisplayObject instance with a listener registered for the throttle event.
stateThrottleType.THROTTLE, ThrottleType.PAUSE, or ThrottleType.RESUME.
targetFrameRateDescribes the frame rate that Flash Player or AIR will target after the - ThrottleEvent is dispatched. For example, if the content is being paused, targetFrameRate will be 0. If the content is - being throttled, then targetFrameRate is typically between 2 and 8, depending on which platform the content is running on, - whether audio is playing, and other factors. If the content is returned to the expected frame rate after being paused or throttled, - targetFrameRate equals Stage.frameRate.
-

-See also -

-
-flash.display.Stage -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/ThrottleType.html b/html-docs/flash/events/ThrottleType.html deleted file mode 100644 index 6cf0ce6..0000000 --- a/html-docs/flash/events/ThrottleType.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - - - -flash.events.ThrottleType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic final class ThrottleType
InheritanceThrottleType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.2 -
-

-

- The ThrottleType class provides values for the playback state property - of the flash.event.ThrottleEvent class. - -

The platforms that support throttling and pausing are currently the following: Flash Player Desktop Mac - and Windows, AIR Mobile, and Flash Player Android. The following platforms do not dispatch the ThrottleEvent - automatically because they do not yet support pausing or throttling: AIR for TV devices, AIR for - desktop, and Flash Player Linux Desktop.

-

-

-See also -

-
-flash.events.ThrottleEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  PAUSE : String = "pause"
[static] - This constant is used for the status property in the ThrottleEvent class.
-		ThrottleType
  RESUME : String = "resume"
[static] - This constant is used for the status property in the ThrottleEvent class.
-		ThrottleType
  THROTTLE : String = "throttle"
[static] - This constant is used for the state property in the ThrottleEvent class.
-		ThrottleType
-
- -
- -
Constant detail
- - - - - -
PAUSEconstant
-
-public static const PAUSE:String = "pause" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.2 -
-

- This constant is used for the status property in the ThrottleEvent class. - Use the syntax ThrottleType.PAUSE. -

-See also -

-
-flash.events.ThrottleEvent -
-
- - - - - -
RESUMEconstant 
-
-public static const RESUME:String = "resume" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.2 -
-

- This constant is used for the status property in the ThrottleEvent class. - Use the syntax ThrottleType.RESUME. -

-See also -

-
-flash.events.ThrottleEvent -
-
- - - - - -
THROTTLEconstant 
-
-public static const THROTTLE:String = "throttle" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.2 -
-

- This constant is used for the state property in the ThrottleEvent class. - Use the syntax ThrottleType.THROTTLE. -

-See also -

-
-flash.events.ThrottleEvent -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/TimerEvent.html b/html-docs/flash/events/TimerEvent.html deleted file mode 100644 index 1425529..0000000 --- a/html-docs/flash/events/TimerEvent.html +++ /dev/null @@ -1,914 +0,0 @@ - - - - - - - - -flash.events.TimerEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class TimerEvent
InheritanceTimerEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- A Timer object dispatches a TimerEvent objects whenever the Timer object reaches the interval - specified by the Timer.delay property. -

-

-View the examples. -

-

-See also -

-
-flash.utils.Timer -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TimerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
-
- Creates an Event object with specific information relevant to timer events.
-		TimerEvent
   -
-clone():Event -
-
- Creates a copy of the TimerEvent object and sets each property's value to match that of the original.
-		TimerEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the TimerEvent object.
-		TimerEvent
   -
-updateAfterEvent():void -
-
- Instructs Flash Player or the AIR runtime to render - after processing of this event completes, if the display list has been modified.
-		TimerEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
  TIMER : String = "timer"
[static] - Defines the value of the type property of a timer event object.
-		TimerEvent
  TIMER_COMPLETE : String = "timerComplete"
[static] - Defines the value of the type property of a timerComplete event object.
-		TimerEvent
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Constructor detail
- - - - - -
TimerEvent()constructor
-
-public function TimerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates an Event object with specific information relevant to timer events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of the TimerEvent object and sets each property's value to match that of the original. -

-Returns - - - - -
Event — - A new TimerEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains all the properties of the TimerEvent object. The string is in the following format: -

[TimerEvent type=value bubbles=value cancelable=value]

-

-Returns - - - - -
String — - A string that contains all the properties of the TimerEvent object. - - -
-
- - - - - -
updateAfterEvent()method 
-
-public function updateAfterEvent():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Instructs Flash Player or the AIR runtime to render - after processing of this event completes, if the display list has been modified. -


-Example -
The following is an example for the TimerEvent.updateAfterEvent() method. -
-
-function onTimer(event:TimerEvent):void {
-    if (40 < my_mc.x && my_mc.x < 375) {
-		my_mc.x-= 50;
-	} else {
-		my_mc.x=374;
-	}
-	event.updateAfterEvent();
-}
-
-var moveTimer:Timer=new Timer(50,250);
-moveTimer.addEventListener(TimerEvent.TIMER,onTimer);
-moveTimer.start();
-
-

-
- -
Constant detail
- - - - - -
TIMERconstant
-
-public static const TIMER:String = "timer" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Defines the value of the type property of a timer event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Timer object that has reached its interval.
-

-See also -

-
-flash.utils.Timer.timer -
-
- - - - - -
TIMER_COMPLETEconstant 
-
-public static const TIMER_COMPLETE:String = "timerComplete" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Defines the value of the type property of a timerComplete event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Timer object that has completed its requests.
-

-See also -

-
-flash.utils.Timer.timerComplete -
-
- -
Examples
-
examples\TimerEventExample
-
The following example uses the TimerExample class to show how a - listener method timerHandler() can be instantiated and set to listen for a new TimerEvent - to be dispatched, which happens when the Timer's start() method is called. -
-
-package {
-    import flash.utils.Timer;
-	import flash.events.TimerEvent;
-	import flash.display.Sprite;
-
-	public class TimerEventExample extends Sprite {
-
-		public function TimerEventExample() {
-			var myTimer:Timer = new Timer(1000, 2);
-			myTimer.addEventListener(TimerEvent.TIMER, timerHandler);
-			myTimer.start();
-		}
-
-		public function timerHandler(event:TimerEvent):void {
-			trace("timerHandler: " + event);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/TouchEvent.html b/html-docs/flash/events/TouchEvent.html deleted file mode 100644 index 6585e39..0000000 --- a/html-docs/flash/events/TouchEvent.html +++ /dev/null @@ -1,3092 +0,0 @@ - - - - - - - - -flash.events.TouchEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class TouchEvent
InheritanceTouchEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The TouchEvent class lets you handle events on devices that detect user contact with - the device (such as a finger on a touch screen). - -

When a user interacts with a device such as a mobile phone or tablet with a touch screen, the user typically - touches the screen with his or her fingers or a pointing device. You can develop applications that respond to - basic touch events (such as a single finger tap) with the TouchEvent class. Create event listeners using the event types defined in this class. - For user interaction with multiple points of contact (such as several fingers moving across a touch screen at the same time) use - the related GestureEvent, PressAndTapGestureEvent, and TransformGestureEvent classes. And, use the properties and methods of these classes - to construct event handlers that respond to the user touching the device.

- -

Use the Multitouch class to determine the current environment's support for touch interaction, and to - manage the support of touch interaction if the current environment supports it.

- -

Note: When objects are nested on the display list, touch events target the deepest possible - nested object that is visible in the display list. This object is called the target node. To have a target node's - ancestor (an object containing the target node in the display list) receive notification of a touch event, use - EventDispatcher.addEventListener() on the ancestor node with the type parameter set to the specific - touch event you want to detect.

- -

In AIR 3, and above, you can listen for proximity events on supported Android devices that have an active stylus. On such devices, - proximityMove and touchMove event objects provide a byte array containing path and pressure - samples taken since the previous move event. You can use these samples to construct the path of the stylus between touch events. - (Note that hit-testing for interaction of the stylus input with the display list only occurs at the end of a path segment.)

- -

-

-View the examples. -

-

-See also -

-
-flash.ui.Multitouch -
-flash.events.GestureEvent -
-flash.events.TransformGestureEvent -
-flash.events.PressAndTapGestureEvent -
-flash.events.MouseEvent -
-flash.events.EventDispatcher.addEventListener() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  altKey : Boolean -
- Indicates whether the Alt key is active (true) or inactive (false).
-		TouchEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
  commandKey : Boolean -
- Indicates whether the command key is activated (Mac only).
-		TouchEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  controlKey : Boolean -
- Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
-		TouchEvent
  ctrlKey : Boolean -
- On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
-		TouchEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  isPrimaryTouchPoint : Boolean -
- Indicates whether the first point of contact is mapped to mouse events.
-		TouchEvent
  isRelatedObjectInaccessible : Boolean -
- If true, the relatedObject property is set to null for - reasons related to security sandboxes.
-		TouchEvent
  isTouchPointCanceled : Boolean -
- Reports that this touch input sequence was canceled by the operating system.
-		TouchEvent
  localX : Number -
- The horizontal coordinate at which the event occurred relative to the containing sprite.
-		TouchEvent
  localY : Number -
- The vertical coordinate at which the event occurred relative to the containing sprite.
-		TouchEvent
  pressure : Number -
- A value between 0.0 and 1.0 indicating force of the contact with the device.
-		TouchEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  relatedObject : InteractiveObject -
- A reference to a display list object that is related to the event.
-		TouchEvent
  shiftKey : Boolean -
- Indicates whether the Shift key is active (true) or inactive - (false).
-		TouchEvent
  sizeX : Number -
- Width of the contact area.
-		TouchEvent
  sizeY : Number -
- Height of the contact area.
-		TouchEvent
  stageX : Number -
[read-only] - The horizontal coordinate at which the event occurred in global Stage coordinates.
-		TouchEvent
  stageY : Number -
[read-only] - The vertical coordinate at which the event occurred in global Stage coordinates.
-		TouchEvent
 Inheritedtarget : Object -
- The event target.
-		Event
  timestamp : Number -
- Reports the time of the event in relative milliseconds.
-		TouchEvent
  touchIntent : String -
- Reports whether the touch was generated by the primary or the eraser end of a stylus.
-		TouchEvent
  touchPointID : int -
- A unique identification number (as an int) assigned to the touch point.
-		TouchEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TouchEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, touchPointID:int = 0, isPrimaryTouchPoint:Boolean = false, localX:Number, localY:Number, sizeX:Number, sizeY:Number, pressure:Number, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false, timestamp:Number, touchIntent:String, samples:ByteArray = null, isTouchPointCanceled:Boolean = false)
-
- Creates an Event object that contains information about touch events.
-		TouchEvent
   -
-clone():Event -
-
- Creates a copy of the TouchEvent object and sets the value of each property to match that of the original.
-		TouchEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
   -
-getSamples(buffer:ByteArray, append:Boolean = false):uint -
-
- Updates the specified ByteArray object with the high-frequency data points for a multi-point touch event.
-		TouchEvent
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-isToolButtonDown(index:int):Boolean -
-
- Reports that the hardware button at the specified index is pressed.
-		TouchEvent
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the TouchEvent object.
-		TouchEvent
   -
-updateAfterEvent():void -
-
- Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
-		TouchEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
  PROXIMITY_BEGIN : String = "proximityBegin"
[static] - Defines the value of the type property of a PROXIMITY_BEGIN - touch event object.
-		TouchEvent
  PROXIMITY_END : String = "proximityEnd"
[static] - Defines the value of the type property of a PROXIMITY_END - touch event object.
-		TouchEvent
  PROXIMITY_MOVE : String = "proximityMove"
[static] - Defines the value of the type property of a PROXIMITY_MOVE - touch event object.
-		TouchEvent
  PROXIMITY_OUT : String = "proximityOut"
[static] - Defines the value of the type property of a PROXIMITY_OUT - touch event object.
-		TouchEvent
  PROXIMITY_OVER : String = "proximityOver"
[static] - Defines the value of the type property of a PROXIMITY_OVER - touch event object.
-		TouchEvent
  PROXIMITY_ROLL_OUT : String = "proximityRollOut"
[static] - Defines the value of the type property of a PROXIMITY_ROLL_OUT - touch event object.
-		TouchEvent
  PROXIMITY_ROLL_OVER : String = "proximityRollOver"
[static] - Defines the value of the type property of a PROXIMITY_ROLL_OVER - touch event object.
-		TouchEvent
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
  TOUCH_BEGIN : String = "touchBegin"
[static] - Defines the value of the type property of a TOUCH_BEGIN touch event object.
-		TouchEvent
  TOUCH_END : String = "touchEnd"
[static] - Defines the value of the type property of a TOUCH_END touch event object.
-		TouchEvent
  TOUCH_MOVE : String = "touchMove"
[static] - Defines the value of the type property of a TOUCH_MOVE touch event object.
-		TouchEvent
  TOUCH_OUT : String = "touchOut"
[static] - Defines the value of the type property of a TOUCH_OUT touch event object.
-		TouchEvent
  TOUCH_OVER : String = "touchOver"
[static] - Defines the value of the type property of a TOUCH_OVER touch event object.
-		TouchEvent
  TOUCH_ROLL_OUT : String = "touchRollOut"
[static] - Defines the value of the type property of a TOUCH_ROLL_OUT touch event object.
-		TouchEvent
  TOUCH_ROLL_OVER : String = "touchRollOver"
[static] - Defines the value of the type property of a TOUCH_ROLL_OVER touch event object.
-		TouchEvent
  TOUCH_TAP : String = "touchTap"
[static] - Defines the value of the type property of a TOUCH_TAP touch event object.
-		TouchEvent
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
altKeyproperty
-
-altKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the Alt key is active (true) or inactive (false). - Supported for Windows and Linux operating systems only. -

Implementation -
-    public function get altKey():Boolean -
-    public function set altKey(value:Boolean):void -
-
- - - - - -
commandKeyproperty 
-
-commandKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the command key is activated (Mac only). - -

On a Mac OS, the value of the commandKey property - is the same value as the ctrlKey property. - This property is always false on Windows or Linux.

- Implementation -
-    public function get commandKey():Boolean -
-    public function set commandKey(value:Boolean):void -
-
- - - - - -
controlKeyproperty 
-
-controlKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux. -

Implementation -
-    public function get controlKey():Boolean -
-    public function set controlKey(value:Boolean):void -
-
- - - - - -
ctrlKeyproperty 
-
-ctrlKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false). - On Macintosh, indicates whether either the Control key or the Command key is activated. -

Implementation -
-    public function get ctrlKey():Boolean -
-    public function set ctrlKey(value:Boolean):void -
-
- - - - - -
isPrimaryTouchPointproperty 
-
-isPrimaryTouchPoint:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the first point of contact is mapped to mouse events. -

Implementation -
-    public function get isPrimaryTouchPoint():Boolean -
-    public function set isPrimaryTouchPoint(value:Boolean):void -
-

-See also -

-
-flash.events.MouseEvent -
-
- - - - - -
isRelatedObjectInaccessibleproperty 
-
-isRelatedObjectInaccessible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- If true, the relatedObject property is set to null for - reasons related to security sandboxes. If the nominal value of relatedObject is a reference to a - DisplayObject in another sandbox, relatedObject is set to - null unless there is permission in both directions across this sandbox boundary. Permission is - established by calling Security.allowDomain() from a SWF file, or by providing - a policy file from the server of an image file, and setting the LoaderContext.checkPolicyFile - property when loading the image. -

Implementation -
-    public function get isRelatedObjectInaccessible():Boolean -
-    public function set isRelatedObjectInaccessible(value:Boolean):void -
-

-See also -

-
-MouseEvent.relatedObject -
-Security.allowDomain() -
-LoaderContext.checkPolicyFile -
-
- - - - - -
isTouchPointCanceledproperty 
-
-isTouchPointCanceled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Reports that this touch input sequence was canceled by the operating system. - -

Touch events can be canceled for a variety of reasons, such as when a palm-generated touch - is rejected because a pen stylus is in use. isTouchPointCanceled - can only be true in a touchEnd event.

- - Implementation -
-    public function get isTouchPointCanceled():Boolean -
-    public function set isTouchPointCanceled(value:Boolean):void -
-
- - - - - -
localXproperty 
-
-localX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

- The horizontal coordinate at which the event occurred relative to the containing sprite. -

Implementation -
-    public function get localX():Number -
-    public function set localX(value:Number):void -
-
- - - - - -
localYproperty 
-
-localY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

- The vertical coordinate at which the event occurred relative to the containing sprite. -

Implementation -
-    public function get localY():Number -
-    public function set localY(value:Number):void -
-
- - - - - -
pressureproperty 
-
-pressure:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

- A value between 0.0 and 1.0 indicating force of the contact with the device. - If the device does not support detecting the pressure, the value is 1.0. -

Implementation -
-    public function get pressure():Number -
-    public function set pressure(value:Number):void -
-
- - - - - -
relatedObjectproperty 
-
-relatedObject:InteractiveObject  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A reference to a display list object that is related to the event. For example, when a touchOut event occurs, - relatedObject represents the display list object to which the pointing device now points. - This property applies to the touchOut, touchOver, touchRollOut, and touchRollOver events. -

The value of this property can be null in two circumstances: if there is no related object, - or there is a related object, but it is in a security sandbox to which you don't have access. - Use the isRelatedObjectInaccessible() property to determine which of these reasons applies.

- Implementation -
-    public function get relatedObject():InteractiveObject -
-    public function set relatedObject(value:InteractiveObject):void -
-

-See also -

-
-TouchEvent.isRelatedObjectInaccessible -
-
- - - - - -
shiftKeyproperty 
-
-shiftKey:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the Shift key is active (true) or inactive - (false). -

Implementation -
-    public function get shiftKey():Boolean -
-    public function set shiftKey(value:Boolean):void -
-
- - - - - -
sizeXproperty 
-
-sizeX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

- Width of the contact area. -

Implementation -
-    public function get sizeX():Number -
-    public function set sizeX(value:Number):void -
-
- - - - - -
sizeYproperty 
-
-sizeY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

- Height of the contact area. -

Implementation -
-    public function get sizeY():Number -
-    public function set sizeY(value:Number):void -
-
- - - - - -
stageXproperty 
-
-stageX:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The horizontal coordinate at which the event occurred in global Stage coordinates. - This property is calculated when the localX property is set. -

Implementation -
-    public function get stageX():Number -
-
- - - - - -
stageYproperty 
-
-stageY:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The vertical coordinate at which the event occurred in global Stage coordinates. - This property is calculated when the localY property is set. -

Implementation -
-    public function get stageY():Number -
-
- - - - - -
timestampproperty 
-
-timestamp:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Reports the time of the event in relative milliseconds. - -

The times reported are relative to the time the application started execution. - For events that return a sequence of points in the samples buffer, this timestamp - reflects the elapsed time of the last sample in the buffer.

- - Implementation -
-    public function get timestamp():Number -
-    public function set timestamp(value:Number):void -
-

-See also -

-
-getSamples() -
-
- - - - - -
touchIntentproperty 
-
-touchIntent:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Reports whether the touch was generated by the primary or the eraser end of a stylus. - -

If a touch event is generated by a finger or other non-stylus input method, - or a stylus for which high-frequency motion tracking is not supported, this property reports - the value: TouchEventIntent.UNKNOWN.

- -

The TouchEventIntent class defines constants for the possible values of this property, - which include:

-
    -
  • TouchEventIntent.ERASER
    • -
  • TouchEventIntent.PEN
    • -
  • TouchEventIntent.UNKNOWN
    • -
- - Implementation -
-    public function get touchIntent():String -
-    public function set touchIntent(value:String):void -
-

-See also -

-
-TouchEventIntent -
-
- - - - - -
touchPointIDproperty 
-
-touchPointID:int  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- A unique identification number (as an int) assigned to the touch point. -

Implementation -
-    public function get touchPointID():int -
-    public function set touchPointID(value:int):void -
-
-Example -
The following example establishes a variable touchMoveID to test for the correct touchPointID - value before responding to a touch move event. Otherwise, other touch input triggers the event handler, too. Notice the listeners for - the move and end phases are on the stage, not the display object. The stage listens for the move or end phases in case the user's touch - moves beyond the display object boundaries. -
-
-Multitouch.inputMode = MultitouchInputMode.TOUCH_POINT; 
-
-var mySprite:Sprite = new Sprite(); 
-mySprite.graphics.beginFill(0x336699); 
-mySprite.graphics.drawRect(0,0,40,40); 
-addChild(mySprite); 
-
-var myTextField:TextField = new TextField(); 
-addChild(myTextField); 
-myTextField.width = 200; 
-myTextField.height = 20; 
-
-var touchMoveID:int = 0; 
- 
-mySprite.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin); 
-function onTouchBegin(event:TouchEvent) { 
-    if(touchMoveID != 0) { 
-		myTextField.text = "already moving. ignoring new touch";	 
-		return; 
-	} 
-	touchMoveID = event.touchPointID; 
- 
-	myTextField.text = "touch begin" + event.touchPointID; 
-	stage.addEventListener(TouchEvent.TOUCH_MOVE, onTouchMove); 
-	stage.addEventListener(TouchEvent.TOUCH_END, onTouchEnd); 
-} 
-function onTouchMove(event:TouchEvent) { 
-	if(event.touchPointID != touchMoveID) { 
-		myTextField.text = "ignoring unrelated touch"; 
-		return; 
-	} 
-	mySprite.x = event.stageX; 
-	mySprite.y = event.stageY; 
-	myTextField.text = "touch move" + event.touchPointID; 
-} 
-function onTouchEnd(event:TouchEvent) { 
-	if(event.touchPointID != touchMoveID) { 
-		myTextField.text = "ignoring unrelated touch end"; 
-		return; 
-	} 
-	touchMoveID = 0; 
-	stage.removeEventListener(TouchEvent.TOUCH_MOVE, onTouchMove); 
-	stage.removeEventListener(TouchEvent.TOUCH_END, onTouchEnd); 
-	myTextField.text = "touch end" + event.touchPointID; 
-}
-
-

-
- -
Constructor detail
- - - - - -
TouchEvent()constructor
-
-public function TouchEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, touchPointID:int = 0, isPrimaryTouchPoint:Boolean = false, localX:Number, localY:Number, sizeX:Number, sizeY:Number, pressure:Number, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false, timestamp:Number, touchIntent:String, samples:ByteArray = null, isTouchPointCanceled:Boolean = false) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates an Event object that contains information about touch events. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are: - TouchEvent.PROXIMITY_BEGIN, - TouchEvent.PROXIMITY_END, TouchEvent.PROXIMITY_MOVE, - TouchEvent.PROXIMITY_OUT, TouchEvent.PROXIMITY_OVER, - TouchEvent.PROXIMITY_ROLL_OUT, TouchEvent.PROXIMITY_ROLL_OVER, - TouchEvent.TOUCH_BEGIN, - TouchEvent.TOUCH_END, TouchEvent.TOUCH_MOVE, - TouchEvent.TOUCH_OUT, TouchEvent.TOUCH_OVER, - TouchEvent.TOUCH_ROLL_OUT, TouchEvent.TOUCH_ROLL_OVER, - and TouchEvent.TOUCH_TAP. - -
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling phase of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
 
touchPointID:int (default = 0) — A unique identification number (as an int) assigned to the touch point. -
 
isPrimaryTouchPoint:Boolean (default = false) — Indicates whether the first point of contact is mapped to mouse events. -
 
localX:Number — The horizontal coordinate at which the event occurred relative to the containing sprite. -
 
localY:Number — The vertical coordinate at which the event occurred relative to the containing sprite. -
 
sizeX:Number — Width of the contact area. -
 
sizeY:Number — Height of the contact area. -
 
pressure:Number — A value between 0.0 and 1.0 indicating force of the contact with the device. - If the device does not support detecting the pressure, the value is 1.0. -
 
relatedObject:InteractiveObject (default = null) — The complementary InteractiveObject instance that is affected by the event. For example, when a touchOut event occurs, - relatedObject represents the display list object to which the pointing device now points. -
 
ctrlKey:Boolean (default = false) — On Windows or Linux, indicates whether the Ctrl key is activated. On Mac, indicates whether either the Ctrl key or the Command key is activated. -
 
altKey:Boolean (default = false) — Indicates whether the Alt key is activated (Windows or Linux only). -
 
shiftKey:Boolean (default = false) — Indicates whether the Shift key is activated. -
 
commandKey:Boolean (default = false) — (AIR only) Indicates whether the Command key is activated (Mac only). This parameter is for Adobe AIR only; do not set it for Flash Player content. -
 
controlKey:Boolean (default = false) — (AIR only) Indicates whether the Control or Ctrl key is activated. This parameter is for Adobe AIR only; do not set it for Flash Player content. -
 
timestamp:Number — (AIR only) The timestamp of the event in milliseconds relative to the start of the application. -
 
touchIntent:String — (AIR only) A value from the TouchEventIntent class. -
 
samples:ByteArray (default = null) — (AIR only) A ByteArray object containing position and pressure readings for each intermediate sample - recorded since the last touch or proximity event in a sequence. -
 
isTouchPointCanceled:Boolean (default = false) — (AIR only) true if the touch event is canceled because of a rejected touch type. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a copy of the TouchEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new TouchEvent object with property values that match those of the original. - - - -
-
- - - - - -
getSamples()method 
-
-public function getSamples(buffer:ByteArray, append:Boolean = false):uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Updates the specified ByteArray object with the high-frequency data points for a multi-point touch event. - -

The ByteArray object referenced by the buffer parameter is updated with values for - the intermediate data points between this and the previous touch event. Three floating point - values are added for each sample: an x coordinate, a y coordinate, and a pressure value. - The position values reported in stage coordinates. The pressure is reported as a value between - 0 and 1. Samples are recorded at regular time intervals. The exact frequency depends on the device - hardware and hardware drivers. Typical sample frequencies are around 133 Hz. Note that touch - events are not dispatched at exact intervals. Thus, the buffer for similar events can contain - a different number of samples. The last sample in the buffer has the same data as the - stageX, stageY, and pressure properties of this touch - event object.

- -

A sample buffer is included in the event objects dispatched for proximityMove - and touchMove events.

- - Parameters - - - - - - - - - - -
buffer:ByteArray — the ByteArray object to receive the sample data. -
 
append:Boolean (default = false) — when true, the samples are added to the buffer - byte array starting at the array's current position property. - When false, the default, existing data in the buffer object is discarded before the samples are added. - -
-

-Returns - - - - -
uint — - uint the number of samples added to the buffer. Each sample consists of three floating point Numbers. - - - -
-

-See also -

-
-ByteArray.readFloat() -
-ByteArray.position -
-ByteArray.bytesAvailable -
-
-Example -
-
-
import flash.events.TouchEvent;
-
-
-
The following example illustrates how to retrieve the sample data from - a touchMove or proximityMove event: -
-
-

-
-
import flash.events.TouchEvent;
-import flash.events.TouchEventIntent;
-import flash.utils.ByteArray;
-
-
-
The following example illustrates how to retrieve the sample data from - a touchMove or proximityMove event. In this example, the samples are appended to an existing - byte array: -
-
-

-
- - - - - -
isToolButtonDown()method 
-
-public function isToolButtonDown(index:int):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Reports that the hardware button at the specified index is pressed. - -

Parameters - - - - -
index:int — the zero-based index of the buttons supported by a stylus-type - input device. - -
-

-Returns - - - - -
Boolean
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that contains all the properties of the TouchEvent object. The string is in the following format: -

[TouchEvent type=value bubbles=value cancelable=value ... ]

-

-Returns - - - - -
String — - A string that contains all the properties of the TouchEvent object. - - - -
-
- - - - - -
updateAfterEvent()method 
-
-public function updateAfterEvent():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified. -

- -
Constant detail
- - - - - -
PROXIMITY_BEGINconstant
-
-public static const PROXIMITY_BEGIN:String = "proximityBegin" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Defines the value of the type property of a PROXIMITY_BEGIN - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.display.InteractiveObject.proximityBegin -
-
- - - - - -
PROXIMITY_ENDconstant 
-
-public static const PROXIMITY_END:String = "proximityEnd" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Defines the value of the type property of a PROXIMITY_END - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.display.InteractiveObject.proximityEnd -
-
- - - - - -
PROXIMITY_MOVEconstant 
-
-public static const PROXIMITY_MOVE:String = "proximityMove" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Defines the value of the type property of a PROXIMITY_MOVE - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.display.InteractiveObject.proximityMove -
-
- - - - - -
PROXIMITY_OUTconstant 
-
-public static const PROXIMITY_OUT:String = "proximityOut" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Defines the value of the type property of a PROXIMITY_OUT - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.display.InteractiveObject.proximityOUT -
-
- - - - - -
PROXIMITY_OVERconstant 
-
-public static const PROXIMITY_OVER:String = "proximityOver" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Defines the value of the type property of a PROXIMITY_OVER - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.display.InteractiveObject.proximityOver -
-
- - - - - -
PROXIMITY_ROLL_OUTconstant 
-
-public static const PROXIMITY_ROLL_OUT:String = "proximityRollOut" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Defines the value of the type property of a PROXIMITY_ROLL_OUT - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.display.InteractiveObject.proximityRollOut -
-
- - - - - -
PROXIMITY_ROLL_OVERconstant 
-
-public static const PROXIMITY_ROLL_OVER:String = "proximityRollOver" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Defines the value of the type property of a PROXIMITY_ROLL_OVER - touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
timestamp(AIR only) The timestamp of the event in milliseconds relative to the start of the application.
touchIntent(AIR only) A value from the TouchEventIntent class.
isTouchPointCanceled(AIR only) true if the touch event is canceled because of the device's touch-rejection logic.
- -

-See also -

-
-flash.display.InteractiveObject.proximityRollOver -
-
- - - - - -
TOUCH_BEGINconstant 
-
-public static const TOUCH_BEGIN:String = "touchBegin" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a TOUCH_BEGIN touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-flash.display.InteractiveObject.touchBegin -
-
- - - - - -
TOUCH_ENDconstant 
-
-public static const TOUCH_END:String = "touchEnd" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a TOUCH_END touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-flash.display.InteractiveObject.touchEnd -
-
- - - - - -
TOUCH_MOVEconstant 
-
-public static const TOUCH_MOVE:String = "touchMove" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a TOUCH_MOVE touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-flash.display.InteractiveObject.touchMove -
-
- - - - - -
TOUCH_OUTconstant 
-
-public static const TOUCH_OUT:String = "touchOut" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a TOUCH_OUT touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-flash.display.InteractiveObject.touchOut -
-
- - - - - -
TOUCH_OVERconstant 
-
-public static const TOUCH_OVER:String = "touchOver" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a TOUCH_OVER touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-flash.display.InteractiveObject.touchOver -
-
- - - - - -
TOUCH_ROLL_OUTconstant 
-
-public static const TOUCH_ROLL_OUT:String = "touchRollOut" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a TOUCH_ROLL_OUT touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-flash.display.InteractiveObject.touchRollOut -
-
- - - - - -
TOUCH_ROLL_OVERconstant 
-
-public static const TOUCH_ROLL_OVER:String = "touchRollOver" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a TOUCH_ROLL_OVER touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-flash.display.InteractiveObject.touchRollOver -
-
- - - - - -
TOUCH_TAPconstant 
-
-public static const TOUCH_TAP:String = "touchTap" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a TOUCH_TAP touch event object. - -

The dispatched TouchEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
eventPhaseThe current phase in the event flow.
isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
relatedObjectA reference to a display list object related to the event.
shiftKeytrue if the Shift key is active; false if it is inactive.
sizeXWidth of the contact area.
sizeYHeight of the contact area.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
touchPointIDA unique identification number (as an int) assigned to the touch point.
- -

-See also -

-
-flash.display.InteractiveObject.touchTap -
-
-Example -
The following example displays a message when the - square drawn on mySprite is tapped on a touch-enabled screen: -
-
-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);
-}
-
-

-
- -
Examples
-
examples\TouchEventExample
-
The following example shows event handling for the TOUCH_BEGIN, TOUCH_MOVE, and TOUCH_END events. - While the point of contact moves across the screen (onTouchMove), the x-coordinate relative to the stage is traced to output. - For the Sprite.startTouchDrag parameters in the onTouchBegin 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). -
-
-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");
-}
-
-
-
examples\TouchExample2
-
The following example shows how to handle touch events and touch event phases, as well as the Multitouch.maxTouchPoints and the - touch event object's touchPointID properties. - This example comes from Christian Cantrell, and is explained in more detail in his quickstart: - Multi-touch and gesture support on the Flash Platform. -
-
- package
-{
-    import flash.display.Sprite;
-	import flash.events.TouchEvent;
-	import flash.text.AntiAliasType;
-	import flash.text.TextField;
-	import flash.text.TextFormat;
-	import flash.ui.Multitouch;
-	import flash.ui.MultitouchInputMode;
-
-	[SWF(width=320, height=460, frameRate=24, backgroundColor=0xEB7F00)]
-	public class TouchExample2 extends Sprite
-	{
-		private var dots:Object;
-		private var labels:Object;
-		private var labelFormat:TextFormat;
-		private var dotCount:uint;
-		private var dotsLeft:TextField;
-		private static const LABEL_SPACING:uint = 15;
-		
-		public function TouchExample2()
-		{
-			super();
-
-			this.labelFormat = new TextFormat();
-			labelFormat.color = 0xACF0F2;
-			labelFormat.font = "Helvetica";
-			labelFormat.size = 11;
-			
-			this.dotCount = 0;
-
-			this.dotsLeft = new TextField();
-			this.dotsLeft.width = 300;
-			this.dotsLeft.defaultTextFormat = this.labelFormat;
-			this.dotsLeft.x = 3;
-			this.dotsLeft.y = 0;
-			this.stage.addChild(this.dotsLeft);
-			this.updateDotsLeft();
-
-			this.dots = new Object();
-			this.labels = new Object();
-
-			Multitouch.inputMode = MultitouchInputMode.TOUCH_POINT;
-			this.stage.addEventListener(TouchEvent.TOUCH_BEGIN, onTouchBegin);
-			this.stage.addEventListener(TouchEvent.TOUCH_MOVE, onTouchMove);
-			this.stage.addEventListener(TouchEvent.TOUCH_END, onTouchEnd);
-		}
-
-		private function onTouchBegin(e:TouchEvent):void
-		{
-			if (this.dotCount == Multitouch.maxTouchPoints) return;
-			var dot:Sprite = this.getCircle();
-			dot.x = e.stageX;
-			dot.y = e.stageY;
-			this.stage.addChild(dot);
-			dot.startTouchDrag(e.touchPointID, true);
-			this.dots[e.touchPointID] = dot;
-			
-			++this.dotCount;
-
-			var label:TextField = this.getLabel(e.stageX + ", " + e.stageY);
-			label.x = 3;
-			label.y = this.dotCount * LABEL_SPACING;
-			this.stage.addChild(label);
-			this.labels[e.touchPointID] = label;
-
-			this.updateDotsLeft();
-		}
-		
-		private function onTouchMove(e:TouchEvent):void
-		{
-			var label:TextField = this.labels[e.touchPointID];
-			label.text = (e.stageX + ", " + e.stageY);
-		}
-		
-		private function onTouchEnd(e:TouchEvent):void
-		{
-			var dot:Sprite = this.dots[e.touchPointID];
-			var label:TextField = this.labels[e.touchPointID];
-			
-			this.stage.removeChild(dot);
-			this.stage.removeChild(label);
-			
-			delete this.dots[e.touchPointID];
-			delete this.labels[e.touchPointID];
-			
-			--this.dotCount;
-
-			this.updateDotsLeft();
-		}
-		
-		private function getCircle(circumference:uint = 40):Sprite
-		{
-			var circle:Sprite = new Sprite();
-			circle.graphics.beginFill(0x1695A3);
-			circle.graphics.drawCircle(0, 0, circumference);
-			return circle;
-		}
-
-		private function getLabel(initialText:String):TextField
-		{
-			var label:TextField = new TextField();
-			label.defaultTextFormat = this.labelFormat;
-			label.selectable = false;
-			label.antiAliasType = AntiAliasType.ADVANCED;
-			label.text = initialText;
-			return label;
-		}
-		
-		private function updateDotsLeft():void
-		{
-			this.dotsLeft.text = "Touches Remaining: " + (Multitouch.maxTouchPoints - this.dotCount);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/TouchEventIntent.html b/html-docs/flash/events/TouchEventIntent.html deleted file mode 100644 index 39b3398..0000000 --- a/html-docs/flash/events/TouchEventIntent.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - - - -flash.events.TouchEventIntent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic final class TouchEventIntent
InheritanceTouchEventIntent Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The TouchEventIntent class defines constants for the touchIntent property of the TouchEvent class. - -

These values describe the general purpose of a touch input, as reported by the device hardware.

- -

-

-See also -

-
-flash.events.TouchEvent.touchIntent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  ERASER : String = "eraser"
[static] - The touch event is generated by an eraser tool, the eraser end of an active stylus, or the like.
-		TouchEventIntent
  PEN : String = "pen"
[static] - The touch event is generated by the primary end of an active stylus or by a pen on a system that can distinguish pen from touch.
-		TouchEventIntent
  UNKNOWN : String -
[static] - A general contact type, for example, the touch event is generated by a finger, the palm of a hand, or a passive stylus.
-		TouchEventIntent
-
- -
- -
Constant detail
- - - - - -
ERASERconstant
-
-public static const ERASER:String = "eraser" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The touch event is generated by an eraser tool, the eraser end of an active stylus, or the like. - -

-See also -

-
-flash.events.TouchEvent.touchIntent -
-
- - - - - -
PENconstant 
-
-public static const PEN:String = "pen" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The touch event is generated by the primary end of an active stylus or by a pen on a system that can distinguish pen from touch. - -

-See also -

-
-flash.events.TouchEvent.touchIntent -
-
- - - - - -
UNKNOWNconstant 
-
-public static const UNKNOWN:String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- A general contact type, for example, the touch event is generated by a finger, the palm of a hand, or a passive stylus. - -

-See also -

-
-flash.events.TouchEvent.touchIntent -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/TransformGestureEvent.html b/html-docs/flash/events/TransformGestureEvent.html deleted file mode 100644 index 3839496..0000000 --- a/html-docs/flash/events/TransformGestureEvent.html +++ /dev/null @@ -1,1767 +0,0 @@ - - - - - - - - -flash.events.TransformGestureEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class TransformGestureEvent
InheritanceTransformGestureEvent Inheritance GestureEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The TransformGestureEvent class lets you handle complex movement input events (such as moving fingers across a touch screen) - that the device or operating system interprets as a gesture. A gesture can have one or more touch points. - When a user interacts with a device such as a mobile phone or tablet with a touch screen, the user typically - touches and moves across the screen with his or her fingers or a pointing device. You can develop applications that respond to - this user interaction with the GestureEvent, PressAndTapGestureEvent, and TransformGestureEvent classes. Create event listeners using the event types defined here, or in - the related GestureEvent and TouchEvent classes. And, use the properties and methods of these classes - to construct event handlers that respond to the user touching the device. -

A device or operating system interprets gesture input. So, different devices or operating systems have different requirements for - individual gesture types. A swipe on one device might require different input movement than a swipe on another device. Refer to the hardware - or operating system documentation to discover how the device or operating system interprets contact as a specific gesture.

-

Use the Multitouch class to determine the current environment's support for touch interaction, and to - manage the support of touch interaction if the current environment supports it.

-

Note: When objects are nested on the display list, touch events target the deepest possible - nested object that is visible in the display list. This object is called the target node. To have a target node's - ancestor (an object containing the target node in the display list) receive notification of a touch event, use - EventDispatcher.addEventListener() on the ancestor node with the type parameter set to the specific - touch event you want to detect.

-

While the user is in contact with the device, the TransformGestureEvent object's scale, rotation, and offset properties are incremental values - from the previous gesture event. For example, as a gesture increases the size of a display object, the scale values might go in sequence 1.03, - 1.01, 1.01, 1.02 indicating the display object scaled 1.0717 times its original size by the end of the gesture.

-

For TransformGestureEvent objects, properties not modified by the current gesture are set to identity values. For example, a pan gesture does not have a rotation - or scale transformation, so the rotation value of the event object is 0, the scaleX and scaleY properties are 1.

-

-

-View the examples. -

-

-See also -

-
-flash.ui.Multitouch -
-flash.events.TouchEvent -
-flash.events.GestureEvent -
-flash.events.PressAndTapGestureEvent -
-flash.events.MouseEvent -
-flash.events.EventDispatcher.addEventListener() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaltKey : Boolean -
- Indicates whether the Alt key is active (true) or inactive (false).
-		GestureEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 InheritedcommandKey : Boolean -
- Indicates whether the command key is activated (Mac only).
-		GestureEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcontrolKey : Boolean -
- Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
-		GestureEvent
 InheritedctrlKey : Boolean -
- On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
-		GestureEvent
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 InheritedlocalX : Number -
- The horizontal coordinate at which the event occurred relative to the containing sprite.
-		GestureEvent
 InheritedlocalY : Number -
- The vertical coordinate at which the event occurred relative to the containing sprite.
-		GestureEvent
  offsetX : Number -
- The horizontal translation of the display object, since the previous gesture event.
-		TransformGestureEvent
  offsetY : Number -
- The vertical translation of the display object, since the previous gesture event.
-		TransformGestureEvent
 Inheritedphase : String -
- A value from the GesturePhase class indicating the progress of the touch gesture.
-		GestureEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rotation : Number -
- The current rotation angle, in degrees, of the display object along the z-axis, since the previous gesture event.
-		TransformGestureEvent
  scaleX : Number -
- The horizontal scale of the display object, since the previous gesture event.
-		TransformGestureEvent
  scaleY : Number -
- The vertical scale of the display object, since the previous gesture event.
-		TransformGestureEvent
 InheritedshiftKey : Boolean -
- Indicates whether the Shift key is active (true) or inactive - (false).
-		GestureEvent
 InheritedstageX : Number -
- The horizontal coordinate at which the event occurred in global Stage coordinates.
-		GestureEvent
 InheritedstageY : Number -
- The vertical coordinate at which the event occurred in global Stage coordinates.
-		GestureEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
  velocity : Number -
- The velocity, in pixels per second, of the transform gesture event.
-		TransformGestureEvent
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TransformGestureEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, phase:String = null, localX:Number = 0, localY:Number = 0, scaleX:Number = 1.0, scaleY:Number = 1.0, rotation:Number = 0, offsetX:Number = 0, offsetY:Number = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false, velocity:Number = 0)
-
- Creates an Event object that contains information about complex multi-touch events, such as - a user sliding his or her finger across a screen.
-		TransformGestureEvent
   -
-clone():Event -
-
- Creates a copy of the TransformGestureEvent object and sets the value of each property to match that of the original.
-		TransformGestureEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the TransformGestureEvent object.
-		TransformGestureEvent
 Inherited -
-updateAfterEvent():void -
-
- Refreshes the Flash runtime display after processing the gesture event, in case the display list has been modified by the event handler.
-		GestureEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
  GESTURE_DIRECTIONAL_TAP : String = "gestureDirectionalTap"
[static] - Defines the value of the type property of a GESTURE_DIRECTIONAL_TAP touch event object.
-		TransformGestureEvent
  GESTURE_PAN : String = "gesturePan"
[static] - Defines the value of the type property of a GESTURE_PAN touch event object.
-		TransformGestureEvent
  GESTURE_ROTATE : String = "gestureRotate"
[static] - Defines the value of the type property of a GESTURE_ROTATE touch event object.
-		TransformGestureEvent
  GESTURE_SWIPE : String = "gestureSwipe"
[static] - Defines the value of the type property of a GESTURE_SWIPE touch event object.
-		TransformGestureEvent
 InheritedGESTURE_TWO_FINGER_TAP : String = "gestureTwoFingerTap"
[static] - Defines the value of the type property of a GESTURE_TWO_FINGER_TAP gesture event object.
-		GestureEvent
  GESTURE_ZOOM : String = "gestureZoom"
[static] - Defines the value of the type property of a GESTURE_ZOOM touch event object.
-		TransformGestureEvent
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
offsetXproperty
-
-offsetX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The horizontal translation of the display object, since the previous gesture event. -

Implementation -
-    public function get offsetX():Number -
-    public function set offsetX(value:Number):void -
-
- - - - - -
offsetYproperty 
-
-offsetY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The vertical translation of the display object, since the previous gesture event. -

Implementation -
-    public function get offsetY():Number -
-    public function set offsetY(value:Number):void -
-
- - - - - -
rotationproperty 
-
-rotation:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The current rotation angle, in degrees, of the display object along the z-axis, since the previous gesture event. -

Implementation -
-    public function get rotation():Number -
-    public function set rotation(value:Number):void -
-
- - - - - -
scaleXproperty 
-
-scaleX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The horizontal scale of the display object, since the previous gesture event. -

Implementation -
-    public function get scaleX():Number -
-    public function set scaleX(value:Number):void -
-
- - - - - -
scaleYproperty 
-
-scaleY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The vertical scale of the display object, since the previous gesture event. -

Implementation -
-    public function get scaleY():Number -
-    public function set scaleY(value:Number):void -
-
- - - - - -
velocityproperty 
-
-velocity:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 -
-

- The velocity, in pixels per second, of the transform gesture event. -

Implementation -
-    public function get velocity():Number -
-    public function set velocity(value:Number):void -
-
- -
Constructor detail
- - - - - -
TransformGestureEvent()constructor
-
-public function TransformGestureEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, phase:String = null, localX:Number = 0, localY:Number = 0, scaleX:Number = 1.0, scaleY:Number = 1.0, rotation:Number = 0, offsetX:Number = 0, offsetY:Number = 0, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, commandKey:Boolean = false, controlKey:Boolean = false, velocity:Number = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates an Event object that contains information about complex multi-touch events, such as - a user sliding his or her finger across a screen. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Possible values are: TransformGestureEvent.GESTURE_PAN, - TransformGestureEvent.GESTURE_ROTATE, TransformGestureEvent.GESTURE_SWIPE and TransformGestureEvent.GESTURE_ZOOM. - -
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling phase of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
 
phase:String (default = null) — This values tracks the beginning, progress, and end of a touch gesture. Possible values are: GesturePhase.BEGIN, - GesturePhase.END, and GesturePhase.UPDATE. -
 
localX:Number (default = 0) — The horizontal coordinate at which the event occurred relative to the containing display object. -
 
localY:Number (default = 0) — The vertical coordinate at which the event occurred relative to the containing display object. -
 
scaleX:Number (default = 1.0) — The horizontal scale of the display object. -
 
scaleY:Number (default = 1.0) — The vertical scale of the display object. -
 
rotation:Number (default = 0) — The current rotation angle, in degrees, of the display object along the z-axis. -
 
offsetX:Number (default = 0) — The horizontal translation of the display object from its original position. -
 
offsetY:Number (default = 0) — The vertical translation of the display object from its original position. -
 
ctrlKey:Boolean (default = false) — (AIR only) The velocity of transform gesture in pixels per second. -
 
altKey:Boolean (default = false) — On Windows or Linux, indicates whether the Ctrl key is activated. On Mac, indicates whether either the Ctrl key or the Command key is activated. -
 
shiftKey:Boolean (default = false) — Indicates whether the Alt key is activated (Windows or Linux only). -
 
commandKey:Boolean (default = false) — Indicates whether the Shift key is activated. -
 
controlKey:Boolean (default = false) — (AIR only) Indicates whether the Command key is activated (Mac only). This parameter is for Adobe AIR only; do not set it for Flash Player content. -
 
velocity:Number (default = 0) — (AIR only) Indicates whether the Control or Ctrl key is activated. This parameter is for Adobe AIR only; do not set it for Flash Player content. -
-

-See also -

-
-flash.ui.Multitouch -
-flash.events.TouchEvent -
-flash.events.GestureEvent -
-flash.events.PressAndTapGestureEvent -
-flash.events.GesturePhase -
-flash.events.MouseEvent -
-flash.events.EventDispatcher.addEventListener() -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a copy of the TransformGestureEvent object and sets the value of each property to match that of the original. -

-Returns - - - - -
Event — - A new TransformGestureEvent object with property values that match those of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that contains all the properties of the TransformGestureEvent object. The string is in the following format: -

[TransformGestureEvent type=value bubbles=value cancelable=value ... ]

-

-Returns - - - - -
String — - A string that contains all the properties of the TransformGestureEvent object. - - - -
-
- -
Constant detail
- - - - - -
GESTURE_DIRECTIONAL_TAPconstant
-
-public static const GESTURE_DIRECTIONAL_TAP:String = "gestureDirectionalTap" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24 -
-

- Defines the value of the type property of a GESTURE_DIRECTIONAL_TAP touch event object. - -

The dispatched TransformGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow. For swipe events, - this value is always all corresponding to the value GesturePhase.ALL once the event is dispatched.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.For directional tap gestures this value is centre of the screen.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.For directional tap gestures this value is centre of the screen.
scaleXThe horizontal scale of the display object. For directional tap gestures this value is 1
scaleYThe vertical scale of the display object. For directional tap gestures this value is 1
rotationThe current rotation angle, in degrees, of the display object along the z-axis. For directional tap gestures this value is 0
offsetXIndicates horizontal direction: 1 for right and -1 for left.
offsetYIndicates vertical direction: 1 for down and -1 for up.
velocityIndicates velocity of the swipe gesture in pixels per second (AIR only).
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.InteractiveObject.gestureDirectionalTap -
-flash.events.GesturePhase -
-
- - - - - -
GESTURE_PANconstant 
-
-public static const GESTURE_PAN:String = "gesturePan" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a GESTURE_PAN touch event object. - -

The dispatched TransformGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow; a value from the GesturePhase class.
localXThe horizontal coordinate at which the event occurred relative to the containing display object.
localYThe vertical coordinate at which the event occurred relative to the containing display object.
scaleXThe horizontal scale of the display object since the previous gesture event. For pan gestures this value is 1.
scaleYThe vertical scale of the display object since the previous gesture event. For pan gestures this value is 1.
rotationThe current rotation angle, in degrees, of the display object along the z-axis, since the previous gesture event. - For pan gestures this value is 0.
offsetXThe horizontal translation of the display object from its position at the previous gesture event.
offsetYThe vertical translation of the display object from its position at the previous gesture event.
velocityThe velocity of the gesture event in pixels per second (AIR only). For pan gesture this value is 0
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.InteractiveObject.gesturePan -
-flash.events.GesturePhase -
-
-Example -
The following example shows event handling for the GESTURE_PAN events. - While the user performs a pan gesture on the touch-enabled device, myTextField populates with the current phase. -
-
-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";
-	}
-}
-
-

-
- - - - - -
GESTURE_ROTATEconstant 
-
-public static const GESTURE_ROTATE:String = "gestureRotate" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a GESTURE_ROTATE touch event object. - -

During this event, the rotation property contains the rotation angle. - The rotation values are as follows:

-
    -
  • 0 to 180 degrees for clockwise direction
    • -
  • - 180 to 0 degrees for counter-clockwise direction
    • -
- -

The dispatched TransformGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow; a value from the GesturePhase class.
localXThe horizontal coordinate at which the event occurred relative to the containing display object.
localYThe vertical coordinate at which the event occurred relative to the containing display object.
scaleXThe horizontal scale of the display object since the previous gesture event.
scaleYThe vertical scale of the display object since the previous gesture event.
rotationThe current rotation angle, in degrees, of the display object along the z-axis, since the previous gesture event.
offsetXThe horizontal translation of the display object from its position at the previous gesture event.
offsetYThe vertical translation of the display object from its position at the previous gesture event.
velocityThe velocity of the gesture event in pixels per second (AIR only). For rotate gesture this value is 0
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.InteractiveObject.gestureRotate -
-flash.events.GesturePhase -
-
-Example -
The following example shows event handling for the GESTURE_ROTATE events. - While the user performs a rotation gesture on the touch-enabled device, mySprite rotates and myTextField populates with the current phase. -
-
-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";
-	}
-}
-
-

-
- - - - - -
GESTURE_SWIPEconstant 
-
-public static const GESTURE_SWIPE:String = "gestureSwipe" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a GESTURE_SWIPE touch event object. - -

The dispatched TransformGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow. For swipe events, - this value is always all corresponding to the value GesturePhase.ALL once the event is dispatched.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
localYThe vertical coordinate at which the event occurred relative to the containing sprite.
scaleXThe horizontal scale of the display object. For swipe gestures this value is 1
scaleYThe vertical scale of the display object. For swipe gestures this value is 1
rotationThe current rotation angle, in degrees, of the display object along the z-axis. For swipe gestures this value is 0
offsetXIndicates horizontal direction: 1 for right and -1 for left.
offsetYIndicates vertical direction: 1 for down and -1 for up.
velocityIndicates velocity of the swipe gesture in pixels per second (AIR only). For rest, this value is 0
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.InteractiveObject.gestureSwipe -
-flash.events.GesturePhase -
-
-Example -
The following example shows event handling for the GESTURE_SWIPE events. - While the user performs a swipe gesture on the touch-enabled device, myTextField populates with the phase all, - which is the only phase for swipe events. -
-
-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;
-
-}
-
-

-
- - - - - -
GESTURE_ZOOMconstant 
-
-public static const GESTURE_ZOOM:String = "gestureZoom" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of a GESTURE_ZOOM touch event object. - -

The dispatched TransformGestureEvent object has the following properties:

- - - - - - - - - - - - - - - - - - - - - -
PropertyValue
altKeytrue if the Alt key is active (Windows or Linux).
bubblestrue
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - object with an event listener.
phaseThe current phase in the event flow; a value from the GesturePhase class.
localXThe horizontal coordinate at which the event occurred relative to the containing display object.
localYThe vertical coordinate at which the event occurred relative to the containing display object.
scaleXThe horizontal scale of the display object since the previous gesture event.
scaleYThe vertical scale of the display object since the previous gesture event.
rotationThe current rotation angle, in degrees, of the display object along the z-axis, since the previous gesture event.
offsetXThe horizontal translation of the display object from its position at the previous gesture event.
offsetYThe vertical translation of the display object from its position at the previous gesture event.
velocityThe velocity of the gesture event in pixels per second (AIR only). For zoom gesture this value is 0
shiftKeytrue if the Shift key is active; false if it is inactive.
targetThe InteractiveObject instance under the touching device. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-flash.display.InteractiveObject.gestureZoom -
-flash.events.GesturePhase -
-
-Example -
The following example shows event handling for the GESTURE_ZOOM events. - While the user performs a zoom gesture on the touch-enabled device, myTextField populates with the current phase. -
-
-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";
-	}
-}
-
-

-
- -
Examples
-
examples\TransformGestureEventExample
-
The following example shows event handling for the GESTURE_ROTATE events. - While the user performs a rotation gesture on the touch-enabled device, mySprite rotates and myTextField populates with the current phase. -
-
-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";
-	}
-}
-
-
-
examples\TransformGestureExample2
-
The following example shows how to handle transform gesture events. This example assumes an image is on your local system - called "african_elephant.jpg" and in the same directory as the TransformGestureExample2 class. - This example comes from Christian Cantrell, and is explained in more detail in his quickstart: - Multi-touch and gesture support on the Flash Platform. -
-
- package
-{
-    import flash.display.Bitmap;
-	import flash.display.Sprite;
-	import flash.events.TransformGestureEvent;
-	import flash.text.TextField;
-	import flash.text.TextFormat;
-	import flash.ui.Multitouch;
-	import flash.ui.MultitouchInputMode;
-	
-	[SWF(width=320, height=460, frameRate=24, backgroundColor=0x000000)]
-	public class TransformGestureExample2 extends Sprite
-	{
-		[Embed(source="african_elephant.jpg")]
-		public var ElephantImage:Class;
-		public var scaleDebug:TextField;
-		public var rotateDebug:TextField;
-
-		public function TransformGestureExample2()
-		{
-			// Debug
-			var tf:TextFormat = new TextFormat();
-			tf.color = 0xffffff;
-			tf.font = "Helvetica";
-			tf.size = 11;
-			this.scaleDebug = new TextField();
-			this.scaleDebug.width = 310;
-			this.scaleDebug.defaultTextFormat = tf;
-			this.scaleDebug.x = 2;
-			this.scaleDebug.y = 2;
-			this.stage.addChild(this.scaleDebug);
-			this.rotateDebug = new TextField();
-			this.rotateDebug.width = 310;
-			this.rotateDebug.defaultTextFormat = tf;
-			this.rotateDebug.x = 2;
-			this.rotateDebug.y = 15;
-			this.stage.addChild(this.rotateDebug);
-
-			var elephantBitmap:Bitmap = new ElephantImage();
-			var elephant:Sprite = new Sprite();
-			
-			elephant.addChild(elephantBitmap);
-			
-			elephant.x = 160;
-			elephant.y = 230;
-			
-			elephantBitmap.x = (300 - (elephantBitmap.bitmapData.width / 2)) * -1;
-			elephantBitmap.y = (400 - (elephantBitmap.bitmapData.height / 2)) *-1;
-			
-			this.addChild(elephant);
-
-			Multitouch.inputMode = MultitouchInputMode.GESTURE;
-			elephant.addEventListener(TransformGestureEvent.GESTURE_ZOOM, onZoom);
-			elephant.addEventListener(TransformGestureEvent.GESTURE_ROTATE, onRotate);
-		}
-		
-		private function onZoom(e:TransformGestureEvent):void
-		{
-			this.scaleDebug.text = (e.scaleX + ", " + e.scaleY);
-			var elephant:Sprite = e.target as Sprite;
-			elephant.scaleX *= e.scaleX;
-			elephant.scaleY *= e.scaleY;
-		}
-		
-		private function onRotate(e:TransformGestureEvent):void
-		{
-			var elephant:Sprite = e.target as Sprite;
-			this.rotateDebug.text = String(e.rotation);
-			elephant.rotation += e.rotation;
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/UncaughtErrorEvent.html b/html-docs/flash/events/UncaughtErrorEvent.html deleted file mode 100644 index 6579284..0000000 --- a/html-docs/flash/events/UncaughtErrorEvent.html +++ /dev/null @@ -1,1217 +0,0 @@ - - - - - - - - -flash.events.UncaughtErrorEvent (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class UncaughtErrorEvent
InheritanceUncaughtErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- An UncaughtErrorEvent object is dispatched by an instance of the UncaughtErrorEvents - class when an uncaught error occurs. An uncaught error happens when an error is - thrown outside of any try..catch blocks or when an ErrorEvent - object is dispatched with no registered listeners. The uncaught error event - functionality is often described as a "global error handler." - -

The UncaughtErrorEvents object that dispatches the event is associated with - either a LoaderInfo object or a Loader object. Use the following properties to - access an UncaughtErrorEvents instance:

- -
    -
  • LoaderInfo.uncaughtErrorEvents: to - detect uncaught errors in code defined in the same SWF.
    • -
  • Loader.uncaughtErrorEvents: to detect uncaught - errors in code defined in the SWF loaded by a Loader object.
    • -
- -

When an uncaughtError event happens, even if the event is handled, - execution does not continue in the call stack that caused the error. If the error is - a synchronous error, any code remaining in the function where the error happened is - not executed. Consequently, it is likely that when an uncaught error event happens, - your application is in an unstable state. Since there can be many causes for an - uncaught error, it is impossible to predict what functionality is available. For - example, your application may be able to execute network operations or file - operations. However, those operations aren't necessarily available.

- -

When one SWF loads another, uncaughtError events bubble down and up - again through the LoaderInfo heirarchy. For example, suppose A.swf loads B.swf using a - Loader instance. If an uncaught error occurs in B.swf, an uncaughtError - event is dispatched to LoaderInfo and Loader objects in the following - sequence:

- -
    -
  1. (Capture phase) A.swf's LoaderInfo
    2. -
  2. (Capture phase) Loader in A.swf
    3. -
  3. (Target phase) B.swf's LoaderInfo
    4. -
  4. (Bubble phase) Loader in A.swf
    5. -
  5. (Bubble phase) A.swf's LoaderInfo
    6. -
- -

A Loader object's uncaughtErrorEvents property - never dispatches an uncaughtErrorEvent in the target phase. It only - dispatches the event in the capture and bubbling phases.

- -

As with other event bubbling, calling stopPropagation() or - stopImmediatePropagation() stops the event from being dispatched - to any other listeners, with one important difference. A Loader object's - UncaughtErrorEvents object is treated as a pair with the loaded SWF's - LoaderInfo.uncaughtErrorEvents object for event propagation purposes. - If a listener registered with one of those objects calls the stopPropagation() - method, events are still dispatched to other listeners registered with that - UncaughtErrorEvents object and to listeners registered with its partner - UncaughtErrorEvents object before event propagation ends. The - stopImmediatePropagation() method still prevents events from being - dispatched to all additional listeners.

- -

When content is running in a debugger version of the runtime, such as the - debugger version of Flash Player or the AIR Debug Launcher (ADL), an uncaught - error dialog appears when an uncaught error happens. - For those runtime versions, the error dialog appears even when a listener is registered - for the uncaughtError event. To prevent the dialog from appearing - in that situation, call the UncaughtErrorEvent object's - preventDefault() method.

- -

If the content loaded by a Loader object is an AVM1 (ActionScript 2) SWF file, - uncaught errors in the AVM1 SWF file do not result in an uncaughtError - event. In addition, JavaScript errors in HTML content loaded in an HTMLLoader object - (including a Flex HTML control) do not result in an uncaughtError event.

- -

-

-View the examples. -

-

-See also -

-
-LoaderInfo.uncaughtErrorEvents -
-Loader.uncaughtErrorEvents -
-UncaughtErrorEvents -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  error : * -
[read-only] - The error object associated with the uncaught error.
-		UncaughtErrorEvent
 InheritederrorID : int -
- Contains the reference number associated with the specific error.
-		ErrorEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtext : String -
- For a textInput event, the character or sequence of characters - entered by the user.
-		TextEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-UncaughtErrorEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = true, error_in:* = null)
-
- Creates an UncaughtErrorEvent object that contains information about an - uncaughtError event.
-		UncaughtErrorEvent
   -
-clone():Event -
-
- Creates a copy of the UncaughtErrorEvent object and sets the value of - each property to match that of the original.
-		UncaughtErrorEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the UncaughtErrorEvent object.
-		UncaughtErrorEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedERROR : String = "error"
[static] - Defines the value of the type property of an error event object.
-		ErrorEvent
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLINK : String = "link"
[static] - Defines the value of the type property of a link event object.
-		TextEvent
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INPUT : String = "textInput"
[static] - Defines the value of the type property of a textInput event object.
-		TextEvent
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
  UNCAUGHT_ERROR : String = "uncaughtError"
[static] - Defines the value of the type property of an uncaughtError event object.
-		UncaughtErrorEvent
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
errorproperty
-
-error:*  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The error object associated with the uncaught error. Typically, this - object's data type is one of the following: - -

    -
  • An Error instance (or one of its subclasses), if the uncaught error is - a synchronous error created by a throw statement, such as an - error that could have been caught using a try..catch block
    • -
  • An ErrorEvent instance (or one of its subclasses), if the uncaught error - is an asynchronous error that dispatches an error event when the error happens
    • -
- -

However, the error property can potentially be an object of any - data type. ActionScript does not require a throw - statement to be used only with Error objects. For example, the following - code is legal both at compile time and run time:

- - 
throw new Sprite()
- -

If that throw statement is not caught by a - try..catch block, the throw statement - triggers an uncaughtError event. In that case, the - error property of the UncaughtErrorEvent object that's dispatched - is the Sprite object that's constructed in the throw statement.

- -

Consequently, in your uncaughtError listener, you should check - the data type of the error property. The following example - demonstrates this check:

- - 
-		 function uncaughtErrorHandler(event:UncaughtErrorEvent):void
-         {
-             var message:String;
-             
-             if (event.error is Error)
-             {
-                 message = Error(event.error).message;
-             }
-             else if (event.error is ErrorEvent)
-             {
-                 message = ErrorEvent(event.error).text;
-             }
-             else
-             {
-                 message = event.error.toString();
-             }
-         }
- - 
-		 function uncaughtErrorHandler(event)
-         {
-             var message; // String
-             
-             if (event.error.message) // It's an Error object
-             {
-                 message = event.error.message;
-             }
-             else if (event.error.text) // It's an ErrorEvent object
-             {
-                 message = event.error.text;
-             }
-             else
-             {
-                 message = event.error.toString();
-             }
-         }
- -

If the error property contains an Error instance (or Error subclass), - the available error information varies depending on the version of the runtime - in which the content is running, as follows:

- -
    -

  • In a debugger version of the runtime such as the debugger - version of Flash Player or the AIR Debug Launcher (ADL):

    -
      -
    • The Error.getStackTrace() method returns the - call stack that led to the error
      • -
    • The Error.message contains the complete error - message text
      • -
    -
    • -

  • In a non-debuger version of the runtime:

    -
      -
    • The Error.getStackTrace() method returns the - call stack that led to the error. However, the call stack - information doesn't include source file names or line numbers.
      • -
    • The Error.message property contains a short - version of the error message, which is oftan a combination - of the Error.errorID and Error.name - properties
      • -
    -
    • -

  • In a non-debugger version of the runtime (Flash Player 11.4 - or earlier and AIR 1.4 or earlier):

    -
      -
    • The Error.getStackTrace() method returns - null
      • -
    • The Error.message property contains a short - version of the error message, which is oftan a combination - of the Error.errorID and Error.name - properties
      • -
    -
    • -
- -

All other properties and methods of the Error class are available in all - runtime versions.

-

Note that if the error property is an ErrorEvent - instance, call stack information is never available.

- - Implementation -
-    public function get error():* -
-
- -
Constructor detail
- - - - - -
UncaughtErrorEvent()constructor
-
-public function UncaughtErrorEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = true, error_in:* = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates an UncaughtErrorEvent object that contains information about an - uncaughtError event. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. -
 
bubbles:Boolean (default = true) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = true) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
error_in:* (default = null) — The object associated with the error that was not caught or handled (an Error or ErrorEvent object under normal circumstances). -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a copy of the UncaughtErrorEvent object and sets the value of - each property to match that of the original. - -

-Returns - - - - -
Event — - A new UncaughtErrorEvent object with property values that match those - of the original. - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that contains all the properties of the UncaughtErrorEvent object. - -

-Returns - - - - -
String — - A string that contains all the properties of the UncaughtErrorEvent object. - - - -
-
- -
Constant detail
- - - - - -
UNCAUGHT_ERRORconstant
-
-public static const UNCAUGHT_ERROR:String = "uncaughtError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the value of the type property of an uncaughtError event object. -

Note: If in a try block, there is an event dispatcher that calls its event handler, - the catch block doesn't catch the error if thrown in event handler. Any error thrown - thereafter can be caught by listening to LoaderInfo.uncaughtErrorEvents.

-

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblestrue
cancelabletrue; cancelling the event prevents the uncaught error dialog from appearing in debugger runtime versions
currentTargetThe object that is actively processing the Event object with an event listener.
errorThe uncaught error.
targetThe LoaderInfo object associated with the SWF where the error happened.
textText error message.
- -
- -
Examples
-
examples\UncaughtErrorEventExample.1
-
The following example demonstrates the use of an uncaught error event - handler to detect uncaught errors in an ActionScript project. The example defines - an uncaughtError event handler to detect uncaught errors. It also - provides a button that, when clicked, throws an error that is caught by the - uncaught error handler. - -

In the constructor, the code registers a listener for the uncaughtError - event dispatched by the LoaderInfo object's uncaughtErrorEvents property.

- -

In the uncaughtErrorHandler() method, the code checks the data type of - the error property and responds accordingly.

-
-
-package
-{
-    import flash.display.Sprite;
-    import flash.events.ErrorEvent;
-	import flash.events.MouseEvent;
-	import flash.events.UncaughtErrorEvent;
-
-    public class UncaughtErrorEventExample extends Sprite
-    {
-        public function UncaughtErrorEventExample()
-        {
-            loaderInfo.uncaughtErrorEvents.addEventListener(UncaughtErrorEvent.UNCAUGHT_ERROR, uncaughtErrorHandler);
-			
-			drawUI();
-        }
-		
-        private function uncaughtErrorHandler(event:UncaughtErrorEvent):void
-        {
-            if (event.error is Error)
-            {
-                var error:Error = event.error as Error;
-				// do something with the error
-            }
-            else if (event.error is ErrorEvent)
-            {
-                var errorEvent:ErrorEvent = event.error as ErrorEvent;
-				// do something with the error
-            }
-            else
-            {
-                // a non-Error, non-ErrorEvent type was thrown and uncaught
-            }
-        }
-		
-		private function drawUI():void
-		{
-			var btn:Sprite = new Sprite();
-			btn.graphics.clear();
-			btn.graphics.beginFill(0xFFCC00);
-			btn.graphics.drawRect(0, 0, 100, 50);
-			btn.graphics.endFill();
-			addChild(btn);
-			btn.addEventListener(MouseEvent.CLICK, clickHandler);
-		}
-		
-		private function clickHandler(event:MouseEvent):void
-		{
-			throw new Error("Gak!");
-		}
-    }
-}
-
-
-
examples\UncaughtErrorEventExample.1.5
-
The following example is the Flex equivalent of the previous example, - using an MXML document instead of an ActionScript class as the root content. -
-
-<?xml version="1.0" encoding="utf-8"?>
-<s:WindowedApplication xmlns:fx="http://ns.adobe.com/mxml/2009" 
-    				   xmlns:s="library://ns.adobe.com/flex/spark" 
-					   xmlns:mx="library://ns.adobe.com/flex/halo"
-                       applicationComplete="applicationCompleteHandler();">
-    
-    <fx:Script>
-        <![CDATA[
-		    import flash.events.ErrorEvent;
-			import flash.events.MouseEvent;
-		    import flash.events.UncaughtErrorEvent;
-            
-			private function applicationCompleteHandler():void
-            {
-                loaderInfo.uncaughtErrorEvents.addEventListener(UncaughtErrorEvent.UNCAUGHT_ERROR, uncaughtErrorHandler);
-            }
-    
-            private function uncaughtErrorHandler(event:UncaughtErrorEvent):void
-            {
-                if (event.error is Error)
-                {
-                    var error:Error = event.error as Error;
-                    // do something with the error
-                }
-                else if (event.error is ErrorEvent)
-                {
-                    var errorEvent:ErrorEvent = event.error as ErrorEvent;
-                    // do something with the error
-                }
-                else
-                {
-                    // a non-Error, non-ErrorEvent type was thrown and uncaught
-                }
-            }
-            
-            private function clickHandler(event:MouseEvent):void
-            {
-                throw new Error("Gak!");
-            }
-        ]]>
-    </fx:Script>
-      
-    <s:Button label="Cause Error" click="clickHandler(event);"/>
-</s:WindowedApplication>
-
-
-
examples\UncaughtErrorEventExample.2
-
The following example demonstrates the use of an uncaught error event - handler to detect uncaught errors in a loaded SWF. The example defines - an uncaughtError event handler to detect uncaught errors. - -

In the constructor, the code creates a Loader object and registers a listener for - the uncaughtError event dispatched by the Loader object's - uncaughtErrorEvents property.

- -

In the uncaughtErrorHandler() method, the code checks the data type of - the error property and responds accordingly.

-
-
-package
-{
-    import flash.display.Loader;
-    import flash.display.Sprite;
-	import flash.events.ErrorEvent;
-	import flash.events.UncaughtErrorEvent;
-	import flash.net.URLRequest;
-
-    public class LoaderUncaughtErrorEventExample extends Sprite
-    {
-		private var ldr:Loader;
-		
-        public function LoaderUncaughtErrorEventExample()
-        {
-			ldr = new Loader();
-			ldr.load(new URLRequest("child.swf"));
-            ldr.uncaughtErrorEvents.addEventListener(UncaughtErrorEvent.UNCAUGHT_ERROR, uncaughtErrorHandler);
-        }
-		
-        private function uncaughtErrorHandler(event:UncaughtErrorEvent):void
-        {
-            if (event.error is Error)
-            {
-                var error:Error = event.error as Error;
-				// do something with the error
-            }
-            else if (event.error is ErrorEvent)
-            {
-                var errorEvent:ErrorEvent = event.error as ErrorEvent;
-				// do something with the error
-            }
-            else
-            {
-                // a non-Error, non-ErrorEvent type was thrown and uncaught
-            }
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/UncaughtErrorEvents.html b/html-docs/flash/events/UncaughtErrorEvents.html deleted file mode 100644 index 3370b4e..0000000 --- a/html-docs/flash/events/UncaughtErrorEvents.html +++ /dev/null @@ -1,429 +0,0 @@ - - - - - - - - -flash.events.UncaughtErrorEvents (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class UncaughtErrorEvents
InheritanceUncaughtErrorEvents Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The UncaughtErrorEvents class provides a way to receive uncaught - error events. An instance of this class dispatches an - uncaughtError event when a runtime error occurs and the - error isn't detected and handled in your code. - -

Use the following properties to access an UncaughtErrorEvents instance:

- -
    -
  • LoaderInfo.uncaughtErrorEvents: to - detect uncaught errors in code defined in the same SWF.
    • -
  • Loader.uncaughtErrorEvents: to detect uncaught - errors in code defined in the SWF loaded by a Loader object.
    • -
- -

To catch an error directly and prevent an uncaught error event, - do the following:

- -
    -
  • Use a try..catch - block to isolate code that potentially throws a synchronous error
    • -
  • When performing an operation that dispatches an event when an error occurs, - register a listener for that error event
    • -
- -

If the content loaded by a Loader object is an AVM1 (ActionScript 2) SWF file, - uncaught errors in the AVM1 SWF file do not result in an uncaughtError - event. In addition, JavaScript errors in HTML content loaded in an HTMLLoader object - (including a Flex HTML control) do not result in an uncaughtError event.

- -

-

-See also -

-
-LoaderInfo.uncaughtErrorEvents -
-Loader.uncaughtErrorEvents -
-UncaughtErrorEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-UncaughtErrorEvents()
-
- Creates an UncaughtErrorEvents instance.
-		UncaughtErrorEvents
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-uncaughtError -
-		 - Dispatched when an error occurs and developer code doesn't detect and handle - the error.UncaughtErrorEvents
-
- -
- -
Constructor detail
- - - - - -
UncaughtErrorEvents()constructor
-
-public function UncaughtErrorEvents() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates an UncaughtErrorEvents instance. Developer code shouldn't create - UncaughtErrorEvents instances directly. To access an UncaughtErrorEvents - object, use one of the following properties: - -

    -
  • LoaderInfo.uncaughtErrorEvents: to - detect uncaught errors in code defined in the same SWF.
    • -
  • Loader.uncaughtErrorEvents: to detect uncaught - errors in code defined in the SWF loaded by a Loader object.
    • -
- -

-See also -

-
-LoaderInfo.uncaughtErrorEvents -
-Loader.uncaughtErrorEvents -
-
-
Event detail
- - - - - -
uncaughtErrorevent 
-
-Event object type: flash.events.UncaughtErrorEvent -
-UncaughtErrorEvent.type property = flash.events.UncaughtErrorEvent.UNCAUGHT_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when an error occurs and developer code doesn't detect and handle - the error. - -

- Defines the value of the type property of an uncaughtError event object. -

Note: If in a try block, there is an event dispatcher that calls its event handler, - the catch block doesn't catch the error if thrown in event handler. Any error thrown - thereafter can be caught by listening to LoaderInfo.uncaughtErrorEvents.

-

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblestrue
cancelabletrue; cancelling the event prevents the uncaught error dialog from appearing in debugger runtime versions
currentTargetThe object that is actively processing the Event object with an event listener.
errorThe uncaught error.
targetThe LoaderInfo object associated with the SWF where the error happened.
textText error message.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/VideoEvent.html b/html-docs/flash/events/VideoEvent.html deleted file mode 100644 index 7d4c5dd..0000000 --- a/html-docs/flash/events/VideoEvent.html +++ /dev/null @@ -1,864 +0,0 @@ - - - - - - - - -flash.events.VideoEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class VideoEvent
InheritanceVideoEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

-

This event class reports the current video rendering status. Use this event for the following purposes:

-
    -
  • To find out when size of the Video display changes or is initialized. Use this event instead of polling for size changes. - When you receive this event you can access Video.videoSize and Video.videoHeight to get the pixel - dimensions of the video that is currently playing.
    • -
  • To find out whether the video is decoded by software or the GPU. If the status property returns "accelerated", - you should switch to using the StageVideo class, if possible.
    • -
-

-

-See also -

-
-flash.events.StageVideoEvent -
-flash.events.StageVideoAvailabilityEvent -
-flash.display.Stage.stageVideos -
-flash.media.Video -
-flash.net.NetStream -
-Working with Video -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  status : String -
[read-only] -

Returns the rendering status of the VideoEvent object.

-		VideoEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-VideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null)
-
-

Constructor.

-
-		VideoEvent
 Inherited -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		Event
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
  codecInfo : String -
-		VideoEvent
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
  RENDER_STATE : String = "renderState"
[static] - Defines the value of the type property of a renderState event object.
-		VideoEvent
  RENDER_STATUS_ACCELERATED : String = "accelerated"
[static] -

For internal use only.

-		VideoEvent
  RENDER_STATUS_SOFTWARE : String = "software"
[static] -

For internal use only.

-		VideoEvent
  RENDER_STATUS_UNAVAILABLE : String = "unavailable"
[static] -

For internal use only.

-		VideoEvent
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
statusproperty
-
-status:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

Returns the rendering status of the VideoEvent object. Possible values include "unavailable", "software", and "accelerated".

- Implementation -
-    public function get status():String -
-
- -
Constructor detail
- - - - - -
VideoEvent()constructor
-
-public function VideoEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

Constructor.

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. Possible values are: VideoEvent.RENDER_STATE. -
 
bubbles:Boolean (default = false) — Indicates whether this Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Indicates whether you can cancel the action that triggers this event. -
 
status:String (default = null) — The rendering state of the video. -
-
- -
Constant detail
- - - - - -
codecInfoconstant
-
-public const codecInfo:String -
- - - - - -
RENDER_STATEconstant 
-
-public static const RENDER_STATE:String = "renderState" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Defines the value of the type property of a renderState event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event.
statusThe rendering status reported by the event.
targetThe Video object reporting rendering status.
-
- - - - - -
RENDER_STATUS_ACCELERATEDconstant 
-
-public static const RENDER_STATUS_ACCELERATED:String = "accelerated" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

For internal use only. Use flash.media.VideoStatus.ACCELERATED instead.

-
- - - - - -
RENDER_STATUS_SOFTWAREconstant 
-
-public static const RENDER_STATUS_SOFTWARE:String = "software" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

For internal use only. Use flash.media.VideoStatus.SOFTWARE instead.

-
- - - - - -
RENDER_STATUS_UNAVAILABLEconstant 
-
-public static const RENDER_STATUS_UNAVAILABLE:String = "unavailable" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

For internal use only. Use flash.media.VideoStatus.UNAVAILABLE instead.

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/VideoTextureEvent.html b/html-docs/flash/events/VideoTextureEvent.html deleted file mode 100644 index 1c626f6..0000000 --- a/html-docs/flash/events/VideoTextureEvent.html +++ /dev/null @@ -1,784 +0,0 @@ - - - - - - - - -flash.events.VideoTextureEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class VideoTextureEvent
InheritanceVideoTextureEvent Inheritance Event Inheritance Object
-

- Almost exactly StageVideoEvent. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
  colorSpace : String -
[read-only] - The color space used by the video being displayed in the VideoTexture object.
-		VideoTextureEvent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  status : String -
[read-only] - The status of the VideoTexture object.
-		VideoTextureEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-VideoTextureEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null, colorSpace:String = null)
-
-
-		VideoTextureEvent
 Inherited -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		Event
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
  RENDER_STATE : String = "renderState"
[static] - The VideoTextureEvent.RENDER_STATE constant defines the value of the type property of a renderState event object.
-		VideoTextureEvent
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
colorSpaceproperty
-
-colorSpace:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 17.0 -
-

- The color space used by the video being displayed in the VideoTexture object. - -

Implementation -
-    public function get colorSpace():String -
-

-See also -

-
-flash.media.StageVideo -
-
- - - - - -
statusproperty 
-
-status:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 17.0 -
-

- The status of the VideoTexture object. - -

Implementation -
-    public function get status():String -
-

-See also -

-
-flash.events.StageVideoEvent.RENDER_STATUS_UNAVAILABLE -
-flash.events.StageVideoEvent.RENDER_STATUS_SOFTWARE -
-flash.events.StageVideoEvent.RENDER_STATUS_ACCELERATED -
-
- -
Constructor detail
- - - - - -
VideoTextureEvent()constructor
-
-public function VideoTextureEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, status:String = null, colorSpace:String = null)

-

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
status:String (default = null)
 
colorSpace:String (default = null)
-
- -
Constant detail
- - - - - -
RENDER_STATEconstant
-
-public static const RENDER_STATE:String = "renderState" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 17.0 -
-

- The VideoTextureEvent.RENDER_STATE constant defines the value of the type property of a renderState event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
colorSpaceThe available color spaces for displaying the video.
currentTargetThe object that is actively processing the StageVideoEvent - object with an event listener.
statusIndicates whether the video is being rendered (decoded and displayed) by hardware or software, or not at all.
targetThe VideoTexture object that changed state.
- -

-See also -

-
-flash.events.StageVideoEvent.RENDER_STATE -
-flash.events.StageVideoEvent.RENDER_STATUS_UNAVAILABLE -
-flash.events.StageVideoEvent.RENDER_STATUS_SOFTWARE -
-flash.events.StageVideoEvent.RENDER_STATUS_ACCELERATED -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/VsyncStateChangeAvailabilityEvent.html b/html-docs/flash/events/VsyncStateChangeAvailabilityEvent.html deleted file mode 100644 index 7072596..0000000 --- a/html-docs/flash/events/VsyncStateChangeAvailabilityEvent.html +++ /dev/null @@ -1,832 +0,0 @@ - - - - - - - - -flash.events.VsyncStateChangeAvailabilityEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class VsyncStateChangeAvailabilityEvent
InheritanceVsyncStateChangeAvailabilityEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 29.0 -
-

-

- The Stage class dispatches VsyncStateChangeAvailabilityEvent when the availablity of Stage for changing vsync state changes. -

-

-See also -

-
-flash.display.Stage -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  available : Boolean -
[read-only] - Indicate that vsync state of Stage is changeable.
-		VsyncStateChangeAvailabilityEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-VsyncStateChangeAvailabilityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false)
-
-

Constructor.

- Creates an VsyncStateChangeAvailabilityEvent object that contains information about availability of vsync state change.
-		VsyncStateChangeAvailabilityEvent
   -
-clone():Event -
-
- Creates a copy of an VsyncStateChangeAvailabilityEvent object and sets the value of each property to match that of - the original.
-		VsyncStateChangeAvailabilityEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the VsyncStateChangeAvailabilityEvent object.
-		VsyncStateChangeAvailabilityEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
  VSYNC_STATE_CHANGE_AVAILABILITY : String = "vSyncStateChangeAvailability"
[static] - Defines the value of the type property of a VsyncStateChangeAvailabilityEvent event object.
-		VsyncStateChangeAvailabilityEvent
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
availableproperty
-
-available:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 29.0 -
-

- Indicate that vsync state of Stage is changeable. -

Implementation -
-    public function get available():Boolean -
-
- -
Constructor detail
- - - - - -
VsyncStateChangeAvailabilityEvent()constructor
-
-public function VsyncStateChangeAvailabilityEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, available:Boolean = false) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 29.0 -
-

-

Constructor.

- Creates an VsyncStateChangeAvailabilityEvent object that contains information about availability of vsync state change. - Parameters - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of update event: AccelerometerEvent.UPDATE. -
 
bubbles:Boolean (default = false) — Determines whether the Event object bubbles. Event listeners can access this information through the inherited bubbles property. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property. -
 
available:Boolean (default = false) — Indicate that vsync state is changeable. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 29.0 -
-

- Creates a copy of an VsyncStateChangeAvailabilityEvent object and sets the value of each property to match that of - the original. - -

-Returns - - - - -
Event — - A new VsyncStateChangeAvailabilityEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 29.0 -
-

- Returns a string that contains all the properties of the VsyncStateChangeAvailabilityEvent object. The following - format is used: -

[VsyncStateChangeAvailabilityEvent type=value bubbles=value cancelable=value - available=value]

- -

-Returns - - - - -
String — - A string that contains all the properties of the VsyncStateChangeAvailabilityEvent object. - - -
-
- -
Constant detail
- - - - - -
VSYNC_STATE_CHANGE_AVAILABILITYconstant
-
-public static const VSYNC_STATE_CHANGE_AVAILABILITY:String = "vSyncStateChangeAvailability" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 29.0 -
-

- Defines the value of the type property of a VsyncStateChangeAvailabilityEvent event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
availableavailability of vsync state change
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/WebSocketEvent.html b/html-docs/flash/events/WebSocketEvent.html deleted file mode 100644 index 822a921..0000000 --- a/html-docs/flash/events/WebSocketEvent.html +++ /dev/null @@ -1,871 +0,0 @@ - - - - - - - - -flash.events.WebSocketEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class WebSocketEvent
InheritanceWebSocketEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

-

- - An event that contains data received from a WebSocket object. - -

This is sent out for 'TEXT' and 'BINARY' message types, and if the format - - is 'TEXT' then the message string can be retrieved via the stringData - - property.

- - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
  data : ByteArray -
[read-only] - - Retrieves the raw data from the WebSocket message.
-		WebSocketEvent
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  format : uint -
[read-only] - - Retrieves the format of the WebSocket message.
-		WebSocketEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  stringData : String -
[read-only] - - Retrieves the WebSocket message string for 'TEXT' messages.
-		WebSocketEvent
 Inheritedtarget : Object -
- The event target.
-		Event
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-WebSocketEvent(type:String, format:uint, data:ByteArray)
-
- - Constructor for a WebSocketEvent object.
-		WebSocketEvent
 Inherited -
-clone():Event -
-
- Duplicates an instance of an Event subclass.
-		Event
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- Returns a string containing all the properties of the Event object.
-		Event
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
  DATA : String = "websocketData"
[static] - - The WebSocketEvent.DATA constant is used when a complete message has been received by a WebSocket object.
-		WebSocketEvent
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
dataproperty
-
-data:ByteArray  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Retrieves the raw data from the WebSocket message. - - -

Implementation -
-    public function get data():ByteArray -
-
- - - - - -
formatproperty 
-
-format:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Retrieves the format of the WebSocket message. - -

This should either be WebSocket.fmtTEXT or WebSocket.fmtBINARY.

- - - Implementation -
-    public function get format():uint -
-
- - - - - -
stringDataproperty 
-
-stringData:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Retrieves the WebSocket message string for 'TEXT' messages. - -

If the message type was not WebSocket.fmtTEXT then this - - returns null, otherwise the message bytes are converted to a string and returned.

- - - Implementation -
-    public function get stringData():String -
-
- -
Constructor detail
- - - - - -
WebSocketEvent()constructor
-
-public function WebSocketEvent(type:String, format:uint, data:ByteArray) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Constructor for a WebSocketEvent object. - -

The format and data (always in ByteArray format, even for 'TEXT' messages) - - should be provided via the constructor as they cannot be set later on.

- - - Parameters - - - - - - - - - - - - - - - - -
type:String — The event type, WebSocketEvent.DATA. - -
 
format:uint — The format of the WebSocket message, one of the static members of WebSocket. - -
 
data:ByteArray — The message data, as a ByteArray. - - -
-
- -
Constant detail
- - - - - -
DATAconstant
-
-public static const DATA:String = "websocketData" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - The WebSocketEvent.DATA constant is used when a complete message has been received by a WebSocket object. - - The event type and (if any) the message data is then provided by the event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe network object reporting the security error.
formatThe format of the WebSocket message ('TEXT', 'BINARY' etc).
dataThe message data as a ByteArray.
stringDataThe message data as a string, for 'TEXT' messages.
- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Sat Jan 11 2025, 8:30 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/events/WebViewDrawEvent.html b/html-docs/flash/events/WebViewDrawEvent.html deleted file mode 100644 index 37b7d03..0000000 --- a/html-docs/flash/events/WebViewDrawEvent.html +++ /dev/null @@ -1,915 +0,0 @@ - - - - - - - - -flash.events.WebViewDrawEvent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.events
Classpublic class WebViewDrawEvent
InheritanceWebViewDrawEvent Inheritance Event Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 -
-

-

- A WebViewDrawEvent object is dispatched when a StageWebView object has completed some asynchronous - draw event. It contains a reference to the target that has been drawn to, so that the application may - retrieve the image data. -

-

-See also -

-
-StageWebView class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bitmapData : BitmapData -
- The BitmapData object containing the bitmap contents rendered from the StageWebView object.
-		WebViewDrawEvent
 Inheritedbubbles : Boolean -
- Indicates whether an event is a bubbling event.
-		Event
 Inheritedcancelable : Boolean -
- Indicates whether the behavior associated with the event can be prevented.
-		Event
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcurrentTarget : Object -
- The object that is actively processing the Event object with an event listener.
-		Event
 InheritedeventPhase : uint -
- The current phase in the event flow.
-		Event
  jpegImage : ByteArray -
- The BitmapData object containing the JPEG-encoded contents rendered from the StageWebView object.
-		WebViewDrawEvent
  pngImage : ByteArray -
- The ByteArray object containing the PNG-encoded contents rendered from the StageWebView object.
-		WebViewDrawEvent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedtarget : Object -
- The event target.
-		Event
  targetType : String -
[read-only] - The type of image data that is being held by this object.
-		WebViewDrawEvent
 Inheritedtype : String -
- The type of event.
-		Event
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-WebViewDrawEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
-
- Creates an Event object that contains the rendered StageWebView content.
-		WebViewDrawEvent
   -
-clone():Event -
-
- Creates a copy of the WebViewDrawEvent object and sets each property's value to match that of the original.
-		WebViewDrawEvent
 Inherited -
-formatToString(className:String, ... arguments):String -
-
- A utility function for implementing the toString() method in custom - ActionScript 3.0 Event classes.
-		Event
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isDefaultPrevented():Boolean -
-
- Checks whether the preventDefault() method has been called on the event.
-		Event
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-preventDefault():void -
-
- Cancels an event's default behavior if that behavior can be canceled.
-		Event
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopImmediatePropagation():void -
-
- Prevents processing of any event listeners in the current node and any subsequent nodes in - the event flow.
-		Event
 Inherited -
-stopPropagation():void -
-
- Prevents processing of any event listeners in nodes subsequent to the current node in the - event flow.
-		Event
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains all the properties of the ProgressEvent object.
-		WebViewDrawEvent
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] - The ACTIVATE constant defines the value of the type property of an activate event object.
-		Event
 InheritedADDED : String = "added"
[static] - The Event.ADDED constant defines the value of the type property of - an added event object.
-		Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] - The Event.ADDED_TO_STAGE constant defines the value of the type - property of an addedToStage event object.
-		Event
 InheritedBROWSER_ZOOM_CHANGE : String = "browserZoomChange"
[static] - The Event.BROWSER_ZOOM_CHANGE constant defines the value of the type - property of an browserZoomChange event object.
-		Event
 InheritedCANCEL : String = "cancel"
[static] - The Event.CANCEL constant defines the value of the type property of a cancel event object.
-		Event
 InheritedCHANGE : String = "change"
[static] - The Event.CHANGE constant defines the value of the type property of a change event object.
-		Event
 InheritedCHANNEL_MESSAGE : String = "channelMessage"
[static] - The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object.
-		Event
 InheritedCHANNEL_STATE : String = "channelState"
[static] - The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object.
-		Event
 InheritedCLEAR : String = "clear"
[static] - The Event.CLEAR constant defines the value of the type property - of a clear event object.
-		Event
 InheritedCLOSE : String = "close"
[static] - The Event.CLOSE constant defines the value of the type property of a close event object.
-		Event
 InheritedCLOSING : String = "closing"
[static] - The Event.CLOSING constant defines the value of the - type property of a closing event object.
-		Event
 InheritedCOMPLETE : String = "complete"
[static] - The Event.COMPLETE constant defines the value of the type property of a complete event object.
-		Event
 InheritedCONNECT : String = "connect"
[static] - The Event.CONNECT constant defines the value of the type property of a connect event object.
-		Event
 InheritedCONTEXT3D_CREATE : String = "context3DCreate"
[static] - The Event.CONTEXT3D_CREATE constant defines the value of the type property of a context3Dcreate event object.
-		Event
 InheritedCOPY : String = "copy"
[static] - Defines the value of the type property of a copy event object.
-		Event
 InheritedCUT : String = "cut"
[static] - Defines the value of the type property of a cut event object.
-		Event
 InheritedDEACTIVATE : String = "deactivate"
[static] - The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
-		Event
 InheritedDISPLAYING : String = "displaying"
[static] - The Event.DISPLAYING constant defines the value of the type property of a displaying event object.
-		Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] - The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
-		Event
 InheritedEXIT_FRAME : String = "exitFrame"
[static] - The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.
-		Event
 InheritedEXITING : String = "exiting"
[static] - The Event.EXITING constant defines the value of the type property of an exiting event object.
-		Event
 InheritedFRAME_CONSTRUCTED : String = "frameConstructed"
[static] - The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.
-		Event
 InheritedFRAME_LABEL : String = "frameLabel"
[static] - The Event.FRAME_LABEL constant defines the value of the type property of an frameLabel event object.
-		Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] - The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
-		Event
 InheritedHTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] - The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
-		Event
 InheritedHTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] - The Event.HTML_DOM_INITIALIZE constant defines the value of the type property - of an htmlDOMInitialize event object.
-		Event
 InheritedHTML_RENDER : String = "htmlRender"
[static] - The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
-		Event
 InheritedID3 : String = "id3"
[static] - The Event.ID3 constant defines the value of the type property of an id3 event object.
-		Event
 InheritedINIT : String = "init"
[static] - The Event.INIT constant defines the value of the type property of an init event object.
-		Event
 InheritedLOCATION_CHANGE : String = "locationChange"
[static] - The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
-		Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] - The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.
-		Event
 InheritedNETWORK_CHANGE : String = "networkChange"
[static] - The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
-		Event
 InheritedOPEN : String = "open"
[static] - The Event.OPEN constant defines the value of the type property of an open event object.
-		Event
 InheritedPASTE : String = "paste"
[static] - The Event.PASTE constant defines the value of the type property of a paste event object.
-		Event
 InheritedPREPARING : String = "preparing"
[static] - The Event.PREPARING constant defines the value of the type property of a preparing event object.
-		Event
 InheritedREMOVED : String = "removed"
[static] - The Event.REMOVED constant defines the value of the type property of - a removed event object.
-		Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] - The Event.REMOVED_FROM_STAGE constant defines the value of the type - property of a removedFromStage event object.
-		Event
 InheritedRENDER : String = "render"
[static] - The Event.RENDER constant defines the value of the type property of a render event object.
-		Event
 InheritedRESIZE : String = "resize"
[static] - The Event.RESIZE constant defines the value of the type property of a resize event object.
-		Event
 InheritedSCROLL : String = "scroll"
[static] - The Event.SCROLL constant defines the value of the type property of a scroll event object.
-		Event
 InheritedSELECT : String = "select"
[static] - The Event.SELECT constant defines the value of the type property of a select event object.
-		Event
 InheritedSELECT_ALL : String = "selectAll"
[static] - The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.
-		Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] - The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
-		Event
 InheritedSTANDARD_ERROR_CLOSE : String = "standardErrorClose"
[static] - The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object.
-		Event
 InheritedSTANDARD_INPUT_CLOSE : String = "standardInputClose"
[static] - The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object.
-		Event
 InheritedSTANDARD_OUTPUT_CLOSE : String = "standardOutputClose"
[static] - The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object.
-		Event
 InheritedSUSPEND : String = "suspend"
[static] - The Event.SUSPEND constant defines the value of the type property of an suspend event object.
-		Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] - The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
-		Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] - The Event.TAB_ENABLED_CHANGE constant defines the value of the type - property of a tabEnabledChange event object.
-		Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] - The Event.TAB_INDEX_CHANGE constant defines the value of the - type property of a tabIndexChange event object.
-		Event
 InheritedTEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange"
[static] - The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of a interaction mode event object.
-		Event
 InheritedTEXTURE_READY : String = "textureReady"
[static] - The Event.TEXTURE_READY constant defines the value of the type property of a textureReady event object.
-		Event
 InheritedUNLOAD : String = "unload"
[static] - The Event.UNLOAD constant defines the value of the type property of an unload event object.
-		Event
 InheritedUSER_IDLE : String = "userIdle"
[static] - The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
-		Event
 InheritedUSER_PRESENT : String = "userPresent"
[static] - The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.
-		Event
 InheritedVIDEO_FRAME : String = "videoFrame"
[static] - The Event.VIDEO_FRAME constant defines the value of the - type property of a videoFrame event object.
-		Event
  WEBVIEW_DRAW_COMPLETE : String = "webViewDrawComplete"
[static] - Defines the value of the type property of a progress event object.
-		WebViewDrawEvent
 InheritedWORKER_STATE : String = "workerState"
[static] - The Event.WORKER_STATE constant defines the value of the type property of a workerState event object.
-		Event
-
- -
- -
Property detail
- - - - - -
bitmapDataproperty
-
-public var bitmapData:BitmapData -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- The BitmapData object containing the bitmap contents rendered from the StageWebView object. - This is only valid when the targetType propery is "BMP". - -

- - - - - -
jpegImageproperty 
-
-public var jpegImage:ByteArray -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- The BitmapData object containing the JPEG-encoded contents rendered from the StageWebView object. - This is only valid when the targetType propery is "JPEG". - -

- - - - - -
pngImageproperty 
-
-public var pngImage:ByteArray -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- The ByteArray object containing the PNG-encoded contents rendered from the StageWebView object. - This is only valid when the targetType propery is "PNG". - -

- - - - - -
targetTypeproperty 
-
-targetType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- The type of image data that is being held by this object. Can be one of: NONE, BMP, PNG, JPEG. - -

Implementation -
-    public function get targetType():String -
-
- -
Constructor detail
- - - - - -
WebViewDrawEvent()constructor
-
-public function WebViewDrawEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 -
-

- Creates an Event object that contains the rendered StageWebView content. - Event objects are passed as parameters to event listeners. -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of the event. This must be: WebViewDrawEvent.WEBVIEW_DRAW_COMPLETE. - -
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. -
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():Event -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 -
-

- Creates a copy of the WebViewDrawEvent object and sets each property's value to match that of the original. - -

-Returns - - - - -
Event — - A new WebViewDrawEvent object with property values that match those of the original. - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 -
-

- Returns a string that contains all the properties of the ProgressEvent object. The string is in the following format: -

[WebViewDrawEvent type=value bubbles=value cancelable=value targetType=BMP|PNG|JPEG], - where the target type shows what type of image data is being held by this event.

- -

-Returns - - - - -
String — - A string that contains all the properties of the WebViewDrawEvent object. - - -
-
- -
Constant detail
- - - - - -
WEBVIEW_DRAW_COMPLETEconstant
-
-public static const WEBVIEW_DRAW_COMPLETE:String = "webViewDrawComplete" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Defines the value of the type property of a progress event object. - -

-See also -

-
-flash.media.StageWebView.webViewDrawComplete -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/events/package-detail.html b/html-docs/flash/events/package-detail.html deleted file mode 100644 index 5d6ddd4..0000000 --- a/html-docs/flash/events/package-detail.html +++ /dev/null @@ -1,453 +0,0 @@ - - - - - - - -flash.events Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.events package supports the new DOM event model and includes the EventDispatcher base class.

-
-
- -
Interfaces
- - - - - - - -
 InterfaceDescription
 IEventDispatcher -The IEventDispatcher interface defines methods for adding or removing event listeners, checks -whether specific types of event listeners are registered, and dispatches events.
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 AccelerometerEvent -The Accelerometer class dispatches AccelerometerEvent objects when acceleration updates are obtained from the Accelerometer sensor installed on the device.
 ActivityEvent -A Camera or Microphone object dispatches an ActivityEvent object whenever a camera or microphone reports that it has -become active or inactive.
 AsyncErrorEvent - An object dispatches an AsyncErrorEvent when an exception is thrown from native - asynchronous code, which could be from, for example, LocalConnection, NetConnection, - SharedObject, or NetStream.
 AudioOutputChangeEvent -

This event fires when user selects a different audio output device from Flash Player's settings - UI, or an audio device gets added to / removed from the system.

- -
 BrowserInvokeEvent - The NativeApplication object of an AIR application dispatches a browserInvoke event when the - application is invoked as the result of a SWF file in the browser using the browser - invocation feature.
 ContextMenuEvent - An InteractiveObject dispatches a ContextMenuEvent object when the user opens or interacts with - the context menu.
 DataEvent -An object dispatches a DataEvent object when raw data has completed loading.
 DatagramSocketDataEvent - A DatagramSocketDataEvent object is dispatched when Datagram socket has received data.
 DeviceRotationEvent -The DeviceRotation class dispatches DeviceRotationEvent and returns roll, yaw, pitch and quaternion data when DeviceRotation updates are obtained from the combined readings from -Accelerometer and Gyroscope sensors' readings installed on the device.
 DNSResolverEvent - The DNSResolverEvent class represents the results of a Domain Name System (DNS) lookup operation.
 DRMAuthenticateEvent - A NetStream object dispatchs a DRMAuthenticateEvent object when attempting to play digital rights management (DRM) encrypted - content that requires a user credential for authentication.
 DRMAuthenticationCompleteEvent - The DRMManager dispatches a DRMAuthenticationCompleteEvent object when a call to the authenticate() - method of the DRMManager object succeeds.
 DRMAuthenticationErrorEvent - The DRMManager dispatches a DRMAuthenticationErrorEvent object when a call to the authenticate() - method of the DRMManager object fails.
 DRMDeviceGroupErrorEvent -

Issued by the DRMManager when any error occurs during any device group related calls.

-

It is the application's responsibility to explicitly handle the error events.These events include cases - where the user inputs valid credentials, but the voucher protecting the encrypted content restricts the access - to the content.

 DRMDeviceGroupEvent -

Issued by the DRMManager when a device group related call successfully completes.

 DRMErrorEvent - The DRMErrorEvent class provides information about errors that occur when playing digital rights management (DRM) - encrypted files.
 DRMLicenseRequestEvent - The DRMManager dispatches a DRMLicenseRequestEvent object before each call to the loadVoucher() - or loadPreviewVoucher() methods of the DRMManager object succeeds.
 DRMReturnVoucherCompleteEvent - The DRMManager dispatches a DRMVoucherReturnCompleteEvent object when a call to the returnVoucher() - method of the DRMManager object succeeds.
 DRMReturnVoucherErrorEvent - The DRMManager dispatches a DRMReturnVoucherErrorEvent object when a call to the returnVoucher() - method of the DRMManager object fails.
 DRMStatusEvent - A NetStream object dispatches a DRMStatusEvent object when the content protected using - digital rights management (DRM) begins playing successfully (when the voucher is - verified, and when the user is authenticated and authorized to view the content).
 ErrorEvent -An object dispatches an ErrorEvent object when an error causes an asynchronous operation -to fail.
 Event - The Event class is used as the base class for the creation of Event objects, - which are passed as parameters to event listeners when an event occurs.
 EventDispatcher -The EventDispatcher class is the base class for all runtime classes that dispatch events.
 EventPhase - The EventPhase class provides values for the eventPhase property of the Event class.
 FileListEvent - A File object dispatches a FileListEvent object when a call to the getDirectoryListingAsync() method - of a File object successfully enumerates a set of files and directories or when a user selects files after a - call to the browseForOpenMultiple() method.
 FocusEvent - An object dispatches a FocusEvent object when the user changes the focus from one object - in the display list to another.
 FullScreenEvent -The Stage object dispatches a FullScreenEvent object whenever the Stage enters or leaves full-screen display mode.
 GameInputEvent - The GameInputEvent class represents an event that is - dispatched when a game input device has either been added or removed - from the application platform.
 GeolocationEvent -A Geolocation object dispatches GeolocationEvent objects when it receives updates from the location sensor installed on the device.
 GestureEvent - The GestureEvent class lets you handle multi-touch events on devices that detect complex user contact with - the device (such as pressing two fingers on a touch screen at the same time).
 GesturePhase - The GesturePhase class is an enumeration class of constant values for use with the GestureEvent, PressAndTapGestureEvent, and TransformGestureEvent - classes.
 HTMLUncaughtScriptExceptionEvent - An HTMLLoader object dispatches an HTMLUncaughtScriptExceptionEvent object whenever a JavaScript exception - is thrown and not handled with a catch statement.
 HTTPStatusEvent -The application dispatches HTTPStatusEvent objects when a network request returns an HTTP -status code.
 IMEEvent - An IMEEvent object is dispatched when the user enters text using an input method editor - (IME).
 InvokeEvent - The NativeApplication object of an AIR application dispatches an invoke event when the - application is invoked.
 IOErrorEvent -An IOErrorEvent object is dispatched when an error causes input or output operations to fail.
 KeyboardEvent - - A KeyboardEvent object id dispatched in response to user input through a keyboard.
 LocationChangeEvent - An HTMLLoader or StageWebView object dispatches a LocationChangeEvent object when a new page loads.
 MediaEvent - CameraRoll and CameraUI classes dispatch MediaEvent objects when a media stream - is available.
 MouseEvent - A MouseEvent object is dispatched into the event flow whenever mouse events occur.
 NativeDragEvent - Native drag events are dispatched by the interactive objects involved in a - drag-and-drop operation.
 NativeProcessExitEvent - This event is dispatched by the NativeProcess object when the process exits.
 NativeWindowBoundsEvent - A NativeWindow object dispatches a NativeWindowBoundsEvent object when the size or location - of the window changes.
 NativeWindowDisplayStateEvent - A NativeWindow object dispatches events of the NativeWindowDisplayStateEvent class when the window - display state changes.
 NetDataEvent -A NetStream object dispatches a NetDataEvent object when a data message is encountered in the media stream.
 NetMonitorEvent - A NetMonitor object dispatches NetMonitorEvent objects when a NetStream object is created.
 NetStatusEvent -A NetConnection, NetStream, or SharedObject object dispatches NetStatusEvent objects when a it reports its status.
 OutputProgressEvent - A FileStream object dispatches OutputProgressEvent objects as pending asynchronous file write operations are - performed.
 PermissionEvent 
 PressAndTapGestureEvent - The PressAndTapGestureEvent class lets you handle press-and-tap gesture on touch-enabled devices.
 ProgressEvent - A ProgressEvent object is dispatched when a load operation has begun or a socket has received data.
 RemoteNotificationEvent - Contains events that are dispatched by flash.notifications.RemoteNotifier in response to push notification events from APNs.
 SampleDataEvent - Dispatched when a Sound object requests new audio data or when a Microphone object - has new audio data to provide.
 ScreenMouseEvent -The SystemTrayIcon object dispatches events of type ScreenMouseEvent in response to mouse interaction.
 SecurityErrorEvent -An object dispatches a SecurityErrorEvent object to report the occurrence of a -security error.
 ServerSocketConnectEvent - A ServerSocket object dispatches a ServerSocketConnectEvent object when a client attempts - to connect to the server socket.
 ShaderEvent - A ShaderEvent is dispatched when a shader operation launched from - a ShaderJob finishes.
 SoftKeyboardEvent -A SoftKeyboardEvent object is dispatched when a software-driven keyboard is activated or de-activated on a device or operating system.
 SoftKeyboardTrigger - The SoftKeyboardTrigger class provides enumerator values for the triggerType property - of the SoftKeyboardEvent class.
 SQLErrorEvent - A SQLErrorEvent instance is dispatched by a SQLConnection instance or SQLStatement instance - when an error occurs while performing a database operation in asynchronous execution mode.
 SQLEvent - Adobe AIR dispatches SQLEvent objects when one of the operations performed by - a SQLConnection or SQLStatement instance completes successfully.
 SQLUpdateEvent - A SQLUpdateEvent object is dispatched by a SQLConnection object when a data change occurs - on any table associated with the SQLConnection instance.
 StageOrientationEvent - A Stage object dispatches a StageOrientationEvent object when the orientation - of the stage changes.
 StageVideoAvailabilityEvent -

This event fires when the state of the Stage.stageVideos property changes.

 StageVideoEvent - A StageVideo object dispatches a StageVideoEvent object after the attachNetStream() method - of the StageVideo object and the play() method of - the attached NetStream object have both been called.
 StatusEvent - An object dispatches a StatusEvent object when a device, such as a camera or microphone, or an object such as a LocalConnection object reports its status.
 StorageVolumeChangeEvent - The StorageVolumeInfo.storageVolumeInfo object dispatches a StorageVolumeChangeEvent event - object when a storage volume is mounted or unmounted.
 SyncEvent - An SharedObject object representing a remote shared object dispatches a SyncEvent object when the remote - shared object has been updated by the server.
 TextEvent - An object dispatches a TextEvent object when a user enters text in a text field or clicks - a hyperlink in an HTML-enabled text field.
 ThrottleEvent - A ThrottleEvent is dispatched when the Flash Player throttles, pauses, or resumes content.
 ThrottleType - The ThrottleType class provides values for the playback state property - of the flash.event.ThrottleEvent class.
 TimerEvent - A Timer object dispatches a TimerEvent objects whenever the Timer object reaches the interval - specified by the Timer.delay property.
 TouchEvent - The TouchEvent class lets you handle events on devices that detect user contact with - the device (such as a finger on a touch screen).
 TouchEventIntent - The TouchEventIntent class defines constants for the touchIntent property of the TouchEvent class.
 TransformGestureEvent - The TransformGestureEvent class lets you handle complex movement input events (such as moving fingers across a touch screen) - that the device or operating system interprets as a gesture.
 UncaughtErrorEvent - An UncaughtErrorEvent object is dispatched by an instance of the UncaughtErrorEvents - class when an uncaught error occurs.
 UncaughtErrorEvents - The UncaughtErrorEvents class provides a way to receive uncaught - error events.
 VideoEvent -

This event class reports the current video rendering status.

 VideoTextureEvent - Almost exactly StageVideoEvent.
 VsyncStateChangeAvailabilityEvent - The Stage class dispatches VsyncStateChangeAvailabilityEvent when the availablity of Stage for changing vsync state changes.
 WebSocketEvent - An event that contains data received from a WebSocket object.
 WebViewDrawEvent - A WebViewDrawEvent object is dispatched when a StageWebView object has completed some asynchronous - draw event.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/external/ExtensionContext.html b/html-docs/flash/external/ExtensionContext.html deleted file mode 100644 index 506a103..0000000 --- a/html-docs/flash/external/ExtensionContext.html +++ /dev/null @@ -1,1149 +0,0 @@ - - - - - - - - -flash.external.ExtensionContext (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.external
Classpublic final class ExtensionContext
InheritanceExtensionContext Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

-

The ExtensionContext class also provides a static method getExtensionDirectory() for - - accessing the directory in which the extension is installed on the device. It also provides a - - property, actionScriptData, for sharing data with the native implementation of the extension.

- - -

Note: AIR applications using the extendedDesktop profile can use the NativeProcess class - - to execute native processes.

- - -

-

-See also -

-
-flash.desktop.NativeProcess -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  actionScriptData : Object -
- - The ActionScript object, if any, associated with this context.
-		ExtensionContext
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  functions : Vector.<String>
[read-only] - - Returns a list of the functions that are available to be called within this native extension context.
-		ExtensionContext
  knownExtensions : Vector.<String>
[static][read-only] - - Gets a list of the extension identifiers for ANEs that are registered with the runtime.
-		ExtensionContext
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-call(functionName:String, ... args):Object -
-
- - Calls the native function specified by functionName.
-		ExtensionContext
   -
-createExtensionContext(extensionID:String, contextType:String):ExtensionContext -
-
[static] - - Creates an ExtensionContext instance for the given extension identifier and context type.
-		ExtensionContext
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-dispose():void -
-
- - Disposes of this ExtensionContext instance.
-		ExtensionContext
   -
-getExtensionDirectory(extensionID:String):File -
-
[static] - - Returns the directory in which the extension is installed on the device.
-		ExtensionContext
   -
-getExtensionInfo(extensionID:String):ExtensionInfo -
-
[static] - - Gets information about an extension from the ID.
-		ExtensionContext
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-loadExtension(extensionID:String, aneFolder:File):Boolean -
-
[static] - - Loads an extension into the AIR runtime so that it can be created via createExtensionContext.
-		ExtensionContext
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-status -
-		 - - The ExtensionContext class provides an interface for calling functions - - in the native implementation of a native extension for Adobe AIR.ExtensionContext
-
- -
- -
Property detail
- - - - - -
actionScriptDataproperty
-
-actionScriptData:Object  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - The ActionScript object, if any, associated with this context. - - -

You can associate any ActionScript object with an ExtensionContext instance. - - The native implementation can also get and set this ActionScript object. Therefore, - - you can use actionScriptData to share data between the ActionScript - - side and the native side of an extension.

- - -

You can also set the value of actionScriptData to null.

- - - - - Implementation -
-    public function get actionScriptData():Object -
-    public function set actionScriptData(value:Object):void -
-
-Throws -
- - - - -
Error — The method dispose() was already called - - on this ExtensionContext instance. - - -
-
- - - - - -
functionsproperty 
-
-functions:Vector.<String>  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Returns a list of the functions that are available to be called within this native extension context. - - This is based on the list of functions passed to the AIR runtime within the native context initialization method. - - -

Implementation -
-    public function get functions():Vector.<String> -
-
- - - - - -
knownExtensionsproperty 
-
-knownExtensions:Vector.<String>  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Gets a list of the extension identifiers for ANEs that are registered with the runtime. - - -

Implementation -
-    public static function get knownExtensions():Vector.<String> -
-
- -
Method detail
- - - - - -
call()method
-
-public function call(functionName:String, ... args):Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Calls the native function specified by functionName. - - Any additional arguments are passed to the native function. - - -

Parameters - - - - - - - - - - -
functionName:String — A name that represents a function in the native implementation. - - This name is not necessarily the actual name of the native function, but any name - - agreed to between the ActionScript side and native side of the extension. - - -
 
... args — A list of arguments for the native function. These arguments can be - - any ActionScript objects: primitive types or ActionScript class objects. The types and - - order of the arguments are agreed to between the ActionScript side and native side of - - the extension. - - -
-

-Returns - - - - -
Object — - The value returned by the native function. The return value is null - - if the native function has no return value or returns an invalid object reference. - - - - -
-
-Throws - - - - - - - - - - -
ArgumentError — No function corresponds to the name given by functionName. - - - -
 
Error — The method dispose() was already called - - on this ExtensionContext instance. This error is also thrown if the native function - - returns an invalid object reference. - - -
-
- - - - - -
createExtensionContext()method 
-
-public static function createExtensionContext(extensionID:String, contextType:String):ExtensionContext -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Creates an ExtensionContext instance for the given extension identifier and context type. - - -

Parameters - - - - - - - - - - -
extensionID:String — The extension identifier of the extension. This identifier has the same - - value as the id element in the extension descriptor file. Application developers also - - use this value in the extensionID element in the application descriptor file. - - All extensions share a single, global namespace. Therefore, to avoid name conflicts, - - use reverse DNS notation for the extension identifier. - - -
 
contextType:String — The context type of the extension. Depending on the context type, the native - - implementation can perform different initializations. These differences can include the native - - implementation specifying a different set of available native functions that the ActionScript - - side can call. The value of the context type is any string agreed to between the ActionScript - - side and the native side of the extension. Simple extensions often have no use for different context types. - - In those cases, pass an empty string "" or null for the contextType value. - - - -
-

-Returns - - - - -
ExtensionContext — - The new ExtensionContext instance. Returns null if no extension with the given - - extensionID value is available or if the context initializer function specified - - in the extension.xml document for the given extensionID cannot be found or run. - - - - -
-
-Throws - - - - -
ArgumentError — The extensionID parameter is null or is not a valid extension ID. - - -
-
- - - - - -
dispose()method 
-
-public function dispose():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Disposes of this ExtensionContext instance. - - - -

The runtime notifies the native implementation, which can release any associated - - native resources. After calling dispose(), the code cannot call the - - call() method and cannot get or set the actionScriptData property.

- - -
- - - - - -
getExtensionDirectory()method 
-
-public static function getExtensionDirectory(extensionID:String):File -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Returns the directory in which the extension is installed on the device. - - -

Sometimes an extension includes resources such as images that you want to access - - from the extension's ActionScript code. Sometimes the code also requires information - - that is available in the extension descriptor file, such as the extension version number. - - You can use this method to access the base directory of the extension.

- - -

Regardless where the extension is on the device, the extension's files are always - - in the same location relative to this base directory of the extension. Using the File instance - - that this method returns, you can navigate to and manipulate specific files included with - - the extension.

- - -

The extension directory has the following structure:

- - 
-
-			 extension base directory/
-
-			      platform independent files
-
-			      META-INF/
-
-			           ANE/
-
-			                extension.xml
-
-			                platform name/
-
-			                     platform-dependent files and directories
-
-
- - -

The extension directory location depends on whether the extension is available through - - application-bundling or device-bundling as follows:

- -
    - -
  • - - With application-bundling, the extension directory is located within the application directory. - -
    • - -
  • - - With device-bundling, the extension directory location depends on the device. - -
    • - -
- -

An exception to using getExtensionDirectory() exists for native extensions for iOS devices. - - The resources for these extensions are not located in the extension directory. - - Instead, they are located in the top-level application directory. - -

- - Parameters - - - - -
extensionID:String — The extension identifier of the extension. This identifier has the same - - value as the extensionID parameter in createExtensionContext(). - - -
-

-Returns - - - - -
File — - A File instance for the directory in which the extension is installed. - - - - -
-
-Throws - - - - - - - - - - -
TypeError — Parameter extensionID must not be null. - - -
 
ArgumentError — The value specified for argument extensionID is invalid. - - The directory does not exist. - - -
-
- - - - - -
getExtensionInfo()method 
-
-public static function getExtensionInfo(extensionID:String):ExtensionInfo -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Gets information about an extension from the ID. This allows an ANE user to check whether an ANE has - - been loaded and to find out other information about the extension, by checking the ExtensionInfo - - details. - - -

Parameters - - - - -
extensionID:String — The extension identifier for the ANE being queried. - - -
-

-Returns - - - - -
ExtensionInfo — - The ExtensionInfo object relating to this ANE, or null if there is no extension - - that has the requested identifier. - - - - -
-
- - - - - -
loadExtension()method 
-
-public static function loadExtension(extensionID:String, aneFolder:File):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Loads an extension into the AIR runtime so that it can be created via createExtensionContext. - - -

Parameters - - - - - - - - - - -
extensionID:String — The extension identifier of the extension. This identifier has the same - - value as the id element in the extension descriptor file. Application developers also - - use this value in the extensionID element in the application descriptor file. - - All extensions share a single, global namespace. Therefore, to avoid name conflicts, - - use reverse DNS notation for the extension identifier. - - -
 
aneFolder:File — The folder in which the extension descriptor file is located. This parameter may - - be null where the request is to load an already-defined extension that was set up as a delayed-load - - extension; otherwise, this location is checked for an extension descriptor file that defines the ANE - - with the given extensionID, and if successful the ANE is then loaded in dynamically. - - -
-

-Returns - - - - -
Boolean — - Success if the ANE was loaded in successfully, such that the client code may now call any - - function that references the ANE's library/interface code. - - - - -
-
-Throws - - - - -
ArgumentError — The extensionID parameter is null or is not a valid extension ID, - - or if the aneFolder is non-null but does not reference a valid folder location. - - -
-
-
Event detail
- - - - - -
statusevent 
-
-Event object type: flash.events.StatusEvent -
-StatusEvent.type property = flash.events.StatusEvent.STATUS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - The ExtensionContext class provides an interface for calling functions - - in the native implementation of a native extension for Adobe AIR. You can use this class only - - in ActionScript classes that are part of the extension. - - -

AIR profile support: This feature is supported - - on mobile devices starting in AIR 3. It is also supported starting in AIR 3 on - - desktop devices in applications that use the extendedDesktop device profile. - - It is supported on AIR for TV devices starting in AIR 2.5 in applications that use the extendedTV - - device profile. - -

- - - -

A native extension is a combination of:

- - -

  • ActionScript classes.
    • - -
  • Native code. Native code is code that executes on a device outside the runtime. - - For example, code that you write in C is native code.
    • - -

- - -

You can create a native extension to:

- -
    - -
  • Give an AIR application access to device-specific features.
    • - -
  • Reuse existing native code.
    • - -
  • Provide more efficient processing using native code than you can provide with ActionScript code.
    • - -
- - -

Use the ExtensionContext class in the ActionScript side of an extension to access - - the native side of the extension. First, create an instance of the ExtensionContext class. - - To do so, call the static method ExtensionContext.createExtensionContext().

- - -

After creating the ExtensionContext instance, use the instance's call() method to - - call a native function.

- - -

When you are done with an ExtensionContext instance, call dispose() to release - - any associated native resources. Without an explicit call to dispose(), - - the runtime garbage collector calls dispose() when it disposes of the instance. - - An explicit call to dispose() typically occurs much sooner than waiting for the - - garbage collector.

- - -

An ExtensionContext instance can listen for StatusEvent events that the native code - - dispatches when some asynchronous event occurs in the extension's native implementation. - - Since the ExtensionContext class derives from EventDispatcher, it can in turn dispatch events.

- - -

- Defines the value of the type property of a status event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
codeA description of the object's status.
currentTargetThe object that is actively processing the Event - object with an event listener.
levelThe category of the message, such as "status", "warning" or "error".
targetThe object reporting its status.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/external/ExtensionInfo.html b/html-docs/flash/external/ExtensionInfo.html deleted file mode 100644 index d491162..0000000 --- a/html-docs/flash/external/ExtensionInfo.html +++ /dev/null @@ -1,602 +0,0 @@ - - - - - - - - -flash.external.ExtensionInfo (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.external
Classpublic final class ExtensionInfo
InheritanceExtensionInfo Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

-

- - The ExtensionInfo class provides details about a particular AIR Native Extension. - - -

-

-See also -

-
-flash.external.ExtensionContext -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  copyright : String -
[read-only] - - The extension copyright information, as provided in the extension's XML descriptor file.
-		ExtensionInfo
  description : String -
[read-only] - - The extension description, as provided in the extension's XML descriptor file.
-		ExtensionInfo
  extensionID : String -
[read-only] - - Returns the identifier for this extension.
-		ExtensionInfo
  inAppDescriptor : Boolean -
[read-only] - - A Boolean value indicating whether the extension was present in the Application Descriptor - - file or whether it was loaded and registered dynamically.
-		ExtensionInfo
  isDynamic : Boolean -
[read-only] - - A Boolean value indicating whether the extension is a 'dynamically loaded' ANE or not.
-		ExtensionInfo
  isLoaded : Boolean -
[read-only] - - A Boolean value indicating whether the extension has been loaded or not.
-		ExtensionInfo
  name : String -
[read-only] - - The extension name, as provided in the extension's XML descriptor file.
-		ExtensionInfo
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  versionNumber : String -
[read-only] - - The extension version number, as provided in the extension's XML descriptor file.
-		ExtensionInfo
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-load():Boolean -
-
- - A utility method to load in the native library for a dynamic extension.
-		ExtensionInfo
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
copyrightproperty
-
-copyright:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - The extension copyright information, as provided in the extension's XML descriptor file. This may be null if no copyright info was given. - - -

Implementation -
-    public function get copyright():String -
-
- - - - - -
descriptionproperty 
-
-description:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - The extension description, as provided in the extension's XML descriptor file. This may be null if no descriptionr was given. - - -

Implementation -
-    public function get description():String -
-
- - - - - -
extensionIDproperty 
-
-extensionID:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Returns the identifier for this extension. - - -

Implementation -
-    public function get extensionID():String -
-
- - - - - -
inAppDescriptorproperty 
-
-inAppDescriptor:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - A Boolean value indicating whether the extension was present in the Application Descriptor - - file or whether it was loaded and registered dynamically. If the extension is listed within the - - extensions section of the app descriptor, this property returns - - true, but if the extension was loaded via ExtensionContent.loadExtension - - then this property returns false. - - -

Implementation -
-    public function get inAppDescriptor():Boolean -
-
- - - - - -
isDynamicproperty 
-
-isDynamic:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - A Boolean value indicating whether the extension is a 'dynamically loaded' ANE or not. - - A 'dynamic' ANE is one that is loaded on demand: this may be one from the Application Descriptor - - that has the delayLoad attribute set to true, or it may be one that has been loaded - - in at runtime using ExtensionContent.loadExtension where the path to the ANE folder is - - provided. This value is false iff the extension was listed in the Application Descriptor - - without the delayLoad attribute being set to true. - - -

Implementation -
-    public function get isDynamic():Boolean -
-
- - - - - -
isLoadedproperty 
-
-isLoaded:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - A Boolean value indicating whether the extension has been loaded or not. Extensions that are - - listed in the Application Descriptor file using the attribute delayLoad="true" will - - be registered but not loaded; this flag will stay false until the ExtensionContext.loadExtension - - method has been called for them. - - -

Implementation -
-    public function get isLoaded():Boolean -
-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - The extension name, as provided in the extension's XML descriptor file. This may be null if no name was given. - - -

Implementation -
-    public function get name():String -
-
- - - - - -
versionNumberproperty 
-
-versionNumber:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - The extension version number, as provided in the extension's XML descriptor file. - - -

Implementation -
-    public function get versionNumber():String -
-
- -
Method detail
- - - - - -
load()method
-
-public function load():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - A utility method to load in the native library for a dynamic extension. - - This is the equivalent of calling ExtensionContent.loadExtension with this object's - - extensionID property. - - -

-Returns - - - - -
Boolean — - true if the extension was loaded successfully (or was already loaded) - - - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/external/ExternalInterface.html b/html-docs/flash/external/ExternalInterface.html deleted file mode 100644 index ec502ea..0000000 --- a/html-docs/flash/external/ExternalInterface.html +++ /dev/null @@ -1,874 +0,0 @@ - - - - - - - - -flash.external.ExternalInterface (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.external
Classpublic final class ExternalInterface
InheritanceExternalInterface Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The ExternalInterface class is an application programming interface - that enables straightforward communication between ActionScript and the SWF - container– for example, an HTML page with JavaScript or a desktop application - that uses Flash Player to display a SWF file. -

Using the ExternalInterface class, you can call an ActionScript function in - the Flash runtime, using JavaScript in the HTML page. The ActionScript function can return a value, - and JavaScript receives it immediately as the return value of the call.

-

This functionality replaces the - fscommand() method.

- -

Use the ExternalInterface class in the following combinations of browser and - operating system:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BrowserOperating SystemOperating System
Internet Explorer 5.0 and later Windows  
Netscape 8.0 and later Windows  MacOS 
Mozilla 1.7.5 and later Windows  MacOS 
Firefox 1.0 and later Windows  MacOS 
Safari 1.3 and later  MacOS 
-

Flash Player for Linux version 9.0.31.0 and later supports the ExternalInterface class in the following browsers:

- - - - - - - - - - - - - -
Browser
Mozilla 1.7.x and later
Firefox 1.5.0.7 and later
SeaMonkey 1.0.5 and later
-

The ExternalInterface class requires the user's web browser to support either - ActiveX® or the NPRuntime API that is exposed by some browsers for plug-in scripting. - Even if a browser and operating system combination are not listed above, they should support - the ExternalInterface class if they support the NPRuntime API. - See http://www.mozilla.org/projects/plugins/npruntime.html.

-

Note: When embedding SWF files within an HTML page, make sure that the id attribute is set and the - id and name attributes of the object and embed - tags do not include the following characters:

- 
- . - + * / \
-
-

Note for Flash Player applications: Flash Player version 9.0.115.0 and later allows the . (period) character - within the id and name attributes.

-

Note for Flash Player applications: In Flash Player 10 and later running in a browser, using this class programmatically to - open a pop-up window may not be successful. Various browsers (and browser configurations) may block pop-up windows - at any time; it is not possible to guarantee any pop-up window will appear. - However, for the best chance of success, use this class to open a pop-up window only in code that executes - as a direct result of a user action (for example, in an event handler for a mouse click or key-press event.)

-

From ActionScript, you can do the following on the HTML page: -

    -
  • Call any JavaScript function.
    • -
  • Pass any number of arguments, with any names.
    • -
  • Pass various data types (Boolean, Number, String, and so on).
    • -
  • Receive a return value from the JavaScript function.
    • -
-

- -

From JavaScript on the HTML page, you can: -

    -
  • Call an ActionScript function.
    • -
  • Pass arguments using standard function call notation.
    • -
  • Return a value to the JavaScript function.
    • -
-

-

Note for Flash Player applications: Flash Player does not currently support SWF files embedded within HTML forms.

- -

Note for AIR applications: In Adobe AIR, the ExternalInterface class can be used to communicate between JavaScript - in an HTML page loaded in the HTMLLoader control and ActionScript in SWF content embedded in that HTML page.

- -

-

-View the examples. -

-

-See also -

-
-fscommand() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  available : Boolean -
[static][read-only] - Indicates whether this player is in a container that offers an external interface.
-		ExternalInterface
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  marshallExceptions : Boolean = false
[static] - Indicates whether the external interface should attempt to pass ActionScript exceptions to the - current browser and JavaScript exceptions to the player.
-		ExternalInterface
  objectID : String -
[static][read-only] - Returns the id attribute of the object tag in Internet Explorer, - or the name attribute of the embed tag in Netscape.
-		ExternalInterface
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-addCallback(functionName:String, closure:Function):void -
-
[static] - Registers an ActionScript method as callable from the container.
-		ExternalInterface
   -
-call(functionName:String, ... arguments):* -
-
[static] - Calls a function exposed by the SWF container, passing zero or - more arguments.
-		ExternalInterface
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
availableproperty
-
-available:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates whether this player is in a container that offers an external interface. - If the external interface is available, this property is true; otherwise, - it is false. -

Note: When using the External API with HTML, always check that the HTML - has finished loading before you attempt to call any JavaScript methods.

- Implementation -
-    public static function get available():Boolean -
-
-Example -

-
- - - - - -
marshallExceptionsproperty 
-
-public static var marshallExceptions:Boolean = false -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether the external interface should attempt to pass ActionScript exceptions to the - current browser and JavaScript exceptions to the player. You must explicitly set this property - to true to catch JavaScript exceptions in ActionScript and to catch ActionScript exceptions - in JavaScript. -

-See also -

-
-addCallBack() -
-try..catch..finally statement -
-
-Example -
The following example creates an ActionScript function and registers it with - the containing browser by using the addCallback() method. The new function throws - an exception so that JavaScript code running in the browser can catch it. This example also - contains a try..catch statement to catch any exceptions thrown by the browser - when the throwit() function is called. -
-
-
-package
-{
-    import flash.external.*
-    import flash.net.*;
-    import flash.display.*;
-    import flash.system.System;
-    public class ext_test extends Sprite {
-    function ext_test():void {
-        ExternalInterface.marshallExceptions = true;
-        ExternalInterface.addCallback("g", g);
-
-        try {
-        ExternalInterface.call("throwit");
-        } catch(e:Error) {
-        trace(e)
-        }
-    }
-    function g() { throw new Error("exception from actionscript!!!!") }
-    }
-}
-
-

-
- - - - - -
objectIDproperty 
-
-objectID:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the id attribute of the object tag in Internet Explorer, - or the name attribute of the embed tag in Netscape. -

Implementation -
-    public static function get objectID():String -
-
- -
Method detail
- - - - - -
addCallback()method
-
-public static function addCallback(functionName:String, closure:Function):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Registers an ActionScript method as callable from the container. - After a successful invocation of addCallBack(), the registered function in - the player can be called by JavaScript or ActiveX code in the container. -

Note: For local content running in a browser, calls to the - ExternalInterface.addCallback() method work only if the SWF file and the - containing web page are in the local-trusted security sandbox. For more information, - see the Flash Player Developer Center Topic: Security.

- - Parameters - - - - - - - - - - -
functionName:String — The name by which the container can invoke - the function. -
 
closure:Function — The function closure to invoke. This could be a - free-standing function, or it could be a method closure - referencing a method of an object instance. By passing - a method closure, you can direct the callback - at a method of a particular object instance. -

Note: Repeating addCallback() on an existing callback function - with a null closure value removes the callback.

-
-
-Throws - - - - - - - - - - - - - - - - -
Error — The container does not support incoming calls. - Incoming calls are supported only in Internet Explorer for Windows and browsers - that use the NPRuntime API such as Mozilla 1.7.5 and later or Firefox 1.0 and later. -
 
SecurityError — A callback with the specified name has already been - added by ActionScript in a sandbox to which you do not have access; you - cannot overwrite that callback. To work around this problem, rewrite the - ActionScript that originally called the addCallback() method so that it also - calls the Security.allowDomain() method. -
 
SecurityError — The containing environment belongs to a security sandbox - to which the calling code does not have access. To fix this problem, follow these steps: - -
    - -
  1. In the object tag for the SWF file in the containing HTML page, - set the following parameter: - -

    <param name="allowScriptAccess" value="always" />

    - -
    2. - -
  2. In the SWF file, add the following ActionScript: - -

    flash.system.Security.allowDomain(sourceDomain)

    - -
    3. - -
- -
-

-See also -

-
-flash.system.Security.allowDomain() -
-
- - - - - -
call()method 
-
-public static function call(functionName:String, ... arguments):* -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Calls a function exposed by the SWF container, passing zero or - more arguments. If the function is not available, the call returns - null; otherwise it returns the value provided by the function. - Recursion is not permitted on Opera or Netscape browsers; on these browsers a recursive call - produces a null response. (Recursion is supported on Internet Explorer and Firefox browsers.) -

If the container is an HTML page, this method invokes a JavaScript function - in a script element.

-

If the container is another ActiveX container, this method dispatches the - FlashCall ActiveX event with the specified name, and the container processes the event.

- -

If the container is hosting the Netscape plug-in, you can either write custom support - for the new NPRuntime interface or embed an HTML control and embed the player within - the HTML control. If you embed an HTML control, you can communicate with the - player through a JavaScript interface to the native container application.

- -

Note: For local content running in a browser, calls to the - ExternalInterface.call() method are permitted only if the SWF file and the - containing web page (if there is one) are in the local-trusted security sandbox. Also, you can - prevent a SWF file from using this method by setting the allowNetworking - parameter of the object and embed tags in the HTML - page that contains the SWF content. For more information, see the Flash Player Developer Center Topic: - Security.

- -

Note for Flash Player applications: In Flash Player 10 and Flash Player 9 Update 5, some web browsers restrict this method - if a pop-up blocker is enabled. In this scenario, you can only call this method successfully - in response to a user event (for example, in an event handler for a mouse click or keypress event).

- Parameters - - - - - - - - - - -
functionName:String — The alphanumeric name of the function to call in the container. Using a non-alphanumeric function name - causes a runtime error (error 2155). You can use a try..catch block to handle the error. -
 
... arguments — The arguments to pass to the function in the - container. You can specify zero or more parameters, separating them with commas. - They can be of any ActionScript data type. - When the call is to a JavaScript function, the ActionScript - types are automatically converted into JavaScript types; when the call is to some other - ActiveX container, the parameters are encoded in the request message. - -
-

-Returns - - - - -
* — The response received from the container. If the call failed– for example, if there is no such - function in the container, the interface is not available, a recursion occurred (with a Netscape - or Opera browser), or there is a security issue– null is returned and an error is thrown. - -
-
-Throws - - - - - - - - - - -
Error — The container does not support outgoing calls. - Outgoing calls are supported only in Internet Explorer for Windows and browsers - that use the NPRuntime API such as Mozilla 1.7.5 and later or Firefox 1.0 and later. -
 
SecurityError — The containing environment belongs to a security sandbox - to which the calling code does not have access. To fix this problem, follow these steps: - -
    - -
  1. In the object tag for the SWF file in the containing HTML page, - set the following parameter: - -

    <param name="allowScriptAccess" value="always" />

    - -
    2. - -
  2. In the SWF file, add the following ActionScript: - -

    flash.system.Security.allowDomain(sourceDomain)

    - -
    3. - -
-
-
-Example -
The following example shows how you can use the ExternalInterface class (flash.external.ExternalInterface) to send a string from Flash Player - to the HTML container where it is displayed using the JavaScript alert() function. - Example provided by - ActionScriptExamples.com. -
-
-//
-// Requires:
-//   - A Flash Professional Label component on the Stage with an instance name of "lbl".
-//   - A Flash Professional Button component on the Stage with an instance name of "button".
-//
-var xmlResponse:String = "<invoke name=\"isReady\" returntype=\"xml\"><arguments><number>1</number><number>" + stage.stageWidth + "</number><number>" + stage.stageHeight + "</number></arguments></invoke>";
- 
-lbl.text = "ExternalInterface.available: " + ExternalInterface.available;
-lbl.width = 200;
-button.enabled = ExternalInterface.available;
-button.addEventListener(MouseEvent.CLICK, button_click);
- 
-function button_click(evt:MouseEvent):void {
-    ExternalInterface.call("alert", xmlResponse);
-}
-
-

-
- -
Examples
-
examples\ExternalInterfaceExample
-
The following example demonstrates sending data between Flash Player and an HTML container. -
-
-
-package  {
-    
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.external.ExternalInterface;
-    import flash.text.TextField;
-    import flash.utils.Timer;
-    import flash.text.TextFieldType;
-    import flash.text.TextFieldAutoSize;
-    import flash.system.Security;
-	
-	public class ExternalInterfaceExample extends Sprite 
-	{
-		
-	private var input:TextField;
-        private var output:TextField;
-        private var sendBtn:Sprite;
-		
-		public function ExternalInterfaceExample() 
-		{
-			// constructor code
-			Security.allowDomain("*");
-			
-			
-			input = new TextField();
-            input.type = TextFieldType.INPUT;
-            input.background = true;
-            input.border = true;
-            input.width = 350;
-            input.height = 18;
-            addChild(input);
-
-            sendBtn = new Sprite();
-            sendBtn.mouseEnabled = true;
-            sendBtn.x = input.width + 10;
-            sendBtn.graphics.beginFill(0xcccccc);
-            sendBtn.graphics.drawRoundRect(0, 0, 80, 18, 10, 10);
-            sendBtn.graphics.endFill();
-            sendBtn.addEventListener(MouseEvent.CLICK, clickHandler);
-            addChild(sendBtn);
-
-            output = new TextField();
-            output.y = 25;
-            output.width = 450;
-            output.height = 325;
-            output.multiline = true;
-            output.wordWrap = true;
-            output.border = true;
-            output.text = "Initializing...\n";
-            addChild(output);
-			
-			
-            if (ExternalInterface.available) {
-                try {
-                    output.appendText("Adding callback...\n");
-                    ExternalInterface.addCallback("sendToActionScript", receivedFromJavaScript);
-                    if (checkJavaScriptReady()) {
-                        output.appendText("JavaScript is ready.\n");
-                    } else {
-                        output.appendText("JavaScript is not ready, creating timer.\n");
-                        var readyTimer:Timer = new Timer(100, 0);
-                        readyTimer.addEventListener(TimerEvent.TIMER, timerHandler);
-                        readyTimer.start();
-                    }
-                } catch (error:SecurityError) {
-                    output.appendText("A SecurityError occurred: " + error.message + "\n");
-                } catch (error:Error) {
-                    output.appendText("An Error occurred: " + error.message + "\n");
-                }
-            } else {
-                output.appendText("External interface is not available for this container.");
-            }
-        }
-        private function receivedFromJavaScript(value:String):void {
-            output.appendText("JavaScript says: " + value + "\n");
-        }
-        private function checkJavaScriptReady():Boolean {
-            var isReady:Boolean = ExternalInterface.call("isReady");
-            return isReady;
-        }
-        private function timerHandler(event:TimerEvent):void {
-            output.appendText("Checking JavaScript status...\n");
-            var isReady:Boolean = checkJavaScriptReady();
-            if (isReady) {
-                output.appendText("JavaScript is ready.\n");
-				output.appendText("ExternalInterface.objectID = " + ExternalInterface.objectID + "\n");
-                Timer(event.target).stop();
-            }
-        }
-        private function clickHandler(event:MouseEvent):void {
-            if (ExternalInterface.available) {
-                ExternalInterface.call("sendToJavaScript", input.text);
-            }
-        }
-    }
-}
-
-
-
-
In order to test the previous ActionScript code, embed the generated SWF file using the following HTML template: - 
-  <!-- saved from url=(0014)about:internet -->
-  <html lang="en">
-  <head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <title>ExternalInterfaceExample</title>
-  <script language="JavaScript">
-      var jsReady = false;
-      function isReady() {
-          return jsReady;
-      }
-      function pageInit() {
-          jsReady = true;
-          document.forms["form1"].output.value += "\n" + "JavaScript is ready.\n";
-      }
-      function sendToActionScript(value) {
-        document.getElementById("ExternalInterfaceExample").sendToActionScript(value);
-      }
-      function sendToJavaScript(value) {
-          document.forms["form1"].output.value += "ActionScript says: " + value + "\n";
-      }
-  </script>
-  </head>
-  <body onload="pageInit();">
-  
-   <object id="ExternalInterfaceExample"  name="ExternalInterfaceExample" 
-   type="application/x-shockwave-flash" data="ExternalInterfaceExample.swf" width="550" height="400">
-     <param name="movie" value="ExternalInterfaceExample.swf"/>
-     <param name="quality" value="high"/>
-     <param name="allowscriptaccess" value="always"/>
-     <a href="http://www.adobe.com/go/getflash">
-         <img src="http://www.adobe.com/images/shared/download_buttons/get_flash_player.gif" alt="Get Adobe Flash player"/>
-     </a>
-   </object>
-  
-      <form name="form1" onsubmit="return false;">
-          <input type="text" name="input" value="" />
-          <input type="button" value="Send" onclick="sendToActionScript(this.form.input.value);" /><br />
-          <textarea cols="60" rows="20" name="output" readonly="true">Initializing...</textarea>
-      </form>
-  
-  </body>
-  </html>
-
-
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/external/HostObject.html b/html-docs/flash/external/HostObject.html deleted file mode 100644 index d9884bb..0000000 --- a/html-docs/flash/external/HostObject.html +++ /dev/null @@ -1,1057 +0,0 @@ - - - - - - - - -flash.external.HostObject (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.external
Classpublic dynamic class HostObject
InheritanceHostObject Inheritance EventDispatcher Inheritance Object
-

- The HostObject is the base class of all host objects. It can either - be used directly, as it is a completely dynamic object, or via derived - classes that implement known elements complete with type declarations; - these implementations would call one of the protected methods below - for direct access to host object elements. -

HostObjects support enumeration as well as dynamic lookup. It is, - therefore, possible to use HostObjects as such, without having to - create ActionScript wrappers for each host object class.

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  available : Boolean -
[static][read-only] - Indicates whether this player is in a container that offers a high-bandwidth interface.
-		HostObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  extensions : Array -
[static][read-only] - Retrieve a list of the package names of all registered object model extensions.
-		HostObject
  mainExtension : String -
[static][read-only] - Retrieve the fully qualified package name of the main object model extension.
-		HostObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-__call(methName:String, args:Array):* -
-
- The universal method invoke method receives the property name - and returns the result of the method call.
-		HostObject
   -
-__get(propName:String):* -
-
- The universal getter method receives the property name - and returns whatever the property value is.
-		HostObject
   -
-__set(propName:String, value:*):void -
-
- The universal setter method stores the supplied value into - the given property.
-		HostObject
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-create(className:String, ... rest):HostObject -
-
[static] - Generic creation function for a new host object with a varying number of - creation arguments.
-		HostObject
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-eventListener(e:Event):void -
-
[static] - Register this method as an event listener to have the host application - process a Flex event.
-		HostObject
   -
-getClassObject(className:String):HostObject -
-
[static] - Return the host object that is a class object for the given class name.
-		HostObject
   -
-getQualifiedClassName(value:*):String -
-
[static] - Return the fully qualified class name of the given value.
-		HostObject
   -
-getRoot(name:String = ""):HostObject -
-
[static] - Return the host object that is a root object for the given extension.
-		HostObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-isExtensionAvailable(packageName:String):Boolean -
-
[static] - Check for the availability of a certain object model extension.
-		HostObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-isValid(obj:HostObject):Boolean -
-
[static] - Check whether this HostObject wrapper object still is connected to its host - counterpart.
-		HostObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Implement toString() by calling the host object's toString() method if - available; if not, return [HostObject xxx], where xxx is the class name.
-		HostObject
   -
-valueOf():* -
-
- Implement valueOf() by calling the host object's valueOf() method if - available; if not, return this instance to indicate the absence of - a primitive value.
-		HostObject
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Protected Methods
- - - - - - - -
 MethodDefined by
   -
-__construct(args:Array):void -
-
- The universal constructor method initizalizes a new instance of the - current class.
-		HostObject
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
availableproperty
-
-available:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether this player is in a container that offers a high-bandwidth interface. - If the high-bandwidth interface is available, this property is true; otherwise, - it is false. -

Implementation -
-    public static function get available():Boolean -
-
- - - - - -
extensionsproperty 
-
-extensions:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Retrieve a list of the package names of all registered object model extensions. - The first element of that list is the package name of the main extension, which - is used to complete bare class names, if the host registered a main extension. -

Implementation -
-    public static function get extensions():Array -
-
- - - - - -
mainExtensionproperty 
-
-mainExtension:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Retrieve the fully qualified package name of the main object model extension. - This name be an empty string if the host did not register a main extension. - Note that other components inside the host may choose to register their own - object model extensions. -

Implementation -
-    public static function get mainExtension():String -
-
- -
Method detail
- - - - - -
__call()method
-
-public function __call(methName:String, args:Array):* -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The universal method invoke method receives the property name - and returns the result of the method call. Derived classes - use this method to implement their own methods. For ease of - implementation, the arguments object can be used as argument - to this method. -

Note: This method is intended for use by SWC code only that implements - wrapper classes for host objects.

- Parameters - - - - - - - - - - -
methName:String — the method name to invoke -
 
args:Array — the arguments; use the arguments object -
-

-Returns - - - - -
* — whatever the method call returns -
-
-Example -

-
- - - - - -
__construct()method 
-
-protected function __construct(args:Array):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The universal constructor method initizalizes a new instance of the - current class. Use this method to implement host-side constructors - for host wrapper classes. -

Note: This method may throw if the host does not support - the construction of the given class.

-

Note: This method is intended for use by SWC code only that implements - wrapper classes for host objects.

- Parameters - - - - -
args:Array — the arguments; use the arguments object -
-
-Example -

-
- - - - - -
__get()method 
-
-public function __get(propName:String):* -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The universal getter method receives the property name - and returns whatever the property value is. Derived classes - use this method to implement property read acces. -

Note: This method is intended for use by SWC code only that implements - wrapper classes for host objects.

- Parameters - - - - -
propName:String — the property name -
-

-Returns - - - - -
* — the property value -
-
-Example -

-
- - - - - -
__set()method 
-
-public function __set(propName:String, value:*):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The universal setter method stores the supplied value into - the given property. Derived classes use this method to - implement property write acces. -

Note: This method is intended for use by SWC code only that implements - wrapper classes for host objects.

- Parameters - - - - - - - - - - -
propName:String — the property name -
 
value:* — the property value -
-
-Example -

-
- - - - - -
create()method 
-
-public static function create(className:String, ... rest):HostObject -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Generic creation function for a new host object with a varying number of - creation arguments. Use this static method to create a HostObject - without using an ActionScript wrapper object derived from HostObject. - The class name is the host object class name. If not fully qualified, - the package name of the main object model extension is used as the package name. - The class name can be either in dot format(packagename.classname) or in - ActionScript format(packagename::classname). -

Parameters - - - - - - - - - - -
className:String — the fully qualified class name of the object to create -
 
... rest — all remaining arguments are passed to the constructor for that object -
-

-Returns - - - - -
HostObject — - the newly created object - - - -
-
- - - - - -
eventListener()method 
-
-public static function eventListener(e:Event):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Register this method as an event listener to have the host application - process a Flex event. If this function is registered as an event listener, - the event is forwarded to all event processors registered until one of them - signals that the event has been processed. -

Parameters - - - - -
e:Event — the Event object to forward -
-
- - - - - -
getClassObject()method 
-
-public static function getClassObject(className:String):HostObject -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Return the host object that is a class object for the given class name. - The supplied string is the fully qualified class name of the class object - to be returned. If a bare class name is supplied, the main extension's - package name is assumed. The class object is required to access class - properties and methods. The class name can be either in dot format - packagename.classname) or in ActionScript format(packagename::classname). - Note that the returned object is a plain HostObject, not an ActionScript - Class object. ActionScript wrapper classes retrieve the class object from - the host and access the class elements as instance elements of the class object. -

Parameters - - - - -
className:String — class name of the class object to return -
-

-Returns - - - - -
HostObject — - the class object - - -
-
- - - - - -
getQualifiedClassName()method 
-
-public static function getQualifiedClassName(value:*):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Return the fully qualified class name of the given value. This method - can be viewed as an extension of flash.utils.getQualifiedClassName() that - also covers generic HostObject instances that do not have an ActionScript - wrapper class implemented. A call to flash.utils.getQualifiedClassName() - with a HostObject as argument would always return "flash.external::HostObject", - while this method returns the combination of the host object's package name and - host class name, like e.g. "com.adobe.indesign::Document". -

Parameters - - - - -
value:* — value whose class name to return -
-

-Returns - - - - -
String — - the value's fully qualified class name - - -
-
- - - - - -
getRoot()method 
-
-public static function getRoot(name:String = ""):HostObject -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Return the host object that is a root object for the given extension. - The supplied string is the package name of the extension whose root object - is to be returned. An example is "com.adobe.photoshop". If the string is - empty or null, the package name of the main extension is assumed. Use the - fully qualified package name for registered extensions that are not main - extensions. Note that the extension may choose to return null if there is - no root object. -

Parameters - - - - -
name:String (default = "") — package name of the extension -
-

-Returns - - - - -
HostObject — - the root object, or null if the root object cannot be returned - - -
-
- - - - - -
isExtensionAvailable()method 
-
-public static function isExtensionAvailable(packageName:String):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Check for the availability of a certain object model extension. Use the - package name to identify the extension. Returns true if the extension is - available, false if not, or the HostObject API is not available at all. - -

Parameters - - - - -
packageName:String — package name of the extension to check for -
-

-Returns - - - - -
Boolean — - true if the extension has been registered - - - -
-
- - - - - -
isValid()method 
-
-public static function isValid(obj:HostObject):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Check whether this HostObject wrapper object still is connected to its host - counterpart. Disconnected objects throw exceptions on any access attempt. - This method checks the object's status without throwing an exception. -

Parameters - - - - -
obj:HostObject — the HostObject wrapper object to check -
-

-Returns - - - - -
Boolean — - true if the object is still connected to its host counterpart - - -
-
- - - - - -
toString()method 
-
-public final override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Implement toString() by calling the host object's toString() method if - available; if not, return [HostObject xxx], where xxx is the class name. - The method is declared final so derived classes cannot provide their own - implementation, but must rely on this default implementation, which - already calls the host object's toString() method if defined. -

-Returns - - - - -
String
-
- - - - - -
valueOf()method 
-
-public final function valueOf():* -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Implement valueOf() by calling the host object's valueOf() method if - available; if not, return this instance to indicate the absence of - a primitive value. - The method is declared final so derived classes cannot provide their own - implementation, but must rely on this default implementation, which - already calls the host object's valueOf() method if defined. -

-Returns - - - - -
*
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/external/package-detail.html b/html-docs/flash/external/package-detail.html deleted file mode 100644 index a0a4283..0000000 --- a/html-docs/flash/external/package-detail.html +++ /dev/null @@ -1,73 +0,0 @@ - - - - - - - -flash.external Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.external package contains the ExternalInterface class which can be used to communicate with the Flash Player's container.

-
-
- -
Classes
- - - - - - - - - - - - - - - - -
 ClassDescription
 ExtensionContext

The ExtensionContext class also provides a static method getExtensionDirectory() for - - accessing the directory in which the extension is installed on the device.

 ExtensionInfo - - The ExtensionInfo class provides details about a particular AIR Native Extension.
 ExternalInterface - The ExternalInterface class is an application programming interface - that enables straightforward communication between ActionScript and the SWF - container– for example, an HTML page with JavaScript or a desktop application - that uses Flash Player to display a SWF file.
 HostObject - The HostObject is the base class of all host objects.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Oct 12 2022, 12:45 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/filesystem/File.html b/html-docs/flash/filesystem/File.html deleted file mode 100644 index efcb330..0000000 --- a/html-docs/flash/filesystem/File.html +++ /dev/null @@ -1,6511 +0,0 @@ - - - - - - - - -flash.filesystem.File (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filesystem
Classpublic class File
InheritanceFile Inheritance FileReference Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - A File object represents a path to a file or directory. This can be an existing file or directory, or it can be - - one that does not yet exist; for instance, it can represent the path to a file or directory that you plan to create. - - - -

The File class has a number of properties and methods for getting information about the file system and - - for performing operations, such as copying files and directories.

- - - -

You can use File objects along with the FileStream class to read and write files.

- - - -

The File class extends the FileReference class. The FileReference class, which is available in Flash® Player as - - well as Adobe® AIR®, represents a pointer to a file, but the File class adds properties and methods that are not - - exposed in Flash Player (in a SWF running in a browser), due to security considerations.

- - - -

The File class includes static properties that let you reference commonly used directory locations. These static properties include:

- - -
    - -
  • File.applicationStorageDirectory—a storage directory unique to each installed AIR application
    • - -
  • File.applicationRemovableStorageDirectory—(Android-only): a storage directory on an exterrnal/removal device unique to each installed AIR application
    • - -
  • File.applicationDirectory—the read-only directory where the application is installed (along with any installed assets)
    • - -
  • File.desktopDirectory—the user's desktop directory
    • - -
  • File.documentsDirectory—the user's documents directory
    • - -
  • File.userDirectory—the user directory
    • - -
- - -

These properties have meaningful values on different operating systems. For example, Mac OS, Linux, and Windows each have - - different native paths to the user's desktop directory. However, the File.desktopDirectory property points to the - - correct desktop directory path on each of these platforms. To write applications that work well across platforms, - - use these properties as the basis for referencing other files used by the application. Then use the resolvePath() - - method to refine the path. For example, this code points to the preferences.xml file in the application storage directory:

- - - 
 var prefsFile:File = File.applicationStorageDirectory;
-
-  prefsFile = prefsFile.resolvePath("preferences.xml");
- - - 
 var prefsFile = air.File.applicationStorageDirectory;
-
-  prefsFile = prefsFile.resolvePath("preferences.xml");
- - -

If you use a literal native path in referencing a file, it will only work on one platform. - - For example, the following File object would only work on Windows:

- - - 
new File("C:\Documents and Settings\joe\My Documents\test.txt")
- - 
new air.File("C:\Documents and Settings\joe\My Documents\test.txt")
- - -

The application storage directory is particularly useful. It gives an application-specific storage - - directory for the AIR application. It is defined by the File.applicationStorageDirectory - - property. Note that on Mac OS, this location changed between AIR 3.2 and AIR 3.3.

- - -

Do not add or remove content from the application directory (where the AIR application is installed). - - Doing so can break an AIR application and invalidate the application signature. AIR does not let you write to - - the application directory by default, because the directory is not writable to all user accounts on all operating systems. - - Use the application storage directory to write internal application files. Use the documents directory to write files - - that a user expects to use outside your application, such as edited pictures or text files.

- - - -

-

-See also -

-
-FileStream -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  applicationDirectory : File -
[static][read-only] - - The folder containing the application's installed files.
-		File
  applicationRemovableStorageDirectory : File -
[static][read-only] - - The application's private storage directory on an external and removable device, if present.
-		File
  applicationStorageDirectory : File -
[static][read-only] - - The application's private storage directory.
-		File
  cacheDirectory : File -
[static][read-only] - - The application's cache directory.
-		File
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcreationDate : Date -
- The creation date of the file on the local disk.
-		FileReference
 Inheritedcreator : String -
- The Macintosh creator type of the file, which is only used in Mac OS versions - prior to Mac OS X.
-		FileReference
 Inheriteddata : ByteArray -
- The ByteArray object representing the data from the loaded file after a successful call to the load() method.
-		FileReference
  desktopDirectory : File -
[static][read-only] - - The user's desktop directory.
-		File
  documentsDirectory : File -
[static][read-only] - - The user's documents directory.
-		File
  downloaded : Boolean -
- - Indicates whether the referenced file or directory was downloaded (from the internet) or not.
-		File
  exists : Boolean -
[read-only] - - Indicates whether the referenced file or directory exists.
-		File
 Inheritedextension : String -
- The filename extension.
-		FileReference
  icon : Icon -
[read-only] - - An Icon object containing the icons defined for the file.
-		File
  isDirectory : Boolean -
[read-only] - - Indicates whether the reference is to a directory.
-		File
  isHidden : Boolean -
[read-only] - - Indicates whether the referenced file or directory is "hidden." - - The value is true if the referenced file or directory is hidden, false otherwise.
-		File
  isPackage : Boolean -
[read-only] - - Indicates whether the referenced directory is a package.
-		File
  isSymbolicLink : Boolean -
[read-only] - - Indicates whether the reference is a symbolic link.
-		File
  lineEnding : String -
[static][read-only] - - The line-ending character sequence used by the host operating system.
-		File
 InheritedmodificationDate : Date -
- The date that the file on the local disk was last modified.
-		FileReference
 Inheritedname : String -
- The name of the file on the local disk.
-		FileReference
  nativePath : String -
- - The full path in the host operating system representation.
-		File
  parent : File -
[read-only] - - The directory that contains the file or directory referenced by this File object.
-		File
  permissionStatus : String -
[static][read-only] - - Determine whether the application has been granted the permission to access filesystem.
-		File
  preventBackup : Boolean -
- - Indicates whether or not the runtime prevents this File object from being backed up to the cloud.
-		File
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  separator : String -
[static][read-only] - - The host operating system's path component separator character.
-		File
 Inheritedsize : Number -
- The size of the file on the local disk in bytes.
-		FileReference
  spaceAvailable : Number -
[read-only] - - The space available for use at this File location, in bytes.
-		File
  systemCharset : String -
[static][read-only] - - The default encoding used by the host operating system.
-		File
 Inheritedtype : String -
- The file type.
-		FileReference
  url : String -
- - The URL for this file path.
-		File
  userDirectory : File -
[static][read-only] - - The user's directory.
-		File
  workingDirectory : File -
[static][read-only] - - The application's working directory (used primarily for command-line applications).
-		File
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-File(path:String = null)
-
- - The constructor function for the File class.
-		File
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-browse(typeFilter:Array = null):Boolean -
-
- Displays a file-browsing dialog box that lets the - user select a file to upload.
-		FileReference
   -
-browseForDirectory(title:String):void -
-
- - Displays a directory chooser dialog box, in which the user can select a directory.
-		File
   -
-browseForOpen(title:String, typeFilter:Array = null):void -
-
- - Displays the Open File dialog box, in which the user can select a file to open.
-		File
   -
-browseForOpenMultiple(title:String, typeFilter:Array = null):void -
-
- - Displays the Open File dialog box, in which the user can select one or more files to open.
-		File
   -
-browseForSave(title:String):void -
-
- - Displays the Save File dialog box, in which the user can select a file destination.
-		File
   -
-cancel():void -
-
- - Cancels any pending asynchronous operation.
-		File
   -
-canonicalize():void -
-
- - Canonicalizes the File path.
-		File
   -
-clone():File -
-
- - Returns a copy of this File object.
-		File
   -
-copyTo(newLocation:FileReference, overwrite:Boolean = false):void -
-
- - Copies the file or directory at the location specified by this File object to - - the location specified by the newLocation parameter.
-		File
   -
-copyToAsync(newLocation:FileReference, overwrite:Boolean = false):void -
-
- - Begins copying the file or directory at the location specified by this File object to - - the location specified by the destination parameter.
-		File
   -
-createDirectory():void -
-
- - Creates the specified directory and any necessary parent directories.
-		File
   -
-createTempDirectory():File -
-
[static] - - Returns a reference to a new temporary directory.
-		File
   -
-createTempFile():File -
-
[static] - - Returns a reference to a new temporary file.
-		File
   -
-deleteDirectory(deleteDirectoryContents:Boolean = false):void -
-
- - Deletes the directory.
-		File
   -
-deleteDirectoryAsync(deleteDirectoryContents:Boolean = false):void -
-
- - Deletes the directory asynchronously.
-		File
   -
-deleteFile():void -
-
- - Deletes the file.
-		File
   -
-deleteFileAsync():void -
-
- - Deletes the file asynchronously.
-		File
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-download(request:URLRequest, defaultFileName:String = null):void -
-
- Opens a dialog box that lets the user download a file from a remote server.
-		FileReference
   -
-getDirectoryListing():Array -
-
- - Returns an array of File objects corresponding to files and directories in the directory represented by this - - File object.
-		File
   -
-getDirectoryListingAsync():void -
-
- - Asynchronously retrieves an array of File objects corresponding to the contents of the directory represented - - by this File object.
-		File
   -
-getRelativePath(ref:FileReference, useDotDot:Boolean = false):String -
-
- - Finds the relative path between two File paths.
-		File
   -
-getRootDirectories():Array -
-
[static] - - Returns an array of File objects, listing the file system root directories.
-		File
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-load():void -
-
- Starts the load of a local file selected by a user.
-		FileReference
   -
-moveTo(newLocation:FileReference, overwrite:Boolean = false):void -
-
- - Moves the file or directory at the location specified by this File object to - - the location specified by the destination parameter.
-		File
   -
-moveToAsync(newLocation:FileReference, overwrite:Boolean = false):void -
-
- - Begins moving the file or directory at the location specified by this File object to - - the location specified by the newLocation parameter.
-		File
   -
-moveToTrash():void -
-
- - Moves a file or directory to the trash.
-		File
   -
-moveToTrashAsync():void -
-
- - Asynchronously moves a file or directory to the trash.
-		File
   -
-openWithDefaultApplication():void -
-
- - Opens the file in the application registered by the operating system to open this file type.
-		File
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-requestPermission():void -
-
- - Requests permission to access filesystem.
-		File
   -
-resolvePath(path:String):File -
-
- - Creates a new File object with a path relative to this File object's path, based on the - - path parameter (a string).
-		File
 Inherited -
-save(data:*, defaultFileName:String = null):void -
-
- Opens a dialog box that lets the user save a file to the local filesystem.
-		FileReference
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-upload(request:URLRequest, uploadDataFieldName:String = "Filedata", testUpload:Boolean = false):void -
-
- Starts the upload of the file to a remote server.
-		FileReference
 Inherited -
-uploadUnencoded(request:URLRequest):void -
-
- Initiate uploading a file to a URL without any encoding.
-		FileReference
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-cancel -
-		 - - Dispatched when a pending asynchronous operation is canceled.File
 Inherited -
-cancel -
-		 - Dispatched when a file upload or download is canceled through the file-browsing dialog - box by the user.FileReference
   -
-complete -
-		 - - Dispatched when an asynchronous operation is complete.File
 Inherited -
-complete -
-		 - Dispatched when download is complete or when upload generates an HTTP status code of 200.FileReference
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-directoryListing -
-		 - - Dispatched when a directory list is available as a result of a call to the getDirectoryListingAsync() - - method.File
 Inherited -
-httpResponseStatus -
-		 - Dispatched if a call to the upload() or uploadUnencoded() - method attempts to access data over HTTP and Adobe AIR is able to detect and return - the status code for the request.FileReference
 Inherited -
-httpStatus -
-		 - Dispatched when an upload fails and an HTTP status code is available - to describe the failure.FileReference
   -
-ioError -
-		 - - Dispatched when an error occurs during an asynchronous file operation.File
 Inherited -
-ioError -
-		 - Dispatched when the upload or download fails.FileReference
 Inherited -
-open -
-		 - Dispatched when an upload or download operation starts.FileReference
   -
-permissionStatus -
-		 - - Dispatched when the application requests permission to access filesystem.File
 Inherited -
-permissionStatus -
-		 - Dispatched when the application requests permission to access filesystem.FileReference
 Inherited -
-progress -
-		 - Dispatched periodically during the file upload or download operation.FileReference
   -
-securityError -
-		 - - Dispatched when an operation violates a security constraint.File
 Inherited -
-securityError -
-		 - Dispatched when a call to the FileReference.upload() - or FileReference.download() method tries to upload a file to a server or - get a file from a server that is outside the caller's security sandbox.FileReference
   -
-select -
-		 - - Dispatched when the user selects a file or directory from a file- or directory-browsing dialog box.File
 Inherited -
-select -
-		 - Dispatched when the user selects a file for upload or download from the file-browsing dialog box.FileReference
   -
-selectMultiple -
-		 - - Dispatched when the user selects files from the dialog box opened by a call to the - - browseForOpenMultiple() method.File
 Inherited -
-uploadCompleteData -
-		 - Dispatched after data is received from the server after a successful upload.FileReference
-
- -
- -
Property detail
- - - - - -
applicationDirectoryproperty
-
-applicationDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The folder containing the application's installed files. - - - -

The url property for this object uses the app URL scheme - - (not the file URL scheme). This means that the url string is specified starting - - with "app:" (not "file:"). Also, if you create a File object relative to the - - File.applicationDirectory directory (by using the resolvePath() method), - - the url property of the File object also uses the app URL scheme. - -

- - - -

Note: You cannot write to files or directories that have paths that use the app: - - URL scheme. Also, you cannot delete or create files or folders that have paths that use the app: - - URL scheme. Modifying content in the application directory is a bad practice, for security reasons, and is - - blocked by the operating system on some platforms. - - If you want to store application-specific data, consider using the application storage directory - - (File.applicationStorageDirectory). If you want any of the content in the application storage directory - - to have access to the application-privileged functionality (AIR APIs), you can expose that functionality - - by using a sandbox bridge.

- - - - -

The applicationDirectory property provides a way to reference the - - application directory that works across platforms. If you set a File object to reference - - the application directory using the nativePath or url property, - - it will only work on the platform for which that path is valid.

- - - -

On Android, the nativePath property of a File object pointing to the application directory is an empty - - string. Use the url property to access application files.

- - Implementation -
-    public static function get applicationDirectory():File -
-

-See also -

-
-applicationStorageDirectory -
-
- - - - - -
applicationRemovableStorageDirectoryproperty 
-
-applicationRemovableStorageDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 - -
-

- - The application's private storage directory on an external and removable device, if present. - - -

On Android, it is possible for an AIR application to use private, persistent storage on a removable - - storage device. This property provides access to that location. If there is no external storage device currently - - available from the device, this property will return null. - - This directory is a convenient location to store very large files for user-specific or application-specific data - - but it must be noted that the user could remove this device at any time.

- - - Implementation -
-    public static function get applicationRemovableStorageDirectory():File -
-
- - - - - -
applicationStorageDirectoryproperty 
-
-applicationStorageDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The application's private storage directory. - - - -

Each AIR application has a unique, persistent application storage directory, which - - is created when you first access File.applicationStorageDirectory. - - This directory is unique to each application and user. - - This directory is a convenient location to store user-specific or application-specific data.

- - - -

When you uninstall an AIR application, whether the uninstaller deletes the application storage directory - - and its files depends on the platform.

- - - -

The url property for this object uses the app-storage URL scheme - - (not the file URL scheme). This means that the url string is specified starting - - with "app-storage:" (not "file:"). Also, if you create a File object relative to the - - File.applicationStoreDirectory directory (by using the resolvePath() method), - - the url of the File object also uses the app-storage URL scheme - - (as in the example).

- - - -

The applicationStorageDirectory property provides a way to reference the - - application storage directory that works across platforms. If you set a File object to reference - - the application storage directory using the nativePath or url property, - - it will only work on the platform for which that path is valid.

- - -

Note (Mac OS only): To comply with Mac App Store requirements, the physical location of - - this directory changed between AIR 3.2 and AIR 3.3:

- -
    - -
  • 3.2 namespace and earlier: ~/Library/Preferences/appid/Local Store/
    • - -
  • 3.3 namespace and later: path/Library/Application Support/appid/Local Store/, where path is - - either ~/Library/Containers/bundle-id/Data (sandboxed environment) or ~ (when running outside a sandboxed - - environment)
    • - -
- - - - Implementation -
-    public static function get applicationStorageDirectory():File -
-
-Example -
The following code creates a File object pointing to the "images" subdirectory of - the application storage directory. -
-
-import flash.filesystem.File;
-
-var tempFiles:File = File.applicationStorageDirectory;
-tempFiles = tempFiles.resolvePath("images/");
-trace(tempFiles.url); // app-storage:/images
-
-

-
- - - - - -
cacheDirectoryproperty 
-
-cacheDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - The application's cache directory. - - -

The cacheDirectory property provides a way to reference the cache - - directory. Your application should use the cache directory to store files that are downloaded from a server - - or that can be otherwise re-generated. Examples of files you should put in the cache directory include - - database cache files and downloadable content, such as that used by magazine, newspaper, - - and map applications.

- - -

- - If you set a File object to reference the cache directory using - - the nativePath or url property, - - it will only work on platforms for which that path is valid.

- - -

If an operating system does not support a cache directory, cacheDirectory is null

- - - Implementation -
-    public static function get cacheDirectory():File -
-
- - - - - -
desktopDirectoryproperty 
-
-desktopDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The user's desktop directory. - - -

The desktopDirectory property provides a way to reference the desktop - - directory that works across platforms. If you set a File object to reference - - the desktop directory using the nativePath or url property, - - it will only work on the platform for which that path is valid.

- - -

If an operating system does not support a desktop directory, a suitable directory in the - - file system is used instead.

- - -

AIR for TV devices have no concept of a user's desktop directory. - - Therefore, the desktopDirectory property - - references the same directory location as File.userDirectory property. - - The user directory is unique to the application.

- - - - - - Implementation -
-    public static function get desktopDirectory():File -
-
-Example -
The following code outputs a list of files and directories contained in the user's desktop directory. -
-
-import flash.filesystem.File;
-var desktop:File = File.desktopDirectory;
-
-var files:Array = desktop.getDirectoryListing();
-
-for (var i:uint = 0; i < files.length; i++) {
-    trace(files[i].nativePath);
-}
-
- -

-
- - - - - -
documentsDirectoryproperty 
-
-documentsDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The user's documents directory. - - - -

On Windows, this is the My Documents directory (for example, C:\Documents and Settings\userName\My Documents). - - On Mac OS, the default location is /Users/userName/Documents. On Linux, the default location is /home/userName/Documents - - (on an English system), and the property observes the xdg-user-dirs setting.

- - - - -

The documentsDirectory property provides a way to reference the documents - - directory that works across platforms. If you set a File object to reference - - the documents directory using the nativePath or url property, - - it will only work on the platform for which that path is valid.

- - -

If an operating system does not support a documents directory, a suitable directory in the - - file system is used instead.

- - -

AIR for TV devices have no concept of a user's documents directory. - - Therefore, the documentsDirectory property - - references the same directory location as the File.userDirectory property. - - The user directory is unique to the application.

- - - - Implementation -
-    public static function get documentsDirectory():File -
-
-Example -
The following code uses the File.documentsDirectory property and the - File.createDirectory() method to ensure that a directory named "AIR Test" exists - in the user's documents directory. -
-
-import flash.filesystem.File;
-
-var directory:File = File.documentsDirectory;
-directory = directory.resolvePath("AIR Test");
-
-File.createDirectory(directory);
-trace(directory.exists); // true
-
-

-
- - - - - -
downloadedproperty 
-
-downloaded:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Indicates whether the referenced file or directory was downloaded (from the internet) or not. - - -

This property is only meaningful on operating systems in which files can be flagged as downloaded:

- - -
    - - -
  • Windows XP service pack 2 and later, and on Windows Vista
    • - - -
  • Mac OS 10.5 and later
    • - - - -
- - - -

On systems that do not flag downloaded files, such as Linux, - - the property is not meaningful (and it is set to false).

- - - Implementation -
-    public function get downloaded():Boolean -
-    public function set downloaded(value:Boolean):void -
-

-See also -

-
-openWithDefaultApplication() -
-
- - - - - -
existsproperty 
-
-exists:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether the referenced file or directory exists. - - The value is true if the File object points to an existing file or directory, - - false otherwise. - - -

Implementation -
-    public function get exists():Boolean -
-
-Example -
The following code creates a temporary file, then deletes it and uses the - File.exists property to check for the existence of the file. -
-
-import flash.filesystem.*;
-
-var temp:File = File.createTempFile();
-trace(temp.exists); // true
-temp.deleteFile();
-trace(temp.exists); // false
-
- -

-
- - - - - -
iconproperty 
-
-icon:Icon  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - An Icon object containing the icons defined for the file. An Icon object is an array of BitmapData - - objects corresponding to the various icon states. On Linux, the Icon object contains no icons. On - - Android, the icon property is null. - - - -

Implementation -
-    public function get icon():Icon -
-
-Example -
The following code shows how to find the image in the icon array that has - the greatest height, and it sets a Bitmap object to that image. -
-
-import flash.filesystem.File;
-import flash.display.*;
-
-var directory:File = File.documentsDirectory;
-var bitmaps:Array = directory.icon.bitmaps;
-var bmpData:BitmapData = new BitmapData(1, 1);
-for (var i:uint = 0; i < bitmaps.length; i++) {
-    if (bitmaps[i].height > bmpData.height) {
-		bmpData = directory.icon.bitmaps[i];
-	}
-}
-var iconBmp:Bitmap = new Bitmap(bmpData);
-
-
You might add this Bitmap object as a child of a display object container, - such as a Sprite object or a Flex UIComponent object. -
-
-

-
- - - - - -
isDirectoryproperty 
-
-isDirectory:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether the reference is to a directory. - - The value is true if the File object points to a directory; false otherwise. - - -

Implementation -
-    public function get isDirectory():Boolean -
-
-Example -
The following code creates an array of File objects pointing to files and directories in the - user directory and then uses the isDirectory property to list only those File objects that point to - directories (not to files). -
-
-import flash.filesystem.*;
-
-var userDirFiles:Array = File.userDirectory.getDirectoryListing();
-for (var i:uint = 0; i < userDirFiles.length; i++) {
-    if (userDirFiles[i].isDirectory) {
-		trace(userDirFiles[i].nativePath);
-	}
-}
-
- -

-
- - - - - -
isHiddenproperty 
-
-isHidden:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether the referenced file or directory is "hidden." - - The value is true if the referenced file or directory is hidden, false otherwise. - - - -

Implementation -
-    public function get isHidden():Boolean -
-
-Example -
The following code creates an array of File objects pointing to files and directories in the - user directory and then uses the isHidden property to list hidden files and directories. -
-
-import flash.filesystem.*;
-
-var userDirFiles:Array = File.userDirectory.getDirectoryListing();
-for (var i:uint = 0; i < userDirFiles.length; i++) {
-    if (userDirFiles[i].isHidden) {
-		trace(userDirFiles[i].nativePath);
-	}
-}
-
- -

-
- - - - - -
isPackageproperty 
-
-isPackage:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether the referenced directory is a package. - - - -

The value is true if the referenced directory is a package, false otherwise. - - Note that the File class does not allow creating packages directly.

- - - -
    - - - -
  • On Mac OS, directories can be designated as packages and will show up in the Finder as a - - single file rather than as a directory. This property is set to true if the referenced - - directory is a package, and false if the file is not a directory, does not exist, or - - is not a package.
    • - - - -
  • On other operating systems, this property is always set to false.
    • - - - -
- - - Implementation -
-    public function get isPackage():Boolean -
-
- - - - - -
isSymbolicLinkproperty 
-
-isSymbolicLink:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Indicates whether the reference is a symbolic link. - - - -

The value is true if the File object is a symbolic link, false otherwise. - - Note that the File class does not allow creating symbolic links directly.

- - - -

Symbolic links allow a file to point to another file or directory on disk. Although similar, symbolic - - links are not the same as aliases on Mac OS and shortcuts on Windows. An alias or a shortcut is always - - reported as a file (rather than a directory), and reading or writing to an alias or shortcut - - never affects the original file or directory that it points to. - - On the other hand, a symbolic link generally behaves like the file or directory it points to. It can be - - reported as a file or a directory, and reading or writing to a symbolic link affects the file or directory - - that it points to, not the symbolic link itself. Deleting a symbolic link, however, deletes the link - - and not the target of the link.

- - - -

Mac® OS®, Linux, and Windows® Vista® - - support symbolic links. Additionally, on Windows the isSymbolicLink - - property for a File object referencing a junction point (used in the NTFS file system) is set to - - true.

- - - Implementation -
-    public function get isSymbolicLink():Boolean -
-
- - - - - -
lineEndingproperty 
-
-lineEnding:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The line-ending character sequence used by the host operating system. - - -

On Mac OS and Linux, this is the line-feed character (character code 0x0A hexadecimal). - - On Windows, this is the carriage return character (character code 0x0D hexadecimal) followed - - by the line-feed character (character code 0x0A hexadecimal).

- - - Implementation -
-    public static function get lineEnding():String -
-
-Example -
The following code writes a string (str) to a text file and uses the - File.lineEnding static property to replace all instances of the new-line character - (represented in the code by the regular expression /\n/g) with the preferred - line-ending character for the host operating system. -
-
-import flash.filesystem.*;
-
-var str:String = "Hello\n" + 
-    	"World\n";
-str = str.replace(/\n/g, File.lineEnding);
-var file:File = File.documentsDirectory.resolvePath("AIR Test/test.txt");
-var fileStream:FileStream = new FileStream();
-fileStream.open(file, FileMode.WRITE);
-fileStream.writeUTF(str);
-fileStream.close();
-
-

-
- - - - - -
nativePathproperty 
-
-nativePath:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The full path in the host operating system representation. On Mac OS and Linux, - - the forward slash (/) character is used as the path separator. - - However, in Windows, you can set the nativePath property - - by using the forward slash character or the backslash (\) character as the - - path separator, and AIR automatically replaces forward slashes with - - the appropriate backslash character. - - -

Before writing code to set the nativePath property directly, - - consider whether doing so may result in platform-specific code. For example, a native - - path such as "C:\\Documents and Settings\\bob\\Desktop" is only valid on Windows. - - It is far better to use the following static properties, which represent commonly used directories, - - and which are valid on all platforms:

- - -
    - -
  • File.applicationDirectory
    • - -
  • File.applicationStorageDirectory
    • - -
  • File.desktopDirectory
    • - -
  • File.documentsDirectory
    • - -
  • File.userDirectory
    • - -
- - - -

You can use the resolvePath() method to get a path relative to these directories.

- - -

Some Flex APIs, such as the source property of the SWFLoader class, use a - - URL (the url property of a File object), not a native path (the nativePath - - property).

- - - -

Some APIs, such as the src property of an IMG object, use a - - URL (the url property of a File object), not a native path (the nativePath - - property).

- - - - Implementation -
-    public function get nativePath():String -
-    public function set nativePath(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — The syntax of the path is invalid. - - -
 
SecurityError — The caller is not in the application security sandbox. - - -
-
-Example -
The following code shows the difference between the nativePath - property and the url property of a File object. The comments show results on an - example Windows computer. -
-
-import flash.filesystem.File;
-
-var docs:File = File.documentsDirectory;
-trace(docs.nativePath); // C:\Documents and Settings\turing\My Documents
-trace(docs.url); // file:///C:/Documents%20and%20Settings/turing/My%20Documents
-
-

-
- - - - - -
parentproperty 
-
-parent:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The directory that contains the file or directory referenced by this File object. - - - -

If the file or directory does not exist, the parent property still returns the - - File object that points to the containing directory, even if that directory does not exist.

- - -

This property is identical to the return value for resolvePath("..") except that the parent of a root - - directory is null.

- - - - Implementation -
-    public function get parent():File -
-
-Example -
The following code uses the parent property to show the directory - that contains a temporary file. -
-
-import flash.filesystem.File;
-
-var tempFile:File = File.createTempDirectory();
-trace(tempFile.parent.nativePath);
-tempFile.deleteFile();
-
-

-
- - - - - -
permissionStatusproperty 
-
-permissionStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24.0 - -
-

- - Determine whether the application has been granted the permission to access filesystem. - - -

Implementation -
-    public static function get permissionStatus():String -
-

-See also -

-
-flash.permissions.PermissionStatus -
-
- - - - - -
preventBackupproperty 
-
-preventBackup:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.6 - -
-

- - Indicates whether or not the runtime prevents this File object from being backed up to the cloud. - - - -

If this property is set to true, it is not automatically backed up to the - - cloud on platforms that provide this service. The default value of this property is false.

- - - Implementation -
-    public function get preventBackup():Boolean -
-    public function set preventBackup(value:Boolean):void -
-
- - - - - -
separatorproperty 
-
-separator:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The host operating system's path component separator character. - - - -

On Mac OS and Linux, this is the forward slash (/) character. On Windows, it is the backslash - - (\) character.

- - - -

Note: When using the backslash character in a String literal, remember to - - type the character twice (as in "directory\\file.ext"). Each pair of backslashes - - in a String literal represent a single backslash in the String.

- - - Implementation -
-    public static function get separator():String -
-
-Example -
The following code uses the getRelativePath() method to get the relative path - between a directory and a file. The code then uses the File.separator static property - to replace forward slash (/) characters in the path with the separator character used by the operating - system, which is the backslash character (\) on Windows and the forward slash character on other - operating systems. -
-
-import flash.filesystem.File;
-
-var directory:File = File.documentsDirectory.resolvePath("Apollo Test");
-var file:File = File.documentsDirectory.resolvePath("Apollo Test/employees/bob/test.txt");
-
-var relativePath:String = directory.getRelativePath(file); // employees/bob/test.txt
-relativePath = relativePath.replace(/\//g, File.separator);
-trace(relativePath); 
-
-
In this example, the replace() method uses a regular expression, - /\//g, to match all forward slash characters. -
-
-

-
- - - - - -
spaceAvailableproperty 
-
-spaceAvailable:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.1 - -
-

- - The space available for use at this File location, in bytes. - - -

If the File object references a directory, - - spaceAvailable indicates the space in the directory that files can use. If - - the File object references a file, spaceAvailable indicates the space into which the file - - could grow. If the file location does not exist, spaceAvailable is set to 0. If the File - - object references a symbolic link, spaceAvailable indicates the space available at the - - location the symbolic link points to.

- - - -

Typically the space available for a directory or file is the same as the space available on the - - volume containing the directory or file. However, space available can take into account quotas and - - per-directory limits.

- - - -

Adding a file or directory to a volume generally requires more space than the actual size of the file - - or the size of the contents of the directory. For example, the operating system may require more space to - - store index information. Or the disk sectors required may use additional space. Also, available - - space changes dynamically. So, you cannot expect to allocate all of the reported space - - for file storage.

- - - - Implementation -
-    public function get spaceAvailable():Number -
-
- - - - - -
systemCharsetproperty 
-
-systemCharset:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The default encoding used by the host operating system. - - - -

Possible values include "windows-1252" - - "shift-jis", "cn-gb", "iso-8859-1", and others. - - For a complete list, see Supported Character Sets.

- - - -

You can use this value when using the readMultiByte() and writeMultiByte() - - methods of the FileStream class.

- - - - Implementation -
-    public static function get systemCharset():String -
-

-See also -

-
-FileStream.readMultiByte() -
-FileStream.writeMultiByte() -
-
-Example -
The following code opens a file (a test.txt file in the AIR Test subdirectory of the - user's documents directory), and uses the File.systemCharset static property - as the charSet parameter of a call to the readMultiByte() method - of a FileStream object. -
-
-import flash.filesystem.File;
-
-var file:File = File.documentsDirectory.resolvePath("AIR Test/test.txt");
-var fileStream:FileStream = new FileStream();
-fileStream.open(file, FileMode.READ);
-var str:String = fileStream.readMultiByte(file.size, File.systemCharset);
-trace(str);
-
-

-
- - - - - -
urlproperty 
-
-url:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The URL for this file path. - - -

If this is a reference to a path in the application storage directory, the URL scheme is - - "app-storage"; if it is a reference to a path in the application directory, the - - URL scheme is "app"; otherwise the scheme is "file".

- - -

You can use blank space characters (rather than "%20") when - - assigning a value to the url property; AIR automatically - - encodes the strings (for instance, converting spaces to "%20").

- - - - Implementation -
-    public function get url():String -
-    public function set url(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — The URL syntax is invalid. - - - -
 
SecurityError — The caller is not in the application security sandbox. - - -
-

-See also -

-
-nativePath -
-decodeURI() global function -
-decodeURIComponent() global function -
-encodeURI() global function -
-encodeURIComponent() global function -
-
-Example -
The following code shows the difference between the nativePath - property and the url property of a File object. The comments show results on an - example Windows computer. -
-
-import flash.filesystem.File;
-
-var docs:File = File.documentsDirectory;
-trace(docs.nativePath); // C:\Documents and Settings\turing\My Documents
-trace(docs.url); // file:///C:/Documents%20and%20Settings/turing/My%20Documents
-
-

-
- - - - - -
userDirectoryproperty 
-
-userDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The user's directory. - - -

On Windows, this is the parent of the My Documents directory - - (for example, C:\Documents and Settings\userName). On - - Mac OS, it is /Users/userName. On Linux, it is /home/userName.

- - -

The userDirectory property provides a way to reference the user - - directory that works across platforms. If you set the nativePath or url - - property of a File object directly, it will only work on the platform for which that path is valid.

- - -

If an operating system does not support a user directory, a suitable directory in the - - file system is used instead.

- - -

On AIR for TV devices, the userDirectory property - - references a user directory that is unique to the application.

- - - Implementation -
-    public static function get userDirectory():File -
-
-Example -
The following code outputs a list of files and directories contained in the root level - of the user directory: -
-
-import flash.filesystem.File;
-
-var files:Array = File.userDirectory.listDirectory();
-for (var i:uint = 0; i < files.length; i++) {
-    trace(files[i].nativePath);
-}
-
-

-
- - - - - -
workingDirectoryproperty 
-
-workingDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 - -
-

- - The application's working directory (used primarily for command-line applications). - - - -

When an AIR application is run in a command-line mode, this property provides the - - working directory set by the operating system for this process. This can be useful for - - handling relative path names from command-line parameters.

- - - Implementation -
-    public static function get workingDirectory():File -
-
- -
Constructor detail
- - - - - -
File()constructor
-
-public function File(path:String = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The constructor function for the File class. - - - -

If you pass a path argument, the - - File object points to the specified path, and the nativePath property and - - and url property are set to reflect that path.

- - - - -

Although you can pass a path argument to specify a file path, consider - - whether doing so may result in platform-specific code. For example, a native path such as - - "C:\\Documents and Settings\\bob\\Desktop" or a URL such as - - "file:///C:/Documents%20and%20Settings/bob/Desktop" is only valid on Windows. - - It is far better to use the following static properties, which represent commonly used directories, - - and which are valid on all platforms:

- - -
    - -
  • File.applicationDirectory
    • - -
  • File.applicationStorageDirectory
    • - -
  • File.desktopDirectory
    • - -
  • File.documentsDirectory
    • - -
  • File.userDirectory
    • - -
- - - -

You can then use the resolvePath() method to get a path relative to these directories. - - For example, the following code sets up a File object to point to the settings.xml file in the application - - storage directory:

- - - 
var file:File = File.applicationStorageDirectory.resolvePath("settings.xml");
- - - - 
var file = air.File.applicationStorageDirectory.resolvePath("settings.xml");
- - - -

Important: If you pass a URL string in the path parameter, the URL is decoded to resolve the file path. - - For example, the statement, new File("file:///c:/test/demo%20file%201%2e0.txt") creates a File object - - with the native path, "c:\test\demo file 1.0.txt". (A URL uses the file:, app:, or app-storage: scheme prefixes.) - - However, if the valid URL prefixes are omitted, the path string is treated like a native path and no decoding takes place. - - You must take this behavior into consideration when validating paths derived from potentially untrusted sources. - - If you simply validate the input string, URL decoding may allow an attacker to bypass your validation checks. - - Always validate the final path of the instantiated File object:

- - - - 
-
-     var file:File = new File( taintedString );
-
-     validate( file.nativePath ); //where validate() is your path validation function
-
-
- - 
-
-     var file = new air.File( taintedString );
-
-     validate( file.nativePath ); //where validate() is your path validation function
-
-
- - - - Parameters - - - - -
path:String (default = null) — The path to the file. You can specify the path by using either a URL or - - native path (platform-specific) notation. - - - -

If you specify a URL, you can use any of the following - - URL schemes: file, app, or - - app-storage. The following are valid values for the path - - parameter using URL notation:

- - - -
    - - - -
  • "app:/DesktopPathTest.xml"
    • - -
  • "app-storage:/preferences.xml"
    • - -
  • "file:///C:/Documents%20and%20Settings/bob/Desktop" (the desktop on Bob's Windows computer)
    • - -
  • "file:///Users/bob/Desktop" (the desktop on Bob's Mac computer)
    • - - - -
- - - -

The app and app-storage URL schemes - - are useful because they can point to a valid file on all file systems. However, - - in the other two examples, which use the file URL scheme to point to the - - user's desktop directory, it would be better to pass no path argument - - to the File() constructor and then assign File.desktopDirectory - - to the File object, as a way to access the desktop directory that is both platform- and - - user-independent.

- - - -

If you specify a native path, on Windows you can use either the backslash character or - - the forward slash character as the path separator in this argument; on Mac OS and Linux, use the - - forward slash. The following are valid values for the path parameter using - - native path notation:

- - - -
    - - - -
  • "C:/Documents and Settings/bob/Desktop"
    • - -
  • "/Users/bob/Desktop"
    • - - - -
- - - -

However, for these two examples, you should pass no path argument - - to the File() constructor and then assign File.desktopDirectory - - to the File object, as a way to access the desktop directory that is both platform- and - - user-independent.

- - -
-
-Throws - - - - -
ArgumentError — The syntax of the path parameter is invalid. - - - -
-

-See also -

-
-nativePath -
-
- -
Method detail
- - - - - -
browseForDirectory()method
-
-public function browseForDirectory(title:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Displays a directory chooser dialog box, in which the user can select a directory. - - When the user selects the directory, the select event is dispatched. - - The target property of the select event is the - - File object pointing to the selected directory. - - - -

The directory chooser dialog is not always displayed in front of windows that are - - "owned" by another window (windows that have a non-null owner property). - - To avoid window ordering issues, hide owned windows before calling this method.

- - - -

Note: On Android devices, browseForDirectory() is not supported. - - The File object dispatches a cancel event immediately.

- - - - Parameters - - - - -
title:String — The string that is displayed in the title bar of the dialog box. - - - -
-
-Events - - - - - - - - - - - - - - - - -
cancel:Event — Dispatched when the user clicks the Cancel button in the Open File dialog box.
 
select:Event — Dispatched when the user selects a directory and closes the directory chooser dialog box.
 
ioError:IOErrorEvent — The browse operation is unsupported on this platform.
-
-Throws - - - - - - - - - - -
Error — A browse operation (browseForOpen(), browseForOpenMultiple(), - - browseForSave(), browseForDirectory()) is currently running. - - - -
 
SecurityError — The application does not have the necessary permissions. - - - -
-

-See also -

-
-browseForOpen() -
-browseForSave() -
-select -
-flash.net.FileFilter -
-
-Example -
The following code uses the File.browseForDirectory() method to - let the user select a directory. When the directory is selected, the code lists the contents of - the selected directory in the trace() output. -
-
-import flash.filesystem.File;
-import flash.events.Event;
-
-var directory:File = File.documentsDirectory;
-
-try
-{
-    directory.browseForDirectory("Select Directory");
-	directory.addEventListener(Event.SELECT, directorySelected);
-}
-catch (error:Error)
-{
-	trace("Failed:", error.message);
-}
-
-function directorySelected(event:Event):void 
-{
-	directory = event.target as File;
-	var files:Array = directory.getDirectoryListing();
-	for(var i:uint = 0; i < files.length; i++)
-	{
-		trace(files[i].name);
-	}
-}
-
-

-
- - - - - -
browseForOpen()method 
-
-public function browseForOpen(title:String, typeFilter:Array = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Displays the Open File dialog box, in which the user can select a file to open. - - - -

When the user selects the file, the select event is dispatched. - - The target property of the select event is the - - File object pointing to the selected file.

- - - -

The Open File dialog is not always displayed in front of windows that are - - "owned" by another window (windows that have a non-null owner property). - - To avoid window ordering issues, hide owned windows before calling this method.

- - - -

Note: On Android devices, the file dialog title cannot be set. The title - - parameter is ignored.

- - - - Parameters - - - - - - - - - - -
title:String — The string that is displayed in the title bar of the dialog box. - - - -
 
typeFilter:Array (default = null) — An array of FileFilter instances used to filter the files - - that are displayed in the dialog box. If you omit this parameter, all files are - - displayed. For more information, see the FileFilter class. - - - -
-
-Events - - - - - - - - - - - - - - - - -
cancel:Event — Dispatched when the user clicks the Cancel button in the Open File dialog box.
 
select:Event — Dispatched when the user selects a file and closes the Open File dialog box.
 
ioError:IOErrorEvent — The browse operation is unsupported on this platform.
-
-Throws - - - - - - - - - - -
Error — A browse operation (browseForOpen(), browseForOpenMultiple(), - - browseForSave(), browseForDirectory()) is currently running. - - - -
 
SecurityError — The application does not have the necessary permissions. - - - -
-

-See also -

-
-browseForSave() -
-browseForOpenMultiple() -
-browseForDirectory() -
-select -
-flash.net.FileFilter -
-
-Example -
The following code uses the File.browseForOpen() method to - let the user choose a text file. When the file is selected, the code reads the file data - into a string. -
-
-import flash.filesystem.*;
-import flash.events.Event;
-import flash.net.FileFilter;
-
-var fileToOpen:File = new File();
-var txtFilter:FileFilter = new FileFilter("Text", "*.as;*.css;*.html;*.txt;*.xml");
-
-try 
-{
-    fileToOpen.browseForOpen("Open", [txtFilter]);
-	fileToOpen.addEventListener(Event.SELECT, fileSelected);
-}
-catch (error:Error)
-{
-	trace("Failed:", error.message);
-}
-
-function fileSelected(event:Event):void 
-{
-	var stream:FileStream = new FileStream();
-	stream.open(event.target, FileMode.READ);
-	var fileData:String = stream.readUTFBytes(stream.bytesAvailable);
-	trace(fileData);
-}
-
-

-
- - - - - -
browseForOpenMultiple()method 
-
-public function browseForOpenMultiple(title:String, typeFilter:Array = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Displays the Open File dialog box, in which the user can select one or more files to open. - - - -

When the user selects the files, the selectMultiple event is dispatched. - - The target property of the select event is this - - File object. Unlike browseForOpen(), with the browseForOpenMultiple() - - method, this File object is not updated to reference any of the chosen files. - - Instead, the resulting selectMultiple event contains an array of the chosen files.

- - - -

The Open File dialog is not always displayed in front of windows that are - - "owned" by another window (windows that have a non-null owner property). - - To avoid window ordering issues, hide owned windows before calling this method.

- - - -

Note: On Android devices, the file dialog title cannot be set. The title - - parameter is ignored.

- - - - Parameters - - - - - - - - - - -
title:String — The string that is displayed in the title bar of the dialog box. - - - -
 
typeFilter:Array (default = null) — An array of FileFilter instances used to filter the files - - that are displayed in the dialog box. If you omit this parameter, all files are - - displayed. For more information, see the FileFilter class. - - -
-
-Events - - - - - - - - - - - - - - - - -
cancel:Event — Dispatched when the user clicks the Cancel button in the Open File dialog box.
 
selectMultiple:FileListEvent — Dispatched when the user selects files and closes the Open File dialog box.
 
ioError:IOErrorEvent — The browse operation is unsupported on this platform.
-
-Throws - - - - - - - - - - -
Error — A browse operation (browseForOpen(), browseForOpenMultiple(), - - browseForSave(), browseForDirectory()) is currently running. - - - -
 
SecurityError — The application does not have the necessary permissions. - - - -
-

-See also -

-
-browseForSave() -
-browseForOpen() -
-browseForDirectory() -
-selectMultiple -
-flash.net.FileFilter -
-
-Example -
The following code uses the File.browseForOpenMultiple() method to - let the user choose multiple files. When the files are selected, the code outputs the paths - for the selected files. -
-
-import flash.filesystem.*;
-import flash.events.FileListEvent;
-
-var docsDir:File = File.documentsDirectory;
-try
-{
-    docsDir.browseForOpenMultiple("Select Files");
-	docsDir.addEventListener(FileListEvent.SELECT_MULTIPLE, filesSelected);
-}
-catch (error:Error)
-{
-	trace("Failed:", error.message);
-}
-
-function filesSelected(event:FileListEvent):void 
-{
-	for (var i:uint = 0; i < event.files.length; i++) 
-	{
-    	trace(event.files[i].nativePath);
-	}
-}
-
-

-
- - - - - -
browseForSave()method 
-
-public function browseForSave(title:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Displays the Save File dialog box, in which the user can select a file destination. - - - -

When the user selects the file, the select event is dispatched. - - The target property of the select event is the - - File object pointing to the selected Save destination.

- - - -

The Save File dialog is not always displayed in front of windows that are - - "owned" by another window (windows that have a non-null owner property). - - To avoid window ordering issues, hide owned windows before calling this method.

- - - -

Note: On Android devices, the file dialog title cannot be set. The title - - parameter is ignored.

- - - - Parameters - - - - -
title:String — The string that is displayed in the title bar of the dialog box. - - - -
-
-Events - - - - - - - - - - - - - - - - -
cancel:Event — Dispatched when the user clicks the Cancel button in the Save File dialog box.
 
select:Event — Dispatched when the user selects a file and closes the Save File dialog box.
 
ioError:IOErrorEvent — The browse operation is unsupported on this platform.
-
-Throws - - - - - - - - - - -
Error — A browse operation (browseForOpen(), browseForOpenMultiple(), - - browseForSave(), browseForDirectory()) is currently running. - - - -
 
SecurityError — The application does not have the necessary permissions. - - - -
-

-See also -

-
-browseForDirectory() -
-browseForOpen() -
-select -
-flash.net.FileFilter -
-
-Example -
The following code uses the File.browseForSave() method to - let the user select a path for saving a file. When the files are selected, the code saves - data to the selected file path. -
-
-import flash.filesystem.*;
-import flash.events.Event;
-
-var docsDir:File = File.documentsDirectory;
-try
-{
-    docsDir.browseForSave("Save As");
-	docsDir.addEventListener(Event.SELECT, saveData);
-}
-catch (error:Error)
-{
-	trace("Failed:", error.message);
-}
-
-function saveData(event:Event):void 
-{
-	var newFile:File = event.target as File;
-	var str:String = "Hello.";
-	if (!newFile.exists)
-	{
-		var stream:FileStream = new FileStream();
-		stream.open(newFile, FileMode.WRITE);
-		stream.writeUTFBytes(str);
-		stream.close();
-	}
-}
-
-

-
- - - - - -
cancel()method 
-
-public override function cancel():void -

- - - - -
Runtime version: AIR 1.0 - -
-

- - Cancels any pending asynchronous operation. - -

- - - - - -
canonicalize()method 
-
-public function canonicalize():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Canonicalizes the File path. - - - -

If the File object represents an existing file or directory, canonicalization - - adjusts the path so that it matches the case of the actual file or directory name. - - If the File object is a symbolic link, canonicalization adjusts the path so that - - it matches the file or directory that the link points to, regardless of whether the - - file or directory that is pointed to exists. On case sensitive file systems - - (such as Linux), when multiple files exist with names differing only in case, - - the canonicalize() method adjusts the path to - - match the first file found (in an order determined by the file system).

- - - -

In addition, canonicalization converts short filenames to long filenames on Windows.

- - -
-Example -
The following code shows how to use the canonicalize() method to find the - correct capitalization of a directory name. Before running this example, create a directory named AIR Test - on the desktop of your computer. -
-
-import flash.filesystem.*;
-
-var path:File = File.desktopDirectory.resolvePath("air test");
-trace(path.nativePath); 
-path.canonicalize();
-trace(path.nativePath); // ...\AIR Test
-
-
-
-

The following code shows how to use the canonicalize() method to find the - long name of a Windows directory based on its short name. This example assumes that there is an AIR Test - directory at the root of the C: drive, and that the system has assigned the short name AIR~1 to the directory. -
-
-import flash.filesystem.*;
-
-var path:File = new File();
-path.nativePath = "C:\\AIR~1";
-path.canonicalize();
-trace(path.nativePath); // C:\AIR Test
-
-

-
- - - - - -
clone()method 
-
-public function clone():File -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns a copy of this File object. Event registrations are not copied. - - - -

Note: This method does not copy the file itself. It simply makes a - - copy of the instance of the ActionScript - - JavaScript File object. To copy a file, use the - - copyTo() method.

- - - -

-Returns - - - - -
File
-
- - - - - -
copyTo()method 
-
-public function copyTo(newLocation:FileReference, overwrite:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Copies the file or directory at the location specified by this File object to - - the location specified by the newLocation parameter. The copy process - - creates any required parent directories (if possible). When overwriting files using copyTo(), the file - - attributes are also overwritten. - - - -

Parameters - - - - - - - - - - -
newLocation:FileReference — The target location of the new file. Note that this File object specifies - - the resulting (copied) file or directory, not the path to the containing directory. - - - -
 
overwrite:Boolean (default = false) — If false, the copy fails if the file specified by the target - - parameter already exists. If true, the operation overwrites existing file or directory - - of the same name. - - - -
-
-Throws - - - - - - - - - - -
Error — The source does not exist; or the destination exists and overwrite is false; - - or the source could not be copied to the target; or the source and destination refer to the same file or folder and - - overwrite is set to true. On Windows, you cannot copy a file that is open or a directory - - that contains a file that is open. - - - -
 
SecurityError — The application does not have the necessary permissions to write to the destination. - - - -
-

-See also -

-
-copyToAsync() -
-moveTo() -
-
-Example -
The following code shows how to use the copyTo() method to copy a file. - Before running this code, create a test1.txt file in the AIR Test subdirectory of the documents directory on - your computer. The resulting copied file is named test2.txt, and it is also in the AIR Test subdirectory. When - you set the overwrite parameter to true, the operation overwrites any existing test2.txt file. -
-
-import flash.filesystem.File;
-import flash.events.Event;
-
-var sourceFile:FileReference = File.documentsDirectory;
-sourceFile = sourceFile.resolvePath("AIR Test/test1.txt");
-var destination:FileReference = File.documentsDirectory;
-destination = destination.resolvePath("AIR Test/test2.txt");
-
-if (sourceFile.copyTo(destination, true)) {
-    trace("Done.");
-}
-
-

The following code shows how to use the copyTo() method to copy a file. - Before running this code, create a test1.txt file in the AIR Test subdirectory of the home directory on your - computer. The resulting copied file is named test2.txt. The try and catch statements - show how to respond to errors. -
-
-import flash.filesystem.File;
-
-var sourceFile:File = File.documentsDirectory;
-sourceFile = sourceFile.resolvePath("AIR Test/test1.txt");
-var destination:File = File.documentsDirectory;
-destination = destination.resolvePath("AIR Test/test2.txt");
-
-try 
-{
-    sourceFile.copyTo(destination, true);
-}
-catch (error:Error)
-{
-	trace("Error:", error.message);
-}
-
-

-
- - - - - -
copyToAsync()method 
-
-public function copyToAsync(newLocation:FileReference, overwrite:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Begins copying the file or directory at the location specified by this File object to - - the location specified by the destination parameter. - - - -

Upon completion, either a complete event (successful) or an ioError event - - (unsuccessful) is dispatched. The copy process creates any required parent directories (if possible).

- - - - Parameters - - - - - - - - - - -
newLocation:FileReference — The target location of the new file. Note that this File object specifies - - the resulting (copied) file or directory, not the path to the containing directory. - - - -
 
overwrite:Boolean (default = false) — If false, the copy fails if the file specified by the target - - file already exists. If true, the operation overwrites any existing file or directory - - of the same name. - - - -
-
-Events - - - - - - - - - - -
complete:Event — Dispatched when the file or directory has been successfully copied.
 
ioError:IOErrorEvent — The source does not exist; or the destination exists and overwrite - - is false; or the source could not be copied to the target; or the source and destination refer - - to the same file or folder and overwrite is set to true. On Windows, you cannot - - copy a file that is open or a directory that contains a file that is open.
-
-Throws - - - - -
SecurityError — The application does not have the necessary permissions to write to the destination. - - - -
-

-See also -

-
-copyTo() -
-moveToAsync() -
-
-Example -
The following code shows how to use the copyToAsync() method to copy a file. - Before running this code, be sure to create a test1.txt file in the AIR Test subdirectory of the documents directory on your - computer. The resulting copied file is named test2.txt, and it is also in the AIR Test subdirectory. When you set the - overwrite parameter to true, the operation overwrites any existing test2.txt file. -
-
-import flash.filesystem.File;
-import flash.events.Event;
-
-var sourceFile:File = File.documentsDirectory;
-sourceFile = sourceFile.resolvePath("AIR Test/test1.txt");
-var destination:File = File.documentsDirectory;
-destination = destination.resolvePath("AIR Test/test2.txt");
-
-sourceFile.copyToAsync(destination, true);
-sourceFile.addEventListener(Event.COMPLETE, fileCopiedHandler);
-
-function fileCopiedHandler(event:Event):void {
-    trace("Done.");
-}
-
-

-
- - - - - -
createDirectory()method 
-
-public function createDirectory():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates the specified directory and any necessary parent directories. If the - - directory already exists, no action is taken. - - - -


-Throws - - - - - - - - - - -
Error — The directory did not exist and could not be created. - - -
 
SecurityError — The application does not have the necessary permissions. - - - -
-
-Example -
The following code moves a file named test.txt on the desktop to the AIR Test - subdirectory of the documents directory. The call to the createDirectory() method - ensures that the AIR Test directory exists before the file is moved. -
-
-import flash.filesystem.*;
-
-var source:File = File.desktopDirectory.resolvePath("test.txt");
-var target:File = File.documentsDirectory.resolvePath("AIR Test/test.txt");
-var targetParent:File = target.parent;
-targetParent.createDirectory();
-source.moveTo(target, true);
-
-

-
- - - - - -
createTempDirectory()method 
-
-public static function createTempDirectory():File -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns a reference to a new temporary directory. This is a new directory - - in the system's temporary directory path. - - -

This method lets you identify a new, unique directory, without having to - - query the system to see that the directory is new and unique.

- - -

You may want to delete the temporary directory before closing the application, - - since on some devices it is not deleted automatically.

- - -

-Returns - - - - -
File — - A File object referencing the new temporary directory. - - - - - -
-

-See also -

-
-createTempFile() -
-
-Example -
The following code uses the createTempFile() method to obtain a - reference to a new temporary directory. -
-
-import flash.File;
-
-var temp:File = File.createTempDirectory();
-trace(temp.nativePath);
-
-
Each time you run this code, a new (unique) file is created. -
-
-

-
- - - - - -
createTempFile()method 
-
-public static function createTempFile():File -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns a reference to a new temporary file. This is a new file - - in the system's temporary directory path. - - - -

This method lets you identify a new, unique file, without having to - - query the system to see that the file is new and unique.

- - - -

You may want to delete the temporary file before closing the application, - - since it is not deleted automatically.

- - -

-Returns - - - - -
File — - A File object referencing the new temporary file. - - - - - -
-

-See also -

-
-createTempDirectory() -
-
-Example -
The following code uses the createTempFile() method to obtain a - reference to a new temporary file. -
-
-import flash.File;
-
-var temp:File = File.createTempFile();
-trace(temp.nativePath);
-
-
Each time you run this code, a new (unique) file is created. -
-
-

-
- - - - - -
deleteDirectory()method 
-
-public function deleteDirectory(deleteDirectoryContents:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Deletes the directory. If this File is actually a symbolic link to a directory, - - then the link, and not the directory, is removed. - - -

Parameters - - - - -
deleteDirectoryContents:Boolean (default = false) — Specifies whether or not to delete a directory that contains files or - - subdirectories. When false, if the directory contains files or directories, a call to - - this method throws an exception. - - - -
-
-Throws - - - - - - - - - - -
Error — The directory does not exist, or the directory could not be deleted. On Windows, - - you cannot delete a directory that contains a file that is open. - - - -
 
SecurityError — The application does not have the necessary permissions to delete the directory. - - - -
-

-See also -

-
-deleteDirectoryAsync() -
-deleteFile() -
-moveToTrash() -
-
-Example -
The following code creates an empty directory and then uses the - deleteDirectory() method to delete the directory. -
-
-import flash.filesystem.File;
-
-var directory:File = File.documentsDirectory.resolvePath("Empty Junk Directory/");
-File.createDirectory(directory);
-trace(directory.exists); // true
-directory.deleteDirectory();
-trace(directory.exists); // false
-
-

-
- - - - - -
deleteDirectoryAsync()method 
-
-public function deleteDirectoryAsync(deleteDirectoryContents:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Deletes the directory asynchronously. If this File is actually a symbolic link to a directory, - - then the link, and not the directory, is removed. - - -

Parameters - - - - -
deleteDirectoryContents:Boolean (default = false) — Specifies whether or not to delete a directory that contains files or - - subdirectories. When false, if the directory contains files or directories, - - the File object dispatches an ioError event. - - - -
-
-Events - - - - - - - - - - -
complete:Event — Dispatched when the directory has been deleted successfully.
 
ioError:IOErrorEvent — The directory does not exist or could not be deleted. On Windows, - - you cannot delete a directory that contains a file that is open.
-
-Throws - - - - -
SecurityError — The application does not have the necessary permissions to delete the directory. - - - -
-

-See also -

-
-deleteDirectory() -
-deleteFileAsync() -
-moveToTrashAsync() -
-
- - - - - -
deleteFile()method 
-
-public function deleteFile():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Deletes the file. If this File is actually a symbolic link, then the link, - - not the target file, is removed. - - -


-Throws - - - - - - - - - - -
Error — The file does not exist or could not to be deleted. On Windows, - - you cannot delete a file that is currently open. - - -
 
SecurityError — The application does not have the necessary permissions to delete the file. - - - -
-

-See also -

-
-deleteDirectory() -
-deleteFileAsync() -
-moveToTrash() -
-
-Example -
The following code creates a temporary file and then calls the deleteFile() - method to delete it. -
-
-import flash.filesystem.*;
-
-var file:File = File.createTempFile();
-trace(file.exists); // true
-file.deleteFile();
-trace(file.exists); // false
-
-

-
- - - - - -
deleteFileAsync()method 
-
-public function deleteFileAsync():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Deletes the file asynchronously. If this File is actually a symbolic link, then the link, - - not the target file, is removed. - - - -


-Events - - - - - - - - - - -
complete:Event — Dispatched when the file has been deleted successfully.
 
ioError:IOErrorEvent — The file does not exist or could not be deleted. On Windows, - - you cannot delete a file that is currently open.
-
-Throws - - - - -
SecurityError — The application does not have the necessary permissions to delete the file. - - - -
-

-See also -

-
-deleteDirectoryAsync() -
-deleteFile() -
-moveToTrashAsync() -
-
- - - - - -
getDirectoryListing()method 
-
-public function getDirectoryListing():Array -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns an array of File objects corresponding to files and directories in the directory represented by this - - File object. This method does not explore the contents of subdirectories. - - - -

-Returns - - - - -
Array — - An array of File objects. - - - - - -
-

-See also -

-
-getDirectoryListingAsync() -
-getRootDirectories() -
-
-Example -
The following code shows how to use the getDirectoryListing() method to - enumerate the contents of the user directory. -
-
-import flash.filesystem.File;
-
-var directory:File = File.userDirectory;
-var list:Array = directory.getDirectoryListing();
-for (var i:uint = 0; i < list.length; i++) {
-    trace(list[i].nativePath);
-}
-
-

-
- - - - - -
getDirectoryListingAsync()method 
-
-public function getDirectoryListingAsync():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Asynchronously retrieves an array of File objects corresponding to the contents of the directory represented - - by this File object. - - - -


-Events - - - - - - - - - - -
ioError:ErrorEvent — You do not have adequate permissions to read this directory, or the directory does - - not exist.
 
directoryListing:FileListEvent — The directory contents have been enumerated successfully. The - - contents event includes a files property, which is the resulting array of File objects.
-

-See also -

-
-getDirectoryListing() -
-getRootDirectories() -
-directoryListing event -
-
-Example -
The following code shows how to use the getDirectoryListingAsync() method to - enumerate the contents of the user directory. -
-
-import flash.filesystem.File;
-import flash.events.FileListEvent;
-
-var directory:File = File.userDirectory;
-directory.getDirectoryListingAsync();
-directory.addEventListener(FileListEvent.DIRECTORY_LISTING, directoryListingHandler);
-
-function directoryListingHandler(event:FileListEvent):void {
-    var list:Array = event.files;
-	for (var i:uint = 0; i < list.length; i++) {
-		trace(list[i].nativePath);
-	}
-}
-
-

-
- - - - - -
getRelativePath()method 
-
-public function getRelativePath(ref:FileReference, useDotDot:Boolean = false):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Finds the relative path between two File paths. - - - -

The relative path is the list of components that can be appended to - - (resolved against) this reference in order to locate the second (parameter) - - reference. The relative path is returned using the "/" separator character.

- - -

Optionally, relative paths may include ".." references, but such paths - - will not cross conspicuous volume boundaries.

- - - Parameters - - - - - - - - - - -
ref:FileReference — A File object against which the path is given. - - - -
 
useDotDot:Boolean (default = false) — Specifies whether the resulting relative path can use ".." components. - - - -
-

-Returns - - - - -
String — - The relative path between this file (or directory) and the ref file - - (or directory), if possible; otherwise null. - - - - -
-
-Throws - - - - - - - - - - -
ArgumentError — The reference is null. - - - -
 
SecurityError — The caller is not in the application security sandbox. - - -
-
- - - - - -
getRootDirectories()method 
-
-public static function getRootDirectories():Array -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Returns an array of File objects, listing the file system root directories. - - - -

For example, on Windows this is a list of volumes such as the C: drive and the - - D: drive. An empty drive, such as a CD or DVD drive in which no disc is inserted, - - is not included in this array. On Mac OS and Linux, this method always returns the - - unique root directory for the machine (the "/" directory)

- - - -

On file systems for which the root is not readable, such as the Android file system, - - the properties of the returned File object do not always reflect the true value. For - - example, on Android, the spaceAvailable property reports 0.

- - - -

-Returns - - - - -
Array — - An array of File objects, listing the root directories. - - - - - -
-
-Example -
The following code outputs a list of root directories: -
-
-import flash.filesystem.File;
-var rootDirs:Array = File.getRootDirectories();
-
-for (var i:uint = 0; i < rootDirs.length; i++) {
-    trace(rootDirs[i].nativePath);
-}
-
-

-
- - - - - -
moveTo()method 
-
-public function moveTo(newLocation:FileReference, overwrite:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Moves the file or directory at the location specified by this File object to - - the location specified by the destination parameter. - - - -

To rename a file, set the destination parameter to point to a path that is - - in the file's directory, but with a different filename.

- - - -

The move process creates any required parent directories (if possible).

- - - - Parameters - - - - - - - - - - -
newLocation:FileReference — The target location for the move. This object specifies the path to the resulting - - (moved) file or directory, not the path to the containing directory. - - - -
 
overwrite:Boolean (default = false) — If false, the move fails if the target file - - already exists. If true, the operation overwrites any existing file or directory - - of the same name. - - - -
-
-Throws - - - - - - - - - - -
Error — The source does not exist; or the destination exists and overwrite is - - set to false; or the source file or directory could not be moved to the target location; - - or the source and destination refer to the same file or folder and overwrite is set to - - true. On Windows, you cannot move a file that is open or a directory that contains a file - - that is open. - - - -
 
SecurityError — The application does not have the necessary permissions to move the file. - - - -
-

-See also -

-
-copyTo() -
-moveToAsync() -
-moveToTrash() -
-
-Example -
The following code shows how to use the moveTo() method to rename - a file. The original filename is test1.txt and the resulting filename is test2.txt. Since both the source and destination File - object point to the same directory (the Apollo Test subdirectory of the user's documents directory), the - moveTo() method renames the file, rather than moving it to a new directory. Before running - this code, create a test1.txt file in the AIR Test subdirectory of the documents directory on your - computer. When you set the overwrite parameter to true, the operation overwrites - any existing test2.txt file. -
-
-
-import flash.filesystem.File;
-import flash.events.Event;
-
-var sourceFile:File = File.documentsDirectory;
-sourceFile = sourceFile.resolvePath("AIR Test/test1.txt");
-var destination:File = File.documentsDirectory;
-destination = destination.resolvePath("Apollo Test/test2.txt");
-
-try  
-{
-    sourceFile.moveTo(destination, true);
-}
-catch (error:Error)
-{
-    trace("Error:" + error.message);
-}
-
-

The following code shows how to use the moveTo() method to move a file. - The original file is the test1.txt file in the Apollo Test subdirectory of the user's documents directory, - and the method moves the file to the Results subdirectory. Before running this code, create a - test1.txt file in the AIR Test subdirectory of the home directory on your computer. The try - and catch statements show how to respond to errors. -
-
-import flash.filesystem.File;
-
-var sourceFile:File = File.documentsDirectory;
-sourceFile = sourceFile.resolvePath("AIR Test/test1.txt");
-var destination:File = File.documentsDirectory;
-destination = destination.resolvePath("AIR Test/Results/test1.txt");
-
-try 
-{
-    sourceFile.moveTo(destination, true);
-}
-catch (error:Error)
-{
-	trace("Error:" + error.message);
-}
-
-

-
- - - - - -
moveToAsync()method 
-
-public function moveToAsync(newLocation:FileReference, overwrite:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Begins moving the file or directory at the location specified by this File object to - - the location specified by the newLocation parameter. - - - -

To rename a file, set the destination parameter to point to a path that is - - in the file's directory, but with a different filename.

- - - -

The move process creates any required parent directories (if possible).

- - - - Parameters - - - - - - - - - - -
newLocation:FileReference — The target location for the move. This object specifies the path to the resulting - - (moved) file or directory, not the path to the containing directory. - - - -
 
overwrite:Boolean (default = false) — If false, the move fails if the target file - - already exists. If true, the operation overwrites any existing file or directory - - of the same name. - - - -
-
-Events - - - - - - - - - - -
complete:Event — Dispatched when the file or directory has been successfully moved.
 
ioError:IOErrorEvent — The source does not exist; or the destination exists and overwrite - - is false; or the source could not be moved to the target; or the source and destination refer - - to the same file or folder and overwrite is set to true. On Windows, you cannot move - - a file that is open or a directory that contains a file that is open.
-
-Throws - - - - -
SecurityError — The application does not have the necessary permissions to move the file. - - - -
-

-See also -

-
-copyToAsync() -
-moveTo() -
-moveToTrashAsync() -
-
-Example -
The following code shows how to use the moveToAsync() method to rename a - file. The original filename is test1.txt and the resulting name is test2.txt. Since both the source and destination File - object point to the same directory (the Apollo Test subdirectory of the user's documents directory), the - moveToAsync() method renames the file, rather than moving it to a new directory. - Before running this code, create a test1.txt file in the Apollo Test subdirectory of the documents directory on your - computer. When you set overwrite parameter to true, the operation overwrites any - existing test2.txt file. -
-
-import flash.filesystem.File;
-import flash.events.Event;
-
-var sourceFile:File = File.documentsDirectory;
-sourceFile = sourceFile.resolvePath("Apollo Test/test1.txt");
-var destination:File = File.documentsDirectory;
-destination = destination.resolvePath("Apollo Test/test2.txt");
-
-sourceFile.moveToAsync(destination, true);
-sourceFile.addEventListener(Event.COMPLETE, fileMoveCompleteHandler);
-
-function fileMoveCompleteHandler(event:Event):void 
-{
-    trace("Done.")
-}
-
-

-
- - - - - -
moveToTrash()method 
-
-public function moveToTrash():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Moves a file or directory to the trash. - - - -

Note: On operating systems that do not support the concept of a recoverable trash folder, the files are removed immediately.

- - - -
-Throws - - - - - - - - - - -
Error — The operating system did not allow the operation; or the file - - or directory does not exist. On Windows, you cannot move a file that is open or a directory - - that contains a file that is currently open. - - - -
 
SecurityError — The application does not have the necessary permissions to move the file to the trash. - - - -
-

-See also -

-
-moveToTrashAsync() -
-
- - - - - -
moveToTrashAsync()method 
-
-public function moveToTrashAsync():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Asynchronously moves a file or directory to the trash. - - - -

Note: On operating systems that do not support the concept of a recoverable trash folder, the files are removed immediately.

- - - -
-Events - - - - - - - - - - -
ioError:IOErrorEvent — The operating system did not allow the operation; or the file - - or directory does not exist. On Windows, you cannot move a file that is open or a directory - - that contains a file that is currently open.
 
complete:Event — Dispatched when the file or directory has been successfully moved to the trash.
-
-Throws - - - - -
SecurityError — The application does not have the necessary permissions to move the file to the trash. - - - -
-

-See also -

-
-moveToTrash() -
-
- - - - - -
openWithDefaultApplication()method 
-
-public function openWithDefaultApplication():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Opens the file in the application registered by the operating system to open this file type. - - -

AIR prevents you from using the File.openWithDefaultApplication() method to open certain files. - - On Windows, AIR prevents you from opening files that have certain file types (files with specific extensions, listed below). - - On Mac OS and Linux, AIR prevents you from opening files that will launch in specific applications, - - specified below. Attempting to open one of these files using the openWithDefaultApplication() method - - results in an exception. However, AIR applications installed with a native installer (extended desktop profile applications) - - are not restricted by these limitations; they can open files of any type.

- - -

You cannot open documents from the application directory.

- - - -

The tables below list file extensions that are prohibited on Windows, as well as the prevented applications on Mac OS and Linux:

- - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Windows Document Extension Kind Mac OS Application Counterpart Linux Application Counterpart
bat Batch file command Terminal No default application
cmd DOS and Windows command file Terminal No default application
com Command Terminal No default application
csh UNIX csh shell script Terminal /bin/csh
dash UNIX dash shell script Terminal /bin/dash
ksh UNIX ksh shell script Terminal /bin/ksh
sh UNIX shell script Terminal /bin/bash
tcsh UNIX tcsh shell script Terminal /bin/tcsh
zsh UNIX zsh shell script Terminal /bin/zsh
exe Executable file Executable bit, .app extension /lib/ld.so
lnk Windows shortcut file Executable bit, .app extension Links in Linux, executable bit set, no default application
pif Program Information File Executable bit, .app extension N/A
reg Registration Information/Key for Windows Registry Data File N/A N/A
scf Windows Explorer command ScriptEditor, AutomatorRunner N/A
shb, shs Shell Scrap Object file N/A N/A
prg Program file N/A N/A
vb, vbe, vbs VBScript files N/A N/A
vsmacros Visual Studio .NET binary-based macro project N/A N/A
ws, wsc, wsf, wsh Windows script files ScriptEditor, AutomatorRunner N/A
fxp Fox Pro compiled source code N/A N/A
mas Microsoft Access stored procedures N/A N/A
scr Windows screen saver N/A N/A
py, pyc Python script file Python Python
pl Perl script file Terminal perl
cgi Common Gateway Interface script file Terminal perl
msi, msm, msp, mst, idt, cub, pcp Windows installer file installer N/A
job Windows Task Scheduler task object N/A N/A
jar, js, jse Java archive file, JavaScript file, JScript encoded script file JarLauncher jar
url Internet shortcut N/A N/A
hta HTML application N/A N/A
- -

- - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Mac OS X Only Kind Mac OS X Application Linux Application Counterpart
N/A Mac OS X Java applet AppletLauncher N/A
N/A Mac OS X AppleScript plugin systemevents N/A
N/A Mac OS X widget dock, dashboardlauncher N/A
- -

- - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Linux-only Document Extension Kind Mac OS X Application Counterpart Linux Application
rb Ruby shell script N/A ruby
desktop Desktop files and shortcuts N/A No default application
directory Directory files and shortcuts N/A No default application
- -

- - - - - -
-Throws - - - - - - - - - - - - - - - - - - - - - - -
Error — (Mac OS and Linux) No application was found that can open the file. - - (On Windows, attempting to open a file that has no associated application fails silently, - - without an exception.) - - -
 
Error — The file is in the application directory or it is of a - - prohibited file type. This error does not apply for AIR applications installed with a - - native application installer (extended desktop profile applications). - - -
 
Error — The file does not exist or no application is registered to open the file. - - -
 
ReferenceError — The file does not exist. - - -
-

-See also -

-
-downloaded -
-NativeProcess -
-
-Example -
The following code lets the user navigate to an MP3 file and open it - in the default application for playing MP3 files. -
-
-import flash.filesystem.File;
-import flash.net.FileFilter;
-
-var file:File = File.documentsDirectory; 
-var mp3Filter:FileFilter = new FileFilter("MP3 Files", "*.mp3"); 
-file.browseForOpen("Open", [mp3Filter]); 
-file.addEventListener(Event.SELECT, fileSelected); 
- 
-function fileSelected(e:Event):void 
-{ 
-    file.openWithDefaultApplication(); 
-}
-
-

-
- - - - - -
requestPermission()method 
-
-public override function requestPermission():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24.0 - -
-

- - Requests permission to access filesystem. - - - -


-Events - - - - -
PermissionStatus:PermissionEvent — dispatched when the requested permission is granted/denied by the user.
-
- - - - - -
resolvePath()method 
-
-public function resolvePath(path:String):File -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Creates a new File object with a path relative to this File object's path, based on the - - path parameter (a string). - - -

You can use a relative path or absolute path as the path parameter.

- - -

If you specify a relative path, the given path is "appended" - - to the path of the File object. However, use of ".." in the path - - can return a resulting path that is not a child of the File object. The resulting reference need not - - refer to an actual file system location.

- - - -

If you specify an absolute file reference, the method returns the File object pointing to that - - path. The absolute file reference should use valid native path syntax for the user's operating - - system (such as "C:\\test" on Windows). Do not use a URL (such as - - "file:///c:/test") as the path parameter.

- - - -

All resulting paths are normalized as follows:

- - - -
    - - - -
  • Any "." element is ignored.
    • - - - -
  • Any ".." element consumes its parent entry.
    • - - - -
  • No ".." reference that reaches the file system root or the application-persistent - - storage root passes that node; it is ignored.
    • - - - -
- - -

You should always use the forward slash (/) character as the path separator. - - On Windows, you can also use the backslash (\) character, but you should not. - - Using the backslash character can lead to applications that do not work on other platforms.

- - -

Filenames and directory names are case-sensitive on Linux.

- - - - Parameters - - - - -
path:String — The path to append to this File object's path (if the path parameter - - is a relative path); or the path to return (if the path parameter is an absolute - - path). - - - -
-

-Returns - - - - -
File — - A new File object pointing to the resulting path. - - - - - -
-
-
Event detail
- - - - - -
cancelevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CANCEL -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when a pending asynchronous operation is canceled. - - - -

- The Event.CANCEL constant defines the value of the type property of a cancel event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetA reference to the object on which the operation is canceled.
-
- - - - - -
completeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when an asynchronous operation is complete. - - - -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
- - - - - -
directoryListingevent  
-
-Event object type: flash.events.FileListEvent -
-FileListEvent.type property = flash.events.FileListEvent.DIRECTORY_LISTING -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when a directory list is available as a result of a call to the getDirectoryListingAsync() - - method. - - -

- The FileListEvent.DIRECTORY_LISTING constant defines the value of the - type property of the event object for a directoryListing event. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
filesAn array of File objects representing the files and directories found.
targetThe FileListEvent object.
-

-See also -

-
-File.getDirectoryListingAsync() -
-
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when an error occurs during an asynchronous file operation. - - - -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -
- - - - - -
permissionStatusevent  
-
-Event object type: flash.events.PermissionEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24.0 - -
-

- - Dispatched when the application requests permission to access filesystem. - - Check the value of status property to determine whether - - the permission was granted or denied - - -

-See also -

-
-File.requestPermission() -
-flash.permissions.PermissionStatus -
-
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when an operation violates a security constraint. - - - - -

- - The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- - - -
- - - - - -
selectevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.SELECT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when the user selects a file or directory from a file- or directory-browsing dialog box. - - - - -

- The Event.SELECT constant defines the value of the type property of a select event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object on which an item has been selected.
- -
- - - - - -
selectMultipleevent  
-
-Event object type: flash.events.FileListEvent -
-FileListEvent.type property = flash.events.FileListEvent.SELECT_MULTIPLE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Dispatched when the user selects files from the dialog box opened by a call to the - - browseForOpenMultiple() method. - - - - -

- The FileListEvent.SELECT_MULTIPLE constant defines the value of the - type property of the event object for a selectMultiple event. - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
filesAn array of File objects representing the files selected.
targetThe FileListEvent object.
-

-See also -

-
-browseForOpenMultiple() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/filesystem/FileMode.html b/html-docs/flash/filesystem/FileMode.html deleted file mode 100644 index 329df41..0000000 --- a/html-docs/flash/filesystem/FileMode.html +++ /dev/null @@ -1,403 +0,0 @@ - - - - - - - - -flash.filesystem.FileMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filesystem
Classpublic class FileMode
InheritanceFileMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The FileMode class defines string constants used in the fileMode parameter of - the open() and openAsync() methods of the FileStream class. - The fileMode parameter of these methods determines the capabilities available - to the FileStream object once the file is opened. - -

The following capabilities are available, in various combinations, based on the fileMode - parameter value specified in the open method:

- -
    - -
  • Reading—The FileStream object can read data from the file.
    • -
  • Writing—The FileStream object can write data to the file.
    • -
  • Creating—The FileStream object creates a nonexistent file upon opening.
    • -
  • Truncate upon opening—Data in the file is deleted upon opening (before any data is written).
    • -
  • Append written data—Data is always written to the end of the file (when any write method is called).
    • - -
- -

The following table shows the capabilities that each constant in the FileMode class provides when applied - as the fileMode parameter of an open method of a FileStream object:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FileMode constantReadingWritingCreatingTruncate upon openingAppend written data
READ •
WRITE • • •
APPEND • • •
UPDATE • • •
- -

-

-See also -

-
-FileStream.open() -
-FileStream.openAsync() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  APPEND : String = "append"
[static] - Used for a file to be opened in write mode, with all written data appended to the end of the file.
-		FileMode
  READ : String = "read"
[static] - Used for a file to be opened in read-only mode.
-		FileMode
  UPDATE : String = "update"
[static] - Used for a file to be opened in read/write mode.
-		FileMode
  WRITE : String = "write"
[static] - Used for a file to be opened in write-only mode.
-		FileMode
-
- -
- -
Constant detail
- - - - - -
APPENDconstant
-
-public static const APPEND:String = "append" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Used for a file to be opened in write mode, with all written data appended to the end of the file. - Upon opening, any nonexistent file is created. - -

- - - - - -
READconstant 
-
-public static const READ:String = "read" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Used for a file to be opened in read-only mode. The file must exist (missing files are not created). - -

- - - - - -
UPDATEconstant 
-
-public static const UPDATE:String = "update" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Used for a file to be opened in read/write mode. Upon opening, any nonexistent file is created. - -

- - - - - -
WRITEconstant 
-
-public static const WRITE:String = "write" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Used for a file to be opened in write-only mode. Upon opening, any nonexistent file is created, and any - existing file is truncated (its data is deleted). - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filesystem/FileStream.html b/html-docs/flash/filesystem/FileStream.html deleted file mode 100644 index c2be8c8..0000000 --- a/html-docs/flash/filesystem/FileStream.html +++ /dev/null @@ -1,3206 +0,0 @@ - - - - - - - - -flash.filesystem.FileStream (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.filesystem
Classpublic class FileStream
InheritanceFileStream Inheritance EventDispatcher Inheritance Object
ImplementsIDataInput, IDataOutput
-

- - - - -
Runtime version: AIR 1.0 -
-

-

- A FileStream object is used to read and write files. Files can be opened synchronously by calling the - open() method or asynchronously by calling the openAsync() method. - -

The advantage of opening files asynchronously is that other code can execute while Adobe AIR - runs read and write processes in the background. When opened asynchronously, progress events - are dispatched as operations proceed.

- -

A File object that is opened synchronously behaves much like a ByteArray object; a file opened asynchronously behaves - much like a Socket or URLStream object. When a File object is opened synchronously, the caller pauses while - the requested data is read from or written to the underlying file. When opened asynchronously, any data - written to the stream is immediately buffered and later written to the file.

- -

Whether reading from a file synchronously or asynchronously, the actual read methods are synchronous. - In both cases they read from data that is currently "available." The difference is that when reading - synchronously all of the data is available at all times, and when reading asynchronously data becomes - available gradually as the data streams into a read buffer. Either way, the data that can be synchronously - read at the current moment is represented by the bytesAvailable property.

- -

An application that is processing asynchronous input typically registers for progress events - and consumes the data as it becomes available by calling read methods. Alternatively, an application can - simply wait until all of the data is available by registering for the complete event and - processing the entire data set when the complete event is dispatched.

- -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bytesAvailable : uint -
[read-only] - - Returns the number of bytes of data available for reading - - in the input buffer.
-		FileStream
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  endian : String -
- - The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN constant - - from the Endian class.
-		FileStream
  objectEncoding : uint -
- Specifies whether the AMF3 or AMF0 format is used when writing or reading binary data by using the - readObject() or writeObject() method.
-		FileStream
  position : Number -
- The current position in the file.
-		FileStream
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  readAhead : Number -
- The minimum amount of data to read from disk when reading files asynchronously.
-		FileStream
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-FileStream()
-
- Creates a FileStream object.
-		FileStream
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-close():void -
-
- Closes the FileStream object.
-		FileStream
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-open(file:File, fileMode:String):void -
-
- Opens the FileStream object synchronously, pointing to the file specified by the file parameter.
-		FileStream
   -
-openAsync(file:File, fileMode:String):void -
-
- Opens the FileStream object asynchronously, pointing to the file specified by the file parameter.
-		FileStream
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-readBoolean():Boolean -
-
- - Reads a Boolean value from the file stream, byte stream, or byte array.
-		FileStream
   -
-readByte():int -
-
- - Reads a signed byte from the file stream, byte stream, or byte array.
-		FileStream
   -
-readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- - Reads the number of data bytes, specified by the length parameter, - - from the file stream, byte stream, or byte array.
-		FileStream
   -
-readDouble():Number -
-
- - Reads an IEEE 754 double-precision floating point number from the file stream, byte stream, or byte array.
-		FileStream
   -
-readFloat():Number -
-
- - Reads an IEEE 754 single-precision floating point number from the file stream, byte stream, or byte array.
-		FileStream
   -
-readInt():int -
-
- - Reads a signed 32-bit integer from the file stream, byte stream, or byte array.
-		FileStream
   -
-readMultiByte(length:uint, charSet:String):String -
-
- - Reads a multibyte string of specified length from the file stream, byte stream, or byte array using the - - specified character set.
-		FileStream
   -
-readObject():* -
-
- - Reads an object from the file stream, byte stream, or byte array, encoded in AMF - - serialized format.
-		FileStream
   -
-readShort():int -
-
- - Reads a signed 16-bit integer from the file stream, byte stream, or byte array.
-		FileStream
   -
-readUnsignedByte():uint -
-
- - Reads an unsigned byte from the file stream, byte stream, or byte array.
-		FileStream
   -
-readUnsignedInt():uint -
-
- - Reads an unsigned 32-bit integer from the file stream, byte stream, or byte array.
-		FileStream
   -
-readUnsignedShort():uint -
-
- - Reads an unsigned 16-bit integer from the file stream, byte stream, or byte array.
-		FileStream
   -
-readUTF():String -
-
- - Reads a UTF-8 string from the file stream, byte stream, or byte array.
-		FileStream
   -
-readUTFBytes(length:uint):String -
-
- - Reads a sequence of UTF-8 bytes from the byte stream or byte array and returns a string.
-		FileStream
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-truncate():void -
-
- Truncates the file at the position specified by the position property of the FileStream - object.
-		FileStream
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
   -
-writeBoolean(value:Boolean):void -
-
- - Writes a Boolean value.
-		FileStream
   -
-writeByte(value:int):void -
-
- - Writes a byte.
-		FileStream
   -
-writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- - Writes a sequence of bytes from the - - specified byte array, bytes, - - starting at the byte specified by offset - - (using a zero-based index) - - with a length specified by length, - - into the file stream, byte stream, or byte array.
-		FileStream
   -
-writeDouble(value:Number):void -
-
- - Writes an IEEE 754 double-precision (64-bit) floating point number.
-		FileStream
   -
-writeFloat(value:Number):void -
-
- - Writes an IEEE 754 single-precision (32-bit) floating point number.
-		FileStream
   -
-writeInt(value:int):void -
-
- - Writes a 32-bit signed integer.
-		FileStream
   -
-writeMultiByte(value:String, charSet:String):void -
-
- - Writes a multibyte string to the file stream, byte stream, or byte array, using the specified character set.
-		FileStream
   -
-writeObject(object:):void -
-
- - Writes an object to the file stream, byte stream, or byte array, in AMF serialized - - format.
-		FileStream
   -
-writeShort(value:int):void -
-
- - Writes a 16-bit integer.
-		FileStream
   -
-writeUnsignedInt(value:uint):void -
-
- - Writes a 32-bit unsigned integer.
-		FileStream
   -
-writeUTF(value:String):void -
-
- - Writes a UTF-8 string to the file stream, byte stream, or byte array.
-		FileStream
   -
-writeUTFBytes(value:String):void -
-
- - Writes a UTF-8 string.
-		FileStream
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-close -
-		 - Indicates that the stream has been - closed by an explicit call to the close() method.FileStream
   -
-complete -
-		 - Signals that the end of the stream has been reached.FileStream
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-ioError -
-		 - Indicates that an error occurred during an asynchronous file I/O operation.FileStream
   -
-outputProgress -
-		 - Signals that buffered data has been written to the file.FileStream
   -
-progress -
-		 - Signals the availability of new data on the stream.FileStream
-
- -
- -
Property detail
- - - - - -
bytesAvailableproperty
-
-bytesAvailable:uint  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- - Returns the number of bytes of data available for reading - - in the input buffer. - - User code must call bytesAvailable to ensure - - that sufficient data is available before trying to read - - it with one of the read methods. - -

Implementation -
-    public function get bytesAvailable():uint -
-
- - - - - -
endianproperty 
-
-endian:String  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- - The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN constant - - from the Endian class. - - -

Implementation -
-    public function get endian():String -
-    public function set endian(value:String):void -
-
- - - - - -
objectEncodingproperty 
-
-objectEncoding:uint  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether the AMF3 or AMF0 format is used when writing or reading binary data by using the - readObject() or writeObject() method. - -

The value is a constant from the ObjectEncoding class. By default, the AMF3 format is used.

- Implementation -
-    public function get objectEncoding():uint -
-    public function set objectEncoding(value:uint):void -
-

-See also -

-
-ObjectEncoding -
-readObject() -
-writeObject() -
-
- - - - - -
positionproperty 
-
-position:Number  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The current position in the file. - -

This value is modified in any of the following ways:

- -
    - -
  • When you set the property explicitly
    • - -
  • When reading from the FileStream object (by using one of the read methods)
    • - -
  • When writing to the FileStream object
    • - -
- -

The position is defined as a Number (instead of uint) in order to support files larger - than 232 bytes in length. The value of this property is always - a whole number less than 253. If you set this value to a number with a - fractional component, the value is rounded down to the nearest integer.

- -

When reading a file asyncronously, if you set the position property, - the application begins filling the read buffer with the data starting at the specified - position, and the bytesAvailable property may be set to 0. Wait for a complete - event before using a read method to read data; or wait for a progress event - and check the bytesAvailable property before using a read method.

- - Implementation -
-    public function get position():Number -
-    public function set position(value:Number):void -
-
-Example -
The following code shows how a position property of the FileStream object - is updated as the application reads data from a file. -
-
-import flash.fileSystem.*;
-import flash.utils.ByteArray;
-import flash.events.Event;
-
-var sourceFile:File = File.documentsDirectory.resolvePath("Apollo Test/test.txt");
-var stream:FileStream = new FileStream();
-stream.addEventListener(Event.COMPLETE, readBytes);
-stream.openAsync(sourceFile, FileMode.READ);
-
-function readBytes(e:Event):void {
-    var bytes:ByteArray = new ByteArray();
-	trace("position 0:", stream.position); // 0
-	bytes[0] = stream.readByte();
-	trace("position 1:", stream.position); // 1
-	fileStream.readBytes(bytes, stream.position, 4); 
-	trace("position 2:", stream.position); // 5
-	stream.close();
-}
-
-

-
- - - - - -
readAheadproperty 
-
-readAhead:Number  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The minimum amount of data to read from disk when reading files asynchronously. -

This property specifies how much data an asynchronous stream attempts to read - beyond the current position. Data is read in blocks based on the file system page size. - Thus if you set readAhead to 9,000 on a computer system with an 8KB (8192 byte) - page size, the runtime reads ahead 2 blocks, or 16384 bytes at a time. - The default value of this property is infinity: by default - a file that is opened to read asynchronously reads as far as the end of the file.

-

Reading data from the read buffer does not change the value of the readAhead - property. When you read data from the buffer, new data is read in to refill the read buffer. -

-

The readAhead property has no effect on a file that is opened synchronously.

- -

As data is read in asynchronously, the FileStream object dispatches progress events. In the - event handler method for the progress event, check to see that the required number of bytes - is available (by checking the bytesAvailable property), and then read the data from the - read buffer by using a read method.

- - Implementation -
-    public function get readAhead():Number -
-    public function set readAhead(value:Number):void -
-
-Example -
The following code shows how to use the readAhead property to limit - the amount of data read into a file to 100 bytes: -
-
-import flash.filesystem.*;
-
-var file:File = File.desktopDirectory.resolvePath("test.txt");
-var fileStream:FileStream = new FileStream();
-fileStream.readAhead = 100;
-fileStream.addEventListener(ProgressEvent.PROGRESS, readProgressHandler)
-fileStream.openAsync(file, FileMode.READ);
-var results:ByteArray;
-
-function readProgressHandler(event:ProgressEvent):void {
-	if (fileStream.bytesAvailable >= 100) {
-		fileStream.readBytes(results, 0, 100);
-	}
-}
-
- -

-
- -
Constructor detail
- - - - - -
FileStream()constructor
-
-public function FileStream() -

- - - - -
Runtime version: AIR 1.0 -
-

- Creates a FileStream object. - Use the open() - or openAsync() method to open a file. - -

-See also -

-
-open() -
-openAsync() -
-
- -
Method detail
- - - - - -
close()method
-
-public function close():void -

- - - - -
Runtime version: AIR 1.0 -
-

- Closes the FileStream object. - -

You cannot read or write any data after you call the close() method. If the file - was opened asynchronously (the FileStream object used the openAsync() method to open the file), - calling the close() method causes the object to dispatch the close event.

- -

Closing the application automatically closes all files associated with FileStream objects in the application. - However, it is best to register for a closed event on all FileStream objects opened asynchronously - that have pending data to write, before closing the application (to ensure that data is written).

- -

You can reuse the FileStream object by calling the open() or the openAsync() - method. This closes any file associated with the FileStream object, but the object does not dispatch the - close event.

- -

For a FileStream object opened asynchronously (by using the openAsync() method), - even if you call the close() event for a FileStream object and delete properties and variables that - reference the object, the FileStream object is not garbage collected as long as there are pending operations and - event handlers are registered for their completion. In particular, an otherwise unreferenced FileStream object - persists as long as any of the following are still possible:

- -
    - -
  • For file reading operations, the end of the file has not been reached (and the complete - event has not been dispatched).
    • - -
  • Output data is still available to written, and output-related events (such as the outputProgress - event or the ioError event) have registered event listeners.
    • - -
- -
-Events - - - - -
close:Event — The file, which was opened asynchronously, is closed.
-

-See also -

-
-open() -
-close event -
-
-Example -
The following code opens a FileStream object asynchronously and writes a text file named - test.txt to the Apollo Test subdirectory of the user's documents directory. A call to the close() - method of the FileStream object closes the file when the data is written. -
-
-import flash.filesystem.*;
-import flash.events.Event;
-			
-var file:File = File.documentsDirectory;
-file = file.resolvePath("Apollo Test/test.txt");
-var fileStream:FileStream = new FileStream();
-fileStream.openAsync(file, FileMode.WRITE);
-fileStream.writeUTFBytes("Hello");
-fileStream.addEventListener(Event.CLOSE, fileClosed);
-fileStream.close();
-
-function fileClosed(event:Event):void {
-	trace("closed");
-}
-
-

The following code opens a FileStream object synchronously and writes a text file named - test.txt to the Apollo Test subdirectory of the user's documents directory. A call to the close() - method of the FileStream object closes the file when the data is written. -
-
-import flash.filesystem.*;
-			
-var file:File = File.documentsDirectory;
-file = file.resolvePath("Apollo Test/test.txt");
-var fileStream:FileStream = new FileStream();
-fileStream.open(file, FileMode.WRITE);
-fileStream.writeUTF("Hello");
-fileStream.close();
-
-

-
- - - - - -
open()method 
-
-public function open(file:File, fileMode:String):void -

- - - - -
Runtime version: AIR 1.0 -
-

- Opens the FileStream object synchronously, pointing to the file specified by the file parameter. - -

If the FileStream object is already open, calling the method closes the file before opening - and no further events (including close) are delivered for the previously opened file.

- -

On systems that support file locking, a file opened in "write" or "update" mode (FileMode.WRITE - or FileMode.UPDATE) is not readable until it is closed.

-

Once you are done performing operations on the file, call the close() method of the FileStream - object. Some operating systems limit the number of concurrently open files.

- - Parameters - - - - - - - - - - -
file:File — The File object specifying the file to open. - -
 
fileMode:String — A string from the FileMode class that defines the capabilities of the FileStream, such as - the ability to read from or write to the file. - -
-
-Throws - - - - - - - - - - -
Error — The file does not exist; you do not have adequate permissions to - open the file; you are opening a file for read access, and you do not have read permissions; - or you are opening a file for write access, and you do not have write permissions. - -
 
SecurityError — The file location is in the application directory, and the fileMode - parameter is set to "append", "update", or "write" mode. - -
-

-See also -

-
-close() -
-File -
-FileMode -
-
-Example -
The following code shows how to synchronously open a test.txt file in the - Apollo Test subdirectory of the user's documents directory and then read the file into a string, - using the system character set as the text encoding. -
-
-import flash.filesystem.*;
-
-var file:File = File.documentsDirectory;
-file = file.resolvePath("Apollo Test/test.txt");
-var fileStream:FileStream = new FileStream();
-fileStream.open(file, FileMode.READ);
-var str:String = fileStream.readMultiByte(file.size, File.systemCharset);
-trace(str);
-fileStream.close();
-
-

-
- - - - - -
openAsync()method 
-
-public function openAsync(file:File, fileMode:String):void -

- - - - -
Runtime version: AIR 1.0 -
-

- Opens the FileStream object asynchronously, pointing to the file specified by the file parameter. - -

If the FileStream object is already open, calling the method closes the file before opening - and no further events (including close) are delivered for the previously opened file.

- -

If the fileMode parameter is set to FileMode.READ or - FileMode.UPDATE, AIR reads data into the input buffer as soon as the file is opened, - and progress and open events are dispatched as the data is read to - the input buffer.

- -

On systems that support file locking, a file opened in "write" or "update" mode (FileMode.WRITE - or FileMode.UPDATE) is not readable until it is closed.

- -

Once you are done performing operations on the file, call the close() method of the FileStream - object. Some operating systems limit the number of concurrently open files.

- - Parameters - - - - - - - - - - -
file:File — The File object specifying the file to open. - -
 
fileMode:String — A string from the FileMode class that defines the capabilities of the FileStream, such as - the ability to read from or write to the file. - -
-
-Events - - - - - - - - - - - - - - - - -
ioError:IOErrorEvent — The file does not exist; you do not have adequate permissions to - open the file; you are opening a file for read access, and you do not have read permissions; - or you are opening a file for write access, and you do not have write permissions.
 
progress:ProgressEvent — Dispatched as data is read to the input buffer. (The file must be opened - with the fileMode parameter set to FileMode.READ or - FileMode.UPDATE.)
 
complete:Event — The file data has been read to the input buffer. (The file must be opened with - the fileMode parameter set to FileMode.READ or - FileMode.UPDATE.)
-
-Throws - - - - -
SecurityError — The file location is in the application directory, and the fileMode parameter - is set to "append", "update", or "write" mode. - -
-

-See also -

-
-close() -
-complete event -
-ioError event -
-progress event -
-FileMode -
-
-Example -
The following code shows how to asynchronously open a test.txt file in the - Apollo Test subdirectory of the user's documents directory and then read the file into a string, - using the system character set as the text encoding. -
-
-import flash.filesystem.*;
-import flash.events.Event;
-
-var file:File = File.documentsDirectory;
-file = file.resolvePath("Apollo Test/test.txt");
-var fileStream:FileStream = new FileStream();
-fileStream.addEventListener(Event.COMPLETE, fileCompleteHandler)
-fileStream.openAsync(file, FileMode.READ);
-
-function fileCompleteHandler(event:Event):void {
-    var str:String = fileStream.readMultiByte(fileStream.bytesAvailable, File.systemCharset);
-	trace(str);
-	fileStream.close();
-}
-
-

-
- - - - - -
readBoolean()method 
-
-public function readBoolean():Boolean -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads a Boolean value from the file stream, byte stream, or byte array. A single byte is read - - and true is returned if the byte is nonzero, - - false otherwise. - -

-Returns - - - - -
Boolean — - A Boolean value, true if the byte is nonzero, - - false otherwise. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readByte()method 
-
-public function readByte():int -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads a signed byte from the file stream, byte stream, or byte array. - -

-Returns - - - - -
int — - The returned value is in the range -128 to 127. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readBytes()method 
-
-public function readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads the number of data bytes, specified by the length parameter, - - from the file stream, byte stream, or byte array. The bytes are read into the - - ByteArray objected specified by the bytes parameter, starting at - - the position specified by offset. - -

Parameters - - - - - - - - - - - - - - - - -
bytes:ByteArray — The ByteArray object to read - - data into. - -
 
offset:uint (default = 0) — The offset into the bytes parameter at which data - - read should begin. - -
 
length:uint (default = 0) — The number of bytes to read. The default value - - of 0 causes all available data to be read. - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readDouble()method 
-
-public function readDouble():Number -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads an IEEE 754 double-precision floating point number from the file stream, byte stream, or byte array. - -

-Returns - - - - -
Number — - An IEEE 754 double-precision floating point number. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readFloat()method 
-
-public function readFloat():Number -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads an IEEE 754 single-precision floating point number from the file stream, byte stream, or byte array. - -

-Returns - - - - -
Number — - An IEEE 754 single-precision floating point number. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readInt()method 
-
-public function readInt():int -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads a signed 32-bit integer from the file stream, byte stream, or byte array. - -

-Returns - - - - -
int — - The returned value is in the range -2147483648 to 2147483647. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readMultiByte()method 
-
-public function readMultiByte(length:uint, charSet:String):String -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads a multibyte string of specified length from the file stream, byte stream, or byte array using the - - specified character set. - - - -

Parameters - - - - - - - - - - -
length:uint — The number of bytes from the byte stream to read. - -
 
charSet:String — The string denoting the character set to use to interpret the bytes. - - Possible character set strings include "shift-jis", "cn-gb", - - "iso-8859-1", and others. - - For a complete list, see Supported Character Sets. - - -

Note: If the value for the charSet parameter is not recognized by the current - - system, then Adobe® Flash® Player or - - Adobe® AIR® uses the system's default - - code page as the character set. For example, a value for the charSet parameter, as in - - myTest.readMultiByte(22, "iso-8859-01"), that uses 01 instead of - - 1 might work on your development system, but not on another system. On the other - - system, Flash Player or the AIR runtime will use the system's - - default code page.

- - -
-

-Returns - - - - -
String — - UTF-8 encoded string. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-

-See also -

-
-File.systemCharset -
-
- - - - - -
readObject()method 
-
-public function readObject():* -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads an object from the file stream, byte stream, or byte array, encoded in AMF - - serialized format. - -

-Returns - - - - -
* — The deserialized object - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-

-See also -

-
-flash.net.registerClassAlias() -
-
- - - - - -
readShort()method 
-
-public function readShort():int -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads a signed 16-bit integer from the file stream, byte stream, or byte array. - -

-Returns - - - - -
int — - The returned value is in the range -32768 to 32767. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readUnsignedByte()method 
-
-public function readUnsignedByte():uint -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads an unsigned byte from the file stream, byte stream, or byte array. - -

-Returns - - - - -
uint — - The returned value is in the range 0 to 255. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readUnsignedInt()method 
-
-public function readUnsignedInt():uint -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads an unsigned 32-bit integer from the file stream, byte stream, or byte array. - -

-Returns - - - - -
uint — - The returned value is in the range 0 to 4294967295. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readUnsignedShort()method 
-
-public function readUnsignedShort():uint -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads an unsigned 16-bit integer from the file stream, byte stream, or byte array. - -

-Returns - - - - -
uint — - The returned value is in the range 0 to 65535. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readUTF()method 
-
-public function readUTF():String -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads a UTF-8 string from the file stream, byte stream, or byte array. The string - - is assumed to be prefixed with an unsigned short indicating - - the length in bytes. - - -

This method is similar to the readUTF() - - method in the Java® IDataInput interface.

- -

-Returns - - - - -
String — - A UTF-8 string produced by the byte representation of characters. - - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
readUTFBytes()method 
-
-public function readUTFBytes(length:uint):String -

- - - - -
Runtime version: AIR 1.0 -
-

- - Reads a sequence of UTF-8 bytes from the byte stream or byte array and returns a string. - -

Parameters - - - - -
length:uint — The number of bytes to read. - -
-

-Returns - - - - -
String — - A UTF-8 string produced by the byte representation of characters of the specified length. - - - -
-
-Events - - - - -
ioError:IOErrorEvent — The file cannot be read or the file is not open. This event is dispatched - only for files opened for asynchronous operations (by using the openAsync() method).
-
-Throws - - - - - - - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - read capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be read (for example, because the file is missing). - -
 
Error — The position specfied for reading data exceeds the number of bytes available - (specified by the bytesAvailable property). - -
-
- - - - - -
truncate()method 
-
-public function truncate():void -

- - - - -
Runtime version: AIR 1.0 -
-

- Truncates the file at the position specified by the position property of the FileStream - object. - -

Bytes from the position specified by the position property to the end of the file - are deleted. The file must be open for writing.

- -
-Throws - - - - -
Error — The file is not open for writing. - -
-

-See also -

-
-position -
-
-Example -
The following code synchronously opens a test.txt file in the Apollo Test subdirectory of - the user's documents directory and then trims the file to 100 characters in length if it is longer than - 100 characters. -
-
-import flash.filesystem.*;
-
-var file:File = File.documentsDirectory;
-file = file.resolvePath("Apollo Test/test.txt");
-var fileStream:FileStream = new FileStream();
-fileStream.open(file, FileMode.UPDATE);
-if (file.size > 100) {
-    fileStream.position = 100;
-	fileStream.truncate();
-}
-fileStream.close();
-
-

The following code asynchronously opens a test.txt file in the Apollo Test subdirectory - of the user's documents directory, and then trims the file to 100 characters in length if it is longer than 100 - characters. -
-
-var file:File = File.documentsDirectory;
-file = file.resolvePath("Apollo Test/test.txt");
-var fileStream:FileStream = new FileStream();
-fileStream.openAsync(file, FileMode.UPDATE);
-trace("start", file.size)
-if (file.size > 100) {
-    fileStream.position = 100;
-	fileStream.truncate();
-}
-fileStream.addEventListener(Event.CLOSE, fileClosed);
-fileStream.close();
-function fileClosed(event:Event):void {
-	trace("closed", file.size); 
-}
-
-

-
- - - - - -
writeBoolean()method 
-
-public function writeBoolean(value:Boolean):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes a Boolean value. A single byte is written according to the value parameter, - - either 1 if true or 0 if false. - - -

Parameters - - - - -
value:Boolean — A Boolean value determining which byte is written. If the parameter is true, - - 1 is written; if false, 0 is written. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-
- - - - - -
writeByte()method 
-
-public function writeByte(value:int):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes a byte. - - The low 8 bits of the - - parameter are used; the high 24 bits are ignored. - -

Parameters - - - - -
value:int — A byte value as an integer. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-
- - - - - -
writeBytes()method 
-
-public function writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes a sequence of bytes from the - - specified byte array, bytes, - - starting at the byte specified by offset - - (using a zero-based index) - - with a length specified by length, - - into the file stream, byte stream, or byte array. - - -

If the length parameter is omitted, the default - - length of 0 is used and the entire buffer starting at - - offset is written. - - If the offset parameter is also omitted, the entire buffer is - - written.

- - -

If the offset or length parameter - - is out of range, they are clamped to the beginning and end - - of the bytes array.

- - Parameters - - - - - - - - - - - - - - - - -
bytes:ByteArray — The byte array to write. - -
 
offset:uint (default = 0) — A zero-based index specifying the position into the array to begin writing. - -
 
length:uint (default = 0) — An unsigned integer specifying how far into the buffer to write. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-
- - - - - -
writeDouble()method 
-
-public function writeDouble(value:Number):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes an IEEE 754 double-precision (64-bit) floating point number. - -

Parameters - - - - -
value:Number — A double-precision (64-bit) floating point number. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-
- - - - - -
writeFloat()method 
-
-public function writeFloat(value:Number):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes an IEEE 754 single-precision (32-bit) floating point number. - -

Parameters - - - - -
value:Number — A single-precision (32-bit) floating point number. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-
- - - - - -
writeInt()method 
-
-public function writeInt(value:int):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes a 32-bit signed integer. - -

Parameters - - - - -
value:int — A byte value as a signed integer. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-
- - - - - -
writeMultiByte()method 
-
-public function writeMultiByte(value:String, charSet:String):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes a multibyte string to the file stream, byte stream, or byte array, using the specified character set. - - -

Parameters - - - - - - - - - - -
value:String — The string value to be written. - -
 
charSet:String — The string denoting the character set to use. Possible character set strings - - include "shift-jis", "cn-gb", "iso-8859-1", and others. - - For a complete list, see Supported Character Sets. - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-

-See also -

-
-File.systemCharset -
-
- - - - - -
writeObject()method 
-
-public function writeObject(object:):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes an object to the file stream, byte stream, or byte array, in AMF serialized - - format. - -

Parameters - - - - -
object: — The object to be serialized. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-

-See also -

-
-flash.net.registerClassAlias() -
-
- - - - - -
writeShort()method 
-
-public function writeShort(value:int):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes a 16-bit integer. The low 16 bits of the parameter are used; - - the high 16 bits are ignored. - -

Parameters - - - - -
value:int — A byte value as an integer. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-
- - - - - -
writeUnsignedInt()method 
-
-public function writeUnsignedInt(value:uint):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes a 32-bit unsigned integer. - -

Parameters - - - - -
value:uint — A byte value as an unsigned integer. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-
- - - - - -
writeUTF()method 
-
-public function writeUTF(value:String):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes a UTF-8 string to the file stream, byte stream, or byte array. The length of the UTF-8 string in bytes - - is written first, as a 16-bit integer, followed by the bytes representing the - - characters of the string. - -

Parameters - - - - -
value:String — The string value to be written. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - - - - - - - -
RangeError — If the length of the string is larger than - 65535. -
 
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-
- - - - - -
writeUTFBytes()method 
-
-public function writeUTFBytes(value:String):void -

- - - - -
Runtime version: AIR 1.0 -
-

- - Writes a UTF-8 string. Similar to writeUTF(), - - but does not prefix the string with a 16-bit length word. - -

Parameters - - - - -
value:String — The string value to be written. - - -
-
-Events - - - - -
ioError:IOErrorEvent — You cannot write to the file (for example, because the file is missing). - This event is dispatched only for files that have been opened for asynchronous operations (by using the - openAsync() method).
-
-Throws - - - - -
Error — The file has not been opened; the file has been opened, but it was not opened with - write capabilities; or for a file that has been opened for synchronous operations (by using the - open() method), the file cannot be written (for example, because the file is missing). - -
-
-
Event detail
- - - - - -
closeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLOSE -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that the stream has been - closed by an explicit call to the close() method. - -

- The Event.CLOSE constant defines the value of the type property of a close event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection has been closed.
- -

-See also -

-
-close() -
-
- - - - - -
completeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Signals that the end of the stream has been reached. - -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -

-See also -

-
-position -
-
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Indicates that an error occurred during an asynchronous file I/O operation. - -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -
- - - - - -
outputProgressevent  
-
-Event object type: flash.events.OutputProgressEvent -
-OutputProgressEvent.type property = flash.events.OutputProgressEvent.OUTPUT_PROGRESS -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Signals that buffered data has been written to the file. - -

- Defines the value of the type property of an outputProgress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesPendingThe number of bytes remaining to be written at the time the - listener processes the event.
bytesTotalThe total number of bytes that ultimately - will be written if the write process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe FileStream object reporting progress.
- -
- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Runtime version: AIR 1.0 -
-

- Signals the availability of new data on the stream. - -

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filesystem/StorageVolume.html b/html-docs/flash/filesystem/StorageVolume.html deleted file mode 100644 index 38ee899..0000000 --- a/html-docs/flash/filesystem/StorageVolume.html +++ /dev/null @@ -1,732 +0,0 @@ - - - - - - - - -flash.filesystem.StorageVolume (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filesystem
Classpublic class StorageVolume
InheritanceStorageVolume Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- A StorageVolume object includes properties defining a mass storage volume. - This class is used in two ways: -
    -
  • The storageVolume property of a StorageVolumeChangeEvent object - is a StorageVolume object. This object represents the storage volume that has been - mounted or unmounted.
    • -
  • The StorageVolumeInfo.storageVolumeInfo.getStorageVolumes() method returns a - vector of StorageVolume objects. Each of these StorageVolume objects represents a - mounted storage volume.
    • -
-

-

-View the examples. -

-

-See also -

-
-flash.filesystem.StorageVolumeInfo.getStorageVolumes() -
-flash.events.StorageVolumeChangeEvent.storageVolume -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  drive : String -
[read-only] - The volume drive letter on Windows.
-		StorageVolume
  fileSystemType : String -
[read-only] - The type of file system on the storage volume (such as "FAT", "NTFS", - "HFS", or "UFS").
-		StorageVolume
  isRemovable : Boolean -
[read-only] - Whether the operating system considers the storage volume to be removable (true) - or not (false).
-		StorageVolume
  isWritable : Boolean -
[read-only] - Whether a volume is writable (true) or not (false).
-		StorageVolume
  name : String -
[read-only] - The name of the volume.
-		StorageVolume
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rootDirectory : File -
[read-only] - A File object corresponding to the root directory of the volume.
-		StorageVolume
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StorageVolume(rootDirPath:File, name:String, writable:Boolean, removable:Boolean, fileSysType:String, drive:String)
-
- The constructor function.
-		StorageVolume
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
driveproperty
-
-drive:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The volume drive letter on Windows. On other platforms, this property is set - to null. -

Implementation -
-    public function get drive():String -
-
- - - - - -
fileSystemTypeproperty 
-
-fileSystemType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The type of file system on the storage volume (such as "FAT", "NTFS", - "HFS", or "UFS"). -

Implementation -
-    public function get fileSystemType():String -
-
-Example -
The following code lists the native path for the root directory and the file system type of each mounted storage volume: -
-
-var volumes:Vector.<StorageVolume> = new Vector.<StorageVolume>;
-volumes = StorageVolumeInfo.storageVolumeInfo.getStorageVolumes();
-for (var i:int = 0; i < volumes.length; i++)
-{
-    trace(volumes[i].rootDirectory.nativePath, "(" + volumes[i].fileSystemType + ")");
-}
-
-

-
- - - - - -
isRemovableproperty 
-
-isRemovable:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Whether the operating system considers the storage volume to be removable (true) - or not (false). -

The following table lists the values StorageVolume.isRemovable property for various types - of devices:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Type of deviceMac OSWindowsLinux
CD/DVD (fixed)truetruetrue
USB flash drivetruetruetrue
USB hard srivefalsefalsetrue
FireWire hard drivefalsefalsetrue
Shared volumetruefalse- 1
Network drivefalsefalsefalse
Storage card reader (empty)- 2false- 2
Storage card reader (with SD/CF card)truetruetrue
- -

1 Linux does not have a concept of a shared volume.

- -

2 On Windows, an empty card reader is listed as a non-removable device. On Mac OS and Linux, - empty car readers are not listed as storage volumes.

- Implementation -
-    public function get isRemovable():Boolean -
-
-Example -
The following code outputs a list of non-removable storage volumes, followed by a list of removable storage volumes: -
-
-var volumes:Vector.<StorageVolume> = new Vector.<StorageVolume>;
-volumes = StorageVolumeInfo.storageVolumeInfo.getStorageVolumes();
-
-trace("Non-removeable volumes:");
-for (var i:int = 0; i < volumes.length; i++)
-{
-    if (!volumes[i].isRemovable)
-	{
-		trace(volumes[i].rootDirectory.nativePath);
-	}
-}
-
-trace("\nRemoveable volumes:");
-for (i = 0; i < volumes.length; i++)
-{
-	if (volumes[i].isRemovable)
-	{
-		trace(volumes[i].rootDirectory.nativePath);
-	}
-}
-
-

-
- - - - - -
isWritableproperty 
-
-isWritable:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Whether a volume is writable (true) or not (false). -

Note: You can determine the amount of space available on a - volume by calling the rootDirectory.spaceAvailble property of the - StorageVolume object.

- Implementation -
-    public function get isWritable():Boolean -
-

-See also -

-
flash.fileSystem.File.spaceAvailable
-
-Example -
The following code outputs a list of writable storage volumes and the space available on each: -
-
-var volumes:Vector.<StorageVolume> = new Vector.<StorageVolume>;
-volumes = StorageVolumeInfo.storageVolumeInfo.getStorageVolumes();
-
-for (var i:int = 0; i < volumes.length; i++)
-{
-    if(volumes[i].isWritable)
-    {         
-        trace(volumes[i].rootDirectory.nativePath, volumes[i].rootDirectory.spaceAvailable);
-    }
-}
-
-

-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the volume. If there is no name, this property is set to null. -

Implementation -
-    public function get name():String -
-
-Example -
The following code lists the native path for the root directory and the file system name (if there is one) of each mounted storage volume: -
-
-var volumes:Vector.<StorageVolume> = new Vector.<StorageVolume>;
-volumes = StorageVolumeInfo.storageVolumeInfo.getStorageVolumes();
-for (var i:int = 0; i < volumes.length; i++)
-{
-    var name:String = new String();
-	if (volumes[i].name)
-	{
-		name = "(" + volumes[i].name + ")";
-	}
-	trace(volumes[i].rootDirectory.nativePath, name);
-}
-
-

-
- - - - - -
rootDirectoryproperty 
-
-rootDirectory:File  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A File object corresponding to the root directory of the volume. -

Implementation -
-    public function get rootDirectory():File -
-
-Example -
The following code lists the native path for the root directory of each mounted storage volume: -
-
-var volumes:Vector.<StorageVolume> = new Vector.<StorageVolume>;
-volumes = StorageVolumeInfo.storageVolumeInfo.getStorageVolumes();
-for (var i:int = 0; i < volumes.length; i++)
-{
-    trace(volumes[i].rootDirectory.nativePath);
-}
-
-

-
- -
Constructor detail
- - - - - -
StorageVolume()constructor
-
-public function StorageVolume(rootDirPath:File, name:String, writable:Boolean, removable:Boolean, fileSysType:String, drive:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The constructor function. Generally, you do not call this constructor function directly - (to create new StorageVolume objects). Rather, you reference StorageVolume objects - by accessing the storageVolume property of a StorageVolumeChangeEvent object - or by calling StorageVolumeInfo.storageVolumeInfo.getStorageVolumes(). -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
rootDirPath:File
 
name:String
 
writable:Boolean
 
removable:Boolean
 
fileSysType:String
 
drive:String
-
- -
Examples
-
examples\StorageVolumeExample
-
The following code lists the properties of each mounted storage volume: -
-
-package
-{
-    import flash.display.Sprite;
-    import flash.filesystem.StorageVolume;
-    import flash.filesystem.StorageVolumeInfo;
-
-    public class StorageVolumeExample extends Sprite
-    {
-        public function StorageVolumeExample()
-        {
-            var volumes:Vector.<StorageVolume> = StorageVolumeInfo.storageVolumeInfo.getStorageVolumes();
-            for (var i:int = 0; i < volumes.length; i++)
-            {
-                var volume:StorageVolume = volumes[i];
-                trace("nativePath:", volume.rootDirectory.nativePath);
-                trace("fileSystemType:", volume.fileSystemType);
-                trace("isRemovable:", volume.isRemovable);
-                trace("isWritable:", volume.isWritable);
-                trace("drive:", volume.drive);
-                trace("name:", volume.name);
-                trace("________________________________________________________");
-            }
-        }
-    }
-}
-
-
-
examples\StorageVolumeChangeEventExample
-
The following code lists the properties of each storage volume that becomes mounted or unmounted. - Note that the storageVolume property of the StorageVolumeChangeEvent is only set for the storageVolumeMount - event; it is null for the storageVolumeUnmount event: -
-
-package
-{
-    import flash.display.Sprite;
-    import flash.events.StorageVolumeChangeEvent;
-    import flash.filesystem.StorageVolume;
-    import flash.filesystem.StorageVolumeInfo;
-
-    public class StorageVolumeChangeEventExample extends Sprite
-    {
-        public function StorageVolumeChangeEventExample()
-        {
-            StorageVolumeInfo.storageVolumeInfo.addEventListener(StorageVolumeChangeEvent.STORAGE_VOLUME_MOUNT, mountEventHandler);
-            StorageVolumeInfo.storageVolumeInfo.addEventListener(StorageVolumeChangeEvent.STORAGE_VOLUME_UNMOUNT, unmountEventHandler);
-        }
-        public function mountEventHandler(event:StorageVolumeChangeEvent):void
-        {            
-            var volume:StorageVolume = event.storageVolume;
-            trace("VOLUME MOUNTED:");
-            trace("nativePath:", event.rootDirectory.nativePath);
-            trace("fileSystemType:", volume.fileSystemType);
-            trace("isRemovable:", volume.isRemovable);
-            trace("isWritable:", volume.isWritable);
-            trace("drive:", volume.drive);
-            trace("name:", volume.name);
-            trace();
-        }
-        public function unmountEventHandler(event:StorageVolumeChangeEvent):void
-        {            
-            trace("VOLUME UNMOUNTED:");
-            trace("nativePath:", event.rootDirectory.nativePath);
-            trace();
-        }        
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filesystem/StorageVolumeInfo.html b/html-docs/flash/filesystem/StorageVolumeInfo.html deleted file mode 100644 index 02216a0..0000000 --- a/html-docs/flash/filesystem/StorageVolumeInfo.html +++ /dev/null @@ -1,742 +0,0 @@ - - - - - - - - -flash.filesystem.StorageVolumeInfo (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filesystem
Classpublic final class StorageVolumeInfo
InheritanceStorageVolumeInfo Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

-

- - The StorageVolumeInfo object dispatches a StorageVolumeChangeEvent object when a - - storage volume is mounted or unmounted. The StorageVolume.storageVolume - - static property references the singleton StorageVolumeInfo object, which dispatches - - the events. The StorageVolumeInfo class also defines a getStorageVolumes - - method for listing currently mounted storage volumes. - - -

AIR profile support: This feature is supported - - on all desktop operating systems, but it is not supported on all AIR for TV devices. - - It is also not supported on mobile devices. You can test - - for support at run time using the StorageVolumeInfo.isSupported property. See - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - - -

On modern Linux distributions, the StorageVolumeInfo object only dispatches storageVolumeMount and - - storageVolumeUnmount events for physical devices and network drives mounted at particular locations.

- - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentVolumes : Vector.<StorageVolume>
[read-only] - - Returns a vector of the currently known StorageVolume objects.
-		StorageVolumeInfo
  isSupported : Boolean -
[static][read-only] - - The isSupported property is set to true if the - - StorageVolumeInfo class is supported on the current platform, otherwise it is - - set to false.
-		StorageVolumeInfo
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  storageVolumeInfo : StorageVolumeInfo -
[static][read-only] - - The singleton instance of the StorageVolumeInfo object.
-		StorageVolumeInfo
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-getStorageVolumes():Vector.<StorageVolume>
-
- - Returns vector of StorageVolume objects corresponding to the currently mounted storage volumes.
-		StorageVolumeInfo
   -
-getStorageVolumesAsync():void -
-
- - Triggers an asynchronous request to find the currently mounted storage volumes.
-		StorageVolumeInfo
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-complete -
-		 - - Dispatched when an asynchronous request to list the current storage volumes has completed.StorageVolumeInfo
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-storageVolumeMount -
-		 - - Dispatched when a storage volume has been mounted.StorageVolumeInfo
   -
-storageVolumeUnmount -
-		 - - Dispatched when a storage volume has been unmounted.StorageVolumeInfo
-
- -
- -
Property detail
- - - - - -
currentVolumesproperty
-
-currentVolumes:Vector.<StorageVolume>  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Returns a vector of the currently known StorageVolume objects. This vector is created from the - - most recent call to getStorageVolumes or getStorageVolumesAsync and will - - be null until one of these methods has completed. - - -

Implementation -
-    public function get currentVolumes():Vector.<StorageVolume> -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - The isSupported property is set to true if the - - StorageVolumeInfo class is supported on the current platform, otherwise it is - - set to false. - - -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
storageVolumeInfoproperty 
-
-storageVolumeInfo:StorageVolumeInfo  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - The singleton instance of the StorageVolumeInfo object. Register event listeners - - on this object for the storageVolumeMount and storageVolumeUnmount - - events. - - -

Implementation -
-    public static function get storageVolumeInfo():StorageVolumeInfo -
-
- -
Method detail
- - - - - -
getStorageVolumes()method
-
-public function getStorageVolumes():Vector.<StorageVolume> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Returns vector of StorageVolume objects corresponding to the currently mounted storage volumes. - - -

On modern Linux distributions, this method returns objects corresponding to physical devices - - and network drives mounted at particular locations.

- - -

-Returns - - - - -
Vector.<StorageVolume>
-

-See also -

-
-flash.filesystem.StorageVolume -
-
-Example -
The following code lists the native path for the root directory of each mounted storage volume: -
-
-var volumes:Vector.<StorageVolume> = new Vector.<StorageVolume>;
-volumes = StorageVolumeInfo.storageVolumeInfo.getStorageVolumes();
-for (var i:int = 0; i < volumes.length; i++)
-{
-    trace(volumes[i].rootDirectory.nativePath);
-}
-
- -

-
- - - - - -
getStorageVolumesAsync()method 
-
-public function getStorageVolumesAsync():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Triggers an asynchronous request to find the currently mounted storage volumes. - - -

A separate thread is used to query for the storage volumes available on the device. When this - - has completed, an Event.COMPLETE event is dispatched and the results of the search are - - available via the currentVolumes property.

- - -
-
Event detail
- - - - - -
completeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Dispatched when an asynchronous request to list the current storage volumes has completed. - - -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
- - - - - -
storageVolumeMountevent  
-
-Event object type: flash.events.StorageVolumeChangeEvent -
-StorageVolumeChangeEvent.type property = flash.events.StorageVolumeChangeEvent.STORAGE_VOLUME_MOUNT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Dispatched when a storage volume has been mounted. - - - -

On modern Linux distributions, the StorageVolumeInfo object only dispatches storageVolumeMount and - - storageVolumeUnmount events for physical devices and network drives mounted at particular locations.

- - -

- The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the - type property of a StorageVolumeChangeEvent when a volume is mounted. -

The event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe StorageVolumeChangeEvent object.
fileA File object representing the storage volume.
nameThe name of the storage volume.
targetThe StorageVolumeChangeEvent object.
type"storageVolumeMount"
-
- - - - - -
storageVolumeUnmountevent  
-
-Event object type: flash.events.StorageVolumeChangeEvent -
-StorageVolumeChangeEvent.type property = flash.events.StorageVolumeChangeEvent.STORAGE_VOLUME_UNMOUNT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Dispatched when a storage volume has been unmounted. - - - -

On modern Linux distributions, the StorageVolumeInfo object only dispatches storageVolumeMount and - - storageVolumeUnmount events for physical devices and network drives mounted at particular locations.

- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/filesystem/package-detail.html b/html-docs/flash/filesystem/package-detail.html deleted file mode 100644 index 605979c..0000000 --- a/html-docs/flash/filesystem/package-detail.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - -flash.filesystem Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.filesystem package contains classes used in accessing the filesystem. This package is only available to content running in the AIR runtime.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - -
 ClassDescription
 File - A File object represents a path to a file or directory.
 FileMode - The FileMode class defines string constants used in the fileMode parameter of - the open() and openAsync() methods of the FileStream class.
 FileStream - A FileStream object is used to read and write files.
 StorageVolume - A StorageVolume object includes properties defining a mass storage volume.
 StorageVolumeInfo - The StorageVolumeInfo object dispatches a StorageVolumeChangeEvent object when a - storage volume is mounted or unmounted.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/filters/BevelFilter.html b/html-docs/flash/filters/BevelFilter.html deleted file mode 100644 index 31a4cc3..0000000 --- a/html-docs/flash/filters/BevelFilter.html +++ /dev/null @@ -1,973 +0,0 @@ - - - - - - - - -flash.filters.BevelFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class BevelFilter
InheritanceBevelFilter Inheritance BitmapFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The BevelFilter class lets you add a bevel effect to display objects. - A bevel effect gives objects such as buttons a three-dimensional look. You can customize - the look of the bevel with different highlight and shadow colors, the amount - of blur on the bevel, the angle of the bevel, the placement of the bevel, - and a knockout effect. - You can apply the filter to any display object (that is, objects that inherit from the - DisplayObject class), such as MovieClip, SimpleButton, TextField, and Video objects, - as well as to BitmapData objects. -

To create a new filter, use the constructor new BevelFilter(). - The use of filters depends on the object to which you apply the filter:

-
  • To apply filters to movie clips, text fields, buttons, and video, use the - filters property (inherited from DisplayObject). Setting the filters - property of an object does not modify the object, and you can remove the filter by clearing the - filters property.
    • - -
  • To apply filters to BitmapData objects, use the BitmapData.applyFilter() method. - Calling applyFilter() on a BitmapData object takes the source BitmapData object - and the filter object and generates a filtered image as a result.
    • -
- -

If you apply a filter to a display object, the value of the cacheAsBitmap property of the - object is set to true. If you remove all filters, the original value of - cacheAsBitmap is restored.

-

This filter supports Stage scaling. However, it does not support general scaling, rotation, and - skewing. If the object itself is scaled (if the scaleX and scaleY properties are - not set to 100%), the filter is not scaled. It is scaled only when the user zooms in on the Stage.

- -

A filter is not applied if the resulting image exceeds the maximum dimensions. - In AIR 1.5 and Flash Player 10, the maximum is 8,191 pixels in width or height, - and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an image is 8,191 pixels - wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, - the limitation is 2,880 pixels in height and 2,880 pixels in width. - If, for example, you zoom in on a large movie clip with a filter applied, the filter is - turned off if the resulting image exceeds the maximum dimensions.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.DisplayObject.filters -
-flash.display.DisplayObject.cacheAsBitmap -
-flash.display.BitmapData.applyFilter() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  angle : Number -
- The angle of the bevel.
-		BevelFilter
  blurX : Number -
- The amount of horizontal blur, in pixels.
-		BevelFilter
  blurY : Number -
- The amount of vertical blur, in pixels.
-		BevelFilter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  distance : Number -
- The offset distance of the bevel.
-		BevelFilter
  highlightAlpha : Number -
- The alpha transparency value of the highlight color.
-		BevelFilter
  highlightColor : uint -
- The highlight color of the bevel.
-		BevelFilter
  knockout : Boolean -
- Applies a knockout effect (true), which effectively - makes the object's fill transparent and reveals the background color of the document.
-		BevelFilter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : int -
- The number of times to apply the filter.
-		BevelFilter
  shadowAlpha : Number -
- The alpha transparency value of the shadow color.
-		BevelFilter
  shadowColor : uint -
- The shadow color of the bevel.
-		BevelFilter
  strength : Number -
- The strength of the imprint or spread.
-		BevelFilter
  type : String -
- The placement of the bevel on the object.
-		BevelFilter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-BevelFilter(distance:Number = 4.0, angle:Number = 45, highlightColor:uint = 0xFFFFFF, highlightAlpha:Number = 1.0, shadowColor:uint = 0x000000, shadowAlpha:Number = 1.0, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1, quality:int = 1, type:String = "inner", knockout:Boolean = false)
-
- Initializes a new BevelFilter instance with the specified parameters.
-		BevelFilter
   -
-clone():BitmapFilter -
-
- Returns a copy of this filter object.
-		BevelFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
angleproperty
-
-angle:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The angle of the bevel. Valid values are from 0 to 360°. The default value is 45°. - -

The angle value represents the angle of the theoretical light source falling on the object - and determines the placement of the effect relative to the object. If the distance - property is set to 0, the effect is not offset from the object and, therefore, - the angle property has no effect.

- - Implementation -
-    public function get angle():Number -
-    public function set angle(value:Number):void -
-
- - - - - -
blurXproperty 
-
-blurX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of horizontal blur, in pixels. Valid values are from 0 to 255 (floating point). - The default value is 4. Values that are a power of 2 (such as 2, 4, 8, 16, and 32) are optimized - to render more quickly than other values. -

Implementation -
-    public function get blurX():Number -
-    public function set blurX(value:Number):void -
-
- - - - - -
blurYproperty 
-
-blurY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of vertical blur, in pixels. Valid values are from 0 to 255 (floating point). - The default value is 4. Values that are a power of 2 (such as 2, 4, 8, 16, and 32) are optimized - to render more quickly than other values. -

Implementation -
-    public function get blurY():Number -
-    public function set blurY(value:Number):void -
-
- - - - - -
distanceproperty 
-
-distance:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The offset distance of the bevel. Valid values are in pixels (floating point). The default is 4. -

Implementation -
-    public function get distance():Number -
-    public function set distance(value:Number):void -
-
- - - - - -
highlightAlphaproperty 
-
-highlightAlpha:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The alpha transparency value of the highlight color. The value is specified as a normalized - value from 0 to 1. For example, - .25 sets a transparency value of 25%. The default value is 1. -

Implementation -
-    public function get highlightAlpha():Number -
-    public function set highlightAlpha(value:Number):void -
-
- - - - - -
highlightColorproperty 
-
-highlightColor:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The highlight color of the bevel. Valid values are in hexadecimal format, - 0xRRGGBB. The default is 0xFFFFFF. -

Implementation -
-    public function get highlightColor():uint -
-    public function set highlightColor(value:uint):void -
-
- - - - - -
knockoutproperty 
-
-knockout:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Applies a knockout effect (true), which effectively - makes the object's fill transparent and reveals the background color of the document. The - default value is false (no knockout). -

Implementation -
-    public function get knockout():Boolean -
-    public function set knockout(value:Boolean):void -
-
- - - - - -
qualityproperty 
-
-quality:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of times to apply the filter. The default value is BitmapFilterQuality.LOW, - which is equivalent to applying the filter once. The value BitmapFilterQuality.MEDIUM - applies the filter twice; the value BitmapFilterQuality.HIGH applies it three times. - Filters with lower values are rendered more quickly. -

For most applications, a quality value of low, medium, or high is sufficient. - Although you can use additional numeric values up to 15 to achieve different effects, - higher values are rendered more slowly. Instead of increasing the value of quality, - you can often get a similar effect, and with faster rendering, by simply increasing the values - of the blurX and blurY properties.

- -

You can use the following BitmapFilterQuality constants to specify values of the quality property: -

    -
  • BitmapFilterQuality.LOW
    • -
  • BitmapFilterQuality.MEDIUM
    • -
  • BitmapFilterQuality.HIGH
    • -
-

- Implementation -
-    public function get quality():int -
-    public function set quality(value:int):void -
-
- - - - - -
shadowAlphaproperty 
-
-shadowAlpha:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The alpha transparency value of the shadow color. This value is specified as a normalized - value from 0 to 1. For example, - .25 sets a transparency value of 25%. The default is 1. -

Implementation -
-    public function get shadowAlpha():Number -
-    public function set shadowAlpha(value:Number):void -
-
- - - - - -
shadowColorproperty 
-
-shadowColor:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The shadow color of the bevel. Valid values are in hexadecimal format, 0xRRGGBB. The default - is 0x000000. -

Implementation -
-    public function get shadowColor():uint -
-    public function set shadowColor(value:uint):void -
-
- - - - - -
strengthproperty 
-
-strength:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The strength of the imprint or spread. Valid values are from 0 to 255. The larger the value, - the more color is imprinted and the stronger the contrast between the bevel and the background. - The default value is 1. -

Implementation -
-    public function get strength():Number -
-    public function set strength(value:Number):void -
-
- - - - - -
typeproperty 
-
-type:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The placement of the bevel on the object. Inner and outer bevels are placed on - the inner or outer edge; a full bevel is placed on the entire object. - Valid values are the BitmapFilterType constants: - -

    -
  • BitmapFilterType.INNER
    • -
  • BitmapFilterType.OUTER
    • -
  • BitmapFilterType.FULL
    • -
- -

Implementation -
-    public function get type():String -
-    public function set type(value:String):void -
-
-Throws -
- - - - -
TypeError — The string is null when being set -
-
- -
Constructor detail
- - - - - -
BevelFilter()constructor
-
-public function BevelFilter(distance:Number = 4.0, angle:Number = 45, highlightColor:uint = 0xFFFFFF, highlightAlpha:Number = 1.0, shadowColor:uint = 0x000000, shadowAlpha:Number = 1.0, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1, quality:int = 1, type:String = "inner", knockout:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Initializes a new BevelFilter instance with the specified parameters. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
distance:Number (default = 4.0) — The offset distance of the bevel, in pixels (floating point). -
 
angle:Number (default = 45) — The angle of the bevel, from 0 to 360 degrees. -
 
highlightColor:uint (default = 0xFFFFFF) — The highlight color of the bevel, 0xRRGGBB. -
 
highlightAlpha:Number (default = 1.0) — The alpha transparency value of the highlight color. Valid values are 0.0 to - 1.0. For example, - .25 sets a transparency value of 25%. -
 
shadowColor:uint (default = 0x000000) — The shadow color of the bevel, 0xRRGGBB. -
 
shadowAlpha:Number (default = 1.0) — The alpha transparency value of the shadow color. Valid values are 0.0 to 1.0. For example, - .25 sets a transparency value of 25%. -
 
blurX:Number (default = 4.0) — The amount of horizontal blur in pixels. Valid values are 0 to 255.0 (floating point). -
 
blurY:Number (default = 4.0) — The amount of vertical blur in pixels. Valid values are 0 to 255.0 (floating point). -
 
strength:Number (default = 1) — The strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the bevel and the background. Valid values are 0 to 255.0. -
 
quality:int (default = 1) — The quality of the bevel. Valid values are 0 to 15, but for most applications, - you can use BitmapFilterQuality constants: -
    -
  • BitmapFilterQuality.LOW
    • -
  • BitmapFilterQuality.MEDIUM
    • -
  • BitmapFilterQuality.HIGH
    • -
-

Filters with lower values render faster. You can use - the other available numeric values to achieve different effects.

- -
 
type:String (default = "inner") — The type of bevel. Valid values are BitmapFilterType constants: - BitmapFilterType.INNER, BitmapFilterType.OUTER, or - BitmapFilterType.FULL. -
 
knockout:Boolean (default = false) — Applies a knockout effect (true), which effectively - makes the object's fill transparent and reveals the background color of the document. -
-

-See also -

-
-BitmapFilterQuality -
-BitmapFilterType -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():BitmapFilter -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a copy of this filter object. -

-Returns - - - - -
BitmapFilter — - A new BevelFilter instance with all the same properties as - the original BevelFilter instance. - - -
-
- -
Examples
-
examples\BevelFilterExample
-
The following example creates a dark yellow square and applies a bevel with a - bright yellow (0xFFFF00) highlight and a blue (0x0000FF) shadow. The general workflow for this - example is as follows: -
    -
  1. Import the required classes.
    2. -
  2. Declare three properties used in the draw() function, which draws the - object to which the bevel filter is applied.
    3. -
  3. Create the BevelFilterExample() constructor function, which does the following: -
      -
    • Calls the draw() function, which is declared later.
      • -
    • Declares a variable filter as a BitmapFilter object - and assigns it to the return of a call to getBitmapFilter().
      • -
    • Creates a new Array object myFilters and adds filter to - the array, and assigns myFilters to the filters property of - BevelFilterExample object. This applies all filters found in myFilters, which in this case - is only filter.
      • -
    -
    4. -
  4. Create the getBitmapFilter function to create and set properties for the filter.
    5. -
  5. Create the draw() function. This function - uses methods of the Graphics class, accessed through the graphics property - of the Sprite class, to draw the square.
    6. - -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.filters.BevelFilter;
-    import flash.filters.BitmapFilter;
-    import flash.filters.BitmapFilterQuality;
-    import flash.filters.BitmapFilterType;
-
-    public class BevelFilterExample extends Sprite {
-        private var bgColor:uint = 0xFFCC00;
-        private var size:uint    = 80;
-        private var offset:uint  = 50;
-
-        public function BevelFilterExample() {
-            draw();
-            var filter:BitmapFilter = getBitmapFilter();
-            var myFilters:Array = new Array();
-            myFilters.push(filter);
-            filters = myFilters;
-        }
-
-        private function getBitmapFilter():BitmapFilter {
-            var distance:Number       = 5;
-            var angleInDegrees:Number = 45;
-            var highlightColor:Number = 0xFFFF00;
-            var highlightAlpha:Number = 0.8;
-            var shadowColor:Number    = 0x0000FF;
-            var shadowAlpha:Number    = 0.8;
-            var blurX:Number          = 5;
-            var blurY:Number          = 5;
-            var strength:Number       = 5;
-            var quality:Number        = BitmapFilterQuality.HIGH;
-            var type:String           = BitmapFilterType.INNER;
-            var knockout:Boolean      = false;
-
-            return new BevelFilter(distance,
-                                   angleInDegrees,
-                                   highlightColor,
-                                   highlightAlpha,
-                                   shadowColor,
-                                   shadowAlpha,
-                                   blurX,
-                                   blurY,
-                                   strength,
-                                   quality,
-                                   type,
-                                   knockout);
-        }
-
-        private function draw():void {
-            graphics.beginFill(bgColor);
-            graphics.drawRect(offset, offset, size, size);
-            graphics.endFill();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/BitmapFilter.html b/html-docs/flash/filters/BitmapFilter.html deleted file mode 100644 index 2e27882..0000000 --- a/html-docs/flash/filters/BitmapFilter.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - - - -flash.filters.BitmapFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.filters
Classpublic class BitmapFilter
InheritanceBitmapFilter Inheritance Object
SubclassesBevelFilter, BlurFilter, ColorMatrixFilter, ConvolutionFilter, DisplacementMapFilter, DropShadowFilter, GlowFilter, GradientBevelFilter, GradientGlowFilter, ShaderFilter
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The BitmapFilter class is the base class for all image filter effects. -

The BevelFilter, BlurFilter, ColorMatrixFilter, ConvolutionFilter, DisplacementMapFilter, - DropShadowFilter, GlowFilter, GradientBevelFilter, and GradientGlowFilter classes all extend the - BitmapFilter class. You can apply these filter effects to any display object.

-

You can neither directly instantiate nor extend BitmapFilter.

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-clone():BitmapFilter -
-
- Returns a BitmapFilter object that is an exact copy of the original - BitmapFilter object.
-		BitmapFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Method detail
- - - - - -
clone()method
-
-public function clone():BitmapFilter -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a BitmapFilter object that is an exact copy of the original - BitmapFilter object. -

-Returns - - - - -
BitmapFilter — - A BitmapFilter object. - - -
-
- -
Examples
-
examples\BitmapFilterExample
-
The following example shows how several filters may be applied to a given - DisplayObject object and tracked using the filters property. -
-
-package {
-    import flash.display.Sprite;
-    import flash.filters.*;
-
-    public class BitmapFilterExample extends Sprite {
-        public function BitmapFilterExample() {
-            trace(this.filters.length);             // 0
-
-            var tmpFilters:Array = this.filters;
-            tmpFilters.push(FilterFactory.createFilter(FilterFactory.BEVEL_FILTER));
-            tmpFilters.push(FilterFactory.createFilter(FilterFactory.GLOW_FILTER));
-            this.filters = tmpFilters;
-
-            trace(this.filters.length);             // 2
-            trace(this.filters[0] is BitmapFilter); // true
-            trace(this.filters[0] is BevelFilter);  // true
-            trace(this.filters[1] is BitmapFilter); // true
-            trace(this.filters[1] is GlowFilter);   // true
-        }
-    }
-}
-
-import flash.filters.*;
-class FilterFactory {
-    public static var BEVEL_FILTER:String = "BevelFilter";
-    public static var BevelFilterConstructor:Class = BevelFilter;
-
-    public static var BLUR_FILTER:String = "BlurFilter";
-    public static var BlurFilterConstructor:Class = BlurFilter;
-
-    public static var COLOR_MATRIX_FILTER:String = "ColorMatrixFilter";
-    public static var ColorMatrixFilterConstructor:Class = ColorMatrixFilter;
-
-    public static var CONVOLUTION_FILTER:String = "ConvolutionFilter";
-    public static var ConvolutionFilterConstructor:Class = ConvolutionFilter;
-
-    public static var DISPLACEMENT_MAP_FILTER:String = "DisplacementMapFilter";
-    public static var DisplacementMapFilterConstructor:Class = DisplacementMapFilter;
-
-    public static var DROP_SHADOW_FILTER:String = "DropShadowFilter";
-    public static var DropShadowFilterConstructor:Class = DropShadowFilter;
-
-    public static var GLOW_FILTER:String = "GlowFilter";
-    public static var GlowFilterConstructor:Class = GlowFilter;
-
-    public static var GRADIENT_BEVEL_FILTER:String = "GradientBevelFilter";
-    public static var GradientBevelFilterConstructor:Class = GradientBevelFilter;
-
-    public static var GRADIENT_GLOW_FILTER:String = "GradientGlowFilter";
-    public static var GradientGlowFilterConstructor:Class = GradientGlowFilter;
-
-    public static function createFilter(type:String):BitmapFilter {
-        return new FilterFactory[type + "Constructor"]();   
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/BitmapFilterQuality.html b/html-docs/flash/filters/BitmapFilterQuality.html deleted file mode 100644 index fb49640..0000000 --- a/html-docs/flash/filters/BitmapFilterQuality.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - - - -flash.filters.BitmapFilterQuality (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class BitmapFilterQuality
InheritanceBitmapFilterQuality Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The BitmapFilterQuality class contains values to set the rendering quality of a BitmapFilter object. -

-

-View the examples. -

-

-See also -

-
-BevelFilter -
-BlurFilter -
-GlowFilter -
-DropShadowFilter -
-GradientBevelFilter -
-GradientGlowFilter -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  HIGH : int = 3
[static] - Defines the high quality filter setting.
-		BitmapFilterQuality
  LOW : int = 1
[static] - Defines the low quality filter setting.
-		BitmapFilterQuality
  MEDIUM : int = 2
[static] - Defines the medium quality filter setting.
-		BitmapFilterQuality
-
- -
- -
Constant detail
- - - - - -
HIGHconstant
-
-public static const HIGH:int = 3 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the high quality filter setting. -

- - - - - -
LOWconstant 
-
-public static const LOW:int = 1 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the low quality filter setting. -

- - - - - -
MEDIUMconstant 
-
-public static const MEDIUM:int = 2 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the medium quality filter setting. -

- -
Examples
-
examples\BitmapFilterQualityExample
-
The following example draws a gray square and applies a BevelFilter object to it. - The example sets the quality property by using the - constant BitmapFilterQuality.HIGH. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.filters.BevelFilter;
-    import flash.filters.BitmapFilter;
-    import flash.filters.BitmapFilterQuality;
-    import flash.filters.BitmapFilterType;
-
-    public class BitmapFilterQualityExample extends Sprite {
-        private var bgColor:uint = 0x999999;
-        private var size:uint    = 80;
-        private var offset:uint  = 50;
-
-        public function BitmapFilterQualityExample() {
-            draw();
-            var filter:BitmapFilter = getBitmapFilter();
-            var myFilters:Array = new Array();
-            myFilters.push(filter);
-            filters = myFilters;
-        }
-
-        private function getBitmapFilter():BitmapFilter {
-            var distance:Number       = 5;
-            var angleInDegrees:Number = 45;
-            var highlightColor:Number = 0xCCCCCC;
-            var highlightAlpha:Number = 0.8;
-            var shadowColor:Number    = 0x808080;
-            var shadowAlpha:Number    = 0.8;
-            var blurX:Number          = 5;
-            var blurY:Number          = 5;
-            var strength:Number       = 5;
-            var quality:Number        = BitmapFilterQuality.HIGH;
-            var type:String           = BitmapFilterType.INNER;
-            var knockout:Boolean      = false;
-
-            return new BevelFilter(distance,
-                                   angleInDegrees,
-                                   highlightColor,
-                                   highlightAlpha,
-                                   shadowColor,
-                                   shadowAlpha,
-                                   blurX,
-                                   blurY,
-                                   strength,
-                                   quality,
-                                   type,
-                                   knockout);
-        }
-
-        private function draw():void {
-            graphics.beginFill(bgColor);
-            graphics.drawRect(offset, offset, size, size);
-            graphics.endFill();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/BitmapFilterType.html b/html-docs/flash/filters/BitmapFilterType.html deleted file mode 100644 index 279e752..0000000 --- a/html-docs/flash/filters/BitmapFilterType.html +++ /dev/null @@ -1,373 +0,0 @@ - - - - - - - - -flash.filters.BitmapFilterType (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class BitmapFilterType
InheritanceBitmapFilterType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The BitmapFilterType class contains values to set the type of a BitmapFilter. -

-

-View the examples. -

-

-See also -

-
-BevelFilter -
-GradientBevelFilter -
-GradientGlowFilter -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  FULL : String = "full"
[static] - Defines the setting that applies a filter to the entire area of an object.
-		BitmapFilterType
  INNER : String = "inner"
[static] - Defines the setting that applies a filter to the inner area of an object.
-		BitmapFilterType
  OUTER : String = "outer"
[static] - Defines the setting that applies a filter to the outer area of an object.
-		BitmapFilterType
-
- -
- -
Constant detail
- - - - - -
FULLconstant
-
-public static const FULL:String = "full" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the setting that applies a filter to the entire area of an object. -

- - - - - -
INNERconstant 
-
-public static const INNER:String = "inner" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the setting that applies a filter to the inner area of an object. -

- - - - - -
OUTERconstant 
-
-public static const OUTER:String = "outer" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the setting that applies a filter to the outer area of an object. -

- -
Examples
-
examples\BitmapFilterTypeExample
-
The following example draws a gray square and applies a BevelFilter object to it. - The example sets the type property by using the constant BitmapFilterType.HIGH. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.filters.BevelFilter;
-    import flash.filters.BitmapFilter;
-    import flash.filters.BitmapFilterQuality;
-    import flash.filters.BitmapFilterType;
-
-    public class BitmapFilterTypeExample extends Sprite {
-        private var bgColor:uint = 0x999999;
-        private var size:uint    = 80;
-        private var offset:uint  = 50;
-
-        public function BitmapFilterTypeExample() {
-            draw();
-            var filter:BitmapFilter = getBitmapFilter();
-            var myFilters:Array = new Array();
-            myFilters.push(filter);
-            filters = myFilters;
-        }
-
-        private function getBitmapFilter():BitmapFilter {
-            var distance:Number       = 5;
-            var angleInDegrees:Number = 45;
-            var highlightColor:Number = 0xCCCCCC;
-            var highlightAlpha:Number = 0.8;
-            var shadowColor:Number    = 0x808080;
-            var shadowAlpha:Number    = 0.8;
-            var blurX:Number          = 5;
-            var blurY:Number          = 5;
-            var strength:Number       = 5;
-            var quality:Number        = BitmapFilterQuality.HIGH;
-            var type:String           = BitmapFilterType.INNER;
-            var knockout:Boolean      = false;
-
-            return new BevelFilter(distance,
-                                   angleInDegrees,
-                                   highlightColor,
-                                   highlightAlpha,
-                                   shadowColor,
-                                   shadowAlpha,
-                                   blurX,
-                                   blurY,
-                                   strength,
-                                   quality,
-                                   type,
-                                   knockout);
-        }
-
-        private function draw():void {
-            graphics.beginFill(bgColor);
-            graphics.drawRect(offset, offset, size, size);
-            graphics.endFill();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/BlurFilter.html b/html-docs/flash/filters/BlurFilter.html deleted file mode 100644 index 8da0b99..0000000 --- a/html-docs/flash/filters/BlurFilter.html +++ /dev/null @@ -1,548 +0,0 @@ - - - - - - - - -flash.filters.BlurFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class BlurFilter
InheritanceBlurFilter Inheritance BitmapFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The BlurFilter class lets you apply a blur visual effect to display objects. - A blur effect softens the details of an image. You can produce blurs that - range from a softly unfocused look to a Gaussian blur, a hazy - appearance like viewing an image through semi-opaque glass. When the quality property - of this filter is set to low, the result is a softly unfocused look. - When the quality property is set to high, it approximates a Gaussian blur - filter. You can apply the filter to any display object (that is, objects that inherit - from the DisplayObject class), - such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects. -

To create a new filter, use the constructor new BlurFilter(). - The use of filters depends on the object to which you apply the filter:

-
  • To apply filters to movie clips, text fields, buttons, and video, use the - filters property (inherited from DisplayObject). Setting the filters - property of an object does not modify the object, and you can remove the filter by clearing the - filters property.
    • - -
  • To apply filters to BitmapData objects, use the BitmapData.applyFilter() method. - Calling applyFilter() on a BitmapData object takes the source BitmapData object - and the filter object and generates a filtered image as a result.
    • -
- -

If you apply a filter to a display object, the cacheAsBitmap property of the - display object is set to true. If you remove all filters, the original value of - cacheAsBitmap is restored.

- -

This filter supports Stage scaling. However, it does not support general scaling, - rotation, and skewing. If the object itself is scaled (scaleX and scaleY are not set to 100%), the - filter effect is not scaled. It is scaled only when the user zooms in on the Stage.

-

A filter is not applied if the resulting image exceeds the maximum dimensions. - In AIR 1.5 and Flash Player 10, the maximum is 8,191 pixels in width or height, - and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an image is 8,191 pixels - wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, - the limitation is 2,880 pixels in height and 2,880 pixels in width. - If, for example, you zoom in on a large movie clip with a filter applied, the filter is - turned off if the resulting image exceeds the maximum dimensions.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.DisplayObject.filters -
-flash.display.DisplayObject.cacheAsBitmap -
-flash.display.BitmapData.applyFilter() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  blurX : Number -
- The amount of horizontal blur.
-		BlurFilter
  blurY : Number -
- The amount of vertical blur.
-		BlurFilter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : int -
- The number of times to perform the blur.
-		BlurFilter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-BlurFilter(blurX:Number = 4.0, blurY:Number = 4.0, quality:int = 1)
-
- Initializes the filter with the specified parameters.
-		BlurFilter
   -
-clone():BitmapFilter -
-
- Returns a copy of this filter object.
-		BlurFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
blurXproperty
-
-blurX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of horizontal blur. Valid values are from 0 to 255 (floating point). The - default value is 4. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized - to render more quickly than other values. -

Implementation -
-    public function get blurX():Number -
-    public function set blurX(value:Number):void -
-
- - - - - -
blurYproperty 
-
-blurY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of vertical blur. Valid values are from 0 to 255 (floating point). The - default value is 4. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized - to render more quickly than other values. - -

Implementation -
-    public function get blurY():Number -
-    public function set blurY(value:Number):void -
-
- - - - - -
qualityproperty 
-
-quality:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of times to perform the blur. The default value is BitmapFilterQuality.LOW, - which is equivalent to applying the filter once. The value BitmapFilterQuality.MEDIUM - applies the filter twice; the value BitmapFilterQuality.HIGH applies it three times - and approximates a Gaussian blur. Filters with lower values are rendered more quickly. -

For most applications, a quality value of low, medium, or high is sufficient. - Although you can use additional numeric values up to 15 to increase the number of times the blur - is applied, - higher values are rendered more slowly. Instead of increasing the value of quality, - you can often get a similar effect, and with faster rendering, by simply increasing the values - of the blurX and blurY properties.

- -

You can use the following BitmapFilterQuality constants to specify values of the - quality property:

-
    -
  • BitmapFilterQuality.LOW
    • -
  • BitmapFilterQuality.MEDIUM
    • -
  • BitmapFilterQuality.HIGH
    • -
- Implementation -
-    public function get quality():int -
-    public function set quality(value:int):void -
-
- -
Constructor detail
- - - - - -
BlurFilter()constructor
-
-public function BlurFilter(blurX:Number = 4.0, blurY:Number = 4.0, quality:int = 1) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Initializes the filter with the specified parameters. - The default values create a soft, unfocused image. -

Parameters - - - - - - - - - - - - - - - - -
blurX:Number (default = 4.0) — The amount to blur horizontally. Valid values are from 0 to 255.0 (floating-point - value). -
 
blurY:Number (default = 4.0) — The amount to blur vertically. Valid values are from 0 to 255.0 (floating-point - value). -
 
quality:int (default = 1) — The number of times to apply the filter. You can specify the quality using - the BitmapFilterQuality constants: -
    -
  • flash.filters.BitmapFilterQuality.LOW
    • -
  • flash.filters.BitmapFilterQuality.MEDIUM
    • -
  • flash.filters.BitmapFilterQuality.HIGH
    • -
-

High quality approximates a Gaussian blur. - For most applications, these three values are sufficient. - Although you can use additional numeric values up to 15 to achieve different effects, be aware - that higher values are rendered more slowly.

-
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():BitmapFilter -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a copy of this filter object. -

-Returns - - - - -
BitmapFilter — - A new BlurFilter instance with all the same - properties as the original BlurFilter instance. - - -
-
- -
Examples
-
examples\BlurFilterExample
-
The following example creates a dark yellow square and applies a Gaussian-style blur filter - to it. The general workflow for this example is as follows: -
    -
  1. Import the required classes.
    2. -
  2. Declare three properties used in the draw() function, which draws the object - to which the blur filter is applied.
    3. -
  3. Create the BlurFilterExample() constructor function, which does the following: -
      -
    • Calls the draw() function, which is declared later.
      • -
    • Declares a filter variable as a BitmapFilter object - and assigns it to the return of a call to getBitmapFilter().
      • -
    • Creates a new Array object myFilters and adds filter to - the array, and assigns myFilters to the filters property of - the BlurFilterExample object. This applies all filters found in myFilters, which in this case - is only filter.
      • -
    -
    4. -
  4. Create the getBitmapFilter() function to create and set properties for the filter.
    5. -
  5. Create the draw() function. This function - uses methods of the Graphics class, accessed through the graphics property - of the Sprite class, to draw the square.
    6. - -
-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.filters.BitmapFilter;
-    import flash.filters.BitmapFilterQuality;
-    import flash.filters.BlurFilter;
-
-    public class BlurFilterExample extends Sprite {
-        private var bgColor:uint = 0xFFCC00;
-        private var size:uint    = 80;
-        private var offset:uint  = 50;
-
-        public function BlurFilterExample() {
-            draw();
-            var filter:BitmapFilter = getBitmapFilter();
-            var myFilters:Array = new Array();
-            myFilters.push(filter);
-            filters = myFilters;
-        }
-
-        private function getBitmapFilter():BitmapFilter {
-            var blurX:Number = 30;
-            var blurY:Number = 30;
-            return new BlurFilter(blurX, blurY, BitmapFilterQuality.HIGH);
-        }
-
-        private function draw():void {
-            graphics.beginFill(bgColor);
-            graphics.drawRect(offset, offset, size, size);
-            graphics.endFill();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/ColorMatrixFilter.html b/html-docs/flash/filters/ColorMatrixFilter.html deleted file mode 100644 index aae42f6..0000000 --- a/html-docs/flash/filters/ColorMatrixFilter.html +++ /dev/null @@ -1,516 +0,0 @@ - - - - - - - - -flash.filters.ColorMatrixFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class ColorMatrixFilter
InheritanceColorMatrixFilter Inheritance BitmapFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The ColorMatrixFilter class lets you apply a 4 x 5 matrix transformation on the RGBA color and alpha values -of every pixel in the input image to produce a result with a new set of RGBA color and alpha values. -It allows saturation changes, hue rotation, luminance to alpha, and various other effects. -You can apply the filter to any display object (that is, objects that inherit from the DisplayObject class), -such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects. - -

Note: For RGBA values, the most significant byte represents the red channel value, -followed by green, blue, and then alpha.

-

To create a new color matrix filter, use the syntax new ColorMatrixFilter(). -The use of filters depends on the object to which you apply the filter:

-
  • To apply filters to movie clips, text fields, buttons, and video, use the -filters property (inherited from DisplayObject). Setting the filters -property of an object does not modify the object, and you can remove the filter by clearing the -filters property.
    • -
  • To apply filters to BitmapData objects, use the BitmapData.applyFilter() method. -Calling applyFilter() on a BitmapData object takes the source BitmapData object -and the filter object and generates a filtered image as a result.
    • -
-

If you apply a filter to a display object, the cacheAsBitmap property of the -display object is set to true. If you remove all filters, the original value of -cacheAsBitmap is restored.

-

A filter is not applied if the resulting image exceeds the maximum dimensions. -In AIR 1.5 and Flash Player 10, the maximum is 8,191 pixels in width or height, -and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an image is 8,191 pixels -wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, -the limitation is 2,880 pixels in height and 2,880 pixels in width. -For example, if you zoom in on a large movie clip with a filter applied, the -filter is turned off if the resulting image reaches the maximum dimensions.

-

-

-View the examples. -

-

-See also -

-
-flash.display.BitmapData.getPixel() -
-flash.display.BitmapData.applyFilter() -
-flash.display.DisplayObject.filters -
-flash.display.DisplayObject.cacheAsBitmap -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  matrix : Array -
- An array of 20 items for 4 x 5 color transform.
-		ColorMatrixFilter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ColorMatrixFilter(matrix:Array = null)
-
- Initializes a new ColorMatrixFilter instance with the specified parameters.
-		ColorMatrixFilter
   -
-clone():BitmapFilter -
-
- Returns a copy of this filter object.
-		ColorMatrixFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
matrixproperty
-
-matrix:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of 20 items for 4 x 5 color transform. The matrix property cannot - be changed by directly modifying its value (for example, myFilter.matrix[2] = 1;). - Instead, you must get a reference to the array, make the change to the reference, and reset the - value. -

The color matrix filter separates each source pixel into its red, green, blue, - and alpha components as srcR, srcG, srcB, srcA. To calculate the result of each of - the four channels, the value of each pixel in the image is multiplied by the values in - the transformation matrix. An offset, between -255 and 255, can optionally be added - to each result (the fifth item in each row of the matrix). The filter combines each - color component back into a single pixel and writes out the result. In the following formula, - a[0] through a[19] correspond to entries 0 through 19 in the 20-item array that is - passed to the matrix property:

- 
-	redResult   = (a[0]  * srcR) + (a[1]  * srcG) + (a[2]  * srcB) + (a[3]  * srcA) + a[4]
-	greenResult = (a[5]  * srcR) + (a[6]  * srcG) + (a[7]  * srcB) + (a[8]  * srcA) + a[9]
-	blueResult  = (a[10] * srcR) + (a[11] * srcG) + (a[12] * srcB) + (a[13] * srcA) + a[14]
-	alphaResult = (a[15] * srcR) + (a[16] * srcG) + (a[17] * srcB) + (a[18] * srcA) + a[19]
-
-

For each color value in the array, a value of 1 is equal to 100% of that channel - being sent to the output, preserving the value of the color channel.

- -

The calculations are performed on unmultiplied color values. If the input graphic consists - of premultiplied color values, those values are automatically converted into unmultiplied color - values for this operation.

-

Two optimized modes are available:

-

Alpha only. When you pass to the filter a matrix that adjusts only the alpha component, as shown here, the filter optimizes its performance:

- 
-	    1 0 0 0 0
-	    0 1 0 0 0
-	    0 0 1 0 0
-	    0 0 0 N 0  (where N is between 0.0 and 1.0)
-
-

Faster version. Available only with SSE/AltiVec accelerator-enabled processors, - such as Intel® Pentium® 3 and later and Apple® G4 and later. The accelerator is used when the multiplier terms are in the range - -15.99 to 15.99 and the adder terms a[4], a[9], a[14], and a[19] are in the range -8000 to 8000.

- Implementation -
-    public function get matrix():Array -
-    public function set matrix(value:Array):void -
-
-Throws -
- - - - -
TypeError — The Array is null when being set -
-
- -
Constructor detail
- - - - - -
ColorMatrixFilter()constructor
-
-public function ColorMatrixFilter(matrix:Array = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Initializes a new ColorMatrixFilter instance with the specified parameters. -

Parameters - - - - -
matrix:Array (default = null) — An array of 20 items arranged as a 4 x 5 matrix. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():BitmapFilter -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a copy of this filter object. -

-Returns - - - - -
BitmapFilter — - A new ColorMatrixFilter instance with all of the same properties as the original - one. - - -
-
- -
Examples
-
examples\ColorMatrixFilterExample
-
The following example applies different color matrix filters to - an image file. The filter constructor calls - buildChild() four times to load and display four instances of the image. - The first call to buildChild() takes null as an argument, - applying no filter to the first instance. Each subsequent call to buildChild() - takes as an argument a function that applies a different color matrix filter to each - subsequent instance of the image. - -

The buildChild() function creates a new Loader object named - loader. For each call to buildChild(), - attach an event listener to the Loader object to listen for complete events, - which are handled by the function passed to buildChild().

- -

The applyRed(), applyGreen(), and applyBlue() - functions use different values for the matrix array to achieve different - effects.

- -

Note: For best results, use an image approximately 80 pixels in width. - The name and location of the image file should match the value you pass to the - url property. For example, the value passed to url in the example - points to an image file named "Image.jpg" that is in the same directory as your SWF file. -

-
-
-
-package {
-    import flash.display.DisplayObject;
-    import flash.display.Loader;
-    import flash.display.Sprite;
-    import flash.events.Event;
-    import flash.events.IOErrorEvent;
-    import flash.filters.ColorMatrixFilter;
-    import flash.net.URLRequest;
-
-    public class ColorMatrixFilterExample extends Sprite {
-        private var size:uint  = 140;
-        private var url:String = "Image.jpg";
-
-        public function ColorMatrixFilterExample() {
-            buildChild(null);
-            buildChild(applyRed);
-            buildChild(applyGreen);
-            buildChild(applyBlue);
-        }
-
-        private function buildChild(loadHandler:Function):void {
-            var loader:Loader = new Loader();
-            loader.x = numChildren * size;
-            loader.y = size;
-            loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            if (loadHandler != null) {
-                loader.contentLoaderInfo.addEventListener(Event.COMPLETE, loadHandler);
-            }
-
-            var request:URLRequest = new URLRequest(url);
-            loader.load(request);
-            addChild(loader);
-        }
-
-        private function applyRed(event:Event):void {
-            var child:DisplayObject = DisplayObject(event.target.loader);
-            var matrix:Array = new Array();
-            matrix = matrix.concat([1, 0, 0, 0, 0]); // red
-            matrix = matrix.concat([0, 0, 0, 0, 0]); // green
-            matrix = matrix.concat([0, 0, 0, 0, 0]); // blue
-            matrix = matrix.concat([0, 0, 0, 1, 0]); // alpha
-
-            applyFilter(child, matrix);
-        }
-
-        private function applyGreen(event:Event):void {
-            var child:DisplayObject = DisplayObject(event.target.loader);
-            var matrix:Array = new Array();
-            matrix = matrix.concat([0, 0, 0, 0, 0]); // red
-            matrix = matrix.concat([0, 1, 0, 0, 0]); // green
-            matrix = matrix.concat([0, 0, 0, 0, 0]); // blue
-            matrix = matrix.concat([0, 0, 0, 1, 0]); // alpha
-
-            applyFilter(child, matrix);
-        }
-
-        private function applyBlue(event:Event):void {
-            var child:DisplayObject = DisplayObject(event.target.loader);
-            var matrix:Array = new Array();
-            matrix = matrix.concat([0, 0, 0, 0, 0]); // red
-            matrix = matrix.concat([0, 0, 0, 0, 0]); // green
-            matrix = matrix.concat([0, 0, 1, 0, 0]); // blue
-            matrix = matrix.concat([0, 0, 0, 1, 0]); // alpha
-
-            applyFilter(child, matrix);
-        }
-
-        private function applyFilter(child:DisplayObject, matrix:Array):void {
-            var filter:ColorMatrixFilter = new ColorMatrixFilter(matrix);
-            var filters:Array = new Array();
-            filters.push(filter);
-            child.filters = filters;
-        }
-        
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("Unable to load image: " + url);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/ConvolutionFilter.html b/html-docs/flash/filters/ConvolutionFilter.html deleted file mode 100644 index 3120d99..0000000 --- a/html-docs/flash/filters/ConvolutionFilter.html +++ /dev/null @@ -1,953 +0,0 @@ - - - - - - - - -flash.filters.ConvolutionFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic class ConvolutionFilter
InheritanceConvolutionFilter Inheritance BitmapFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The ConvolutionFilter class applies a matrix convolution filter effect. A convolution combines pixels -in the input image with neighboring pixels to produce an image. A wide variety of image -effects can be achieved through convolutions, including blurring, edge detection, sharpening, -embossing, and beveling. You can apply the filter to any display object (that is, objects that -inherit from the DisplayObject class), -such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects. -

To create a convolution filter, use the syntax new ConvolutionFilter(). -The use of filters depends on the object to which you apply the filter:

-
  • To apply filters to movie clips, text fields, buttons, and video, use the -filters property (inherited from DisplayObject). Setting the filters -property of an object does not modify the object, and you can remove the filter by clearing the -filters property.
    • - -
  • To apply filters to BitmapData objects, use the BitmapData.applyFilter() method. -Calling applyFilter() on a BitmapData object takes the source BitmapData object -and the filter object and generates a filtered image as a result.
    • -
- -

If you apply a filter to a display object, the value of the cacheAsBitmap property of the -object is set to true. If you clear all filters, the original value of -cacheAsBitmap is restored.

-

A filter is not applied if the resulting image exceeds the maximum dimensions. -In AIR 1.5 and Flash Player 10, the maximum is 8,191 pixels in width or height, -and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an image is 8,191 pixels -wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, -the limitation is 2,880 pixels in height and 2,880 pixels in width. -For example, if you zoom in on a large movie clip with a filter applied, the filter is -turned off if the resulting image exceeds maximum dimensions.

-

-

-View the examples. -

-

-See also -

-
-flash.display.BitmapData.applyFilter() -
-flash.display.DisplayObject.filters -
-flash.display.DisplayObject.cacheAsBitmap -
-matrix -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  alpha : Number -
- The alpha transparency value of the substitute color.
-		ConvolutionFilter
  bias : Number -
- The amount of bias to add to the result of the matrix transformation.
-		ConvolutionFilter
  clamp : Boolean -
- Indicates whether the image should be clamped.
-		ConvolutionFilter
  color : uint -
- The hexadecimal color to substitute for pixels that are off the source image.
-		ConvolutionFilter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  divisor : Number -
- The divisor used during matrix transformation.
-		ConvolutionFilter
  matrix : Array -
- An array of values used for matrix transformation.
-		ConvolutionFilter
  matrixX : Number -
- The x dimension of the matrix (the number of columns in the matrix).
-		ConvolutionFilter
  matrixY : Number -
- The y dimension of the matrix (the number of rows in the matrix).
-		ConvolutionFilter
  preserveAlpha : Boolean -
- Indicates if the alpha channel is preserved without the filter effect - or if the convolution filter is applied - to the alpha channel as well as the color channels.
-		ConvolutionFilter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ConvolutionFilter(matrixX:Number = 0, matrixY:Number = 0, matrix:Array = null, divisor:Number = 1.0, bias:Number = 0.0, preserveAlpha:Boolean = true, clamp:Boolean = true, color:uint = 0, alpha:Number = 0.0)
-
- Initializes a ConvolutionFilter instance with the specified parameters.
-		ConvolutionFilter
   -
-clone():BitmapFilter -
-
- Returns a copy of this filter object.
-		ConvolutionFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alphaproperty
-
-alpha:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The alpha transparency value of the substitute color. Valid values are 0 to 1.0. The default is 0. For example, - .25 sets a transparency value of 25%. -

Implementation -
-    public function get alpha():Number -
-    public function set alpha(value:Number):void -
-
- - - - - -
biasproperty 
-
-bias:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of bias to add to the result of the matrix transformation. - The bias increases the color value of each channel, so that dark colors - appear brighter. The default value is 0. - -

Implementation -
-    public function get bias():Number -
-    public function set bias(value:Number):void -
-
- - - - - -
clampproperty 
-
-clamp:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether the image should be clamped. For pixels off the source image, a value of - true indicates that the input - image is extended along each of its borders as necessary by duplicating the color values at each - respective edge of the input image. A value of false indicates that another color should - be used, as specified in the color and alpha properties. - The default is true. - -

Implementation -
-    public function get clamp():Boolean -
-    public function set clamp(value:Boolean):void -
-
-Example -
The following example creates two boxes using the BitmapData class, one of which is half the size of the other. - When the example first loads, the larger box is drawn inside mc using the attachBitmap(). - When mc is clicked and the applyFilter() method is called, the largeBox instance of BitmapData is redrawn with smallBox as a source bitmap. - Since applyFilter() draws smallBox over a Rectangle whose width and height is specified as those of largeBox, the source bitmap is smaller than the drawing area. - The clamp property of ConvolutionFilter in this case is set to false and the area which is not covered by the source bitmap, smallBox, is a solid red as determined by the clampColor and clampAlpha variables. -
-
- package {
-    import flash.display.Sprite;
-    import flash.display.BitmapData;
-	import flash.filters.ConvolutionFilter;
-    import flash.text.TextField;
-	import flash.geom.Rectangle;
-	import flash.geom.Point;
-
-    public class ConvolutionClampExample extends Sprite {
-		// Variables that affect clamping:
-		var clamp:Boolean = false;
-		var clampColor:Number = 0xFF0000;
-		var clampAlpha:Number = 1;
-		
-		// For illustration, keep other ConvolutionFilter variables neutral:
-		var bias:Number = 0;
-		var preserveAlpha:Boolean = false;
-		// Also, construct a neutral matrix
-		var matrixCols:Number = 3;
-		var matrixRows:Number = 3;
-		var matrix:Array = [ 1,1,1,
-							 1,1,1,
-							 1,1,1 ];
-		
-		var filter:ConvolutionFilter = new ConvolutionFilter(matrixCols, matrixRows, matrix, matrix.length, bias, preserveAlpha, clamp, clampColor, clampAlpha);
-		
-		var largeBoxWidth:Number = 100;
-		var largeBoxHeight:Number = 100;
-		var largeBox:BitmapData = new BitmapData(largeBoxWidth, largeBoxWidth, true, 0xCC00FF00);
-		var smallBoxWidth:Number = largeBoxWidth / 2;
-		var smallBoxHeight:Number = largeBoxHeight / 2;
-		var smallBox:BitmapData = new BitmapData(smallBoxWidth, smallBoxWidth, true, 0xCC0000FF);
-			
-		var mc:MovieClip = this.createEmptyMovieClip("mc", this.getNextHighestDepth());
-		mc.attachBitmap(largeBox, this.getNextHighestDepth());
-		
-		mc.onPress = function() {
-			largeBox.applyFilter(smallBox,
-								 new Rectangle(0,0, largeBoxWidth, largeBoxHeight),
-								 new Point(0,0),
-								 filter);
-		}
-	}
-}
-
-

-
- - - - - -
colorproperty 
-
-color:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The hexadecimal color to substitute for pixels that are off the source image. - It is an RGB value with no alpha component. The default is 0. - -

Implementation -
-    public function get color():uint -
-    public function set color(value:uint):void -
-
- - - - - -
divisorproperty 
-
-divisor:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The divisor used during matrix transformation. The default value is 1. - A divisor that is the sum of all the matrix values smooths out the overall color intensity of the - result. A value of 0 is ignored and the default is used instead. - -

Implementation -
-    public function get divisor():Number -
-    public function set divisor(value:Number):void -
-
- - - - - -
matrixproperty 
-
-matrix:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of values used for matrix transformation. The number of items - in the array must equal matrixX * matrixY. -

A matrix convolution is based on an n x m matrix, which describes how a given pixel value in the - input image is combined with its neighboring pixel values to produce a resulting pixel value. Each - result pixel is determined by applying the matrix to the corresponding source pixel and its - neighboring pixels.

-

For a 3 x 3 matrix convolution, the following formula is used for each independent color channel: - 


-	dst (x, y) = ((src (x-1, y-1) * a0 + src(x, y-1) * a1....
-	                  src(x, y+1) * a7 + src (x+1,y+1) * a8) / divisor) + bias
-
-

-

Certain filter specifications perform faster when run by a processor - that offers SSE (Streaming SIMD Extensions). The following are criteria - for faster convolution operations:

-
    -
  • The filter must be a 3x3 filter.
    • -
  • All the filter terms must be integers between -127 and +127.
    • -
  • The sum of all the filter terms must not have an absolute value greater than 127.
    • -
  • If any filter term is negative, the divisor must be between 2.00001 and 256.
    • -
  • If all filter terms are positive, the divisor must be between 1.1 and 256.
    • -
  • The bias must be an integer.
    • -
-

Note: If you create a ConvolutionFilter instance using the - constructor without parameters, the order you assign values to matrix properties affects - the behavior of the filter. In the following case, the matrix array is assigned while the - matrixX and matrixY properties are still set to 0 - (the default value):

- 
-    public var myfilter:ConvolutionFilter = new ConvolutionFilter();
-    myfilter.matrix = [0, 0, 0, 0, 1, 0, 0, 0, 0];
-    myfilter.matrixX = 3;
-    myfilter.matrixY = 3;
-
-

In the following case, the matrix array is assigned while the matrixX - and matrixY properties are set to 3:

- 
-    public var myfilter:ConvolutionFilter = new ConvolutionFilter();
-    myfilter.matrixX = 3;
-    myfilter.matrixY = 3;
-    myfilter.matrix = [0, 0, 0, 0, 1, 0, 0, 0, 0];
-
- Implementation -
-    public function get matrix():Array -
-    public function set matrix(value:Array):void -
-
-Throws -
- - - - -
TypeError — The Array is null when being set -
-
- - - - - -
matrixXproperty 
-
-matrixX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The x dimension of the matrix (the number of columns in the matrix). The default - value is 0. - -

Implementation -
-    public function get matrixX():Number -
-    public function set matrixX(value:Number):void -
-
- - - - - -
matrixYproperty 
-
-matrixY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The y dimension of the matrix (the number of rows in the matrix). The default value - is 0. - -

Implementation -
-    public function get matrixY():Number -
-    public function set matrixY(value:Number):void -
-
- - - - - -
preserveAlphaproperty 
-
-preserveAlpha:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates if the alpha channel is preserved without the filter effect - or if the convolution filter is applied - to the alpha channel as well as the color channels. - A value of false indicates that the - convolution applies to all channels, including the - alpha channel. A value of true indicates that the convolution applies only to the - color channels. The default value is true. -

Implementation -
-    public function get preserveAlpha():Boolean -
-    public function set preserveAlpha(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
ConvolutionFilter()constructor
-
-public function ConvolutionFilter(matrixX:Number = 0, matrixY:Number = 0, matrix:Array = null, divisor:Number = 1.0, bias:Number = 0.0, preserveAlpha:Boolean = true, clamp:Boolean = true, color:uint = 0, alpha:Number = 0.0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Initializes a ConvolutionFilter instance with the specified parameters. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
matrixX:Number (default = 0) — The x dimension of the matrix (the number of columns in the matrix). The - default value is 0. -
 
matrixY:Number (default = 0) — The y dimension of the matrix (the number of rows in the matrix). The - default value is 0. -
 
matrix:Array (default = null) — The array of values used for matrix transformation. The number of - items in the array must equal matrixX * matrixY. -
 
divisor:Number (default = 1.0) — The divisor used during matrix transformation. The default value is 1. - A divisor that is the sum of all the matrix values evens out the overall color intensity of the - result. A value of 0 is ignored and the default is used instead. -
 
bias:Number (default = 0.0) — The bias to add to the result of the matrix transformation. The default value is 0. -
 
preserveAlpha:Boolean (default = true) — A value of false indicates that the alpha value is not - preserved and that the convolution applies to all - channels, including the alpha channel. A value of true indicates that - the convolution applies only to the color channels. The default value is true. -
 
clamp:Boolean (default = true) — For pixels that are off the source image, a value of true indicates that the - input image is extended along each of its borders as necessary by duplicating the color values - at the given edge of the input image. A value of false indicates that another - color should be used, as specified in the color and alpha properties. - The default is true. -
 
color:uint (default = 0) — The hexadecimal color to substitute for pixels that are off the source image. -
 
alpha:Number (default = 0.0) — The alpha of the substitute color. -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():BitmapFilter -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a copy of this filter object. - -

-Returns - - - - -
BitmapFilter — - BitmapFilter A new ConvolutionFilter instance with all the same properties as the original - ConvolutionMatrixFilter instance. - - -
-
- -
Examples
-
examples\ConvolutionFilterExample
-
The following example applies different convolution filters to - an image file. The filter constructor calls - buildChild() four times to load and display four instances of the image. - Each call to buildChild() takes as an argument a function that applies - no filter to the first instance and a different convolution filter to each - subsequent instance. - -

The buildChild() function creates a new Loader object named - loader. For each call to buildChild(), - attach an event listener to the Loader object to listen for complete events, - which are handled by the function passed to buildChild().

- -

The applyBrightness(), applySharpness(), and applyOutline() - functions use different values for the matrix array to achieve different - ConvolutionFilter effects.

- -

Note: For best results, use an image approximately 80 pixels in width. - The name and location of the image file should match the value you pass to the - url property. For example, the value passed to url in the example - points to an image file named "Image.jpg" that is in the same directory as your SWF file. -

- -
-
-
-package {
-    import flash.display.DisplayObject;
-    import flash.display.Loader;
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.filters.BitmapFilter;
-    import flash.filters.ConvolutionFilter;
-    import flash.net.URLRequest;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-
-    public class ConvolutionFilterExample extends Sprite {
-        private var size:uint = 140;
-        private var url:String = "Image.jpg";
-
-        public function ConvolutionFilterExample() {
-            buildChild(applyNothing);
-            buildChild(applyBrightness);
-            buildChild(applySharpness);
-            buildChild(applyOutline);
-        }
-
-        private function buildChild(loadHandler:Function):void {
-            var loader:Loader = new Loader();
-            loader.x = numChildren * size;
-            loader.y = size;
-            loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            if(loadHandler != null) {
-                loader.contentLoaderInfo.addEventListener(Event.COMPLETE, loadHandler);
-            }
-
-            var request:URLRequest = new URLRequest(url);
-            loader.load(request);
-            addChild(loader);
-        }
-
-        private function applyNothing(event:Event):void {
-            var child:DisplayObject = DisplayObject(event.target.loader);
-            applyLabel(child, "no filter");
-        }
-
-        private function applyBrightness(event:Event):void {
-            var child:DisplayObject = DisplayObject(event.target.loader);
-            var matrix:Array = [5, 5, 5,
-                                5, 0, 5,
-                                5, 5, 5];
-            applyFilter(child, matrix);
-            applyLabel(child, "brightness");
-        }
-
-        private function applySharpness(event:Event):void {
-            var child:DisplayObject = DisplayObject(event.target.loader);
-            var matrix:Array = [0, -1, 0,
-                               -1, 20, -1,
-                                0, -1, 0];
-            applyFilter(child, matrix);
-            applyLabel(child, "sharpness");
-        }
-
-        private function applyOutline(event:Event):void {
-            var child:DisplayObject = DisplayObject(event.target.loader);
-            var matrix:Array = [-30, 30, 0,
-                                -30, 30, 0,
-                                -30, 30, 0];
-            applyFilter(child, matrix);
-            applyLabel(child, "outline");
-        }
-
-        private function applyFilter(child:DisplayObject, matrix:Array):void {
-            var matrixX:Number = 3;
-            var matrixY:Number = 3;
-            var divisor:Number = 9;
-            var filter:BitmapFilter = new ConvolutionFilter(matrixX, matrixY, matrix, divisor);
-            var filters:Array = new Array();
-            filters.push(filter);
-            child.filters = filters;
-        }
-
-        private function applyLabel(child:DisplayObject, label:String):void {
-            var tf:TextField = new TextField();
-            tf.x = child.x;
-            tf.y = child.height;
-            tf.autoSize = TextFieldAutoSize.LEFT;
-            tf.text = label;
-            addChild(tf);
-        }
-
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("Unable to load image: " + url);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/DisplacementMapFilter.html b/html-docs/flash/filters/DisplacementMapFilter.html deleted file mode 100644 index ced23ee..0000000 --- a/html-docs/flash/filters/DisplacementMapFilter.html +++ /dev/null @@ -1,930 +0,0 @@ - - - - - - - - -flash.filters.DisplacementMapFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class DisplacementMapFilter
InheritanceDisplacementMapFilter Inheritance BitmapFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The DisplacementMapFilter class uses the pixel values from the specified BitmapData object -(called the displacement map image) to perform a displacement of an object. -You can use this filter to apply a warped -or mottled effect to any object that inherits from the DisplayObject class, -such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects. - -

The use of filters depends on the object to which you apply the filter:

-
  • To apply filters to a display object, use the -filters property of the display object. Setting the filters -property of an object does not modify the object, and you can remove the filter by clearing the -filters property.
    • - -
  • To apply filters to BitmapData objects, use the BitmapData.applyFilter() method. -Calling applyFilter() on a BitmapData object takes the source BitmapData object -and the filter object and generates a filtered image.
    • -
- -

If you apply a filter to a display object, the value of the cacheAsBitmap property of the -display object is set to true. If you clear all filters, the original value of -cacheAsBitmap is restored.

-

The filter uses the following formula:

- -
-dstPixel[x, y] = srcPixel[x + ((componentX(x, y) - 128) * scaleX) / 256, y + ((componentY(x, y) - 128) *scaleY) / 256)
-
- -

where componentX(x, y) gets the componentX property color value -from the mapBitmap property at (x - mapPoint.x ,y - mapPoint.y).

-

The map image used by the filter is scaled to match the Stage scaling. -It is not scaled when the object itself is scaled.

- -

This filter supports Stage scaling. However, general scaling, rotation, and -skewing are not supported. If the object itself is scaled (if the scaleX -and scaleY properties are set to a value other than 1.0), -the filter effect is not scaled. It is scaled only when the user zooms in on the Stage.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.BitmapData.applyFilter() -
-flash.display.DisplayObject.filters -
-flash.display.DisplayObject.cacheAsBitmap -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  alpha : Number -
- Specifies the alpha transparency value to use for out-of-bounds displacements.
-		DisplacementMapFilter
  color : uint -
- Specifies what color to use for out-of-bounds displacements.
-		DisplacementMapFilter
  componentX : uint -
- Describes which color channel to use in the map image to displace the x result.
-		DisplacementMapFilter
  componentY : uint -
- Describes which color channel to use in the map image to displace the y result.
-		DisplacementMapFilter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  mapBitmap : BitmapData -
- A BitmapData object containing the displacement map data.
-		DisplacementMapFilter
  mapPoint : Point -
- A value that contains the offset of the upper-left corner of - the target display object from the upper-left corner of the map image.
-		DisplacementMapFilter
  mode : String -
- The mode for the filter.
-		DisplacementMapFilter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  scaleX : Number -
- The multiplier to use to scale the x displacement result from the map calculation.
-		DisplacementMapFilter
  scaleY : Number -
- The multiplier to use to scale the y displacement result from the map calculation.
-		DisplacementMapFilter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DisplacementMapFilter(mapBitmap:BitmapData = null, mapPoint:Point = null, componentX:uint = 0, componentY:uint = 0, scaleX:Number = 0.0, scaleY:Number = 0.0, mode:String = "wrap", color:uint = 0, alpha:Number = 0.0)
-
- Initializes a DisplacementMapFilter instance with the specified parameters.
-		DisplacementMapFilter
   -
-clone():BitmapFilter -
-
- Returns a copy of this filter object.
-		DisplacementMapFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alphaproperty
-
-alpha:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies the alpha transparency value to use for out-of-bounds displacements. - It is specified as a normalized value from 0.0 to 1.0. For example, - .25 sets a transparency value of 25%. The default value is 0. - Use this property if the mode property is set to DisplacementMapFilterMode.COLOR. -

Implementation -
-    public function get alpha():Number -
-    public function set alpha(value:Number):void -
-
- - - - - -
colorproperty 
-
-color:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies what color to use for out-of-bounds displacements. The valid range of - displacements is 0.0 to 1.0. Values are in hexadecimal format. The default value - for color is 0. Use this property if the mode property - is set to DisplacementMapFilterMode.COLOR. -

Implementation -
-    public function get color():uint -
-    public function set color(value:uint):void -
-
- - - - - -
componentXproperty 
-
-componentX:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Describes which color channel to use in the map image to displace the x result. - Possible values are BitmapDataChannel constants: -

    -
  • BitmapDataChannel.ALPHA
    • -
  • BitmapDataChannel.BLUE
    • -
  • BitmapDataChannel.GREEN
    • -
  • BitmapDataChannel.RED
    • -
- -

Implementation -
-    public function get componentX():uint -
-    public function set componentX(value:uint):void -
-

-See also -

-
-flash.display.BitmapDataChannel -
-
- - - - - -
componentYproperty 
-
-componentY:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Describes which color channel to use in the map image to displace the y result. - Possible values are BitmapDataChannel constants: -

    -
  • BitmapDataChannel.ALPHA
    • -
  • BitmapDataChannel.BLUE
    • -
  • BitmapDataChannel.GREEN
    • -
  • BitmapDataChannel.RED
    • -
-

Implementation -
-    public function get componentY():uint -
-    public function set componentY(value:uint):void -
-

-See also -

-
-flash.display.BitmapDataChannel -
-
- - - - - -
mapBitmapproperty 
-
-mapBitmap:BitmapData  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A BitmapData object containing the displacement map data. - -

Implementation -
-    public function get mapBitmap():BitmapData -
-    public function set mapBitmap(value:BitmapData):void -
-
-Throws -
- - - - -
TypeError — The BitmapData is null when being set -
-

-See also -

-
-flash.display.BitmapData -
-
- - - - - -
mapPointproperty 
-
-mapPoint:Point  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A value that contains the offset of the upper-left corner of - the target display object from the upper-left corner of the map image. -

Implementation -
-    public function get mapPoint():Point -
-    public function set mapPoint(value:Point):void -
-
-Throws -
- - - - -
TypeError — The Point is null when being set -
-

-See also -

-
-flash.geom.Point -
-
- - - - - -
modeproperty 
-
-mode:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The mode for the filter. Possible values are DisplacementMapFilterMode - constants: -

    -
  • DisplacementMapFilterMode.WRAP — Wraps the displacement value to the other side of the source image.
    • -
  • DisplacementMapFilterMode.CLAMP — Clamps the displacement value to the edge of the source image.
    • -
  • DisplacementMapFilterMode.IGNORE — If the displacement value is out of range, ignores the displacement and uses the source pixel.
    • -
  • DisplacementMapFilterMode.COLOR — If the displacement value is outside the image, substitutes the values in the color and alpha properties.
    • -
- -

Implementation -
-    public function get mode():String -
-    public function set mode(value:String):void -
-
-Throws -
- - - - - - - - - - -
TypeError — The String is null when being set -
 
ArgumentError — The mode string is not one of the valid types -
-

-See also -

-
-flash.filters.DisplacementMapFilterMode -
-
- - - - - -
scaleXproperty 
-
-scaleX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The multiplier to use to scale the x displacement result from the map calculation. -

Implementation -
-    public function get scaleX():Number -
-    public function set scaleX(value:Number):void -
-
- - - - - -
scaleYproperty 
-
-scaleY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The multiplier to use to scale the y displacement result from the map calculation. -

Implementation -
-    public function get scaleY():Number -
-    public function set scaleY(value:Number):void -
-
- -
Constructor detail
- - - - - -
DisplacementMapFilter()constructor
-
-public function DisplacementMapFilter(mapBitmap:BitmapData = null, mapPoint:Point = null, componentX:uint = 0, componentY:uint = 0, scaleX:Number = 0.0, scaleY:Number = 0.0, mode:String = "wrap", color:uint = 0, alpha:Number = 0.0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Initializes a DisplacementMapFilter instance with the specified parameters. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
mapBitmap:BitmapData (default = null) — A BitmapData object containing the displacement map data. -
 
mapPoint:Point (default = null) — A value that contains the offset of the upper-left corner of the - target display object from the upper-left corner of the map image. -
 
componentX:uint (default = 0) — Describes which color channel to use in the map image to displace the x result. - Possible values are the BitmapDataChannel constants. -
 
componentY:uint (default = 0) — Describes which color channel to use in the map image to displace the y result. - Possible values are the BitmapDataChannel constants. -
 
scaleX:Number (default = 0.0) — The multiplier to use to scale the x displacement result from the map calculation. -
 
scaleY:Number (default = 0.0) — The multiplier to use to scale the y displacement result from the map calculation. -
 
mode:String (default = "wrap") — The mode of the filter. Possible values are the DisplacementMapFilterMode - constants. -
 
color:uint (default = 0) — Specifies the color to use for out-of-bounds displacements. The valid range of - displacements is 0.0 to 1.0. Use this parameter if mode is set to DisplacementMapFilterMode.COLOR. -
 
alpha:Number (default = 0.0) — Specifies what alpha value to use for out-of-bounds displacements. - It is specified as a normalized value from 0.0 to 1.0. For example, - .25 sets a transparency value of 25%. - Use this parameter if mode is set to DisplacementMapFilterMode.COLOR. - -
-

-See also -

-
-flash.display.BitmapDataChannel -
-flash.filters.DisplacementMapFilterMode -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():BitmapFilter -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a copy of this filter object. -

-Returns - - - - -
BitmapFilter — - A new DisplacementMapFilter instance with all the same properties as the - original one. - - -
-
- -
Examples
-
examples\DisplacementMapFilterExample
-
The following example draws a square with a radial gradient fill, creates a text field, - creates a BitmapData object, and applies a displacement map filter to the - DisplacementMapFilterExample object. The general workflow for this example is as follows: - -
    -
  1. The class defines variables for the background color, for the text field label, - and for the size and offset that will be used in various functions.
    2. - -
  2. The constructor function calls the draw() method, - which uses the methods of the Graphics class to draw a square with a radial gradient fill. - Note that graphics is a property of the DisplacementMapFilterExample object, - which extends Sprite.
    3. - -
  3. The constructor function calls the createLabel() method, which creates a text field - displaying the value of labelText and adds it to the display list.
    4. - -
  4. The constructor function calls the createFilter() method, which does the following: -
      -
    • Creates a variable named filter for the filter object.
      • -
    • Calls the getDisplacementMapFilter() method and assigns its return value - to the filter variable.
      • -
    • Passes filter to the filters property of the - DisplacementFilterExample object (the main class).
      • -
    -
    5. - -
  5. The getBitmapFilter() method creates a BitmapData object - named mapBitmap and assigns it the results of - the createBitmapData() method. The mapBitmap object, - along with other variables, defines a new displacement map filter.
    6. - -
  6. The createBitmapData() method creates a new BitmapData object that is based on - the current contents of the DisplacementMapFilterExample object. It creates a new bitmap - based on bitmapData and adds the bitmap to the Stage.
    7. - -
-
-
-package {
-    import flash.display.Bitmap;
-    import flash.display.BitmapData;
-    import flash.display.BitmapDataChannel;
-    import flash.display.GradientType;
-    import flash.display.SpreadMethod;
-    import flash.display.Sprite;
-    import flash.filters.BitmapFilter;
-    import flash.filters.DisplacementMapFilter;
-    import flash.filters.DisplacementMapFilterMode;
-    import flash.geom.Matrix;
-    import flash.geom.Point;
-    import flash.text.TextField;
-    
-    public class DisplacementMapFilterExample extends Sprite {
-        private var bgColor:uint     = 0xFFCC00;
-        private var size:uint        = 200;
-        private var offset:uint      = 90;
-        private var labelText:String = "Watch the text bend with the displacement map";
-
-        public function DisplacementMapFilterExample() {
-            draw();
-            createLabel();
-            createFilter();
-        }
-
-        private function createFilter():void {
-            var filter:BitmapFilter = getBitmapFilter();
-            filters = new Array(filter);
-        }
-
-        private function getBitmapFilter():BitmapFilter {
-            var mapBitmap:BitmapData = createBitmapData();
-            var mapPoint:Point       = new Point(0, 0);
-            var channels:uint        = BitmapDataChannel.RED;
-            var componentX:uint      = channels;
-            var componentY:uint      = channels;
-            var scaleX:Number        = 0.5;
-            var scaleY:Number        = -30;
-            var mode:String          = DisplacementMapFilterMode.CLAMP;
-            var color:uint           = 0;
-            var alpha:Number         = 0;
-            return new DisplacementMapFilter(mapBitmap,
-                                             mapPoint,
-                                             componentX,
-                                             componentY,
-                                             scaleX,
-                                             scaleY,
-                                             mode,
-                                             color,
-                                             alpha);
-        }
-
-        private function draw():void {
-            var matrix:Matrix = new Matrix();
-            matrix.createGradientBox(size, size);
-            graphics.beginGradientFill(GradientType.RADIAL,
-                                       [0xFF0000, 0x0000FF],
-                                       [100, 100],
-                                       [55, 200],
-                                       matrix,
-                                       SpreadMethod.PAD);
-            graphics.drawRect(0, 0, size, size);
-        }
-
-        private function createBitmapData():BitmapData {
-            var bitmapData:BitmapData = new BitmapData(size, size, true, bgColor);
-            bitmapData.draw(this, new Matrix());
-            var bitmap:Bitmap = new Bitmap(bitmapData);
-            bitmap.x = size;
-            addChild(bitmap);
-            return bitmapData;
-        }
-
-        private function createLabel():void {
-            var tf:TextField = new TextField();
-            tf.text = labelText;
-            tf.y = offset;
-            tf.width = size;
-            addChild(tf);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/DisplacementMapFilterMode.html b/html-docs/flash/filters/DisplacementMapFilterMode.html deleted file mode 100644 index eebbf95..0000000 --- a/html-docs/flash/filters/DisplacementMapFilterMode.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - - - -flash.filters.DisplacementMapFilterMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class DisplacementMapFilterMode
InheritanceDisplacementMapFilterMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The DisplacementMapFilterMode class provides values for the mode property -of the DisplacementMapFilter class. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  CLAMP : String = "clamp"
[static] - Clamps the displacement value to the edge of the source image.
-		DisplacementMapFilterMode
  COLOR : String = "color"
[static] - If the displacement value is outside the image, substitutes the values in - the color and alpha properties.
-		DisplacementMapFilterMode
  IGNORE : String = "ignore"
[static] - If the displacement value is out of range, ignores the displacement and uses the source pixel.
-		DisplacementMapFilterMode
  WRAP : String = "wrap"
[static] - Wraps the displacement value to the other side of the source image.
-		DisplacementMapFilterMode
-
- -
- -
Constant detail
- - - - - -
CLAMPconstant
-
-public static const CLAMP:String = "clamp" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Clamps the displacement value to the edge of the source image. - - Use with the DisplacementMapFilter.mode property. - -

-See also -

-
-flash.filters.DisplacementMapFilter.mode -
-
- - - - - -
COLORconstant 
-
-public static const COLOR:String = "color" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- If the displacement value is outside the image, substitutes the values in - the color and alpha properties. - - Use with the DisplacementMapFilter.mode property. - -

-See also -

-
-flash.filters.DisplacementMapFilter.mode -
-
- - - - - -
IGNOREconstant 
-
-public static const IGNORE:String = "ignore" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- If the displacement value is out of range, ignores the displacement and uses the source pixel. - - Use with the DisplacementMapFilter.mode property. - -

-See also -

-
-flash.filters.DisplacementMapFilter.mode -
-
- - - - - -
WRAPconstant 
-
-public static const WRAP:String = "wrap" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Wraps the displacement value to the other side of the source image. - Use with the DisplacementMapFilter.mode property. - -

-See also -

-
-flash.filters.DisplacementMapFilter.mode -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/DropShadowFilter.html b/html-docs/flash/filters/DropShadowFilter.html deleted file mode 100644 index ad3fea7..0000000 --- a/html-docs/flash/filters/DropShadowFilter.html +++ /dev/null @@ -1,912 +0,0 @@ - - - - - - - - -flash.filters.DropShadowFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class DropShadowFilter
InheritanceDropShadowFilter Inheritance BitmapFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The DropShadowFilter class lets you add a drop shadow to display objects. -The shadow algorithm is based on the same box filter that the blur filter uses. You have -several options for the style of the drop shadow, including inner or outer shadow and knockout mode. -You can apply the filter to any display object (that is, objects that inherit from the DisplayObject class), -such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects. - -

The use of filters depends on the object to which you apply the filter:

-
  • To apply filters to display objects use the - filters property (inherited from DisplayObject). Setting the filters - property of an object does not modify the object, and you can remove the filter by clearing the - filters property.
    • - -
  • To apply filters to BitmapData objects, use the BitmapData.applyFilter() method. - Calling applyFilter() on a BitmapData object takes the source BitmapData object - and the filter object and generates a filtered image as a result.
    • -
- -

If you apply a filter to a display object, the value of the cacheAsBitmap property of the -display object is set to true. If you clear all filters, the original value of -cacheAsBitmap is restored.

-

This filter supports Stage scaling. However, it does not support general scaling, rotation, and - skewing. If the object itself is scaled (if scaleX and scaleY are - set to a value other than 1.0), the filter is not scaled. It is scaled only when - the user zooms in on the Stage.

- -

A filter is not applied if the resulting image exceeds the maximum dimensions. - In AIR 1.5 and Flash Player 10, the maximum is 8,191 pixels in width or height, - and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an image is 8,191 pixels - wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, - the limitation is 2,880 pixels in height and 2,880 pixels in width. - If, for example, you zoom in on a large movie clip with a filter applied, the filter is - turned off if the resulting image exceeds the maximum dimensions.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.BitmapData.applyFilter() -
-flash.display.DisplayObject.filters -
-flash.display.DisplayObject.cacheAsBitmap -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  alpha : Number -
- The alpha transparency value for the shadow color.
-		DropShadowFilter
  angle : Number -
- The angle of the shadow.
-		DropShadowFilter
  blurX : Number -
- The amount of horizontal blur.
-		DropShadowFilter
  blurY : Number -
- The amount of vertical blur.
-		DropShadowFilter
  color : uint -
- The color of the shadow.
-		DropShadowFilter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  distance : Number -
- The offset distance for the shadow, in pixels.
-		DropShadowFilter
  hideObject : Boolean -
- Indicates whether or not the object is hidden.
-		DropShadowFilter
  inner : Boolean -
- Indicates whether or not the shadow is an inner shadow.
-		DropShadowFilter
  knockout : Boolean -
- Applies a knockout effect (true), which effectively - makes the object's fill transparent and reveals the background color of the document.
-		DropShadowFilter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : int -
- The number of times to apply the filter.
-		DropShadowFilter
  strength : Number -
- The strength of the imprint or spread.
-		DropShadowFilter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DropShadowFilter(distance:Number = 4.0, angle:Number = 45, color:uint = 0, alpha:Number = 1.0, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1.0, quality:int = 1, inner:Boolean = false, knockout:Boolean = false, hideObject:Boolean = false)
-
- Creates a new DropShadowFilter instance with the specified parameters.
-		DropShadowFilter
   -
-clone():BitmapFilter -
-
- Returns a copy of this filter object.
-		DropShadowFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alphaproperty
-
-alpha:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The alpha transparency value for the shadow color. Valid values are 0.0 to 1.0. - For example, - .25 sets a transparency value of 25%. The default value is 1.0. - -

Implementation -
-    public function get alpha():Number -
-    public function set alpha(value:Number):void -
-
- - - - - -
angleproperty 
-
-angle:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The angle of the shadow. Valid values are 0 to 360 degrees (floating point). The - default value is 45. -

Implementation -
-    public function get angle():Number -
-    public function set angle(value:Number):void -
-
- - - - - -
blurXproperty 
-
-blurX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of horizontal blur. Valid values are 0 to 255.0 (floating point). The - default value is 4.0. - -

Implementation -
-    public function get blurX():Number -
-    public function set blurX(value:Number):void -
-
- - - - - -
blurYproperty 
-
-blurY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of vertical blur. Valid values are 0 to 255.0 (floating point). The - default value is 4.0. - -

Implementation -
-    public function get blurY():Number -
-    public function set blurY(value:Number):void -
-
- - - - - -
colorproperty 
-
-color:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The color of the shadow. Valid values are in hexadecimal format 0xRRGGBB. The - default value is 0x000000. - -

Implementation -
-    public function get color():uint -
-    public function set color(value:uint):void -
-
- - - - - -
distanceproperty 
-
-distance:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The offset distance for the shadow, in pixels. The default - value is 4.0 (floating point). -

Implementation -
-    public function get distance():Number -
-    public function set distance(value:Number):void -
-
- - - - - -
hideObjectproperty 
-
-hideObject:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether or not the object is hidden. The value true - indicates that the object itself is not drawn; only the shadow is visible. - The default is false (the object is shown). - -

Implementation -
-    public function get hideObject():Boolean -
-    public function set hideObject(value:Boolean):void -
-
- - - - - -
innerproperty 
-
-inner:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether or not the shadow is an inner shadow. The value true indicates - an inner shadow. The default is false, an outer shadow (a - shadow around the outer edges of the object). - -

Implementation -
-    public function get inner():Boolean -
-    public function set inner(value:Boolean):void -
-
- - - - - -
knockoutproperty 
-
-knockout:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Applies a knockout effect (true), which effectively - makes the object's fill transparent and reveals the background color of the document. The - default is false (no knockout). - -

Implementation -
-    public function get knockout():Boolean -
-    public function set knockout(value:Boolean):void -
-
- - - - - -
qualityproperty 
-
-quality:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of times to apply the filter. - The default value is BitmapFilterQuality.LOW, which is equivalent to applying - the filter once. The value BitmapFilterQuality.MEDIUM applies the filter twice; - the value BitmapFilterQuality.HIGH applies it three times. Filters with lower values - are rendered more quickly. -

For most applications, a quality value of low, medium, or high is sufficient. - Although you can use additional numeric values up to 15 to achieve different effects, - higher values are rendered more slowly. Instead of increasing the value of quality, - you can often get a similar effect, and with faster rendering, by simply increasing - the values of the blurX and blurY properties.

- Implementation -
-    public function get quality():int -
-    public function set quality(value:int):void -
-

-See also -

-
-flash.filters.BitmapFilterQuality -
-
- - - - - -
strengthproperty 
-
-strength:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The strength of the imprint or spread. The higher the value, - the more color is imprinted and the stronger the contrast between the shadow and the background. - Valid values are from 0 to 255.0. The default is 1.0. - -

Implementation -
-    public function get strength():Number -
-    public function set strength(value:Number):void -
-
- -
Constructor detail
- - - - - -
DropShadowFilter()constructor
-
-public function DropShadowFilter(distance:Number = 4.0, angle:Number = 45, color:uint = 0, alpha:Number = 1.0, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1.0, quality:int = 1, inner:Boolean = false, knockout:Boolean = false, hideObject:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new DropShadowFilter instance with the specified parameters. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
distance:Number (default = 4.0) — Offset distance for the shadow, in pixels. - -
 
angle:Number (default = 45) — Angle of the shadow, 0 to 360 degrees (floating point). - -
 
color:uint (default = 0) — Color of the shadow, in hexadecimal format - 0xRRGGBB. The default value is 0x000000. - -
 
alpha:Number (default = 1.0) — Alpha transparency value for the shadow color. Valid values are 0.0 to 1.0. - For example, - .25 sets a transparency value of 25%. - -
 
blurX:Number (default = 4.0) — Amount of horizontal blur. Valid values are 0 to 255.0 (floating point). - -
 
blurY:Number (default = 4.0) — Amount of vertical blur. Valid values are 0 to 255.0 (floating point). - -
 
strength:Number (default = 1.0) — The strength of the imprint or spread. The higher the value, - the more color is imprinted and the stronger the contrast between the shadow and the background. - Valid values are 0 to 255.0. - -
 
quality:int (default = 1) — The number of times to apply the filter. Use the BitmapFilterQuality constants: -
    -
  • BitmapFilterQuality.LOW
    • -
  • BitmapFilterQuality.MEDIUM
    • -
  • BitmapFilterQuality.HIGH
    • -
-

For more information about these values, see the quality property description.

-
 
inner:Boolean (default = false) — Indicates whether or not the shadow is an inner shadow. A value of true specifies - an inner shadow. A value of false specifies an outer shadow (a - shadow around the outer edges of the object). - -
 
knockout:Boolean (default = false) — Applies a knockout effect (true), which effectively - makes the object's fill transparent and reveals the background color of the document. - -
 
hideObject:Boolean (default = false) — Indicates whether or not the object is hidden. A value of true - indicates that the object itself is not drawn; only the shadow is visible. - -
-

-See also -

-
-flash.filters.BitmapFilterQuality -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():BitmapFilter -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a copy of this filter object. -

-Returns - - - - -
BitmapFilter — - A new DropShadowFilter instance with all the - properties of the original DropShadowFilter instance. - - -
-
- -
Examples
-
examples\DropShadowFilterExample
-
The following example creates a yellow square and applies a drop shadow to it. - The general workflow of this example is as follows: -
    -
  1. Declare three properties that are used to draw the square to which the - filter is applied.
    2. -
  2. Create the constructor function. The constructor calls the draw() method, - which uses methods of the Graphics class accessed through the graphics - property of Sprite to draw an orange square.
    3. -
  3. In the constructor, declare a variable filter as a BitmapFilter object - and assign it to the return value of a call to getBitmapFilter(). - The getBitmapFilter() method defines the drop shadow filter used.
    4. -
  4. Create a new Array object myFilters and add filter to - the array. Assign the myFilters array to the filters property of - the DropShadowFilterExample object. This applies all filters found in myFilters, which in this case - is only filter.
    5. -
-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.Event;
-    import flash.events.MouseEvent;
-    import flash.filters.BitmapFilter;
-    import flash.filters.BitmapFilterQuality;
-    import flash.filters.DropShadowFilter;
-
-    public class DropShadowFilterExample extends Sprite {
-        private var bgColor:uint = 0xFFCC00;
-        private var size:uint    = 80;
-        private var offset:uint  = 50;
-
-        public function DropShadowFilterExample() {
-            draw();
-            var filter:BitmapFilter = getBitmapFilter();
-            var myFilters:Array = new Array();
-            myFilters.push(filter);
-            filters = myFilters;
-        }
-
-        private function getBitmapFilter():BitmapFilter {
-            var color:Number = 0x000000;
-            var angle:Number = 45;
-            var alpha:Number = 0.8;
-            var blurX:Number = 8;
-            var blurY:Number = 8;
-            var distance:Number = 15;
-            var strength:Number = 0.65;
-            var inner:Boolean = false;
-            var knockout:Boolean = false;
-            var quality:Number = BitmapFilterQuality.HIGH;
-            return new DropShadowFilter(distance,
-                                        angle,
-                                        color,
-                                        alpha,
-                                        blurX,
-                                        blurY,
-                                        strength,
-                                        quality,
-                                        inner,
-                                        knockout);
-        }
-
-        private function draw():void {
-            graphics.beginFill(bgColor);
-            graphics.drawRect(offset, offset, size, size);
-            graphics.endFill();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/GlowFilter.html b/html-docs/flash/filters/GlowFilter.html deleted file mode 100644 index 60ab5c8..0000000 --- a/html-docs/flash/filters/GlowFilter.html +++ /dev/null @@ -1,798 +0,0 @@ - - - - - - - - -flash.filters.GlowFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class GlowFilter
InheritanceGlowFilter Inheritance BitmapFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The GlowFilter class lets you apply a glow effect to display objects. - You have several options for the style of the - glow, including inner or outer glow and knockout mode. - The glow filter is similar to the drop shadow filter with the distance - and angle properties of the drop shadow filter set to 0. - You can apply the filter to any display object (that is, objects that inherit from the DisplayObject class), - such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects. -

The use of filters depends on the object to which you apply the filter:

-
  • To apply filters to display objects, use the - filters property (inherited from DisplayObject). Setting the filters - property of an object does not modify the object, and you can remove the filter by clearing the - filters property.
    • - -
  • To apply filters to BitmapData objects, use the BitmapData.applyFilter() method. - Calling applyFilter() on a BitmapData object takes the source BitmapData object - and the filter object and generates a filtered image as a result.
    • -
- - -

If you apply a filter to a display object, the cacheAsBitmap property of the -display object is set to true. If you clear all filters, the original value of -cacheAsBitmap is restored.

-

This filter supports Stage scaling. However, it does not support general scaling, rotation, and - skewing. If the object itself is scaled (if scaleX and scaleY are - set to a value other than 1.0), the filter is not scaled. It is scaled only when the user zooms - in on the Stage.

- -

A filter is not applied if the resulting image exceeds the maximum dimensions. - In AIR 1.5 and Flash Player 10, the maximum is 8,191 pixels in width or height, - and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an image is 8,191 pixels - wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, - the limitation is 2,880 pixels in height and 2,880 pixels in width. - For example, if you zoom in on a large movie clip with a filter applied, the filter is - turned off if the resulting image exceeds the maximum dimensions.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.BitmapData.applyFilter() -
-flash.display.DisplayObject.filters -
-flash.display.DisplayObject.cacheAsBitmap -
-flash.display.DisplayObject.scaleX -
-flash.display.DisplayObject.scaleY -
-flash.filters.DropShadowFilter.distance -
-flash.filters.DropShadowFilter.angle -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  alpha : Number -
- The alpha transparency value for the color.
-		GlowFilter
  blurX : Number -
- The amount of horizontal blur.
-		GlowFilter
  blurY : Number -
- The amount of vertical blur.
-		GlowFilter
  color : uint -
- The color of the glow.
-		GlowFilter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  inner : Boolean -
- Specifies whether the glow is an inner glow.
-		GlowFilter
  knockout : Boolean -
- Specifies whether the object has a knockout effect.
-		GlowFilter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : int -
- The number of times to apply the filter.
-		GlowFilter
  strength : Number -
- The strength of the imprint or spread.
-		GlowFilter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GlowFilter(color:uint = 0xFF0000, alpha:Number = 1.0, blurX:Number = 6.0, blurY:Number = 6.0, strength:Number = 2, quality:int = 1, inner:Boolean = false, knockout:Boolean = false)
-
- Initializes a new GlowFilter instance with the specified parameters.
-		GlowFilter
   -
-clone():BitmapFilter -
-
- Returns a copy of this filter object.
-		GlowFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alphaproperty
-
-alpha:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The alpha transparency value for the color. Valid values are 0 to 1. - For example, - .25 sets a transparency value of 25%. The default value is 1. - -

Implementation -
-    public function get alpha():Number -
-    public function set alpha(value:Number):void -
-
- - - - - -
blurXproperty 
-
-blurX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of horizontal blur. Valid values are 0 to 255 (floating point). The - default value is 6. Values that are a power of 2 (such as 2, 4, - 8, 16, and 32) are optimized - to render more quickly than other values. - -

Implementation -
-    public function get blurX():Number -
-    public function set blurX(value:Number):void -
-
- - - - - -
blurYproperty 
-
-blurY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of vertical blur. Valid values are 0 to 255 (floating point). The - default value is 6. Values that are a power of 2 (such as 2, 4, - 8, 16, and 32) are optimized - to render more quickly than other values. - -

Implementation -
-    public function get blurY():Number -
-    public function set blurY(value:Number):void -
-
- - - - - -
colorproperty 
-
-color:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The color of the glow. Valid values are in the hexadecimal format - 0xRRGGBB. The default value is 0xFF0000. - -

Implementation -
-    public function get color():uint -
-    public function set color(value:uint):void -
-
- - - - - -
innerproperty 
-
-inner:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether the glow is an inner glow. The value true indicates - an inner glow. The default is false, an outer glow (a glow - around the outer edges of the object). - -

Implementation -
-    public function get inner():Boolean -
-    public function set inner(value:Boolean):void -
-
- - - - - -
knockoutproperty 
-
-knockout:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether the object has a knockout effect. A value of true - makes the object's fill transparent and reveals the background color of the document. The - default value is false (no knockout effect). -

Implementation -
-    public function get knockout():Boolean -
-    public function set knockout(value:Boolean):void -
-
- - - - - -
qualityproperty 
-
-quality:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of times to apply the filter. The default value is BitmapFilterQuality.LOW, - which is equivalent to applying the filter once. The value BitmapFilterQuality.MEDIUM - applies the filter twice; the value BitmapFilterQuality.HIGH applies it three times. - Filters with lower values are rendered more quickly. -

For most applications, a quality value of low, medium, or high is sufficient. - Although you can use additional numeric values up to 15 to achieve different effects, - higher values are rendered more slowly. Instead of increasing the value of quality, - you can often get a similar effect, and with faster rendering, by simply increasing the values - of the blurX and blurY properties.

- - Implementation -
-    public function get quality():int -
-    public function set quality(value:int):void -
-

-See also -

-
-flash.filters.BitmapFilterQuality -
-
- - - - - -
strengthproperty 
-
-strength:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The strength of the imprint or spread. The higher the value, - the more color is imprinted and the stronger the contrast between the glow and the background. - Valid values are 0 to 255. The default is 2. - -

Implementation -
-    public function get strength():Number -
-    public function set strength(value:Number):void -
-
- -
Constructor detail
- - - - - -
GlowFilter()constructor
-
-public function GlowFilter(color:uint = 0xFF0000, alpha:Number = 1.0, blurX:Number = 6.0, blurY:Number = 6.0, strength:Number = 2, quality:int = 1, inner:Boolean = false, knockout:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Initializes a new GlowFilter instance with the specified parameters. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
color:uint (default = 0xFF0000) — The color of the glow, in the hexadecimal format - 0xRRGGBB. The default value is 0xFF0000. -
 
alpha:Number (default = 1.0) — The alpha transparency value for the color. Valid values are 0 to 1. For example, - .25 sets a transparency value of 25%. -
 
blurX:Number (default = 6.0) — The amount of horizontal blur. Valid values are 0 to 255 (floating point). Values - that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized - to render more quickly than other values. -
 
blurY:Number (default = 6.0) — The amount of vertical blur. Valid values are 0 to 255 (floating point). - Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized - to render more quickly than other values. -
 
strength:Number (default = 2) — The strength of the imprint or spread. The higher the value, - the more color is imprinted and the stronger the contrast between the glow and the background. - Valid values are 0 to 255. -
 
quality:int (default = 1) — The number of times to apply the filter. Use the BitmapFilterQuality constants: -
    -
  • BitmapFilterQuality.LOW
    • -
  • BitmapFilterQuality.MEDIUM
    • -
  • BitmapFilterQuality.HIGH
    • -
-

For more information, see the description of the quality property.

-
 
inner:Boolean (default = false) — Specifies whether the glow is an inner glow. The value true specifies - an inner glow. The value false specifies an outer glow (a glow - around the outer edges of the object). -
 
knockout:Boolean (default = false) — Specifies whether the object has a knockout effect. The value true - makes the object's fill transparent and reveals the background color of the document. -
-

-See also -

-
-BitmapFilterQuality -
-GlowFilter.quality -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():BitmapFilter -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a copy of this filter object. -

-Returns - - - - -
BitmapFilter — - A new GlowFilter instance with all the - properties of the original GlowFilter instance. - - -
-
- -
Examples
-
examples\GlowFilterExample
-
The following example draws a square and applies a blur filter to it. - The general workflow of the example is as follows: -
    -
  1. Import the required classes.
    2. - -
  2. Declare three properties used in the draw method, which uses methods - of the Graphics class accessed through the graphics property of Sprite - to draw an orange square.
    3. - -
  3. Create the constructor function, which does the following: -
      -
    • Calls the draw function to create a rectangle.
      • -
    • Creates a BitmapFilter object glowFilter and assigns it the return values from the getBitmapFilter() function.
      • -
    • Assigns the array of values from the glowFilter object to the filters property of the root display object. In this case, - all display object children of the root display object inherit the glow filter properties. So, the rectangle created in the the draw() - function displays the glow filter properties.
      • -
    -
    4. -
-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.Event;
-    import flash.events.MouseEvent;
-    import flash.filters.BitmapFilter;
-    import flash.filters.BitmapFilterQuality;
-    import flash.filters.GlowFilter;
-
-    public class GlowFilterExample extends Sprite {
-        private var bgColor:uint = 0xFFCC00;
-        private var size:uint    = 80;
-        private var offset:uint  = 50;
-
-        public function GlowFilterExample() {
-        //draw the rectangle using the draw() function below
-            draw();
-            
-        //assign the values from getBitmapFilter function below
-        //to a BitmapFilter object "glowFilter"
-            var glowFilter:BitmapFilter = getBitmapFilter();
-            
-        //populate the filters property of the root display object with the array of values
-        //from the glowFilter object.
-            filters = [ glowFilter ];
-        }
-
-        private function getBitmapFilter():BitmapFilter {
-            var color:Number = 0x33CCFF;
-            var alpha:Number = 0.8;
-            var blurX:Number = 35;
-            var blurY:Number = 35;
-            var strength:Number = 2;
-            var inner:Boolean = false;
-            var knockout:Boolean = false;
-            var quality:Number = BitmapFilterQuality.HIGH;
-
-            return new GlowFilter(color,
-                                  alpha,
-                                  blurX,
-                                  blurY,
-                                  strength,
-                                  quality,
-                                  inner,
-                                  knockout);
-        }
-
-        private function draw():void {
-            graphics.beginFill(bgColor);
-            graphics.drawRect(offset, offset, size, size);
-            graphics.endFill();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/GradientBevelFilter.html b/html-docs/flash/filters/GradientBevelFilter.html deleted file mode 100644 index b40b4c0..0000000 --- a/html-docs/flash/filters/GradientBevelFilter.html +++ /dev/null @@ -1,1051 +0,0 @@ - - - - - - - - -flash.filters.GradientBevelFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class GradientBevelFilter
InheritanceGradientBevelFilter Inheritance BitmapFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The GradientBevelFilter class lets you apply a gradient bevel effect to -display objects. A gradient bevel is a beveled edge, enhanced with gradient color, -on the outside, inside, or top of an object. Beveled edges make objects look -three-dimensional. -You can apply the filter to any display object (that is, objects that inherit from the DisplayObject class), -such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects. -

The use of filters depends on the object to which you apply the filter:

-
  • To apply filters to display objects, use the - filters property. Setting the filters - property of an object does not modify the object, and you can remove the filter by clearing the - filters property.
    • - -
  • To apply filters to BitmapData objects, use the BitmapData.applyFilter() method. - Calling applyFilter() on a BitmapData object takes the source BitmapData object - and the filter object and generates a filtered image as a result.
    • -
- -

If you apply a filter to a display object, the cacheAsBitmap property of the -display object is set to true. If you clear all filters, the original value of -cacheAsBitmap is restored.

-

This filter supports Stage scaling. However, it does not support general scaling, rotation, -and skewing; if the object itself is scaled (if scaleX and scaleY are set -to a value other than 1.0), the -filter effect is not scaled. It is scaled only when the user zooms in on the Stage.

- -

A filter is not applied if the resulting image exceeds the maximum dimensions. -In AIR 1.5 and Flash Player 10, the maximum is 8,191 pixels in width or height, -and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an image is 8,191 pixels -wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, -the limitation is 2,880 pixels in height and 2,880 pixels in width. -For example, if you zoom in on a large movie clip with a filter applied, the filter is -turned off if the resulting image exceeds the maximum dimensions.

- -

-

-View the examples. -

-

-See also -

-
-GradientBevelFilter.ratios -
-flash.display.BitmapData.applyFilter() -
-BevelFilter -
-flash.display.DisplayObject.filters -
-flash.display.DisplayObject.cacheAsBitmap -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  alphas : Array -
- An array of alpha transparency values for the corresponding colors in the - colors array.
-		GradientBevelFilter
  angle : Number -
- The angle, in degrees.
-		GradientBevelFilter
  blurX : Number -
- The amount of horizontal blur.
-		GradientBevelFilter
  blurY : Number -
- The amount of vertical blur.
-		GradientBevelFilter
  colors : Array -
- An array of RGB hexadecimal color values to use in the gradient.
-		GradientBevelFilter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  distance : Number -
- The offset distance.
-		GradientBevelFilter
  knockout : Boolean -
- Specifies whether the object has a knockout effect.
-		GradientBevelFilter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : int -
- The number of times to apply the filter.
-		GradientBevelFilter
  ratios : Array -
- An array of color distribution ratios for the corresponding colors in the - colors array.
-		GradientBevelFilter
  strength : Number -
- The strength of the imprint or spread.
-		GradientBevelFilter
  type : String -
- The placement of the bevel effect.
-		GradientBevelFilter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GradientBevelFilter(distance:Number = 4.0, angle:Number = 45, colors:Array = null, alphas:Array = null, ratios:Array = null, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1, quality:int = 1, type:String = "inner", knockout:Boolean = false)
-
- Initializes the filter with the specified parameters.
-		GradientBevelFilter
   -
-clone():BitmapFilter -
-
- Returns a copy of this filter object.
-		GradientBevelFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alphasproperty
-
-alphas:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of alpha transparency values for the corresponding colors in the - colors array. Valid values for each element - in the array are 0 to 1. For example, .25 sets a transparency value of 25%. -

The alphas property cannot be changed by directly modifying its values. - Instead, you must get a reference to alphas, make the change to the - reference, and then set alphas to the reference.

-

The colors, alphas, and ratios properties are related. - The first element in the colors array - corresponds to the first element in the alphas array - and in the ratios array, and so on.

- Implementation -
-    public function get alphas():Array -
-    public function set alphas(value:Array):void -
-
-Throws -
- - - - -
TypeError — The Array is null when being set -
-

-See also -

-
-GradientBevelFilter.colors -
-GradientBevelFilter.ratios -
-
- - - - - -
angleproperty 
-
-angle:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The angle, in degrees. Valid values are 0 to 360. The default is 45. -

The angle value represents the angle of the theoretical light source falling on the object. - The value determines the angle at which the gradient colors are applied to the object: - where the highlight and the shadow appear, or where the first color in the array appears. - The colors are then applied in the order in which they appear in the array.

- Implementation -
-    public function get angle():Number -
-    public function set angle(value:Number):void -
-

-See also -

-
-GradientBevelFilter.ratios -
-
- - - - - -
blurXproperty 
-
-blurX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of horizontal blur. Valid values are 0 to 255. A blur of 1 or - less means that the original image is copied as is. The default value - is 4. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized - to render more quickly than other values. - -

Implementation -
-    public function get blurX():Number -
-    public function set blurX(value:Number):void -
-
- - - - - -
blurYproperty 
-
-blurY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of vertical blur. Valid values are 0 to 255. A blur of 1 or less - means that the original image is copied as is. The default value is - 4. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized - to render more quickly than other values. -

Implementation -
-    public function get blurY():Number -
-    public function set blurY(value:Number):void -
-
- - - - - -
colorsproperty 
-
-colors:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of RGB hexadecimal color values to use in the gradient. - For example, red is 0xFF0000, blue is 0x0000FF, and so on. - -

The colors property cannot be changed by directly modifying its values. - Instead, you must get a reference to colors, make the change to the - reference, and then set colors to the reference.

-

The colors, alphas, and ratios properties are related. - The first element in the colors array - corresponds to the first element in the alphas array - and in the ratios array, and so on.

- - Implementation -
-    public function get colors():Array -
-    public function set colors(value:Array):void -
-
-Throws -
- - - - -
TypeError — The Array is null when being set -
-

-See also -

-
-GradientBevelFilter.alphas -
-GradientBevelFilter.ratios -
-
- - - - - -
distanceproperty 
-
-distance:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The offset distance. Valid values are 0 to 8. The default value is 4.0. - -

Implementation -
-    public function get distance():Number -
-    public function set distance(value:Number):void -
-
- - - - - -
knockoutproperty 
-
-knockout:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether the object has a knockout effect. A knockout effect - makes the object's fill transparent and reveals the background color of the document. - The value true specifies a knockout effect; - the default is false (no knockout effect). -

Implementation -
-    public function get knockout():Boolean -
-    public function set knockout(value:Boolean):void -
-
- - - - - -
qualityproperty 
-
-quality:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of times to apply the filter. The default value is BitmapFilterQuality.LOW, - which is equivalent to applying the filter once. The value BitmapFilterQuality.MEDIUM - applies the filter twice; the value BitmapFilterQuality.HIGH applies it three times. - Filters with lower values are rendered more quickly. -

For most applications, a quality value of low, medium, or high is sufficient. - Although you can use additional numeric values up to 15 to achieve different effects, - higher values are rendered more slowly. Instead of increasing the value of quality, - you can often get a similar effect, and with faster rendering, by simply increasing the values - of the blurX and blurY properties.

- - Implementation -
-    public function get quality():int -
-    public function set quality(value:int):void -
-

-See also -

-
-BitmapFilterQuality -
-GradientBevelFilter.ratios -
-
- - - - - -
ratiosproperty 
-
-ratios:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of color distribution ratios for the corresponding colors in the - colors array. Valid values for each element - in the array are 0 to 255. -

The ratios property cannot be changed by directly modifying its values. - Instead, you must get a reference to ratios, make the change to the - reference, and then set ratios to the reference.

-

The colors, alphas, and ratios properties are related. - The first element in the colors array - corresponds to the first element in the alphas array - and in the ratios array, and so on.

-

To understand how the colors in a gradient bevel are distributed, think first of the colors - that you want in your gradient bevel. Consider that a simple bevel has a highlight color and shadow - color; a gradient bevel has a highlight gradient and a shadow gradient. Assume that the highlight - appears on the top-left corner, and the shadow appears on the bottom-right corner. Assume that one - possible usage of the filter has four colors in the highlight and four in the shadow. In addition - to the highlight and shadow, the filter uses a base fill color that appears where the edges of the - highlight and shadow meet. Therefore the total number of colors is nine, and the corresponding number - of elements in the ratios array is nine.

-

If you think of a gradient as composed of stripes of various colors, blending into each other, - each ratio value sets the position of the color on the radius of the gradient, where 0 represents - the outermost point of the gradient and 255 represents the innermost point of the gradient. - For a typical usage, - the middle value is 128, and that is the base fill value. To get the bevel effect shown in the - image below, assign the - ratio values as follows, using the example of nine colors:

-
    -
  • The first four colors range from 0-127, increasing in value so that each value is greater than - or equal to the previous one. This is the highlight bevel edge.
    • -
  • The fifth color (the middle color) is the base fill, set to 128. The pixel value of 128 - sets the base fill, which appears either outside the shape (and around the bevel edges) if the type - is set to outer; or inside the shape, effectively covering the object's own fill, if the type - is set to inner.
    • -
  • The last four colors range from 129-255, increasing in value so that each value - is greater than or equal to the previous one. This is the shadow bevel edge.
    • -
-

If you want an equal distribution of colors for each edge, use an odd number of colors, - where the middle color is the base fill. Distribute the values between 0-127 and 129-255 - equally among your colors, then adjust the value to change the width of each stripe of color - in the gradient. For a gradient bevel with nine colors, a possible array is - [16, 32, 64, 96, 128, 160, 192, 224, 235]. The following image depicts the gradient bevel - as described:

- -

A nine color gradient bevel.

-

Keep in mind that the spread of the colors in the gradient varies based on the values - of the blurX, blurY, strength, and quality - properties, as well as the ratios values.

- Implementation -
-    public function get ratios():Array -
-    public function set ratios(value:Array):void -
-
-Throws -
- - - - -
TypeError — The Array is null when being set -
-

-See also -

-
-GradientBevelFilter.alphas -
-GradientBevelFilter.colors -
-flash.display.Graphics.beginGradientFill() -
-
- - - - - -
strengthproperty 
-
-strength:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The strength of the imprint or spread. The higher the value, the more color is imprinted - and the stronger the contrast between the bevel and the background. - Valid values are 0 to 255. - A value of 0 means that the filter is not applied. The default value is 1. -

Implementation -
-    public function get strength():Number -
-    public function set strength(value:Number):void -
-

-See also -

-
-GradientBevelFilter.ratios -
-
- - - - - -
typeproperty 
-
-type:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The placement of the bevel effect. Possible values are BitmapFilterType constants: -

  • BitmapFilterType.OUTER — Bevel on the outer edge of the object
    • -
  • BitmapFilterType.INNER — Bevel on the inner edge of the object
    • -
  • BitmapFilterType.FULL — Bevel on top of the object
    • -
-

Implementation -
-    public function get type():String -
-    public function set type(value:String):void -
-
- -
Constructor detail
- - - - - -
GradientBevelFilter()constructor
-
-public function GradientBevelFilter(distance:Number = 4.0, angle:Number = 45, colors:Array = null, alphas:Array = null, ratios:Array = null, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1, quality:int = 1, type:String = "inner", knockout:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Initializes the filter with the specified parameters. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
distance:Number (default = 4.0) — The offset distance. Valid values are 0 to 8. -
 
angle:Number (default = 45) — The angle, in degrees. Valid values are 0 to 360. -
 
colors:Array (default = null) — An array of RGB hexadecimal color values to use in the gradient. - For example, red is 0xFF0000, blue is 0x0000FF, and so on. -
 
alphas:Array (default = null) — An array of alpha transparency values for the corresponding colors in - the colors array. Valid values for each element in the array are 0 to 1. - For example, .25 sets a transparency value of 25%. -
 
ratios:Array (default = null) — An array of color distribution ratios; valid values are - 0 to 255. -
 
blurX:Number (default = 4.0) — The amount of horizontal blur. Valid values are 0 to 255. A blur of 1 or - less means that the original image is copied as is. The default value - is 4. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized - to render more quickly than other values. -
 
blurY:Number (default = 4.0) — The amount of vertical blur. Valid values are 0 to 255. A blur of 1 or less - means that the original image is copied as is. Values that are a power of 2 - (such as 2, 4, 8, 16 and 32) are optimized - to render more quickly than other values. -
 
strength:Number (default = 1) — The strength of the imprint or spread. The higher the value, the more color - is imprinted and the stronger the contrast between the bevel and the background. - Valid values are 0 to 255. A value of 0 means that the filter is not applied. - -
 
quality:int (default = 1) — The quality of the filter. Use BitmapFilterQuality constants: -
    -
  • BitmapFilterQuality.LOW
    • -
  • BitmapFilterQuality.MEDIUM
    • -
  • BitmapFilterQuality.HIGH
    • -
-

For more information, see the description of the quality property.

-
 
type:String (default = "inner") — The placement of the bevel effect. Possible values are BitmapFilterType constants: -
  • BitmapFilterType.OUTER — Bevel on the outer edge of the object
    • -
  • BitmapFilterType.INNER — Bevel on the inner edge of the object
    • -
  • BitmapFilterType.FULL — Bevel on top of the object
    • -
-
 
knockout:Boolean (default = false) — Specifies whether a knockout effect is applied. The value true - makes the object's fill transparent and reveals the background color of the document. -
-

-See also -

-
-GradientBevelFilter.quality -
-GradientBevelFilter.ratios -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():BitmapFilter -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a copy of this filter object. -

-Returns - - - - -
BitmapFilter — - A new GradientBevelFilter instance with all the - same properties as the original GradientBevelFilter instance. - - -
-
- -
Examples
-
examples\GradientBevelFilterExample
-
The following example draws a square and applies a gradient bevel filter to it. - The general workflow of this example is as follows: -
    -
  1. Import the required classes.
    2. -
  2. Declare global variables to define the square and the filter.
    3. -
  3. Create the constructor functions, which does the following: -
      -
    • Calls the draw() method, which uses methods of the Graphics class - accessed through the graphics property of Sprite to draw a gray square.
      • -
    • Creates a BitmapFilter object named filter and assigns it - the return value of a call to getBitmapFilter(), which creates the filter.
      • -
    • Creates a new array named myFilters and adds filter to it.
      • -
    • Assigns myFilters to the filters property of the - GradientBevelFilterExample object. This applies all filters found in myFilters, which in this case - is only filter.
      • -
    -
    4. -
-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.filters.BitmapFilter;
-    import flash.filters.BitmapFilterQuality;
-    import flash.filters.BitmapFilterType;
-    import flash.filters.GradientBevelFilter;
-
-    public class GradientBevelFilterExample extends Sprite {
-        private var bgColor:uint     = 0xCCCCCC;
-        private var size:uint        = 80;
-        private var offset:uint      = 50;
-        private var distance:Number  = 5;
-        private var angleInDegrees:Number = 225; // opposite 45 degrees
-        private var colors:Array     = [0xFFFFFF, 0xCCCCCC, 0x000000];
-        private var alphas:Array     = [1, 0, 1];
-        private var ratios:Array     = [0, 128, 255];
-        private var blurX:Number     = 8;
-        private var blurY:Number     = 8;
-        private var strength:Number  = 2;
-        private var quality:Number   = BitmapFilterQuality.HIGH
-        private var type:String      = BitmapFilterType.INNER;
-        private var knockout:Boolean = true;
-
-        public function GradientBevelFilterExample() {
-            draw();
-            var filter:BitmapFilter = getBitmapFilter();
-            var myFilters:Array = new Array();
-            myFilters.push(filter);
-            filters = myFilters;
-        }
-
-        private function getBitmapFilter():BitmapFilter {
-            return new GradientBevelFilter(distance,
-                                           angleInDegrees,
-                                           colors,
-                                           alphas,
-                                           ratios,
-                                           blurX,
-                                           blurY,
-                                           strength,
-                                           quality,
-                                           type,
-                                           knockout);
-        }
-
-        private function draw():void {
-            graphics.beginFill(bgColor);
-            graphics.drawRect(offset, offset, size, size);
-            graphics.endFill();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/GradientGlowFilter.html b/html-docs/flash/filters/GradientGlowFilter.html deleted file mode 100644 index 41a0353..0000000 --- a/html-docs/flash/filters/GradientGlowFilter.html +++ /dev/null @@ -1,1054 +0,0 @@ - - - - - - - - -flash.filters.GradientGlowFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic final class GradientGlowFilter
InheritanceGradientGlowFilter Inheritance BitmapFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The GradientGlowFilter class lets you apply a gradient glow effect to display objects. - A gradient glow is a realistic-looking glow with a color gradient that - you can control. You can apply a gradient glow around - the inner or outer edge of an object or on top of an object. - You can apply the filter to any display object (objects that inherit from the DisplayObject class), - such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects. -

The use of filters depends on the object to which you apply the filter:

-
  • To apply filters to display objects, use the - filters property. Setting the filters - property of an object does not modify the object, and you can remove the filter by clearing the - filters property.
    • - -
  • To apply filters to BitmapData objects, use the BitmapData.applyFilter() method. - Calling applyFilter() on a BitmapData object takes the source BitmapData object - and the filter object and generates a filtered image as a result.
    • -
- -

If you apply a filter to a display object, the cacheAsBitmap property of the - display object is set to true. If you clear all filters, the original value of - cacheAsBitmap is restored.

-

This filter supports Stage scaling. However, it does not support general scaling, rotation, - and skewing; if the object itself is scaled (if scaleX and scaleY are set - to a value other than 1.0), the - filter effect is not scaled. It is scaled only when the user zooms in on the Stage.

- -

A filter is not applied if the resulting image exceeds the maximum dimensions. - In AIR 1.5 and Flash Player 10, the maximum is 8,191 pixels in width or height, - and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an image is 8,191 pixels - wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, - the limitation is 2,880 pixels in height and 2,880 pixels in width. - For example, if you zoom in on a large movie clip with a filter applied, the filter is - turned off if the resulting image exceeds the maximum dimensions.

- -

-

-View the examples. -

-

-See also -

-
-GradientGlowFilter.ratios -
-flash.display.BitmapData.applyFilter() -
-flash.display.DisplayObject.cacheAsBitmap -
-flash.display.DisplayObject.filters -
-GlowFilter class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  alphas : Array -
- An array of alpha transparency values for the corresponding colors in - the colors array.
-		GradientGlowFilter
  angle : Number -
- The angle, in degrees.
-		GradientGlowFilter
  blurX : Number -
- The amount of horizontal blur.
-		GradientGlowFilter
  blurY : Number -
- The amount of vertical blur.
-		GradientGlowFilter
  colors : Array -
- An array of colors that defines a gradient.
-		GradientGlowFilter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  distance : Number -
- The offset distance of the glow.
-		GradientGlowFilter
  knockout : Boolean -
- Specifies whether the object has a knockout effect.
-		GradientGlowFilter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : int -
- The number of times to apply the filter.
-		GradientGlowFilter
  ratios : Array -
- An array of color distribution ratios for the corresponding colors in the - colors array.
-		GradientGlowFilter
  strength : Number -
- The strength of the imprint or spread.
-		GradientGlowFilter
  type : String -
- The placement of the filter effect.
-		GradientGlowFilter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GradientGlowFilter(distance:Number = 4.0, angle:Number = 45, colors:Array = null, alphas:Array = null, ratios:Array = null, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1, quality:int = 1, type:String = "inner", knockout:Boolean = false)
-
- Initializes the filter with the specified parameters.
-		GradientGlowFilter
   -
-clone():BitmapFilter -
-
- Returns a copy of this filter object.
-		GradientGlowFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alphasproperty
-
-alphas:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of alpha transparency values for the corresponding colors in - the colors array. Valid values for each element in the array are 0 to 1. - For example, .25 sets the alpha transparency value to 25%. -

The alphas property cannot be changed by directly modifying its values. - Instead, you must get a reference to alphas, make the change to the - reference, and then set alphas to the reference.

-

The colors, alphas, and ratios properties are related. - The first element in the colors array - corresponds to the first element in the alphas array - and in the ratios array, and so on.

- - Implementation -
-    public function get alphas():Array -
-    public function set alphas(value:Array):void -
-
-Throws -
- - - - -
TypeError — The Array is null when being set -
-

-See also -

-
-GradientGlowFilter.colors -
-GradientGlowFilter.ratios -
-
- - - - - -
angleproperty 
-
-angle:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The angle, in degrees. Valid values are 0 to 360. The default is 45. - -

The angle value represents the angle of the theoretical light source falling on the object and - determines the placement of the effect relative to the object. If distance is set to 0, the effect - is not offset from the object, and therefore the angle property has no effect.

- Implementation -
-    public function get angle():Number -
-    public function set angle(value:Number):void -
-
- - - - - -
blurXproperty 
-
-blurX:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of horizontal blur. Valid values are 0 to 255. A blur of 1 or - less means that the original image is copied as is. The default value - is 4. Values that are a power of 2 (such as 2, 4, 8, 16, and 32) are optimized - to render more quickly than other values. - -

Implementation -
-    public function get blurX():Number -
-    public function set blurX(value:Number):void -
-
- - - - - -
blurYproperty 
-
-blurY:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of vertical blur. Valid values are 0 to 255. A blur of 1 or less - means that the original image is copied as is. The default value is - 4. Values that are a power of 2 (such as 2, 4, 8, 16, and 32) are optimized - to render more quickly than other values. - -

Implementation -
-    public function get blurY():Number -
-    public function set blurY(value:Number):void -
-
- - - - - -
colorsproperty 
-
-colors:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of colors that defines a gradient. - For example, red is 0xFF0000, blue is 0x0000FF, and so on. -

The colors property cannot be changed by directly modifying its values. - Instead, you must get a reference to colors, make the change to the - reference, and then set colors to the reference.

-

The colors, alphas, and ratios properties are related. - The first element in the colors array - corresponds to the first element in the alphas array - and in the ratios array, and so on.

- Implementation -
-    public function get colors():Array -
-    public function set colors(value:Array):void -
-
-Throws -
- - - - -
TypeError — The Array is null when being set -
-

-See also -

-
-GradientGlowFilter.alphas -
-GradientGlowFilter.ratios -
-
- - - - - -
distanceproperty 
-
-distance:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The offset distance of the glow. The default value is 4. -

Implementation -
-    public function get distance():Number -
-    public function set distance(value:Number):void -
-
- - - - - -
knockoutproperty 
-
-knockout:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether the object has a knockout effect. A knockout effect - makes the object's fill transparent and reveals the background color of the document. - The value true specifies a knockout effect; - the default value is false (no knockout effect). - -

Implementation -
-    public function get knockout():Boolean -
-    public function set knockout(value:Boolean):void -
-
- - - - - -
qualityproperty 
-
-quality:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of times to apply the filter. The default value is BitmapFilterQuality.LOW, - which is equivalent to applying the filter once. The value BitmapFilterQuality.MEDIUM - applies the filter twice; the value BitmapFilterQuality.HIGH applies it three times. - Filters with lower values are rendered more quickly. -

For most applications, a quality value of low, medium, or high is sufficient. - Although you can use additional numeric values up to 15 to achieve different effects, - higher values are rendered more slowly. Instead of increasing the value of quality, - you can often get a similar effect, and with faster rendering, by simply increasing the values - of the blurX and blurY properties.

- - Implementation -
-    public function get quality():int -
-    public function set quality(value:int):void -
-

-See also -

-
-flash.filters.BitmapFilterQuality -
-
- - - - - -
ratiosproperty 
-
-ratios:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of color distribution ratios for the corresponding colors in the - colors array. Valid values are - 0 to 255. -

The ratios property cannot be changed by directly modifying its values. - Instead, you must get a reference to ratios, make the change to the - reference, and then set ratios to the reference.

-

The colors, alphas, and ratios properties are related. - The first element in the colors array - corresponds to the first element in the alphas array - and in the ratios array, and so on.

- -

Think of the gradient glow filter as a glow that emanates from - the center of the object (if the distance value is set to 0), - with gradients that are stripes of color blending into each other. The first color - in the colors array is the outermost color of the glow. - The last color is the innermost color of the glow.

-

Each value in the ratios array sets - the position of the color on the radius of the gradient, where 0 represents - the outermost point of the gradient and 255 represents the innermost point of - the gradient. The ratio values can range from 0 to 255 pixels, - in increasing value; for example [0, 64, 128, 200, 255]. Values from 0 to 128 - appear on the outer edges of the glow. Values from 129 to 255 appear in the inner - area of the glow. Depending on the ratio values of the colors and the type - value of the filter, the filter colors might be obscured by the object to which - the filter is applied.

-

In the following code and image, a filter is applied to a black circle movie - clip, with the type set to "full". For instructional purposes, the first color - in the colors array, pink, has an alpha value of 1, - so it shows against the white document background. (In practice, you probably would - not want the first color showing in this way.) The last color in the - array, yellow, obscures the black circle to which the filter is applied:

- 

-	var colors:Array = [0xFFCCFF, 0x0000FF, 0x9900FF, 0xFF0000, 0xFFFF00];
-	var alphas:Array = [1, 1, 1, 1, 1];
-	var ratios:Array = [0, 32, 64, 128, 225];
-	var myGGF:GradientGlowFilter = new GradientGlowFilter(0, 0, colors, alphas, ratios, 50, 50, 1, 2, "full", false);
-

-

A gradient glow filter with a ratios array of 0, 32, 64, 128, 225.

- -

To achieve a seamless effect with your document background when you set the type - value to "outer" or "full", set the first color in the - array to the same color as the document background, or set the - alpha value of the first color to 0; either technique makes the filter blend in with the background.

-

If you make two small changes in the code, the effect of the glow can be very - different, even with the same ratios and colors arrays. Set - the alpha value of the first - color in the array to 0, to make the filter blend in with the document's - white background; and set the type property to - "outer" or "inner". - Observe the results, as shown in the following images.

-

outer glow - inner glow

-

Keep in mind that the spread of the colors in the gradient varies based on the values - of the blurX, blurY, strength, and quality - properties, as well as the ratios values.

- - Implementation -
-    public function get ratios():Array -
-    public function set ratios(value:Array):void -
-
-Throws -
- - - - -
TypeError — The Array is null when being set -
-

-See also -

-
-GradientGlowFilter.colors -
-GradientGlowFilter.alphas -
-flash.display.Graphics.beginGradientFill() -
-
- - - - - -
strengthproperty 
-
-strength:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The strength of the imprint or spread. The higher the value, the more color is imprinted - and the stronger the contrast between the glow and the background. Valid values are 0 to 255. - A value of 0 means that the filter is not applied. The default value is 1. - -

Implementation -
-    public function get strength():Number -
-    public function set strength(value:Number):void -
-
- - - - - -
typeproperty 
-
-type:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The placement of the filter effect. Possible values are flash.filters.BitmapFilterType constants: -

  • BitmapFilterType.OUTER — Glow on the outer edge of the object
    • -
  • BitmapFilterType.INNER — Glow on the inner edge of the object; the default.
    • -
  • BitmapFilterType.FULL — Glow on top of the object
    • -
- -

Implementation -
-    public function get type():String -
-    public function set type(value:String):void -
-
-Throws -
- - - - -
TypeError — The string is null when being set -
-
- -
Constructor detail
- - - - - -
GradientGlowFilter()constructor
-
-public function GradientGlowFilter(distance:Number = 4.0, angle:Number = 45, colors:Array = null, alphas:Array = null, ratios:Array = null, blurX:Number = 4.0, blurY:Number = 4.0, strength:Number = 1, quality:int = 1, type:String = "inner", knockout:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Initializes the filter with the specified parameters. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
distance:Number (default = 4.0) — The offset distance of the glow. -
 
angle:Number (default = 45) — The angle, in degrees. Valid values are 0 to 360. -
 
colors:Array (default = null) — An array of colors that defines a gradient. - For example, red is 0xFF0000, blue is 0x0000FF, and so on. -
 
alphas:Array (default = null) — An array of alpha transparency values for the corresponding colors in - the colors array. Valid values for each element in the array are 0 to 1. - For example, a value of .25 sets the alpha transparency value to 25%. -
 
ratios:Array (default = null) — An array of color distribution ratios. Valid values are - 0 to 255. This value defines the percentage of the width where the color - is sampled at 100 percent. -
 
blurX:Number (default = 4.0) — The amount of horizontal blur. Valid values are 0 to 255. A blur of 1 or - less means that the original image is copied as is. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized - to render more quickly than other values. -
 
blurY:Number (default = 4.0) — The amount of vertical blur. Valid values are 0 to 255. A blur of 1 or less - means that the original image is copied as is. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized - to render more quickly than other values. -
 
strength:Number (default = 1) — The strength of the imprint or spread. The higher the value, the more color is - imprinted and the stronger the contrast between the glow and the background. - Valid values are 0 to 255. The larger the value, the stronger the imprint. A value of 0 - means the filter is not applied. -
 
quality:int (default = 1) — The number of times to apply the filter. Use the BitmapFilterQuality constants: -
    -
  • BitmapFilterQuality.LOW
    • -
  • BitmapFilterQuality.MEDIUM
    • -
  • BitmapFilterQuality.HIGH
    • -
-

For more information, see the description of the quality property.

-
 
type:String (default = "inner") — The placement of the filter effect. Possible values are the - flash.filters.BitmapFilterType constants: -
    -
  • BitmapFilterType.OUTER — Glow on the outer edge of the object
    • -
  • BitmapFilterType.INNER — Glow on the inner edge of the object; the default.
    • -
  • BitmapFilterType.FULL — Glow on top of the object
    • -
- -
 
knockout:Boolean (default = false) — Specifies whether the object has a knockout effect. A knockout effect - makes the object's fill transparent and reveals the background color of the document. - The value true specifies a knockout effect; - the default is false (no knockout effect). -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():BitmapFilter -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a copy of this filter object. -

-Returns - - - - -
BitmapFilter — - A new GradientGlowFilter instance with all the - same properties as the original GradientGlowFilter instance. - - -
-
- -
Examples
-
examples\GradientGlowFilterExample
-
The following example draws a square and applies a gradient glow filter to it. - The general workflow of the example is as follows: - -
    -
  1. Import the required classes.
    2. -
  2. Declare global variables used to define the square and filter.
    3. -
  3. Create the constructor function, which does the following: -
      -
    • Calls the draw() method, which uses methods of the Graphics class - accessed through the graphics property of Sprite to draw a square.
      • -
    • Creates a BitmapFilter object named filter and assigns it - the return value of a call to getBitmapFilter(), which creates the filter.
      • -
    • Creates a new array named myFilters and adds filter to it.
      • -
    • Assigns myFilters to the filters property of the - GradientGlowFilterExample object. This applies all filters found in myFilters, - which in this case is only filter.
      • -
    -
    4. -
-
-
-package {
-    import flash.filters.BitmapFilter;
-    import flash.filters.BitmapFilterQuality;
-    import flash.filters.BitmapFilterType;
-    import flash.filters.GradientGlowFilter;
-    import flash.display.Sprite;
-
-    public class GradientGlowFilterExample extends Sprite {
-        private var bgColor:uint = 0xCCCCCC;
-        private var size:uint    = 80;
-        private var offset:uint  = 50;
-
-        private var distance:Number  = 0;
-        private var angleInDegrees:Number = 45;
-        private var colors:Array     = [0xFFFFFF, 0xFF0000, 0xFFFF00, 0x00CCFF];
-        private var alphas:Array     = [0, 1, 1, 1];
-        private var ratios:Array     = [0, 63, 126, 255];
-        private var blurX:Number     = 50;
-        private var blurY:Number     = 50;
-        private var strength:Number  = 2.5;
-        private var quality:Number   = BitmapFilterQuality.HIGH;
-        private var type:String      = BitmapFilterType.OUTER;
-        private var knockout:Boolean = false;
-
-        public function GradientGlowFilterExample() {
-            draw();
-            var filter:BitmapFilter = getBitmapFilter();
-            var myFilters:Array = new Array();
-            myFilters.push(filter);
-            filters = myFilters;
-        }
-
-        private function getBitmapFilter():BitmapFilter {
-            return new GradientGlowFilter(distance,
-                                          angleInDegrees,
-                                          colors,
-                                          alphas,
-                                          ratios,
-                                          blurX,
-                                          blurY,
-                                          strength,
-                                          quality,
-                                          type,
-                                          knockout);
-        }
-
-        private function draw():void {
-            graphics.beginFill(bgColor);
-            graphics.drawRect(offset, offset, size, size);
-            graphics.endFill();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/ShaderFilter.html b/html-docs/flash/filters/ShaderFilter.html deleted file mode 100644 index a98ab37..0000000 --- a/html-docs/flash/filters/ShaderFilter.html +++ /dev/null @@ -1,622 +0,0 @@ - - - - - - - - -flash.filters.ShaderFilter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.filters
Classpublic class ShaderFilter
InheritanceShaderFilter Inheritance BitmapFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The ShaderFilter class applies a filter by executing a shader on the object - being filtered. The filtered object is used as an input to the shader, and the - shader output becomes the filter result. - -

To create a new filter, use the constructor new ShaderFilter(). The - use of filters depends on the object to which you apply the filter:

- -
    -
  • To apply filters to movie clips, text fields, buttons, and video, use the - filters property (inherited from DisplayObject). Setting the - filters property of an object does not modify the object, and you - can remove the filter by clearing the filters property.
    • -
  • To apply filters to BitmapData objects, use the BitmapData.applyFilter() - method. Calling applyFilter() on a BitmapData object takes the source - BitmapData object and the filter object and generates a filtered image as a - result.
    • -
- -

If you apply a filter to a display object, the value of the cacheAsBitmap - property of the object is set to true. If you remove all filters, the original value of - cacheAsBitmap is restored.

- -

This filter supports stage scaling. However, it does not support general scaling, - rotation, and skewing. If the object itself is scaled (if the scaleX and - scaleY properties are not set to 100%), the filter is not scaled. It is - scaled only when the user zooms in on the stage.

- -

A filter is not applied if the resulting image exceeds the maximum dimensions. - In AIR 1.5 and Flash Player 10, the maximum is 8,191 pixels in width or height, - and the total number of pixels cannot exceed 16,777,215 pixels. (So, if an image is 8,191 pixels - wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier and AIR 1.1 and earlier, - the limitation is 2,880 pixels in height and 2,880 pixels in width. - If, for example, you zoom in on a large movie clip with a filter applied, the filter is - turned off if the resulting image exceeds the maximum dimensions.

- -

To specify the Shader instance to use with the filter, pass the Shader instance - as an argument to the ShaderFilter() - constructor, or set it as the value of the shader property.

- -

To allow the shader output to extend beyond the bounds of the filtered object, - use the leftExtension, rightExtension, topExtension, - and bottomExtension properties.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.DisplayObject.filters -
-flash.display.DisplayObject.cacheAsBitmap -
-flash.display.BitmapData.applyFilter() -
-flash.display.Shader -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bottomExtension : int -
- The growth in pixels on the bottom side of the target object.
-		ShaderFilter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  leftExtension : int -
- The growth in pixels on the left side of the target object.
-		ShaderFilter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rightExtension : int -
- The growth in pixels on the right side of the target object.
-		ShaderFilter
  shader : Shader -
- The shader to use for this filter.
-		ShaderFilter
  topExtension : int -
- The growth in pixels on the top side of the target object.
-		ShaderFilter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ShaderFilter(shader:Shader = null)
-
- Creates a new shader filter.
-		ShaderFilter
 Inherited -
-clone():BitmapFilter -
-
- Returns a BitmapFilter object that is an exact copy of the original - BitmapFilter object.
-		BitmapFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
bottomExtensionproperty
-
-bottomExtension:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The growth in pixels on the bottom side of the target object. - -

The growth is the area beyond the bounds of the target object - that is passed to the shader during execution. At execution time - Flash Player or AIR computes the normal bounds of a movie clip and extends - the bounds based on the leftExtension, rightExtension, - topExtension, and bottomExtension values.

- -

The default value is 0.

-Implementation -
-    public function get bottomExtension():int -
-    public function set bottomExtension(value:int):void -
-
- - - - - -
leftExtensionproperty 
-
-leftExtension:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The growth in pixels on the left side of the target object. - -

The growth is the area beyond the bounds of the target object - that is passed to the shader during execution. At execution time - Flash Player or AIR computes the normal bounds of a movie clip and extends - the bounds based on the leftExtension, rightExtension, - topExtension, and bottomExtension values.

- -

The default value is 0.

-Implementation -
-    public function get leftExtension():int -
-    public function set leftExtension(value:int):void -
-
- - - - - -
rightExtensionproperty 
-
-rightExtension:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The growth in pixels on the right side of the target object. - -

The growth is the area beyond the bounds of the target object - that is passed to the shader during execution. At execution time - Flash Player or AIR computes the normal bounds of a movie clip and extends - the bounds based on the leftExtension, rightExtension, - topExtension, and bottomExtension values.

- -

The default value is 0.

-Implementation -
-    public function get rightExtension():int -
-    public function set rightExtension(value:int):void -
-
- - - - - -
shaderproperty 
-
-shader:Shader  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The shader to use for this filter. - -

The Shader assigned to the shader property must specify at least one - image4 input. The input does not need to be specified in code using the - associated ShaderInput object's input property. Instead, the object to which the - filter is applied is automatically - used as the first input (the input with index 0). A shader used as a filter - can specify more than one input, in which case any additional input must be specified - by setting its ShaderInput instance's input property.

-

When you assign a Shader instance to this property the shader is copied internally and the - filter 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 filter. To make it so that shader changes are taken - into account in the filter output, - you must reassign the Shader instance to the shader property. As with all filters, - you must also reassign the ShaderFilter instance to the display object's filters - property in order to apply filter changes.

- Implementation -
-    public function get shader():Shader -
-    public function set shader(value:Shader):void -
-
- - - - - -
topExtensionproperty 
-
-topExtension:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The growth in pixels on the top side of the target object. - -

The growth is the area beyond the bounds of the target object - that is passed to the shader during execution. At execution time - Flash Player or AIR computes the normal bounds of a movie clip and extends - the bounds based on the leftExtension, rightExtension, - topExtension, and bottomExtension values.

- -

The default value is 0.

-Implementation -
-    public function get topExtension():int -
-    public function set topExtension(value:int):void -
-
- -
Constructor detail
- - - - - -
ShaderFilter()constructor
-
-public function ShaderFilter(shader:Shader = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new shader filter. -

Parameters - - - - -
shader:Shader (default = null) — The Shader to use for this filter. For details and limitations that - the shader must conform to, see the description for the shader - property. - -
-

-See also -

-
-shader -
-
- -
Examples
-
examples\ShaderFilterExample.1
-
The following example loads a shader and uses it as the shader property - of a ShaderFilter. The code draws a circle in a Sprite instance and adds it to the stage. When - the shader loads, the shader filter is applied to that Sprite. - -

Note that this example assumes there's a shader bytecode file named "gradient.pbj" in the same - directory as the output directory for the application.

-
-
-
-//
-// Source code for the shader:
-//
-<languageVersion : 1.0;>
-
-kernel RedGradientFilter
-<
-    namespace: "Adobe::Example";
-    vendor: "Adobe examples";
-    version: 1;
-    description: "Applies a gradient across the red channel of the input image.";
->
-{
-    input image4 src;
-    output pixel4 dst;
-    
-    parameter float width
-    <
-        description: "The width of the image to which the shader is applied.";
-        minValue: 0.0;
-    >;
-
-    void evaluatePixel()
-    {
-        pixel4 temp = sampleNearest(src, outCoord());
-        temp.r = 1.0 - (outCoord().x * (1.0 / width));
-        dst = temp;
-    }
-}
-
-//
-// ActionScript source code:
-//
-package {
-	import flash.display.Shader;
-	import flash.display.Sprite;
-	import flash.events.Event;
-	import flash.filters.ShaderFilter;
-	import flash.net.URLLoader;
-	import flash.net.URLLoaderDataFormat;
-	import flash.net.URLRequest;
-
-	public class ShaderFilterExample extends Sprite {
-		
-		private var loader:URLLoader;
-		private var s:Sprite;
-		
-		public function ShaderFilterExample() {
-			loader = new URLLoader();
-			loader.dataFormat = URLLoaderDataFormat.BINARY;
-			loader.addEventListener(Event.COMPLETE, loadCompleteHandler);
-			loader.load(new URLRequest("gradient.pbj"));
-			
-			s = new Sprite();
-			s.graphics.beginFill(0x009900);
-			s.graphics.drawCircle(100, 100, 100);
-			addChild(s);
-		}
-		
-		private function loadCompleteHandler(event:Event):void {
-			var shader:Shader = new Shader(loader.data);
-			shader.data.width.value = [s.width];
-			
-			var gradientFilter:ShaderFilter = new ShaderFilter(shader);
-			s.filters = [gradientFilter];
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/filters/package-detail.html b/html-docs/flash/filters/package-detail.html deleted file mode 100644 index 7bd0d45..0000000 --- a/html-docs/flash/filters/package-detail.html +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - -flash.filters Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.filters package contains classes for bitmap filter effects. Filters let you apply rich visual effects, such as blur, bevel, glow, and drop shadows, to display objects.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 BevelFilter - The BevelFilter class lets you add a bevel effect to display objects.
 BitmapFilter - The BitmapFilter class is the base class for all image filter effects.
 BitmapFilterQuality -The BitmapFilterQuality class contains values to set the rendering quality of a BitmapFilter object.
 BitmapFilterType -The BitmapFilterType class contains values to set the type of a BitmapFilter.
 BlurFilter - The BlurFilter class lets you apply a blur visual effect to display objects.
 ColorMatrixFilter -The ColorMatrixFilter class lets you apply a 4 x 5 matrix transformation on the RGBA color and alpha values -of every pixel in the input image to produce a result with a new set of RGBA color and alpha values.
 ConvolutionFilter -The ConvolutionFilter class applies a matrix convolution filter effect.
 DisplacementMapFilter -The DisplacementMapFilter class uses the pixel values from the specified BitmapData object -(called the displacement map image) to perform a displacement of an object.
 DisplacementMapFilterMode -The DisplacementMapFilterMode class provides values for the mode property -of the DisplacementMapFilter class.
 DropShadowFilter -The DropShadowFilter class lets you add a drop shadow to display objects.
 GlowFilter - The GlowFilter class lets you apply a glow effect to display objects.
 GradientBevelFilter -The GradientBevelFilter class lets you apply a gradient bevel effect to -display objects.
 GradientGlowFilter - The GradientGlowFilter class lets you apply a gradient glow effect to display objects.
 ShaderFilter - The ShaderFilter class applies a filter by executing a shader on the object - being filtered.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/geom/ColorTransform.html b/html-docs/flash/geom/ColorTransform.html deleted file mode 100644 index 91b0cfc..0000000 --- a/html-docs/flash/geom/ColorTransform.html +++ /dev/null @@ -1,782 +0,0 @@ - - - - - - - - -flash.geom.ColorTransform (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.geom
Classpublic class ColorTransform
InheritanceColorTransform Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The ColorTransform class lets you adjust the color values in a display object. - The color adjustment or color transformation can be applied to all four channels: - red, green, blue, and alpha transparency. -

When a ColorTransform object is applied to a display object, a new value for each color - channel is calculated like this:

-
    -
  • New red value = (old red value * redMultiplier) + redOffset
    • -
  • New green value = (old green value * greenMultiplier) + - greenOffset
    • -
  • New blue value = (old blue value * blueMultiplier) + blueOffset
    • -
  • New alpha value = (old alpha value * alphaMultiplier) + - alphaOffset
    • -
-

If any of the color channel values is greater than 255 after the calculation, it is set to 255. - If it is less than 0, it is set to 0.

- -

You can use ColorTransform objects in the following ways:

- -
    - -
  • In the colorTransform parameter of the colorTransform() method - of the BitmapData class
    • - -
  • As the colorTransform property of a Transform object (which can be - used as the transform property of a display object)
    • - -
-

You must use the new ColorTransform() constructor to create a - ColorTransform object before you can call the methods of the - ColorTransform object.

-

Color transformations do not apply to the background color of a movie clip (such as a loaded SWF - object). They apply only to graphics and symbols that are attached to the movie clip.

- -

-

-View the examples. -

-

-See also -

-
-flash.geom.Transform -
-flash.display.DisplayObject.transform -
-flash.display.BitmapData.colorTransform() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  alphaMultiplier : Number -
- A decimal value that is multiplied with the alpha transparency channel value.
-		ColorTransform
  alphaOffset : Number -
- A number from -255 to 255 that is added to the alpha transparency channel value after it has - been multiplied by the alphaMultiplier value.
-		ColorTransform
  blueMultiplier : Number -
- A decimal value that is multiplied with the blue channel value.
-		ColorTransform
  blueOffset : Number -
- A number from -255 to 255 that is added to the blue channel value after it has - been multiplied by the blueMultiplier value.
-		ColorTransform
  color : uint -
- The RGB color value for a ColorTransform object.
-		ColorTransform
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  greenMultiplier : Number -
- A decimal value that is multiplied with the green channel value.
-		ColorTransform
  greenOffset : Number -
- A number from -255 to 255 that is added to the green channel value after it has - been multiplied by the greenMultiplier value.
-		ColorTransform
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  redMultiplier : Number -
- A decimal value that is multiplied with the red channel value.
-		ColorTransform
  redOffset : Number -
- A number from -255 to 255 that is added to the red channel value after it has been - multiplied by the redMultiplier value.
-		ColorTransform
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ColorTransform(redMultiplier:Number = 1.0, greenMultiplier:Number = 1.0, blueMultiplier:Number = 1.0, alphaMultiplier:Number = 1.0, redOffset:Number = 0, greenOffset:Number = 0, blueOffset:Number = 0, alphaOffset:Number = 0)
-
- Creates a ColorTransform object for a display object with the specified - color channel values and alpha values.
-		ColorTransform
   -
-concat(second:ColorTransform):void -
-
Concatenates the ColorTranform object specified by the second parameter - with the current ColorTransform object and sets the - current object as the result, which is an additive combination of the two color transformations.
-		ColorTransform
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Formats and returns a string that describes all of the properties of the - ColorTransform object.
-		ColorTransform
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alphaMultiplierproperty
-
-public var alphaMultiplier:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A decimal value that is multiplied with the alpha transparency channel value. - -

If you set the alpha transparency value of a display object directly by using the - alpha property of the DisplayObject instance, it affects the value of the - alphaMultiplier property of that display object's transform.colorTransform - property.

- -

-See also -

-
-flash.display.DisplayObject.alpha -
-
- - - - - -
alphaOffsetproperty 
-
-public var alphaOffset:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A number from -255 to 255 that is added to the alpha transparency channel value after it has - been multiplied by the alphaMultiplier value. - -

- - - - - -
blueMultiplierproperty 
-
-public var blueMultiplier:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A decimal value that is multiplied with the blue channel value. - -

- - - - - -
blueOffsetproperty 
-
-public var blueOffset:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A number from -255 to 255 that is added to the blue channel value after it has - been multiplied by the blueMultiplier value. - -

- - - - - -
colorproperty 
-
-color:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The RGB color value for a ColorTransform object. -

When you set this property, it changes the three color offset values (redOffset, - greenOffset, and blueOffset) - accordingly, and it sets the three color multiplier values (redMultiplier, - greenMultiplier, and blueMultiplier) to 0. - The alpha transparency multiplier and offset values do not change.

- -

When you pass a value for this property, use the format 0xRRGGBB. - RR, GG, and BB each consist - of two hexadecimal digits that specify the offset of each color component. The 0x - tells the ActionScript compiler that the number is a hexadecimal value.

- Implementation -
-    public function get color():uint -
-    public function set color(value:uint):void -
-
- - - - - -
greenMultiplierproperty 
-
-public var greenMultiplier:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A decimal value that is multiplied with the green channel value. - -

- - - - - -
greenOffsetproperty 
-
-public var greenOffset:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A number from -255 to 255 that is added to the green channel value after it has - been multiplied by the greenMultiplier value. - -

- - - - - -
redMultiplierproperty 
-
-public var redMultiplier:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A decimal value that is multiplied with the red channel value. - -

- - - - - -
redOffsetproperty 
-
-public var redOffset:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A number from -255 to 255 that is added to the red channel value after it has been - multiplied by the redMultiplier value. - -

- -
Constructor detail
- - - - - -
ColorTransform()constructor
-
-public function ColorTransform(redMultiplier:Number = 1.0, greenMultiplier:Number = 1.0, blueMultiplier:Number = 1.0, alphaMultiplier:Number = 1.0, redOffset:Number = 0, greenOffset:Number = 0, blueOffset:Number = 0, alphaOffset:Number = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a ColorTransform object for a display object with the specified - color channel values and alpha values. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
redMultiplier:Number (default = 1.0) — The value for the red multiplier, in the range from 0 to 1. -
 
greenMultiplier:Number (default = 1.0) — The value for the green multiplier, in the range from 0 to 1. -
 
blueMultiplier:Number (default = 1.0) — The value for the blue multiplier, in the range from 0 to 1. -
 
alphaMultiplier:Number (default = 1.0) — The value for the alpha transparency multiplier, in the range from 0 to 1. -
 
redOffset:Number (default = 0) — The offset value for the red color channel, in the range from -255 to 255. -
 
greenOffset:Number (default = 0) — The offset value for the green color channel, in the range from -255 to 255. -
 
blueOffset:Number (default = 0) — The offset for the blue color channel value, in the range from -255 to 255. -
 
alphaOffset:Number (default = 0) — The offset for alpha transparency channel value, in the range from -255 to 255. -
-
- -
Method detail
- - - - - -
concat()method
-
-public function concat(second:ColorTransform):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

Concatenates the ColorTranform object specified by the second parameter - with the current ColorTransform object and sets the - current object as the result, which is an additive combination of the two color transformations. - When you apply the concatenated ColorTransform object, the effect is the same as applying the - second color transformation after the original color transformation. - -

Parameters - - - - -
second:ColorTransform — The ColorTransform object to be combined with the current ColorTransform object. - -
-
- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Formats and returns a string that describes all of the properties of the - ColorTransform object. - -

-Returns - - - - -
String — - A string that lists all of the properties of the ColorTransform object. - - -
-
- -
Examples
-
examples\ColorTransformExample
-
The following example uses the TransformExample class to create a simple sprite - in the shape of a square filled with a gradient pattern. Each time the user clicks the square, the - application transforms the colors of the square sprite, adding to the red color channel and - lightening the blue color channel. This is accomplished with the following steps: - -
    -
  1. The constructor creates a new sprite object target.
    2. - -
  2. The CustomButton() constructor calls the draw() method, which draws a gradient - square in the sprite.
    3. - -
  3. The CustomButton() constructor adds a click event listener for the sprite, which is handled by the - clickHandler() method.
    4. - -
  4. In the clickHandler() method, two properties are set to the - redOffset and blueOffset properties of the current - color transformation. Each is adjusted by 25. Then the transform.colorTransform - property of the square sprite is modified to use the new offset values. - Each time the user clicks the square, the call to the clickHandler() method modifies - the color of the square, by augmenting its red color value and diminishing its blue color value.
    5. -
-
-
-package {
-	import flash.display.Sprite;
-	import flash.display.GradientType;
-	import flash.geom.ColorTransform;
-	import flash.events.MouseEvent;
-
-	public class ColorTransformExample extends Sprite {
-		public function ColorTransformExample() {
-			var target:Sprite = new Sprite();
-			draw(target);
-			addChild(target);
-			target.useHandCursor = true;
-			target.buttonMode = true;
-			target.addEventListener(MouseEvent.CLICK, clickHandler)
-		}
-		public function draw(sprite:Sprite):void {
-			var red:uint = 0xFF0000;
-			var green:uint = 0x00FF00;
-			var blue:uint = 0x0000FF;
-			var size:Number = 100;
-			sprite.graphics.beginGradientFill(GradientType.LINEAR, [red, blue, green], [1, 0.5, 1], [0, 200, 255]);
-			sprite.graphics.drawRect(0, 0, 100, 100);
-		}
-		public function clickHandler(event:MouseEvent):void {
-			var rOffset:Number = transform.colorTransform.redOffset + 25;
-			var bOffset:Number = transform.colorTransform.redOffset - 25;
-			this.transform.colorTransform = new ColorTransform(1, 1, 1, 1, rOffset, 0, bOffset, 0);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/geom/Matrix.html b/html-docs/flash/geom/Matrix.html deleted file mode 100644 index b969595..0000000 --- a/html-docs/flash/geom/Matrix.html +++ /dev/null @@ -1,2601 +0,0 @@ - - - - - - - - -flash.geom.Matrix (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.geom
Classpublic class Matrix
InheritanceMatrix Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - - - -
- - - - -
Runtime version: 
-

-

- - The Matrix class represents a transformation matrix that determines how to map points from one - - coordinate space to another. You can perform various graphical - - transformations on a display object by setting the properties of a Matrix object, - - applying that Matrix object to the matrix property of a Transform object, - - and then applying that Transform object as the transform property of the display object. - - These transformation functions include translation - - (x and y repositioning), rotation, scaling, and skewing. - - - -

Together these types of transformations are known as affine transformations. - - Affine transformations preserve the straightness of lines while transforming, so that - - parallel lines stay parallel.

- - -

To apply a transformation matrix to a display object, you create a Transform - - object, set its matrix property to the transformation matrix, and then set the transform - - property of the display object to the Transform object. - - Matrix objects are also used as parameters of some methods, such as the following:

- - -
    - - - -
  • The draw() method of a BitmapData object
    • - - - -
  • The beginBitmapFill() method, beginGradientFill() method, - - or lineGradientStyle() method of a Graphics object
    • - - - -
- - - -

A transformation matrix object is a 3 x 3 matrix with the following contents:

- - -

Matrix class properties in matrix notation

- - -

In traditional transformation matrixes, the u, v, and w - - properties provide extra capabilities. - - The Matrix class can only operate in two-dimensional space, so it always - - assumes that the property values u and v are 0.0, and that the property value - - w is 1.0. The effective values of the matrix are as follows:

- - -

Matrix class properties in matrix notation showing - - assumed values for u, v, and w

- - -

You can get and set the values of all six of the other properties in a Matrix - - object: a, b, c, - - d, tx, and ty.

- - -

The Matrix class supports the four major types of transformations: - - translation, scaling, rotation, and skewing. You can set three of these transformations by using - - specialized methods, as described in the following table:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TransformationMethodMatrix valuesDisplay resultDescription
Translation (displacement)translate(tx, ty) Matrix notation of translate method parametersIllustration of translate method effectsMoves the image tx pixels to the right and ty pixels - - down.
Scalingscale(sx, sy)Matrix notation of scale method parametersIllustration of scale method effectsResizes the image, multiplying the location of each pixel by sx on the - - x axis and sy on the y axis.
Rotationrotate(q)Matrix notation of rotate method propertiesIllustration of rotate method effectsRotates the image by an angle q, which is measured in radians.
Skewing or shearing None; must set the properties b and cMatrix notation of skew function propertiesIllustration of skew function effectsProgressively slides the image in a direction parallel to the x or y axis. The b - - property of the Matrix object represents the tangent of the skew angle along the y axis; - - the c property of the Matrix object represents the tangent of the skew angle along the - - x axis.
- -

Each transformation function alters the current matrix properties so that - - you can effectively combine multiple transformations. To do this, you call more than one - - transformation function before applying the matrix to its display object target (by using the - - transform property of that display object).

- - -

Use the new Matrix() constructor to create a - - Matrix object before you can call the methods of the Matrix object.

- - -

-

-View the examples. -

-

-See also -

-
-flash.display.DisplayObject.transform -
-flash.geom.Transform -
-flash.display.BitmapData.draw() -
-flash.display.Graphics.beginBitmapFill() -
-flash.display.Graphics.beginGradientFill() -
-flash.display.Graphics.lineGradientStyle() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  a : Number -
- - The value that affects the positioning of pixels - - along the x axis when scaling or rotating an image.
-		Matrix
  b : Number -
- - The value that affects the positioning of pixels - - along the y axis when rotating or skewing an image.
-		Matrix
  c : Number -
- - The value that affects the positioning of pixels - - along the x axis when rotating or skewing an image.
-		Matrix
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  d : Number -
- - The value that affects the positioning of pixels - - along the y axis when scaling or rotating an image.
-		Matrix
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  tx : Number -
- - The distance by which to translate each point along the x axis.
-		Matrix
  ty : Number -
- - The distance by which to translate each point along the y axis.
-		Matrix
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Matrix(a:Number = 1, b:Number = 0, c:Number = 0, d:Number = 1, tx:Number = 0, ty:Number = 0)
-
- - Creates a new Matrix object with the specified parameters.
-		Matrix
   -
-clone():Matrix -
-
- - Returns a new Matrix object that is a clone of this - - matrix, with an exact copy of the contained object.
-		Matrix
   -
-concat(m:Matrix):void -
-
- - Concatenates a matrix with the current matrix, effectively combining the - - geometric effects of the two.
-		Matrix
   -
-copyColumnFrom(column:uint, vector3D:Vector3D):void -
-
- - Copies a Vector3D object into specific column of the calling Matrix3D object.
-		Matrix
   -
-copyColumnTo(column:uint, vector3D:Vector3D):void -
-
- - Copies specific column of the calling Matrix object into the Vector3D object.
-		Matrix
   -
-copyFrom(sourceMatrix:Matrix):void -
-
- - Copies all of the matrix data from the source Point object into the - - calling Matrix object.
-		Matrix
   -
-copyRowFrom(row:uint, vector3D:Vector3D):void -
-
- - Copies a Vector3D object into specific row of the calling Matrix object.
-		Matrix
   -
-copyRowTo(row:uint, vector3D:Vector3D):void -
-
- - Copies specific row of the calling Matrix object into the Vector3D object.
-		Matrix
   -
-createBox(scaleX:Number, scaleY:Number, rotation:Number = 0, tx:Number = 0, ty:Number = 0):void -
-
- - Includes parameters for scaling, - - rotation, and translation.
-		Matrix
   -
-createGradientBox(width:Number, height:Number, rotation:Number = 0, tx:Number = 0, ty:Number = 0):void -
-
- - Creates the specific style of matrix expected by the beginGradientFill() and - - lineGradientStyle() methods of the Graphics class.
-		Matrix
   -
-deltaTransformPoint(point:Point):Point -
-
- - Given a point in the pretransform coordinate space, returns the coordinates of - - that point after the transformation occurs.
-		Matrix
   -
-deltaTransformPointToOutput(point:Point, output:Point):Point -
-
- - Given a point in the pretransform coordinate space, returns the coordinates of - - that point after the transformation occurs.
-		Matrix
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-identity():void -
-
- - Sets each matrix property to a value that causes a null transformation.
-		Matrix
   -
-invert():void -
-
- - Performs the opposite transformation - - of the original matrix.
-		Matrix
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-rotate(angle:Number):void -
-
- - Applies a rotation transformation to the Matrix object.
-		Matrix
   -
-scale(sx:Number, sy:Number):void -
-
- - Applies a scaling transformation to the matrix.
-		Matrix
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setTo(aa:Number, ba:Number, ca:Number, da:Number, txa:Number, tya:Number):void -
-
- - Sets the members of Matrix to the specified values - - - -
-		Matrix
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns a text value listing the properties of the Matrix object.
-		Matrix
   -
-transformPoint(point:Point):Point -
-
- - Returns the result of applying the geometric transformation represented by the Matrix object to the - - specified point.
-		Matrix
   -
-transformPointToOutput(point:Point, output:Point):Point -
-
- - Returns the result of applying the geometric transformation represented by the Matrix object to the - - specified point.
-		Matrix
   -
-translate(dx:Number, dy:Number):void -
-
- - Translates the matrix along the x and y axes, as specified by the dx - - and dy parameters.
-		Matrix
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
aproperty
-
-public var a:Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The value that affects the positioning of pixels - - along the x axis when scaling or rotating an image. - - - -


-Example -
The following example creates the Matrix object myMatrix and sets its - a value. -
-
-import flash.geom.Matrix;
-
-var myMatrix:Matrix = new Matrix();
-trace(myMatrix.a);  // 1
-
-myMatrix.a = 2;
-trace(myMatrix.a);  // 2
-
-

-
- - - - - -
bproperty 
-
-public var b:Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The value that affects the positioning of pixels - - along the y axis when rotating or skewing an image. - - - -


-Example -
The following example creates the Matrix object myMatrix and sets its - b value. -
-
-import flash.geom.Matrix;
- 
-var myMatrix:Matrix = new Matrix();
-trace(myMatrix.b);  // 0
-
-var degrees:Number = 30;
-var radians:Number = (degrees/180) ~~ Math.PI;
-myMatrix.b = Math.tan(radians);
-trace(myMatrix.b);  // 0.5773502691896257
-
-

-
- - - - - -
cproperty 
-
-public var c:Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The value that affects the positioning of pixels - - along the x axis when rotating or skewing an image. - - -


-Example -
The following example creates the Matrix object myMatrix and sets its - c value. -
-
-import flash.geom.Matrix;
-
-var myMatrix:Matrix = new Matrix();
-trace(myMatrix.c);  // 0
-
-var degrees:Number = 30;
-var radians:Number = (degrees/180) ~~ Math.PI;
-myMatrix.c = Math.tan(radians);
-trace(myMatrix.c);  // 0.5773502691896257
-
-

-
- - - - - -
dproperty 
-
-public var d:Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The value that affects the positioning of pixels - - along the y axis when scaling or rotating an image. - - -


-Example -
The following example creates the Matrix object myMatrix and sets its - d value. -
-
-import flash.geom.Matrix;
-
-var myMatrix:Matrix = new Matrix();
-trace(myMatrix.d);  // 1
-
-myMatrix.d = 2;
-trace(myMatrix.d);  // 2
-
-

-
- - - - - -
txproperty 
-
-public var tx:Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The distance by which to translate each point along the x axis. - - -


-Example -
The following example creates the Matrix object myMatrix and sets its - tx value. -
-
-import flash.geom.Matrix;
-
-var myMatrix:Matrix = new Matrix();
-trace(myMatrix.tx);  // 0
-
-myMatrix.tx = 50;  // 50
-trace(myMatrix.tx);
-
-

-
- - - - - -
typroperty 
-
-public var ty:Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The distance by which to translate each point along the y axis. - - -


-Example -
The following example creates the Matrix object myMatrix and sets its - ty value. -
-
-import flash.geom.Matrix;
-
-var myMatrix:Matrix = new Matrix();
-trace(myMatrix.ty);  // 0
-
-myMatrix.ty = 50;
-trace(myMatrix.ty);  // 50
-
-

-
- -
Constructor detail
- - - - - -
Matrix()constructor
-
-public function Matrix(a:Number = 1, b:Number = 0, c:Number = 0, d:Number = 1, tx:Number = 0, ty:Number = 0) -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates a new Matrix object with the specified parameters. In matrix notation, the properties - - are organized like this: - - -

Matrix class properties in matrix notation showing assumed values for u, v, and w

- - -

If you do not provide any parameters to the new Matrix() constructor, it creates an - - identity matrix with the following values:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - 
a = 1
b = 0
c = 0
d = 1
tx = 0
ty = 0
- -

In matrix notation, the identity matrix looks like this:

- - -

Matrix class properties in matrix notation

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
a:Number (default = 1) — The value that affects the positioning of pixels - - along the x axis when scaling or rotating an image. - -
 
b:Number (default = 0) — The value that affects the positioning of pixels - - along the y axis when rotating or skewing an image. - -
 
c:Number (default = 0) — The value that affects the positioning of pixels - - along the x axis when rotating or skewing an image. - -
 
d:Number (default = 1) — The value that affects the positioning of pixels - - along the y axis when scaling or rotating an image.. - -
 
tx:Number (default = 0) — The distance by which to translate each point along the x axis. - -
 
ty:Number (default = 0) — The distance by which to translate each point along the y axis. - - -
-
-Example -
The following example creates matrix_1 by sending no parameters to the - Matrix() constructor and matrix_2 by sending parameters to it. Notice that - matrix_1, which was created with no parameters, results in an identity matrix with the values - a=1, b=0, c=0, d=1, tx=0, - ty=0. -
-
-import flash.geom.Matrix;
-
-var matrix_1:Matrix = new Matrix();
-trace(matrix_1);  // (a=1, b=0, c=0, d=1, tx=0, ty=0)
-
-var matrix_2:Matrix = new Matrix(1, 2, 3, 4, 5, 6);
-trace(matrix_2);  // (a=1, b=2, c=3, d=4, tx=5, ty=6)
-
-

-
- -
Method detail
- - - - - -
clone()method
-
-public function clone():Matrix -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a new Matrix object that is a clone of this - - matrix, with an exact copy of the contained object. - - -

-Returns - - - - -
Matrix — - A Matrix object. - - - - -
-
- - - - - -
concat()method 
-
-public function concat(m:Matrix):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Concatenates a matrix with the current matrix, effectively combining the - - geometric effects of the two. In mathematical terms, concatenating two matrixes - - is the same as combining them using matrix multiplication. - - - -

For example, if matrix m1 scales an object by a factor of four, and - - matrix m2 rotates an object by 1.5707963267949 radians - - (Math.PI/2), then m1.concat(m2) transforms m1 - - into a matrix that scales an object by a factor of four and rotates the object by - - Math.PI/2 radians.

- - - -

This method replaces the source matrix with the concatenated matrix. If you - - want to concatenate two matrixes without altering either of the two source matrixes, - - first copy the source matrix by using the clone() method, as shown in the Class Examples section.

- - - - Parameters - - - - -
m:Matrix — The matrix to be concatenated to the source matrix. - - -
-
- - - - - -
copyColumnFrom()method 
-
-public function copyColumnFrom(column:uint, vector3D:Vector3D):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Copies a Vector3D object into specific column of the calling Matrix3D object. - - - -

Parameters - - - - - - - - - - -
column:uint — The column from which to copy the data from. - -
 
vector3D:Vector3D — The Vector3D object from which to copy the data. - - - -
-
- - - - - -
copyColumnTo()method 
-
-public function copyColumnTo(column:uint, vector3D:Vector3D):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Copies specific column of the calling Matrix object into the Vector3D object. - - The w element of the Vector3D object will not be changed. - - - -

Parameters - - - - - - - - - - -
column:uint — The column from which to copy the data from. - -
 
vector3D:Vector3D — The Vector3D object from which to copy the data. - - - -
-
- - - - - -
copyFrom()method 
-
-public function copyFrom(sourceMatrix:Matrix):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Copies all of the matrix data from the source Point object into the - - calling Matrix object. - - - -

Parameters - - - - -
sourceMatrix:Matrix — The Matrix object from which to copy the data. - - - -
-
- - - - - -
copyRowFrom()method 
-
-public function copyRowFrom(row:uint, vector3D:Vector3D):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Copies a Vector3D object into specific row of the calling Matrix object. - - - -

Parameters - - - - - - - - - - -
row:uint — The row from which to copy the data from. - -
 
vector3D:Vector3D — The Vector3D object from which to copy the data. - - - -
-
- - - - - -
copyRowTo()method 
-
-public function copyRowTo(row:uint, vector3D:Vector3D):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Copies specific row of the calling Matrix object into the Vector3D object. - - The w element of the Vector3D object will not be changed. - - - -

Parameters - - - - - - - - - - -
row:uint — The row from which to copy the data from. - -
 
vector3D:Vector3D — The Vector3D object from which to copy the data. - - - -
-
- - - - - -
createBox()method 
-
-public function createBox(scaleX:Number, scaleY:Number, rotation:Number = 0, tx:Number = 0, ty:Number = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Includes parameters for scaling, - - rotation, and translation. When applied to a matrix it sets the matrix's values - - based on those parameters. - - -

Using the createBox() method lets you obtain the same matrix as you would if - - you applied the identity(), rotate(), scale(), and translate() methods - - in succession. For example, mat1.createBox(2,2,Math.PI/4, 100, 100) has the - - same effect as the following:

- - - - 
-
-     import flash.geom.Matrix;
-
-     
-     var mat1:Matrix = new Matrix();
-
-     mat1.identity();
-
-     mat1.rotate(Math.PI/4);
-
-     mat1.scale(2,2);
-
-     mat1.translate(10,20);
-
-
- - - 
-
-     var mat1 = new air.Matrix();
-
-     mat1.identity();
-
-     mat1.rotate(Math.PI/4);
-
-     mat1.scale(2, 2);
-
-     mat1.translate(10, 20);
-
-
- - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
scaleX:Number — The factor by which to scale horizontally. - - - -
 
scaleY:Number — The factor by which scale vertically. - - - -
 
rotation:Number (default = 0) — The amount to rotate, in radians. - - - -
 
tx:Number (default = 0) — The number of pixels to translate (move) to the right along the x axis. - - - -
 
ty:Number (default = 0) — The number of pixels to translate (move) down along the y axis. - - - -
-

-See also -

-
-flash.display.Graphics.beginBitmapFill() -
-
-Example -
The following example sets the x scale, y scale, rotation, x location, - and y location of myMatrix by calling its createBox() method. -
-
-
-package
-{
-    import flash.display.Shape;
-	import flash.display.Sprite;
-	import flash.geom.Matrix;
-	import flash.geom.Transform;
-	
-	public class Matrix_createBox extends Sprite
-	{
-		public function Matrix_createBox()
-		{
-		     var myMatrix:Matrix = new Matrix();
-		     trace(myMatrix.toString());  // (a=1, b=0, c=0, d=1, tx=0, ty=0)
-		     
-		     myMatrix.createBox(1, 2, Math.PI/4, 50, 100);
-		     trace(myMatrix.toString());  
-		     // (a=0.7071067811865476, b=1.414213562373095, c=-0.7071067811865475, 
-		     //  d=1.4142135623730951, tx=50, ty=100)
-		     
-		     var rectangleShape:Shape = createRectangle(20, 80, 0xFF0000);   
-		     addChild(rectangleShape);
-		      
-		     var rectangleTrans:Transform = new Transform(rectangleShape);
-		     rectangleTrans.matrix = myMatrix;
-		}
-		
-		public function createRectangle(w:Number, h:Number, color:Number):Shape 
-		{
-			var rect:Shape = new Shape();
-			rect.graphics.beginFill(color);
-			rect.graphics.drawRect(0, 0, w, h);
-			addChild(rect);
-			return rect;
-		}
-	}
-}
-
-

-
- - - - - -
createGradientBox()method 
-
-public function createGradientBox(width:Number, height:Number, rotation:Number = 0, tx:Number = 0, ty:Number = 0):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates the specific style of matrix expected by the beginGradientFill() and - - lineGradientStyle() methods of the Graphics class. Width and height are scaled to - - a scaleX/scaleY pair and the tx/ty - - values are offset by half the width and height. - - - -

For example, consider a gradient with the following characteristics:

- - - -
    - - - -
  • GradientType.LINEAR
    • - -
  • Two colors, green and blue, with the ratios array set to [0, 255]
    • - -
  • SpreadMethod.PAD
    • - -
  • InterpolationMethod.LINEAR_RGB
    • - - - -
- - - -

The following illustrations show gradients in which the matrix was defined using the - - createGradientBox() method with different parameter settings:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
createGradientBox() settingsResulting gradient
width = 25;
-
-     height = 25; 
-
-     rotation = 0; 
-
-     tx = 0; 
-
-     ty = 0;
resulting linear gradient
width = 25; 
-
-     height = 25; 
-
-     rotation = 0; 
-
-     tx = 25; 
-
-     ty = 0;
resulting linear gradient
width = 50; 
-
-     height = 50; 
-
-     rotation = 0; 
-
-     tx = 0; 
-
-     ty = 0;
resulting linear gradient
width = 50;
-
-     height = 50; 
-
-     rotation = Math.PI / 4; // 45 degrees
-
-     tx = 0; 
-
-     ty = 0;
resulting linear gradient
- - - - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
width:Number — The width of the gradient box. - - - -
 
height:Number — The height of the gradient box. - - - -
 
rotation:Number (default = 0) — The amount to rotate, in radians. - - - -
 
tx:Number (default = 0) — The distance, in pixels, to translate to the right along the x axis. - - This value is offset by half of the width parameter. - - - -
 
ty:Number (default = 0) — The distance, in pixels, to translate down along the y axis. - - - - This value is offset by half of the height parameter. - - -
-

-See also -

-
-flash.display.Graphics.beginGradientFill() -
-flash.display.Graphics.lineGradientStyle() -
-
-Example -
The following example sets the x scale, y scale, rotation, x location, - and y location of myMatrix by calling its createBox() method. -
-
-
-package
-{
-    import flash.display.GradientType;
-	import flash.display.Sprite;
-	import flash.geom.Matrix;
-	
-	public class Matrix_createGradientBox extends Sprite
-	{
-		public function Matrix_createGradientBox()
-		{
-		     var myMatrix:Matrix = new Matrix();
-		     trace(myMatrix.toString());          // (a=1, b=0, c=0, d=1, tx=0, ty=0)
-		     
-		     myMatrix.createGradientBox(200, 200, 0, 50, 50);
-		     trace(myMatrix.toString());          // (a=0.1220703125, b=0, c=0, d=0.1220703125, tx=150, ty=150)
-		     
-		     var colors:Array = [0xFF0000, 0x0000FF];
-		     var alphas:Array = [100, 100];
-		     var ratios:Array = [0, 0xFF];
-		     
-		     this.graphics.beginGradientFill(GradientType.LINEAR, colors, alphas, ratios, myMatrix);
-		     this.graphics.drawRect(0, 0, 300, 200);
-		}
-	}
-}
-
-

-
- - - - - -
deltaTransformPoint()method 
-
-public function deltaTransformPoint(point:Point):Point -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Given a point in the pretransform coordinate space, returns the coordinates of - - that point after the transformation occurs. Unlike the standard transformation applied using - - the transformPoint() method, the deltaTransformPoint() method's - - transformation does not consider the translation parameters tx and ty. - - - -

Parameters - - - - -
point:Point — The point for which you want to get the result of the matrix transformation. - - - -
-

-Returns - - - - -
Point — - The point resulting from applying the matrix transformation. - - - - - -
-
- - - - - -
deltaTransformPointToOutput()method 
-
-public function deltaTransformPointToOutput(point:Point, output:Point):Point -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 33.1 - -
-

- - Given a point in the pretransform coordinate space, returns the coordinates of - - that point after the transformation occurs. Unlike the standard transformation applied using - - the transformPoint() method, the deltaTransformPoint() method's - - transformation does not consider the translation parameters tx and ty. - - - -

Parameters - - - - - - - - - - -
point:Point — The point for which you want to get the result of the matrix transformation. - -
 
output:Point — An optional point to be set with the output value and returned, to avoid the runtime creating a new point object. - - - -
-

-Returns - - - - -
Point — - The point resulting from applying the matrix transformation. - - - - - -
-
- - - - - -
identity()method 
-
-public function identity():void -

- - - - -
Language version: ActionScript 3.0 - - - - -
- - - - -
Runtime version: 
-

- - Sets each matrix property to a value that causes a null transformation. An object transformed - - by applying an identity matrix will be identical to the original. - - - -

After calling the identity() method, the resulting matrix has the following properties: - - a=1, b=0, c=0, d=1, tx=0, ty=0.

- - -

In matrix notation, the identity matrix looks like this:

- - -

Matrix class properties in matrix notation

- - - -
- - - - - -
invert()method 
-
-public function invert():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Performs the opposite transformation - - of the original matrix. You can apply an inverted matrix to an object to undo the transformation - - performed when applying the original matrix. - - -


-Example -
The following example creates a halfScaleMatrix by calling the - invert() method of doubleScaleMatrix. It then demonstrates that - the two are Matrix inverses of one another -- matrices that undo any - transformations performed by the other -- by creating originalAndInverseMatrix - which is equal to noScaleMatrix. -
-
-
-package
-{
-    import flash.display.Shape;
-	import flash.display.Sprite;
-	import flash.geom.Matrix;
-	import flash.geom.Transform;
-	
-	public class Matrix_invert extends Sprite
-	{
-		public function Matrix_invert()
-		{
-			var rect0:Shape = createRectangle(20, 80, 0xFF0000);   
-			var rect1:Shape = createRectangle(20, 80, 0x00FF00);   
-			var rect2:Shape = createRectangle(20, 80, 0x0000FF);
-			var rect3:Shape = createRectangle(20, 80, 0x000000);
-			
-			var trans0:Transform = new Transform(rect0);
-			var trans1:Transform = new Transform(rect1);
-			var trans2:Transform = new Transform(rect2);
-			var trans3:Transform = new Transform(rect3);
-			 
-			var doubleScaleMatrix:Matrix = new Matrix(2, 0, 0, 2, 0, 0);
-			trans0.matrix = doubleScaleMatrix;
-			trace(doubleScaleMatrix.toString());  // (a=2, b=0, c=0, d=2, tx=0, ty=0)
-			 
-			var noScaleMatrix:Matrix = new Matrix(1, 0, 0, 1, 0, 0);
-			trans1.matrix = noScaleMatrix;
-			rect1.x = 50;
-			trace(noScaleMatrix.toString());  // (a=1, b=0, c=0, d=1, tx=0, ty=0)
-			 
-			var halfScaleMatrix:Matrix = doubleScaleMatrix.clone();
-			halfScaleMatrix.invert();
-			trans2.matrix = halfScaleMatrix;
-			rect2.x = 100;
-			trace(halfScaleMatrix.toString());  // (a=0.5, b=0, c=0, d=0.5, tx=0, ty=0)
-			 
-			var originalAndInverseMatrix:Matrix = doubleScaleMatrix.clone();
-			originalAndInverseMatrix.concat(halfScaleMatrix);
-			trans3.matrix = originalAndInverseMatrix;
-			rect3.x = 150;
-			trace(originalAndInverseMatrix.toString());  // (a=1, b=0, c=0, d=1, tx=0, ty=0)			
-		}
-		
-		public function createRectangle(w:Number, h:Number, color:Number):Shape 
-		{
-			var rect:Shape = new Shape();
-			rect.graphics.beginFill(color);
-			rect.graphics.drawRect(0, 0, w, h);
-			addChild(rect);
-			return rect;
-		}
-	}
-}
-
-

-
- - - - - -
rotate()method 
-
-public function rotate(angle:Number):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Applies a rotation transformation to the Matrix object. - - -

The rotate() method alters the a, b, c, - - and d properties of the Matrix object. - - In matrix notation, this is the same as concatenating the current matrix with the following:

- - - -

Matrix notation of scale method parameters

- - - - Parameters - - - - -
angle:Number — The rotation angle in radians. - - - - -
-
- - - - - -
scale()method 
-
-public function scale(sx:Number, sy:Number):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Applies a scaling transformation to the matrix. The x axis is multiplied - - by sx, and the y axis it is multiplied by sy. - - -

The scale() method alters the a and d properties of - - the Matrix object. - - In matrix notation, this is the same as concatenating the current matrix with the following matrix:

- -

Matrix notation of scale method parameters

- - - Parameters - - - - - - - - - - -
sx:Number — A multiplier used to scale the object along the x axis. - -
 
sy:Number — A multiplier used to scale the object along the y axis. - - - -
-
- - - - - -
setTo()method 
-
-public function setTo(aa:Number, ba:Number, ca:Number, da:Number, txa:Number, tya:Number):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Sets the members of Matrix to the specified values - - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
aa:Number — the values to set the matrix to. - - - -
 
ba:Number
 
ca:Number
 
da:Number
 
txa:Number
 
tya:Number
-
- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a text value listing the properties of the Matrix object. - - -

-Returns - - - - -
String — - A string containing the values of the properties of the Matrix object: a, b, c, - - d, tx, and ty. - - - -
-
- - - - - -
transformPoint()method 
-
-public function transformPoint(point:Point):Point -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the result of applying the geometric transformation represented by the Matrix object to the - - specified point. - - - -

Parameters - - - - -
point:Point — The point for which you want to get the result of the Matrix transformation. - - - -
-

-Returns - - - - -
Point — - The point resulting from applying the Matrix transformation. - - - - - - - -
-
- - - - - -
transformPointToOutput()method 
-
-public function transformPointToOutput(point:Point, output:Point):Point -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 33.1 - -
-

- - Returns the result of applying the geometric transformation represented by the Matrix object to the - - specified point. - - - -

Parameters - - - - - - - - - - -
point:Point — The point for which you want to get the result of the Matrix transformation. - -
 
output:Point — An optional point to be set with the output value and returned, to avoid the runtime creating a new point object. - - - -
-

-Returns - - - - -
Point — - The point resulting from applying the Matrix transformation. - - - -
-
- - - - - -
translate()method 
-
-public function translate(dx:Number, dy:Number):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Translates the matrix along the x and y axes, as specified by the dx - - and dy parameters. - - -

Parameters - - - - - - - - - - -
dx:Number — The amount of movement along the x axis to the right, in pixels. - - - -
 
dy:Number — The amount of movement down along the y axis, in pixels. - - - - -
-
- -
Examples
-
examples\MatrixExample
-
The following example uses the MatrixExample class to show - how a large gradient-filled square can be created. This is accomplished with the following - steps: -
    -
  1. The application creates a new Matrix object myMatrix, and it uses the - trace() method to output - the default property values for the myMatrix object.
    2. -
  2. The application calls the createGradientBox() with the width - and height parameters set to 200 pixels, no rotation, and the distance to translate along - the x and y axes set to 50 pixels.
    3. -
  3. The application prints the myMatrix object again to show the change after calling - createGradientBox().
    4. -
  4. The application sets up three variables to control how the gradient box is filled: -
      -
    • colors: Sets the gradient colors to range between solid red and solid blue.
      • -
    • alphas: Sets the opacity to solid.
      • -
    • ratios: Sets the distribution of the colors to be equal for both red and blue.
      • -
    5. -
  5. The application calls the graphics method beginGradientFill(), which operates on the myMatrix - object, and it calls the lineTo() method, resulting in the gradient-filled box.
    6. -
-
-
-package {
-	import flash.geom.Matrix;
-	import flash.display.Sprite;
-	import flash.display.GradientType;
-
-	public class MatrixExample extends Sprite {
-
-		public function MatrixExample() {
-			var myMatrix:Matrix = new Matrix();
-			trace(myMatrix.toString());    // (a=1, b=0, c=0, d=1, tx=0, ty=0)
-
-			myMatrix.createGradientBox(200, 200, 0, 50, 50);
-			trace(myMatrix.toString());    // (a=0.1220703125, b=0, c=0, d=0.1220703125, tx=150, ty=150)
-
-			var colors:Array = [0xFF0000, 0x0000FF];
-			var alphas:Array = [1, 1];
-			var ratios:Array = [0, 0xFF];
-			graphics.beginGradientFill(GradientType.LINEAR, colors, alphas, ratios, myMatrix);
-			graphics.lineTo(0, 300);
-			graphics.lineTo(300, 300);
-			graphics.lineTo(300, 0);
-			graphics.lineTo(0, 0);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/geom/Matrix3D.html b/html-docs/flash/geom/Matrix3D.html deleted file mode 100644 index 8ae0d47..0000000 --- a/html-docs/flash/geom/Matrix3D.html +++ /dev/null @@ -1,2877 +0,0 @@ - - - - - - - - -flash.geom.Matrix3D (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.geom
Classpublic class Matrix3D
InheritanceMatrix3D Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The Matrix3D class represents a transformation matrix that determines the position and orientation of - a three-dimensional (3D) display object. The matrix can perform transformation functions including - translation (repositioning along the x, y, and z axes), rotation, and scaling (resizing). - The Matrix3D class can also perform perspective projection, which maps points from the 3D coordinate space - to a two-dimensional (2D) view. -

A single matrix can combine multiple transformations and apply them at once to a 3D display object. - For example, a matrix can be applied to 3D coordinates to perform a rotation followed by a translation.

-

When you explicitly set the z property or any of the rotation or scaling - properties of a display object, a corresponding Matrix3D object is automatically created.

- -

You can access a 3D display object's Matrix3D object through the transform.matrix3d - property. 2D objects do not have a Matrix3D object.

-

The value of the z property of a 2D object is zero and the value of its - matrix3D property is null.

-

Note: If the same Matrix3D object is assigned to two different display objects, - a runtime error is thrown.

-

The Matrix3D class uses a 4x4 square matrix: a table of four rows and columns of numbers that hold - the data for the transformation. The first three rows of the matrix hold data for each 3D - axis (x,y,z). The translation information is in the last column. The orientation - and scaling data are in the first three columns. The scaling factors are the diagonal numbers in - the first three columns. Here is a representation of Matrix3D elements:

-

Matrix3D elements

-

You don't need to understand matrix mathematics to use the Matrix3D class. - It offers specific methods that simplify the task of transformation and projection, such as the - appendTranslation(), appendRotation(), or interpolateTo() methods. - You also can use the decompose() and recompose() methods or the rawData - property to access the underlying matrix elements.

-

Display objects cache their axis rotation properties to have separate rotation for each axis - and to manage the different combinations of rotations. When a method of a Matrix3D object is called - to transform a display object, the rotation cache of the object is invalidated.

-

-

-See also -

-
-flash.display.DisplayObject -
-flash.geom.Transform -
-flash.geom.PerspectiveProjection -
-flash.geom.Vector3D -
-flash.geom.Orientation3D -
-flash.geom.Utils3D -
-flash.geom.Matrix -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  determinant : Number -
[read-only] - A Number that determines whether a matrix is invertible.
-		Matrix3D
  position : Vector3D -
- A Vector3D object that holds the position, the 3D coordinate (x,y,z) of a display object - within the transformation's frame of reference.
-		Matrix3D
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rawData : Vector.<Number>
- A Vector of 16 Numbers, where every four elements is - a column of a 4x4 matrix.
-		Matrix3D
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Matrix3D(v:Vector.<Number> = null)
-
- Creates a Matrix3D object.
-		Matrix3D
   -
-append(lhs:Matrix3D):void -
-
- Appends the matrix by multiplying another Matrix3D object by the current Matrix3D object.
-		Matrix3D
   -
-appendRotation(degrees:Number, axis:Vector3D, pivotPoint:Vector3D = null):void -
-
- Appends an incremental rotation to a Matrix3D object.
-		Matrix3D
   -
-appendScale(xScale:Number, yScale:Number, zScale:Number):void -
-
- Appends an incremental scale change along the x, y, and z axes - to a Matrix3D object.
-		Matrix3D
   -
-appendTranslation(x:Number, y:Number, z:Number):void -
-
- Appends an incremental translation, a repositioning along the x, y, and z axes, - to a Matrix3D object.
-		Matrix3D
   -
-clone():Matrix3D -
-
- Returns a new Matrix3D object that is an exact copy of the current Matrix3D object.
-		Matrix3D
   -
-copyColumnFrom(column:uint, vector3D:Vector3D):void -
-
- Copies a Vector3D object into specific column of the calling Matrix3D object.
-		Matrix3D
   -
-copyColumnTo(column:uint, vector3D:Vector3D):void -
-
- Copies specific column of the calling Matrix3D object into the Vector3D object.
-		Matrix3D
   -
-copyFrom(sourceMatrix3D:Matrix3D):void -
-
- Copies all of the matrix data from the source Matrix3D object into the - calling Matrix3D object.
-		Matrix3D
   -
-copyRawDataFrom(vector:Vector.<Number>, index:uint = 0, transpose:Boolean = false):void -
-
- Copies all of the vector data from the source vector object into the - calling Matrix3D object.
-		Matrix3D
   -
-copyRawDataTo(vector:Vector.<Number>, index:uint = 0, transpose:Boolean = false):void -
-
- Copies all of the matrix data from the calling Matrix3D object into the - provided vector.
-		Matrix3D
   -
-copyRowFrom(row:uint, vector3D:Vector3D):void -
-
- Copies a Vector3D object into specific row of the calling Matrix3D object.
-		Matrix3D
   -
-copyRowTo(row:uint, vector3D:Vector3D):void -
-
- Copies specific row of the calling Matrix3D object into the Vector3D object.
-		Matrix3D
   -
-copyToMatrix3D(dest:Matrix3D):void -
-
-		Matrix3D
   -
-decompose(orientationStyle:String = "eulerAngles"):Vector.<Vector3D>
-
- Returns the transformation matrix's translation, rotation, and scale settings as - a Vector of three Vector3D objects.
-		Matrix3D
   -
-decomposeToOutput(orientationStyle:String = "eulerAngles", output:Vector.<Vector3D> = null):Vector.<Vector3D>
-
- Returns the transformation matrix's translation, rotation, and scale settings as - a Vector of three Vector3D objects.
-		Matrix3D
   -
-deltaTransformVector(v:Vector3D):Vector3D -
-
- Uses the transformation matrix without its translation elements - to transform a Vector3D object from one space coordinate to another.
-		Matrix3D
   -
-deltaTransformVectorToOutput(v:Vector3D, output:Vector3D):Vector3D -
-
- Uses the transformation matrix to transform a Vector3D object from one space coordinate - to another.
-		Matrix3D
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-identity():void -
-
- Converts the current matrix to an identity or unit matrix.
-		Matrix3D
   -
-interpolate(thisMat:Matrix3D, toMat:Matrix3D, percent:Number):Matrix3D -
-
[static] - Interpolates the translation, rotation, and scale transformation of one matrix toward those of the - target matrix.
-		Matrix3D
   -
-interpolateTo(toMat:Matrix3D, percent:Number):void -
-
- Interpolates this matrix towards the translation, rotation, and scale transformations of the target matrix.
-		Matrix3D
   -
-interpolateToOutput(thisMat:Matrix3D, toMat:Matrix3D, percent:Number, output:Matrix3D):Matrix3D -
-
[static] - Interpolates the translation, rotation, and scale transformation of one matrix toward those of the - target matrix.
-		Matrix3D
   -
-invert():Boolean -
-
- Inverts the current matrix.
-		Matrix3D
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-pointAt(pos:Vector3D, at:Vector3D = null, up:Vector3D = null):void -
-
- Rotates the display object so that it faces a specified position.
-		Matrix3D
   -
-prepend(rhs:Matrix3D):void -
-
- Prepends a matrix by multiplying the current Matrix3D object by another Matrix3D object.
-		Matrix3D
   -
-prependRotation(degrees:Number, axis:Vector3D, pivotPoint:Vector3D = null):void -
-
- Prepends an incremental rotation to a Matrix3D object.
-		Matrix3D
   -
-prependScale(xScale:Number, yScale:Number, zScale:Number):void -
-
- Prepends an incremental scale change along the x, y, and z axes to a Matrix3D object.
-		Matrix3D
   -
-prependTranslation(x:Number, y:Number, z:Number):void -
-
- Prepends an incremental translation, a repositioning along the x, y, - and z axes, to a Matrix3D object.
-		Matrix3D
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-recompose(components:Vector.<Vector3D>, orientationStyle:String = "eulerAngles"):Boolean -
-
- Sets the transformation matrix's translation, rotation, and scale settings.
-		Matrix3D
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-transformVector(v:Vector3D):Vector3D -
-
- Uses the transformation matrix to transform a Vector3D object from one space coordinate - to another.
-		Matrix3D
   -
-transformVectors(vin:Vector.<Number>, vout:Vector.<Number>):void -
-
- Uses the transformation matrix to transform a Vector of Numbers from one - coordinate space to another.
-		Matrix3D
   -
-transformVectorToOutput(v:Vector3D, output:Vector3D):Vector3D -
-
- Uses the transformation matrix to transform a Vector3D object from one space coordinate - to another.
-		Matrix3D
   -
-transpose():void -
-
- Converts the current Matrix3D object to a matrix where the rows and columns - are swapped.
-		Matrix3D
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
determinantproperty
-
-determinant:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A Number that determines whether a matrix is invertible. - -

A Matrix3D object must be invertible. You can use the determinant - property to make sure that a Matrix3D object is invertible. If determinant is zero, - an inverse of the matrix does not exist. For example, if an entire row or column - of a matrix is zero or if two rows or columns are equal, the determinant is zero. - Determinant is also used to solve a series of equations.

-

Only a square matrix, like the Matrix3D class, has a determinant.

- Implementation -
-    public function get determinant():Number -
-

-See also -

-
-invert() -
-
- - - - - -
positionproperty 
-
-position:Vector3D  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A Vector3D object that holds the position, the 3D coordinate (x,y,z) of a display object - within the transformation's frame of reference. The position property provides immediate - access to the translation vector of the display object's matrix without needing to decompose and - recompose the matrix. - -

With the position property, you can get and set the translation elements - of the transformation matrix.

- Implementation -
-    public function get position():Vector3D -
-    public function set position(value:Vector3D):void -
-

-See also -

-
-appendTranslation() -
-prependTranslation() -
-
- - - - - -
rawDataproperty 
-
-rawData:Vector.<Number>  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A Vector of 16 Numbers, where every four elements is - a column of a 4x4 matrix. -

An exception is thrown if the rawData property is set to a matrix - that is not invertible. The Matrix3D object must be invertible. If a non-invertible matrix - is needed, create a subclass of the Matrix3D object.

- Implementation -
-    public function get rawData():Vector.<Number> -
-    public function set rawData(value:Vector.<Number>):void -
-

-See also -

-
-Vector -
-
- -
Constructor detail
- - - - - -
Matrix3D()constructor
-
-public function Matrix3D(v:Vector.<Number> = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a Matrix3D object. Matrix3D objects can be initialized with a Vector of 16 Numbers, - where every four elements is a column. Once the Matrix3D object is created, - you can access its matrix elements with the rawData property. -

If no parameter is defined, the constructor produces an identity or unit Matrix3D object. - In matrix notation, an identity matrix has a value of one for all elements on the main diagonal - position and a value of zero for all other elements. The value of the rawData property - of an identity matrix is: 1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1. The position or translation - value of the identity matrix is Vector3D(0,0,0), the rotation setting is - Vector3D(0,0,0), and the scale value is Vector3D(1,1,1).

- Parameters - - - - -
v:Vector.<Number> (default = null) — A Vector of 16 Numbers, where each four elements is a column - of a 4x4 matrix. -
-

-See also -

-
-identity() -
-Vector -
-
- -
Method detail
- - - - - -
append()method
-
-public function append(lhs:Matrix3D):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Appends the matrix by multiplying another Matrix3D object by the current Matrix3D object. - The result combines both matrix transformations. You can multiply a Matrix3D object - by many matrixes. The final Matrix3D object contains the result of all the - transformations. -

Matrix multiplication is different from matrix addition. Matrix multiplication is not commutative. - In other words, A times B is not equal to B times A. With the append() method, - the multiplication happens from the left side, meaning the lhs Matrix3D object is - on the left side of the multiplication operator.

- thisMatrix = lhs * thisMatrix; - -

The first time the append() method is called, it makes a modification relative - to the parent space. Subsequent calls are relative to the frame of reference of the appended - Matrix3D object.

-

The append() method replaces the current matrix with the appended matrix. - If you want to append two matrixes without altering the current matrix, copy the - current matrix by using the clone() method and then apply the append() - method to the copy.

- Parameters - - - - -
lhs:Matrix3D — A left-hand-side matrix that is multiplied by the current Matrix3D object. -
-

-See also -

-
-flash.geom.Matrix3D.prepend() -
-
- - - - - -
appendRotation()method 
-
-public function appendRotation(degrees:Number, axis:Vector3D, pivotPoint:Vector3D = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Appends an incremental rotation to a Matrix3D object. When the Matrix3D object is applied - to a display object, the matrix performs the rotation after other transformations in the Matrix3D - object. -

The display object's rotation is defined by an axis, an incremental degree - of rotation around the axis, and an optional pivot point for the center of the object's rotation. - The axis can be any general direction. The common axes are the X_AXIS (Vector3D(1,0,0)), - Y_AXIS (Vector3D(0,1,0)), and Z_AXIS (Vector3D(0,0,1)). - In aviation terminology, the rotation about the y axis is called yaw. The rotation about the x axis is - called pitch. The rotation about the z axis is called roll.

- -

The order of transformation matters. A rotation followed by a translation transformation - produces a different effect than a translation followed by a rotation transformation.

-

The rotation effect is not absolute. It is relative to the current position and orientation. - To make an absolute change to the transformation matrix, use the recompose() method. - The appendRotation() method is also different from the axis rotation property of - the display object, such as rotationX property. The rotation property is always - performed before any translation, whereas the appendRotation() method is performed - relative to what is already in the matrix. To make sure that you get a similar effect as the display - object's axis rotation property, use the prependRotation() method, which performs - the rotation before other transformations in the matrix.

- -

When the appendRotation() method's transformation is applied to a Matrix3D object - of a display object, the cached rotation property values of the display object are invalidated.

-

One way to have a display object rotate around a specific point relative to its location is - to set the translation of the object to the specified point, rotate the object using the appendRotation() - method, and translate the object back to the original position. In the following example, the - myObject 3D display object makes a y-axis rotation around - the coordinate (10,10,0).

- 
-    
-    myObject.z = 1; 
-    myObject.transform.matrix3D.appendTranslation(10,10,0);
-    myObject.transform.matrix3D.appendRotation(1, Vector3D.Y_AXIS);
-    myObject.transform.matrix3D.appendTranslation(-10,-10,0);
-     
-
- - Parameters - - - - - - - - - - - - - - - - -
degrees:Number — The degree of the rotation. -
 
axis:Vector3D — The axis or direction of rotation. The usual axes are the X_AXIS (Vector3D(1,0,0)), - Y_AXIS (Vector3D(0,1,0)), and Z_AXIS (Vector3D(0,0,1)). - This vector should have a length of one. -
 
pivotPoint:Vector3D (default = null) — A point that determines the center of an object's rotation. The default pivot point - for an object is its registration point. -
-

-See also -

-
-prependRotation() -
-
- - - - - -
appendScale()method 
-
-public function appendScale(xScale:Number, yScale:Number, zScale:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Appends an incremental scale change along the x, y, and z axes - to a Matrix3D object. When the Matrix3D object is applied to a display object, the matrix performs - the scale changes after other transformations in the Matrix3D object. The default scale - factor is (1.0, 1.0, 1.0). -

The scale is defined as a set of three incremental changes along the three axes (x,y,z). - You can multiply each axis with a different number. When the scale changes are applied to - a display object, the object's size increases or decreases. For example, setting - the x, y, and z axes to two doubles the size of the object, while - setting the axes to 0.5 halves the size. To make sure that - the scale transformation only affects a specific axis, set the other parameters to one. - A parameter of one means no scale change along the specific axis.

-

The appendScale() method can be used for resizing as well as - for managing distortions, such as stretch or contract of a display object, or for zooming in - and out on a location. Scale transformations are automatically performed during a display - object's rotation and translation.

-

The order of transformation matters. A resizing followed by a translation transformation - produces a different effect than a translation followed by a resizing transformation.

- Parameters - - - - - - - - - - - - - - - - -
xScale:Number — A multiplier used to scale the object along the x axis. -
 
yScale:Number — A multiplier used to scale the object along the y axis. -
 
zScale:Number — A multiplier used to scale the object along the z axis. -
-

-See also -

-
-prependScale() -
-
- - - - - -
appendTranslation()method 
-
-public function appendTranslation(x:Number, y:Number, z:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Appends an incremental translation, a repositioning along the x, y, and z axes, - to a Matrix3D object. When the Matrix3D object is applied to a display object, the matrix performs - the translation changes after other transformations in the Matrix3D object. -

The translation is defined as a set of three incremental changes along the three axes (x,y,z). - When the transformation is applied to a display object, the display object moves from it current - location along the x, y, and z axes as specified by the parameters. - To make sure that the translation only affects a specific axis, set the other parameters to zero. - A zero parameter means no change along the specific axis.

-

The translation changes are not absolute. They are relative to the current - position and orientation of the matrix. To make an absolute change to the transformation matrix, - use the recompose() method. The order of transformation also matters. A translation - followed by a rotation transformation produces a different effect than a rotation followed - by a translation.

- Parameters - - - - - - - - - - - - - - - - -
x:Number — An incremental translation along the x axis. -
 
y:Number — An incremental translation along the y axis. -
 
z:Number — An incremental translation along the z axis. -
-

-See also -

-
-prependTranslation() -
-position -
-
- - - - - -
clone()method 
-
-public function clone():Matrix3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a new Matrix3D object that is an exact copy of the current Matrix3D object. -

-Returns - - - - -
Matrix3D — - A new Matrix3D object that is an exact copy of the current Matrix3D object. - - -
-
- - - - - -
copyColumnFrom()method 
-
-public function copyColumnFrom(column:uint, vector3D:Vector3D):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Copies a Vector3D object into specific column of the calling Matrix3D object. - -

Parameters - - - - - - - - - - -
column:uint — The destination column of the copy. -
 
vector3D:Vector3D — The Vector3D object from which to copy the data. - -
-
- - - - - -
copyColumnTo()method 
-
-public function copyColumnTo(column:uint, vector3D:Vector3D):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Copies specific column of the calling Matrix3D object into the Vector3D object. - -

Parameters - - - - - - - - - - -
column:uint — The column from which to copy the data. -
 
vector3D:Vector3D — The destination Vector3D object of the copy. - -
-
- - - - - -
copyFrom()method 
-
-public function copyFrom(sourceMatrix3D:Matrix3D):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Copies all of the matrix data from the source Matrix3D object into the - calling Matrix3D object. - -

Parameters - - - - -
sourceMatrix3D:Matrix3D — The Matrix3D object from which to copy the data. - -
-
- - - - - -
copyRawDataFrom()method 
-
-public function copyRawDataFrom(vector:Vector.<Number>, index:uint = 0, transpose:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Copies all of the vector data from the source vector object into the - calling Matrix3D object. The optional index parameter allows you to select any - starting slot in the vector. - -

Parameters - - - - - - - - - - - - - - - - -
vector:Vector.<Number> — The vector object from which to copy the data. - -
 
index:uint (default = 0)
 
transpose:Boolean (default = false)
-
- - - - - -
copyRawDataTo()method 
-
-public function copyRawDataTo(vector:Vector.<Number>, index:uint = 0, transpose:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Copies all of the matrix data from the calling Matrix3D object into the - provided vector. The optional index parameter allows you to select any - target starting slot in the vector. - -

Parameters - - - - - - - - - - - - - - - - -
vector:Vector.<Number> — The vector object to which to copy the data. - -
 
index:uint (default = 0)
 
transpose:Boolean (default = false)
-
- - - - - -
copyRowFrom()method 
-
-public function copyRowFrom(row:uint, vector3D:Vector3D):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Copies a Vector3D object into specific row of the calling Matrix3D object. - -

Parameters - - - - - - - - - - -
row:uint — The row from which to copy the data to. -
 
vector3D:Vector3D — The Vector3D object from which to copy the data. - -
-
- - - - - -
copyRowTo()method 
-
-public function copyRowTo(row:uint, vector3D:Vector3D):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Copies specific row of the calling Matrix3D object into the Vector3D object. - -

Parameters - - - - - - - - - - -
row:uint — The row from which to copy the data from. -
 
vector3D:Vector3D — The Vector3D object to copy the data into. - -
-
- - - - - -
copyToMatrix3D()method 
-
-public function copyToMatrix3D(dest:Matrix3D):voidParameters - - - - -
dest:Matrix3D
-
- - - - - -
decompose()method 
-
-public function decompose(orientationStyle:String = "eulerAngles"):Vector.<Vector3D> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the transformation matrix's translation, rotation, and scale settings as - a Vector of three Vector3D objects. The first Vector3D object holds the translation - elements. The second Vector3D object holds the rotation elements. The third Vector3D object - holds the scale elements. -

Some Matrix3D methods, such as the interpolateTo() method, automatically - decompose and recompose the matrix to perform their transformation.

- -

To modify the matrix's transformation with an absolute parent frame of reference, - retrieve the settings with the decompose() method and make the appropriate changes. - You can then set the Matrix3D object to the modified transformation using the recompose() - method.

-

The decompose() method's parameter specifies the orientation style that - is meant to be used for the transformation. The default orientation is eulerAngles, - which defines the orientation with three separate angles of rotation for each axis. - The rotations occur consecutively and do not change the axis of each other. The - display object's axis rotation properties perform Euler Angles orientation style transformation. - The other orientation style options are axisAngle and quaternion. - The Axis Angle orientation uses a combination of an axis and an angle to determine the orientation. - The axis around which the object is rotated is a unit vector that represents a direction. - The angle represents the magnitude of the rotation about the vector. The direction also - determines where a display object is facing and the angle determines which way is up. - The appendRotation() and prependRotation() methods use the Axis Angle orientation. - The quaternion orientation uses complex numbers and the fourth element of a vector. - The three axes of rotation (x,y,z) and an angle of rotation (w) represent the orientation. - The interpolate() method uses quaternion.

- Parameters - - - - -
orientationStyle:String (default = "eulerAngles") — An optional parameter that determines the orientation style - used for the matrix transformation. The three types of orientation style are - eulerAngles (constant EULER_ANGLES), axisAngle - (constant AXIS_ANGLE), and quaternion (constant QUATERNION). - For additional information on the different orientation style, see the geom.Orientation3D class. -
-

-Returns - - - - -
Vector.<Vector3D> — A Vector of three Vector3D objects, each holding the translation, rotation, and scale - settings, respectively. -
-

-See also -

-
-flash.geom.Orientation3D -
-recompose() -
-Vector -
-
-Example -
This example uses the decompose() - and recompose() methods to have an ellipse stretch horizontally - while moving toward the vanishing point. The first Vector3D object returned - by the decompose() method holds the translation coordinates. The - third Vector3D object holds the scale settings. The Vector3D object's - incrementBy() method increments the matrix's absolute translation - and scale settings. -
-
-package {
-    import flash.display.MovieClip;
-    import flash.display.Shape;
-    import flash.geom.*;
-    import flash.events.Event;
-    
-    public class Matrix3DdecomposeExample extends MovieClip {
-        private var ellipse:Shape = new Shape();
-
-        public function Matrix3DdecomposeExample():void {
-            
-            ellipse.x = (this.stage.stageWidth / 2);
-            ellipse.y = (this.stage.stageHeight - 40);
-            ellipse.z = 1;
-            ellipse.graphics.beginFill(0xFF0000);
-            ellipse.graphics.lineStyle(2);
-            ellipse.graphics.drawEllipse(0, 0, 50, 40);
-            ellipse.graphics.endFill();
-            addChild(ellipse);
-
-            ellipse.addEventListener(Event.ENTER_FRAME, enterFrameHandler);
-        }
-
-        private function enterFrameHandler(e:Event):void {  
-
-            var v3:Vector.<Vector3D> = new Vector.<Vector3D>(3);
-            v3 = ellipse.transform.matrix3D.decompose();
-            v3[0].incrementBy(new Vector3D(0,0,1));
-            v3[2].incrementBy(new Vector3D(0.01,0,0));
-            ellipse.transform.matrix3D.recompose(v3);
-        }
-    }
-}
-
-

-
- - - - - -
decomposeToOutput()method 
-
-public function decomposeToOutput(orientationStyle:String = "eulerAngles", output:Vector.<Vector3D> = null):Vector.<Vector3D> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Returns the transformation matrix's translation, rotation, and scale settings as - a Vector of three Vector3D objects. The first Vector3D object holds the translation - elements. The second Vector3D object holds the rotation elements. The third Vector3D object - holds the scale elements. -

Some Matrix3D methods, such as the interpolateTo() method, automatically - decompose and recompose the matrix to perform their transformation.

- -

To modify the matrix's transformation with an absolute parent frame of reference, - retrieve the settings with the decompose() method and make the appropriate changes. - You can then set the Matrix3D object to the modified transformation using the recompose() - method.

-

The decompose() method's parameter specifies the orientation style that - is meant to be used for the transformation. The default orientation is eulerAngles, - which defines the orientation with three separate angles of rotation for each axis. - The rotations occur consecutively and do not change the axis of each other. The - display object's axis rotation properties perform Euler Angles orientation style transformation. - The other orientation style options are axisAngle and quaternion. - The Axis Angle orientation uses a combination of an axis and an angle to determine the orientation. - The axis around which the object is rotated is a unit vector that represents a direction. - The angle represents the magnitude of the rotation about the vector. The direction also - determines where a display object is facing and the angle determines which way is up. - The appendRotation() and prependRotation() methods use the Axis Angle orientation. - The quaternion orientation uses complex numbers and the fourth element of a vector. - The three axes of rotation (x,y,z) and an angle of rotation (w) represent the orientation. - The interpolate() method uses quaternion.

- Parameters - - - - - - - - - - -
orientationStyle:String (default = "eulerAngles") — An optional parameter that determines the orientation style - used for the matrix transformation. The three types of orientation style are - eulerAngles (constant EULER_ANGLES), axisAngle - (constant AXIS_ANGLE), and quaternion (constant QUATERNION). - For additional information on the different orientation style, see the geom.Orientation3D class. -
 
output:Vector.<Vector3D> (default = null) — An optional vector of three Vector3D objects to be used and returned to avoid the runtime creating new objects. -
-

-Returns - - - - -
Vector.<Vector3D> — A Vector of three Vector3D objects, each holding the translation, rotation, and scale - settings, respectively. -
-

-See also -

-
-flash.geom.Orientation3D -
-recompose() -
-Vector -
-
- - - - - -
deltaTransformVector()method 
-
-public function deltaTransformVector(v:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Uses the transformation matrix without its translation elements - to transform a Vector3D object from one space coordinate to another. - The returned Vector3D object holds the new coordinates after the rotation - and scaling transformations have been applied. If the deltaTransformVector() - method applies a matrix that only contains a translation transformation, - the returned Vector3D is the same as the original Vector3D object. -

You can use the deltaTransformVector() method to have a - display object in one coordinate space respond to the rotation transformation - of a second display object. The object does not copy the rotation; - it only changes its position to reflect the changes in the rotation. - For example, to use the display.Graphics API for drawing a rotating - 3D display object, you must map the object's rotating coordinates - to a 2D point. First, retrieve the object's 3D - coordinates after each rotation, using the deltaTransformVector() method. - Next, apply the display object's local3DToGlobal() method to translate the - 3D coordinates to 2D points. You can then use - the 2D points to draw the rotating 3D object.

-

Note: This method automatically sets the w component of the passed Vector3D to 0.0. -

- Parameters - - - - -
v:Vector3D — A Vector3D object holding the coordinates that are going to be transformed. -
-

-Returns - - - - -
Vector3D — - A Vector3D object with the transformed coordinates. - - -
-

-See also -

-
-transformVectors() -
-transformVector() -
-
- - - - - -
deltaTransformVectorToOutput()method 
-
-public function deltaTransformVectorToOutput(v:Vector3D, output:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Uses the transformation matrix to transform a Vector3D object from one space coordinate - to another. The returned Vector3D object holds the new coordinates after the transformation. - All the matrix transformations including translation are applied to the Vector3D object. -

If the result of the transformVector() method was applied to the position - of a display object, only the display object's position changes. - The display object's rotation and scale elements remain the same.

-

Note: This method automatically sets the w component of the passed Vector3D to 1.0. -

- Parameters - - - - - - - - - - -
v:Vector3D — A Vector3D object holding the coordinates that are going to be transformed. -
 
output:Vector3D — An optional Vector3D object to be used and returned to avoid the runtime creating a new object. -
-

-Returns - - - - -
Vector3D — - A Vector3D object with the transformed coordinates. - - -
-

-See also -

-
-transformVectors() -
-deltaTransformVector() -
-
- - - - - -
identity()method 
-
-public function identity():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Converts the current matrix to an identity or unit matrix. An identity matrix has a value - of one for the elements on the main diagonal and a value of zero for all - other elements. The result is a matrix where the rawData value is - 1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1 and the rotation setting is set to - Vector3D(0,0,0), the position or translation setting is set to - Vector3D(0,0,0), and the scale is set to Vector3D(1,1,1). - Here is a representation of an identity matrix. -

Identity Matrix

-

An object transformed by applying an identity matrix performs no transformation. - In other words, if a matrix is multiplied by an identity matrix, the result is - a matrix that is the same as (identical to) the original matrix.

-
- - - - - -
interpolate()method 
-
-public static function interpolate(thisMat:Matrix3D, toMat:Matrix3D, percent:Number):Matrix3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Interpolates the translation, rotation, and scale transformation of one matrix toward those of the - target matrix. - -

The interpolate() method avoids some of the unwanted results that can occur when - using methods such as the display object's axis rotation properties. The interpolate() - method invalidates the cached value of the rotation property of the display - object and converts the orientation elements of the display object's matrix to a quaternion - before interpolation. This method guarantees the shortest, most efficient path for the rotation. - It also produces a smooth, gimbal-lock-free rotation. A gimbal lock can occur when using Euler Angles, - where each axis is handled independently. During the rotation around two or more axes, the axes can - become aligned, leading to unexpected results. Quaternion rotation avoids the gimbal lock.

-

Consecutive calls to the interpolate() method can produce the effect of a display - object starting quickly and then slowly approaching another display object. For example, if you set - the thisMat parameter to the returned Matrix3D object, the toMat parameter - to the target display object's - associated Matrix3D object, and the percent parameter to 0.1, - the display object moves ten percent toward the target object. On subsequent calls or in subsequent - frames, the object moves ten percent of the remaining 90 percent, then ten percent of the remaining - distance, and continues until it reaches the target.

- Parameters - - - - - - - - - - - - - - - - -
thisMat:Matrix3D — The Matrix3D object that is to be interpolated. -
 
toMat:Matrix3D — The target Matrix3D object. -
 
percent:Number — A value between 0 and 1 that determines the percent - the thisMat Matrix3D object is interpolated toward the target Matrix3D object. -
-

-Returns - - - - -
Matrix3D — - A Matrix3D object with elements that place the values of the matrix between the original matrix - and the target matrix. When the returned matrix is applied to the this display object, the - object moves the specified percent closer to the target object. - - -
-

-See also -

-
-interpolateTo() -
-flash.geom.Utils3D.pointTowards() -
-
- - - - - -
interpolateTo()method 
-
-public function interpolateTo(toMat:Matrix3D, percent:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Interpolates this matrix towards the translation, rotation, and scale transformations of the target matrix. -

The interpolateTo() method avoids the unwanted results that can occur when - using methods such as the display object's axis rotation properties. The interpolateTo() - method invalidates the cached value of the rotation property of the display - object and converts the orientation elements of the display object's matrix to a quaternion - before interpolation. This method guarantees the shortest, most efficient path for the rotation. - It also produces a smooth, gimbal-lock-free rotation. A gimbal lock can occur when using Euler Angles, - where each axis is handled independently. During the rotation around two or more axes, the axes can - become aligned, leading to unexpected results. Quaternion rotation avoids the gimbal lock.

-

Note: In case of interpolation, the scaling value of the matrix will reset - and the matrix will be normalized.

-

Consecutive calls to the interpolateTo() method can produce the effect of a display - object starting quickly and then slowly approaching another display object. For example, if the percent - parameter is set to 0.1, the display object moves ten percent toward the target object - specified by the toMat parameter. On subsequent calls or in subsequent - frames, the object moves ten percent of the remaining 90 percent, then ten percent of the - remaining distance, and continues until it reaches the target.

- Parameters - - - - - - - - - - -
toMat:Matrix3D — The target Matrix3D object. -
 
percent:Number — A value between 0 and 1 that determines the location of the display object - relative to the target. The closer the value is to 1.0, the closer the display object - is to its current position. The closer the value is to 0, the closer the display object is - to the target. -
-

-See also -

-
-interpolate() -
-
-Example -
In this example, ellipse2, a three-dimensional display object, goes - toward ellipse1, another three-dimensional display object. - ellipse2 follows ellipse1 around trying to catch it. - If ellipse1 does not rotate around its y axis, ellipse2 - will reach and land on top of ellipse1. The two ellipses are - drawn in the same way but are placed in different three-dimensional world-space locations. -
-
-package {
-    import flash.display.MovieClip;
-    import flash.display.Shape;
-    import flash.display.Graphics;
-    import flash.geom.*;
-    import flash.events.Event;
-
-    public class InterpolateToExample extends MovieClip {
-        private var ellipse1:Shape = new Shape();
-        private var ellipse2:Shape = new Shape();
-
-        public function InterpolateToExample():void {
-
-            ellipse1 = myEllipses(250, 100, 500, 0xFF0000);
-            addChild(ellipse1);
-            
-            ellipse2 = myEllipses(-30, 120, 1, 0x00FF00);
-            addChild(ellipse2);
-
-            addEventListener(Event.ENTER_FRAME, enterFrameHandler);
-        }
-
-        private function myEllipses(x:Number, y:Number, z:Number, c:Number):Shape {
-            var s:Shape = new Shape();                            
-            s.x = x;
-            s.y = y;
-            s.z = z;
-            s.graphics.beginFill(c);
-            s.graphics.lineStyle(2);
-            s.graphics.drawEllipse(100, 50, 100, 80);
-            s.graphics.endFill();
-            return s;
-        }
-
-        private function enterFrameHandler(e:Event) {
-            ellipse1.rotationY += 1;
-
-            ellipse2.transform.matrix3D.interpolateTo(ellipse1.transform.matrix3D, 0.1);
-        }
-    }
-}
-
-

-
- - - - - -
interpolateToOutput()method 
-
-public static function interpolateToOutput(thisMat:Matrix3D, toMat:Matrix3D, percent:Number, output:Matrix3D):Matrix3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Interpolates the translation, rotation, and scale transformation of one matrix toward those of the - target matrix. - -

The interpolate() method avoids some of the unwanted results that can occur when - using methods such as the display object's axis rotation properties. The interpolate() - method invalidates the cached value of the rotation property of the display - object and converts the orientation elements of the display object's matrix to a quaternion - before interpolation. This method guarantees the shortest, most efficient path for the rotation. - It also produces a smooth, gimbal-lock-free rotation. A gimbal lock can occur when using Euler Angles, - where each axis is handled independently. During the rotation around two or more axes, the axes can - become aligned, leading to unexpected results. Quaternion rotation avoids the gimbal lock.

-

Consecutive calls to the interpolate() method can produce the effect of a display - object starting quickly and then slowly approaching another display object. For example, if you set - the thisMat parameter to the returned Matrix3D object, the toMat parameter - to the target display object's - associated Matrix3D object, and the percent parameter to 0.1, - the display object moves ten percent toward the target object. On subsequent calls or in subsequent - frames, the object moves ten percent of the remaining 90 percent, then ten percent of the remaining - distance, and continues until it reaches the target.

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
thisMat:Matrix3D — The Matrix3D object that is to be interpolated. -
 
toMat:Matrix3D — The target Matrix3D object. -
 
percent:Number — A value between 0 and 1 that determines the percent - the thisMat Matrix3D object is interpolated toward the target Matrix3D object. -
 
output:Matrix3D — An optional Matrix3D object to be used and returned to avoid the runtime creating a new object. -
-

-Returns - - - - -
Matrix3D — - A Matrix3D object with elements that place the values of the matrix between the original matrix - and the target matrix. When the returned matrix is applied to the this display object, the - object moves the specified percent closer to the target object. - - -
-

-See also -

-
-interpolateTo() -
-flash.geom.Utils3D.pointTowards() -
-
- - - - - -
invert()method 
-
-public function invert():Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Inverts the current matrix. An inverted matrix is the same size as the original - but performs the opposite transformation of the original matrix. For example, - if the original matrix has an object rotate around the x axis in one direction, - the inverse of the matrix will have the object rotate around the axis in - the opposite direction. Applying an inverted matrix to an object undoes the - transformation performed by the original matrix. If a matrix is multiplied by its - inverse matrix, the result is an identity matrix. -

An inverse of a matrix can be used to divide one matrix by another. The way to divide - matrix A by matrix B is to multiply matrix A by the inverse of matrix B. The inverse matrix can also be used - with a camera space. When the camera moves in the world space, the object in the world needs to - move in the opposite direction to transform from the world view to the camera or - view space. For example, if the camera moves closer, the objects becomes bigger. - In other words, if the camera moves down the world z axis, the object moves up - world z axis.

-

The invert() method replaces the current matrix with an inverted matrix. - If you want to invert a matrix without altering the current matrix, first copy the - current matrix by using the clone() method and then apply the invert() - method to the copy.

-

The Matrix3D object must be invertible.

-

-Returns - - - - -
Boolean — - Returns true if the matrix was successfully inverted. - - -
-

-See also -

-
-determinant -
-
- - - - - -
pointAt()method 
-
-public function pointAt(pos:Vector3D, at:Vector3D = null, up:Vector3D = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Rotates the display object so that it faces a specified position. This method allows for an - in-place modification to the orientation. The forward direction vector of the display object - (the at Vector3D object) points at the specified world-relative position. - The display object's up direction is specified with the up - Vector3D object. -

The pointAt() method invalidates the cached rotation property - value of the display object. The method decomposes the display object's matrix and modifies - the rotation elements to have the object turn to the specified position. It - then recomposes (updates) the display object's matrix, which performs the transformation. - If the object is pointing at a moving target, such as a moving object's position, - then with each subsequent call, the method has the object rotate toward the moving target.

-

Note: If you use the Matrix3D.pointAt() method without setting the optional parameters, - a target object does not face the specified world-relative position by default. You need to set the values - for at to the -y-axis (0,-1,0) and up to the -z axis (0,0,-1).

- Parameters - - - - - - - - - - - - - - - - -
pos:Vector3D — The world-relative position of the target object. World-relative defines - the object's transformation relative to the world space and coordinates, where all objects are positioned. -
 
at:Vector3D (default = null) — The object-relative vector that defines where the display object is pointing. - Object-relative defines the object's transformation relative to the object space, the object's own - frame of reference and coordinate system. Default value is the +y axis (0,1,0). -
 
up:Vector3D (default = null) — The object-relative vector that defines "up" for the display object. If the object - is drawn looking down from above, the +z axis is its "up" vector. - Object-relative defines the object's transformation relative to the object space, the object's own - frame of reference and coordinate system. Default value is the +z-axis (0,0,1). -
-

-See also -

-
-flash.geom.Utils3D.pointTowards() -
-
-Example -
In this example, a triangle points and follows the path of the ellipse's - movement. The ellipse and triangle are set to different locations. - The ellipse then moves up toward the corner of the stage. The triangle - follows the ellipse's translation changes. You can change the triangle's - shape and the "at" and "up" parameters of the pointAt() - to see their impacts on the triangle's movement. -
-
-package {
-    import flash.display.MovieClip;
-    import flash.display.Shape;
-    import flash.display.Graphics;
-    import flash.geom.*;
-    import flash.events.Event;
-
-    public class PointAtExample extends MovieClip {
-        private var ellipse:Shape = new Shape();
-        private var triangle:Shape = new Shape();
-
-        public function PointAtExample():void {
-            ellipse.graphics.beginFill(0xFF0000);
-            ellipse.graphics.lineStyle(2);
-            ellipse.graphics.drawEllipse(30, 40, 50, 40);
-            ellipse.graphics.endFill();
-            ellipse.x = 100;
-            ellipse.y = 150;
-            ellipse.z = 1;
-
-            triangle.graphics.beginFill(0x0000FF);
-            triangle.graphics.moveTo(0, 0);
-            triangle.graphics.lineTo(40, 40);
-            triangle.graphics.lineTo(80, 0);
-            triangle.graphics.lineTo(0, 0);
-            triangle.graphics.endFill();
-            triangle.x = 200;
-            triangle.y = 50;
-            triangle.z = 1;
-
-            addChild(ellipse);
-            addChild(triangle);
-
-            ellipse.addEventListener(Event.ENTER_FRAME, ellipseEnterFrameHandler);
-            triangle.addEventListener(Event.ENTER_FRAME, triangleEnterFrameHandler);
-        }
-
-        private function ellipseEnterFrameHandler(e:Event) {
-            if(e.target.y > 0) {
-                e.target.y -= 1;
-                e.target.x -= 1;
-            }
-        }
-        
-        private function triangleEnterFrameHandler(e:Event) {
-            e.target.transform.matrix3D.pointAt(ellipse.transform.matrix3D.position,
-                                                Vector3D.X_AXIS, Vector3D.Y_AXIS);
-        }
-    }
-}
-
-

-
- - - - - -
prepend()method 
-
-public function prepend(rhs:Matrix3D):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Prepends a matrix by multiplying the current Matrix3D object by another Matrix3D object. - The result combines both matrix transformations. -

Matrix multiplication is different from matrix addition. Matrix multiplication is not commutative. - In other words, A times B is not equal to B times A. With the prepend() method, - the multiplication happens from the right side, meaning the rhs Matrix3D object is - on the right side of the multiplication operator.

- thisMatrix = thisMatrix * rhs - -

The modifications made by prepend() method are object-space-relative. In other words, - they are always relative to the object's initial frame of reference.

-

The prepend() method replaces the current matrix with the prepended matrix. - If you want to prepend two matrixes without altering the current matrix, first copy the - current matrix by using the clone() method and then apply the prepend() - method to the copy.

- Parameters - - - - -
rhs:Matrix3D — A right-hand-side of the matrix by which the current Matrix3D is multiplied. -
-

-See also -

-
-append() -
-
- - - - - -
prependRotation()method 
-
-public function prependRotation(degrees:Number, axis:Vector3D, pivotPoint:Vector3D = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Prepends an incremental rotation to a Matrix3D object. When the Matrix3D object is applied - to a display object, the matrix performs the rotation before other transformations in the Matrix3D - object. -

The display object's rotation is defined by an axis, an incremental degree - of rotation around the axis, and an optional pivot point for the center of the object's rotation. - The axis can be any general direction. The common axes are the X_AXIS (Vector3D(1,0,0)), - Y_AXIS (Vector3D(0,1,0)), and Z_AXIS (Vector3D(0,0,1)). - In aviation terminology, the rotation about the y axis is called yaw. - The rotation about the x axis is called pitch. - The rotation about the z axis is called roll.

-

The order of transformation matters. A rotation followed by a translation transformation - produces a different effect than a translation followed by a rotation.

-

The rotation effect is not absolute. The effect is object-relative, relative to the frame - of reference of the original position and orientation. To make an absolute change to the transformation, - use the recompose() method.

- -

When the prependRotation() method's transformation is applied to a Matrix3D object - of a display object, the cached rotation property values of the display object are invalidated.

-

One way to have a display object rotate around a specific point relative to its location is - to set the translation of the object to the specified point, rotate the object using - the prependRotation() method, and translate the object back to the original position. - In the following example, the myObject 3D display object makes a y-axis rotation around - the coordinate (10,10,0).

- 
-    
-    myObject.z = 1; 
-    myObject.transform.matrix3D.prependTranslation(10,10,0);
-    myObject.transform.matrix3D.prependRotation(1, Vector3D.Y_AXIS);
-    myObject.transform.matrix3D.prependTranslation(-10,-10,0);
-     
-
- Parameters - - - - - - - - - - - - - - - - -
degrees:Number — The degree of rotation. -
 
axis:Vector3D — The axis or direction of rotation. The usual axes are the X_AXIS (Vector3D(1,0,0)), - Y_AXIS (Vector3D(0,1,0)), and Z_AXIS (Vector3D(0,0,1)). - This vector should have a length of one. -
 
pivotPoint:Vector3D (default = null) — A point that determines the center of rotation. The default pivot point - for an object is its registration point. -
-

-See also -

-
-appendRotation() -
-
-Example -
In this example, the user can move a mouse to rotate an ellipse - around its x and y axes. The ellipse is drawn - with its registration point in its center. The ellipse rotates - around its y axis using the mouse's x coordinate. - It rotates around its x axis using the mouse's y coordinate. - -
-
-package {
-    import flash.display.MovieClip;
-    import flash.display.Shape;
-    import flash.geom.*;
-    import flash.events.MouseEvent;
-    
-    public class Matrix3DprependRotationExample extends MovieClip {
-        private var ellipse:Shape = new Shape();
-
-        public function Matrix3DprependRotationExample():void {
-
-            ellipse.graphics.beginFill(0xFF0000);
-            ellipse.graphics.lineStyle(2);
-            ellipse.graphics.drawEllipse(-50, -40, 100, 80);
-            ellipse.graphics.endFill();
-
-            ellipse.x = (this.stage.stageWidth / 2);
-            ellipse.y = (this.stage.stageHeight / 2);
-            ellipse.z = 1;
-            
-            addChild(ellipse);
-
-            stage.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
-        }
-
-        private function mouseMoveHandler(e:MouseEvent):void {
-            var y:int;
-            var x:int;
-            
-            if(e.localX > ellipse.x) {
-                y = (Math.round(e.localX) / 100);   
-            } else {
-                y = -(Math.round(e.localX) / 10);   
-            }
-            
-            if(e.localY > ellipse.y) {
-                x = (Math.round(e.localY) / 100);
-            } else {
-                x = -(Math.round(e.localY) / 100);
-            }
-            
-            ellipse.transform.matrix3D.prependRotation(y, Vector3D.Y_AXIS);
-            ellipse.transform.matrix3D.prependRotation(x, Vector3D.X_AXIS);
-        }
-        
-    }
-}
-
-

-
- - - - - -
prependScale()method 
-
-public function prependScale(xScale:Number, yScale:Number, zScale:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Prepends an incremental scale change along the x, y, and z axes to a Matrix3D object. - When the Matrix3D object is applied to a display object, the matrix performs - the scale changes before other transformations in the Matrix3D object. The changes are - object-relative, relative to the frame of reference of the original position and orientation. - The default scale factor is (1.0, 1.0, 1.0). -

The scale is defined as a set of three incremental changes along the three axes (x,y,z). - You can multiply each axis with a different number. When the scale changes are applied to - a display object, the object's size increases or decreases. For example, setting - the x, y, and z axes to two doubles the size of the object, while - setting the axes to 0.5 halves the size. To make sure that - the scale transformation only affects a specific axis, set the other parameters to one. - A parameter of one means no scale change along the specific axis.

-

The prependScale() method can be used for resizing as well as - for managing distortions, such as stretch or contract of a display object. It can also be - used for zooming in and out on a location. Scale transformations are automatically - performed during a display object's rotation and translation.

-

The order of transformation matters. A resizing followed by a translation transformation - produces a different effect than a translation followed by a resizing transformation.

- Parameters - - - - - - - - - - - - - - - - -
xScale:Number — A multiplier used to scale the object along the x axis. -
 
yScale:Number — A multiplier used to scale the object along the y axis. -
 
zScale:Number — A multiplier used to scale the object along the z axis. -
-

-See also -

-
-appendScale() -
-
- - - - - -
prependTranslation()method 
-
-public function prependTranslation(x:Number, y:Number, z:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Prepends an incremental translation, a repositioning along the x, y, - and z axes, to a Matrix3D object. When the Matrix3D object is applied to a - display object, the matrix performs the translation changes before other transformations - in the Matrix3D object. - -

Translation specifies the distance the display object moves from its current location along - the x, y, and z axes. The prependTranslation() method - sets the translation as a set of three incremental changes along the three axes (x,y,z). - To have a translation change only a specific axis, set the other parameters to zero. - A zero parameter means no change along the specific axis.

-

The translation changes are not absolute. The effect is object-relative, relative to the frame - of reference of the original position and orientation. To make an absolute change to the transformation - matrix, use the recompose() method. The order of transformation also matters. A translation - followed by a rotation transformation produces a different effect than a rotation followed by a translation - transformation. When prependTranslation() is used, the display object continues to move - in the direction it is facing, regardless of the other transformations. For example, if a display object - was facing toward a positive x axis, it continues to move in the direction specified - by the prependTranslation() method, regardless of how the object has been rotated. To make - translation changes occur after other transformations, use the appendTranslation() method.

- Parameters - - - - - - - - - - - - - - - - -
x:Number — An incremental translation along the x axis. -
 
y:Number — An incremental translation along the y axis. -
 
z:Number — An incremental translation along the z axis. -
-

-See also -

-
-appendTranslation() -
-
-Example -
In this example, the user can push an ellipse up the stage's y axis - using a mouse. When the user moves the mouse over the ellipse, the ellipse - jumps ten coordinates up the y axis. When the mouse moves off of - the ellipse, if the ellipse has not reached the top, the ellipse again jumps - ten coordinates up the y axis. Once the ellipse reaches the top, - it is moved back to the bottom of the stage. -
-
-package {
-    import flash.display.MovieClip;
-    import flash.display.Sprite;
-    import flash.geom.*;
-    import flash.events.MouseEvent;
-
-    public class Matrix3DprependTranslationExample extends MovieClip {
-        private var ellipse:Sprite = new Sprite();
-
-        public function Matrix3DprependTranslationExample():void {
-            ellipse.x = this.stage.stageWidth / 2;
-            ellipse.y = this.stage.stageHeight - 100;
-            ellipse.z = 1;
-            ellipse.graphics.beginFill(0xFF0000);
-            ellipse.graphics.lineStyle(2);
-            ellipse.graphics.drawEllipse(0, 0, 60, 50);
-            ellipse.graphics.endFill();
-            addChild(ellipse);
-
-            ellipse.addEventListener(MouseEvent.MOUSE_OVER, mouseOverHandler);
-            ellipse.addEventListener(MouseEvent.MOUSE_OUT, mouseOutHandler);
-        }
-
-        private function mouseOverHandler(e:MouseEvent):void {
-            if(ellipse.y > 0) { 
-                ellipse.transform.matrix3D.prependTranslation(0, -10, 0);
-            } 
-        }
-        
-        private function mouseOutHandler(e:MouseEvent):void {
-            if(ellipse.y > 0) { 
-                ellipse.transform.matrix3D.prependTranslation(0, -10, 0);
-            } else {
-                ellipse.transform.matrix3D.prependTranslation(0, 
-                                     (this.stage.stageHeight - 100), 0);
-            }   
-        }
-    }
-}
-
-

-
- - - - - -
recompose()method 
-
-public function recompose(components:Vector.<Vector3D>, orientationStyle:String = "eulerAngles"):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Sets the transformation matrix's translation, rotation, and scale settings. - Unlike the incremental changes made by the display object's rotation properties or - Matrix3D object's rotation methods, the changes made by recompose() method - are absolute changes. The recompose() method overwrites the matrix's transformation. -

To modify the matrix's transformation with an absolute parent frame of reference, retrieve - the settings with the decompose() method and make the appropriate changes. You can then - set the Matrix3D object to the modified transformation using the recompose() method.

-

The recompose() method's parameter specifies the orientation style that was used - for the transformation. The default orientation is eulerAngles, - which defines the orientation with three separate angles of rotation for each axis. - The rotations occur consecutively and do not change the axis of each other. The - display object's axis rotation properties perform Euler Angles orientation style transformation. - The other orientation style options are axisAngle and quaternion. - The Axis Angle orientation uses the combination of an axis and an angle to determine the orientation. - The axis around which the object is rotated is a unit vector that represents a direction. - The angle represents the magnitude of the rotation about the vector. The direction also - determines where a display object is facing and the angle determines which way is up. - The appendRotation() and prependRotation() methods use the Axis Angle orientation. - The quaternion orientation uses complex numbers and the fourth element of a vector. - An orientation is represented by the three axes of rotation (x,y,z) and an angle of - rotation (w). The interpolate() method uses quaternion.

- Parameters - - - - - - - - - - -
components:Vector.<Vector3D> — A Vector of three Vector3D objects that replace the Matrix3D - object's translation, rotation, and scale elements. - -
 
orientationStyle:String (default = "eulerAngles") — An optional parameter that determines the orientation style - used for the matrix transformation. The three types of orientation styles are - eulerAngles (constant EULER_ANGLES), axisAngle - (constant AXIS_ANGLE), and quaternion (constant QUATERNION). - For additional information on the different orientation style, see the geom.Orientation3D class. -
-

-Returns - - - - -
Boolean — - Returns false if any of the Vector3D elements of the components Vector do not exist or are null. - - -
-

-See also -

-
-flash.geom.Orientation3D -
-decompose() -
-Vector -
-
- - - - - -
transformVector()method 
-
-public function transformVector(v:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Uses the transformation matrix to transform a Vector3D object from one space coordinate - to another. The returned Vector3D object holds the new coordinates after the transformation. - All the matrix transformations including translation are applied to the Vector3D object. -

If the result of the transformVector() method was applied to the position - of a display object, only the display object's position changes. - The display object's rotation and scale elements remain the same.

-

Note: This method automatically sets the w component of the passed Vector3D to 1.0. -

- Parameters - - - - -
v:Vector3D — A Vector3D object holding the coordinates that are going to be transformed. -
-

-Returns - - - - -
Vector3D — - A Vector3D object with the transformed coordinates. - - -
-

-See also -

-
-transformVectors() -
-deltaTransformVector() -
-
- - - - - -
transformVectors()method 
-
-public function transformVectors(vin:Vector.<Number>, vout:Vector.<Number>):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Uses the transformation matrix to transform a Vector of Numbers from one - coordinate space to another. The tranformVectors() method reads every - three Numbers in the vin Vector object as a 3D coordinate - (x,y,z) and places a transformed 3D coordinate in the vout - Vector object. All the matrix transformations including translation are applied to the - vin Vector object. You can use the transformVectors() method - to render and transform a 3D object as a mesh. A mesh is a collection of - vertices that defines the shape of the object. - -

Parameters - - - - - - - - - - -
vin:Vector.<Number> — A Vector of Numbers, where every three Numbers are a 3D coordinate - (x,y,z) that is going to be transformed. -
 
vout:Vector.<Number> — A Vector of Numbers, where every three Numbers are a 3D - transformed coordinate (x,y,z). -
-

-See also -

-
-transformVector() -
-deltaTransformVector() -
-Vector -
-
- - - - - -
transformVectorToOutput()method 
-
-public function transformVectorToOutput(v:Vector3D, output:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Uses the transformation matrix to transform a Vector3D object from one space coordinate - to another. The returned Vector3D object holds the new coordinates after the transformation. - All the matrix transformations including translation are applied to the Vector3D object. -

If the result of the transformVector() method was applied to the position - of a display object, only the display object's position changes. - The display object's rotation and scale elements remain the same.

-

Note: This method automatically sets the w component of the passed Vector3D to 1.0. -

- Parameters - - - - - - - - - - -
v:Vector3D — A Vector3D object holding the coordinates that are going to be transformed. -
 
output:Vector3D — An optional Vector3D object to be used and returned to avoid the runtime creating a new object. -
-

-Returns - - - - -
Vector3D — - A Vector3D object with the transformed coordinates. - - -
-

-See also -

-
-transformVectors() -
-deltaTransformVector() -
-
- - - - - -
transpose()method 
-
-public function transpose():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Converts the current Matrix3D object to a matrix where the rows and columns - are swapped. For example, if the current Matrix3D object's rawData contains - the following 16 numbers, 1,2,3,4,11,12,13,14,21,22,23,24,31,32,33,34, - the transpose() method reads every four elements as a row and turns the rows - into columns. The result is a matrix with the rawData of: - 1,11,21,31,2,12,22,32,3,13,23,33,4,14,24,34. - -

The transpose() method replaces the current matrix with a transposed matrix. - If you want to transpose a matrix without altering the current matrix, first copy the - current matrix by using the clone() method and then apply the transpose() - method to the copy.

-

An orthogonal matrix is a square matrix whose transpose is equal to its inverse.

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/geom/Orientation3D.html b/html-docs/flash/geom/Orientation3D.html deleted file mode 100644 index 0bb235b..0000000 --- a/html-docs/flash/geom/Orientation3D.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - -flash.geom.Orientation3D (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.geom
Classpublic final class Orientation3D
InheritanceOrientation3D Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-

-The Orientation3D class is an enumeration of constant values for representing the orientation style -of a Matrix3D object. The three types of orientation are Euler angles, axis angle, and quaternion. -The decompose and recompose methods of the Matrix3D object take one of these -enumerated types to identify the rotational components of the Matrix. - -

-

-See also -

-
-flash.geom.Matrix3D -
-flash.geom.Transform -
-flash.geom.PerspectiveProjection -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  AXIS_ANGLE : String = "axisAngle"
[static] - The axis angle orientation uses a combination of an axis and an angle to determine the orientation.
-		Orientation3D
  EULER_ANGLES : String = "eulerAngles"
[static] - Euler angles, the default orientation for decompose() and recompose() methods, - defines the orientation with three separate angles of rotation for each axis.
-		Orientation3D
  QUATERNION : String = "quaternion"
[static] - The quaternion orientation uses complex numbers.
-		Orientation3D
-
- -
- -
Constant detail
- - - - - -
AXIS_ANGLEconstant
-
-public static const AXIS_ANGLE:String = "axisAngle" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The axis angle orientation uses a combination of an axis and an angle to determine the orientation. - A line or vector from the center of a three-dimensional globe to the surface is an example of an axis. - The axis around which the object is rotated is a unit vector that represents any possible direction - in the three-dimensional space. The angle represents the magnitude of the rotation - about the vector. The direction determines where a display object is facing and the roll angle determines - which way is up. You can use Vector3D and the Matrix3D objects to determine - the various matrix transformations as well as to determine important three-dimensional programming - values such as the distance to the intersection of two objects that can be used to detect simple - collision between three-dimensional objects. -

The Matrix3D.appendRotation() and Matrix3D.prependRotation() methods - use the axis angle orientation.

-

-See also -

-
-flash.geom.Matrix3D.decompose() -
-flash.geom.Matrix3D.recompose() -
-
- - - - - -
EULER_ANGLESconstant 
-
-public static const EULER_ANGLES:String = "eulerAngles" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Euler angles, the default orientation for decompose() and recompose() methods, - defines the orientation with three separate angles of rotation for each axis. Usually, - a rotation around the x axis is followed by a rotation around the y axis, which is followed by a - rotation around the z axis. -

Euler angles can sometimes lead to animation errors because of problems such as singularities when - rotating around the x axis or gimbal lock. For example, since with Euler angles each axis is handled - independently, gimbal lock can occur during the rotation around two or more axes. The axes - can become aligned, leading to unexpected results.

-

The axis rotation properties of the display object perform Euler angles rotation.

-

-See also -

-
-flash.geom.Matrix3D.decompose() -
-flash.geom.Matrix3D.recompose() -
-
- - - - - -
QUATERNIONconstant 
-
-public static const QUATERNION:String = "quaternion" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The quaternion orientation uses complex numbers. An orientation in quaternion is by the three axes of - rotation (x,y,z) and an angle of rotation (w). Quaternion guarantees the shortest, most efficient - path for the rotation. It also produces a smooth, gimbal-lock-free rotation. A gimbal lock can occur - when during the rotation around two or more axes the axes are aligned, leading to unexpected results. -

The Matrix3D.interpolate() method uses quaternion.

-

-See also -

-
-flash.geom.Matrix3D.decompose() -
-flash.geom.Matrix3D.recompose() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/geom/PerspectiveProjection.html b/html-docs/flash/geom/PerspectiveProjection.html deleted file mode 100644 index 3fa97f4..0000000 --- a/html-docs/flash/geom/PerspectiveProjection.html +++ /dev/null @@ -1,523 +0,0 @@ - - - - - - - - -flash.geom.PerspectiveProjection (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.geom
Classpublic class PerspectiveProjection
InheritancePerspectiveProjection Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The PerspectiveProjection class provides an easy way to assign or modify the perspective - transformations of a display object and all of its children. For more complex or - custom perspective transformations, use the Matrix3D class. While the PerspectiveProjection - class provides basic three-dimensional presentation properties, the Matrix3D class - provides more detailed control over the three-dimensional presentation of display objects. -

Projection is a way of representing a three-dimensional object in a - two-dimensional space, like a cube projected onto a computer screen. Perspective projection uses a viewing - frustum (a rectangular pyramid) to model and project a three-dimensional world and its objects - on the screen. The viewing frustum becomes increasingly wider as it moves further from the origin - of the viewpoint. The origin of the viewpoint could be a camera or the eyes of an observer facing the screen. - The projected perspective produces the illusion of three dimensions with depth and distance, - where the objects closer to the screen appear larger than the objects farther from the screen.

- -

Frustum viewing area

-

A default PerspectiveProjection object is a framework defined for perspective transformation - of the root object, based on the field of view and aspect ratio (dimensions) of the stage. - The projection center, the vanishing point, is set to the center of the stage, which means the - three-dimensional display objects disappear toward the center of the stage as they move - back in the z axis. The default viewpoint is at point (0,0) looking down the positive - z axis. The y-axis points down toward the bottom of the screen. You can - gain access to the root display object's perspective projection settings - and change the field of view and projection center properties of the perspectiveProjection - property through the root object's DisplayObject.transform property.

-

You can also set a different perspective projection setting for a display object through - the parent's perspective projection. First, create a PerspectiveProjection object and set - its fieldOfView and projectionCenter properties. Next, assign the - PerspectiveProjection object to the parent display object using - the DisplayObject.transform property. The specified projection matrix and transformation - will then apply to all the display object's three-dimensional children.

- -

-

-See also -

-
-flash.display.DisplayObject.transform -
-flash.geom.Transform -
-flash.geom.Matrix3D -
-flash.geom.Utils3D -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fieldOfView : Number -
- Specifies an angle, as a degree between 0 and 180, for the field of view in three - dimensions.
-		PerspectiveProjection
  focalLength : Number -
- The distance between the eye or the viewpoint's origin (0,0,0) and the display object located - in the z axis.
-		PerspectiveProjection
  projectionCenter : Point -
- A two-dimensional point representing the center of the projection, the vanishing point for the display object.
-		PerspectiveProjection
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-PerspectiveProjection()
-
- Creates an instance of a PerspectiveProjection object.
-		PerspectiveProjection
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toMatrix3D():Matrix3D -
-
- Returns the underlying Matrix3D object of the display object.
-		PerspectiveProjection
   -
-toMatrix3DToOutput(output:Matrix3D):Matrix3D -
-
- Returns the underlying Matrix3D object of the display object, reusing any passed-in object.
-		PerspectiveProjection
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
fieldOfViewproperty
-
-fieldOfView:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies an angle, as a degree between 0 and 180, for the field of view in three - dimensions. This value determines how strong the perspective transformation and distortion apply to - a three-dimensional display object with a non-zero z-coordinate. -

A degree close to 0 means that the screen's two-dimensional x- and y-coordinates are - roughly the same as the three-dimensional x-, y-, and z-coordinates with little or - no distortion. In other words, for a small angle, a display object moving down the z axis appears - to stay near the same size and moves little.

-

A value close to 180 degrees results in a fisheye lens effect: positions - with a z value smaller than 0 are magnified, while positions with a - z value larger than 0 are minimized. With a large angle, a display object - moving down the z axis appears to change size quickly and moves a great distance. If the field of view - is set to 0 or 180, nothing is seen on the screen.

- Implementation -
-    public function get fieldOfView():Number -
-    public function set fieldOfView(value:Number):void -
-
- - - - - -
focalLengthproperty 
-
-focalLength:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The distance between the eye or the viewpoint's origin (0,0,0) and the display object located - in the z axis. During the perspective transformation, the focalLength is calculated dynamically - using the angle of the field of view and the stage's aspect ratio (stage width divided by - stage height). -

Implementation -
-    public function get focalLength():Number -
-    public function set focalLength(value:Number):void -
-

-See also -

-
-fieldOfView -
-
- - - - - -
projectionCenterproperty 
-
-projectionCenter:Point  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A two-dimensional point representing the center of the projection, the vanishing point for the display object. -

The projectionCenter property is an offset to the default registration point that is the - upper left of the stage, point (0,0). The default projection transformation center is in the middle of - the stage, which means the three-dimensional display objects disappear toward the center of the stage - as they move backwards in the z axis.

- Implementation -
-    public function get projectionCenter():Point -
-    public function set projectionCenter(value:Point):void -
-
- -
Constructor detail
- - - - - -
PerspectiveProjection()constructor
-
-public function PerspectiveProjection() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates an instance of a PerspectiveProjection object. -

- -
Method detail
- - - - - -
toMatrix3D()method
-
-public function toMatrix3D():Matrix3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the underlying Matrix3D object of the display object. -

A display object, like the root object, can have a PerspectiveProjection object without - needing a Matrix3D property defined for its transformations. In fact, use either - a PerspectiveProjection or a Matrix3D object to specify the perspective transformation. - If when using the PerspectiveProjection object, a Matrix3D object was needed, the toMatrix3D() - method can retrieve the underlying Matrix3D object of the display object. For example, the - toMatrix3D() method can be used with the Utils3D.projectVectors() - method.

-

-Returns - - - - -
Matrix3D — - The underlying Matrix3D object. - - -
-

-See also -

-
-flash.geom.Matrix3D -
-
- - - - - -
toMatrix3DToOutput()method 
-
-public function toMatrix3DToOutput(output:Matrix3D):Matrix3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Returns the underlying Matrix3D object of the display object, reusing any passed-in object. -

This function is identical to toMatrix3D() but rather than creating a new Matrix3D - object, it will set the values in the output parameter and return that object instead.

- Parameters - - - - -
output:Matrix3D — An optional Matrix3D to be set to the underlying Matrix3D, avoiding the creation of a new object. -
-

-Returns - - - - -
Matrix3D — - The underlying Matrix3D object. - - -
-

-See also -

-
-flash.geom.Matrix3D -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/geom/Point.html b/html-docs/flash/geom/Point.html deleted file mode 100644 index b025f2d..0000000 --- a/html-docs/flash/geom/Point.html +++ /dev/null @@ -1,1356 +0,0 @@ - - - - - - - - -flash.geom.Point (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.geom
Classpublic class Point
InheritancePoint Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- The Point object represents a location in a two-dimensional coordinate system, where x - represents the horizontal axis and y represents the vertical axis. - -

The following code creates a point at (0,0):

- - 
var myPoint:Point = new Point();
- - 
var myPoint = new Point();
- -

Methods and properties of the following classes use Point objects:

- -
    - -
  • BitmapData
    • - -
  • DisplayObject
    • - -
  • DisplayObjectContainer
    • - -
  • DisplacementMapFilter
    • - -
  • NativeWindow
    • - -
  • Matrix
    • - -
  • Rectangle
    • - -
-

You can use the new Point() constructor to create a - Point object.

-

-

-View the examples. -

-

-See also -

-
-flash.display.BitmapData -
-flash.display.DisplayObject -
-flash.display.DisplayObjectContainer -
-flash.filters.DisplacementMapFilter -
-flash.geom.Matrix -
-flash.display.NativeWindow -
-flash.geom.Rectangle -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  length : Number -
[read-only] - The length of the line segment from (0,0) to this point.
-		Point
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  x : Number -
- The horizontal coordinate of the point.
-		Point
  y : Number -
- The vertical coordinate of the point.
-		Point
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Point(x:Number = 0, y:Number = 0)
-
- Creates a new point.
-		Point
   -
-add(v:Point):Point -
-
- Adds the coordinates of another point to the coordinates of this point to create a new point.
-		Point
   -
-addToOutput(v:Point, output:Point):Point -
-
- Adds the coordinates of another point to the coordinates of this point to create a new point.
-		Point
   -
-clone():Point -
-
- Creates a copy of this Point object.
-		Point
   -
-copyFrom(sourcePoint:Point):void -
-
- Copies all of the point data from the source Point object into the - calling Point object.
-		Point
   -
-distance(pt1:Point, pt2:Point):Number -
-
[static] - Returns the distance between pt1 and pt2.
-		Point
   -
-equals(toCompare:Point):Boolean -
-
- Determines whether two points are equal.
-		Point
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-interpolate(pt1:Point, pt2:Point, f:Number):Point -
-
[static] - Determines a point between two specified points.
-		Point
   -
-interpolateToOutput(pt1:Point, pt2:Point, f:Number, output:Point):Point -
-
[static] - Determines a point between two specified points.
-		Point
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-normalize(thickness:Number):void -
-
- Scales the line segment between (0,0) and the current point to a set length.
-		Point
   -
-offset(dx:Number, dy:Number):void -
-
- Offsets the Point object by the specified amount.
-		Point
   -
-polar(len:Number, angle:Number):Point -
-
[static] - Converts a pair of polar coordinates to a Cartesian point coordinate.
-		Point
   -
-polarToOutput(len:Number, angle:Number, output:Point):Point -
-
[static] - Converts a pair of polar coordinates to a Cartesian point coordinate.
-		Point
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setTo(xa:Number, ya:Number):void -
-
- Sets the members of Point to the specified values - -
-		Point
   -
-subtract(v:Point):Point -
-
- Subtracts the coordinates of another point from the coordinates of this point to create a new - point.
-		Point
   -
-subtractToOutput(v:Point, output:Point):Point -
-
- Subtracts the coordinates of another point from the coordinates of this point to create a new - point.
-		Point
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string that contains the values of the x and y coordinates.
-		Point
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
lengthproperty
-
-length:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The length of the line segment from (0,0) to this point. -

Implementation -
-    public function get length():Number -
-

-See also -

-
-Point.polar() -
-
- - - - - -
xproperty 
-
-public var x:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The horizontal coordinate of the point. The default value is 0. - -

- - - - - -
yproperty 
-
-public var y:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The vertical coordinate of the point. The default value is 0. - -

- -
Constructor detail
- - - - - -
Point()constructor
-
-public function Point(x:Number = 0, y:Number = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new point. If you pass no parameters to this method, a point is created at (0,0). -

Parameters - - - - - - - - - - -
x:Number (default = 0) — The horizontal coordinate. -
 
y:Number (default = 0) — The vertical coordinate. - -
-
- -
Method detail
- - - - - -
add()method
-
-public function add(v:Point):Point -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Adds the coordinates of another point to the coordinates of this point to create a new point. - -

Parameters - - - - -
v:Point — The point to be added. - -
-

-Returns - - - - -
Point — - The new point (or the object passed in as the output parameter, if not null). - - - -
-
- - - - - -
addToOutput()method 
-
-public function addToOutput(v:Point, output:Point):Point -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Adds the coordinates of another point to the coordinates of this point to create a new point. - -

Parameters - - - - - - - - - - -
v:Point — The point to be added. -
 
output:Point — An optional point to be used for the result of the operation. - -
-

-Returns - - - - -
Point — - The new point (or the object passed in as the output parameter, if not null). - - - - -
-
- - - - - -
clone()method 
-
-public function clone():Point -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a copy of this Point object. -

-Returns - - - - -
Point — - The new Point object. - - - -
-
- - - - - -
copyFrom()method 
-
-public function copyFrom(sourcePoint:Point):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Copies all of the point data from the source Point object into the - calling Point object. - -

Parameters - - - - -
sourcePoint:Point — The Point object from which to copy the data. - -
-
- - - - - -
distance()method 
-
-public static function distance(pt1:Point, pt2:Point):Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the distance between pt1 and pt2. -

Parameters - - - - - - - - - - -
pt1:Point — The first point. -
 
pt2:Point — The second point. -
-

-Returns - - - - -
Number — - The distance between the first and second points. - - -
-
- - - - - -
equals()method 
-
-public function equals(toCompare:Point):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether two points are equal. Two points are equal if they have the same x and - y values. -

Parameters - - - - -
toCompare:Point — The point to be compared. -
-

-Returns - - - - -
Boolean — - A value of true if the object is equal to this Point object; false if it is not equal. - - -
-
- - - - - -
interpolate()method 
-
-public static function interpolate(pt1:Point, pt2:Point, f:Number):Point -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines a point between two specified points. The parameter f - determines where the new interpolated point is located relative to the two end points - specified by parameters pt1 and pt2. The closer the value of the parameter - f is to 1.0, the closer the interpolated point is to the - first point (parameter pt1). The closer the value of the parameter f is - to 0, the closer the interpolated point is to the second point (parameter pt2). - -

Parameters - - - - - - - - - - - - - - - - -
pt1:Point — The first point. -
 
pt2:Point — The second point. -
 
f:Number — The level of interpolation between the two points. Indicates where the new point will be, along the line - between pt1 and pt2. If f=1, pt1 is returned; if - f=0, pt2 is returned. - -
-

-Returns - - - - -
Point — - The new, interpolated point. - - - -
-
- - - - - -
interpolateToOutput()method 
-
-public static function interpolateToOutput(pt1:Point, pt2:Point, f:Number, output:Point):Point -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Determines a point between two specified points. The parameter f - determines where the new interpolated point is located relative to the two end points - specified by parameters pt1 and pt2. The closer the value of the parameter - f is to 1.0, the closer the interpolated point is to the - first point (parameter pt1). The closer the value of the parameter f is - to 0, the closer the interpolated point is to the second point (parameter pt2). - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
pt1:Point — The first point. -
 
pt2:Point — The second point. -
 
f:Number — The level of interpolation between the two points. Indicates where the new point will be, along the line - between pt1 and pt2. If f=1, pt1 is returned; if - f=0, pt2 is returned. -
 
output:Point — An optional point to be used for the result of the operation. - -
-

-Returns - - - - -
Point — - The new, interpolated point. - - - -
-
- - - - - -
normalize()method 
-
-public function normalize(thickness:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Scales the line segment between (0,0) and the current point to a set length. - -

Parameters - - - - -
thickness:Number — The scaling value. For example, if the current point is (0,5), - and you normalize it to 1, the point returned is at (0,1). - -
-

-See also -

-
-length -
-
- - - - - -
offset()method 
-
-public function offset(dx:Number, dy:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Offsets the Point object by the specified amount. The value of dx is added - to the original value of x to create the new x value. The value - of dy is added to the original value of y to create the new y value. -

Parameters - - - - - - - - - - -
dx:Number — The amount by which to offset the horizontal coordinate, x. -
 
dy:Number — The amount by which to offset the vertical coordinate, y. -
-
- - - - - -
polar()method 
-
-public static function polar(len:Number, angle:Number):Point -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Converts a pair of polar coordinates to a Cartesian point coordinate. - -

Parameters - - - - - - - - - - -
len:Number — The length coordinate of the polar pair. -
 
angle:Number — The angle, in radians, of the polar pair. - -
-

-Returns - - - - -
Point — - The Cartesian point. - - - -
-

-See also -

-
-length -
-Math.round() -
-
- - - - - -
polarToOutput()method 
-
-public static function polarToOutput(len:Number, angle:Number, output:Point):Point -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Converts a pair of polar coordinates to a Cartesian point coordinate. - -

Parameters - - - - - - - - - - - - - - - - -
len:Number — The length coordinate of the polar pair. -
 
angle:Number — The angle, in radians, of the polar pair. -
 
output:Point — An optional point to be used for the result of the operation. - -
-

-Returns - - - - -
Point — - The Cartesian point. - - - -
-

-See also -

-
-length -
-Math.round() -
-
- - - - - -
setTo()method 
-
-public function setTo(xa:Number, ya:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Sets the members of Point to the specified values - -

Parameters - - - - - - - - - - -
xa:Number — the values to set the point to. - -
 
ya:Number
-
- - - - - -
subtract()method 
-
-public function subtract(v:Point):Point -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Subtracts the coordinates of another point from the coordinates of this point to create a new - point. - -

Parameters - - - - -
v:Point — The point to be subtracted. - -
-

-Returns - - - - -
Point — - The new point. - - - -
-
- - - - - -
subtractToOutput()method 
-
-public function subtractToOutput(v:Point, output:Point):Point -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Subtracts the coordinates of another point from the coordinates of this point to create a new - point. - -

Parameters - - - - - - - - - - -
v:Point — The point to be subtracted. -
 
output:Point — An optional point to be used for the result of the operation. - -
-

-Returns - - - - -
Point — - The new point. - - - -
-
- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a string that contains the values of the x and y coordinates. - - The string has the form "(x=x, y=y)", so calling the toString() - method for a point at 23,17 would return "(x=23, y=17)". - -

-Returns - - - - -
String — - The string representation of the coordinates. - - -
-
- -
Examples
-
examples\PointExample
-
The following example uses the PointExample class to create a number of new Point - objects at various x,y coordinates and then uses the trace() method to output the - results of various class methods. -
-
-package {
-    import flash.display.Sprite;
-	import flash.geom.Point;
-
-	public class PointExample extends Sprite {
-
-		public function PointExample() {
-		var point1:Point = new Point();
-		trace(point1);  // (x=0, y=0)
-		
-		var point2:Point = new Point(6, 8);
-		trace(point2); // (x=6, y=8)
-		
-		trace(Point.interpolate(point1, point2, 0.5)); // (x=3, y=4)
-		
-		trace(Point.distance(point1, point2)); // 10
-		
-		trace(point1.add(point2)); // (x=6, y=8)
-		
-		var point3:Point = point2.clone();
-		trace(point2.equals(point3)); // true
-		
-		point3.normalize(2.5);
-		trace(point3); // (x=1.5, y=2)
-		
-		trace(point2.subtract(point3)); // (x=4.5, y=6)
-		
-		trace(point1.offset(2, 3)); // 
-		
-		var angle:Number = Math.PI * 2 * (30 / 360); // 30 degrees
-		trace(Point.polar(4, angle)) // (x=3.464101615137755, y=1.9999999999999998)   
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/geom/Rectangle.html b/html-docs/flash/geom/Rectangle.html deleted file mode 100644 index f399a21..0000000 --- a/html-docs/flash/geom/Rectangle.html +++ /dev/null @@ -1,2029 +0,0 @@ - - - - - - - - -flash.geom.Rectangle (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.geom
Classpublic class Rectangle
InheritanceRectangle Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- A Rectangle object is an area defined by its position, as - indicated by its top-left corner point (x, y) and by its width - and its height. -

The x, y, width, and - height properties of the Rectangle class are - independent of each other; changing the value of one property has - no effect on the others. However, the right and bottom - properties are integrally related to those four properties. For example, if you change - the value of the right property, the value of the width property - changes; if you change the bottom property, the value of the height - property changes.

-

The following methods and properties use Rectangle objects:

- -
    - -
  • The applyFilter(), colorTransform(), - copyChannel(), copyPixels(), draw(), fillRect(), - generateFilterRect(), getColorBoundsRect(), getPixels(), - merge(), paletteMap(), pixelDisolve(), setPixels(), and - threshold() methods, and the rect property of the BitmapData class
    • - -
  • The getBounds() and getRect() methods, and the scrollRect - and scale9Grid properties of the DisplayObject class
    • - -
  • The getCharBoundaries() method of the TextField class
    • - -
  • The pixelBounds property of the Transform class
    • - -
  • The bounds parameter for the startDrag() method of the Sprite class
    • - -
  • The printArea parameter of the addPage() method of the PrintJob class
    • - -
- -

You can use the new Rectangle() constructor to create a - Rectangle object.

-

Note: The Rectangle class does not define a rectangular Shape display object. To draw - a rectangular Shape object onscreen, use the drawRect() method of the Graphics - class.

- -

-

-View the examples. -

-

-See also -

-
-flash.display.DisplayObject.scrollRect -
-flash.display.BitmapData -
-flash.display.DisplayObject -
-flash.display.NativeWindow -
-flash.text.TextField.getCharBoundaries() -
-flash.geom.Transform.pixelBounds -
-flash.display.Sprite.startDrag() -
-flash.printing.PrintJob.addPage() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bottom : Number -
- The sum of the y and - height properties.
-		Rectangle
  bottomRight : Point -
- The location of the Rectangle object's bottom-right corner, determined by the values of the right and - bottom properties.
-		Rectangle
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  height : Number -
- The height of the rectangle, in pixels.
-		Rectangle
  left : Number -
- The x coordinate of the top-left corner of the rectangle.
-		Rectangle
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  right : Number -
- The sum of the x and - width properties.
-		Rectangle
  size : Point -
- The size of the Rectangle object, expressed as a Point object with the values - of the width and height properties.
-		Rectangle
  top : Number -
- The y coordinate of the top-left corner of the rectangle.
-		Rectangle
  topLeft : Point -
- The location of the Rectangle object's top-left corner, determined by the x and - y coordinates of the point.
-		Rectangle
  width : Number -
- The width of the rectangle, in pixels.
-		Rectangle
  x : Number -
- The x coordinate of the top-left corner of the rectangle.
-		Rectangle
  y : Number -
- The y coordinate of the top-left corner of the rectangle.
-		Rectangle
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0)
-
- Creates a new Rectangle object with the top-left corner specified by the x - and y parameters and with the specified width and height - parameters.
-		Rectangle
   -
-clone():Rectangle -
-
- Returns a new Rectangle object with the same values for the x, y, - width, and height properties as the original Rectangle object.
-		Rectangle
   -
-contains(x:Number, y:Number):Boolean -
-
- Determines whether the specified point is contained within the rectangular region defined - by this Rectangle object.
-		Rectangle
   -
-containsPoint(point:Point):Boolean -
-
- Determines whether the specified point is contained within the rectangular region defined - by this Rectangle object.
-		Rectangle
   -
-containsRect(rect:Rectangle):Boolean -
-
- Determines whether the Rectangle object specified by the rect parameter is contained - within this Rectangle object.
-		Rectangle
   -
-copyFrom(sourceRect:Rectangle):void -
-
- Copies all of rectangle data from the source Rectangle object into the - calling Rectangle object.
-		Rectangle
   -
-equals(toCompare:Rectangle):Boolean -
-
- Determines whether the object specified in the toCompare parameter is - equal to this Rectangle object.
-		Rectangle
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-inflate(dx:Number, dy:Number):void -
-
- Increases the size of the Rectangle object by the specified amounts, in pixels.
-		Rectangle
   -
-inflatePoint(point:Point):void -
-
- Increases the size of the Rectangle object.
-		Rectangle
   -
-intersection(toIntersect:Rectangle):Rectangle -
-
- If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle - object, returns the area of intersection as a Rectangle object.
-		Rectangle
   -
-intersectionToOutput(toIntersect:Rectangle, output:Rectangle):Rectangle -
-
- If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle - object, returns the area of intersection as a Rectangle object.
-		Rectangle
   -
-intersects(toIntersect:Rectangle):Boolean -
-
- Determines whether the object specified in the toIntersect parameter intersects - with this Rectangle object.
-		Rectangle
   -
-isEmpty():Boolean -
-
- Determines whether or not this Rectangle object is empty.
-		Rectangle
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-offset(dx:Number, dy:Number):void -
-
- Adjusts the location of the Rectangle object, as determined by its top-left corner, - by the specified amounts.
-		Rectangle
   -
-offsetPoint(point:Point):void -
-
- Adjusts the location of the Rectangle object using a Point object as a parameter.
-		Rectangle
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-setEmpty():void -
-
- Sets all of the Rectangle object's properties to 0.
-		Rectangle
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setTo(xa:Number, ya:Number, widtha:Number, heighta:Number):void -
-
- Sets the members of Rectangle to the specified values - -
-		Rectangle
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Builds and returns a string that lists the horizontal and vertical positions - and the width and height of the Rectangle object.
-		Rectangle
   -
-union(toUnion:Rectangle):Rectangle -
-
- Adds two rectangles together to create a new Rectangle object, by - filling in the horizontal and vertical space between the two rectangles.
-		Rectangle
   -
-unionToOutput(toUnion:Rectangle, output:Rectangle):Rectangle -
-
- Adds two rectangles together to create a new Rectangle object, by - filling in the horizontal and vertical space between the two rectangles.
-		Rectangle
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
bottomproperty
-
-bottom:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The sum of the y and - height properties. - -

A rectangle image showing location and measurement properties.

- - Implementation -
-    public function get bottom():Number -
-    public function set bottom(value:Number):void -
-

-See also -

-
-y -
-height -
-
- - - - - -
bottomRightproperty 
-
-bottomRight:Point  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The location of the Rectangle object's bottom-right corner, determined by the values of the right and - bottom properties. - -

A rectangle image showing location and measurement properties.

- - Implementation -
-    public function get bottomRight():Point -
-    public function set bottomRight(value:Point):void -
-

-See also -

-
-flash.geom.Point -
-
- - - - - -
heightproperty 
-
-public var height:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The height of the rectangle, in pixels. Changing the height value of a Rectangle - object has no effect on the x, y, and - width properties. - -

A rectangle image showing location and measurement properties.

- -

-See also -

-
-x -
-y -
-height -
-
- - - - - -
leftproperty 
-
-left:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The x coordinate of the top-left corner of the rectangle. Changing - the left property of a Rectangle object has no effect on the y - and height properties. However it does affect the width - property, whereas changing the x value does not affect the - width property. - -

The value of the left property is equal to the value of the - x property.

- - -

A rectangle image showing location and measurement properties.

- - Implementation -
-    public function get left():Number -
-    public function set left(value:Number):void -
-

-See also -

-
-x -
-y -
-width -
-height -
-
- - - - - -
rightproperty 
-
-right:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The sum of the x and - width properties. - -

A rectangle image showing location and measurement properties.

- - Implementation -
-    public function get right():Number -
-    public function set right(value:Number):void -
-

-See also -

-
-x -
-width -
-
- - - - - -
sizeproperty 
-
-size:Point  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The size of the Rectangle object, expressed as a Point object with the values - of the width and height properties. - -

Implementation -
-    public function get size():Point -
-    public function set size(value:Point):void -
-

-See also -

-
-flash.geom.Point -
-
- - - - - -
topproperty 
-
-top:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The y coordinate of the top-left corner of the rectangle. Changing - the top property of a Rectangle object has no effect on the x - and width properties. However it does affect the height - property, whereas changing the y value does not affect the - height property. - -

The value of the top property is equal to the value of the y property.

- -

A rectangle image showing location and measurement properties.

- - Implementation -
-    public function get top():Number -
-    public function set top(value:Number):void -
-

-See also -

-
-x -
-y -
-width -
-height -
-
- - - - - -
topLeftproperty 
-
-topLeft:Point  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The location of the Rectangle object's top-left corner, determined by the x and - y coordinates of the point. - -

A rectangle image showing location and measurement properties.

- - Implementation -
-    public function get topLeft():Point -
-    public function set topLeft(value:Point):void -
-

-See also -

-
-flash.geom.Point -
-x -
-y -
-
- - - - - -
widthproperty 
-
-public var width:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The width of the rectangle, in pixels. Changing the width value of a Rectangle object - has no effect on the x, y, and height - properties. - -

A rectangle image showing location and measurement properties.

- -

-See also -

-
-x -
-y -
-height -
-
- - - - - -
xproperty 
-
-public var x:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The x coordinate of the top-left corner of the rectangle. Changing - the value of the x property of a Rectangle object has no effect on the - y, - width, and height properties. - -

The value of the x property is equal to the value of the - left property.

- - -

-See also -

-
-left -
-
- - - - - -
yproperty 
-
-public var y:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The y coordinate of the top-left corner of the rectangle. Changing - the value of the y property of a Rectangle object has no effect on the - x, width, and height properties. - -

The value of the y property is equal to the value of - the top property.

- -

-See also -

-
-x -
-width -
-height -
-top -
-
- -
Constructor detail
- - - - - -
Rectangle()constructor
-
-public function Rectangle(x:Number = 0, y:Number = 0, width:Number = 0, height:Number = 0) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a new Rectangle object with the top-left corner specified by the x - and y parameters and with the specified width and height - parameters. If you call this function without parameters, - a rectangle with x, y, width, and height - properties set to 0 is created. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
x:Number (default = 0) — The x coordinate of the top-left corner of the rectangle. -
 
y:Number (default = 0) — The y coordinate of the top-left corner of the rectangle. -
 
width:Number (default = 0) — The width of the rectangle, in pixels. -
 
height:Number (default = 0) — The height of the rectangle, in pixels. - -
-

-See also -

-
-x -
-y -
-width -
-height -
-
- -
Method detail
- - - - - -
clone()method
-
-public function clone():Rectangle -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a new Rectangle object with the same values for the x, y, - width, and height properties as the original Rectangle object. - -

-Returns - - - - -
Rectangle — - A new Rectangle object with the same values for the x, y, - width, and height properties as the original Rectangle object. - - - -
-

-See also -

-
-x -
-y -
-width -
-height -
-
- - - - - -
contains()method 
-
-public function contains(x:Number, y:Number):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether the specified point is contained within the rectangular region defined - by this Rectangle object. - -

Parameters - - - - - - - - - - -
x:Number — The x coordinate (horizontal position) of the point. -
 
y:Number — The y coordinate (vertical position) of the point. -
-

-Returns - - - - -
Boolean — - A value of true if the Rectangle object contains the specified point; - otherwise false. - - - -
-

-See also -

-
-flash.geom.Point -
-
- - - - - -
containsPoint()method 
-
-public function containsPoint(point:Point):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether the specified point is contained within the rectangular region defined - by this Rectangle object. This method is similar to the Rectangle.contains() method, - except that it takes a Point object as a parameter. - -

Parameters - - - - -
point:Point — The point, as represented by its x and y coordinates. -
-

-Returns - - - - -
Boolean — - A value of true if the Rectangle object contains the specified point; - otherwise false. - - -
-

-See also -

-
-contains() -
-flash.geom.Point -
-
- - - - - -
containsRect()method 
-
-public function containsRect(rect:Rectangle):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether the Rectangle object specified by the rect parameter is contained - within this Rectangle object. A Rectangle object is said to contain another if the second - Rectangle object falls entirely within the boundaries of the first. - -

Parameters - - - - -
rect:Rectangle — The Rectangle object being checked. - -
-

-Returns - - - - -
Boolean — - A value of true if the Rectangle object that you specify is - contained by this Rectangle object; otherwise false. - - -
-
- - - - - -
copyFrom()method 
-
-public function copyFrom(sourceRect:Rectangle):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Copies all of rectangle data from the source Rectangle object into the - calling Rectangle object. - -

Parameters - - - - -
sourceRect:Rectangle — The Rectangle object from which to copy the data. - -
-
- - - - - -
equals()method 
-
-public function equals(toCompare:Rectangle):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether the object specified in the toCompare parameter is - equal to this Rectangle object. This method compares the x, y, - width, and height properties of an object against the same properties - of this Rectangle object. -

Parameters - - - - -
toCompare:Rectangle — The rectangle to compare to this Rectangle object. -
-

-Returns - - - - -
Boolean — - A value of true if the object has exactly the same values for the - x, y, width, and height properties - as this Rectangle object; otherwise false. - - - -
-

-See also -

-
-x -
-y -
-width -
-height -
-
- - - - - -
inflate()method 
-
-public function inflate(dx:Number, dy:Number):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Increases the size of the Rectangle object by the specified amounts, in pixels. The center point of the - Rectangle object stays the same, and its size increases to the left and right by the - dx value, and to the top and the bottom by the dy value. - -

Parameters - - - - - - - - - - -
dx:Number — The value to be added to the left and the right of the Rectangle object. The following - equation is used to calculate the new width and position of the rectangle: - - 
-	x -= dx;
-	width += 2 * dx;
-
- -
 
dy:Number — The value to be added to the top and the bottom of the Rectangle. The - following equation is used to calculate the new height and position of the rectangle: - - 
-	y -= dy;
-	height += 2 * dy;
-
- -
-

-See also -

-
-x -
-y -
-
- - - - - -
inflatePoint()method 
-
-public function inflatePoint(point:Point):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Increases the size of the Rectangle object. - This method is similar to the Rectangle.inflate() method - except it takes a Point object as a parameter. -

The following two code examples give the same result:

- - 
-	 var rect1:Rectangle = new Rectangle(0,0,2,5);
-	 rect1.inflate(2,2)
-
- - 
-	 var rect1:Rectangle = new Rectangle(0,0,2,5);
-	 var pt1:Point = new Point(2,2);
-	 rect1.inflatePoint(pt1)
-
- - 
-	 var rect1 = new air.Rectangle(0,0,2,5);
-	 rect1.inflate(2,2)
-
- - 
-	 var rect1 = new air.Rectangle(0,0,2,5);
-	 var pt1 = new air.Point(2,2);
-	 rect1.inflatePoint(pt1)
-
- - Parameters - - - - -
point:Point — The x property of this Point object is used to increase the - horizontal dimension of the Rectangle object. The y property - is used to increase the vertical dimension of the Rectangle object. - -
-

-See also -

-
-flash.geom.Point -
-
- - - - - -
intersection()method 
-
-public function intersection(toIntersect:Rectangle):Rectangle -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle - object, returns the area of intersection as a Rectangle object. - If the rectangles do not intersect, this method returns an empty Rectangle object with its properties - set to 0. - -

The resulting intersection rectangle.

- - Parameters - - - - -
toIntersect:Rectangle — The Rectangle object to compare against to see if it intersects with - this Rectangle object. -
-

-Returns - - - - -
Rectangle — - A Rectangle object that equals the area of intersection. If the rectangles do not - intersect, this method returns an empty Rectangle object; that is, a rectangle with its x, - y, width, and height properties set to 0. - - - -
-
- - - - - -
intersectionToOutput()method 
-
-public function intersectionToOutput(toIntersect:Rectangle, output:Rectangle):Rectangle -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- If the Rectangle object specified in the toIntersect parameter intersects with this Rectangle - object, returns the area of intersection as a Rectangle object. - If the rectangles do not intersect, this method returns an empty Rectangle object with its properties - set to 0. - -

The resulting intersection rectangle.

- - Parameters - - - - - - - - - - -
toIntersect:Rectangle — The Rectangle object to compare against to see if it intersects with - this Rectangle object. -
 
output:Rectangle — An optional Rectangle to be used as the output value, avoiding the creation of a new object -
-

-Returns - - - - -
Rectangle — - A Rectangle object that equals the area of intersection. If the rectangles do not - intersect, this method returns an empty Rectangle object; that is, a rectangle with its x, - y, width, and height properties set to 0. - - -
-
- - - - - -
intersects()method 
-
-public function intersects(toIntersect:Rectangle):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether the object specified in the toIntersect parameter intersects - with this Rectangle object. This method checks the x, y, - width, and height properties of the specified Rectangle object to see - if it intersects with this Rectangle object. -

Parameters - - - - -
toIntersect:Rectangle — The Rectangle object to compare against this Rectangle object. -
-

-Returns - - - - -
Boolean — - A value of true if the specified object intersects with this Rectangle object; - otherwise false. - - - -
-

-See also -

-
-x -
-y -
-width -
-height -
-
- - - - - -
isEmpty()method 
-
-public function isEmpty():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Determines whether or not this Rectangle object is empty. - -

-Returns - - - - -
Boolean — - A value of true if the Rectangle object's width or height is less than - or equal to 0; otherwise false. - - - -
-
- - - - - -
offset()method 
-
-public function offset(dx:Number, dy:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Adjusts the location of the Rectangle object, as determined by its top-left corner, - by the specified amounts. - -

Parameters - - - - - - - - - - -
dx:Number — Moves the x value of the Rectangle object by this amount. -
 
dy:Number — Moves the y value of the Rectangle object by this amount. - -
-
- - - - - -
offsetPoint()method 
-
-public function offsetPoint(point:Point):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Adjusts the location of the Rectangle object using a Point object as a parameter. - This method is similar to the Rectangle.offset() method, except that it takes a Point - object as a parameter. - -

Parameters - - - - -
point:Point — A Point object to use to offset this Rectangle object. - -
-

-See also -

-
-flash.geom.Point -
-
- - - - - -
setEmpty()method 
-
-public function setEmpty():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Sets all of the Rectangle object's properties to 0. A Rectangle object is empty if its width or - height is less than or equal to 0. -

This method sets the values of the x, y, - width, and height properties to 0.

-

-See also -

-
-x -
-y -
-width -
-height -
-
- - - - - -
setTo()method 
-
-public function setTo(xa:Number, ya:Number, widtha:Number, heighta:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Sets the members of Rectangle to the specified values - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
xa:Number — the values to set the rectangle to. - -
 
ya:Number
 
widtha:Number
 
heighta:Number
-
- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Builds and returns a string that lists the horizontal and vertical positions - and the width and height of the Rectangle object. - -

-Returns - - - - -
String — - A string listing the value of each of the following properties of the Rectangle object: - x, y, width, and height. - - - -
-

-See also -

-
-x -
-y -
-width -
-height -
-
- - - - - -
union()method 
-
-public function union(toUnion:Rectangle):Rectangle -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Adds two rectangles together to create a new Rectangle object, by - filling in the horizontal and vertical space between the two rectangles. -

The resulting union rectangle.

-

Note: The union() method ignores rectangles with 0 - as the height or width value, such as:
var rect2:Rectangle = new Rectangle(300,300,50,0);

- - Parameters - - - - -
toUnion:Rectangle — A Rectangle object to add to this Rectangle object. -
-

-Returns - - - - -
Rectangle — - A new Rectangle object that is the union of the two rectangles. - - - -
-
- - - - - -
unionToOutput()method 
-
-public function unionToOutput(toUnion:Rectangle, output:Rectangle):Rectangle -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 -
-

- Adds two rectangles together to create a new Rectangle object, by - filling in the horizontal and vertical space between the two rectangles. -

The resulting union rectangle.

-

Note: The union() method ignores rectangles with 0 - as the height or width value, such as:
var rect2:Rectangle = new Rectangle(300,300,50,0);

- - Parameters - - - - - - - - - - -
toUnion:Rectangle — A Rectangle object to add to this Rectangle object. -
 
output:Rectangle — An optional Rectangle to be used as the output value, avoiding the creation of a new object -
-

-Returns - - - - -
Rectangle — - A new Rectangle object that is the union of the two rectangles. - - -
-
- -
Examples
-
examples\RectangleExample
-
The following example uses the RectangleExample class to create three new Rectangle - objects at various x,y coordinates and with various heights and widths and then uses the - trace() method to confirm that the Rectangle instances were successfully created. Then a Boolean - variable isContained is assigned to the result of the call to - the containsRect() method, - which determines that the second rectangle does not fully enclose the third rectangle. -
-
-package {
-    import flash.display.Sprite;
-	import flash.geom.Rectangle;
-
-	public class RectangleExample extends Sprite {
-
-		public function RectangleExample() {
-			var firstRect:Rectangle = new Rectangle();
-			trace(firstRect);  // (x=0, y=0, w=0, h=0)
-			var secondRect:Rectangle = new Rectangle(1, 3, 11, 13);
-			trace(secondRect); // (x=1, y=3, w=11, h=13)
-			var thirdRect:Rectangle = new Rectangle(5, 8, 17, 19);
-			trace(thirdRect);  // (x=5, y=8, w=17, h=19)
-			var isContained:Boolean = secondRect.containsRect(thirdRect);
-			trace(isContained); // false
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/geom/Transform.html b/html-docs/flash/geom/Transform.html deleted file mode 100644 index de08e6b..0000000 --- a/html-docs/flash/geom/Transform.html +++ /dev/null @@ -1,981 +0,0 @@ - - - - - - - - -flash.geom.Transform (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.geom
Classpublic class Transform
InheritanceTransform Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The Transform class provides access to color adjustment properties and two- or three-dimensional - transformation objects that can be applied to a display object. During the transformation, - the color or the orientation and position of a display object is adjusted (offset) from - the current values or coordinates to new values or coordinates. - The Transform class also collects data about color and two-dimensional matrix transformations - that are applied to a display object and all of its parent objects. You can access - these combined transformations through the concatenatedColorTransform - and concatenatedMatrix properties. -

To apply color transformations: create a ColorTransform object, - set the color adjustments using the object's methods and properties, and then assign the - colorTransformation property of the transform property of the - display object to the new ColorTransformation object.

-

To apply two-dimensional transformations: create a Matrix object, - set the matrix's two-dimensional transformation, and then assign the transform.matrix - property of the display object to the new Matrix object.

-

To apply three-dimensional transformations: start with a three-dimensional display object. - A three-dimensional display object has a z property value other than zero. - You do not need to create the Matrix3D object. For all three-dimensional objects, a Matrix3D object - is created automatically when you assign a z value to a display object. You can - access the display object's Matrix3D object through the display object's transform property. - Using the methods of the Matrix3D class, you can add to or modify the existing transformation settings. Also, you can - create a custom Matrix3D object, set the custom Matrix3D object's transformation elements, - and then assign the new Matrix3D object to the display object using the transform.matrix - property.

-

To modify a perspective projection of the stage or root object: - use the transform.matrix property of the root display object to gain access to the - PerspectiveProjection object. Or, apply different perspective projection - properties to a display object by setting the perspective projection properties of the display - object's parent. The child display object inherits the new properties. Specifically, create a - PerspectiveProjection object and set its properties, then assign the PerspectiveProjection - object to the perspectiveProjection property of the parent display object's - transform property. The specified projection transformation then applies - to all the display object's three-dimensional children.

-

Since both PerspectiveProjection and Matrix3D objects perform perspective transformations, - do not assign both to a display object at the same time. Use the PerspectiveProjection object - for focal length and projection center changes. For more control over the perspective transformation, - create a perspective projection Matrix3D object.

-

-

-View the examples. -

-

-See also -

-
-flash.display.DisplayObject.transform -
-flash.geom.ColorTransform -
-flash.geom.Matrix -
-flash.geom.Matrix3D -
-flash.geom.PerspectiveProjection -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  colorTransform : ColorTransform -
- A ColorTransform object containing values that universally adjust the colors in - the display object.
-		Transform
  concatenatedColorTransform : ColorTransform -
[read-only] - A ColorTransform object representing the combined color transformations applied to the display object - and all of its parent objects, back to the root level.
-		Transform
  concatenatedMatrix : Matrix -
[read-only] - A Matrix object representing the combined transformation matrixes of the - display object and all of its parent objects, back to the root level.
-		Transform
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  matrix : Matrix -
- A Matrix object containing values that alter the scaling, rotation, - and translation of the display object.
-		Transform
  matrix3D : Matrix3D -
- Provides access to the Matrix3D object of a three-dimensional display object.
-		Transform
  perspectiveProjection : PerspectiveProjection -
- Provides access to the PerspectiveProjection object of a three-dimensional display - object.
-		Transform
  pixelBounds : Rectangle -
[read-only] - A Rectangle object that defines the bounding rectangle of the display object on the stage.
-		Transform
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-copyConcatenatedColorTransformToOutput(output:ColorTransform):void -
-
- A ColorTransform object representing the combined color transformations applied to the display object - and all of its parent objects, back to the root level.
-		Transform
   -
-copyConcatenatedMatrixToOutput(output:Matrix):void -
-
- A Matrix object representing the combined transformation matrixes of the - display object and all of its parent objects, back to the root level.
-		Transform
   -
-copyPerspectiveProjectionToOutput(output:PerspectiveProjection):void -
-
- Provides access to the PerspectiveProjection object of a three-dimensional display - object.
-		Transform
   -
-copyPixelBoundsToOutput(output:Rectangle):void -
-
- Provides access to the Rectangle object that defines the bounding rectangle of the display object on the stage.
-		Transform
   -
-getRelativeMatrix3D(relativeTo:DisplayObject):Matrix3D -
-
- Returns a Matrix3D object, which can transform the space of a specified - display object in relation to the current display object's space.
-		Transform
   -
-getRelativeMatrix3DToOutput(relativeTo:DisplayObject, output:Matrix3D):Matrix3D -
-
- Returns a Matrix3D object, which can transform the space of a specified - display object in relation to the current display object's space.
-		Transform
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
colorTransformproperty
-
-colorTransform:ColorTransform  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A ColorTransform object containing values that universally adjust the colors in - the display object. - -

Implementation -
-    public function get colorTransform():ColorTransform -
-    public function set colorTransform(value:ColorTransform):void -
-
-Throws -
- - - - -
TypeError — The colorTransform is null when being set - -
-

-See also -

-
-flash.geom.ColorTransform -
-
- - - - - -
concatenatedColorTransformproperty 
-
-concatenatedColorTransform:ColorTransform  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A ColorTransform object representing the combined color transformations applied to the display object - and all of its parent objects, back to the root level. - If different color transformations have been applied at different levels, all of those transformations are - concatenated into one ColorTransform object - for this property. - -

Implementation -
-    public function get concatenatedColorTransform():ColorTransform -
-

-See also -

-
-flash.geom.ColorTransform -
-
- - - - - -
concatenatedMatrixproperty 
-
-concatenatedMatrix:Matrix  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A Matrix object representing the combined transformation matrixes of the - display object and all of its parent objects, back to the root level. - If different transformation matrixes have been applied at different levels, - all of those matrixes are concatenated into one matrix - for this property. Also, for resizeable SWF content running in the browser, - this property factors in the difference between stage coordinates and window - coordinates due to window resizing. Thus, the property converts local coordinates - to window coordinates, which may not be the same coordinate space as that of - the Stage. - -

Implementation -
-    public function get concatenatedMatrix():Matrix -
-
- - - - - -
matrixproperty 
-
-matrix:Matrix  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A Matrix object containing values that alter the scaling, rotation, - and translation of the display object. - - -

If the matrix property is set to a value (not null), the - matrix3D property is null. And if the matrix3D property - is set to a value (not null), the matrix property is null.

- - Implementation -
-    public function get matrix():Matrix -
-    public function set matrix(value:Matrix):void -
-
-Throws -
- - - - -
TypeError — The matrix is null when being set - -
-

-See also -

-
-flash.geom.Matrix -
-
- - - - - -
matrix3Dproperty 
-
-matrix3D:Matrix3D  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Provides access to the Matrix3D object of a three-dimensional display object. - The Matrix3D object represents a transformation matrix that determines the - display object's position and orientation. A Matrix3D object can also - perform perspective projection. - - -

If the matrix property is set to a value (not null), the - matrix3D property is null. And if the matrix3D property - is set to a value (not null), the matrix property is null.

- - Implementation -
-    public function get matrix3D():Matrix3D -
-    public function set matrix3D(value:Matrix3D):void -
-

-See also -

-
-flash.geom.Matrix3D -
-
- - - - - -
perspectiveProjectionproperty 
-
-perspectiveProjection:PerspectiveProjection  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Provides access to the PerspectiveProjection object of a three-dimensional display - object. The PerspectiveProjection object can be used to modify the perspective - transformation of the stage or to assign a perspective transformation to all the - three-dimensional children of a display object. -

Based on the field of view and aspect ratio (dimensions) of the stage, a - default PerspectiveProjection object is assigned to the root object.

- Implementation -
-    public function get perspectiveProjection():PerspectiveProjection -
-    public function set perspectiveProjection(value:PerspectiveProjection):void -
-

-See also -

-
-flash.geom.PerspectiveProjection -
-
- - - - - -
pixelBoundsproperty 
-
-pixelBounds:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A Rectangle object that defines the bounding rectangle of the display object on the stage. - -

Implementation -
-    public function get pixelBounds():Rectangle -
-
- -
Method detail
- - - - - -
copyConcatenatedColorTransformToOutput()method
-
-public function copyConcatenatedColorTransformToOutput(output:ColorTransform):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1
-

- A ColorTransform object representing the combined color transformations applied to the display object - and all of its parent objects, back to the root level. - If different color transformations have been applied at different levels, all of those transformations are - concatenated into one ColorTransform object - for this property. - -

Parameters - - - - -
output:ColorTransform — The ColorTransform object to set with the combined color transformations. -
-

-See also -

-
-flash.geom.ColorTransform -
-
- - - - - -
copyConcatenatedMatrixToOutput()method 
-
-public function copyConcatenatedMatrixToOutput(output:Matrix):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1
-

- A Matrix object representing the combined transformation matrixes of the - display object and all of its parent objects, back to the root level. - If different transformation matrixes have been applied at different levels, - all of those matrixes are concatenated into one matrix - for this property. Also, for resizeable SWF content running in the browser, - this property factors in the difference between stage coordinates and window - coordinates due to window resizing. Thus, the property converts local coordinates - to window coordinates, which may not be the same coordinate space as that of - the Stage. - -

Parameters - - - - -
output:Matrix — The Matrix object to set with the concatenated transformation matrices. - -
-
- - - - - -
copyPerspectiveProjectionToOutput()method 
-
-public function copyPerspectiveProjectionToOutput(output:PerspectiveProjection):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1
-

- Provides access to the PerspectiveProjection object of a three-dimensional display - object. The PerspectiveProjection object can be used to modify the perspective - transformation of the stage or to assign a perspective transformation to all the - three-dimensional children of a display object. -

Based on the field of view and aspect ratio (dimensions) of the stage, a - default PerspectiveProjection object is assigned to the root object.

- Parameters - - - - -
output:PerspectiveProjection — An existing PerspectiveProject object to be set with the values. -
-

-See also -

-
-flash.geom.PerspectiveProjection -
-
- - - - - -
copyPixelBoundsToOutput()method 
-
-public function copyPixelBoundsToOutput(output:Rectangle):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Provides access to the Rectangle object that defines the bounding rectangle of the display object on the stage. -

Parameters - - - - -
output:Rectangle — An existing Rectangle object to set with the bounding rectangle values. -
-
- - - - - -
getRelativeMatrix3D()method 
-
-public function getRelativeMatrix3D(relativeTo:DisplayObject):Matrix3D -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a Matrix3D object, which can transform the space of a specified - display object in relation to the current display object's space. You can use the - getRelativeMatrix3D() method to move one three-dimensional display - object relative to another three-dimensional display object. -

Parameters - - - - -
relativeTo:DisplayObject — The display object relative to which the transformation occurs. - To get a Matrix3D object relative to the stage, set the parameter to the root - or stage object. To get the world-relative matrix of the display object, - set the parameter to a display object that has a perspective transformation applied to it. - -
-

-Returns - - - - -
Matrix3D — - A Matrix3D object that can be used to transform the space from the relativeTo - display object to the current display object space. - - - -
-

-See also -

-
-flash.geom.Matrix3D -
-
- - - - - -
getRelativeMatrix3DToOutput()method 
-
-public function getRelativeMatrix3DToOutput(relativeTo:DisplayObject, output:Matrix3D):Matrix3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Returns a Matrix3D object, which can transform the space of a specified - display object in relation to the current display object's space. You can use the - getRelativeMatrix3D() method to move one three-dimensional display - object relative to another three-dimensional display object. -

Parameters - - - - - - - - - - -
relativeTo:DisplayObject — The display object relative to which the transformation occurs. - To get a Matrix3D object relative to the stage, set the parameter to the root - or stage object. To get the world-relative matrix of the display object, - set the parameter to a display object that has a perspective transformation applied to it. -
 
output:Matrix3D — An optional Matrix3D output to be used for the result of the operation rather than it creating a new object to return. - -
-

-Returns - - - - -
Matrix3D — - A Matrix3D object that can be used to transform the space from the relativeTo - display object to the current display object space. - - - -
-

-See also -

-
-flash.geom.Matrix3D -
-
- -
Examples
-
examples\TransformExample
-
The following example uses the TransformExample class to skew the bottom side - of a square sprite filled with a gradient pattern. Each time the user clicks the square, the - application transforms the sprite by skewing it with the following steps: - -
    -
  1. The TransformExample() constructor creates a new sprite object target.
    2. - -
  2. The TransformExample() constructor calls the draw() method, - which draws a gradient square in the sprite.
    3. - -
  3. The TransformExample() constructor adds a click event listener for the sprite, - which is handled by the clickHandler() method.
    4. - -
  4. The clickHandler() method creates a new Matrix object, skewMatrix, - which is set to apply a skew effect. Another matrix, tempMatrix, is assigned to the - current transformation matrix of the sprite, and then is combined with skewMatrix - using the concat() method. This matrix is assigned to the - transform.matrix property of the square sprite. Each time the user clicks the square, - the call to the clickHandler() modifies the shape of the square by skewing it.
    5. - -
  5. Additionally, the clickHandler() method creates a new ColorTransform object. The - redOffset property of the new ColorTransform is set to the current value of redOffset and - increased by 25. Likewise, the blueOffset property is reduced by 25. With each click, - the colors of the sprite change.
    6. -
-
-
-package {
-	import flash.display.Sprite;
-	import flash.display.GradientType;
-	import flash.geom.Matrix;
-	import flash.geom.ColorTransform;
-	import flash.events.MouseEvent;
-
-	public class TransformExample extends Sprite {
-		public function TransformExample() { 
-			var target:Sprite = new Sprite();
-			draw(target);
-			addChild(target);
-			target.useHandCursor = true;
-			target.buttonMode = true;
-			target.addEventListener(MouseEvent.CLICK, clickHandler)
-		}
-		public function draw(sprite:Sprite):void {
-			var red:uint = 0xFF0000;
-			var green:uint = 0x00FF00;
-			var blue:uint = 0x0000FF;
-			var size:Number = 100;
-			sprite.graphics.beginGradientFill(GradientType.LINEAR, [red, blue, green], [1, 0.5, 1], [0, 200, 255]);
-			sprite.graphics.drawRect(0, 0, 100, 100);
-		}
-		public function clickHandler(event:MouseEvent):void {
-			var skewMatrix:Matrix = new Matrix();
-			skewMatrix.c = 0.25;
-			var tempMatrix:Matrix = this.transform.matrix;
-			tempMatrix.concat(skewMatrix);
-			this.transform.matrix = tempMatrix;
-			
-            var rOffset:Number = this.transform.colorTransform.redOffset + 25;
-            var bOffset:Number = this.transform.colorTransform.blueOffset - 25;
-            this.transform.colorTransform = new ColorTransform(1, 1, 1, 1, rOffset, 0, bOffset, 0);			
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/geom/Utils3D.html b/html-docs/flash/geom/Utils3D.html deleted file mode 100644 index d96813c..0000000 --- a/html-docs/flash/geom/Utils3D.html +++ /dev/null @@ -1,697 +0,0 @@ - - - - - - - - -flash.geom.Utils3D (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.geom
Classpublic class Utils3D
InheritanceUtils3D Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The Utils3D class contains static methods that simplify the implementation of certain three-dimensional - matrix operations. - -

-

-See also -

-
-flash.geom.Matrix3D -
-flash.geom.Vector3D -
-flash.geom.Transform -
-flash.geom.PerspectiveProjection -
-flash.display.Graphics -
-flash.display.GraphicsTrianglePath -
-Vector -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-pointTowards(percent:Number, mat:Matrix3D, pos:Vector3D, at:Vector3D = null, up:Vector3D = null):Matrix3D -
-
[static] - Interpolates the orientation of an object toward a position.
-		Utils3D
   -
-pointTowardsToOutput(percent:Number, mat:Matrix3D, pos:Vector3D, at:Vector3D = null, up:Vector3D = null, output:Matrix3D = null):Matrix3D -
-
[static] - Interpolates the orientation of an object toward a position.
-		Utils3D
   -
-projectVector(m:Matrix3D, v:Vector3D):Vector3D -
-
[static] - Using a projection Matrix3D object, projects a Vector3D object from one space coordinate to another.
-		Utils3D
   -
-projectVectors(m:Matrix3D, verts:Vector.<Number>, projectedVerts:Vector.<Number>, uvts:Vector.<Number>):void -
-
[static] - Using a projection Matrix3D object, projects a Vector of three-dimensional space coordinates (verts) - to a Vector of two-dimensional space coordinates (projectedVerts).
-		Utils3D
   -
-projectVectorToOutput(m:Matrix3D, v:Vector3D, output:Vector3D):Vector3D -
-
[static] - Using a projection Matrix3D object, projects a Vector3D object from one space coordinate to another.
-		Utils3D
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Method detail
- - - - - -
pointTowards()method
-
-public static function pointTowards(percent:Number, mat:Matrix3D, pos:Vector3D, at:Vector3D = null, up:Vector3D = null):Matrix3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Interpolates the orientation of an object toward a position. The pointTowards() - method combines the functionality of the Matrix3D.pointAt() and - Matrix3D.interpolateTo() methods. - -

The pointTowards() method allows for in-place modification to the orientation. - It decomposes the Matrix3D of the display object and replaces the rotation elements - by ones that make a percent turn toward the position of the target. The object - can make an incremental turn toward the target while still moving in its own direction. - The consecutive calls to the pointTowards() followed by a translation method - can produce the animation of an object chasing or following a moving target. - First point the object a percent point toward the target, then incrementally move the - object along an axis.

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
percent:Number — A Number between 0 and 1 that incrementally turns the object toward the target. -
 
mat:Matrix3D — The Matrix3D property of the object that is transformed. -
 
pos:Vector3D — The world-relative position of the target object. World-relative defines - the transformation of the object relative to the world space and coordinates, - where all objects are positioned. -
 
at:Vector3D (default = null) — The object-relative vector that defines where the display object is pointing. - Object-relative defines the transformation of the object relative to the object space, - the object's own frame of reference and coordinate system. Default value is (0,0,-1). -
 
up:Vector3D (default = null) — The object-relative vector that defines "up" for the display object. If the object - is drawn looking down from the above, the +z axis is its "up" vector. - Object-relative defines the transformation of the object relative to the object space, the object's - own frame of reference and coordinate system. Default value is (0,-1,0). -
-

-Returns - - - - -
Matrix3D — - A modified version of the Matrix3D object specified in the second parameter. To - transform the display object using the pointTowards() method, set the Matrix3D property - of the display object to the returned Matrix3D object. - - -
-

-See also -

-
-flash.geom.Matrix3D.pointAt() -
-flash.geom.Matrix3D.interpolateTo() -
-flash.geom.Matrix3D.interpolate() -
-
- - - - - -
pointTowardsToOutput()method 
-
-public static function pointTowardsToOutput(percent:Number, mat:Matrix3D, pos:Vector3D, at:Vector3D = null, up:Vector3D = null, output:Matrix3D = null):Matrix3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Interpolates the orientation of an object toward a position. The pointTowards() - method combines the functionality of the Matrix3D.pointAt() and - Matrix3D.interpolateTo() methods. - -

The pointTowards() method allows for in-place modification to the orientation. - It decomposes the Matrix3D of the display object and replaces the rotation elements - by ones that make a percent turn toward the position of the target. The object - can make an incremental turn toward the target while still moving in its own direction. - The consecutive calls to the pointTowards() followed by a translation method - can produce the animation of an object chasing or following a moving target. - First point the object a percent point toward the target, then incrementally move the - object along an axis.

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
percent:Number — A Number between 0 and 1 that incrementally turns the object toward the target. -
 
mat:Matrix3D — The Matrix3D property of the object that is transformed. -
 
pos:Vector3D — The world-relative position of the target object. World-relative defines - the transformation of the object relative to the world space and coordinates, - where all objects are positioned. -
 
at:Vector3D (default = null) — The object-relative vector that defines where the display object is pointing. - Object-relative defines the transformation of the object relative to the object space, - the object's own frame of reference and coordinate system. Default value is (0,0,-1). -
 
up:Vector3D (default = null) — The object-relative vector that defines "up" for the display object. If the object - is drawn looking down from the above, the +z axis is its "up" vector. - Object-relative defines the transformation of the object relative to the object space, the object's - own frame of reference and coordinate system. Default value is (0,-1,0). -
 
output:Matrix3D (default = null) — An optional Matrix3D object that will be used for the output rather than creating a new Matrix3D object -
-

-Returns - - - - -
Matrix3D — - A modified version of the Matrix3D object specified in the second parameter. To - transform the display object using the pointTowards() method, set the Matrix3D property - of the display object to the returned Matrix3D object. - - -
-

-See also -

-
-flash.geom.Matrix3D.pointAt() -
-flash.geom.Matrix3D.interpolateTo() -
-flash.geom.Matrix3D.interpolate() -
-
- - - - - -
projectVector()method 
-
-public static function projectVector(m:Matrix3D, v:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Using a projection Matrix3D object, projects a Vector3D object from one space coordinate to another. - The projectVector() method is like the Matrix3D.transformVector() - method except that the projectVector() method divides the x, y, and z - elements of the original Vector3D object by the projection depth value. The depth value is the distance - from the eye to the Vector3D object in view or eye space. The default value for this distance is the - value of the z element. -

Parameters - - - - - - - - - - -
m:Matrix3D — A projection Matrix3D object that implements the projection transformation. If a display object - has a PerspectiveProjection object, you can use the perspectiveProjection.toMatrix() method - to produce a projection Matrix3D object that applies to the children of the display object. For more advance - projections, use the matrix3D.rawData property to create a custom projection matrix. - There is no built-in Matrix3D method for creating a projection Matrix3D object. -
 
v:Vector3D — The Vector3D object that is projected to a new space coordinate. -
-

-Returns - - - - -
Vector3D — - A new Vector3D with a transformed space coordinate. - - -
-

-See also -

-
-flash.geom.Matrix3D.transformVector() -
-projectVectors() -
-
- - - - - -
projectVectors()method 
-
-public static function projectVectors(m:Matrix3D, verts:Vector.<Number>, projectedVerts:Vector.<Number>, uvts:Vector.<Number>):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Using a projection Matrix3D object, projects a Vector of three-dimensional space coordinates (verts) - to a Vector of two-dimensional space coordinates (projectedVerts). The projected Vector - object should be pre-allocated before it is used as a parameter. -

The projectVectors() method also sets the t value of the uvt data. - You should pre-allocate a Vector that can hold the uvts data for each projected - Vector set of coordinates. Also specify the u and v values of the - uvt data. The uvt data is a Vector of normalized coordinates used for texture - mapping. In UV coordinates, (0,0) is the upper left of the bitmap, and (1,1) is the lower right of the bitmap.

- -

This method can be used in conjunction with the Graphics.drawTriangles() method - and the GraphicsTrianglePath class.

- - Parameters - - - - - - - - - - - - - - - - - - - - - - -
m:Matrix3D — A projection Matrix3D object that implements the projection transformation. You can produce a - projection Matrix3D object using the Matrix3D.rawData property. -
 
verts:Vector.<Number> — A Vector of Numbers, where every three Numbers represent the x, y, - and z coordinates of a three-dimensional space, like Vector3D(x,y,z). -
 
projectedVerts:Vector.<Number> — A vector of Numbers, where every two Numbers represent a projected two-dimensional - coordinate, like Point(x,y). You should pre-allocate the Vector. The projectVectors() - method fills the values for each projected point. -
 
uvts:Vector.<Number> — A vector of Numbers, where every three Numbers represent the u, v, and t - elements of the uvt data. The u and v are the texture coordinate for each projected - point. The t value is the projection depth value, the distance from the eye to the Vector3D object in the - view or eye space. You should pre-allocate the Vector and specify the u and v values. - The projectVectors method fills the t value for each projected point. -
-

-See also -

-
-flash.display.Graphics.drawTriangles() -
-flash.display.GraphicsTrianglePath -
-flash.geom.Matrix3D -
-projectVector() -
-Vector -
-
- - - - - -
projectVectorToOutput()method 
-
-public static function projectVectorToOutput(m:Matrix3D, v:Vector3D, output:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Using a projection Matrix3D object, projects a Vector3D object from one space coordinate to another. - The projectVector() method is like the Matrix3D.transformVector() - method except that the projectVector() method divides the x, y, and z - elements of the original Vector3D object by the projection depth value. The depth value is the distance - from the eye to the Vector3D object in view or eye space. The default value for this distance is the - value of the z element. -

Parameters - - - - - - - - - - - - - - - - -
m:Matrix3D — A projection Matrix3D object that implements the projection transformation. If a display object - has a PerspectiveProjection object, you can use the perspectiveProjection.toMatrix() method - to produce a projection Matrix3D object that applies to the children of the display object. For more advance - projections, use the matrix3D.rawData property to create a custom projection matrix. - There is no built-in Matrix3D method for creating a projection Matrix3D object. -
 
v:Vector3D — The Vector3D object that is projected to a new space coordinate. -
 
output:Vector3D — An optional Vector3D object that will be used for the output rather than creating a new Vector3D object -
-

-Returns - - - - -
Vector3D — - A new Vector3D with a transformed space coordinate. - - -
-

-See also -

-
-flash.geom.Matrix3D.transformVector() -
-projectVectors() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/geom/Vector3D.html b/html-docs/flash/geom/Vector3D.html deleted file mode 100644 index 883288a..0000000 --- a/html-docs/flash/geom/Vector3D.html +++ /dev/null @@ -1,1833 +0,0 @@ - - - - - - - - -flash.geom.Vector3D (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.geom
Classpublic class Vector3D
InheritanceVector3D Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The Vector3D class represents a point or a location in the three-dimensional space using the - Cartesian coordinates x, y, and z. As in a two-dimensional space, the x property represents the - horizontal axis and the y property represents the vertical axis. In three-dimensional space, the - z property represents depth. The value of the x property increases as the object moves to the right. - The value of the y property increases as the object moves down. The z property increases as the object - moves farther from the point of view. Using perspective projection and scaling, the object is seen - to be bigger when near and smaller when farther away from the screen. As in a right-handed three-dimensional - coordinate system, the positive z-axis points away from the viewer and the value of the z property - increases as the object moves away from the viewer's eye. The origin point (0,0,0) of the global space - is the upper-left corner of the stage. - -

X, Y, Z Axes

-

The Vector3D class can also represent a direction, an arrow pointing from the origin of the coordinates, such as - (0,0,0), to an endpoint; or a floating-point component of an RGB (Red, Green, Blue) color model.

-

Quaternion notation introduces a fourth element, the w property, which provides additional orientation - information. For example, the w property can define an angle of rotation of a Vector3D object. The - combination of the angle of rotation and the coordinates x, y, and z can determine the display object's - orientation. Here is a representation of Vector3D elements in matrix notation:

-

Vector3D elements

- -

-

-See also -

-
-flash.display.DisplayObject -
-flash.geom.Point -
-flash.geom.Matrix3D -
-flash.geom.Utils3D -
-Vector -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  length : Number -
[read-only] - The length, magnitude, of the current Vector3D object from the origin (0,0,0) to - the object's x, y, and z coordinates.
-		Vector3D
  lengthSquared : Number -
[read-only] - The square of the length of the current Vector3D object, calculated using the x, - y, and z properties.
-		Vector3D
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  w : Number -
- The fourth element of a Vector3D object (in addition to the x, y, - and z properties) can hold - data such as the angle of rotation.
-		Vector3D
  x : Number -
- The first element of a Vector3D object, such as - the x coordinate of a point in the three-dimensional space.
-		Vector3D
  y : Number -
- The second element of a Vector3D object, such as - the y coordinate of a point in the three-dimensional space.
-		Vector3D
  z : Number -
- The third element of a Vector3D object, such as - the z coordinate of a point in three-dimensional space.
-		Vector3D
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Vector3D(x:Number = 0., y:Number = 0., z:Number = 0., w:Number = 0.)
-
- Creates an instance of a Vector3D object.
-		Vector3D
   -
-add(a:Vector3D):Vector3D -
-
- Adds the value of the x, y, and z elements of the current Vector3D object - to the values of the x, y, and z elements of another Vector3D object.
-		Vector3D
   -
-addToOutput(a:Vector3D, output:Vector3D):Vector3D -
-
- Adds the value of the x, y, and z elements of the current Vector3D object - to the values of the x, y, and z elements of another Vector3D object.
-		Vector3D
   -
-angleBetween(a:Vector3D, b:Vector3D):Number -
-
[static] - Returns the angle in radians between two vectors.
-		Vector3D
   -
-clone():Vector3D -
-
- Returns a new Vector3D object that is an exact copy of the current Vector3D object.
-		Vector3D
   -
-copyFrom(sourceVector3D:Vector3D):void -
-
- Copies all of vector data from the source Vector3D object into the - calling Vector3D object.
-		Vector3D
   -
-crossProduct(a:Vector3D):Vector3D -
-
- Returns a new Vector3D object that is perpendicular (at a right angle) to the current - Vector3D and another Vector3D object.
-		Vector3D
   -
-crossProductToOutput(a:Vector3D, output:Vector3D):Vector3D -
-
- Returns a new Vector3D object that is perpendicular (at a right angle) to the current - Vector3D and another Vector3D object.
-		Vector3D
   -
-decrementBy(a:Vector3D):void -
-
- Decrements the value of the x, y, and z elements of the current Vector3D object - by the values of the x, y, and z elements of specified Vector3D object.
-		Vector3D
   -
-distance(pt1:Vector3D, pt2:Vector3D):Number -
-
[static] - Returns the distance between two Vector3D objects.
-		Vector3D
   -
-dotProduct(a:Vector3D):Number -
-
- If the current Vector3D object and the one specified as the parameter are unit vertices, this - method returns the cosine of the angle between the two vertices.
-		Vector3D
   -
-equals(toCompare:Vector3D, allFour:Boolean = false):Boolean -
-
- Determines whether two Vector3D objects are equal by comparing the x, y, and z - elements of the current Vector3D object with a specified Vector3D object.
-		Vector3D
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-incrementBy(a:Vector3D):void -
-
- Increments the value of the x, y, and z elements of the current Vector3D object - by the values of the x, y, and z elements of a specified Vector3D object.
-		Vector3D
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-nearEquals(toCompare:Vector3D, tolerance:Number, allFour:Boolean = false):Boolean -
-
- Compares the elements of the current Vector3D object with the elements of a specified - Vector3D object to determine whether they are nearly equal.
-		Vector3D
   -
-negate():void -
-
- Sets the current Vector3D object to its inverse.
-		Vector3D
   -
-normalize():Number -
-
- Converts a Vector3D object to a unit vector by dividing the first three elements - (x, y, z) by the length of the vector.
-		Vector3D
   -
-project():void -
-
- Divides the value of the x, y, and z properties of the - current Vector3D object by the value of its w property.
-		Vector3D
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-scaleBy(s:Number):void -
-
- Scales the current Vector3D object by a scalar, a magnitude.
-		Vector3D
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setTo(xa:Number, ya:Number, za:Number):void -
-
- Sets the members of Vector3D to the specified values - -
-		Vector3D
   -
-subtract(a:Vector3D):Vector3D -
-
- Subtracts the value of the x, y, and z elements of the current Vector3D object - from the values of the x, y, and z elements of another Vector3D object.
-		Vector3D
   -
-subtractToOutput(a:Vector3D, output:Vector3D):Vector3D -
-
- Subtracts the value of the x, y, and z elements of the current Vector3D object - from the values of the x, y, and z elements of another Vector3D object.
-		Vector3D
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string representation of the current Vector3D object.
-		Vector3D
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  X_AXIS : Vector3D -
[static] - The x axis defined as a Vector3D object with coordinates (1,0,0).
-		Vector3D
  Y_AXIS : Vector3D -
[static] - The y axis defined as a Vector3D object with coordinates (0,1,0).
-		Vector3D
  Z_AXIS : Vector3D -
[static] - The z axis defined as a Vector3D object with coordinates (0,0,1).
-		Vector3D
-
- -
- -
Property detail
- - - - - -
lengthproperty
-
-length:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The length, magnitude, of the current Vector3D object from the origin (0,0,0) to - the object's x, y, and z coordinates. The w - property is ignored. A unit vector has a length or magnitude of one. -

Implementation -
-    public function get length():Number -
-

-See also -

-
-lengthSquared -
-
- - - - - -
lengthSquaredproperty 
-
-lengthSquared:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The square of the length of the current Vector3D object, calculated using the x, - y, and z properties. The w property is ignored. - Use the lengthSquared() method whenever possible instead of the slower - Math.sqrt() method call of the Vector3D.length() method. -

Implementation -
-    public function get lengthSquared():Number -
-

-See also -

-
-length -
-
- - - - - -
wproperty 
-
-public var w:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The fourth element of a Vector3D object (in addition to the x, y, - and z properties) can hold - data such as the angle of rotation. The default value is 0. -

Quaternion notation employs an angle as the fourth element in its calculation of - three-dimensional rotation. The w property can be used to define the angle of rotation - about the Vector3D object. The combination of the rotation angle and the coordinates (x,y,z) - determines the display object's orientation.

-

In addition, the w property can be used as a perspective - warp factor for a projected three-dimensional position or as a projection transform value in - representing a three-dimensional coordinate projected into the two-dimensional space. For example, - you can create a projection matrix using the Matrix3D.rawData property, that, when - applied to a Vector3D object, produces a transform value in the Vector3D object's fourth element (the - w property). Dividing the Vector3D object's other elements by the transform value - then produces a projected Vector3D object. You can use the Vector3D.project() method - to divide the first three elements of a Vector3D object by its fourth element.

- -

-See also -

-
-project() -
-
- - - - - -
xproperty 
-
-public var x:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The first element of a Vector3D object, such as - the x coordinate of a point in the three-dimensional space. The default value is 0. - -

- - - - - -
yproperty 
-
-public var y:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The second element of a Vector3D object, such as - the y coordinate of a point in the three-dimensional space. The default value is 0. - -

- - - - - -
zproperty 
-
-public var z:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The third element of a Vector3D object, such as - the z coordinate of a point in three-dimensional space. The default value is 0. - -

- -
Constructor detail
- - - - - -
Vector3D()constructor
-
-public function Vector3D(x:Number = 0., y:Number = 0., z:Number = 0., w:Number = 0.) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates an instance of a Vector3D object. If you do not specify a parameter for the constructor, - a Vector3D object is created with the elements (0,0,0,0). -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
x:Number (default = 0.) — The first element, such as the x coordinate. -
 
y:Number (default = 0.) — The second element, such as the y coordinate. -
 
z:Number (default = 0.) — The third element, such as the z coordinate. -
 
w:Number (default = 0.) — An optional element for additional data such as the angle of rotation. - -
-
- -
Method detail
- - - - - -
add()method
-
-public function add(a:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Adds the value of the x, y, and z elements of the current Vector3D object - to the values of the x, y, and z elements of another Vector3D object. - The add() method does not change the current Vector3D object. Instead, it returns - a new Vector3D object with the new values. -

The result of adding two vectors together is a resultant vector. One way to visualize - the result is by drawing a vector from the origin or tail of the first vector - to the end or head of the second vector. The resultant vector is the distance - between the origin point of the first vector and the end point of the second vector.

-

Resultant Vector3D

- Parameters - - - - -
a:Vector3D — A Vector3D object to be added to the current Vector3D object. -
-

-Returns - - - - -
Vector3D — - A Vector3D object that is the result of adding the current Vector3D object - to another Vector3D object. - - -
-

-See also -

-
-incrementBy() -
-
- - - - - -
addToOutput()method 
-
-public function addToOutput(a:Vector3D, output:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Adds the value of the x, y, and z elements of the current Vector3D object - to the values of the x, y, and z elements of another Vector3D object. - The add() method does not change the current Vector3D object. Instead, it returns - a new Vector3D object with the new values. -

The result of adding two vectors together is a resultant vector. One way to visualize - the result is by drawing a vector from the origin or tail of the first vector - to the end or head of the second vector. The resultant vector is the distance - between the origin point of the first vector and the end point of the second vector.

-

Resultant Vector3D

- Parameters - - - - - - - - - - -
a:Vector3D — A Vector3D object to be added to the current Vector3D object. -
 
output:Vector3D — An optional Vector3D object to be used as the output value, avoiding the creation of a new object -
-

-Returns - - - - -
Vector3D — - A Vector3D object that is the result of adding the current Vector3D object - to another Vector3D object. - - -
-

-See also -

-
-incrementBy() -
-
- - - - - -
angleBetween()method 
-
-public static function angleBetween(a:Vector3D, b:Vector3D):Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the angle in radians between two vectors. The returned angle is the smallest radian - the first Vector3D object rotates until it aligns with the second Vector3D object. -

The angleBetween() method is a static method. You can use it directly as - a method of the Vector3D class.

-

To convert a degree to a radian, you can use the following formula:

-

radian = Math.PI/180 * degree

- Parameters - - - - - - - - - - -
a:Vector3D — The first Vector3D object. -
 
b:Vector3D — The second Vector3D object. -
-

-Returns - - - - -
Number — - The angle between two Vector3D objects. - - -
-
- - - - - -
clone()method 
-
-public function clone():Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a new Vector3D object that is an exact copy of the current Vector3D object. -

-Returns - - - - -
Vector3D — - A new Vector3D object that is a copy of the current Vector3D object. - - -
-
- - - - - -
copyFrom()method 
-
-public function copyFrom(sourceVector3D:Vector3D):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Copies all of vector data from the source Vector3D object into the - calling Vector3D object. - -

Parameters - - - - -
sourceVector3D:Vector3D — The Vector3D object from which to copy the data. - -
-
- - - - - -
crossProduct()method 
-
-public function crossProduct(a:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a new Vector3D object that is perpendicular (at a right angle) to the current - Vector3D and another Vector3D object. If the returned Vector3D object's coordinates are - (0,0,0), then the two Vector3D objects are parallel to each other. -

Cross Product

-

You can use the normalized cross product of two vertices of a polygon surface with the - normalized vector of the camera or eye viewpoint to get a dot product. The value of - the dot product can identify whether a surface of a three-dimensional object is hidden - from the viewpoint.

- Parameters - - - - -
a:Vector3D — A second Vector3D object. -
-

-Returns - - - - -
Vector3D — - A new Vector3D object that is perpendicular to the current Vector3D object and the Vector3D - object specified as the parameter. - - -
-

-See also -

-
-dotProduct() -
-normalize() -
-
- - - - - -
crossProductToOutput()method 
-
-public function crossProductToOutput(a:Vector3D, output:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Returns a new Vector3D object that is perpendicular (at a right angle) to the current - Vector3D and another Vector3D object. If the returned Vector3D object's coordinates are - (0,0,0), then the two Vector3D objects are parallel to each other. -

Cross Product

-

You can use the normalized cross product of two vertices of a polygon surface with the - normalized vector of the camera or eye viewpoint to get a dot product. The value of - the dot product can identify whether a surface of a three-dimensional object is hidden - from the viewpoint.

- Parameters - - - - - - - - - - -
a:Vector3D — A second Vector3D object. -
 
output:Vector3D — An optional Vector3D object to be used as the output value, avoiding the creation of a new object -
-

-Returns - - - - -
Vector3D — - A new Vector3D object that is perpendicular to the current Vector3D object and the Vector3D - object specified as the parameter. - - -
-

-See also -

-
-dotProduct() -
-normalize() -
-
- - - - - -
decrementBy()method 
-
-public function decrementBy(a:Vector3D):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Decrements the value of the x, y, and z elements of the current Vector3D object - by the values of the x, y, and z elements of specified Vector3D object. Unlike the - Vector3D.subtract() method, the decrementBy() method changes the current - Vector3D object and does not return a new Vector3D object. - -

Parameters - - - - -
a:Vector3D — The Vector3D object containing the values to subtract from the current Vector3D object. -
-

-See also -

-
-subtract() -
-
- - - - - -
distance()method 
-
-public static function distance(pt1:Vector3D, pt2:Vector3D):Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the distance between two Vector3D objects. The distance() method - is a static method. You can use it directly as a method of the Vector3D class to get - the Euclidean distance between two three-dimensional points. -

Parameters - - - - - - - - - - -
pt1:Vector3D — A Vector3D object as the first three-dimensional point. -
 
pt2:Vector3D — A Vector3D object as the second three-dimensional point. -
-

-Returns - - - - -
Number — - The distance between two Vector3D objects. - - -
-
- - - - - -
dotProduct()method 
-
-public function dotProduct(a:Vector3D):Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- If the current Vector3D object and the one specified as the parameter are unit vertices, this - method returns the cosine of the angle between the two vertices. Unit vertices are vertices that - point to the same direction but their length is one. They remove the length of the vector - as a factor in the result. You can use the normalize() method to convert a vector to a unit vector. - -

The dotProduct() method finds the angle between two vertices. It is also - used in backface culling or lighting calculations. Backface culling is a procedure for determining - which surfaces are hidden from the viewpoint. You can use the normalized vertices from the camera, - or eye, viewpoint and the cross product of the vertices of a polygon surface to get the dot product. - If the dot product is less than zero, then the surface is facing the camera or the viewer. If the - two unit vertices are perpendicular to each other, they are orthogonal and the dot product is zero. - If the two vertices are parallel to each other, the dot product is one.

- Parameters - - - - -
a:Vector3D — The second Vector3D object. -
-

-Returns - - - - -
Number — - A scalar which is the dot product of the current Vector3D object and the specified Vector3D object. - - -
-

-See also -

-
-crossProduct() -
-normalize() -
-
- - - - - -
equals()method 
-
-public function equals(toCompare:Vector3D, allFour:Boolean = false):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Determines whether two Vector3D objects are equal by comparing the x, y, and z - elements of the current Vector3D object with a specified Vector3D object. If the values of - these elements are the same, the two Vector3D objects are equal. If the second - optional parameter is set to true, all four elements of the Vector3D objects, - including the w property, are compared. -

Parameters - - - - - - - - - - -
toCompare:Vector3D — The Vector3D object to be compared with the current Vector3D object. -
 
allFour:Boolean (default = false) — An optional parameter that specifies whether the w property of - the Vector3D objects is used in the comparison. -
-

-Returns - - - - -
Boolean — - A value of true if the specified Vector3D object is equal to the current - Vector3D object; false if it is not equal. - - -
-

-See also -

-
-nearEquals() -
-
- - - - - -
incrementBy()method 
-
-public function incrementBy(a:Vector3D):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Increments the value of the x, y, and z elements of the current Vector3D object - by the values of the x, y, and z elements of a specified Vector3D object. Unlike the - Vector3D.add() method, the incrementBy() method changes the current - Vector3D object and does not return a new Vector3D object. - -

Parameters - - - - -
a:Vector3D — The Vector3D object to be added to the current Vector3D object. -
-

-See also -

-
-add() -
-
- - - - - -
nearEquals()method 
-
-public function nearEquals(toCompare:Vector3D, tolerance:Number, allFour:Boolean = false):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Compares the elements of the current Vector3D object with the elements of a specified - Vector3D object to determine whether they are nearly equal. The two Vector3D objects are nearly equal - if the value of all the elements of the two vertices are equal, or the result of the comparison - is within the tolerance range. The difference between two elements must be less than the number - specified as the tolerance parameter. If the third optional parameter is set to - true, all four elements of the Vector3D objects, including the w property, - are compared. Otherwise, only the x, y, and z elements are included in the comparison. -

Parameters - - - - - - - - - - - - - - - - -
toCompare:Vector3D — The Vector3D object to be compared with the current Vector3D object. -
 
tolerance:Number — A number determining the tolerance factor. If the difference between the values - of the Vector3D element specified in the toCompare parameter and the current Vector3D element - is less than the tolerance number, the two values are considered nearly equal. -
 
allFour:Boolean (default = false) — An optional parameter that specifies whether the w property of - the Vector3D objects is used in the comparison. -
-

-Returns - - - - -
Boolean — - A value of true if the specified Vector3D object is nearly equal to the current - Vector3D object; false if it is not equal. - - -
-

-See also -

-
-equals() -
-
- - - - - -
negate()method 
-
-public function negate():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Sets the current Vector3D object to its inverse. The inverse object is also considered the - opposite of the original object. The value of - the x, y, and z properties of the current Vector3D object - is changed to -x, -y, and -z. - -

- - - - - -
normalize()method 
-
-public function normalize():Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Converts a Vector3D object to a unit vector by dividing the first three elements - (x, y, z) by the length of the vector. Unit vertices are - vertices that have a direction but their length is one. They simplify - vector calculations by removing length as a factor. - -

-Returns - - - - -
Number — - The length of the current Vector3D object. - - -
-
- - - - - -
project()method 
-
-public function project():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Divides the value of the x, y, and z properties of the - current Vector3D object by the value of its w property. -

If the current Vector3D object is the result of multiplying a Vector3D object by a projection Matrix3D object, - the w property can hold the transform value. The project() method then can - complete the projection by dividing the elements by the w property. Use the - Matrix3D.rawData property to create a projection Matrix3D object.

-
- - - - - -
scaleBy()method 
-
-public function scaleBy(s:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Scales the current Vector3D object by a scalar, a magnitude. The Vector3D object's - x, y, and z elements are multiplied by the scalar number - specified in the parameter. For example, if the vector is scaled by ten, - the result is a vector that is ten times longer. The scalar can also - change the direction of the vector. Multiplying the vector by a negative - number reverses its direction. - -

Parameters - - - - -
s:Number — A multiplier (scalar) used to scale a Vector3D object. -
-
- - - - - -
setTo()method 
-
-public function setTo(xa:Number, ya:Number, za:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 -
-

- Sets the members of Vector3D to the specified values - -

Parameters - - - - - - - - - - - - - - - - -
xa:Number — the values to set the vector to. - -
 
ya:Number
 
za:Number
-
- - - - - -
subtract()method 
-
-public function subtract(a:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Subtracts the value of the x, y, and z elements of the current Vector3D object - from the values of the x, y, and z elements of another Vector3D object. - The subtract() method does not change the current Vector3D object. Instead, - this method returns a new Vector3D object with the new values. - -

Parameters - - - - -
a:Vector3D — The Vector3D object to be subtracted from the current Vector3D object. -
-

-Returns - - - - -
Vector3D — - A new Vector3D object that is the difference between the current Vector3D - and the specified Vector3D object. - - -
-

-See also -

-
-decrementBy() -
-
- - - - - -
subtractToOutput()method 
-
-public function subtractToOutput(a:Vector3D, output:Vector3D):Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Subtracts the value of the x, y, and z elements of the current Vector3D object - from the values of the x, y, and z elements of another Vector3D object. - The subtract() method does not change the current Vector3D object. Instead, - this method returns a new Vector3D object with the new values. - -

Parameters - - - - - - - - - - -
a:Vector3D — The Vector3D object to be subtracted from the current Vector3D object. -
 
output:Vector3D — An optional Vector3D object to be used as the output value, avoiding the creation of a new object -
-

-Returns - - - - -
Vector3D — - A new Vector3D object that is the difference between the current Vector3D - and the specified Vector3D object. - - -
-

-See also -

-
-decrementBy() -
-
- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a string representation of the current Vector3D object. The string - contains the values of the x, y, and z properties. -

-Returns - - - - -
String — - A string containing the values of the x, y, and - z properties. - - -
-
- -
Constant detail
- - - - - -
X_AXISconstant
-
-public static const X_AXIS:Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The x axis defined as a Vector3D object with coordinates (1,0,0). -

- - - - - -
Y_AXISconstant 
-
-public static const Y_AXIS:Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The y axis defined as a Vector3D object with coordinates (0,1,0). -

- - - - - -
Z_AXISconstant 
-
-public static const Z_AXIS:Vector3D -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The z axis defined as a Vector3D object with coordinates (0,0,1). -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/geom/package-detail.html b/html-docs/flash/geom/package-detail.html deleted file mode 100644 index 022c394..0000000 --- a/html-docs/flash/geom/package-detail.html +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - -flash.geom Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.geom package contains geometry classes, such as points, rectangles and transformation matrixes, to support the BitmapData class and the bitmap caching feature.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 ColorTransform - The ColorTransform class lets you adjust the color values in a display object.
 Matrix - The Matrix class represents a transformation matrix that determines how to map points from one - coordinate space to another.
 Matrix3D - The Matrix3D class represents a transformation matrix that determines the position and orientation of - a three-dimensional (3D) display object.
 Orientation3D -The Orientation3D class is an enumeration of constant values for representing the orientation style -of a Matrix3D object.
 PerspectiveProjection - The PerspectiveProjection class provides an easy way to assign or modify the perspective - transformations of a display object and all of its children.
 Point - The Point object represents a location in a two-dimensional coordinate system, where x - represents the horizontal axis and y represents the vertical axis.
 Rectangle - A Rectangle object is an area defined by its position, as - indicated by its top-left corner point (x, y) and by its width - and its height.
 Transform - The Transform class provides access to color adjustment properties and two- or three-dimensional - transformation objects that can be applied to a display object.
 Utils3D - The Utils3D class contains static methods that simplify the implementation of certain three-dimensional - matrix operations.
 Vector3D - The Vector3D class represents a point or a location in the three-dimensional space using the - Cartesian coordinates x, y, and z.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/globalization/Collator.html b/html-docs/flash/globalization/Collator.html deleted file mode 100644 index 389634a..0000000 --- a/html-docs/flash/globalization/Collator.html +++ /dev/null @@ -1,1399 +0,0 @@ - - - - - - - - -flash.globalization.Collator (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class Collator
InheritanceCollator Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The Collator class provides locale-sensitive string comparison capabilities. - -

This class uses the string comparison services provided by the operating system. - The comparisons differ according to the locale identifier that is provided when the class instance is created. - ActionScript stores strings using the Unicode character set. The Boolean string comparison - operators (==, !=, <, <=, >, >=) use Unicode code points for comparison. In most cases the resulting - sort order doesn't match the conventions of a particular language and region, and thus - should not be used to sort strings that are presented in a user interface. In contrast the comparison methods in this class - provide an order that adheres to these conventions. -

-

Here are some examples where the sort order differs depending on the language: -

-
    -
  • In English, lowercase a is before uppercase A and uppercase A is before lowercase b.
    • -
  • ö is after z in Swedish, whereas in German ö is after o
    • -
  • ch is sorted as one character between c-d in traditional Spanish
    • -
-

- Sort orders can even differ within the same language and region depending on the usage. For example, in German there - is a different sort order used for names in a phone book versus words in a dictionary. In Chinese and Japanese - there are different ways of sorting the ideographic characters: by pronunciation or by the ideographic radical and the - number of strokes uses in the glyph. In Spanish and Georgian, there is a difference between modern and traditional sorting. -

-

- The comparison methods in this class provide two main usage modes. The initialMode - parameter of the Collator() constructor controls these modes. The default "sorting" mode is for sorting items that are displayed to an end user. - In this mode, comparison is more strict to ensure that items that are otherwise the same are sorted in a - consistent manner. For example, uppercase letters and lowercase letters do not compare as equal. - In the "matching" mode the comparison is more lenient. For example in this mode uppercase and - lowercase letters are treated equally. Here's an example that demonstrates both of these modes: -

- 
 
-     var sortingCollator:Collator = new Collator("en-US", CollatorMode.SORTING);
-     var words:Array = new  Array("Airplane" , "airplane", "boat", "Boat");
-     words.sort(sortingCollator.compare);
-     trace(words);
-              
-     var matchingCollator:Collator = new Collator("en-US", CollatorMode.MATCHING);
-     if (matchingCollator.equals("Car", "car")) {
-       trace("The words match!");
-     }
-
-

- Even when providing a locale ID parameter to the constructor as shown above, collation behavior can differ by user - based on the user's operating system settings and whether a fallback locale is used when the - requested locale is not supported. -

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  actualLocaleIDName : String -
[read-only] - The name of the actual locale ID used by this Collator object.
-		Collator
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  ignoreCase : Boolean -
- When this property is set to true, identical strings and strings that differ only in the case of the letters - are evaluated as equal.
-		Collator
  ignoreCharacterWidth : Boolean -
- When this property is true, full-width and half-width forms of some Chinese and Japanese characters are evaluated as equal.
-		Collator
  ignoreDiacritics : Boolean -
- When this property is set to true, strings that use the same base characters but - different accents or other diacritic marks are evaluated as equal.
-		Collator
  ignoreKanaType : Boolean -
- When this property is set to true, strings that differ only by the type of kana character being used are - treated as equal.
-		Collator
  ignoreSymbols : Boolean -
- When this property is set to is true, symbol characters such as spaces, currency symbols, math symbols, - and other types of symbols are ignored when sorting or matching.
-		Collator
  lastOperationStatus : String -
[read-only] - The status of the most recent operation that this Collator object performed.
-		Collator
  numericComparison : Boolean -
- Controls how numeric values embedded in strings are handled during string comparison.
-		Collator
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  requestedLocaleIDName : String -
[read-only] - The name of the requested locale ID that was passed to the constructor of this Collator object.
-		Collator
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Collator(requestedLocaleIDName:String, initialMode:String = "sorting")
-
- Constructs a new Collator object to provide string comparisons according to the conventions of a specified locale.
-		Collator
   -
-compare(string1:String, string2:String):int -
-
- Compares two strings and returns an integer value indicating whether the first string is - less than, equal to, or greater than the second string.
-		Collator
   -
-equals(string1:String, string2:String):Boolean -
-
- Compares two strings and returns a Boolean value indicating whether the strings are equal.
-		Collator
   -
-getAvailableLocaleIDNames():Vector.<String>
-
[static] - Lists all of the locale ID names supported by this class.
-		Collator
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
actualLocaleIDNameproperty
-
-actualLocaleIDName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the actual locale ID used by this Collator object. -

There are three possibilities for the value of the name, depending on operating system and the - value of the requestedLocaleIDName parameter passed to the Collator() constructor.

-
    -
  1. If the requested locale was not LocaleID.DEFAULT and - the operating system provides support for the requested locale, - then the name returned is the same as the requestedLocaleIDName property. -
    2. - -
  2. If LocaleID.DEFAULT was used as the value for the requestedLocaleIDName - parameter to the constructor, then the name of the current locale specified by the user's operating system - is used. The LocaleID.DEFAULT value preserves user's customized setting in the OS. Passing - an explicit value as the requestedLocaleIDName parameter does not necessarily give the - same result as using the LocaleID.DEFAULT even if the two locale ID names are the same. - The user might have customized the locale settings on their machine, and by requesting an - explicit locale ID name rather than using LocaleID.DEFAULT your application would not - retrieve those customized settings. -
    -

    For example:

    - 
    -         var fmt:Collator = new Collator(LocaleID.DEFAULT);
-         var aliName:String = fmt.actualLocaleIDName;
-
    -

    In the above example, aliName is the name of the locale corresponding to - the user's current operating systems settings (e.g. "it-IT" if the user's locale is set to Italian-Italy), - and not "i-default" (the name of the LocaleID.DEFAULT locale).

    -
    3. -
  3. If the system does not support the requestedLocaleIDName specified in the constructor - then a fallback locale ID name is provided. -
    -

    For Example:

    - 
    -         var fmt:Collator = new Collator("fr-CA");         
-         var aliName:String = fmt.actualLocaleIDName;
-
    -

    Assuming that the operating system in the example above does not support the "fr-CA" (French-Canada) locale ID, - a fallback is used. In that case the aliName variable contains the fallback locale ID - "fr-FR" (French-France).

    -
    4. -
- Implementation -
-    public function get actualLocaleIDName():String -
-

-See also -

-
-LocaleID -
-requestedLocaleIDName -
-
- - - - - -
ignoreCaseproperty 
-
-ignoreCase:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- When this property is set to true, identical strings and strings that differ only in the case of the letters - are evaluated as equal. - For example, compare("ABC", "abc") returns true when the - ignoreCase property is set to true. -

- The case conversion of the string follows the rules for the specified locale. -

- When the ignoreCase property is false then upper- and lowercase characters are not equal to one another. -

- When this property is assigned a value and there are no errors or warnings, - the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

- Otherwise, the lastOperationStatus property is set to one of the constants - defined in the LastOperationStatus class.

-

The default value is true when the Collator() constructor's initialMode parameter - is set to Collator.MATCHING. - The default value is false when the Collator() constructor's initialMode parameter - is set to Collator.SORTING.

- Implementation -
-    public function get ignoreCase():Boolean -
-    public function set ignoreCase(value:Boolean):void -
-

-See also -

-
-lastOperationStatus -
-compare() -
-equals() -
-LastOperationStatus -
-
- - - - - -
ignoreCharacterWidthproperty 
-
-ignoreCharacterWidth:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- When this property is true, full-width and half-width forms of some Chinese and Japanese characters are evaluated as equal. - -

For compatibility with existing standards for Chinese and Japanese character sets, Unicode provides character codes - for both full-width and half width-forms of some characters. - For example, when the ignoreCharacterWidth property is set to true, - compare("Ａｱ", "Aア") returns true.

-

- If the ignoreCharacterWidth property is set to false, then full-width and half-width forms - are not equal to one another. -

-

When this property is assigned a value and there are no errors or warnings, - the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

- Otherwise the lastOperationStatus property is set to one of the constants - defined in the LastOperationStatus class.

-

The default value is false.

-Implementation -
-    public function get ignoreCharacterWidth():Boolean -
-    public function set ignoreCharacterWidth(value:Boolean):void -
-

-See also -

-
-lastOperationStatus -
-compare() -
-equals() -
-LastOperationStatus -
-
- - - - - -
ignoreDiacriticsproperty 
-
-ignoreDiacritics:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- When this property is set to true, strings that use the same base characters but - different accents or other diacritic marks are evaluated as equal. - For example compare("coté", "côte") returns true when the - ignoreDiacritics property is set to true. - -

When the ignoreDiacritics is set to false then base characters with - diacritic marks or accents are not considered equal to one another.

-

When this property is assigned a value and there are no errors or warnings, - the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants - defined in the LastOperationStatus class.

-

The default value is false.

-Implementation -
-    public function get ignoreDiacritics():Boolean -
-    public function set ignoreDiacritics(value:Boolean):void -
-

-See also -

-
-lastOperationStatus -
-compare() -
-equals() -
-LastOperationStatus -
-
- - - - - -
ignoreKanaTypeproperty 
-
-ignoreKanaType:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- When this property is set to true, strings that differ only by the type of kana character being used are - treated as equal. - For example, compare("カナ", "かな") returns true when the - ignoreKanaType property is set to true. -

- If the ignoreKanaType is set to false then hiragana and katakana characters that refer to the same - syllable are not equal to one another. -

-

When this property is assigned a value and there are no errors or warnings, - the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants - defined in the LastOperationStatus class.

-

The default value is false.

-Implementation -
-    public function get ignoreKanaType():Boolean -
-    public function set ignoreKanaType(value:Boolean):void -
-

-See also -

-
-lastOperationStatus -
-compare() -
-equals() -
-LastOperationStatus -
-
- - - - - -
ignoreSymbolsproperty 
-
-ignoreSymbols:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- When this property is set to is true, symbol characters such as spaces, currency symbols, math symbols, - and other types of symbols are ignored when sorting or matching. - For example the strings "OBrian", "O'Brian", and "O Brian" would all be treated as equal when the - ignoreSymbols property is set to true. -

- If the ignoreSymbols property is false then symbol characters are considered in string comparisons. -

-

When this property is assigned a value and there are no errors or warnings, - the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

- Otherwise the lastOperationStatus property is set to one of the constants - defined in the LastOperationStatus class.

-

The default value is false.

-Implementation -
-    public function get ignoreSymbols():Boolean -
-    public function set ignoreSymbols(value:Boolean):void -
-

-See also -

-
-lastOperationStatus -
-compare() -
-equals() -
-LastOperationStatus -
-
- - - - - -
lastOperationStatusproperty 
-
-lastOperationStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The status of the most recent operation that this Collator object performed. - The lastOperationStatus is set whenever the constructor or a method of - this class is called, or when a property is set. For the possible values see the description under each method. -

Implementation -
-    public function get lastOperationStatus():String -
-

-See also -

-
-LastOperationStatus -
-
- - - - - -
numericComparisonproperty 
-
-numericComparison:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Controls how numeric values embedded in strings are handled during string comparison. - -

When the numericComparison property is set to true, the compare method - converts numbers that appear in strings to numerical values for comparison.

- -

When this property is set to false, the comparison treats numbers as character codes and - sort them according to the rules for sorting characters in the specified locale.

-

For example, when this property is true for the locale ID "en-US", then the strings - "version1", "version10", and "version2" - are sorted into the following order: version1 < version2 < version10.

-

When this property is false for "en-US", those same strings - are sorted into the following order: version1 < version10 < version2.

-

When this property is assigned a value and there are no errors or warnings, - the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

- Otherwise the lastOperationStatus property is set to one of the constants - defined in the LastOperationStatus class.

- -

The default value is false.

-Implementation -
-    public function get numericComparison():Boolean -
-    public function set numericComparison(value:Boolean):void -
-

-See also -

-
-lastOperationStatus -
-compare() -
-equals() -
-LastOperationStatus -
-
- - - - - -
requestedLocaleIDNameproperty 
-
-requestedLocaleIDName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the requested locale ID that was passed to the constructor of this Collator object. - -

If the LocaleID.DEFAULT value was used then the name returned is "i-default". - The actual locale used can differ from the requested locale when a fallback locale is applied. - The name of the actual locale can be retrieved using the actualLocaleIDName property. -

- Implementation -
-    public function get requestedLocaleIDName():String -
-

-See also -

-
-LocaleID -
-actualLocaleIDName -
-
- -
Constructor detail
- - - - - -
Collator()constructor
-
-public function Collator(requestedLocaleIDName:String, initialMode:String = "sorting") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs a new Collator object to provide string comparisons according to the conventions of a specified locale. -

- If the current operating system does not support the locale ID that is passed in the requestedLocaleIDName - parameter, then a fallback locale is determined. - If a fallback is used then the lastOperationStatus property is set to indicate the type of fallback. -

-

- The initialMode parameter sets various collation options for general uses. - It can be set to one of the following values: -

-
    -
  • CollatorMode.SORTING: sets collation options for general linguistic sorting usages such as - sorting a list of text strings that are displayed to an end user. - In this mode, differences in uppercase and lowercase letters, accented characters, and other differences - specific to the locale are considered when doing string comparisons.
    • -
  • CollatorMode.MATCHING: sets collation options for general usages such as - determining if two strings are equivalent. In this mode, differences in uppercase and lower - case letters, accented characters, and so on are ignored when doing string comparisons.
    • -
-

- Here is an example of a sorted list created using a Collator with the locale ID "en-US" (English in US) - and the CollatorMode.SORTING option: -

- - - - - - - - - - - - - - - - - - - - -
A
a
Ä
ä
Ａ
ａ
AE
ae
Æ
æ
B
b
Ｂ
ｂ
C
c
ç
Ｃ
ｃ
-

- As shown above, all characters are treated as if they have different values, but in linguistic order. -

- Here is an example of a sorted list created using Collator with the locale ID "en-US" (English in US) and the CollatorMode.MATCHING option: -

- - - - - -
A a Ä ä Ａ ａ
AE ae Æ æ
B b Ｂ ｂ
C c ç Ｃ ｃ
-

Legend: Characters in a same row are treated as equivalent characters during comparison/sorting. For example, "a" (U+0040 = LATIN SMALL LETTER A) and "Ä" (U+00C4 = LATIN CAPITAL LETTER A WITH DIAERESIS) are considered to be equal. -

- As shown above, some characters are in linguistic order and are treated as if they have the same character value. -

- For finer control over sorting order, you can change collator properties such as - Collator.ignoreCase or Collator.ignoreDiacritics. -

- For reference, here is a corresponding sorting example done using the standard Array.sort(), - which is not locale-aware: -

- - - - - - - - - - - - - - - - - - -
A
AE
B
C
a
ae
b
c
Ä
Æ
ä
æ
ç
Ａ
Ｂ
ａ
ｂ
-

- As you can see above, all characters are sorted simply in Unicode numeric value order. - It does not make much sense linguistically. -

- To use the user's current operating system preferences, pass the static value LocaleID.DEFAULT - in the requestedLocaleIDName parameter to the constructor. -

- Some locales have several sort order variants. For example, in German - one sort order is used for phone books and another sort order is used for dictionaries. - In Chinese, words are commonly supported by transliteration of the characters - into the pinyin. These different sort orders can be selected by including the "collation" keyword - in the string that is passed in the requestedLocaleIDName parameter to the constructor. -

- - 
-         var germanPhonebook:LocaleID = new LocaleID("de-DE@collation=phonebook");
-         var chinesePinyin:LocaleID = new LocaleID("zh-Hant@collation=pinyin");
-
- -

- Possible values for the collation string are as follows, with the affected - languages shown in parentheses: -

- - - - - - - - - - - - - - - - - - - - -
Collation stringDescription
standardThe default ordering for each language.
phonebookFor a phonebook-style ordering (used in German).
pinyinPinyin ordering for Latin and for CJK characters; that is, an ordering for - CJK characters based on a character-by-character transliteration into a pinyin. (used in Chinese)
traditionalFor a traditional-style sort (used in Spanish)
strokePinyin ordering for Latin, stroke order for CJK characters (used in Chinese)
direct(used in Hindi)
big5hanPinyin ordering for Latin, big5 character set ordering for CJK characters. (used in Chinese)
gb2312han Pinyin ordering for Latin, gb2312han character set ordering for CJK characters. - (used in Chinese)
unihanPinyin ordering for Latin, Unihan radical-stroke ordering for CJK characters. (used in Chinese)
-

- If the host platform does not support the requested collation type, then a fallback is used - and the lastOperationStatus property is set to indicate that a fallback was selected. - You can use the actualLocaleIDName property to determine the value that was used as a fallback, - as shown in the following example: -

- 
-         var collator:Collator = new Collator("fr-FR");
-         if (collator.lastOperationStatus == LastOperationStatus.USING_FALLBACK_WARNING)
-         {
-           trace ("Using fallback locale: " + collator.actualLocaleIDName);
-         }
-
- -

When the constructor completes successfully, then - the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

When the requested locale ID is not available, then the lastOperationStatus property is set to one of the following:

-
    -
  • LastOperationStatus.USING_FALLBACK_WARNING
    • -
  • LastOperationStatus.USING_DEFAULT_WARNING
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

-

For details on the warnings listed above and other possible values of lastOperationStatus, see - the descriptions in the LastOperationStatus class.

- - Parameters - - - - - - - - - - -
requestedLocaleIDName:String — String to be used by this Collator object. -
 
initialMode:String (default = "sorting") — A string value to specify the initial collation mode. The default value is - CollatorMode.SORTING. See the CollatorMode class - for a list of available modes. - -
-
-Throws - - - - - - - - - - -
TypeError — when the requestedLocaleIDName parameter is null. -
 
ArgumentError — when the requestedLocaleIDName parameter contains an invalid value. -
-

-See also -

-
-CollatorMode -
-LastOperationStatus -
-LocaleID -
-lastOperationStatus -
-requestedLocaleIDName -
-actualLocaleIDName -
-
- -
Method detail
- - - - - -
compare()method
-
-public function compare(string1:String, string2:String):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Compares two strings and returns an integer value indicating whether the first string is - less than, equal to, or greater than the second string. The comparison - uses the sort order rules for the locale ID that was specified in the Collator() constructor. -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants - defined in the LastOperationStatus class.

- Parameters - - - - - - - - - - -
string1:String — First comparison string. -
 
string2:String — Second comparison string. -
-

-Returns - - - - -
int — - An integer value indicating whether the first string is - less than, equal to, or greater than the second string. -
    -
  • If the return value is negative, string1 is less than string2.
    • -
  • If the return value is zero, string1 is equal to string2.
    • -
  • If the return value is positive, string1 is larger than string2.
    • -
- - - -
-
-Throws - - - - - - - - - - -
TypeError — when a required parameter is null. -
 
ArgumentError — when a parameter contains an invalid value. - -
-

-See also -

-
-equals() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
equals()method 
-
-public function equals(string1:String, string2:String):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Compares two strings and returns a Boolean value indicating whether the strings are equal. - The comparison uses the sort order rules for the locale ID that was specified in the Collator() constructor. - -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants - defined in the LastOperationStatus class.

- - Parameters - - - - - - - - - - -
string1:String — First comparison string. -
 
string2:String — Second comparison string. -
-

-Returns - - - - -
Boolean — - A Boolean value indicating whether the strings are equal (true) or unequal (false). - - -
-
-Throws - - - - - - - - - - -
TypeError — when a required parameter is null. -
 
ArgumentError — when a parameter contains an invalid value. -
-

-See also -

-
-compare() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getAvailableLocaleIDNames()method 
-
-public static function getAvailableLocaleIDNames():Vector.<String> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Lists all of the locale ID names supported by this class. - -

If this class is not supported at all on the current operating system, this method returns a null value.

- -

-Returns - - - - -
Vector.<String> — A vector of strings containing all of the locale ID names supported by this class. - -
-
- -
Examples
-
examples\CollatorExample1
-
The following example shows sorting results that differ based on the locale. - - The example takes the following steps: -
    -
  1. Iterates through an array of locale ID names, including the default locale ID for the operating system - (as specified by LocaleID.DEFAULT)
    2. -
  2. Creates a Collator object for each locale ID name using "sorting" mode (the default).
    3. -
  3. Displays the requested and actual locale ID names and the value of the lastOperationStatus property - so you can see if a fallback locale was used.
    4. -
  4. Sorts a data array using each collator and displays the results. The resulting order is different for each locale.
    5. -
-
-
-
-package {
-    import flash.globalization.Collator;
-    import flash.globalization.LocaleID;
-
-    public class CollatorExample1
-    {
-        public var col:Collator;
-        
-        public function CollatorExample1():void
-        {        
-            var localeNames:Array = [LocaleID.DEFAULT,
-                                     "de-DE", "sv-SE",
-                                     "fr-FR", "lt-LT",
-                                     "es-ES"];
-            
-            var testSortData:Array = [
-                "y ", "i ", "k ", // Latvian
-                "acxa ", "acha ", "adxa ", // es_traditional
-                "n ", "ö ", "o ", "z ", "vu ", "wo ", // sw
-                "däd ", "daed ", // de
-                "öf ", "of ", // de_dictionary
-                "côte ", "coté " // fr
-            ];
-            
-            for each (var localeName:String in localeNames) {
-            
-                col = new Collator(localeName);
-                
-                trace("LocaleID requested: " + col.requestedLocaleIDName 
-                       + "; actual: " + col.actualLocaleIDName);
-                       
-                trace("Last Operation Status: " + col.lastOperationStatus );
-                
-                var result:Array = testSortData.sort(col.compare);
-                        
-                trace ("sorted data: " + result); 
-            }
-        }      
-    }
-}
-
-
-
examples\CollatorExample2
-
The following examples shows uses a Collator object to control the behavior of string comparisons. - - The example takes the following steps: -
    -
  1. Creates a Collator object for the user's default locale using "matching" mode.
    2. -
  2. Alternately sets the Collator.ignoreDiacritics property to false and true
    3. -
  3. Compares sets of strings that contain diacritics and upper case and lower case characters.
    4. -
  4. Shows how the comparisons change when the - Collator.ignoreDiacritics and Collator.ignoreCase properties change.
    5. -
-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.globalization.Collator;
-    import flash.globalization.CollatorMode;
-    import flash.globalization.LocaleID;
-    
-    public class CollatorExample2 extends Sprite
-    {
-        public var col:Collator;
-        public var testMatchData:Array = ["cote", "Cote", "côte", "coté"];
-        public var wordToMatch:String = "Cote";
-        
-        public function CollatorExample2()
-        {
-            col = new Collator( LocaleID.DEFAULT, CollatorMode.MATCHING );
-
-            trace("LocaleID requested: " + col.requestedLocaleIDName 
-                    + "; actual: " + col.actualLocaleIDName);
-                    
-            trace("Last Operation Status: " + col.lastOperationStatus );
-
-            trace('\n' + "ignoreCase = " + col.ignoreCase);
-            trace("ignoreDiacritics = " + col.ignoreDiacritics);
-
-            compareString(testMatchData, wordToMatch) // All variations of the word cote match
-
-            col.ignoreDiacritics = false;
-            trace('\n' + "ignoreDiacritics = false");
-
-            compareString(testMatchData, wordToMatch) // Variations with different diacritics will not match
-
-            col.ignoreCase = false;
-            trace('\n' + "ignoreCase = false");
-
-            compareString(testMatchData, wordToMatch) // Variations with different case will not match
-        }
-    
-        private function compareString(stringArray:Array, keyword:String):void
-        {
-            for each(var s:String in stringArray)
-            {
-                if(col.equals(s, keyword))    
-                {
-                    trace(keyword + " = " + s);
-                }
-            }
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/CollatorMode.html b/html-docs/flash/globalization/CollatorMode.html deleted file mode 100644 index bbdd9b7..0000000 --- a/html-docs/flash/globalization/CollatorMode.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - -flash.globalization.CollatorMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class CollatorMode
InheritanceCollatorMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The CollatorMode class enumerates constant values that govern the behavior of string comparisons - performed by a Collator object. - These constants represent the values that can be passed in the initialMode parameter - of the Collator() constructor. -

-

-See also -

-
-Collator -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  MATCHING : String = "matching"
[static] - Initializes a Collator object so that the compare method is optimized for - determining whether two strings are equivalent.
-		CollatorMode
  SORTING : String = "sorting"
[static] - Initializes a Collator object so that the compare method is optimized for - sorting a list of text strings to be displayed to an end user.
-		CollatorMode
-
- -
- -
Constant detail
- - - - - -
MATCHINGconstant
-
-public static const MATCHING:String = "matching" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Initializes a Collator object so that the compare method is optimized for - determining whether two strings are equivalent. - In this mode, string comparisons ignore differences in uppercase and lower - case letters, accented characters, etc. -

-See also -

-
-Collator() constructor -
-
- - - - - -
SORTINGconstant 
-
-public static const SORTING:String = "sorting" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Initializes a Collator object so that the compare method is optimized for - sorting a list of text strings to be displayed to an end user. - In this mode, string comparisons consider - differences in uppercase and lowercase letters, accented characters, and so on, - according to the language and sorting rules required by the locale. -

-See also -

-
-Collator() constructor -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/CurrencyFormatter.html b/html-docs/flash/globalization/CurrencyFormatter.html deleted file mode 100644 index 959c94a..0000000 --- a/html-docs/flash/globalization/CurrencyFormatter.html +++ /dev/null @@ -1,2078 +0,0 @@ - - - - - - - - -flash.globalization.CurrencyFormatter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class CurrencyFormatter
InheritanceCurrencyFormatter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The CurrencyFormatter class provides locale-sensitive formatting and parsing of currency values. -

The CurrencyFormatter class uses the data and functionality provided by the operating system - and is designed to format currency values according to the conventions - of a specific locale and type of currency. The position of the currency symbol, - the negative symbol, the decimal separator, the grouping separator, the grouping pattern - decimal separator, and other elements can vary depending on the locale.

-

If the operating system supports the requested locale, the properties and - currency type are set according to the conventions and defaults of the requested locale. - If the requested locale is not available, then the properties are set according to - a fallback or default system locale, which can be retrieved using the actualLocaleIDName property. -

-

- Due to the use of the user's settings, the use of formatting patterns - provided by the operating system, and the use of a fallback locale when a requested locale is not supported, - different users can see different formatting results, even when using the same locale ID. -

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  actualLocaleIDName : String -
[read-only] - The name of the actual locale ID used by this CurrencyFormatter object.
-		CurrencyFormatter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currencyISOCode : String -
[read-only] - The three letter ISO 4217 currency code for the actual locale being used.
-		CurrencyFormatter
  currencySymbol : String -
[read-only] - The currency symbol or string for the actual locale being used.
-		CurrencyFormatter
  decimalSeparator : String -
- The decimal separator character used for formatting or parsing currency amounts that have a decimal part.
-		CurrencyFormatter
  digitsType : uint -
- Defines the set of digit characters used when formatting currency amounts.
-		CurrencyFormatter
  fractionalDigits : int -
- The maximum number of digits that can appear after the decimal separator.
-		CurrencyFormatter
  groupingPattern : String -
- Describes the placement of grouping separators within the formatted currency amount string.
-		CurrencyFormatter
  groupingSeparator : String -
- The character or string used for the grouping separator.
-		CurrencyFormatter
  lastOperationStatus : String -
[read-only] - The status of the most recent operation that this CurrencyFormatter object performed.
-		CurrencyFormatter
  leadingZero : Boolean -
- Specifies whether a leading zero is included in a formatted currency amount when there are no integer digits - to the left of the decimal separator.
-		CurrencyFormatter
  negativeCurrencyFormat : uint -
- A numeric value that indicates a formatting pattern for negative currency amounts.
-		CurrencyFormatter
  negativeSymbol : String -
- The negative symbol used when formatting negative currency amounts.
-		CurrencyFormatter
  positiveCurrencyFormat : uint -
- A numeric value that indicates a formatting pattern for positive currency amounts.
-		CurrencyFormatter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  requestedLocaleIDName : String -
[read-only] - The name of the requested locale ID that was passed to the constructor of this CurrencyFormatter object.
-		CurrencyFormatter
  trailingZeros : Boolean -
- Specifies whether trailing zeros are included in the formatted currency amount.
-		CurrencyFormatter
  useGrouping : Boolean -
- Enables the use of the grouping separator when formatting currency amounts.
-		CurrencyFormatter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-CurrencyFormatter(requestedLocaleIDName:String)
-
- Constructs a new CurrencyFormatter object to format numbers representing currency amounts according to - the conventions of a given locale.
-		CurrencyFormatter
   -
-format(value:Number, withCurrencySymbol:Boolean = false):String -
-
- Creates a string representing a currency amount formatted according to the current properties of this CurrencyFormatter object, - including the locale, currency symbol, and currency ISO code.
-		CurrencyFormatter
   -
-formattingWithCurrencySymbolIsSafe(requestedISOCode:String):Boolean -
-
- Determines whether the currently specified currency symbol can be used when formatting currency amounts.
-		CurrencyFormatter
   -
-getAvailableLocaleIDNames():Vector.<String>
-
[static] - Lists all of the locale ID names supported by this class.
-		CurrencyFormatter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-parse(inputString:String):CurrencyParseResult -
-
- Parses a string into a currency amount and a currency symbol.
-		CurrencyFormatter
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-setCurrency(currencyISOCode:String, currencySymbol:String):void -
-
- Sets the currencyISOCode and currencySymbol properties of the CurrencyFormatter object.
-		CurrencyFormatter
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
actualLocaleIDNameproperty
-
-actualLocaleIDName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the actual locale ID used by this CurrencyFormatter object. -

There are three possibilities for the value of the name, depending on operating system and the - value of the requestedLocaleIDName parameter passed to the CurrencyFormatter() constructor.

-
    -
  1. If the requested locale was not LocaleID.DEFAULT and - the operating system provides support for the requested locale, - then the name returned is the same as the requestedLocaleIDName property. -
    2. - -
  2. If LocaleID.DEFAULT was used as the value for the requestedLocaleIDName - parameter to the constructor, then the name of the current locale specified by the user's operating system - is used. The LocaleID.DEFAULT value preserves user's customized setting in the OS. - Passing an explicit value as the requestedLocaleIDName parameter does not necessarily give the - same result as using the LocaleID.DEFAULT even if the two locale ID names are the same. - The user might have customized the locale settings on their machine, and by requesting an - explicit locale ID name rather than using LocaleID.DEFAULT your application would not - retrieve those customized settings. -
    -

    For example:

    - 
    -         var fmt:CurrencyFormatter = new CurrencyFormatter(LocaleID.DEFAULT);
-		 var aliName:String = fmt.actualLocaleIDName;
-
    -

    In the above example, aliName is the name of the locale corresponding to - the user's current operating systems settings (for example, "it-IT" if the user's locale is set to Italian-Italy), - and not "i-default" (the name of the LocaleID.DEFAULT locale).

    -
    3. -
  3. If the system does not support the requestedLocaleIDName specified in the constructor - then a fallback locale ID name is provided. -
    -

    For Example:

    - 
     	 
-         var fmt:CurrencyFormatter = new CurrencyFormatter("fr-CA"); 	 
-         var aliName:String = fmt.actualLocaleIDName;
-
    -

    Assuming that the operating system in the example above does not support the "fr-CA" (French-Canada) locale ID, - a fallback is used. In this case the fallback locale ID is "fr-FR" (French-France).

    -
    4. -
- Implementation -
-    public function get actualLocaleIDName():String -
-

-See also -

-
-LocaleID -
-requestedLocaleIDName -
-CurrencyFormatter() -
-
- - - - - -
currencyISOCodeproperty 
-
-currencyISOCode:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The three letter ISO 4217 currency code for the actual locale being used. - -

This code is used to determine the currency symbol or string when formatting currency amounts - using the format() method with the withCurrencySymbol parameter set to false.

- -

This property is initialized by the constructor based on the actual locale that is used. When a fallback - locale is used this property reflects the preferred, default currency code for the fallback locale.

- -

The default value is dependent on the actual locale and operating system.

-Implementation -
-    public function get currencyISOCode():String -
-

-See also -

-
-format() -
-setCurrency() -
-currencySymbol -
-
- - - - - -
currencySymbolproperty 
-
-currencySymbol:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The currency symbol or string for the actual locale being used. -

This property is used as the currency symbol when formatting currency amounts - using the format() method with the withCurrencySymbol parameter set to true.

-

This property is initialized by the constructor based on the actual locale that is used. When a fallback - locale is used this property reflects the preferred, default currency symbol for the fallback locale.

- -

The default value is dependent on the actual locale and operating system.

-Implementation -
-    public function get currencySymbol():String -
-

-See also -

-
-format() -
-setCurrency() -
-formattingWithCurrencySymbolIsSafe() -
-currencyISOCode -
-
- - - - - -
decimalSeparatorproperty 
-
-decimalSeparator:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The decimal separator character used for formatting or parsing currency amounts that have a decimal part. -

This property is initially set based on the locale that is selected when the formatter object - is constructed.

-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the actual locale and operating system.

-Implementation -
-    public function get decimalSeparator():String -
-    public function set decimalSeparator(value:String):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-format() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
digitsTypeproperty 
-
-digitsType:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the set of digit characters used when formatting currency amounts. -

Different languages and regions use different sets of characters to represent the - digits 0 through 9. This property defines the set of digits to be used.

-

The value of this property represents the Unicode value for the zero digit of a decimal digit set. - The valid values for this property are defined in the NationalDigitsType class.

- -

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the actual locale and operating system.

-Implementation -
-    public function get digitsType():uint -
-    public function set digitsType(value:uint):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-NationalDigitsType -
-
- - - - - -
fractionalDigitsproperty 
-
-fractionalDigits:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The maximum number of digits that can appear after the decimal separator. - -

Numbers are rounded to the number of digits specified by this property. The rounding scheme - varies depending on the user's operating system.

- -

When the trailingZeros property is set to true, the fractional portion of the - number (after the decimal point) is padded with trailing zeros until its length matches the value of this - fractionalDigits property.

-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- -

The default value is 0.

-Implementation -
-    public function get fractionalDigits():int -
-    public function set fractionalDigits(value:int):void -
-

-See also -

-
-trailingZeros -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
groupingPatternproperty 
-
-groupingPattern:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Describes the placement of grouping separators within the formatted currency amount string. -

When the useGrouping property is set to true, the groupingPattern property is used - to define the placement and pattern used for the grouping separator.

-

The grouping pattern is defined as a string containing numbers separated by semicolons and optionally may end - with an asterisk. For example: "3;2;*". Each number in the string represents the number of digits - in a group. The grouping separator is placed before each group of digits. An asterisk at the end of the string - indicates that groups with that number of digits should be repeated for the rest of the formatted string. - If there is no asterisk then there are no additional groups or separators for the rest of the formatted string.

- -

The first number in the string corresponds to the first group of digits to the left of the decimal separator. - Subsequent numbers define the number of digits in subsequent groups to the left. Thus the string "3;2;*" - indicates that a grouping separator is placed after the first group of 3 digits, followed by groups of 2 digits. - For example: 98,76,54,321

- -

The following table shows examples of formatting the currency amount 123456789.12 with various grouping patterns. - The grouping separator is a comma, the decimal separator is a period, and a dollar sign ($) is the currency symbol. -

- - - - - - - - - - - - - - - - - -
Grouping PatternSample Format
3;* $123,456,789.12
3;2;*$12,34,56,789.12
3$123456,789.12
- -

Only a limited number of grouping sizes can be defined. On some operating systems, grouping patterns can only contain - two numbers plus an asterisk. Other operating systems can support up to four numbers and an asterisk. - For patterns without an asterisk, some operating systems only support one number while others support up to three numbers. - If the maximum number of grouping pattern elements is exceeded, then additional elements - are ignored, and the lastOperationStatus property is set as described below. -

-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Implementation -
-    public function get groupingPattern():String -
-    public function set groupingPattern(value:String):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. - -
-

-See also -

-
-groupingSeparator -
-useGrouping -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
groupingSeparatorproperty 
-
-groupingSeparator:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The character or string used for the grouping separator. -

The value of this property is used as the grouping separator when formatting currency amounts when the - useGrouping property is set to true. This - property is initially set based on the locale that is selected when the formatter object - is constructed.

-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the actual locale and operating system.

-Implementation -
-    public function get groupingSeparator():String -
-    public function set groupingSeparator(value:String):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-format() -
-useGrouping -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
lastOperationStatusproperty 
-
-lastOperationStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The status of the most recent operation that this CurrencyFormatter object performed. - The lastOperationStatus property is set whenever the constructor or a method of - this class is called or another property is set. For the possible values see the description for each method. -

Implementation -
-    public function get lastOperationStatus():String -
-

-See also -

-
-LastOperationStatus -
-
- - - - - -
leadingZeroproperty 
-
-leadingZero:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether a leading zero is included in a formatted currency amount when there are no integer digits - to the left of the decimal separator. - -

When this property is set to true a leading zero is included to the left of the decimal separator - when formatting numeric values between -1.0 and 1.0. - When this property is set to false a leading zero is not included.

-

For example if the currency amount is 0.321 and this property is set true, then the leading - zero is included in the formatted string. If the property is set to false, the leading zero - is not included. In that case the string would just include the decimal separator followed by the decimal digits, - like $.321.

- -

The following table shows examples of how currency amounts are formatted based on the values of this property and - the related fractionalDigits and trailingZeros properties. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
trailingZerosleadingZerofractionalDigits0.120
truetrue3$0.120$0.000
falsetrue3$0.12$0
truefalse3$.120$.000
falsefalse3$.12$0
-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the actual locale and operating system.

-Implementation -
-    public function get leadingZero():Boolean -
-    public function set leadingZero(value:Boolean):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-format() -
-lastOperationStatus -
-LastOperationStatus -
-trailingZeros -
-
- - - - - -
negativeCurrencyFormatproperty 
-
-negativeCurrencyFormat:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A numeric value that indicates a formatting pattern for negative currency amounts. - This pattern defines the location of the currency symbol and the negative symbol - or parentheses in relation to the numeric portion of the currency amount. -

The value of this property must be one of the constants defined in the table below. -

- -

The table below summarizes the possible formatting patterns for negative currency amounts. - When a currency amount is formatted with the format() method:

-
    -
  • The '¤' symbol is replaced with the value of the currencyISOCode or - the currencySymbol property, depending on the value of the withCurrencySymbol parameter - passed to the format() method;
    • -
  • The '-' character is replaced with the value of the negativeNumberSymbol property;
    • -
  • The 'n' character is replaced with the currency amount value that is passed to the format() method.
    • -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Negative currency format typeFormatting pattern
0(¤n)
1-¤n
2¤-n
3¤n-
4(n¤)
5-n¤
6n-¤
7n¤-
8-n ¤
9-¤ n
10n ¤-
11¤ n-
12¤ -n
13n- ¤
14(¤ n)
15(n ¤)
-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the actual locale and operating system.

-Implementation -
-    public function get negativeCurrencyFormat():uint -
-    public function set negativeCurrencyFormat(value:uint):void -
-
-Throws -
- - - - -
ArgumentError — if the assigned value is not between 0 and 15. -
-

-See also -

-
-format() -
-currencySymbol -
-negativeSymbol -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
negativeSymbolproperty 
-
-negativeSymbol:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The negative symbol used when formatting negative currency amounts. -

This symbol is used with the negative currency - format when formatting a currency amount that is less than zero. It is not used in negative currency formats that do not include - a negative sign (for example, when negative currency amounts are enclosed in parentheses).

-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the actual locale and operating system.

-Implementation -
-    public function get negativeSymbol():String -
-    public function set negativeSymbol(value:String):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-format() -
-negativeCurrencyFormat -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
positiveCurrencyFormatproperty 
-
-positiveCurrencyFormat:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A numeric value that indicates a formatting pattern for positive currency amounts. - This format defines the location of currency symbol - relative to the numeric portion of the currency amount. -

The value of this property must be one of the constants defined in the table below. -

- -

The table below summarizes the possible formatting patterns for positive currency amounts. - When a currency amount is formatted with the format() method:

-
    -
  • The '¤' symbol is replaced with the value of the currencyISOCode or - the currencySymbol property, depending on the value of the withCurrencySymbol parameter - passed to the format() method;
    • -
  • The 'n' character is replaced with the currency amount value that is passed to the format() method.
    • -
- - - - - - - - - - - - - - - - - - - - - -
Positive currency format typeFormatting pattern
0¤n
1n¤
2¤ n
3n ¤
- -

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the actual locale and operating system.

-Implementation -
-    public function get positiveCurrencyFormat():uint -
-    public function set positiveCurrencyFormat(value:uint):void -
-
-Throws -
- - - - -
ArgumentError — if the assigned value is not between 0 and 3. -
-

-See also -

-
-currencySymbol -
-format() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
requestedLocaleIDNameproperty 
-
-requestedLocaleIDName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the requested locale ID that was passed to the constructor of this CurrencyFormatter object. - -

If the LocaleID.DEFAULT value was used then the name returned is "i-default". - The actual locale used can differ from the requested locale when a fallback locale is applied. - The name of the actual locale can be retrieved using the actualLocaleIDName property. -

- Implementation -
-    public function get requestedLocaleIDName():String -
-

-See also -

-
-LocaleID -
-actualLocaleIDName -
-CurrencyFormatter() -
-
- - - - - -
trailingZerosproperty 
-
-trailingZeros:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether trailing zeros are included in the formatted currency amount. -

When this property is set to true, trailing zeros are included in the fractional part - of the formatted number up the limit specified by the fractionalDigits property. - When this property is set to false then no trailing zeros are shown.

-

For example if the currency amount is 123.4, and this property is set true, and the fractionalDigits property - is set to 3, the formatted string would show trailing zeros, like $123.400 . - If this property is false, trailing zeros are not included, and the string shows just the decimal - separator followed by the non-zero decimal digits, like $123.4 .

-

The following table shows examples of how currency amounts are formatted based on the values of this property and - the related fractionalDigits and leadingZero properties. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
trailingZerosleadingZerofractionalDigits0.120
truetrue3$0.120$0.000
falsetrue3$0.12$0
truefalse3$.120$.000
falsefalse3$.12$0
-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the actual locale and operating system.

-Implementation -
-    public function get trailingZeros():Boolean -
-    public function set trailingZeros(value:Boolean):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-leadingZero -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
useGroupingproperty 
-
-useGrouping:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Enables the use of the grouping separator when formatting currency amounts. -

When the useGrouping property is set to true, digits are grouped and - delimited by the grouping separator character. - For example: $123,456,789

-

When the useGrouping property is set to false, digits are not grouped or separated. - For example: $123456789

- -

The groupingSeparator property defines the symbol to be used as a grouping separator. The - groupingPattern property defines the number of digits between grouping separators.

- -

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Implementation -
-    public function get useGrouping():Boolean -
-    public function set useGrouping(value:Boolean):void -
-

-See also -

-
-groupingPattern -
-groupingSeparator -
-lastOperationStatus -
-LastOperationStatus -
-
- -
Constructor detail
- - - - - -
CurrencyFormatter()constructor
-
-public function CurrencyFormatter(requestedLocaleIDName:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs a new CurrencyFormatter object to format numbers representing currency amounts according to - the conventions of a given locale. -

This constructor determines if the current operating system supports the requested locale ID name. - If it is not supported then a fallback locale is used instead. - If a fallback locale is used then the lastOperationStatus property - indicates the type of fallback, and the actualLocaleIDName property contains - the name of the fallback locale ID.

-

Certain properties such as the currencySymbol and currencyISOCode properties are set - automatically based on the locale.

- -

NOTE: When a fallback locale is used the currency properties are set to default values, - and therefore the currencySymbol or - currencyISOCode properties might be given unexpected values. It is a good idea to examine the - currencySymbol and currencyISOCode property values before formatting a currency amount. -

-

To format based on the user's current operating system preferences, pass the value LocaleID.DEFAULT - in the requestedLocaleIDName parameter to the constructor. -

- -

When the constructor is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

When the requested locale ID name is not available then the lastOperationStatus - is set to one of the following:

-
    -
  • LastOperationStatus.USING_FALLBACK_WARNING
    • -
  • LastOperationStatus.USING_DEFAULT_WARNING
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in - the LastOperationStatus class.

-

For details on the warnings listed above and other possible values of the - lastOperationStatus property, see the descriptions in the LastOperationStatus class.

- - Parameters - - - - -
requestedLocaleIDName:String — The preferred locale ID name to use when determining date or time formats. -
-
-Throws - - - - -
TypeError — if the requestedLocaleIDName parameter is null. - -
-

-See also -

-
-lastOperationStatus -
-requestedLocaleIDName -
-actualLocaleIDName -
-LastOperationStatus -
-LocaleID -
-
- -
Method detail
- - - - - -
format()method
-
-public function format(value:Number, withCurrencySymbol:Boolean = false):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a string representing a currency amount formatted according to the current properties of this CurrencyFormatter object, - including the locale, currency symbol, and currency ISO code. - -

By default this method uses the currencyISOCode property to determine the currency symbol and other - settings used when formatting.

- -

Many countries and regions use the same currency symbols for different currencies. - For example the United States, Australia, New Zealand, Canada, - and Mexico all use the same dollar sign symbol ($) for local currency values. When the formatting currency differs - from the user's local currency it is best to use the ISO code as the currency string. - You can use the formattingWithCurrencySymbolIsSafe() method to test whether the ISO code of the - currency to be formatted matches the currencyISOCode property of the formatter. -

- -

This method can format numbers of very large and very small magnitudes. However the - number of significant digits is limited to the precision provided by the Number data type. -

- - Parameters - - - - - - - - - - -
value:Number — The numeric value to be formatted into a currency string. -
 
withCurrencySymbol:Boolean (default = false) — When set to false the currencyISOCode property determines which - currency string or symbol to use in the output string. When set to true, the current value of the - currencySymbol property is used in the output string. - - -
-

-Returns - - - - -
String — - A string containing the formatted currency value. - - - -
-

-See also -

-
-currencySymbol -
-currencyISOCode -
-formattingWithCurrencySymbolIsSafe() -
-lastOperationStatus -
-LastOperationStatus -
-
-Example -

-
- - - - - -
formattingWithCurrencySymbolIsSafe()method 
-
-public function formattingWithCurrencySymbolIsSafe(requestedISOCode:String):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Determines whether the currently specified currency symbol can be used when formatting currency amounts. - -

Many regions and countries use the same currency symbols. This method can be used to - safeguard against the use of an ambiguous currency symbol, or a currency symbol or ISO code that - is different than expected due to the use of a fallback locale.

-

A common use case for this method is to determine whether to show a local currency symbol (if the amount is formatted in - the user's default currency), or a more specific ISO code string (if the amount is formatted in a currency - different from the user's default).

-

This method compares the requestedISOCode parameter against the current currencyISOCode property, - returning true if the strings are equal and false if they are not. - When the strings are equal, using the format() method with the - withCurrencySymbol parameter set to true results in a formatted currency value string - with a unique currency symbol for the locale. - If this method returns false, then using the format() method with the withCurrencySymbol - parameter set to true could result in the use of an ambiguous or incorrect currency symbol. -

- -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Parameters - - - - -
requestedISOCode:String — A three letter ISO 4217 currency code (for example, USD for US dollars, EUR for Euros). - Must contain three uppercase letters from A to Z. - -
-

-Returns - - - - -
Boolean — - true if the currencyISOCode property matches the requestedISOCode parameter; - otherwise false. - - - -
-
-Throws - - - - -
TypeError — if the requestedISOCode parameter is null. - -
-

-See also -

-
-currencySymbol -
-currencyISOCode -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getAvailableLocaleIDNames()method 
-
-public static function getAvailableLocaleIDNames():Vector.<String> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Lists all of the locale ID names supported by this class. - -

If this class is not supported on the current operating system, this method returns a null value.

-

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

-Returns - - - - -
Vector.<String> — A vector of strings containing all of the locale ID names supported by this class. - -
-
- - - - - -
parse()method 
-
-public function parse(inputString:String):CurrencyParseResult -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Parses a string into a currency amount and a currency symbol. - -

The parsing algorithm uses the value of the decimalSeparator property to determine the integral and fractional - portion of the number. It uses the values of the negativeCurrencyFormat and positiveCurrencyFormat - properties to determine the location of the currency symbol or string relative to the currency amount. - For negative amounts the value of the negativeCurrencyFormat property determines the location of the - negative symbol and whether parentheses are used.

-

If the order of the currency symbol, minus sign, and number in the input string does not match the pattern identified by the - negativeCurrencyFormat and positiveCurrencyFormat properties, then:

-
    -
  1. The value property of the returned CurrencyParseResult object is set to NaN.
    2. -
  2. The currencyString property of the returned CurrencyParseResult object is set to null.
    3. -
  3. The lastOperationStatus property is set to indicate that parsing failed.
    4. -
-

The input string may include space characters, which are ignored during the parsing.

- -

Parsing can succeed even if there is no currency symbol. No validation is done of the portion of the string - corresponding to the currency symbol. If there is no currency symbol or string, the currencyString property in the - returned CurrencyParseResult object is set to an empty string.

- -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Parameters - - - - -
inputString:String — The input string to parse. -
-

-Returns - - - - -
CurrencyParseResult — - A CurrencyParseResult object containing the numeric value and the currency symbol or string. - - -
-
-Throws - - - - -
TypeError — if the inputString parameter is null. -
-

-See also -

-
-decimalSeparator -
-negativeCurrencyFormat -
-positiveCurrencyFormat -
-CurrencyParseResult -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
setCurrency()method 
-
-public function setCurrency(currencyISOCode:String, currencySymbol:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Sets the currencyISOCode and currencySymbol properties of the CurrencyFormatter object. - -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the the currencyISOCode and the currencySymbol properties are not modified and the - lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Parameters - - - - - - - - - - -
currencyISOCode:String — The three letter ISO 4217 currency code (for example, USD for US dollars, EUR for Euros). - Must contain three uppercase letters from A to Z. -
 
currencySymbol:String — The currency symbol or string to be used when formatting currency values. This can be an empty string. - -
-
-Throws - - - - -
TypeError — if the currencyISOCode or currencySymbol parameter is null. -
-

-See also -

-
-currencyISOCode -
-currencySymbol -
-lastOperationStatus -
-LastOperationStatus -
-
- -
Examples
-
examples\CurrencyFormatterExample
-
The following shows how a currency amount is formatted - differently based on different locales and currencies. - - The results from this example will differ based on your operating system and user preferences. -

- This example uses the following locales: -

-
    -
  • The default operating system locale for currency formatting (LocaleID.DEFAULT)
    • -
  • Japanese (Japan)
    • -
  • English (US)
    • -
  • French (France)
    • -
- -

The example does the following for each locale in the list:

-
    -
  1. Creates a CurrencyFormatter object
    2. -
  2. Uses the formattingWithCurrencySymbolIsSafe() method to check whether the default currency for the locale is Euros ("EUR") - and if so it formats the string using the currency symbol. Otherwise it formats the string using the ISO code. -
    3. -
-
-
-  
-package {
-    import flash.display.Sprite;
-    import flash.globalization.CurrencyFormatter;
-    import flash.globalization.LocaleID;
-    
-    public class CurrencyFormatterExample1 extends Sprite
-    {
-        public function CurrencyFormatterExample1():void
-        {
-            var cf:CurrencyFormatter;
-            var amountWithSymbol:String;
-            var amountWithISOCode:String
-            
-            var localeNames:Array = [LocaleID.DEFAULT, "ja-JP", "en-US", "fr-FR"];
-            
-            for each (var localeName:String in localeNames) 
-            {
-                cf = new CurrencyFormatter(localeName);
-                
-                trace('\n' + "LocaleID requested=" + cf.requestedLocaleIDName 
-                    + "; actual=" + cf.actualLocaleIDName);
-                
-                trace("Last Operation Status: " + cf.lastOperationStatus );
-                
-                trace("Currency ISO Code: " + cf.currencyISOCode);
-                
-                if (cf.formattingWithCurrencySymbolIsSafe("EUR")) 
-                {
-                    amountWithSymbol = cf.format(123456789.19, true);
-                    trace("Format using Symbol: "+ amountWithSymbol);
-                }
-                else 
-                {
-                    amountWithISOCode = cf.format(123456789.19); 
-                    trace("Format using ISO Code: " + amountWithISOCode);
-                }
-            }
-        }
-    }
-}
-
-
-
examples\CurrencyFormatterParseExample
-
The following example parses a currency amount using the rules for a given locale. - The results from this example may differ based on your operating system and user preferences. - -

This example takes the following steps:

- -
    -
  1. Creates a CurrencyFormatter object for the English (US) locale.
    2. -
  2. Uses the parse() method to parse the input string.
    3. -
  3. Displays the amount and currency string values from the resulting CurrencyParseResult object.
    4. -
-
-
- 
-package {
-      import flash.display.Sprite;
-      import flash.globalization.CurrencyFormatter;
-      import flash.globalization.CurrencyParseResult;
-      import flash.globalization.LastOperationStatus;
-      import flash.globalization.LocaleID;
-
-      public class CurrencyFormatterParseExample extends Sprite
-      {
-            public function CurrencyFormatterParseExample()
-            {
-    			var cf:CurrencyFormatter = new CurrencyFormatter( "en_US" );
-				
-				trace("LocaleID requested=" + cf.requestedLocaleIDName 
-                    + "; actual=" + cf.actualLocaleIDName);
-                trace("Last Operation Status: " + cf.lastOperationStatus );
-
-				var inputString:String = "Dollar 123,567,89,0.254";
-				
-				var result:CurrencyParseResult = cf.parse(inputString);
-				
-				if (cf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
-	            	trace("Amount value: " + result.value); 
-	            	trace("Currency string: " + result.currencyString); 
-                }
-            }
-      }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/CurrencyParseResult.html b/html-docs/flash/globalization/CurrencyParseResult.html deleted file mode 100644 index 8be553a..0000000 --- a/html-docs/flash/globalization/CurrencyParseResult.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - - -flash.globalization.CurrencyParseResult (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class CurrencyParseResult
InheritanceCurrencyParseResult Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- A data structure that represents a currency amount and currency symbol or string that were extracted by parsing a currency value. - -

-

-See also -

-
-CurrencyFormatter.parse() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currencyString : String -
[read-only] - The portion of the input string that corresponds to the currency symbol or currency string.
-		CurrencyParseResult
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  value : Number -
[read-only] - The currency amount value that was extracted from the input string.
-		CurrencyParseResult
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-CurrencyParseResult(value:Number, symbol:String = "")
-
- Constructs a currency parse result object.
-		CurrencyParseResult
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
currencyStringproperty
-
-currencyString:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The portion of the input string that corresponds to the currency symbol or currency string. -

Implementation -
-    public function get currencyString():String -
-
- - - - - -
valueproperty 
-
-value:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The currency amount value that was extracted from the input string. -

Implementation -
-    public function get value():Number -
-
- -
Constructor detail
- - - - - -
CurrencyParseResult()constructor
-
-public function CurrencyParseResult(value:Number, symbol:String = "") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs a currency parse result object. - -

Parameters - - - - - - - - - - -
value:Number — A number representing the currency amount value. -
 
symbol:String (default = "") — A string representing the currency symbol. - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/DateTimeFormatter.html b/html-docs/flash/globalization/DateTimeFormatter.html deleted file mode 100644 index 6b5bd82..0000000 --- a/html-docs/flash/globalization/DateTimeFormatter.html +++ /dev/null @@ -1,1894 +0,0 @@ - - - - - - - - -flash.globalization.DateTimeFormatter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class DateTimeFormatter
InheritanceDateTimeFormatter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The DateTimeFormatter class provides locale-sensitive formatting for Date objects and access to localized - date field names. The methods of this class use functions and settings provided by the operating system. - -

There are two ways to select a date time format: using a predefined pattern - or a custom pattern. For most applications the predefined styles specified by the - DateTimeStyle constants (LONG, MEDIUM, NONE, or SHORT - should be used. These constants - specify the default patterns for the requested locale or the default patterns based on the - user's operating system settings. -

-

- For example the following code creates a date string using the default short date format: -

- 
 
-	 var df:DateTimeFormatter = new DateTimeFormatter(LocaleID.DEFAULT, DateTimeStyle.SHORT, DateTimeStyle.NONE);
-	 var currentDate:Date = new Date();
-	 var shortDate:String = df.format(currentDate);
-
- -

When an instance of this class is created, if the requested locale is supported by the - operating system then the properties of the instance are set according to the conventions and - defaults of the requested locale and the constructor's dateStyle and timeStyle parameters. - If the requested locale is not available, then the properties are set according to a fallback or - default system locale, which can be retrieved using the actualLocaleIDName property. -

-

- This class contains additional methods to get localized strings for month names and - weekday names, and to retrieve the first day of the week that can be used in a calendar picker - or other similar application. -

-

- Due to the use of the user's settings, the use of formatting patterns - provided by the operating system, and the use of a fallback locale when a requested locale is not supported, - different users can see different formatting results even when using the same locale ID. -

-

-

-View the examples. -

-

-See also -

-
-actualLocaleIDName -
-DateTimeStyle -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  actualLocaleIDName : String -
[read-only] - The name of the actual locale ID used by this DateTimeFormatter object.
-		DateTimeFormatter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  lastOperationStatus : String -
[read-only] - The status of previous operation that this DateTimeFormatter object performed.
-		DateTimeFormatter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  requestedLocaleIDName : String -
[read-only] - The name of the requested locale ID that was passed to the constructor of this DateTimeFormatter object.
-		DateTimeFormatter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DateTimeFormatter(requestedLocaleIDName:String, dateStyle:String = "long", timeStyle:String = "long")
-
- Constructs a new DateTimeFormatter object to format dates and times according to the conventions of the - specified locale and the provided date and time formatting styles.
-		DateTimeFormatter
   -
-format(dateTime:Date):String -
-
- Formats a display string for a Date object that is interpreted as being in the user's local time - (using the local time components of the Date object such as: date, day, fullYear, hours, minutes, month, and seconds).
-		DateTimeFormatter
   -
-formatUTC(dateTime:Date):String -
-
- Formats a display string for a Date object that is interpreted as being in UTC time - (using the UTC components of the Date object such as: dateUTC, dayUTC, fullYearUTC, hoursUTC, minutesUTC, monthUTC, - and secondsUTC), according to the dateStyle, timeStyle or date time pattern.
-		DateTimeFormatter
   -
-getAvailableLocaleIDNames():Vector.<String>
-
[static] - Lists all of the locale ID names supported by this class.
-		DateTimeFormatter
   -
-getDateStyle():String -
-
- Gets the date style for this instance of the DateTimeFormatter.
-		DateTimeFormatter
   -
-getDateTimePattern():String -
-
- Returns the pattern string used by this DateTimeFormatter object to format dates and times.
-		DateTimeFormatter
   -
-getFirstWeekday():int -
-
- Returns an integer corresponding to the first day of the week for this locale and calendar system.
-		DateTimeFormatter
   -
-getMonthNames(nameStyle:String = "full", context:String = "standalone"):Vector.<String>
-
- Retrieves a list of localized strings containing the month names for the current calendar system.
-		DateTimeFormatter
   -
-getTimeStyle():String -
-
- Gets the time style for this instance of the DateTimeFormatter.
-		DateTimeFormatter
   -
-getWeekdayNames(nameStyle:String = "full", context:String = "standalone"):Vector.<String>
-
- Retrieves a list of localized strings containing the names of weekdays for the current calendar system.
-		DateTimeFormatter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-setDateTimePattern(pattern:String):void -
-
- Sets the pattern string used by this DateTimeFormatter object to format dates and times.
-		DateTimeFormatter
   -
-setDateTimeStyles(dateStyle:String, timeStyle:String):void -
-
- Sets the date and time styles for this instance of the DateTimeFormatter.
-		DateTimeFormatter
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
actualLocaleIDNameproperty
-
-actualLocaleIDName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the actual locale ID used by this DateTimeFormatter object. -

There are three possibilities for the value of the name, depending on operating system and the - value of the requestedLocaleIDName parameter passed to the Collator() constructor.

-
    -
  1. If the requested locale was not LocaleID.DEFAULT and - the operating system provides support for the requested locale, - then the name returned is the same as the requestedLocaleIDName property. -
    2. - -
  2. If LocaleID.DEFAULT was used as the value for the requestedLocaleIDName - parameter to the constructor, then the name of the current locale specified by the user's operating system is - used. The LocaleID.DEFAULT value preserves user's customized setting in the OS. - Passing an explicit value as the requestedLocaleIDName parameter does not necessarily give the - same result as using the LocaleID.DEFAULT even if the two locale ID names are the same. - The user might have customized the locale settings on their machine, and by requesting an - explicit locale ID name rather than using LocaleID.DEFAULT your application would not - retrieve those customized settings. -
    -

    For example:

    - 
    -		 var fmt:DateTimeFormatter = new DateTimeFormatter(LocaleID.DEFAULT);
-		 var aliName:String = fmt.actualLocaleIDName;
-
    -

    In the above example, aliName is the name of the locale corresponding to - the user's current operating systems settings (e.g. "it-IT" if the user's locale is set to Italian-Italy), - and not "i-default" (the name of the LocaleID.DEFAULT locale).

    -
    3. -
  3. If the system does not support the requestedLocaleIDName specified in the constructor - then a fallback locale ID name is provided. -
    -

    For Example:

    - 
     	 
-		 var fmt:DateTimeFormatter = new DateTimeFormatter("fr-CA"); 	 
-		 var aliName:String = fmt.actualLocaleIDName;
-
    -

    Assuming that the operating system in the example above does not support the "fr-CA" (French-Canada) locale ID, - a fallback is used. In this case the fallback locale ID is "fr-FR" (French-France).

    -
    4. -
- Implementation -
-    public function get actualLocaleIDName():String -
-

-See also -

-
-LocaleID -
-requestedLocaleIDName -
-DateTimeFormatter() -
-
- - - - - -
lastOperationStatusproperty 
-
-lastOperationStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The status of previous operation that this DateTimeFormatter object performed. - The lastOperationStatus property is set whenever the constructor or a method of - this class is called, or another property is set. For the possible values see the description for each method. -

Implementation -
-    public function get lastOperationStatus():String -
-

-See also -

-
-LastOperationStatus -
-
- - - - - -
requestedLocaleIDNameproperty 
-
-requestedLocaleIDName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the requested locale ID that was passed to the constructor of this DateTimeFormatter object. - -

If the LocaleID.DEFAULT value was used then the name returned is "i-default". - The actual locale used can differ from the requested locale when a fallback locale is applied. - The name of the actual locale can be retrieved using the actualLocaleIDName property. -

- Implementation -
-    public function get requestedLocaleIDName():String -
-

-See also -

-
-LocaleID -
-actualLocaleIDName -
-DateTimeFormatter() -
-
- -
Constructor detail
- - - - - -
DateTimeFormatter()constructor
-
-public function DateTimeFormatter(requestedLocaleIDName:String, dateStyle:String = "long", timeStyle:String = "long") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs a new DateTimeFormatter object to format dates and times according to the conventions of the - specified locale and the provided date and time formatting styles. Date and time styles are used to set - date and time formatting patterns to predefined, locale dependent patterns from the operating system. -

This constructor determines if the current operating system supports the requested locale ID name. - If it is not supported then a fallback locale is used instead. - The name of the fallback locale ID can be determined from the actualLocaleIDName property. -

- If a fallback is used for any of the requestedLocaleIDName, dateStyle or - timeStyle parameters then the lastOperationStatus property is set - to indicate the type of fallback. -

-

To format based on the user's current operating system preferences, pass the value LocaleID.DEFAULT - in the requestedLocaleIDName parameter to the constructor. -

- -

When the constructor is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

When the requested locale ID name is not available then the lastOperationStatus - is set to one of the following:

-
    -
  • LastOperationStatus.USING_FALLBACK_WARNING
    • -
  • LastOperationStatus.USING_DEFAULT_WARNING
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in - the LastOperationStatus class.

-

For details on the warnings listed above and other possible values of the - lastOperationStatus property see the descriptions in the LastOperationStatus class.

- - Parameters - - - - - - - - - - - - - - - - -
requestedLocaleIDName:String — The preferred locale ID name to use when determining date or time formats. -
 
dateStyle:String (default = "long") — Specifies the style to use when formatting dates. - The value corresponds to one of the values enumerated by the DateTimeStyle class: -
    -
  • DateTimeStyle.LONG
    • -
  • DateTimeStyle.MEDIUM
    • -
  • DateTimeStyle.SHORT
    • -
  • DateTimeStyle.NONE
    • -
-
 
timeStyle:String (default = "long") — Specifies the style to use when formatting times. - The value corresponds to one of the values enumerated by the DateTimeStyle class: -
    -
  • DateTimeStyle.LONG
    • -
  • DateTimeStyle.MEDIUM
    • -
  • DateTimeStyle.SHORT
    • -
  • DateTimeStyle.NONE
    • -
- -
-
-Throws - - - - - - - - - - -
ArgumentError — if the dateStyle or timeStyle parameter is not a valid DateTimeStyle constant. -
 
TypeError — if the dateStyle or timeStyle parameter is null. - -
-

-See also -

-
-lastOperationStatus -
-requestedLocaleIDName -
-actualLocaleIDName -
-DateTimeStyle -
-LastOperationStatus -
-LocaleID -
-
- -
Method detail
- - - - - -
format()method
-
-public function format(dateTime:Date):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Formats a display string for a Date object that is interpreted as being in the user's local time - (using the local time components of the Date object such as: date, day, fullYear, hours, minutes, month, and seconds). - The formatting is done using the conventions of the locale ID - and the date style and time style, or customized date pattern and time pattern, - specified for this DateTimeFormatter instance. -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- - Parameters - - - - -
dateTime:Date — A Date value to be formatted. Valid range is from Jan 1, 1601 to Dec 31, 30827. -
-

-Returns - - - - -
String — - A formatted string representing the date or time value. - - - -
-

-See also -

-
-setDateTimeStyles() -
-setDateTimePattern() -
-getDateStyle() -
-getTimeStyle() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
formatUTC()method 
-
-public function formatUTC(dateTime:Date):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Formats a display string for a Date object that is interpreted as being in UTC time - (using the UTC components of the Date object such as: dateUTC, dayUTC, fullYearUTC, hoursUTC, minutesUTC, monthUTC, - and secondsUTC), according to the dateStyle, timeStyle or date time pattern. - The formatting is done using the conventions of the locale ID - and the date style and time style, or customized date pattern and time pattern, - specified for this DateTimeFormatter instance. -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- - Parameters - - - - -
dateTime:Date — A Date value to be formatted. Valid range is from Jan 1, 1601 to Dec 31, 30827. -
-

-Returns - - - - -
String — - A formatted string representing the date or time value. - - - -
-

-See also -

-
-setDateTimeStyles() -
-setDateTimePattern() -
-getDateStyle() -
-getTimeStyle() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getAvailableLocaleIDNames()method 
-
-public static function getAvailableLocaleIDNames():Vector.<String> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Lists all of the locale ID names supported by this class. - -

If this class is not supported on the current operating system, this method returns a null value.

-

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

-Returns - - - - -
Vector.<String> — A vector of strings containing all of the locale ID names supported by this class. - -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-LocaleID -
-
- - - - - -
getDateStyle()method 
-
-public function getDateStyle():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Gets the date style for this instance of the DateTimeFormatter. The date style is used to retrieve a - predefined date formatting pattern from the operating system. - - The date style value can be set by the DateTimeFormatter() constructor, the setDateTimeStyles() - method or the setDateTimePattern() method. - -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- -

-Returns - - - - -
String — - The date style string for this formatter. -

Possible values:

-
    -
  • DateTimeStyle.LONG
    • -
  • DateTimeStyle.MEDIUM
    • -
  • DateTimeStyle.SHORT
    • -
  • DateTimeStyle.NONE
    • -
  • DateTimeStyle.CUSTOM
    • -
- - -
-

-See also -

-
-setDateTimeStyles() -
-setDateTimePattern() -
-lastOperationStatus -
-DateTimeStyle -
-DateTimeFormatter -
-LastOperationStatus -
-
- - - - - -
getDateTimePattern()method 
-
-public function getDateTimePattern():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns the pattern string used by this DateTimeFormatter object to format dates and times. - -

This pattern can be set in one of three ways:

-
    -
  1. By the dateStyle and timeStyle parameters used in the constructor
    2. -
  2. By the setDateTimeStyles() method
    3. -
  3. By the setDateTimePattern() method.
    4. -
-

For a description of the pattern syntax, see the - setDateTimePattern() method. -

- -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- -

-Returns - - - - -
String — - A string containing the pattern used by this DateTimeFormatter object to format dates and times. - - - -
-

-See also -

-
-DateTimeFormatter -
-setDateTimeStyles() -
-setDateTimePattern() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getFirstWeekday()method 
-
-public function getFirstWeekday():int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns an integer corresponding to the first day of the week for this locale and calendar system. - A value of 0 corresponds to Sunday, 1 corresponds to Monday, and so on, with 6 corresponding to Saturday. -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

-Returns - - - - -
int — - An integer corresponding to the first day of the week for this locale and calendar system. - - - -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getMonthNames()method 
-
-public function getMonthNames(nameStyle:String = "full", context:String = "standalone"):Vector.<String> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Retrieves a list of localized strings containing the month names for the current calendar system. - The first element in the list is the name for the first month of the year. -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- - Parameters - - - - - - - - - - -
nameStyle:String (default = "full") — Indicates the style of name string to be used. Valid values are: -
    -
  • DateTimeNameStyle.FULL
    • -
  • DateTimeNameStyle.LONG_ABBREVIATION
    • -
  • DateTimeNameStyle.SHORT_ABBREVIATION
    • -
-
 
context:String (default = "standalone") — A code indicating the context in which the formatted string is used. - This context makes a difference only for certain locales. Valid values are: -
    -
  • DateTimeNameContext.FORMAT
    • -
  • DateTimeNameContext.STANDALONE
    • -
- -
-

-Returns - - - - -
Vector.<String> — A vector of localized strings containing the month names for the specified locale, name style, and context. - The first element in the vector, at index 0, is the name for the first month of the year; the next element is - the name for the second month of the year; and so on. -
-
-Throws - - - - -
TypeError — if the nameStyle or context parameter is null. -
-

-See also -

-
-lastOperationStatus -
-DateTimeNameContext -
-DateTimeNameStyle -
-LastOperationStatus -
-
- - - - - -
getTimeStyle()method 
-
-public function getTimeStyle():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Gets the time style for this instance of the DateTimeFormatter. The time style is used to retrieve a - predefined time formatting pattern from the operating system. - - The time style value can be set by the DateTimeFormatter() constructor, the setDateTimeStyles() - method or the setDateTimePattern() method. - -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- -

-Returns - - - - -
String — - The time style string for this formatter. -

Possible values:

-
    -
  • DateTimeStyle.LONG
    • -
  • DateTimeStyle.MEDIUM
    • -
  • DateTimeStyle.SHORT
    • -
  • DateTimeStyle.NONE
    • -
  • DateTimeStyle.CUSTOM
    • -
- - -
-

-See also -

-
-setDateTimeStyles() -
-setDateTimePattern() -
-lastOperationStatus -
-DateTimeStyle -
-DateTimeFormatter -
-LastOperationStatus -
-
- - - - - -
getWeekdayNames()method 
-
-public function getWeekdayNames(nameStyle:String = "full", context:String = "standalone"):Vector.<String> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Retrieves a list of localized strings containing the names of weekdays for the current calendar system. - The first element in the list represents the name for Sunday. -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- - Parameters - - - - - - - - - - -
nameStyle:String (default = "full") — Indicates the style of name string to be used. Valid values are: -
    -
  • DateTimeNameStyle.FULL
    • -
  • DateTimeNameStyle.LONG_ABBREVIATION
    • -
  • DateTimeNameStyle.SHORT_ABBREVIATION
    • -
-
 
context:String (default = "standalone") — A code indicating the context in which the formatted string is used. - This context only applies for certain locales where the name of a month changes depending on the context. - For example, in Greek the month names are different if they are displayed alone versus displayed along with a day. - Valid values are: -
    -
  • DateTimeNameContext.FORMAT
    • -
  • DateTimeNameContext.STANDALONE
    • -
- -
-

-Returns - - - - -
Vector.<String> — A vector of localized strings containing the month names for the specified locale, name style, and context. - The first element in the vector, at index 0, is the name for Sunday; the next element is the name - for Monday; and so on. -
-
-Throws - - - - -
TypeError — if the nameStyle or context parameter is null. -
-

-See also -

-
-lastOperationStatus -
-DateTimeNameContext -
-DateTimeNameStyle -
-LastOperationStatus -
-
- - - - - -
setDateTimePattern()method 
-
-public function setDateTimePattern(pattern:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Sets the pattern string used by this DateTimeFormatter object to format dates and times. - -

The pattern used to format dates can be set in one of three ways:

-
    -
  1. By the dateStyle and timeStyle parameters used in the constructor
    2. -
  2. By the setDateTimeStyles() method
    3. -
  3. By this setDateTimePattern() method.
    4. -
-

- As a side effect this method overrides the current time and date styles for this DateTimeFormatter object and set them - to the value DateTimeStyle.CUSTOM. -

-

A pattern string defines how date and times are formatted. The pattern contains sequences of letters that are replaced - with date and time values in the formatted string. - For example, in the pattern "yyyy/MM" the characters "yyyy" are replaced with a four-digit year, followed by a - "/" character, and the characters "MM" are replaced with a two-digit month. -

-

Many of the letters used in patterns can be repeated more than once to produce different outputs, - as described in the table below. -

- If a sequence exceeds the maximum number of letters supported by a pattern, - it is mapped back to the longest supported sequence for that pattern letter. - For example: -

-
    -
  • MMMMMM is replaced with MMMM
    • -
  • dddd is replaced with dd
    • -
  • EEEEEEE is replaced with EEEE
    • -
  • aa is replaced with a
    • -
  • hhh is replaced with hh
    • -
  • mmmm is replaced with mm
    • -
-

In theory a pattern can contain up to 255 characters, but some platforms have stricter limit. - If the pattern exceeds the pattern character limit, the lastOperationStatus property is set to the value - LastOperationStatus.PATTERN_SYNTAX_ERROR. -

-

Not all possible patterns are supported on each operating system. If a pattern is not supported on the platform - then a fallback pattern is used - and the lastOperationStatus property is set to indicate the use of a fallback. - If no reasonable fallback pattern can be provided, an empty string is used - and the lastOperationStatus property is set to indicate that the pattern was unsupported. -

-

The following table describes the valid pattern letters and their meaning. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Pattern letterDescription
GEra. Replaced by the Era string for the current date and calendar. This pattern is not supported on all - operating systems. On operating systems that do not support the era, the letters of the input pattern - are replaced by an empty string. -

There can be one to five letters in era patterns that are interpreted as follows:

-
    -
  • If the number of pattern letters is one to three, the abbreviated form is used.
    • -
  • If the number of pattern letters is four, the format is interpreted as the full form.
    • -
  • If the number of pattern letters is five, the format is interpreted as the short abbreviation.
    • -
-

Examples with the Gregorian Calendar(for operating systems that support this pattern):

-
    -
  • G, GG, GGG = AD
    • -
  • GGGG = Anno Domini
    • -
  • GGGGG = A
    • -
yYear. If the number of pattern letters is two, the last two digits of the year are displayed; otherwise the number of letters determines - the number of digits. If the year value requires more digits than provided by the number of letters, then the full - year value is provided. If there are more letters than required by the value, then the year values are padded with zeros. - The following list shows the results for the years 1 and 2005. -

Examples:

-
    -
  • y = 1
    • -
  • y = 2005
    • -
  • yy = 01
    • -
  • yy = 05
    • -
  • yyyy = 0001 or 01, Depending on the operating system.
    • -
  • yyyy = 2005
    • -
  • yyyyy = 01 or 0001, Depending on the operating system. More than four y's fall back to the maximum number of digits supported on the operating system.
    • -
  • yyyyy = 2005
    • -
M Month in year. There can be one to five letters in month patterns that are interpreted as follows: -
    -
  • If the number of pattern letters is one, the format is interpreted as numeric in one or two digits.
    • -
  • If the number of pattern letters is two, the format is interpreted as numeric in two digits.
    • -
  • If the number of pattern letters is three, the format is interpreted as the long abbreviation.
    • -
  • If the number of pattern letters is four, the format is interpreted as the full name.
    • -
  • If the number of pattern letters is five, the format is interpreted as the short abbreviation. This format is not supported - on all operating systems and falls back to the long abbreviation.
    • -
-

Examples:

-
    -
  • M = 7
    • -
  • MM = 07
    • -
  • MMM = Jul, 7月
    • -
  • MMMM = July, 7月
    • -
  • MMMMM = J or Jul, 7 or 7月 depending on the operating system.
    • -
d Day of the month. There can be one or two letters in day of the month patterns that are interpreted as follows: -
    -
  • If the number of pattern letters is one, the format is interpreted as numeric in one or two digits.
    • -
  • If the number of pattern letters is two, the format is interpreted as numeric in two digits.
    • -
-

Examples:

-
    -
  • d = 4
    • -
  • dd = 04
    • -
  • dd = 14
    • -
EDay in week. There can be one to five letters in day of the week patterns that are interpreted as follows: -
    -
  • If the number of pattern letters is one to three, the format is interpreted as the long abbreviation.
    • -
  • If the number of pattern letters is four, the format is interpreted as the full name.
    • -
  • If the number of pattern letters is five, the format is interpreted as the short abbreviation. This format is not supported - on all operating systems and falls back to the long abbreviation.
    • -
-

Examples:

-
    -
  • E, EE, EEE = Tues
    • -
  • EEEE = Tuesday
    • -
  • EEEEE = T or Tues depending on the operating system.
    • -
QQuarter. Some platforms do not support this pattern. There can be one to four letters in quarter patterns that are interpreted as follows: -
    -
  • If the number of pattern letters is one, the format is interpreted as numeric in one digit.
    • -
  • If the number of pattern letters is two, the format is interpreted as numeric in two digits.
    • -
  • If the number of pattern letters is three, the format is interpreted as the abbreviation.
    • -
  • If the number of pattern letters is four, the format is interpreted as the full name.
    • -
-

Examples (for operating systems that support this pattern):

-
    -
  • Q = 2
    • -
  • QQ = 02
    • -
  • QQQ = Q2
    • -
  • QQQQ = second quarter
    • -
wWeek of the year. Some platforms do not support this pattern. There can be one to two letters in this pattern that are interpreted as follows. -
    -
  • If the number of pattern letters is one, the format is interpreted as numeric in one or two digits.
    • -
  • If the number of pattern letters is two, the format is interpreted as numeric in two digits.
    • -
-

Examples for the second week of the year (for operating systems that support this pattern):

-
    -
  • w = 2
    • -
  • ww = 02
    • -
WWeek of the month. Some platforms do not support this pattern. This pattern allows one letter only. -

Examples for the second week of July (for operating systems that support this pattern):

-
    -
  • W = 2
    • -
DDay of the year. Some platforms do not support this pattern. There can be one to three letters in this pattern. -

Examples for the second day of the year (for operating systems that support this pattern):

-
    -
  • D = 2
    • -
  • DD = 02
    • -
  • DDD = 002
    • -
FOccurrence of a day of the week within a calendar month. For example, this element displays "3" - if used to format the date for the third Monday in October. This pattern allows one letter only. -

Examples for the second Wednesday in July (for operating systems that support this pattern):

-
    -
  • F = 2
    • -
aAM/PM indicator. This pattern allows one letter only, a or p. -

Examples:

-
    -
  • a = AM, 午前
    • -
  • p = PM, 午後
    • -
hHour of the day in a 12-hour format [1 - 12]. This pattern must be one or two letters. -

Examples:

-
    -
  • h = 1
    • -
  • h = 12
    • -
  • hh = 01
    • -
HHour of the day in a 24-hour format [0 - 23]. This pattern must be one or two letters. -

Examples:

-
    -
  • H = 0
    • -
  • H = 23
    • -
  • HH = 00
    • -
KHour in the day in a 12-hour format [0 - 11]. This pattern must be one or two letters. - This pattern is not supported on all operating systems. -

Examples (for operating systems that support this pattern):

-
    -
  • K = 0
    • -
  • K = 11
    • -
  • KK = 00
    • -
kHour of the day in a 24-hour format [1 - 24]. This pattern must be one or two letters. - This pattern is not supported on all operating systems. -

Examples (for operating systems that support this pattern):

-
    -
  • k = 1
    • -
  • k = 24
    • -
  • kk = 01
    • -
mMinute of the hour [0 - 59]. This pattern must be one or two letters. -

Examples:

-
    -
  • m = 2
    • -
  • m = 59
    • -
  • mm = 02
    • -
sSeconds in the minute [0 - 59]. This pattern must be one or two letters. -

Examples:

-
    -
  • s = 2
    • -
  • s = 59
    • -
  • ss = 02
    • -
SMilliseconds. This pattern must be one to five letters. The value is rounded according to the - number of letters used. When five characters are used (SSSSS) it denotes fractional milliseconds. -

Examples:

-
    -
  • S = 2
    • -
  • SS = 24
    • -
  • SSS = 235
    • -
  • SSSS = 2350
    • -
  • SSSSS = 23500
    • -
zTime Zone. Represents the time zone as a string that respects standard or daylight time, without referring to a specific - location. This pattern is not supported on all operating systems. On operating systems that do not support - time zone patterns, the letters of the input pattern are replaced by an empty string. On operating - systems that do support this pattern, not all locales have a defined string. Those locales fall back - to a localized GMT format such as GMT-08:00 or GW-08:00 -

There must be one to four letters in this time zone pattern, interpreted as follows:

-
    -
  • If the number of pattern letters is one to three, the format is interpreted as abbreviated form.
    • -
  • If the number of pattern letters is four, the format is interpreted as the full name.
    • -
-

Examples for operating systems that support this format:

-
    -
  • z, zz, zzz = PDT
    • -
  • z, zz, zzz = PST
    • -
  • z, zz, zzz = GMT-0800
    • -
  • zzzz = Pacific Daylight Time
    • -
  • zzzz = Pacific Standard Time
    • -
ZTime Zone. Represents the time zone as an offset from GMT. This pattern is not supported on all operating systems. On operating systems that do not support - time zone patterns, the letters of the input pattern are replaced by an empty string. -

There must be one to four letters in this time zone pattern, interpreted as follows:

-
    -
  • If the number of pattern letters is one to three, the format uses the RFC 822 format.
    • -
  • If the number of pattern letters is four, the format uses the localized GMT format. This - falls back to the non-localized GMT format for locales that do not have a localized GMT format.
    • -
-

Examples for operating systems that support this format:

-
    -
  • Z, ZZ, ZZZ = -0800
    • -
  • ZZZZ = GMT-08:00, GW-08:00
    • -
vTime Zone. A string reflecting the generic time zone that does not refer to a specific - location or distinguish between daylight savings time or standard time. This pattern is not supported on all operating systems. On operating systems that do not support - time zone patterns the letters of the input pattern are replaced by an empty string. On operating - systems that support this pattern, fallback strings are provided if a localized name is not - available. -

There must be one or four letters in this time zone pattern, interpreted as follows:

-
    -
  • If the number of pattern letters is one, the format uses the abbreviated form.
    • -
  • If the number of pattern letters is four, the format uses the full form.
    • -
-

Examples for operating systems that support this format:

-
    -
  • v = PT
    • -
  • vvvv = Pacific Time
    • -
'Other text'Text and punctuation may be included in the pattern string. However the characters from a to z and A to Z, are reserved as - syntax characters and must be enclosed in single quotes to be included in - the formatted string. To include a single quote in the result string, two single quotes must be used in the - pattern string. The two single quotes may appear inside or outside a quoted portion of the pattern string. - An unmatched pair of single quotes is terminated at the end of the string. -

Examples:

-
    -
  • EEEE, MMM. d, yyyy 'at' h 'o''clock' a= Tuesday, Sept. 8, 2005 at 1 o'clock PM
    • -
  • yyyy年M月d日 = 2005年9月8日
    • -
  • mm''ss'' = 43'01'
    • -
- -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- - Parameters - - - - -
pattern:String
-
-Throws - - - - -
TypeError — if the pattern parameter is null. -
-

-See also -

-
-DateTimeFormatter -
-setDateTimeStyles() -
-setDateTimePattern() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
setDateTimeStyles()method 
-
-public function setDateTimeStyles(dateStyle:String, timeStyle:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Sets the date and time styles for this instance of the DateTimeFormatter. Date and time styles are used to set - date and time formatting patterns to predefined, locale-dependent patterns from the operating system. - - This method replaces the styles that were set using the DateTimeFormatter() constructor or - using the setDateTimePattern() method. The date and time pattern is - also updated based on the styles that are set. - -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- - Parameters - - - - - - - - - - -
dateStyle:String — Specifies the style to use when formatting dates. - The value corresponds to one of the values enumerated by the DateTimeStyle class: -
    -
  • DateTimeStyle.LONG
    • -
  • DateTimeStyle.MEDIUM
    • -
  • DateTimeStyle.SHORT
    • -
  • DateTimeStyle.NONE
    • -
-
 
timeStyle:String — Specifies the style to use when formatting times. - The value corresponds to one of the values enumerated by the DateTimeStyle class: -
    -
  • DateTimeStyle.LONG
    • -
  • DateTimeStyle.MEDIUM
    • -
  • DateTimeStyle.SHORT
    • -
  • DateTimeStyle.NONE
    • -
- -
-
-Throws - - - - - - - - - - -
ArgumentError — if the dateStyle or timeStyle parameter is not a valid DateTimeStyle constant. -
 
TypeError — if the dateStyle or timeStyle parameter is null. -
-

-See also -

-
-DateTimeFormatter() -
-setDateTimeStyles() -
-setDateTimePattern() -
-lastOperationStatus -
-DateTimeStyle -
-LastOperationStatus -
-
- -
Examples
-
examples\DateTimeFormatter.1
-
The following examples shows how strings that represent date and time values can be formatted - differently based on the locale. - - The output from this example will differ based on the operating system and user preferences. -

- This example uses the following locales: English (US), French (France), Spanish (Spain). -

-

- The example does the following for each locale in the list: -

-
    -
  1. Creates a DateTimeFormatter object using the default style (long dateStyle, long timeStyle)
    2. -
  2. Formats the current date and time using the default long date style.
    3. -
  3. Change to a time-only short date style using the DateTimeStyle.NONE and DateTimeStyle.SHORT - constants.
    4. -
  4. Formats the current date and time using the time-only short date style.
    5. -
-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.globalization.DateTimeFormatter;
-    import flash.globalization.DateTimeStyle;
-    
-    public class DateTimeFormatterExample extends Sprite
-    {    
-    	private var localeList:Array = new Array("en-US", "fr-FR", "es-ES");
-    
-        public function DateTimeFormatterExample()
-        {
-            var date:Date = new Date();
-            
-        	for each (var locale:String in localeList) {
-    			var dtf:DateTimeFormatter = new DateTimeFormatter(locale);
-                trace('\n' + "LocaleID requested=" + dtf.requestedLocaleIDName 
-                    + "; actual=" + dtf.actualLocaleIDName);
-			
-				var longDate:String = dtf.format(date);
-				trace(longDate + " (" + dtf.getDateTimePattern() + ")");
-			
-				dtf.setDateTimeStyles(DateTimeStyle.NONE, DateTimeStyle.SHORT);
-				var shortDate:String = dtf.format(date);
-				trace(shortDate + " (" + dtf.getDateTimePattern() + ")");
-        	}		
-        }
-    }
-}
-
-
-
examples\DateTimeFormatter.2
-
The following example shows how an application can format a date based on a pattern selected by the user. - - The output from this example will differ based on the operating system and user preferences. -

- The example does the following for each locale in the list: -

-
    -
  1. Creates three input and output text fields.
    2. -
  2. Creates a DateTimeFormatter object using the American English locale.
    3. -
  3. Calls the configureTextField() function which sets the position and size of the text fields - and adds an event listener to the patternField object.
    4. -
  4. When the user enters pattern in the patternField text field, the textInputHandler function - formats the current date and time using the pattern, and displays the result and the lastOperationStatus - value the in output text fields.
    5. -
-
-
- 
-package {  
-    import flash.display.Sprite;
-    import flash.events.Event;
-    import flash.globalization.DateTimeFormatter;
-    import flash.text.*;
-    
-    public class DateTimePatternExample extends Sprite
-    {    
-        private var patternField:TextField = new TextField();
-        private var resultField:TextField = new TextField();
-        private var statusField:TextField = new TextField();
-       	private var date:Date = new Date();
- 		private var dtf:DateTimeFormatter = new DateTimeFormatter("en-US");       	
- 		
-        private function configureTextField():void
-        {
-            patternField.type = TextFieldType.INPUT;
-            patternField.width = 300;
-            patternField.height = 20;
-            patternField.background = true;
-            patternField.border = true;
-            
-            resultField.y = 40;
-            resultField.width = 300;
-            resultField.height = 20;
-            
-            statusField.y = 80;
-            statusField.width = 300;
-            statusField.height = 20;
-
-            addChild(patternField);
-            addChild(resultField);
-            addChild(statusField);
-            patternField.addEventListener(Event.CHANGE,textInputHandler);
-        }
-
-        private function textInputHandler(event:Event):void
-        {		 		
-    		dtf.setDateTimePattern(patternField.text);
-    		statusField.text = dtf.lastOperationStatus;
-    		resultField.text = dtf.format(date);
-        }
-
-        public function DateTimePatternExample()
-        {
-        	configureTextField();	
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/DateTimeNameContext.html b/html-docs/flash/globalization/DateTimeNameContext.html deleted file mode 100644 index 5bd9d0b..0000000 --- a/html-docs/flash/globalization/DateTimeNameContext.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - - - - - -flash.globalization.DateTimeNameContext (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class DateTimeNameContext
InheritanceDateTimeNameContext Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The DateTimeNameContext class enumerates constant values representing the formatting context in which a month name - or weekday name is used. These constants are used for the context parameters for the DateTimeFormatter's - getMonthNames() and getWeekDayNames() methods. - -

The context parameter only changes the results of those methods for certain locales and operating systems. - For most locales the lists of month names and weekday names do not differ by context.

-

-

-See also -

-
-DateTimeFormatter.getMonthNames() -
-DateTimeFormatter.getWeekDayNames() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  FORMAT : String = "format"
[static] - Indicates that the date element name is used within a date format.
-		DateTimeNameContext
  STANDALONE : String = "standalone"
[static] - Indicates that the date element name is used in a "stand alone" context, independent of other formats.
-		DateTimeNameContext
-
- -
- -
Constant detail
- - - - - -
FORMATconstant
-
-public static const FORMAT:String = "format" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the date element name is used within a date format. - -

- - - - - -
STANDALONEconstant 
-
-public static const STANDALONE:String = "standalone" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the date element name is used in a "stand alone" context, independent of other formats. - For example, the name can be used to show only the month name in a calendar or the weekday name in a date chooser. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/DateTimeNameStyle.html b/html-docs/flash/globalization/DateTimeNameStyle.html deleted file mode 100644 index e363e06..0000000 --- a/html-docs/flash/globalization/DateTimeNameStyle.html +++ /dev/null @@ -1,318 +0,0 @@ - - - - - - - - -flash.globalization.DateTimeNameStyle (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class DateTimeNameStyle
InheritanceDateTimeNameStyle Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The DateTimeNameStyle class enumerates constants that control the length of the month names and weekday names - that are used when formatting dates. Use these constants for the nameStyle parameter - of the DateTimeFormatter getMonthNames() and getWeekDayNames() methods. -

The LONG_ABBREVIATION and SHORT_ABBREVIATION may be the same or - different depending on the operating system settings.

- -

-

-See also -

-
-DateTimeFormatter -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  FULL : String = "full"
[static] - Specifies the full form or full name style for month names and weekday names.
-		DateTimeNameStyle
  LONG_ABBREVIATION : String = "longAbbreviation"
[static] - Specifies the long abbreviation style for month names and weekday names.
-		DateTimeNameStyle
  SHORT_ABBREVIATION : String = "shortAbbreviation"
[static] - Specifies the short abbreviation style for month names and weekday names.
-		DateTimeNameStyle
-
- -
- -
Constant detail
- - - - - -
FULLconstant
-
-public static const FULL:String = "full" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the full form or full name style for month names and weekday names. - - Examples: Tuesday, November. - -

- - - - - -
LONG_ABBREVIATIONconstant 
-
-public static const LONG_ABBREVIATION:String = "longAbbreviation" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the long abbreviation style for month names and weekday names. - - Examples: Tues for Tuesday, Nov for November. - -

- - - - - -
SHORT_ABBREVIATIONconstant 
-
-public static const SHORT_ABBREVIATION:String = "shortAbbreviation" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the short abbreviation style for month names and weekday names. - - Examples: T for Tuesday, N for November. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/DateTimeStyle.html b/html-docs/flash/globalization/DateTimeStyle.html deleted file mode 100644 index d3a6b02..0000000 --- a/html-docs/flash/globalization/DateTimeStyle.html +++ /dev/null @@ -1,373 +0,0 @@ - - - - - - - - -flash.globalization.DateTimeStyle (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class DateTimeStyle
InheritanceDateTimeStyle Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- Enumerates constants that determine a locale-specific date and time formatting pattern. These constants are used when - constructing a DateTimeFormatter object or when calling the DateTimeFormatter.setDateTimeStyles() method. - -

The CUSTOM constant cannot be used in the DateTimeFormatter constructor or the - DateFormatter.setDateTimeStyles() method. - This constant is instead set as the timeStyle and dateStyle property as a side effect of - calling the DateTimeFormatter.setDateTimePattern() method. -

- -

-

-See also -

-
-DateTimeFormatter -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  CUSTOM : String = "custom"
[static] - Specifies that a custom pattern string is used to specify the date or time style.
-		DateTimeStyle
  LONG : String = "long"
[static] - Specifies the long style of a date or time.
-		DateTimeStyle
  MEDIUM : String = "medium"
[static] - Specifies the medium style of a date or time.
-		DateTimeStyle
  NONE : String = "none"
[static] - Specifies that the date or time should not be included in the formatted string.
-		DateTimeStyle
  SHORT : String = "short"
[static] - Specifies the short style of a date or time.
-		DateTimeStyle
-
- -
- -
Constant detail
- - - - - -
CUSTOMconstant
-
-public static const CUSTOM:String = "custom" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies that a custom pattern string is used to specify the date or time style. - -

- - - - - -
LONGconstant 
-
-public static const LONG:String = "long" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the long style of a date or time. - -

- - - - - -
MEDIUMconstant 
-
-public static const MEDIUM:String = "medium" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the medium style of a date or time. - -

- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies that the date or time should not be included in the formatted string. - -

- - - - - -
SHORTconstant 
-
-public static const SHORT:String = "short" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the short style of a date or time. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/LastOperationStatus.html b/html-docs/flash/globalization/LastOperationStatus.html deleted file mode 100644 index d32875d..0000000 --- a/html-docs/flash/globalization/LastOperationStatus.html +++ /dev/null @@ -1,739 +0,0 @@ - - - - - - - - -flash.globalization.LastOperationStatus (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class LastOperationStatus
InheritanceLastOperationStatus Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The LastOperationStatus class enumerates constant values that represent the status of the most recent globalization service operation. - These values can be retrieved through the read-only property lastOperationStatus available in most globalization - classes. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  BUFFER_OVERFLOW_ERROR : String = "bufferOverflowError"
[static] - Indicates that given buffer is not enough to hold the result.
-		LastOperationStatus
  ERROR_CODE_UNKNOWN : String = "errorCodeUnknown"
[static] - Indicates that the return error code is not known.
-		LastOperationStatus
  ILLEGAL_ARGUMENT_ERROR : String = "illegalArgumentError"
[static] - Indicates that an argument passed to a method was illegal.
-		LastOperationStatus
  INDEX_OUT_OF_BOUNDS_ERROR : String = "indexOutOfBoundsError"
[static] - Indicates that an iterator went out of range or an invalid parameter was specified for month, day, or time.
-		LastOperationStatus
  INVALID_ATTR_VALUE : String = "invalidAttrValue"
[static] - Indicates that a given attribute value is out of the expected range.
-		LastOperationStatus
  INVALID_CHAR_FOUND : String = "invalidCharFound"
[static] - Indicates that invalid Unicode value was found.
-		LastOperationStatus
  MEMORY_ALLOCATION_ERROR : String = "memoryAllocationError"
[static] - Indicates that memory allocation has failed.
-		LastOperationStatus
  NO_ERROR : String = "noError"
[static] - Indicates that the last operation succeeded without any errors.
-		LastOperationStatus
  NUMBER_OVERFLOW_ERROR : String = "numberOverflowError"
[static] - Indicates that an operation resulted a value that exceeds a specified numeric type.
-		LastOperationStatus
  PARSE_ERROR : String = "parseError"
[static] - Indicates that the parsing of a number failed.
-		LastOperationStatus
  PATTERN_SYNTAX_ERROR : String = "patternSyntaxError"
[static] - Indicates that the pattern for formatting a number, date, or time is invalid.
-		LastOperationStatus
  PLATFORM_API_FAILED : String = "platformAPIFailed"
[static] - Indicates that an underlying platform API failed for an operation.
-		LastOperationStatus
  TRUNCATED_CHAR_FOUND : String = "truncatedCharFound"
[static] - Indicates that a truncated Unicode character value was found.
-		LastOperationStatus
  UNEXPECTED_TOKEN : String = "unexpectedToken"
[static] - Indicates that an unexpected token was detected in a Locale ID string.
-		LastOperationStatus
  UNSUPPORTED_ERROR : String = "unsupportedError"
[static] - Indicates that the requested operation or option is not supported.
-		LastOperationStatus
  USING_DEFAULT_WARNING : String = "usingDefaultWarning"
[static] - Indicates that an operating system default value was used during the most recent operation.
-		LastOperationStatus
  USING_FALLBACK_WARNING : String = "usingFallbackWarning"
[static] - Indicates that a fallback value was set during the most recent operation.
-		LastOperationStatus
-
- -
- -
Constant detail
- - - - - -
BUFFER_OVERFLOW_ERRORconstant
-
-public static const BUFFER_OVERFLOW_ERROR:String = "bufferOverflowError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that given buffer is not enough to hold the result. -

- - - - - -
ERROR_CODE_UNKNOWNconstant 
-
-public static const ERROR_CODE_UNKNOWN:String = "errorCodeUnknown" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the return error code is not known. - Any non-static method or read/write properties can return this error when the operation is not successful - and the return error code is not known. -

- - - - - -
ILLEGAL_ARGUMENT_ERRORconstant 
-
-public static const ILLEGAL_ARGUMENT_ERROR:String = "illegalArgumentError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that an argument passed to a method was illegal. -

For example, the following code shows that an invalid argument error status is set - when CurrencyFormatter.grouping property is set to the invalid value "3;".

- 
-	    var cf:CurrencyFormatter = new CurrencyFormatter("en-US");
-	    cf.groupingPattern = "3;";
-	    trace(cf.lastOperationStatus); // "illegalArgumentError"
-
-
- - - - - -
INDEX_OUT_OF_BOUNDS_ERRORconstant 
-
-public static const INDEX_OUT_OF_BOUNDS_ERROR:String = "indexOutOfBoundsError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that an iterator went out of range or an invalid parameter was specified for month, day, or time. -

- - - - - -
INVALID_ATTR_VALUEconstant 
-
-public static const INVALID_ATTR_VALUE:String = "invalidAttrValue" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that a given attribute value is out of the expected range. -

The following example shows that setting the NumberFormatter.negativeNumberFormat - property to an out-of-range value results in an invalid attribute value status. -

- 
-	    var nf:NumberFormatter = new NumberFormatter(LocaleID.DEFAULT);
-	    nf.negativeNumberFormat = 9;
-	    nf.lastOperationStatus; // "invalidAttrValue" 
-
-
- - - - - -
INVALID_CHAR_FOUNDconstant 
-
-public static const INVALID_CHAR_FOUND:String = "invalidCharFound" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that invalid Unicode value was found. -

- - - - - -
MEMORY_ALLOCATION_ERRORconstant 
-
-public static const MEMORY_ALLOCATION_ERROR:String = "memoryAllocationError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that memory allocation has failed. -

- - - - - -
NO_ERRORconstant 
-
-public static const NO_ERROR:String = "noError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the last operation succeeded without any errors. This status can be returned - by all constructors, non-static methods, static methods and read/write properties. - -

- - - - - -
NUMBER_OVERFLOW_ERRORconstant 
-
-public static const NUMBER_OVERFLOW_ERROR:String = "numberOverflowError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that an operation resulted a value that exceeds a specified numeric type. -

- - - - - -
PARSE_ERRORconstant 
-
-public static const PARSE_ERROR:String = "parseError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the parsing of a number failed. - This status can be returned by parsing methods of the formatter classes, such as - CurrencyFormatter.parse() and NumberFormatter.parseNumber(). For example, if the value "12abc34" is passed - as the parameter to the CurrencyFormatter.parse() method, the method returns "NaN" and sets the - lastOperationStatus value to LastOperationStatus.PARSE_ERROR. -

- - - - - -
PATTERN_SYNTAX_ERRORconstant 
-
-public static const PATTERN_SYNTAX_ERROR:String = "patternSyntaxError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the pattern for formatting a number, date, or time is invalid. - This status is set when the user's operating system does not support the given pattern. -

For example, the following code shows the value of the lastOperationStatus property after - an invalid "xx" pattern is used for date formatting:

- 
-		var df:DateTimeFormatter = new DateTimeFormatter("en-US");
-		df.setDateTimePattern("xx");
-	    trace(df.lastOperationStatus); // "patternSyntaxError" 
-
-
- - - - - -
PLATFORM_API_FAILEDconstant 
-
-public static const PLATFORM_API_FAILED:String = "platformAPIFailed" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that an underlying platform API failed for an operation. -

- - - - - -
TRUNCATED_CHAR_FOUNDconstant 
-
-public static const TRUNCATED_CHAR_FOUND:String = "truncatedCharFound" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that a truncated Unicode character value was found. -

- - - - - -
UNEXPECTED_TOKENconstant 
-
-public static const UNEXPECTED_TOKEN:String = "unexpectedToken" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that an unexpected token was detected in a Locale ID string. -

For example, the following code shows the value of the lastOperationStatus property after - an incomplete string is used when requesting a locale ID. As a result the lastOperationStatus - property is set to the value UNEXPECTED_TOKEN after a call to the - LocaleID.getKeysAndValues() method. -

- 
-	    var locale:LocaleID = new LocaleID("en-US@Collation");
-		var kav:Object = locale.getKeysAndValues();
-		trace(locale.lastOperationStatus); // "unexpectedToken"
-
-
- - - - - -
UNSUPPORTED_ERRORconstant 
-
-public static const UNSUPPORTED_ERROR:String = "unsupportedError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the requested operation or option is not supported. This status can be returned by methods like - DateTimeFormatter.setDateTimePattern() and when retrieving properties like - Collator.ignoreCase. -

- - - - - -
USING_DEFAULT_WARNINGconstant 
-
-public static const USING_DEFAULT_WARNING:String = "usingDefaultWarning" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that an operating system default value was used during the most recent operation. - Class constructors can return this status. - -

- - - - - -
USING_FALLBACK_WARNINGconstant 
-
-public static const USING_FALLBACK_WARNING:String = "usingFallbackWarning" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that a fallback value was set during the most recent operation. - This status can be returned by constructors and methods like DateTimeFormatter.setDateTimeStyles(), - and when retrieving properties like CurrencyFormatter.groupingPattern. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/LocaleID.html b/html-docs/flash/globalization/LocaleID.html deleted file mode 100644 index 191865b..0000000 --- a/html-docs/flash/globalization/LocaleID.html +++ /dev/null @@ -1,962 +0,0 @@ - - - - - - - - -flash.globalization.LocaleID (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class LocaleID
InheritanceLocaleID Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The LocaleID class provides methods for parsing and using locale ID names. This class supports locale ID names - that use the syntax defined by the Unicode Technical Standard #35 - (http://unicode.org/reports/tr35/). - -

-

-View the examples. -

-

-See also -

-
-Unicode Technical Standard #35 -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  lastOperationStatus : String -
[read-only] - The status of the most recent operation that this LocaleID object performed.
-		LocaleID
  name : String -
[read-only] - Returns a slightly more "canonical" locale identifier.
-		LocaleID
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-LocaleID(name:String)
-
- Constructs a new LocaleID object, given a locale name.
-		LocaleID
   -
-determinePreferredLocales(want:Vector.<String>, have:Vector.<String>, keyword:String = "userinterface"):Vector.<String>
-
[static] - Returns a list of acceptable locales based on a list of desired locales and a list of the locales that are currently available.
-		LocaleID
   -
-getKeysAndValues():Object -
-
- Returns an object containing all of the key and value pairs from the LocaleID object.
-		LocaleID
   -
-getLanguage():String -
-
- Returns the language code specified by the locale ID name.
-		LocaleID
   -
-getRegion():String -
-
- Returns the region code specified by the locale ID name.
-		LocaleID
   -
-getScript():String -
-
- Returns the script code specified by the locale ID name.
-		LocaleID
   -
-getVariant():String -
-
- Returns the language variant code specified by the locale ID name.
-		LocaleID
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-isRightToLeft():Boolean -
-
- Specifies whtehr the text direction for the specified locale is right to left.
-		LocaleID
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - -
 ConstantDefined by
  DEFAULT : String = "i-default"
[static] - Indicates that the user's default linguistic preferences should be used, as specified in the user's operating system settings.
-		LocaleID
-
- -
- -
Property detail
- - - - - -
lastOperationStatusproperty
-
-lastOperationStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The status of the most recent operation that this LocaleID object performed. - The lastOperationStatus property is set whenever the constructor or a method of - this class is called or another property is set. For the possible values see the description for each method. -

Implementation -
-    public function get lastOperationStatus():String -
-

-See also -

-
-LastOperationStatus -
-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a slightly more "canonical" locale identifier. -

This method performs the following conversion to the locale ID name to give it a more canonical form.

-
    -
  • Proper casing is applied to all of the components.
    • -
  • Underscores are converted to dashes.
    • -
- -

No additional processing is performed. For example, aliases are not replaced, and no elements are added or removed.

- -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Implementation -
-    public function get name():String -
-
- -
Constructor detail
- - - - - -
LocaleID()constructor
-
-public function LocaleID(name:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs a new LocaleID object, given a locale name. The locale name - must conform to the syntax defined by the Unicode Technical Standard #35 - (http://unicode.org/reports/tr35/). -

When the constructor completes successfully the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

When the requested locale ID name is not available then the lastOperationStatus - is set to one of the following:

-
    -
  • LastOperationStatus.USING_FALLBACK_WARNING
    • -
  • LastOperationStatus.USING_DEFAULT_WARNING
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in - the LastOperationStatus class.

-

For details on the warnings listed above and other possible values of the lastOperationStatus property - see the descriptions in the LastOperationStatus class.

- Parameters - - - - -
name:String — A locale ID name, which can also include an optional collation string. - For example: "en-US" or "de-DE@collation=phonebook" -
-
-Throws - - - - -
ArgumentError — if the name is null. -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- -
Method detail
- - - - - -
determinePreferredLocales()method
-
-public static function determinePreferredLocales(want:Vector.<String>, have:Vector.<String>, keyword:String = "userinterface"):Vector.<String> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a list of acceptable locales based on a list of desired locales and a list of the locales that are currently available. -

The resulting list is sorted according in order of preference.

- -

Here is a typical use case for this method:

-
    -
  • A user specifies a list of languages that she understands - (stored in a user profile, a browser setting, or a cookie). - The user lists the languages that she understands best first, so the order of the languages in the list is relevant. - This list is the "want" list.
    • -
  • The application is localized into a number of different languages. - This list is the "have" list.
    • -
  • The determinePreferredLocales() method returns an intersection of the two lists, sorted so that the - user's preferred languages come first.
    • -
-

If this feature is not supported on the current operating system, this method returns a null value.

-

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Parameters - - - - - - - - - - - - - - - - -
want:Vector.<String> — A list of the user's preferred locales sorted in order of preference. -
 
have:Vector.<String> — A list of locales available to the application. The order of this list is not important. -
 
keyword:String (default = "userinterface") — A keyword to use to help determine the best fit. - -
-

-Returns - - - - -
Vector.<String> — A subset of the available locales, sorted according to the user's preferences. - -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getKeysAndValues()method 
-
-public function getKeysAndValues():Object -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns an object containing all of the key and value pairs from the LocaleID object. - -

The returned object is structured as a hash table or associative array, where each property name represents a key - and the value of the property is value for that key. For example, the following code lists all of the keys and values - obtained from the LocaleID object using the getKeysAndValues() method:

- 
-		 var myLocale:LocaleID = new LocaleID("fr-CA");
-		 var localeData:Object = myLocale.getKeysAndValues();
-		 for (var propertyName:String in localeData)
-		 {
-		   trace(propertyName + " = " + localeData[propertyName]);
-		 }
-
- -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

-Returns - - - - -
Object — - An Object containing all the keys and values in the LocaleID object, structured as an associative array or hashtable. - - - -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getLanguage()method 
-
-public function getLanguage():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns the language code specified by the locale ID name. - -

If the locale name cannot be properly parsed then the language code is the same as the full locale name.

-

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

-Returns - - - - -
String — - A two-character language code obtained by parsing the locale ID name. - - - -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getRegion()method 
-
-public function getRegion():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns the region code specified by the locale ID name. -

This method returns an empty string if the region code cannot be parsed or guessed - This could occur if an unknown or incomplete locale ID name like "xy" is used. - The region code is not validated against a fixed list. For example, the region code returned for a locale ID name of - "xx-YY" is "YY".

-

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

If the region is not part of the specified locale name, the most likely region code for the locale is "guessed" and - lastOperationStatus property is set to LastOperationStatus.USING_FALLBACK_WARNING

-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

-Returns - - - - -
String — - A two-character region code, or an empty string if the region code cannot be parsed or otherwise - determined from the locale name. - - - -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getScript()method 
-
-public function getScript():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns the script code specified by the locale ID name. -

This method returns an empty string if the script code cannot be parsed or guessed - This could occur if an unknown or incomplete locale ID name like "xy" is used. - The script code is not validated against a fixed list. For example, the script code returned for a locale ID name of - "xx-Abcd-YY" is "Abcd".

-

The region, as well as the language, can also affect the return value. For example, the script code for "mn-MN" - (Mongolian-Mongolia) is "Cyrl" (Cyrillic), while the script code for "mn-CN" (Mongolian-China) is - "Mong" (Mongolian).

- -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

If the script code is not part of the specified locale name, the most likely script code is "guessed" and - lastOperationStatus property is set to LastOperationStatus.USING_FALLBACK_WARNING.

-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- -

-Returns - - - - -
String — - A four-character script code, or an empty string if the script code cannot be parsed or otherwise - determined from the locale name. - - - -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getVariant()method 
-
-public function getVariant():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns the language variant code specified by the locale ID name. -

This method returns an empty string if there is no language variant code in the given locale ID name. - (No guessing is necessary because few locales have or need a language variant.)

- -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

-Returns - - - - -
String — - A language variant code, or an empty string if the locale ID name does not contain a language variant code. - - - -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
isRightToLeft()method 
-
-public function isRightToLeft():Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whtehr the text direction for the specified locale is right to left. - -

The result can be used to determine the direction of the text in the Flash text engine, - and to decide whether to mirror the user interface to support the current text direction.

-

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

-Returns - - - - -
Boolean — - true if the general text flows in a line of text should go from right to left; otherwise false; - - - -
-

-See also -

-
flashx.textLayout.formats.Direction
-lastOperationStatus -
-LastOperationStatus -
-
- -
Constant detail
- - - - - -
DEFAULTconstant
-
-public static const DEFAULT:String = "i-default" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the user's default linguistic preferences should be used, as specified in the user's operating system settings. - For example, such preferences are typically set using the "Control Panel" for Windows, or the "System Preferences" in Mac OS X. -

Using the LocaleID.DEFAULT setting can result in the use of a different locale ID name for different - kinds of operations. For example, one locale could be used for sorting and a different one for formatting. - This flexibility respects the user preferences, and the class behaves this way by design.

-

This locale identifier is not always the most appropriate one to use. - For applications running in the browser, the browser's preferred locale could be a better choice. - It is often a good idea to let the user alter the preferred locale ID name setting and preserve that preference - in a user profile, cookie, or shared object.

-
- -
Examples
-
examples\LocaleID
-
The following example shows how to retrieve and display information about LocaleID strings - for different locales. -

- This example uses the following locales: Arabic (Saudi Arabia), English (US), English (US, POSIX variant), Chinese (PRC), - Chinese (Taiwan), Chinese (Simplified Han Script), Chinese (PRC with several keys and values) -

-

- The example does the following for each locale in the list: -

-
    -
  1. Creates a new LocaleID object.
    2. -
  2. Displays various properties of the LocaleID. The values shown will differ based on your operating system and user preferences.
    3. -
  3. Displays the full set of keys and values for the LocaleID.
    4. -
-
-
-package 
-{
-    import flash.display.Sprite;
-    import flash.globalization.LocaleID;
-    
-    public class LocaleIDExample extends Sprite
-    {
-        public function LocaleIDExample()
-        {
-            var localeNames:Array = ["ar-SA", "EN_us", "en-US-POSIX", "zh-CH", "zh-TW", "zh-Hans", "zh-CH@collation=pinyin;calendar=chinese;currency=RMB"];
-            
-            for ( var i:int = 0; i < localeNames.length; i++ ) 
-            {
-                var locID:LocaleID = new LocaleID( localeNames[i] as String );
-                
-                trace('\n\n' + "LocaleID requested: " + locID.requestedLocaleIDName 
-                    + "; actual: " + locID.actualLocaleIDName);
-                trace( "Last Operation Status after new LocaleID: " + locID.lastOperationStatus);
-                
-                trace("name:     " + locID.name);
-                trace("language: " + locID.getLanguage() + "; status: "  + locID.lastOperationStatus);
-                trace("script:   " + locID.getScript()  +  "; status: "  + locID.lastOperationStatus);
-                trace("region:   " + locID.getRegion()  +  "; status: "  + locID.lastOperationStatus);
-                trace("variant:  " + locID.getVariant()  + "; status: "  + locID.lastOperationStatus);
-                trace("isRightToLeft: ", locID.isRightToLeft(), "; status: "  + locID.lastOperationStatus);
-                
-                var keysAndValues:Object = locID.getKeysAndValues();
-                var key:String;
-                for (key in keysAndValues)
-                {
-                    trace("key: ", key + " value: " + keysAndValues[ key ]);
-                }
-                trace( "Last Operation Status after getKeysAndValues(): " + locID.lastOperationStatus);
-            }
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/NationalDigitsType.html b/html-docs/flash/globalization/NationalDigitsType.html deleted file mode 100644 index ba7e128..0000000 --- a/html-docs/flash/globalization/NationalDigitsType.html +++ /dev/null @@ -1,1106 +0,0 @@ - - - - - - - - -flash.globalization.NationalDigitsType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class NationalDigitsType
InheritanceNationalDigitsType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

- The NationalDigitsType class enumerates constants that indicate digit sets used by the NumberFormatter class. - The value of each constant represents the Unicode value for the zero digit in the specified decimal digit set. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ARABIC_INDIC : uint = 0x0660
[static] - Represents the Unicode value for the zero digit of the Arabic-Indic digit set.
-		NationalDigitsType
  BALINESE : uint = 0x1B50
[static] - Represents the Unicode value for the zero digit of the Balinese digit set.
-		NationalDigitsType
  BENGALI : uint = 0x09E6
[static] - Represents the Unicode value for the zero digit of the Bengali digit set.
-		NationalDigitsType
  CHAM : uint = 0xAA50
[static] - Represents the Unicode value for the zero digit of the Cham digit set.
-		NationalDigitsType
  DEVANAGARI : uint = 0x0966
[static] - Represents the Unicode value for the zero digit of the Devanagari digit set.
-		NationalDigitsType
  EUROPEAN : uint = 0x0030
[static] - Represents the Unicode value for the zero digit of the Latin-1 (European) digit set.
-		NationalDigitsType
  EXTENDED_ARABIC_INDIC : uint = 0x06F0
[static] - Represents the Unicode value for the zero digit of the Extended Arabic-Indic digit set.
-		NationalDigitsType
  FULL_WIDTH : uint = 0xFF10
[static] - Represents the Unicode value for the zero digit of the Fullwidth digit set.
-		NationalDigitsType
  GUJARATI : uint = 0x0AE6
[static] - Represents the Unicode value for the zero digit of the Gujarati digit set.
-		NationalDigitsType
  GURMUKHI : uint = 0x0A66
[static] - Represents the Unicode value for the zero digit of the Gurmukhi digit set.
-		NationalDigitsType
  KANNADA : uint = 0x0CE6
[static] - Represents the Unicode value for the zero digit of the Kannada digit set.
-		NationalDigitsType
  KAYAH_LI : uint = 0xA900
[static] - Represents the Unicode value for the zero digit of the Kayah Li digit set.
-		NationalDigitsType
  KHMER : uint = 0x17E0
[static] - Represents the Unicode value for the zero digit of the Khmer digit set.
-		NationalDigitsType
  LAO : uint = 0x0ED0
[static] - Represents the Unicode value for the zero digit of the Lao digit set.
-		NationalDigitsType
  LEPCHA : uint = 0x1C40
[static] - Represents the Unicode value for the zero digit of the Lepcha digit set.
-		NationalDigitsType
  LIMBU : uint = 0x1946
[static] - Represents the Unicode value for the zero digit of the Limbu digit set.
-		NationalDigitsType
  MALAYALAM : uint = 0x0D66
[static] - Represents the Unicode value for the zero digit of the Malayalam digit set.
-		NationalDigitsType
  MONGOLIAN : uint = 0x1810
[static] - Represents the Unicode value for the zero digit of the Mongolian digit set.
-		NationalDigitsType
  MYANMAR : uint = 0x1040
[static] - Represents the Unicode value for the zero digit of the Myanmar digit set.
-		NationalDigitsType
  MYANMAR_SHAN : uint = 0x1090
[static] - Represents the Unicode value for the zero digit of the Myanmar Shan digit set.
-		NationalDigitsType
  NEW_TAI_LUE : uint = 0x19D0
[static] - Represents the Unicode value for the zero digit of the New Tai Lue digit set.
-		NationalDigitsType
  NKO : uint = 0x07C0
[static] - Represents the Unicode value for the zero digit of the Nko digit set.
-		NationalDigitsType
  OL_CHIKI : uint = 0x1C50
[static] - Represents the Unicode value for the zero digit of the Ol Chiki digit set.
-		NationalDigitsType
  ORIYA : uint = 0x0B66
[static] - Represents the Unicode value for the zero digit of the Oriya digit set.
-		NationalDigitsType
  OSMANYA : uint = 0x104A0
[static] - Represents the Unicode value for the zero digit of the Osmanya digit set.
-		NationalDigitsType
  SAURASHTRA : uint = 0xA8D0
[static] - Represents the Unicode value for the zero digit of the Saurashtra digit set.
-		NationalDigitsType
  SUNDANESE : uint = 0x1BB0
[static] - Represents the Unicode value for the zero digit of the Sundanese digit set.
-		NationalDigitsType
  TAMIL : uint = 0x0BE6
[static] - Represents the Unicode value for the zero digit of the Tamil digit set.
-		NationalDigitsType
  TELUGU : uint = 0x0C66
[static] - Represents the Unicode value for the zero digit of the Telugu digit set.
-		NationalDigitsType
  THAI : uint = 0x0E50
[static] - Represents the Unicode value for the zero digit of the Thai digit set.
-		NationalDigitsType
  TIBETAN : uint = 0x0F20
[static] - Represents the Unicode value for the zero digit of the Tibetan digit set.
-		NationalDigitsType
  VAI : uint = 0xA620
[static] - Represents the Unicode value for the zero digit of the Vai digit set.
-		NationalDigitsType
-
- -
- -
Constant detail
- - - - - -
ARABIC_INDICconstant
-
-public static const ARABIC_INDIC:uint = 0x0660 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

- Represents the Unicode value for the zero digit of the Arabic-Indic digit set. -

- - - - - -
BALINESEconstant 
-
-public static const BALINESE:uint = 0x1B50 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Balinese digit set. -

- - - - - -
BENGALIconstant 
-
-public static const BENGALI:uint = 0x09E6 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Bengali digit set. -

- - - - - -
CHAMconstant 
-
-public static const CHAM:uint = 0xAA50 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Cham digit set. -

- - - - - -
DEVANAGARIconstant 
-
-public static const DEVANAGARI:uint = 0x0966 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

- Represents the Unicode value for the zero digit of the Devanagari digit set. -

- - - - - -
EUROPEANconstant 
-
-public static const EUROPEAN:uint = 0x0030 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

- Represents the Unicode value for the zero digit of the Latin-1 (European) digit set. -

- - - - - -
EXTENDED_ARABIC_INDICconstant 
-
-public static const EXTENDED_ARABIC_INDIC:uint = 0x06F0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

- Represents the Unicode value for the zero digit of the Extended Arabic-Indic digit set. -

- - - - - -
FULL_WIDTHconstant 
-
-public static const FULL_WIDTH:uint = 0xFF10 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Fullwidth digit set. -

- - - - - -
GUJARATIconstant 
-
-public static const GUJARATI:uint = 0x0AE6 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Gujarati digit set. -

- - - - - -
GURMUKHIconstant 
-
-public static const GURMUKHI:uint = 0x0A66 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Gurmukhi digit set. -

- - - - - -
KANNADAconstant 
-
-public static const KANNADA:uint = 0x0CE6 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Kannada digit set. -

- - - - - -
KAYAH_LIconstant 
-
-public static const KAYAH_LI:uint = 0xA900 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Kayah Li digit set. -

- - - - - -
KHMERconstant 
-
-public static const KHMER:uint = 0x17E0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Khmer digit set. -

- - - - - -
LAOconstant 
-
-public static const LAO:uint = 0x0ED0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Lao digit set. -

- - - - - -
LEPCHAconstant 
-
-public static const LEPCHA:uint = 0x1C40 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Lepcha digit set. -

- - - - - -
LIMBUconstant 
-
-public static const LIMBU:uint = 0x1946 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Limbu digit set. -

- - - - - -
MALAYALAMconstant 
-
-public static const MALAYALAM:uint = 0x0D66 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Malayalam digit set. -

- - - - - -
MONGOLIANconstant 
-
-public static const MONGOLIAN:uint = 0x1810 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Mongolian digit set. -

- - - - - -
MYANMARconstant 
-
-public static const MYANMAR:uint = 0x1040 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Myanmar digit set. -

- - - - - -
MYANMAR_SHANconstant 
-
-public static const MYANMAR_SHAN:uint = 0x1090 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Myanmar Shan digit set. -

- - - - - -
NEW_TAI_LUEconstant 
-
-public static const NEW_TAI_LUE:uint = 0x19D0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the New Tai Lue digit set. -

- - - - - -
NKOconstant 
-
-public static const NKO:uint = 0x07C0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

- Represents the Unicode value for the zero digit of the Nko digit set. -

- - - - - -
OL_CHIKIconstant 
-
-public static const OL_CHIKI:uint = 0x1C50 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Ol Chiki digit set. -

- - - - - -
ORIYAconstant 
-
-public static const ORIYA:uint = 0x0B66 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Oriya digit set. -

- - - - - -
OSMANYAconstant 
-
-public static const OSMANYA:uint = 0x104A0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Osmanya digit set. -

- - - - - -
SAURASHTRAconstant 
-
-public static const SAURASHTRA:uint = 0xA8D0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Saurashtra digit set. -

- - - - - -
SUNDANESEconstant 
-
-public static const SUNDANESE:uint = 0x1BB0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Sundanese digit set. -

- - - - - -
TAMILconstant 
-
-public static const TAMIL:uint = 0x0BE6 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Tamil digit set. -

- - - - - -
TELUGUconstant 
-
-public static const TELUGU:uint = 0x0C66 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Telugu digit set. -

- - - - - -
THAIconstant 
-
-public static const THAI:uint = 0x0E50 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Thai digit set. -

- - - - - -
TIBETANconstant 
-
-public static const TIBETAN:uint = 0x0F20 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Tibetan digit set. -

- - - - - -
VAIconstant 
-
-public static const VAI:uint = 0xA620 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Represents the Unicode value for the zero digit of the Vai digit set. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/NumberFormatter.html b/html-docs/flash/globalization/NumberFormatter.html deleted file mode 100644 index 960c55e..0000000 --- a/html-docs/flash/globalization/NumberFormatter.html +++ /dev/null @@ -1,1914 +0,0 @@ - - - - - - - - -flash.globalization.NumberFormatter (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class NumberFormatter
InheritanceNumberFormatter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The NumberFormatter class provides locale-sensitive formatting and parsing of numeric values. It can format int, - uint, and Number objects. -

The NumberFormatter class uses the data and functionality provided by the operating system - and is designed to format numbers according to the conventions - of a specific locale, based on the user's preferences and features supported by the user's operating system. - The position of the negative symbol, the decimal separator, - the grouping separator, the grouping pattern, and other elements within the number format can vary depending on the locale.

-

If the operating system supports the requested locale, the number formatting properties - are set according to the conventions and defaults of the requested locale. - If the requested locale is not available, then the properties are set according to - a fallback or default system locale, which can be retrieved using the actualLocaleIDName property. -

-

- Due to the use of the user's settings, the use of formatting patterns - provided by the operating system, and the use of a fallback locale when a requested locale is not supported, - different users can see different formatting results, even when using the same locale ID. -

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  actualLocaleIDName : String -
[read-only] - The name of the actual locale ID used by this NumberFormatter object.
-		NumberFormatter
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  decimalSeparator : String -
- The decimal separator character used for formatting or parsing numbers that have a decimal part.
-		NumberFormatter
  digitsType : uint -
- Defines the set of digit characters to be used when formatting numbers.
-		NumberFormatter
  fractionalDigits : int -
- The maximum number of digits that can appear after the decimal separator.
-		NumberFormatter
  groupingPattern : String -
- Describes the placement of grouping separators within the formatted number string.
-		NumberFormatter
  groupingSeparator : String -
- The character or string used for the grouping separator.
-		NumberFormatter
  lastOperationStatus : String -
[read-only] - The status of previous operation that this NumberFormatter object performed.
-		NumberFormatter
  leadingZero : Boolean -
- Specifies whether a leading zero is included in a formatted number when there are no integer digits - to the left of the decimal separator.
-		NumberFormatter
  negativeNumberFormat : uint -
- A numeric value that indicates a formatting pattern for negative numbers.
-		NumberFormatter
  negativeSymbol : String -
- The negative symbol to be used when formatting negative values.
-		NumberFormatter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  requestedLocaleIDName : String -
[read-only] - The name of the requested locale ID that was passed to the constructor of this NumberFormatter object.
-		NumberFormatter
  trailingZeros : Boolean -
- Specifies whether trailing zeros are included in a formatted number.
-		NumberFormatter
  useGrouping : Boolean -
- Enables the use of the grouping separator when formatting numbers.
-		NumberFormatter
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NumberFormatter(requestedLocaleIDName:String)
-
- Constructs a new NumberFormatter object to format numbers according to - the conventions of a given locale.
-		NumberFormatter
   -
-formatInt(value:int):String -
-
- Formats an int value.
-		NumberFormatter
   -
-formatNumber(value:Number):String -
-
- Formats a Number value.
-		NumberFormatter
   -
-formatUint(value:uint):String -
-
- Formats a uint value.
-		NumberFormatter
   -
-getAvailableLocaleIDNames():Vector.<String>
-
[static] - Lists all of the locale ID names supported by this class.
-		NumberFormatter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-parse(parseString:String):NumberParseResult -
-
- Parses a string and returns a NumberParseResult object containing the parsed elements.
-		NumberFormatter
   -
-parseNumber(parseString:String):Number -
-
- Parses a string that contains only digits and optional whitespace characters and returns a Number.
-		NumberFormatter
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
actualLocaleIDNameproperty
-
-actualLocaleIDName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the actual locale ID used by this NumberFormatter object. -

There are three possibilities for the value of the name, depending on operating system and the - value of the requestedLocaleIDName parameter passed to the Collator() constructor.

-
    -
  1. If the requested locale was not LocaleID.DEFAULT and - the operating system provides support for the requested locale, - then the name returned is the same as the requestedLocaleIDName property. -
    2. - -
  2. If LocaleID.DEFAULT was used as the value for the requestedLocaleIDName - parameter to the constructor, then the name of the current locale specified by the user's operating system is - used. The LocaleID.DEFAULT value preserves user's customized setting in the OS. - Passing an explicit value as the requestedLocaleIDName parameter does not necessarily give the - same result as using the LocaleID.DEFAULT even if the two locale ID names are the same. - The user could have customized the locale settings on their machine, and by requesting an - explicit locale ID name rather than using LocaleID.DEFAULT your application would not - retrieve those customized settings. -
    -

    For example:

    - 
    -         var fmt:NumberFormatter = new NumberFormatter(LocaleID.DEFAULT);
-		 var aliName:String = fmt.actualLocaleIDName;
-
    -

    In the above example, aliName is the name of the locale corresponding to - the user's current operating systems settings (e.g. "it-IT" if the user's locale is set to Italian-Italy), - and not "i-default" (the name of the LocaleID.DEFAULT locale).

    -
    3. -
  3. If the system does not support the requestedLocaleIDName specified in the constructor - then a fallback locale ID name is provided. -
    -

    For Example:

    - 
    	 	 
-         var fmt:NumberFormatter = new NumberFormatter("fr-CA"); 	 
-         var aliName:String = fmt.actualLocaleIDName;
-
    -

    Assuming that the operating system in the example above does not support the "fr-CA" (French-Canada) locale ID, - a fallback is used. In this case the fallback locale ID is "fr-FR" (French-France).

    -
    4. -
- Implementation -
-    public function get actualLocaleIDName():String -
-

-See also -

-
-LocaleID -
-requestedLocaleIDName -
-NumberFormatter() -
-
- - - - - -
decimalSeparatorproperty 
-
-decimalSeparator:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The decimal separator character used for formatting or parsing numbers that have a decimal part. -

This property is initially set based on the locale that is selected when the formatter object - is constructed.

-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the locale and operating system..

-Implementation -
-    public function get decimalSeparator():String -
-    public function set decimalSeparator(value:String):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-formatInt() -
-formatNumber() -
-formatUInt() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
digitsTypeproperty 
-
-digitsType:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Defines the set of digit characters to be used when formatting numbers. -

Different languages and regions use different sets of characters to represent the - digits 0 through 9. This property defines the set of digits to be used.

-

The value of this property represents the Unicode value for the zero digit of a decimal digit set. - The valid values for this property are defined in the NationalDigitsType class.

- -

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the locale and operating system..

-Implementation -
-    public function get digitsType():uint -
-    public function set digitsType(value:uint):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-NationalDigitsType -
-
- - - - - -
fractionalDigitsproperty 
-
-fractionalDigits:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The maximum number of digits that can appear after the decimal separator. - -

Numbers are rounded to the number of digits specified by this property. The rounding scheme - varies depending on the user's operating system.

- -

When the trailingZeros property is set to true, the fractional portion of the - number (after the decimal point) is padded with trailing zeros until its length matches the value of this - fractionalDigits property.

-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is 0.

-Implementation -
-    public function get fractionalDigits():int -
-    public function set fractionalDigits(value:int):void -
-

-See also -

-
-trailingZeros -
-lastOperationStatus -
-flash.globalization.LastOperationStatus -
-
- - - - - -
groupingPatternproperty 
-
-groupingPattern:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Describes the placement of grouping separators within the formatted number string. -

When the useGrouping property is set to true, the groupingPattern property is used - to define the placement and pattern used for the grouping separator.

-

The grouping pattern is defined as a string containing numbers separated by semicolons and optionally may end - with an asterisk. For example: "3;2;*". Each number in the string represents the number of digits - in a group. The grouping separator is placed before each group of digits. An asterisk at the end of the string - indicates that groups with that number of digits should be repeated for the rest of the formatted string. - If there is no asterisk then there are no additional groups or separators for the rest of the formatted string.

- -

The first number in the string corresponds to the first group of digits to the left of the decimal separator. - Subsequent numbers define the number of digits in subsequent groups to the left. Thus the string "3;2;*" - indicates that a grouping separator is placed after the first group of 3 digits, followed by groups of 2 digits. - For example: 98,76,54,321

- -

The following table shows examples of formatting the number 123456789.12 with various grouping patterns. - The grouping separator is a comma and the decimal separator is a period. -

- - - - - - - - - - - - - - - - - -
Grouping PatternSample Format
3;*123,456,789.12
3;2;*12,34,56,789.12
3123456,789.12
- -

Only a limited number of grouping sizes can be defined. On some operating systems, grouping patterns can only contain - two numbers plus an asterisk. Other operating systems can support up to four numbers and an asterisk. - For patterns without an asterisk, some operating systems only support one number while others support up to three numbers. - If the maximum number of grouping pattern elements is exceeded, then additional elements - are ignored and the lastOperationStatus property is set as described below. -

-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Implementation -
-    public function get groupingPattern():String -
-    public function set groupingPattern(value:String):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. - -
-

-See also -

-
-groupingSeparator -
-useGrouping -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
groupingSeparatorproperty 
-
-groupingSeparator:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The character or string used for the grouping separator. -

The value of this property is used as the grouping separator when formatting numbers with the - useGrouping property set to true. This - property is initially set based on the locale that is selected when the formatter object - is constructed.

-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the locale and operating system..

-Implementation -
-    public function get groupingSeparator():String -
-    public function set groupingSeparator(value:String):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-formatInt() -
-formatNumber() -
-formatUInt() -
-useGrouping -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
lastOperationStatusproperty 
-
-lastOperationStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The status of previous operation that this NumberFormatter object performed. - The lastOperationStatus property is set whenever the constructor or a method of - this class is called, or another property is set. For the possible values see the description for each method. -

Implementation -
-    public function get lastOperationStatus():String -
-

-See also -

-
-LastOperationStatus -
-
- - - - - -
leadingZeroproperty 
-
-leadingZero:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether a leading zero is included in a formatted number when there are no integer digits - to the left of the decimal separator. - -

When this property is set to true a leading zero is included to the left of the decimal separator - when formatting numeric values between -1.0 and 1.0. - When this property is set to false a leading zero is not included.

-

For example if the number is 0.321 and this property is set true, then the leading - zero is included in the formatted string. If the property is set to false, the leading zero - is not included. In that case the string would just include the decimal separator followed by the decimal digits, - like .321.

- -

The following table shows examples of how numbers are formatted based on the values of this property and - the related fractionalDigits and trailingZeros properties. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
trailingZerosleadingZerofractionalDigits0.120
truetrue30.1200.000
falsetrue30.120
truefalse3.120.000
falsefalse3.120
-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the locale and operating system..

-Implementation -
-    public function get leadingZero():Boolean -
-    public function set leadingZero(value:Boolean):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-formatInt() -
-formatNumber() -
-formatUInt() -
-trailingZeros -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
negativeNumberFormatproperty 
-
-negativeNumberFormat:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A numeric value that indicates a formatting pattern for negative numbers. - This pattern defines the location of the negative symbol - or parentheses in relation to the numeric portion of the formatted number. - -

The following table summarizes the possible formats for negative numbers. When a negative number is formatted, - the minus sign in the format is replaced with the value of - the negativeSymbol property and the 'n' character is replaced with the formatted numeric value.

- - - - - - - - - - - - - - - - - - - - - - - - - - -
Negative number format typeFormat
0(n)
1-n
2- n
3n-
4n -
-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the locale and operating system..

-Implementation -
-    public function get negativeNumberFormat():uint -
-    public function set negativeNumberFormat(value:uint):void -
-
-Throws -
- - - - -
ArgumentError — if the assigned value is not a number between 0 and 4. - -
-

-See also -

-
-negativeSymbol -
-formatInt() -
-formatNumber() -
-formatUInt() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
negativeSymbolproperty 
-
-negativeSymbol:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The negative symbol to be used when formatting negative values. -

This symbol is used with the negative number - format when formatting a number that is less than zero. It is not used in negative number formats that do not include - a negative sign (e.g. when negative numbers are enclosed in parentheses).

-

This property is set to a default value for the actual locale selected when this - formatter is constructed. It can be set with a value to override the default setting.

-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Implementation -
-    public function get negativeSymbol():String -
-    public function set negativeSymbol(value:String):void -
-
-Throws -
- - - - -
Error — if the system cannot allocate enough internal memory. -
-

-See also -

-
-negativeNumberFormat -
-formatInt() -
-formatNumber() -
-formatUInt() -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
requestedLocaleIDNameproperty 
-
-requestedLocaleIDName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the requested locale ID that was passed to the constructor of this NumberFormatter object. - -

If the LocaleID.DEFAULT value was used then the name returned is "i-default". - The actual locale used can differ from the requested locale when a fallback locale is applied. - The name of the actual locale can be retrieved using the actualLocaleIDName property. -

- Implementation -
-    public function get requestedLocaleIDName():String -
-

-See also -

-
-LocaleID -
-actualLocaleIDName -
-NumberFormatter() -
-
- - - - - -
trailingZerosproperty 
-
-trailingZeros:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether trailing zeros are included in a formatted number. -

When this property is set to true, trailing zeros are included in the fractional part - of the formatted number up to the limit specified by the fractionalDigits property. - When this property is set to false then no trailing zeros are shown.

-

For example if the numeric value is 123.4, and this property is set true, and the fractionalDigits property - is set to 3, the formatted string would show trailing zeros, like 123.400 . - If this property is false, trailing zeros are not included, and the string shows just the decimal - separator followed by the non-zero decimal digits, like 123.4 .

-

The following table shows examples of how numeric values are formatted based on the values of this property and - the related fractionalDigits and leadingZero properties. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
trailingZerosleadingZerofractionalDigits0.120
truetrue30.1200.000
falsetrue30.120
truefalse3.120.000
falsefalse3.120
-

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

The default value is dependent on the locale and operating system..

-Implementation -
-    public function get trailingZeros():Boolean -
-    public function set trailingZeros(value:Boolean):void -
-
-Throws -
- - - - -
TypeError — if this property is assigned a null value. -
-

-See also -

-
-leadingZero -
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
useGroupingproperty 
-
-useGrouping:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Enables the use of the grouping separator when formatting numbers. -

When the useGrouping property is set to true, digits are grouped and - delimited by the grouping separator character. - For example: 123,456,789.22

-

When the useGrouping property is set to false, digits are not grouped or separated. - For example: 123456789.22

- -

The symbol to be used as a grouping separator is defined by the groupingSeparator property. The number of digits - between grouping separators is defined by the groupingPattern property.

- -

When this property is assigned a value and there are no errors or warnings, the lastOperationStatus property - is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Implementation -
-    public function get useGrouping():Boolean -
-    public function set useGrouping(value:Boolean):void -
-

-See also -

-
-groupingPattern -
-groupingSeparator -
-lastOperationStatus -
-LastOperationStatus -
-
- -
Constructor detail
- - - - - -
NumberFormatter()constructor
-
-public function NumberFormatter(requestedLocaleIDName:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs a new NumberFormatter object to format numbers according to - the conventions of a given locale. -

This constructor determines if the current operating system supports the requested locale ID name. - If it is not supported then a fallback locale is used instead. - If a fallback locale is used then the the lastOperationStatus property - indicates the type of fallback, and the actualLocaleIDName property contains - the name of the fallback locale ID.

-

To format based on the user's current operating system preferences, pass the value LocaleID.DEFAULT - in the requestedLocaleIDName parameter to the constructor. -

-

When the constructor completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

When the requested locale ID name is not available then the lastOperationStatus - is set to one of the following:

-
    -
  • LastOperationStatus.USING_FALLBACK_WARNING
    • -
  • LastOperationStatus.USING_DEFAULT_WARNING
    • -
-

If this class is not supported on the current operating system, then the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.UNSUPPORTED_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in - the LastOperationStatus class.

-

For details on the warnings listed above and other possible values of the - lastOperationStatus property see the descriptions in the LastOperationStatus class.

- - Parameters - - - - -
requestedLocaleIDName:String — The preferred locale ID name to use when determining number formats. -
-
-Throws - - - - -
TypeError — if the requestedLocaleIDName is null - -
-

-See also -

-
-LocaleID -
-requestedLocaleIDName -
-actualLocaleIDName -
-lastOperationStatus -
-LastOperationStatus -
-
- -
Method detail
- - - - - -
formatInt()method
-
-public function formatInt(value:int):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Formats an int value. - This function is equivalent to the formatNumber() method except that it takes an int value. - If the value passed in is too large or small, such as a value greater than 1.72e308 or less than 1.72e-308, then this function returns 0. - -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Parameters - - - - -
value:int — int value to format. -
-

-Returns - - - - -
String — - A formatted number string. - - -
-
-Throws - - - - -
Error — for any internal memory allocation problems. -
-

-See also -

-
-lastOperationStatus -
-flash.globalization.LastOperationStatus -
-
- - - - - -
formatNumber()method 
-
-public function formatNumber(value:Number):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Formats a Number value. -

This function formats the number based on the property values of the formatter. If the properties are - not modified after the the numberFormatter object is created, the numbers are formatted - according to the locale specific conventions provided by the operating system for the locale identified - by actualLocaleIDName. To customize the format, the properties can be altered to control specific - aspects of formatting a number. -

- -

Very large numbers and very small magnitude numbers can be formatted with this function. However, the - number of significant digits is limited to the precision provided by the Number object. Scientific notation - is not supported. -

- - -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Parameters - - - - -
value:Number — Number value to format. -
-

-Returns - - - - -
String — - A formatted number string. - - - -
-
-Throws - - - - -
Error — if there are any internal memory allocation problems. -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
formatUint()method 
-
-public function formatUint(value:uint):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Formats a uint value. - This function is equivalent to the formatNumber() method except that it takes a uint. - If the value passed in is too large, such as a value greater than 1.72e308, then this function returns 0. -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Parameters - - - - -
value:uint — uint value. -
-

-Returns - - - - -
String — - A formatted number string. - - -
-
-Throws - - - - -
Error — if there are any internal memory allocation problems. -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
getAvailableLocaleIDNames()method 
-
-public static function getAvailableLocaleIDNames():Vector.<String> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Lists all of the locale ID names supported by this class. - -

If this class is not supported on the current operating system, this method returns a null value.

-

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

-Returns - - - - -
Vector.<String> — A vector of strings containing all of the locale ID names supported by this class. - -
-
- - - - - -
parse()method 
-
-public function parse(parseString:String):NumberParseResult -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Parses a string and returns a NumberParseResult object containing the parsed elements. - -

The NumberParseResult object contains - the value of the first number found in the input string, the starting index for the number within the string, and the index - of the first character after the number in the string.

- -

If the string does not contain a number, the value property of the NumberParseResult is set to NaN and the - startIndex and endIndex properties are set to the hexadecimal value 0x7fffffff. -

- -

This function uses the value of the decimalSeparator property to determine the portion of the number - that contains fractional - digits, and the groupingSeparator property to determine which characters are allowed within the digits of a number, - and the negativeNumberFormat property to control how negative values are represented.

- -

The following table identifies the result of strings parsed for the various NegativeNumberFormat values:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NegativeNumberFormatInput StringResult
(n)"(123)" or "( 123 )""-123"
-n"-123" or "- 123""-123"
- n"-123" or "- 123""-123"
n-"123-" or "123 -""-123"
n -"123-" or "123 -""-123"
- -

A single white space is allowed between the number and the minus sign or parenthesis.

- -

Other properties are ignored when determining a valid number. Specifically the value of the - digitsType property is ignored and the digits can be from any of - the digit sets that are enumerated in the NationalDigitsType class. The values of the groupingPattern - and useGrouping properties do not influence the parsing of the number. -

- -

If numbers are preceded or followed in the string by a plus sign '+', the plus sign is treated as - a character that is not part of the number. -

- -

This function does not parse strings containing numbers in scientific notation (e.g. 1.23e40).

-

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- Parameters - - - - -
parseString:String
-

-Returns - - - - -
NumberParseResult
-
-Throws - - - - -
TypeError — if the parseString is null -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-NumberParseResult -
-parseNumber() -
parseFloat()
-NationalDigitsType -
-
-Example -

-
- - - - - -
parseNumber()method 
-
-public function parseNumber(parseString:String):Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Parses a string that contains only digits and optional whitespace characters and returns a Number. - If the string does not begin - with a number or contains characters other than whitespace that are not part of the number, then - this method returns NaN. White space before or after the numeric digits is ignored. A white space - character is a character that has a Space Separator (Zs) property in the Unicode Character Database (see http://www.unicode.org/ucd/). - -

If the numeric digit is preceded or followed by a plus sign '+' it is treated as a non-whitespace character. - The return value is NaN. -

- -

See the description of the parse function for more information about number parsing and what constitutes - a valid number. -

-

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- - Parameters - - - - -
parseString:String
-

-Returns - - - - -
Number
-
-Throws - - - - -
TypeError — if the parseString is null -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-parse() -
parseFloat()
-NationalDigitsType -
-
- -
Examples
-
examples\NumberFormatterExample
-
This example shows how numbers can be formatted differently across different locales. - -

This example uses the following locales: default operating system locale for number formatting, Japanese (Japan), English (US), and - French (France). The example uses the static member LocaleID.DEFAULT to request the default operating system locale.

-

- The results from this example might differ based on your operating system and user preferences. -

-

- This example does the following for each locale in the list: -

-
    -
  1. Creates a NumberFormatter object.
    2. -
  2. Formats the same value as a Number, an integer, and an unsigned integer, and displays the results.
    3. -
-
-
- 
-package {
-    import flash.globalization.NumberFormatter;
-    import flash.globalization.LocaleID;
-    
-    public class NumberFormatterExample extends Sprite
-    {
-        public function NumberFormatterExample():void
-        {
-            var localeNames:Array = [LocaleID.DEFAULT,"ja_JP","en_US","fr_FR"];
-            
-            for ( var i:int = 0; i < localeNames.length; i++ ) 
-            {
-                var nf:NumberFormatter = new NumberFormatter( localeNames[i] as String );
-                trace('\n\n' + "LocaleID requested: " + nf.requestedLocaleIDName 
-                    + "; actual: " + nf.actualLocaleIDName);
-                trace( "Last Operation Status:" + nf.lastOperationStatus );   
-            
-                var numberString:String = nf.formatNumber(123456789.19); 
-                trace( "Formatted Number:" + numberString);
-                numberString = nf.formatInt(-123456789); 
-                trace( "Formatted Int:" + numberString);
-                numberString = nf.formatUint(123456789); 
-                trace( "Formatted UInt:" + numberString);
-            }
-        }
-    }
-}
-
-
-
examples\NumberFormatterParseExample
-
This example shows two different ways to parse an input string and extract a numeric value. -

- The results from this example might differ based on your operating system and user preferences. -

-

- This example does the following: -

-
    -
  1. Creates a NumberFormatter object.
    2. -
  2. Calls the NumberFormatter.parse() method to parse the string and return a NumberParseResult object.
    3. -
  3. Calls the NumberFormatter.parseNumber() method to parse the string and return a Number value.
    4. -
-
-
- 
-package {
-      import flash.globalization.NumberFormatter;
-      import flash.globalization.NumberParseResult;
-      import flash.globalization.LastOperationStatus;
-      import flash.globalization.LocaleID;
-
-      public class NumberFormatterParseExample
-      {
-            public function NumberFormatterParseExample():void
-            {
-                var nf:NumberFormatter = new NumberFormatter( "en_US" );
-                trace("LocaleID requested: " + nf.requestedLocaleIDName 
-                    + "; actual: " + nf.actualLocaleIDName);
-                trace( "Last Operation Status:" + nf.lastOperationStatus );  
-
-                var inputNumberString:String = "123,567,89,0.254";
-                var parseResult:NumberParseResult = nf.parse(inputNumberString);
-                if ( nf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
-                    trace("Parsed value:" + parseResult.value);
-                }
-                inputNumberString = "-123,567,89,0.254";
-                var parsedNumber:Number = nf.parseNumber(inputNumberString);
-                if ( nf.lastOperationStatus == LastOperationStatus.NO_ERROR ) {
-                    trace("Parsed value:" + parsedNumber);
-                }
-            }
-      }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/NumberParseResult.html b/html-docs/flash/globalization/NumberParseResult.html deleted file mode 100644 index 7aeb3e0..0000000 --- a/html-docs/flash/globalization/NumberParseResult.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - - - -flash.globalization.NumberParseResult (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class NumberParseResult
InheritanceNumberParseResult Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- A data structure that holds information about a number that was extracted by parsing a string. - -

The number string can contain a prefix and suffix surrounding a number. In such - cases the startIndex property is set to the first character of the number. - Also, the endIndex property - is set to the index of the character that follows the last character of the number. -

- -

-

-See also -

-
-NumberFormatter.parse() -
-NumberFormatter.parseNumber() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  endIndex : int -
[read-only] - The index of the character after the last character of the numeric portion of the input string.
-		NumberParseResult
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  startIndex : int -
[read-only] - The index of the first character of the numeric portion of the input string.
-		NumberParseResult
  value : Number -
[read-only] - The value of the numeric portion of the input string.
-		NumberParseResult
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NumberParseResult(value:Number, startIndex:int = 0x7fffffff, endIndex:int = 0x7fffffff)
-
- Constructs a number parse result object.
-		NumberParseResult
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
endIndexproperty
-
-endIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The index of the character after the last character of the numeric portion of the input string. -

Implementation -
-    public function get endIndex():int -
-
- - - - - -
startIndexproperty 
-
-startIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The index of the first character of the numeric portion of the input string. -

Implementation -
-    public function get startIndex():int -
-
- - - - - -
valueproperty 
-
-value:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The value of the numeric portion of the input string. -

Implementation -
-    public function get value():Number -
-
- -
Constructor detail
- - - - - -
NumberParseResult()constructor
-
-public function NumberParseResult(value:Number, startIndex:int = 0x7fffffff, endIndex:int = 0x7fffffff) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs a number parse result object. NumberParseResult objects are usually created by the - NumberFormatter.parse() and NumberFormatter.parseNumber() methods, rather - than by calling this constructor directly. - -

Parameters - - - - - - - - - - - - - - - - -
value:Number — The value of the numeric portion of the input string. -
 
startIndex:int (default = 0x7fffffff) — The index of the first character of the number in the input string. -
 
endIndex:int (default = 0x7fffffff) — The index of the character after the last character of the number in the input string. - -
-

-See also -

-
-NumberFormatter.parse() -
-NumberFormatter.parseNumber() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/StringTools.html b/html-docs/flash/globalization/StringTools.html deleted file mode 100644 index 920ba6a..0000000 --- a/html-docs/flash/globalization/StringTools.html +++ /dev/null @@ -1,763 +0,0 @@ - - - - - - - - -flash.globalization.StringTools (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.globalization
Classpublic final class StringTools
InheritanceStringTools Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The StringTools class provides locale-sensitive case conversion methods. -

In some situations the - conversion between uppercase and lowercase letters is not a simple mapping from one character - to another and instead requires language- or context-specific processing. For example:

-
    -
  • In Turkish and Azeri, - the uppercase of the dotted lowercase i is an uppercase dotted İ (U+0130). - Similarly the lowercase of a - dotless uppercase I, is a lowercase dotless ı (U+0131).
    • -
  • The lowercase sharp S, ß (U+00DF), used in German - is converted to uppercase double SS.
    • -
  • In Greek there are two representations of the - lowercase sigma, σ (U+03C3) and ς (U+03C2), which both convert to the single - uppercase sigma Σ (U+03A3).
    • -
-

- The toLowerCase() and toUpperCase() methods of this - class provide this special case conversion logic. -

-

- Due to the use of the user's settings, the use of case conversion rules - provided by the operating system, and the use of a fallback locale when a requested locale is not supported, - different users can see different case conversion results even when using the same locale ID. -

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  actualLocaleIDName : String -
[read-only] - The name of the actual locale ID used by this StringTools object.
-		StringTools
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  lastOperationStatus : String -
[read-only] - The status of the most recent operation that this StringTools object performed.
-		StringTools
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  requestedLocaleIDName : String -
[read-only] - The name of the requested locale ID that was passed to the constructor of this StringTools object.
-		StringTools
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StringTools(requestedLocaleIDName:String)
-
- Constructs a new StringTools object that provides case conversion and other utilities according to - the conventions of a given locale.
-		StringTools
   -
-getAvailableLocaleIDNames():Vector.<String>
-
[static] - Lists all of the locale ID names supported by this class.
-		StringTools
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toLowerCase(s:String):String -
-
- Converts a string to lowercase according to language conventions.
-		StringTools
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-toUpperCase(s:String):String -
-
- Converts a string to uppercase according to language conventions.
-		StringTools
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
actualLocaleIDNameproperty
-
-actualLocaleIDName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the actual locale ID used by this StringTools object. -

There are three possibilities for the value of the name, depending on operating system and the - value of the requestedLocaleIDName parameter passed to the StringTools() constructor.

- -
    -
  1. If the requested locale was not LocaleID.DEFAULT and - the operating system provides support for the requested locale, - then the name returned is the same as the requestedLocaleIDName property. -
    2. - -
  2. If LocaleID.DEFAULT was used as the value for the requestedLocaleIDName - parameter to the constructor, then the name of the current locale specified by the user's operating system is - used. The LocaleID.DEFAULT value preserves user's customized setting in the OS. - Passing an explicit value as the requestedLocaleIDName parameter does not necessarily give the - same result as using the LocaleID.DEFAULT even if the two locale ID names are the same. - The user could have customized the locale settings on the machine, and by requesting an - explicit locale ID name rather than using LocaleID.DEFAULT your application would not - retrieve those customized settings. -
    -

    For example:

    - 
    -         var tools:StringTools = new StringTools(LocaleID.DEFAULT);
-		 var aliName:String = tools.actualLocaleIDName;
-
    -

    In the above example, aliName is the name of the locale corresponding to - the user's current operating systems settings (e.g. "it-IT" if the user's locale is set to Italian-Italy), - and not "i-default" (the name of the LocaleID.DEFAULT locale).

    -
    3. -
  3. If the system does not support the requestedLocaleIDName specified in the constructor - then a fallback locale ID name is provided. -
    -

    For Example:

    - 
     	 
-         var tools:StringTools = new StringTools("fr-CA"); 	 
-         var aliName:String = tools.actualLocaleIDName;
-
    -

    Assuming that the operating system in the example above does not support the "fr-CA" (French-Canada) locale ID, - a fallback is used. In this case the fallback locale ID is "fr-FR" (French-France).

    -
    4. -
- Implementation -
-    public function get actualLocaleIDName():String -
-

-See also -

-
-LocaleID -
-requestedLocaleIDName -
-StringTools -
-
- - - - - -
lastOperationStatusproperty 
-
-lastOperationStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The status of the most recent operation that this StringTools object performed. - The lastOperationStatus property is set whenever the constructor or a method of - this class is called or another property is set. For the possible values see the description for each method. -

Implementation -
-    public function get lastOperationStatus():String -
-

-See also -

-
-LastOperationStatus -
-
- - - - - -
requestedLocaleIDNameproperty 
-
-requestedLocaleIDName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of the requested locale ID that was passed to the constructor of this StringTools object. - -

If the LocaleID.DEFAULT value was used then the name returned is "i-default". - The actual locale used can differ from the requested locale when a fallback locale is applied. - The name of the actual locale can be retrieved using the actualLocaleIDName property. -

- Implementation -
-    public function get requestedLocaleIDName():String -
-

-See also -

-
-LocaleID -
-actualLocaleIDName -
-StringTools() -
-
- -
Constructor detail
- - - - - -
StringTools()constructor
-
-public function StringTools(requestedLocaleIDName:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs a new StringTools object that provides case conversion and other utilities according to - the conventions of a given locale. -

This constructor determines if the current operating system supports the requested locale ID name. - If it is not supported then a fallback locale is used instead. - If a fallback locale is used then the lastOperationStatus property - indicates the type of fallback, and the actualLocaleIDName property contains - the name of the fallback locale ID.

-

When this constructor completes successfully the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

When the requested locale ID name is not available then the lastOperationStatus - is set to one of the following:

-
    -
  • LastOperationStatus.USING_FALLBACK_WARNING
    • -
  • LastOperationStatus.USING_DEFAULT_WARNING
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in - the LastOperationStatus class.

- - Parameters - - - - -
requestedLocaleIDName:String — The preferred locale ID name to use when determining date or time formats. -
-
-Throws - - - - -
ArgumentError — when the requestedLocaleIDName parameter is null -
-

-See also -

-
-LocaleID -
-lastOperationStatus -
requestedLocaleIDName
actualLocaleIDName
-
- -
Method detail
- - - - - -
getAvailableLocaleIDNames()method
-
-public static function getAvailableLocaleIDNames():Vector.<String> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Lists all of the locale ID names supported by this class. - -

If this class is not supported on the current operating system, this method returns a null value.

-

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

-

-Returns - - - - -
Vector.<String> — A vector of strings containing all of the locale ID names supported by this class. - -
-
- - - - - -
toLowerCase()method 
-
-public function toLowerCase(s:String):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Converts a string to lowercase according to language conventions. - Depending on the locale, the output string length can differ from the input string length. -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- - Parameters - - - - -
s:String — string to convert to lowercase. -
-

-Returns - - - - -
String — - The converted lowercase string. - - -
-
-Throws - - - - -
ArgumentError — when the s parameter is null. -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- - - - - -
toUpperCase()method 
-
-public function toUpperCase(s:String):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Converts a string to uppercase according to language conventions. - Depending on the locale, the output string length can differ from the input string length. -

When this method is called and it completes successfully, the lastOperationStatus property is set to:

-
    -
  • LastOperationStatus.NO_ERROR
    • -
-

Otherwise the lastOperationStatus property is set to one of the constants defined in the - LastOperationStatus class.

- - Parameters - - - - -
s:String — string to convert to uppercase. -
-

-Returns - - - - -
String — - The converted uppercase string. - - -
-
-Throws - - - - -
ArgumentError — when the s parameter is null. -
-

-See also -

-
-lastOperationStatus -
-LastOperationStatus -
-
- -
Examples
-
examples\StringToolsExample
-
This example shows how different strings - are converted to lower case and upper case in a lingustically correct manner. - -

- This example takes the following steps: -

-
    -
  1. Creates a StringTools object.
    2. -
  2. Defines three strings with characters unique to the Turkish, Greek, and German languages.
    3. -
  3. Converts each string to upper case and lower case and displays the results. This example demonstrates interesting - locale-specific behavior for characters like the Turkish "ı" and "İ", the German "ß" and the Greek "Σςσ".
    4. -
-
-
-package {
-    import flash.display.Sprite;
-	import flash.globalization.LocaleID;
-	import flash.globalization.StringTools;
-	import flash.text.TextField;
-	import flash.text.TextFieldAutoSize;
-
-	public class StringToolsExample extends Sprite
-	{
-		public function StringToolsExample()
-		{
-            var localeName:String= LocaleID.DEFAULT;
-            var strTool:StringTools = new StringTools(localeName);
-            
-            trace('\n\n' + "LocaleID requested: " + nf.requestedLocaleIDName 
-            + "; actual: " + nf.actualLocaleIDName);
-            trace( "Last Operation Status:" + nf.lastOperationStatus );  
-            
-            var turkishStr:String = "iI ıİ";
-            var greekStr:String = "ΣςσβΰΐΣ";
-            var germanStr:String= "ß";
-            
-            var tfTurInp:TextField = createTextField(10, 10);
-            tfTurInp.text="Turkish Input: \t " + turkishStr;
-            
-            var tfdash:TextField = createTextField(10, 20);
-            tfdash.text="-------------------";
-            
-            var tf1:TextField = createTextField(10, 30);
-            tf1.text="\t Upper case: \t " + strTool.toUpperCase(turkishStr);
-            
-            var tf2:TextField = createTextField(10, 40);
-            tf2.text="\t Lower case: \t " + strTool.toLowerCase(turkishStr);
-            
-            var tfgreekInp:TextField = createTextField(10, 60);
-            tfgreekInp.text="Greek Input: \t " + greekStr;
-            
-            var tfdash1:TextField = createTextField(10, 70);
-            tfdash1.text="-------------------";
-            
-            var tf3:TextField = createTextField(10, 80);
-            tf3.text="\t Upper case: \t " + strTool.toUpperCase(greekStr);
-            
-            var tf4:TextField = createTextField(10, 90);
-            tf4.text="\t Lower case: \t " + strTool.toLowerCase(greekStr);
-            
-            var tfgermanInp:TextField = createTextField(10, 110);
-            tfgermanInp.text="German Input: \t " + germanStr;
-            
-            var tfdash2:TextField = createTextField(10, 120);
-            tfdash2.text="-------------------";
-            			 
-            var tf5:TextField = createTextField(10, 130);
-            tf5.text="\t Upper case: \t " + strTool.toUpperCase(germanStr);
-            
-            var tf6:TextField = createTextField(10, 140);
-            tf6.text="\t Lower case: \t " + strTool.toLowerCase(germanStr);
-        }
-        
-        private function createTextField(x:Number, y:Number):TextField 
-        {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.autoSize=TextFieldAutoSize.LEFT;
-            addChild(result);
-            return result;
-        }
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/globalization/package-detail.html b/html-docs/flash/globalization/package-detail.html deleted file mode 100644 index b73a7de..0000000 --- a/html-docs/flash/globalization/package-detail.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - - -flash.globalization Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 Collator - The Collator class provides locale-sensitive string comparison capabilities.
 CollatorMode - The CollatorMode class enumerates constant values that govern the behavior of string comparisons - performed by a Collator object.
 CurrencyFormatter - The CurrencyFormatter class provides locale-sensitive formatting and parsing of currency values.
 CurrencyParseResult - A data structure that represents a currency amount and currency symbol or string that were extracted by parsing a currency value.
 DateTimeFormatter - The DateTimeFormatter class provides locale-sensitive formatting for Date objects and access to localized - date field names.
 DateTimeNameContext - The DateTimeNameContext class enumerates constant values representing the formatting context in which a month name - or weekday name is used.
 DateTimeNameStyle - The DateTimeNameStyle class enumerates constants that control the length of the month names and weekday names - that are used when formatting dates.
 DateTimeStyle - Enumerates constants that determine a locale-specific date and time formatting pattern.
 LastOperationStatus - The LastOperationStatus class enumerates constant values that represent the status of the most recent globalization service operation.
 LocaleID - The LocaleID class provides methods for parsing and using locale ID names.
 NationalDigitsType - The NationalDigitsType class enumerates constants that indicate digit sets used by the NumberFormatter class.
 NumberFormatter - The NumberFormatter class provides locale-sensitive formatting and parsing of numeric values.
 NumberParseResult - A data structure that holds information about a number that was extracted by parsing a string.
 StringTools - The StringTools class provides locale-sensitive case conversion methods.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/html/HTMLHistoryItem.html b/html-docs/flash/html/HTMLHistoryItem.html deleted file mode 100644 index e53f9d7..0000000 --- a/html-docs/flash/html/HTMLHistoryItem.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - - - - - -flash.html.HTMLHistoryItem (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.html
Classpublic class HTMLHistoryItem
InheritanceHTMLHistoryItem Inheritance Object
-

- - - - -
Runtime version: AIR 1.0 -
-

-

- An HTMLHistoryItem object describes a location in the navigation history of - an HTMLLoader object. -

-

-See also -

-
-HTMLLoader -
-HTMLWindowCreateOptions -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isPost : Boolean -
[read-only] - Indicates whether the HTML page includes POST data.
-		HTMLHistoryItem
  originalUrl : String -
[read-only] - The original URL of the HTML page, before any redirects.
-		HTMLHistoryItem
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  title : String -
[read-only] - The title of the HTML page.
-		HTMLHistoryItem
  url : String -
[read-only] - The URL of the HTML page.
-		HTMLHistoryItem
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
isPostproperty
-
-isPost:Boolean  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- Indicates whether the HTML page includes POST data. - -

Implementation -
-    public function get isPost():Boolean -
-
- - - - - -
originalUrlproperty 
-
-originalUrl:String  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The original URL of the HTML page, before any redirects. - -

Implementation -
-    public function get originalUrl():String -
-
- - - - - -
titleproperty 
-
-title:String  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The title of the HTML page. - -

Implementation -
-    public function get title():String -
-
- - - - - -
urlproperty 
-
-url:String  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The URL of the HTML page. - -

Implementation -
-    public function get url():String -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/html/HTMLHost.html b/html-docs/flash/html/HTMLHost.html deleted file mode 100644 index b6498d0..0000000 --- a/html-docs/flash/html/HTMLHost.html +++ /dev/null @@ -1,809 +0,0 @@ - - - - - - - - -flash.html.HTMLHost (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.html
Classpublic class HTMLHost
InheritanceHTMLHost Inheritance Object
-

- - - - -
Runtime version: AIR 1.0 -
-

-

- An HTMLHost object defines behaviors of an HTMLLoader object for user interface elements that - can be controlled by setting various properties or by calling various methods of the window - object of the HTML page. These methods and properties are: - -
    - -
  • window.blur()
    • -
  • window.focus()
    • -
  • window.moveBy()
    • -
  • window.moveTo()
    • -
  • window.location
    • -
  • window.close()
    • -
  • window.open()
    • -
  • window.resizeBy()
    • -
  • window.resizeTo()
    • -
  • window.status
    • -
  • window.document.title
    • -
- -

The methods in the HTMLHost class provide ways of handling changes in each of these window - settings. To use this class, create a new class (a subclass) that extends the HTMLHost class and - that overrides the methods for which you want to define behaviors. The methods of the HTMLHost class - handle JavaScript properties and methods as follows:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
JavaScript property or methodHTMLHost method
window.blur()windowBlur()
window.focus()windowFocus
window.locationupdateLocation
window.close()windowClose
window.open()createWindow
window.statusupdateStatus
window.document.titleupdateTitle
- -

To respond to changes in the window.moveBy(), window.moveTo(), - window.resizeBy(), and window.resizeTo() methods, override - the set windowRect() method in the subclass of HTMLHost.

- -

Each HTMLHost object can be associated with at most one HTMLLoader object. Assigning - an HTMLHost instance to the htmlHost property of the HTMLLoader object - establishes this relationship. Assigning null to the htmlHost - property of the HTMLLoader object or setting the HTMLHost object as the htmlHost - property of another HTMLLoader object removes the HTMLHost from the first HTMLLoader object.

- -

-

-View the examples. -

-

-See also -

-
-HTMLLoader -
-HTMLWindowCreateOptions -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  htmlLoader : HTMLLoader -
[read-only] - The HTMLLoader object to which this HostControl object applies.
-		HTMLHost
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  windowRect : Rectangle -
- The property that is changed when JavaScript code in the HTMLLoader object calls - the window.moveBy(), window.moveTo(), - window.resizeBy(), or window.resizeTo() method.
-		HTMLHost
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-HTMLHost(defaultBehaviors:Boolean = true)
-
- Creates an HTMLHost object.
-		HTMLHost
   -
-createWindow(windowCreateOptions:HTMLWindowCreateOptions):HTMLLoader -
-
- The function called when JavaScript code in the HTMLLoader object calls the - window.open() method.
-		HTMLHost
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-updateLocation(locationURL:String):void -
-
- The function called when JavaScript code in the HTMLLoader object sets the - window.location property.
-		HTMLHost
   -
-updateStatus(status:String):void -
-
- The function called when JavaScript code in the HTMLLoader object sets the - window.status property.
-		HTMLHost
   -
-updateTitle(title:String):void -
-
- The function called when JavaScript code in the HTMLLoader object sets the - window.document.title property or when the title - element changes, either via the DOM or because of a new page load.
-		HTMLHost
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
   -
-windowBlur():void -
-
- The function called when JavaScript code in the HTMLLoader object calls the - window.blur() method.
-		HTMLHost
   -
-windowClose():void -
-
- The function called when JavaScript code in the HTMLLoader object calls the - window.close() method.
-		HTMLHost
   -
-windowFocus():void -
-
- The function called when JavaScript code in the HTMLLoader object calls the - window.focus() method.
-		HTMLHost
-
- -
- -
Property detail
- - - - - -
htmlLoaderproperty
-
-htmlLoader:HTMLLoader  [read-only]

- - - - -
Runtime version: AIR 1.0 -
-

- The HTMLLoader object to which this HostControl object applies. The htmlHost - property of that HTMLLoader object is set to this HostControl object. - -

Implementation -
-    public function get htmlLoader():HTMLLoader -
-

-See also -

-
-HTMLLoader.htmlHost -
-
- - - - - -
windowRectproperty 
-
-windowRect:Rectangle  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The property that is changed when JavaScript code in the HTMLLoader object calls - the window.moveBy(), window.moveTo(), - window.resizeBy(), or window.resizeTo() method. - -

In the subclass of HTMLHost, override the set windowRect() method - to handle the new window bounds, as desired.

- - Implementation -
-    public function get windowRect():Rectangle -
-    public function set windowRect(value:Rectangle):void -
-
- -
Constructor detail
- - - - - -
HTMLHost()constructor
-
-public function HTMLHost(defaultBehaviors:Boolean = true) -

- - - - -
Runtime version: AIR 1.0 -
-

- Creates an HTMLHost object. -

Parameters - - - - -
defaultBehaviors:Boolean (default = true) — Indicates wether root-content behaviors should be provided by default. - -
-
- -
Method detail
- - - - - -
createWindow()method
-
-public function createWindow(windowCreateOptions:HTMLWindowCreateOptions):HTMLLoader -

- - - - -
Runtime version: AIR 1.0 -
-

- The function called when JavaScript code in the HTMLLoader object calls the - window.open() method. - -

By default, a JavaScript call to window.open() in the HTML - page of an HTMLLoader does not open an new NativeWindow object in the - runtime. You can open a new NativeWindow object in the runtime by creating a - new NativeWindow object in the createWindow method override in - the subclass of the HTMLHost class.

- - Parameters - - - - -
windowCreateOptions:HTMLWindowCreateOptions — An object containing properties in the string passed as the - features parameter of the call to window.open(). - -
-

-Returns - - - - -
HTMLLoader — - An HTMLLoader object that contains the new HTML page. Typically, - you create a new HTMLLoader object in this method, add it to the stage of a new - NativeWindow object, and then return it. - - - -
-
- - - - - -
updateLocation()method 
-
-public function updateLocation(locationURL:String):void -

- - - - -
Runtime version: AIR 1.0 -
-

- The function called when JavaScript code in the HTMLLoader object sets the - window.location property. - -

Parameters - - - - -
locationURL:String — The value to which the location property - of the window property of the HTMLLoader object is set. - -
-
- - - - - -
updateStatus()method 
-
-public function updateStatus(status:String):void -

- - - - -
Runtime version: AIR 1.0 -
-

- The function called when JavaScript code in the HTMLLoader object sets the - window.status property. - -

Parameters - - - - -
status:String — The value to which the status property - of the window property of the HTMLLoader object is set. - -
-
- - - - - -
updateTitle()method 
-
-public function updateTitle(title:String):void -

- - - - -
Runtime version: AIR 1.0 -
-

- The function called when JavaScript code in the HTMLLoader object sets the - window.document.title property or when the title - element changes, either via the DOM or because of a new page load. - -

Parameters - - - - -
title:String — The value to which the window.document.title property - of the HTMLLoader object is set. - -
-
- - - - - -
windowBlur()method 
-
-public function windowBlur():void -

- - - - -
Runtime version: AIR 1.0 -
-

- The function called when JavaScript code in the HTMLLoader object calls the - window.blur() method. - -

- - - - - -
windowClose()method 
-
-public function windowClose():void -

- - - - -
Runtime version: AIR 1.0 -
-

- The function called when JavaScript code in the HTMLLoader object calls the - window.close() method. - -

By default, a JavaScript call to window.close() in the HTML - page of an HTMLLoader object closes the windows containing the HTMLLoader object.

- -
- - - - - -
windowFocus()method 
-
-public function windowFocus():void -

- - - - -
Runtime version: AIR 1.0 -
-

- The function called when JavaScript code in the HTMLLoader object calls the - window.focus() method. - -

- -
Examples
-
examples\HTMLHost.1
-
The following code defines CustomHost, a subclass of HTMLHost. - Methods of the CustomHost class override the inherited methods in the HTMLHost - class to define actions taken when JavaScript code in the HTMLLoader page - sets various properties or calls various methods of the window - object: -
-
-package
-{
-    import flash.html.HTMLHost;
-	import flash.html.HTMLLoader;
-	import flash.display.NativeWindow;
-	import flash.display.NativeWindowInitOptions;
-	import flash.display.StageScaleMode;
-	import flash.geom.Rectangle;
-	import flash.text.TextField;
-
-	public class CustomHost extends HTMLHost
-	{
-		import flash.html.*;
-		public var statusField:TextField;
-		public function CustomHost(defaultBehaviors:Boolean=true)
-		{
-			super(defaultBehaviors);
-		}
-		override public function windowClose():void
-		{
-			htmlLoader.stage.window.close();
-		}
-		override public function createWindow(windowCreateOptions:HTMLWindowCreateOptions):HTMLLoader
-		{
-			var initOptions:NativeWindowInitOptions = new NativeWindowInitOptions();
-			var window:NativeWindow = new NativeWindow(initOptions);
-			window.visible = true;
-			var htmlLoader2:HTMLLoader = new HTMLLoader();
-			htmlLoader2.width = window.width;
-			htmlLoader2.height = window.height;
-			window.stage.scaleMode = StageScaleMode.NO_SCALE;
-			window.stage.addChild(htmlLoader2);
-			return htmlLoader2;
-		}
-		override public function updateLocation(locationURL:String):void
-		{
-			trace(locationURL);
-		}		
-		override public function set windowRect(value:Rectangle):void
-		{
-			htmlLoader.stage.nativeWindow.bounds = value;
-		}
-		override public function updateStatus(status:String):void
-		{
-			statusField.text = status;
-		}		
-		override public function updateTitle(title:String):void
-		{
-			htmlLoader.stage.nativeWindow.title = title + "- Example Application";
-		}
-		override public function windowBlur():void
-		{
-			htmlLoader.alpha = 0.5;
-		}
-		override public function windowFocus():void
-		{
-			htmlLoader.alpha = 1;
-		}
-	}
-}
-
-
Create the following class, which adds an HTMLLoader object to the - stage, as well as a TextField object named statusBar. The HTMLLoader - object defines a CustomHost object as its htmlHost property: - - 
package
- {
- 	import flash.display.Sprite;
- 
- 	public class SimpleHTMLBox extends Sprite
- 	{
- 		import flash.html.HTMLHost;
- 		import flash.html.HTMLLoader;
- 		import flash.text.TextField;
- 		import flash.net.URLRequest;
- 		import CustomHost;
- 		private var host:CustomHost;
- 		private var statusField:TextField;
- 		private var html:HTMLLoader;
- 		
- 		public function SimpleHTMLBox()
- 		{
- 			html = new HTMLLoader();
- 			var url:String = "Test.html";
- 			var urlReq:URLRequest = new URLRequest(url); 
- 			html.load(urlReq);
- 			
- 			host = new CustomHost();
- 			html.htmlHost = host;
- 			statusField = new TextField();
- 			host.statusField = statusField;
- 			
- 			configureUI();
- 		}
- 		private function configureUI():void
- 		{
- 			html.width = 400;
- 			html.height = 200;
- 			statusField.width = 400;
- 			statusField.height = 24;
- 			statusField.border = true;
- 			statusField.y = 200;
- 			
- 			addChild(html);
- 			addChild(statusField);				
- 		}
- 		
- 	}
- }
- -

Build an AIR application that adds an object defined by this class to - the main window's stage.

- -

Create an HTML page named Test.html in the application resources directory - (the directory that contains the application descriptor file), and add the - following content to it:

- - 
<html>
- 	<head>
- 		<title>Test</title>
- 	</head>
- 	<body>
- 		<a href="#" onclick="window.open('Test.html')">window.open('Test.html')</a>
- 		<br/><a href="#" onclick="window.document.location = 'www.adobe.com'">window.document.location = 'www.adobe.com'</a>
- 		<br/><a href="#" onclick="window.moveBy(6, 12)">moveBy(6, 12)</a>
- 		<br/><a href="#" onclick="window.close()">window.close()</a>
- 		<br/><a href="#" onclick="window.blur()">window.blur()</a>
- 		<br/><a href="#" onclick="window.focus()">window.focus()</a>
- 		<br/><a href="#" onclick="window.status = new Date().toString()">window.status = new Date().toString()</a>
- 	</body>
- </html>
- -

When you test the application, the CustomHost class handles the user-interface-related - JavaScript settings in the HTML page.

-
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/html/HTMLLoader.html b/html-docs/flash/html/HTMLLoader.html deleted file mode 100644 index 19a94d7..0000000 --- a/html-docs/flash/html/HTMLLoader.html +++ /dev/null @@ -1,2381 +0,0 @@ - - - - - - - - -flash.html.HTMLLoader (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.html
Classpublic class HTMLLoader
InheritanceHTMLLoader Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityImplementation : AccessibilityImplementation -
- - The current accessibility implementation (AccessibilityImplementation) - - for this InteractiveObject instance.
-		InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
  authenticate : Boolean -
-		HTMLLoader
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedbuttonMode : Boolean -
- Specifies the button mode of this sprite.
-		Sprite
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
  cacheResponse : Boolean -
-		HTMLLoader
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  contentHeight : Number -
[read-only]
-		HTMLLoader
  contentWidth : Number -
[read-only]
-		HTMLLoader
 InheritedcontextMenu : NativeMenu -
- - Specifies the context menu associated with this object.
-		InteractiveObject
 InheriteddoubleClickEnabled : Boolean -
- - Specifies whether the object receives doubleClick events.
-		InteractiveObject
 InheriteddropTarget : DisplayObject -
- Specifies the display object over which the sprite is being dragged, or on - which the sprite was dropped.
-		Sprite
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 InheritedfocusRect : Object -
- - Specifies whether this object displays a focus rectangle.
-		InteractiveObject
 Inheritedgraphics : Graphics -
- Specifies the Graphics object that belongs to this sprite where vector - drawing commands can occur.
-		Sprite
  hasFocusableContent : Boolean -
[read-only]
-		HTMLLoader
  height : Number -
-		HTMLLoader
  historyLength : uint -
[read-only]
-		HTMLLoader
  historyPosition : uint -
-		HTMLLoader
 InheritedhitArea : Sprite -
- Designates another sprite to serve as the hit area for a sprite.
-		Sprite
  htmlHost : HTMLHost -
-		HTMLLoader
  idleTimeout : Number -
-		HTMLLoader
  isSupported : Boolean -
[static][read-only]
-		HTMLLoader
  loaded : Boolean -
[read-only]
-		HTMLLoader
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
  location : String -
[read-only]
-		HTMLLoader
  manageCookies : Boolean -
-		HTMLLoader
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseChildren : Boolean -
- Determines whether or not the children of the object are mouse, or user input device, enabled.
-		DisplayObjectContainer
 InheritedmouseEnabled : Boolean -
- - Specifies whether this object receives mouse, or other user input, messages.
-		InteractiveObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
  navigateInSystemBrowser : Boolean -
-		HTMLLoader
 InheritedneedsSoftKeyboard : Boolean -
- - Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - - when this InteractiveObject instance receives focus.
-		InteractiveObject
 InheritednumChildren : int -
- Returns the number of children of this object.
-		DisplayObjectContainer
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
  paintsDefaultBackground : Boolean -
-		HTMLLoader
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
  pdfCapability : int -
[static][read-only]
-		HTMLLoader
  placeLoadStringContentInApplicationSandbox : Boolean -
-		HTMLLoader
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
  runtimeApplicationDomain : ApplicationDomain -
-		HTMLLoader
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
  scrollH : Number -
-		HTMLLoader
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
  scrollV : Number -
-		HTMLLoader
 InheritedsoftKeyboard : String -
- - Controls the appearance of the soft keyboard.
-		InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle -
- - Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
-		InteractiveObject
 InheritedsoundTransform : SoundTransform -
- Controls sound within this sprite.
-		Sprite
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
  swfCapability : int -
[static][read-only]
-		HTMLLoader
 InheritedtabChildren : Boolean -
- Determines whether the children of the object are tab enabled.
-		DisplayObjectContainer
 InheritedtabEnabled : Boolean -
- - Specifies whether this object is in the tab order.
-		InteractiveObject
 InheritedtabIndex : int -
- - Specifies the tab ordering of objects in a SWF file.
-		InteractiveObject
  textEncodingFallback : String -
-		HTMLLoader
  textEncodingOverride : String -
-		HTMLLoader
 InheritedtextSnapshot : TextSnapshot -
- Returns a TextSnapshot object for this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
  useCache : Boolean -
-		HTMLLoader
 InheriteduseHandCursor : Boolean -
- A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls - over a sprite in which the buttonMode property is set to true.
-		Sprite
  userAgent : String -
-		HTMLLoader
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
  width : Number -
-		HTMLLoader
  window : Object -
[read-only]
-		HTMLLoader
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-HTMLLoader()
-
-		HTMLLoader
 Inherited -
-addChild(child:DisplayObject):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-addChildAt(child:DisplayObject, index:int):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer - instance.
-		DisplayObjectContainer
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-areInaccessibleObjectsUnderPoint(point:Point):Boolean -
-
- Indicates whether the security restrictions - would cause any display objects to be omitted from the list returned by calling - the DisplayObjectContainer.getObjectsUnderPoint() method - with the specified point point.
-		DisplayObjectContainer
   -
-cancelLoad():void -
-
-		HTMLLoader
 Inherited -
-contains(child:DisplayObject):Boolean -
-
- Determines whether the specified display object is a child of the DisplayObjectContainer instance or - the instance itself.
-		DisplayObjectContainer
   -
-createRootWindow(visible:Boolean = true, windowInitOptions:NativeWindowInitOptions = null, scrollBarsVisible:Boolean = true, bounds:Rectangle = null):HTMLLoader -
-
[static]
-		HTMLLoader
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getChildAt(index:int):DisplayObject -
-
- Returns the child display object instance that exists at the specified index.
-		DisplayObjectContainer
 Inherited -
-getChildByName(name:String):DisplayObject -
-
- Returns the child display object that exists with the specified name.
-		DisplayObjectContainer
 Inherited -
-getChildIndex(child:DisplayObject):int -
-
- Returns the index position of a child DisplayObject instance.
-		DisplayObjectContainer
   -
-getHistoryAt(position:uint):HTMLHistoryItem -
-
-		HTMLLoader
 Inherited -
-getObjectsUnderPoint(point:Point):Array -
-
- Returns an array of objects that lie under the specified point and are children - (or grandchildren, and so on) of this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-historyBack():void -
-
-		HTMLLoader
   -
-historyForward():void -
-
-		HTMLLoader
   -
-historyGo(steps:int):void -
-
-		HTMLLoader
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-load(urlRequestToLoad:URLRequest):void -
-
-		HTMLLoader
   -
-loadString(htmlContent:String):void -
-
-		HTMLLoader
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-reload():void -
-
-		HTMLLoader
 Inherited -
-removeChild(child:DisplayObject):DisplayObject -
-
- Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeChildAt(index:int):DisplayObject -
-
- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer.
-		DisplayObjectContainer
 Inherited -
-removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void -
-
- Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-requestSoftKeyboard():Boolean -
-
- - Raises a virtual keyboard.
-		InteractiveObject
 Inherited -
-setChildIndex(child:DisplayObject, index:int):void -
-
- Changes the position of an existing child in the display object container.
-		DisplayObjectContainer
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void -
-
- Lets the user drag the specified sprite.
-		Sprite
 Inherited -
-startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void -
-
- Lets the user drag the specified sprite on a touch-enabled device.
-		Sprite
 Inherited -
-stopAllMovieClips():void -
-
- Recursively stops the timeline execution of all MovieClips rooted at this object.
-		DisplayObjectContainer
 Inherited -
-stopDrag():void -
-
- Ends the startDrag() method.
-		Sprite
 Inherited -
-stopTouchDrag(touchPointID:int):void -
-
- Ends the startTouchDrag() method, for use with touch-enabled devices.
-		Sprite
 Inherited -
-swapChildren(child1:DisplayObject, child2:DisplayObject):void -
-
- Swaps the z-order (front-to-back order) of the two specified child objects.
-		DisplayObjectContainer
 Inherited -
-swapChildrenAt(index1:int, index2:int):void -
-
- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list.
-		DisplayObjectContainer
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-clear -
-		 - - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 Inherited -
-click -
-		 - - Dispatched when a user presses and releases the main button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-contextMenu -
-		 - - Dispatched when a user gesture triggers the context menu associated with this interactive - - object in an AIR application.InteractiveObject
 Inherited -
-copy -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - - or selects 'Copy' from the text context menu.InteractiveObject
 Inherited -
-cut -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - - or selects 'Cut' from the text context menu.InteractiveObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-doubleClick -
-		 - - Dispatched when a user presses and releases the main button of a pointing device twice in - - rapid succession over the same InteractiveObject when that object's - - doubleClickEnabled flag is set to true.InteractiveObject
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-focusIn -
-		 - - Dispatched after a display object gains focus.InteractiveObject
 Inherited -
-focusOut -
-		 - - Dispatched after a display object loses focus.InteractiveObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-gestureDirectionalTap -
-		 - - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - - Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 Inherited -
-gestureLongPress -
-		 - - Dispatched when the user presses two points of contact over the same InteractiveObject instance - - on a touch-enabled device (such as presses and releases two fingers over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gesturePan -
-		 - - Dispatched when the user moves a point of contact over the InteractiveObject instance - - on a touch-enabled device (such as moving a finger from left to right over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureRotate -
-		 - - Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers - - and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureSwipe -
-		 - - Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three - - fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureTap -
-		 - - Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps - - on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureZoom -
-		 - - Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two - - fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-imeStartComposition -
-		 - - This event is dispatched to any client app that supports inline input with an IME - - - - InteractiveObject
 Inherited -
-keyDown -
-		 - - Dispatched when the user presses a key.InteractiveObject
 Inherited -
-keyFocusChange -
-		 - - Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited -
-keyUp -
-		 - - Dispatched when the user releases a key.InteractiveObject
 Inherited -
-middleClick -
-		 - - Dispatched when a user presses and releases the middle button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-middleMouseDown -
-		 - - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-middleMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseFocusChange -
-		 - - Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 Inherited -
-mouseMove -
-		 - - Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited -
-mouseOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheel -
-		 - - Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheelHorizontal -
-		 - - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-nativeDragComplete -
-		 - - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited -
-nativeDragDrop -
-		 - - Dispatched by the target InteractiveObject when a dragged object is - - dropped on it and the drop has been accepted with a call to - - DragManager.acceptDragDrop().InteractiveObject
 Inherited -
-nativeDragEnter -
-		 - - Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited -
-nativeDragExit -
-		 - - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited -
-nativeDragOver -
-		 - - Dispatched by an InteractiveObject continually while a drag gesture remains within its - - boundary.InteractiveObject
 Inherited -
-nativeDragStart -
-		 - - Dispatched at the beginning of a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-nativeDragUpdate -
-		 - - Dispatched during a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-paste -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - - or selects 'Paste' from the text context menu.InteractiveObject
 Inherited -
-proximityBegin -
-		 - - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityEnd -
-		 - - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityMove -
-		 - - Dispatched when the user moves an active stylus over the screen while remaining within - - the proximity detection threshold.InteractiveObject
 Inherited -
-proximityOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - - the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityOver -
-		 - - Dispatched when the user moves an active stylus directly above this InteractiveObject - - while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject - - and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOver -
-		 - - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - - object's tree of descendents in the display list - - (while remaining within the proximity detection threshold of the screen).InteractiveObject
 Inherited -
-releaseOutside -
-		 - - Dispatched when a user releases the button on the pointing device after the - - user first pressed the button over an InteractiveObject instance - - and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 Inherited -
-rightClick -
-		 - - Dispatched when a user presses and releases the right button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-rightMouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-rightMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-rollOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject - - instance.InteractiveObject
 Inherited -
-rollOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-selectAll -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a select all operation - - or selects 'Select All' from the text context menu.InteractiveObject
 Inherited -
-softKeyboardActivate -
-		 - - Dispatched immediately after the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardActivating -
-		 - - Dispatched immediately before the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardDeactivate -
-		 - - Dispatched immediately after the soft keyboard is lowered.InteractiveObject
 Inherited -
-tabChildrenChange -
-		 - - Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited -
-tabEnabledChange -
-		 - - Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited -
-tabIndexChange -
-		 - - Dispatched when the value of the object's tabIndex property changes.InteractiveObject
 Inherited -
-textInput -
-		 - - Dispatched when a user enters one or more - - characters of text.InteractiveObject
 Inherited -
-touchBegin -
-		 - - Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchEnd -
-		 - - Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchMove -
-		 - - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 Inherited -
-touchOut -
-		 - - Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device - - (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOut -
-		 - - Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchTap -
-		 - - Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated - - on a touch-enabled device (such as presses and releases a finger from a single point over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
-
- -
- -
Property detail
- - - - - -
authenticateproperty
-
-authenticate:Boolean  [read-write]Implementation -
-    public function get authenticate():Boolean -
-    public function set authenticate(value:Boolean):void -
-
- - - - - -
cacheResponseproperty 
-
-cacheResponse:Boolean  [read-write]Implementation -
-    public function get cacheResponse():Boolean -
-    public function set cacheResponse(value:Boolean):void -
-
- - - - - -
contentHeightproperty 
-
-contentHeight:Number  [read-only]Implementation -
-    public function get contentHeight():Number -
-
- - - - - -
contentWidthproperty 
-
-contentWidth:Number  [read-only]Implementation -
-    public function get contentWidth():Number -
-
- - - - - -
hasFocusableContentproperty 
-
-hasFocusableContent:Boolean  [read-only]Implementation -
-    public function get hasFocusableContent():Boolean -
-
- - - - - -
heightproperty 
-
-height:Number  [read-write]Implementation -
-    public function get height():Number -
-    public function set height(value:Number):void -
-
- - - - - -
historyLengthproperty 
-
-historyLength:uint  [read-only]Implementation -
-    public function get historyLength():uint -
-
- - - - - -
historyPositionproperty 
-
-historyPosition:uint  [read-write]Implementation -
-    public function get historyPosition():uint -
-    public function set historyPosition(value:uint):void -
-
- - - - - -
htmlHostproperty 
-
-htmlHost:HTMLHost  [read-write]Implementation -
-    public function get htmlHost():HTMLHost -
-    public function set htmlHost(value:HTMLHost):void -
-
- - - - - -
idleTimeoutproperty 
-
-idleTimeout:Number  [read-write]Implementation -
-    public function get idleTimeout():Number -
-    public function set idleTimeout(value:Number):void -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
loadedproperty 
-
-loaded:Boolean  [read-only]Implementation -
-    public function get loaded():Boolean -
-
- - - - - -
locationproperty 
-
-location:String  [read-only]Implementation -
-    public function get location():String -
-
- - - - - -
manageCookiesproperty 
-
-manageCookies:Boolean  [read-write]Implementation -
-    public function get manageCookies():Boolean -
-    public function set manageCookies(value:Boolean):void -
-
- - - - - -
navigateInSystemBrowserproperty 
-
-navigateInSystemBrowser:Boolean  [read-write]Implementation -
-    public function get navigateInSystemBrowser():Boolean -
-    public function set navigateInSystemBrowser(value:Boolean):void -
-
- - - - - -
paintsDefaultBackgroundproperty 
-
-paintsDefaultBackground:Boolean  [read-write]Implementation -
-    public function get paintsDefaultBackground():Boolean -
-    public function set paintsDefaultBackground(value:Boolean):void -
-
- - - - - -
pdfCapabilityproperty 
-
-pdfCapability:int  [read-only]Implementation -
-    public static function get pdfCapability():int -
-
- - - - - -
placeLoadStringContentInApplicationSandboxproperty 
-
-placeLoadStringContentInApplicationSandbox:Boolean  [read-write]Implementation -
-    public function get placeLoadStringContentInApplicationSandbox():Boolean -
-    public function set placeLoadStringContentInApplicationSandbox(value:Boolean):void -
-
- - - - - -
runtimeApplicationDomainproperty 
-
-runtimeApplicationDomain:ApplicationDomain  [read-write]Implementation -
-    public function get runtimeApplicationDomain():ApplicationDomain -
-    public function set runtimeApplicationDomain(value:ApplicationDomain):void -
-
- - - - - -
scrollHproperty 
-
-scrollH:Number  [read-write]Implementation -
-    public function get scrollH():Number -
-    public function set scrollH(value:Number):void -
-
- - - - - -
scrollVproperty 
-
-scrollV:Number  [read-write]Implementation -
-    public function get scrollV():Number -
-    public function set scrollV(value:Number):void -
-
- - - - - -
swfCapabilityproperty 
-
-swfCapability:int  [read-only]Implementation -
-    public static function get swfCapability():int -
-
- - - - - -
textEncodingFallbackproperty 
-
-textEncodingFallback:String  [read-write]Implementation -
-    public function get textEncodingFallback():String -
-    public function set textEncodingFallback(value:String):void -
-
- - - - - -
textEncodingOverrideproperty 
-
-textEncodingOverride:String  [read-write]Implementation -
-    public function get textEncodingOverride():String -
-    public function set textEncodingOverride(value:String):void -
-
- - - - - -
useCacheproperty 
-
-useCache:Boolean  [read-write]Implementation -
-    public function get useCache():Boolean -
-    public function set useCache(value:Boolean):void -
-
- - - - - -
userAgentproperty 
-
-userAgent:String  [read-write]Implementation -
-    public function get userAgent():String -
-    public function set userAgent(value:String):void -
-
- - - - - -
widthproperty 
-
-width:Number  [read-write]Implementation -
-    public function get width():Number -
-    public function set width(value:Number):void -
-
- - - - - -
windowproperty 
-
-window:Object  [read-only]Implementation -
-    public function get window():Object -
-
- -
Constructor detail
- - - - - -
HTMLLoader()constructor
-
-public function HTMLLoader() -
- -
Method detail
- - - - - -
cancelLoad()method
-
-public function cancelLoad():void -
- - - - - -
createRootWindow()method 
-
-public static function createRootWindow(visible:Boolean = true, windowInitOptions:NativeWindowInitOptions = null, scrollBarsVisible:Boolean = true, bounds:Rectangle = null):HTMLLoaderParameters - - - - - - - - - - - - - - - - - - - - - - -
visible:Boolean (default = true)
 
windowInitOptions:NativeWindowInitOptions (default = null)
 
scrollBarsVisible:Boolean (default = true)
 
bounds:Rectangle (default = null)
-

-Returns - - - - -
HTMLLoader
-
- - - - - -
getHistoryAt()method 
-
-public function getHistoryAt(position:uint):HTMLHistoryItemParameters - - - - -
position:uint
-

-Returns - - - - -
HTMLHistoryItem
-
- - - - - -
historyBack()method 
-
-public function historyBack():void -
- - - - - -
historyForward()method 
-
-public function historyForward():void -
- - - - - -
historyGo()method 
-
-public function historyGo(steps:int):voidParameters - - - - -
steps:int
-
- - - - - -
load()method 
-
-public function load(urlRequestToLoad:URLRequest):voidParameters - - - - -
urlRequestToLoad:URLRequest
-
- - - - - -
loadString()method 
-
-public function loadString(htmlContent:String):voidParameters - - - - -
htmlContent:String
-
- - - - - -
reload()method 
-
-public function reload():void -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/html/HTMLPDFCapability.html b/html-docs/flash/html/HTMLPDFCapability.html deleted file mode 100644 index eecd4da..0000000 --- a/html-docs/flash/html/HTMLPDFCapability.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - - - - -flash.html.HTMLPDFCapability (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.html
Classpublic final class HTMLPDFCapability
InheritanceHTMLPDFCapability Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 - -
-

-

- The HTMLPDFCapability class contains possible values of the pdfCapability property of - an HTMLLoader object. - It also defines the values of the errorID property of an ErrorEvent object dispatched - when an attempt to load PDF content is unsuccessful. -

-

-See also -

-
-HTMLLoader.pdfCapability -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ERROR_CANNOT_LOAD_READER : int = 3204
[static] - An error was returned by the OS when trying to load the Adobe Reader or Acrobat - application or one of its necessary libraries.
-		HTMLPDFCapability
  ERROR_INSTALLED_READER_NOT_FOUND : int = 3201
[static] - No version of Adobe Reader is detected.
-		HTMLPDFCapability
  ERROR_INSTALLED_READER_TOO_OLD : int = 3202
[static] - Adobe Reader is detected, but the version is too old.
-		HTMLPDFCapability
  ERROR_PREFERRED_READER_TOO_OLD : int = 3203
[static] - A sufficient version (8.1 or later) of Adobe Reader or Acrobat is detected, but the the version - of Adobe Reader that is set up to handle PDF content is older than Adobe Reader or Acrobat 8.1.
-		HTMLPDFCapability
  STATUS_OK : int = 0
[static] - A sufficient version (8.1 or later) of Adobe Reader is detected and PDF content - can be loaded in an HTMLLoader object.
-		HTMLPDFCapability
-
- -
- -
Constant detail
- - - - - -
ERROR_CANNOT_LOAD_READERconstant
-
-public static const ERROR_CANNOT_LOAD_READER:int = 3204 -

- - - - -
Runtime version: AIR 1.0 -
-

- An error was returned by the OS when trying to load the Adobe Reader or Acrobat - application or one of its necessary libraries. - -

Note: This is not returned from HTMLLoader.pdfCapability, but it is - sent as the errorID property of an ErrorEvent object dispatched when - an HTMLLoader object attempts to load PDF content and the operating system returns an error. - HTMLLoader.pdfCapability may return PDFCapability.STATUS_OK, - because it examines only the configuration and does not - attempt to load any libraries.

- -
- - - - - -
ERROR_INSTALLED_READER_NOT_FOUNDconstant 
-
-public static const ERROR_INSTALLED_READER_NOT_FOUND:int = 3201 -

- - - - -
Runtime version: AIR 1.0 -
-

- No version of Adobe Reader is detected. An HTMLLoader - object cannot display PDF content. - -

- - - - - -
ERROR_INSTALLED_READER_TOO_OLDconstant 
-
-public static const ERROR_INSTALLED_READER_TOO_OLD:int = 3202 -

- - - - -
Runtime version: AIR 1.0 -
-

- Adobe Reader is detected, but the version is too old. An HTMLLoader - object cannot display PDF content. - -

- - - - - -
ERROR_PREFERRED_READER_TOO_OLDconstant 
-
-public static const ERROR_PREFERRED_READER_TOO_OLD:int = 3203 -

- - - - -
Runtime version: AIR 1.0 -
-

- A sufficient version (8.1 or later) of Adobe Reader or Acrobat is detected, but the the version - of Adobe Reader that is set up to handle PDF content is older than Adobe Reader or Acrobat 8.1. - An HTMLLoader object cannot display PDF content. - -

- - - - - -
STATUS_OKconstant 
-
-public static const STATUS_OK:int = 0 -

- - - - -
Runtime version: AIR 1.0 -
-

- A sufficient version (8.1 or later) of Adobe Reader is detected and PDF content - can be loaded in an HTMLLoader object. - -

Note: On Windows, if an earlier version of Acrobat is installed and is running - on the user's system, any running version of Acrobat or Adobe Reader, 7.x or higher, is used - even if a later version is installed. In this case, if the value of the pdfCapability - property is PDFCapability.STATUS_OK, when an AIR application attempts to load - PDF content into an HTMLLoader object, the older version of Acrobat or Adobe Reader displays an alert, - without an error message displayed in the AIR runtime. If this is a possible situation for - your users, consider instructing them to close Acrobat or Adobe Reader while - running your application. Or consider displaying these instructions if the PDF content - does not load within an acceptable amount of time.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/html/HTMLSWFCapability.html b/html-docs/flash/html/HTMLSWFCapability.html deleted file mode 100644 index a9f144c..0000000 --- a/html-docs/flash/html/HTMLSWFCapability.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - - - -flash.html.HTMLSWFCapability (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.html
Classpublic final class HTMLSWFCapability
InheritanceHTMLSWFCapability Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 - -
-

-

- The HTMLSWFCapability class contains possible values of the swfCapability property of - an HTMLLoader object. - It also defines the values of the errorID property of an ErrorEvent object dispatched - when an attempt to load SWF content is unsuccessful. -

-

-See also -

-
-HTMLLoader.swfCapability -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  ERROR_INSTALLED_PLAYER_NOT_FOUND : int = 3221
[static] - No version of Adobe Flash Player is detected.
-		HTMLSWFCapability
  ERROR_INSTALLED_PLAYER_TOO_OLD : int = 3222
[static] - Adobe Flash Player is detected, but the version is too old.
-		HTMLSWFCapability
  STATUS_OK : int = 0
[static] - A sufficient version of Adobe Flash Player is detected and SWF content - can be loaded in a HTMLLoader object.
-		HTMLSWFCapability
-
- -
- -
Constant detail
- - - - - -
ERROR_INSTALLED_PLAYER_NOT_FOUNDconstant
-
-public static const ERROR_INSTALLED_PLAYER_NOT_FOUND:int = 3221 -

- - - - -
Runtime version: AIR 2 -
-

- No version of Adobe Flash Player is detected. An HTMLLoader - object cannot display PDF content. - -

- - - - - -
ERROR_INSTALLED_PLAYER_TOO_OLDconstant 
-
-public static const ERROR_INSTALLED_PLAYER_TOO_OLD:int = 3222 -

- - - - -
Runtime version: AIR 2 -
-

- Adobe Flash Player is detected, but the version is too old. An HTMLLoader - object cannot display SWF content. - -

- - - - - -
STATUS_OKconstant 
-
-public static const STATUS_OK:int = 0 -

- - - - -
Runtime version: AIR 2 -
-

- A sufficient version of Adobe Flash Player is detected and SWF content - can be loaded in a HTMLLoader object. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/html/HTMLWindowCreateOptions.html b/html-docs/flash/html/HTMLWindowCreateOptions.html deleted file mode 100644 index 5b53cfb..0000000 --- a/html-docs/flash/html/HTMLWindowCreateOptions.html +++ /dev/null @@ -1,521 +0,0 @@ - - - - - - - - -flash.html.HTMLWindowCreateOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.html
Classpublic class HTMLWindowCreateOptions
InheritanceHTMLWindowCreateOptions Inheritance Object
-

- - - - -
Runtime version: AIR 1.0 -
-

-

- This class defines the options that can be specified when JavaScript running - in an HTMLLoader object tries to create a new HTML window by calling the - window.open() method. - -

This class defines the properties and methods that correspond to options in the - features parameter passed to the window.open() method in JavaScript.

- -

For example, JavaScript in an HTML document (in an HTMLLoader object) - can include the following call to window.open(), in which - the features parameter (the third parameter) lists a number - of options:

- - 
window.open("http://www.adobe.com", "AdobeWindow", "scrollbars=1,menubar=1,location=0,status=0")
- -

You use the HTMLWindowCreateOptions class in overriding the - createWindow() method of a subclass of the - HTMLHost class. The HTMLLoader object passes an HTMLWindowCreateOptions object - as the windowCreateOptions parameter of the createWindow() - method of the HTMLHost object.

- -

-

-See also -

-
-HTMLHost#createWindow() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fullscreen : Boolean = false
- Specifies whether the window should be full screen.
-		HTMLWindowCreateOptions
  height : Number = NaN
- Specifies the desired initial height of the new window.
-		HTMLWindowCreateOptions
  locationBarVisible : Boolean = false
- Whether a location bar should be displayed.
-		HTMLWindowCreateOptions
  menuBarVisible : Boolean = false
- Specifies whether a menu bar should be displayed.
-		HTMLWindowCreateOptions
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  resizable : Boolean = false
- Specifies whether the window should be resizable.
-		HTMLWindowCreateOptions
  scrollBarsVisible : Boolean = true
- Specifies whether scrollbars should be displayed.
-		HTMLWindowCreateOptions
  statusBarVisible : Boolean = false
- Specifies whether a status bar should be displayed.
-		HTMLWindowCreateOptions
  toolBarVisible : Boolean = false
- Specifies whether a toolbar bar should be displayed.
-		HTMLWindowCreateOptions
  width : Number = NaN
- Specifies the desired initial width of the new window.
-		HTMLWindowCreateOptions
  x : Number = NaN
- Specifies the desired initial x position of the new window on the screen.
-		HTMLWindowCreateOptions
  y : Number = NaN
- Specifies the desired initial y position of the new window on the screen.
-		HTMLWindowCreateOptions
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
fullscreenproperty
-
-public var fullscreen:Boolean = false -

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether the window should be full screen. This property is set to true if the - features string of the JavaScript call to the window.open() - method includes "fullscreen", "fullscreen=1", or - "fullscreen=y". - -

- - - - - -
heightproperty 
-
-public var height:Number = NaN -

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the desired initial height of the new window. This is set to the height value - in the features string of the JavaScript call to the window.open() - method. If the value is NaN, the default when no height value is - specified in the features string, then a default window height is used. - -

- - - - - -
locationBarVisibleproperty 
-
-public var locationBarVisible:Boolean = false -

- - - - -
Runtime version: AIR 1.0 -
-

- Whether a location bar should be displayed. This property is set to true if the - features string of the JavaScript call to the window.open() - method includes "location", "location=1", or "location=y". - -

- - - - - -
menuBarVisibleproperty 
-
-public var menuBarVisible:Boolean = false -

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether a menu bar should be displayed. This property is set to true if the - features string of the JavaScript call to the window.open() - method includes "menubar", "menubar=1", or - "menubar=y". - -

- - - - - -
resizableproperty 
-
-public var resizable:Boolean = false -

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether the window should be resizable. This property is set to true if the - features string of the JavaScript call to the window.open() - method includes "resizable", "resizable=1", or - "resizable=y". - -

- - - - - -
scrollBarsVisibleproperty 
-
-public var scrollBarsVisible:Boolean = true -

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether scrollbars should be displayed. This property is set to true if the - features string of JavaScript call to the window.open() - method includes "scrollbars", "scrollbars=1", or - "scrollbars=y". - -

- - - - - -
statusBarVisibleproperty 
-
-public var statusBarVisible:Boolean = false -

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether a status bar should be displayed. This property is set to true if the - features string of the JavaScript call to the window.open() - method includes "status", "status=1", or "status=y". - -

- - - - - -
toolBarVisibleproperty 
-
-public var toolBarVisible:Boolean = false -

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether a toolbar bar should be displayed. This property is set to true if the - features string of the JavaScript call to the window.open() - method includes "toolbar", "toolbar=1", or "toolbar=y". - -

- - - - - -
widthproperty 
-
-public var width:Number = NaN -

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the desired initial width of the new window. This is set to the width value - in the features string of the JavaScript call to the window.open() - method. If the value is NaN, the default when no width value is - specified in the features string, then a default window width is used. - -

- - - - - -
xproperty 
-
-public var x:Number = NaN -

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the desired initial x position of the new window on the screen. This is set to the - value specified for left or screenX in the features - string of the JavaScript call to the window.open() method. If the value - is NaN, the default when no left or screenX value is - specified in the features string, then a default window x position is used. - -

- - - - - -
yproperty 
-
-public var y:Number = NaN -

- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the desired initial y position of the new window on the screen. This is set to the - value specified for top or screenY in the features - string of the JavaScript call to the window.open() method. If the value is - NaN, the default when no left or screenX value is specified - in the features string, then a default window x position is used. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/html/package-detail.html b/html-docs/flash/html/package-detail.html deleted file mode 100644 index b52a848..0000000 --- a/html-docs/flash/html/package-detail.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - -flash.html Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.html package contains classes used for including HTML content in an AIR application. The HTMLControl class is a display object that can render HTML content. The other classes support functionality related to HTMLControl object. This package is only available to content running in the AIR runtime.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 HTMLHistoryItem - An HTMLHistoryItem object describes a location in the navigation history of - an HTMLLoader object.
 HTMLHost - An HTMLHost object defines behaviors of an HTMLLoader object for user interface elements that - can be controlled by setting various properties or by calling various methods of the window - object of the HTML page.
 HTMLLoader 
 HTMLPDFCapability - The HTMLPDFCapability class contains possible values of the pdfCapability property of - an HTMLLoader object.
 HTMLSWFCapability - The HTMLSWFCapability class contains possible values of the swfCapability property of - an HTMLLoader object.
 HTMLWindowCreateOptions - This class defines the options that can be specified when JavaScript running - in an HTMLLoader object tries to create a new HTML window by calling the - window.open() method.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/media/AudioDecoder.html b/html-docs/flash/media/AudioDecoder.html deleted file mode 100644 index 43b1fb0..0000000 --- a/html-docs/flash/media/AudioDecoder.html +++ /dev/null @@ -1,398 +0,0 @@ - - - - - - - - -flash.media.AudioDecoder (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class AudioDecoder
InheritanceAudioDecoder Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The AudioDecoder class enumerates the types of multichannel audio that a - system can support. -

Use one of the constants defined in this class as the parameter to the hasMultiChannelAudio() method - of the Capabilities class.

-

AIR profile support: Multichannel audio is supported - only on AIR for TV devices. On all other devices, hasMultiChannelAudio() always returns false. - See - - AIR Profile Support for more information regarding API support across multiple profiles.

- - -

-

-See also -

-
-Capabilities.hasMultiChannelAudio() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  DOLBY_DIGITAL : String = "DolbyDigital"
[static] - Dolby Digital Audio, which is also known as AC-3.
-		AudioDecoder
  DOLBY_DIGITAL_PLUS : String = "DolbyDigitalPlus"
[static] - Dolby Digital Plus Audio, which is also known as Enhanced AC-3 and Enhanced Dolby Digital.
-		AudioDecoder
  DTS : String = "DTS"
[static] - DTS Audio, which is also known as DTS Coherent Acoustics, DTS Digital Surround, and DTS core.
-		AudioDecoder
  DTS_EXPRESS : String = "DTSExpress"
[static] - DTS Express Audio, which is also known as DTS Low Bit Rate (LBR).
-		AudioDecoder
  DTS_HD_HIGH_RESOLUTION_AUDIO : String = "DTSHDHighResolutionAudio"
[static] - DTS-HD High Resolution Audio, which is also known as DTS-HD HR.
-		AudioDecoder
  DTS_HD_MASTER_AUDIO : String = "DTSHDMasterAudio"
[static] - DTS-HD Master Audio, which is also known as DTS-HD MA.
-		AudioDecoder
-
- -
- -
Constant detail
- - - - - -
DOLBY_DIGITALconstant
-
-public static const DOLBY_DIGITAL:String = "DolbyDigital" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Dolby Digital Audio, which is also known as AC-3. -

- - - - - -
DOLBY_DIGITAL_PLUSconstant 
-
-public static const DOLBY_DIGITAL_PLUS:String = "DolbyDigitalPlus" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Dolby Digital Plus Audio, which is also known as Enhanced AC-3 and Enhanced Dolby Digital. -

- - - - - -
DTSconstant 
-
-public static const DTS:String = "DTS" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- DTS Audio, which is also known as DTS Coherent Acoustics, DTS Digital Surround, and DTS core. -

- - - - - -
DTS_EXPRESSconstant 
-
-public static const DTS_EXPRESS:String = "DTSExpress" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- DTS Express Audio, which is also known as DTS Low Bit Rate (LBR). -

- - - - - -
DTS_HD_HIGH_RESOLUTION_AUDIOconstant 
-
-public static const DTS_HD_HIGH_RESOLUTION_AUDIO:String = "DTSHDHighResolutionAudio" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- DTS-HD High Resolution Audio, which is also known as DTS-HD HR. -

- - - - - -
DTS_HD_MASTER_AUDIOconstant 
-
-public static const DTS_HD_MASTER_AUDIO:String = "DTSHDMasterAudio" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- DTS-HD Master Audio, which is also known as DTS-HD MA. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/AudioDeviceManager.html b/html-docs/flash/media/AudioDeviceManager.html deleted file mode 100644 index 475be82..0000000 --- a/html-docs/flash/media/AudioDeviceManager.html +++ /dev/null @@ -1,487 +0,0 @@ - - - - - - - - -flash.media.AudioDeviceManager (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class AudioDeviceManager
InheritanceAudioDeviceManager Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 28
-

-

- - Use the AudioDeviceManager class to get audio device information of the system, and - select a device for audio playback. User can change audio output device either through - Flash Player's Settings UI, or the AudioDeviceManager API. Both of them are in sync - with audio output settings. AudioDeviceManager API was enabled for Flash Player 27. - It is now enabled for AIR Desktop from AIR 28. -

The audio device selected from one AIR application does not affect the audio from - other AIR applications or Flash Player instances.

-

Privacy Restriction

-

- AudioDeviceManager API is under User Invoked Action (UIA) restriction, that is, it can - only be invoked with some user interaction. If this API is not invoked by user interaction, - Flash Player throws runtime error IllegalOperationError with error code set to 2176. - In case of AIR applications, the UIA check will be applied when we load - an external SWF/HTML hosted over a network. If the externally loaded SWF/HTML tries to change the - audio output device without any user invoked action, then AIR runtime throws an error - IllegalOperationError with error code 2176. -

-

Access AudioDeviceManager instance

-

- AudioDeviceManager instance is a singleton object, it is in sync with Flash Player's Audio - Output Settings. Client should use AudioDeviceManager.audioDeviceManager to - get a reference to this singleton object. -

-

Get the current audio devices available on the system

-

- Use AudioDeviceManager.deviceNames to get all the available audio output - devices in the system. -

-

Get the current selected audio device

-

- Use AudioDeviceManager.selectedDeviceIndex to find the index of the current - used audio output device. Use this index to find the device name the device list returned - from AudioDeviceManager.deviceNames -

-

Select an audio output device

-

- Set AudioDeviceManager.selectedDeviceIndex to a different value can make that device - to be the current selected audio playback device. -

-

Monitor audio output device change

-

- Audio output device may change because of user selecting a different device from Flash Player's - Settings UI, Content setting AudioDeviceManager.selectedDeviceIndex, audio device - being added/removed from the system. Client application can register listener to event: - AudioOutputChangeEvent.AUDIO_OUTPUT_CHANGE - to receive notification when audio output device change happens. - The reason property of the event object indicates how this change is triggered. - There are 2 possible values for reason property: - AudioOutputChangeReason.USER_SELECTION - indicates that user selects a different audio output device through Flash Player's Settings UI, - or Content sets AudioDeviceManager.selectedDeviceIndex. - AudioOutputChangeReason.DEVICE_CHANGE - indicates that audio output device has been added or removed from the system. -

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  audioDeviceManager : AudioDeviceManager -
[static][read-only] - The singleton instance of the AudioDeviceManager object.
-		AudioDeviceManager
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  deviceNames : Array -
[read-only] - An array of strings containing the names of all available audio output devices.
-		AudioDeviceManager
  isSupported : Boolean -
[static][read-only] - Whether AudioDeviceManager is enabled.
-		AudioDeviceManager
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  selectedDeviceIndex : int -
- The index of the current selected audio output device, as reflected in the - array returned by AudioDeviceManager.deviceNames.
-		AudioDeviceManager
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-audioOutputChange -
-		 - Dispatched when audio output device is changed for the following reasons: - (1) User selection - - User selects through Flash Player Settings UI - Content setting AudioDeviceManager.selectedDeviceIndex - (2) Device change - - Audio device is added/removed from the system.AudioDeviceManager
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
audioDeviceManagerproperty
-
-audioDeviceManager:AudioDeviceManager  [read-only]

- The singleton instance of the AudioDeviceManager object. -

Implementation -
-    public static function get audioDeviceManager():AudioDeviceManager -
-
- - - - - -
deviceNamesproperty 
-
-deviceNames:Array  [read-only]

- An array of strings containing the names of all available audio output devices. - This array provides the zero-based index of each audio output device and the number - of audio output devices on the system, through the following property: - AudioDeviceManager.deviceNames.length - For more information, see the Array class entry. - This list of device names is the same as that in Audio Output Settings. - -

Note for Chrome browser: Chrome requires user to grant Microphone - access permission in order to enumerate audio output devices, because Audio Output and - Audio Input share the same permission, and only Audio Input permission warning will be - displayed to the user. -

- Implementation -
-    public function get deviceNames():Array -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- Whether AudioDeviceManager is enabled. -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
selectedDeviceIndexproperty 
-
-selectedDeviceIndex:int  [read-write]

- The index of the current selected audio output device, as reflected in the - array returned by AudioDeviceManager.deviceNames. This index - in sync with Audio Output Settings. -

Implementation -
-    public function get selectedDeviceIndex():int -
-    public function set selectedDeviceIndex(value:int):void -
-
-
Event detail
- - - - - -
audioOutputChangeevent 
-
-Event object type: flash.events.AudioOutputChangeEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 28
-

- Dispatched when audio output device is changed for the following reasons: - (1) User selection - - User selects through Flash Player Settings UI - Content setting AudioDeviceManager.selectedDeviceIndex - (2) Device change - - Audio device is added/removed from the system. -

- Check the reason property of this event to find out what causes the change. - The possible reasons are: - AudioOutputChangeReason.USER_SELECTION - AudioOutputChangeReason.DEVICE_CHANGE. -

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/AudioOutputChangeReason.html b/html-docs/flash/media/AudioOutputChangeReason.html deleted file mode 100644 index 06ca8cd..0000000 --- a/html-docs/flash/media/AudioOutputChangeReason.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - -flash.media.AudioOutputChangeReason (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class AudioOutputChangeReason
InheritanceAudioOutputChangeReason Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 28 -
-

-

- This class defines an enumeration that indicates the reason for AudioOutputChangeEvent. -

-

-See also -

-
-flash.events.AudioOutputChangeEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  DEVICE_CHANGE : String = "deviceChange"
[static] - Audio Output is changed because system device has been added or removed.
-		AudioOutputChangeReason
  USER_SELECTION : String = "userSelection"
[static] - Audio Output is changed by user selecting a different device.
-		AudioOutputChangeReason
-
- -
- -
Constant detail
- - - - - -
DEVICE_CHANGEconstant
-
-public static const DEVICE_CHANGE:String = "deviceChange" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 28 -
-

- Audio Output is changed because system device has been added or removed. -

- - - - - -
USER_SELECTIONconstant 
-
-public static const USER_SELECTION:String = "userSelection" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 28
-

- Audio Output is changed by user selecting a different device. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/AudioPlaybackMode.html b/html-docs/flash/media/AudioPlaybackMode.html deleted file mode 100644 index e60f944..0000000 --- a/html-docs/flash/media/AudioPlaybackMode.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - -flash.media.AudioPlaybackMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class AudioPlaybackMode
InheritanceAudioPlaybackMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

-

- The AudioPlaybackMode class defines constants for the audioPlaybackMode property of the - SoundMixer class. -

Known Issue: No audio is played in the Media Playback mode for StageVideo, when the mute switch is ON.

-

Each of these constants represents a set of behavior for audio on mobile tailored to a particular use.

-

-

-See also -

-
-flash.media.Sound -
-flash.media.SoundMixer -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  AMBIENT : String = "ambient"
[static] - A mode for playing ambient sound.
-		AudioPlaybackMode
  MEDIA : String = "media"
[static] - A mode for playing media sounds.
-		AudioPlaybackMode
  VOICE : String = "voice"
[static] - A mode for playing voice audio.
-		AudioPlaybackMode
-
- -
- -
Constant detail
- - - - - -
AMBIENTconstant
-
-public static const AMBIENT:String = "ambient" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- A mode for playing ambient sound. Use this mode for playing sounds that are accompaniments to - the actual purpose of the application and are not necessary for its successful use. - When using this mode, audio is routed through the speakerphone. If headphones are plugged in, - they override the speakerphone. The operating system uses defaults for ambient sound when - deciding behavior and priority for audio. -

This setting has no special effect on the desktop or TV.

-

On iOS, using this mode causes audio to be silenced by locking the screen (or sending the app to the - background by any other means) and enabling the hardware Silent switch while the Microphone is not in - use. If a Microphone is in use, audio is not affected by these actions.

- -

Note:: Audio is not silenced by the Silent switch if a Headset is connected.

-
- - - - - -
MEDIAconstant 
-
-public static const MEDIA:String = "media" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- A mode for playing media sounds. - When using this mode on mobile, sound is routed through the speakerphone. If headphones are plugged in - they override the speakerphone. The operating system uses defaults for media audio when deciding - behavior and priority for audio. -

This setting has no special effect on the desktop or TV.

-

This is the default.

-
- - - - - -
VOICEconstant 
-
-public static const VOICE:String = "voice" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- A mode for playing voice audio. - When using this mode, audio is routed through the phone earpiece by default. If headphones are plugged in - they override the earpiece. If the SoundMixer.useSpeakerphoneForVoice property is set, sound - goes to the speakerphone, overriding the earpiece/headphones. The operating system uses defaults for - voice audio when deciding behavior and priority for audio. -

Try to minimize usage of AudioPlaybackMode.VOICE, and try to switch to - AudioPlaybackMode.MEDIA as soon as possible after a voice call ends, which - allows other applications to play in media mode.

-

This setting has no special effect on the desktop or TV.

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/Camera.html b/html-docs/flash/media/Camera.html deleted file mode 100644 index 5c55afe..0000000 --- a/html-docs/flash/media/Camera.html +++ /dev/null @@ -1,3321 +0,0 @@ - - - - - - - - -flash.media.Camera (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class Camera
InheritanceCamera Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

-

- - Use the Camera class to capture video from the client system or device camera. - - Use the Video class to monitor the video locally. - - Use the NetConnection and NetStream classes to transmit the video to Flash Media Server. - - Flash Media Server can send the video stream to other servers and broadcast it to other clients running Flash Player or AIR. - - -

A Camera instance captures video in landscape aspect ratio. On devices that can change the screen orientation, - - such as mobile phones, a Video object attached to the camera will only show upright video in a landscape-aspect orientation. - - Thus, mobile apps should use a landscape orientation when displaying video and should not auto-rotate.

- - - -

On iOS, the video from the front camera is mirrored. On Android, it is not.

- - - -

On mobile devices with an autofocus camera, autofocus is enabled automatically. If the camera does not support continuous autofocus, - - and many mobile device cameras do not, then the camera is focused when the Camera object is attached to a video stream and whenever - - the setMode() method is called. On desktop computers, autofocus behavior is dependent on the camera driver and settings.

- - - -

In an AIR application on Android and iOS, the camera does not capture video while an AIR app is not the active, foreground application. - - In addition, streaming connections can be lost when the application is in the background. On iOS, the camera video cannot be - - displayed when an application uses the GPU rendering mode. The camera video can still be streamed to a server.

- - - -

AIR profile support: This feature is not - - supported on AIR for TV devices. See - - - - AIR Profile Support for more information regarding API support across multiple profiles. - - Note that for AIR for TV devices, Camera.isSupported is true but - - Camera.getCamera() always returns null. Camera access is not supported - - in mobile browsers.

- - -

- - For information about capturing audio, see the Microphone class. - -

- - -

- - Important: The runtime displays a Privacy dialog box that lets the user choose whether - - to allow or deny access to the camera. Make sure your application window size is at least 215 x 138 pixels; - - this is the minimum size required to display the dialog box. - -

- - -

To create or reference a Camera object, use the getCamera() method.

- - -

-

-View the examples. -

-

-See also -

-
-flash.media.Microphone -
-Cristophe Coenraets: Video Chat for Android in 30 Lines of Code -
-Michael Chaize: Android, AIR, and the Camera -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  activityLevel : Number -
[read-only] - - The amount of motion the camera is detecting.
-		Camera
  bandwidth : int -
[read-only] - - The maximum amount of bandwidth the current outgoing video feed can use, in bytes.
-		Camera
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentFPS : Number -
[read-only] - - The rate at which the camera is capturing data, in frames per second.
-		Camera
  fps : Number -
[read-only] - - The maximum rate at which the camera can capture data, in frames per second.
-		Camera
  height : int -
[read-only] - - The current capture height, in pixels.
-		Camera
  index : int -
[read-only] - - A zero-based index that specifies the position of the camera in - - the Camera.names array, which lists all available cameras.
-		Camera
  isSupported : Boolean -
[static][read-only] - - The isSupported property is set to true if the - - Camera class is supported on the current platform, otherwise it is - - set to false.
-		Camera
  keyFrameInterval : int -
[read-only] - - The number of video frames transmitted in full (called keyframes) - - instead of being interpolated by the video compression algorithm.
-		Camera
  loopback : Boolean -
[read-only] - - Indicates whether a local view of what the camera is capturing is compressed - - and decompressed (true), as it would be for live transmission using - - Flash Media Server, or uncompressed (false).
-		Camera
  motionLevel : int -
[read-only] - - The amount of motion required to invoke the activity event.
-		Camera
  motionTimeout : int -
[read-only] - - The number of milliseconds between the time the camera stops detecting motion and the time the activity event is invoked.
-		Camera
  muted : Boolean -
[read-only] - - A Boolean value indicating whether the user has denied access to the camera - - (true) or allowed access (false) in the Flash Player Privacy dialog box.
-		Camera
  name : String -
[read-only] - - The name of the current camera, as returned by the camera hardware.
-		Camera
  names : Array -
[static][read-only] - - An array of strings containing the names of all available cameras.
-		Camera
  permissionManager : PermissionManager -
[static][read-only] - - Retrieves the permission manager object for the Camera resource - - -
-		Camera
  permissionStatus : String -
[static][read-only] - - Determine whether the application has been granted the permission to use camera.
-		Camera
  position : String -
[read-only] - - Specifies the side of a device on which the camera is located.
-		Camera
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : int -
[read-only] - - The required level of picture quality, as determined by the amount of compression being applied to each video - - frame.
-		Camera
  width : int -
[read-only] - - The current capture width, in pixels.
-		Camera
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-copyToByteArray(rect:Rectangle, destination:ByteArray):void -
-
- - Fills a byte array from a rectangular region of pixel data - - -

Writes an unsigned integer (a 32-bit unmultiplied pixel value) - - for each pixel into the byte array.

-		Camera
   -
-copyToVector(rect:Rectangle, destination:Vector.<uint>):void -
-
- - Fills a vector from a rectangular region of pixel data.
-		Camera
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-drawToBitmapData(destination:BitmapData):void -
-
- - Copies the last frame to a bitmap.
-		Camera
   -
-getCamera(name:String = null):Camera -
-
[static] - - Returns a reference to a Camera object for capturing video.
-		Camera
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-requestPermission():void -
-
- - Requests camera permission for the application.
-		Camera
   -
-setKeyFrameInterval(keyFrameInterval:int):void -
-
- - Specifies which video frames are transmitted in full (called keyframes) - - instead of being interpolated by the video compression algorithm.
-		Camera
   -
-setLoopback(compress:Boolean = false):void -
-
- - Specifies whether to use a compressed video stream for a local view of the camera.
-		Camera
   -
-setMode(width:int, height:int, fps:Number, favorArea:Boolean = true):void -
-
- - Sets the camera capture mode to the native mode that best meets the specified requirements.
-		Camera
   -
-setMotionLevel(motionLevel:int, timeout:int = 2000):void -
-
- - Specifies how much motion is required to dispatch the activity event.
-		Camera
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setQuality(bandwidth:int, quality:int):void -
-
- - Sets the maximum amount of bandwidth per second or the required picture quality - - of the current outgoing video feed.
-		Camera
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-activity -
-		 - - Dispatched when a camera begins or ends a session.Camera
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-permissionStatus -
-		 - - Dispatched when the application requests permission to use camera on the device.Camera
   -
-status -
-		 - - Dispatched when a camera reports its status.Camera
   -
-videoFrame -
-		 - - Dispatched after a new camera frame is processed by the runtime and is available to be copied.Camera
-
- -
- -
Property detail
- - - - - -
activityLevelproperty
-
-activityLevel:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The amount of motion the camera is detecting. Values range from 0 (no motion is being detected) to - - 100 (a large amount of motion is being detected). The value of this property can help you determine if you need to pass a setting - - to the setMotionLevel() method. - -

If the camera is available but is not yet being used because the - - Video.attachCamera() method has not been called, this property - - is set to -1.

- -

If you are streaming only uncompressed local video, this property is set only if you have assigned a function to the event - - handler. Otherwise, it is undefined.

- - - Implementation -
-    public function get activityLevel():Number -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-motionLevel -
-setMotionLevel() -
-
- - - - - -
bandwidthproperty 
-
-bandwidth:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The maximum amount of bandwidth the current outgoing video feed can use, in bytes. - - A value of 0 means the feed can use as much bandwidth as needed to maintain the desired frame quality. - -

To set this property, use the setQuality() method.

- - - Implementation -
-    public function get bandwidth():int -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-setQuality() -
-
- - - - - -
currentFPSproperty 
-
-currentFPS:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The rate at which the camera is capturing data, in frames per second. - - This property cannot be set; however, you can use the setMode() method - - to set a related property—fps—which specifies the maximum - - frame rate at which you would like the camera to capture data. - - -

Implementation -
-    public function get currentFPS():Number -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-setMode() -
-
- - - - - -
fpsproperty 
-
-fps:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - The maximum rate at which the camera can capture data, in frames per second. - - The maximum rate possible depends on the capabilities of the camera; this frame rate may not be achieved. - -

    - -
  • To set a desired value for this property, use the setMode() method.
    • - -
  • To determine the rate at which the camera is currently capturing data, use the currentFPS property.
    • - -
- - -

Implementation -
-    public function get fps():Number -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-currentFPS -
-setMode() -
-
- - - - - -
heightproperty 
-
-height:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - The current capture height, in pixels. To set a value for this property, - - use the setMode() method. - - -

Implementation -
-    public function get height():int -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - - -
-

-See also -

-
-width -
-setMode() -
-
- - - - - -
indexproperty 
-
-index:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A zero-based index that specifies the position of the camera in - - the Camera.names array, which lists all available cameras. - - -

Implementation -
-    public function get index():int -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-names -
-getCamera() -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - The isSupported property is set to true if the - - Camera class is supported on the current platform, otherwise it is - - set to false. - - -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
keyFrameIntervalproperty 
-
-keyFrameInterval:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - The number of video frames transmitted in full (called keyframes) - - instead of being interpolated by the video compression algorithm. - - The default value is 15, which means that every 15th frame is a keyframe. - - A value of 1 means that every frame is a keyframe. The allowed values are - - 1 through 300. - - -

Implementation -
-    public function get keyFrameInterval():int -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-setKeyFrameInterval() -
-
- - - - - -
loopbackproperty 
-
-loopback:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Indicates whether a local view of what the camera is capturing is compressed - - and decompressed (true), as it would be for live transmission using - - Flash Media Server, or uncompressed (false). The default value is - - false. - - - -

- - Although a compressed stream is useful for testing, such as when previewing - - video quality settings, it has a significant processing cost. The local view - - is compressed, edited for transmission as it would be over a live connection, - - and then decompressed for local viewing. - -

- - - -

To set this value, use Camera.setLoopback(). To set the amount of - - compression used when this property is true, use Camera.setQuality().

- - - Implementation -
-    public function get loopback():Boolean -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - - -
-

-See also -

-
-setLoopback() -
-setQuality() -
-
- - - - - -
motionLevelproperty 
-
-motionLevel:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The amount of motion required to invoke the activity event. Acceptable values range from 0 to 100. - - The default value is 50. - -

Video can be displayed regardless of the value of the motionLevel property. For more information, see - - setMotionLevel().

- - - Implementation -
-    public function get motionLevel():int -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-setMotionLevel() -
-
- - - - - -
motionTimeoutproperty 
-
-motionTimeout:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The number of milliseconds between the time the camera stops detecting motion and the time the activity event is invoked. The - - default value is 2000 (2 seconds). - -

To set this value, use setMotionLevel().

- - - Implementation -
-    public function get motionTimeout():int -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-setMotionLevel() -
-
- - - - - -
mutedproperty 
-
-muted:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A Boolean value indicating whether the user has denied access to the camera - - (true) or allowed access (false) in the Flash Player Privacy dialog box. - - - When this value changes, the statusevent is dispatched. - - -

Implementation -
-    public function get muted():Boolean -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-getCamera() -
-status -
-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The name of the current camera, as returned by the camera hardware. - - -

Implementation -
-    public function get name():String -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-names -
-getCamera() -
-
- - - - - -
namesproperty 
-
-names:Array  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - An array of strings containing the names of all available cameras. - - Accessing this array does not display the Flash Player Privacy dialog box. This array - - provides the zero-based index of each camera and the number of cameras on the system (by means of - - names.length). - - -

Calling the names property requires an extensive examination of the hardware. - - In most cases, you can just use the default camera.

- - - Implementation -
-    public static function get names():Array -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-getCamera() -
-index -
-name -
-
- - - - - -
permissionManagerproperty 
-
-permissionManager:PermissionManager  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 - -
-

- - Retrieves the permission manager object for the Camera resource - - -

Implementation -
-    public static function get permissionManager():PermissionManager -
-
- - - - - -
permissionStatusproperty 
-
-permissionStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24.0 - -
-

- - Determine whether the application has been granted the permission to use camera. - - -

Implementation -
-    public static function get permissionStatus():String -
-

-See also -

-
-flash.permissions.PermissionStatus -
-
- - - - - -
positionproperty 
-
-position:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Specifies the side of a device on which the camera is located. - - -

Use the position property to determine whether a camera on a mobile device is - - on the front or back face of the device. The following function checks every available camera until it finds - - a camera with the desired position. If no camera has the desired position, then the default camera is returned.

- - 
-
-	 function getCamera( position:String ):Camera
-
-	 {
-
-	   var camera:Camera;
-
-	   var cameraCount:uint = Camera.names.length;
-
-	  for ( var i:uint = 0; i < cameraCount; ++i )
-
-	  {
-
-	    camera = Camera.getCamera( String(i) );
-
-	    if ( camera.position == position ) return camera;
-
-	  }
-
-	  return Camera.getCamera();
-
-	 
-
-
- - - -

On mobile devices the camera position is normally either CameraPosition.FRONT or CameraPosition.BACK. - - If the position of the Camera cannot be determined then the position is reported as CameraPosition.UNKNOWN. - - On desktop platforms, the position is always CameraPosition.UNKNOWN.

- - -

Constants for the valid values of this property are defined in the - - CameraPosition class - -

- - - Implementation -
-    public function get position():String -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-flash.media.CameraPosition -
-
- - - - - -
qualityproperty 
-
-quality:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The required level of picture quality, as determined by the amount of compression being applied to each video - - frame. Acceptable quality values range from 1 (lowest quality, maximum compression) to 100 (highest quality, no compression). The - - default value is 0, which means that picture quality can vary as needed to avoid exceeding available bandwidth. - - -

To set this property, use the setQuality() method.

- - Implementation -
-    public function get quality():int -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-setQuality() -
-
- - - - - -
widthproperty 
-
-width:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - The current capture width, in pixels. To set a desired value for this property, - - use the setMode() method. - - -

Implementation -
-    public function get width():int -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-setMode() -
-
- -
Method detail
- - - - - -
copyToByteArray()method
-
-public function copyToByteArray(rect:Rectangle, destination:ByteArray):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Fills a byte array from a rectangular region of pixel data - - -

Writes an unsigned integer (a 32-bit unmultiplied pixel value) - - for each pixel into the byte array. The array is resized to the - - necessary number of bytes to hold all the pixels.

- - - - - Parameters - - - - - - - - - - -
rect:Rectangle — A rectangular area in the current BitmapData object. - - -
 
destination:ByteArray — A ByteArray representing the pixels in the given rectangle. - - - -
-
-Throws - - - - - - - - - - - - - - - - -
PermissionError — The application does not have permission to use camera. - - -
 
TypeError — The rect is null. - -
 
TypeError — The destination is null - - -
-

-See also -

-
-flash.utils.ByteArray -
-flash.media.StageVideo.attachCamera() -
-
- - - - - -
copyToVector()method 
-
-public function copyToVector(rect:Rectangle, destination:Vector.<uint>):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Fills a vector from a rectangular region of pixel data. - - - -

Writes an unsigned integer (a 32-bit unmultiplied pixel value) - - for each pixel into the vector. The vector is resized to the - - necessary number of entries to hold all the pixels.

- - - - - - Parameters - - - - - - - - - - -
rect:Rectangle — A rectangular area in the current BitmapData object. - - -
 
destination:Vector.<uint> — A Vector.<uint> representing the pixels in the given rectangle. - - -
-
-Throws - - - - - - - - - - - - - - - - -
PermissionError — The application does not have permission to use camera. - -
 
TypeError — The rect is null. - -
 
TypeError — The destination is null - - - -
-

-See also -

-
-Vector -
-flash.media.StageVideo.attachCamera() -
-
- - - - - -
drawToBitmapData()method 
-
-public function drawToBitmapData(destination:BitmapData):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Copies the last frame to a bitmap. - - -

This method copies the contents of the last frame to a BitmapData instance.

- - - Parameters - - - - -
destination:BitmapData — A BitmapData instance object to contain the last frame. - - -
-
-Throws - - - - -
ArgumentError — kInvalidBitmapDataError if destination is too small - - -
-

-See also -

-
-flash.media.StageVideo.attachCamera() -
-flash.display.BitmapData -
-
- - - - - -
getCamera()method 
-
-public static function getCamera(name:String = null):Camera -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Returns a reference to a Camera object for capturing video. To begin capturing - - the video, you must attach the Camera object to a Video object (see Video.attachCamera() - - ). To transmit video to Flash Media Server, call NetStream.attachCamera() - - to attach the Camera object to a NetStream object. - - -

Multiple calls to the getCamera() method reference the same camera driver. - - Thus, if your code contains code like firstCam:Camera = getCamera() - - and secondCam:Camera = getCamera(), - - both firstCam and secondCam reference the same camera, - - which is the user's default camera.

- - - -

On mobile devices with a both a front- and a rear-facing camera, you can only capture - - video from one camera at a time.

- - -

In general, you shouldn't pass a value for the name parameter; simply use - - getCamera() to return a reference to the default camera. By means of the Camera - - settings panel (discussed later in this section), the user can specify the default camera - - to use.

- - -

You can't use ActionScript to set a user's Allow or Deny permission setting - - for access to the camera, but you can display the Adobe Flash Player Settings camera - - setting dialog box where the user can set the camera permission. When a SWF file using - - the attachCamera() method tries to - - attach the camera returned by the getCamera() method to a Video or - - NetStream object, Flash Player displays a dialog box that lets the user choose - - to allow or deny access to the camera. (Make sure your application window size is at least - - 215 x 138 pixels; this is the minimum size Flash Player requires to display the dialog box.) - - When the user responds to the camera setting dialog box, Flash Player returns an - - information object in the status event that indicates the user's response: - - Camera.Muted indicates - - the user denied access to a camera; Camera.Unmuted indicates the user allowed access - - to a camera. To determine whether the user has denied or allowed access to the camera without - - handling the status event, use the muted property.

- - -

In Flash Player, the user can specify permanent privacy settings for a particular domain by right-clicking - - (Windows and Linux) or Control-clicking (Macintosh) while a SWF file is playing, selecting Settings, - - opening the Privacy dialog, and selecting Remember. If the user selects Remember, Flash Player no longer - - asks the user whether to allow or deny SWF files from this domain access to your camera.

- - - -

Note: The attachCamera() method will not invoke the dialog box - - to Allow or Deny access to the camera if the user has denied access by selecting Remember - - in the Flash Player Settings dialog box. In this case, you can prompt the user to change the - - Allow or Deny setting by displaying the Flash Player Privacy panel for the user - - using Security.showSettings(SecurityPanel.PRIVACY).

- - - -

If getCamera() returns null, either the camera is in use by another - - application, or there are no cameras installed on the system. To determine whether any cameras - - are installed, use the names.length property. To display the Flash Player Camera Settings panel, - - which lets the user choose the camera to be referenced by getCamera(), use - - Security.showSettings(SecurityPanel.CAMERA).

- - -

Scanning the hardware for cameras takes time. When the runtime finds at least one camera, - - the hardware is not scanned again for the lifetime of the player instance. However, if - - the runtime doesn't find any cameras, it will scan each time getCamera is called. - - This is helpful if the camera is present but is disabled; if your SWF file provides a - - Try Again button that calls getCamera, Flash Player can find the camera without the - - user having to restart the SWF file.

- - - Parameters - - - - -
name:String (default = null) — Specifies which camera to get, as determined from the array - - returned by the names property. For most applications, get the default camera - - by omitting this parameter. To specify a value for this parameter, use the string representation - - of the zero-based index position within the Camera.names array. For example, to specify the third - - camera in the array, use Camera.getCamera("2"). - - -
-

-Returns - - - - -
Camera — - If the name parameter is not specified, this method returns a reference - - to the default camera or, if it is in use by another application, to the first - - available camera. (If there is more than one camera installed, the user may specify - - the default camera in the Flash Player Camera Settings panel.) If no cameras are available - - or installed, the method returns null. - - - - - -
-
-Events - - - - -
status:StatusEvent — Dispatched when a camera reports its status. - - Before accessing a camera, Flash Player displays a Privacy dialog box to let users - - allow or deny access to their camera. If the value of the code property is "Camera.Muted", - - the user has refused to allow the SWF file access to the user's camera. - - If the value of the code property is "Camera.Unmuted", - - the user has allowed the SWF file access to the user's camera.
-

-See also -

-
-index -
-muted -
-names -
-setMode() -
-status -
-Video.attachCamera() -
-
-Example -
In the following example, after the user allows access to the camera, the attached - camera is used to capture video images. Information about the video stream, such as - the current frames per second, is also displayed. - -

The Camera.getCamera() method returns a reference to a camera object, or returns null if - no camera is available or installed. The if statement checks whether the camera was found and whether - the user allowed access to the camera. If the user denied access, the muted - property is set to true.

- -

Usually, when the attachCamera() method is invoked, a dialog box appears and prompts the - user to allow or deny Flash Player access to the camera. However, if the user denied access - and selected the Remember option, the dialog box does not appear and nothing displays. - To make sure the user has the option to allow access to the camera, the myTextField text field - instructs the user to click the text field to invoke the Flash Player Settings dialog box.

- -

The clickHandler() method calls Security.showSettings() method, which - displays the PRIVACY panel of the Settings dialog box. If the user allows access, - the StatusEvent.STATUS event is dispatched and the value of the event's code - property is set to Camera.Unmuted. (The camera object's mute property is also - set to false.)

- -

The statusHandler() method, added to listen to the status change of the user's setting, - invokes the connectCamera() method, if the user allows access. The connectCamera() - method instantiates a video object with the captured stream's width and height. To display the - camera's captured video, the reference to the video stream is attached to the video object, and the video - object is added to the display list.

- -

A Timer object also is started. Every second, a Timer object's timer event is dispatched and the - timerHandler() method is invoked. The timerHandler() method is displayed and updates - a number of properties of the Camera object.

-

Note: For this example, the only property that changes - is the currentFPS property.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.media.Camera;
-    import flash.media.Video;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.utils.Timer;
-    import flash.events.TimerEvent;
-    import flash.events.StatusEvent;
-    import flash.events.MouseEvent;
-    import flash.system.SecurityPanel;
-    import flash.system.Security;
-
-    public class Camera_getCameraExample extends Sprite {
-        private var myTextField:TextField;
-        private var cam:Camera;
-        private var t:Timer = new Timer(1000);
-        
-        public function Camera_getCameraExample() {
-            myTextField = new TextField();
-            myTextField.x = 10;
-            myTextField.y = 10;
-            myTextField.background = true;
-            myTextField.selectable = false;
-            myTextField.autoSize = TextFieldAutoSize.LEFT;    
-        
-            if (Camera.isSupported)
-        	{
-	            cam = Camera.getCamera();
-	            
-	         	if (!cam) {
-	                myTextField.text = "No camera is installed.";
-	                
-	            } else if (cam.muted) {
-	                myTextField.text = "To enable the use of the camera,\n"
-	                                 + "please click on this text field.\n" 
-	                                 + "When the Flash Player Settings dialog appears,\n"
-	                                 + "make sure to select the Allow radio button\n" 
-	                                 + "to grant access to your camera.";
-	
-	                myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-	
-	            }else {
-	                myTextField.text = "Connecting";
-	                connectCamera(); 
-	            }
-	   
-	            addChild(myTextField);
-	
-	            t.addEventListener(TimerEvent.TIMER, timerHandler);
-	        }else {
-	        	myTextField.text = "The Camera class is not supported on this device.";
-	        }
-        }
-
-        private function clickHandler(e:MouseEvent):void {
-            Security.showSettings(SecurityPanel.PRIVACY);
-
-            cam.addEventListener(StatusEvent.STATUS, statusHandler);
-
-            myTextField.removeEventListener(MouseEvent.CLICK, clickHandler);
-        }
-
-        private function statusHandler(event:StatusEvent):void {
-
-            if (event.code == "Camera.Unmuted") {
-                connectCamera(); 
-                cam.removeEventListener(StatusEvent.STATUS, statusHandler);
-            }
-        }
-
-        private function connectCamera():void {
-                var vid:Video = new Video(cam.width, cam.height);
-                vid.x = 10;
-                vid.y = 10;
-                vid.attachCamera(cam);
-                addChild(vid);    
-
-                t.start();
-        }
-
-        private function timerHandler(event:TimerEvent):void {
-            myTextField.y = cam.height + 20;
-            myTextField.text = "";
-            myTextField.appendText("bandwidth: " + cam.bandwidth + "\n");
-            myTextField.appendText("currentFPS: " + Math.round(cam.currentFPS) + "\n");
-            myTextField.appendText("fps: " + cam.fps + "\n");
-            myTextField.appendText("keyFrameInterval: " + cam.keyFrameInterval + "\n");
-        }
-    }
-}
-
-

-
- - - - - -
requestPermission()method 
-
-public function requestPermission():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24.0 - -
-

- - Requests camera permission for the application. - - - -


-Events - - - - -
PermissionStatus:PermissionEvent — dispatched when the requested permission is granted/denied by the user.
-
- - - - - -
setKeyFrameInterval()method 
-
-public function setKeyFrameInterval(keyFrameInterval:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies which video frames are transmitted in full (called keyframes) - - instead of being interpolated by the video compression algorithm. This method - - is applicable only if you are transmitting video using Flash Media Server. - - - -

The Flash Video compression algorithm compresses video by transmitting - - only what has changed since the last frame of the video; these portions are - - considered to be interpolated frames. Frames of a video can be interpolated according - - to the contents of the previous frame. A keyframe, however, is a video frame that - - is complete; it is not interpolated from prior frames.

- - - -

To determine how to set a value for the keyFrameInterval parameter, - - consider both bandwidth use and video playback accessibility. For example, - - specifying a higher value for keyFrameInterval (sending keyframes less frequently) - - reduces bandwidth use. - - However, this may increase the amount of time required to position the playhead - - at a particular point in the video; more prior video frames may have to be interpolated - - before the video can resume.

- - - -

Conversely, specifying a lower value for keyFrameInterval - - (sending keyframes more frequently) increases bandwidth use because entire video frames - - are transmitted more often, but may decrease the amount of time required to seek a - - particular video frame within a recorded video.

- - - - Parameters - - - - -
keyFrameInterval:int — A value that specifies which video frames are transmitted in full - - (as keyframes) instead of being interpolated by the video compression algorithm. - - A value of 1 means that every frame is a keyframe, a value of 3 means that every third frame - - is a keyframe, and so on. Acceptable values are 1 through 48. - - -
-
-Throws - - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-keyFrameInterval -
-
- - - - - -
setLoopback()method 
-
-public function setLoopback(compress:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Specifies whether to use a compressed video stream for a local view of the camera. - - This method is applicable only if you are transmitting video using Flash Media Server; - - setting compress to true lets you see more precisely how the video - - will appear to users when they view it in real time. - - - -

Although a compressed stream is useful for testing purposes, such as previewing video - - quality settings, it has a significant processing cost, because the local view is not - - simply compressed; it is compressed, edited for transmission as it would be over a live - - connection, and then decompressed for local viewing.

- - - -

To set the amount of compression used when you set compress to true, - - use Camera.setQuality().

- - - - Parameters - - - - -
compress:Boolean (default = false) — Specifies whether to use a compressed video stream (true) - - or an uncompressed stream (false) for a local view of what the camera - - is receiving. - -
-
-Throws - - - - -
PermissionError — The application does not have permission to use camera. - - - -
-

-See also -

-
-setQuality() -
-
- - - - - -
setMode()method 
-
-public function setMode(width:int, height:int, fps:Number, favorArea:Boolean = true):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Sets the camera capture mode to the native mode that best meets the specified requirements. - - If the camera does not have a native mode that matches all the parameters you pass, - - the runtime selects a capture mode that most closely synthesizes the requested mode. - - This manipulation may involve cropping the image and dropping frames. - - -

By default, the runtime drops frames as needed to maintain image size. To minimize the number - - of dropped frames, even if this means reducing the size of the image, pass false - - for the favorArea parameter.

- - -

When choosing a native mode, the runtime tries to maintain the requested aspect ratio - - whenever possible. For example, if you issue the command myCam.setMode(400, 400, 30), - - and the maximum width and height values available on the camera are 320 and 288, the runtime sets - - both the width and height at 288; by setting these properties to the same value, the runtime - - maintains the 1:1 aspect ratio you requested.

- - -

To determine the values assigned to these properties after the runtime selects the mode - - that most closely matches your requested values, use the width, height, - - and fps properties.

- - - -

- - If you are using Flash Media Server, you can also capture single frames or create time-lapse - - photography. For more information, see NetStream.attachCamera(). - -

- - - Parameters - - - - - - - - - - - - - - - - - - - - - - -
width:int — The requested capture width, in pixels. The default value is 160. - -
 
height:int — The requested capture height, in pixels. The default value is 120. - -
 
fps:Number — The requested rate at which the camera should capture data, in frames per second. - - The default value is 15. - -
 
favorArea:Boolean (default = true) — Specifies whether to manipulate the width, height, and frame rate if - - the camera does not have a native mode that meets the specified requirements. - - The default value is true, which means that maintaining capture size - - is favored; using this parameter selects the mode that most closely matches - - width and height values, even if doing so adversely affects - - performance by reducing the frame rate. To maximize frame rate at the expense - - of camera height and width, pass false for the favorArea parameter. - - - - -
-
-Throws - - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-fps -
-height -
-width -
-flash.net.NetStream.attachCamera() -
-
-Example -
In the following example, when a user clicks on the Stage, the video - is resized and the frames per second capture rate is set to a new value. - -

The Stage is set so it does not scale. The Camera.getCamera() method - returns a reference to a camera object, or returns null if no camera is available or installed. - If a camera exists, the connectCamera() method is called. - The connectCamera() method instantiates a video object. To - display the camera's captured video, the reference to the video stream is attached - to the video object, and the video object is added to the display list. An event listener - also is set for a MouseEvent.CLICK event. After the user clicks on the Stage, - the clickHandler() method is invoked. The method checks the width of the - captured video and sets the camera capture mode's width, height, and the frame per second - request rate. In order for these setting to take effect, the video object must be removed - and re-created. The video's width and height also must be set to the camera object's width - and height.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.media.Camera;
-    import flash.media.Video;
-    import flash.events.MouseEvent;
-    import flash.display.StageScaleMode;
-
-    public class Camera_setModeExample extends Sprite {
-        private var cam:Camera;
-        private var vid:Video;
-
-        public function Camera_setModeExample() {
-            stage.scaleMode = StageScaleMode.NO_SCALE;
-
-            cam = Camera.getCamera();
-            
-            if (!cam) {
-                trace("No camera is installed.");
-            }else {
-                connectCamera();
-            }
-        }
-
-        private function connectCamera():void {
-            vid = new Video();
-            vid.width = cam.width;
-            vid.height = cam.height; 
-            vid.attachCamera(cam);
-            addChild(vid);    
-
-            stage.addEventListener(MouseEvent.CLICK, clickHandler);
-        }
-    
-        private function clickHandler(e:MouseEvent):void {
-
-            switch (cam.width) {
-                case 160:
-                cam.setMode(320, 240, 10); 
-                break;
-                case 320:
-                cam.setMode(640, 480, 5); 
-                break;
-                default:
-                cam.setMode(160, 120, 15); 
-                break;
-            } 
-
-            removeChild(vid);           
-            connectCamera();
-        }
-    }
-}
-
-

-
- - - - - -
setMotionLevel()method 
-
-public function setMotionLevel(motionLevel:int, timeout:int = 2000):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies how much motion is required to dispatch the activity event. - - Optionally sets the number of milliseconds that must elapse without activity before - - the runtime considers motion to have stopped and dispatches the event. - -

Note: Video can be displayed regardless of the value of the - - motionLevel parameter. This parameter determines only when and under - - what circumstances the event is dispatched—not whether video is actually being - - captured or displayed.

- -

- - To prevent the camera from detecting motion at all, pass a value of 100 for the - - motionLevel parameter; the activity event is never dispatched. - - (You would probably use this value only for testing purposes—for example, to - - temporarily disable any handlers that would normally be triggered when the event is dispatched.) - -

- -

- - To determine the amount of motion the camera is currently detecting, use the - - activityLevel property. - - Motion sensitivity values correspond directly to activity values. - - Complete lack of motion is an activity value of 0. Constant motion is an activity value of 100. - - Your activity value is less than your motion sensitivity value when you're not moving; - - when you are moving, activity values frequently exceed your motion sensitivity value. - -

- -

- - This method is similar in purpose to the Microphone.setSilenceLevel() method; - - both methods are used to specify when the activity event - - should be dispatched. However, these methods have a significantly different impact - - on publishing streams: - -

- - - -
    - -
  • Microphone.setSilenceLevel() is designed to optimize bandwidth. - - When an audio stream is considered silent, no audio data is sent. Instead, a single message - - is sent, indicating that silence has started.
    • - -
  • Camera.setMotionLevel() is designed to detect motion and does not affect - - bandwidth usage. Even if a video stream does not detect motion, video is still sent.
    • - -
- - - - - Parameters - - - - - - - - - - -
motionLevel:int — Specifies the amount of motion required to dispatch the - - activity event. Acceptable values range from 0 to 100. The default value is 50. - - -
 
timeout:int (default = 2000) — Specifies how many milliseconds must elapse without activity - - before the runtime considers activity to have stopped and dispatches the activity event. - - The default value is 2000 milliseconds (2 seconds). - - -
-
-Throws - - - - -
PermissionError — The application does not have permission to use camera. - - - -
-

-See also -

-
-motionLevel -
-motionTimeout -
-Microphone.setSilenceLevel() -
-
-Example -
In the following example, the user's camera is used as a monitor or - a surveillance camera. The camera detects motion and a text field shows - the activity level. (The example can be extended to sound an alarm or - send a message through a web service to other applications.) - -

The Camera.getCamera() method returns a reference to a camera object, - or returns null if no camera is available or installed. The if statement checks whether a camera - is available, and invokes the connectCamera() method when it is available. - The connectCamera() method instantiates a video object with the captured stream's - width and height. To display the camera's captured video, the reference to the - video stream is attached to the video object, and the video object is added to the display list. - (Usually, when the attachCamera() method is invoked, a dialog box appears and - prompts the user to allow or deny Flash Player access to the camera. However, if the - user denied access and selected the Remember option, the dialog box does not appear - and nothing is displayed. To make sure the user has the option to allow access to the camera, use the - system.Security.showSettings() method to invoke the Flash Player - Settings dialog box.)

- -

The setMotionLevel() method sets the level of activity (amount of motion), before - the activity event is invoked, to five, for minimal motion. The time between when the camera stops - detecting motion and when the activity event is invoked, is set to 1 second (1000 millisecond). After 1 second - passes without activity or the level of activity reaches five, the ActivityEvent.ACTIVITY - event is dispatched and the activityHandler() method is invoked. If the event - was triggered by the level of activity, the activating property is set to - true and a Timer object is started. Every second, a Timer object’s timer event - is dispatched and the timerHandler() method is invoked, which displays the current - level of activity. (Although a level of five or larger triggers the timer, the displayed - current level of activity might be a smaller number.)

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.media.Camera;
-    import flash.media.Video;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.utils.Timer;
-    import flash.events.TimerEvent;
-    import flash.events.ActivityEvent;
-
-    public class Camera_setMotionLevelExample extends Sprite {
-        private var myTextField:TextField;
-        private var cam:Camera;
-        private var t:Timer = new Timer(1000);
-
-        public function Camera_setMotionLevelExample() {
-            myTextField = new TextField();
-            myTextField.background = true;
-            myTextField.selectable = false;
-            myTextField.autoSize = TextFieldAutoSize.LEFT;    
-        
-            cam = Camera.getCamera();
-            
-            if (!cam) {
-                myTextField.text = "No camera is installed.";
-
-            }else {
-                myTextField.text = "Waiting to connect.";
-                connectCamera(); 
-            }
-
-            addChild(myTextField);
-
-            t.addEventListener(TimerEvent.TIMER, timerHandler);
-        }
-
-        private function connectCamera():void {
-                var vid:Video = new Video(cam.width, cam.height);
-                vid.x = 10;
-                vid.y = 10;
-                vid.attachCamera(cam);
-                addChild(vid);    
-
-                cam.setMotionLevel(5, 1000);
-                cam.addEventListener(ActivityEvent.ACTIVITY, activityHandler);
-        }
-
-        private function activityHandler(e:ActivityEvent):void {
-            if (e.activating == true) {
-                t.start();    
-            } else {
-                myTextField.text = "Everything is quiet.";
-                t.stop();
-            }    
-        }
-
-        private function timerHandler(event:TimerEvent):void {
-             myTextField.x = 10;
-             myTextField.y = cam.height + 20;
-             myTextField.text = "There is some activity. Level: " + cam.activityLevel;
-        }
-    }
-}
-
-

-
- - - - - -
setQuality()method 
-
-public function setQuality(bandwidth:int, quality:int):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Sets the maximum amount of bandwidth per second or the required picture quality - - of the current outgoing video feed. This method is generally applicable only if - - you are transmitting video using Flash Media Server. - - -

Use this method to specify which element of the outgoing video feed is more - - important to your application—bandwidth use or picture quality.

- - -
    - -
  • To indicate that bandwidth use takes precedence, pass a value for bandwidth - - and 0 for quality. The runtime transmits video at the highest quality - - possible within the specified bandwidth. If necessary, the runtime reduces picture - - quality to avoid exceeding the specified bandwidth. In general, as motion increases, - - quality decreases.
    • - -
  • To indicate that quality takes precedence, pass 0 for bandwidth - - and a numeric value for quality. The runtime uses as much bandwidth - - as required to maintain the specified quality. If necessary, the runtime reduces the frame - - rate to maintain picture quality. In general, as motion increases, bandwidth use also - - increases.
    • - -
  • To specify that both bandwidth and quality are equally important, pass numeric - - values for both parameters. The runtime transmits video that achieves the specified quality - - and that doesn't exceed the specified bandwidth. If necessary, the runtime reduces the - - frame rate to maintain picture quality without exceeding the specified bandwidth.
    • - -
- - - Parameters - - - - - - - - - - -
bandwidth:int — Specifies the maximum amount of bandwidth that the current outgoing video - - feed can use, in bytes per second. To specify that the video can use as much bandwidth - - as needed to maintain the value of quality, pass 0 for - - bandwidth. The default value is 16384. - - -
 
quality:int — An integer that specifies the required level of picture quality, - - as determined by the amount of compression being applied to each video frame. - - Acceptable values range from 1 (lowest quality, maximum compression) to 100 (highest - - quality, no compression). To specify that picture quality can vary as needed to avoid - - exceeding bandwidth, pass 0 for quality. - - -
-
-Throws - - - - -
PermissionError — The application does not have permission to use camera. - - -
-

-See also -

-
-getCamera() -
-quality -
-
-
Event detail
- - - - - -
activityevent 
-
-Event object type: flash.events.ActivityEvent -
-ActivityEvent.type property = flash.events.ActivityEvent.ACTIVITY -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Dispatched when a camera begins or ends a session. - - Call Camera.setMotionLevel() to specify the amount of motion - - required to trigger an activity event with an activating - - value of true, or the time without activity - - that must elapse before triggering an activity event with an activating - - value of false. - - - - - - - -

- The ActivityEvent.ACTIVITY constant defines the value of the type property of an activity event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
activatingtrue if the device is activating or false if it is deactivating.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object beginning or ending a session, such as a Camera or - Microphone object.
- -
- - - - - -
permissionStatusevent  
-
-Event object type: flash.events.PermissionEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24.0 - -
-

- - Dispatched when the application requests permission to use camera on the device. - - Check the value of status property to determine whether - - the permission was granted or denied - - -

-See also -

-
-Camera.requestPermission() -
-flash.permissions.PermissionStatus -
-
- - - - - -
statusevent  
-
-Event object type: flash.events.StatusEvent -
-StatusEvent.type property = flash.events.StatusEvent.STATUS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR (unsupported) - -
-

- - Dispatched when a camera reports its status. - - Before accessing a camera, the runtime displays a Privacy dialog box to let users - - allow or deny access to their camera. If the value of the code property is "Camera.Muted", - - the user has refused to allow the SWF file access to the user's camera. - - If the value of the code property is "Camera.Unmuted", - - the user has allowed the SWF file access to the user's camera. - - -

Note: This event is not dispatched on the AIR platform. It is used only in Flash Player.

- -

- Defines the value of the type property of a status event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
codeA description of the object's status.
currentTargetThe object that is actively processing the Event - object with an event listener.
levelThe category of the message, such as "status", "warning" or "error".
targetThe object reporting its status.
- -

-See also -

-
-Camera.getCamera() -
-
- - - - - -
videoFrameevent  
-
-Event object type: flash.events.Event -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Dispatched after a new camera frame is processed by the runtime and is available to be copied. - - -

-See also -

-
-Camera.getCamera() -
-
- -
Examples
-
examples\CameraExample
-
The following example shows the image from a camera after acknowledging the - security warning. The Stage is set such that it cannot be scaled and is aligned to the - top-left of the player window. The activity event is dispatched at the - start and end (if any) of the session and is captured by the activityHandler() - method, which prints out information about the event. - -

Note: A camera must be attached to your computer for this example - to work correctly.

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.display.StageAlign;
-    import flash.display.StageScaleMode;
-    import flash.events.*;
-    import flash.media.Camera;
-    import flash.media.Video;
-
-    public class CameraExample extends Sprite {
-        private var video:Video;
-        
-        public function CameraExample() {
-            stage.scaleMode = StageScaleMode.NO_SCALE;
-            stage.align = StageAlign.TOP_LEFT;
-            
-            var camera:Camera = Camera.getCamera();
-            
-            if (camera != null) {
-                camera.addEventListener(ActivityEvent.ACTIVITY, activityHandler);
-                video = new Video(camera.width * 2, camera.height * 2);
-                video.attachCamera(camera);
-                addChild(video);
-            } else {
-                trace("You need a camera.");
-            }
-        }
-        
-        private function activityHandler(event:ActivityEvent):void {
-            trace("activityHandler: " + event);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/CameraPosition.html b/html-docs/flash/media/CameraPosition.html deleted file mode 100644 index a27c020..0000000 --- a/html-docs/flash/media/CameraPosition.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - - - -flash.media.CameraPosition (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class CameraPosition
InheritanceCameraPosition Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

-

- The CameraPosition class defines constants for the position property of the - Camera class. -

Each of these constants represents a set of values for the Camera's position property.

-

-

-See also -

-
-flash.media.Camera -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  BACK : String = "back"
[static] - The Camera.position property returns this for a back camera.
-		CameraPosition
  FRONT : String = "front"
[static] - The Camera.position property returns this for a front camera.
-		CameraPosition
  UNKNOWN : String -
[static] - The Camera.position property returns this when the position of the Camera cannot be determined.
-		CameraPosition
-
- -
- -
Constant detail
- - - - - -
BACKconstant
-
-public static const BACK:String = "back" -

- - - - -
Runtime version: AIR 3.0 -
-

- The Camera.position property returns this for a back camera. -

- - - - - -
FRONTconstant 
-
-public static const FRONT:String = "front" -

- - - - -
Runtime version: AIR 3.0 -
-

- The Camera.position property returns this for a front camera. -

- - - - - -
UNKNOWNconstant 
-
-public static const UNKNOWN:String -

- - - - -
Runtime version: AIR 3.0 -
-

- The Camera.position property returns this when the position of the Camera cannot be determined. - This is the default value. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/CameraRoll.html b/html-docs/flash/media/CameraRoll.html deleted file mode 100644 index f22840f..0000000 --- a/html-docs/flash/media/CameraRoll.html +++ /dev/null @@ -1,971 +0,0 @@ - - - - - - - - -flash.media.CameraRoll (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic class CameraRoll
InheritanceCameraRoll Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-The CameraRoll class allows you to access image data in the system media library or "camera roll." - -

AIR profile support: This feature is supported -on mobile devices, but it is not supported on desktop operating systems or AIR for TV devices. See - -AIR Profile Support for more information regarding API support across multiple profiles.

- -

The CameraRoll.addBitmapData() method adds an image to the device's dedicated media library. To check at run time whether your -application supports the CameraRoll.addBitmapData() method, check the CameraRoll.supportsAddBitmapData property.

- -

The CameraRoll.browseForImage() method opens an image-choosing dialog that allows a user to choose an image in the - media library. When the user selects an image, the CameraRoll object dispatches a select event. Use the MediaEvent object - dispatched for this event to access the chosen image. To check at run time whether your -application supports the CameraRoll.browseForImage() method, check the CameraRoll.supportsBrowseForImage property.

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  permissionStatus : String -
[static][read-only] - Determine whether the application has been granted the permission to access camera roll.
-		CameraRoll
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  supportsAddBitmapData : Boolean -
[static][read-only] - Whether the CameraRoll.addBitmapData() method is supported.
-		CameraRoll
  supportsBrowseForImage : Boolean -
[static][read-only] - Reports whether the CameraRoll.browseForImage() method is supported.
-		CameraRoll
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-CameraRoll()
-
- Creates a CameraRoll object.
-		CameraRoll
   -
-addBitmapData(bitmapData:BitmapData):void -
-
- Adds an image to the device camera roll.
-		CameraRoll
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-browseForImage(value:CameraRollBrowseOptions = null):void -
-
- Opens an image browser dialog to allow the user to select an existing image from the device camera roll.
-		CameraRoll
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-requestPermission():void -
-
- Requests permission to access system media library or "camera roll".
-		CameraRoll
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-cancel -
-		 - Dispatched when a user cancels a browse-for-image operation without selecting an image.CameraRoll
   -
-complete -
-		 - Signals that an addBitmapData() operation completed successfully.CameraRoll
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-error -
-		 - The error event is dispatched when an error occurs.CameraRoll
   -
-permissionStatus -
-		 - Dispatched when the application requests permission to access camera roll.CameraRoll
   -
-select -
-		 - Dispatched when a user selects an image from the device media library.CameraRoll
-
- -
- -
Property detail
- - - - - -
permissionStatusproperty
-
-permissionStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Determine whether the application has been granted the permission to access camera roll. -

Implementation -
-    public static function get permissionStatus():String -
-

-See also -

-
-flash.permissions.PermissionStatus -
-
- - - - - -
supportsAddBitmapDataproperty 
-
-supportsAddBitmapData:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Whether the CameraRoll.addBitmapData() method is supported. Currently, the feature - is only supported in AIR applications on mobile devices. -

Implementation -
-    public static function get supportsAddBitmapData():Boolean -
-
- - - - - -
supportsBrowseForImageproperty 
-
-supportsBrowseForImage:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Reports whether the CameraRoll.browseForImage() method is supported. Currently, the feature - is only supported in AIR applications on mobile devices. -

Implementation -
-    public static function get supportsBrowseForImage():Boolean -
-
- -
Constructor detail
- - - - - -
CameraRoll()constructor
-
-public function CameraRoll() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a CameraRoll object. - -

There is only a single media library supported by ActionScript. All CameraRoll objects - save to the same image repository.

- -
- -
Method detail
- - - - - -
addBitmapData()method
-
-public function addBitmapData(bitmapData:BitmapData):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Adds an image to the device camera roll. - - -

To check at run time whether your application supports the CameraRoll.addBitmapData() method, - check the CameraRoll.supportsAddBitmapData property.

- Parameters - - - - -
bitmapData:BitmapData — a BitmapData object containing the image to send to the camera roll. -
-
-Throws - - - - -
PermissionError — The application does not have permission to use camera. -
-
- - - - - -
browseForImage()method 
-
-public function browseForImage(value:CameraRollBrowseOptions = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Opens an image browser dialog to allow the user to select an existing image from the device camera roll. - -

When the user selects an image, this CameraRoll instance dispatches a select event containing a MediaEvent - object. Use the data property of the MediaEvent object to load the image. The data property - is a MediaPromise object, which you can load using the loadFilePromise() method of the Loader class. - Note that the MediaPromise object contains a valid file object on some platforms (Blackberry Tablet OS), but not on others - (iOS and Android). When you use the loadFilePromise() method, the image is loaded properly - on all platforms. To access the raw data from the media object, you can open the data source provided by - the media promise and read the data using the methods from the IDataInput interface.

- -

To check at run time whether your application supports the CameraRoll.browseForImage() method, - check the CameraRoll.supportsBrowseForImage property.

-

On iOS (and only on the iPad) you can request a specific size for the image browser dialog. - You can also specify an area of the screen that you don't want the image browser dialog to cover. - This request works only on the iPad, because on that device the image browser does not occupy the entire screen.

-

To request size and placement options for the image browser (for iPad), pass a CameraRollBrowseOptions object - to browseForImage(). With no parameters, this method positions the dialog in the display's top-left - corner, using system defaults for the dialog's dimensions. -

- Parameters - - - - -
value:CameraRollBrowseOptions (default = null) — A CameraRollBrowseOptions object that you can use to specify options for displaying the image roll dialog. - This parameter is optional. -
-
-Events - - - - - - - - - - - - - - - - - - - - - - -
select:MediaEvent — Dispatched when the user chooses an image.
 
cancel:Event — Dispatched when a user cancels the browse operation.
 
error:ErrorEvent — Dispatched if the default image browser application is already in use.
 
error:ErrorEvent — Dispatched if the AIR application is in the background when it calls this function.
-
-Throws - - - - -
PermissionError — The application does not have permission to use camera. -
-

-See also -

-
-MediaEvent -
-MediaPromise -
-Loader.loadFilePromise() -
-Uploading images from CameraRoll and CameraUI -
-
-Example -
-
-
package flash.media.examples
-{
-    	import flash.media.CameraRoll;
-		import flash.media.MediaPromise;
-		import flash.media.MediaType;
-		import flash.events.MediaEvent;
-		import flash.events.Event;
-		import flash.display.Loader;
-		import flash.display.Sprite;
-		import flash.events.IOErrorEvent;
-		import flash.display.StageAlign;
-		import flash.display.StageScaleMode;
-		
-		public class CameraRollTest extends Sprite{
-			private var mediaSource:CameraRoll = new CameraRoll();
-			
-			public function CameraRollTest() {
-				this.stage.align = StageAlign.TOP_LEFT;
-				this.stage.scaleMode = StageScaleMode.NO_SCALE;
-				
-				if( CameraRoll.supportsBrowseForImage )
-				{
-					log( "Browsing for image..." );
-					mediaSource.addEventListener( MediaEvent.SELECT, imageSelected );
-					mediaSource.addEventListener( Event.CANCEL, browseCanceled );
-					
-					mediaSource.browseForImage();
-				}
-				else
-				{
-					log( "Browsing in camera roll is not supported.");
-				}
-			}
-			
-			private var imageLoader:Loader; 
-			private function imageSelected( event:MediaEvent ):void
-			{
-				log( "Image selected..." );
-				
-				var imagePromise:MediaPromise = event.data;
-				
-				imageLoader = new Loader();
-				if( imagePromise.isAsync )
-				{
-					log( "Asynchronous media promise." );
-					imageLoader.contentLoaderInfo.addEventListener( Event.COMPLETE, imageLoaded );
-					imageLoader.contentLoaderInfo.addEventListener( IOErrorEvent.IO_ERROR, imageLoadFailed );
-					imageLoader.loadFilePromise( imagePromise );
-				}
-				else
-				{
-					log( "Synchronous media promise." );
-					imageLoader.loadFilePromise( imagePromise );
-					this.addChild( imageLoader );
-				}
-			}
-			
-			private function browseCanceled( event:Event ):void
-			{
-				log( "Image browse canceled." );
-			}
-			
-			private function imageLoaded( event:Event ):void
-			{
-				log( "Image loaded asynchronously." );
-				this.addChild( imageLoader );
-			}
-			
-			private function imageLoadFailed( event:Event ):void
-			{
-				log( "Image load failed." );
-			}
-			
-			private function log( text:String ):void
-			{
-				trace( text );
-			}
-			
-		}
-		
-	}
-
-

-
- - - - - -
requestPermission()method 
-
-public function requestPermission():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Requests permission to access system media library or "camera roll". - -


-Events - - - - -
PermissionStatus:PermissionEvent — dispatched when the requested permission is granted/denied by the user.
-
-
Event detail
- - - - - -
cancelevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CANCEL -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Dispatched when a user cancels a browse-for-image operation without selecting an image. - -

- The Event.CANCEL constant defines the value of the type property of a cancel event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetA reference to the object on which the operation is canceled.
-
- - - - - -
completeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that an addBitmapData() operation completed successfully. -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
- - - - - -
errorevent  
-
-Event object type: flash.events.ErrorEvent -
-ErrorEvent.type property = flash.events.ErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The error event is dispatched when an error occurs. - -

Sources of errors include:

-
    -
  • An image browser cannot be opened.
    • -
  • An image browser is already in use.
    • -
  • The AIR application attempts to browse for an image while in the background.
    • -
  • An image cannot be added to the media library.
    • -
  • A method is called that is not supported on the device.
    • -
  • The AIR application attempts to load a remote image without an internet connection.
    • -
- -

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -
- - - - - -
permissionStatusevent  
-
-Event object type: flash.events.PermissionEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Dispatched when the application requests permission to access camera roll. - Check the value of status property to determine whether - the permission was granted or denied -

-See also -

-
-CameraRoll.requestPermission() -
-flash.permissions.PermissionStatus -
-
- - - - - -
selectevent  
-
-Event object type: flash.events.MediaEvent -
-MediaEvent.type property = flash.events.MediaEvent.SELECT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Dispatched when a user selects an image from the device media library. - -

The MediaEvent object dispatched for this event provides access to the chosen media.

- -

- A constant for the select MediaEvent. - -

Defines the value of the type property of a MediaEvent event object. - This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe MediaPromise object of the available media instance.
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/CameraRollBrowseOptions.html b/html-docs/flash/media/CameraRollBrowseOptions.html deleted file mode 100644 index 4afe2fa..0000000 --- a/html-docs/flash/media/CameraRollBrowseOptions.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - - - - -flash.media.CameraRollBrowseOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic class CameraRollBrowseOptions
InheritanceCameraRollBrowseOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

-

- The CameraRollBrowseOptions class defines the initialization options that may be used - when using the Camera Roll API to launch the Image Picker. - - This is presently used only on iOS where the image picker does not occupy the entire screen. - On all other platforms and devices these are ignored. -

-

-See also -

-
-flash.media.CameraRoll -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  height : Number -
- Specifies the height of the CameraRoll image picker.
-		CameraRollBrowseOptions
  origin : Rectangle -
- Specifies the origin rect of the object that launched CameraRoll image picker.
-		CameraRollBrowseOptions
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  width : Number -
- Specifies the width of the CameraRoll image picker.
-		CameraRollBrowseOptions
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-CameraRollBrowseOptions()
-
- Creates a new CameraRollBrowseOptions object.
-		CameraRollBrowseOptions
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
heightproperty
-
-height:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Specifies the height of the CameraRoll image picker. -

Note that this is only a request to create the image picker of this height. - However if its not possible to draw the picker of the required size then it is ignored - and the system default value is used. - Specifying a negative value for the height results in an ArgumentError.

-

Note that this is presently being used on iOS (iPad) only.

-

The default value is 0.0.

-Implementation -
-    public function get height():Number -
-    public function set height(value:Number):void -
-
- - - - - -
originproperty 
-
-origin:Rectangle  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Specifies the origin rect of the object that launched CameraRoll image picker. - This is used to position the image picker in such a way that it does not cover this rectangle. - If howeveer the dimensions of the image picker are such that it is not possible - to draw it on the screen without overlapping with this rect then the image picker would overlap with it - Specifying a negative value for either the width or the height would result in an ArgumentError. -

The default value is 0.0.

-Implementation -
-    public function get origin():Rectangle -
-    public function set origin(value:Rectangle):void -
-
- - - - - -
widthproperty 
-
-width:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Specifies the width of the CameraRoll image picker. -

The value should be in range of 320 - 600 for iOS devices. - If the value is outside that range on iOS5 and above or the application is compiled for AIR 3.1 or later, - a value less than 320 is changed to 320 and a value greater than 600 is changed to 600.

-

Note that this is only a request to create the image picker of this width. - However if its not possible to draw the picker of the required size then it is ignored - and the system default value is used. - Specifying a negative value for the width results in an ArgumentError.

-

Note that this option is only used on iOS (iPad).

-

The default value is 0.0.

-Implementation -
-    public function get width():Number -
-    public function set width(value:Number):void -
-
- -
Constructor detail
- - - - - -
CameraRollBrowseOptions()constructor
-
-public function CameraRollBrowseOptions() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Creates a new CameraRollBrowseOptions object. - -

The default values of the newly created object are:

-
    -
  • width = 0.0
    • -
  • height = 0.0
    • -
  • origin = new Rectangle (0.0, 0.0, 0.0, 0.0)
    • -
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/CameraUI.html b/html-docs/flash/media/CameraUI.html deleted file mode 100644 index 9766228..0000000 --- a/html-docs/flash/media/CameraUI.html +++ /dev/null @@ -1,864 +0,0 @@ - - - - - - - - -flash.media.CameraUI (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic class CameraUI
InheritanceCameraUI Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

-

- The CameraUI class allows you to capture a still image or video using the default camera application on a device. - -

The launch() method requests that the device open the default camera application. - The captured image or video is available in the MediaEvent object dispatched for the complete event. - Since the default camera application can save the image or video in a variety of formats, there - is no guarantee that returned media object can be loaded and displayed by the AIR runtime.

- -

On some platforms, the media object returned by the camera is accessible as a file-based media promise. On others, - the media promise is not file-based and the file and relativePath - properties of the MediaPromise object are null. Do not use these properties in - code that is used on more than one platform.

-

On Android, the default camera application does not open if the external storage card is not available - (such as when the user has mounted the card as a USB mass storage device). In addition, the AIR application - that launches the camera loses focus. If the device runs low on resources, the AIR application can be - terminated by the operating system before the media capture is complete.

- -

On some platforms, the media object is automatically stored in the device media library. On - platforms on which images and video are not automatically stored by the default camera application, you can use the - CameraRoll addBitmapData() function to store the media object.

- -

AIR profile support: This feature is supported - on mobile devices, but it is not supported on desktop operating systems or AIR for TV devices. You can test - for support at run time using the CameraUI.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

-

-View the examples. -

-

-See also -

-
-Michael Chaize: Android, AIR, and the Camera -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - Reports whether the CameraUI class is supported on the current device.
-		CameraUI
  permissionStatus : String -
[static][read-only] - Determine whether the application has been granted the permission to use camera.
-		CameraUI
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-CameraUI()
-
- Creates a CameraUI object.
-		CameraUI
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-launch(requestedMediaType:String):void -
-
- Launches the default camera application on the device.
-		CameraUI
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-requestPermission():void -
-
- Requests permission to access Camera UI.
-		CameraUI
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-cancel -
-		 - The cancel event is dispatched when the user closes the Camera UI without - saving a picture or video.CameraUI
   -
-complete -
-		 - The complete event is dispatched when the user either captures a still picture or - video in the Camera UI.CameraUI
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-error -
-		 - The error event is dispatched when the default camera cannot be opened.CameraUI
   -
-permissionStatus -
-		 - Dispatched when the application requests permission to access Camera UI.CameraUI
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Reports whether the CameraUI class is supported on the current device. Currently, the feature - is only supported in AIR applications on Android. -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
permissionStatusproperty 
-
-permissionStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Determine whether the application has been granted the permission to use camera. -

Implementation -
-    public static function get permissionStatus():String -
-

-See also -

-
-flash.permissions.PermissionStatus -
-
- -
Constructor detail
- - - - - -
CameraUI()constructor
-
-public function CameraUI() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Creates a CameraUI object. - -

- -
Method detail
- - - - - -
launch()method
-
-public function launch(requestedMediaType:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Launches the default camera application on the device. - -

You can capture either still images or video with this class. Video capture uses the - "Quality Low" camcorder profile on the device.

- -

When the launch() method is called, the default camera application on - the device is invoked. The AIR application loses focus and waits for the user to - capture a still image or to finish capturing video. Once the desired media is captured by the user, - the AIR application regains focus and this CameraUI object dispatches a complete - event. If the user cancels the operation, this CameraUI object dispatches a cancel - event instead.

- -

Note: It is possible for the AIR application to be shut down by the Android operating - system while it is in the background waiting for the user to capture an image or video. If this happens, - the user must restart the application. The AIR application does not dispatch a media event for the - previous image capture.

- -

You can access the captured media file using the data property of the - MediaEvent object dispatched for the complete event. This property is an instance - of the MediaPromise class, which you can load into your application using the - loadFilePromise() method of the Loader class. Note that the device camera can - save captured media in a variety of formats. Video is particularly problematic in this regard. - It might not be possible to display the captured media in AIR.

- - Parameters - - - - -
requestedMediaType:String — The type of media object to capture. The valid values for this parameter - are defined in the MediaType class: -
    -
  • MediaType.IMAGE
    • -
  • MediaType.VIDEO
    • -
- -
-
-Events - - - - - - - - - - - - - - - - - - - - - - -
complete:MediaEvent — Dispatched when a media object is captured.
 
cancel:Event — Dispatched when the user exits from the native camera without capturing a media object.
 
error:ErrorEvent — Dispatched if the default camera application is already in use.
 
error:ErrorEvent — Dispatched if the AIR application is in the background when it calls this function.
-
-Throws - - - - -
PermissionError — The application does not have permission to use Camera. -
-

-See also -

-
-MediaType -
-MediaPromise -
-Loader.loadFilePromise() -
-
- - - - - -
requestPermission()method 
-
-public function requestPermission():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Requests permission to access Camera UI. - -


-Events - - - - -
PermissionStatus:PermissionEvent — dispatched when the requested permission is granted/denied by the user.
-
-
Event detail
- - - - - -
cancelevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CANCEL -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The cancel event is dispatched when the user closes the Camera UI without - saving a picture or video. -

- The Event.CANCEL constant defines the value of the type property of a cancel event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetA reference to the object on which the operation is canceled.
-
- - - - - -
completeevent  
-
-Event object type: flash.events.MediaEvent -
-MediaEvent.type property = flash.events.MediaEvent.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The complete event is dispatched when the user either captures a still picture or - video in the Camera UI. -

- A constant for the complete MediaEvent. - -

Defines the value of the type property of a MediaEvent event object. - This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe MediaPromise object of the available media instance.
-
- - - - - -
errorevent  
-
-Event object type: flash.events.ErrorEvent -
-ErrorEvent.type property = flash.events.ErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The error event is dispatched when the default camera cannot be opened. -

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -
- - - - - -
permissionStatusevent  
-
-Event object type: flash.events.PermissionEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Dispatched when the application requests permission to access Camera UI. - Check the value of status property to check whether - the permission was granted or denied -

-See also -

-
-CameraUI.requestPermission() -
-flash.permissions.PermissionStatus -
-
- -
Examples
-
examples\CameraUIExample.Still.1
-
The following example uses the CameraUI class to launch the default camera - application on the device. When a picture is taken by the user, the example places the - image on the display list. -
-
-package  {
- import flash.desktop.NativeApplication;
- import flash.display.Loader;
- import flash.display.MovieClip;
- import flash.display.StageAlign;
- import flash.display.StageScaleMode;
- import flash.events.ErrorEvent;
- import flash.events.Event;
- import flash.events.IOErrorEvent;
- import flash.events.MediaEvent;
- import flash.media.CameraUI;
- import flash.media.MediaPromise;
- import flash.media.MediaType;
- 
-     public class CameraUIStillImage extends MovieClip{
-
-	  	private var deviceCameraApp:CameraUI = new CameraUI();
-	  	private var imageLoader:Loader; 
-	
-	  	public function CameraUIStillImage() {
-	   		this.stage.align = StageAlign.TOP_LEFT;
-	   		this.stage.scaleMode = StageScaleMode.NO_SCALE;
-	   
-	   		if( CameraUI.isSupported )
-	   		{
-	    		trace( "Initializing camera..." );
-	
-	    		deviceCameraApp.addEventListener( MediaEvent.COMPLETE, imageCaptured );
-	    		deviceCameraApp.addEventListener( Event.CANCEL, captureCanceled );
-	    		deviceCameraApp.addEventListener( ErrorEvent.ERROR, cameraError );
-	    		deviceCameraApp.launch( MediaType.IMAGE );
-	   		}
-	   		else
-	   		{
-	    		trace( "Camera interface is not supported.");
-	   		}
-	  	}
-	
-	  	private function imageCaptured( event:MediaEvent ):void
-	  	{
-	   		trace( "Media captured..." );
-	   
-	   		var imagePromise:MediaPromise = event.data;
-	   
-	   		if( imagePromise.isAsync )
-	   		{
-	    		trace( "Asynchronous media promise." );
-	    		imageLoader = new Loader();
-	    		imageLoader.contentLoaderInfo.addEventListener( Event.COMPLETE, asyncImageLoaded );
-	    		imageLoader.addEventListener( IOErrorEvent.IO_ERROR, cameraError );
-	    		
-	    		imageLoader.loadFilePromise( imagePromise );
-	   		}
-	   		else
-	   		{
-	    		trace( "Synchronous media promise." );
-	    		imageLoader.loadFilePromise( imagePromise );
-	    		showMedia( imageLoader );
-	   		}
-	  	}
-	
-	  	private function captureCanceled( event:Event ):void
-	  	{
-	   		trace( "Media capture canceled." );
-	   		NativeApplication.nativeApplication.exit();
-	  	}
-	
-	  	private function asyncImageLoaded( event:Event ):void
-	  	{
-	   		trace( "Media loaded in memory." );
-	   		showMedia( imageLoader );    
-	  	}
-	
-	  	private function showMedia( loader:Loader ):void
-	  	{
-	   		this.addChild( loader );
-	  	}
-	  
-	  	private function cameraError( error:ErrorEvent ):void
-	  	{
-	   		trace( "Error:" + error.text );
-	   		NativeApplication.nativeApplication.exit();
-	  	}
- 	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/H264Level.html b/html-docs/flash/media/H264Level.html deleted file mode 100644 index 376dab2..0000000 --- a/html-docs/flash/media/H264Level.html +++ /dev/null @@ -1,695 +0,0 @@ - - - - - - - - -flash.media.H264Level (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class H264Level
InheritanceH264Level Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The H264Level class is an enumeration of constant values used in setting the - level of H264VideoStreamSettings class. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  LEVEL_1 : String = "1"
[static] - Constant for H.264 level 1.
-		H264Level
  LEVEL_1_1 : String = "1.1"
[static] - Constant for H.264 level 1.1.
-		H264Level
  LEVEL_1_2 : String = "1.2"
[static] - Constant for H.264 level 1.2.
-		H264Level
  LEVEL_1_3 : String = "1.3"
[static] - Constant for H.264 level 1.3.
-		H264Level
  LEVEL_1B : String = "1b"
[static] - Constant for H.264 level 1b.
-		H264Level
  LEVEL_2 : String = "2"
[static] - Constant for H.264 level 2.
-		H264Level
  LEVEL_2_1 : String = "2.1"
[static] - Constant for H.264 level 2.1.
-		H264Level
  LEVEL_2_2 : String = "2.2"
[static] - Constant for H.264 level 2.2.
-		H264Level
  LEVEL_3 : String = "3"
[static] - Constant for H.264 level 3.
-		H264Level
  LEVEL_3_1 : String = "3.1"
[static] - Constant for H.264 level 3.1.
-		H264Level
  LEVEL_3_2 : String = "3.2"
[static] - Constant for H.264 level 3.2.
-		H264Level
  LEVEL_4 : String = "4"
[static] - Constant for H.264 level 4.
-		H264Level
  LEVEL_4_1 : String = "4.1"
[static] - Constant for H.264 level 4.1.
-		H264Level
  LEVEL_4_2 : String = "4.2"
[static] - Constant for H.264 level 4.2.
-		H264Level
  LEVEL_5 : String = "5"
[static] - Constant for H.264 level 5.
-		H264Level
  LEVEL_5_1 : String = "5.1"
[static] - Constant for H.264 level 5.1.
-		H264Level
-
- -
- -
Constant detail
- - - - - -
LEVEL_1constant
-
-public static const LEVEL_1:String = "1" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 1. - -

- - - - - -
LEVEL_1_1constant 
-
-public static const LEVEL_1_1:String = "1.1" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 1.1. - -

- - - - - -
LEVEL_1_2constant 
-
-public static const LEVEL_1_2:String = "1.2" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 1.2. - -

- - - - - -
LEVEL_1_3constant 
-
-public static const LEVEL_1_3:String = "1.3" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 1.3. - -

- - - - - -
LEVEL_1Bconstant 
-
-public static const LEVEL_1B:String = "1b" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 1b. - -

- - - - - -
LEVEL_2constant 
-
-public static const LEVEL_2:String = "2" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 2. - -

- - - - - -
LEVEL_2_1constant 
-
-public static const LEVEL_2_1:String = "2.1" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 2.1. - -

- - - - - -
LEVEL_2_2constant 
-
-public static const LEVEL_2_2:String = "2.2" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 2.2. - -

- - - - - -
LEVEL_3constant 
-
-public static const LEVEL_3:String = "3" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 3. - -

- - - - - -
LEVEL_3_1constant 
-
-public static const LEVEL_3_1:String = "3.1" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 3.1. - -

- - - - - -
LEVEL_3_2constant 
-
-public static const LEVEL_3_2:String = "3.2" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 3.2. - -

- - - - - -
LEVEL_4constant 
-
-public static const LEVEL_4:String = "4" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 4. - -

- - - - - -
LEVEL_4_1constant 
-
-public static const LEVEL_4_1:String = "4.1" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 4.1. - -

- - - - - -
LEVEL_4_2constant 
-
-public static const LEVEL_4_2:String = "4.2" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 4.2. - -

- - - - - -
LEVEL_5constant 
-
-public static const LEVEL_5:String = "5" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 5. - -

- - - - - -
LEVEL_5_1constant 
-
-public static const LEVEL_5_1:String = "5.1" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264 level 5.1. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/H264Profile.html b/html-docs/flash/media/H264Profile.html deleted file mode 100644 index ac02fd7..0000000 --- a/html-docs/flash/media/H264Profile.html +++ /dev/null @@ -1,276 +0,0 @@ - - - - - - - - -flash.media.H264Profile (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class H264Profile
InheritanceH264Profile Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The H264Profile class is an enumeration of constant values used in setting the profile - of H264VideoStreamSettings class. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  BASELINE : String = "baseline"
[static] - Constant for H.264/AVC baseline profile.
-		H264Profile
  MAIN : String = "main"
[static] - Constant for H.264/AVC main profile.
-		H264Profile
-
- -
- -
Constant detail
- - - - - -
BASELINEconstant
-
-public static const BASELINE:String = "baseline" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264/AVC baseline profile. This is the default value for - H264VideoStreamSettings class. - -

- - - - - -
MAINconstant 
-
-public static const MAIN:String = "main" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant for H.264/AVC main profile. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/H264VideoStreamSettings.html b/html-docs/flash/media/H264VideoStreamSettings.html deleted file mode 100644 index 57244e1..0000000 --- a/html-docs/flash/media/H264VideoStreamSettings.html +++ /dev/null @@ -1,470 +0,0 @@ - - - - - - - - -flash.media.H264VideoStreamSettings (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic class H264VideoStreamSettings
InheritanceH264VideoStreamSettings Inheritance VideoStreamSettings Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The H264VideoStreamSettings class enables specifying video compression settings for each NetStream. - Properties will be validated once Camera is attached to NetStream and compression - has started. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedbandwidth : int -
- Retrieve the maximum amount of bandwidth that the current outgoing video feed can use, in bytes per second.
-		VideoStreamSettings
  codec : String -
[read-only] - Video codec used for compression.
-		H264VideoStreamSettings
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedfps : Number -
- The maximum frame rate at which the video frames are encoded, in frames per second.
-		VideoStreamSettings
 Inheritedheight : int -
- The current encoded height, in pixels.
-		VideoStreamSettings
 InheritedkeyFrameInterval : int -
- The number of video frames transmitted in full (called keyframes or IDR frames) instead of - being interpolated by the video compression algorithm.
-		VideoStreamSettings
  level : String -
[read-only] - Level used for H.264/AVC encoding.
-		H264VideoStreamSettings
  profile : String -
[read-only] - Profile used for H.264/AVC encoding.
-		H264VideoStreamSettings
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedquality : int -
- The required level of picture quality, as determined by the amount of compression being applied to each video - frame.
-		VideoStreamSettings
 Inheritedwidth : int -
- The current encoded width, in pixels.
-		VideoStreamSettings
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-H264VideoStreamSettings()
-
- Creates a setting object that specifies to use H.264/AVC codec for video compression.
-		H264VideoStreamSettings
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setKeyFrameInterval(keyFrameInterval:int):void -
-
- The number of video frames transmitted in full (called keyframes or Instantaneous Decoding Refresh (IDR) frames) instead of being interpolated by the video compression algorithm.
-		VideoStreamSettings
 Inherited -
-setMode(width:int, height:int, fps:Number):void -
-
- Sets the resolution and frame rate used for video encoding.
-		VideoStreamSettings
   -
-setProfileLevel(profile:String, level:String):void -
-
- Set profile and level for video encoding.
-		H264VideoStreamSettings
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-setQuality(bandwidth:int, quality:int):void -
-
- Sets maximum amount of bandwidth per second or the required picture quality that the current - outgoing video feed can use.
-		VideoStreamSettings
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
codecproperty
-
-codec:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Video codec used for compression. - -

Implementation -
-    public function get codec():String -
-
- - - - - -
levelproperty 
-
-level:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Level used for H.264/AVC encoding. To set the desired value for this - property, please use setProfileLevel() method. This property - can be increased by H.264 codec if the selected level is not high enough - for the specified resolution and frame rate. -

Implementation -
-    public function get level():String -
-
- - - - - -
profileproperty 
-
-profile:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Profile used for H.264/AVC encoding. To set the desired value for this - property, please use setProfileLevel() method. -

Implementation -
-    public function get profile():String -
-
- -
Constructor detail
- - - - - -
H264VideoStreamSettings()constructor
-
-public function H264VideoStreamSettings() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Creates a setting object that specifies to use H.264/AVC codec for video compression. -

- -
Method detail
- - - - - -
setProfileLevel()method
-
-public function setProfileLevel(profile:String, level:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Set profile and level for video encoding. Possible values for profile - are H264Profile.BASELINE and H264Profile.MAIN. Default value is - H264Profile.BASELINE. Other values are ignored and results in an error. - Please see H264Profile class for more information. Supported levels are 1, 1b, - 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1, 4.2, 5, and 5.1. - Level may be increased if required by resolution and frame rate. Please see - H264Level class for more information. -

Parameters - - - - - - - - - - -
profile:String — The requested encoder profile as a String. Please see H264Profile class for possible values. -
 
level:String — The requested encoder level as a String. Please see H264Level class for possible values. -
-
-Throws - - - - -
Error — If invalid profile or level is specified. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/ID3Info.html b/html-docs/flash/media/ID3Info.html deleted file mode 100644 index 809f09e..0000000 --- a/html-docs/flash/media/ID3Info.html +++ /dev/null @@ -1,417 +0,0 @@ - - - - - - - - -flash.media.ID3Info (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final dynamic class ID3Info
InheritanceID3Info Inheritance Object
-

- - - - -
Language version: ActionScript AS3
- - - - -
Runtime version: 
-

-

- The ID3Info class contains properties that reflect ID3 metadata. You can get additional - metadata for MP3 files by accessing the id3 - property of the Sound class; for example, mySound.id3.TIME. - For more information, see the entry for Sound.id3 and - the ID3 tag definitions at http://www.id3.org. -

-

-See also -

-
-Sound.id3 -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  album : String -
- The name of the album; corresponds to the ID3 2.0 tag TALB.
-		ID3Info
  artist : String -
- The name of the artist; corresponds to the ID3 2.0 tag TPE1.
-		ID3Info
  comment : String -
- A comment about the recording; corresponds to the ID3 2.0 tag COMM.
-		ID3Info
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  genre : String -
- The genre of the song; corresponds to the ID3 2.0 tag TCON.
-		ID3Info
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  songName : String -
- The name of the song; corresponds to the ID3 2.0 tag TIT2.
-		ID3Info
  track : String -
- The track number; corresponds to the ID3 2.0 tag TRCK.
-		ID3Info
  year : String -
- The year of the recording; corresponds to the ID3 2.0 tag TYER.
-		ID3Info
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
albumproperty
-
-public var album:String -

- - - - -
Language version: ActionScript AS3 -
- - - - -
Runtime version: 
-

- The name of the album; corresponds to the ID3 2.0 tag TALB. -

- - - - - -
artistproperty 
-
-public var artist:String -

- - - - -
Language version: ActionScript AS3 -
- - - - -
Runtime version: 
-

- The name of the artist; corresponds to the ID3 2.0 tag TPE1. -

- - - - - -
commentproperty 
-
-public var comment:String -

- - - - -
Language version: ActionScript AS3 -
- - - - -
Runtime version: 
-

- A comment about the recording; corresponds to the ID3 2.0 tag COMM. -

- - - - - -
genreproperty 
-
-public var genre:String -

- - - - -
Language version: ActionScript AS3 -
- - - - -
Runtime version: 
-

- The genre of the song; corresponds to the ID3 2.0 tag TCON. -

- - - - - -
songNameproperty 
-
-public var songName:String -

- - - - -
Language version: ActionScript AS3 -
- - - - -
Runtime version: 
-

- The name of the song; corresponds to the ID3 2.0 tag TIT2. -

- - - - - -
trackproperty 
-
-public var track:String -

- - - - -
Language version: ActionScript AS3 -
- - - - -
Runtime version: 
-

- The track number; corresponds to the ID3 2.0 tag TRCK. -

- - - - - -
yearproperty 
-
-public var year:String -

- - - - -
Language version: ActionScript AS3 -
- - - - -
Runtime version: 
-

- The year of the recording; corresponds to the ID3 2.0 tag TYER. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/MediaPromise.html b/html-docs/flash/media/MediaPromise.html deleted file mode 100644 index 26bbd9c..0000000 --- a/html-docs/flash/media/MediaPromise.html +++ /dev/null @@ -1,788 +0,0 @@ - - - - - - - - -flash.media.MediaPromise (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.media
Classpublic class MediaPromise
InheritanceMediaPromise Inheritance EventDispatcher Inheritance Object
ImplementsIFilePromise
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

-

- The MediaPromise class represents the promise to deliver a media object. - -

The data property of a MediaEvent object is a MediaPromise - instance. You can use the MediaPromise methods to access the promised media - object. Supported media formats include still images and video.

-

You cannot create a MediaPromise object. Calling new MediaPromise() - generates a run-time error.

- -

-

-See also -

-
-MediaEvent -
-IFilePromise -
-Loader.LoadFilePromise() -
-IDataInput -
-CameraRoll.browseForImage() -
-CameraUI -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  file : File -
[read-only] - The File instance representing the media object, if one exists.
-		MediaPromise
  isAsync : Boolean -
[read-only] - Reports whether the underlying data source is asynchronous or synchronous.
-		MediaPromise
  mediaType : String -
[read-only] - The general type of media, either image or video.
-		MediaPromise
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  relativePath : String -
[read-only] - The file name of the media object, if one exists.
-		MediaPromise
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-close():void -
-
- Closes the data source.
-		MediaPromise
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-open():IDataInput -
-
- Opens the underlying data source and returns the IDataInput instance allowing you to read it.
-		MediaPromise
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-reportError(e:ErrorEvent):void -
-
- Used by the runtime to report errors.
-		MediaPromise
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-close -
-		 - A MediaPromise object dispatches a close event when the underlying data stream has closed.MediaPromise
   -
-complete -
-		 - A MediaPromise object dispatches a complete event when all data has been read.MediaPromise
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-ioError -
-		 - A MediaPromise object dispatches an ioError event when an error is encountered while reading - the underlying data stream.MediaPromise
   -
-progress -
-		 - A MediaPromise object dispatches progress events as the data becomes available.MediaPromise
-
- -
- -
Property detail
- - - - - -
fileproperty
-
-file:File  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The File instance representing the media object, if one exists. - -

This property references a File object if the underlying data source is file-based and the - file is accessible to your application. - Otherwise, the property is null.

- - Implementation -
-    public function get file():File -
-
- - - - - -
isAsyncproperty 
-
-isAsync:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Reports whether the underlying data source is asynchronous or synchronous. - -

- Implementation -
-    public function get isAsync():Boolean -
-
- - - - - -
mediaTypeproperty 
-
-mediaType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The general type of media, either image or video. - -

The constants in the MediaType class define possible values of this property:

-
    -
  • MediaType.IMAGE
    • -
  • MediaType.VIDEO
    • -
- Implementation -
-    public function get mediaType():String -
-

-See also -

-
-MediaType -
-
- - - - - -
relativePathproperty 
-
-relativePath:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The file name of the media object, if one exists. - -

A file name is available if the underlying data source is file-based and the - file is accessible to your application. - Otherwise, the property is null.

- Implementation -
-    public function get relativePath():String -
-
- -
Method detail
- - - - - -
close()method
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Closes the data source. -

- - - - - -
open()method 
-
-public function open():IDataInput -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Opens the underlying data source and returns the IDataInput instance allowing you to read it. - -

If the underlying data source is asynchronous, then the MediaPromise object dispatches - progress and complete events to indicate whether data is available - to be read. If the data source is synchronous, all data is available immediately and these - events are not dispatched.

- -

Note: You can load a MediaPromise object using the loadFilePromise() - method of the Loader class instead of reading the data manually.

- -

-Returns - - - - -
IDataInput
-

-See also -

-
-Loader.loadFilePromise() -
-
- - - - - -
reportError()method 
-
-public function reportError(e:ErrorEvent):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Used by the runtime to report errors. - -

Application code should not call this method.

- Parameters - - - - -
e:ErrorEvent — the error vent to dispatch. -
-
-
Event detail
- - - - - -
closeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLOSE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- A MediaPromise object dispatches a close event when the underlying data stream has closed. -

- The Event.CLOSE constant defines the value of the type property of a close event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection has been closed.
- -
- - - - - -
completeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- A MediaPromise object dispatches a complete event when all data has been read. - The event indicates that there is no more data available in the underlying stream. -

A complete event is not dispatched by a synchronous data source.

- -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- A MediaPromise object dispatches an ioError event when an error is encountered while reading - the underlying data stream. No more data can be read after this event is dispatched. -

- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- A MediaPromise object dispatches progress events as the data becomes available. - -

The bytesTotal property of all progress events except the last has the value 0. - If all the data is available immediately, no progress events may be dispatched. - No progress events are dispatched by synchronous data sources.

- -

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/MediaType.html b/html-docs/flash/media/MediaType.html deleted file mode 100644 index cdb54aa..0000000 --- a/html-docs/flash/media/MediaType.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - -flash.media.MediaType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class MediaType
InheritanceMediaType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

-

- The MediaType class enumerates the general types of media that can be returned by a camera. - -

Use the constants defined in this class as input to the launch() method - of the CameraUI class. MediaType values are also used in the mediaType property - of the MediaPromise class.

- -

-

-See also -

-
-CameraUI.launch() -
MediaPromise.mediaType
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  IMAGE : String = "image"
[static] - A single image.
-		MediaType
  VIDEO : String = "video"
[static] - A video.
-		MediaType
-
- -
- -
Constant detail
- - - - - -
IMAGEconstant
-
-public static const IMAGE:String = "image" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- A single image. -

- - - - - -
VIDEOconstant 
-
-public static const VIDEO:String = "video" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- A video. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/Microphone.html b/html-docs/flash/media/Microphone.html deleted file mode 100644 index 4063dbb..0000000 --- a/html-docs/flash/media/Microphone.html +++ /dev/null @@ -1,2231 +0,0 @@ - - - - - - - - -flash.media.Microphone (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class Microphone
InheritanceMicrophone Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- - Use the Microphone class to monitor or capture audio from a microphone. -

- To get access to the device microphone, you can use Microphone.getMicrophone() method. - However, this method returns a simple microphone, which does not have the ability to eliminate acoustic echo. - In order to eliminate acoustic echo, you need to get an instance of microphone using Microphone.getEnhancedMicrophone() method. - This method returns a device microphone that has the acoustic echo cancellation feature enabled for mobile. Use acoustic echo cancellation - to create real-time audio/video applications that don't require headsets. -

- -

Create a real-time chat application

-

To create a real-time chat application, capture audio and send it to Flash Media Server. - Use the NetConnection and NetStream classes to send the audio stream to Flash Media Server. - Flash Media Server can broadcast the audio to other clients. - To create a chat application that doesn't require headsets, use acoustic echo - cancellation. Acoustic echo cancellation prevents the feedback loop that occurs when audio enters a microphone, - travels out the speakers, and enters the microphone again. To use acoustic echo cancellation, call - the Microphone.getEnhancedMicrophone() method to get a reference to a Microphone instance. - Set Microphone.enhancedOptions to an instance of the MicrophoneEnhancedOptions class to - configure settings.

-

Play microphone audio locally

-

Call the Microphone setLoopback() method to route the microphone audio directly to - the local computer or device audio output. Uncontrolled audio feedback is an inherent danger and is likely - to occur whenever the audio output can be picked up by the microphone input. The - setUseEchoSuppression() method can reduce, but not eliminate, the risk of feedback - amplification.

- -

Capture microphone audio for local recording or processing

-

To capture microphone audio, listen for the sampleData events dispatched by a - Microphone instance. The SampleDataEvent object dispatched for this event contains the audio data.

- -

For information about capturing video, see the Camera class.

- -

Runtime microphone support

-

The Microphone class is not supported in Flash Player running in a mobile browser.

-

AIR profile support: The Microphone class is supported - on desktop operating systems, and iOS and Android mobile devices. - It is not supported on AIR for TV devices. See - - AIR Profile Support for more information regarding API support across multiple profiles.

-

You can test for support at run time using the Microphone.isSupported property. - Note that for AIR for TV devices, Microphone.isSupported is true but - Microphone.getMicrophone() always returns null.

-

Privacy controls

-

- Flash Player displays a Privacy dialog - box that lets the user choose whether to allow or deny access to - the microphone. Your application window size must be at least 215 x 138 - pixels, the minimum size required to display the dialog box, or access is denied automatically. -

-

Content running in the AIR application sandbox does not need permission to access the microphone - and no dialog is displayed. AIR content running outside the application sandbox does require permission - and the Privacy dialog is displayed.

- -

-

-View the examples. -

-

-See also -

-
-flash.media.Camera -
-flash.media.MicrophoneEnhancedMode -
-flash.media.MicrophoneEnhancedOptions -
-aYo Binitie: Implementing Acoustic Echo Suppression in Flash/Flex applications -
-Cristophe Coenraets: Voice Notes for Android -
-Michael Chaize: AIR, Android, and the Microphone -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  activityLevel : Number -
[read-only] - The amount of sound the microphone is detecting.
-		Microphone
  codec : String -
- The codec to use for compressing audio.
-		Microphone
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  enableVAD : Boolean -
- Enable Speex voice activity detection.
-		Microphone
  encodeQuality : int -
- The encoded speech quality when using the Speex codec.
-		Microphone
  enhancedOptions : MicrophoneEnhancedOptions -
- Controls enhanced microphone options.
-		Microphone
  framesPerPacket : int -
- Number of Speex speech frames transmitted in a packet (message).
-		Microphone
  gain : Number -
- The microphone gain—that is, the amount by which the microphone multiplies the signal before - transmitting it.
-		Microphone
  index : int -
[read-only] - The index of the microphone, as reflected in the array returned by - Microphone.names.
-		Microphone
  isSupported : Boolean -
[static][read-only] - The isSupported property is set to true if the - Microphone class is supported on the current platform, otherwise it is - set to false.
-		Microphone
  muted : Boolean -
[read-only] - Specifies whether the user has denied access to the microphone (true) - or allowed access (false).
-		Microphone
  name : String -
[read-only] - The name of the current sound capture device, as returned by the sound capture hardware.
-		Microphone
  names : Array -
[static][read-only] - An array of strings containing the names of all available sound capture devices.
-		Microphone
  noiseSuppressionLevel : int -
- Maximum attenuation of the noise in dB (negative number) used for Speex encoder.
-		Microphone
  permissionManager : PermissionManager -
[static][read-only] - Retrieves the permission manager object for the Camera resource -
-		Microphone
  permissionStatus : String -
[static][read-only] - Determine whether the application has been granted the permission to use Microphone.
-		Microphone
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rate : int -
- The rate at which the microphone is capturing sound, in kHz.
-		Microphone
  silenceLevel : Number -
[read-only] - The amount of sound required to activate the microphone and dispatch - the activity event.
-		Microphone
  silenceTimeout : int -
[read-only] - The number of milliseconds between the time the microphone stops - detecting sound and the time the activity event is dispatched.
-		Microphone
  soundTransform : SoundTransform -
- Controls the sound of this microphone object when it is in loopback mode.
-		Microphone
  useEchoSuppression : Boolean -
[read-only] - Set to true if echo suppression is enabled; false otherwise.
-		Microphone
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-getEnhancedMicrophone(index:int = -1):Microphone -
-
[static] - Returns a reference to an enhanced Microphone object that can - perform acoustic echo cancellation.
-		Microphone
   -
-getMicrophone(index:int = -1):Microphone -
-
[static] - - Returns a reference to a Microphone object for capturing audio.
-		Microphone
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-requestPermission():void -
-
- Requests Microphone permission for the application.
-		Microphone
   -
-setLoopBack(state:Boolean = true):void -
-
- Routes audio captured by a microphone to the local speakers.
-		Microphone
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setSilenceLevel(silenceLevel:Number, timeout:int = -1):void -
-
- Sets the minimum input level that should be considered sound and (optionally) the amount - of silent time signifying that silence has actually begun.
-		Microphone
   -
-setUseEchoSuppression(useEchoSuppression:Boolean):void -
-
- Specifies whether to use the echo suppression feature of the audio codec.
-		Microphone
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-activity -
-		 - Dispatched when a microphone starts or stops recording due to detected silence.Microphone
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-permissionStatus -
-		 - Dispatched when the application requests permission to use Microphone on the device.Microphone
   -
-sampleData -
-		 - Dispatched when the microphone has sound data in the buffer.Microphone
   -
-status -
-		 - Dispatched when a microphone reports its status.Microphone
-
- -
- -
Property detail
- - - - - -
activityLevelproperty
-
-activityLevel:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of sound the microphone is detecting. Values range from - 0 (no sound is detected) to 100 (very loud sound is detected). The value of this property can - help you determine a good value to pass to the Microphone.setSilenceLevel() method. - -

If the microphone muted property is true, the value of this property is always -1.

- Implementation -
-    public function get activityLevel():Number -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-flash.media.Microphone.getMicrophone() -
-flash.media.Microphone.setSilenceLevel() -
-flash.media.Microphone.gain -
-
- - - - - -
codecproperty 
-
-codec:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The codec to use for compressing audio. The default codec used is the Nellymoser codec. - The enumeration class SoundCodec contains the various values that are valid for the codec property. -

Implementation -
-    public function get codec():String -
-    public function set codec(value:String):void -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-SoundCodec -
-
- - - - - -
enableVADproperty 
-
-enableVAD:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Enable Speex voice activity detection. -

Implementation -
-    public function get enableVAD():Boolean -
-    public function set enableVAD(value:Boolean):void -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-
- - - - - -
encodeQualityproperty 
-
-encodeQuality:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The encoded speech quality when using the Speex codec. Possible values are from 0 to 10. The default value is 6. - Higher numbers represent higher quality but require more bandwidth, as shown in the following table. The bit rate values that are listed - represent net bit rates and do not include packetization overhead. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Quality valueRequired bit rate (kilobits per second)
0 3.95
15.75
27.75
39.80
412.8
516.8
620.6
723.8
827.8
934.2
1042.2
-

- Implementation -
-    public function get encodeQuality():int -
-    public function set encodeQuality(value:int):void -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-codec -
-
- - - - - -
enhancedOptionsproperty 
-
-enhancedOptions:MicrophoneEnhancedOptions  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Controls enhanced microphone options. For more information, see - MicrophoneEnhancedOptions class. This property is ignored for non-enhanced Microphone instances. -

Implementation -
-    public function get enhancedOptions():MicrophoneEnhancedOptions -
-    public function set enhancedOptions(value:MicrophoneEnhancedOptions):void -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-flash.media.MicrophoneEnhancedOptions -
-
- - - - - -
framesPerPacketproperty 
-
-framesPerPacket:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Number of Speex speech frames transmitted in a packet (message). - Each frame is 20 ms long. The default value is two frames per packet. -

The more Speex frames in a message, the lower the bandwidth required but the longer the delay in sending the - message. Fewer Speex frames increases bandwidth required but reduces delay.

- Implementation -
-    public function get framesPerPacket():int -
-    public function set framesPerPacket(value:int):void -
-
- - - - - -
gainproperty 
-
-gain:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The microphone gain—that is, the amount by which the microphone multiplies the signal before - transmitting it. A value of 0 tells Flash Player to multiply by 0; that is, the microphone transmits no sound. -

You can think of this setting like a volume knob on a stereo: 0 is no volume and 50 is normal - volume. Numbers below 50 specify lower than normal volume, while numbers above 50 specify higher than - normal volume. Valid values are 0 through 100, and 50 is the default value. The user can change - this value in the Flash Player Microphone Settings panel.

- Implementation -
-    public function get gain():Number -
-    public function set gain(value:Number):void -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-flash.media.Microphone.setUseEchoSuppression() -
-
- - - - - -
indexproperty 
-
-index:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The index of the microphone, as reflected in the array returned by - Microphone.names. -

Implementation -
-    public function get index():int -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-flash.media.Microphone.getMicrophone() -
-flash.media.Microphone.names -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The isSupported property is set to true if the - Microphone class is supported on the current platform, otherwise it is - set to false. -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
mutedproperty 
-
-muted:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether the user has denied access to the microphone (true) - or allowed access (false). When this value changes, - a status event is dispatched. - For more information, see Microphone.getMicrophone(). -

Implementation -
-    public function get muted():Boolean -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-flash.media.Microphone.getMicrophone() -
-flash.media.Microphone.status -
-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The name of the current sound capture device, as returned by the sound capture hardware. -

Implementation -
-    public function get name():String -
-

-See also -

-
-flash.media.Microphone.getMicrophone() -
-flash.media.Microphone.names -
-
- - - - - -
namesproperty 
-
-names:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of strings containing the names of all available sound capture devices. - The names are returned without - having to display the Flash Player Privacy Settings panel to the user. This array - provides the zero-based index of each sound capture device and the - number of sound capture devices on the system, through the Microphone.names.length property. - For more information, see the Array class entry. - -

Calling Microphone.names requires an extensive examination of the hardware, and it - may take several seconds to build the array. In most cases, you can just use the default microphone.

-

Note: To determine the name of the current microphone, - use the name property.

- Implementation -
-    public static function get names():Array -
-

-See also -

-
-Array -
-flash.media.Microphone.name -
-flash.media.Microphone.getMicrophone() -
-
- - - - - -
noiseSuppressionLevelproperty 
-
-noiseSuppressionLevel:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Maximum attenuation of the noise in dB (negative number) used for Speex encoder. If enabled, noise suppression is applied to sound captured from Microphone before - Speex compression. Set to 0 to disable noise suppression. Noise suppression is enabled by default with maximum attenuation of -30 dB. Ignored when Nellymoser - codec is selected. -

Implementation -
-    public function get noiseSuppressionLevel():int -
-    public function set noiseSuppressionLevel(value:int):void -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-
- - - - - -
permissionManagerproperty 
-
-permissionManager:PermissionManager  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Retrieves the permission manager object for the Camera resource -

Implementation -
-    public static function get permissionManager():PermissionManager -
-
- - - - - -
permissionStatusproperty 
-
-permissionStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Determine whether the application has been granted the permission to use Microphone. -

Implementation -
-    public static function get permissionStatus():String -
-

-See also -

-
-flash.permissions.PermissionStatus -
-
- - - - - -
rateproperty 
-
-rate:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The rate at which the microphone is capturing sound, in kHz. Acceptable values are 5, 8, 11, 22, and 44. The default value is 8 - kHz if your sound capture device supports this value. Otherwise, the default value is the next available capture level above 8 kHz - that your sound capture device supports, usually 11 kHz. Flash Player 10 and AIR 1.5 or later support a 16kHz rate value. - -

Note: If you are using the Speex codec (Microphone.codec = SoundCodec.SPEEX) for Flash Player 10 and AIR 1.5 - or later, the default rate value is 16kHz. If you use the Speex codec and then change the codec value to Nellymoser - (Microphone.codec = SoundCodec.NELLYMOSER), the rate continues to be set to 16kHz until you explicitly set the rate to a new value. - To receive audio using Flash Player releases before Flash Player 10 and AIR releases before AIR 1.5, change both the codec and the rate values - when you publish the audio.

- Implementation -
-    public function get rate():int -
-    public function set rate(value:int):void -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-flash.media.Microphone.codec -
-flash.media.SoundCodec -
-
- - - - - -
silenceLevelproperty 
-
-silenceLevel:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The amount of sound required to activate the microphone and dispatch - the activity event. The default value is 10. -

Implementation -
-    public function get silenceLevel():Number -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-flash.media.Microphone.gain -
-flash.media.Microphone.setSilenceLevel() -
-
- - - - - -
silenceTimeoutproperty 
-
-silenceTimeout:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of milliseconds between the time the microphone stops - detecting sound and the time the activity event is dispatched. The default - value is 2000 (2 seconds). - -

To set this value, use the Microphone.setSilenceLevel() method.

- Implementation -
-    public function get silenceTimeout():int -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-flash.media.Microphone.setSilenceLevel() -
-
- - - - - -
soundTransformproperty 
-
-soundTransform:SoundTransform  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Controls the sound of this microphone object when it is in loopback mode. -

Implementation -
-    public function get soundTransform():SoundTransform -
-    public function set soundTransform(value:SoundTransform):void -
-
-Throws -
- - - - -
PermissionError — The application does not have permission to use Microphone. - -
-
- - - - - -
useEchoSuppressionproperty 
-
-useEchoSuppression:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Set to true if echo suppression is enabled; false otherwise. The default value is - false unless the user has selected Reduce Echo in the Flash Player Microphone Settings panel. -

Implementation -
-    public function get useEchoSuppression():Boolean -
-

-See also -

-
-flash.media.Microphone.setUseEchoSuppression() -
-
- -
Method detail
- - - - - -
getEnhancedMicrophone()method
-
-public static function getEnhancedMicrophone(index:int = -1):Microphone -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Returns a reference to an enhanced Microphone object that can - perform acoustic echo cancellation. Use acoustic echo cancellation to create audio/video chat applications - that don't require headsets. -

The index parameter for the Microphone.getEnhancedMicrophone() method and the Microphone.getMicrophone() - method work the same way.

-

To use this method on Android, add MODIFY_AUDIO_SETTINGS permission under Android manifest additions in the application descriptor.

-

Important: At any given time you can have only a single instance of enhanced microphone device. - All other Microphone instances stop providing audio data and receive a StatusEvent with the - code property Microphone.Unavailable. When enhanced audio fails to initialize, - calls to this method return null, setting a value for Microphone.enhancedOptions has no effect, - and all existing Microphone instances function as before.

-

To configure an enhanced Microphone object, set the Microphone.enhancedOptions property. The following - code uses an enhanced Microphone object and full-duplex acoustic echo cancellation in a local test:

- 
-	     var mic:Microphone = Microphone.getEnhancedMicrophone();
-	     var options:MicrophoneEnhancedOptions = new MicrophoneEnhancedOptions();
-	     options.mode = MicrophoneEnhancedMode.FULL_DUPLEX;
-	     mic.enhancedOptions = options;
-	     mic.setLoopBack(true);
-
-

The setUseEchoSuppression() method is ignored when using acoustic echo cancellation. -

-

- When a SWF file tries to access the object returned by Microphone.getEnhancedMicrophone() - —for example, when you call NetStream.attachAudio()— - Flash Player displays a Privacy dialog box that lets the user choose whether to - allow or deny access to the microphone. (Make sure your Stage size is at least - 215 x 138 pixels; this is the minimum size Flash Player requires to display the dialog box.) -

- - Parameters - - - - -
index:int (default = -1) — The index value of the microphone. -
-

-Returns - - - - -
Microphone — - A reference to a Microphone object for capturing audio. If enhanced audio fails to initialize, returns null. - - -
-

-See also -

-
-Microphone.getMicrophone() -
-Microphone.enhancedOptions -
-Microphone.status -
-
- - - - - -
getMicrophone()method 
-
-public static function getMicrophone(index:int = -1):Microphone -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- - Returns a reference to a Microphone object for capturing audio. - To begin capturing the audio, you must attach the Microphone - object to a NetStream object (see NetStream.attachAudio()). - -

- Multiple calls to Microphone.getMicrophone() reference the same microphone. - Thus, if your code contains the lines mic1 = Microphone.getMicrophone() - mic1 = air.Microphone.getMicrophone() and - mic2 = Microphone.getMicrophone() - mic2 = air.Microphone.getMicrophone(), both mic1 and mic2 - reference the same (default) microphone.

- -

- In general, you should not pass a value for index. Simply call - air.Microphone.getMicrophone() - Microphone.getMicrophone() to return a reference to the default microphone. - Using the Microphone Settings section in the Flash Player settings panel, the user can specify the default - microphone the application should use. (The user access the Flash Player settings panel by right-clicking - Flash Player content running in a web browser.) If you pass a value for index, you can - reference a microphone other than the one the user chooses. You can use index in - rare cases—for example, if your application is capturing audio from two microphones - at the same time. Content running in Adobe AIR also uses the Flash Player setting for the default - microphone.

-

- Use the Microphone.index property to get the index value of the current - Microphone object. You can then pass this value to other methods of the - Microphone class. -

- -

- When a SWF file tries to access the object returned by Microphone.getMicrophone() - —for example, when you call NetStream.attachAudio()— - Flash Player displays a Privacy dialog box that lets the user choose whether to - allow or deny access to the microphone. (Make sure your Stage size is at least - 215 x 138 pixels; this is the minimum size Flash Player requires to display the dialog box.) -

- -

- When the user responds to this dialog box, a status event is dispatched - that indicates the user's response. You can also check the Microphone.muted - property to determine if the user has allowed or denied access to the microphone. -

- -

- If Microphone.getMicrophone() returns null, either the microphone is in use - by another application, or there are no microphones installed on the system. To determine - whether any microphones are installed, use Microphones.names.length. To display - the Flash Player Microphone Settings panel, which lets the user choose the microphone to be - referenced by Microphone.getMicrophone, use Security.showSettings(). - -

- - Parameters - - - - -
index:int (default = -1) — The index value of the microphone. - -
-

-Returns - - - - -
Microphone — - A reference to a Microphone object for capturing audio. - - - -
-
-Events - - - - -
status:StatusEvent — Dispatched when a microphone reports its status. - If the value of the code property is "Microphone.Muted", - the user has refused to allow the SWF file access to the user's microphone. - If the value of the code property is "Microphone.Unmuted", - the user has allowed the SWF file access to the user's microphone.
-

-See also -

-
-Microphone.status -
-flash.net.NetStream.attachAudio() -
-flash.system.Security.showSettings() -
-
-Example -
The following example shows how you can request access to the user's microphone using the static Microphone.getMicrophone() method and listening for the status event. - Example provided by - ActionScriptExamples.com. -
-
-var mic:Microphone = Microphone.getMicrophone();
-mic.setLoopBack();
-mic.addEventListener(StatusEvent.STATUS, mic_status);
- 
-var tf:TextField = new TextField();
-tf.autoSize = TextFieldAutoSize.LEFT;
-tf.text = "Detecting microphone...";
-addChild(tf);
- 
-function mic_status(evt:StatusEvent):void {
-    tf.text = "Microphone is muted?: " + mic.muted;
-    switch (evt.code) {
-        case "Microphone.Unmuted":
-            tf.appendText("\n" + "Microphone access was allowed.");
-            break;
-        case "Microphone.Muted":
-            tf.appendText("\n" + "Microphone access was denied.");
-            break;
-    }
-}
-
-

-
- - - - - -
requestPermission()method 
-
-public function requestPermission():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Requests Microphone permission for the application. - -


-Events - - - - -
PermissionStatus:PermissionEvent — dispatched when the requested permission is granted/denied by the user.
-
- - - - - -
setLoopBack()method 
-
-public function setLoopBack(state:Boolean = true):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Routes audio captured by a microphone to the local speakers. -

Parameters - - - - -
state:Boolean (default = true)
-
-Throws - - - - -
PermissionError — The application does not have permission to use Microphone. - -
-
- - - - - -
setSilenceLevel()method 
-
-public function setSilenceLevel(silenceLevel:Number, timeout:int = -1):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sets the minimum input level that should be considered sound and (optionally) the amount - of silent time signifying that silence has actually begun. -

    -
  • To prevent the microphone from detecting sound at all, pass a value of 100 for - silenceLevel; the activity event is never dispatched.
    • -
  • To determine the amount of sound the microphone is currently detecting, use Microphone.activityLevel.
    • -
- -

Speex includes voice activity detection (VAD) and automatically reduces bandwidth when no voice is detected. - When using the Speex codec, Adobe recommends that you set the silence level to 0.

-

Activity detection is the ability to detect when audio levels suggest that a person is talking. - When someone is not talking, bandwidth can be saved because there is no need to send the associated - audio stream. This information can also be used for visual feedback so that users know - they (or others) are silent.

- -

Silence values correspond directly to activity values. Complete silence is an activity value of 0. - Constant loud noise (as loud as can be registered based on the current gain setting) is an activity value - of 100. After gain is appropriately adjusted, your activity value is less than your silence value when - you're not talking; when you are talking, the activity value exceeds your silence value.

- -

This method is similar to Camera.setMotionLevel(); both methods are used to - specify when the activity event is dispatched. However, these methods have - a significantly different impact on publishing streams:

- -
    -
  • Camera.setMotionLevel() is designed to detect motion and does not affect bandwidth - usage. Even if a video stream does not detect motion, video is still sent.
    • - -
  • Microphone.setSilenceLevel() is designed to optimize bandwidth. When an audio - stream is considered silent, no audio data is sent. Instead, a single message is sent, indicating - that silence has started.
    • -
- Parameters - - - - - - - - - - -
silenceLevel:Number — The amount of sound required to activate the microphone - and dispatch the activity event. Acceptable values range from 0 to 100. - -
 
timeout:int (default = -1) — The number of milliseconds that must elapse without - activity before Flash Player or Adobe AIR considers sound to have stopped and dispatches the - dispatch event. The default value is 2000 (2 seconds). - (Note: The default value shown - in the signature, -1, is an internal value that indicates to Flash Player or Adobe AIR to use 2000.) -
-
-Throws - - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-flash.media.Camera.setMotionLevel() -
-flash.media.Microphone.activityLevel -
-flash.media.Microphone.activity -
-flash.media.Microphone.gain -
-flash.media.Microphone.silenceLevel -
-flash.media.Microphone.silenceTimeout -
-
- - - - - -
setUseEchoSuppression()method 
-
-public function setUseEchoSuppression(useEchoSuppression:Boolean):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether to use the echo suppression feature of the audio codec. The default value is - false unless the user has selected Reduce Echo in the Flash Player Microphone - Settings panel. - -

Echo suppression is an effort to reduce the effects of audio feedback, which is caused when - sound going out the speaker is picked up by the microphone on the same system. (This is different - from acoustic echo cancellation, which completely removes the feedback. The setUseEchoSuppression() method - is ignored when you call the getEnhancedMicrophone() method to use acoustic echo cancellation.)

- -

Generally, echo suppression is advisable when the sound being captured is played through - speakers — instead of a headset —. If your SWF file allows users to specify the - sound output device, you may want to call Microphone.setUseEchoSuppression(true) - if they indicate they are using speakers and will be using the microphone as well.

- -

Users can also adjust these settings in the Flash Player Microphone Settings panel.

- Parameters - - - - -
useEchoSuppression:Boolean — A Boolean value indicating whether to use echo suppression - (true) or not (false). -
-
-Throws - - - - -
PermissionError — The application does not have permission to use Microphone. -
-

-See also -

-
-flash.media.Microphone.setUseEchoSuppression() -
-flash.media.Microphone.useEchoSuppression -
-
-
Event detail
- - - - - -
activityevent 
-
-Event object type: flash.events.ActivityEvent -
-ActivityEvent.type property = flash.events.ActivityEvent.ACTIVITY -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a microphone starts or stops recording due to detected silence. - -

- To specify the amount of sound required to trigger this event - with an activating property of true, - or the amount of time that must elapse without sound to - trigger this event with an activating property of - false, use Microphone.setSilenceLevel(). -

-

For a Microphone object to dispatch activity events, the application must be monitoring - the input, either by calling setLoopback( true ), by listening for - sampleData events, or by attaching the microphone to a NetStream object.

- -

- The ActivityEvent.ACTIVITY constant defines the value of the type property of an activity event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
activatingtrue if the device is activating or false if it is deactivating.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object beginning or ending a session, such as a Camera or - Microphone object.
- -

-See also -

-
-setSilenceLevel() -
-
- - - - - -
permissionStatusevent  
-
-Event object type: flash.events.PermissionEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Dispatched when the application requests permission to use Microphone on the device. - Check the value of status property to check whether - the permission was granted or denied -

-See also -

-
-Microphone.requestPermission() -
-flash.permissions.PermissionStatus -
-
- - - - - -
sampleDataevent  
-
-Event object type: flash.events.SampleDataEvent -
-SampleDataEvent.type property = flash.events.SampleDataEvent.SAMPLE_DATA -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when the microphone has sound data in the buffer. -

- The Microphone.rate property determines the number of samples generated - per second. The number of samples per event is a factor of the number of samples - per second and the latency between event calls. -

-

- Defines the value of the type property of a SampleDataEvent event object. -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
positionThe point from which audio data is provided.
- -
-Example -
The following example captures 4 seconds of audio samples from the default microphone - and then plays the audio back. Be sure that there is a microphone attached. The the micSampleDataHandler() - is the event listener for the sampleData event of the Microphone object. The micSampleDataHandler() - method gets the samples as they become available and appends their values to a ByteArray object. A Timer - object is set for 4 seconds. The Timer removes the sampleData event of the Microphone object event listener, - creates a Sound object, and adds a sampleData event listener for the Sound object. The sampleData - event listener for the Sound object, the playbackSampleHandler() method, provides audio samples - for the Sound object to play. These audio samples are retrieved from the ByteArray object that stored the - Microphone samples. The samples are written to the Sound object twice since the Microphone samples are - recorded in monaural sound and the Sound object requests stereo pairs of samples. The rate - property of the Microphone object is set to 44, to match the 44-kHz sample rate used by Sound objects. - - -
-
 
-const DELAY_LENGTH:int = 4000;
-
-var mic:Microphone = Microphone.getMicrophone();
-mic.setSilenceLevel(0, DELAY_LENGTH);
-mic.gain = 100;
-mic.rate = 44;
-mic.addEventListener(SampleDataEvent.SAMPLE_DATA, micSampleDataHandler);
-
-var timer:Timer = new Timer(DELAY_LENGTH);
-timer.addEventListener(TimerEvent.TIMER, timerHandler);
-timer.start();
-
-var soundBytes:ByteArray = new ByteArray();
-
-function micSampleDataHandler(event:SampleDataEvent):void
-{
-    while(event.data.bytesAvailable)
-	{
-		var sample:Number = event.data.readFloat();
-		soundBytes.writeFloat(sample);
-	}
-}
-
-function timerHandler(event:TimerEvent):void
-{		
-	mic.removeEventListener(SampleDataEvent.SAMPLE_DATA, micSampleDataHandler);
-	timer.stop();
-	soundBytes.position = 0;
-	var sound:Sound = new Sound();
-	sound.addEventListener(SampleDataEvent.SAMPLE_DATA, playbackSampleHandler);
-	sound.play();
-}
-
-function playbackSampleHandler(event:SampleDataEvent):void
-{
-	for (var i:int = 0; i < 8192 && soundBytes.bytesAvailable > 0; i++) 
-	{
-		var sample:Number = soundBytes.readFloat();
-		event.data.writeFloat(sample);
-		event.data.writeFloat(sample);
-	}
-}
-
-

The following example captures sound using echo suppression from a microphone after the - user allows access to their computer's microphone. - The Security.showSettings() method displays the Flash Player dialog box, which requests - permission to access the user's microphone. The call to setLoopBack(true) reroutes - input to the local speaker, so you can hear the sound while you run the example. - -

Two listeners listen for activity and - status events. The activity event is dispatched at the - start and end (if any) of the session and is captured by the activityHandler() - method, which traces information on the event. The status event is dispatched if - the attached microphone object reports any status information; it is captured and traced using - the statusHandler() method.

- -

Note: A microphone must be attached to your computer for this example - to work correctly.

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.media.Microphone;
-    import flash.system.Security;
-
-    public class MicrophoneExample extends Sprite {
-        public function MicrophoneExample() {
-            var mic:Microphone = Microphone.getMicrophone();
-            Security.showSettings("2");
-            mic.setLoopBack(true);
-                    
-            if (mic != null) {
-                mic.setUseEchoSuppression(true);
-                mic.addEventListener(ActivityEvent.ACTIVITY, activityHandler);
-                mic.addEventListener(StatusEvent.STATUS, statusHandler);
-            }
-        }
-
-        private function activityHandler(event:ActivityEvent):void {
-            trace("activityHandler: " + event);
-        }
-
-        private function statusHandler(event:StatusEvent):void {
-            trace("statusHandler: " + event);
-        }
-    }
-}
-
-

-

-See also -

-
-flash.events.SampleDataEvent -
-
- - - - - -
statusevent  
-
-Event object type: flash.events.StatusEvent -
-StatusEvent.type property = flash.events.StatusEvent.STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a microphone reports its status. - If the value of the code property is "Microphone.Muted", - the user has refused to allow the SWF file access to the microphone. - If the value of the code property is "Microphone.Unmuted", - the user has allowed the SWF file access to the microphone. - -

Status events are not dispatched in Adobe AIR applications; access to the microphone - cannot be changed dynamically. On most platforms, AIR applications can always access the microphone. - On Android, an application must specify the Android RECORD_AUDIO permission in the application - descriptor. Otherwise, Android denies access to the microphone altogether.

- -

- Defines the value of the type property of a status event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
codeA description of the object's status.
currentTargetThe object that is actively processing the Event - object with an event listener.
levelThe category of the message, such as "status", "warning" or "error".
targetThe object reporting its status.
- -

-See also -

-
-Microphone.getMicrophone() -
-
- -
Examples
-
examples\MicrophoneExample
-
The following example captures sound using echo suppression from a microphone after the - user allows access to their computer's microphone. - The Security.showSettings() method displays the Flash Player dialog box, which requests - permission to access the user's microphone. The call to setLoopBack(true) reroutes - input to the local speaker, so you can hear the sound while you run the example. - -

Two listeners listen for activity and - status events. The activity event is dispatched at the - start and end (if any) of the session and is captured by the activityHandler() - method, which traces information on the event. The status event is dispatched if - the attached microphone object reports any status information; it is captured and traced using - the statusHandler() method.

- -

Note: A microphone must be attached to your computer for this example - to work correctly.

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.media.Microphone;
-    import flash.system.Security;
-
-    public class MicrophoneExample extends Sprite {
-        public function MicrophoneExample() {
-            var mic:Microphone = Microphone.getMicrophone();
-            Security.showSettings("2");
-            mic.setLoopBack(true);
-                    
-            if (mic != null) {
-                mic.setUseEchoSuppression(true);
-                mic.addEventListener(ActivityEvent.ACTIVITY, activityHandler);
-                mic.addEventListener(StatusEvent.STATUS, statusHandler);
-            }
-        }
-
-        private function activityHandler(event:ActivityEvent):void {
-            trace("activityHandler: " + event);
-        }
-
-        private function statusHandler(event:StatusEvent):void {
-            trace("statusHandler: " + event);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/MicrophoneEnhancedMode.html b/html-docs/flash/media/MicrophoneEnhancedMode.html deleted file mode 100644 index df2bd9d..0000000 --- a/html-docs/flash/media/MicrophoneEnhancedMode.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - - - - -flash.media.MicrophoneEnhancedMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class MicrophoneEnhancedMode
InheritanceMicrophoneEnhancedMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

-

- The MicrophoneEnhancedMode class is an enumeration of constant values used in setting the mode property - of MicrophoneEnhancedOptions class. -

Note: This feature is not available on iOS. -

-

-

-See also -

-
-flash.media.MicrophoneEnhancedOptions -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  FULL_DUPLEX : String = "fullDuplex"
[static] - Use this mode to allow both parties to talk at the same time.
-		MicrophoneEnhancedMode
  HALF_DUPLEX : String = "halfDuplex"
[static] - Use this mode for older and lower-quality speakers and microphones.
-		MicrophoneEnhancedMode
  HEADSET : String = "headset"
[static] - Use this mode when both parties are using headsets.
-		MicrophoneEnhancedMode
  OFF : String = "off"
[static] - All enhanced microphone functionality is off.
-		MicrophoneEnhancedMode
  SPEAKER_MUTE : String = "speakerMute"
[static] - Use this mode when the speaker is muted.
-		MicrophoneEnhancedMode
-
- -
- -
Constant detail
- - - - - -
FULL_DUPLEXconstant
-
-public static const FULL_DUPLEX:String = "fullDuplex" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Use this mode to allow both parties to talk at the same time. Acoustic echo cancellation operates in full-duplex mode. - Full-duplex mode is the highest quality echo cancellation. This mode requires - high-quality microphones and speakers and the most computing power. Do not use this mode with a USB microphone. -

- - - - - -
HALF_DUPLEXconstant 
-
-public static const HALF_DUPLEX:String = "halfDuplex" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Use this mode for older and lower-quality speakers and microphones. Acoustic echo cancellation operates in half-duplex mode. - In half-duplex mode, only one party can speak at a time. Half-duplex mode requires simpler - processing than full-duplex mode. Half-duplex mode is the default mode for USB microphone devices. -

If the application uses the default enhancedOptions setting and a USB mic, Flash Player automatically switches to halfDuplex mode. - If the application uses the default enhancedOptions setting and the built-in microphone, Flash Player uses fullDuplex mode.

-
- - - - - -
HEADSETconstant 
-
-public static const HEADSET:String = "headset" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Use this mode when both parties are using headsets. Acoustic echo cancellation operates in low-echo mode. This mode requires the least amount - of computing power. -

- - - - - -
OFFconstant 
-
-public static const OFF:String = "off" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- All enhanced microphone functionality is off. -

- - - - - -
SPEAKER_MUTEconstant 
-
-public static const SPEAKER_MUTE:String = "speakerMute" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Use this mode when the speaker is muted. In this mode, acoustic echo cancellation is off. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/MicrophoneEnhancedOptions.html b/html-docs/flash/media/MicrophoneEnhancedOptions.html deleted file mode 100644 index 1661e1a..0000000 --- a/html-docs/flash/media/MicrophoneEnhancedOptions.html +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - - -flash.media.MicrophoneEnhancedOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class MicrophoneEnhancedOptions
InheritanceMicrophoneEnhancedOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.7 -
-

-

- The MicrophoneEnhancedOptions class provides configuration options for enhanced audio (acoustic echo cancellation). - Acoustic echo cancellation allows multiple parties to communicate in an audio/video chat application without - using headsets. -

To use acoustic echo cancellation, call Microphone.getEnhancedMicrophone() to get a reference to - an enhanced Microphone object. Set the Microphone.enhancedOptions - property to an instance of the MicrophoneEnhancedOptions class. -

-

-

-See also -

-
-flash.media.Microphone.enhancedOptions -
-flash.media.Microphone.getEnhancedMicrophone() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  echoPath : int -
- Specifies the echo path (in milliseconds) used for acoustic echo cancellation.
-		MicrophoneEnhancedOptions
  isVoiceDetected : int -
- Indicates whether the Microphone input detected a voice.
-		MicrophoneEnhancedOptions
  mode : String -
- Controls enhanced microphone mode.
-		MicrophoneEnhancedOptions
  nonLinearProcessing : Boolean -
- Enable non-linear processing.
-		MicrophoneEnhancedOptions
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-MicrophoneEnhancedOptions()
-
-		MicrophoneEnhancedOptions
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
echoPathproperty
-
-echoPath:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Specifies the echo path (in milliseconds) used for acoustic echo cancellation. A longer - echo path results in better echo cancellation. A longer echo path also causes a longer delay - and requires more computational complexity. The default value is 128 (recommended). The other - possible value is 256. -

Implementation -
-    public function get echoPath():int -
-    public function set echoPath(value:int):void -
-
- - - - - -
isVoiceDetectedproperty 
-
-isVoiceDetected:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Indicates whether the Microphone input detected a voice. - -

Possible values are: -1, not enabled; 0, a voice is not detected; 1, a voice is detected. -

- Implementation -
-    public function get isVoiceDetected():int -
-    public function set isVoiceDetected(value:int):void -
-
- - - - - -
modeproperty 
-
-mode:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Controls enhanced microphone mode. The default value is FULL_DUPLEX for all microphones that aren't USB. - The default value for USB microphones is HALF_DUPLEX. - See MicrophoneEnhancedMode for possible values and descriptions. -

Note: This feature is not available on iOS. -

- Implementation -
-    public function get mode():String -
-    public function set mode(value:String):void -
-

-See also -

-
-flash.media.MicrophoneEnhancedMode -
-
- - - - - -
nonLinearProcessingproperty 
-
-nonLinearProcessing:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Enable non-linear processing. Non-linear processing - suppresses the residual echo when one person is talking. The time-domain non-linear - processing technique is used. Turn off non-linear - processing for music sources. The default value is true which turns on non-linear processing. -

Implementation -
-    public function get nonLinearProcessing():Boolean -
-    public function set nonLinearProcessing(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
MicrophoneEnhancedOptions()constructor
-
-public function MicrophoneEnhancedOptions() -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/Sound.html b/html-docs/flash/media/Sound.html deleted file mode 100644 index acb6a96..0000000 --- a/html-docs/flash/media/Sound.html +++ /dev/null @@ -1,2280 +0,0 @@ - - - - - - - - -flash.media.Sound (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic class Sound
InheritanceSound Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The Sound class lets you work with sound in an application. The Sound class - lets you create a Sound object, load and play an external MP3 file into that object, - close the sound stream, and access - data about the sound, such as information about the number of bytes in the stream and - ID3 metadata. More detailed control of the sound is performed through the sound source — - the SoundChannel or Microphone object for the sound — and through the properties - in the SoundTransform class that control the output of the sound to the computer's speakers. -

In Flash Player 10 and later and AIR 1.5 and later, you can also use this - class to work with sound that is generated dynamically. - In this case, the Sound object uses the function you assign to a sampleData event handler to - poll for sound data. The sound is played as it is retrieved from a ByteArray object that - you populate with sound data. You can use Sound.extract() to extract sound data from a - Sound object, - after which you can manipulate it before writing it back to the stream for playback.

-

To control sounds that are embedded in a SWF file, use the properties in the SoundMixer class.

- -

Note: The ActionScript 3.0 Sound API differs from ActionScript 2.0. - In ActionScript 3.0, you cannot take sound objects and arrange them in a hierarchy - to control their properties.

- -

When you use this class, consider the following security model:

-
    - -
  • Loading and playing a sound is not allowed if the calling file is in a network sandbox - and the sound file to be loaded is local.
    • - -
  • By default, loading and playing a sound is not allowed if the calling file is local and - tries to load and play a remote sound. A user must grant explicit permission to allow this type of access.
    • - -
  • Certain operations dealing with sound are restricted. The data in a loaded sound cannot - be accessed by a file in a different domain unless you implement a cross-domain policy file. - Sound-related APIs that fall under this restriction are Sound.id3, - SoundMixer.computeSpectrum(), SoundMixer.bufferTime, - and the SoundTransform class.
    • - -
- -

However, in Adobe AIR, content in the application security sandbox (content - installed with the AIR application) are not restricted by these security limitations.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

-

-View the examples. -

-

-See also -

-
-flash.net.NetStream -
-Microphone -
-SoundChannel -
-SoundMixer -
-SoundTransform -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bytesLoaded : uint -
[read-only] - Returns the currently available number of bytes in this sound object.
-		Sound
  bytesTotal : int -
[read-only] - Returns the total number of bytes in this sound object.
-		Sound
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  id3 : ID3Info -
[read-only] - Provides access to the metadata that is part of an MP3 file.
-		Sound
  isBuffering : Boolean -
[read-only] - Returns the buffering state of external MP3 files.
-		Sound
  isURLInaccessible : Boolean -
[read-only] - Indicates if the Sound.url property has been - truncated.
-		Sound
  length : Number -
[read-only] - The length of the current sound in milliseconds.
-		Sound
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  url : String -
[read-only] - The URL from which this sound was loaded.
-		Sound
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Sound(stream:URLRequest = null, context:SoundLoaderContext = null)
-
- Creates a new Sound object.
-		Sound
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-close():void -
-
- Closes the stream, causing any download of data to cease.
-		Sound
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-extract(target:ByteArray, length:Number, startPosition:Number = -1):Number -
-
- Extracts raw sound data from a Sound object.
-		Sound
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-load(stream:URLRequest, context:SoundLoaderContext = null):void -
-
- Initiates loading of an external MP3 file from the specified URL.
-		Sound
   -
-loadCompressedDataFromByteArray(bytes:ByteArray, bytesLength:uint):void -
-
- load MP3 sound data from a ByteArray object into a Sound object.
-		Sound
   -
-loadPCMFromByteArray(bytes:ByteArray, samples:uint, format:String = "float", stereo:Boolean = true, sampleRate:Number = 44100.0):void -
-
- Load PCM 32-bit floating point sound data from a ByteArray object into a Sound object.
-		Sound
   -
-play(startTime:Number = 0, loops:int = 0, sndTransform:SoundTransform = null):SoundChannel -
-
- Generates a new SoundChannel object to play back the sound.
-		Sound
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-complete -
-		 - Dispatched when data has loaded successfully.Sound
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-id3 -
-		 - Dispatched by a Sound object when ID3 data is available for an MP3 sound.Sound
   -
-ioError -
-		 - Dispatched when an input/output error occurs that causes a load operation to fail.Sound
   -
-open -
-		 - Dispatched when a load operation starts.Sound
   -
-progress -
-		 - Dispatched when data is received as a load operation progresses.Sound
   -
-sampleData -
-		 - Dispatched when the runtime requests new audio data.Sound
-
- -
- -
Property detail
- - - - - -
bytesLoadedproperty
-
-bytesLoaded:uint  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns the currently available number of bytes in this sound object. This property is - usually useful only for externally loaded files. - -

Implementation -
-    public function get bytesLoaded():uint -
-
- - - - - -
bytesTotalproperty 
-
-bytesTotal:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns the total number of bytes in this sound object. - -

Implementation -
-    public function get bytesTotal():int -
-
- - - - - -
id3property 
-
-id3:ID3Info  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Provides access to the metadata that is part of an MP3 file. - -

MP3 sound files can contain ID3 tags, which provide metadata about the - file. If an MP3 sound that you load using the Sound.load() - method contains ID3 tags, you can query these properties. Only ID3 tags - that use the UTF-8 character set are supported.

- -

Flash Player 9 and later and AIR support - AIR supports ID3 2.0 tags, - specifically 2.3 and 2.4. The following tables list the standard ID3 2.0 tags - and the type of content the tags represent. The Sound.id3 property provides - access to these tags through the format - my_sound.id3.COMM, my_sound.id3.TIME, and so on. The first - table describes tags that can be accessed either through the ID3 2.0 property name or - the ActionScript property name. The second table describes ID3 tags that are supported but do not have - predefined properties in ActionScript.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ID3 2.0 tagCorresponding Sound class property
COMMSound.id3.comment
TALBSound.id3.album
TCONSound.id3.genre
TIT2Sound.id3.songName
TPE1Sound.id3.artist
TRCKSound.id3.track
TYERSound.id3.year
-

The following table describes ID3 tags that are supported but do not have - predefined properties in the Sound class. You access them by calling - mySound.id3.TFLT, mySound.id3.TIME, and so on. NOTE: None of - these tags are supported in Flash Lite 4.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
TFLTFile type
TIMETime
TIT1Content group description
TIT2Title/song name/content description
TIT3Subtitle/description refinement
TKEYInitial key
TLANLanguages
TLENLength
TMEDMedia type
TOALOriginal album/movie/show title
TOFNOriginal filename
TOLYOriginal lyricists/text writers
TOPEOriginal artists/performers
TORYOriginal release year
TOWNFile owner/licensee
TPE1Lead performers/soloists
TPE2Band/orchestra/accompaniment
TPE3Conductor/performer refinement
TPE4Interpreted, remixed, or otherwise modified by
TPOSPart of a set
TPUBPublisher
TRCKTrack number/position in set
TRDARecording dates
TRSNInternet radio station name
TRSOInternet radio station owner
TSIZSize
TSRCISRC (international standard recording code)
TSSESoftware/hardware and settings used for encoding
TYERYear
WXXXURL link frame
- -

When using this property, consider the Flash Player security model:

- -
    - -
  • The id3 property of a Sound object is always permitted for SWF files - that are in the same security sandbox as the sound file. For files in other sandboxes, there - are security checks.
    • - -
  • When you load the sound, using the load() method of the Sound class, you can - specify a context parameter, which is a SoundLoaderContext object. If you set the - checkPolicyFile property of the SoundLoaderContext object to true, Flash Player - checks for a URL policy file on the server from which the sound is loaded. If a - policy file exists and permits access from the domain of the loading SWF file, then the file is allowed - to access the id3 property of the Sound object; otherwise it is not.
    • - -
- -

However, in Adobe AIR, content in the application security sandbox (content - installed with the AIR application) are not restricted by these security limitations.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- Implementation -
-    public function get id3():ID3Info -
-

-See also -

-
-SoundLoaderContext.checkPolicyFile -
-
-Example -
The following example reads the ID3 information from a sound file and displays - it in a text field. - -

In the constructor, the sound file is loaded but it is not set to play. Here, it is - assumed that the file is in the SWF directory. The system must have permission - in order to read the ID3 tags of a loaded sound file. If there is ID3 information in - the file and the program is permitted to read it, an Event.ID3 event will - be fired and the id3 property of the sound file will be populated. - The id3 property contains an ID3Info object with all - of the ID3 information.

- -

In the id3Handler() method, the file's ID3 tags - are stored in id3, an ID3Info class object. A text field is - instantiated to display the list of the ID3 tags. The for loop iterates - through all the ID3 2.0 tags and appends the name and value to the content of - the text field. Using ID3 info (ID3Info) properties, the artist, - song name, and album are also appended. ActionScript 3.0 - and Flash Player 9 and later support ID3 2.0 tags, specifically 2.3 and 2.4. - If you iterate through properties like in the for loop, only ID3 2.0 tags will appear. - However, the data from the earlier versions are also stored in the song's id3 - property and can be accessed using ID3 info class properties. - The tags for the ID3 1.0 are at the end of the file while the ID3 2.0 tags are in - the beginning of the file. (Sometimes, the files may have both earlier and later version - tags in the same place.) If a file encoded with both version 1.0 and 2.0 tags at the - beginning and the end of the file, the method id3Handler() will be invoked twice. - It first reads the 2.0 version and then the version 1.0. If only ID3 1.0 tag is available, - then the information is accessible via the ID3 info properties, like id3.songname. - For ID3 2.0, id3.TITS property will retrieve the song name using the new tag (TITS).

- -

Note that no error handling is written for this example and if the ID3 content is long, - the result may go beyond the viewable area.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.media.Sound;
-    import flash.net.URLRequest;
-    import flash.media.ID3Info;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.events.Event;
-
-    public class Sound_id3Example extends Sprite {
-        private var snd:Sound = new Sound();       
-        private var myTextField:TextField = new TextField();
-
-        public function Sound_id3Example() {
-            snd.addEventListener(Event.ID3, id3Handler);
-            snd.load(new URLRequest("mySound.mp3"));
-        }
-    
-        private function id3Handler(event:Event):void {
-            var id3:ID3Info = snd.id3;
-
-            myTextField.autoSize = TextFieldAutoSize.LEFT;
-            myTextField.border = true;
-
-            myTextField.appendText("Received ID3 Info: \n");
-              
-            for (var propName:String in id3) {
-                myTextField.appendText(propName + " = " + id3[propName] + "\n");
-            }
- 
-            myTextField.appendText("\n" + "Artist: " + id3.artist + "\n");
-            myTextField.appendText("Song name: " + id3.songName + "\n");
-            myTextField.appendText("Album: " + id3.album + "\n\n"); 
- 
-            this.addChild(myTextField);
-        }
-    }
-}
-
-

-
- - - - - -
isBufferingproperty 
-
-isBuffering:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns the buffering state of external MP3 files. If the value is true, - any playback is - currently suspended while the object waits for more data. - -

Implementation -
-    public function get isBuffering():Boolean -
-
- - - - - -
isURLInaccessibleproperty 
-
-isURLInaccessible:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates if the Sound.url property has been - truncated. When the isURLInaccessible value is true the - Sound.url value is only the domain of the final URL from which the sound loaded. - For example, the property is truncated if the sound is loaded from http://www.adobe.com/assets/hello.mp3, - and the Sound.url property has the value http://www.adobe.com. - The isURLInaccessible value is true only when all of the following are also true: -

    -
  • An HTTP redirect occurred while loading the sound file.
    • -
  • The SWF file calling Sound.load() is from a different domain than - the sound file's final URL.
    • -
  • The SWF file calling Sound.load() does not have permission to access - the sound file. Permission is granted to access the sound file the same way permission is granted - for the Sound.id3 property: establish a policy file and use the SoundLoaderContext.checkPolicyFile - property.
    • -
-

Note: The isURLInaccessible property was added for Flash Player 10.1 and AIR 2.0. - However, this property is made available to SWF files of all versions when the - Flash runtime supports it. So, using some authoring tools in "strict mode" causes a compilation error. To work around the error - use the indirect syntax mySound["isURLInaccessible"], or disable strict mode. If you are using Flash Professional CS5 - or Flex SDK 4.1, you can use and compile this API for runtimes released before Flash Player 10.1 and AIR 2.

-

For application content in AIR, the value of this property is always false.

- Implementation -
-    public function get isURLInaccessible():Boolean -
-

-See also -

-
-url -
-id3 -
-flash.media.SoundLoaderContext.checkPolicyFile -
-
- - - - - -
lengthproperty 
-
-length:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The length of the current sound in milliseconds. -

Implementation -
-    public function get length():Number -
-
- - - - - -
urlproperty 
-
-url:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The URL from which this sound was loaded. This property is applicable only to Sound - objects that were loaded using the Sound.load() method. For - Sound objects that are associated with a sound asset from a SWF file's library, the - value of the url property is null. -

When you first call Sound.load(), the url property - initially has a value of null, because the final URL is not yet known. - The url property will have a non-null value as soon as an - open event is dispatched from the Sound object.

-

The url property contains the final, absolute URL from which a sound was - loaded. The value of url is usually the same as the value passed to the - stream parameter of Sound.load(). - However, if you passed a relative URL to Sound.load() - the value of the url property represents the absolute URL. - Additionally, if the original URL request is redirected by an HTTP server, the value - of the url property reflects the final URL from which the sound file was actually - downloaded. This reporting of an absolute, final URL is equivalent to the behavior of - LoaderInfo.url.

-

In some cases, the value of the url property is truncated; see the - isURLInaccessible property for details.

- Implementation -
-    public function get url():String -
-

-See also -

-
-load() -
-flash.display.LoaderInfo.url -
-isURLInaccessible -
-
- -
Constructor detail
- - - - - -
Sound()constructor
-
-public function Sound(stream:URLRequest = null, context:SoundLoaderContext = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new Sound object. If you pass a valid URLRequest object to the - Sound constructor, the constructor automatically calls the load() function - for the Sound object. - If you do not pass a valid URLRequest object to the Sound constructor, - you must call the load() function for the Sound object yourself, - or the stream will not load. -

Once load() is called on a Sound object, you can't later load - a different sound file into that Sound object. To load a different sound file, - create a new Sound object.

- In Flash Player 10 and later and AIR 1.5 and later, instead of using load(), - you can use the sampleData event handler to load sound dynamically into the Sound object. - - Parameters - - - - - - - - - - -
stream:URLRequest (default = null) — The URL that points to an external MP3 file. - -
 
context:SoundLoaderContext (default = null) — An optional SoundLoader context object, which can define the buffer time - (the minimum number of milliseconds of MP3 data to hold in the Sound object's - buffer) and can specify whether the application should check for a cross-domain - policy file prior to loading the sound. -
-
- -
Method detail
- - - - - -
close()method
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Closes the stream, causing any download of data to cease. - No data may be read from the stream after the close() - method is called. - -


-Throws - - - - -
Error — The stream could not be closed, or - the stream was not open. - -
-
-Example -
In the following example, when the user clicks on the Stop button, - the Sound.close() method will be called and the sound will stop streaming. - -

In the constructor, a text field is created for the Start and Stop button. - When the user clicks on the text field, the clickHandler() method is invoked. - It handles the starting and stopping of the sound file. Note that depending on - the network connection or when the user clicks the Stop button, much of the file could - already have been loaded and it may take a while for the sound file to stop playing. - A try...catch block is used to catch any IO error that may occur while - closing the stream. For example, if the sound is loaded from a local directory and - not streamed, error 2029 is caught, stating, "This URLStream object does not have an open stream."

- -
-
 
-package {
-    import flash.display.Sprite;
-    import flash.net.URLRequest;
-    import flash.media.Sound;    
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.events.MouseEvent;
-    import flash.errors.IOError;
-    import flash.events.IOErrorEvent;
-
-    public class Sound_closeExample extends Sprite {
-        private var snd:Sound = new Sound();
-        private var button:TextField = new TextField();
-        private var req:URLRequest = new URLRequest("http://av.adobe.com/podcast/csbu_dev_podcast_epi_2.mp3");
-        
-        public function Sound_closeExample() {
-            button.x = 10;
-            button.y = 10;
-            button.text = "START";
-            button.border = true;
-            button.background = true;
-            button.selectable = false;
-            button.autoSize = TextFieldAutoSize.LEFT;
-
-            button.addEventListener(MouseEvent.CLICK, clickHandler);
-
-            this.addChild(button);
-        }
-
-        private function clickHandler(e:MouseEvent):void {
-
-            if(button.text == "START") {
-
-                snd.load(req);
-                snd.play();        
-
-                snd.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-
-                button.text = "STOP";
-            }
-            else if(button.text == "STOP") {
-                    
-                try {
-                    snd.close();
-                    button.text = "Wait for loaded stream to finish.";
-                }
-                catch (error:IOError) {
-                    button.text = "Couldn't close stream " + error.message;    
-                }
-            }
-        }
-        
-        private function errorHandler(event:IOErrorEvent):void {
-                button.text = "Couldn't load the file " + event.text;
-        }
-    }
-}
-
-

-
- - - - - -
extract()method 
-
-public function extract(target:ByteArray, length:Number, startPosition:Number = -1):Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Extracts raw sound data from a Sound object. -

This method is designed to be used when you are working - with dynamically generated audio, using a function you assign - to the sampleData event for a different Sound object. - That is, you can use this method to extract sound data from a Sound object. - Then you can write the data to the byte array that another Sound object is using - to stream dynamic audio.

- -

The audio data is placed in the target byte array starting from the current position of the byte array. - The audio data is always exposed as 44100 Hz Stereo. The sample type is a 32-bit floating-point value, - which can be converted to a Number using ByteArray.readFloat().

- - Parameters - - - - - - - - - - - - - - - - -
target:ByteArray — A ByteArray object in which the extracted sound samples are placed. -
 
length:Number — The number of sound samples to extract. - A sample contains both the left and right channels — that is, two 32-bit floating-point values. - -
 
startPosition:Number (default = -1) — The sample at which extraction begins. - If you don't specify a value, the first call to Sound.extract() starts at the beginning - of the sound; subsequent calls without a value for startPosition - progress sequentially through the file. -
-

-Returns - - - - -
Number — - The number of samples written to the ByteArray specified in the target parameter. - - -
-

-See also -

-
-play() -
-sampleData -
-
-Example -
The following example loads an mp3 file and uses the - extract() method of the Sound class to access the audio data. - -

The mp3 data is loaded into the sourceSnd Sound object. When the - application loads the mp3 data, it calls the loaded() function - (the event handler for the complete event of the sourceSnd - object). A second Sound object, outputSound, is used to play the - modified audio. The outputSound object has a sampleData - event listener; so the object dispatches periodical sampleData events - once you call the play() method of the object. - The upOctave() method returns a byte array of modified audio data - based on the source audio data. It returns audio that is one octave higher by - skipping over every other audio sample in the source data. The event handler for - the sampleData event writes the returned byte array to the data - property of the outputSound object. The data byte array is - appended to the output audio data for the outputSound object.

- -

To test this example, add a test.mp3 file to the same directory as the SWF file.

-
-
-
-var sourceSnd:Sound = new Sound();
-var outputSnd:Sound = new Sound();
-var urlReq:URLRequest = new URLRequest("test.mp3");
-
-sourceSnd.load(urlReq);
-sourceSnd.addEventListener(Event.COMPLETE, loaded);
-
-function loaded(event:Event):void
-{
-    outputSnd.addEventListener(SampleDataEvent.SAMPLE_DATA, processSound);
-    outputSnd.play();
-}
-
-function processSound(event:SampleDataEvent):void
-{
-    var bytes:ByteArray = new ByteArray();
-    sourceSnd.extract(bytes, 4096);
-    event.data.writeBytes(upOctave(bytes));
-}
-
-function upOctave(bytes:ByteArray):ByteArray
-{
-    var returnBytes:ByteArray = new ByteArray();
-    bytes.position = 0;
-    while(bytes.bytesAvailable > 0)
-    {
-        returnBytes.writeFloat(bytes.readFloat());
-        returnBytes.writeFloat(bytes.readFloat());
-        if (bytes.bytesAvailable > 0)
-        {
-            bytes.position += 8;
-        }
-    }
-    return returnBytes;
-}
-
-

-
- - - - - -
load()method 
-
-public function load(stream:URLRequest, context:SoundLoaderContext = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Initiates loading of an external MP3 file from the specified URL. If you provide - a valid URLRequest object to the Sound constructor, the constructor calls - Sound.load() for you. You only need to call Sound.load() - yourself if you - don't pass a valid URLRequest object to the Sound constructor or you pass a null - value. -

Once load() is called on a Sound object, you can't later load - a different sound file into that Sound object. To load a different sound file, - create a new Sound object.

-

When using this method, consider the following security model:

- -
    - -
  • Calling Sound.load() is not allowed if the calling file is in the - local-with-file-system sandbox and the sound is in a network sandbox.
    • - -
  • Access from the local-trusted or local-with-networking sandbox requires permission - from a website through a URL policy file.
    • - -
  • You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.
    • -
  • You can prevent a SWF file from using this method by setting the - allowNetworking parameter of the object and embed - tags in the HTML page that contains the SWF content.
    • - -
- -

In Flash Player 10 and later, if you use a multipart Content-Type (for example "multipart/form-data") - that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), - the POST operation is subject to the security rules applied to uploads:

-
    -
  • The POST operation must be performed in response to a user-initiated action, such as a mouse click or key press.
    • -
  • If the POST operation is cross-domain (the POST target is not on the same server as the SWF file - that is sending the POST request), - the target server must provide a URL policy file that permits cross-domain access.
    • -
-

Also, for any multipart Content-Type, the syntax must be valid (according to the RFC2046 standards). - If the syntax appears to be invalid, the POST operation is subject to the security rules applied to uploads.

-

In Adobe AIR, content in the application security sandbox (content - installed with the AIR application) are not restricted by these security limitations.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- - Parameters - - - - - - - - - - -
stream:URLRequest — A URL that points to an external MP3 file. - -
 
context:SoundLoaderContext (default = null) — An optional SoundLoader context object, which can define the buffer time - (the minimum number of milliseconds of MP3 data to hold in the Sound object's - buffer) and can specify whether the application should check for a cross-domain - policy file prior to loading the sound. -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
Error — A network error caused the load to fail. - -
 
SecurityError — Local untrusted files may not communicate with - the Internet. You can work around this by reclassifying this file - as local-with-networking or trusted. - -
 
SecurityError — You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide. - -
 
Error — The digest property of the stream object is not - null. You should only set the digest property of a URLRequest object - when calling the URLLoader.load() method when loading a SWZ file (an Adobe - platform component). -
-
-Example -
The following example displays the loading progress of a sound file. - -

In the constructor a URLRequest object is created to identify the location - of the sound file, which is a podcast from Adobe. The file is loaded in a try...catch - block in order to catch any error that may occur while loading the file. If an IO error - occurred, the errorHandler() method also is invoked and the error message - is written in the text field intended for the progress report. While a load operation is in - progress, a ProgressEvent.PROGRESS event is dispatched and the progressHandler() - method is called. Here, ProgressEvent.PROGRESS event is used as a timer for - calculating the load progress.

- -

The progressHandler() method divides the bytesLoaded value - passed with the ProgressEvent object by the bytesTotal value to - arrive at a percentage of the sound data that is being loaded. It then displays these values - in the text field. (Note that if the file is small, cached, or the file is in the local directory, - the progress may not be noticeable.)

-
-
-package {
-    import flash.display.Sprite;
-    import flash.net.URLRequest;
-    import flash.media.Sound;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.events.ProgressEvent;
-    import flash.events.IOErrorEvent;
-    
-    public class Sound_loadExample extends Sprite {
-        private var snd:Sound = new Sound();
-        private var statusTextField:TextField  = new TextField();
-
-        public function Sound_loadExample(){
-
-            statusTextField.autoSize = TextFieldAutoSize.LEFT;
-            var req:URLRequest = new URLRequest("http://av.adobe.com/podcast/csbu_dev_podcast_epi_2.mp3");
-            
-            try {
-            snd.load(req);
-            
-            snd.play();
-            }
-            catch (err:Error) {
-                trace(err.message);
-            }
- 
-            snd.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-            snd.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-                     
-            this.addChild(statusTextField);
-        }
-    
-        private function progressHandler(event:ProgressEvent):void {
-            var loadTime:Number = event.bytesLoaded / event.bytesTotal;
-            var LoadPercent:uint = Math.round(100 * loadTime);
-              
-            statusTextField.text = "Sound file's size in bytes: " + event.bytesTotal + "\n" 
-                                 + "Bytes being loaded: " + event.bytesLoaded + "\n" 
-                                 + "Percentage of sound file that is loaded " + LoadPercent + "%.\n";
-        }
- 
-        private function errorHandler(errorEvent:IOErrorEvent):void {
-            statusTextField.text = "The sound could not be loaded: " + errorEvent.text;
-        }
-    }
-}
-
-

-
- - - - - -
loadCompressedDataFromByteArray()method 
-
-public function loadCompressedDataFromByteArray(bytes:ByteArray, bytesLength:uint):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- load MP3 sound data from a ByteArray object into a Sound object. The data will be read from - the current ByteArray position and will leave the ByteArray position at the end of the specified - bytes length once finished. - If the MP3 sound data contains ID3 data ID3 events will be dispatched during this function call. - This function will throw an exception if the ByteArray object does not contain enough data. -

Parameters - - - - - - - - - - -
bytes:ByteArray
 
bytesLength:uint
-
- - - - - -
loadPCMFromByteArray()method 
-
-public function loadPCMFromByteArray(bytes:ByteArray, samples:uint, format:String = "float", stereo:Boolean = true, sampleRate:Number = 44100.0):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Load PCM 32-bit floating point sound data from a ByteArray object into a Sound object. The data - will be read from the current ByteArray position and will leave the ByteArray position at the - end of the specified sample length multiplied by either 1 channel or 2 channels if the stereo - flag is set once finished. -

Starting with Flash Player 11.8, the amount of audio data that can be passed to this function is limited. - For SWF versions >= 21, this function throws an exception if the amount of audio data passed into - this function is more than 1800 seconds. That is, samples / sampleRate should be less than or equal - to 1800. - For swf versions < 21, the runtime fails silently if the amount of audio data passed in - is more than 12000 seconds. This is provided only for backward compatibility.

-

This function throws an exception if the ByteArray object does not contain enough data.

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
bytes:ByteArray
 
samples:uint
 
format:String (default = "float")
 
stereo:Boolean (default = true)
 
sampleRate:Number (default = 44100.0)
-
- - - - - -
play()method 
-
-public function play(startTime:Number = 0, loops:int = 0, sndTransform:SoundTransform = null):SoundChannel -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Generates a new SoundChannel object to play back the sound. This method - returns a SoundChannel object, which you access to stop the sound and to monitor volume. - (To control the volume, panning, and balance, access the SoundTransform object assigned - to the sound channel.) -

Parameters - - - - - - - - - - - - - - - - -
startTime:Number (default = 0) — The initial position in milliseconds at which playback should - start. -
 
loops:int (default = 0) — Defines the number of times a sound loops back to the startTime value - before the sound channel stops playback. -
 
sndTransform:SoundTransform (default = null) — The initial SoundTransform object assigned to the sound channel. -
-

-Returns - - - - -
SoundChannel — - A SoundChannel object, which you use to control the sound. - This method returns null if you have no sound card - or if you run out of available sound channels. The maximum number of - sound channels available at once is 32. - - -
-

-See also -

-
-SoundChannel.stop() -
-SoundMixer.stopAll() -
-
-Example -
In the following example, once the file is loaded, the user using a - graphic bar can select the starting position (starting time) of the sound file. - -

The constructor calls the Sound.load() method to start loading the sound data. - Next it calls the Sound.play() method which will start playing the sound as soon - as enough data has loaded. The Sound.play() method returns a SoundChannel object - that can be used to control the playback of the sound. The text field displays the instructions. - To make sure the content of where the user wants the sound to start, has already been loaded, - the bar Sprite object is created and displayed after the file has finished loading. - An Event.COMPLETE event is dispatched when the file is successfully loaded, which - triggers the completeHandler() method. The completeHandler() method - then creates the bar and adds it to the display list. (A sprite object is used instead of a shape - object to support interactivity.) When the user clicks on the bar, the clickHandler() - method is triggered.

- -

In the clickHandler() method, the position of x coordinate of the user's click, - event.localX, is used to determine where the user wants the file to start. - Since the bar is 100 pixels and it starts at x coordinate 100 pixels, it is easy to determine - the percentage of the position. Also, since the file is loaded, the length - property of the sound file will have the length of the complete file in milliseconds. - Using the length of the sound file and the position in the line, a starting position - for the sound file is determined. After stopping the sound from playing, the sound file - restarts at the selected starting position, which is past as the startTime - parameter to the play() method.

- -
-
 
-package {
-    import flash.display.Sprite;
-    import flash.display.Graphics;
-    import flash.events.MouseEvent;
-    import flash.media.Sound;;
-    import flash.net.URLRequest;
-    import flash.media.SoundChannel;
-    import flash.events.ProgressEvent;
-    import flash.events.Event;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.events.IOErrorEvent;
-    
-    public class Sound_playExample1 extends Sprite {
-        private var snd:Sound = new Sound();
-        private var channel:SoundChannel = new SoundChannel();
-        private var infoTextField:TextField = new TextField();
-    
-        public function Sound_playExample1() {
-
-            var req:URLRequest = new URLRequest("MySound.mp3");
-            
-            infoTextField.autoSize = TextFieldAutoSize.LEFT;
-            infoTextField.text = "Please wait for the file to be loaded.\n" 
-                                + "Then select from the bar to decide where the file should start.";
-            
-            snd.load(req);               
-            channel = snd.play();
-
-            snd.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-            snd.addEventListener(Event.COMPLETE, completeHandler);
-
-
-            this.addChild(infoTextField);
-        }
-
-        private function completeHandler(event:Event):void {                
-            infoTextField.text = "File is ready.";
-
-            var bar:Sprite = new Sprite();
-
-            bar.graphics.lineStyle(5, 0xFF0000);
-            bar.graphics.moveTo(100, 100);
-            bar.graphics.lineTo(200, 100);
-
-            bar.addEventListener(MouseEvent.CLICK, clickHandler);
-
-            this.addChild(bar);
-        }
-    
-        private function clickHandler(event:MouseEvent):void {
-            
-                var position:uint = event.localX;
-                var percent:uint = Math.round(position) - 100;   
-                var cue:uint = (percent / 100) * snd.length;
-
-                channel.stop();
-                channel = snd.play(cue);    
-        }
-
-        private function errorHandler(errorEvent:IOErrorEvent):void {
-            infoTextField.text = "The sound could not be loaded: " + errorEvent.text;
-        }
-    }
-}
-
-

In the following example, depending on whether the user single or double clicks on - a button the sound will play once or twice. - -

In the constructor, the sound is loaded and a simple rectangle button sprite object - is created. (A sprite object is used instead of a shape object to support interactivity.) - Here, it is assumed that the sound file is in the same directory as the SWF file. (There - is no error handling code for this example.)

- -

Two event listeners are set up to respond to single mouse clicks and double clicks. - If the user clicks once, the clickHandler() method is invoked, which plays the sound. - If the user double clicks on the button, the doubleClickHandler() method is invoked, - which will play the sound file twice. The second argument of the play() method is set - to 1, which means the sound will loop back once to the starting time of the - sound and play again. The starting time, first argument, is set to 0, meaning - the file will play from the beginning.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.events.MouseEvent;
-    import flash.media.Sound;
-    import flash.net.URLRequest;
-
-    public class Sound_playExample2 extends Sprite {
-        private var button:Sprite = new Sprite(); 
-        private var snd:Sound = new Sound();
-            
-        public function Sound_playExample2() {
-
-            var req:URLRequest = new URLRequest("click.mp3");
-            snd.load(req);               
-     
-            button.graphics.beginFill(0x00FF00);
-            button.graphics.drawRect(10, 10, 50, 30);
-            button.graphics.endFill();
-     
-            button.addEventListener(MouseEvent.CLICK, clickHandler);
-            button.addEventListener(MouseEvent.DOUBLE_CLICK, doubleClickHandler);
-     
-            this.addChild(button);
-        }
-
-        private function clickHandler(event:MouseEvent):void {
-            snd.play();            
-        }
-
-        private function doubleClickHandler(event:MouseEvent):void {
-            snd.play(0, 2);        
-        }
-    }
-}
-
-

The following example displays the loading and playing progress of a sound file. - -

In the constructor, the file is loaded in a try...catch block in order to catch - any error that may occur while loading the file. A listener is added to the sound object that - will respond to an IOErrorEvent event by calling the errorHandler() method. - Another listener is added for the main application that will respond to an Event.ENTER_FRAME - event, which is used as the timing mechanism for showing playback progress. Finally, a third listener - is added for the sound channel that will respond to an Event.SOUND_COMPLETE event (when - the sound has finished playing), by calling the soundCompleteHandler() method. - The soundCompleteHandler() method also removes the event listener for the - Event.ENTER_FRAME event.

- -

The enterFrameHandler() method divides the bytesLoaded value - passed with the ProgressEvent object by the bytesTotal value to - arrive at a percentage of the sound data that is being loaded. The percentage of sound data that is - being played could be determined by dividing the value of sound channel's position property - by the length of the sound data. However, if the sound data is not fully loaded, the length - property of the sound object shows only the size of the sound data that is currently loaded. - An estimate of the eventual size of the full sound file is calculated by dividing the value - of the current sound object's length by the value of the bytesLoaded - property divided by the value of the bytesTotal property.

- -

Note that if the file is small, cached, or the file is in the local directory, the load progress - may not be noticeable. Also the lag time between when the sound data starts loading and the loaded - data starts playing is determined by the value of the SoundLoaderContext.buffertime - property, which is by default 1000 milliseconds and can be reset.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.net.URLRequest;
-    import flash.media.Sound;
-    import flash.media.SoundChannel;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.events.Event;
-    import flash.events.IOErrorEvent;
-    
-    public class Sound_playExample3 extends Sprite {
-        private var snd:Sound = new Sound();
-        private var channel:SoundChannel;
-        private var statusTextField:TextField  = new TextField();
-
-        public function Sound_playExample3(){
-
-            statusTextField.autoSize = TextFieldAutoSize.LEFT;
-
-           var req:URLRequest = new URLRequest("http://av.adobe.com/podcast/csbu_dev_podcast_epi_2.mp3");
-            
-            try {
-                snd.load(req);
-            
-                channel = snd.play();
-            }
-            catch (err:Error) {
-                trace(err.message);
-            }
-                    
-            snd.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-            addEventListener(Event.ENTER_FRAME, enterFrameHandler);
-            channel.addEventListener(Event.SOUND_COMPLETE, soundCompleteHandler);
-                    
-            this.addChild(statusTextField);
-        }
-    
-        private function enterFrameHandler(event:Event):void {    
-            var loadTime:Number = snd.bytesLoaded / snd.bytesTotal;
-            var loadPercent:uint = Math.round(100 * loadTime);
-            var estimatedLength:int = Math.ceil(snd.length / (loadTime));
-            var playbackPercent:uint = Math.round(100 * (channel.position / estimatedLength));
-      
-            statusTextField.text = "Sound file's size is " + snd.bytesTotal + " bytes.\n" 
-                                   + "Bytes being loaded: " + snd.bytesLoaded + "\n" 
-                                   + "Percentage of sound file that is loaded " + loadPercent + "%.\n"
-                                   + "Sound playback is " + playbackPercent + "% complete.";     
-        }
- 
-        private function errorHandler(errorEvent:IOErrorEvent):void {
-            statusTextField.text = "The sound could not be loaded: " + errorEvent.text;
-        }
-
-        private function soundCompleteHandler(event:Event):void {
-            statusTextField.text = "The sound has finished playing.";
-            removeEventListener(Event.ENTER_FRAME, enterFrameHandler);
-        }
-    }
-}
-
-

-
-
Event detail
- - - - - -
completeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when data has loaded successfully. -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -

-See also -

-
-load() -
-
- - - - - -
id3event  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.ID3 -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched by a Sound object when ID3 data is available for an MP3 sound. -

- The Event.ID3 constant defines the value of the type property of an id3 event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Sound object loading the MP3 for which ID3 data is now available. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -

-See also -

-
-Sound.id3 -
-
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when an input/output error occurs that causes a load operation to fail. -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -

-See also -

-
-load() -
-
- - - - - -
openevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.OPEN -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when a load operation starts. -

- The Event.OPEN constant defines the value of the type property of an open event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has opened a connection.
- -

-See also -

-
-load() -
-
- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when data is received as a load operation progresses. -

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -

-See also -

-
-load() -
-
- - - - - -
sampleDataevent  
-
-Event object type: flash.events.SampleDataEvent -
-SampleDataEvent.type property = flash.events.SampleDataEvent.SAMPLE_DATA -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Dispatched when the runtime requests new audio data. -

- Defines the value of the type property of a SampleDataEvent event object. -

This event has the following properties:

- - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
positionThe point from which audio data is provided.
- -
-Example -
The following example plays a simple sine wave. - -
-
-var mySound:Sound = new Sound();
-function sineWaveGenerator(event:SampleDataEvent):void {
-    for ( var c:int=0; c<8192; c++ ) {
-		event.data.writeFloat(Math.sin((Number(c+event.position)/Math.PI/2))*0.25);
-		event.data.writeFloat(Math.sin((Number(c+event.position)/Math.PI/2))*0.25);
-	}
-}
-
-mySound.addEventListener(SampleDataEvent.SAMPLE_DATA,sineWaveGenerator);
-mySound.play();
-
-

-

-See also -

-
-extract() -
-play() -
-flash.events.SampleDataEvent -
-
- -
Examples
-
examples\SoundExample
-
The following example displays - information about sound events that take place as an MP3 file is opened and played. To run this example, - place a file named MySound.mp3 in the same directory as your SWF file. -
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.media.Sound;
-    import flash.media.SoundChannel;
-    import flash.net.URLRequest;
-
-    public class SoundExample extends Sprite {
-        private var url:String = "MySound.mp3";
-        private var song:SoundChannel;
-
-        public function SoundExample() {
-            var request:URLRequest = new URLRequest(url);
-            var soundFactory:Sound = new Sound();
-            soundFactory.addEventListener(Event.COMPLETE, completeHandler);
-            soundFactory.addEventListener(Event.ID3, id3Handler);
-            soundFactory.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            soundFactory.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            soundFactory.load(request);
-            song = soundFactory.play();
-        }
-
-        private function completeHandler(event:Event):void {
-            trace("completeHandler: " + event);
-        }
-
-        private function id3Handler(event:Event):void {
-            trace("id3Handler: " + event);
-        }
-
-        private function ioErrorHandler(event:Event):void {
-            trace("ioErrorHandler: " + event);
-        }
-
-        private function progressHandler(event:ProgressEvent):void {
-            trace("progressHandler: " + event);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/SoundChannel.html b/html-docs/flash/media/SoundChannel.html deleted file mode 100644 index 185c6b8..0000000 --- a/html-docs/flash/media/SoundChannel.html +++ /dev/null @@ -1,786 +0,0 @@ - - - - - - - - -flash.media.SoundChannel (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class SoundChannel
InheritanceSoundChannel Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The SoundChannel class controls a sound in an application. Every sound - is assigned to a sound channel, and the application can have multiple - sound channels that are mixed together. The SoundChannel class contains a stop() method, - properties for monitoring the amplitude (volume) of the channel, and a property for assigning a - SoundTransform object to the channel. - -

-

-View the examples. -

-

-See also -

-
-Sound -
-SoundTransform -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  leftPeak : Number -
[read-only] - The current amplitude (volume) of the left channel, from 0 (silent) to 1 (full amplitude).
-		SoundChannel
  position : Number -
[read-only] - When the sound is playing, the position property indicates in milliseconds the current point - that is being played in the sound file.
-		SoundChannel
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rightPeak : Number -
[read-only] - The current amplitude (volume) of the right channel, from 0 (silent) to 1 (full amplitude).
-		SoundChannel
  soundTransform : SoundTransform -
- The SoundTransform object assigned to the sound channel.
-		SoundChannel
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-stop():void -
-
- Stops the sound playing in the channel.
-		SoundChannel
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-soundComplete -
-		 - Dispatched when a sound has finished playing.SoundChannel
-
- -
- -
Property detail
- - - - - -
leftPeakproperty
-
-leftPeak:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The current amplitude (volume) of the left channel, from 0 (silent) to 1 (full amplitude). - -

Implementation -
-    public function get leftPeak():Number -
-
- - - - - -
positionproperty 
-
-position:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- When the sound is playing, the position property indicates in milliseconds the current point - that is being played in the sound file. When the sound is stopped or paused, the - position property indicates the last point that was played in the sound file. -

A common use case is to save the value of the position property when the - sound is stopped. You can resume the sound later by restarting it from that saved position. -

- -

If the sound is looped, position is reset to 0 at the beginning of each loop.

- Implementation -
-    public function get position():Number -
-
- - - - - -
rightPeakproperty 
-
-rightPeak:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The current amplitude (volume) of the right channel, from 0 (silent) to 1 (full amplitude). - -

Implementation -
-    public function get rightPeak():Number -
-
- - - - - -
soundTransformproperty 
-
-soundTransform:SoundTransform  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The SoundTransform object assigned to the sound channel. A SoundTransform object - includes properties for setting volume, panning, left speaker assignment, and right - speaker assignment. - -

Implementation -
-    public function get soundTransform():SoundTransform -
-    public function set soundTransform(value:SoundTransform):void -
-

-See also -

-
-SoundTransform -
-
- -
Method detail
- - - - - -
stop()method
-
-public function stop():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Stops the sound playing in the channel. - -


-Example -
In the following example, the user can pause and replay a sound file. - -

In the constructor, the sound file is loaded. (This example assumes that the file is - in the same directory as the SWF file.) A text field is used as a button for the user - to play or pause the sound. When the user selects the button - text field, the clickHandler() method is invoked.

- -

In the clickHandler() method, the first time the user selects - the text field, the sound is set to play and is assigned to a sound channel. Next, when - the user selects the text field to pause, the sound stops playing. The sound channel's - position property records the position of the sound at the - time it was stopped. This property is used to resume the sound starting at that position, after - the user selects the text field to start playing again. Each time the - Sound.play() method is called, a new SoundChannel object is created and - assigned to the channel variable. The Sound object must be - assigned to a SoundChannel object in order to use the sound channel's - stop() method to pause the sound.

- -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.media.Sound;
-    import flash.media.SoundChannel;
-    import flash.net.URLLoader;
-    import flash.net.URLRequest;
-    import flash.text.TextField;
-    import flash.events.MouseEvent;
-    import flash.text.TextFieldAutoSize;
-            
-    public class SoundChannel_stopExample extends Sprite {
-        private var snd:Sound = new Sound();
-        private var channel:SoundChannel = new SoundChannel();
-        private var button:TextField = new TextField();
-
-        public function SoundChannel_stopExample() {
-            var req:URLRequest = new URLRequest("MySound.mp3");
-            snd.load(req);
-            
-            button.x = 10;
-            button.y = 10;
-            button.text = "PLAY";
-            button.border = true;
-            button.background = true;
-            button.selectable = false;
-            button.autoSize = TextFieldAutoSize.CENTER;
-
-            button.addEventListener(MouseEvent.CLICK, clickHandler);
-
-            this.addChild(button);
-        }
-
-        private function clickHandler(e:MouseEvent):void {
-            var pausePosition:int = channel.position;
-
-            if(button.text == "PLAY") {
-                channel = snd.play(pausePosition);
-                button.text = "PAUSE";
-            } 
-            else {
-                channel.stop();
-                button.text = "PLAY";
-            }
-        }
-    }
-}
-
-

-
-
Event detail
- - - - - -
soundCompleteevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.SOUND_COMPLETE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a sound has finished playing. -

- The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe SoundChannel object in which a sound has finished playing.
- -
-Example -
In the following example, the user selects songs from a playlist, - and then selects Play to play the song in the order selected. - -

In the constructor, a text field is defined that holds the song list - and a line for the selection to play. (Usually, buttons are - used for play and list boxes for a song list.) A text format object is - defined that changes the format of the song lines to italic after they are - selected. When a user selects the text field, the clickHandler() - method is invoked.

- -

In the clickHandler() method, the getLineIndexAtPoint() - method of the text field object returns the index of the line that the user selected. Using - the line index, the getLineText() method gets the content of the text. - The if statement checks whether the user selected to play a song or add a song to the - play list. If a user selected to play and a song has been selected, then the event - listener for mouse click is removed and the playNext() method is called to - begin playing the songs. If the user selected a song title, the content of the - line is added to the songList array and the format of the line is set to italic.

- -

The playNext() method iterates through the array list to load - and play each song. The song is also assigned to a sound channel. An event listener - for the sound channel is added to respond when the song finishes playing and the - Event.SOUND_COMPLETE event is dispatched. The soundCompleteHandler() - method then invokes the playNext() method to play the next song. This process - continues until all the songs listed in the array finish playing.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.media.Sound;
-    import flash.media.SoundChannel;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.events.MouseEvent;
-    import flash.text.TextFormat;
-    import flash.net.URLRequest;
-    import flash.events.Event;
-    import flash.events.IOErrorEvent;
-
-    public class SoundChannel_event_soundCompleteExample extends Sprite {
-        private var channel:SoundChannel = new SoundChannel();
-        private var songList:Array = new Array();
-        private var listTextField:TextField = new TextField();
-        private var songFormat:TextFormat = new TextFormat();
-        private var arrayIndex:int = 0;
-        private var songSelected:Boolean = false;
-        
-        public function SoundChannel_event_soundCompleteExample() {
-            
-            listTextField.autoSize = TextFieldAutoSize.LEFT;
-            listTextField.border = true
-            listTextField.background = true;
-            listTextField.text = "Song1.mp3\n" + "Song2.mp3\n" 
-                                + "Song3.mp3\n" + "Song4.mp3\n" + "PLAY";
-        
-            songFormat.italic = true;
- 
-            listTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-                        
-            addChild(listTextField);
-        }
-        
-        private function clickHandler(e:MouseEvent):void {
-            var index:int = listTextField.getLineIndexAtPoint(e.localX, e.localY);
-            var line:String = listTextField.getLineText(index);
-            var firstIndex:uint = listTextField.getLineOffset(index);
-            var playLine:uint = listTextField.numLines - 1;
-
-                if((index == playLine) && (songSelected == true)) {
-                    listTextField.removeEventListener(MouseEvent.CLICK, clickHandler);
-                    playNext();       
-
-                } else if (index != playLine) {
-                     songList.push(line.substr(0, (line.length - 1)));
-                     listTextField.setTextFormat(songFormat, firstIndex, 
-                                (firstIndex + listTextField.getLineLength(index)));     
-                    songSelected = true;
-                 }
-        }
-
-        private function playNext():void {
- 
-             if(arrayIndex < songList.length) {
-                var snd:Sound = new Sound();
-                snd.load(new URLRequest(songList[arrayIndex]));
-                channel = snd.play();
-                
-                channel.addEventListener(Event.SOUND_COMPLETE, soundCompleteHandler);
-                arrayIndex++;
- 
-            } else {
-                songSelected = false;
-                    
-                while(arrayIndex > 0) {
-                    songList.pop();
-                    arrayIndex--;
-                }
-            }
-        }    
-
-        private function soundCompleteHandler(e:Event):void {
-            playNext();
-        }
-
-        private function errorHandler(errorEvent:IOErrorEvent):void {
-            trace(errorEvent.text);
-        }
-    }
-}
-
-

-
- -
Examples
-
examples\SoundChannelExample
-
The following example loads an MP3 file, plays it, and displays - information about sound events that take place as the MP3 file is loaded and played. A Timer - object provides updated information about the position of the playhead every 50 milliseconds. - To run this example, place a file named MySound.mp3 in the same directory as your SWF file. - -
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.media.Sound;
-    import flash.media.SoundChannel;
-    import flash.net.URLRequest;
-    import flash.utils.Timer;
-
-    public class SoundChannelExample extends Sprite {
-        private var url:String = "MySound.mp3";
-        private var soundFactory:Sound;
-        private var channel:SoundChannel;
-        private var positionTimer:Timer;
-
-        public function SoundChannelExample() {
-            var request:URLRequest = new URLRequest(url);
-            soundFactory = new Sound();
-            soundFactory.addEventListener(Event.COMPLETE, completeHandler);
-            soundFactory.addEventListener(Event.ID3, id3Handler);
-            soundFactory.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            soundFactory.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            soundFactory.load(request);
-
-            channel = soundFactory.play();
-            channel.addEventListener(Event.SOUND_COMPLETE, soundCompleteHandler);
-
-            positionTimer = new Timer(50);
-            positionTimer.addEventListener(TimerEvent.TIMER, positionTimerHandler);
-            positionTimer.start();
-        }
-        
-
-        private function positionTimerHandler(event:TimerEvent):void {
-            trace("positionTimerHandler: " + channel.position.toFixed(2));
-        }
-
-        private function completeHandler(event:Event):void {
-            trace("completeHandler: " + event);
-        }
-
-        private function id3Handler(event:Event):void {
-            trace("id3Handler: " + event);
-        }
-
-        private function ioErrorHandler(event:Event):void {
-            trace("ioErrorHandler: " + event);
-            positionTimer.stop();       
-        }
-
-        private function progressHandler(event:ProgressEvent):void {
-            trace("progressHandler: " + event);
-        }
-
-        private function soundCompleteHandler(event:Event):void {
-            trace("soundCompleteHandler: " + event);
-            positionTimer.stop();
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/SoundCodec.html b/html-docs/flash/media/SoundCodec.html deleted file mode 100644 index f4e9547..0000000 --- a/html-docs/flash/media/SoundCodec.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - - - -flash.media.SoundCodec (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class SoundCodec
InheritanceSoundCodec Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-

-The SoundCodec class is an enumeration of constant values used in setting the codec property -of the Microphone class. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  NELLYMOSER : String = "NellyMoser"
[static] - Specifies that the Nellymoser codec be used for compressing audio.
-		SoundCodec
  PCMA : String = "pcma"
[static] - Specifies that the G711 A-law codec be used for compressing audio.
-		SoundCodec
  PCMU : String = "pcmu"
[static] - Specifies that the G711 u-law codec be used for compressing audio.
-		SoundCodec
  SPEEX : String = "Speex"
[static] - Specifies that the Speex codec be used for compressing audio.
-		SoundCodec
-
- -
- -
Constant detail
- - - - - -
NELLYMOSERconstant
-
-public static const NELLYMOSER:String = "NellyMoser" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that the Nellymoser codec be used for compressing audio. - This constant is the default value of the Microphone.codec property. - -

- - - - - -
PCMAconstant 
-
-public static const PCMA:String = "pcma" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.7 -
-

- Specifies that the G711 A-law codec be used for compressing audio. - -

- - - - - -
PCMUconstant 
-
-public static const PCMU:String = "pcmu" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.7 -
-

- Specifies that the G711 u-law codec be used for compressing audio. - -

- - - - - -
SPEEXconstant 
-
-public static const SPEEX:String = "Speex" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that the Speex codec be used for compressing audio. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/SoundLoaderContext.html b/html-docs/flash/media/SoundLoaderContext.html deleted file mode 100644 index 059330a..0000000 --- a/html-docs/flash/media/SoundLoaderContext.html +++ /dev/null @@ -1,473 +0,0 @@ - - - - - - - - -flash.media.SoundLoaderContext (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic class SoundLoaderContext
InheritanceSoundLoaderContext Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The SoundLoaderContext class provides security checks for files that load sound. - SoundLoaderContext objects are passed as an argument to the constructor and the - load() method of the Sound class. -

When you use this class, consider the following security model:

-
    -
  • Loading and playing a sound is not allowed if the calling file is in a network sandbox - and the sound file to be loaded is local.
    • - -
  • By default, loading and playing a sound is not allowed if the calling is local and - tries to load and play a remote sound. A user must grant explicit permission to allow this.
    • - -
  • Certain operations dealing with sound are restricted. The data in a loaded sound cannot - be accessed by a file in a different domain unless you implement a URL policy file. - Sound-related APIs that fall under this restriction are the Sound.id3 property and the - SoundMixer.computeSpectrum(), SoundMixer.bufferTime, - and SoundTransform() methods.
    • - -
- -

However, in Adobe AIR, content in the application security sandbox (content - installed with the AIR application) are not restricted by these security limitations.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
  bufferTime : Number = 1000
- The number of milliseconds to preload a streaming sound into a buffer - before the sound starts to stream.
-		SoundLoaderContext
  checkPolicyFile : Boolean = false
- Specifies whether the application should try to download a URL policy file from the - loaded sound's server before beginning to load the sound.
-		SoundLoaderContext
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SoundLoaderContext(bufferTime:Number = 1000, checkPolicyFile:Boolean = false)
-
- Creates a new sound loader context object.
-		SoundLoaderContext
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
bufferTimeproperty
-
-public var bufferTime:Number = 1000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The number of milliseconds to preload a streaming sound into a buffer - before the sound starts to stream. -

Note that you cannot override the value of SoundLoaderContext.bufferTime - by setting the global SoundMixer.bufferTime property. - The SoundMixer.bufferTime property affects the buffer time - for embedded streaming sounds in a SWF file and is independent of dynamically created - Sound objects (that is, Sound objects created in ActionScript).

-
- - - - - -
checkPolicyFileproperty 
-
-public var checkPolicyFile:Boolean = false -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies whether the application should try to download a URL policy file from the - loaded sound's server before beginning to load the sound. This property applies to - sound that is loaded from outside - the calling file's own domain using the Sound.load() method. -

This property only applies to SWF content running outside - of the AIR application sandbox.

-

Set this property to true when you load a sound from outside the - calling file's own domain and code in the calling file needs low-level access to - the sound's data. Examples of low-level access to a sound's data - include referencing the Sound.id3 property to get an - ID3Info object or calling the SoundMixer.computeSpectrum() method to get - sound samples from the loaded sound. If you try to access sound data without - setting the checkPolicyFile property to true at loading time, - you may get a SecurityError exception because the required policy file has not been downloaded.

-

If you don't need low-level access to the sound data that you are loading, avoid setting - checkPolicyFile to true. Checking for a policy file consumes - network bandwidth - and might delay the start of your download, so it should only be done when necessary.

-

When you call Sound.load() with SoundLoaderContext.checkPolicyFile set - to true, Flash Player or AIR must - either successfully download a relevant URL policy file or determine that no such policy file - exists before it begins downloading the specified sound. - Flash Player or AIR performs the following - actions, in this order, to verify the existence of a policy file:

-
    - -
  • Flash Player or AIR considers policy files that have already been downloaded.
    • - -
  • Flash Player or AIR tries to download any pending policy files specified in calls to - Security.loadPolicyFile().
    • - -
  • Flash Player or AIR tries to download a - policy file from the default location that corresponds to the sound's URL, which is - /crossdomain.xml on the same server as URLRequest.url. - (The sound's URL is specified in the url property of the URLRequest object - passed to Sound.load() or the Sound() constructor function.)
    • -
-

In all cases, Flash Player or AIR - requires that an appropriate policy file exist on the sound's server, that it provide access - to the sound file at URLRequest.url by virtue of the policy file's location, and - that it allow the domain of the calling file to access the sound, through one or more - <allow-access-from> tags. -

-

If you set checkPolicyFile to true, - Flash Player or AIR waits until the policy file is verified - before loading the sound. You should wait to perform - any low-level operations on the sound data, such as calling Sound.id3 or - SoundMixer.computeSpectrum(), until progress and complete - events are dispatched from the Sound object. -

-

If you set checkPolicyFile to true but no appropriate policy file is found, - you will not receive an error until you perform an operation that requires - a policy file, and then Flash Player or AIR throws a - SecurityError exception. After you receive a complete - event, you can test whether a relevant policy file was found by getting the value - of Sound.id3 within a try block and seeing if a - SecurityError is thrown.

-

Be careful with checkPolicyFile if you are downloading sound from a URL that - uses server-side HTTP redirects. Flash Player or AIR tries to retrieve policy files that - correspond to the url property of the URLRequest object - passed to Sound.load(). If the final - sound file comes from a different URL because of HTTP redirects, then the initially downloaded - policy files might not be applicable to the sound's final URL, which is the URL that matters - in security decisions.

-

If you find yourself in this situation, here is one possible solution. - After you receive a progress or complete event, you can examine the value of - the Sound.url property, which contains the sound's final URL. - Then call the Security.loadPolicyFile() method - with a policy file URL that you calculate based on the sound's final URL. Finally, poll the value - of Sound.id3 until no exception is thrown.

-

This does not apply to content in the AIR application sandbox. - Content in the application sandbox always has programatic access to sound content, regardless - of its origin.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

-See also -

-
-flash.media.Sound.load() -
-flash.media.Sound.id3 -
-flash.media.SoundMixer.computeSpectrum() -
-flash.media.Sound.url -
-flash.system.Security.loadPolicyFile() -
-
- -
Constructor detail
- - - - - -
SoundLoaderContext()constructor
-
-public function SoundLoaderContext(bufferTime:Number = 1000, checkPolicyFile:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new sound loader context object. -

Parameters - - - - - - - - - - -
bufferTime:Number (default = 1000) — The number of seconds to preload a streaming sound into a buffer - before the sound starts to stream. -
 
checkPolicyFile:Boolean (default = false) — Specifies whether the existence of a URL policy file - should be checked upon loading the object (true) or not. -
-
-Example -
In the following example, the buffer for the sound that will be loaded - is set to three seconds. - -

The first parameter of a SoundLoaderContext object (context) is used to increase - the default buffer value of one second to three seconds. (The value is in milliseconds.) - If the second parameter of the SoundLoaderContext object is set to true, - Flash Player will check for a cross-domain policy file upon loading the object. Here it is - set to the default value false, so no policy file will be checked. - The load() method of the sound object will use the context setting to make sure - it will take three seconds to preload the streaming sound into a buffer before the sound starts - to stream. The URLRequest object determines the location of the file, which is a - podcast from Adobe. If an IOErrorEvent.IO_ERROR error occurs during the loading - of the sound file, the errorHandler() method is invoked.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.net.URLRequest;
-    import flash.media.Sound;
-    import flash.media.SoundLoaderContext;
-    import flash.events.IOErrorEvent;
-    
-    public class SoundLoaderContextExample extends Sprite {
-
-        public function SoundLoaderContextExample() {
-            var snd:Sound = new Sound();
-            var req:URLRequest = new URLRequest("http://av.adobe.com/podcast/csbu_dev_podcast_epi_2.mp3");
-            var context:SoundLoaderContext = new SoundLoaderContext(3000, false);
-
-            snd.load(req, context);
-            snd.play();      
- 
-            snd.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-        }
-
-        private function errorHandler(errorEvent:IOErrorEvent):void {
-            trace("The sound could not be loaded: " + errorEvent.text);
-        }
-
-    }
-}
-
-

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/SoundMixer.html b/html-docs/flash/media/SoundMixer.html deleted file mode 100644 index f04c6c3..0000000 --- a/html-docs/flash/media/SoundMixer.html +++ /dev/null @@ -1,828 +0,0 @@ - - - - - - - - -flash.media.SoundMixer (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class SoundMixer
InheritanceSoundMixer Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The SoundMixer class contains static properties and methods for global sound control -in the application. The SoundMixer class controls embedded and streaming sounds in the application, -as well as dynamically created sounds (that is, sounds generated in response -to a Sound object dispatching a sampleData event). - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  audioPlaybackMode : String -
[static] - Specifies the audio playback mode of all Sound objects.
-		SoundMixer
  bufferTime : int -
[static] - The number of seconds to preload an embedded streaming sound into a buffer before it starts - to stream.
-		SoundMixer
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  soundTransform : SoundTransform -
[static] - The SoundTransform object that controls global sound properties.
-		SoundMixer
  useSpeakerphoneForVoice : Boolean -
[static] - Toggles the speakerphone when the device is in voice mode.
-		SoundMixer
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-areSoundsInaccessible():Boolean -
-
[static] - Determines whether any sounds are not accessible due to security restrictions.
-		SoundMixer
   -
-computeSpectrum(outputArray:ByteArray, FFTMode:Boolean = false, stretchFactor:int = 0):void -
-
[static] - Takes a snapshot of the current sound wave and places it into the specified ByteArray object.
-		SoundMixer
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-stopAll():void -
-
[static] - Stops all sounds currently playing.
-		SoundMixer
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
audioPlaybackModeproperty
-
-audioPlaybackMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Specifies the audio playback mode of all Sound objects. On mobile devices, - this property sets sound priorities and defaults according to platform idioms. In - desktop and TV environments, no functional difference exists between audio playback modes. -

Valid values for this property are defined in the AudioPlaybackMode class. -

-

Note On iOS, if one application sets audioPlaybackMode=AudioPlaybackMode.VOICE, - other applications cannot change it to AudioPlaybackMode.MEDIA. -

-

Make the minimum usage of AudioPlaybackMode.VOICE mode, and try to switch to - AudioPlaybackMode.MEDIA mode as soon as you can after the voice call ends - to allow other applications to play in media mode.

-

When you change audio play mode on iOS, mative apps playing music pause briefly. -

-

The default value is AudioPlaybackMode.MEDIA.

-Implementation -
-    public static function get audioPlaybackMode():String -
-    public function set audioPlaybackMode(value:String):void -
-
-Throws -
- - - - -
ArgumentError — kInvalidParameterError -
-

-See also -

-
-flash.media.AudioPlaybackMode -
-flash.media.Sound -
-
- - - - - -
bufferTimeproperty 
-
-bufferTime:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of seconds to preload an embedded streaming sound into a buffer before it starts - to stream. The data in a loaded sound, including its buffer time, - cannot be accessed by a SWF file that is in a different domain - unless you implement a cross-domain policy file. - For more information about security and sound, see the Sound class description. - The data in a loaded sound, including its buffer time, - cannot be accessed by code in a file that is in a different domain - unless you implement a cross-domain policy file. However, in the application sandbox - in an AIR application, code can access data in sound files from any source. - For more information about security and sound, see the Sound class description. -

The SoundMixer.bufferTime property only affects the buffer time - for embedded streaming sounds in a SWF and is independent of dynamically created - Sound objects (that is, Sound objects created in ActionScript). - The value of SoundMixer.bufferTime cannot override - or set the default of the buffer time specified in the SoundLoaderContext object - that is passed to the Sound.load() method.

- Implementation -
-    public static function get bufferTime():int -
-    public function set bufferTime(value:int):void -
-

-See also -

-
-Sound -
-
- - - - - -
soundTransformproperty 
-
-soundTransform:SoundTransform  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The SoundTransform object that controls global sound properties. A SoundTransform object - includes properties for setting volume, panning, left speaker assignment, and right - speaker assignment. The SoundTransform object used in this property provides final sound settings - that are applied to all sounds after any individual sound settings are applied. - -

Implementation -
-    public static function get soundTransform():SoundTransform -
-    public function set soundTransform(value:SoundTransform):void -
-

-See also -

-
-SoundTransform -
-
- - - - - -
useSpeakerphoneForVoiceproperty 
-
-useSpeakerphoneForVoice:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Toggles the speakerphone when the device is in voice mode. By default, smartphones use the phone earpiece for audio - output when SoundMixer.audioPlaybackMode is set to - AudioPlaybackMode.VOICE. The useSpeakerphoneForVoice property lets you override - the default output so that you can implement a speakerphone button in a phone application. This property - has no effect in modes other than AudioPlaybackMode.VOICE. In desktop and TV environments, - this property has no effect. -

Note On iOS, if your application has set audioPlaybackMode=VOICE and another application is also playing in voice mode, - you cannot set useSpeakerphoneForVoice=true. -

-

Note On Android, you must set the android.permission.MODIFY_AUDIO_SETTINGS - in the AIR application descriptor or changing this value has no effect. In addition, the - setting is global device setting. Other applications running on the device can change - the underlying device setting at any time.

-

The default value is false.

-Implementation -
-    public static function get useSpeakerphoneForVoice():Boolean -
-    public function set useSpeakerphoneForVoice(value:Boolean):void -
-

-See also -

-
-flash.media.AudioPlaybackMode -
-
- -
Method detail
- - - - - -
areSoundsInaccessible()method
-
-public static function areSoundsInaccessible():Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Determines whether any sounds are not accessible due to security restrictions. For example, - a sound loaded from a domain other than that of the content calling this method is not accessible if - the server for the sound has no URL policy file that grants access to - the domain of that domain. The sound can still be loaded and played, but low-level - operations, such as getting ID3 metadata for the sound, cannot be performed on - inaccessible sounds. - -

For AIR application content in the application security sandbox, calling this method always - returns false. All sounds, including those loaded from other domains, are accessible - to content in the application security sandbox.

- -

-Returns - - - - -
Boolean — - The string representation of the boolean. - - -
-

-See also -

-
-computeSpectrum() -
-
- - - - - -
computeSpectrum()method 
-
-public static function computeSpectrum(outputArray:ByteArray, FFTMode:Boolean = false, stretchFactor:int = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Takes a snapshot of the current sound wave and places it into the specified ByteArray object. - The values are formatted as normalized floating-point values, in the range -1.0 to 1.0. - The ByteArray object passed to the outputArray parameter is overwritten with the new values. - The size of the ByteArray object created is fixed to 512 floating-point values, where the - first 256 values represent the left channel, and the second 256 values represent - the right channel. -

Note: This method is subject to local file security restrictions and - restrictions on cross-domain loading. If you are working with local files or sounds loaded from a server in a - different domain than the calling content, you might need to address sandbox restrictions - through a cross-domain policy file. For more information, see the Sound class description. - In addition, this method cannot be used to extract data from RTMP streams, even when - it is called by content that reside in the same domain as the RTMP server.

- -

This method is supported over RTMP in Flash Player 9.0.115.0 - and later and in Adobe AIR. You can control access to streams on - Flash Media Server in a server-side script. For more information, see the Client.audioSampleAccess - and Client.videoSampleAccess properties in - Server-Side ActionScript Language Reference for Adobe Flash Media Server.

- - Parameters - - - - - - - - - - - - - - - - -
outputArray:ByteArray — A ByteArray object that holds the values associated with the sound. - If any sounds are not available due to security restrictions - (areSoundsInaccessible == true), the outputArray object - is left unchanged. If all sounds are stopped, the outputArray object is - filled with zeros. - -
 
FFTMode:Boolean (default = false) — A Boolean value indicating whether a Fourier transformation is performed - on the sound data first. Setting this parameter to true causes the method to return a - frequency spectrum instead of the raw sound wave. In the frequency spectrum, low frequencies - are represented on the left and high frequencies are on the right. - -
 
stretchFactor:int (default = 0) — The resolution of the sound samples. - If you set the stretchFactor value to 0, data is sampled at 44.1 KHz; - with a value of 1, data is sampled at 22.05 KHz; with a value of 2, data is sampled 11.025 KHz; - and so on. - -
-

-See also -

-
-areSoundsInaccessible() -
-flash.utils.ByteArray -
-flash.media.Sound -
-flash.media.SoundLoaderContext.checkPolicyFile -
-
-Example -
In the following example, the computeSpectrum() method is - used to produce a graphic representation of the sound wave data. - -

In the constructor, a sound file is loaded and set to play. (There is no error handling - in this example and it is assumed that the sound file is in the same directory as the SWF file.) - The example listens for the Event.ENTER_FRAME event while the sound plays, repeatedly - triggering the onEnterFrame() method to draw a graph of the sound data values. - When the sound finishes playing the onPlaybackComplete() method stops the drawing process - by removing the listener for the Event.ENTER_FRAME event.

- -

In the onEnterFrame() method, the computeSpectrum() method stores the raw - sound in the bytes byte array object. The data is sampled at 44.1 KHz. - The byte array containing 512 bytes of data, each of which contains a floating-point value - between -1 and 1. The first 256 values represent the left channel, and the second 256 values - represent the right channel. The first for loop, reads the first 256 data values (the left stereo channel) - and draws a line from each point to the next using the Graphics.lineTo() method. (The vector - graphic display of the sound wave is written directly on to the class's sprite object.) The sound bytes - are read as 32-bit floating-point number from the byte stream and multiplied by the plot height to allow - for the vertical range of the graph. The width is set to twice the width of the channel length. The - second for loop reads the next set of 256 values (the right stereo channel), and plots the lines in - reverse order. The g.lineTo(CHANNEL_LENGTH 2, PLOT_HEIGHT); and g.lineTo(0, PLOT_HEIGHT); - methods draw the baseline for the waves. The resulting waveform plot produces a mirror-image effect.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.display.Graphics;
-    import flash.events.Event;
-    import flash.media.Sound;
-    import flash.media.SoundChannel;
-    import flash.media.SoundMixer;
-    import flash.net.URLRequest;
-    import flash.utils.ByteArray;
-    import flash.text.TextField;
-
-    public class SoundMixer_computeSpectrumExample extends Sprite {
-
-        public function SoundMixer_computeSpectrumExample() {
-            var snd:Sound = new Sound();
-            var req:URLRequest = new URLRequest("Song1.mp3");
-            snd.load(req);
-            
-            var channel:SoundChannel;
-            channel = snd.play();
-            addEventListener(Event.ENTER_FRAME, onEnterFrame);
-            channel.addEventListener(Event.SOUND_COMPLETE, onPlaybackComplete);
-        }
-
-        private function onEnterFrame(event:Event):void {
-            var bytes:ByteArray = new ByteArray();
-            const PLOT_HEIGHT:int = 200;
-            const CHANNEL_LENGTH:int = 256;
-
-            SoundMixer.computeSpectrum(bytes, false, 0);
-            
-            var g:Graphics = this.graphics;
-            
-            g.clear();
-       
-            g.lineStyle(0, 0x6600CC);
-            g.beginFill(0x6600CC);
-            g.moveTo(0, PLOT_HEIGHT);
-            
-            var n:Number = 0;
-            
-            for (var i:int = 0; i < CHANNEL_LENGTH; i++) {
-                n = (bytes.readFloat() * PLOT_HEIGHT);
-                g.lineTo(i * 2, PLOT_HEIGHT - n);
-            }
-
-            g.lineTo(CHANNEL_LENGTH * 2, PLOT_HEIGHT);
-            g.endFill();
- 
-            g.lineStyle(0, 0xCC0066);
-            g.beginFill(0xCC0066, 0.5);
-            g.moveTo(CHANNEL_LENGTH * 2, PLOT_HEIGHT);
-            
-            for (i = CHANNEL_LENGTH; i > 0; i--) {
-                n = (bytes.readFloat() * PLOT_HEIGHT);
-                g.lineTo(i * 2, PLOT_HEIGHT - n);
-            }
-  
-            g.lineTo(0, PLOT_HEIGHT);
-            g.endFill();
-        }
-        
-        private function onPlaybackComplete(event:Event):void {
-            removeEventListener(Event.ENTER_FRAME, onEnterFrame);
-        }
-    }
-}
-
-

-
- - - - - -
stopAll()method 
-
-public static function stopAll():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Stops all sounds currently playing. - -

>In Flash Professional, this method does not stop the playhead. - Sounds set to stream will resume playing as the playhead moves over the frames in which they - are located.

- -

When using this property, consider the following security model:

- -
    - -
  • By default, calling the SoundMixer.stopAll() method stops - only sounds in the same security sandbox as the object that is calling the method. - Any sounds whose playback was not started from the same sandbox as the calling object - are not stopped.
    • - -
  • When you load the sound, using the load() method of the Sound class, you can - specify a context parameter, which is a SoundLoaderContext object. If you set the - checkPolicyFile property of the SoundLoaderContext object to true, - Flash Player or Adobe AIR - checks for a cross-domain policy file on the server from which the sound is loaded. If the server has a - cross-domain policy file, and the file permits the domain of the calling content, then the file can stop the loaded - sound by using the SoundMixer.stopAll() method; otherwise it cannot.
    • - -
- -

However, in Adobe AIR, content in the application security sandbox (content - installed with the AIR application) are not restricted by these security limitations.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-
-Example -
In the following example, the stopAll() method is used to mute two - sounds that are playing at the same time. - -

In the constructor, two different sound files are loaded and set to play. The first sound is - loaded locally and is assigned to a sound channel. (It is assumed that the file is - in the same directory as the SWF file.) The second file is loaded and streamed from the Adobe - site. In order to use the SoundMixer.stopAll() method, all sound must be accessible. - (A SoundLoaderContext object can be used to check for the cross-domain policy file.) Each sound - also has an event listener that is invoked if an IO error occurred while loading the sound file. - A muteButton text field is also created. It listens for a click event, which - will invoke the muteButtonClickHandler() method.

- -

In the muteButtonClickHandler() method, if the text field content is "MUTE," - the areSoundsInaccessible() method checks if the sound mixer has access to the files. - If the files are accessible, the stopAll() method stops the sounds. By selecting the - text field again, the first sound begins playing and the text field's content changes to - "MUTE" again. This time, the stopAll() method mutes the one sound that is running. - Note that sound channel stop() method can also be used to stop a specific sound - assigned to the channel. (To use the channel functionally, the sound needs to be reassigned - to the channel each time the play() method is invoked.)

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.net.URLRequest;
-    import flash.media.Sound;
-    import flash.media.SoundLoaderContext;
-    import flash.media.SoundChannel;
-    import flash.media.SoundMixer;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.events.MouseEvent;
-    import flash.events.IOErrorEvent;
-
-    public class SoundMixer_stopAllExample extends Sprite  {
-        private var firstSound:Sound = new Sound();
-        private var secondSound:Sound = new Sound();
-        private var muteButton:TextField = new TextField();
-        private var channel1:SoundChannel = new SoundChannel();
-        
-        public function SoundMixer_stopAllExample() {
-            firstSound.load(new URLRequest("mySound.mp3"));
-            secondSound.load(new URLRequest("http://av.adobe.com/podcast/csbu_dev_podcast_epi_2.mp3"));
-
-            firstSound.addEventListener(IOErrorEvent.IO_ERROR, firstSoundErrorHandler);
-            secondSound.addEventListener(IOErrorEvent.IO_ERROR, secondSoundErrorHandler);
-            
-            channel1 = firstSound.play();
-            secondSound.play();
-            
-            muteButton.autoSize = TextFieldAutoSize.LEFT;
-            muteButton.border = true;
-            muteButton.background = true;
-            muteButton.text = "MUTE";
-        
-            muteButton.addEventListener(MouseEvent.CLICK, muteButtonClickHandler);         
-        
-            this.addChild(muteButton);
-        }
-
-        private function muteButtonClickHandler(event:MouseEvent):void {
-
-            if(muteButton.text == "MUTE") {        
-  
-                if(SoundMixer.areSoundsInaccessible() == false) {
-                    SoundMixer.stopAll();
-                    muteButton.text = "click to play only one of sound.";
-                }
-                else {
-                    muteButton.text = "The sounds are not accessible.";
-                }
-            }
-           else {
-                firstSound.play();        
-                muteButton.text = "MUTE";
-           }
-        } 
-
-        private function firstSoundErrorHandler(errorEvent:IOErrorEvent):void {
-            trace(errorEvent.text);
-        }
-
-        private function secondSoundErrorHandler(errorEvent:IOErrorEvent):void {
-            trace(errorEvent.text);
-        }
-    }
-}
-
-

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/SoundTransform.html b/html-docs/flash/media/SoundTransform.html deleted file mode 100644 index baf2a63..0000000 --- a/html-docs/flash/media/SoundTransform.html +++ /dev/null @@ -1,621 +0,0 @@ - - - - - - - - -flash.media.SoundTransform (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class SoundTransform
InheritanceSoundTransform Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The SoundTransform class contains properties for volume and panning. - -

-

-View the examples. -

-

-See also -

-
-flash.display.SimpleButton.soundTransform -
-flash.display.Sprite.soundTransform -
-flash.media.Microphone.soundTransform -
-flash.media.SoundChannel.soundTransform -
-flash.media.SoundMixer.soundTransform -
-flash.net.NetStream.soundTransform -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  leftToLeft : Number -
- A value, from 0 (none) to 1 (all), specifying how much of the left input is played in the - left speaker.
-		SoundTransform
  leftToRight : Number -
- A value, from 0 (none) to 1 (all), specifying how much of the left input is played in the - right speaker.
-		SoundTransform
  pan : Number -
- The left-to-right panning of the sound, ranging from -1 (full pan left) - to 1 (full pan right).
-		SoundTransform
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rightToLeft : Number -
- A value, from 0 (none) to 1 (all), specifying how much of the right input is played in the - left speaker.
-		SoundTransform
  rightToRight : Number -
- A value, from 0 (none) to 1 (all), specifying how much of the right input is played in the - right speaker.
-		SoundTransform
  volume : Number -
- The volume, ranging from 0 (silent) to 1 (full volume).
-		SoundTransform
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SoundTransform(vol:Number = 1, panning:Number = 0)
-
- Creates a SoundTransform object.
-		SoundTransform
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
leftToLeftproperty
-
-leftToLeft:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A value, from 0 (none) to 1 (all), specifying how much of the left input is played in the - left speaker. - -

Implementation -
-    public function get leftToLeft():Number -
-    public function set leftToLeft(value:Number):void -
-
- - - - - -
leftToRightproperty 
-
-leftToRight:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A value, from 0 (none) to 1 (all), specifying how much of the left input is played in the - right speaker. - -

Implementation -
-    public function get leftToRight():Number -
-    public function set leftToRight(value:Number):void -
-
- - - - - -
panproperty 
-
-pan:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The left-to-right panning of the sound, ranging from -1 (full pan left) - to 1 (full pan right). A value of 0 represents no panning (balanced center between - right and left). - -

Implementation -
-    public function get pan():Number -
-    public function set pan(value:Number):void -
-
- - - - - -
rightToLeftproperty 
-
-rightToLeft:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A value, from 0 (none) to 1 (all), specifying how much of the right input is played in the - left speaker. - -

Implementation -
-    public function get rightToLeft():Number -
-    public function set rightToLeft(value:Number):void -
-
- - - - - -
rightToRightproperty 
-
-rightToRight:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A value, from 0 (none) to 1 (all), specifying how much of the right input is played in the - right speaker. - -

Implementation -
-    public function get rightToRight():Number -
-    public function set rightToRight(value:Number):void -
-
- - - - - -
volumeproperty 
-
-volume:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The volume, ranging from 0 (silent) to 1 (full volume). - -

Implementation -
-    public function get volume():Number -
-    public function set volume(value:Number):void -
-
- -
Constructor detail
- - - - - -
SoundTransform()constructor
-
-public function SoundTransform(vol:Number = 1, panning:Number = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a SoundTransform object. - -

Parameters - - - - - - - - - - -
vol:Number (default = 1) — The volume, ranging from 0 (silent) to 1 (full volume). - -
 
panning:Number (default = 0) — The left-to-right panning of the sound, ranging from -1 (full pan left) - to 1 (full pan right). A value of 0 represents no panning (center). - - -
-
-Example -
In the following example, the sound plays only from the - right channel, and the volume is set to 50 percent. - -

In the constructor, the sound is loaded and is assigned to a sound channel - (channel). A SoundTranform object (transform) is also - created. Its first argument sets the volume at 50 percent (the range is 0.0 - to 1.0). Its second argument sets the panning. In this example, panning is set to 1.0, which means - the sound comes from the right speaker only. In order for these settings to - take effect, the transform SoundTranform object is - assigned to the sound channel's souundTransform property.

-

Note: There is - limited error handling written for this example.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.net.URLRequest;
-    import flash.media.Sound;
-    import flash.media.SoundChannel;
-    import flash.media.SoundTransform;
-    import flash.events.IOErrorEvent;
-
-    public class SoundTransform_constructorExample extends Sprite
-    {
-        public function SoundTransform_constructorExample() {
-            var mySound:Sound = new Sound();
-            var url:URLRequest = new URLRequest("mySound.mp3");
-            var channel:SoundChannel;
-            var transform:SoundTransform = new SoundTransform(0.5, 1.0);
-
-            mySound.load(url);    
-            channel = mySound.play();
-            channel.soundTransform = transform;
-
-            mySound.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-        }
-
-        private function errorHandler(errorEvent:IOErrorEvent):void {
-            trace("The sound could not be loaded: " + errorEvent.text);
-        }
-    }
-}
-
-

-
- -
Examples
-
examples\SoundTransformExample
-
The following example loads and plays an MP3 file. As the MP3 file plays, - move the mouse or other user input device; the - volume and panning change as you move the user input device over the Stage. - To run this example, place a file named MySound.mp3 in the same directory as your SWF file. -
-
-package {
-    import flash.display.Sprite;
-    import flash.display.StageAlign;
-    import flash.display.StageScaleMode;
-    import flash.events.*;
-    import flash.media.Sound;
-    import flash.media.SoundChannel;
-    import flash.media.SoundTransform;
-    import flash.net.URLRequest;
-    import flash.utils.Timer;
-
-    public class SoundTransformExample extends Sprite {
-        private var url:String = "MySound.mp3";
-        private var soundFactory:Sound;
-        private var channel:SoundChannel;
-        private var positionTimer:Timer;
-
-        public function SoundTransformExample() {
-            stage.align = StageAlign.TOP_LEFT;
-            stage.scaleMode = StageScaleMode.NO_SCALE;
-
-            var request:URLRequest = new URLRequest(url);
-            soundFactory = new Sound();
-            soundFactory.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            soundFactory.load(request);
-            channel = soundFactory.play();
-            stage.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
-        }
-
-        private function ioErrorHandler(event:Event):void {
-            trace("ioErrorHandler: " + event);
-        }
-
-        private function setPan(pan:Number):void {
-            trace("setPan: " + pan.toFixed(2));
-            var transform:SoundTransform = channel.soundTransform;
-            transform.pan = pan;
-            channel.soundTransform = transform;
-        }
-
-        private function setVolume(volume:Number):void {
-            trace("setVolume: " + volume.toFixed(2));
-            var transform:SoundTransform = channel.soundTransform;
-            transform.volume = volume;
-            channel.soundTransform = transform;
-        }
-
-        private function mouseMoveHandler(event:MouseEvent):void {
-            var halfStage:uint = Math.floor(stage.stageWidth / 2);
-            var xPos:uint = event.stageX;
-            var yPos:uint = event.stageY;
-            var value:Number;
-            var pan:Number;
-
-            if (xPos > halfStage) {
-                value = xPos / halfStage;
-                pan = value - 1;
-            } else if (xPos < halfStage) {
-                value = (xPos - halfStage) / halfStage;
-                pan = value;
-            } else {
-                pan = 0;
-            }
-
-            var volume:Number = 1 - (yPos / stage.stageHeight);
-
-            setVolume(volume);
-            setPan(pan);
-            
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/StageVideo.html b/html-docs/flash/media/StageVideo.html deleted file mode 100644 index bb72a57..0000000 --- a/html-docs/flash/media/StageVideo.html +++ /dev/null @@ -1,940 +0,0 @@ - - - - - - - - -flash.media.StageVideo (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic class StageVideo
InheritanceStageVideo Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

-

- The StageVideo object uses the device's hardware acceleration capabilities, if available, to display - live or recorded video in an application. Hardware acceleration capabilities are available on most devices. - See the flash.net.NetStream class for more information about supported formats. -

AIR profile support: In AIR 3, all AIR for TV devices and some mobile devices support this - feature. AIR 3 for iOS uses the StageVideo object for H.264 video with hardware decoding, with limited supported for NetStream functionality. - AIR 3 for iOS also supports On2 and Sorenson codecs through the StageVideo object. This support does not use hardware decoding, and it does not - limit NetStream functionality. In AIR 2.5, only AIR for TV devices support this feature. Furthermore, ActionScript for this feature - in AIR 2.5 for TV is different than the ActionScript for AIR 3 or Flash Player 10.2. - The differences are noted in the ActionScript descriptions. - See - - AIR Profile Support for more information regarding API support across multiple profiles. - The StageVideo class is not supported in the AIR desktop or extendedDesktop profiles. -

- -

The video displayed by the StageVideo object always appears in a rectangular area on the stage - behind all Flash display list objects. Therefore, the StageVideo object takes advantage of hardware acceleration - while supporting the most common case for displaying video: a rectangular display area overlaid with - video controls.

- -

The benefits to using a StageVideo object instead of the Video object are:

-

  • Improved video display performance because of using hardware acceleration.
    • - -
  • Decreased CPU usage.
    • -
  • Flexibility and creativity for development of content, such as video controls, - that appears in front of the StageVideo object.
    • -

- -

Because the device's hardware displays the video, a StageVideo object is subject to the following constraints - compared to a Video object:

-

  • For each SWF file, Flash Player limits the number of StageVideo objects that can concurrently display - videos to four. However, the actual limit can be lower, depending on device hardware resources. - On AIR for TV devices, only one StageVideo object at a time can display a video.
    • -
  • The video timing is not synchronized with the timing of Flash content that the runtime displays.
    • -
  • The video display area can only be a rectangle. You cannot use more advanced display areas, such as - elliptical or irregular shapes.
    • -
  • You cannot rotate the video.
    • - -
  • You cannot bitmap cache the video or use BitmapData to access it.
    • -
  • You cannot apply filters to the video.
    • -
  • You cannot apply color transforms to the video.
    • -
  • You cannot apply an alpha value to the video.
    • -
  • Blend modes that you apply to display objects that are in front of the video do not apply to the video.
    • -
  • You can place the video only on full pixel boundaries.
    • -
  • Though the rendering is the best available for the given device hardware, it is not 100% "pixel identical" across devices. - Slight variations occur due to driver and platform differences.
    • -
  • A few devices do not support all required color spaces. For example, some devices do not support BT.709, the H.264 standard. In such - cases you can use BT.601 for fast display.
    • -
  • You cannot use stage video with WMODE settings such as normal, opaque, or transparent. - Stage video supports only WMODE=direct when not in full screen mode. WMODE has no effect in Safari 4 or higher, IE 9 or higher, - or in AIR for TV.
    • -
  • When using StageVideo in an AIR for Android application, set the colorDepth to 32bit in the application descriptor. - Using StageVideo with a 16-bit color depth is not supported.
    • - -
  • On Android, StageVideo is only supported on devices running Android 3 (Honeycomb) and higher. To enable your app - to run on the widest possible selection of Android devices, always provide logic to display video - using the Video object when StageVideo is not available.
    • -

-

The following steps summarize how to use a StageVideo object to play a video:

-

  1. Listen for the StageVideoAvailabilityEvent.STAGE_VIDEO_AVAILABILITY event to find out when the - Stage.stageVideos vector has changed. (Not supported for AIR 2.5 for TV.)
    2. -
  2. If the StageVideoAvailabilityEvent.STAGE_VIDEO_AVAILABILITY event reports that stage video is available, - use the Stage.stageVideos Vector object within the event handler to access a StageVideo object. - In AIR 2.5 for TV, access Stage.stageVideos after the first SWF frame has rendered. - Note You cannot create a StageVideo object.
    3. -
  3. Attach a NetStream object using StageVideo.attachNetStream().
    4. -
  4. Play the video using NetStream.play().
    5. -
  5. Listen for the StageVideoEvent.RENDER_STATE event on the StageVideo object to determine the status of playing the video. - Receipt of this event also indicates that the width and height properties of the video have been initialized or changed.
    6. -
  6. Listen for the VideoEvent.RENDER_STATE event on the Video object. This event provides the same statuses as - StageVideoEvent.RENDER_STATE, so you can also use it to determine whether GPU acceleration is available. Receipt of this event - also indicates that the width and height properties of the video have been initialized or changed. (Not supported for AIR 2.5 for TV.)
    7. -

- -

If a StageVideoEvent.RENDER_STATE event indicates that the video cannot be played, - you can revert to using a Video object instead of a StageVideo object. This event is - dispatched after the video has been attached to a NetStream object and is playing. Also, depending on the platform, - any change in the playing status can result in dispatching the event. - Handle the StageVideoEvent.RENDER_STATE event to ensure that the application plays the video - or gracefully does not play the video. -

-

If a running video goes into full screen mode from a WMODE that does not support stage video, stage video can become available. - Likewise, if the user exits full screen mode, stage video can become unavailable. In these cases, the Stage.stageVideos vector changes. - To receive notification of this change, listen to the StageVideoAvailabilityEvent.STAGE_VIDEO_AVAILABITY event. NOTE: This notification - is not available in AIR 2.5 for TV.

-

-

-See also -

-
-flash.events.StageVideoEvent -
-flash.events.StageVideoAvailabilityEvent -
-flash.events.VideoEvent -
-flash.display.Stage.stageVideos -
-flash.media.Video -
-flash.net.NetStream -
-Using the StageVideo class for hardware-accelerated rendering -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  colorSpaces : Vector.<String>
[read-only] - Returns the names of available color spaces for this video surface.
-		StageVideo
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  depth : int -
- The depth level of a StageVideo object relative to other StageVideo objects.
-		StageVideo
  pan : Point -
- The pan setting for displaying the video, specified as a Point object.
-		StageVideo
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  videoHeight : int -
[read-only] - An integer specifying the height of the video stream, in pixels.
-		StageVideo
  videoWidth : int -
[read-only] - An integer specifying the width of the video stream, in pixels.
-		StageVideo
  viewPort : Rectangle -
- The absolute position and size of the video surface in pixels.
-		StageVideo
  zoom : Point -
- The zoom setting of the video, specified as a Point object.
-		StageVideo
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-attachCamera(theCamera:Camera):void -
-
- Specifies a video stream from a camera to be displayed - within the boundaries of the StageVideo object in the application, leveraging the GPU for rendering.
-		StageVideo
   -
-attachNetStream(netStream:NetStream):void -
-
- Specifies a video stream to be displayed within the boundaries of the StageVideo object in the application.
-		StageVideo
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-renderState -
-		 - Dispatched by the StageVideo object when the render state of the StageVideo object changes.StageVideo
-
- -
- -
Property detail
- - - - - -
colorSpacesproperty
-
-colorSpaces:Vector.<String>  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Returns the names of available color spaces for this video surface. - Usually this list includes "BT.601" and "BT.709". On some configurations, only - "BT.601" is supported which means a video is possibly not rendered in the - correct color space. -

Note: On AIR for TV devices, a value of "BT.601" indicates software playback, - and a value of "BT.709" indicates hardware playback.

- Implementation -
-    public function get colorSpaces():Vector.<String> -
-
- - - - - -
depthproperty 
-
-depth:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The depth level of a StageVideo object relative to other StageVideo objects. -

StageVideo objects always display behind other objects on the stage. If a platform supports more than one - StageVideo object, the depth property indicates a StageVideo object's depth level. - The bottom StageVideo object's depth property has the smallest value. - If multiple StageVideo objects have the same depth setting, the order they appear in the - stage,stageVideos Vector determines their relative depth.

-

Note: AIR for TV devices support only one StageVideo object. Therefore, this property is not - applicable for those devices.

- Implementation -
-    public function get depth():int -
-    public function set depth(value:int):void -
-

-See also -

-
-flash.display.Stage.stageVideos -
-
- - - - - -
panproperty 
-
-pan:Point  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The pan setting for displaying the video, specified as a Point object. - -

By default, the value of pan is (0,0). - This default value centers the video in the rectangle specified by StageVideo.viewPort.

-

The pan value is significant only when the zoom property value is not the - default value (1.0, 1.0). When a video displays in the StageVideo.viewPort rectangle - with the default zoom value, the platform sizes the video to fit exactly into the rectangle. Therefore, the entire - video is visible. However, if a zoom factor is specified, the entire video is not visible. In this case, you can - set the pan value to specify which subrectangle of the video to show - in the StageVideo.viewPort rectangle.

-

The valid values of the pan property range from (-1.0, -1.0) to (1.0, 1.0). - Specifically:

-

    -
  • - A pan value of (-1.0, -1.0) places the upper-left pixel of the video at the upper-left - position of the StageVideo.viewPort rectangle. -
    • -
  • - A pan value of (1.0, 1.0) places the lower-right pixel of the video at the lower-right - position of the StageVideo.viewPort rectangle. -
    • -
  • - A pan value of (1.0, -1.0) places the upper-right pixel of the video at the upper-right - position of the StageVideo.viewPort rectangle. -
    • -
  • - A pan value of (-1.0, 1.0) places the lower-left pixel of the video at the lower-left - position of the StageVideo.viewPort rectangle. -
    • -
-

-

Values between -1.0 and 1.0 pan according to scale.

-

If you set the pan property to a value outside the valid range, - a RangeError exception is thrown. - The runtime resets the value to the last valid value.

-

Also, consider that to use a StageVideo object, you assign an element - of the Stage.stageVideos Vector object to a StageVideo variable. When you set - the pan property of the StageVideo variable, the underlying Stage.stageVideos Vector - element also changes. If you later assign that element to another StageVideo variable to play - another video, reset the pan property.

- - Implementation -
-    public function get pan():Point -
-    public function set pan(value:Point):void -
-
-Throws -
- - - - -
RangeError — The Point value is not valid. -
-

-See also -

-
-zoom -
-
- - - - - -
videoHeightproperty 
-
-videoHeight:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- An integer specifying the height of the video stream, in pixels. -

You may want to use this property, for example, to ensure that the user is seeing the - video at the same height at which it was captured, - regardless of the size of the StageVideo.viewPort rectangle.

-

The NetStream.Video.DimensionChange event is dispatched in the case of recorded videos - when this value changes.

- Implementation -
-    public function get videoHeight():int -
-
- - - - - -
videoWidthproperty 
-
-videoWidth:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- An integer specifying the width of the video stream, in pixels. -

You may want to use this property, for example, to ensure that the user is seeing the - video at the same width at which it was captured, - regardless of the size of the StageVideo.viewPort rectangle.

-

The NetStream.Video.DimensionChange event is dispatched in the case of recorded videos - when this value changes.

- Implementation -
-    public function get videoWidth():int -
-
- - - - - -
viewPortproperty 
-
-viewPort:Rectangle  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The absolute position and size of the video surface in pixels. - -

The position of the video is relative to the upper left corner of the stage.

-

- The valid range of the x and y properties of the viewPort - Rectangle object are -8192 to 8191. Therefore, you can position the video - completely or partially off the stage. You can also make the video larger than the stage if you - make the width and height properties of the viewPort - property larger than the stage.

- - Implementation -
-    public function get viewPort():Rectangle -
-    public function set viewPort(value:Rectangle):void -
-
-Throws -
- - - - -
RangeError — The Rectangle value is not valid. -
-
- - - - - -
zoomproperty 
-
-zoom:Point  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The zoom setting of the video, specified as a Point object. - -

The zoom point is a scale factor. By default, the value of zoom is (1.0, 1.0). - This default value displays the entire video in the StageVideo.viewPort rectangle.

-

The valid values of the zoom property range from (1.0, 1.0) to (8.0, 8.0). - The x property of the zoom Point object specifies the zoom value for the horizontal pixels, and - the y property specifies the zoom value for the vertical pixels.

-

For example, a zoom value of (2.0, 2.0) displays only half the horizontal pixels - and half the vertical pixels in the StageVideo.viewPort rectangle. That is, the video still fills the - StageVideo.viewPort rectangle, but only half the video is visible, creating a 2x zoom effect. - Similarly, a zoom value of (8.0, 8.0) displays only 1/8 of the horizontal pixels - and 1/8 of the vertical pixels in the StageVideo.viewPort rectangle, - zooming in the maximum amount of 8x.

-

When you set the zoom property, set the pan property so that the StageVideo.viewPort rectangle - shows the appropriate subrectangle of the video.

-

Consider the following situation where it is useful to set a different value for the - x and y properties of the zoom Point object. - First, note that when a video displays in the StageVideo.viewPort rectangle - with the default zoom value, the platform sizes the video to fit exactly into the rectangle. - If the video's rectangle does not scale evenly to the StageVideo.viewPort rectangle, - the video display can be distorted. - That is, the aspect ratios of the video and the StageVideo.viewPort are not equal. - This case can occur, for example, if the video has a different width than height, but the StageVideo.viewPort - property specifies a square. - To resolve the distortion, set different values for the - x and y properties of the zoom Point object. - Then set the pan property to make sure the StageVideo.viewPort rectangle - shows the appropriate subrectangle of the video.

-

If you set the zoom property to a value outside the valid range, - a RangeError exception is thrown. - The runtime resets the value to the last valid value.

-

Also, consider that to use a StageVideo object, you assign an element - of the Stage.stageVideos Vector object to a StageVideo variable. When you set - the zoom property of the StageVideo variable, the underlying Stage.stageVideos Vector - element also changes. If you later assign that element to another StageVideo variable to play - another video, reset the zoom property.

- - Implementation -
-    public function get zoom():Point -
-    public function set zoom(value:Point):void -
-
-Throws -
- - - - -
RangeError — The Point value is not valid. -
-

-See also -

-
-pan -
-
- -
Method detail
- - - - - -
attachCamera()method
-
-public function attachCamera(theCamera:Camera):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Specifies a video stream from a camera to be displayed - within the boundaries of the StageVideo object in the application, leveraging the GPU for rendering. - -

Note: StageVideo for camera is not supported on Android.

- -

Use this method to attach live video captured by the user - to the StageVideo object. To drop the connection to the StageVideo object, pass null.

- Parameters - - - - -
theCamera:Camera — A Camera object that is capturing video data. - -
-

-See also -

-
-flash.media.Video.attachCamera() -
-flash.media.Camera -
-
- - - - - -
attachNetStream()method 
-
-public function attachNetStream(netStream:NetStream):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- Specifies a video stream to be displayed within the boundaries of the StageVideo object in the application. - The video stream is either a video file played with NetStream.play(), or null. - A video file can be stored on the local file - system or on Flash Media Server. If the value of the netStream argument is null, - the video is no longer played in the StageVideo object. - -

Before calling attachNetStream() a second time, - call the currently attached NetStream object's close() method. - Calling close() - releases all the resources, including hardware decoders, involved with playing the video. - Then you can call attachNetStream() - with either another NetStream object or null.

-

- You do not need to use this method if a video file contains only audio; the audio - portion of a video file is played automatically - when you call NetStream.play(). To control the audio - associated with a video file, use the soundTransform property - of the NetStream object that plays the video file. -

- Parameters - - - - -
netStream:NetStream — A NetStream object. To drop the connection to the StageVideo object, pass - null. -
-
-
Event detail
- - - - - -
renderStateevent 
-
-Event object type: flash.events.StageVideoEvent -
-StageVideoEvent.type property = flash.events.StageVideoEvent.RENDER_STATE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 -
-

- Dispatched by the StageVideo object when the render state of the StageVideo object changes. -

- The StageVideoEvent.RENDER_STATE constant defines the value of the type property of a renderState event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
colorSpaceThe available color spaces for displaying the video.
currentTargetThe object that is actively processing the StageVideoEvent - object with an event listener.
statusIndicates whether the video is being rendered (decoded and displayed) by hardware or software, or not at all.
targetThe StageVideo object that changed state.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/StageVideoAvailability.html b/html-docs/flash/media/StageVideoAvailability.html deleted file mode 100644 index e8a3f94..0000000 --- a/html-docs/flash/media/StageVideoAvailability.html +++ /dev/null @@ -1,276 +0,0 @@ - - - - - - - - -flash.media.StageVideoAvailability (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class StageVideoAvailability
InheritanceStageVideoAvailability Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

-

- This class defines an enumeration that indicates whether stage video is currently available. -

-

-See also -

-
-flash.events.StageVideoAvailabilityEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  AVAILABLE : String = "available"
[static] - Stage video is currently available.
-		StageVideoAvailability
  UNAVAILABLE : String = "unavailable"
[static] - Stage video is not currently available.
-		StageVideoAvailability
-
- -
- -
Constant detail
- - - - - -
AVAILABLEconstant
-
-public static const AVAILABLE:String = "available" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

- Stage video is currently available. -

- - - - - -
UNAVAILABLEconstant 
-
-public static const UNAVAILABLE:String = "unavailable" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

- Stage video is not currently available. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/StageVideoAvailabilityReason.html b/html-docs/flash/media/StageVideoAvailabilityReason.html deleted file mode 100644 index c87ede2..0000000 --- a/html-docs/flash/media/StageVideoAvailabilityReason.html +++ /dev/null @@ -1,364 +0,0 @@ - - - - - - - - -flash.media.StageVideoAvailabilityReason (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class StageVideoAvailabilityReason
InheritanceStageVideoAvailabilityReason Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

-

- This class defines an enumeration that indicates whether stage video is currently available. -

-

-See also -

-
-flash.events.StageVideoAvailabilityEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  DRIVER_TOO_OLD : String = "driverTooOld"
[static] - Stage video is not currently available, the driver is too old or black listed -
-		StageVideoAvailabilityReason
  NO_ERROR : String = "noError"
[static] - Stage video is currently available, no errors occurred -
-		StageVideoAvailabilityReason
  UNAVAILABLE : String = "unavailable"
[static] - Stage video is not currently available, no hardware was available -
-		StageVideoAvailabilityReason
  USER_DISABLED : String = "userDisabled"
[static] - Stage video is not currently available, the user disabled HW acceleration -
-		StageVideoAvailabilityReason
  WMODE_INCOMPATIBLE : String = "wModeIncompatible"
[static] - Stage video is not currently available, the wmode doesn't support Stage video.
-		StageVideoAvailabilityReason
-
- -
- -
Constant detail
- - - - - -
DRIVER_TOO_OLDconstant
-
-public static const DRIVER_TOO_OLD:String = "driverTooOld" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

- Stage video is not currently available, the driver is too old or black listed -

- - - - - -
NO_ERRORconstant 
-
-public static const NO_ERROR:String = "noError" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

- Stage video is currently available, no errors occurred -

- - - - - -
UNAVAILABLEconstant 
-
-public static const UNAVAILABLE:String = "unavailable" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

- Stage video is not currently available, no hardware was available -

- - - - - -
USER_DISABLEDconstant 
-
-public static const USER_DISABLED:String = "userDisabled" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

- Stage video is not currently available, the user disabled HW acceleration -

- - - - - -
WMODE_INCOMPATIBLEconstant 
-
-public static const WMODE_INCOMPATIBLE:String = "wModeIncompatible" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

- Stage video is not currently available, the wmode doesn't support Stage video. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/StageWebView.html b/html-docs/flash/media/StageWebView.html deleted file mode 100644 index c116231..0000000 --- a/html-docs/flash/media/StageWebView.html +++ /dev/null @@ -1,1607 +0,0 @@ - - - - - - - - -flash.media.StageWebView (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class StageWebView
InheritanceStageWebView Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

-

- The StageWebView class displays HTML content in a stage view port. - -

The StageWebView class provides a simple means to display HTML content on - devices where the HTMLLoader class is not supported. The class provides no - interaction between ActionScript and the HTML content except through - the methods and properties of the StageWebView class itself. There is, for example, - no way to pass values or call functions between ActionScript and JavaScript.

- -

AIR profile support: This feature is supported - on all desktop operating systems and mobile devices, but is not supported on AIR for TV devices. You can test - for support at run time using the StageWebView.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

-

On devices in the mobile and extended mobile profiles, the StageWebView class uses - the system web control provided by the device operating system. Thus, the available - features and rendering appearance may vary from device to device.

-

On android, inline HTML5 video is supported only if <application android:hardwareAccelerated="true"/> - is included in the application descriptor.

-

On desktop computers (in the desktop and extended desktop profiles), the StageWebView class - uses the system web control provided by the Flash Player plugin. The features available and - rendering appearance are the same as those of the HTMLLoader class (without the close integration - and script bridging between ActionScript and JavaScript provided by an HTMLLoader instance). - Since the HTMLLoader class uses the internal AIR WebKit engine, concurrent use of StageWebView and - HTMLLoader instances is strongly discouraged as it has undefined behavior and can possibly terminate - the application.

- -

The StageWebView class is NOT a display object and cannot be added to the Flash display list. - Instead you display a StageWebView object by attaching it directly to a stage using the - stage property. The StageWebView instance attached to a stage is displayed on top - of any Flash display objects. You control the size and position of the rendering area with the - viewPort property. There is no way to control the depth ordering of different - StageWebView objects. Overlapping two instances is not recommended.

- -

When the content within the StageWebView object has focus, the StageWebView object has the first - opportunity to handle keyboard input. The stage to which the StageWebView object is attached - dispatches any keyboard input that is not handled. The normal event capture/bubble cycle does not - apply here since the StageWebView instance is not part of the display list.

-

In Android 3.0+, an application must enable hardware acceleration in the Android manifestAdditions - element of the AIR application descriptor to display plug-in content in a StageWebView object.

- -

-

-View the examples. -

-

-See also -

-
-Enabling Flash Player and other plug-ins in a StageWebView object -
-HTMLLoader class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isHistoryBackEnabled : Boolean -
[read-only] - Reports whether there is a previous page in the browsing history.
-		StageWebView
  isHistoryForwardEnabled : Boolean -
[read-only] - Reports whether there is a next page in the browsing history.
-		StageWebView
  isSupported : Boolean -
[static][read-only] - Reports whether the StageWebView class is supported on the current device.
-		StageWebView
  location : String -
[read-only] - The URL of the current location.
-		StageWebView
  mediaPlaybackRequiresUserAction : Boolean -
- Set whether User is required to perform gesture to play media content.
-		StageWebView
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  stage : Stage -
- The stage on which this StageWebView object is displayed.
-		StageWebView
  title : String -
[read-only] - The HTML title value.
-		StageWebView
  viewPort : Rectangle -
- The area on the stage in which the StageWebView object is displayed.
-		StageWebView
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StageWebView(... configuration)
-
- Creates a StageWebView object.
-		StageWebView
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-assignFocus(direction:String = "none"):void -
-
- Assigns focus to the content within this StageWebView object.
-		StageWebView
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-dispose():void -
-
- Disposes of this StageWebView object.
-		StageWebView
   -
-drawViewPortAsync(target:Object):void -
-
- Draws the StageWebView's view port to a bitmap or image.
-		StageWebView
   -
-drawViewPortToBitmapData(bitmap:BitmapData):void -
-
- Draws the StageWebView's view port to a bitmap.
-		StageWebView
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-historyBack():void -
-
- Navigates to the previous page in the browsing history.
-		StageWebView
   -
-historyForward():void -
-
- Navigates to the next page in the browsing history.
-		StageWebView
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-loadString(text:String, mimeType:String = "text/html"):void -
-
- Loads and displays the specified HTML string.
-		StageWebView
   -
-loadURL(url:String):void -
-
- Loads the page at the specified URL.
-		StageWebView
   -
-postMessage(message:String):void -
-
- Posts a message to the HTML content within the StageWebView host.
-		StageWebView
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-reload():void -
-
- Reloads the current page.
-		StageWebView
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-stop():void -
-
- Halts the current load operation.
-		StageWebView
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-complete -
-		 - Signals that the last load operation requested by loadString() or - loadURL() method has completed.StageWebView
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-error -
-		 - Signals that an error has occurred.StageWebView
   -
-focusIn -
-		 - Dispatched when this StageWebView object receives focus.StageWebView
   -
-focusOut -
-		 - Dispatched when the StageWebView relinquishes focus.StageWebView
   -
-locationChange -
-		 - Signals that the location property of the StageWebView object has changed.StageWebView
   -
-locationChanging -
-		 - Signals that the location property of the StageWebView object is about to change.StageWebView
   -
-webViewDrawComplete -
-		 - Dispatched when the StageWebView rendering to a target has completed.StageWebView
   -
-webViewMessage -
-		 - Dispatched when the HTML contents within the StageWebView posts a message out - to the client application.StageWebView
-
- -
- -
Property detail
- - - - - -
isHistoryBackEnabledproperty
-
-isHistoryBackEnabled:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Reports whether there is a previous page in the browsing history. - -

Implementation -
-    public function get isHistoryBackEnabled():Boolean -
-
- - - - - -
isHistoryForwardEnabledproperty 
-
-isHistoryForwardEnabled:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Reports whether there is a next page in the browsing history. - -

Implementation -
-    public function get isHistoryForwardEnabled():Boolean -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Reports whether the StageWebView class is supported on the current device. - -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
locationproperty 
-
-location:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The URL of the current location. - -

Implementation -
-    public function get location():String -
-
- - - - - -
mediaPlaybackRequiresUserActionproperty 
-
-mediaPlaybackRequiresUserAction:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Set whether User is required to perform gesture to play media content. - For iOS, this property will not be honored, and media autoPlay can only be achieved through the constructor StageWebView(). - Default value is True. -

Implementation -
-    public function get mediaPlaybackRequiresUserAction():Boolean -
-    public function set mediaPlaybackRequiresUserAction(value:Boolean):void -
-
- - - - - -
stageproperty 
-
-stage:Stage  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The stage on which this StageWebView object is displayed. - -

Set stage to null to hide this StageWebView object.

- - Implementation -
-    public function get stage():Stage -
-    public function set stage(value:Stage):void -
-
- - - - - -
titleproperty 
-
-title:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The HTML title value. - -

Implementation -
-    public function get title():String -
-
- - - - - -
viewPortproperty 
-
-viewPort:Rectangle  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- The area on the stage in which the StageWebView object is displayed. - -

Implementation -
-    public function get viewPort():Rectangle -
-    public function set viewPort(value:Rectangle):void -
-
-Throws -
- - - - -
RangeError — The Rectangle value is not valid. -
-
- -
Constructor detail
- - - - - -
StageWebView()constructor
-
-public function StageWebView(... configuration) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Creates a StageWebView object. - -

The object is invisible until it is attached to a stage and until the viewPort - is set.

- -

Note: The StageWebView is always now provided by an operating system component, - AIR does not ship with an embedded WebKit build now. The earlier useNative argument is ignored.

-

The arguments for this constructor have changed in AIR 51.0, previously there had been two optional boolean - arguments (useNative defaulting to false, and mediaPlaybackRequiresUserAction defaulting to - true). These have been replaced with the ...rest argument which means the constructor can take any number - of arguments. If there are zero arguments, or one or two boolean arguments, then these would be treated in the same - way as previously i.e. as if these are the earlier useNative and mediaPlaybackRequiresUserAction - with their default values). However, if a single Object is passed in, it will be treated like a configuration - object, and its properties will be enumerated and evaluated appropriately based on the support available within the - AIR runtime.

-

For example, the StageWebView object could be created with:

-

var swv : StageWebView = new StageWebView( { userAgent:"my-app-ua-string", mediaPlaybackRequiresUserAction:false } );

-

Note that some options may be platform-specific and could depend upon the available components from the operating system.

- Parameters - - - - -
... configuration
-
- -
Method detail
- - - - - -
assignFocus()method
-
-public function assignFocus(direction:String = "none"):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Assigns focus to the content within this StageWebView object. - -

Direction values are defined in FocusDirection class and include: - "bottom", "none", and "top".

- - Parameters - - - - -
direction:String (default = "none") — specifies whether the first or last focusable object - in the displayed content should receive focus. - -
-

-See also -

-
-FocusDirection -
-
- - - - - -
dispose()method 
-
-public function dispose():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Disposes of this StageWebView object. - -

Calling dispose() is optional. If you do not maintain a reference to this - StageWebView instance it will be eligible for garbage collection. Calling dispose() - can make garbage collection occur sooner, or at a more convenient time.

- -
- - - - - -
drawViewPortAsync()method 
-
-public function drawViewPortAsync(target:Object):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Draws the StageWebView's view port to a bitmap or image. -

This is an asynchronous form of the drawViewPortToBitmapData method, which is requred for the new Edge-based StageWebView. - Using this you can pass in either a BitmapData object in order to draw the web contents into a bitmap, or a PNGEncoderOptions or JPEGEncoderOptions object - in order to draw the web contents into a new ByteArray object.

-

When the functionality is complete, the StageWebView object will dispatch a WebViewDrawEvent object that contains the requested image data.

- Parameters - - - - -
target:Object — The BitmapData object on which to draw the visible portion of the StageWebView's view port, or one of the PNG/JPEG EncorderOptions objects to specify a ByteArray should be created for the image. -
-
-Throws - - - - -
ArgumentError — The bitmap's width or height is different from view port's width or height, or the provided object is not one of BitmapData/PNGEncoderOptions/JPEGEncoderOptions. -
-
- - - - - -
drawViewPortToBitmapData()method 
-
-public function drawViewPortToBitmapData(bitmap:BitmapData):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- Draws the StageWebView's view port to a bitmap. -

Capture the bitmap and set the stage to null for displaying the content above the StageWebView object.

-

Note: The behavior of this method is not guaranteed for pages that contain plugin content (such as embedded PDF and SWF files).

- - Parameters - - - - -
bitmap:BitmapData — The BitmapData object on which to draw the visible portion of the StageWebView's view port. -
-
-Throws - - - - - - - - - - -
ArgumentError — The bitmap's width or height is different from view port's width or height. -
 
Error — The bitmap is null. -
-
-Example -
The following example displays two labels: google and facebook. - Clicking on the label captures the corresponding web page and displays it as a snapshot on the stage. -
-
-
-package
-{
-    import flash.display.Bitmap;
-	import flash.display.BitmapData;
-	import flash.display.Sprite;
-	import flash.events.*;
-	import flash.geom.Rectangle;
-	import flash.media.StageWebView;
-	import flash.net.*;
-	import flash.text.TextField;
-	
-	public class stagewebview1 extends Sprite
-	{	
-		public var webView:StageWebView = new StageWebView();
-		public var textGoogle:TextField=new TextField();
-		public var textFacebook:TextField=new TextField();
-	
-		public function stagewebview()
-		
-		{
-			textGoogle.htmlText="<b>Google</b>";
-			textGoogle.x=300;
-			textGoogle.y=-80;		
-			addChild(textGoogle);
-			textFacebook.htmlText="<b>Facebook</b>";
-			textFacebook.x=0;
-			textFacebook.y=-80;		
-			addChild(textFacebook);
-			textGoogle.addEventListener(MouseEvent.CLICK,goGoogle);
-			textFacebook.addEventListener(MouseEvent.CLICK,goFaceBook);
-			webView.stage = this.stage;
-			webView.viewPort = new Rectangle(0, 0, stage.stageWidth, stage.stageHeight);
-
-		}	
-	
-		public function goGoogle(e:Event):void
-		
-		{
-			webView.loadURL("http://www.google.com");
-			webView.stage = null;
-			webView.addEventListener(Event.COMPLETE,handleLoad);
-		}
-	
-		public function goFaceBook(e:Event):void
-		{
-			webView.loadURL("http://www.facebook.com");
-			webView.stage = null;
-			webView.addEventListener(Event.COMPLETE,handleLoad);
-		}
-	
-		public function handleLoad(e:Event):void
-		{
-			var bitmapData:BitmapData = new BitmapData(webView.viewPort.width, webView.viewPort.height);
-			webView.drawViewPortToBitmapData(bitmapData);
-			var webViewBitmap:Bitmap=new Bitmap(bitmapData);
-			addChild(webViewBitmap);
-		}
-	}
-}
-
-

-
- - - - - -
historyBack()method 
-
-public function historyBack():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Navigates to the previous page in the browsing history. - -

- - - - - -
historyForward()method 
-
-public function historyForward():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Navigates to the next page in the browsing history. - -

- - - - - -
loadString()method 
-
-public function loadString(text:String, mimeType:String = "text/html"):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Loads and displays the specified HTML string. - -

When the loadString() method is used, the location - is reported as "about:blank." Only standard URI schemes can be used in URLs within - the HTML string. The AIR URI schemes, "app:" and "app-storage:" are not allowed.

- -

The HTML content cannot load local resources, such as image files. XMLHttpRequests - are not allowed.

- -

Only the "text/html" and "application/xhtml+xml" MIME types are supported.

- - Parameters - - - - - - - - - - -
text:String — the string of HTML or XHTML content to display. -
 
mimeType:String (default = "text/html") — The MIME type of the content, either "text/html" or "application/xhtml+xml". - -
-
-Example -
The following example sets up a StageWebView object to fill the stage. The example - loads an HTML page with the loadString() method. -
-
-
-var webView:StageWebView = new StageWebView();
-webView.stage = this.stage;
-webView.viewPort = new Rectangle( 0, 0, stage.stageWidth, stage.stageHeight );
-
-var htmlString:String = "<!DOCTYPE HTML>" +
-    					"<html>" +
-							"<body>" +
-								"<h1>Example</h1>" +
-								"<p>King Phillip cut open five green snakes.</p>" +
-							"</body>" +
-						"</html>";
-
-webView.loadString( htmlString, "text/html" );
-
-

-
- - - - - -
loadURL()method 
-
-public function loadURL(url:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Loads the page at the specified URL. - -

The URL can use the following URI schemes: http:, https:, file:, data:, and javascript:. - Content loaded with the file: scheme can load other local resources.

- - Parameters - - - - -
url:String
-
-Example -
The following example sets up a StageWebView object to fill the stage. The example - loads a web site with the loadURL() method. - -

Note: On Android, you must specify the INTERNET permission in your AIR application - descriptor to load remote URLs.

-
-
-
-var webView:StageWebView = new StageWebView();
-webView.stage = this.stage;
-webView.viewPort = new Rectangle( 0, 0, stage.stageWidth, stage.stageHeight );
-
-webView.loadURL( "http://www.example.com" );
-
-

-
- - - - - -
postMessage()method 
-
-public function postMessage(message:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51.0 -
-

- Posts a message to the HTML content within the StageWebView host. The message is provided as a string but may be stringified JSON. - This is asynchronous, the message will be posted to the container but if a response is required, it would need to be seperately posted - back by the JavaScript code, and can be obtained by listening for the webViewMessage event. -

Parameters - - - - -
message:String
-
- - - - - -
reload()method 
-
-public function reload():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Reloads the current page. - -

- - - - - -
stop()method 
-
-public function stop():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Halts the current load operation. - -

-
Event detail
- - - - - -
completeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Signals that the last load operation requested by loadString() or - loadURL() method has completed. -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
- - - - - -
errorevent  
-
-Event object type: flash.events.ErrorEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Signals that an error has occurred. - -

- - - - - -
focusInevent  
-
-Event object type: flash.events.FocusEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Dispatched when this StageWebView object receives focus. - -

- - - - - -
focusOutevent  
-
-Event object type: flash.events.FocusEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Dispatched when the StageWebView relinquishes focus. - -

- - - - - -
locationChangeevent  
-
-Event object type: flash.events.LocationChangeEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Signals that the location property of the StageWebView object has changed. -

The event cannot be canceled.

- -
- - - - - -
locationChangingevent  
-
-Event object type: flash.events.LocationChangeEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Signals that the location property of the StageWebView object is about to change. -

A locationChanging event is only dispatched when the location change is initiated through - HTML content or code running inside the StageWebView object,such as when a user clicks a link. - By default, the new location is displayed in this - StageWebView object. You can call the preventDefault() method of the event - object to cancel the default behavior. For example, you could use the flash.net.navigateToURL() - function to open the page in the system browser based on the location - property of the event object

- -

A locationChanging event is not dispatched when you change the location with the following methods:

-
    -
  • historyBack()
    • -
  • historyForward()
    • -
  • loadString()
    • -
  • loadURL()
    • -
  • reload()
    • -
- -
- - - - - -
webViewDrawCompleteevent  
-
-Event object type: flash.events.WebViewDrawEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Dispatched when the StageWebView rendering to a target has completed. -

- - - - - -
webViewMessageevent  
-
-Event object type: flash.events.DataEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51.0 -
-

- Dispatched when the HTML contents within the StageWebView posts a message out - to the client application. -

- -
Examples
-
examples\StageWebViewExample.1
-
The following example sets up a StageWebView object to fill the stage. The example - loads a web site with the loadURL() method and uses the device Back and Search - softkeys for history navigation. -
-
-package  {
-    import flash.display.MovieClip;
-	import flash.media.StageWebView;
-	import flash.geom.Rectangle;
-	import flash.events.KeyboardEvent;
-	import flash.ui.Keyboard;
-	import flash.desktop.NativeApplication;
-                
-	public class StageWebViewExample extends MovieClip{
-
-		private var webView:StageWebView = new StageWebView();
-                                
-		public function StageWebViewExample() 
-		{
-			webView.stage = this.stage;
-			webView.viewPort = new Rectangle( 0, 0, stage.stageWidth, stage.stageHeight );
-			webView.loadURL( "http://www.example.com" );
-                                                
-			stage.addEventListener( KeyboardEvent.KEY_DOWN, onKey );
-		}
-                                
-		private function onKey( event:KeyboardEvent ):void
-		{
-			if( event.keyCode == Keyboard.BACK && webView.isHistoryBackEnabled )
-			{
-				trace("Back.");
-				webView.historyBack();
-				event.preventDefault();
-			}
-
-			if( event.keyCode == Keyboard.SEARCH && webView.isHistoryForwardEnabled )
-			{
-				trace("Forward.");
-				webView.historyForward();
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/Video.html b/html-docs/flash/media/Video.html deleted file mode 100644 index 13aabe7..0000000 --- a/html-docs/flash/media/Video.html +++ /dev/null @@ -1,1241 +0,0 @@ - - - - - - - - -flash.media.Video (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic class Video
InheritanceVideo Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- - The Video class displays live or recorded video in an application - without embedding the video in your SWF file. - This class creates a Video object that plays - either of the following kinds of video: recorded video files stored on a server or locally, - or live video captured by the user. - A Video object is a display object on the application's display list and represents - the visual space in which the video runs in a user interface. - -

- When used with Flash Media Server, the Video object allows you to - send live video captured by a user to the server and then - broadcast it from the server to other users. - Using these features, you can develop media applications such as - a simple video player, a video player with multipoint publishing from - one server to another, or a video sharing application for a user community. -

-

- Flash Player 9 and later supports publishing and playback of FLV files encoded - with either the Sorenson Spark or On2 VP6 codec and also supports an alpha channel. The On2 - VP6 video codec uses less bandwidth than older technologies and offers additional deblocking - and deringing filters. See the flash.net.NetStream class for more information about video playback and supported - formats.

- -

- Flash Player 9.0.115.0 and later supports mipmapping to optimize runtime rendering quality and performance. - For video playback, Flash Player uses mipmapping optimization if you set the Video object's smoothing - property to true. -

-

- Beginning with AIR 25, a new tag has been introduced for Android in app.xml named disableMediaCodec. - Setting this tag as true disables mediacodec and the video is decoded using OpenMax AL. Otherwise, mediacodec is enabled. - The value of this tag is false, by default. -

-

- As with other display objects on the display list, - you can control various properties of Video objects. For example, - you can move the Video object around on the Stage by using its x and - y properties, you can change its size using its height - and width properties, and so on. -

-

- To play a video stream, use attachCamera() or attachNetStream() - to attach the video to the Video object. Then, add the Video object - to the display list using addChild(). -

- -

- If you are using Flash Professional, you can also place the Video object on the Stage - rather than adding it with addChild(), like this: -

-
    -
  1. If the Library panel isn't visible, select Window > Library to display it.
    2. -
  2. Add an embedded Video object to the library by clicking the Options menu on - the right side of the Library panel title bar and selecting New Video.
    3. -
  3. In the Video Properties dialog box, name the embedded Video object for use in the library - and click OK.
    4. -
  4. Drag the Video object to the Stage and use the Property Inspector to give it - a unique instance name, such as my_video. (Do not name it Video.)
    5. -
-

In AIR applications on the desktop, playing video in fullscreen mode disables any power and screen saving - features (when allowed by the operating system).

- -

Note: - The Video class is not a subclass of the InteractiveObject class, so - it cannot dispatch mouse events. However, you can call the addEventListener() method - on the display object container that contains the Video object. -

-

-

-View the examples. -

-

-See also -

-
-attachCamera() -
-attachNetStream() -
-flash.media.Camera.getCamera() -
-flash.net.NetConnection -
-flash.net.NetStream -
-flash.display.DisplayObjectContainer.addChild() -
-flash.display.Stage.addChild() -
-Working with Video -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  deblocking : int -
- Indicates the type of filter applied to decoded video as part of post-processing.
-		Video
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
  smoothing : Boolean -
- Specifies whether the video should be smoothed (interpolated) when it is scaled.
-		Video
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
  videoHeight : int -
[read-only] - An integer specifying the height of the video stream, in pixels.
-		Video
  videoWidth : int -
[read-only] - An integer specifying the width of the video stream, in pixels.
-		Video
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Video(width:int = 320, height:int = 240)
-
- Creates a new Video instance.
-		Video
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-attachCamera(camera:Camera):void -
-
- Specifies a video stream from a camera to be displayed - within the boundaries of the Video object in the application.
-		Video
   -
-attachNetStream(netStream:NetStream):void -
-
- Specifies a video stream to be displayed within the boundaries of the Video object - in the application.
-		Video
   -
-clear():void -
-
- Clears the image currently displayed in the Video object (not the video stream).
-		Video
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
-
- -
- -
Property detail
- - - - - -
deblockingproperty
-
-deblocking:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the type of filter applied to decoded video as part of post-processing. - The default value is 0, which lets the video compressor apply a deblocking filter as needed. -

Compression of video can result in undesired artifacts. You can use the - deblocking property to set filters that reduce blocking and, - for video compressed using the On2 codec, ringing.

-

Blocking refers to visible imperfections between the boundaries - of the blocks that compose each video frame. Ringing refers to distorted - edges around elements within a video image.

-

Two deblocking filters are available: one in the Sorenson codec and one in the On2 VP6 codec. - In addition, a deringing filter is available when you use the On2 VP6 codec. - To set a filter, use one of the following values:

-
    -
  • 0—Lets the video compressor apply the deblocking filter as needed.
    • -
  • 1—Does not use a deblocking filter.
    • -
  • 2—Uses the Sorenson deblocking filter.
    • -
  • 3—For On2 video only, uses the On2 deblocking filter but no deringing filter.
    • -
  • 4—For On2 video only, uses the On2 deblocking and deringing filter.
    • -
  • 5—For On2 video only, uses the On2 deblocking and a higher-performance - On2 deringing filter.
    • -
-

If a value greater than 2 is selected for video when you are using - the Sorenson codec, the Sorenson decoder defaults to 2.

-

Using a deblocking filter has an effect on overall playback performance, and it is usually - not necessary for high-bandwidth video. If a user's system is not powerful enough, - the user may experience difficulties playing back video with a deblocking filter enabled.

- Implementation -
-    public function get deblocking():int -
-    public function set deblocking(value:int):void -
-
- - - - - -
smoothingproperty 
-
-smoothing:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether the video should be smoothed (interpolated) when it is scaled. For - smoothing to work, the runtime must be in high-quality mode (the default). The default value - is false (no smoothing). -

For video playback using Flash Player 9.0.115.0 and later versions, set this property to - true to take advantage of mipmapping image optimization.

- Implementation -
-    public function get smoothing():Boolean -
-    public function set smoothing(value:Boolean):void -
-
- - - - - -
videoHeightproperty 
-
-videoHeight:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An integer specifying the height of the video stream, in pixels. For live streams, this - value is the same as the Camera.height - property of the Camera object that is capturing the video stream. For recorded video files, this - value is the height of the video. The NetStream.Video.DimensionChange event is dispatched in - the case of recorded videos when this value changes. -

You may want to use this property, for example, to ensure that the user is seeing the - video at the same size at which it was captured, - regardless of the actual size of the Video object on the Stage.

- Implementation -
-    public function get videoHeight():int -
-

-See also -

-
-flash.media.Camera.height -
-
- - - - - -
videoWidthproperty 
-
-videoWidth:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An integer specifying the width of the video stream, in pixels. For live streams, this - value is the same as the Camera.width - property of the Camera object that is capturing the video stream. For recorded video files, this - value is the width of the video. The NetStream.Video.DimensionChange event is dispatched in - the case of recorded videos when this value changes. - -

You may want to use this property, for example, to ensure that the user is seeing the - video at the same size at which it was captured, - regardless of the actual size of the Video object on the Stage.

- - Implementation -
-    public function get videoWidth():int -
-

-See also -

-
-flash.media.Camera.width -
-
- -
Constructor detail
- - - - - -
Video()constructor
-
-public function Video(width:int = 320, height:int = 240) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new Video instance. If no values for the width and - height parameters are supplied, - the default values are used. You can also set the width and height properties of the - Video object after the initial construction, using Video.width and - Video.height. - When a new Video object is created, values of zero for width or height are not allowed; - if you pass zero, the defaults will be applied. -

After creating the Video, call the - DisplayObjectContainer.addChild() or DisplayObjectContainer.addChildAt() - method to add the Video object to a parent DisplayObjectContainer object.

- - Parameters - - - - - - - - - - -
width:int (default = 320) — The width of the video, in pixels. -
 
height:int (default = 240) — The height of the video, in pixels. -
-
-Example -
The following example shows how to load an external FLV file: -
-
-var MyVideo:Video = new Video();
-addChild(MyVideo);
- 
-var MyNC:NetConnection = new NetConnection();
-MyNC.connect(null);
- 
-var MyNS:NetStream = new NetStream(MyNC);
-MyNS.play("http://www.helpexamples.com/flash/video/clouds.flv");
-
-MyVideo.attachNetStream(MyNS);
-
-//the clouds.flv video has metadata we're not using, so create
-//an error handler to ignore the message generated by the runtime
-//about the metadata
-MyNS.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler); 
-
-function asyncErrorHandler(event:AsyncErrorEvent):void 
-{ 
-   //ignore metadata error message
-}
-
-

-
- -
Method detail
- - - - - -
attachCamera()method
-
-public function attachCamera(camera:Camera):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies a video stream from a camera to be displayed - within the boundaries of the Video object in the application. - -

- Use this method to attach live video captured by the user - to the Video object. You can play the live video locally on the same computer - or device on which it is being captured, or you can send it to Flash Media Server and - use the server to stream it to other users. -

-

Note: In an iOS AIR application, camera video cannot be displayed when the application - uses GPU rendering mode.

- - Parameters - - - - -
camera:Camera — A Camera object that is capturing video data. - To drop the connection to the Video object, pass null. -
-

-See also -

-
-Video.attachNetStream() -
-flash.media.Camera -
-
-Example -

-
- - - - - -
attachNetStream()method 
-
-public function attachNetStream(netStream:NetStream):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies a video stream to be displayed within the boundaries of the Video object - in the application. - The video stream is either a video file played - with NetStream.play(), a Camera object, or null. - If you use a video file, it can be stored on the local file system or on - Flash Media Server. - If the value of the netStream argument is - null, the video is no longer played in the Video object. -

- You do not need to use this method if a video file contains only audio; the audio - portion of video files is played automatically - when you call NetStream.play(). To control the audio - associated with a video file, use the soundTransform property - of the NetStream object that plays the video file. -

- Parameters - - - - -
netStream:NetStream — A NetStream object. To drop the connection to the Video object, pass - null. -
-

-See also -

-
-Video.attachCamera() -
-flash.net.NetStream.soundTransform -
-flash.net.NetStream.play() -
-SoundTransform -
-
-Example -

-
- - - - - -
clear()method 
-
-public function clear():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Clears the image currently displayed in the Video object (not the video stream). This method is useful for - handling the current image. For example, you can clear the last image or display standby information - without hiding the Video object. -

-See also -

-
-Video.attachCamera() -
-
- -
Examples
-
examples\VideoExample
-
The following example uses a Video object with the NetConnection and - NetStream classes to load and play an FLV file. To run this example, you need an FLV file - whose name and location match the variable passed to videoURL, - in this case, an FLV file called Video.flv that is in the same directory as the SWF file. - -

In this example, the code that creates the Video and NetStream objects and calls - Video.attachNetStream() and NetStream.play() is placed - in a handler function. The handler is called only if the - attempt to connect to the NetConnection object is successful, which is - when the netStatus event returns an info object with a code - property that indicates success. - It is recommended that you wait for a successful connection before calling - NetStream.play().

-
-
-
- package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.media.Video;
-    import flash.net.NetConnection;
-    import flash.net.NetStream;
-
-    public class VideoExample extends Sprite {
-        private var videoURL:String = "Video.flv";
-        private var connection:NetConnection;
-        private var stream:NetStream;
-
-        public function VideoExample() {
-            connection = new NetConnection();
-            connection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            connection.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            connection.connect(null);
-        }
-
-        private function netStatusHandler(event:NetStatusEvent):void {
-            switch (event.info.code) {
-                case "NetConnection.Connect.Success":
-                    connectStream();
-                    break;
-                case "NetStream.Play.StreamNotFound":
-                    trace("Unable to locate video: " + videoURL);
-                    break;
-            }
-        }
-
-        private function connectStream():void {
-            stream = new NetStream(connection);
-            stream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            stream.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler);
-            var video:Video = new Video();
-            video.attachNetStream(stream);
-            stream.play(videoURL);
-            addChild(video);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-        
-        private function asyncErrorHandler(event:AsyncErrorEvent):void {
-            // ignore AsyncErrorEvent events.
-        }
-    }
- }
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/VideoCodec.html b/html-docs/flash/media/VideoCodec.html deleted file mode 100644 index a0e9b47..0000000 --- a/html-docs/flash/media/VideoCodec.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - -flash.media.VideoCodec (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class VideoCodec
InheritanceVideoCodec Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The VideoCodec class is an enumeration of constant values of supported video codecs. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  H264AVC : String = "H264Avc"
[static] - Constant value indicating that H.264/AVC codec is used for compressing video.
-		VideoCodec
  SORENSON : String = "Sorenson"
[static] - Constant value indicating that Sorenson Spark codec is used for compressing video.
-		VideoCodec
  VP6 : String = "VP6"
[static] - Constant value indicating that On2Vp6 codec is used for compressing video.
-		VideoCodec
-
- -
- -
Constant detail
- - - - - -
H264AVCconstant
-
-public static const H264AVC:String = "H264Avc" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant value indicating that H.264/AVC codec is used for compressing video. -

- - - - - -
SORENSONconstant 
-
-public static const SORENSON:String = "Sorenson" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 -
-

- Constant value indicating that Sorenson Spark codec is used for compressing video. - -

- - - - - -
VP6constant 
-
-public static const VP6:String = "VP6" -

- - - - -
Runtime version: 
-

- Constant value indicating that On2Vp6 codec is used for compressing video. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/VideoStatus.html b/html-docs/flash/media/VideoStatus.html deleted file mode 100644 index f23ca04..0000000 --- a/html-docs/flash/media/VideoStatus.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - -flash.media.VideoStatus (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.media
Classpublic final class VideoStatus
InheritanceVideoStatus Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

-

- This class defines an enumeration that describes possible levels of video decoding. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  ACCELERATED : String = "accelerated"
[static] - Indicates hardware-accelerated (GPU) video decoding.
-		VideoStatus
  SOFTWARE : String = "software"
[static] - Indicates software video decoding.
-		VideoStatus
  UNAVAILABLE : String = "unavailable"
[static] - Video decoding is not supported.
-		VideoStatus
-
- -
- -
Constant detail
- - - - - -
ACCELERATEDconstant
-
-public static const ACCELERATED:String = "accelerated" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

- Indicates hardware-accelerated (GPU) video decoding. -

- - - - - -
SOFTWAREconstant 
-
-public static const SOFTWARE:String = "software" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

- Indicates software video decoding. -

- - - - - -
UNAVAILABLEconstant 
-
-public static const UNAVAILABLE:String = "unavailable" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR (unsupported) -
-

- Video decoding is not supported. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/VideoStreamSettings.html b/html-docs/flash/media/VideoStreamSettings.html deleted file mode 100644 index a234a62..0000000 --- a/html-docs/flash/media/VideoStreamSettings.html +++ /dev/null @@ -1,707 +0,0 @@ - - - - - - - - -flash.media.VideoStreamSettings (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.media
Classpublic class VideoStreamSettings
InheritanceVideoStreamSettings Inheritance Object
SubclassesH264VideoStreamSettings
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The VideoStreamSettings class enables specifying video compression settings for each NetStream. - All parameters (resolution, frame rate, bandwidth, etc.) are gated by Camera capture parameters. You can use - methods (setMode(), etc.) to specify desired encoder parameters and you can use - the properties (width, etc.) to retrieve the actual compression parameters used. - Properties will be validated once Camera is attached to NetStream object - and compression has started. -

Note Current implementation does not support setting properties per NetStream and Camera parameters will be used - instead for each publishing NetStream.

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bandwidth : int -
[read-only] - Retrieve the maximum amount of bandwidth that the current outgoing video feed can use, in bytes per second.
-		VideoStreamSettings
  codec : String -
[read-only] - Video codec used for compression.
-		VideoStreamSettings
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fps : Number -
[read-only] - The maximum frame rate at which the video frames are encoded, in frames per second.
-		VideoStreamSettings
  height : int -
[read-only] - The current encoded height, in pixels.
-		VideoStreamSettings
  keyFrameInterval : int -
[read-only] - The number of video frames transmitted in full (called keyframes or IDR frames) instead of - being interpolated by the video compression algorithm.
-		VideoStreamSettings
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : int -
[read-only] - The required level of picture quality, as determined by the amount of compression being applied to each video - frame.
-		VideoStreamSettings
  width : int -
[read-only] - The current encoded width, in pixels.
-		VideoStreamSettings
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-VideoStreamSettings()
-
- Creates a setting object that specifies to use Sorenson Spark video codec for compresion.
-		VideoStreamSettings
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-setKeyFrameInterval(keyFrameInterval:int):void -
-
- The number of video frames transmitted in full (called keyframes or Instantaneous Decoding Refresh (IDR) frames) instead of being interpolated by the video compression algorithm.
-		VideoStreamSettings
   -
-setMode(width:int, height:int, fps:Number):void -
-
- Sets the resolution and frame rate used for video encoding.
-		VideoStreamSettings
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setQuality(bandwidth:int, quality:int):void -
-
- Sets maximum amount of bandwidth per second or the required picture quality that the current - outgoing video feed can use.
-		VideoStreamSettings
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
bandwidthproperty
-
-bandwidth:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Retrieve the maximum amount of bandwidth that the current outgoing video feed can use, in bytes per second. - To set this property, use the setQuality() method. -

Implementation -
-    public function get bandwidth():int -
-

-See also -

-
-setQuality() -
-
- - - - - -
codecproperty 
-
-codec:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Video codec used for compression. - -

Implementation -
-    public function get codec():String -
-
- - - - - -
fpsproperty 
-
-fps:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The maximum frame rate at which the video frames are encoded, in frames per second. - To set a desired value for this property, use the setMode() method. - This value is validated once Camera is attached to NetStream. -

Implementation -
-    public function get fps():Number -
-

-See also -

-
-setMode() -
-
- - - - - -
heightproperty 
-
-height:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The current encoded height, in pixels. To set a desired value for this property, - use the setMode() method. This value is validated once Camera is attached - to NetStream and compression has started. -

Implementation -
-    public function get height():int -
-

-See also -

-
-setMode() -
-height -
-
- - - - - -
keyFrameIntervalproperty 
-
-keyFrameInterval:int  [read-only]

- - - - -
Language version: ActionScript 3.0 #see setKeyFrameInterval() -
- - - - -
Runtime version: AIR 3 -
-

- The number of video frames transmitted in full (called keyframes or IDR frames) instead of - being interpolated by the video compression algorithm. To set a value for - this property, use the setKeyFrameInterval() method. -

Implementation -
-    public function get keyFrameInterval():int -
-
- - - - - -
qualityproperty 
-
-quality:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The required level of picture quality, as determined by the amount of compression being applied to each video - frame. This value ranges from 1 (lowest quality, maximum compression) to 100 (highest quality, small compression). - To set this property, use the setQuality() method. -

Implementation -
-    public function get quality():int -
-

-See also -

-
-setQuality() -
-
- - - - - -
widthproperty 
-
-width:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- The current encoded width, in pixels. To set a desired value for this property, - use the setMode() method. This value is validated once Camera is attached - to NetStream and compression has started. -

Implementation -
-    public function get width():int -
-

-See also -

-
-setMode() -
-height -
-
- -
Constructor detail
- - - - - -
VideoStreamSettings()constructor
-
-public function VideoStreamSettings() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Creates a setting object that specifies to use Sorenson Spark video codec for compresion. -

- -
Method detail
- - - - - -
setKeyFrameInterval()method
-
-public function setKeyFrameInterval(keyFrameInterval:int):void -

- - - - -
Language version: ActionScript 3.0 #see keyFrameInterval -
- - - - -
Runtime version: AIR 3 -
-

- The number of video frames transmitted in full (called keyframes or Instantaneous Decoding Refresh (IDR) frames) instead of being interpolated by the video compression algorithm. - The default value is 15, which means that every 15th frame is a keyframe. A value of 1 means that every frame is a keyframe. - The allowed values are 1 through 300. Set to -1 to use the same value as specified for Camera object. This value - is capped by Camera value. -

Note This feature will be supported in future releases of Flash Player and AIR, for now, Camera - parameters are used.

- Parameters - - - - -
keyFrameInterval:int — A value that specifies which video frames are transmitted in full - (as keyframes or IDR frames) instead of being interpolated by the video compression algorithm. -
-
- - - - - -
setMode()method 
-
-public function setMode(width:int, height:int, fps:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Sets the resolution and frame rate used for video encoding. Set each parameter - to -1 to use same encoding value as capture value. Encoding values must be less - than equal than capture values specified on Camera object. If invalid values are specified, capture values - will be used. Currently, only integer downsampling is supported for both resolution - and frame rate. Captured video is downsampled to desired resolution and frame rate. - The specified values are validated once Camera is attached to NetStream. You can use - width, height and fps properties to retrieve - actual compressed width, height and frame rate, respectively. -

Note This feature will be supported in future releases of Flash Player and AIR, for now, Camera - parameters are used.

- Parameters - - - - - - - - - - - - - - - - -
width:int — The requested encode width, in pixels. The default value is -1 (same as capture width). -
 
height:int — The requested encode height, in pixels. The default value is -1 (same as capture height). -
 
fps:Number — The requested frame rate at which frames should be encoded, in frames per second. - The default value is -1 (same as capture fps). -
-

-See also -

-
-width -
-height -
-fps -
-
- - - - - -
setQuality()method 
-
-public function setQuality(bandwidth:int, quality:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Sets maximum amount of bandwidth per second or the required picture quality that the current - outgoing video feed can use. To specify bandwidth, pass a value for - bandwidth and 0 for quality. To specify quality, pass 0 for bandwidth and - a value for quality. Both bandwidth and quality values are capped by Camera - parameters. -

Note This feature will be supported in future releases of Flash Player and AIR, for now, Camera - parameters are used.

- Parameters - - - - - - - - - - -
bandwidth:int — Specifies the maximum amount of bandwidth that the current outgoing video feed can use, - in bytes per second. The default value is 16384 (128k bits-per-second (bps), which is very low for high quality video). -
 
quality:int — An integer that specifies the required level of picture quality, as determined - by the amount of compression being applied to each video frame. Acceptable values - range from 1 (lowest quality, maximum compression) to 100 (highest quality, - small compression). The default value is 0. -
-

-See also -

-
-quality -
-bandwidth -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/media/package-detail.html b/html-docs/flash/media/package-detail.html deleted file mode 100644 index e650740..0000000 --- a/html-docs/flash/media/package-detail.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - - -flash.media Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.media package contains classes for working with multimedia assets such as sound and video. It also contains the video and audio classes available in Flash Media Server.

-
-
- -
Functions
- - - - - - - -
 FunctionDescription
 scanHardware - - Forces a rescan of the microphones and cameras on the system.
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 AudioDecoder - The AudioDecoder class enumerates the types of multichannel audio that a - system can support.
 AudioDeviceManager - - Use the AudioDeviceManager class to get audio device information of the system, and - select a device for audio playback.
 AudioOutputChangeReason - This class defines an enumeration that indicates the reason for AudioOutputChangeEvent.
 AudioPlaybackMode - The AudioPlaybackMode class defines constants for the audioPlaybackMode property of the - SoundMixer class.
 Camera - - Use the Camera class to capture video from the client system or device camera.
 CameraPosition - The CameraPosition class defines constants for the position property of the - Camera class.
 CameraRoll -The CameraRoll class allows you to access image data in the system media library or "camera roll." - -

AIR profile support: This feature is supported -on mobile devices, but it is not supported on desktop operating systems or AIR for TV devices.

 CameraRollBrowseOptions - The CameraRollBrowseOptions class defines the initialization options that may be used - when using the Camera Roll API to launch the Image Picker.
 CameraUI - The CameraUI class allows you to capture a still image or video using the default camera application on a device.
 H264Level - The H264Level class is an enumeration of constant values used in setting the - level of H264VideoStreamSettings class.
 H264Profile - The H264Profile class is an enumeration of constant values used in setting the profile - of H264VideoStreamSettings class.
 H264VideoStreamSettings - The H264VideoStreamSettings class enables specifying video compression settings for each NetStream.
 ID3Info - The ID3Info class contains properties that reflect ID3 metadata.
 MediaPromise - The MediaPromise class represents the promise to deliver a media object.
 MediaType - The MediaType class enumerates the general types of media that can be returned by a camera.
 Microphone - - Use the Microphone class to monitor or capture audio from a microphone.
 MicrophoneEnhancedMode - The MicrophoneEnhancedMode class is an enumeration of constant values used in setting the mode property - of MicrophoneEnhancedOptions class.
 MicrophoneEnhancedOptions - The MicrophoneEnhancedOptions class provides configuration options for enhanced audio (acoustic echo cancellation).
 Sound - The Sound class lets you work with sound in an application.
 SoundChannel - The SoundChannel class controls a sound in an application.
 SoundCodec -The SoundCodec class is an enumeration of constant values used in setting the codec property -of the Microphone class.
 SoundLoaderContext - The SoundLoaderContext class provides security checks for files that load sound.
 SoundMixer -The SoundMixer class contains static properties and methods for global sound control -in the application.
 SoundTransform - The SoundTransform class contains properties for volume and panning.
 StageVideo - The StageVideo object uses the device's hardware acceleration capabilities, if available, to display - live or recorded video in an application.
 StageVideoAvailability - This class defines an enumeration that indicates whether stage video is currently available.
 StageVideoAvailabilityReason - This class defines an enumeration that indicates whether stage video is currently available.
 StageWebView - The StageWebView class displays HTML content in a stage view port.
 Video - - The Video class displays live or recorded video in an application - without embedding the video in your SWF file.
 VideoCodec - The VideoCodec class is an enumeration of constant values of supported video codecs.
 VideoStatus - This class defines an enumeration that describes possible levels of video decoding.
 VideoStreamSettings - The VideoStreamSettings class enables specifying video compression settings for each NetStream.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/media/package.html b/html-docs/flash/media/package.html deleted file mode 100644 index ded7e4c..0000000 --- a/html-docs/flash/media/package.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - -flash.media Details (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-Package functions description.
-
Public Functions
- - - - - - - -
 FunctionDefined by
   -
-scanHardware():void -
-
- - Forces a rescan of the microphones and cameras on the system.
-		flash.media
-
- -
Function detail
- - - - - -
scanHardware()function
-
-public function scanHardware():void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Forces a rescan of the microphones and cameras on the system. - - -

-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/net/DatagramSocket.html b/html-docs/flash/net/DatagramSocket.html deleted file mode 100644 index d558992..0000000 --- a/html-docs/flash/net/DatagramSocket.html +++ /dev/null @@ -1,1475 +0,0 @@ - - - - - - - - -flash.net.DatagramSocket (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class DatagramSocket
InheritanceDatagramSocket Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The DatagramSocket class enables code to send and receive - Universal Datagram Protocol (UDP) packets. - -

AIR profile support: This feature is supported on all desktop - operating systems, on iOS (starting with AIR 3.8), and on Android (starting with AIR 3.8). - This feature is not supported on AIR for TV devices. You can test - for support at run time using the DatagramSocket.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

Datagram packets are individually transmitted between the source and destination. - Packets can arrive in a different order than they were sent. Packets lost in transmission are not retransmitted, or - even detected.

- -

Data sent using a datagram socket is not automatically broken - up into packets of transmittable size. If you send a UDP packet that exceeds the maximum - transmission unit (MTU) size, network discards the packet (without warning). The limiting MTU is the - smallest MTU of any interface, switch, or router in the transmission path. - You can use the NetworkInterface class to determine the MTU of the local interface, but - other nodes in the network can have different MTU values.

- -

The Socket class uses TCP which provides guaranteed packet delivery and automatically - divides and reassembles large packets. TCP also provides better network bandwidth - management. These features mean that data sent using a TCP socket incurs higher - latency, but for most uses, the benefits of TCP far outweigh the costs. Most network - communication should use the Socket class rather than the DatagramSocket class.

- -

The DatagramSocket class is useful for working with - applications where a small transmission latency is important - and packet loss is tolerable. For example, network operations in voice-over-IP (VoIP) applications and - real-time, multiplayer games can often benefit from UDP. The - DatagramSocket class is also useful for some server-side - applications. Since UDP is a stateless protocol, a - server can handle more requests from more clients than it can with - TCP.

- -

The DatagramSocket class can only be used in Adobe AIR - applications and only in the application security sandbox.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- -

-

-View the examples. -

-

-See also -

-
-RFC 768 -
-Socket class -
-XMLSocket class -
-ServerSocket class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bound : Boolean -
[read-only] - Indicates whether this socket object is currently bound to a local address - and port.
-		DatagramSocket
  connected : Boolean -
[read-only] - Indicates whether this socket object is currently connected to a remote address - and port.
-		DatagramSocket
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - Indicates whether or not DatagramSocket features are supported in the run-time environment.
-		DatagramSocket
  localAddress : String -
[read-only] - The IP address this socket is bound to on the local machine.
-		DatagramSocket
  localPort : int -
[read-only] - The port this socket is bound to on the local machine.
-		DatagramSocket
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  remoteAddress : String -
[read-only] - The IP address of the remote machine to which this socket is connected.
-		DatagramSocket
  remotePort : int -
[read-only] - The port on the remote machine to which this socket is connected.
-		DatagramSocket
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DatagramSocket()
-
- Creates a DatagramSocket object.
-		DatagramSocket
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-bind(localPort:int = 0, localAddress:String = "0.0.0.0"):void -
-
- Binds this socket to the specified local address and port.
-		DatagramSocket
   -
-broadcast(bytes:ByteArray, offset:uint = 0, length:uint = 0, address:String = "255.255.255.255", port:int = 0):void -
-
[static] - Broadcast a message on the local network.
-		DatagramSocket
   -
-close():void -
-
- Closes the socket.
-		DatagramSocket
   -
-connect(remoteAddress:String, remotePort:int):void -
-
- Connects the socket to a specified remote address and port.
-		DatagramSocket
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-receive():void -
-
- Enables this DatagramSocket object to receive incoming packets on the bound IP address and port.
-		DatagramSocket
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-send(bytes:ByteArray, offset:uint = 0, length:uint = 0, address:String = null, port:int = 0):void -
-
- Sends packet containing the bytes in the ByteArray using UDP.
-		DatagramSocket
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-close -
-		 - Dispatched when the operating system closes this socket.DatagramSocket
   -
-data -
-		 - Dispatched when this socket receives a packet of data.DatagramSocket
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-ioError -
-		 - Dispatched when this socket receives an I/O error.DatagramSocket
-
- -
- -
Property detail
- - - - - -
boundproperty
-
-bound:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether this socket object is currently bound to a local address - and port. - -

Implementation -
-    public function get bound():Boolean -
-

-See also -

-
-bind() -
-
- - - - - -
connectedproperty 
-
-connected:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether this socket object is currently connected to a remote address - and port. - -

Note: A value of true does not mean that a remote computer - is listening on the connected address and port. It only means that this DataGramSocket object - will only send data to or receive data from that address and port.

- - Implementation -
-    public function get connected():Boolean -
-

-See also -

-
-connect() -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether or not DatagramSocket features are supported in the run-time environment. - - -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
localAddressproperty 
-
-localAddress:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The IP address this socket is bound to on the local machine. - -

Implementation -
-    public function get localAddress():String -
-

-See also -

-
-bind() -
-
- - - - - -
localPortproperty 
-
-localPort:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The port this socket is bound to on the local machine. - -

Implementation -
-    public function get localPort():int -
-

-See also -

-
-bind() -
-
- - - - - -
remoteAddressproperty 
-
-remoteAddress:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The IP address of the remote machine to which this socket is connected. - -

Implementation -
-    public function get remoteAddress():String -
-

-See also -

-
-connect() -
-
- - - - - -
remotePortproperty 
-
-remotePort:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The port on the remote machine to which this socket is connected. - -

Implementation -
-    public function get remotePort():int -
-

-See also -

-
-connect() -
-
- -
Constructor detail
- - - - - -
DatagramSocket()constructor
-
-public function DatagramSocket() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a DatagramSocket object. - -


-Throws - - - - -
SecurityError — if content outside the AIR application security - sandbox attempts to create a DatagramSocket object. - -
-
- -
Method detail
- - - - - -
bind()method
-
-public function bind(localPort:int = 0, localAddress:String = "0.0.0.0"):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Binds this socket to the specified local address and port. - -

The bind() method executes synchronously. The bind operation completes - before the next line of code is executed.

- - Parameters - - - - - - - - - - -
localPort:int (default = 0) — The number of the port to bind to on the local computer. If localPort, - is set to 0 (the default), the next available system port is bound. Permission to connect to a port - number below 1024 is subject to the system security policy. On Mac and Linux systems, for example, - the application must be running with root privileges to connect to ports below 1024. -
 
localAddress:String (default = "0.0.0.0") — The IP address on the local machine to bind to. This address can be an - IPv4 or IPv6 address. If localAddress is set to 0.0.0.0 (the default), - the socket listens on all available IPv4 addresses. - To listen on all available IPv6 addresses, you must specify "::" as the localAddress - argument. To use an IPv6 address, the computer and network must both be - configured to support IPv6. Furthermore, a socket bound to an IPv4 address - cannot connect to a socket with an IPv6 address. Likewise, a socket bound to an IPv6 - address cannot connect to a socket with an IPv4 address. The type of address must match. - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
RangeError — This error occurs when localPort is less than 0 or greater than 65535. - -
 
ArgumentError — This error occurs when localAddress is not a syntactically well-formed IP address. -
 
Error — This error occurs if the socket cannot be bound, such as when: -
    -
  1. localPort is already in use by another socket.
    2. -
  2. the user account under which the application is running doesn't have sufficient - system privileges to bind to the specified port. (Privilege issues typically occur when localPort < 1024.)
    3. -
  3. This DatagramSocket object is already bound.
    4. -
  4. This DatagramSocket object has been closed.
    5. -
- -
 
Error — This error occurs when localAddress is not a valid local address. - -
-
-Example -
The following example illustrates various ways to bind a DatagramSocket object: -
-
-
-udpSocket.bind(); //bind to any available port, listen on all IPv4 addresses
-udpSocket.bind( 0, "0.0.0.0" ); //same as above
-udpSocket.bind( 0, "127.0.0.1" ); //any available port on the localhost address
-udpSocket.bind( 8989, "192.168.0.1" ); //port 8989 on a particular IPv4 address
-udpSocket.bind( 0, "::" ); //any available port on all IPv6 address
-udpSocket.bind( 8989, "::1" ); //port 8989 on the IPv6 localhost address
-udpSocket.bind( 8989, "2001:1890:110b:1e19:f06b:72db:7026:3d7a" ); //port 8989 on a particular IPv6 address
-
-

-
- - - - - -
broadcast()method 
-
-public static function broadcast(bytes:ByteArray, offset:uint = 0, length:uint = 0, address:String = "255.255.255.255", port:int = 0):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51 -
-

- Broadcast a message on the local network. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
bytes:ByteArray — a ByteArray containing the packet data. -
 
offset:uint (default = 0) — The zero-based offset into the bytes ByteArray - object at which the packet begins. -
 
length:uint (default = 0) — The number of bytes in the packet. The default value of 0 causes - the entire ByteArray to be sent, starting at the value specified by - the offset parameter. -
 
address:String (default = "255.255.255.255") — The broadcast address to use. The default is to attempt a broadcast across - the local network using 255.255.255.255 but this can (and should) be changed - to a broadcast address appropriate for the sub-net, for example 192.168.1.255. -
 
port:int (default = 0) — The port number to broadcast on. -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
RangeError — This error occurs when port is less than 1 or greater than 65535. -
 
ArgumentError — If bytes is null or if address is not a well-formed IP address. -
 
Error — This error occurs if the broadcast was not successful (e.g. if the number of bytes actually sent - is less than the bytes requested to send). -
 
RangeError — If offset is greater than the length of the ByteArray specified in - bytes or if the amount of data specified to be written by offset plus - length exceeds the data available. -
-
- - - - - -
close()method 
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Closes the socket. - -

The socket is disconnected from the remote machine - and unbound from the local machine. A closed socket cannot be reused.

- -
-Throws - - - - -
Error — If the socket cannot be closed (because of an internal, networking, - or operating system error), or if the socket is not open. - -
-
- - - - - -
connect()method 
-
-public function connect(remoteAddress:String, remotePort:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Connects the socket to a specified remote address and port. - -

When a datagram socket is "connected," datagram packets can only be sent to and received from - the specified target. Packets from other sources are ignored. Connecting a datagram socket is not - required. Establishing a connection can remove the need to filter out extraneous packets from - other sources. However, a UDP socket connection is not a persistent network connection (as it - is for a TCP connection). It is possible that the remote end of the socket does not even exist.

- -

If the bind() method has not been called, the socket is - automatically bound to the default local address and port.

- - Parameters - - - - - - - - - - -
remoteAddress:String — The IP address of the remote machine with which to establish - a connection. This address can be an IPv4 or IPv6 address. If bind() has not - been called, the address family of the remoteAddress, IPv4 or IPv6, is used when calling the - default bind(). - -
 
remotePort:int — The port number on the remote machine used to establish a connection. - -
-
-Throws - - - - - - - - - - - - - - - - -
RangeError — This error occurs when localPort is less than 1 or greater than 65535. - -
 
ArgumentError — This error occurs when localAddress is not a syntactically valid address. - Or when a default route address ('0.0.0.0' or '::') is used. -
 
Error — This error occurs if the socket cannot be connected, such as when bind() has not - been called before the call to connect() and default binding to the remote address family is not possible. - -
-
- - - - - -
receive()method 
-
-public function receive():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Enables this DatagramSocket object to receive incoming packets on the bound IP address and port. - -

The function returns immediately. The DatagramSocket object dispatches a data event - when a data packet is received.

- -
-Events - - - - -
data:DatagramSocketDataEvent — when a UDP packet is received.
-
- - - - - -
send()method 
-
-public function send(bytes:ByteArray, offset:uint = 0, length:uint = 0, address:String = null, port:int = 0):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Sends packet containing the bytes in the ByteArray using UDP. - -

If the socket is connected, the packet - is sent to the remote address and port specified in the connect() - method and no destination IP address and port can be specified. If the socket is - not connected, the packet is sent to the specified address and port - and you must supply valid values for address and port. - If the bind() method has not been called, the socket is - automatically bound to the default local address and port.

- -

Note: Sending data to a broadcast address is not supported. Instead, - see the broadcast() method.

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
bytes:ByteArray — a ByteArray containing the packet data. - -
 
offset:uint (default = 0) — The zero-based offset into the bytes ByteArray - object at which the packet begins. - -
 
length:uint (default = 0) — The number of bytes in the packet. The default value of 0 causes - the entire ByteArray to be sent, starting at the value specified by - the offset parameter. - -
 
address:String (default = null) — The IPv4 or IPv6 address of the remote machine. An address is required - if one has not already been specified using the connect() method. - -
 
port:int (default = 0) — The port number on the remote machine. A value greater than 0 and - less than 65536 is required if the port has not already been specified using the - connect() method. - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
RangeError — This error occurs when port is less than 1 or greater than 65535. - -
 
ArgumentError — If the socket is not connected and address is not a well-formed IP address. - -
 
Error — This error occurs: -
    -
  1. If bind() has not been called, and when default binding to the - destination address family is not possible.
    2. -
  2. On some operating systems, an IOError is thrown if the connect() method is - called when an ICMP "destination unreachable" message has already been - received from the target host. (Thus, the error is thrown on the second failed attempt to send data, not the first.) Other - operating systems, such as Windows, disregard these ICMP messages, so no error is thrown.
    3. -
-
 
Error — when the bytes parameter is null. -
 
RangeError — If offset is greater than the length of the ByteArray specified in - bytes or if the amount of data specified to be written by offset plus - length exceeds the data available. - -
 
Error — If the address or port parameters are specified - when the socket has already been connected. - -
-
-
Event detail
- - - - - -
closeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLOSE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when the operating system closes this socket. - -

The close event is not dispatched when the DatagramSocket close() - method is called.

- -

- The Event.CLOSE constant defines the value of the type property of a close event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection has been closed.
- -
- - - - - -
dataevent  
-
-Event object type: flash.events.DatagramSocketDataEvent -
-DatagramSocketDataEvent.type property = flash.events.DatagramSocketDataEvent.DATA -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when this socket receives a packet of data. - -

- Defines the value of the type property of a data event object. - -

- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Dispatched when this socket receives an I/O error. - -

- -
Examples
-
examples\DatagramSocketExample
-
-
-
-package
-{
-    import flash.display.Sprite;
-	import flash.events.DatagramSocketDataEvent;
-	import flash.events.Event;
-	import flash.events.MouseEvent;
-	import flash.events.TimerEvent;
-	import flash.net.DatagramSocket;
-	import flash.text.TextField;
-	import flash.text.TextFieldAutoSize;
-	import flash.text.TextFieldType;
-	import flash.utils.ByteArray;
-	import flash.utils.Timer;
-	
-	public class DatagramSocketExample extends Sprite
-	{
-		private var datagramSocket:DatagramSocket = new DatagramSocket();;
-
-		private var localIP:TextField;
-		private var localPort:TextField;
-		private var logField:TextField;
-		private var targetIP:TextField;
-		private var targetPort:TextField;
-		private var message:TextField;
-		
-		public function DatagramSocketExample()
-		{
-			setupUI();
-		}
-
-		private function bind( event:Event ):void
-		{
-			if( datagramSocket.bound ) 
-			{
-				datagramSocket.close();
-				datagramSocket = new DatagramSocket();
-				
-			}
-			datagramSocket.bind( parseInt( localPort.text ), localIP.text );
-			datagramSocket.addEventListener( DatagramSocketDataEvent.DATA, dataReceived );
-			datagramSocket.receive();
-			log( "Bound to: " + datagramSocket.localAddress + ":" + datagramSocket.localPort );
-		}
-		
-		private function dataReceived( event:DatagramSocketDataEvent ):void
-		{
-			//Read the data from the datagram
-			log("Received from " + event.srcAddress + ":" + event.srcPort + "> " + 
-				event.data.readUTFBytes( event.data.bytesAvailable ) );
-		}
-		
-		private function send( event:Event ):void
-		{
-			//Create a message in a ByteArray
-			var data:ByteArray = new ByteArray();
-			data.writeUTFBytes( message.text );
-			
-			//Send a datagram to the target
-			try
-			{
-				datagramSocket.send( data, 0, 0, targetIP.text, parseInt( targetPort.text )); 
-				log( "Sent message to " + targetIP.text + ":" + targetPort.text );
-			}
-			catch ( error:Error )
-			{
-				log( error.message );
-			}
-		}
-		
-		private function log( text:String ):void
-		{
-			logField.appendText( text + "\n" );
-			logField.scrollV = logField.maxScrollV;
-			trace( text );
-		}
-		private function setupUI():void
-		{
-			targetIP = createTextField( 10, 10, "Target IP:", "192.168.0.1" );
-			targetPort = createTextField( 10, 35, "Target port:", "8989" );
-			message = createTextField( 10, 60, "Message:", "Lucy can't drink milk." );
-			localIP = createTextField( 10, 85, "Local IP", "0.0.0.0");
-			localPort = createTextField( 10, 110, "Local port:", "0" );
-			createTextButton( 250, 135, "Bind", bind );
-			createTextButton( 300, 135, "Send", send );
-			logField = createTextField( 10, 160, "Log:", "", false, 200 )
-				
-			this.stage.nativeWindow.activate();
-		}
-		
-		private function createTextField( x:int, y:int, label:String, defaultValue:String = '', editable:Boolean = true, height:int = 20 ):TextField
-		{
-			var labelField:TextField = new TextField();
-			labelField.text = label;
-			labelField.type = TextFieldType.DYNAMIC;
-			labelField.width = 180;
-			labelField.x = x;
-			labelField.y = y;
-			
-			var input:TextField = new TextField();
-			input.text = defaultValue;
-			input.type = TextFieldType.INPUT;
-			input.border = editable;
-			input.selectable = editable;
-			input.width = 280;
-			input.height = height;
-			input.x = x + labelField.width;
-			input.y = y;
-			
-			this.addChild( labelField );
-			this.addChild( input );
-			
-			return input;
-		}
-		
-		private function createTextButton( x:int, y:int, label:String, clickHandler:Function ):TextField
-		{
-			var button:TextField = new TextField();
-			button.htmlText = "<u><b>" + label + "</b></u>";
-			button.type = TextFieldType.DYNAMIC;
-			button.selectable = false;
-			button.width = 180;
-			button.x = x;
-			button.y = y;
-			button.addEventListener( MouseEvent.CLICK, clickHandler );
-			
-			this.addChild( button );
-			return button;
-			
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/FileFilter.html b/html-docs/flash/net/FileFilter.html deleted file mode 100644 index 445586a..0000000 --- a/html-docs/flash/net/FileFilter.html +++ /dev/null @@ -1,464 +0,0 @@ - - - - - - - - -flash.net.FileFilter (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class FileFilter
InheritanceFileFilter Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The FileFilter class is used to indicate what files on the user's system are shown - in the file-browsing dialog box that is displayed when the FileReference.browse() - method, the FileReferenceList.browse() method is called or a - browse method of a File, FileReference, or FileReferenceList object is called. - FileFilter instances are passed as a value for the optional typeFilter parameter to the method. - If you use a FileFilter instance, extensions and file types that aren't specified in the FileFilter instance - are filtered out; that is, they are not available to the user for selection. - If no FileFilter object is passed to the method, all files are shown in the dialog box. -

You can use FileFilter instances in one of two ways:

- -
    - -
  • A description with file extensions only
    • - -
  • A description with file extensions and Macintosh file types
    • - -
- -

The two formats are not interchangeable within a single call to the browse method. - You must use one or the other.

-

You can pass one or more FileFilter instances to the browse method, as shown in the following:

- - 
- var imagesFilter:FileFilter = new FileFilter("Images", "*.jpg;*.gif;*.png");
- var docFilter:FileFilter = new FileFilter("Documents", "*.pdf;*.doc;*.txt");
- var myFileReference:FileReference = new FileReference();
- myFileReference.browse([imagesFilter, docFilter]);
-
- -

Or in an AIR application:

- - 
- var imagesFilter:FileFilter = new FileFilter("Images", "*.jpg;*.gif;*.png");
- var docFilter:FileFilter = new FileFilter("Documents", "*.pdf;*.doc;*.txt");
- var myFile:File = new File();
- myFile.browseForOpen("Open", [imagesFilter, docFilter]);
-
- - 
- var imagesFilter = new air.FileFilter("Images", "*.jpg;*.gif;*.png");
- var docFilter = new air.FileFilter("Documents", "*.pdf;*.doc;*.txt");
- var myFile = new air.File();
- myFile.browseForOpen("Open", [imagesFilter, docFilter]);
-
- -

The list of extensions in the FileFilter.extension property - is used to filter the files shown in the file browsing dialog. The list is not actually - displayed in the dialog box; to display the file types - for users, you must list the file types in the description string as well as in the extension - list. The description string is displayed in the dialog box in Windows and Linux. - (It is not used on the Macintosh®.) On the Macintosh, if you supply a list of Macintosh file types, - that list is used to filter the files. If not, the list of file extensions is used.

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  description : String -
- The description string for the filter.
-		FileFilter
  extension : String -
- A list of file extensions.
-		FileFilter
  macType : String -
- A list of Macintosh file types.
-		FileFilter
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-FileFilter(description:String, extension:String, macType:String = null)
-
- Creates a new FileFilter instance.
-		FileFilter
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
descriptionproperty
-
-description:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The description string for the filter. The description - is visible to the user in the dialog box that opens - when FileReference.browse() - or FileReferenceList.browse() is called. - The description string contains a string, such as - "Images (*.gif, *.jpg, *.png)", that can - help instruct the user on what file types can be uploaded - or downloaded. Note that the actual file types that are supported by - this FileReference object are stored in the extension - property. -

Implementation -
-    public function get description():String -
-    public function set description(value:String):void -
-
- - - - - -
extensionproperty 
-
-extension:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A list of file extensions. This list indicates the types of files - that you want to show in the file-browsing dialog box. (The list - is not visible to the user; the user sees only the value of the - description property.) The extension property contains - a semicolon-delimited list of file extensions, - with a wildcard (*) preceding each extension, as shown - in the following string: "*.jpg;*.gif;*.png". - -

Implementation -
-    public function get extension():String -
-    public function set extension(value:String):void -
-
- - - - - -
macTypeproperty 
-
-macType:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A list of Macintosh file types. This list indicates the types of files - that you want to show in the file-browsing dialog box. (This list - itself is not visible to the user; the user sees only the value of the - description property.) The macType property contains - a semicolon-delimited list of Macintosh file types, as shown - in the following string: "JPEG;jp2_;GIFF". -

Implementation -
-    public function get macType():String -
-    public function set macType(value:String):void -
-
- -
Constructor detail
- - - - - -
FileFilter()constructor
-
-public function FileFilter(description:String, extension:String, macType:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new FileFilter instance. -

Parameters - - - - - - - - - - - - - - - - -
description:String — The description string that is visible to users when they select files for uploading. - -
 
extension:String — A list of file extensions that indicate which file formats are visible to users - when they select files for uploading. -
 
macType:String (default = null) — A list of Macintosh file types that indicate which file types are visible to - users when they select files for uploading. If no value is passed, this parameter is set to null. -
-
-Example -
The following example uploads an image from your local file system to the root display object (in this case, the stage). - Example provided by Andre Venancio. - -
-
-var buttonShape:Shape = new Shape();
-buttonShape.graphics.beginFill(0x336699);
-buttonShape.graphics.drawCircle(50, 50, 25);
-var button = new SimpleButton(buttonShape, buttonShape, buttonShape, buttonShape);
-addChild(button);
-
-var fileRef:FileReference= new FileReference();
-button.addEventListener(MouseEvent.CLICK, onButtonClick);
-
-function onButtonClick(e:MouseEvent):void {
-fileRef.browse([new FileFilter("Images", "*.jpg;*.gif;*.png")]);
-fileRef.addEventListener(Event.SELECT, onFileSelected);
-}
-
-function onFileSelected(e:Event):void {
-fileRef.addEventListener(Event.COMPLETE, onFileLoaded);
-fileRef.load();
-}
-
-function onFileLoaded(e:Event):void {
-var loader:Loader = new Loader();
-loader.loadBytes(e.target.data);
-addChild(loader);
-}
-
-

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/FileReference.html b/html-docs/flash/net/FileReference.html deleted file mode 100644 index 2921ca6..0000000 --- a/html-docs/flash/net/FileReference.html +++ /dev/null @@ -1,3461 +0,0 @@ - - - - - - - - -flash.net.FileReference (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.net
Classpublic class FileReference
InheritanceFileReference Inheritance EventDispatcher Inheritance Object
SubclassesFile
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The FileReference class provides a means to upload and - download files between a user's computer and a server. An operating-system - dialog box prompts the user to select a file to upload or a location for - download. Each FileReference object refers to a single file on the user's disk - and has properties that contain information about - the file's size, type, name, creation date, modification date, and creator type - (Macintosh only). -

Note: In Adobe AIR, the File class, which extends the FileReference class, - provides more capabilities and has less security restrictions than the FileReference class.

- -

FileReference instances are created in the following ways:

-
    -
  • When you use the new operator with the FileReference constructor: - - var myFileReference = new FileReference();
    • - -
  • When you call the FileReferenceList.browse() method, which creates an array of FileReference objects.
    • -
- -

During an upload operation, all the properties of a FileReference object are - populated by calls to the FileReference.browse() or FileReferenceList.browse() methods. - During a download operation, the name property is populated when the - select event is dispatched; all other properties are populated when the - complete event is dispatched.

- -

The browse() method opens an operating-system dialog box that prompts the - user to select a file for upload. The FileReference.browse() method - lets the user select a single file; the FileReferenceList.browse() method - lets the user select multiple files. After a successful call to the browse() method, - call the FileReference.upload() method to upload one file at a time. The - FileReference.download() method prompts the user for a location to save - the file and initiates downloading from a remote URL.

-

The FileReference and FileReferenceList classes do not let you set the default file location - for the dialog box that the browse() or download() methods generate. - The default location shown in the dialog box is the most - recently browsed folder, if that location can be determined, or the desktop. - The classes do not allow you to read from or write to the transferred file. - They do not allow the SWF file that initiated the - upload or download to access the uploaded or downloaded file or the file's location on - the user's disk.

- -

The FileReference and FileReferenceList classes also do not provide - methods for authentication. With servers that require authentication, you can - download files with the Flash® Player browser plug-in, but - uploading (on all players) and downloading (on the stand-alone or - external player) fails. Listen for FileReference events to determine whether - operations complete successfully and to handle errors.

-

For content running in Flash Player or for - content running in Adobe AIR outside of the application security sandbox, - uploading and downloading operations can access files only within its own domain and within - any domains that a URL policy file specifies. Put a policy file on the file server - if the content initiating the upload or download doesn't come from the same domain as the file server.

-

Note that because of new functionality added to the Flash Player, when publishing to Flash Player 10, you can have - only one of the following operations active at one time: FileReference.browse(), - FileReference.upload(), FileReference.download(), FileReference.load(), - FileReference.save(). Otherwise, Flash Player throws a runtime error (code 2174). Use FileReference.cancel() - to stop an operation in progress. This restriction applies only to Flash Player 10. Previous versions of Flash Player - are unaffected by this restriction on simultaneous multiple operations.

-

While calls to the FileReference.browse(), FileReferenceList.browse(), - or FileReference.download() methods are executing, SWF file playback pauses in stand-alone and external versions - of Flash Player and in AIR for Linux and Mac OS X 10.1 and earlier

- -

The following sample HTTP POST request is sent from Flash Player to a server-side - script if no parameters are specified: -

- - 
-  POST /handler.cfm HTTP/1.1 
-  Accept: text/*
-  Content-Type: multipart/form-data; 
-  boundary=----------Ij5ae0ae0KM7GI3KM7 
-  User-Agent: Shockwave Flash 
-  Host: www.example.com 
-  Content-Length: 421 
-  Connection: Keep-Alive 
-  Cache-Control: no-cache
-  
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7
-  Content-Disposition: form-data; name="Filename"
-  
-  MyFile.jpg
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7
-  Content-Disposition: form-data; name="Filedata"; filename="MyFile.jpg"
-  Content-Type: application/octet-stream
-  
-  FileDataHere
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7
-  Content-Disposition: form-data; name="Upload"
-  
-  Submit Query
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7--
-
-

Flash Player sends the following HTTP POST request if the user - specifies the parameters "api_sig", "api_key", and - "auth_token": -

- - 
-  POST /handler.cfm HTTP/1.1 
-  Accept: text/*
-  Content-Type: multipart/form-data; 
-  boundary=----------Ij5ae0ae0KM7GI3KM7 
-  User-Agent: Shockwave Flash 
-  Host: www.example.com 
-  Content-Length: 421 
-  Connection: Keep-Alive 
-  Cache-Control: no-cache
-  
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7
-  Content-Disposition: form-data; name="Filename"
-  
-  MyFile.jpg
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7
-  Content-Disposition: form-data; name="api_sig"
-  
-  XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7
-  Content-Disposition: form-data; name="api_key"
-  
-  XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7
-  Content-Disposition: form-data; name="auth_token"
-  
-  XXXXXXXXXXXXXXXXXXXXXX
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7
-  Content-Disposition: form-data; name="Filedata"; filename="MyFile.jpg"
-  Content-Type: application/octet-stream
-  
-  FileDataHere
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7
-  Content-Disposition: form-data; name="Upload"
-  
-  Submit Query
-  ------------Ij5GI3GI3ei4GI3ei4KM7GI3KM7KM7--
-
-

-

-View the examples. -

-

-See also -

-
-flash.net.FileReferenceList -
-flash.filesystem.File -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  creationDate : Date -
[read-only] - The creation date of the file on the local disk.
-		FileReference
  creator : String -
[read-only] - The Macintosh creator type of the file, which is only used in Mac OS versions - prior to Mac OS X.
-		FileReference
  data : ByteArray -
[read-only] - The ByteArray object representing the data from the loaded file after a successful call to the load() method.
-		FileReference
  extension : String -
[read-only] - The filename extension.
-		FileReference
  modificationDate : Date -
[read-only] - The date that the file on the local disk was last modified.
-		FileReference
  name : String -
[read-only] - The name of the file on the local disk.
-		FileReference
  permissionStatus : String -
[static][read-only] - Determine whether the application has been granted the permission to access filesystem.
-		FileReference
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  size : Number -
[read-only] - The size of the file on the local disk in bytes.
-		FileReference
  type : String -
[read-only] - The file type.
-		FileReference
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-FileReference()
-
- Creates a new FileReference object.
-		FileReference
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-browse(typeFilter:Array = null):Boolean -
-
- Displays a file-browsing dialog box that lets the - user select a file to upload.
-		FileReference
   -
-cancel():void -
-
- Cancels any ongoing upload or download operation on this FileReference object.
-		FileReference
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-download(request:URLRequest, defaultFileName:String = null):void -
-
- Opens a dialog box that lets the user download a file from a remote server.
-		FileReference
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-load():void -
-
- Starts the load of a local file selected by a user.
-		FileReference
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-requestPermission():void -
-
- Requests permission to access filesystem.
-		FileReference
   -
-save(data:*, defaultFileName:String = null):void -
-
- Opens a dialog box that lets the user save a file to the local filesystem.
-		FileReference
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-upload(request:URLRequest, uploadDataFieldName:String = "Filedata", testUpload:Boolean = false):void -
-
- Starts the upload of the file to a remote server.
-		FileReference
   -
-uploadUnencoded(request:URLRequest):void -
-
- Initiate uploading a file to a URL without any encoding.
-		FileReference
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-cancel -
-		 - Dispatched when a file upload or download is canceled through the file-browsing dialog - box by the user.FileReference
   -
-complete -
-		 - Dispatched when download is complete or when upload generates an HTTP status code of 200.FileReference
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-httpResponseStatus -
-		 - Dispatched if a call to the upload() or uploadUnencoded() - method attempts to access data over HTTP and Adobe AIR is able to detect and return - the status code for the request.FileReference
   -
-httpStatus -
-		 - Dispatched when an upload fails and an HTTP status code is available - to describe the failure.FileReference
   -
-ioError -
-		 - Dispatched when the upload or download fails.FileReference
   -
-open -
-		 - Dispatched when an upload or download operation starts.FileReference
   -
-permissionStatus -
-		 - Dispatched when the application requests permission to access filesystem.FileReference
   -
-progress -
-		 - Dispatched periodically during the file upload or download operation.FileReference
   -
-securityError -
-		 - Dispatched when a call to the FileReference.upload() - or FileReference.download() method tries to upload a file to a server or - get a file from a server that is outside the caller's security sandbox.FileReference
   -
-select -
-		 - Dispatched when the user selects a file for upload or download from the file-browsing dialog box.FileReference
   -
-uploadCompleteData -
-		 - Dispatched after data is received from the server after a successful upload.FileReference
-
- -
- -
Property detail
- - - - - -
creationDateproperty
-
-creationDate:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The creation date of the file on the local disk. If the object is - was not populated, a call to get the value of this property returns null. -

Note: If an operating system does not have creationDate as its property, - in such cases, CreationDate is equal to lastModifiedDate.

- Implementation -
-    public function get creationDate():Date -
-
-Throws -
- - - - - - - - - - -
Error — If the FileReference.browse(), - FileReferenceList.browse(), or FileReference.download() method was not called - successfully, an exception is thrown with a message indicating that functions were called in the - incorrect sequence or an earlier call was unsuccessful. - In this case, the value of the creationDate property is null. - -
 
Error — If the file information cannot be accessed, an exception is thrown with a message - indicating a file I/O error. -
-

-See also -

-
-FileReference.browse() -
-
- - - - - -
creatorproperty 
-
-creator:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The Macintosh creator type of the file, which is only used in Mac OS versions - prior to Mac OS X. In Windows or Linux, this property is null. - If the FileReference object - was not populated, a call to get the value of this property returns null. -

Implementation -
-    public function get creator():String -
-
-Throws -
- - - - -
Error — On Macintosh, if the FileReference.browse(), - FileReferenceList.browse(), or FileReference.download() method was not called - successfully, an exception is thrown with a message indicating that functions were called in the - incorrect sequence or an earlier call was unsuccessful. In this case, the value of the creator property - is null. -
-

-See also -

-
-FileReference.browse() -
-FileReference.extension -
-
- - - - - -
dataproperty 
-
-data:ByteArray  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The ByteArray object representing the data from the loaded file after a successful call to the load() method. -

Implementation -
-    public function get data():ByteArray -
-
-Throws -
- - - - - - - - - - -
Error — If the load() method was not called - successfully, an exception is thrown with a message indicating that functions were called in the - incorrect sequence or an earlier call was unsuccessful. In this case, the value of the data property - is null. - -
 
Error — If the file cannot be opened or read, or if a similar error is encountered in - accessing the file, an exception is thrown with a message indicating a file I/O error. In this case, the value - of the data property is null. -
-

-See also -

-
-FileReference.browse() -
-FileReference.load() -
-
- - - - - -
extensionproperty 
-
-extension:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The filename extension. -

A file's extension is the part of the name following (and not including) the final dot ("."). - If there is no dot in the filename, the extension is null.

-

Note: You should use the extension property to determine a file's type; do not use the - creator or type properties. You should consider the creator and type - properties to be considered deprecated. They apply to older versions of Mac OS.

- - Implementation -
-    public function get extension():String -
-
-Throws -
- - - - -
Error — If the reference is not initialized. - -
-
- - - - - -
modificationDateproperty 
-
-modificationDate:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The date that the file on the local disk was last modified. If the FileReference - object was not populated, a call to get the value of this property returns null. -

Implementation -
-    public function get modificationDate():Date -
-
-Throws -
- - - - - - - - - - -
Error — If the FileReference.browse(), - FileReferenceList.browse(), or FileReference.download() method was not called - successfully, an exception is thrown with a message indicating that functions were called in the - incorrect sequence or an earlier call was unsuccessful. In this case, - the value of the modificationDate property is null. - -
 
Error — If the file information cannot be accessed, an exception is thrown with a message - indicating a file I/O error. -
-

-See also -

-
-FileReference.browse() -
-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The name of the file on the local disk. If the FileReference object - was not populated (by a valid call to FileReference.download() or - FileReference.browse()), Flash Player throws an error when you try to get the - value of this property. -

All the properties of a FileReference object are populated by calling the browse() method. - Unlike other FileReference properties, if you call the download() method, - the name property is populated when the select event is dispatched.

- - Implementation -
-    public function get name():String -
-
-Throws -
- - - - -
Error — If the FileReference.browse(), - FileReferenceList.browse(), or FileReference.download() method was not called - successfully, an exception is thrown with a message indicating that functions were called in the - incorrect sequence or an earlier call was unsuccessful. - -
-

-See also -

-
-FileReference.browse() -
-
- - - - - -
permissionStatusproperty 
-
-permissionStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Determine whether the application has been granted the permission to access filesystem. -

Implementation -
-    public static function get permissionStatus():String -
-

-See also -

-
-flash.permissions.PermissionStatus -
-
- - - - - -
sizeproperty 
-
-size:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The size of the file on the local disk in bytes. - -

Note: In the initial version of ActionScript 3.0, the size property was - defined as a uint object, which supported files with sizes up to about 4 GB. It is now implemented as a Number - object to support larger files.

-

Implementation -
-    public function get size():Number -
-
-Throws -
- - - - - - - - - - -
Error — If the FileReference.browse(), - FileReferenceList.browse(), or FileReference.download() method was not called - successfully, an exception is thrown with a message indicating that functions were called in the - incorrect sequence or an earlier call was unsuccessful. - -
 
Error — If the file cannot be opened or read, or if a similar error is encountered in - accessing the file, an exception is thrown with a message indicating a file I/O error. -
-

-See also -

-
-FileReference.browse() -
-
- - - - - -
typeproperty 
-
-type:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The file type. - -

In Windows or Linux, this property is the file extension. On the Macintosh, this property is - the four-character file type, which is only used in Mac OS versions prior to Mac OS X. If the FileReference object - was not populated, a call to get the value of this property returns null.

- -

For Windows, Linux, and Mac OS X, the file extension — the portion of the name property that - follows the last occurrence of the dot (.) character — identifies the file type.

- - Implementation -
-    public function get type():String -
-
-Throws -
- - - - -
Error — If the FileReference.browse(), - FileReferenceList.browse(), or FileReference.download() method was not called - successfully, an exception is thrown with a message indicating that functions were called in the - incorrect sequence or an earlier call was unsuccessful. In this case, the value of the type property - is null. -
-

-See also -

-
-FileReference.extension -
-
- -
Constructor detail
- - - - - -
FileReference()constructor
-
-public function FileReference() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new FileReference object. When populated, a FileReference object represents a file - on the user's local disk. - -

-See also -

-
-FileReference.browse() -
-
- -
Method detail
- - - - - -
browse()method
-
-public function browse(typeFilter:Array = null):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Displays a file-browsing dialog box that lets the - user select a file to upload. The dialog box is native to the user's - operating system. The user can select a file on the local computer - or from other systems, for example, through a UNC path on Windows. -

Note: The File class, available in Adobe AIR, includes methods for - accessing more specific system file selection dialog boxes. These methods are - File.browseForDirectory(), File.browseForOpen(), - File.browseForOpenMultiple(), and File.browseForSave().

-

When you call this method and the user - successfully selects a file, the properties of this FileReference object are populated with - the properties of that file. Each subsequent time that the FileReference.browse() method - is called, the FileReference - object's properties are reset to the file that the user selects in the dialog box. - Only one browse() or download() session - can be performed at a time (because only one dialog box can be invoked at a time).

-

Using the typeFilter parameter, you can determine which files the dialog box displays.

- -

In Flash Player 10 and Flash Player 9 Update 5, you can only call this method successfully in response - to a user event (for example, in an event handler for a mouse click or keypress event). Otherwise, calling - this method results in Flash Player throwing an Error exception.

- -

Note that because of new functionality added to the Flash Player, when publishing to Flash Player 10, you can have - only one of the following operations active at one time: FileReference.browse(), - FileReference.upload(), FileReference.download(), FileReference.load(), - FileReference.save(). Otherwise, Flash Player throws a runtime error (code 2174). Use FileReference.cancel() - to stop an operation in progress. This restriction applies only to Flash Player 10. Previous versions of Flash Player - are unaffected by this restriction on simultaneous multiple operations.

- -

In Adobe AIR, the file-browsing dialog is not always displayed in front of windows that are - "owned" by another window (windows that have a non-null owner property). - To avoid window ordering issues, hide owned windows before calling this method.

- - Parameters - - - - -
typeFilter:Array (default = null) — An array of FileFilter instances used to filter the files that are - displayed in the dialog box. If you omit this parameter, - all files are displayed. - For more information, see the FileFilter class. - -
-

-Returns - - - - -
Boolean — - Returns true if the parameters are valid and the file-browsing dialog box - opens. - - -
-
-Events - - - - - - - - - - -
select:Event — Dispatched when the user successfully selects an item from the Browse file chooser.
 
cancel:Event — Dispatched when the user cancels the file upload Browse window.
-
-Throws - - - - - - - - - - - - - - - - -
Error — Thrown in the following situations: - 1) Another FileReference or FileReferenceList browse session is in - progress; only one file browsing session may be performed at a time. - 2) A setting in the user's mms.cfg file prohibits this operation. -
 
ArgumentError — If the typeFilter array contains - FileFilter objects that are incorrectly formatted, an exception is thrown. - For information on the correct format for FileFilter objects, - see the FileFilter class. -
 
Error — If the method is not called in response to a user action, such as a mouse - event or keypress event. - -
-

-See also -

-
-select event -
-cancel event -
-FileReference.download() -
-FileReferenceList.browse() -
File.browseForDirectory()
File.browseForOpen()
File.browseForOpenMultiple()
File.browseForSave()
-
- - - - - -
cancel()method 
-
-public function cancel():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Cancels any ongoing upload or download operation on this FileReference object. - Calling this method does not dispatch the cancel event; that event - is dispatched only when the user cancels the operation by dismissing the - file upload or download dialog box. -

- - - - - -
download()method 
-
-public function download(request:URLRequest, defaultFileName:String = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Opens a dialog box that lets the user download a file from a remote server. - Although Flash Player has no restriction on the size of files you can upload or download, - the player officially supports uploads or downloads of up to 100 MB. - -

The download() method first opens - an operating-system dialog box that asks the user to enter a filename and - select a location on the local computer - to save the file. When the user selects a location and confirms the download operation - (for example, by clicking Save), the download from the remote server begins. - Listeners receive events to indicate the progress, success, or - failure of the download. - To ascertain the status of the dialog box and the download operation after calling - download(), your code must listen for events - such as cancel, open, - progress, and complete. -

-

The FileReference.upload() and FileReference.download() functions - are nonblocking. These functions return after they are called, before the file transmission - is complete. In addition, if the FileReference object goes out of scope, any upload or download - that is not yet completed on that object is canceled upon leaving the scope. - Be sure that your FileReference object remains in scope for as long as the - upload or download is expected to continue.

-

When the file is downloaded successfully, the - properties of the FileReference object are populated with the properties - of the local file. The complete event is dispatched if the - download is successful.

-

Only one browse() or download() session can - be performed at a time (because only one dialog box can be invoked at a time).

-

This method supports downloading of any file type, with either HTTP or HTTPS.

-

You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.

-

Note: If your server requires user authentication, only - SWF files running in a browser — that is, using the browser plug-in or ActiveX control — - can provide a dialog box to prompt the user for a user name and password for authentication, - and only for downloads. For uploads using the plug-in or ActiveX control, or for - uploads and downloads using the stand-alone or external player, the file transfer fails.

- -

When you use this method in content in security sandboxes other - than the application security sandbox, consider the Flash Player - AIR security model:

- -
    -
  • Loading operations are not allowed if the calling SWF file is in an untrusted local sandbox.
    • - -
  • The default behavior is to deny access between sandboxes. A website can enable access to a - resource by adding a URL policy file.
    • - -
  • You can prevent a SWF file from using this method by setting the allowNetworking - parameter of the the object and embed tags in the HTML - page that contains the SWF content.
    • - -
  • In Flash Player 10 and Flash Player 9 Update 5, you can only call this method successfully in response - to a user event (for example, in an event handler for a mouse click or keypress event). Otherwise, calling - this method results in Flash Player throwing an Error exception.
    • - -
-

However, in Adobe AIR, - content in the application security sandbox (content - installed with the AIR application) is not restricted by these security limitations.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

When you download a file using this method, it is flagged as downloaded on operating systems - that flag downloaded files:

- -
    -
  • Windows XP service pack 2 and later, and on Windows Vista
    • -
  • Mac OS 10.5 and later
    • -
- -

Some operating systems, such as Linux, do not flag downloaded files.

- -

Note that because of new functionality added to the Flash Player, when publishing to Flash Player 10, you can have - only one of the following operations active at one time: FileReference.browse(), - FileReference.upload(), FileReference.download(), FileReference.load(), - FileReference.save(). Otherwise, Flash Player throws a runtime error (code 2174). Use FileReference.cancel() - to stop an operation in progress. This restriction applies only to Flash Player 10. Previous versions of Flash Player - are unaffected by this restriction on simultaneous multiple operations.

- -

In Adobe AIR, the download dialog is not always displayed in front of windows that are - "owned" by another window (windows that have a non-null owner property). - To avoid window ordering issues, hide owned windows before calling this method.

- - Parameters - - - - - - - - - - -
request:URLRequest — The URLRequest object. The url property of the URLRequest object - should contain the URL of the file to download to the local computer. - If this parameter is null, an exception is thrown. The requestHeaders property - of the URLRequest object is ignored; custom HTTP request headers are not supported in uploads or downloads. - To send POST or GET parameters to the server, set the value of URLRequest.data - to your parameters, and set URLRequest.method to either URLRequestMethod.POST - or URLRequestMethod.GET. -

On some browsers, URL strings are limited in length. Lengths greater than 256 characters may - fail on some browsers or servers.

-
 
defaultFileName:String (default = null) — The default filename displayed in the dialog box for the file - to be downloaded. This string must not contain the following characters: - / \ : * ? " < > | % -

If you omit this parameter, the filename of the - remote URL is parsed and used as the default.

-
-
-Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
open:Event — Dispatched when a download operation starts.
 
progress:ProgressEvent — Dispatched periodically during the file download operation.
 
complete:Event — Dispatched when the file download operation successfully completes.
 
cancel:Event — Dispatched when the user dismisses the dialog box.
 
select:Event — Dispatched when the user selects a file for download from the dialog box.
 
securityError:SecurityErrorEvent — Dispatched when a download fails because of a - security error.
 
ioError:IOErrorEvent — Dispatched for any of the following reasons: -
    -
  • An input/output error occurs while the file is being read or transmitted.
    • -
  • SWF content running in the stand-alone or external versions of Flash Player tries to download a - file from a server that requires authentication. During download, the standalone and external players - do not provide a means for users to enter passwords. If a SWF file in these players tries to download - a file from a server that requires authentication, the download fails. - File download can succeed only in the ActiveX control and browser plug-in players.
    • -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Error — Thrown in the following situations: 1) Another browse session is in - progress; only one file browsing session can be performed at a time. - 2) The value passed to request does not contain - a valid path or protocol. - 3) The filename to download contains prohibited characters. - 4) A setting in the user's mms.cfg file prohibits this operation. - -
 
SecurityError — Local untrusted content may not communicate with the Internet. To avoid this situation, reclassify this - SWF file as local-with-networking or trusted. This exception is thrown with a message indicating the filename - and the URL that may not be accessed because of local file security restrictions. -
 
SecurityError — You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide. -
 
ArgumentError — If url.data is of type ByteArray, an exception is - thrown. For use with the FileReference.upload() and - FileReference.download() methods, url.data can only be of type - URLVariables or String. -
 
Error — This error can occur for the following reasons: - 1) Flash Player cannot convert the URLRequest.data - parameter from UTF8 to MBCS. This error is applicable if the URLRequest object - passed to the FileReference.download() method is set to perform a GET operation and if - System.useCodePage is set to true. - 2) Flash Player cannot allocate memory for the POST data. This error is - applicable if the URLRequest object passed to the FileReference.download() method is set - to perform a POST operation. -
 
Error — If the method is not called in response to a user action, such as a mouse - event or keypress event. - -
-

-See also -

-
-File.downloaded -
-FileReference.browse() -
-FileReferenceList.browse() -
-FileReference.upload() -
-FileReference.save() -
-
-Example -
The following example shows usage of the download event object. - To run this example, change the downloadURL.url property to point to an actual domain and file, - rather than the fictional http://www.[yourDomain].com/SomeFile.pdf. - You might also need to compile the SWF file with Local playback security set to Access network only - or to update Flash Player security settings to allow this file network access. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.FileReference;
-    import flash.net.URLRequest;
-    import flash.net.FileFilter;
-
-    public class FileReference_download extends Sprite {
-        private var downloadURL:URLRequest;
-        private var fileName:String = "SomeFile.pdf";
-        private var file:FileReference;
-
-        public function FileReference_download() {
-            downloadURL = new URLRequest();
-            downloadURL.url = "http://www.[yourDomain].com/SomeFile.pdf";
-            file = new FileReference();
-            configureListeners(file);
-            file.download(downloadURL, fileName);
-        }
-
-        private function configureListeners(dispatcher:IEventDispatcher):void {
-            dispatcher.addEventListener(Event.CANCEL, cancelHandler);
-            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            dispatcher.addEventListener(Event.OPEN, openHandler);
-            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            dispatcher.addEventListener(Event.SELECT, selectHandler);
-        }
-
-        private function cancelHandler(event:Event):void {
-            trace("cancelHandler: " + event);
-        }
-
-        private function completeHandler(event:Event):void {
-            trace("completeHandler: " + 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 {
-            var file:FileReference = FileReference(event.target);
-            trace("progressHandler name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-
-        private function selectHandler(event:Event):void {
-            var file:FileReference = FileReference(event.target);
-            trace("selectHandler: name=" + file.name + " URL=" + downloadURL.url);
-        }
-    }
-}
-
-

-
- - - - - -
load()method 
-
-public function load():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Starts the load of a local file selected by a user. - Although Flash Player has no restriction on the size of files you can upload, - download, load or save, it officially supports sizes of up to 100 MB. For content running in Flash Player, - you must call the FileReference.browse() or FileReferenceList.browse() method before - you call the load() method. However, content running in AIR in the application sandbox can call - the load() method of a File object without first calling the browse() method. - (The AIR File class extends the FileReference class.) - -

Listeners receive events to indicate the progress, success, or - failure of the load. Although you can use the FileReferenceList object to let users - select multiple files to load, you must load the files one by one. To load the files - one by one, iterate through the FileReferenceList.fileList array of FileReference objects.

-

Adobe AIR also includes the FileStream class which provides more options for - reading files.

-

The FileReference.upload(), FileReference.download(), FileReference.load() - and FileReference.save() functions - are nonblocking. These functions return after they are called, before the file transmission - is complete. In addition, if the FileReference object goes out of scope, any transaction - that is not yet completed on that object is canceled upon leaving the scope. - Be sure that your FileReference object remains in scope for as long as the - upload, download, load or save is expected to continue.

-

If the file finishes loading successfully, its contents are stored as a byte array - in the data property of the FileReference object.

-

The following security considerations apply:

-
    -
  • Loading operations are not allowed if the calling SWF file is in an untrusted local sandbox.
    • -
  • The default behavior is to deny access between sandboxes. A website can enable access to a - resource by adding a cross-domain policy file.
    • -
  • You can prevent a file from using this method by setting the allowNetworking - parameter of the the object and embed tags in the HTML - page that contains the SWF content.
    • -
- -

However, these considerations do not apply to AIR content in the application sandbox.

-

Note that when publishing to Flash Player 10 or AIR 1.5, you can have only one of the following operations active at one time: - FileReference.browse(), FileReference.upload(), FileReference.download(), FileReference.load(), - FileReference.save(). Otherwise, the application throws a runtime error (code 2174). Use FileReference.cancel() - to stop an operation in progress. This restriction applies only to Flash Player 10 and AIR 1.5. Previous versions of Flash Player - or AIR are unaffected by this restriction on simultaneous multiple operations.

- -

In Adobe AIR, the file-browsing dialog is not always displayed in front of windows that are - "owned" by another window (windows that have a non-null owner property). - To avoid window ordering issues, hide owned windows before calling this method.

- -
-Events - - - - - - - - - - - - - - - - - - - - - - -
open:Event — Dispatched when an load operation starts.
 
progress:ProgressEvent — Dispatched periodically during the file load operation.
 
complete:Event — Dispatched when the file load operation completes successfully.
 
ioError:IOErrorEvent — Invoked if the load fails because of an input/output error while the application - is reading or writing the file.
-
-Throws - - - - - - - - - - -
Error — Thrown in the following situations: 1) Another FileReference or - FileReferenceList browse session is in progress; only one file browsing session may be performed - at a time. - 2) A setting in the user's mms.cfg file prohibits this operation. -
 
Error — This error can occur if the application cannot allocate memory for the file. - The file may be too large or available memory may be too low. -
-

-See also -

-
-FileReference.browse() -
-FileReferenceList.browse() -
-FileReference.data -
-FileReferenceList.fileList -
-FileReference.save() -
-FileStream -
-
-Example -
The following example uploads an image from your local file system to the root display object (in this case, the stage). - Example provided by Andre Venancio. - -
-
-var buttonShape:Shape = new Shape();
-buttonShape.graphics.beginFill(0x336699);
-buttonShape.graphics.drawCircle(50, 50, 25);
-var button = new SimpleButton(buttonShape, buttonShape, buttonShape, buttonShape);
-addChild(button);
-
-var fileRef:FileReference= new FileReference();
-button.addEventListener(MouseEvent.CLICK, onButtonClick);
-
-function onButtonClick(e:MouseEvent):void {
-fileRef.browse([new FileFilter("Images", "*.jpg;*.gif;*.png")]);
-fileRef.addEventListener(Event.SELECT, onFileSelected);
-}
-
-function onFileSelected(e:Event):void {
-fileRef.addEventListener(Event.COMPLETE, onFileLoaded);
-fileRef.load();
-}
-
-function onFileLoaded(e:Event):void {
-var loader:Loader = new Loader();
-loader.loadBytes(e.target.data);
-addChild(loader);
-}
-
-

-
- - - - - -
requestPermission()method 
-
-public function requestPermission():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Requests permission to access filesystem. - -


-Events - - - - -
PermissionStatus:PermissionEvent — dispatched when the requested permission is granted/denied by the user.
-
- - - - - -
save()method 
-
-public function save(data:*, defaultFileName:String = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Opens a dialog box that lets the user save a file to the local filesystem. - Although Flash Player has no restriction on - the size of files you can upload, download, load or save, - the player officially supports sizes of up to 100 MB. - -

The save() method first opens - an operating-system dialog box that asks the user to enter a filename and - select a location on the local computer - to save the file. When the user selects a location and confirms the save operation - (for example, by clicking Save), the save process begins. - Listeners receive events to indicate the progress, success, or - failure of the save operation. - To ascertain the status of the dialog box and the save operation after calling - save(), your code must listen for events - such as cancel, open, - progress, and complete. -

-

Adobe AIR also includes the FileStream class which provides more options for - saving files locally.

-

The FileReference.upload(), FileReference.download(), FileReference.load() - and FileReference.save() functions - are nonblocking. These functions return after they are called, before the file transmission - is complete. In addition, if the FileReference object goes out of scope, any transaction - that is not yet completed on that object is canceled upon leaving the scope. - Be sure that your FileReference object remains in scope for as long as the - upload, download, load or save is expected to continue.

-

When the file is saved successfully, the - properties of the FileReference object are populated with the properties - of the local file. The complete event is dispatched if the - save is successful.

-

Only one browse() or save() session can - be performed at a time (because only one dialog box can be invoked at a time).

-

In Flash Player, you can only call this method successfully in response to - a user event (for example, in an event handler for a mouse click or keypress event). Otherwise, calling - this method results in Flash Player throwing an Error exception. This limitation does not apply to - AIR content in the application sandbox.

- -

In Adobe AIR, the save dialog is not always displayed in front of windows that are - "owned" by another window (windows that have a non-null owner property). - To avoid window ordering issues, hide owned windows before calling this method.

- - Parameters - - - - - - - - - - -
data:* — The data to be saved. The data can be in one of several formats, and will be treated - appropriately: -
    -
  • If the value is null, the application throws an ArgumentError exception.
    • -
  • If the value is a String, it is saved as a UTF-8 text file.
    • -
  • If the value is XML, it is written to a text file in XML format, with all formatting preserved.
    • -
  • If the value is a ByteArray object, it is written to a data file verbatim.
    • -
  • If the value is none of the above, the save() method calls the toString() method of the - object to convert the data to a string, and it then saves the data as a text file. If that fails, the application throws - an ArgumentError exception.
    • -
-
 
defaultFileName:String (default = null) — The default filename displayed in the dialog box for the file - to be saved. This string must not contain the following characters: - / \ : * ? " < > | % -

In Flash Player, if you omit this parameter, the filename will be blank by default. - If a File object calls this method, the filename will be that of the file the File object references. (The AIR File class - extends the FileReference class.)

-
-
-Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
open:Event — Dispatched when a download operation starts.
 
progress:ProgressEvent — Dispatched periodically during the file download operation.
 
complete:Event — Dispatched when the file download operation successfully completes.
 
cancel:Event — Dispatched when the user dismisses the dialog box.
 
select:Event — Dispatched when the user selects a file for download from the dialog box.
 
ioError:IOErrorEvent — Dispatched if an input/output error occurs while the file is being read or transmitted.
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
Error — Thrown in the following situations: 1) Another browse session is in - progress; only one file browsing session can be performed at a time. - 2) The filename to download contains prohibited characters. - 3) A setting in the user's mms.cfg file prohibits this operation. - -
 
ArgumentError — If data is not of type ByteArray, and it does not - have a toString() method, an exception is thrown. If data is - not of type XML, and it does not have a toXMLString() method, an exception is thrown. -
 
Error — If the method is not called in response to a user action, such as a mouse - event or keypress event. - -
 
Error — This error can occur if Flash Player cannot allocate memory for the file. - The file may be too large or available memory may be too low. -
-

-See also -

-
-FileReferenceList.browse() -
-FileReference.load() -
-FileReference.data -
-FileReference.upload() -
-FileReference.download() -
-FileStream -
-
-Example -
The following example saves the content typed into a text field to a file. - The example creates an editable text field (MyTextField) - and another text field that is not editable (MyButtonField)to serve as a "button" - to respond to a mouse click. A user can edit the first text field and click the button - to save the text field contents to a local file. The mouse click event handler clickhandler - uses the FileReference.save() method (for a FileReference object named MyFileReference) - to open a dialog on the user's current operating system so the user can save the contents to a local file with the - name the user provides. -
-
-var MyTextField:TextField = new TextField();
-var MyButtonField:TextField = new TextField();
-var MyFile:FileReference = new FileReference();
-
-MyTextField.border = true;
-MyTextField.type = TextFieldType.INPUT;
-
-MyButtonField.background = true;
-MyButtonField.backgroundColor = 0x339933;
-MyButtonField.x = 150;
-MyButtonField.height = 20;
-MyButtonField.text = "Click here to save";
-
-addChild(MyTextField);
-addChild(MyButtonField);
-MyButtonField.addEventListener(MouseEvent.CLICK, clickhandler);
-
-function clickhandler(e:MouseEvent): void {
-    MyFile.save(MyTextField.text);
-}
-
-

-
- - - - - -
upload()method 
-
-public function upload(request:URLRequest, uploadDataFieldName:String = "Filedata", testUpload:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Starts the upload of the file to a remote server. Although - Flash Player has no restriction on the size of files you can upload or download, - the player officially supports uploads or downloads of up to 100 MB. - You must call the FileReference.browse() or FileReferenceList.browse() - method before you call this method. -

For the Adobe AIR File class, which extends the FileReference class, you can use the upload() - method to upload any file. For the FileReference class (used in Flash Player), the user must first - select a file.

- -

Listeners receive events to indicate the progress, success, or - failure of the upload. Although you can use the FileReferenceList object to let users - select multiple files for upload, you must upload the files one by one; to do so, iterate through - the FileReferenceList.fileList array of FileReference objects.

-

The FileReference.upload() and FileReference.download() functions - are nonblocking. These functions return after they are called, before the file transmission - is complete. In addition, if the FileReference object goes out of scope, any upload or download - that is not yet completed on that object is canceled upon leaving the scope. - Be sure that your FileReference object remains in scope for as long as the - upload or download is expected to continue.

-

The file is uploaded to the URL passed in the url parameter. The URL - must be a server script configured to accept uploads. Flash Player uploads files by using - the HTTP POST method. The server script that handles the upload - should expect a POST request with the following elements:

-
    -
  • Content-Type of multipart/form-data
    • -
  • Content-Disposition with a name attribute set to "Filedata" by default - and a filename attribute set to the name of the original file
    • -
  • The binary contents of the file
- -

You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.

-

For a sample POST request, see the description of the uploadDataFieldName - parameter. You can send POST or GET parameters to the server with the upload() - method; see the description of the request parameter.

-

If the testUpload parameter is true, - and the file to be uploaded is bigger than approximately 10 KB, Flash Player on Windows - first sends a test upload POST operation with zero content before uploading the actual file, - to verify that the transmission is likely to succeed. Flash Player then sends - a second POST operation that contains the actual file content. - For files smaller than 10 KB, Flash Player performs a single - upload POST with the actual file content to be uploaded. - Flash Player on Macintosh does not perform test upload POST operations.

-

Note: If your server requires user authentication, only - SWF files running in a browser — that is, using the browser plug-in or ActiveX control — - can provide a dialog box to prompt the user for a username and password for authentication, - and only for downloads. For uploads using the plug-in or ActiveX control, or for - uploads and downloads using the stand-alone or external player, the file transfer fails.

- -

When you use this method in content in security sandboxes other - than the application security sandbox, consider the Flash Player - AIR security model:

- - -
    -
  • Loading operations are not allowed if the calling SWF file is in an untrusted local sandbox.
    • -
  • The default behavior is to deny access between sandboxes. A website can enable access to a - resource by adding a URL policy file.
    • -
  • You can prevent a SWF file from using this method by setting the allowNetworking - parameter of the the object and embed tags in the HTML - page that contains the SWF content.
    • -
- -

However, in Adobe AIR, content in the application security sandbox (content - installed with the AIR application) are not restricted by these security limitations.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

Note that because of new functionality added to the Flash Player, when publishing to Flash Player 10, you can have - only one of the following operations active at one time: FileReference.browse(), - FileReference.upload(), FileReference.download(), FileReference.load(), - FileReference.save(). Otherwise, Flash Player throws a runtime error (code 2174). Use FileReference.cancel() - to stop an operation in progress. This restriction applies only to Flash Player 10. Previous versions of Flash Player - are unaffected by this restriction on simultaneous multiple operations.

- - Parameters - - - - - - - - - - - - - - - - -
request:URLRequest — The URLRequest object; the url property of the URLRequest object - should contain the URL of the server script - configured to handle upload through HTTP POST calls. - On some browsers, URL strings are limited in length. - Lengths greater than 256 characters may fail on some browsers or servers. - If this parameter is null, an exception is thrown. The requestHeaders property - of the URLRequest object is ignored; custom HTTP request headers are not supported in uploads or downloads. - -

The URL can be HTTP or, for secure uploads, HTTPS. - To use HTTPS, use an HTTPS url in the url parameter. - If you do not specify a port number in the url - parameter, port 80 is used for HTTP and port 443 us used for HTTPS, by default.

-

To send POST or GET parameters to the server, set the data property - of the URLRequest object to your parameters, and set the method property - to either URLRequestMethod.POST or - URLRequestMethod.GET.

-
 
uploadDataFieldName:String (default = "Filedata") — The field name that precedes the file data in the upload POST operation. - The uploadDataFieldName value must be non-null and a non-empty String. - By default, the value of uploadDataFieldName is "Filedata", - as shown in the following sample POST request: - 
-    Content-Type: multipart/form-data; boundary=AaB03x
-    --AaB03x 
-    Content-Disposition: form-data; name="Filedata"; filename="example.jpg" 
-    Content-Type: application/octet-stream
-    ... contents of example.jpg ... 
-    --AaB03x-- 
-
-
 
testUpload:Boolean (default = false) — A setting to request a test file upload. If testUpload - is true, for files larger than 10 KB, Flash Player attempts - a test file upload POST with a Content-Length of 0. The test upload - checks whether the actual file upload will be successful and that server - authentication, if required, will succeed. A test upload - is only available for Windows players. -
-
-Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
open:Event — Dispatched when an upload operation starts.
 
progress:ProgressEvent — Dispatched periodically during the file upload operation.
 
complete:Event — Dispatched when the file upload operation completes successfully.
 
uploadCompleteData:DataEvent — Dispatched when data has been received from the server after a successful file upload.
 
securityError:SecurityErrorEvent — Dispatched when an upload fails because of a - security violation.
 
httpStatus:HTTPStatusEvent — Dispatched when an upload fails because of an HTTP error.
 
httpResponseStatus:HTTPStatusEvent — The upload operation completes successfully and the server - returns a response URL and response headers.
 
ioError:IOErrorEvent — Invoked in any of the following situations: -
    -
  • The upload fails because of an input/output error while Flash - Player or Adobe AIR is reading, writing, or transmitting the file.
    • -
  • The upload fails because an attempt to upload a file to a server that requires - authentication (such as a user name and password). During upload, no mean is provided - for users to enter passwords.
    • -
  • The upload fails because the url parameter contains an invalid protocol. - FileReference.upload() must use HTTP or HTTPS.
    • -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
SecurityError — Local untrusted SWF files may not communicate with - the Internet. To avoid this situation, reclassify this SWF file - as local-with-networking or trusted. This exception is thrown with a message indicating the name of - the local file and the URL that may not be accessed. - -
 
SecurityError — You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide. -
 
Error — Thrown in the following situations: 1) Another FileReference or - FileReferenceList browse session is in progress; only one file browsing session may be performed - at a time. - 2) The URL parameter is not a valid path or protocol. File upload must use HTTP, - and file download must use FTP or HTTP. - 3) The uploadDataFieldName parameter is set to null. - 4) A setting in the user's mms.cfg file prohibits this operation. -
 
ArgumentError — Thrown in the following situations: 1) The uploadDataFieldName - parameter is an empty string. 2) url.data is of type ByteArray. - For use with the FileReference.upload() and - FileReference.download() methods, url.data may only be of type - URLVariables or String. 3) In the AIR runtime (in the application security sandbox), the method of the - URLRequest is not GET or POST (use uploadEncoded() instead). -
 
Error — This error can occur for the following reasons: - 1) Flash Player cannot convert the URLRequest.data - parameter from UTF8 to MBCS. This error is applicable if the URLRequest object - passed to FileReference.upload() is set to perform a GET operation and if - System.useCodePage is set to true. - 2) Flash Player cannot allocate memory for the POST data. This error is - applicable if the URLRequest object passed to FileReference.upload() is set - to perform a POST operation. -
-

-See also -

-
-FileReference.browse() -
-FileReferenceList.browse() -
-FileReference.download() -
-FileReferenceList.fileList -
-FileReference.load() -
-
- - - - - -
uploadUnencoded()method 
-
-public function uploadUnencoded(request:URLRequest):void -

- - - - -
Runtime version: AIR 1.0 -
-

- Initiate uploading a file to a URL without any encoding. Whereas the upload() method encodes - the file in a form-data envelope, the uploadUnencoded() method passes the file contents as-is - in the HTTP request body. Use the uploadUnencoded() method if the data you wish to send is already encoded - in a format that the receiving server can understand.You typically use the uploadeUnencoded() - method with the HTTP/WebDAV PUT method. - -

Parameters - - - - -
request:URLRequest — The URLRequest object; the url property of the URLRequest object - should contain the URL of the server script - configured to handle upload through HTTP POST calls. - On some browsers, URL strings are limited in length. - Lengths greater than 256 characters may fail on some browsers or servers. - If this parameter is null, an exception is thrown. - -

The URL can be HTTP or, for secure uploads, HTTPS. - To use HTTPS, use an HTTPS url in the url parameter. - If you do not specify a port number in the url - parameter, port 80 is used for HTTP and port 443 us used for HTTPS, by default.

-

To send POST or GET parameters to the server, set the data property - of the URLRequest object to your parameters, and set the method property - to either URLRequestMethod.POST or - URLRequestMethod.GET.

-
-
-Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
open:Event — Dispatched when an upload operation starts.
 
progress:ProgressEvent — Dispatched periodically during the file upload operation.
 
complete:Event — Dispatched when the file upload operation completes successfully.
 
uploadCompleteData:DataEvent — Dispatched when data has been received from the server after a - successful file upload.
 
securityError:SecurityErrorEvent — Dispatched when an upload fails because of a - security violation.
 
httpStatus:HTTPStatusEvent — Dispatched when an upload fails because of an HTTP error.
 
httpResponseStatus:HTTPStatusEvent — The upload operation completes successfully and the server - returns a response URL and response headers.
 
ioError:IOErrorEvent — Invoked in any of the following situations: -
    -
  • The upload fails because of an input/output error while Adobe AIR is reading, - writing, or transmitting the file.
    • -
  • The upload fails because an attempt to upload a file to a server that requires - authentication (such as a user name and password). During upload, no mean is provided - for users to enter passwords.
    • -
  • The upload fails because the url parameter contains an invalid protocol. - FileReference.upload() must use HTTP or HTTPS.
    • -
-
-Throws - - - - - - - - - - -
SecurityError — Local untrusted SWF files may not communicate with - the Internet. To avoid this situation, reclassify this SWF file - as local-with-networking or trusted. This exception is thrown with a message indicating the name of - the local file and the URL that may not be accessed. - -
 
Error — Thrown in the following situations: 1) Another FileReference or FileReferenceList - browse session is in progress; only one file browsing session may be performed at a time. 2) The URL parameter - is not a valid path or protocol. File upload must use HTTP. - -
-

-See also -

-
-FileReference.browse() -
-FileReferenceList.browse() -
-FileReference.download() -
-FileReferenceList.fileList -
-upload() -
-
-
Event detail
- - - - - -
cancelevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CANCEL -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when a file upload or download is canceled through the file-browsing dialog - box by the user. Flash Player does not dispatch this event if the user cancels an upload - or download through other means (closing the browser or stopping the current - application). - -

- The Event.CANCEL constant defines the value of the type property of a cancel event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetA reference to the object on which the operation is canceled.
-
-Example -
The following example shows usage of the cancel event object. - To run this example, change the downloadURL.url property to point to an actual domain and file, - rather than the fictional http://www.[yourDomain].com/SomeFile.pdf. - You might also need to compile the SWF file with Local playback security set to Access network only - or to update Flash Player security settings to allow this file network access. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.FileReference;
-    import flash.net.URLRequest;
-
-    public class FileReference_event_cancel extends Sprite {
-        private var downloadURL:URLRequest;
-        private var fileName:String = "SomeFile.pdf";
-        private var file:FileReference;
-
-        public function FileReference_event_cancel() {
-            downloadURL = new URLRequest();
-            downloadURL.url = "http://www.[yourDomain].com/SomeFile.pdf";
-            file = new FileReference();
-            file.addEventListener(Event.CANCEL, cancelHandler);
-            file.download(downloadURL, fileName);
-        }
-        private function cancelHandler(event:Event):void {
-            trace("cancelHandler: " + event);
-        }
-    }
-}
-
-

-
- - - - - -
completeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when download is complete or when upload generates an HTTP status code of 200. - For file download, this event is dispatched when Flash Player or - Adobe AIR finishes downloading the entire file to disk. - For file upload, this event is dispatched after the - Flash Player or Adobe AIR - receives an HTTP status code of 200 from the server receiving - the transmission. - -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
-Example -
The following example shows usage of the complete event object. - To run this example, change the downloadURL.url property to point to an actual domain and file, - rather than the fictional http://www.[yourDomain].com/SomeFile.pdf. - You might also need to compile the SWF file with Local playback security set to Access network only - or to update Flash Player security settings to allow this file network access. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.FileReference;
-    import flash.net.URLRequest;
-
-    public class FileReference_event_complete extends Sprite {
-        private var downloadURL:URLRequest;
-        private var fileName:String = "SomeFile.pdf";
-        private var file:FileReference;
-
-        public function FileReference_event_complete() {
-            downloadURL = new URLRequest();
-            downloadURL.url = "http://www.[yourDomain].com/SomeFile.pdf";
-            file = new FileReference();
-            configureListeners(file);
-            file.download(downloadURL, fileName);
-        }
-
-        private function configureListeners(dispatcher:IEventDispatcher):void {
-            dispatcher.addEventListener(Event.CANCEL, cancelHandler);
-            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            dispatcher.addEventListener(Event.OPEN, openHandler);
-            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            dispatcher.addEventListener(Event.SELECT, selectHandler);
-        }
-
-        private function cancelHandler(event:Event):void {
-            trace("cancelHandler: " + event);
-        }
-
-        private function completeHandler(event:Event):void {
-            trace("completeHandler: " + 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 {
-            var file:FileReference = FileReference(event.target);
-            trace("progressHandler name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-
-        private function selectHandler(event:Event):void {
-            var file:FileReference = FileReference(event.target);
-            trace("selectHandler: name=" + file.name + " URL=" + downloadURL.url);
-        }
-    }
-}
-
-

-

-See also -

-
-FileReference.download() -
-FileReference.upload() -
-
- - - - - -
httpResponseStatusevent  
-
-Event object type: flash.events.HTTPStatusEvent -
-HTTPStatusEvent.type property = flash.events.HTTPStatusEvent.HTTP_RESPONSE_STATUS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -AIR 1.0 -
-

- Dispatched if a call to the upload() or uploadUnencoded() - method attempts to access data over HTTP and Adobe AIR is able to detect and return - the status code for the request. - -

- Unlike the httpStatus event, the httpResponseStatus event is - delivered before any response data. Also, the httpResponseStatus event includes - values for the responseHeaders and responseURL properties (which are - undefined for an httpStatus event. Note that the httpResponseStatus event - (if any) will be sent before (and in addition to) any complete or error - event. - -

The HTTPStatusEvent.HTTP_RESPONSE_STATUS constant defines the value of the - type property of a httpResponseStatus event object.

- - -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
responseURLThe URL from which the response was returned.
responseHeadersThe response headers that the response returned, - as an array of URLRequestHeader objects.
statusThe HTTP status code returned by the server.
redirectedWhether the reponse is the result of a redierct.
targetThe network object receiving an HTTP status code.
- -

-See also -

-
-upload() -
-uploadUnencoded() -
-
- - - - - -
httpStatusevent  
-
-Event object type: flash.events.HTTPStatusEvent -
-HTTPStatusEvent.type property = flash.events.HTTPStatusEvent.HTTP_STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when an upload fails and an HTTP status code is available - to describe the failure. The httpStatus event - is dispatched, followed by an ioError event. - -

The httpStatus event is dispatched only for upload failures. - For content running in Flash Player this event is not applicable for download failures. - If a download fails because of an HTTP error, the error is reported as an I/O error.

-

- The HTTPStatusEvent.HTTP_STATUS constant defines the value of the - type property of a httpStatus event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
statusThe HTTP status code returned by the server.
targetThe network object receiving an HTTP status code.
- -

-See also -

-
-FileReference.upload() -
-
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when the upload or download fails. A file transfer can fail for one of the following reasons: - -

    -
  • An input/output error occurs while the player is reading, writing, or transmitting the file.
    • -
  • The SWF fileAIR application - tries to upload a file to a server that requires authentication - (such as a user name and password). During upload, Flash Player or - Adobe AIR does not provide a means for users to enter passwords. If a SWF file - an AIR application tries to upload a file to a server that - requires authentication, the upload fails.
    • -
  • The SWF fileAIR application - tries to download a file from a server that requires authentication, - within the stand-alone or external player. During download, the stand-alone and external players - do not provide a means for users to enter passwords. If a SWF file - an AIR application in these players tries to download - a file from a server that requires authentication, the download fails. - File download can succeed only in the ActiveX control, browser plug-in - players, and the Adobe AIR runtime.
    • -
  • The value passed to the url parameter in the upload() method contains an - invalid protocol. Valid protocols are HTTP and HTTPS.
    • -
- -

Important: Only applications running - in a browser — that is, using the browser plug-in or ActiveX control — and - content running in Adobe AIR can provide a dialog box to prompt - the user to enter a user name and password for authentication, and then only for downloads. - For uploads using the plug-in or ActiveX control version of Flash Player, or for upload or - download using either the stand-alone or the external player, the file transfer fails.

- -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -

-See also -

-
-FileReference.download() -
-FileReference.upload() -
-
- - - - - -
openevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.OPEN -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when an upload or download operation starts. - - -

- The Event.OPEN constant defines the value of the type property of an open event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has opened a connection.
- -
-Example -
The following example shows usage of the download event object. - To run this example, change the downloadURL.url property to point to an actual domain and file, - rather than the fictional http://www.[yourDomain].com/SomeFile.pdf. - You might also need to compile the SWF file with Local playback security set to Access network only - or to update Flash Player security settings to allow this file network access. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.FileReference;
-    import flash.net.URLRequest;
-    import flash.net.FileFilter;
-
-    public class FileReference_download extends Sprite {
-        private var downloadURL:URLRequest;
-        private var fileName:String = "SomeFile.pdf";
-        private var file:FileReference;
-
-        public function FileReference_download() {
-            downloadURL = new URLRequest();
-            downloadURL.url = "http://www.[yourDomain].com/SomeFile.pdf";
-            file = new FileReference();
-            configureListeners(file);
-            file.download(downloadURL, fileName);
-        }
-
-        private function configureListeners(dispatcher:IEventDispatcher):void {
-            dispatcher.addEventListener(Event.CANCEL, cancelHandler);
-            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            dispatcher.addEventListener(Event.OPEN, openHandler);
-            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            dispatcher.addEventListener(Event.SELECT, selectHandler);
-        }
-
-        private function cancelHandler(event:Event):void {
-            trace("cancelHandler: " + event);
-        }
-
-        private function completeHandler(event:Event):void {
-            trace("completeHandler: " + 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 {
-            var file:FileReference = FileReference(event.target);
-            trace("progressHandler name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-
-        private function selectHandler(event:Event):void {
-            var file:FileReference = FileReference(event.target);
-            trace("selectHandler: name=" + file.name + " URL=" + downloadURL.url);
-        }
-    }
-}
-
-

-

-See also -

-
-FileReference.download() -
-FileReference.upload() -
-
- - - - - -
permissionStatusevent  
-
-Event object type: flash.events.PermissionEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Dispatched when the application requests permission to access filesystem. - Check the value of status property to determine whether - the permission was granted or denied -

-See also -

-
-FileReference.requestPermission() -
-flash.permissions.PermissionStatus -
-
- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched periodically during the file upload or download operation. - The progress event is dispatched while Flash Player - transmits bytes to a server, and it is periodically dispatched during the - transmission, even if the transmission is ultimately not successful. - To determine if and when the file transmission is actually successful - and complete, listen for the complete event. - -

In some cases, progress events are not received. For example, - when the file being transmitted is very small or the upload or download - happens very quickly a progress event might not be dispatched.

- -

File upload progress cannot be determined on Macintosh platforms earlier than OS X 10.3. - The progress event is called during the upload operation, but the value of the - bytesLoaded property of the progress event is -1, - indicating that the progress cannot be determined.

- -

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -
-Example -
The following example shows usage of the progress event. - To run this example, change the downloadURL.url property to point to an actual domain and file, - rather than the fictional http://www.[yourDomain].com/SomeFile.pdf. - You might also need to compile the SWF file with Local playback security set to Access network only - or to update Flash Player security settings to allow this file network access. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.FileReference;
-    import flash.net.URLRequest;
-
-    public class FileReference_event_progress extends Sprite {
-        private var downloadURL:URLRequest;
-        private var fileName:String = "SomeFile.pdf";
-        private var file:FileReference;
-
-        public function FileReference_event_progress() {
-            downloadURL = new URLRequest();
-            downloadURL.url = "http://www.[yourDomain].com/SomeFile.pdf";
-            file = new FileReference();
-            file.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            file.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            file.addEventListener(Event.COMPLETE, completeHandler);
-            file.download(downloadURL, fileName);
-        }
-
-        private function progressHandler(event:ProgressEvent):void {
-            var file:FileReference = FileReference(event.target);
-            trace("progressHandler: name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
-        }
-        
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("ioErrorHandler: " + event);
-        }
-        
-        private function completeHandler(event:Event):void {
-            trace("completeHandler: " + event);
-        }
-    }
-}
-
-

-

-See also -

-
-FileReference.complete -
-flash.events.ProgressEvent -
-FileReference.download() -
-FileReference.upload() -
-
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a call to the FileReference.upload() - or FileReference.download() method tries to upload a file to a server or - get a file from a server that is outside the caller's security sandbox. The value of - the text property that describes the specific error that occurred - is normally "securitySandboxError". - The calling SWF file may have tried to access a SWF file - outside its domain and does not have permission to do so. You can - try to remedy this error by using a URL policy file. - -

In Adobe AIR, these security restrictions do not apply - to content in the application security sandbox.

- -

In Adobe AIR, these security restrictions do not apply - to content in the application security sandbox.

- -

- The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- -

-See also -

-
-FileReference.download() -
-FileReference.upload() -
-
- - - - - -
selectevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.SELECT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when the user selects a file for upload or download from the file-browsing dialog box. - (This dialog box opens when you call the FileReference.browse(), - FileReferenceList.browse(), - or FileReference.download() method.) - When the user selects a file and confirms the operation (for example, by clicking OK), - the properties of the FileReference object are populated. - -

For content running in Flash Player or outside of the - application security sandbox in the Adobe AIR runtime, - the select event acts slightly differently depending on what - method invokes it. When the select event is dispatched after a browse() call, - Flash Player or the AIR application can read all the - FileReference object's properties, because the file selected by the user is on the local - file system. When the select event occurs after a download() call, - Flash Player or the AIR application can read only - the name property, because the file hasn't yet been downloaded to the local file system - at the moment the select event is dispatched. When the file is downloaded and the - complete event dispatched, Flash Player or - the AIR application can read all other properties of the FileReference object.

- -

- The Event.SELECT constant defines the value of the type property of a select event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object on which an item has been selected.
- -
-Example -
The following example shows usage of the select event object. - To run this example, change the uploadURL.url property to point to an actual domain and file, - rather than the fictional http://www.[yourDomain].com/SomeFile.pdf. - You might also need to compile the SWF file with Local playback security set to Access network only - or to update Flash Player security settings to allow this file network access. - In order for this example to run from your desktop, your server also needs to have a crossdomain.xml - file posted. - If the ioErrorHandler() function is triggered, you probably need to update the provided uploadURL with - a valid url that is configured to receive uploads. -
-
- 
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.FileReference;
-    import flash.net.URLRequest;
-
-    public class FileReference_event_select extends Sprite {
-        private var uploadURL:URLRequest;
-        private var file:FileReference;
-
-        public function FileReference_event_select() {
-            uploadURL = new URLRequest();
-            uploadURL.url = "http://www.[yourDomain].com/yourUploadHandlerScript.cfm";
-            file = new FileReference();
-            file.addEventListener(Event.SELECT, selectHandler);
-            file.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            file.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            file.addEventListener(Event.COMPLETE, completeHandler);
-            file.browse();
-        }
-
-        private function selectHandler(event:Event):void {
-            var file:FileReference = FileReference(event.target);
-            trace("selectHandler: name=" + file.name + " URL=" + uploadURL.url);
-            file.upload(uploadURL);
-        }
-
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("ioErrorHandler: " + event);
-        }
-
-        private function progressHandler(event:ProgressEvent):void {
-            var file:FileReference = FileReference(event.target);
-            trace("progressHandler: name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
-        }
-
-        private function completeHandler(event:Event):void {
-            trace("completeHandler: " + event);
-        }
-    }
-}
-
-

-
- - - - - -
uploadCompleteDataevent  
-
-Event object type: flash.events.DataEvent -
-DataEvent.type property = flash.events.DataEvent.UPLOAD_COMPLETE_DATA -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched after data is received from the server after a successful upload. - This event is not dispatched if data is not returned from the server. -

- Defines the value of the type property of an uploadCompleteData event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe raw data returned from the server after a successful file upload.
targetThe FileReference object receiving data after a successful upload.
- -
- -
Examples
-
examples\FileReferenceExample
-
The following example displays the - data format and status information for a file loaded at runtime. - -

Note: - To run this example, change the uploadURL.url property to point to an actual URL, - rather than the fictional one in the example. The URL should point to a file named - yourUploadHandlerScript.cfm in the root web directory of the URL specified. - Based on your configuration, you might also need to compile the SWF file with Local Playback Security set to Access Network Only - or to update Flash Player security settings to allow this file network access. -

-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.FileFilter;
-    import flash.net.FileReference;
-    import flash.net.URLRequest;
-
-    public class FileReferenceExample extends Sprite {
-        private var uploadURL:URLRequest;
-        private var file:FileReference;
-
-        public function FileReferenceExample() {
-            uploadURL = new URLRequest();
-            uploadURL.url = "http://www.[yourDomain].com/yourUploadHandlerScript.cfm";
-            file = new FileReference();
-            configureListeners(file);
-            file.browse(getTypes());
-        }
-
-        private function configureListeners(dispatcher:IEventDispatcher):void {
-            dispatcher.addEventListener(Event.CANCEL, cancelHandler);
-            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-            dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
-            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            dispatcher.addEventListener(Event.OPEN, openHandler);
-            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            dispatcher.addEventListener(Event.SELECT, selectHandler);
-            dispatcher.addEventListener(DataEvent.UPLOAD_COMPLETE_DATA,uploadCompleteDataHandler);
-        }
-
-        private function getTypes():Array {
-            var allTypes:Array = new Array(getImageTypeFilter(), getTextTypeFilter());
-            return allTypes;
-        }
-
-        private function getImageTypeFilter():FileFilter {
-            return new FileFilter("Images (*.jpg, *.jpeg, *.gif, *.png)", "*.jpg;*.jpeg;*.gif;*.png");
-        }
-
-        private function getTextTypeFilter():FileFilter {
-            return new FileFilter("Text Files (*.txt, *.rtf)", "*.txt;*.rtf");
-        }
-
-        private function cancelHandler(event:Event):void {
-            trace("cancelHandler: " + event);
-        }
-
-        private function completeHandler(event:Event):void {
-            trace("completeHandler: " + event);
-        }
-
-		private function uploadCompleteDataHandler(event:DataEvent):void {
-			trace("uploadCompleteData: " + event);
-		}
-
-        private function httpStatusHandler(event:HTTPStatusEvent):void {
-            trace("httpStatusHandler: " + 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 {
-            var file:FileReference = FileReference(event.target);
-            trace("progressHandler name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-
-        private function selectHandler(event:Event):void {
-            var file:FileReference = FileReference(event.target);
-            trace("selectHandler: name=" + file.name + " URL=" + uploadURL.url);
-            file.upload(uploadURL);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/FileReferenceList.html b/html-docs/flash/net/FileReferenceList.html deleted file mode 100644 index f01093b..0000000 --- a/html-docs/flash/net/FileReferenceList.html +++ /dev/null @@ -1,803 +0,0 @@ - - - - - - - - -flash.net.FileReferenceList (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class FileReferenceList
InheritanceFileReferenceList Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The FileReferenceList class provides a means to let users select one or more files for uploading. - A FileReferenceList object represents a group of one or more local files on the user's disk as - an array of FileReference objects. For detailed information and important considerations about - FileReference objects and the FileReference class, which you use with FileReferenceList, - see the FileReference class. -

To work with the FileReferenceList class:

-
    -
  • Instantiate the class: var myFileRef = new FileReferenceList();
    • -
  • Call the FileReferenceList.browse() method, which opens a dialog box that - lets the user select one or more files for upload: myFileRef.browse();
    • -
  • After the browse() method is called successfully, the fileList property of - the FileReferenceList object is populated with an array of FileReference objects.
    • -
  • Call FileReference.upload() on each element in the - fileList array.
    • -
-

The FileReferenceList class includes a browse() method and a - fileList property for working with multiple files. While a call to FileReferenceList.browse() - is executing, SWF file playback pauses in stand-alone and external versions of Flash Player - and in AIR for Linux and Mac OS X 10.1 and earlier.

-

-

-View the examples. -

-

-See also -

-
-FileReference -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fileList : Array -
[read-only] - An array of FileReference objects.
-		FileReferenceList
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-FileReferenceList()
-
- Creates a new FileReferenceList object.
-		FileReferenceList
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-browse(typeFilter:Array = null):Boolean -
-
- Displays a file-browsing dialog box that lets the - user select one or more local files to upload.
-		FileReferenceList
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-cancel -
-		 - Dispatched when the user dismisses the file-browsing dialog box.FileReferenceList
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-select -
-		 - Dispatched when the user selects one or more files to upload from the file-browsing dialog box.FileReferenceList
-
- -
- -
Property detail
- - - - - -
fileListproperty
-
-fileList:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of FileReference objects. -

When the FileReferenceList.browse() method is called and the user - has selected one or more files from the dialog box that the browse() method opens, - this property is populated with an array of FileReference objects, - each of which represents the files the user selected. - You can then use this array to upload each file with the FileReference.upload()method. - You must upload one file at a time.

-

The fileList property is populated anew each time browse() is called on - that FileReferenceList object.

-

The properties of FileReference objects are described - in the FileReference class documentation.

- Implementation -
-    public function get fileList():Array -
-

-See also -

-
-FileReference -
-FileReference.upload() -
-FileReferenceList.browse() -
-
- -
Constructor detail
- - - - - -
FileReferenceList()constructor
-
-public function FileReferenceList() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new FileReferenceList object. A FileReferenceList object contains nothing - until you call the browse() method on it and the user selects one or more files. - When you call browse() on the - FileReference object, the fileList property of the object is populated - with an array of FileReference objects. -

-See also -

-
-FileReference -
-FileReferenceList.browse() -
-
- -
Method detail
- - - - - -
browse()method
-
-public function browse(typeFilter:Array = null):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Displays a file-browsing dialog box that lets the - user select one or more local files to upload. The dialog box is native to the user's - operating system. -

In Flash Player 10 and later, you can call this method successfully - only in response to a user event (for example, in an event handler for a mouse click or keypress event). - Otherwise, calling this method results in Flash Player throwing an Error.

- -

When you call this method and the user successfully selects files, - the fileList property of this FileReferenceList object is populated with - an array of FileReference objects, one for each file that the user selects. - Each subsequent time that the FileReferenceList.browse() method is called, the - FileReferenceList.fileList property is reset to the file(s) that the - user selects in the dialog box.

-

Using the typeFilter parameter, you can determine which files - the dialog box displays.

-

Only one FileReference.browse(), FileReference.download(), - or FileReferenceList.browse() session can be performed at a time - on a FileReferenceList object - (because only one dialog box can be opened at a time).

- Parameters - - - - -
typeFilter:Array (default = null) — An array of FileFilter instances used to filter the files that are - displayed in the dialog box. If you omit this parameter, all files are displayed. - For more information, see the FileFilter class. -
-

-Returns - - - - -
Boolean — - Returns true if the parameters are valid and the file-browsing dialog box - opens. - - -
-
-Events - - - - - - - - - - -
select:Event — Invoked when the user has successfully selected an item for upload from the dialog box.
 
cancel:Event — Invoked when the user dismisses the dialog box by clicking Cancel or by closing it.
-
-Throws - - - - - - - - - - - - - - - - -
Error — Thrown for the following reasons: 1) Another FileReference - or FileReferenceList browse session is in progress; only one file browsing session - may be performed at a time. 2) A setting in the user's mms.cfg file prohibits this operation. -
 
ArgumentError — If the typeFilter array does not contain correctly formatted - FileFilter objects, an exception is thrown. For details on correct filter formatting, - see the FileFilter documentation. -
 
Error — If the method is not called in response to a user action, such as a mouse - event or keypress event. - -
-

-See also -

-
-FileReference.browse() -
-FileReference class -
-FileFilter class -
-
-
Event detail
- - - - - -
cancelevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CANCEL -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when the user dismisses the file-browsing dialog box. - (This dialog box opens - when you call the FileReferenceList.browse(), - FileReference.browse(), or FileReference.download() methods.) -

- The Event.CANCEL constant defines the value of the type property of a cancel event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetA reference to the object on which the operation is canceled.
-

-See also -

-
-FileReferenceList.browse() -
-
- - - - - -
selectevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.SELECT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when the user selects one or more files to upload from the file-browsing dialog box. - (This dialog box opens - when you call the FileReferenceList.browse(), - FileReference.browse(), or FileReference.download() methods.) - When the user selects a file and confirms the operation (for example, by clicking Save), - the FileReferenceList object is populated with FileReference objects - that represent the files that the user selects. -

- The Event.SELECT constant defines the value of the type property of a select event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object on which an item has been selected.
- -

-See also -

-
-FileReferenceList.browse() -
-
- -
Examples
-
examples\FileReferenceListExample
-
The following example shows how you can use events to manage the upload of multiple files. - The CustomFileReferenceList class extends FileReferenceList and includes a complete event, - which is dispatched - when each individual file in the FileReferenceList object is uploaded. The LIST_COMPLETE - event in the FileReferenceListExample class is dispatched when all the files in the FileReferenceList - object have been uploaded. - -

To run this example, place a script that is written to accept - a file upload at http://www.[yourDomain].com/yourUploadHandlerScript.cfm. - Based on the location of your SWF file and where you are uploading files to, you - also might need to compile the SWF file with Local Playback Security set to Access Network Only - or update Flash® Player security settings to allow this file network access. - If your upload server is remote and you run this example from your desktop computer, - your server must have a crossdomain.xml file.

- -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.FileReference;
-    import flash.net.FileReferenceList;
- 
-    public class FileReferenceListExample extends Sprite {
-        public static var LIST_COMPLETE:String = "listComplete";
-        public function FileReferenceListExample() {
-            initiateFileUpload();
-        }
-
-        private function initiateFileUpload():void {
-            var fileRef:CustomFileReferenceList = new CustomFileReferenceList();
-            fileRef.addEventListener(FileReferenceListExample.LIST_COMPLETE, listCompleteHandler);
-            fileRef.browse(fileRef.getTypes());
-        }
-
-        private function listCompleteHandler(event:Event):void {
-            trace("listCompleteHandler");
-        }
-    }
-}
- 
-import flash.events.*;
-import flash.net.FileReference;
-import flash.net.FileReferenceList;
-import flash.net.FileFilter;
-import flash.net.URLRequest;
- 
-class CustomFileReferenceList extends FileReferenceList {
-    private var uploadURL:URLRequest;
-    private var pendingFiles:Array;
-
-    public function CustomFileReferenceList() {
-        uploadURL = new URLRequest();
-        uploadURL.url = "http://www.[yourDomain].com/yourUploadHandlerScript.cfm";
-        initializeListListeners();
-    }
-
-    private function initializeListListeners():void {
-        addEventListener(Event.SELECT, selectHandler);
-        addEventListener(Event.CANCEL, cancelHandler);
-    }
-
-    public function getTypes():Array {
-        var allTypes:Array = new Array();
-        allTypes.push(getImageTypeFilter());
-        allTypes.push(getTextTypeFilter());
-        return allTypes;
-    }
- 
-    private function getImageTypeFilter():FileFilter {
-        return new FileFilter("Images (*.jpg, *.jpeg, *.gif, *.png)", "*.jpg;*.jpeg;*.gif;*.png");
-    }
- 
-    private function getTextTypeFilter():FileFilter {
-        return new FileFilter("Text Files (*.txt, *.rtf)", "*.txt;*.rtf");
-    }
- 
-    private function doOnComplete():void {
-        var event:Event = new Event(FileReferenceListExample.LIST_COMPLETE);
-        dispatchEvent(event);
-    }
- 
-    private function addPendingFile(file:FileReference):void {
-        trace("addPendingFile: name=" + file.name);
-        pendingFiles.push(file);
-        file.addEventListener(Event.OPEN, openHandler);
-        file.addEventListener(Event.COMPLETE, completeHandler);
-        file.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-        file.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-        file.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-        file.upload(uploadURL);
-    }
- 
-    private function removePendingFile(file:FileReference):void {
-        for (var i:uint; i < pendingFiles.length; i++) {
-            if (pendingFiles[i].name == file.name) {
-                pendingFiles.splice(i, 1);
-                if (pendingFiles.length == 0) {
-                    doOnComplete();
-                }
-                return;
-            }
-        }
-    }
- 
-    private function selectHandler(event:Event):void {
-        trace("selectHandler: " + fileList.length + " files");
-        pendingFiles = new Array();
-        var file:FileReference;
-        for (var i:uint = 0; i < fileList.length; i++) {
-            file = FileReference(fileList[i]);
-            addPendingFile(file);
-        }
-    }
- 
-    private function cancelHandler(event:Event):void {
-        var file:FileReference = FileReference(event.target);
-        trace("cancelHandler: name=" + file.name);
-    }
- 
-    private function openHandler(event:Event):void {
-        var file:FileReference = FileReference(event.target);
-        trace("openHandler: name=" + file.name);
-    }
- 
-    private function progressHandler(event:ProgressEvent):void {
-        var file:FileReference = FileReference(event.target);
-        trace("progressHandler: name=" + file.name + " bytesLoaded=" + event.bytesLoaded + " bytesTotal=" + event.bytesTotal);
-    }
- 
-    private function completeHandler(event:Event):void {
-        var file:FileReference = FileReference(event.target);
-        trace("completeHandler: name=" + file.name);
-        removePendingFile(file);
-    }
- 
-    private function httpErrorHandler(event:Event):void {
-        var file:FileReference = FileReference(event.target);
-        trace("httpErrorHandler: name=" + file.name);
-    }
- 
-    private function ioErrorHandler(event:Event):void {
-        var file:FileReference = FileReference(event.target);
-        trace("ioErrorHandler: name=" + file.name);
-    }
- 
-    private function securityErrorHandler(event:Event):void {
-        var file:FileReference = FileReference(event.target);
-        trace("securityErrorHandler: name=" + file.name + " event=" + event.toString());
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/GroupSpecifier.html b/html-docs/flash/net/GroupSpecifier.html deleted file mode 100644 index f1a7a40..0000000 --- a/html-docs/flash/net/GroupSpecifier.html +++ /dev/null @@ -1,1387 +0,0 @@ - - - - - - - - -flash.net.GroupSpecifier (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class GroupSpecifier
InheritanceGroupSpecifier Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The GroupSpecifier class is used to construct the opaque groupspec strings - that can be passed to NetStream and NetGroup constructors. - A groupspec specifies an RTMFP Peer-to-Peer Group, including - the capabilities, restrictions, and authorizations of the member using the groupspec. -

By default, all capabilities are disabled, and peer-to-peer connections are allowed.

-

-

-See also -

-
-flash.net.NetGroup -
-flash.net.NetStream -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  ipMulticastMemberUpdatesEnabled : Boolean -
- Specifies whether information about group membership can be exchanged on IP multicast - sockets.
-		GroupSpecifier
  maxSupportedGroupspecVersion : int -
[static][read-only] - Specifies the maximum groupspec version supported by - this runtime.
-		GroupSpecifier
  minGroupspecVersion : int -
- Specifies the minimum version number the generated groupspec - will have.
-		GroupSpecifier
  multicastEnabled : Boolean -
- Specifies whether streaming is enabled for the NetGroup.
-		GroupSpecifier
  objectReplicationEnabled : Boolean -
- Specifies whether object replication is enabled for the NetGroup.
-		GroupSpecifier
  peerToPeerDisabled : Boolean -
- Specifies whether peer-to-peer connections are disabled for the NetGroup or NetStream.
-		GroupSpecifier
  postingEnabled : Boolean -
- Specifies whether posting is enabled for the NetGroup.
-		GroupSpecifier
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  routingEnabled : Boolean -
- Specifies whether directed routing methods are enabled for the NetGroup.
-		GroupSpecifier
  serverChannelEnabled : Boolean -
- Specifies whether members of the NetGroup can open a channel to the server.
-		GroupSpecifier
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GroupSpecifier(name:String)
-
- Creates a new GroupSpecifier object.
-		GroupSpecifier
   -
-addBootstrapPeer(peerID:String):void -
-
- Causes the associated NetStream or NetGroup to make an initial neighbor connection to the - specified peerID.
-		GroupSpecifier
   -
-addIPMulticastAddress(address:String, port:* = null, source:String = null):void -
-
- Causes the associated NetStream or NetGroup to join the specified IP multicast group and listen - to the specified UDP port.
-		GroupSpecifier
   -
-authorizations():String -
-
- Returns a string that represents passwords for IP multicast publishing and for posting.
-		GroupSpecifier
   -
-encodeBootstrapPeerIDSpec(peerID:String):String -
-
[static] - Encodes and returns a string that represents a bootstrap peerID.
-		GroupSpecifier
   -
-encodeIPMulticastAddressSpec(address:String, port:* = null, source:String = null):String -
-
[static] - Encodes and returns a string that represents an IP multicast socket address.
-		GroupSpecifier
   -
-encodePostingAuthorization(password:String):String -
-
[static] - Encodes and returns a string that represents a posting password.
-		GroupSpecifier
   -
-encodePublishAuthorization(password:String):String -
-
[static] - Encodes and returns a string that represents a multicast publishing password.
-		GroupSpecifier
   -
-groupspecWithAuthorizations():String -
-
- Returns the opaque groupspec string, including authorizations, that can be passed to NetStream and NetGroup constructors.
-		GroupSpecifier
   -
-groupspecWithoutAuthorizations():String -
-
- Returns the opaque groupspec string, without authorizations, that can be passed to NetStream and NetGroup constructors.
-		GroupSpecifier
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-makeUnique():void -
-
- Adds a strong pseudorandom tag to the groupspec to make it unique.
-		GroupSpecifier
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-setPostingPassword(password:String = null, salt:String = null):void -
-
- Specifies whether a password is required to post in the NetGroup.
-		GroupSpecifier
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setPublishPassword(password:String = null, salt:String = null):void -
-
- Specifies whether a password is required to publish a multicast stream in the NetStream.
-		GroupSpecifier
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Identical to the groupspecWithAuthorizations() method.
-		GroupSpecifier
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
ipMulticastMemberUpdatesEnabledproperty
-
-ipMulticastMemberUpdatesEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether information about group membership can be exchanged on IP multicast - sockets. IP multicast servers may send group membership updates to help bootstrap P2P meshes - or heal partitions. Peers may send membership updates on the LAN to help bootstrap LAN P2P - meshes and to inform on-LAN neighbors in global meshes that other on-LAN neighbors exist. - These updates can improve P2P performance. -

Implementation -
-    public function get ipMulticastMemberUpdatesEnabled():Boolean -
-    public function set ipMulticastMemberUpdatesEnabled(value:Boolean):void -
-

-See also -

-
-addIPMulticastAddress() -
-peerToPeerDisabled -
-
- - - - - -
maxSupportedGroupspecVersionproperty 
-
-maxSupportedGroupspecVersion:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Specifies the maximum groupspec version supported by - this runtime. A groupspec having a version greater than this - will fail in this runtime. -

Implementation -
-    public static function get maxSupportedGroupspecVersion():int -
-

-See also -

-
-minGroupspecVersion -
-
- - - - - -
minGroupspecVersionproperty 
-
-minGroupspecVersion:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Specifies the minimum version number the generated groupspec - will have. The groupspec version number may be higher than this - value if an option requiring a higher version number is enabled. A - groupspec having a version number lower than the minimum - supported will fail. -

Implementation -
-    public function get minGroupspecVersion():int -
-    public function set minGroupspecVersion(value:int):void -
-

-See also -

-
-maxSupportedGroupspecVersion -
-
- - - - - -
multicastEnabledproperty 
-
-multicastEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether streaming is enabled for the NetGroup. Methods used for streaming - are NetStream.publish(), NetStream.play(), and NetStream.play2(). - By default, this property is FALSE (streaming is disabled). -

Implementation -
-    public function get multicastEnabled():Boolean -
-    public function set multicastEnabled(value:Boolean):void -
-

-See also -

-
-setPublishPassword() -
-flash.net.NetStream.play() -
-flash.net.NetStream.play2() -
-flash.net.NetStream.publish() -
-
- - - - - -
objectReplicationEnabledproperty 
-
-objectReplicationEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether object replication is enabled for the NetGroup. - By default, this property is FALSE (object replication is disabled). -

Implementation -
-    public function get objectReplicationEnabled():Boolean -
-    public function set objectReplicationEnabled(value:Boolean):void -
-

-See also -

-
-flash.net.NetGroup.addHaveObjects() -
-flash.net.NetGroup.addWantObjects() -
-flash.net.NetGroup.denyRequestedObject() -
-flash.net.NetGroup.removeHaveObjects() -
-flash.net.NetGroup.removeWantObjects() -
-flash.net.NetGroup.writeRequestedObject() -
-
- - - - - -
peerToPeerDisabledproperty 
-
-peerToPeerDisabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether peer-to-peer connections are disabled for the NetGroup or NetStream. - By default, this property is FALSE (P2P connections are enabled). -

If P2P connections are disabled (you set this property to TRUE), the P2P warning dialog is suppressed. - In this situation, no neighbor connections can be made, and no group members use upstream bandwidth. - Disabling P2P connections in this way is generally useful only when receiving multicast streams via pure IP multicast.

- Implementation -
-    public function get peerToPeerDisabled():Boolean -
-    public function set peerToPeerDisabled(value:Boolean):void -
-
- - - - - -
postingEnabledproperty 
-
-postingEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether posting is enabled for the NetGroup. - By default, this property is FALSE (posting is disabled). -

Implementation -
-    public function get postingEnabled():Boolean -
-    public function set postingEnabled(value:Boolean):void -
-

-See also -

-
-flash.net.NetGroup.post() -
-
- - - - - -
routingEnabledproperty 
-
-routingEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether directed routing methods are enabled for the NetGroup. - By default, this property is FALSE (directed routing methods are disabled). -

Implementation -
-    public function get routingEnabled():Boolean -
-    public function set routingEnabled(value:Boolean):void -
-

-See also -

-
-flash.net.NetGroup.sendToNearest() -
-
- - - - - -
serverChannelEnabledproperty 
-
-serverChannelEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether members of the NetGroup can open a channel to the server. - By default, this property is FALSE. -

A channel to the server must be opened before the - server can provide supporting functions to group members. Depending on server - configuration, supporting functions may or may not be provided over this channel.

- Implementation -
-    public function get serverChannelEnabled():Boolean -
-    public function set serverChannelEnabled(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
GroupSpecifier()constructor
-
-public function GroupSpecifier(name:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a new GroupSpecifier object. - By default, all capabilities are disabled, and peer-to-peer connections are allowed. -

Parameters - - - - -
name:String — A name for the Group on which all members must agree. -
-
-Throws - - - - -
ArgumentError — if name is empty or null. -
-

-See also -

-
-flash.net.NetGroup -
-flash.net.NetStream -
-
- -
Method detail
- - - - - -
addBootstrapPeer()method
-
-public function addBootstrapPeer(peerID:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Causes the associated NetStream or NetGroup to make an initial neighbor connection to the - specified peerID. -

Parameters - - - - -
peerID:String — The peerID to which an initial neighbor connection should be made to - bootstrap into the peer-to-peer mesh. -
-

-See also -

-
-encodeBootstrapPeerIDSpec() -
-flash.net.NetGroup.addMemberHint() -
-flash.net.NetGroup.addNeighbor() -
-
- - - - - -
addIPMulticastAddress()method 
-
-public function addIPMulticastAddress(address:String, port:* = null, source:String = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Causes the associated NetStream or NetGroup to join the specified IP multicast group and listen - to the specified UDP port. -

Parameters - - - - - - - - - - - - - - - - -
address:String — A String specifying the address of the IPv4 or IPv6 multicast group to join, optionally followed - by a colon (":") and the UDP port number. If specifying an IPv6 address and a port, - the IPv6 address must be enclosed in square brackets. Examples: "224.0.0.254", - "224.0.0.254:30000", "ff03::ffff", "[ff03::ffff]:30000". -
 
port:* (default = null) — The UDP port on which to receive IP multicast datagrams. If port is null, - the UDP port must be specified in address. If not null, the - UDP port must not be specified in address. -
 
source:String (default = null) — If not null, a String specifying the source IP address of a source-specific multicast (SSM). -
-

-See also -

-
-encodeIPMulticastAddressSpec() -
-ipMulticastMemberUpdatesEnabled -
-
- - - - - -
authorizations()method 
-
-public function authorizations():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a string that represents passwords for IP multicast publishing and for posting. - Append the string to an unauthorized groupspec to enable - features for which passwords have been set. -

-Returns - - - - -
String
-

-See also -

-
-encodePostingAuthorization() -
-encodePublishAuthorization() -
-groupspecWithAuthorizations() -
-groupspecWithoutAuthorizations() -
-setPostingPassword() -
-setPublishPassword() -
-
- - - - - -
encodeBootstrapPeerIDSpec()method 
-
-public static function encodeBootstrapPeerIDSpec(peerID:String):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Encodes and returns a string that represents a bootstrap peerID. If you append the string - to a groupspec, the associated NetStream or NetGroup makes an initial neighbor connection to the - specified peerID. -

Parameters - - - - -
peerID:String — The peerID to which an initial neighbor connection should be made to - bootstrap into the peer-to-peer mesh. -
-

-Returns - - - - -
String
-

-See also -

-
-addBootstrapPeer() -
-flash.net.NetGroup.addMemberHint() -
-flash.net.NetGroup.addNeighbor() -
-
- - - - - -
encodeIPMulticastAddressSpec()method 
-
-public static function encodeIPMulticastAddressSpec(address:String, port:* = null, source:String = null):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Encodes and returns a string that represents an IP multicast socket address. - If you append the string to a groupspec, the associated NetStream or NetGroup - joins the specified IP multicast group and listens to the specified UDP port. -

Parameters - - - - - - - - - - - - - - - - -
address:String — A String indicating the address of the IPv4 or IPv6 multicast group to join, optionally followed - by a colon (":") and the UDP port number. If specifying an IPv6 address and a port, - the IPv6 address must be enclosed in square brackets. Examples: "224.0.0.254", - "224.0.0.254:30000", "ff03::ffff", "[ff03::ffff]:30000". -
 
port:* (default = null) — The UDP port on which to receive IP multicast datagrams. If port is null, - the UDP port must be specified in address. If not null, the - UDP port must not be specified in address. -
 
source:String (default = null) — If not null, a String specifying the source IP address of a source-specific multicast (SSM). -
-

-Returns - - - - -
String
-

-See also -

-
-addIPMulticastAddress() -
-ipMulticastMemberUpdatesEnabled -
-
- - - - - -
encodePostingAuthorization()method 
-
-public static function encodePostingAuthorization(password:String):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Encodes and returns a string that represents a posting password. When posting is password-protected, - you can concatenate the string to a groupspec to enable posting. -

Parameters - - - - -
password:String — The password to encode, which must match the posting - password (if set) to enable NetGroup.post(). -
-

-Returns - - - - -
String
-

-See also -

-
-groupspecWithoutAuthorizations() -
-setPostingPassword() -
-flash.net.NetGroup.post() -
-
- - - - - -
encodePublishAuthorization()method 
-
-public static function encodePublishAuthorization(password:String):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Encodes and returns a string that represents a multicast publishing password. When multicast publishing is password-protected, - you can concatenate the string to a groupspec to enable publishing. -

Parameters - - - - -
password:String — The password to encode, which must match the publish - password (if set) to enable NetStream.publish(). -
-

-Returns - - - - -
String
-

-See also -

-
-groupspecWithoutAuthorizations() -
-setPublishPassword() -
-flash.net.NetStream.publish() -
-
- - - - - -
groupspecWithAuthorizations()method 
-
-public function groupspecWithAuthorizations():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns the opaque groupspec string, including authorizations, that can be passed to NetStream and NetGroup constructors. -

-Returns - - - - -
String
-

-See also -

-
-authorizations() -
-groupspecWithoutAuthorizations() -
-setPostingPassword() -
-setPublishPassword() -
-toString() -
-
- - - - - -
groupspecWithoutAuthorizations()method 
-
-public function groupspecWithoutAuthorizations():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns the opaque groupspec string, without authorizations, that can be passed to NetStream and NetGroup constructors. -

-Returns - - - - -
String
-

-See also -

-
-authorizations() -
-encodePostingAuthorization() -
-encodePublishAuthorization() -
-groupspecWithAuthorizations() -
-
- - - - - -
makeUnique()method 
-
-public function makeUnique():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Adds a strong pseudorandom tag to the groupspec to make it unique. The opaque groupspec string must then - be passed verbatim to other potential members of the Group if they are to successfully join. -

- - - - - -
setPostingPassword()method 
-
-public function setPostingPassword(password:String = null, salt:String = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether a password is required to post in the NetGroup. -

Parameters - - - - - - - - - - -
password:String (default = null) — The password that must be given to use NetGroup.post(). If null, - no password is required to post. -
 
salt:String (default = null) — Modifies the hash of the password to increase the difficulty of guessing it. - For best security, this parameter should be set to a random value. -
-

-See also -

-
-encodePostingAuthorization() -
-groupspecWithAuthorizations() -
-groupspecWithoutAuthorizations() -
-flash.net.NetGroup.post() -
-
- - - - - -
setPublishPassword()method 
-
-public function setPublishPassword(password:String = null, salt:String = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether a password is required to publish a multicast stream in the NetStream. -

Parameters - - - - - - - - - - -
password:String (default = null) — The password that must be given to use NetStream.publish(). If null, - no password is required to publish. -
 
salt:String (default = null) — Modifies the hash of the password to increase the difficulty of guessing it. - For best security, this parameter should be set to a random value. -
-

-See also -

-
-encodePublishAuthorization() -
-groupspecWithAuthorizations() -
-groupspecWithoutAuthorizations() -
-flash.net.NetStream.publish() -
-
- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Identical to the groupspecWithAuthorizations() method. - Convenience method to return the opaque groupspec string, including authorizations, - that can be passed to NetStream and NetGroup constructors. -

-Returns - - - - -
String
-

-See also -

-
-groupspecWithAuthorizations() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/IDynamicPropertyOutput.html b/html-docs/flash/net/IDynamicPropertyOutput.html deleted file mode 100644 index ed6c71e..0000000 --- a/html-docs/flash/net/IDynamicPropertyOutput.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - - - -flash.net.IDynamicPropertyOutput (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - -
Packageflash.net
Interfacepublic interface IDynamicPropertyOutput
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - This interface controls the serialization of dynamic properties of dynamic objects. - - You use this interface with the IDynamicPropertyWriter interface - - and the ObjectEncoding.dynamicPropertyWriter property. - - -

-

-See also -

-
-IDynamicPropertyWriter -
-ObjectEncoding.dynamicPropertyWriter -
-
-
-
- -
-
Public Methods
- - - - - - - -
 MethodDefined by
   -
-writeDynamicProperty(name:String, value:*):void -
-
- - Adds a dynamic property to the binary output of a serialized object.
-		IDynamicPropertyOutput
-
- -
- -
Method detail
- - - - - -
writeDynamicProperty()method
-
-public function writeDynamicProperty(name:String, value:*):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Adds a dynamic property to the binary output of a serialized object. - - When the object is subsequently read (using a method such as - - readObject), it contains the new property. - - You can use this method - - to exclude properties of dynamic objects from serialization; to write values - - to properties of dynamic objects; or to create new properties - - for dynamic objects. - - -

Parameters - - - - - - - - - - -
name:String — The name of the property. You can use this parameter either to specify - - the name of an existing property of the dynamic object or to create a - - new property. - - -
 
value:* — The value to write to the specified property. - - -
-

-See also -

-
-IDynamicPropertyWriter -
-ObjectEncoding.dynamicPropertyWriter -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/IDynamicPropertyWriter.html b/html-docs/flash/net/IDynamicPropertyWriter.html deleted file mode 100644 index 5918271..0000000 --- a/html-docs/flash/net/IDynamicPropertyWriter.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - - - -flash.net.IDynamicPropertyWriter (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - -
Packageflash.net
Interfacepublic interface IDynamicPropertyWriter
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - This interface is used with the IDynamicPropertyOutput interface to control - - the serialization of dynamic properties of dynamic objects. To use this interface, - - assign an object that implements the IDynamicPropertyWriter interface to - - the ObjectEncoding.dynamicPropertyWriter property. - - -

-

-See also -

-
-IDynamicPropertyOutput -
-ObjectEncoding.dynamicPropertyWriter -
-
-
-
- -
-
Public Methods
- - - - - - - -
 MethodDefined by
   -
-writeDynamicProperties(obj:Object, output:IDynamicPropertyOutput):void -
-
- - Writes the name and value of an IDynamicPropertyOutput object to an object with - - dynamic properties.
-		IDynamicPropertyWriter
-
- -
- -
Method detail
- - - - - -
writeDynamicProperties()method
-
-public function writeDynamicProperties(obj:Object, output:IDynamicPropertyOutput):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes the name and value of an IDynamicPropertyOutput object to an object with - - dynamic properties. If ObjectEncoding.dynamicPropertyWriter is set, - - this method is invoked for each object with dynamic properties. - - -

Parameters - - - - - - - - - - -
obj:Object — The object to write to. - -
 
output:IDynamicPropertyOutput — The IDynamicPropertyOutput object that contains the name and value - - to dynamically write to the object. - - -
-

-See also -

-
-IDynamicPropertyOutput -
-ObjectEncoding.dynamicPropertyWriter -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/IPVersion.html b/html-docs/flash/net/IPVersion.html deleted file mode 100644 index acd72f7..0000000 --- a/html-docs/flash/net/IPVersion.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - - - -flash.net.IPVersion (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class IPVersion
InheritanceIPVersion Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The IPVersion class defines constants representing the different families of IP addresses. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  IPV4 : String = "IPv4"
[static] - An Internet Protocol version 4 (IPv4) address.
-		IPVersion
  IPV6 : String = "IPv6"
[static] - An Internet Protocol version 6 (IPv6) address.
-		IPVersion
-
- -
- -
Constant detail
- - - - - -
IPV4constant
-
-public static const IPV4:String = "IPv4" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- An Internet Protocol version 4 (IPv4) address. - -

IPv4 addresses are expressed in ActionScript as a string in dot-decimal notation, such as: "192.0.2.0".

- -
- - - - - -
IPV6constant 
-
-public static const IPV6:String = "IPv6" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- An Internet Protocol version 6 (IPv6) address. - -

IPv6 addresses are expressed in ActionScript as a string in hexadecimal-colon notation and enclosed in - brackets, such as: "[2001:db8:ccc3:ffff:0:444d:555e:666f]".

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/InterfaceAddress.html b/html-docs/flash/net/InterfaceAddress.html deleted file mode 100644 index f14aad0..0000000 --- a/html-docs/flash/net/InterfaceAddress.html +++ /dev/null @@ -1,362 +0,0 @@ - - - - - - - - -flash.net.InterfaceAddress (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class InterfaceAddress
InheritanceInterfaceAddress Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The InterfaceAddress class reports the properties of a network interface address. -

-

-See also -

-
-NetworkInfo class -
-NetworkInterface class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  address : String -
- The Internet Protocol (IP) address.
-		InterfaceAddress
  broadcast : String -
- The broadcast address of the local network segment.
-		InterfaceAddress
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  ipVersion : String -
- The IP address type (IPv4 or IPv6).
-		InterfaceAddress
  prefixLength : int -
- The prefix length for this address.
-		InterfaceAddress
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
addressproperty
-
-address:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The Internet Protocol (IP) address. - -

Implementation -
-    public function get address():String -
-    public function set address(value:String):void -
-
- - - - - -
broadcastproperty 
-
-broadcast:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The broadcast address of the local network segment. - -

Implementation -
-    public function get broadcast():String -
-    public function set broadcast(value:String):void -
-
- - - - - -
ipVersionproperty 
-
-ipVersion:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The IP address type (IPv4 or IPv6). - -

Implementation -
-    public function get ipVersion():String -
-    public function set ipVersion(value:String):void -
-
- - - - - -
prefixLengthproperty 
-
-prefixLength:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The prefix length for this address. - -

For IPv4 addresses, this is the subnet mask. Examples of the prefix length for - IPv4 values include: 8 (255.0.0.0), 16 (255.255.0.0) and 24 (255.255.255.0). - Example IPv6 prefix length values include 128 (::1/128) and 32 (2001:db8::/32)

- -

Note: If the prefix length for this address is not available, the value of - prefixLength is -1. A prefix value is not always returned by - the network implementation of a specific client computer.

- - Implementation -
-    public function get prefixLength():int -
-    public function set prefixLength(value:int):void -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/LocalConnection.html b/html-docs/flash/net/LocalConnection.html deleted file mode 100644 index 6fb102b..0000000 --- a/html-docs/flash/net/LocalConnection.html +++ /dev/null @@ -1,1488 +0,0 @@ - - - - - - - - -flash.net.LocalConnection (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class LocalConnection
InheritanceLocalConnection Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The LocalConnection class lets you create a LocalConnection object that can invoke a method in another - LocalConnection object. The communication can be: -
    -
  • Within a single SWF file
    • -
  • Between multiple SWF files
    • -
  • Between content (SWF-based or HTML-based) in AIR applications
    • -
  • Between content (SWF-based or HTML-based) in an AIR application and SWF content running in a browser
    • -
-

AIR profile support: This feature is supported - on all desktop operating systems and on all AIR for TV devices, but is not supported on mobile devices. - You can test for support at run time using the LocalConnection.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

-

Note: AIR for TV devices support communication only between SWF-based content in AIR - applications.

- -

Local connections enable this kind of communication between SWF files without the use of fscommand() - or JavaScript. LocalConnection objects can communicate only among files that are running - on the same client computer, but they can be - running in different applications — for example, a file running in a browser - and a SWF file running in Adobe AIR.

-

LocalConnection objects created in ActionScript 3.0 can communicate with - LocalConnection objects created in ActionScript 1.0 or 2.0. The reverse is also true: - LocalConnection objects created in ActionScript 1.0 or 2.0 can communicate with LocalConnection - objects created in ActionScript 3.0. Flash Player handles this communication - between LocalConnection objects of different versions automatically.

-

There are three ways to add callback methods to a LocalConnection object:

-
    -
  • Subclass the LocalConnection class and add methods.
    • -
  • Set the LocalConnection.client property to an object that implements the methods.
    • -
  • Create a dynamic class that extends LocalConnection and dynamically attach methods.
    • -
-

To understand how to use LocalConnection objects to implement communication between two files, - it is helpful to identify the commands used in each file. One file is called the receiving file; - it is the file that contains the method to be invoked. The receiving file must contain a LocalConnection object - and a call to the connect() method. The other file is called the sending file; - it is the file that invokes the method. The sending file must contain another LocalConnection object - and a call to the send() method.

-

Your use of send() and connect() differs depending on whether the - files are in the same domain, in different domains with predictable domain names, - or in different domains with unpredictable or dynamic domain names. The following paragraphs - explain the three different situations, with code samples for each.

-

Same domain. This is the simplest way to use a LocalConnection object, - to allow communication only between LocalConnection objects that are located in the same domain, - because same-domain communication is permitted by default. When two files from the same domain communicate, - you do not need to implement any special security measures, and you simply pass the same - value for the connectionName parameter to both the connect() - and send() methods:

-

Loading from the same domain

- 
-// receivingLC is in http://www.domain.com/receiving.swf
-receivingLC.connect('myConnection');
-
-// sendingLC is in http://www.domain.com/sending.swf
-// myMethod() is defined in sending.swf
-sendingLC.send('myConnection', 'myMethod');
-
-

Different domains with predictable domain names. - When two SWF files from different domains communicate, - you need to allow communication between the two domains by calling the allowDomain() - method. You also need to qualify the connection name in the send() method - with the receiving LocalConnection object's domain name:

-

Loading from separate domains

- 
-// receivingLC is in http://www.domain.com/receiving.swf
-receivingLC.allowDomain('www.anotherdomain.com');
-receivingLC.connect('myConnection');
-
-// sendingLC is in http://www.anotherdomain.com/sending.swf
-sendingLC.send('www.domain.com:myConnection', 'myMethod');
-
-

Different domains with unpredictable domain names. - Sometimes, you might want to make the file with the receiving LocalConnection object - more portable between domains. To avoid specifying the domain name in the send() method, - but to indicate that the receiving and sending LocalConnection objects - are not in the same domain, precede the connection name - with an underscore (_), in both the connect() and send() calls. - To allow communication between the two domains, call the allowDomain() method - and pass the domains from which you want to allow LocalConnection calls. - Alternatively, pass the wildcard (*) argument to allow calls from all domains:

-

Loading from unknown domain names

-
-// receivingLC is in http://www.domain.com/receiving.swf
-receivingLC.allowDomain('*');
-receivingLC.connect('_myConnection');
-
-// sendingLC is in http://www.anotherdomain.com/sending.swf
-sendingLC.send('_myConnection', 'myMethod');
-
-

From Flash Player to an AIR application. - A LocalConnection object created in the AIR application sandbox uses a special string as it's connection - prefix instead of a domain name. This string has the form: - app#appID.pubID where appID is the application ID and pubID is the publisher ID of the application. - (Only include the publisher ID if the AIR application uses a publisher ID.) For example, if an - AIR application has an application ID of, "com.example", and no publisher ID, you could use: - app#com.example:myConnection as the local connection string. The AIR application also must call - the allowDomain() method, passing in the calling SWF file's domain of origin:

-

Flash Player to AIR connection

- 
-// receivingLC is an AIR application with app ID = com.example (and no publisher ID)
-receivingLC.allowDomain('www.domain.com');
-receivingLC.connect('myConnection');
-
-// sendingLC is in http://www.domain.com/sending.swf
-sendingLC.send('app#com.example:myConnection', 'myMethod');
-
-

Note: If an AIR application loads a SWF outside the AIR application sandbox, then the rules for - establishing a local connection with that SWF are the same as the rules for establishing a connection with a SWF - running in Flash Player.

- -

From an AIR application to Flash Player. - When an AIR application communicates with a SWF running in the Flash Player runtime, - you need to allow communication between the two by calling the allowDomain() - method and passing in the AIR application's connection prefix. For example, if an - AIR application has an application ID of, "com.example", and no publisher ID, you could pass the string: - app#com.example to the allowDomain() method. - You also need to qualify the connection name in the send() method - with the receiving LocalConnection object's domain name (use "localhost" as the domain for SWF files loaded from the - local file system):

-

AIR to Flash Player communication

- 
-// receivingLC is in http://www.domain.com/receiving.swf
-receivingLC.allowDomain('app#com.example');
-receivingLC.connect('myConnection');
-
-// sendingLC is an AIR application with app ID = com.example (and no publisher ID)
-sendingLC.send('www.domain.com:myConnection', 'myMethod');
-
-

From an AIR application to another AIR application. - To communicate between two AIR applications, - you need to allow communication between the two by calling the allowDomain() - method and passing in the sending AIR application's connection prefix. For example, if the sending - application has an application ID of, "com.example", and no publisher ID, you could pass the string: - app#com.example to the allowDomain() method in the receiving application. - You also need to qualify the connection name in the send() method - with the receiving LocalConnection object's connection prefix:

-

AIR to AIR communication

- 
-// receivingLC is an AIR application with app ID = com.sample (and no publisher ID)
-receivingLC.allowDomain('app#com.example');
-receivingLC.connect('myConnection');
-
-// sendingLC is an AIR application with app ID = com.example (and no publisher ID)
-sendingLC.send('app#com.sample:myConnection', 'myMethod');
-
-

You can use LocalConnection objects to send and receive data within a single file, - but this is not a typical implementation.

-

For more information about the send() and connect() methods, see the discussion of the - connectionName parameter in the LocalConnection.send() and - LocalConnection.connect()entries. Also, see the allowDomain() and domain entries.

-

-

-View the examples. -

-

-See also -

-
-flash.net.LocalConnection.send() -
-flash.net.LocalConnection.allowDomain() -
-flash.net.LocalConnection.domain -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  client : Object -
- Indicates the object on which callback methods are invoked.
-		LocalConnection
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  domain : String -
[read-only] - A string representing the domain of the location of the current file.
-		LocalConnection
  isPerUser : Boolean -
- Indicates whether the LocalConnection object is scoped to the current user (true) - or is globally accessible to all users on the computer (false).
-		LocalConnection
  isSupported : Boolean -
[static][read-only] - The isSupported property is set to true if the - LocalConnection class is supported on the current platform, otherwise it is - set to false.
-		LocalConnection
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-LocalConnection()
-
- Creates a LocalConnection object.
-		LocalConnection
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-allowDomain(... domains):void -
-
- Specifies one or more domains that can send LocalConnection calls to this LocalConnection instance.
-		LocalConnection
   -
-allowInsecureDomain(... domains):void -
-
- Specifies one or more domains that can send LocalConnection calls to this LocalConnection object.
-		LocalConnection
   -
-close():void -
-
- Closes (disconnects) a LocalConnection object.
-		LocalConnection
   -
-connect(connectionName:String):void -
-
- Prepares a LocalConnection object to receive commands that are sent from a send() command - (from the sending LocalConnection object).
-		LocalConnection
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-send(connectionName:String, methodName:String, ... arguments):void -
-
- Invokes the method named methodName on a connection that was opened with the - connect(connectionName) method (in the receiving LocalConnection - object).
-		LocalConnection
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-asyncError -
-		 - Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code.LocalConnection
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-securityError -
-		 - Dispatched if a call to LocalConnection.send() - attempts to send data to a different security sandbox.LocalConnection
   -
-status -
-		 - Dispatched when a LocalConnection object reports its status.LocalConnection
-
- -
- -
Property detail
- - - - - -
clientproperty
-
-client:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the object on which callback methods are invoked. The default object - is this, the local connection being created. You can set the - client property to another object, and callback methods are - invoked on that other object. -

Implementation -
-    public function get client():Object -
-    public function set client(value:Object):void -
-
-Throws -
- - - - -
TypeError — The client property must be set to a non-null object. -
-
- - - - - -
domainproperty 
-
-domain:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A string representing the domain of the location of the current file. -

In content running in the application security sandbox in Adobe AIR (content - installed with the AIR application), the runtime uses the string app# followed by the application - ID for the AIR application (defined in the application descriptor file) in place of the superdomain. - For example a connectionName for an application with the application ID com.example.air.MyApp - connectionName resolves to "app#com.example.air.MyApp:connectionName".

-

In SWF files published for Flash Player 9 or later, the returned string is the exact domain of - the file, including subdomains. For example, if the file is located at www.adobe.com, this command - returns "www.adobe.com".

-

If the current file is a local file residing on the client computer running in Flash Player, - this command returns "localhost".

-

The most common ways to use this property are to include the domain name of the sending - LocalConnection object as a parameter to the method you plan to invoke in the receiving - LocalConnection object, or to use it with LocalConnection.allowDomain() to accept commands - from a specified domain. If you are enabling communication only between LocalConnection objects - that are located in the same domain, you probably don't need to use this property.

- Implementation -
-    public function get domain():String -
-

-See also -

-
-flash.net.LocalConnection.allowDomain() -
-flash.net.LocalConnection.connect() -
-
- - - - - -
isPerUserproperty 
-
-isPerUser:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5.2 -
-

- Indicates whether the LocalConnection object is scoped to the current user (true) - or is globally accessible to all users on the computer (false). - This property only affects content running on Mac OS X; other platforms ignore this parameter. - Connections on Windows and Linux operating systems are always per-user. -

In Flash Player 10.0.22 and earlier, and in AIR 1.5.1 and earlier, all LocalConnection objects - on Mac OS X have a global scope. Always set this property to true, unless you need to - preserve compatibility with previous versions. In future releases, the default value of this - property might change to true.

-

The default value is false.

-Implementation -
-    public function get isPerUser():Boolean -
-    public function set isPerUser(value:Boolean):void -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The isSupported property is set to true if the - LocalConnection class is supported on the current platform, otherwise it is - set to false. -

Implementation -
-    public static function get isSupported():Boolean -
-
- -
Constructor detail
- - - - - -
LocalConnection()constructor
-
-public function LocalConnection() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a LocalConnection object. You can use LocalConnection objects to enable - communication between different files that are running on the same client computer. -

-See also -

-
-flash.net.LocalConnection.connect() -
-flash.net.LocalConnection.send() -
-
- -
Method detail
- - - - - -
allowDomain()method
-
-public function allowDomain(... domains):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies one or more domains that can send LocalConnection calls to this LocalConnection instance. -

You cannot use this method to let files hosted using a secure protocol (HTTPS) allow access from - files hosted in nonsecure protocols; you must use the allowInsecureDomain() method instead.

-

You may want to use this method so that a child file from a different domain can make LocalConnection - calls to the parent file, without knowing the final domain from which the child file will come. - This can happen, for example, when you use load-balancing redirects or third-party servers. In this situation, - you can use the url property of the LoaderInfo object used with the load, to get the domain to use with - the allowDomain() method. For example, if you use a Loader object to load a child file, once the file - is loaded, you can check the contentLoaderInfo.url property of the Loader object, and parse the domain - out of the full URL string. If you do this, make sure that you wait until the file is loaded, because the - contentLoaderInfo.url property will not have its final, correct value until the file is completely loaded.

-

The opposite situation can also occur: you might create a child file that wants to accept LocalConnection - calls from its parent but doesn't know the domain of its parent. In this situation, implement this method by - checking whether the domain argument matches the domain of the loaderInfo.url property in the - loaded file. Again, you must parse the domain out of the full URL from loaderInfo.url. - In this situation, you don't have to wait for the parent file to load; the parent will already be loaded - by the time the child loads.

-

When using this method, consider the Flash Player security model. By default, a LocalConnection object - is associated with the sandbox of the file that created it, and cross-domain calls to LocalConnection - objects are not allowed unless you call the LocalConnection.allowDomain() method in the - receiving file. However, in Adobe AIR, content in the application security sandbox - (content installed with the AIR application) are not restricted by these security limitations.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

Note: The allowDomain() method has changed - from the form it had in ActionScript 1.0 and 2.0. In those earlier versions, - allowDomain was a callback method that you - implemented. In ActionScript 3.0, allowDomain() is a built-in - method of LocalConnection that you call. With this change, allowDomain() - works in much the same way as flash.system.Security.allowDomain().

- Parameters - - - - -
... domains — One or more strings that name the domains from which - you want to allow LocalConnection calls. This parameter has two special cases: -
    -
  • You can specify a wildcard character "*" to allow calls from all domains.
    • -
  • You can specify the string "localhost" to allow calls to this file from files that - are installed locally. Flash Player 8 introduced security restrictions - on local files. By default, a SWF file running in Flash Player - that is allowed to access the Internet cannot also have access to the local file system. - In Flash Player, if you specify "localhost", any local SWF file can access this - SWF file.
    • -
-
-
-Throws - - - - -
ArgumentError — All parameters specified must be non-null strings. -
-

-See also -

-
-flash.net.LocalConnection.allowInsecureDomain() -
-flash.display.LoaderInfo.url -
-flash.system.Security.allowDomain() -
-
- - - - - -
allowInsecureDomain()method 
-
-public function allowInsecureDomain(... domains):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies one or more domains that can send LocalConnection calls to this LocalConnection object. -

The allowInsecureDomain() method works just like the allowDomain() method, - except that the allowInsecureDomain() method additionally permits SWF files - from non-HTTPS origins to send LocalConnection calls to files from HTTPS origins. This difference - is meaningful only if you call the allowInsecureDomain() method from a - file that was loaded using HTTPS. You must call the allowInsecureDomain() method even - if you are crossing a non-HTTPS/HTTPS boundary within the same domain; by default, LocalConnection calls - are never permitted from non-HTTPS files to HTTPS files, even within the same domain.

-

Calling allowInsecureDomain() is not recommended, - because it can compromise the security offered by HTTPS. When you - load a file over HTTPS, you can be reasonably sure that the file - will not be tampered with during delivery over the network. If you - then permit a non-HTTPS file to make LocalConnection calls to the - HTTPS file, you are accepting calls from a file that may in fact have - been tampered with during delivery. This generally requires extra - vigilance because you cannot trust the authenticity of LocalConnection - calls arriving at your HTTPS file.

-

By default, files hosted using the HTTPS protocol can be accessed only by other files hosted - using the HTTPS protocol. This implementation maintains the integrity provided by the HTTPS protocol.

-

Using this method to override the default behavior is not recommended, because it compromises HTTPS security. - However, you might need to do so, for example, if you need to permit access to HTTPS SWF files published for - Flash Player 9 or later from HTTP files SWF published for Flash Player 6 or earlier.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- Parameters - - - - -
... domains — One or more strings that name the domains from which - you want to allow LocalConnection calls. There are two special cases - for this parameter: -
    -
  • You can specify the wildcard character "*" to allow calls from all domains. - Specifying "*" does not include local hosts.
    • -
  • You can specify the string "localhost" to allow calls to this SWF file from SWF files that - are installed locally. Flash Player 8 introduced security restrictions on local SWF files. A SWF file - that is allowed to access the Internet cannot also have access to the local file system. If you - specify "localhost", any local SWF file can access this SWF file. Remember that you must also - designate the calling SWF file as a local-with-networking SWF file at authoring time.
    • -
-
-
-Throws - - - - -
ArgumentError — All parameters specified must be non-null strings. -
-

-See also -

-
-flash.net.LocalConnection.allowDomain() -
-
- - - - - -
close()method 
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Closes (disconnects) a LocalConnection object. Issue this command when you no longer want the object - to accept commands — for example, when you want to issue a connect() - command using the same connectionName parameter in another SWF file. -


-Throws - - - - -
ArgumentError — The LocalConnection instance is not connected, so it cannot be closed. -
-

-See also -

-
-flash.net.LocalConnection.connect() -
-
- - - - - -
connect()method 
-
-public function connect(connectionName:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Prepares a LocalConnection object to receive commands that are sent from a send() command - (from the sending LocalConnection object). The object used with the connect() method is - called the receiving LocalConnection object. The receiving and sending objects - must be running on the same client computer. -

To avoid a race condition, define the methods attached to the - receiving LocalConnection object before - calling this method, as shown in the LocalConnection class example.

-

By default, the connectionName argument is resolved into a value of - "superdomain:connectionName", - where superdomain is the superdomain of the file that contains the - connect() command. For example, if the file that contains the - receiving LocalConnection object is located at www.someDomain.com, connectionName - resolves to "someDomain.com:connectionName". (If a file running in Flash Player - is located on the client computer, the value assigned to superdomain is - "localhost".)

-

In content running in the application security sandbox in Adobe AIR (content - installed with the AIR application), the runtime uses the string app# followed by the application - ID for the AIR application (defined in the application descriptor file) in place of the superdomain. - For example a connectionName for an application with the application ID com.example.air.MyApp - connectionName resolves to "app#com.example.air.MyApp:connectionName".

-

Also by default, Flash Player lets the receiving LocalConnection object accept commands only from - sending LocalConnection objects whose connection name also resolves into a value of - "superdomain:connectionName". In this way, Flash Player makes - it simple for files that are located in the same domain to communicate with each other.

-

If you are implementing communication only between files in the same domain, specify a string - for connectionName that does not begin with an underscore (_) and that does not specify - a domain name (for example, "myDomain:connectionName"). Use the same string in the - connect(connectionName) method.

-

If you are implementing communication between files in different domains, specifying a string - for connectionName that begins with an underscore (_) makes the file with the - receiving LocalConnection object more portable between domains. Here are the two possible cases:

-
    -
  • If the string for connectionNamedoes not begin with an underscore (_), - a prefix is added with the superdomain and a colon (for example, - "myDomain:connectionName"). Although this ensures that your connection does not conflict - with connections of the same name from other domains, any sending LocalConnection objects must - specify this superdomain (for example, "myDomain:connectionName"). - If the file with the receiving LocalConnection object is moved to another domain, the player changes - the prefix to reflect the new superdomain (for example, "anotherDomain:connectionName"). - All sending LocalConnection objects would have to be manually edited to point to the new superdomain.
    • -
  • If the string for connectionNamebegins with an underscore (for example, - "_connectionName"), a prefix is not added to the string. This means that - the receiving and sending LocalConnection objects use identical strings for - connectionName. If the receiving object uses allowDomain() - to specify that connections from any domain will be accepted, the file with the receiving LocalConnection - object can be moved to another domain without altering any sending LocalConnection objects.
    • -
-

For more information, see the discussion in the class overview and the discussion - of connectionName in send(), and also - the allowDomain() and domain entries.

-

Note: Colons are used as special characters to separate the superdomain from the - connectionName string. A string for connectionName that contains a colon is - not valid.

-

When you use this method in content in security sandboxes other - than then application security sandbox, consider the Flash Player - AIR security model. By default, a LocalConnection object - is associated with the sandbox of the file that created it, and cross-domain calls to LocalConnection - objects are not allowed unless you call the LocalConnection.allowDomain() method in the - receiving file. You can prevent a file from using this method by setting the - allowNetworking parameter of the the object and embed - tags in the HTML page that contains the SWF content. However, in Adobe AIR, - content in the application security sandbox (content installed with the AIR application) - are not restricted by these security limitations.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- Parameters - - - - -
connectionName:String — A string that corresponds to the connection name specified in the - send() command that wants to communicate with the receiving LocalConnection object. -
-
-Throws - - - - - - - - - - -
TypeError — The value passed to the connectionName parameter must be non-null. -
 
ArgumentError — This error can occur for three reasons: 1) The string value passed to the connectionName parameter - was null. Pass a non-null value. 2) The value passed to the connectionName parameter - contained a colon (:). Colons are used as special characters to separate the superdomain - from the connectionName string in the send() method, not the - connect()method. 3) The LocalConnection instance is already connected. -
-

-See also -

-
-flash.net.LocalConnection.send() -
-flash.net.LocalConnection.allowDomain() -
-flash.net.LocalConnection.domain -
-
- - - - - -
send()method 
-
-public function send(connectionName:String, methodName:String, ... arguments):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Invokes the method named methodName on a connection that was opened with the - connect(connectionName) method (in the receiving LocalConnection - object). The object used with the send() method is called the sending LocalConnection object. - The SWF files that contain the sending and receiving objects must be running on the same client computer. -

There is a 40 kilobyte limit to the amount of data you can pass as parameters to this command. - If send() throws an ArgumentError but your syntax is correct, try dividing the - send() requests into multiple commands, each with less than 40K of data.

-

As discussed in the connect() entry, the current superdomain in added to - connectionName by default. If you are implementing communication between different domains, - you need to define connectionName in both the sending and receiving LocalConnection - objects in such a way that the current superdomain is not added to connectionName. - You can do this in one of the following two ways:

-
    -
  • Use an underscore (_) at the beginning of connectionName in both the sending and - receiving LocalConnection objects. In the file that contains the receiving object, use - LocalConnection.allowDomain() to specify that connections from any domain will be accepted. - This implementation lets you store your sending and receiving files in any domain.
    • -
  • Include the superdomain in connectionName in the sending LocalConnection - object — for example, myDomain.com:myConnectionName. In the receiving object, use - LocalConnection.allowDomain() to specify that connections from the specified superdomain - will be accepted (in this case, myDomain.com) or that connections from any domain will be accepted.
    • -
-

Note: You cannot specify a superdomain in connectionName in the receiving - LocalConnection object — you can do this in only the sending LocalConnection object.

-

When you use this method in content in security sandboxes other - than then application security sandbox, consider the Flash Player - AIR security model. By default, a LocalConnection object - is associated with the sandbox of the file that created it, and cross-domain calls to LocalConnection - objects are not allowed unless you call the LocalConnection.allowDomain() method in the - receiving file. For SWF content running in the browser, ou can prevent a file from using this method by setting the - allowNetworking parameter of the the object and embed - tags in the HTML page that contains the SWF content. However, in Adobe AIR, content in the - application security sandbox (content installed with the AIR application) are not - restricted by these security limitations.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- Parameters - - - - - - - - - - - - - - - - -
connectionName:String — Corresponds to the connection name specified in the connect() command - that wants to communicate with the sending LocalConnection object. -
 
methodName:String — The name of the method to be invoked in the receiving LocalConnection object. The - following method names cause the command to fail: send, connect, - close, allowDomain, allowInsecureDomain, - client, and domain. -
 
... arguments — Additional optional parameters to be passed to the specified method. -
-
-Events - - - - - - - - - - -
securityError:SecurityErrorEvent — LocalConnection.send() attempted - to communicate with a SWF file from a security sandbox to which the calling - code does not have access. You can work around this in the receiver's - implementation of LocalConnection.allowDomain().
 
status:StatusEvent — If the value of the level property is "status", - the call was successful; if the value is "error", the call failed. The call can fail - if the receiving SWF file refuses the connection.
-
-Throws - - - - - - - - - - -
TypeError — The value of either connectionName or methodName - is null. Pass non-null values for these parameters. -
 
ArgumentError — This error can occur for one of the following reasons: - 1) The value of either connectionName or methodName - is an empty string. Pass valid strings for these parameters. - 2) The method specified in methodName is restricted. - 3) The serialized message that is being sent is too large (larger than 40K). -
-

-See also -

-
-flash.net.LocalConnection.allowDomain() -
-flash.net.LocalConnection.connect() -
-flash.net.LocalConnection.domain -
-
-
Event detail
- - - - - -
asyncErrorevent 
-
-Event object type: flash.events.AsyncErrorEvent -
-AsyncErrorEvent.type property = flash.events.AsyncErrorEvent.ASYNC_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code. -

- The AsyncErrorEvent.ASYNC_ERROR constant defines the value of the - type property of an asyncError event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse - This property applies to ActionScript 3.0 display objects (in SWF files).
cancelablefalse; there is no default - behavior to cancel. This property applies to display objects - in SWF content, which use the ActionScript 3.0 display architecture.
currentTargetThe object that is actively processing the - Event object with an event listener. This property applies to display - objects in SWF content, which use the ActionScript 3.0 display architecture.
target The object dispatching the event.
errorThe error that triggered the event.
- -
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched if a call to LocalConnection.send() - attempts to send data to a different security sandbox. -

- The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- -

-See also -

-
-send() -
-
- - - - - -
statusevent  
-
-Event object type: flash.events.StatusEvent -
-StatusEvent.type property = flash.events.StatusEvent.STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a LocalConnection object reports its status. - If LocalConnection.send() is successful, the value of the status event - object's level property is "status"; if the call fails, the level property - is "error". If the receiving file refuses the connection, the call can fail - without notification to the sending file. -

- Defines the value of the type property of a status event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
codeA description of the object's status.
currentTargetThe object that is actively processing the Event - object with an event listener.
levelThe category of the message, such as "status", "warning" or "error".
targetThe object reporting its status.
- -

-See also -

-
-LocalConnection.send() -
-
- -
Examples
-
examples\LocalConnectionSenderExample
-
This example consists of two ActionScript classes which - should be compiled into two separate SWF files: - -

In the LocalConnectionSenderExample SWF file, a LocalConnection instance is created, - and when the button is pressed the call() method is used to - call the method named lcHandler in the SWF file with the - connection name "myConnection," passing the contents of the - TextField as a parameter.

- -

In the LocalConnectionReceiverExample SWF file, a LocalConnection instance is - created and the connect() method is called to designate - this SWF file as the recipient of messages that are addressed to the - connection named "myConnection." In addition, this class includes - a public method named lcHandler(); this method is the - one that is called by the LocalConnectionSenderExample SWF file. When it's called, - the text that is passed in as a parameter is appended to the - TextField on the Stage.

- -

Note: To test the example, both SWF files must - be loaded on the same computer simultaneously.

-
-
-
-// Code in LocalConnectionSenderExample.as
-package {
-    import flash.display.Sprite;
-	import flash.events.MouseEvent;
-	import flash.net.LocalConnection;
-	import flash.text.TextField;
-	import flash.text.TextFieldType;
-	import flash.events.StatusEvent;
-	import flash.text.TextFieldAutoSize;
-
-	public class LocalConnectionSenderExample extends Sprite {
-		private var conn:LocalConnection;
-		
-		// UI elements
-		private var messageLabel:TextField;
-		private var message:TextField;
-		private var sendBtn:Sprite;
-		
-		public function LocalConnectionSenderExample() {
-			buildUI();
-			sendBtn.addEventListener(MouseEvent.CLICK, sendMessage);
-			conn = new LocalConnection();
-			conn.addEventListener(StatusEvent.STATUS, onStatus);
-		}
-		
-		private function sendMessage(event:MouseEvent):void {
-			conn.send("myConnection", "lcHandler", message.text);
-		}
-		
-		private function onStatus(event:StatusEvent):void {
-			switch (event.level) {
-				case "status":
-					trace("LocalConnection.send() succeeded");
-					break;
-				case "error":
-					trace("LocalConnection.send() failed");
-					break;
-			}
-		}
-		
-		private function buildUI():void {
-			const hPadding:uint = 5;
-			// messageLabel
-			messageLabel = new TextField();
-			messageLabel.x = 10;
-			messageLabel.y = 10;
-			messageLabel.text = "Text to send:";
-			messageLabel.autoSize = TextFieldAutoSize.LEFT;
-			addChild(messageLabel);
-			
-			// message
-			message = new TextField();
-			message.x = messageLabel.x + messageLabel.width + hPadding;
-			message.y = 10;
-			message.width = 120;
-			message.height = 20;
-			message.background = true;
-			message.border = true;
-			message.type = TextFieldType.INPUT;
-			addChild(message);
-			
-			// sendBtn
-			sendBtn = new Sprite();
-			sendBtn.x = message.x + message.width + hPadding;
-			sendBtn.y = 10;
-			var sendLbl:TextField = new TextField();
-			sendLbl.x = 1 + hPadding;
-			sendLbl.y = 1;
-			sendLbl.selectable = false;
-			sendLbl.autoSize = TextFieldAutoSize.LEFT;
-			sendLbl.text = "Send";
-			sendBtn.addChild(sendLbl);
-			sendBtn.graphics.lineStyle(1);
-			sendBtn.graphics.beginFill(0xcccccc);
-			sendBtn.graphics.drawRoundRect(0, 0, (sendLbl.width + 2 + hPadding + hPadding), (sendLbl.height + 2), 5, 5);
-			sendBtn.graphics.endFill();
-			addChild(sendBtn);
-		}
-	}
-}
-
-
-
examples\LocalConnectionReceiverExample
-
-
-
-// Code in LocalConnectionReceiverExample.as
-package {
-    import flash.display.Sprite;
-	import flash.net.LocalConnection;
-	import flash.text.TextField;
-
-	public class LocalConnectionReceiverExample extends Sprite {
-		private var conn:LocalConnection;
-		private var output:TextField;
-		
-		public function LocalConnectionReceiverExample() 	{
-			buildUI();
-			
-			conn = new LocalConnection();
-			conn.client = this;
-			try {
-				conn.connect("myConnection");
-			} catch (error:ArgumentError) {
-				trace("Can't connect...the connection name is already being used by another SWF");
-			}
-		}
-		
-		public function lcHandler(msg:String):void {
-			output.appendText(msg + "\n");
-		}
-		
-		private function buildUI():void {
-			output = new TextField();
-			output.background = true;
-			output.border = true;
-			output.wordWrap = true;
-			addChild(output);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetConnection.html b/html-docs/flash/net/NetConnection.html deleted file mode 100644 index 83e273b..0000000 --- a/html-docs/flash/net/NetConnection.html +++ /dev/null @@ -1,1753 +0,0 @@ - - - - - - - - -flash.net.NetConnection (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class NetConnection
InheritanceNetConnection Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The NetConnection class creates a two-way connection between a client and a server. - The client can be a Flash Player or AIR an AIR application. - The server can be a web server, Flash Media Server, an application server running Flash Remoting, - or the Adobe Stratus service. Call NetConnection.connect() to - establish the connection. Use the NetStream class to send streams of media and data over the connection. -

For security information about loading content and data into Flash Player and AIR, see the following:

- -

- To write callback methods for this class, extend the class and define the - callback methods in the subclass, or assign the client - property to an object and define the callback methods on that object.

-

-

-View the examples. -

-

-See also -

-
-client -
-NetStream -
-connect() -
-flash.net.Responder -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  client : Object -
- Indicates the object on which callback methods are invoked.
-		NetConnection
  connected : Boolean -
[read-only] - Indicates whether the application is connected to a server through - a persistent RTMP connection (true) or not (false).
-		NetConnection
  connectedProxyType : String -
[read-only] - The proxy type used to make a successful connection to Flash Media Server.
-		NetConnection
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  defaultObjectEncoding : uint -
[static] - The default object encoding for NetConnection objects.
-		NetConnection
  farID : String -
[read-only] - The identifier of the Flash Media Server instance to which this Flash Player or Adobe AIR instance is connected.
-		NetConnection
  farNonce : String -
[read-only] - A value chosen substantially by Flash Media Server, unique to this connection.
-		NetConnection
  httpIdleTimeout : Number -
- The time, in milliseconds, to wait for an HTTP response.
-		NetConnection
  maxPeerConnections : uint -
- The total number of inbound and outbound peer connections that this instance of Flash Player or Adobe AIR allows.
-		NetConnection
  nearID : String -
[read-only] - The identifier of this Flash Player or Adobe AIR instance for this NetConnection instance.
-		NetConnection
  nearNonce : String -
[read-only] - A value chosen substantially by this Flash Player or Adobe AIR instance, unique to this connection.
-		NetConnection
  objectEncoding : uint -
- The object encoding for this NetConnection instance.
-		NetConnection
  protocol : String -
[read-only] - The protocol used to establish the connection.
-		NetConnection
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  proxyType : String -
- Determines which fallback methods are tried if an - initial connection attempt to Flash Media Server fails.
-		NetConnection
  unconnectedPeerStreams : Array -
[read-only] - An object that holds all of the peer subscriber NetStream objects that are not associated with publishing NetStream objects.
-		NetConnection
  uri : String -
[read-only] - The URI passed to the NetConnection.connect() method.
-		NetConnection
  usingTLS : Boolean -
[read-only] - Indicates whether a secure connection was made using native Transport Layer Security (TLS) - rather than HTTPS.
-		NetConnection
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NetConnection()
-
- Creates a NetConnection object.
-		NetConnection
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-addHeader(operation:String, mustUnderstand:Boolean = false, param:Object = null):void -
-
- Adds a context header to the Action Message Format (AMF) packet structure.
-		NetConnection
   -
-call(command:String, responder:Responder, ... arguments):void -
-
- Calls a command or method on Flash Media Server or on an application server running Flash Remoting.
-		NetConnection
   -
-close():void -
-
- Closes the connection that was opened locally or to the server and dispatches - a netStatus event - with a code property of NetConnection.Connect.Closed.
-		NetConnection
   -
-connect(command:String, ... arguments):void -
-
- Creates a two-way connection to an application on Flash Media Server or to Flash Remoting, or creates a two-way network - endpoint for RTMFP peer-to-peer group communication.
-		NetConnection
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-asyncError -
-		 - Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code.NetConnection
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-ioError -
-		 - Dispatched when an input or output error occurs that causes a network operation to fail.NetConnection
   -
-netStatus -
-		 - Dispatched when a NetConnection object is reporting its status or error condition.NetConnection
   -
-securityError -
-		 - Dispatched if a call to NetConnection.call() - attempts to connect to a server outside the caller's security sandbox.NetConnection
-
- -
- -
Property detail
- - - - - -
clientproperty
-
-client:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the object on which callback methods are invoked. The default is - this NetConnection instance. If you set the client property to another object, - callback methods will be invoked on that object. -

Implementation -
-    public function get client():Object -
-    public function set client(value:Object):void -
-
-Throws -
- - - - -
TypeError — The client property must be set to a non-null object. -
-
- - - - - -
connectedproperty 
-
-connected:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether the application is connected to a server through - a persistent RTMP connection (true) or not (false). - When connected through HTTP, this property is false, except - when connected to Flash Remoting services on an application server, - in which case it is true. -

Implementation -
-    public function get connected():Boolean -
-
- - - - - -
connectedProxyTypeproperty 
-
-connectedProxyType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The proxy type used to make a successful connection to Flash Media Server. Possible values are: - "none", "HTTP", "HTTPS", or "CONNECT". -

The value is "none" if the connection is not tunneled or is a native SSL connection.

-

The value is "HTTP" if the connection is tunneled over HTTP.

-

The value is "HTTPS" if the connection is tunneled over HTTPS,

-

The value is "CONNECT" if the connection is tunneled using the CONNECT method through a proxy server.

- Implementation -
-    public function get connectedProxyType():String -
-
-Throws -
- - - - -
ArgumentError — An attempt was made to access this property when the NetConnection instance - was not connected. -
-
- - - - - -
defaultObjectEncodingproperty 
-
-defaultObjectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The default object encoding for NetConnection objects. - When an object is written to or read from binary data, the defaultObjectEncoding - property indicates which Action Message Format (AMF) version is used to serialize the data: - the ActionScript 3.0 format (ObjectEncoding.AMF3) - or the ActionScript 1.0 and ActionScript 2.0 format (ObjectEncoding.AMF0). -

The default value is ObjectEncoding.AMF3. - Changing NetConnection.defaultObjectEncoding - does not affect existing NetConnection instances; it affects only instances that - are created subsequently.

-

To set an object's encoding separately (rather than setting object encoding for the entire - application), set the objectEncoding property of the NetConnection object instead.

-

For more detailed information, see the description of the objectEncoding - property.

- Implementation -
-    public static function get defaultObjectEncoding():uint -
-    public function set defaultObjectEncoding(value:uint):void -
-

-See also -

-
-NetConnection.objectEncoding -
-flash.net.ObjectEncoding -
-
- - - - - -
farIDproperty 
-
-farID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The identifier of the Flash Media Server instance to which this Flash Player or Adobe AIR instance is connected. - This property is meaningful only for RTMFP connections. The value of this property is available only after an RTMFP connection is established. -

Implementation -
-    public function get farID():String -
-

-See also -

-
-nearID -
-
- - - - - -
farNonceproperty 
-
-farNonce:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A value chosen substantially by Flash Media Server, unique to this connection. This value appears to the server - as its client.nearNonce value. This value is defined only for RTMFP, RTMPE, and RTMPTE connections. -

Implementation -
-    public function get farNonce():String -
-
- - - - - -
httpIdleTimeoutproperty 
-
-httpIdleTimeout:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- The time, in milliseconds, to wait for an HTTP response. The default value is zero. -

    - -
  • The httpIdleTimeout value is a Number.
    • -
  • When using an HTTP connection, a positive value indicates the number of milliseconds an inactive connection should remain - open.
    • -
  • A value of zero indicates that the default networking idle timeout value for the platform should be used.
    • -
  • A negative value will result in a RangeError.
    • -
  • If the httpIdleTimeout value is exceeded, a netStatus event is dispatched.
    • - -
  • This property will only affect NetConnection objects created with HTTP connections. - NetConnection objects created with RTMP, RTMFP, or other HTTP channels remain unaffected by this property.
    • - -
- 
-	//Set the timeout to 5 seconds
-	connection = new NetConnection();
-	connection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-	connection.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-	connection.httpIdleTimeout = 5000;
-
- - In Linux-based systems, the NetConnection may take more seconds to timeout than what is specified using the - httpIdleTimeout value. -

Implementation -
-    public function get httpIdleTimeout():Number -
-    public function set httpIdleTimeout(value:Number):void -
-
- - - - - -
maxPeerConnectionsproperty 
-
-maxPeerConnections:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The total number of inbound and outbound peer connections that this instance of Flash Player or Adobe AIR allows. - The default value is 8. -

This value does not distinguish between publisher and subscriber connections. If this value is reduced while - peer connections are present, the new value affects new incoming connections only. Existing connections are not dropped.

- Implementation -
-    public function get maxPeerConnections():uint -
-    public function set maxPeerConnections(value:uint):void -
-
- - - - - -
nearIDproperty 
-
-nearID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The identifier of this Flash Player or Adobe AIR instance for this NetConnection instance. This property is meaningful only for RTMFP connections. -

Every NetConnection instance has a unique nearID property. No Flash Player or Adobe AIR instance - or NetConnection instance has the same identifier.

-

Other Flash Player or Adobe AIR instances - use this identifier as the peerID for new NetStream connections to this client. - Subsequently, this identifier is the farID in any peer NetStream that connects to this instance.

- Implementation -
-    public function get nearID():String -
-

-See also -

-
-farID -
-
- - - - - -
nearNonceproperty 
-
-nearNonce:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A value chosen substantially by this Flash Player or Adobe AIR instance, unique to this connection. This value appears to the server - as its client.farNonce value. This value is defined only for RTMFP, RTMPE, and RTMPTE connections. -

Implementation -
-    public function get nearNonce():String -
-
- - - - - -
objectEncodingproperty 
-
-objectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The object encoding for this NetConnection instance. -

- When an object is written to or read from binary data, the defaultObjectEncoding - property indicates which Action Message Format (AMF) version is used to serialize the data: the ActionScript 3.0 format (ObjectEncoding.AMF3) - or the ActionScript 1.0 and ActionScript 2.0 format (ObjectEncoding.AMF0). - Set the objectEncoding property to set an AMF version for a NetConnection instance. -

-

It's important to understand this property if your application needs to - communicate with servers released prior to Flash Player 9. The following three scenarios are possible: -

-
    -
  • Connecting to a server that supports AMF3 (for example, Flex Data Services 2 or Flash Media Server 3). - The default value of defaultObjectEncoding is - ObjectEncoding.AMF3. All NetConnection instances created in this - file use AMF3 serialization, so you don't need to set the - objectEncoding property.
    • -
  • Connecting to a server that doesn't support AMF3 (for example, Flash Media Server 2). - In this scenario, set the static NetConnection.defaultObjectEncoding property to - ObjectEncoding.AMF0. All NetConnection instances created in this - SWF file use AMF0 serialization. You don't need to set the - objectEncoding property.
    • -
  • Connecting to multiple servers that use different encoding versions. Instead of - using defaultObjectEncoding, set the object encoding on a per-connection - basis using the objectEncoding property for each connection. - Set it to ObjectEncoding.AMF0 to connect to - servers that use AMF0 encoding, such as Flash Media Server 2, - and set it to ObjectEncoding.AMF3 to connect to - servers that use AMF3 encoding, such as Flex Data Services 2.
    • -
-

Once a NetConnection instance is connected, its objectEncoding - property is read-only.

-

If you use the wrong encoding to connect to a server, the NetConnection object - dispatches the netStatus event. The NetStatusEvent.info - property contains an information object with a code property value of - NetConnection.Connect.Failed, and a description explaining that the object - encoding is incorrect.

- Implementation -
-    public function get objectEncoding():uint -
-    public function set objectEncoding(value:uint):void -
-
-Throws -
- - - - - - - - - - -
ReferenceError — An attempt was made to set the value of the objectEncoding - property while the NetConnection instance was connected. -
 
ArgumentError — This property was set to a value other than ObjectEncoding.AMF0 - or ObjectEncoding.AMF3. -
-

-See also -

-
-defaultObjectEncoding -
-flash.net.ObjectEncoding -
-
- - - - - -
protocolproperty 
-
-protocol:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The protocol used to establish the connection. This property is relevant when using - Flash Media Server. Possible values are as follows: -

    -
  • "rtmp": Real-Time Messaging Protocol (RTMP)
    • -
  • "rtmpe": Encrypted RTMP
    • -
  • "rtmpt": HTTP tunneling RTMP
    • -
  • "rtmpte": HTTP tunneling encrypted RTMP
    • -
  • "rtmps": HTTPS-based RTMP
    • -
  • "rtmfp": Real-Time Media Flow Protocol (RTMFP)
    • -
-

Implementation -
-    public function get protocol():String -
-
-Throws -
- - - - -
ArgumentError — An attempt was made to access this property when the NetConnection instance - was not connected. -
-
- - - - - -
proxyTypeproperty 
-
-proxyType:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Determines which fallback methods are tried if an - initial connection attempt to Flash Media Server fails. Set the proxyType property before - calling the NetConnection.connect() method. -

Acceptable values are "none", "HTTP", "CONNECTOnly", "CONNECT", - and "best".The default value is "none".

-

To use native SSL, set the property to "best". If the player cannot make a direct connection - to the server (over the default port of 443 or over another port that you specify) - and a proxy server is in place, the player tries to use the CONNECT method. If that attempt fails, the player tunnels over HTTPS. -

-

If the property is set to "CONNECTOnly", the player tries to use the CONNECT method first. - If that fails, there is no fallback.

-

If the property is set to "HTTP" and a direct connection fails, HTTP tunneling is used. - If the property is set to "CONNECT" and a direct connection fails, - the CONNECT method of tunneling is used. If that fails, the connection does - not fall back to HTTP tunneling.

-

This property is applicable only when using RTMP, RTMPS, or RTMPT. The CONNECT and - CONNECTOnly methods are - applicable only to users who are connected to the network by a proxy server.

- Implementation -
-    public function get proxyType():String -
-    public function set proxyType(value:String):void -
-
- - - - - -
unconnectedPeerStreamsproperty 
-
-unconnectedPeerStreams:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- An object that holds all of the peer subscriber NetStream objects that are not associated with publishing NetStream objects. - Subscriber NetStream objects that are associated with publishing NetStream objects are in the NetStream.peerStreams - array. -

Implementation -
-    public function get unconnectedPeerStreams():Array -
-

-See also -

-
-NetStream.peerStreams -
-
- - - - - -
uriproperty 
-
-uri:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The URI passed to the NetConnection.connect() method. - If NetConnection.connect() hasn't been called or if no URI was passed, - this property is undefined. -

Implementation -
-    public function get uri():String -
-
- - - - - -
usingTLSproperty 
-
-usingTLS:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether a secure connection was made using native Transport Layer Security (TLS) - rather than HTTPS. This property is valid only when a NetConnection object is connected. -

Implementation -
-    public function get usingTLS():Boolean -
-
-Throws -
- - - - -
ArgumentError — An attempt was made to access this property when the NetConnection instance - was not connected. -
-
- -
Constructor detail
- - - - - -
NetConnection()constructor
-
-public function NetConnection() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a NetConnection object. Call the connect() method to make a connection. -

If an application needs to communicate with servers released prior - to Flash Player 9, set the NetConnection object's - objectEncoding property.

-

The following code creates a NetConnection object:

- 
-     var nc:NetConnection = new NetConnection();
-
-

-See also -

-
-flash.net.NetConnection.connect() -
-objectEncoding -
-
- -
Method detail
- - - - - -
addHeader()method
-
-public function addHeader(operation:String, mustUnderstand:Boolean = false, param:Object = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Adds a context header to the Action Message Format (AMF) packet structure. This header is sent with - every future AMF packet. If you call NetConnection.addHeader() - using the same name, the new header replaces the existing header, and the new header - persists for the duration of the NetConnection object. You can remove a header by - calling NetConnection.addHeader() with the name of the header to remove - an undefined object. -

Parameters - - - - - - - - - - - - - - - - -
operation:String — Identifies the header and the ActionScript object data associated with it. -
 
mustUnderstand:Boolean (default = false) — A value of true indicates that the server must understand - and process this header before it handles any of the following headers or messages. -
 
param:Object (default = null) — Any ActionScript object. -
-
- - - - - -
call()method 
-
-public function call(command:String, responder:Responder, ... arguments):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Calls a command or method on Flash Media Server or on an application server running Flash Remoting. - Before calling NetConnection.call() you must call NetConnection.connect() - to connect to the server. You must create a server-side function to pass to this method. -

You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.

- Parameters - - - - - - - - - - - - - - - - -
command:String — A method specified in the form [objectPath/]method. For example, - the someObject/doSomething command tells the remote server - to call the clientObject.someObject.doSomething() method, with all the optional - ... arguments parameters. If the object path is missing, - clientObject.doSomething() is invoked on the remote server. -

- With Flash Media Server, command is the name of a function - defined in an application's server-side script. - You do not need to use an object path before command - if the server-side script is placed at the root level of - the application directory. -

-
 
responder:Responder — An optional object that is used to handle return values from the server. - The Responder object can have two defined methods to handle the returned result: - result and status. If an error is returned as the result, - status is invoked; otherwise, result is invoked. The Responder object - can process errors related to specific operations, while the NetConnection object responds to - errors related to the connection status. -
 
... arguments — Optional arguments that can be of any ActionScript type, - including a reference to another ActionScript object. These arguments are passed - to the method specified in the command parameter when the method is executed on the - remote application server. -
-
-Events - - - - -
securityError:SecurityErrorEvent — A call attempted - to communicate with a server outside the caller's security sandbox. - You can avoid this problem by using a policy file on the server.
-

-See also -

-
-flash.net.Responder -
-
- - - - - -
close()method 
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Closes the connection that was opened locally or to the server and dispatches - a netStatus event - with a code property of NetConnection.Connect.Closed. -

- This method disconnects all NetStream objects running over the connection. - Any queued data that has not been sent is discarded. (To terminate - local or server streams without closing the connection, use NetStream.close().) - If you close the connection and then want to create a new one, - you must create a new NetConnection object and call the connect() method again. -

-

The close() method also disconnects all remote shared objects running - over this connection. - However, you don't need to recreate the shared object to reconnect. Instead, you can just - call SharedObject.connect() to reestablish the connection to the shared object. - Also, any data in the shared object that was queued when you issued - NetConnection.close() is sent after you reestablish a connection - to the shared object.

-

- With Flash Media Server, the best development practice is to call close() - when the client no longer needs the connection to the server. Calling close() - is the fastest way to clean up unused connections. You can configure the server to close idle connections - automatically as a back-up measure. For more information, see - the Flash Media Server Configuration and Administration Guide. -

-

-See also -

-
-NetStream -
-flash.events.NetStatusEvent.info -
-
- - - - - -
connect()method 
-
-public function connect(command:String, ... arguments):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a two-way connection to an application on Flash Media Server or to Flash Remoting, or creates a two-way network - endpoint for RTMFP peer-to-peer group communication. To report its status or an error condition, a - call to NetConnection.connect() dispatches a netStatus event. -

Call NetConnection.connect() to do the following:

-
    -
  • Pass "null" to play video and mp3 files from a local file system or from a web server.
    • -
  • Pass an "http" URL to connect to an application server running Flash Remoting. Use the NetServices class to call functions on and - return results from application servers over a NetConnection object. - For more information, see the Flash Remoting documentation.
    • -
  • Pass an "rtmp/e/s" URL to connect to a Flash Media Server application.
    • -
  • Pass an "rtmfp" URL to create a two-way network endpoint for RTMFP client-server, peer-to-peer, and IP multicast communication.
    • -
  • Pass the string "rtmfp:" to create a serverless two-way network endpoint for RTMFP IP multicast communication.
    • -
-

Consider the following security model:

-
    -
  • By default, Flash Player or AIR denies access between sandboxes. - A website can enable access to a resource by using a URL policy file.
    • -
  • Your application can deny access to a resource on the server. - In a Flash Media Server application, use Server-Side ActionScript code to deny access. - See the Flash Media Server documentation.
    • -
  • You cannot call NetConnection.connect() if the calling file is in the - local-with-file-system sandbox.
    • -
  • You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.
    • -
  • To prevent a SWF file from calling this method, set the allowNetworking - parameter of the the object and embed tags in the HTML - page that contains the SWF content.
    • -
-

However, in Adobe AIR, content in the application security sandbox (content - installed with the AIR application) are not restricted by these security limitations.

-

For more information about security, see the Adobe Flash Player Developer Center: - Security.

- Parameters - - - - - - - - - - -
command:String — Use one of the following values for the command parameter: -
    -
  • To play video and mp3 files from a local file system or from a web server, pass null.
    • -
  • To connect to an application server running Flash Remoting, pass a URL that uses the http protocol.
    • -
  • (Flash Player 10.1 or AIR 2 or later) To create a serverless network endpoint for RTMFP IP multicast communication, - pass the string "rtmfp:". Use this connection type to receive an IP multicast stream from a publisher without using a server. - You can also use this connection type to use IP multicast to discover peers on the same local area network (LAN).
    • -

    This connection type has the following limitations:

    -

    Only peers on the same LAN can discover each other.

    -

    Using IP multicast, Flash Player can receive streams, it cannot send them.

    -

    Flash Player and AIR can send and receive streams in a peer-to-peer group, but the peers - must be discovered on the same LAN using IP multicast.

    -

    This technique cannot be used for one-to-one communication.

    -

    -
  • To connect to Flash Media Server, pass the URI of the - application on the server. Use the following - syntax (items in brackets are optional): -

    protocol:[//host][:port]/appname[/instanceName]

    -

    Use one of the following protocols: rtmp, - rtmpe, rtmps, rtmpt, rtmpte, or rtmfp. - If the connection is successful, a - netStatus event with a code property of - NetConnection.Connect.Success is returned. - See the NetStatusEvent.info property for a list of - all event codes returned in response to calling connect().

    -

    If the file is served from the same host where the server is installed, - you can omit the //host parameter. If you omit the /instanceName parameter, - Flash Player or AIR connects to the application's default instance.

    -

    (Flash Player 10.1 or AIR 2 or later)To create peer-to-peer applications, use the rtmfp protocol.

    -
    • -
-
 
... arguments — Optional parameters of any type passed to the application - specified in command. - With Flash Media Server, the additional arguments are passed to the - application.onConnect() event handler in the application's server-side - code. You must define and handle the arguments in onConnect(). -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — The URI passed to the command parameter is - improperly formatted. -
 
Error — The connection failed. This can happen if you call connect() - from within a netStatus event handler, which is not allowed. -
 
SecurityError — Local-with-filesystem SWF files cannot communicate with the Internet. - You can avoid this problem by reclassifying the SWF file as local-with-networking or trusted. -
 
SecurityError — You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide. -
-

-See also -

-
-flash.net.NetStream -
-flash.events.NetStatusEvent.info -
-
-
Event detail
- - - - - -
asyncErrorevent 
-
-Event object type: flash.events.AsyncErrorEvent -
-AsyncErrorEvent.type property = flash.events.AsyncErrorEvent.ASYNC_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code. -

- The AsyncErrorEvent.ASYNC_ERROR constant defines the value of the - type property of an asyncError event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse - This property applies to ActionScript 3.0 display objects (in SWF files).
cancelablefalse; there is no default - behavior to cancel. This property applies to display objects - in SWF content, which use the ActionScript 3.0 display architecture.
currentTargetThe object that is actively processing the - Event object with an event listener. This property applies to display - objects in SWF content, which use the ActionScript 3.0 display architecture.
target The object dispatching the event.
errorThe error that triggered the event.
- -
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when an input or output error occurs that causes a network operation to fail. -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -
- - - - - -
netStatusevent  
-
-Event object type: flash.events.NetStatusEvent -
-NetStatusEvent.type property = flash.events.NetStatusEvent.NET_STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a NetConnection object is reporting its status or error condition. - The netStatus event contains an info property, - which is an information object that contains specific information about the event, - such as whether a connection attempt succeeded or failed. -

- Defines the value of the type property of a netStatus event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
infoAn object with properties that describe the object's status or error condition.
targetThe NetConnection or NetStream object reporting its status.
-

-See also -

-
-flash.events.NetStatusEvent.info -
-
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched if a call to NetConnection.call() - attempts to connect to a server outside the caller's security sandbox. -

- The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- -

-See also -

-
-NetConnection.call() -
-
- -
Examples
-
examples\NetConnectionExample
-
The following example uses a Video object with the NetConnection and - NetStream classes to load and play an FLV file. - -

In this example, the code that creates the Video and NetStream objects and calls the - Video.attachNetStream() and NetStream.play() methods is placed - in a handler function. The handler is called only if the - attempt to connect to the NetConnection object is successful; that is, - when the netStatus event returns an info object with a code - property that indicates success. - It is recommended that you wait for a successful connection before you call - NetStream.play().

-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.NetStatusEvent;
-    import flash.events.SecurityErrorEvent;
-    import flash.media.Video;
-    import flash.net.NetConnection;
-    import flash.net.NetStream;
-    import flash.events.Event;
-
-    public class NetConnectionExample extends Sprite {
-        private var videoURL:String = "http://www.helpexamples.com/flash/video/cuepoints.flv";
-        private var connection:NetConnection;
-        private var stream:NetStream;
-        private var video:Video = new Video();    	
-
-        public function NetConnectionExample() {
-            connection = new NetConnection();
-            connection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            connection.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            connection.connect(null);
-        }
-
-        private function netStatusHandler(event:NetStatusEvent):void {
-            switch (event.info.code) {
-                case "NetConnection.Connect.Success":
-                    connectStream();
-                    break;
-                case "NetStream.Play.StreamNotFound":
-                    trace("Stream not found: " + videoURL);
-                    break;
-            }
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-
-        private function connectStream():void {
-            addChild(video);
-            var stream:NetStream = new NetStream(connection);
-            stream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            stream.client = new CustomClient();
-            video.attachNetStream(stream);
-            stream.play(videoURL);
-        }
-    }
-}
-
-class CustomClient {
-    public function onMetaData(info:Object):void {
-        trace("metadata: duration=" + info.duration + " width=" + info.width + " height=" + info.height + " framerate=" + info.framerate);
-    }
-    public function onCuePoint(info:Object):void {
-        trace("cuepoint: time=" + info.time + " name=" + info.name + " type=" + info.type);
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetGroup.html b/html-docs/flash/net/NetGroup.html deleted file mode 100644 index cc2d973..0000000 --- a/html-docs/flash/net/NetGroup.html +++ /dev/null @@ -1,1942 +0,0 @@ - - - - - - - - -flash.net.NetGroup (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class NetGroup
InheritanceNetGroup Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-Instances of the NetGroup class represent membership in an RTMFP group. Use this class -to do the following: -
    -
  • Monitor Quality of Service. The info property contains a NetGroupInfo object whose properties provide -QoS statistics for this group.
    • -
  • Posting. Call post() to broadcast ActionScript messages to all members of a group.
    • -
  • Direct routing. Call sendToNearest(), sendToNeighbor(), and -sendToAllNeighbors() to send a short data message to a specific member of a peer-to-peer group. -The source and the destination do not need to have a direct connection.
    • -
  • Object replication. Call addHaveObjects(), removeHaveObjects(), addWantObjects(), removeWantObjects(), -writeRequestedObject(), and denyRequestedObject() to break up large data into pieces and replicate it to all nodes in a peer-to-peer group.
    • -
-

In the client-side NetGroup class, the NetConnection dispatches the following events:

-
    -
  • NetGroup.Connect.Success
    • -
  • NetGroup.Connect.Failed
    • -
  • NetGroup.Connect.Rejected
    • -
-

The info.group property of the event object contains a reference to the event source (the NetGroup). -The NetGroup dispatches all other events. In the server-side NetGroup class, the NetGroup dispatches all events.

-

For information about using groups with peer-assisted networking, see -Social Media Experiences with Flash Media -and RTMFP, also by Tom Krcha.

-

For information about the technical details behind peer-assisted networking, see P2P on the Flash Platform with RTMFP by Adobe Computer Scientist Matthew Kaufman.

-

-

-See also -

-
-flash.net.GroupSpecifier -
-flash.net.NetStream -
-flash.events.NetStatusEvent info.code values starting with "NetGroup." -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  estimatedMemberCount : Number -
[read-only] - Specifies the estimated number of members of the group, based on local neighbor density and - assuming an even distribution of group addresses.
-		NetGroup
  info : NetGroupInfo -
[read-only] - Returns a NetGroupInfo object whose properties provide Quality of Service - statistics about this NetGroup's RTMFP peer-to-peer data transport.
-		NetGroup
  localCoverageFrom : String -
[read-only] - Specifies the start of the range of group addresses for which this node is the "nearest" and responsible.
-		NetGroup
  localCoverageTo : String -
[read-only] - Specifies the end of the range of group addresses for which this node is the "nearest" and responsible.
-		NetGroup
  neighborCount : Number -
[read-only] - Specifies the number of group members to which this node is directly connected.
-		NetGroup
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  receiveMode : String -
- Specifies this node's routing receive mode as one of values in the NetGroupReceiveMode enum class.
-		NetGroup
  replicationStrategy : String -
- Specifies the object replication fetch strategy.
-		NetGroup
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NetGroup(connection:NetConnection, groupspec:String)
-
- Constructs a NetGroup on the specified NetConnection object and joins it to the group - specified by groupspec.
-		NetGroup
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-addHaveObjects(startIndex:Number, endIndex:Number):void -
-
- Adds objects from startIndex through endIndex, to the set of objects this node - advertises to neighbors as objects for which it fulfills requests.
-		NetGroup
   -
-addMemberHint(peerID:String):Boolean -
-
- Manually adds a record specifying that peerID is a member of the group.
-		NetGroup
   -
-addNeighbor(peerID:String):Boolean -
-
- Manually adds a neighbor by immediately connecting directly to the specified peerID, which must already be - in this group.
-		NetGroup
   -
-addWantObjects(startIndex:Number, endIndex:Number):void -
-
- Adds objects from startIndex through endIndex, to the set of objects to retrieve.
-		NetGroup
   -
-close():void -
-
- Disconnect from the group and close this NetGroup.
-		NetGroup
   -
-convertPeerIDToGroupAddress(peerID:String):String -
-
- Converts a peerID to a group address suitable for use with the sendToNearest() method.
-		NetGroup
   -
-denyRequestedObject(requestID:int):void -
-
- Denies a request received in a NetStatusEvent - NetGroup.Replication.Request for an object previously advertised with - addHaveObjects().
-		NetGroup
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-post(message:Object):String -
-
- Sends a message to all members of a group.
-		NetGroup
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-removeHaveObjects(startIndex:Number, endIndex:Number):void -
-
- Removes objects from startIndex through endIndex, from the set of objects this node - advertises to neighbors as objects for which it fulfills requests.
-		NetGroup
   -
-removeWantObjects(startIndex:Number, endIndex:Number):void -
-
- Removes objects from startIndex through endIndex, from the set of objects to retrieve.
-		NetGroup
   -
-sendToAllNeighbors(message:Object):String -
-
- Sends a message to all neighbors.
-		NetGroup
   -
-sendToNearest(message:Object, groupAddress:String):String -
-
- Sends a message to the neighbor (or local node) nearest to the specified group address.
-		NetGroup
   -
-sendToNeighbor(message:Object, sendMode:String):String -
-
- Sends a message to the neighbor specified by the sendMode parameter.
-		NetGroup
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
   -
-writeRequestedObject(requestID:int, object:Object):void -
-
- Satisfies the request as received by - NetStatusEvent NetGroup.Replication.Request for an object previously - advertised with the addHaveObjects() method.
-		NetGroup
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-netStatus -
-		 - Dispatched when a NetGroup object is reporting its status or error condition.NetGroup
-
- -
- -
Property detail
- - - - - -
estimatedMemberCountproperty
-
-estimatedMemberCount:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the estimated number of members of the group, based on local neighbor density and - assuming an even distribution of group addresses. -

Implementation -
-    public function get estimatedMemberCount():Number -
-

-See also -

-
-neighborCount -
-
- - - - - -
infoproperty 
-
-info:NetGroupInfo  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a NetGroupInfo object whose properties provide Quality of Service - statistics about this NetGroup's RTMFP peer-to-peer data transport. -

Implementation -
-    public function get info():NetGroupInfo -
-

-See also -

-
-flash.net.NetGroupInfo -
-
- - - - - -
localCoverageFromproperty 
-
-localCoverageFrom:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the start of the range of group addresses for which this node is the "nearest" and responsible. - The range is specified in the increasing direction along the group address ring mod 2256. -

Implementation -
-    public function get localCoverageFrom():String -
-

-See also -

-
-localCoverageTo -
-receiveMode -
-sendToNearest() -
-flash.events.NetStatusEvent.info.code="NetGroup.LocalCoverage.Notify" -
-
- - - - - -
localCoverageToproperty 
-
-localCoverageTo:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the end of the range of group addresses for which this node is the "nearest" and responsible. - The range is specified in the increasing direction along the group address ring mod 2256. -

Implementation -
-    public function get localCoverageTo():String -
-

-See also -

-
-localCoverageFrom -
-receiveMode -
-sendToNearest() -
-flash.events.NetStatusEvent.info.code="NetGroup.LocalCoverage.Notify" -
-
- - - - - -
neighborCountproperty 
-
-neighborCount:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of group members to which this node is directly connected. -

Implementation -
-    public function get neighborCount():Number -
-

-See also -

-
-addNeighbor() -
-estimatedMemberCount -
-flash.events.NetStatusEvent.info.code="NetGroup.Neighbor.Connect" -
-flash.events.NetStatusEvent.info.code="NetGroup.Neighbor.Disconnect" -
-
- - - - - -
receiveModeproperty 
-
-receiveMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies this node's routing receive mode as one of values in the NetGroupReceiveMode enum class. -

Implementation -
-    public function get receiveMode():String -
-    public function set receiveMode(value:String):void -
-

-See also -

-
-localCoverageFrom -
-localCoverageTo -
-sendToNearest() -
-flash.net.NetGroupReceiveMode -
-
- - - - - -
replicationStrategyproperty 
-
-replicationStrategy:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the object replication fetch strategy. The value is one of the enumerated values - in the NetGroupReplicationStrategy class. -

Implementation -
-    public function get replicationStrategy():String -
-    public function set replicationStrategy(value:String):void -
-

-See also -

-
-flash.net.NetGroupReplicationStrategy -
-
- -
Constructor detail
- - - - - -
NetGroup()constructor
-
-public function NetGroup(connection:NetConnection, groupspec:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructs a NetGroup on the specified NetConnection object and joins it to the group - specified by groupspec. -

In most cases, a groupspec has the potential for using the network uplink on the local system. - When a NetStream or NetGroup object is constructed with a groupspec, Flash Player displays a Privacy Dialog. - The dialog asks whether Flash Player can use the connection to share data with a user's peers. - If the user clicks "Allow for this domain", the dialog is not displayed the next time the user connects to this application. - If a user does not allow peer-assisted networking, all peer features within the group (posting, directed routing, and object replication, and multicast) - are disabled. If permission is allowed, a NetStatusEvent is sent to the NetConnection's event listener - with NetGroup.Connect.Success in the code property of the info object. - If permission is denied, the code property is NetGroup.Connect.Rejected. - Until a NetGroup.Connect.Success event is received, an exception is thrown - if you try to call any method of the NetGroup object.

-

Note: When a client subscribes to a native-IP multicast stream, the security dialog is not displayed.

- Parameters - - - - - - - - - - -
connection:NetConnection — A NetConnection object. -
 
groupspec:String — A string specifying the RTMFP peer-to-peer group to join, including its name, capabilities, - restrictions, and the authorizations of this member. - 
-     new NetGroup(myConnection, myGroupSpecifier.groupspecWithAuthorizations());
-
-
-
-Throws - - - - - - - - - - -
ArgumentError — The NetConnection instance is not connected. -
 
Error — The groupspec is invalid. -
-

-See also -

-
-flash.events.NetStatusEvent.info.code="NetGroup.Connect.Success" -
-flash.events.NetStatusEvent.info.code="NetGroup.Connect.Rejected" -
-flash.net.NetConnection -
-flash.net.GroupSpecifier -
-
- -
Method detail
- - - - - -
addHaveObjects()method
-
-public function addHaveObjects(startIndex:Number, endIndex:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Adds objects from startIndex through endIndex, to the set of objects this node - advertises to neighbors as objects for which it fulfills requests. By default, - the Have set is empty. Indices must be whole numbers from 0 through 9007199254740992. -

For more information about object replication, - see "Replicate an object within a group" in Flash Media Server Developer’s Guide.

- -

This method sends a NetStatusEvent to the NetGroup's event listener with "NetGroup.Replication.Request" - in the code property of the info object.

-

NOTE: Test for the NetGroup.Neighbor.Connect event before calling this method.

- - Parameters - - - - - - - - - - -
startIndex:Number — The beginning of the range of object indices to add to the Have set. -
 
endIndex:Number — The end of the range of object indices to add to the Have set. -
-
-Throws - - - - -
RangeError — A number passed to this method is less than 0 - or greater than 9007199254740992. -
-

-See also -

-
-removeHaveObjects() -
-writeRequestedObject() -
-denyRequestedObject() -
-flash.events.NetStatusEvent.info.code="NetGroup.Replication.Request" -
-
- - - - - -
addMemberHint()method 
-
-public function addMemberHint(peerID:String):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Manually adds a record specifying that peerID is a member of the group. - An immediate connection to it is attempted only if it is needed for the topology. -

Parameters - - - - -
peerID:String — The peerID to add to the set of potential neighbors. -
-

-Returns - - - - -
Boolean — - TRUE for success, FALSE for failure. - - -
-

-See also -

-
-addNeighbor() -
-
- - - - - -
addNeighbor()method 
-
-public function addNeighbor(peerID:String):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Manually adds a neighbor by immediately connecting directly to the specified peerID, which must already be - in this group. This direct connection may later be dropped if it is not needed for the topology. -

Parameters - - - - -
peerID:String — The peerID to which to immediately connect. -
-

-Returns - - - - -
Boolean — - TRUE for success, FALSE for failure. - - -
-

-See also -

-
-addMemberHint() -
-
- - - - - -
addWantObjects()method 
-
-public function addWantObjects(startIndex:Number, endIndex:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Adds objects from startIndex through endIndex, to the set of objects to retrieve. - Indices must be whole numbers from 0 through 9007199254740992. - By default, the Want set is empty. -

For more information about object replication, - see "Replicate an object within a group" in Flash Media Server Developer’s Guide.

- -

This method sends a NetStatusEvent to the NetGroup's event listener with - NetGroup.Replication.Fetch.SendNotify - in the info.code property. This event is followed by an NetGroup.Replication.Fetch.Failed - or NetGroup.Replication.Fetch.Result event.

-

NOTE: Test for the NetGroup.Neighbor.Connect event before calling this method.

- - Parameters - - - - - - - - - - -
startIndex:Number — The beginning of the range of object indices to add to the Want set. -
 
endIndex:Number — The end of the range of object indices to add to the Want set. -
-
-Throws - - - - -
RangeError — A number passed to this method is less than 0 - or greater than 9007199254740992. -
-

-See also -

-
-removeWantObjects() -
-flash.events.NetStatusEvent.info.code="NetGroup.Replication.Fetch.SendNotify" -
-flash.events.NetStatusEvent.info.code="NetGroup.Replication.Fetch.Failed" -
-flash.events.NetStatusEvent.info.code="NetGroup.Replication.Fetch.Result" -
-
- - - - - -
close()method 
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Disconnect from the group and close this NetGroup. This NetGroup is not usable after calling this method. -

- - - - - -
convertPeerIDToGroupAddress()method 
-
-public function convertPeerIDToGroupAddress(peerID:String):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Converts a peerID to a group address suitable for use with the sendToNearest() method. -

Parameters - - - - -
peerID:String — The peerID to convert. -
-

-Returns - - - - -
String — - The group address for the peerID. - - -
-

-See also -

-
-flash.net.NetConnection.farID -
-flash.net.NetConnection.nearID -
-flash.net.NetStream.farID -
-sendToNearest() -
-
- - - - - -
denyRequestedObject()method 
-
-public function denyRequestedObject(requestID:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Denies a request received in a NetStatusEvent - NetGroup.Replication.Request for an object previously advertised with - addHaveObjects(). The requestor can request this object again unless - or until it is withdrawn from the Have set. -

For more information about object replication, - see "Replicate an object within a group" in Flash Media Server Developer’s Guide.

- -

NOTE: Test for the NetGroup.Neighbor.Connect event before calling this method.

- - Parameters - - - - -
requestID:int — The request identifier as given in the NetGroup.Replication.Request event. -
-

-See also -

-
-addHaveObjects() -
-writeRequestedObject() -
-flash.events.NetStatusEvent.info.code="NetGroup.Replication.Request" -
-
- - - - - -
post()method 
-
-public function post(message:Object):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Sends a message to all members of a group. To call this method, - the GroupSpecifier.postingEnabled property must be true in the groupspec passed to the - NetGroup constructor. For more information, see "Post messages to a group" - in Flash Media Server Developer’s Guide. -

All messages must be unique. A message that is identical to one posted - earlier might not be propagated. Use a sequence number to make messages unique.

-

Message delivery is not ordered. Message delivery is not guaranteed.

-

Messages are serialized in AMF. The message can be one of the following types: - an Object, an int, a Number, or a String. The message cannot be a MovieClip.

-

This method sends a NetStatusEvent to the NetGroup's event listener - with "NetGroup.Posting.Notify" in the info.code property. The "NetGroup.Posting.Notify" event - is dispatched to the NetGroup on both the client and the server.

-

NOTE: Test for the NetGroup.Neighbor.Connect event before calling this method.

- - Parameters - - - - -
message:Object — The message to send to all other members of the group. -
-

-Returns - - - - -
String — - The messageID of the message if posted, or null on error. The messageID is the hexadecmial of the SHA256 of the raw - bytes of the serialization of the message. - - -
-

-See also -

-
-flash.events.NetStatusEvent.info.code="NetGroup.Posting.Notify" -
-
-Example -
This is a simple text chat application that uses peer-to-peer networking. - The application connects over RTMFP to Flash Media Server. - The server keeps the client applications' fingerprints and manages the peer group as clients connect. However, all data is sent between clients (peers) -- - data is not sent back to the server. - -

When you run the application, you can enter any group name into the text input field. The GroupSpecifier class uses the name (along with any - GroupSpecifier properties you've set) to create a string which is the perpetually unique name of the group. To connect another client to the group, that client must use - the same group name. For example, if client A uses the group name "firstmesh", other clients that want to communicate with client A must also use the group - name "firstmesh". If client B uses the group name "kite", it will connect successfully, but it will create a new group and won't be able to communicate with - client A or anyone in the "firstmesh" group.

- -

To run this example, add a Button, a Label, a TextInput, and a TextArea component to the Library in Flash Pro.

- -
-
-
-
-
-package  {
-
-    import flash.display.Sprite;
-    import flash.events.TextEvent;
-    import flash.events.MouseEvent;
-	import flash.events.NetStatusEvent;
-	import fl.events.ComponentEvent;
-	import fl.controls.Label;
-	import fl.controls.Button;
-	import fl.controls.TextInput;
-	import fl.controls.TextArea;
-	import flash.text.TextFieldAutoSize;
-	import flash.net.*;
-
-	public class NetGroupPostExample extends Sprite{
-
-		private var connectButton:Button;
-		private var disconnectButton:Button;
-		private var groupNameText:TextInput;
-		private var userNameText:TextInput;
-		private var chatText:TextInput;
-		private var statusLog:TextArea;
-		private var groupLabel:Label;
-		private var userLabel:Label;
-
-		private var netConnection:NetConnection = null;
-		private var netGroup:NetGroup = null;
-		private var sequenceNumber:uint = 0;
-		private var connected:Boolean = false;
-		private var joinedGroup:Boolean = false;
-
-		private const SERVER:String = "rtmfp://fms.example.com/someapp";
-
-		public function NetGroupPostExample() {
-			DoUI();
-		}
-
-		// Writes messages to the TextArea.
-		private function StatusMessage(msg:Object):void{
-			statusLog.text += msg;
-			statusLog.verticalScrollPosition = statusLog.textHeight;
-			statusLog.validateNow();
-		}
-
-		// Handles all NetStatusEvents for the NetConnection and the NetGroup.
-		// This code includes cases it doesn't handle so you can see the cases
-		// and their info objects for learning purposes.
-		private function NetStatusHandler(e:NetStatusEvent):void{
-			StatusMessage(e.info.code + "\n");
-			switch(e.info.code){
-				case "NetConnection.Connect.Success":
-					connectButton.enabled = false;
-					disconnectButton.enabled = true;
-					OnConnect();
-					break;
-
-				case "NetConnection.Connect.Closed":
-					OnDisconnect();
-					break;
-
-				case "NetGroup.Connect.Success": // e.info.group
-					OnNetGroupConnect();
-					break;
-
-				case "NetGroup.Connect.Rejected": // e.info.group
-				case "NetGroup.Connect.Failed": // e.info.group
-					break;
-
-				case "NetGroup.Posting.Notify": // e.info.message, e.info.messageID
-					OnPosting(e.info.message);
-					break;
-
-				case "NetStream.MulticastStream.Reset":
-				case "NetStream.Buffer.Full":
-					break;
-
-				case "NetGroup.SendTo.Notify": // e.info.message, e.info.from, e.info.fromLocal
-				case "NetGroup.LocalCoverage.Notify": //
-				case "NetGroup.Neighbor.Connect": // e.info.neighbor
-				case "NetGroup.Neighbor.Disconnect": // e.info.neighbor
-				case "NetGroup.MulticastStream.PublishNotify": // e.info.name
-				case "NetGroup.MulticastStream.UnpublishNotify": // e.info.name
-				case "NetGroup.Replication.Fetch.SendNotify": // e.info.index
-				case "NetGroup.Replication.Fetch.Failed": // e.info.index
-				case "NetGroup.Replication.Fetch.Result": // e.info.index, e.info.object
-				case "NetGroup.Replication.Request": // e.info.index, e.info.requestID
-				default:
-					break;
-				}
-			}
-		// Creates a NetConnection to Flash Media Server if the app isn't already connected
-		// and if there's a group name in the TextInput field.
-		private function DoConnect(e:MouseEvent):void{
-			if(!connected && (groupNameText.length > 0)){
-				StatusMessage("Connecting to \"" + SERVER + "\" ...\n");
-				netConnection = new NetConnection();
-				netConnection.addEventListener(NetStatusEvent.NET_STATUS, NetStatusHandler);
-				// To connect to Flash Media Server, pass the server name.
-				netConnection.connect(SERVER);
-			}
-			else
-			{
-				StatusMessage("Enter a group name");
-			}
-		}
-
-		// Called in the "NetConnection.Connect.Success" case in the NetStatusEvent handler.
-		private function OnConnect():void{
-
-			StatusMessage("Connected\n");
-			connected = true;
-
-			// Create a GroupSpecifier object to pass to the NetGroup constructor.
-			// The GroupSpecifier determines the properties of the group
-			var groupSpecifier:GroupSpecifier;
-			groupSpecifier = new GroupSpecifier("aslrexample/" + groupNameText.text);
-			groupSpecifier.postingEnabled = true;
-			groupSpecifier.serverChannelEnabled = true;
-
-			netGroup = new NetGroup(netConnection, groupSpecifier.groupspecWithAuthorizations());
-			netGroup.addEventListener(NetStatusEvent.NET_STATUS, NetStatusHandler);
-
-			StatusMessage("Join \"" + groupSpecifier.groupspecWithAuthorizations() + "\"\n");
-
-		}
-
-		private function OnNetGroupConnect():void{
-			joinedGroup = true;
-		}
-
-		private function DoDisconnect(e:MouseEvent):void{
-			if(netConnection){
-				netConnection.close();
-			}
-		}
-
-		private function OnDisconnect():void{
-			StatusMessage("Disconnected\n");
-			netConnection = null;
-			netGroup = null;
-			connected = false;
-			joinedGroup = false;
-			connectButton.enabled = true;
-			disconnectButton.enabled = false;
-		}
-
-		private function ClearChatText():void{
-			chatText.text = "";
-		}
-
-		// Called when you the chatText field has focus and you press Enter.
-		private function DoPost(e:ComponentEvent):void{
-			if(joinedGroup){
-				var message:Object = new Object;
-				message.user = userNameText.text;
-				message.text = chatText.text;
-				message.sequence = sequenceNumber++;
-				message.sender = netConnection.nearID;
-
-				netGroup.post(message);
-				StatusMessage("==> " + chatText.text + "\n");
-			} else {
-				StatusMessage("Click Connect before sending a chat message");
-			}
-			ClearChatText();
-		}
-
-		private function OnPosting(message:Object):void{
-			StatusMessage("<" + message.user + "> " + message.text + "\n");
-		}
-
-		private function DoUI():void {
-
-			groupLabel = new Label();
-			groupLabel.move(20, 10);
-			groupLabel.autoSize = TextFieldAutoSize.LEFT
-			groupLabel.text = "Group name:"
-			addChild(groupLabel);
-
-			groupNameText = new TextInput();
-			groupNameText.move(90, 10);
-			groupNameText.text = "channel" + (int(Math.random() * 899) + 101);
-			addChild(groupNameText);
-
-        	connectButton = new Button();
-			connectButton.addEventListener(MouseEvent.CLICK, DoConnect);
-			connectButton.move(205, 10);
-			connectButton.label = "Connect";
-			addChild(connectButton);
-
-			disconnectButton = new Button();
-			disconnectButton.addEventListener(MouseEvent.CLICK, DoDisconnect);
-			disconnectButton.move(310, 10);
-			disconnectButton.label = "Disconnect";
-			disconnectButton.enabled = false;
-			addChild(disconnectButton);
-
-			statusLog = new TextArea();
-			statusLog.move(30, 38);
-			statusLog.width = 360;
-			statusLog.height = 215;
-			statusLog.editable = false;
-			addChild(statusLog);
-
-			userLabel = new Label();
-			userLabel.move(20, 270);
-			userLabel.autoSize = TextFieldAutoSize.LEFT
-			userLabel.text = "User name:"
-			addChild(userLabel);
-
-			userNameText = new TextInput();
-			userNameText.move(80, 270);
-			userNameText.text = "user " + int(Math.random() * 65536);
-			addChild(userNameText);
-
-			chatText = new TextInput();
-			chatText.addEventListener(ComponentEvent.ENTER, DoPost);
-			chatText.move(185, 270);
-			chatText.maxChars = 255;
-			chatText.width = 215;
-			addChild(chatText);
-
-		}
-
-		public function onPlayStatus(info:Object):void {}
-		public function onMetaData(info:Object):void {}
-		public function onCuePoint(info:Object):void {}
-		public function onTextData(info:Object):void {}
-
-	}
-
-}
-
-

-
- - - - - -
removeHaveObjects()method 
-
-public function removeHaveObjects(startIndex:Number, endIndex:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Removes objects from startIndex through endIndex, from the set of objects this node - advertises to neighbors as objects for which it fulfills requests. - Indices must be whole numbers from 0 through 9007199254740992. -

For more information about object replication, - see "Replicate an object within a group" in Flash Media Server Developer’s Guide.

- -

NOTE: Test for the NetGroup.Neighbor.Connect event before calling this method.

- - Parameters - - - - - - - - - - -
startIndex:Number — The beginning of the range of object indices to remove from the Have set. -
 
endIndex:Number — The end of the range of object indices to remove from the Have set. -
-
-Throws - - - - -
RangeError — A number passed to this method is less than 0 - or greater than 9007199254740992. -
-

-See also -

-
-addHaveObjects() -
-
- - - - - -
removeWantObjects()method 
-
-public function removeWantObjects(startIndex:Number, endIndex:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Removes objects from startIndex through endIndex, from the set of objects to retrieve. - Indices must be whole numbers from 0 through 9007199254740992. -

For more information about object replication, - see "Replicate an object within a group" in Flash Media Server Developer’s Guide.

- -

NOTE: Test for the NetGroup.Neighbor.Connect event before calling this method.

- - Parameters - - - - - - - - - - -
startIndex:Number — The beginning of the range of object indices to remove from the Want set. -
 
endIndex:Number — The end of the range of object indices to remove from the Want set. -
-
-Throws - - - - -
RangeError — A number passed to this method is less than 0 - or greater than 9007199254740992. -
-

-See also -

-
-addWantObjects() -
-
- - - - - -
sendToAllNeighbors()method 
-
-public function sendToAllNeighbors(message:Object):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Sends a message to all neighbors. Returns NetGroupSendResult.SENT if at least one neighbor was selected. -

For more information about routing messages, see - "Route messages directly to a peer" in Flash Media Server Developer’s Guide.

-

When a node receives a message, a NetStatusEvent is sent to the NetGroup's event listener - with NetGroup.SendTo.Notify - in the code property of the info object.

-

NOTE: Test for the NetGroup.Neighbor.Connect event before calling this method.

- - Parameters - - - - -
message:Object — The message to send. -
-

-Returns - - - - -
String — - A property of enumeration class NetGroupSendResult indicating the success or failure of the send. - - -
-

-See also -

-
-sendToNeighbor() -
-flash.events.NetStatusEvent.info.code="NetGroup.SendTo.Notify" -
-flash.net.NetGroupSendResult -
-
- - - - - -
sendToNearest()method 
-
-public function sendToNearest(message:Object, groupAddress:String):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Sends a message to the neighbor (or local node) nearest to the specified group address. - Considers neighbors from the entire ring. Returns NetGroupSendResult.SENT if the message - was successfully sent toward its destination. -

For more information about routing messages, see - "Route messages directly to a peer" in Flash Media Server Developer’s Guide.

-

When a node receives a message, a NetStatusEvent is sent to the NetGroup's event listener - with NetGroup.SendTo.Notify - in the code property of the info object.

-

NOTE: Test for the NetGroup.Neighbor.Connect event before calling this method.

- - Parameters - - - - - - - - - - -
message:Object — The message to send. -
 
groupAddress:String — The group address toward which to route the message. -
-

-Returns - - - - -
String — - A property of enumeration class NetGroupSendResult indicating the success or failure of the send. - - -
-

-See also -

-
-convertPeerIDToGroupAddress() -
-receiveMode -
-flash.net.NetGroupSendResult -
-flash.events.NetStatusEvent.info.code="NetGroup.SendTo.Notify" -
-
- - - - - -
sendToNeighbor()method 
-
-public function sendToNeighbor(message:Object, sendMode:String):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Sends a message to the neighbor specified by the sendMode parameter. - Returns NetGroupSendResult.SENT if the message was successfully sent to the requested destination. -

For more information about routing messages, see - "Route messages directly to a peer" in Flash Media Server Developer’s Guide.

-

When a node receives a message, a NetStatusEvent is sent to the NetGroup's event listener - with NetGroup.SendTo.Notify - in the code property of the info object.

-

NOTE: Test for the NetGroup.Neighbor.Connect event before calling this method.

- - Parameters - - - - - - - - - - -
message:Object — The message to send. -
 
sendMode:String — A property of enumeration class NetGroupSendMode specifying the neighbor to which to send the message. -
-

-Returns - - - - -
String — - A property of enumeration class NetGroupSendResult indicating the success or failure of the send. - - -
-

-See also -

-
-sendToAllNeighbors() -
-flash.events.NetStatusEvent.info.code="NetGroup.SendTo.Notify" -
-flash.net.NetGroupSendMode -
-flash.net.NetGroupSendResult -
-
- - - - - -
writeRequestedObject()method 
-
-public function writeRequestedObject(requestID:int, object:Object):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Satisfies the request as received by - NetStatusEvent NetGroup.Replication.Request for an object previously - advertised with the addHaveObjects() method. The object - can be any of the following: An Object, an int, a Number, and a String. - The object cannot be a MovieClip. -

For more information about object replication, - see "Replicate an object within a group" in Flash Media Server Developer’s Guide.

- -

NOTE: Test for the NetGroup.Neighbor.Connect event before calling this method.

- - Parameters - - - - - - - - - - -
requestID:int — The request identifier as given in the NetGroup.Replication.Request event. -
 
object:Object — The object corresponding to the index given in the NetGroup.Replication.Request event. -
-

-See also -

-
-addHaveObjects() -
-denyRequestedObject() -
-flash.events.NetStatusEvent.info.code="NetGroup.Replication.Request" -
-
-
Event detail
- - - - - -
netStatusevent 
-
-Event object type: flash.events.NetStatusEvent -
-NetStatusEvent.type property = flash.events.NetStatusEvent.NET_STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a NetGroup object is reporting its status or error condition. - The netStatus event contains an info property. - The info property is an object that contains information about the event, - such as whether a connection attempt succeeded or failed. -

- Defines the value of the type property of a netStatus event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
infoAn object with properties that describe the object's status or error condition.
targetThe NetConnection or NetStream object reporting its status.
-

-See also -

-
-flash.events.NetStatusEvent.info -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetGroupInfo.html b/html-docs/flash/net/NetGroupInfo.html deleted file mode 100644 index cc98098..0000000 --- a/html-docs/flash/net/NetGroupInfo.html +++ /dev/null @@ -1,584 +0,0 @@ - - - - - - - - -flash.net.NetGroupInfo (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class NetGroupInfo
InheritanceNetGroupInfo Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-The NetGroupInfo class specifies various Quality of Service (QoS) statistics -related to a NetGroup object's underlying RTMFP Peer-to-Peer data transport. -The NetGroup.info property returns a NetGroupInfo object which is -a snapshot of the current QoS state. -

-

-See also -

-
-flash.net.NetGroup.info -
-flash.net.NetGroup.post() -
-flash.net.NetGroup.sendToNearest() -
-flash.net.NetGroup.sendToNeighbor() -
-flash.net.NetGroup.sendToAllNeighbors() -
-flash.net.NetGroup.addWantObjects() -
-flash.net.NetGroup.writeRequestedObject() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  objectReplicationReceiveBytesPerSecond : Number -
[read-only] - Specifies the rate at which the local node is receiving objects from - peers via the Object Replication system, in bytes per second.
-		NetGroupInfo
  objectReplicationSendBytesPerSecond : Number -
[read-only] - Specifies the rate at which objects are being copied from the local node to peers - by the Object Replication system, in bytes per second.
-		NetGroupInfo
  postingReceiveControlBytesPerSecond : Number -
[read-only] - Specifies the rate at which the local node is receiving posting control overhead messages from peers, in bytes per second.
-		NetGroupInfo
  postingReceiveDataBytesPerSecond : Number -
[read-only] - Specifies the rate at which the local node is receiving posting data from - peers, in bytes per second.
-		NetGroupInfo
  postingSendControlBytesPerSecond : Number -
[read-only] - Specifies the rate at which the local node is sending posting control overhead messages to peers, in bytes per second.
-		NetGroupInfo
  postingSendDataBytesPerSecond : Number -
[read-only] - Specifies the rate at which the local node is sending posting data to - peers, in bytes per second.
-		NetGroupInfo
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  routingReceiveBytesPerSecond : Number -
[read-only] - Specifies the rate at which the local node is receiving directed routing messages - from peers, in bytes per second.
-		NetGroupInfo
  routingSendBytesPerSecond : Number -
[read-only] - Specifies the rate at which the local node is sending directed routing messages to - peers, in bytes per second.
-		NetGroupInfo
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string containing the values of the properties of the NetGroupInfo object.
-		NetGroupInfo
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
objectReplicationReceiveBytesPerSecondproperty
-
-objectReplicationReceiveBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is receiving objects from - peers via the Object Replication system, in bytes per second. -

Implementation -
-    public function get objectReplicationReceiveBytesPerSecond():Number -
-

-See also -

-
-flash.net.NetGroup.writeRequestedObject() -
-
- - - - - -
objectReplicationSendBytesPerSecondproperty 
-
-objectReplicationSendBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which objects are being copied from the local node to peers - by the Object Replication system, in bytes per second. -

Implementation -
-    public function get objectReplicationSendBytesPerSecond():Number -
-

-See also -

-
-flash.net.NetGroup.writeRequestedObject() -
-
- - - - - -
postingReceiveControlBytesPerSecondproperty 
-
-postingReceiveControlBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is receiving posting control overhead messages from peers, in bytes per second. -

Implementation -
-    public function get postingReceiveControlBytesPerSecond():Number -
-

-See also -

-
-flash.net.NetGroup.post() -
-
- - - - - -
postingReceiveDataBytesPerSecondproperty 
-
-postingReceiveDataBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is receiving posting data from - peers, in bytes per second. -

Implementation -
-    public function get postingReceiveDataBytesPerSecond():Number -
-

-See also -

-
-flash.net.NetGroup.post() -
-
- - - - - -
postingSendControlBytesPerSecondproperty 
-
-postingSendControlBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is sending posting control overhead messages to peers, in bytes per second. -

Implementation -
-    public function get postingSendControlBytesPerSecond():Number -
-

-See also -

-
-flash.net.NetGroup.post() -
-
- - - - - -
postingSendDataBytesPerSecondproperty 
-
-postingSendDataBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is sending posting data to - peers, in bytes per second. -

Implementation -
-    public function get postingSendDataBytesPerSecond():Number -
-

-See also -

-
-flash.net.NetGroup.post() -
-
- - - - - -
routingReceiveBytesPerSecondproperty 
-
-routingReceiveBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is receiving directed routing messages - from peers, in bytes per second. -

Implementation -
-    public function get routingReceiveBytesPerSecond():Number -
-

-See also -

-
-flash.net.NetGroup.sendToNearest() -
-flash.net.NetGroup.sendToNeighbor() -
-flash.net.NetGroup.sendToAllNeighbors() -
-
- - - - - -
routingSendBytesPerSecondproperty 
-
-routingSendBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is sending directed routing messages to - peers, in bytes per second. -

Implementation -
-    public function get routingSendBytesPerSecond():Number -
-

-See also -

-
-flash.net.NetGroup.sendToNearest() -
-flash.net.NetGroup.sendToNeighbor() -
-flash.net.NetGroup.sendToAllNeighbors() -
-
- -
Method detail
- - - - - -
toString()method
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a string containing the values of the properties of the NetGroupInfo object. -

-Returns - - - - -
String — - A string containing the values of the properties of the NetGroupInfo object - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetGroupReceiveMode.html b/html-docs/flash/net/NetGroupReceiveMode.html deleted file mode 100644 index 2bc7ddf..0000000 --- a/html-docs/flash/net/NetGroupReceiveMode.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - - - -flash.net.NetGroupReceiveMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class NetGroupReceiveMode
InheritanceNetGroupReceiveMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-The NetGroupReceiveMode class is an enumeration of constant values used for the receiveMode property -of the NetGroup class. -

-

-See also -

-
-flash.net.NetGroup.receiveMode -
-flash.net.NetGroup.sendToNearest() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  EXACT : String = "exact"
[static] - Specifies that this node accepts local messages from neighbors only if the address the neighbor uses - matches this node's address exactly.
-		NetGroupReceiveMode
  NEAREST : String = "nearest"
[static] - Specifies that this node accepts local messages from neighbors that send messages to group - addresses that don't match this node's address exactly.
-		NetGroupReceiveMode
-
- -
- -
Constant detail
- - - - - -
EXACTconstant
-
-public static const EXACT:String = "exact" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Specifies that this node accepts local messages from neighbors only if the address the neighbor uses - matches this node's address exactly. That is, this node considers itself as nearest for any - NetGroup.sendToNearest() call only if the groupAddress parameter passed to - NetGroup.sendToNearest() matches this node's group address exactly. - This value is the default setting. -

If you want to enable distributed routing behavior, set this value - to NetGroupReceiveMode.NEAREST. With this value set, a node waits for its connectivity to stabilize - before participating in the Directed Routing mesh.

- -

-See also -

-
-flash.net.NetGroup.sendToNearest() -
-
- - - - - -
NEARESTconstant 
-
-public static const NEAREST:String = "nearest" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Specifies that this node accepts local messages from neighbors that send messages to group - addresses that don't match this node's address exactly. Messages are received when this node is nearest among all neighbors whose - receive mode is NetGroupReceiveMode.NEAREST. Distance is measured between addresses on the ring mod 2256. - -

-See also -

-
-flash.net.NetGroup.sendToNearest() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetGroupReplicationStrategy.html b/html-docs/flash/net/NetGroupReplicationStrategy.html deleted file mode 100644 index 902c074..0000000 --- a/html-docs/flash/net/NetGroupReplicationStrategy.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - -flash.net.NetGroupReplicationStrategy (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class NetGroupReplicationStrategy
InheritanceNetGroupReplicationStrategy Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-The NetGroupReplicationStrategy class is an enumeration of constant values used in setting the replicationStrategy property -of the NetGroup class. -

-

-See also -

-
-flash.net.NetGroup.addWantObjects() -
-flash.net.NetGroup.replicationStrategy -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  LOWEST_FIRST : String = "lowestFirst"
[static] - Specifies that when fetching objects from a neighbor to satisfy a want, the objects with the - lowest index numbers are requested first.
-		NetGroupReplicationStrategy
  RAREST_FIRST : String = "rarestFirst"
[static] - Specifies that when fetching objects from a neighbor to satisfy a want, the objects with - the fewest replicas among all the neighbors are requested first.
-		NetGroupReplicationStrategy
-
- -
- -
Constant detail
- - - - - -
LOWEST_FIRSTconstant
-
-public static const LOWEST_FIRST:String = "lowestFirst" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Specifies that when fetching objects from a neighbor to satisfy a want, the objects with the - lowest index numbers are requested first. - -

-See also -

-
-flash.net.NetGroup.addWantObjects() -
-
- - - - - -
RAREST_FIRSTconstant 
-
-public static const RAREST_FIRST:String = "rarestFirst" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Specifies that when fetching objects from a neighbor to satisfy a want, the objects with - the fewest replicas among all the neighbors are requested first. - -

-See also -

-
-NetGroup.addWantObjects() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetGroupSendMode.html b/html-docs/flash/net/NetGroupSendMode.html deleted file mode 100644 index 46407b3..0000000 --- a/html-docs/flash/net/NetGroupSendMode.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - - - - -flash.net.NetGroupSendMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class NetGroupSendMode
InheritanceNetGroupSendMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-The NetGroupSendMode class is an enumeration of constant values used for the sendMode parameter of the NetGroup.sendToNeighbor() -method. -

-

-See also -

-
-flash.net.NetGroup.sendToNeighbor() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  NEXT_DECREASING : String = "nextDecreasing"
[static] - Specifies the neighbor with the nearest group address in the decreasing direction.
-		NetGroupSendMode
  NEXT_INCREASING : String = "nextIncreasing"
[static] - Specifies the neighbor with the nearest group address in the increasing direction.
-		NetGroupSendMode
-
- -
- -
Constant detail
- - - - - -
NEXT_DECREASINGconstant
-
-public static const NEXT_DECREASING:String = "nextDecreasing" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Specifies the neighbor with the nearest group address in the decreasing direction. - -

- - - - - -
NEXT_INCREASINGconstant 
-
-public static const NEXT_INCREASING:String = "nextIncreasing" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Specifies the neighbor with the nearest group address in the increasing direction. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetGroupSendResult.html b/html-docs/flash/net/NetGroupSendResult.html deleted file mode 100644 index ac9dc8e..0000000 --- a/html-docs/flash/net/NetGroupSendResult.html +++ /dev/null @@ -1,312 +0,0 @@ - - - - - - - - -flash.net.NetGroupSendResult (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class NetGroupSendResult
InheritanceNetGroupSendResult Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

-The NetGroupSendResult class is an enumeration of constant values used for the return value of the -Directed Routing methods associated with a NetGroup instance. -

-

-See also -

-
-flash.net.NetGroup.sendToNearest() -
-flash.net.NetGroup.sendToNeighbor() -
-flash.net.NetGroup.sendToAllNeighbors() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  ERROR : String = "error"
[static] - Indicates an error occurred (such as no permission) when using a Directed Routing method.
-		NetGroupSendResult
  NO_ROUTE : String = "no route"
[static] - Indicates no neighbor could be found to route the message toward its requested destination.
-		NetGroupSendResult
  SENT : String = "sent"
[static] - Indicates that a route was found for the message and it was forwarded toward its destination.
-		NetGroupSendResult
-
- -
- -
Constant detail
- - - - - -
ERRORconstant
-
-public static const ERROR:String = "error" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates an error occurred (such as no permission) when using a Directed Routing method. - -

- - - - - -
NO_ROUTEconstant 
-
-public static const NO_ROUTE:String = "no route" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates no neighbor could be found to route the message toward its requested destination. - -

- - - - - -
SENTconstant 
-
-public static const SENT:String = "sent" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that a route was found for the message and it was forwarded toward its destination. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetMonitor.html b/html-docs/flash/net/NetMonitor.html deleted file mode 100644 index b7ef497..0000000 --- a/html-docs/flash/net/NetMonitor.html +++ /dev/null @@ -1,401 +0,0 @@ - - - - - - - - -flash.net.NetMonitor (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class NetMonitor
InheritanceNetMonitor Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

-

- The NetMonitor class maintains a list of NetStream objects. - -

Use the NetMonitor class to keep track of NetStream objects in use in an application. An instance of this class - dispatches a netStreamCreate event whenever a new NetStream object is created.

-

You can use the NetMonitor class to help track video playback and related events without regard to the specific - video player being used. This facility can be helpful when implementing media measurement, analytics, and usage tracking - libraries.

- -

Note: NetStream monitoring is not supported by Flash Player in the browser on Android and Blackberry Tablet OS, or - by AIR on iOS.

- -

-

-See also -

-
-NetStream -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-listStreams():Vector.<NetStream>
-
- Retrieves all NetStream objects belonging to this NetMonitor object's security context.
-		NetMonitor
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-netStreamCreate -
-		 - Dispatched when a new NetStream object is created within the security context of this NetMonitor instance.NetMonitor
-
- -
- -
Method detail
- - - - - -
listStreams()method
-
-public function listStreams():Vector.<NetStream> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Retrieves all NetStream objects belonging to this NetMonitor object's security context. -

Avoid caching the list of NetStream objects. Maintaining a reference to these NetStream objects - can introduce memory leaks into an application by preventing the garbage collector from reclaiming - an object's resources when it is no longer being used.

- -

Note: if the NetStream monitoring is not supported on the current platform, the list returned by - this function is always empty.

- -

-Returns - - - - -
Vector.<NetStream> — Vector of NetStream objects -
-
-
Event detail
- - - - - -
netStreamCreateevent 
-
-Event object type: flash.events.NetMonitorEvent -
-NetMonitorEvent.type property = flash.events.NetMonitorEvent.NET_STREAM_CREATE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Dispatched when a new NetStream object is created within the security context of this NetMonitor instance. -

Note: if the NetStream monitoring is not supported on the current platform, netStreamCreate events - are not dispatched.

- -

- The NetMonitorEvent.NET_STREAM_CREATE constant defines the value of the type property of an netStreamCreate event object. -

The netStreamCreate event has the following properties:

- - - - - - - -
PropertyValue
netStreamNetStream object that has been created.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object beginning or ending a session.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetStream.html b/html-docs/flash/net/NetStream.html deleted file mode 100644 index bafb8ff..0000000 --- a/html-docs/flash/net/NetStream.html +++ /dev/null @@ -1,5642 +0,0 @@ - - - - - - - - -flash.net.NetStream (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class NetStream
InheritanceNetStream Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The NetStream class opens a one-way streaming channel over a NetConnection. -

Use the NetStream class to do the following:

-
    -
  • Call NetStream.play() to play a media file from a local disk, a web server, or Flash Media Server.
    • -
  • Call NetStream.publish() to publish a video, audio, and data stream to Flash Media Server.
    • -
  • Call NetStream.send() to send data messages to all subscribed clients.
    • -
  • Call NetStream.send() to add metadata to a live stream.
    • -
  • Call NetStream.appendBytes() to pass ByteArray data into the NetStream.
    • -
-

Note:You cannot play and publish a stream over the same NetStream object.

-

Adobe AIR and Flash Player 9.0.115.0 and later versions - support files derived from the standard MPEG-4 container format. These files include F4V, MP4, M4A, MOV, MP4V, 3GP, and 3G2 - if they contain H.264 video, HEAAC v2 encoded audio, or both. H.264 delivers higher quality video at lower bit rates - when compared to the same encoding profile in Sorenson or On2. AAC is a standard audio format defined in the MPEG-4 video standard. - HE-AAC v2 is an extension of AAC that uses Spectral Band Replication (SBR) - and Parametric Stereo (PS) techniques to increase coding efficiency at low bit rates.

-

For information about supported codecs and file formats, see the following:

- -

Receiving data from a Flash Media Server stream, progressive F4V file, or progressive FLV file

-

Flash Media Server, F4V files, and FLV files can send event objects containing data at specific - data points during streaming or playback. You can handle data from a stream or FLV file during playback in two ways:

-
    -
  • - Associate a client property with an event handler to receive the data object. - Use the NetStream.client property to assign an object to call specific - data handling functions. The object assigned to the NetStream.client property - can listen for the following data points: onCuePoint(), - onImageData(), onMetaData(), onPlayStatus(), onSeekPoint(), - onTextData(), and onXMPData(). Write procedures within those functions - to handle the data object returned from the stream during playback. - See the NetStream.client property for more information. -
    • -
  • - Associate a client property with a subclass of the NetStream class, then write - an event handler to receive the data object. NetStream is - a sealed class, which means that properties or methods cannot be added to a NetStream object - at runtime. However, you can create a subclass of NetStream and define your event handler - in the subclass. You can also make the subclass dynamic and add the event handler to an - instance of the subclass. -
    • -
-

Wait to receive a NetGroup.Neighbor.Connect event before you use the object replication, direct routing, or posting APIs.

- -

Note: To send data through an audio file, like an mp3 file, use the Sound class - to associate the audio file with a Sound object. Then, use the Sound.id3 property - to read metadata from the sound file.

-

Support for H.264 encoded video in AIR for iOS

-

For H.264 video, AIR 3.0 (and later) for iOS supports a subset of the full NetStream API. The following table lists NetStream members - for playback that are not supported in AIR for iOS:

- - - - - - - - - - - - - - - -
Unsupported propertiesUnsupported methodsUnsupported events
bufferTimeappendBytes()onCuePoint (works only with FLV files)
bufferLengthappendBytesAction()onImageData
backBufferTimestep()onSeekPoint
backBufferLengthonTextData
bufferTimeMaxonXMPData
bytesLoadeddrmError
currentFPSdrmStatus
inBufferSeekonDRMContentData
infodrmAuthenticate
liveDelayDRM.encryptedFLV status event code
maxPauseBufferTime
soundTransform
All properties describing RTMFP connections
-

For additional information on using AIR for iOS, see the NetStream.play() method.

-

-

-View the examples. -

-

-See also -

-
-flash.media.Video -
-flash.net.NetConnection -
-appendBytes() -
-play() -
-publish() -
-send() -
-onImageData -
-onMetaData -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  audioReliable : Boolean -
- For RTMFP connections, specifies whether audio is sent with full reliability.
-		NetStream
  audioSampleAccess : Boolean -
- For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the audio stream.
-		NetStream
  backBufferLength : Number -
[read-only] - The number of seconds of previously displayed data that currently cached for rewinding and playback.
-		NetStream
  backBufferTime : Number -
- Specifies how much previously displayed data Flash Player tries to cache for rewinding and playback, in seconds.
-		NetStream
  bufferLength : Number -
[read-only] - The number of seconds of data currently in the buffer.
-		NetStream
  bufferTime : Number -
- Specifies how long to buffer messages before starting to display the stream.
-		NetStream
  bufferTimeMax : Number -
- Specifies a maximum buffer length for live streaming content, in seconds.
-		NetStream
  bytesLoaded : uint -
[read-only] - The number of bytes of data that have been loaded into the application.
-		NetStream
  bytesTotal : uint -
[read-only] - The total size in bytes of the file being loaded into the application.
-		NetStream
  checkPolicyFile : Boolean -
- Specifies whether the application tries to download a cross-domain policy file from the - loaded video file's server before beginning to load the video file.
-		NetStream
  client : Object -
- Specifies the object on which callback methods are invoked to handle streaming or F4V/FLV - file data.
-		NetStream
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentFPS : Number -
[read-only] - The number of frames per second being displayed.
-		NetStream
  dataReliable : Boolean -
- For RTMFP connections, specifies whether NetStream.send() calls are sent with full reliability.
-		NetStream
  farID : String -
[read-only] - For RTMFP connections, the identifier of the far end that is connected to this NetStream instance.
-		NetStream
  farNonce : String -
[read-only] - For RTMFP and RTMPE connections, a value chosen substantially by the other end of this stream, unique to this connection.
-		NetStream
  inBufferSeek : Boolean -
- Specifies whether displayed data is cached for smart seeking (TRUE), or not (FALSE).
-		NetStream
  info : NetStreamInfo -
[read-only] - Returns a NetStreamInfo object whose properties contain statistics about the quality of service.
-		NetStream
  liveDelay : Number -
[read-only] - The number of seconds of data in the subscribing stream's - buffer in live (unbuffered) mode.
-		NetStream
  maxPauseBufferTime : Number -
- Specifies how long to buffer messages during pause mode, in seconds.
-		NetStream
  multicastAvailabilitySendToAll : Boolean -
- For RTMFP connections, specifies whether peer-to-peer multicast fragment availability messages are - sent to all peers or to just one peer.
-		NetStream
  multicastAvailabilityUpdatePeriod : Number -
- For RTMFP connections, specifies the interval in seconds between messages sent to peers informing them that - the local node has new peer-to-peer multicast media fragments available.
-		NetStream
  multicastFetchPeriod : Number -
- For RTMFP connections, specifies the time in seconds between when the local node learns that a peer-to-peer - multicast media fragment is available and when it tries to fetch it from a peer.
-		NetStream
  multicastInfo : NetStreamMulticastInfo -
[read-only] - For RTMFP connections, returns a NetStreamMulticastInfo object whose properties contain statistics about the quality of service.
-		NetStream
  multicastPushNeighborLimit : Number -
- For RTMFP connections, specifies the maximum number of peers to which to proactively push - multicast media.
-		NetStream
  multicastRelayMarginDuration : Number -
- For RTMFP connections, specifies the duration in seconds that peer-to-peer multicast data remains - available to send to peers that request it beyond a specified duration.
-		NetStream
  multicastWindowDuration : Number -
- For RTMFP connections, specifies the duration in seconds of the peer-to-peer multicast reassembly - window.
-		NetStream
  nearNonce : String -
[read-only] - For RTMFP and RTMPE connections, a value chosen substantially by this end of the stream, unique to this connection.
-		NetStream
  objectEncoding : uint -
[read-only] - The object encoding (AMF version) for this NetStream object.
-		NetStream
  peerStreams : Array -
[read-only] - An object that holds all of the subscribing NetStream instances that are listening to this publishing NetStream instance.
-		NetStream
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  soundTransform : SoundTransform -
- Controls sound in this NetStream object.
-		NetStream
  time : Number -
[read-only] - The position of the playhead, in seconds.
-		NetStream
  useHardwareDecoder : Boolean -
- Specifies whether to use hardware accelerated decoding on the stream.
-		NetStream
  useJitterBuffer : Boolean -
- Minimize latency for live un-buffered streaming (bufferTime = 0).
-		NetStream
  videoReliable : Boolean -
- For RTMFP connections, specifies whether video is sent with full reliability.
-		NetStream
  videoSampleAccess : Boolean -
- For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the video stream.
-		NetStream
  videoStreamSettings : VideoStreamSettings -
-		NetStream
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NetStream(connection:NetConnection, peerID:String = "connectToFMS")
-
- Creates a stream that you can use to play media files and send data over a NetConnection object.
-		NetStream
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-appendBytes(bytes:ByteArray):void -
-
- Passes a ByteArray into a NetStream for playout.
-		NetStream
   -
-appendBytesAction(netStreamAppendBytesAction:String):void -
-
- Indicates a timescale discontinuity, flushes the FIFO, and tells the byte parser to expect a file header or the beginning of an FLV tag.
-		NetStream
   -
-attach(connection:NetConnection):void -
-
- Attaches a stream to a new NetConnection object.
-		NetStream
   -
-attachAudio(microphone:Microphone):void -
-
- Attaches an audio stream to a NetStream object from a Microphone - object passed as the source.
-		NetStream
   -
-attachCamera(theCamera:Camera, snapshotMilliseconds:int = -1):void -
-
- Starts capturing video from a camera, or stops capturing if - theCamera is set to null.
-		NetStream
   -
-close():void -
-
- Stops playing all data on the stream, sets the time property to 0, - and makes the stream available for another use.
-		NetStream
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-dispose():void -
-
- Releases all the resources held by the NetStream object.
-		NetStream
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-onPeerConnect(subscriber:NetStream):Boolean -
-
- Invoked when a peer-publishing stream matches a peer-subscribing stream.
-		NetStream
   -
-pause():void -
-
- Pauses playback of a video stream.
-		NetStream
   -
-play(... arguments):void -
-
- Plays a media file from a local directory or a web server; plays a media file or a live stream from Flash Media Server.
-		NetStream
   -
-play2(param:NetStreamPlayOptions):void -
-
- Switches seamlessly between files with multiple bit rates and allows a NetStream to resume when a connection is dropped and reconnected.
-		NetStream
   -
-preloadEmbeddedData(param:NetStreamPlayOptions):void -
-
- Extracts any DRM metadata from a locally stored media file.
-		NetStream
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-publish(name:String = null, type:String = null):void -
-
- Sends streaming audio, video, and data messages from a client to Flash Media Server, - optionally recording the stream during transmission.
-		NetStream
   -
-receiveAudio(flag:Boolean):void -
-
- Specifies whether incoming audio plays on the stream.
-		NetStream
   -
-receiveVideo(flag:Boolean):void -
-
- Specifies whether incoming video plays on the stream.
-		NetStream
   -
-receiveVideoFPS(FPS:Number):void -
-
- Specifies the frame rate for incoming video.
-		NetStream
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-resume():void -
-
- Resumes playback of a video stream that is paused.
-		NetStream
   -
-seek(offset:Number):void -
-
- Seeks the keyframe (also called an I-frame in the video industry) closest to - the specified location.
-		NetStream
   -
-send(handlerName:String, ... arguments):void -
-
- Sends a message on a published stream to all subscribing clients.
-		NetStream
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-step(frames:int):void -
-
- Steps forward or back the specified number of frames, relative to the currently displayed frame.
-		NetStream
   -
-togglePause():void -
-
- Pauses or resumes playback of a stream.
-		NetStream
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-asyncError -
-		 - Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code.NetStream
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-drmAuthenticate -
-		 - Dispatched when a NetStream object tries to play a digital rights management (DRM) encrypted - content that requires a user credential for authentication before playing.NetStream
   -
-drmError -
-		 - Dispatched when a NetStream object, trying to play a digital rights management (DRM) encrypted - file, encounters a DRM-related error.NetStream
   -
-drmStatus -
-		 - Dispatched when the digital rights management (DRM) encrypted content - begins playing (when the user is authenticated and authorized to play the content).NetStream
   -
-ioError -
-		 - Dispatched when an input or output error occurs that causes a network operation to fail.NetStream
   -
-mediaTypeData -
-		 - Dispatched when playing video content and certain type of messages are processed.NetStream
   -
-netStatus -
-		 - Dispatched when a NetStream object is reporting its status or error condition.NetStream
   -
-onCuePoint -
-		 - Establishes a listener to respond when an embedded cue point is reached while playing a video file.NetStream
   -
-onDRMContentData -
-		 - Establishes a listener to respond when AIR extracts DRM content metadata embedded in a media file.NetStream
   -
-onImageData -
-		 - Establishes a listener to respond when Flash Player receives image data as a byte array embedded in a media file that is - playing.NetStream
   -
-onMetaData -
-		 - Establishes a listener to respond when Flash Player receives descriptive information embedded in the video being played.NetStream
   -
-onPlayStatus -
-		 - Establishes a listener to respond when a NetStream object has completely played a stream.NetStream
   -
-onSeekPoint -
-		 - Called synchronously from appendBytes() when the append bytes parser encounters a point that it believes is a seekable - point (for example, a video key frame).NetStream
   -
-onTextData -
-		 - Establishes a listener to respond when Flash Player receives text data embedded in a media file that is playing.NetStream
   -
-onXMPData -
-		 - Establishes a listener to respond when Flash Player receives information specific to Adobe - Extensible Metadata Platform (XMP) embedded in the video being played.NetStream
   -
-status -
-		 - Dispatched when the application attempts to play content encrypted with digital rights management (DRM), - by invoking the NetStream.play() method.NetStream
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  CONNECT_TO_FMS : String = "connectToFMS"
[static] - A static object used as a parameter to - the constructor for a NetStream instance.
-		NetStream
  DIRECT_CONNECTIONS : String = "directConnections"
[static] - Creates a peer-to-peer publisher connection.
-		NetStream
-
- -
- -
Property detail
- - - - - -
audioReliableproperty
-
-audioReliable:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies whether audio is sent with full reliability. When TRUE, all audio transmitted over this NetStream is fully reliable. - When FALSE, the audio transmitted is not fully reliable, but instead is retransmitted for a limited time and then dropped. - You can use the FALSE value to reduce latency at the expense of audio quality. -

If you try to set this property to FALSE on a network protocol that does not support partial reliability, - the attempt is ignored and the property is set to TRUE.

-

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- - Implementation -
-    public function get audioReliable():Boolean -
-    public function set audioReliable(value:Boolean):void -
-

-See also -

-
-dataReliable -
-videoReliable -
-
- - - - - -
audioSampleAccessproperty 
-
-audioSampleAccess:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the audio stream. - When FALSE, subscriber attempts to capture the audio stream show permission errors. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get audioSampleAccess():Boolean -
-    public function set audioSampleAccess(value:Boolean):void -
-

-See also -

-
-videoSampleAccess -
-
- - - - - -
backBufferLengthproperty 
-
-backBufferLength:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The number of seconds of previously displayed data that currently cached for rewinding and playback. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

-

This property is available only when data is streaming from Flash Media Server 3.5.3 or higher; - for more information on Flash Media Server, see the class description.

-

To specify how much previously displayed data is cached, use the Netstream.backBufferTime property.

-

To prevent data from being cached, set the Netstream.inBufferSeek property to FALSE.

- Implementation -
-    public function get backBufferLength():Number -
-

-See also -

-
-backBufferTime -
-inBufferSeek -
-
- - - - - -
backBufferTimeproperty 
-
-backBufferTime:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies how much previously displayed data Flash Player tries to cache for rewinding and playback, in seconds. - The default value is 30 seconds for desktop applications and 3 seconds for mobile applications. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

-

This property is available only when data is streaming from Flash Media Server version 3.5.3 or later; - for more information on Flash Media Server, see the class description.

-

Using this property improves performance for rewind operations, as data that has already been displayed - isn't retrieved from the server again. Instead, the stream begins replaying from the buffer. - During playback, data continues streaming from the server until the buffer is full.

-

If the rewind position is farther back than the data in the cache, the buffer is flushed; - the data then starts streaming from the server at the requested position.

-

To use this property set the Netstream.inBufferSeek property to TRUE.

- Implementation -
-    public function get backBufferTime():Number -
-    public function set backBufferTime(value:Number):void -
-

-See also -

-
-backBufferLength -
-bufferTime -
-inBufferSeek -
-
- - - - - -
bufferLengthproperty 
-
-bufferLength:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of seconds of data currently in the buffer. You can use this property with - the bufferTime property to estimate how close the buffer is to being full — for example, - to display feedback to a user who is waiting for data to be loaded into the buffer. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get bufferLength():Number -
-

-See also -

-
-backBufferLength -
-bufferTime -
-bytesLoaded -
-
- - - - - -
bufferTimeproperty 
-
-bufferTime:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies how long to buffer messages before starting to display the stream. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

-

The default value is 0.1 (one-tenth of a second). To determine the number of seconds - currently in the buffer, use the bufferLength property.

-

To play a server-side playlist, set bufferTime to at least 1 second. If - you experience playback issues, increase the length of bufferTime. -

-

Recorded content To avoid distortion when streaming pre-recorded (not live) content, - do not set the value of Netstream.bufferTime to 0. By default, the application - uses an input buffer for pre-recorded content that queues the media data and plays the media properly. - For pre-recorded content, use the default setting or increase the buffer time.

-

Live content When streaming live content, set the bufferTime property to 0.

-

Starting with Flash Player 9.0.115.0, Flash Player no longer clears the buffer - when NetStream.pause() is called. Before Flash Player 9.0.115.0, Flash Player - waited for the buffer to fill up before resuming playback, which often caused a delay.

-

For a single pause, the NetStream.bufferLength property has a limit of either 60 seconds - or twice the value of NetStream.bufferTime, whichever value is higher. For example, if - bufferTime is 20 seconds, Flash Player buffers until NetStream.bufferLength - is the higher value of either 20*2 (40), or 60. In this case it buffers until bufferLength is 60. - If bufferTime is 40 seconds, Flash Player buffers until bufferLength is the higher value - of 40*2 (80), or 60. In this case it buffers until bufferLength is 80 seconds.

-

The bufferLength property also has an absolute limit. - If any call to pause() causes bufferLength - to increase more than 600 seconds or the value of bufferTime * 2, whichever is higher, Flash Player - flushes the buffer and resets bufferLength to 0. For example, if - bufferTime is 120 seconds, Flash Player flushes the buffer - if bufferLength reaches 600 seconds; if bufferTime is 360 seconds, - Flash Player flushes the buffer if bufferLength reaches 720 seconds.

-

Tip: You can use NetStream.pause() in code to buffer data while viewers are watching - a commercial, for example, and then unpause when the main video starts.

-

For more information about the new pause behavior, - see http://www.adobe.com/go/learn_fms_smartpause_en.

-

- Flash Media Server. The buffer behavior depends on whether the buffer time is - set on a publishing stream or a subscribing stream. - For a publishing stream, bufferTime specifies how long the outgoing buffer can - grow before the application starts dropping frames. - On a high-speed connection, buffer time is not a concern; data is sent - almost as quickly as the application can buffer it. On a slow connection, however, there can - be a significant difference between how fast the application buffers the data and how fast it - is sent to the client. -

-

- For a subscribing stream, bufferTime specifies how long to buffer incoming - data before starting to display the stream. -

-

- When a recorded stream is played, if bufferTime is 0, Flash sets it to a small - value (approximately 10 milliseconds). If live streams are later played - (for example, from a playlist), this buffer time persists. That is, bufferTime - remains nonzero for the stream. -

- Implementation -
-    public function get bufferTime():Number -
-    public function set bufferTime(value:Number):void -
-

-See also -

-
-backBufferTime -
-bufferLength -
-bufferTimeMax -
-time -
-
- - - - - -
bufferTimeMaxproperty 
-
-bufferTimeMax:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies a maximum buffer length for live streaming content, in seconds. The default value is 0. - Buffer length can grow over time due to networking and device issues (such as clock drift between sender and receiver). - Set this property to cap the buffer length for live applications such as meetings and surveillance. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

-

When bufferTimeMax > 0 and bufferLength >= bufferTimeMax, audio plays faster until - bufferLength reaches bufferTime. If a live stream is video-only, video plays faster - until bufferLength reaches bufferTime.

-

Depending on how much playback is lagging (the difference between bufferLength and bufferTime), - Flash Player controls the rate of catch-up between 1.5% and 6.25%. - If the stream contains audio, faster playback is achieved by frequency domain downsampling which minimizes audible distortion.

-

Set the bufferTimeMax property to enable live buffered stream catch-up in the following cases:

-
    -
  • Streaming live media from Flash Media Server.
    • -
  • Streaming live media in Data Generation Mode (NetStream.appendBytes()).
    • -
- Implementation -
-    public function get bufferTimeMax():Number -
-    public function set bufferTimeMax(value:Number):void -
-

-See also -

-
-bufferLength -
-bufferTime -
-
- - - - - -
bytesLoadedproperty 
-
-bytesLoaded:uint  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of bytes of data that have been loaded into the application. You can use this property - with the bytesTotal property to estimate how close the buffer is to being full — for example, - to display feedback to a user who is waiting for data to be loaded into the buffer. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- - Implementation -
-    public function get bytesLoaded():uint -
-

-See also -

-
-bytesTotal -
-bufferLength -
-
- - - - - -
bytesTotalproperty 
-
-bytesTotal:uint  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The total size in bytes of the file being loaded into the application. -

Implementation -
-    public function get bytesTotal():uint -
-

-See also -

-
-bytesLoaded -
-bufferTime -
-
- - - - - -
checkPolicyFileproperty 
-
-checkPolicyFile:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether the application tries to download a cross-domain policy file from the - loaded video file's server before beginning to load the video file. Use this property for progressive video download, - and to load files that are outside the calling SWF file's own domain. - This property is ignored when you are using RTMP. -

Set this property to true to call BitmapData.draw() on a video file loaded from a - domain outside that of the calling SWF. The BitmapData.draw() method provides pixel-level access to the video. - If you call BitmapData.draw() without setting the checkPolicyFile property - to true at loading time, you can get a SecurityError exception - because the required policy file was not downloaded.

-

Do not set this property to true unless you want pixel-level access to the video you are loading. - Checking for a policy file consumes network bandwidth and can delay the start of your download.

-

When you call the NetStream.play() method with checkPolicyFile set to true, - Flash Player or the AIR runtime - must either successfully download a relevant cross-domain policy file or determine - that no such policy file exists before it begins downloading. To verify the existence of a policy file, - Flash Player or the AIR runtime - performs the following actions, in this order:

-
    -
  1. The application considers policy files that have already been downloaded.
    2. -
  2. The application tries to download any pending policy files specified in calls to the - Security.loadPolicyFile() method.
    3. -
  3. The application tries to download a policy file from the default - location that corresponds to the URL you passed to NetStream.play(), which is - /crossdomain.xml on the same server as that URL.
    4. -
-

In all cases, Flash Player or Adobe AIR - requires that an appropriate policy file exist on the video's server, - that it provide access to the object at the URL you passed to play() based on the - policy file's location, and that it allow the domain of the calling code's file to access the video, - through one or more <allow-access-from> tags.

-

If you set checkPolicyFile to true, the application waits until the policy file - is verified before downloading the video. Wait to perform any pixel-level - operations on the video data, such as calling BitmapData.draw(), until - you receive onMetaData or NetStatus events from your - NetStream object.

-

If you set checkPolicyFile to true but no relevant policy file is found, - you won't receive an error until you perform an operation that requires a policy file, and then - the application throws a SecurityError exception.

-

Be careful with checkPolicyFile if you are downloading a file from a URL that - uses server-side HTTP redirects. The application tries to retrieve policy files - that correspond to the initial URL that you specify in NetStream.play(). If the - final file comes from a different URL because of HTTP redirects, the initially - downloaded policy files might not be applicable to the file's final URL, which is the URL - that matters in security decisions.

-

For more information on policy files, see "Website controls (policy files)" in - the ActionScript 3.0 Developer's Guide and the Flash Player Developer Center Topic: - Security.

- Implementation -
-    public function get checkPolicyFile():Boolean -
-    public function set checkPolicyFile(value:Boolean):void -
-

-See also -

-
-flash.display.BitmapData.draw() -
-flash.system.Security.loadPolicyFile() -
-netStatus -
-onMetaData -
-play() -
-
- - - - - -
clientproperty 
-
-client:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies the object on which callback methods are invoked to handle streaming or F4V/FLV - file data. The default object is this, the - NetStream object being created. If you set the client property to another - object, callback methods are invoked on that other object. The NetStream.client - object can call the following functions and receive an associated data object: - onCuePoint(), - onImageData(), - onMetaData(), onPlayStatus(), onSeekPoint(), - onTextData(), and onXMPData(). -

To associate the client property with an event handler:

-

  1. Create an object and assign it to the client property of the - NetStream object: - 
    -     var customClient:Object = new Object();
-     my_netstream.client = customClient;
-
    -
    2. -
  2. Assign a handler function for the desired data event as a property of the client - object: - 
    -     customClient.onImageData = onImageDataHandler;
-
    -
    3. -
  3. Write the handler function to receive the data event object, such as: - 
    -      public function onImageDataHandler(imageData:Object):void {
-              trace("imageData length: " + imageData.data.length);
-      }
-
    4. -

-

When data is passed through the stream or during playback, the data event object (in - this case the imageData object) is populated with the data. See the onImageData - description, which includes a full example of an object assigned to the client property.


-

To associate the client property with a subclass:

-

  1. Create a subclass with a handler function to receive the data event object: - 
    -     class CustomClient {
-        public function onMetaData(info:Object):void {
-            trace("metadata: duration=" + info.duration + " framerate=" + info.framerate);
-     }
-
    -
    2. -
  2. Assign an instance of the subclass to the client property of the - NetStream object: - 
    -     my_netstream.client = new CustomClient();
-
    -
    3. -

-

When data is passed through the stream or during playback, the data event object (in - this case the info object) is populated with the data. See the class example at - the end of the NetStream class, which shows the assignment of a subclass instance - to the client property.

- Implementation -
-    public function get client():Object -
-    public function set client(value:Object):void -
-
-Throws -
- - - - -
TypeError — The client property must be set to a non-null object. -
-

-See also -

-
-onCuePoint -
-onImageData -
-onMetaData -
-onPlayStatus -
-onSeekPoint -
-onTextData -
-
- - - - - -
currentFPSproperty 
-
-currentFPS:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of frames per second being displayed. If you are exporting video files to be played back on a number - of systems, you can check this value during testing to help you determine how much compression to apply when - exporting the file. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get currentFPS():Number -
-
- - - - - -
dataReliableproperty 
-
-dataReliable:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies whether NetStream.send() calls are sent with full reliability. - When TRUE, NetStream.send() calls - that are transmitted over this NetStream are fully reliable. - When FALSE, NetStream.send() calls are not transmitted with full reliability, - but instead are retransmitted for a limited time and then dropped. - You can set this value to FALSE to reduce latency at the expense of data quality. -

If you try to set this property to FALSE on a network protocol that does not support partial reliability, - the attempt is ignored and the property is set to TRUE.

-

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get dataReliable():Boolean -
-    public function set dataReliable(value:Boolean):void -
-

-See also -

-
-audioReliable -
-send() -
-videoReliable -
-
- - - - - -
farIDproperty 
-
-farID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- For RTMFP connections, the identifier of the far end that is connected to this NetStream instance. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get farID():String -
-
- - - - - -
farNonceproperty 
-
-farNonce:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- For RTMFP and RTMPE connections, a value chosen substantially by the other end of this stream, unique to this connection. - This value appears to the other end of the stream as its nearNonce value. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- - Implementation -
-    public function get farNonce():String -
-
- - - - - -
inBufferSeekproperty 
-
-inBufferSeek:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether displayed data is cached for smart seeking (TRUE), or not (FALSE). - The default value is FALSE. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

-

Flash Media Server 3.5.3 and Flash Player 10.1 work together to support smart seeking. - Smart seeking uses back and forward buffers to seek without requesting data from the server. - Standard seeking flushes buffered data and asks the server to send new data based on the seek time.

-

Call NetStream.step() to step forward and backward a specified number of frames. Call - NetStream.seek() to seek forward and backward a specified number of seconds.

-

Smart seeking reduces server load and improves seeking performance. Set inBufferSeek=true and - call step() and seek() to create:

-
    -
  • Client-side DVR functionality.
    Seek within the client-side buffer instead of going to the server for delivery of new video.
    • -
  • Trick modes.
    Create players that step through frames, fast-forward, fast-rewind, and advance in slow-motion.
    • -
-

When inBufferSeek=true and a call to NetStream.seek() is successful, - the NetStatusEvent info.description property contains the string "client-inBufferSeek".

-

When a call to NetStream.step() is successful, the NetStatusEvent info.code property - contains the string "NetStream.Step.Notify".

- Implementation -
-    public function get inBufferSeek():Boolean -
-    public function set inBufferSeek(value:Boolean):void -
-

-See also -

-
-backBufferTime -
-backBufferLength -
-bufferTime -
-bufferLength -
-step() -
-seek() -
-
- - - - - -
infoproperty 
-
-info:NetStreamInfo  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a NetStreamInfo object whose properties contain statistics about the quality of service. - The object is a snapshot of the current state. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get info():NetStreamInfo -
-

-See also -

-
-flash.net.NetStreamInfo -
-
- - - - - -
liveDelayproperty 
-
-liveDelay:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The number of seconds of data in the subscribing stream's - buffer in live (unbuffered) mode. This property specifies the current - network transmission delay (lag time). -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

-

This property is intended primarily for use with a server such as Flash Media Server; - for more information, see the class description.

-

You can get the value of this property to roughly gauge the transmission - quality of the stream and communicate it to the user.

- Implementation -
-    public function get liveDelay():Number -
-
- - - - - -
maxPauseBufferTimeproperty 
-
-maxPauseBufferTime:Number  [read-write]

- - - - -
Runtime version: AIR 1.5 -
-

- Specifies how long to buffer messages during pause mode, in seconds. This property can be used to limit how much buffering is done - during pause mode. As soon as the value of NetStream.bufferLength reaches - this limit, it stops buffering. -

If this value is not set, it defaults the limit to 60 seconds or twice the value of NetStream.bufferTime on each pause, - whichever is higher.

-

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get maxPauseBufferTime():Number -
-    public function set maxPauseBufferTime(value:Number):void -
-

-See also -

-
-bufferTime -
-
- - - - - -
multicastAvailabilitySendToAllproperty 
-
-multicastAvailabilitySendToAll:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies whether peer-to-peer multicast fragment availability messages are - sent to all peers or to just one peer. - A value of TRUE specifies that the messages are sent to all peers once - per specified interval. A value of FALSE specifies that the - messages are sent to just one peer per specified interval. The interval - is determined by the multicastAvailabilityUpdatePeriod property. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get multicastAvailabilitySendToAll():Boolean -
-    public function set multicastAvailabilitySendToAll(value:Boolean):void -
-

-See also -

-
-multicastAvailabilityUpdatePeriod -
-
- - - - - -
multicastAvailabilityUpdatePeriodproperty 
-
-multicastAvailabilityUpdatePeriod:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies the interval in seconds between messages sent to peers informing them that - the local node has new peer-to-peer multicast media fragments available. - Larger values can increase batching efficiency and reduce control overhead, - but they can lower quality on the receiving end by reducing the amount of time available to retrieve - fragments before they are out-of-window. Lower values can reduce latency and - improve quality, but they increase control overhead. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- - Implementation -
-    public function get multicastAvailabilityUpdatePeriod():Number -
-    public function set multicastAvailabilityUpdatePeriod(value:Number):void -
-

-See also -

-
-multicastAvailabilitySendToAll -
-multicastFetchPeriod -
-multicastWindowDuration -
-
- - - - - -
multicastFetchPeriodproperty 
-
-multicastFetchPeriod:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies the time in seconds between when the local node learns that a peer-to-peer - multicast media fragment is available and when it tries to fetch it from a peer. This value gives an opportunity for the - fragment to be proactively pushed to the local node before a fetch from a - peer is attempted. It also allows for more than one peer to announce availability - of the fragment, so the fetch load can be spread among multiple peers. -

Larger values can improve load balancing and fairness in the peer-to-peer mesh, - but reduce the available multicastWindowDuration and increase latency. Smaller values can - reduce latency when fetching is required, but might increase duplicate data reception - and reduce peer-to-peer mesh load balance.

-

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get multicastFetchPeriod():Number -
-    public function set multicastFetchPeriod(value:Number):void -
-

-See also -

-
-multicastAvailabilityUpdatePeriod -
-multicastWindowDuration -
-
- - - - - -
multicastInfoproperty 
-
-multicastInfo:NetStreamMulticastInfo  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, returns a NetStreamMulticastInfo object whose properties contain statistics about the quality of service. - The object is a snapshot of the current state. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get multicastInfo():NetStreamMulticastInfo -
-

-See also -

-
-flash.net.NetStreamMulticastInfo -
-
- - - - - -
multicastPushNeighborLimitproperty 
-
-multicastPushNeighborLimit:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies the maximum number of peers to which to proactively push - multicast media. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- - Implementation -
-    public function get multicastPushNeighborLimit():Number -
-    public function set multicastPushNeighborLimit(value:Number):void -
-
- - - - - -
multicastRelayMarginDurationproperty 
-
-multicastRelayMarginDuration:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies the duration in seconds that peer-to-peer multicast data remains - available to send to peers that request it beyond a specified duration. The duration is specified - by the multicastWindowDuration property. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- - Implementation -
-    public function get multicastRelayMarginDuration():Number -
-    public function set multicastRelayMarginDuration(value:Number):void -
-

-See also -

-
-multicastWindowDuration -
-
- - - - - -
multicastWindowDurationproperty 
-
-multicastWindowDuration:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies the duration in seconds of the peer-to-peer multicast reassembly - window. Shorter values reduce latency but may reduce quality by not - allowing enough time to obtain all of the fragments. Conversely, larger values may increase - quality by providing more time to obtain all of the fragments, with a corresponding - increase in latency. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- - Implementation -
-    public function get multicastWindowDuration():Number -
-    public function set multicastWindowDuration(value:Number):void -
-

-See also -

-
-multicastRelayMarginDuration -
-
- - - - - -
nearNonceproperty 
-
-nearNonce:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- For RTMFP and RTMPE connections, a value chosen substantially by this end of the stream, unique to this connection. - This value appears to the other end of the stream as its farNonce value. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- - Implementation -
-    public function get nearNonce():String -
-
- - - - - -
objectEncodingproperty 
-
-objectEncoding:uint  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The object encoding (AMF version) for this NetStream object. The NetStream object - inherits its objectEncoding value from the associated NetConnection object. - It's important to understand this property if your ActionScript 3.0 SWF file needs to - communicate with servers released prior to Flash Player 9. - For more information, see the objectEncoding property description - in the NetConnection class. -

The value of this property depends on whether the stream is local or - remote. Local streams, where null was passed to the - NetConnection.connect() method, return the value of - NetConnection.defaultObjectEncoding. Remote streams, where you - are connecting to a server, return the object encoding of the connection to the server.

-

If you try to read this property when not connected, or if you try to change this property, - the application throws an exception.

- Implementation -
-    public function get objectEncoding():uint -
-

-See also -

-
-flash.net.NetConnection.objectEncoding -
-
- - - - - -
peerStreamsproperty 
-
-peerStreams:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- An object that holds all of the subscribing NetStream instances that are listening to this publishing NetStream instance. -

Implementation -
-    public function get peerStreams():Array -
-
- - - - - -
soundTransformproperty 
-
-soundTransform:SoundTransform  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Controls sound in this NetStream object. For more information, see the SoundTransform class. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get soundTransform():SoundTransform -
-    public function set soundTransform(value:SoundTransform):void -
-

-See also -

-
-flash.media.SoundTransform -
-
- - - - - -
timeproperty 
-
-time:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The position of the playhead, in seconds. -

- Flash Media Server For a subscribing stream, the number of seconds - the stream has been playing. For a publishing stream, the number of - seconds the stream has been publishing. - This number is accurate to the thousandths decimal place; multiply - by 1000 to get the number of milliseconds the stream has been playing. -

-

- For a subscribing stream, if the server stops sending data but the stream remains open, - the value of the time property stops advancing. When the server begins sending data again, - the value continues to advance from the point at which it stopped (when the server stopped sending data). -

-

- The value of time continues to advance when the stream - switches from one playlist element to another. This property is set to 0 when - NetStream.play() is called with reset set to 1 or - true, or when NetStream.close() is called. -

- Implementation -
-    public function get time():Number -
-

-See also -

-
-bufferLength -
-bytesLoaded -
-
- - - - - -
useHardwareDecoderproperty 
-
-useHardwareDecoder:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Specifies whether to use hardware accelerated decoding on the stream. -

Note: You cannot set this property during video playback. You must set - it before you call NetStream.play().

-

The default value is true.

-Implementation -
-    public function get useHardwareDecoder():Boolean -
-    public function set useHardwareDecoder(value:Boolean):void -
-

-See also -

-
-play() -
-
- - - - - -
useJitterBufferproperty 
-
-useJitterBuffer:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Minimize latency for live un-buffered streaming (bufferTime = 0). - Instead of conservative push-based catchup mechanism, audio - messages are placed in an adaptive jitter buffer. When audio is needed by speaker device, - messages are popped from jitter buffer, decoded, and played back. Speex and - G.711 always use this pull-based approach, regardless of this - settings (useJitterBuffer returns true for Speex/G.711). When enabled in un-buffered mode, all the codecs use jitter buffer, - such as Speex, G.711, Nellymoser, MP3 and AAC. This property has no effect in buffered mode (bufferTime > 0), and thus - useJitterBuffer returns false. - -

Implementation -
-    public function get useJitterBuffer():Boolean -
-    public function set useJitterBuffer(value:Boolean):void -
-
- - - - - -
videoReliableproperty 
-
-videoReliable:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies whether video is sent with full reliability. When TRUE, all video transmitted over this NetStream is fully reliable. - When FALSE, the video transmitted is not fully reliable, but instead is retransmitted for a limited time and then dropped. - You can use the FALSE value to reduce latency at the expense of video quality. -

If you try to set this property to FALSE on a network protocol that does not support partial reliability, - the attempt is ignored and the property is set to TRUE.

-

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get videoReliable():Boolean -
-    public function set videoReliable(value:Boolean):void -
-

-See also -

-
-audioReliable -
-dataReliable -
-
- - - - - -
videoSampleAccessproperty 
-
-videoSampleAccess:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- For RTMFP connections, specifies whether peer-to-peer subscribers on this NetStream are allowed to capture the video stream. - When FALSE, subscriber attempts to capture the video stream show permission errors. -

Note: This property is not supported for H.264 video in AIR 3.0 for iOS.

- Implementation -
-    public function get videoSampleAccess():Boolean -
-    public function set videoSampleAccess(value:Boolean):void -
-

-See also -

-
-audioSampleAccess -
-
- - - - - -
videoStreamSettingsproperty 
-
-videoStreamSettings:VideoStreamSettings  [read-write]Implementation -
-    public function get videoStreamSettings():VideoStreamSettings -
-    public function set videoStreamSettings(value:VideoStreamSettings):void -
-
- -
Constructor detail
- - - - - -
NetStream()constructor
-
-public function NetStream(connection:NetConnection, peerID:String = "connectToFMS") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a stream that you can use to play media files and send data over a NetConnection object. -

It is considered invalid to not handle a NetStream object's - netStatus event. To avoid errors, register a listener for - the netStatus after creating the NetStream object and before - calling its play() method.

- Parameters - - - - - - - - - - -
connection:NetConnection — A NetConnection object. -
 
peerID:String (default = "connectToFMS") — This optional parameter is available in Flash Player 10 and later, for use with RTMFP connections. - (If the value of the NetConnection.protocol property - is not "rtmfp", this parameter is ignored.) Use one of the following values: -
    -
  • To connect to Flash Media Server, specify NetStream.CONNECT_TO_FMS.
    • -
  • To publish directly to peers, specify NetStream.DIRECT_CONNECTIONS.
    • -
  • To play directly from a specific peer, specify that peer's identity (see NetConnection.nearID - and NetStream.farID).
    • -
  • (Flash Player 10.1 or AIR 2 or later) To publish or play a stream in a peer-to-peer multicast group, - specify a groupspec string (see the GroupSpecifier class).
    • -
-

In most cases, a groupspec has the potential to use the network uplink on the local system. In this case, - the user is asked for permission to use the computer's network resources. If the user allows this - use, a NetStream.Connect.Success NetStatusEvent is sent to the NetConnection's event - listener. If the user denies permission, a NetStream.Connect.Rejected event is sent. - When specifying a groupspec, until a NetStream.Connect.Success event is received, it is an error to use any method - of the NetStream object, and an exception is raised.

-

If you include this parameter in your constructor statement but pass a value of null, - the value is set to "connectToFMS".

-
-
-Throws - - - - -
ArgumentError — The NetConnection instance is not connected. -
-

-See also -

-
-CONNECT_TO_FMS -
-DIRECT_CONNECTIONS -
-farID -
-flash.media.Video.attachCamera() -
-flash.net.GroupSpecifier -
-flash.net.GroupSpecifier.groupspecWithAuthorizations() -
-flash.net.GroupSpecifier.groupspecWithoutAuthorizations() -
-flash.net.GroupSpecifier.multicastEnabled -
-flash.net.NetConnection -
-flash.net.NetConnection.nearID -
-flash.net.NetConnection.protocol -
-flash.net.NetGroup -
-flash.events.NetStatusEvent.info.code="NetStream.Connect.Rejected" -
-flash.events.NetStatusEvent.info.code="NetStream.Connect.Success" -
-
-Example -
The following code shows a connection to download and display, progressively, a video assigned to the - variable videoURL: -
-
-var my_video:Video = new Video();
-addChild(my_video);
-var my_nc:NetConnection = new NetConnection();
-my_nc.connect(null);
-var my_ns:NetStream = new NetStream(my_nc);
-my_video.attachNetStream(my_ns);
-my_ns.play(videoURL);
-
-

The following code shows a connection to stream and display a video (assigned to the - variable videoURL) on a remote Flash Media Server instance specified in the connect() - command: -
-
-var my_video:Video = new Video();
-addChild(my_video);
-var my_nc:NetConnection = new NetConnection();
-my_nc.connect("rtmp://www.yourfmsserver.com/someappname");
-var my_ns:NetStream = new NetStream(my_nc, NetStream.CONNECT_TO_FMS);
-my_video.attachNetStream(my_ns);
-my_ns.play(videoURL);
-
-

-
- -
Method detail
- - - - - -
appendBytes()method
-
-public function appendBytes(bytes:ByteArray):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Passes a ByteArray into a NetStream for playout. Call this method on a NetStream in "Data Generation Mode". To put a NetStream into - Data Generation Mode, call NetStream.play(null) on a NetStream created on a NetConnection connected to null. - Calling appendBytes() on a NetStream that isn't in Data Generation Mode is an error and raises an exception. -

Note: This method is not supported for H.264 video in AIR 3.0 for iOS.

-

- The byte parser understands an FLV file with a header. - After the header is parsed, appendBytes() expects all future calls to be continuations - of the same real or virtual file. Another header is not expected unless - appendBytesAction(NetStreamAppendBytesAction.RESET_BEGIN) is called. -

-

- A NetStream object has two buffers: the FIFO from appendBytes() to the NetStream, - and the playout buffer. The FIFO is the partial-FLV-tag reassembly buffer and contains no more than one incomplete FLV tag. - Calls to NetStream.seek() flush both buffers. - After a call to seek(), call appendBytesAction() to reset the timescale to begin at the timestamp of the next appended message. -

-

- Each call to appendBytes() adds bytes into the FIFO until an FLV tag is complete. - When an FLV tag is complete, it moves to the playout buffer. A call to appendBytes() can write multiple FLV tags. - The first bytes complete an existing FLV tag (which moves to the playout buffer). Complete FLV tags move to the playout buffer. - Remaining bytes that don’t form a complete FLV tag go into the FIFO. Bytes in the FIFO are either completed by a call to appendBytes() - or flushed by a call to appendBytesAction() with the RESET_SEEK or RESET_BEGIN argument. -

-

Note: The byte parser may not be able to completely decode a call to appendBytes() until a - subsequent call to appendBytes() is made.

- Parameters - - - - -
bytes:ByteArray
-

-See also -

-
-appendBytesAction() -
-seek() -
-
- - - - - -
appendBytesAction()method 
-
-public function appendBytesAction(netStreamAppendBytesAction:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates a timescale discontinuity, flushes the FIFO, and tells the byte parser to expect a file header or the beginning of an FLV tag. -

Note: This method is not supported for H.264 video in AIR 3.0 for iOS.

- -

- Calls to NetStream.seek() flush the NetStream buffers. The byte parser remains in flushing mode until you - call appendBytesAction() and pass the RESET_BEGIN or RESET_SEEK argument. - Capture the "NetStream.Seek.Notify" event to call appendBytesAction() after a seek. - A new file header can support playlists and seeking without calling NetStream.seek(). -

-

- You can also call this method to reset the byte counter for the onSeekPoint()) callback. -

- Parameters - - - - -
netStreamAppendBytesAction:String
-

-See also -

-
-appendBytes() -
-seek() -
-flash.net.NetStreamAppendBytesAction -
-
- - - - - -
attach()method 
-
-public function attach(connection:NetConnection):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Attaches a stream to a new NetConnection object. Call this method to attach a NetStream to a new NetConnection object - after a connection has dropped and been reconnected. Flash Player and AIR resume streaming from the playback point when - the connection was lost.You can also use this method to implement load balancing. -

This method requires Flash Media Server version 3.5.3 or later.

-

To use this method to implement stream reconnection, see the - Flash Media Server 3.5.3 documentation.

-

To use this method to implement load balancing, do the following:

-
    -
  1. Attach a connected stream to a NetConnection object on another server.
    2. -
  2. After the stream is successfully attached to the new connection, call NetConnection.close() - on the prior connection to prevent data leaks.
    3. -
  3. Call NetStream.play2() and set the value of NetStreamPlayOptions.transition to RESUME. - Set the rest of the NetStreamPlayOptions properties to the same values you used when you originally called - NetStream.play() or NetStream.play2() to start the stream.
    4. -
- Parameters - - - - -
connection:NetConnection
-

-See also -

-
-play2() -
-NetStreamPlayOptions.transition -
-
- - - - - -
attachAudio()method 
-
-public function attachAudio(microphone:Microphone):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Attaches an audio stream to a NetStream object from a Microphone - object passed as the source. This method is available - only to the publisher of the specified stream. -

Use this method with Flash Media Server to send live audio to the server. - Call this method before or after you call the publish() method. -

-

Set the Microphone.rate property to match - the rate of the sound capture device. Call setSilenceLevel() to set the silence level threshold. - To control the sound properties (volume and panning) of - the audio stream, use the Microphone.soundTransform property.

- 
-     var nc:NetConnection = new NetConnection();
-     nc.connect("rtmp://server.domain.com/app");
-     var ns:NetStream = new NetStream(nc);
-     
-     var live_mic:Microphone = Microphone.get();
-     live_mic.rate = 8;
-     live_mic.setSilenceLevel(20,200);
-     
-     var soundTrans:SoundTransform = new SoundTransform();
-     soundTrans.volume = 6;
-     live_mic.soundTransform = soundTrans;
-     
-     ns.attachAudio(live_mic);
-     ns.publish("mic_stream","live")
-
-

To hear the audio, call the NetStream.play() method and call DisplayObjectContainer.addChild() - to route the audio to an object on the display list. -

- Parameters - - - - -
microphone:Microphone — The source of the audio stream to be transmitted. -
-

-See also -

-
-play() -
-flash.media.Microphone -
-flash.display.DisplayObjectContainer.addChild() -
-
- - - - - -
attachCamera()method 
-
-public function attachCamera(theCamera:Camera, snapshotMilliseconds:int = -1):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Starts capturing video from a camera, or stops capturing if - theCamera is set to null. - This method is available only to the publisher of the specified stream. -

This method is intended for use with Flash Media Server; - for more information, see the class description.

-

After attaching the video source, you must call NetStream.publish() - to begin transmitting. Subscribers who want to display the video - must call the NetStream.play() and Video.attachCamera() methods - to display the video on the stage.

-

You can use snapshotMilliseconds to send a single snapshot - (by providing a value of 0) or a series of snapshots — in effect, - time-lapse footage — by providing a positive number that adds a trailer - of the specified number of milliseconds to the video feed. The trailer - extends the display time of the video message. By repeatedly - calling attachCamera() with a positive value for snapshotMilliseconds, - the sequence of alternating snapshots and trailers creates time-lapse footage. - For example, you could capture one frame per day and append it to a video file. - When a subscriber plays the file, each frame remains onscreen for the specified - number of milliseconds and then the next frame is displayed.

-

The purpose of the snapshotMilliseconds parameter is different - from the fps parameter you can set with Camera.setMode(). When you specify - snapshotMilliseconds, you control how much time elapses between recorded frames. When - you specify fps using Camera.setMode(), you are - controlling how much time elapses during recording and playback.

-

For example, suppose you want to take a snapshot every 5 minutes for a total - of 100 snapshots. You can do this in two ways:

-
    -
  • You can issue a NetStream.attachCamera(myCamera, 500) command - 100 times, once every 5 minutes. This takes 500 minutes to record, but the resulting file - will play back in 50 seconds (100 frames with 500 milliseconds between frames).
    • -
  • You can issue a Camera.setMode() command with an fps value - of 1/300 (one per 300 seconds, or one every 5 minutes), and then issue a - NetStream.attachCamera(source) command, letting the camera capture continuously - for 500 minutes. The resulting file will play back in 500 minutes — the same length of time - that it took to record — with each frame being displayed for 5 minutes.
    • -
- -

Both techniques capture the same 500 frames, and both approaches are useful; - the approach to use depends primarily on your playback requirements. For example, - in the second case, you could be recording audio the entire time. Also, both files - would be approximately the same size.

- Parameters - - - - - - - - - - -
theCamera:Camera — The source of the video transmission. Valid values are a Camera object - (which starts capturing video) and null. If you pass null, - the application stops capturing video, and any additional parameters you send are ignored. -
 
snapshotMilliseconds:int (default = -1) — Specifies whether the video stream is continuous, - a single frame, or a series of single frames used to create time-lapse photography. -
    -
  • If you omit this parameter, the application captures all video until you pass - a value of null to attachCamera.
    • -
  • If you pass 0, the application captures only a single video frame. Use this value - to transmit "snapshots" within a preexisting stream. Flash Player - or AIR interprets invalid, negative, or nonnumeric arguments as 0.
    • -
  • If you pass a positive number, the application captures a single video frame and then appends a pause - of the specified length as a trailer on the snapshot. Use this value to create time-lapse - photography effects.
    • -
-
-
- - - - - -
close()method 
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Stops playing all data on the stream, sets the time property to 0, - and makes the stream available for another use. This method also deletes the local copy - of a video file that was downloaded through HTTP. Although the application deletes the - local copy of the file that it creates, a copy might persist in the - cache directory. If you must completely prevent caching or local storage of the video file, - use Flash Media Server. -

- When using Flash Media Server, this method is invoked implicitly when you call - NetStream.play() from a publishing stream or - NetStream.publish() from a subscribing stream. - Please note that: -

-
    -
  • - If close() is called from a publishing stream, the stream - stops publishing and the publisher can now use the stream for another purpose. - Subscribers no longer receive anything that was being published on the stream, - because the stream has stopped publishing. -
    • -
  • - If close() is called from a subscribing stream, the stream - stops playing for the subscriber, and the subscriber can use the stream for - another purpose. Other subscribers are not affected. -
    • -
  • - You can stop a subscribing stream from playing, without closing the stream - or changing the stream type by using flash.net.NetStream.play(false). -
    • -
-

-See also -

-
-pause() -
-play() -
-publish() -
-
- - - - - -
dispose()method 
-
-public function dispose():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Releases all the resources held by the NetStream object. - -

The dispose() method is similar to the close method. - The main difference between the two methods is that dispose() releases the - memory used to display the current video frame. If that frame is currently displayed on screen, the display - will go blank. The close() method does not blank the display because it - does not release this memory.

- -
- - - - - -
onPeerConnect()method 
-
-public function onPeerConnect(subscriber:NetStream):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Invoked when a peer-publishing stream matches a peer-subscribing stream. Before the subscriber is - connected to the publisher, call this method to allow the ActionScript code fine access control for - peer-to-peer publishing. The following code shows an example of how to create a callback function for this method: - 

-     var c:Object = new Object;
-     c.onPeerConnect = function(subscriber:NetStream):Boolean {
-      if (accept)
-          return true;
-      else
-          return false;
-      };
-      m_netStream.client = c;
-
-

If a peer-publisher does not implement this method, all peers are allowed to play any published content.

- Parameters - - - - -
subscriber:NetStream
-

-Returns - - - - -
Boolean
-
- - - - - -
pause()method 
-
-public function pause():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Pauses playback of a video stream. Calling this method does nothing if the video - is already paused. To resume play after pausing a video, call resume(). - To toggle between pause and play (first pausing the video, then resuming), call - togglePause(). -

Starting with Flash Player 9.0.115.0, Flash Player no longer clears the buffer when NetStream.pause() is called. - This behavior is called "smart pause". Before Flash Player 9.0.115.0, Flash Player waited for the buffer to fill up before resuming - playback, which often caused a delay.

-

Note: For backwards compatibility, the "NetStream.Buffer.Flush" event (see the NetStatusEvent.info - property) still fires, although the server does not flush the buffer.

-

For a single pause, the NetStream.bufferLength property has a limit of either 60 seconds - or twice the value of NetStream.bufferTime, whichever value is higher. For example, if - bufferTime is 20 seconds, Flash Player buffers until NetStream.bufferLength - is the higher value of either 20*2 (40), or 60, so in this case it buffers until bufferLength is 60. - If bufferTime is 40 seconds, Flash Player buffers until bufferLength is the higher value - of 40*2 (80), or 60, so in this case it buffers until bufferLength is 80 seconds.

-

The bufferLength property also has an absolute limit. - If any call to pause() causes bufferLength - to increase more than 600 seconds or the value of bufferTime * 2, whichever is higher, Flash Player - flushes the buffer and resets bufferLength to 0. For example, if - bufferTime is 120 seconds, Flash Player flushes the buffer - if bufferLength reaches 600 seconds; if bufferTime is 360 seconds, - Flash Player flushes the buffer if bufferLength reaches 720 seconds.

-

Tip: You can use NetStream.pause() in code to buffer data while viewers are watching - a commercial, for example, and then unpause when the main video starts.

-

-See also -

-
-close() -
-play() -
-resume() -
-togglePause() -
-bufferLength -
-bufferTime -
-flash.events.NetStatusEvent.info -
-
- - - - - -
play()method 
-
-public function play(... arguments):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Plays a media file from a local directory or a web server; plays a media file or a live stream from Flash Media Server. - Dispatches a NetStatusEvent object to report status and error messages. -

For information about supported codecs and file formats, see the following:

- -

Workflow for playing a file or live stream

-
    -
  1. Create a Video object that will display the video and call addChild() - to add it to the stage.
    2. -

  2. Create a NetConnection object and call NetConnection.connect().

    -

    To play a file from a local directory or web server, pass null.

    -

    To play a recorded file or live stream from Flash Media Server, - pass the URI of a Flash Media Server application.

    -
    3. -
  3. Call the NetConnection object's addEventListener() method - to listen for the netStatus (NetStatusEvent.NET_STATUS) event.
    4. -
  4. On "NetConnection.Connect.Success", create a NetStream - object and pass the NetConnection object to the constructor.
    5. -
  5. Call the Viceo object's attachNetStream() method and pass the NetStream object.
    6. -

  6. Call the NetStream object's play() method.

    -

    To play a live stream, pass the stream name passed to the - NetStream.publish() method.

    -

    To play a recorded file, pass the file name.

    -
    7. -
-

Note: As a best practice, you should always add the Video object to the stage, then attach the NetStream to it, then call the NetStream object's play() method.

-

Enable Data Generation Mode

-

- Call play(null) to enable "Data Generation Mode". In this mode, call the appendBytes() method to deliver - data to the NetStream. Use Data Generation Mode to stream content over HTTP from the Adobe HTTP Dynamic Streaming Origin Module on an Apache HTTP Server. - HTTP Dynamic Streaming lets clients seek quickly to any point in a file. The Open Source Media Framework (OSMF) - supports HTTP Dynamic Streaming for vod and live streams. For examples of how to use NetStream Data Generation Mode, download the - OSMF source. - For more information about HTTP Dynamic Streaming, see - HTTP Dynamic Streaming. -

-

- When you use this method without Flash Media Server, there are security considerations. A file in the local-trusted or - local-with-networking sandbox can load and play a video file from the remote sandbox, but cannot access - the remote file's data without explicit permission in the form of a URL policy file. - Also, you can prevent a SWF file running in Flash Player from using this method - by setting the allowNetworking parameter of the the object and embed - tags in the HTML page that contains the SWF content. For more information related to security, see the Flash Player Developer Center Topic: - Security. -

- Parameters - - - - -
... arguments —

Play a local file

-

- The location of a media file. Argument can be a String, a URLRequest.url - property, or a variable referencing either. In Flash Player and in AIR content outside the application - security sandbox, you can play local video files that are stored in the same directory as the SWF file or in a - subdirectory; however, you can't navigate to a higher-level directory. -

-

Play a file from Flash Media Server

- - - - - - - - - - - - - - - - - - - - - - - - - - -
NameRequiredDescription
name:ObjectRequired The name of a recorded file, - an identifier for live data published by NetStream.publish(), - or false. - If false, the stream stops playing and any additional parameters - are ignored. For more information on the filename syntax, see the file format table following this table.
start:NumberOptional The start time, in seconds. Allowed values are -2, -1, 0, - or a positive number. The default value is -2, which looks - for a live stream, then a recorded stream, and if it finds - neither, opens a live stream. - You cannot use -2 with MP3 files. - If -1, plays only a live stream. - If 0 or a positive number, plays a recorded stream, beginning - start seconds in. -
len:Number Optional if start is specified. The duration of the playback, in seconds. - Allowed values are -1, 0, or a positive number. - The default value is -1, - which plays a live or recorded stream until it ends. - If 0, plays a single frame that is - start - seconds from the beginning of a recorded stream. - If a positive number, plays a live or recorded stream for - len seconds. -
reset:Object Optional if len is specified. Whether to clear a playlist. - The default value is 1 or true, which clears any previous - play calls and plays name immediately. - If 0 or false, adds the stream to a playlist. - If 2, maintains the playlist and returns all stream - messages at once, rather than at intervals. - If 3, clears the playlist and returns all stream messages - at once.
-

- You can play back the file formats described in the following table. The syntax differs depending on the file format. -

- - - - - - - - - - - - - - - - - - - - - - - - - - -
File formatSyntaxExample
FLVSpecify the stream name (in the "samples" directory) as a string without a filename extension.ns.play("samples/myflvstream");
mp3 or ID3Specify the stream name (in the "samples" directory) as a string with the prefix mp3: or id3: without a filename extension.

ns.play("mp3:samples/mymp3stream");

-

ns.play("id3:samples/myid3data");

MPEG-4-based files (such as F4V and MP4)Specify the stream name (in the "samples" directory) as a string with the prefix mp4: - The prefix indicates to the server that the file contains H.264-encoded video and AAC-encoded audio within - the MPEG-4 Part 14 container format. If the file on the server has a file extension, specify it.

ns.play("mp4:samples/myvideo.f4v");

-

ns.play("mp4:samples/myvideo.mp4");

-

ns.play("mp4:samples/myvideo");

-

ns.play("mp4:samples/myvideo.mov");

RAWSpecify the stream name (in the "samples" directory) as a string with the prefix raw:ns.play("raw:samples/myvideo");
-

Enable Data Generation Mode

-

- To enable "Data Generation Mode", pass the value null to a NetStream created on a NetConnection connected to null. - In this mode, call appendBytes() to deliver data to the NetStream. - (Passing null also resets the byte counter for the onSeekPoint() callback.) -

-

Special considerations for H.264 video in AIR 3.0 for iOS

-

For H.264 video, the iOS APIs for video playback accept only a URL to a file or stream. You cannot pass in a buffer of H264 video data to be decoded. Depending on your video source, - pass the appropriate argument to NetStream.play() as follows:

-
    -

  • For progressive playback: Pass the URL of the file (local or remote).

    • -

  • For streaming video: Pass the URL of a playlist in Apple's HTTP Live Streaming (HLS) format. This file can be hosted by any server; Flash Media Server 4.5 and higher - has the advantage of being able to encode streams in HLS format.

-
-
-Events - - - - -
status:StatusEvent — Dispatched when attempting to play content encrypted with - digital rights management (DRM). The value of the code property is - "DRM.encryptedFLV".
-
-Throws - - - - - - - - - - - - - - - - -
SecurityError — Local untrusted SWF files cannot communicate with - the Internet. You can work around this restriction by reclassifying this SWF file - as local-with-networking or trusted. -
 
ArgumentError — At least one parameter must be specified. -
 
Error — The NetStream Object is invalid. This may be due to a failed NetConnection. -
-

-See also -

-
-DisplayObjectContainer.addChild() -
-checkPolicyFile -
-appendBytes() -
-
-Example -

The following example shows how to load an external FLV file: -
-
-var MyVideo:Video = new Video();
-addChild(MyVideo);
- 
-var MyNC:NetConnection = new NetConnection();
-MyNC.connect(null);
- 
-var MyNS:NetStream = new NetStream(MyNC);
-MyVideo.attachNetStream(MyNS);
-MyNS.play("http://www.helpexamples.com/flash/video/clouds.flv");
-
-//the clouds.flv video has metadata we're not using, so create
-//an error handler to ignore the message generated by the runtime
-//about the metadata
-MyNS.addEventListener(AsyncErrorEvent.ASYNC_ERROR, asyncErrorHandler); 
-
-function asyncErrorHandler(event:AsyncErrorEvent):void 
-{ 
-   //ignore metadata error message
-}
-
-

-
- - - - - -
play2()method 
-
-public function play2(param:NetStreamPlayOptions):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Switches seamlessly between files with multiple bit rates and allows a NetStream to resume when a connection is dropped and reconnected. -

This method is an enhanced version of NetStream.play(). Like the play() method, the play2() method begins - playback of a media file or queues up media files to create a playlist. When used with Flash Media Server, it can also - request that the server switch to a different media file. The transition occurs seamlessly in the client application. The following features - use play2() stream switching:

-

Dynamic streaming

-

Dynamic streaming (supported in Flash Media Server 3.5 and later) lets you serve a stream encoded at multiple bit rates. As a viewer's network conditions change, - they receive the bitrate that provides the best viewing experience. Use the NetStreamInfo class to monitor network conditions and - switch streams based on the data. You can also switch streams for clients with different capabilities. - For more information, see "Dynamic streaming" in the - "Adobe Flash Media Server Developer Guide".

-

Adobe built a custom ActionScript class called DynamicStream that extends the NetStream class. You can use the DynamicStream class - to implement dynamic streaming in an application instead of writing your own code to detect network conditions. Even if you choose to write your own - dynamic streaming code, use the DynamicStream class as a reference implementation. Download the class and the class documentation at the - Flash Media Server tools and downloads page.

-

Stream reconnecting

-

Stream reconnecting (supported in Flash Media Server 3.5.3 and later) lets users to experience media uninterrupted even when they lose their connection. - The media uses the buffer to play while your ActionScript logic reconnects to Flash Media Server. After reconnection, call NetStream.attach() - to use the same NetStream object with the new NetConnection. Use the NetStream.attach(), NetStreamPlayTransitions.RESUME, - and NetStreamPlayTrasitions.APPEND_AND_WAIT APIs to reconnect a stream. For more information, - see the Flash Media Server 3.5.3 documentation.

- Parameters - - - - -
param:NetStreamPlayOptions
-

-See also -

-
-play() -
-attach() -
-NetStreamPlayOptions -
-NetStreamPlayTransitions -
-
- - - - - -
preloadEmbeddedData()method 
-
-public function preloadEmbeddedData(param:NetStreamPlayOptions):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Extracts any DRM metadata from a locally stored media file. -

Use preloadEmbeddedMetaData() as the first step in downloading and caching the DRM vouchers - needed for offline playback. When embedded DRM metadata is detected in a media file, a DRMContentData object is passed - to the NetStream client onDRMContentData function. This DRMContentData object contains the information - needed to obtain the voucher required to play the content. Pass the DRMContentDataObject to the DRMManager - loadVoucher() method to download the voucher.

-

The steps for preloading a DRM voucher include:

-
    -
  • -

    Create a new NetStream object for preloading the metadata.

    -
    • -
  • Assign a callback function to the onDRMContentData property of the NetStream client.
    • -
  • Create a new NetStreamPlayOptions object and set its streamName property to the the URL string of the local video file.
    • -
  • Call preloadEmbeddedMetadata(), passing in the NetStreamPlayOptions object.
    • -
  • In response to the onDRMContentData callback, call the DRMManager loadVoucher() method, passing - in the DRMContentData object. If the authenticationMethod property of the DRMContentData object has the value, - userNameAndPassWord, authenticate the user on the media rights server before loading the voucher.
    • -
  • Close the NetStream used for preloading.
    • -
-

Note: To use the same NetStream object to both preload metadata and play content, - wait for the onPlayStatus call generated by the preload operation before starting playback.

-

Downloaded vouchers are stored in a local cache. Playing content online also downloads and - caches vouchers. When a DRM-protected content file is viewed, a cached - voucher is retrieved from the local store automatically. Use the DRMManager to manage the - voucher cache.

-

Notes: Preloading DRM metadata through HTTP, HTTPS, or RTMP connections is not supported. You can only - preload metadata from files stored on the file system.

- Parameters - - - - -
param:NetStreamPlayOptions — A NetStreamPlayOptions describing the options to use while processing the content file. -
-

-See also -

-
-onDRMContentData -
-flash.net.drm.DRMContentData -
-flash.net.drm.DRMManager.loadVoucher() -
-flash.net.drm.DRMVoucher -
-client -
-
- - - - - -
publish()method 
-
-public function publish(name:String = null, type:String = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sends streaming audio, video, and data messages from a client to Flash Media Server, - optionally recording the stream during transmission. This method dispatches a NetStatusEvent object with information about the stream. - Before you call NetStream.publish(), capture the "NetConnection.Connect.Success" event - to verify that the application has successfully connected to Flash Media Server. -

While publishing, you can record files in FLV or F4V format. If you record a file in F4V format, - use a flattener tool to edit or play the file in another application. - To download the tool, see - www.adobe.com/go/fms_tools.

-

Note:Do not use this method to play a stream. To play a stream, call the NetStream.play() method.

-

Workflow for publishing a stream

-
    -
  1. Create a NetConnection object and call NetConnection.connect().
    2. -
  2. Call NetConnection.addEventListener() to listen for NetStatusEvent events.
    3. -
  3. On the "NetConnection.Connect.Success" event, create a NetStream object and pass the NetConnection object to the constructor.
    4. -
  4. To capture audio and video, call the NetStream.attachAudio()method - and the NetStream.attachCamera() method.
    5. -
  5. To publish a stream, call the NetStream.publish() method. - You can record the data as you publish it so that users can play it back later.
    6. -
-

Note: A NetStream can either publish a stream or play a stream, it cannot do both. To publish a stream and view the playback - from the server, create two NetStream objects. You can send multiple NetStream objects over one NetConnection object.

-

When Flash Media Server records a stream it creates a file. - By default, the server creates a directory with the - application instance name passed to NetConnection.connect() and stores the file in the directory. - For example, the following code connects to the default instance of the "lectureseries" application and records a stream called "lecture". - The file "lecture.flv" is recorded in the applications/lectureseries/streams/_definst_ directory: -

- 
-     var nc:NetConnection = new NetConnection();
-     nc.connect("rtmp://fms.example.com/lectureseries");
-     nc.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-     
-     function netStatusHandler(event:NetStatusEvent):void
-     {
-       if (event.info.code == "NetConnection.Connect.Success")
-       {
-            var ns:NetStream = new NetStream(nc);
-            ns.publish("lecture", "record");
-       }
-     }
-
-

The following example connects to the "monday" instance of the same application. - The file "lecture.flv" is recorded in the directory /applications/lectureseries/streams/monday:

- 
-     var nc:NetConnection = new NetConnection();
-     nc.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-     nc.connect("rtmp://fms.example.com/lectureseries/monday");
-     
-     function netStatusHandler(event:NetStatusEvent):void
-     {
-       if (event.info.code == "NetConnection.Connect.Success")
-       {
-            var ns:NetStream = new NetStream(nc);
-            ns.publish("lecture", "record");
-       }
-     }
-
- Parameters - - - - - - - - - - -
name:String (default = null) — A string that identifies the stream. Clients that subscribe to this stream pass - this name when they call NetStream.play(). Don't follow the stream name with a "/". For example, don't use - the stream name "bolero/". -

- You can record files in the formats described in the following table (you cannot use publish() for MP3 format files). - The syntax differs depending on the file format.

-

- - - - - - - - - - - - - - - - - - - - - -
File formatSyntaxExample
FLVSpecify the stream name as a string without a filename extension.ns.publish("myflvstream");
MPEG-4-based files (such as F4V or MP4)Specify the stream name as a string with the prefix mp4: with or without the filename extension. - Flash Player encodes using H.263, not H.264. Flash Media Server can record any codec in the F4V container. Flash Media Live Encoder - can encode using H.264. - ns.publish("mp4:myvideo.f4v")
- ns.publish("mp4:myvideo");
RAWSpecify the stream name as a string with the prefix raw:ns.publish("raw:myvideo");
-

-
 
type:String (default = null) — A string that specifies how to publish the stream. - Valid values are "record", "append", "appendWithGap", and "live". - The default value is "live". -
    -
  • If you pass "record", the server publishes and records live data, - saving the recorded data to a new file with a name matching the value passed - to the name parameter. If the file exists, it is overwritten.
    • -
  • If you pass "append", the server publishes and records live data, - appending the recorded data to a file with a name that matches the value passed - to the name parameter. If no file matching the name parameter is found, it is created.
    • -
  • If you pass "appendWithGap", additional - information about time coordination is passed to help the server determine the correct transition point when dynamic streaming.
    • -
  • If you omit this parameter or pass "live", the server publishes live data without - recording it. If a file with a name that matches the value passed - to the name parameter exists, it is deleted.
    • -
-
-

-See also -

-
-flash.net.NetConnection.connect() -
-flash.events.NetStatusEvent.info -
-
-Example -
The following example captures video from a camera and publishes it over a NetStream to Flash Media Server. - The example displays the video as it's played back from Flash Media Server. - -

To run this example, you need a camera attached to your computer. You also need to add a Button - component and a Label component to the Library.

- -

The application has a button that publishes a stream (sends it to Flash Media Server) only after - the application has successfully connected to the server. The application plays back the stream from the server - only after the stream has been successfully published. The NetStatusEvent returns an info object with a code - property that specifies these cases. The netStatusHandler function handles these events for the NetConnection and NetStream classes.

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.media.Video;
-    import flash.media.Camera;
-    import flash.net.NetConnection;
-    import flash.net.NetStream;
-    import fl.controls.Button;
-    import fl.controls.Label;
-
-    public class NetStream_publish extends Sprite {
-        private var connectionURL:String = "rtmp://localhost/live/";
-        private var videoURL:String = "liveVideo";
-        private var nc:NetConnection;
-        private var ns_publish:NetStream;
-        private var ns_playback:NetStream;
-        private var video_publish:Video;
-        private var video_playback:Video;
-        private var cam:Camera;
-		private var b:Button;
-		private var l:Label;
-
-        public function NetStream_publish() {
-			setUpUI();
-			
-            nc = new NetConnection();
-            nc.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-			
-			// Add bandwidth detection handlers on the NetConnection Client to
-			// prevent Reference Errors at runtime when using the "live" and "vod" applications.		  
-			var clientObj:Object = new Object();
-			clientObj.onBWDone = onBWDone;
-			clientObj.onBWCheck = onBWCheck;
-			nc.client = clientObj;
-			
-			// Connect to the "live" application on Flash Media Server.
-            nc.connect(connectionURL);
-        }
-
-        private function netStatusHandler(event:NetStatusEvent):void {
-			trace(event.info.code + " | " + event.info.description);
-            switch (event.info.code) {
-                case "NetConnection.Connect.Success":
-					// Enable the "Publish" button after the client connects to the server.
-					b.enabled = true;
-					break;
-                case "NetStream.Publish.Start":
-					playbackVideo();
-					break;
-            }
-        }
-	
-        private function publishVideo(event:MouseEvent):void{
-			// Disable the button so that you can only publish once.
-			b.enabled = false;
-            // Create a NetStream to send video to FMS.
-            ns_publish = new NetStream(nc);
-            ns_publish.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            // Publish (send) the video to FMS.
-            cam = Camera.getCamera();
-            ns_publish.attachCamera(cam);
-           	ns_publish.publish(videoURL);
-        }
-
-        private function playbackVideo():void {
-            // Create the Video object to show the video on the stage
-            video_playback = new Video(cam.width, cam.height);
-            video_playback.x = cam.width + 20;
-            video_playback.y = 10;
-            addChild(video_playback);
-            // Create a NetStream to receive the video from FMS.
-            ns_playback = new NetStream(nc);
-            ns_playback.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            // Display the video that was published to FMS.
-			      video_playback.attachNetStream(ns_playback);
-            ns_playback.play(videoURL); 
-        }
-		
-		
-		private function setUpUI():void { 
-      b = new Button(); 
-      b.addEventListener(MouseEvent.CLICK, publishVideo);
-      b.width = 150;
-			b.label = "Publish video to server";
-			b.move(10, 150);
-			b.enabled = false;
-			
-			l = new Label();
-			l.width = 150;
-			l.text = "Playing back from server"
-			l.move(190, 150);
-			
-			addChild(b);
-			addChild(l);
-		}
-		
-		// Handlers called by the Flash Media Server "live" and "vod" applications.
-		public function onBWDone(... rest):Boolean {
-			return true;
-		}
-		
-		public function onBWCheck(... rest):Number {
-			return 0;
-		}
-    }
-}
-
-

-
- - - - - -
receiveAudio()method 
-
-public function receiveAudio(flag:Boolean):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether incoming audio plays on the stream. - This method is available only to clients subscribed to the specified stream. - It is not available to the publisher of the stream. Call this method before or after you call the NetStream.play() method. - For example, attach this method to a button to allow users to mute and unmute the audio. - Use this method only on unicast streams that are played back from Flash Media Server. This method doesn't work on RTMFP multicast streams - or when using the NetStream.appendBytes() method. -

Parameters - - - - -
flag:Boolean — Specifies whether incoming audio plays on the stream (true) or not (false). The default value is true. - If the specified stream contains only audio data, NetStream.time stops incrementing when you pass false. -
-
- - - - - -
receiveVideo()method 
-
-public function receiveVideo(flag:Boolean):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether incoming video plays on the stream. This method is available only to clients subscribed to the specified stream. - It is not available to the publisher of the stream. Call this method before or after you call the NetStream.play() method. - For example, attach this method to a button to allow users to show and hide the video. - Use this method only on unicast streams that are played back from Flash Media Server. This method doesn't work on RTMFP multicast streams - or when using the NetStream.appendBytes() method. -

Parameters - - - - -
flag:Boolean — Specifies whether incoming video plays on this stream (true) or not (false). The default value is true. - If the specified stream contains only video data, NetStream.time stops incrementing when you pass false. -
-
- - - - - -
receiveVideoFPS()method 
-
-public function receiveVideoFPS(FPS:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies the frame rate for incoming video. This method is available only to clients subscribed to the specified stream. - It is not available to the publisher of the stream. - Call this method before or after you call the NetStream.play() method. For example, call this method to allow users - to set the video frame rate. To determine the current frame rate, use NetStream.currentFPS. To stop receiving video, pass 0. -

When you pass a value to the FPS parameter to limit the frame rate of the video, Flash Media Server attempts to reduce the frame rate while preserving - the integrity of the video. Between every two keyframes, the server sends the minimum number of frames needed to satisfy the desired rate. - Please note that I-frames (or intermediate frames) must be sent contiguously, otherwise the video is corrupted. Therefore, the desired number of frames - is sent immediately and contiguously following a keyframe. Since the frames are not evenly distributed, the motion appears smooth in segments punctuated by stalls.

-

Use this method only on unicast streams that are played back from Flash Media Server. This method doesn't work on RTMFP multicast streams or when using the - NetStream.appendBytes() method.

- Parameters - - - - -
FPS:Number — Specifies the frame rate per second at which the incoming video plays. -
-
- - - - - -
resume()method 
-
-public function resume():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Resumes playback of a video stream that is paused. If the video is already playing, calling this method - does nothing. -

-See also -

-
-close() -
-pause() -
-play() -
-togglePause() -
-
- - - - - -
seek()method 
-
-public function seek(offset:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Seeks the keyframe (also called an I-frame in the video industry) closest to - the specified location. The keyframe is placed at an offset, in seconds, from - the beginning of the stream. -

- Video streams are usually encoded with two types of frames, keyframes (or I-frames) - and P-frames. A keyframe contains an entire image, while a P-frame is an - interim frame that provides additional video information between keyframes. - A video stream typically has a keyframe every 10-50 frames. -

-

Flash Media Server has several types of seek behavior: enhanced seeking and smart seeking.

-

Enhanced seeking

-

Enhanced seeking is enabled by default. To disable enhanced seeking, on Flash Media Server set the EnhancedSeek - element in the Application.xml configuration file to false. -

-

If enhanced seeking is enabled, the server generates - a new keyframe at offset based on the previous keyframe and any - intervening P-frames. However, generating keyframes creates a high processing load on the server - and distortion might occur in the generated keyframe. - If the video codec is On2, the keyframe before the seek point and any - P-frames between the keyframe and the seek point are sent to the client. -

-

- If enhanced seeking is disabled, the server starts streaming - from the nearest keyframe. For example, suppose a video has keyframes at 0 seconds - and 10 seconds. A seek to 4 seconds causes playback to start at 4 seconds - using the keyframe at 0 seconds. The video stays frozen until it reaches the - next keyframe at 10 seconds. To get a better seeking experience, you need to - reduce the keyframe interval. In normal seek mode, you cannot start the video - at a point between the keyframes. -

-

Smart seeking

-

To enable smart seeking, set NetStream.inBufferSeek to true.

-

Smart seeking allows Flash Player to seek within an existing back buffer and forward buffer. When smart seeking is disabled, - each time seek() is called Flash Player flushes the buffer and requests data from the server. - For more information, see NetStream.inBufferSeek.

-

Seeking in Data Generation Mode

-

When you call seek() on a NetStream in Data Generation Mode, all bytes passed to - appendBytes() are discarded (not placed in the buffer, accumulated in the partial message FIFO, or parsed for seek points) - until you call appendBytesAction(NetStreamAppendBytesAction.RESET_BEGIN) or appendBytesAction(NetStreamAppendBytesAction.RESET_SEEK) - to reset the parser. For information about Data Generation Mode, see NetStream.play().

- Parameters - - - - -
offset:Number — The approximate time value, in seconds, to move to in a video file. - With Flash Media Server, if <EnhancedSeek> is set to true in the Application.xml - configuration file (which it is by default), the server - generates a keyframe at offset. -
    -
  • To return to the beginning of the stream, pass 0 for offset.
    • -
  • To seek forward from the beginning of the stream, pass the number of seconds to advance. - For example, to position the playhead at 15 seconds from the beginning (or the keyframe - before 15 seconds), use myStream.seek(15).
    • -
  • To seek relative to the current position, pass NetStream.time + n - or NetStream.time - n - to seek n seconds forward or backward, respectively, from the current position. - For example, to rewind 20 seconds from the current position, use - NetStream.seek(NetStream.time - 20).
    • -
-
-

-See also -

-
-inBufferSeek -
-backBufferLength -
-backBufferTime -
-step() -
-time -
-play() -
-
- - - - - -
send()method 
-
-public function send(handlerName:String, ... arguments):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sends a message on a published stream to all subscribing clients. - This method is available only to the publisher of the specified stream. - This method is available for use with Flash Media Server only. - To process and respond to this message, create a handler on the - NetStream object, for example, ns.HandlerName. -

- Flash Player or AIR does not serialize methods - or their data, object prototype variables, or non-enumerable variables. For display objects, - Flash Player or AIR serializes the path but none of the data. -

-

- You can call the send() method to add data keyframes to a live stream - published to Flash Media Server. A data keyframe is a message a publisher adds - to a live stream. Data keyframes are typically used to add metadata to a live stream - before data is captured for the stream from camera and microphone. - A publisher can add a data keyframe at any time while the live stream is being published. - The data keyframe is saved in the server's memory as long - as the publisher is connected to the server. -

-

- Clients who are subscribed to the live stream before a data keyframe is - added receive the keyframe as soon as it is added. Clients who subscribe - to the live stream after the data keyframe is added receive the keyframe - when they subscribe. -

-

- To add a keyframe of metadata to a live stream sent to Flash Media Server, use - @setDataFrame as the handler name, - followed by two additional arguments, for example: -

- 
-     var ns:NetStream = new NetStream(nc);
-     ns.send("@setDataFrame", "onMetaData", metaData);
-
- 
-     var ns = new air.NetStream(nc);
-     ns.send("@setDataFrame", "onMetaData", metaData);
-
-

- The @setDataFrame argument - refers to a special handler built in to Flash Media Server. - The onMetaData argument is the - name of a callback function in your client application that - listens for the onMetaData event and retrieves the metadata. - The third item, metaData, is an instance - of Object or Array - with properties that define the metadata values. -

-

Use @clearDataFrame to clear a keyframe - of metadata that has already been set in the stream: -

- 
-     ns.send("@clearDataFrame", "onMetaData");
-
- Parameters - - - - - - - - - - -
handlerName:String — The message to send; also the name of the ActionScript - handler to receive the message. The handler name can be only one level deep - (that is, it can't be of the form parent/child) and is relative to the stream object. - Do not use a reserved term for a handler name. - For example, using "close" as a handler name causes - the method to fail. - With Flash Media Server, use @setDataFrame to add a - keyframe of metadata to a live stream - or @clearDataFrame to remove a keyframe. -
 
... arguments — Optional arguments that can be of any type. They are - serialized and sent over the connection, and the receiving handler receives - them in the same order. If a parameter is a circular object (for example, - a linked list that is circular), the serializer handles the references correctly. - With Flash Media Server, - if @setDataFrame is the first argument, - use onMetaData as the second argument; for the third - argument, pass an instance of Object - or Array that has the metadata set as properties. - See the - Flash Media Server Developer Guide - for a list of suggested - property names. - With @clearDataFrame as the first argument, - use onMetaData as the second argument and no third argument. -
-

-See also -

-
-client -
-dataReliable -
-play() -
-
-Example -
-
-
-package {
-   import flash.display.Sprite;
-   import flash.net.NetConnection;
-   import flash.net.NetStream;
-   import flash.events.NetStatusEvent;
-   import flash.media.Video;
-   import flash.utils.setTimeout;
-
- 
-   public class TestExample extends Sprite
-   {
-     var nc:NetConnection = new NetConnection();
-     var ns1:NetStream;
-     var ns2:NetStream;
-     var vid:Video = new Video(300,300);
-     var obj:Object = new Object();
- 
-     public function TestExample() {
-        nc.objectEncoding = 0;
-        nc.addEventListener("netStatus", onNCStatus);
-        nc.connect("rtmp://localhost/FlashVideoApp");
-        addChild(vid); 
-     }
-  
-     function onNCStatus(event:NetStatusEvent):void {
-       switch (event.info.code) {
-           case "NetConnection.Connect.Success":
-               trace("You've connected successfully");
-               ns1 = new NetStream(nc);
-               ns2 = new NetStream(nc);
-               
-               ns1.client = new CustomClient();
-               ns1.publish("dummy", "live");
-    
-               ns2.client = new CustomClient();
-               vid.attachNetStream(ns2);
-               ns2.play("dummy");
-               setTimeout(sendHello, 3000);
-               break;
-              
-           case "NetStream.Publish.BadName":
-               trace("Please check the name of the publishing stream" );
-               break;
-        }   
-     }
-
-     function sendHello():void {
-         ns1.send("myFunction", "hello");
-     }       
-   }
- }
- 
- class CustomClient {
-    public function myFunction(event:String):void {
-       trace(event);
-    }
- }
-
-

-
-
-private function netStatusHandler(event:NetStatusEvent):void {
-     switch (event.info.code) {  
-        case "NetStream.Publish.Start":
-            var metaData:Object = new Object();
-            metaData.title = "myStream";
-            metaData.width = 400;
-            metaData.height = 200;
-            ns.send("&#64;setDataFrame", "onMetaData", metaData);
-            ns.attachCamera( Camera.getCamera() );
-            ns.attachAudio( Microphone.getMicrophone() );    	
-	}
-}
-
-

-
-
- public function onMetaData(info:Object):void {
-    trace("width: " + info.width);
-    trace("height: " + info.height);
- }
-
-

-
-
- // Create a NetStream for playing
- var my_ns:NetStream = new NetStream(my_nc);
- my_video.attachNetStream(my_ns);
- 
- // Play the stream record1
- my_ns.play("record1", 0, -1, true);
- 
- // Switch to the stream live1 and play for 5 seconds.  
- // Since reset is false, live1 will start to play after record1 is done.
- my_ns.play("live1", -1 , 5, false);
-
-

-
-
- //To play at normal speed
- var my_ns:NetStream = new NetStream(my_nc);
- my_ns.play("log", 0, -1);
- 
- //To get the data messages all at once
- my_ns.play("log", 0, -1, 3);
-
-

-
- - - - - -
step()method 
-
-public function step(frames:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Steps forward or back the specified number of frames, relative to the currently displayed frame. - Specify a positive number to step forward and a negative number to step in reverse. - Call this method to create accurate fast forward or rewind functionality. -

Note: This method is not supported for H.264 video in AIR 3.0 for iOS.

-

This method is available only when data is streaming from Flash Media Server 3.5.3 or higher - and when NetStream.inBufferSeek is true. Also, the target frame must be in the buffer. - For example, if the currently displayed frame is frame number 120 and you specify a value - of 1000, the method fails if frame number 1120 is not in the buffer.

-

This method is intended to be used with the pause() or togglePause() methods. If you - step 10 frames forward or backward during playback without pausing, you may not notice the steps or they'll look like a glitch. - Also, when you call pause() or togglePause the audio is suppressed.

-

If the call to NetStream.step() is successful, a NetStatusEvent is sent with "NetStream.Step.Notify" - as the value of the info object's code property.

-

- Parameters - - - - -
frames:int
-

-See also -

-
-inBufferSeek -
-backBufferTime -
-backBufferLength -
-bufferTime -
-bufferLength -
-step() -
-seek() -
-
- - - - - -
togglePause()method 
-
-public function togglePause():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Pauses or resumes playback of a stream. - The first time you call this method, it pauses play; the next time, it resumes play. - You could use this method to let users pause or resume playback by pressing - a single button. -

-See also -

-
-close() -
-play() -
-pause() -
-resume() -
-
-
Event detail
- - - - - -
asyncErrorevent 
-
-Event object type: flash.events.AsyncErrorEvent -
-AsyncErrorEvent.type property = flash.events.AsyncErrorEvent.ASYNC_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code. - This event is dispatched when a server calls a method on the client that is not defined. -

- The AsyncErrorEvent.ASYNC_ERROR constant defines the value of the - type property of an asyncError event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse - This property applies to ActionScript 3.0 display objects (in SWF files).
cancelablefalse; there is no default - behavior to cancel. This property applies to display objects - in SWF content, which use the ActionScript 3.0 display architecture.
currentTargetThe object that is actively processing the - Event object with an event listener. This property applies to display - objects in SWF content, which use the ActionScript 3.0 display architecture.
target The object dispatching the event.
errorThe error that triggered the event.
- -

-See also -

-
-onPlayStatus -
-onMetaData -
-
- - - - - -
drmAuthenticateevent  
-
-Event object type: flash.events.DRMAuthenticateEvent -
-DRMAuthenticateEvent.type property = flash.events.DRMAuthenticateEvent.DRM_AUTHENTICATE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a NetStream object tries to play a digital rights management (DRM) encrypted - content that requires a user credential for authentication before playing. -

Note: This event is not supported for H.264 video in AIR 3.0 for iOS.

- -

- Use the setDRMAuthenticationCredentials() method of the NetStream object - to authenticate the user. If user authentication failed, the application retries - authentication and dispatches a new DRMAuthenticateEvent event for the NetStream object. -

-

- The DRMAuthenticateEvent.AUTHENTICATION_TYPE_PROXY constant defines the value of the - authenticationType property of a DRMAuthenticateEvent object. - -

This event has the following properties:

- - - - - - - - - - - - -
PropertyValue
authenticationTypeIndicates whether the supplied credentials are for - authenticating against the Flash Media Rights Management Server (FMRMS) or a proxy server.
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
headerThe encrypted content file header provided by the server.
netstreamThe NetStream object that initiated this event.
passwordPromptA prompt for a password credential, provided by the server.
targetThe NetStream object.
urlPromptA prompt for a URL to display, provided by the server.
usernamePromptA prompt for a user name credential, provided by the server.
- -

-See also -

-
-flash.events.DRMAuthenticateEvent -
-flash.net.drm.DRMManager.resetDRMVouchers() -
-setDRMAuthenticationCredentials() -
-
- - - - - -
drmErrorevent  
-
-Event object type: flash.events.DRMErrorEvent -
-DRMErrorEvent.type property = flash.events.DRMErrorEvent.DRM_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when a NetStream object, trying to play a digital rights management (DRM) encrypted - file, encounters a DRM-related error. For example, a DRMErrorEvent object is dispatched when - the user authorization fails. This may be because the user has not purchased the rights to view the content - or because the content provider does not support the viewing application. -

Note: This event is not supported for H.264 video in AIR 3.0 for iOS.

- -

- The DRMErrorEvent.DRM_ERROR constant defines the value of the - type property of a drmError event object. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
errorIDA numerical error code assigned to the problem.
subErrorIDAn error code that indicates more detailed information about - the underlying problem.
targetThe NetStream object.
- -

-See also -

-
-flash.events.DRMErrorEvent -
-flash.net.drm.DRMManager.resetDRMVouchers() -
-setDRMAuthenticationCredentials() -
-
- - - - - -
drmStatusevent  
-
-Event object type: flash.events.DRMStatusEvent -
-DRMStatusEvent.type property = flash.events.DRMStatusEvent.DRM_STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when the digital rights management (DRM) encrypted content - begins playing (when the user is authenticated and authorized to play the content). -

Note: This event is not supported for H.264 video in AIR 3.0 for iOS.

- -

- DRMStatusEvent object contains information related to the voucher, such as whether the content - is available offline or when the voucher expires and users can no longer view the content. -

-

- The DRMStatusEvent.DRM_STATUS constant defines the value of the - type property of a drmStatus event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
detailA string explaining the context of the status event.
isAnonymousIndicates whether the content protected with DRM - encryption is available without requiring a user to provide authentication credentials.
isAvailableOfflineIndicates whether the content protected with DRM - encryption is available offline.
offlineLeasePeriodThe remaining number of days that content can be - viewed offline.
policiesA custom object of the DRM status event.
targetThe NetStream object.
voucherEndDateThe absolute date on which the voucher expires - and the content can no longer be viewed by users
contentDataThe DRMContentData for the content
voucherThe DRMVoucher object for the content.
isLocalIndicates whether the content is stored on the local file system
- - -

-See also -

-
-flash.events.DRMStatusEvent -
-flash.net.drm.DRMManager.resetDRMVouchers() -
-setDRMAuthenticationCredentials() -
-
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when an input or output error occurs that causes a network operation to fail. -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -
- - - - - -
mediaTypeDataevent  
-
-Event object type: flash.events.NetDataEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Dispatched when playing video content and certain type of messages are processed. -

A NetDataEvent is dispatched for the following messages:

-
    -
  • onCuePoint
    • -
  • onImageData
    • -
  • onMetaData
    • -
  • onPlayStatus (for code NetStream.Play.Complete)
    • -
  • onTextData
    • -
  • onXMPData
    • -
- -

Note: This event is not dispatched by content running in Flash Player in the browser on Android or Blackberry Tablet OS or - by content running in AIR on iOS.

- -
- - - - - -
netStatusevent  
-
-Event object type: flash.events.NetStatusEvent -
-NetStatusEvent.type property = flash.events.NetStatusEvent.NET_STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a NetStream object is reporting its status or error condition. - The netStatus event contains an info property, - which is an information object that contains specific information about the event, - such as if a connection attempt succeeded or failed. -

- Defines the value of the type property of a netStatus event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
infoAn object with properties that describe the object's status or error condition.
targetThe NetConnection or NetStream object reporting its status.
-

-See also -

-
-flash.events.NetStatusEvent.info -
-
- - - - - -
onCuePointevent  
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Establishes a listener to respond when an embedded cue point is reached while playing a video file. You can use the listener to trigger actions in your - code when the video reaches a specific cue point, which lets you synchronize other actions in your application with video - playback events. For information about video file formats supported by Flash Media Server, see - the www.adobe.com/go/learn_fms_fileformats_en. -

Note: This event is not supported for H.264 video in AIR 3.0 for iOS.

-

onCuePoint is actually a property of the NetStream.client - object. IThe property is listed in the Events section because it responds to a data - event, either when streaming media using Flash Media Server or during FLV file playback. For more information, see the NetStream class - description. You cannot use the addEventListener() method, or any - other EventDispatcher methods, to listen for, or process onCuePoint as an event. Define a - callback function and attach it to one of the following objects:

-
    -
  • The object that the client property of a NetStream instance references.
    • -
  • An instance of a NetStream subclass. NetStream is a sealed class, which means that properties or methods cannot be added to a NetStream object - at runtime. Create a subclass of NetStream and define your event handler in the subclass. - You can also make the subclass dynamic and add the event handler function to an instance of the subclass.
    • -
-

The associated event listener is triggered after a call to the NetStream.play() method, but before the - video playhead has advanced.

-

You can embed the following types of cue points in a video file:

-
    -
  • A navigation cue point specifies a keyframe within the video file - and the cue point's time property corresponds to that exact keyframe. Navigation cue points are often used as bookmarks - or entry points to let users navigate through the video file.
    • -
  • An event cue point specifies a time. The time may or may not correspond to a specific keyframe. - An event cue point usually represents a time in the video when something happens that could be used to trigger other application events.
    • -
-

The onCuePoint event object has the following properties:

- - - - - - - - - - - - - - - - - - - - -
PropertyDescription
nameThe name given to the cue point when it was embedded in the video file.
parametersAn associative array of name and value pair strings specified for this cue point. Any valid string can be used for - the parameter name or value.
timeThe time in seconds at which the cue point occurred in the video file during playback.
typeThe type of cue point that was reached, either navigation or event.
-

You can define cue points in a video file when you first encode the file, or when you import a video clip in - the Flash authoring tool by using the Video Import wizard.

-

The onMetaData event also retrieves information about the cue points in a video file. - However the onMetaData event gets information about all of the cue points - before the video begins playing. The onCuePoint event receives information about a single cue point - at the time specified for that cue point during playback.

-

Generally, to have your code respond to a specific cue point at the time it occurs, use - the onCuePoint event to trigger some action in your code.

-

You can use the list of cue points provided to the onMetaData event to - let the user start playing the video at predefined points along the video stream. - Pass the value of the cue point's time property to the - NetStream.seek() method to play the video from that cue point.

-
-Example -
The following example shows how you can load external FLV files and respond to metadata and cue points. - Example provided by - ActionScriptExamples.com. -
-
-var video:Video = new Video();
-addChild(video);
- 
-var nc:NetConnection = new NetConnection();
-nc.connect(null);
- 
-var ns:NetStream = new NetStream(nc);
-ns.client = {};
-ns.client.onMetaData = ns_onMetaData;
-ns.client.onCuePoint = ns_onCuePoint;
-
-video.attachNetStream(ns);
-ns.play("http://www.helpexamples.com/flash/video/cuepoints.flv");
-
- 
-function ns_onMetaData(item:Object):void {
-    trace("metaData");
-    // Resize video instance.
-    video.width = item.width;
-    video.height = item.height;
-    // Center video instance on Stage.
-    video.x = (stage.stageWidth - video.width) / 2;
-    video.y = (stage.stageHeight - video.height) / 2;
-}
- 
-function ns_onCuePoint(item:Object):void {
-    trace("cuePoint");
-    trace(item.name + "\t" + item.time);
-}
-
-

-

-See also -

-
-client -
-onMetaData -
-
- - - - - -
onDRMContentDataevent  
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Establishes a listener to respond when AIR extracts DRM content metadata embedded in a media file. -

Note: This event is not supported for H.264 video in AIR 3.0 for iOS.

-

A DRMContentData object contains the information needed to obtain - a voucher required to play a DRM-protected media file. Use the DRMManager class to download the voucher with - this information.

-

onDRMContentData is a property of the NetStream.client - object. This property is listed in the Events section because it responds to a data - event when preloading embedded data from a local media file. - For more information, see the NetStream class - description. You cannot use the addEventListener() method, or any - other EventDispatcher methods, to listen for, or process onDRMContentData as an event. - Rather, you must define a single - callback function and attach it directly to one of the following objects:

-
    -
  • The object that the client property of a NetStream instance references.
    • -
  • An instance of a NetStream subclass. NetStream is a sealed class, which means that properties - or methods cannot be added to a NetStream object at runtime. However, you can create a subclass of - NetStream and define your event handler in the subclass or make the subclass dynamic and add the - event handler function to an instance of the subclass.
    • -
-

-See also -

-
-flash.net.drm.DRMContentData -
-preloadEmbeddedData() -
-flash.net.drm.DRMManager -
-flash.net.drm.DRMVoucher -
-
- - - - - -
onImageDataevent  
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Establishes a listener to respond when Flash Player receives image data as a byte array embedded in a media file that is - playing. The image data can produce either JPEG, PNG, or GIF content. Use the - flash.display.Loader.loadBytes() method to load the byte array into a display object. -

Note: This event is not supported for H.264 video in AIR 3.0 for iOS.

- -

onImageData is actually a property of the NetStream.client - object. The property is listed in the Events section because it responds to a data - event, either when streaming media using Flash Media Server or during FLV file playback. For more information, see the NetStream class - description. You cannot use the addEventListener() method, or any - other EventDispatcher methods, to listen for, or process onImageData as an event. Define a single - callback function and attach it to one of the following objects:

-
    -
  • The object that the client property of a NetStream instance references.
    • -
  • An instance of a NetStream subclass. NetStream is a sealed class, which means that properties or methods cannot be added - to a NetStream object at runtime. Create a subclass of NetStream and define your event handler in the subclass. - You can also make the subclass dynamic and add the event handler function to an instance of the subclass.
    • -
-

The associated event listener is triggered after a call to the NetStream.play() method, but before the - video playhead has advanced.

-

The onImageData event object contains the image data as a byte array sent through an AMF0 data channel.

-
-Example -
The code in this example uses the Netstream.client property to handle - the callback functions for onTextData and onImageData. - The onImageDataHandler() function uses the onImageData event object - imageData to store the byte array. And, the onTextDataHandler() - function uses the onTextData event object textData to store the pieces of - text data (each piece of data is a property of the textData object). -

You need to substitute a real location to a media file with text or image - metadata for the location "yourURL" in the code.

-

You can also handle image and text data using a custom class. See the article - Handling metadata and cue points in Flash video for more information and examples.

-
-
-package {
-    import flash.display.*;
-    import flash.net.*;
-    import flash.media.*;
-    import flash.system.*;
-    import flash.events.*;
-
-        public class OnTextDataExample extends Sprite {
-                                              
-            public function OnTextDataExample():void {
-
-                var my_video:Video = new Video();
-                addChild(my_video);
-
-                var customClient:Object = new Object();
-                customClient.onImageData = onImageDataHandler;           
-                customClient.onTextData = onTextDataHandler;               
-
-                var my_nc:NetConnection = new NetConnection();
-                my_nc.connect(null);
-                var my_ns:NetStream = new NetStream(my_nc);
-                my_ns.client = customClient;
-
-                my_video.attachNetStream(my_ns);
-                my_ns.play("yourURL");
-            }
-
-            public function onImageDataHandler(imageData:Object):void {
-
-                trace("imageData length: " + imageData.data.length);
-                var imageloader:Loader = new Loader();           
-                imageloader.loadBytes(imageData.data); // imageData.data is a ByteArray object.
-                addChild(imageloader);
-            }
-
-    
-            public function onTextDataHandler(textData:Object):void {
-
-                trace("--- textData properties ----");
-                var key:String;
-
-                for (key in textData) {
-                    trace(key + ": " + textData[key]);
-                }
-            }
-
-        }
-
-}
-
-

-

-See also -

-
-NetConnection -
-flash.display.Loader.loadBytes() -
-client -
-asyncError -
-play() -
-onTextData -
-
- - - - - -
onMetaDataevent  
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Establishes a listener to respond when Flash Player receives descriptive information embedded in the video being played. - For information about video file formats supported by Flash Media Server, see - the www.adobe.com/go/learn_fms_fileformats_en. -

onMetaData is actually a property of the NetStream.client - object. The property is listed in the Events section because it responds to a data - event, either when streaming media using Flash Media Server or during FLV file playback. - For more information, see the NetStream class description and the - NetStream.client property. You cannot use the addEventListener() - method, or any other EventDispatcher methods, to listen for or process - onMetaData as an event. Define a single - callback function and attach it to one of the following objects:

-
    -
  • The object that the client property of a NetStream instance references.
    • -
  • An instance of a NetStream subclass. NetStream is a sealed class, which means that properties or methods - cannot be added to a NetStream object at runtime. You can create a subclass of NetStream - and define your event handler in the subclass. You can also make the subclass dynamic and add the event handler function - to an instance of the subclass.
    • -
-

The Flash Video Exporter utility (version 1.1 or later) embeds - a video's duration, creation date, data rates, and other information into the video file itself. - Different video encoders embed different sets of meta data.

-

The associated event listener is triggered after a call to the NetStream.play() method, - but before the video playhead has advanced.

-

In many cases, the duration value embedded in stream metadata approximates the actual duration - but is not exact. In other words, it does not always match the value of the NetStream.time property - when the playhead is at the end of the video stream.

-

The event object passed to the onMetaData event handler contains one property for each piece of data.

-
-Example -
The following example shows how you can load external FLV files and respond to metadata and cue points. - Example provided by - ActionScriptExamples.com. -
-
-var video:Video = new Video();
-addChild(video);
- 
-var nc:NetConnection = new NetConnection();
-nc.connect(null);
- 
-var ns:NetStream = new NetStream(nc);
-ns.client = {};
-ns.client.onMetaData = ns_onMetaData;
-ns.client.onCuePoint = ns_onCuePoint;
-
-video.attachNetStream(ns);
-ns.play("http://www.helpexamples.com/flash/video/cuepoints.flv");
-
- 
-function ns_onMetaData(item:Object):void {
-    trace("metaData");
-    // Resize video instance.
-    video.width = item.width;
-    video.height = item.height;
-    // Center video instance on Stage.
-    video.x = (stage.stageWidth - video.width) / 2;
-    video.y = (stage.stageHeight - video.height) / 2;
-}
- 
-function ns_onCuePoint(item:Object):void {
-    trace("cuePoint");
-    trace(item.name + "\t" + item.time);
-}
-
-

-

-See also -

-
-NetConnection -
-client -
-asyncError -
-onCuePoint -
-play() -
-time -
-
- - - - - -
onPlayStatusevent  
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Establishes a listener to respond when a NetStream object has completely played a stream. - The associated event object provides information in addition to - what's returned by the netStatus event. - You can use this property to trigger actions in your code when a NetStream object - has switched from one stream to another stream in a playlist (as indicated by the - information object NetStream.Play.Switch) - or when a NetStream object has played to the end (as indicated by the information object - NetStream.Play.Complete). -

onPlayStaus is actually a property of the NetStream.client - object. The property is listed in the Events section because it responds to a data - event, either when streaming media using Flash Media Server or during FLV file playback. For more information, see the NetStream class - description. You cannot use the addEventListener() method, or any - other EventDispatcher methods, to listen for, or process onPlayStatus as an event. Define a - callback function and attach it to one of the following objects:

-
    -
  • The object that the client property of a NetStream instance references.
    • -
  • An instance of a NetStream subclass. NetStream is a sealed class, which means that - properties or methods cannot be added to a NetStream object at runtime. Create a subclass of NetStream and - define your event handler in the subclass. You can also make the subclass dynamic and add the event handler function to - an instance of the subclass.
    • -
-

This event can return an information object with the following properties:

- - - - - - - - - - - - - - - - - - - - - - -
Code propertyLevel propertyMeaning
NetStream.Play.Switch"status"The subscriber is switching from one stream to another in a playlist.
NetStream.Play.Complete"status"Playback has completed.
NetStream.Play.TransitionComplete"status"The subscriber is switching to a new stream as a result of stream bit-rate switching
-

-See also -

-
-client -
-flash.events.NetStatusEvent.NET_STATUS -
-asyncError -
-onMetaData -
-onCuePoint -
-
- - - - - -
onSeekPointevent  
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Called synchronously from appendBytes() when the append bytes parser encounters a point that it believes is a seekable - point (for example, a video key frame). Use this event to construct a seek point table. The byteCount corresponds to - the byteCount at the first byte of the parseable message for that seek point, and is reset to zero as described above. - To seek, at the event NetStream.Seek.Notify, find the bytes that start at a - seekable point and call appendBytes(bytes). - If the bytes argument is a ByteArray consisting of bytes starting at the seekable point, the video - plays at that seek point. -

Note: Calls to appendBytes() from within this callback are ignored.

-

Note: This event is not supported for H.264 video in AIR 3.0 for iOS.

- -

The onSeekPoint property is a property of the NetStream.client - object. The property is listed in the Events section because it responds to data - coming into the appendBytes() method. - For more information, see the NetStream class description and the - NetStream.client property. You cannot use the addEventListener() - method, or any other EventDispatcher methods, to listen for or process - onSeekPoint as an event. To use onSeekPoint, define a - callback function and attach it to one of the following objects:

-
    -
  • The object that the client property of a NetStream instance references.
    • -
  • An instance of a NetStream subclass. NetStream is a sealed class, which means that properties or methods - cannot be added to a NetStream object at runtime. However, you can create a subclass of NetStream - and define your event handler in the subclass. You can also make the subclass dynamic and add the event handler function - to an instance of the subclass.
    • -
-

-See also -

-
-client -
-
- - - - - -
onTextDataevent  
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Establishes a listener to respond when Flash Player receives text data embedded in a media file that is playing. - The text data - is in UTF-8 format and can contain information about formatting based on the 3GP timed text specification. -

Note: This event is not supported for H.264 video in AIR 3.0 for iOS.

- -

onTextData is actually a property of the NetStream.client - object. The property is listed in the Events section because it responds to a data - event, either when streaming media using Flash Media Server or during FLV file playback. For more information, - see the NetStream class - description. You cannot use the addEventListener() method, or any - other EventDispatcher methods, to listen for, or process onTextData as an event. - Define a callback function and attach it to one of the following objects:

-
    -
  • The object that the client property of a NetStream instance references.
    • -
  • An instance of a NetStream subclass. NetStream is a sealed class, which means that properties or - methods cannot be added to a NetStream object at runtime. Create a subclass of - NetStream and define your event handler in the subclass. You can also make the subclass dynamic and add the - event handler function to an instance of the subclass.
    • -
-

The associated event listener is triggered after a call to the NetStream.play() method, but before the - video playhead has advanced.

-

The onTextData event object contains one property for each piece of text data.

-
-Example -
The code in this example uses the Netstream.client property to handle - the callback functions for onTextData and onImageData. - The onImageDataHandler() function uses the onImageData event object - imageData to store the byte array. And, the onTextDataHandler() - function uses the onTextData event object textData to store the pieces of - text data (each piece of data is a property of the textData object). -

You need to substitute a real location to a media file with text or image - metadata for the location "yourURL" in the code.

-

You can also handle image and text data using a custom class. See the article - Handling metadata and cue points in Flash video for more information and examples.

-
-
-package {
-    import flash.display.*;
-    import flash.net.*;
-    import flash.media.*;
-    import flash.system.*;
-    import flash.events.*;
-
-        public class OnTextDataExample extends Sprite {
-                                              
-            public function OnTextDataExample():void {
-
-                var my_video:Video = new Video();
-                addChild(my_video);
-
-                var customClient:Object = new Object();
-                customClient.onImageData = onImageDataHandler;           
-                customClient.onTextData = onTextDataHandler;               
-
-                var my_nc:NetConnection = new NetConnection();
-                my_nc.connect(null);
-                var my_ns:NetStream = new NetStream(my_nc);
-                my_ns.client = customClient;
-
-                my_video.attachNetStream(my_ns);
-                my_ns.play("yourURL");
-            }
-
-            public function onImageDataHandler(imageData:Object):void {
-
-                trace("imageData length: " + imageData.data.length);
-                var imageloader:Loader = new Loader();           
-                imageloader.loadBytes(imageData.data); // imageData.data is a ByteArray object.
-                addChild(imageloader);
-            }
-
-    
-            public function onTextDataHandler(textData:Object):void {
-
-                trace("--- textData properties ----");
-                var key:String;
-
-                for (key in textData) {
-                    trace(key + ": " + textData[key]);
-                }
-            }
-
-        }
-
-}
-
-

-

-See also -

-
-NetConnection -
-client -
-asyncError -
-play() -
-onImageData -
-
- - - - - -
onXMPDataevent  
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Establishes a listener to respond when Flash Player receives information specific to Adobe - Extensible Metadata Platform (XMP) embedded in the video being played. - For information about video file formats supported by Flash Media Server, see - the www.adobe.com/go/learn_fms_fileformats_en. -

Note: This event is not supported for H.264 video in AIR 3.0 for iOS.

- -

onXMPData is actually a property of the NetStream.client - object. The property is listed in the Events section because it responds to a data - event, either when streaming media using Flash Media Server or during FLV file playback. - For more information, see the NetStream class description and the - NetStream.client property. You cannot use the addEventListener() - method, or any other EventDispatcher methods, to listen for or process - onMetaData as an event. Define a - callback function and attach it to one of the following objects:

-
    -
  • The object that the client property of a NetStream instance references.
    • -
  • An instance of a NetStream subclass. NetStream is a sealed class, which means that properties or methods - cannot be added to a NetStream object at runtime. - However, you can create a subclass of NetStream and define your event handler in the subclass. - You can also make the subclass dynamic and add the event handler function to an instance of the subclass.
    • -
-

The associated event listener is triggered after a call to the NetStream.play() method, - but before the video playhead has advanced.

-

The object passed to the onXMPData() event handling function has one data - property, which is a string. The string is generated from - a top-level UUID box. (The 128-bit UUID of the top level box is BE7ACFCB-97A9-42E8-9C71-999491E3AFAC.) This - top-level UUID box contains exactly one XML document represented as a null-terminated UTF-8 string.

-

-See also -

-
-flash.net.NetConnection -
-client -
-asyncError -
-onCuePoint -
-play() -
-time -
-
- - - - - -
statusevent  
-
-Event object type: flash.events.StatusEvent -
-StatusEvent.type property = flash.events.StatusEvent.STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when the application attempts to play content encrypted with digital rights management (DRM), - by invoking the NetStream.play() method. The value of the status code property will be - "DRM.encryptedFLV". -

Note: This event is not supported for H.264 video in AIR 3.0 for iOS.

- -

- Defines the value of the type property of a status event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
codeA description of the object's status.
currentTargetThe object that is actively processing the Event - object with an event listener.
levelThe category of the message, such as "status", "warning" or "error".
targetThe object reporting its status.
- -

-See also -

-
-play() -
-
- -
Constant detail
- - - - - -
CONNECT_TO_FMSconstant
-
-public static const CONNECT_TO_FMS:String = "connectToFMS" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A static object used as a parameter to - the constructor for a NetStream instance. It is the default value of the second parameter - in the NetStream constructor; it is - not used by the application for progressive media playback. When used, this parameter causes the constructor to - make a connection to a Flash Media Server instance. -

- - - - - -
DIRECT_CONNECTIONSconstant 
-
-public static const DIRECT_CONNECTIONS:String = "directConnections" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a peer-to-peer publisher connection. Pass this string for the second (optional) parameter to - the constructor for a NetStream instance. With this string, an application can create - a NetStream connection for the purposes of publishing audio and video to clients. -

- -
Examples
-
examples\NetConnectionExample
-
The following example uses a Video object with the NetConnection and - NetStream classes to load and play an FLV file. - -

In this example, the code that creates the Video and NetStream objects and calls the - Video.attachNetStream() and NetStream.play() methods is placed - in a handler function. The handler is called only if the - attempt to connect to the NetConnection object is successful; that is, - when the netStatus event returns an info object with a code - property that indicates success. - It is recommended that you wait for a successful connection before you call - NetStream.play().

-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.NetStatusEvent;
-    import flash.events.SecurityErrorEvent;
-    import flash.media.Video;
-    import flash.net.NetConnection;
-    import flash.net.NetStream;
-    import flash.events.Event;
-
-    public class NetConnectionExample extends Sprite {
-        private var videoURL:String = "http://www.helpexamples.com/flash/video/cuepoints.flv";
-        private var connection:NetConnection;
-        private var stream:NetStream;
-        private var video:Video = new Video();    	
-
-        public function NetConnectionExample() {
-            connection = new NetConnection();
-            connection.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            connection.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            connection.connect(null);
-        }
-
-        private function netStatusHandler(event:NetStatusEvent):void {
-            switch (event.info.code) {
-                case "NetConnection.Connect.Success":
-                    connectStream();
-                    break;
-                case "NetStream.Play.StreamNotFound":
-                    trace("Stream not found: " + videoURL);
-                    break;
-            }
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-
-        private function connectStream():void {
-            addChild(video);
-            var stream:NetStream = new NetStream(connection);
-            stream.addEventListener(NetStatusEvent.NET_STATUS, netStatusHandler);
-            stream.client = new CustomClient();
-            video.attachNetStream(stream);
-            stream.play(videoURL);
-        }
-    }
-}
-
-class CustomClient {
-    public function onMetaData(info:Object):void {
-        trace("metadata: duration=" + info.duration + " width=" + info.width + " height=" + info.height + " framerate=" + info.framerate);
-    }
-    public function onCuePoint(info:Object):void {
-        trace("cuepoint: time=" + info.time + " name=" + info.name + " type=" + info.type);
-    }
-}
-
-
-
examples\NetConnectionExample.2
-
You can get metadata using a function, instead of creating a custom class. The following suggestion, - provided by Bill Sanders, shows how to edit the NetConnectionExample code above to call metadata within a function. In this case, the object - mdata is used to set up the width and height of a video instance video: -
-
-  //Place the following in the connectStream() function
-  //in the NetConnectionExample code
-  var metaSniffer:Object=new Object();  
-  stream.client=metaSniffer; //stream is the NetStream instance  
-  metaSniffer.onMetaData=getMeta;  
-      
-   
-  // Add the following function within the NetConnectionExample class  
-  private function getMeta (mdata:Object):void  
-  {  
-     video.width=mdata.width/2;  
-     video.height=mdata.height/2;  
-  }
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetStreamAppendBytesAction.html b/html-docs/flash/net/NetStreamAppendBytesAction.html deleted file mode 100644 index a1c01e7..0000000 --- a/html-docs/flash/net/NetStreamAppendBytesAction.html +++ /dev/null @@ -1,313 +0,0 @@ - - - - - - - - -flash.net.NetStreamAppendBytesAction (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class NetStreamAppendBytesAction
InheritanceNetStreamAppendBytesAction Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-The NetStreamAppendBytesAction class is an enumeration of the constants you can pass to the NetStream.appendBytesAction() method. -

Two of the constants indicate a timescale discontinuity. Every FLV tag has a timestamp indicating its position in the timescale. -Timestamps are used to synchronize video, audio, and script data playback. Timestamps for FLV tags of the same type -(video, audio, script data) must not decrease as the FLV progresses.

-

-

-See also -

-
-flash.net.NetStream.appendBytesAction() -
-flash.net.NetStream.appendBytes() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  END_SEQUENCE : String = "endSequence"
[static] - Indicates that the media stream data is complete.
-		NetStreamAppendBytesAction
  RESET_BEGIN : String = "resetBegin"
[static] - Indicates a timescale discontinuity.
-		NetStreamAppendBytesAction
  RESET_SEEK : String = "resetSeek"
[static] - Indicates a timescale discontinuity.
-		NetStreamAppendBytesAction
-
- -
- -
Constant detail
- - - - - -
END_SEQUENCEconstant
-
-public static const END_SEQUENCE:String = "endSequence" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates that the media stream data is complete. For some codecs, such as H.264, the byte parser waits for - the buffer to fill to a certain point before beginning playback. Pass END_SEQUENCE to tell the byte parser to - begin playback immediately. -

- - - - - -
RESET_BEGINconstant 
-
-public static const RESET_BEGIN:String = "resetBegin" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates a timescale discontinuity. Flushes the FIFO (composed of an incomplete FLV tag) and resets the timescale to begin at the timestamp of the next appended message. - On the next call to appendBytes(), the byte parser expects a file header and starts at the beginning of a file. -

- - - - - -
RESET_SEEKconstant 
-
-public static const RESET_SEEK:String = "resetSeek" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates a timescale discontinuity. Flushes the FIFO (composed of an incomplete FLV tag) and resets the timescale to begin at the timestamp of the next appended message. - On the next call to appendBytes(), the byte parser expects the beginning of an FLV tag, as though you’ve just done a seek to - a location in the same FLV, on a tag boundary. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetStreamInfo.html b/html-docs/flash/net/NetStreamInfo.html deleted file mode 100644 index d17f503..0000000 --- a/html-docs/flash/net/NetStreamInfo.html +++ /dev/null @@ -1,1166 +0,0 @@ - - - - - - - - -flash.net.NetStreamInfo (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class NetStreamInfo
InheritanceNetStreamInfo Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The NetStreamInfo class specifies the various Quality of Service (QOS) statistics and other information related to a NetStream object - and the underlying streaming buffer for audio, video, and data. A NetStreamInfo object is returned in response - to the NetStream.info call, which takes a snapshot of the current QOS state - and provides the QOS statistics through the NetStreamInfo properties. -

Note: AIR 3.0 for iOS does not support any NetStreamInfo properties.

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  audioBufferByteLength : Number -
[read-only] - Provides the NetStream audio buffer size in bytes.
-		NetStreamInfo
  audioBufferLength : Number -
[read-only] - Provides NetStream audio buffer size in seconds.
-		NetStreamInfo
  audioByteCount : Number -
[read-only] - Specifies the total number of audio bytes that have arrived in the queue, regardless of how many have been played or flushed.
-		NetStreamInfo
  audioBytesPerSecond : Number -
[read-only] - Specifies the rate at which the NetStream audio buffer is filled in bytes per second.
-		NetStreamInfo
  audioLossRate : Number -
[read-only] - Specifies the audio loss for the NetStream session.
-		NetStreamInfo
  byteCount : Number -
[read-only] - Specifies the total number of bytes that have arrived into the queue, regardless of how many have been played or flushed.
-		NetStreamInfo
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentBytesPerSecond : Number -
[read-only] - Specifies the rate at which the NetStream buffer is filled in bytes per second.
-		NetStreamInfo
  dataBufferByteLength : Number -
[read-only] - Provides the NetStream data buffer size in bytes.
-		NetStreamInfo
  dataBufferLength : Number -
[read-only] - Provides NetStream data buffer size in seconds.
-		NetStreamInfo
  dataByteCount : Number -
[read-only] - Specifies the total number of bytes of data messages that have arrived in the queue, regardless of how many have been played or flushed.
-		NetStreamInfo
  dataBytesPerSecond : Number -
[read-only] - Specifies the rate at which the NetStream data buffer is filled in bytes per second.
-		NetStreamInfo
  droppedFrames : Number -
[read-only] - Returns the number of video frames dropped in the current NetStream playback session.
-		NetStreamInfo
  isLive : Boolean -
[read-only] - Whether the media being played is recorded or live.
-		NetStreamInfo
  maxBytesPerSecond : Number -
[read-only] - Specifies the maximum rate at which the NetStream buffer is filled in bytes per second.
-		NetStreamInfo
  metaData : Object -
[read-only] - The most recent metadata object associated with the media being played.
-		NetStreamInfo
  playbackBytesPerSecond : Number -
[read-only] - Returns the stream playback rate in bytes per second.
-		NetStreamInfo
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  resourceName : String -
[read-only] - The resource name used when NetStream.play() was called.
-		NetStreamInfo
  SRTT : Number -
[read-only] - The smoothed round trip time (SRTT) for the NetStream session, in milliseconds.
-		NetStreamInfo
  uri : String -
[read-only] - The URI used when NetConnection.connect() was called.
-		NetStreamInfo
  videoBufferByteLength : Number -
[read-only] - Provides the NetStream video buffer size in bytes.
-		NetStreamInfo
  videoBufferLength : Number -
[read-only] - Provides NetStream video buffer size in seconds.
-		NetStreamInfo
  videoByteCount : Number -
[read-only] - Specifies the total number of video bytes that have arrived in the queue, regardless of how many have been played or flushed.
-		NetStreamInfo
  videoBytesPerSecond : Number -
[read-only] - Specifies the rate at which the NetStream video buffer is filled in bytes per second.
-		NetStreamInfo
  videoLossRate : Number -
[read-only] - Provides the NetStream video loss rate (ratio of lost messages to total messages).
-		NetStreamInfo
  xmpData : Object -
[read-only] - The most recent XMP data object associated with the media being played.
-		NetStreamInfo
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a text value listing the properties of the NetStreamInfo object.
-		NetStreamInfo
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
audioBufferByteLengthproperty
-
-audioBufferByteLength:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Provides the NetStream audio buffer size in bytes. - It specifies the buffer size for audio data in streaming media, both live and recorded. - This property is like Netstream.bytesLoaded, - which is used in progressive downloads. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get audioBufferByteLength():Number -
-
- - - - - -
audioBufferLengthproperty 
-
-audioBufferLength:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Provides NetStream audio buffer size in seconds. This property extends the NetStream.bufferLength property - and provides the buffer length in time specifically for audio data. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get audioBufferLength():Number -
-
- - - - - -
audioByteCountproperty 
-
-audioByteCount:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the total number of audio bytes that have arrived in the queue, regardless of how many have been played or flushed. - You can use this value to calculate the incoming audio data rate, using the metric of your choice, by creating a timer and calculating the difference in values - in successive timer calls. Alternatively, use audioBytesPerSecond. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get audioByteCount():Number -
-

-See also -

-
-audioBytesPerSecond -
-
- - - - - -
audioBytesPerSecondproperty 
-
-audioBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the rate at which the NetStream audio buffer is filled in bytes per second. The value is calculated as a smooth - average for the audio data received in the last second. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get audioBytesPerSecond():Number -
-
- - - - - -
audioLossRateproperty 
-
-audioLossRate:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies the audio loss for the NetStream session. This value returns a valid value only for RTMFP streams and would return 0 for RTMP streams. - Loss rate is defined as the ratio of lost messages to total messages. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get audioLossRate():Number -
-
- - - - - -
byteCountproperty 
-
-byteCount:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the total number of bytes that have arrived into the queue, regardless of how many have been played or flushed. - You can use this value to calculate the incoming data rate, using the metric of your choice, by creating a timer and calculating the difference in values - in successive timer calls. Alternatively, use currentBytesPerSecond. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get byteCount():Number -
-

-See also -

-
-currentBytesPerSecond -
-
- - - - - -
currentBytesPerSecondproperty 
-
-currentBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the rate at which the NetStream buffer is filled in bytes per second. The value is calculated as a smooth - average for the total data received in the last second. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get currentBytesPerSecond():Number -
-
- - - - - -
dataBufferByteLengthproperty 
-
-dataBufferByteLength:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Provides the NetStream data buffer size in bytes. - It specifies the buffer size for data messages in streaming media, both live and recorded. - This property is like Netstream.bytesLoaded, - which is used in progressive downloads. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get dataBufferByteLength():Number -
-
- - - - - -
dataBufferLengthproperty 
-
-dataBufferLength:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Provides NetStream data buffer size in seconds. This property extends the NetStream.bufferLength property - and provides the buffer length in time specifically for data messages. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get dataBufferLength():Number -
-
- - - - - -
dataByteCountproperty 
-
-dataByteCount:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the total number of bytes of data messages that have arrived in the queue, regardless of how many have been played or flushed. - You can use this value to calculate the incoming data-messages rate, using the metric of your choice, - by creating a timer and calculating the difference in values in successive timer calls. - Alternatively, use dataBytesPerSecond. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get dataByteCount():Number -
-

-See also -

-
-dataBytesPerSecond -
-
- - - - - -
dataBytesPerSecondproperty 
-
-dataBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the rate at which the NetStream data buffer is filled in bytes per second. The value is calculated as a smooth - average for the data messages received in the last second. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get dataBytesPerSecond():Number -
-
- - - - - -
droppedFramesproperty 
-
-droppedFrames:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the number of video frames dropped in the current NetStream playback session. -

In recorded streaming or progressive download, if the video is a high-quality or high-resolution, high-bitrate video, - the decoder can lag behind in decoding the required number of frames per second if it does not have adequate - system CPU resources. In live streaming, the buffer drops video frames if the latency is too high. This property specifies - the number of frames that were dropped and not presented normally.

-

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get droppedFrames():Number -
-
- - - - - -
isLiveproperty 
-
-isLive:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Whether the media being played is recorded or live. This property is relevant for RTMP streaming only. For - progressive download and HTTP Dynamic Streaming the property is always false. -

Note: Not supported in AIR 3.0 for iOS.

-

Note: This property is always false in Flash Player in the browser on Android and Blackberry Tablet OS or - in AIR on iOS.

- - Implementation -
-    public function get isLive():Boolean -
-
- - - - - -
maxBytesPerSecondproperty 
-
-maxBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the maximum rate at which the NetStream buffer is filled in bytes per second. This value provides information about the capacity of the - client network based on the last messages received by the NetStream object. Depending on the size of the buffer specified in - NetStream.bufferTime and the bandwidth available on the client, Flash Media Server fills the buffer in bursts. - This property provides the maximum rate at which the client buffer is filled. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get maxBytesPerSecond():Number -
-
- - - - - -
metaDataproperty 
-
-metaData:Object  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- The most recent metadata object associated with the media being played. - -

Note: Not supported in AIR 3.0 for iOS.

-

Note: This property is always null in Flash Player in the browser on Android and Blackberry Tablet OS or - in AIR on iOS.

- - Implementation -
-    public function get metaData():Object -
-
- - - - - -
playbackBytesPerSecondproperty 
-
-playbackBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the stream playback rate in bytes per second. The playback buffer can contain content of various playlists. - This property provides the playback rate that closely matches the bit rate of the currently playing stream. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get playbackBytesPerSecond():Number -
-
- - - - - -
resourceNameproperty 
-
-resourceName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- The resource name used when NetStream.play() was called. This property contains the full URL for progressive - download, the resource name for RTMP streaming and null for HTTP streaming. -

Note: Not supported in AIR 3.0 for iOS.

-

Note: This property is always null in Flash Player in the browser on Android and Blackberry Tablet OS or - in AIR on iOS.

- - Implementation -
-    public function get resourceName():String -
-

-See also -

-
flash.media.NetStream.play()
-
- - - - - -
SRTTproperty 
-
-SRTT:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The smoothed round trip time (SRTT) for the NetStream session, in milliseconds. - This property contains a valid value only for RTMFP streams. For RTMP streams, the value is 0. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get SRTT():Number -
-

-See also -

-
-flash.net.NetGroup -
-
- - - - - -
uriproperty 
-
-uri:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- The URI used when NetConnection.connect() was called. This is null for progressive download - or HTTP streaming. -

Note: Not supported in AIR 3.0 for iOS.

-

Note: This property is always null in Flash Player in the browser on Android and Blackberry Tablet OS or - in AIR on iOS.

- - Implementation -
-    public function get uri():String -
-

-See also -

-
flash.media.NetConnection.uri
-
- - - - - -
videoBufferByteLengthproperty 
-
-videoBufferByteLength:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Provides the NetStream video buffer size in bytes. - It specifies the buffer size for video data in streaming media, both live and recorded. - This property is like Netstream.bytesLoaded, - which is used in progressive downloads. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get videoBufferByteLength():Number -
-
- - - - - -
videoBufferLengthproperty 
-
-videoBufferLength:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Provides NetStream video buffer size in seconds. This property extends the NetStream.bufferLength property - and provides the buffer length in time specifically for video data. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get videoBufferLength():Number -
-
- - - - - -
videoByteCountproperty 
-
-videoByteCount:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the total number of video bytes that have arrived in the queue, regardless of how many have been played or flushed. - You can use this value to calculate the incoming video data rate, using the metric of your choice, - by creating a timer and calculating the difference in values in successive timer calls. - Alternatively, use videoBytesPerSecond, -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get videoByteCount():Number -
-

-See also -

-
-videoBytesPerSecond -
-
- - - - - -
videoBytesPerSecondproperty 
-
-videoBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the rate at which the NetStream video buffer is filled in bytes per second. The value is calculated as a smooth - average for the video data received in the last second. -

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get videoBytesPerSecond():Number -
-
- - - - - -
videoLossRateproperty 
-
-videoLossRate:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Provides the NetStream video loss rate (ratio of lost messages to total messages). -

When the message size is smaller than the maximum transmission unit (MTU), this value corresponds to - the network packet loss rate.

-

This property returns a valid value only for RTMFP streams. For RTMP streams, it returns a value of zero. - For more information, see the - Flash Media Server documentation.

-

Note: Not supported in AIR 3.0 for iOS.

- Implementation -
-    public function get videoLossRate():Number -
-
- - - - - -
xmpDataproperty 
-
-xmpData:Object  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- The most recent XMP data object associated with the media being played. -

Note: Not supported in AIR 3.0 for iOS.

-

Note: This property is always null in Flash Player in the browser on Android and Blackberry Tablet OS or - in AIR on iOS.

- - Implementation -
-    public function get xmpData():Object -
-
- -
Method detail
- - - - - -
toString()method
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns a text value listing the properties of the NetStreamInfo object. -

-Returns - - - - -
String — - A string containing the values of the properties of the NetStreamInfo object - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetStreamMulticastInfo.html b/html-docs/flash/net/NetStreamMulticastInfo.html deleted file mode 100644 index be25299..0000000 --- a/html-docs/flash/net/NetStreamMulticastInfo.html +++ /dev/null @@ -1,1069 +0,0 @@ - - - - - - - - -flash.net.NetStreamMulticastInfo (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class NetStreamMulticastInfo
InheritanceNetStreamMulticastInfo Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-The NetStreamMulticastInfo class specifies various Quality of Service (QoS) statistics -related to a NetStream object's underlying RTMFP Peer-to-Peer and IP Multicast stream transport. -A NetStreamMulticastInfo object is returned by the NetStream.multicastInfo property. -

Properties that return numbers represent totals computed from the beginning of the multicast stream. -These types of properties include the number of media bytes sent or the number of media fragment messages received. -Properties that are rates represent a snapshot of the current rate averaged over a few seconds. -These types of properties include the rate at which a local node is receiving data.

-

To see a list of values contained in the NetStreamMulticastInfo object, use the -NetStreamMulticastInfo.toString() method.

-

-

-See also -

-
-toString() -
-flash.net.NetStream.multicastInfo -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bytesPushedFromPeers : Number -
[read-only] - Specifies the number of media bytes that were proactively pushed from peers and received by the local node.
-		NetStreamMulticastInfo
  bytesPushedToPeers : Number -
[read-only] - Specifies the number of media bytes that the local node has proactively pushed to peers.
-		NetStreamMulticastInfo
  bytesReceivedFromIPMulticast : Number -
[read-only] - Specifies the number of media bytes that the local node has received from IP Multicast.
-		NetStreamMulticastInfo
  bytesReceivedFromServer : Number -
[read-only] - Specifies the number of media bytes that the local node has received from the server.
-		NetStreamMulticastInfo
  bytesRequestedByPeers : Number -
[read-only] - Specifies the number of media bytes that the local node has sent to peers in response to requests from those peers for specific fragments.
-		NetStreamMulticastInfo
  bytesRequestedFromPeers : Number -
[read-only] - Specifies the number of media bytes that the local node requested and received from peers.
-		NetStreamMulticastInfo
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fragmentsPushedFromPeers : Number -
[read-only] - Specifies the number of media fragment messages that were proactively pushed from peers and received by the local node.
-		NetStreamMulticastInfo
  fragmentsPushedToPeers : Number -
[read-only] - Specifies the number of media fragment messages that the local node has proactively pushed to peers.
-		NetStreamMulticastInfo
  fragmentsReceivedFromIPMulticast : Number -
[read-only] - Specifies the number of media fragment messages that the local node has received from IP Multicast.
-		NetStreamMulticastInfo
  fragmentsReceivedFromServer : Number -
[read-only] - Specifies the number of media fragment messages that the local node has received from the server.
-		NetStreamMulticastInfo
  fragmentsRequestedByPeers : Number -
[read-only] - Specifies the number of media fragment messages that the local node has sent to peers in response to requests from those peers for specific fragments.
-		NetStreamMulticastInfo
  fragmentsRequestedFromPeers : Number -
[read-only] - Specifies the number of media fragment messages that the local node requested and received from peers.
-		NetStreamMulticastInfo
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  receiveControlBytesPerSecond : Number -
[read-only] - Specifies the rate at which the local node is receiving control overhead messages from peers, in bytes per second.
-		NetStreamMulticastInfo
  receiveDataBytesPerSecond : Number -
[read-only] - Specifies the rate at which the local node is receiving media data from peers, from the server, and over IP multicast, in bytes per second.
-		NetStreamMulticastInfo
  receiveDataBytesPerSecondFromIPMulticast : Number -
[read-only] - Specifies the rate at which the local node is receiving data from IP Multicast, in bytes per second.
-		NetStreamMulticastInfo
  receiveDataBytesPerSecondFromServer : Number -
[read-only] - Specifies the rate at which the local node is receiving media data from the server, in bytes per second.
-		NetStreamMulticastInfo
  sendControlBytesPerSecond : Number -
[read-only] - Specifies the rate at which the local node is sending control overhead messages to peers and the server, in bytes per second.
-		NetStreamMulticastInfo
  sendControlBytesPerSecondToServer : Number -
[read-only] - Specifies the rate at which the local node is sending control overhead messages to the server, in bytes per second.
-		NetStreamMulticastInfo
  sendDataBytesPerSecond : Number -
[read-only] - Specifies the rate at which media data is being sent by the local node to peers, in bytes per second.
-		NetStreamMulticastInfo
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string listing the properties of the NetStreamMulticastInfo object.
-		NetStreamMulticastInfo
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
bytesPushedFromPeersproperty
-
-bytesPushedFromPeers:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media bytes that were proactively pushed from peers and received by the local node. -

Implementation -
-    public function get bytesPushedFromPeers():Number -
-

-See also -

-
-bytesRequestedFromPeers -
-fragmentsPushedFromPeers -
-fragmentsRequestedFromPeers -
-
- - - - - -
bytesPushedToPeersproperty 
-
-bytesPushedToPeers:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media bytes that the local node has proactively pushed to peers. -

Implementation -
-    public function get bytesPushedToPeers():Number -
-

-See also -

-
-bytesRequestedByPeers -
-fragmentsPushedToPeers -
-fragmentsRequestedByPeers -
-
- - - - - -
bytesReceivedFromIPMulticastproperty 
-
-bytesReceivedFromIPMulticast:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media bytes that the local node has received from IP Multicast. -

Implementation -
-    public function get bytesReceivedFromIPMulticast():Number -
-

-See also -

-
-bytesReceivedFromServer -
-fragmentsReceivedFromIPMulticast -
-fragmentsReceivedFromServer -
-receiveDataBytesPerSecondFromIPMulticast -
-
- - - - - -
bytesReceivedFromServerproperty 
-
-bytesReceivedFromServer:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media bytes that the local node has received from the server. -

Implementation -
-    public function get bytesReceivedFromServer():Number -
-

-See also -

-
-bytesReceivedFromIPMulticast -
-fragmentsReceivedFromIPMulticast -
-fragmentsReceivedFromServer -
-receiveDataBytesPerSecondFromServer -
-
- - - - - -
bytesRequestedByPeersproperty 
-
-bytesRequestedByPeers:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media bytes that the local node has sent to peers in response to requests from those peers for specific fragments. -

Implementation -
-    public function get bytesRequestedByPeers():Number -
-

-See also -

-
-bytesPushedToPeers -
-fragmentsPushedToPeers -
-fragmentsRequestedByPeers -
-
- - - - - -
bytesRequestedFromPeersproperty 
-
-bytesRequestedFromPeers:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media bytes that the local node requested and received from peers. -

Implementation -
-    public function get bytesRequestedFromPeers():Number -
-

-See also -

-
-bytesPushedFromPeers -
-fragmentsPushedFromPeers -
-fragmentsRequestedFromPeers -
-
- - - - - -
fragmentsPushedFromPeersproperty 
-
-fragmentsPushedFromPeers:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media fragment messages that were proactively pushed from peers and received by the local node. -

Implementation -
-    public function get fragmentsPushedFromPeers():Number -
-

-See also -

-
-bytesPushedFromPeers -
-bytesRequestedFromPeers -
-fragmentsRequestedFromPeers -
-
- - - - - -
fragmentsPushedToPeersproperty 
-
-fragmentsPushedToPeers:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media fragment messages that the local node has proactively pushed to peers. -

Implementation -
-    public function get fragmentsPushedToPeers():Number -
-

-See also -

-
-bytesPushedToPeers -
-bytesRequestedByPeers -
-fragmentsRequestedByPeers -
-
- - - - - -
fragmentsReceivedFromIPMulticastproperty 
-
-fragmentsReceivedFromIPMulticast:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media fragment messages that the local node has received from IP Multicast. -

Implementation -
-    public function get fragmentsReceivedFromIPMulticast():Number -
-

-See also -

-
-bytesReceivedFromIPMulticast -
-bytesReceivedFromServer -
-fragmentsReceivedFromServer -
-receiveDataBytesPerSecondFromIPMulticast -
-
- - - - - -
fragmentsReceivedFromServerproperty 
-
-fragmentsReceivedFromServer:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media fragment messages that the local node has received from the server. -

Implementation -
-    public function get fragmentsReceivedFromServer():Number -
-

-See also -

-
-bytesReceivedFromIPMulticast -
-bytesReceivedFromServer -
-fragmentsReceivedFromIPMulticast -
-receiveDataBytesPerSecondFromServer -
-
- - - - - -
fragmentsRequestedByPeersproperty 
-
-fragmentsRequestedByPeers:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media fragment messages that the local node has sent to peers in response to requests from those peers for specific fragments. -

Implementation -
-    public function get fragmentsRequestedByPeers():Number -
-

-See also -

-
-bytesPushedToPeers -
-bytesRequestedByPeers -
-fragmentsPushedToPeers -
-
- - - - - -
fragmentsRequestedFromPeersproperty 
-
-fragmentsRequestedFromPeers:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the number of media fragment messages that the local node requested and received from peers. -

Implementation -
-    public function get fragmentsRequestedFromPeers():Number -
-

-See also -

-
-bytesPushedFromPeers -
-bytesRequestedFromPeers -
-fragmentsPushedFromPeers -
-
- - - - - -
receiveControlBytesPerSecondproperty 
-
-receiveControlBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is receiving control overhead messages from peers, in bytes per second. -

Implementation -
-    public function get receiveControlBytesPerSecond():Number -
-

-See also -

-
-receiveDataBytesPerSecond -
-receiveDataBytesPerSecondFromServer -
-receiveDataBytesPerSecondFromIPMulticast -
-sendControlBytesPerSecond -
-
- - - - - -
receiveDataBytesPerSecondproperty 
-
-receiveDataBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is receiving media data from peers, from the server, and over IP multicast, in bytes per second. -

Implementation -
-    public function get receiveDataBytesPerSecond():Number -
-

-See also -

-
-receiveControlBytesPerSecond -
-receiveDataBytesPerSecondFromIPMulticast -
-receiveDataBytesPerSecondFromServer -
-sendDataBytesPerSecond -
-
- - - - - -
receiveDataBytesPerSecondFromIPMulticastproperty 
-
-receiveDataBytesPerSecondFromIPMulticast:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is receiving data from IP Multicast, in bytes per second. -

Implementation -
-    public function get receiveDataBytesPerSecondFromIPMulticast():Number -
-

-See also -

-
-receiveControlBytesPerSecond -
-receiveDataBytesPerSecond -
-receiveDataBytesPerSecondFromServer -
-sendDataBytesPerSecond -
-
- - - - - -
receiveDataBytesPerSecondFromServerproperty 
-
-receiveDataBytesPerSecondFromServer:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is receiving media data from the server, in bytes per second. -

Implementation -
-    public function get receiveDataBytesPerSecondFromServer():Number -
-

-See also -

-
-receiveControlBytesPerSecond -
-receiveDataBytesPerSecond -
-receiveDataBytesPerSecondFromIPMulticast -
-sendDataBytesPerSecond -
-
- - - - - -
sendControlBytesPerSecondproperty 
-
-sendControlBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is sending control overhead messages to peers and the server, in bytes per second. -

Implementation -
-    public function get sendControlBytesPerSecond():Number -
-

-See also -

-
-receiveControlBytesPerSecond -
-sendControlBytesPerSecondToServer -
-sendDataBytesPerSecond -
-
- - - - - -
sendControlBytesPerSecondToServerproperty 
-
-sendControlBytesPerSecondToServer:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which the local node is sending control overhead messages to the server, in bytes per second. -

Implementation -
-    public function get sendControlBytesPerSecondToServer():Number -
-

-See also -

-
-receiveDataBytesPerSecondFromServer -
-sendControlBytesPerSecond -
-sendDataBytesPerSecond -
-
- - - - - -
sendDataBytesPerSecondproperty 
-
-sendDataBytesPerSecond:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the rate at which media data is being sent by the local node to peers, in bytes per second. -

Implementation -
-    public function get sendDataBytesPerSecond():Number -
-

-See also -

-
-receiveDataBytesPerSecond -
-sendControlBytesPerSecond -
-sendControlBytesPerSecondToServer -
-
- -
Method detail
- - - - - -
toString()method
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Returns a string listing the properties of the NetStreamMulticastInfo object. -

-Returns - - - - -
String — - A string containing the values of the properties of the NetStreamMulticastInfo object - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetStreamPlayOptions.html b/html-docs/flash/net/NetStreamPlayOptions.html deleted file mode 100644 index f84fcef..0000000 --- a/html-docs/flash/net/NetStreamPlayOptions.html +++ /dev/null @@ -1,633 +0,0 @@ - - - - - - - - -flash.net.NetStreamPlayOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic dynamic class NetStreamPlayOptions
InheritanceNetStreamPlayOptions Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

-

- The NetStreamPlayOptions class specifies the various options that can be passed - to the NetStream.play2() method. You pass a NetStreamPlayOptions object - to play2(), and the properties of the class specify the various options. - The primary use case for this class is to implement transitions between streams dynamically, - either to switch to streams of different bit rates and sizes or to swap to different content - in a playlist. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  len : Number -
- The duration of playback, in seconds, for the stream specified in streamName.
-		NetStreamPlayOptions
  offset : Number -
- The absoulte stream time at which the server switches between streams of different bitrates for Flash Media Server dynamic streaming.
-		NetStreamPlayOptions
  oldStreamName : String -
- The name of the old stream or the stream to transition from.
-		NetStreamPlayOptions
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  start : Number -
- The start time, in seconds, for streamName.
-		NetStreamPlayOptions
  streamName : String -
- The name of the new stream to transition to or to play.
-		NetStreamPlayOptions
  transition : String -
- The mode in which streamName is played or transitioned to.
-		NetStreamPlayOptions
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-NetStreamPlayOptions()
-
- Creates a NetStreamPlayOptions object to specify the options that are passed to the NetStream.play2() method.
-		NetStreamPlayOptions
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
lenproperty
-
-public var len:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The duration of playback, in seconds, for the stream specified in streamName. - The default value is -1, which means that Flash Player plays a live stream until it is no longer available or plays a recorded stream until it ends. - If you pass 0 for len, Flash Player plays the single frame that is start seconds from the beginning of a recorded stream - (assuming that start is equal to or greater than 0). -

If you pass a positive number for len, Flash Player plays a live stream for len seconds after it becomes available, - or plays a recorded stream for len seconds. (If a stream ends before len seconds, playback ends when the stream ends.)

-

If you pass a negative number other than -1 for len, Flash Player interprets the value as if it were -1.

- -

-See also -

-
-NetStream.play() -
-NetStream.play2() -
-start -
-
- - - - - -
offsetproperty 
-
-public var offset:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The absoulte stream time at which the server switches between streams of different bitrates for Flash Media Server dynamic streaming. - The offset property is used when a NetStream.play2() call is made with the - NetStreamPlayTransitions.SWITCH transition mode. There are two switching modes: fast switch and standard switch. The default - value of offset is -1 which is fast switch mode. Write ActionScript logic to decide when to use - fast switch and when to use standard switch. -

Fast switch

-

In fast switch mode, Flash Media Server switches to the new stream without waiting to play the data in the buffer. - Any data buffered from the old stream past the offset is flushed. Fast switching is faster than standard switching - because the buffered data from the old stream doesn't have to play out.

-

The default value of offset is -1, which is fast switch mode. When offset is -1, the switch occurs at the - first available keyframe after netstream.time + 3, which is about 3 seconds later than the playback point. - You can also set the offset property to any value greater than netstream.time. - For example, to fast switch 5 seconds after the playback point, set the offset property to netstream.time + 5. - If the value of offset is less than netstream.time, a NetStream.Play.Failed status event is sent. -

-

Note: The offset property is absolute stream time, it is not an offset from the playback point. - For example, to switch 5 seconds from the playback point, set the offset property to netstream.time + 5, - not to 5. -

-

Standard switch

- -

- To use standard switch instead of fast switch, set offset to a value greater than netstream.time + netstream.bufferLength. -

-

- Use standard switch when the client has a high bitrate in the buffer and wants to switch to a lower bandwidth due to bandwidth dropping - (and not due to CPU issues or dropped frames). The client may want to play out the higher bitrate for as long as possible and - switch to the lower bitrate at the end of the buffer (as in standard switching). -

-

For more information, see "Fast switching between streams" - in the Adobe Flash Media Server Developer's Guide.

-

-See also -

-
-start -
-NetStream.play() -
-NetStream.play2() -
-NetStream.time -
-NetStreamPlayTransitions.SWITCH -
-
- - - - - -
oldStreamNameproperty 
-
-public var oldStreamName:String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The name of the old stream or the stream to transition from. - When NetStream.play2() is used to simply play a stream (not perform a transition), the value of this property - should be either null or undefined. Otherwise, specify the stream to transition from. - -

-See also -

-
-streamName -
-NetStream.play() -
-NetStream.play2() -
-
- - - - - -
startproperty 
-
-public var start:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The start time, in seconds, for streamName. Valid values are -2, -1, and 0. -

The default value for start is -2, which means that Flash Player first tries to play the live stream specified in streamName. - If a live stream of that name is not found, Flash Player plays the recorded stream specified in streamName. - If neither a live nor a recorded stream is found, Flash Player opens a live stream named streamName, even though no one is - publishing on it. When someone does begin publishing on that stream, Flash Player begins playing it.

-

If you pass -1 for start, Flash Player plays only the live stream specified in streamName. If no live stream is found, - Flash Player waits for it indefinitely if len is set to -1; if len is set to a different value, - Flash Player waits for len seconds before it begins playing the next item in the playlist.

-

If you pass 0 or a positive number for start, Flash Player plays only a recorded stream named streamName, - beginning start seconds from the beginning of the stream. If no recorded stream is found, Flash Player begins playing the next item - in the playlist immediately.

-

If you pass a negative number other than -1 or -2 for start, Flash Player interprets the value as if it were -2.

- -

-See also -

-
-NetStream.play() -
-NetStream.play2() -
-len -
-
- - - - - -
streamNameproperty 
-
-public var streamName:String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The name of the new stream to transition to or to play. When oldStreamName is null or undefined, calling - NetStream.play2() simply starts playback of streamName. If oldStreamName is specified, calling NetStream.play2() - transitions oldStreamName to streamName using the transition mode specified in the transition property. -

-See also -

-
-oldStreamName -
-NetStream.play() -
-NetStream.play2() -
-
- - - - - -
transitionproperty 
-
-public var transition:String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The mode in which streamName is played or transitioned to. Possible values are constants from the NetStreamPlayTransitions class. - Depending on whether Netstream.play2() is called to play or transition a stream, the transition mode results in different behaviors. - For more information on the transition modes, see the NetStreamPlayTransitions class. - -

-See also -

-
-NetStreamPlayTransitions -
-NetStream.play2() -
-
- -
Constructor detail
- - - - - -
NetStreamPlayOptions()constructor
-
-public function NetStreamPlayOptions() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a NetStreamPlayOptions object to specify the options that are passed to the NetStream.play2() method. - -

-See also -

-
-NetStream.play2() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetStreamPlayTransitions.html b/html-docs/flash/net/NetStreamPlayTransitions.html deleted file mode 100644 index 60b7eda..0000000 --- a/html-docs/flash/net/NetStreamPlayTransitions.html +++ /dev/null @@ -1,567 +0,0 @@ - - - - - - - - -flash.net.NetStreamPlayTransitions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class NetStreamPlayTransitions
InheritanceNetStreamPlayTransitions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The NetStreamPlayTransitions class specifies the valid strings that you can use with the - NetStreamPlayOptions.transition property. These strings control the - behavior that is used to transition to a new stream or to play a stream, depending on the - transition mode that is used. -

-

-See also -

-
-NetStreamPlayOptions -
-NetStream.play2() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  APPEND : String = "append"
[static] - - Adds the stream to a playlist and begins playback with the first stream.
-		NetStreamPlayTransitions
  APPEND_AND_WAIT : String = "appendAndWait"
[static] - - Builds a playlist without starting to play it from the first stream.
-		NetStreamPlayTransitions
  RESET : String = "reset"
[static] - Clears any previous play calls and plays the specified stream immediately.
-		NetStreamPlayTransitions
  RESUME : String = "resume"
[static] - - Requests data from the new connection starting from the point at which the previous connection ended.
-		NetStreamPlayTransitions
  STOP : String = "stop"
[static] - - Stops playing the streams in a playlist.
-		NetStreamPlayTransitions
  SWAP : String = "swap"
[static] - Replaces a content stream with a different content stream and maintains the rest of the playlist.
-		NetStreamPlayTransitions
  SWITCH : String = "switch"
[static] - Switches from playing one stream to another stream, typically with streams of the same content.
-		NetStreamPlayTransitions
-
- -
- -
Constant detail
- - - - - -
APPENDconstant
-
-public static const APPEND:String = "append" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- - Adds the stream to a playlist and begins playback with the first stream. This mode does the same thing as the NetStream.play() - method with the reset flag set to false. -

In this mode, Flash Media Server queues up the stream specified in NetStreamPlayOptions.streamName - at the end of the playlist and ignores the NetStreamPlayOptions.oldStreamName parameter.

-

-See also -

-
-APPEND_AND_WAIT -
-NetStream.play() -
-NetStream.play2() -
-NetStreamPlayOptions.oldStreamName -
-NetStreamPlayOptions.streamName -
-
- - - - - -
APPEND_AND_WAITconstant 
-
-public static const APPEND_AND_WAIT:String = "appendAndWait" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- - Builds a playlist without starting to play it from the first stream. - -

The APPEND_AND_WAIT transition mode is used with the NetStream.play2() method to build a playlist without - immediately starting to play it from the first stream. Use this mode to load each item in the playlist except the last one. - When you load the last stream in the playlist, set the transition mode to RESUME. - At this point, Flash Player begins to stream and play the playlist.

- -

You can use this mode to build a playlist from scratch, or to rebuild a playlist after a lost connection is recovered. - For a new playlist, when NetStream.play2() is called with RESUME, Flash Player begins streaming - and playing from the first stream, or from the start position specified. - To recover from a lost connection, when you call the NetStream.play2() method with - RESUME, Flash Player determines where the stream was interrupted and instructs the server to start streaming from that location. - The server in turn is able to determine which stream in the playlist corresponds to that location, and starts streaming from that location.

- -

This transition mode is in contrast to the APPEND mode, where playback starts immediately with the first stream.

-

-See also -

-
-APPEND -
-RESUME -
-NetStream.play2() -
-
- - - - - -
RESETconstant 
-
-public static const RESET:String = "reset" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Clears any previous play calls and plays the specified stream immediately. - This mode does the same thing as the NetStream.play() method with the reset flag set to true - (the default behavior for NetStream.play()). - -

In this mode, the currently playing stream is flushed and the stream specified in NetStreamPlayOptions.streamName starts to play. - The NetStreamPlayOptions.oldStreamName parameter is ignored.

-

-See also -

-
-NetStream.play() -
-NetStream.play2() -
-NetStreamPlayOptions.oldStreamName -
-NetStreamPlayOptions.streamName -
-
- - - - - -
RESUMEconstant 
-
-public static const RESUME:String = "resume" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- - Requests data from the new connection starting from the point at which the previous connection ended. - The RESUME mode aligns the stream across the two connections so no artifacts or jumps are observed - in the video playback. Use this mode when you reconnect a stream that was dropped due to server issues - or other connection problems. -

-See also -

-
-APPEND_AND_WAIT -
-NetStream.play2() -
-
- - - - - -
STOPconstant 
-
-public static const STOP:String = "stop" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- - Stops playing the streams in a playlist. This mode does the same thing as calling NetStream.play(false). - It stops and resets the playlist. -

-See also -

-
-NetStream.play() -
-NetStream.play2() -
-
- - - - - -
SWAPconstant 
-
-public static const SWAP:String = "swap" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Replaces a content stream with a different content stream and maintains the rest of the playlist. - -

This mode replaces the stream specified in NetStreamPlayOptions.oldStreamName - with the stream specified in NetStreamPlayOptions.streamName. The rest of the playlist is maintained. - In this mode, Flash Media Server does not make assumptions about the content of the streams and treats - them like different content.

-

If oldStreamName has not yet been sent, the server performs the switch - at the stream boundary and sends the bits for streamName from the beginning. - If the server has already started sending the bits for oldStreamName, it doesn't switch to streamName, - and a NetStream.Play.Failed event is sent.

-

Use this mode if the streams you want to switch are not related to each other and have different content or lengths. For example, - use this mode when you want to swap one commercial for another based on user tracking and past commercial-viewing statistics.

-

To switch from one stream to another with the same content, use the SWITCH mode instead.

- -

-See also -

-
-SWITCH -
-NetStreamPlayOptions.oldStreamName -
-NetStreamPlayOptions.streamName -
-
- - - - - -
SWITCHconstant 
-
-public static const SWITCH:String = "switch" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Switches from playing one stream to another stream, typically with streams of the same content. - Specify the streams to switch in NetStreamPlayOptions.oldStreamName and NetStreamPlayOptions.streamName. - -

Use this mode when you want to switch to a stream that has the same content but is encoded - at a different bit rate or resolution. For example, use this mode when the application queues up streams in a playlist - or is playing a single stream at a particular bit rate, then calculates that the bandwidth availability - or the CPU capability is either lower or higher than the stream requirements. The application can then - update the streams with their higher or lower bit rate versions.

- -

In this mode, Flash Media Server makes certain assumptions about the relationship between the - oldStreamName and streamName streams. - The server assumes that the streams contain the same content and have the same keyframe interval but have different - resolutions or bit rates.

- -

When a playlist has been queued up and oldStreamName is one of the streams in the playlist or is currently playing, - oldStreamName is replaced by streamName.

- -

If oldStreamName is null or undefined, or if it is not found in the playlist, - the server switches to streamName at the next logical point, to ensure a smooth switch.

-

To switch from one stream to another with different content, use the SWAP mode instead.

- -

-See also -

-
-SWAP -
-NetStreamPlayOptions.oldStreamName -
-NetStreamPlayOptions.streamName -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetworkInfo.html b/html-docs/flash/net/NetworkInfo.html deleted file mode 100644 index 779151c..0000000 --- a/html-docs/flash/net/NetworkInfo.html +++ /dev/null @@ -1,632 +0,0 @@ - - - - - - - - -flash.net.NetworkInfo (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class NetworkInfo
InheritanceNetworkInfo Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 2 - -
-

-

- - The NetworkInfo class provides information about the network - - interfaces on a computer. - - - -

AIR profile support: This feature is supported - - on all desktop operating systems and AIR for TV devices, but is not supported on all mobile devices. - - You can test for support at run time using the NetworkInfo.isSupported property. See - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - - -

The NetworkInfo object is a singleton. To get the single NetworkInfo object, - - use the static NetworkInfo.networkInfo property. Do not call the class - - constructor, new NetworkInfo().

- - - -

Most computers have one or more interfaces, such as - - a wired and a wireless network interface. Additional interfaces such as - - VPN, loopback, or virtual interfaces can also be present.

- - - -

A NetworkInfo object dispatches a change event when the available - - interfaces change. Call the findInterfaces() - - method to determine the most current network information.

- - - -

Note: The NativeApplication object also dispatches network change events.

- - -

-

-See also -

-
-NetworkInterface class -
-InterfaceAddress class -
-Retrieving a list of network interfaces in Adobe AIR 2 -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  disableNetworkChanges : Boolean -
- - Disables the network change detection within AIR.
-		NetworkInfo
  isSupported : Boolean -
[static][read-only] - - Indicates whether access to network interface information is supported on the client system.
-		NetworkInfo
  networkInfo : NetworkInfo -
[static][read-only] - - The singleton instance of the NetworkInfo object.
-		NetworkInfo
  permissionStatus : String -
[static][read-only] - - Determine whether the application has been granted the permission to access NetworkInfo.
-		NetworkInfo
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-findInterfaces():Vector.<NetworkInterface>
-
- - Returns the list of network interfaces associated with this - - machine.
-		NetworkInfo
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-networkChange -
-		 - - Dispatched when the network interfaces have changed.NetworkInfo
-
- -
- -
Property detail
- - - - - -
disableNetworkChangesproperty
-
-disableNetworkChanges:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Disables the network change detection within AIR. - -

This property has been provided to prevent issues caused by overly active - - network changes which could result in a lot of network change events, as well - - as potentially causing AIR to disconnect some active socket connections.

- - - Implementation -
-    public function get disableNetworkChanges():Boolean -
-    public function set disableNetworkChanges(value:Boolean):void -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Runtime version: AIR 2 - -
-

- - Indicates whether access to network interface information is supported on the client system. - - - -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
networkInfoproperty 
-
-networkInfo:NetworkInfo  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - The singleton instance of the NetworkInfo object. - - -

Implementation -
-    public static function get networkInfo():NetworkInfo -
-
-Throws -
- - - - -
SecurityError — If content running outside the AIR application security - - sandbox accesses this property. - - - -
-
- - - - - -
permissionStatusproperty 
-
-permissionStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 29.0 - -
-

- - Determine whether the application has been granted the permission to access NetworkInfo. - - -

Implementation -
-    public static function get permissionStatus():String -
-

-See also -

-
-flash.permissions.PermissionStatus -
-
- -
Method detail
- - - - - -
findInterfaces()method
-
-public function findInterfaces():Vector.<NetworkInterface> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Returns the list of network interfaces associated with this - - machine. - - - -

-Returns - - - - -
Vector.<NetworkInterface> — An array of NetworkInterface objects - - - -
-
-
Event detail
- - - - - -
networkChangeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.NETWORK_CHANGE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Dispatched when the network interfaces have changed. - - - -

- The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe NativeApplication object.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/NetworkInterface.html b/html-docs/flash/net/NetworkInterface.html deleted file mode 100644 index 5e3a58d..0000000 --- a/html-docs/flash/net/NetworkInterface.html +++ /dev/null @@ -1,506 +0,0 @@ - - - - - - - - -flash.net.NetworkInterface (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class NetworkInterface
InheritanceNetworkInterface Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The NetworkInterface class describes a network interface. - -

You can get a list of network interfaces by calling the - findInterfaces() method of a NetworkInfo object.

- -

-

-See also -

-
-NetworkInfo -
-InterfaceAddress -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  active : Boolean -
- Reports whether this interface is active.
-		NetworkInterface
  addresses : Vector.<InterfaceAddress>
- The list of the addresses bound to this network interface.
-		NetworkInterface
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  displayName : String -
- The display name of this network interface.
-		NetworkInterface
  hardwareAddress : String -
- The hardware address of this network interface.
-		NetworkInterface
  mtu : int -
- The maximum transmission unit (MTU) of this network interface.
-		NetworkInterface
  name : String -
- The name of this network interface.
-		NetworkInterface
  parent : NetworkInterface -
- The NetworkInterface object representing the parent interface (if this interface has a parent).
-		NetworkInterface
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  subInterfaces : Vector.<NetworkInterface>
- The list of subinterfaces attached to this network interface.
-		NetworkInterface
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
activeproperty
-
-active:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Reports whether this interface is active. - -

Implementation -
-    public function get active():Boolean -
-    public function set active(value:Boolean):void -
-
- - - - - -
addressesproperty 
-
-addresses:Vector.<InterfaceAddress>  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The list of the addresses bound to this network interface. - -

Implementation -
-    public function get addresses():Vector.<InterfaceAddress> -
-    public function set addresses(value:Vector.<InterfaceAddress>):void -
-
- - - - - -
displayNameproperty 
-
-displayName:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The display name of this network interface. - -

Implementation -
-    public function get displayName():String -
-    public function set displayName(value:String):void -
-
- - - - - -
hardwareAddressproperty 
-
-hardwareAddress:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The hardware address of this network interface. - -

The hardware address is typically the Media Access Control (MAC) address - of the network adapter or interface card.

- - Implementation -
-    public function get hardwareAddress():String -
-    public function set hardwareAddress(value:String):void -
-
- - - - - -
mtuproperty 
-
-mtu:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The maximum transmission unit (MTU) of this network interface. - -

If the mtu value is reported as -1, then the actual MTU is unknown.

- - Implementation -
-    public function get mtu():int -
-    public function set mtu(value:int):void -
-
- - - - - -
nameproperty 
-
-name:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name of this network interface. - -

Implementation -
-    public function get name():String -
-    public function set name(value:String):void -
-
- - - - - -
parentproperty 
-
-parent:NetworkInterface  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The NetworkInterface object representing the parent interface (if this interface has a parent). - -

This interface could have a parent if it is a subinterface. The parent - property is null if this interface has no parent.

- - Implementation -
-    public function get parent():NetworkInterface -
-    public function set parent(value:NetworkInterface):void -
-
- - - - - -
subInterfacesproperty 
-
-subInterfaces:Vector.<NetworkInterface>  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The list of subinterfaces attached to this network interface. - -

Subinterfaces are often virtual interfaces. The subInterfaces - property is null if this interface has no subinterfaces.

- Implementation -
-    public function get subInterfaces():Vector.<NetworkInterface> -
-    public function set subInterfaces(value:Vector.<NetworkInterface>):void -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/ObjectEncoding.html b/html-docs/flash/net/ObjectEncoding.html deleted file mode 100644 index fd89e55..0000000 --- a/html-docs/flash/net/ObjectEncoding.html +++ /dev/null @@ -1,455 +0,0 @@ - - - - - - - - -flash.net.ObjectEncoding (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class ObjectEncoding
InheritanceObjectEncoding Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - The ObjectEncoding class is used in defining serialization settings in classes - - that serialize objects (such as FileStream, NetStream, NetConnection, SharedObject, - - and ByteArray) to work with prior versions of ActionScript. - - -

Object encoding controls - - how objects are represented in Action Message Format (AMF). Flash Player uses - - AMF to enable efficient communication between an application and a remote server. - - AMF encodes remote procedure calls into a compact binary representation that can - - be transferred over HTTP/HTTPS or the RTMP/RTMPS protocol used by Flash Media Server. - - Objects and data values are serialized into this binary format, - - which is generally more compact than other representations, such as XML.

- - -

Adobe AIR and Flash Player 9 can serialize in two different formats: AMF3 and AMF0. - - AMF3, the default serialization developed for ActionScript 3.0, provides various advantages - - over AMF0, which is used for ActionScript 1.0 and 2.0. AMF3 sends data over - - the network more efficiently than AMF0. AMF3 supports - - sending int and uint - - objects as integers and supports data types that are available only in ActionScript 3.0, such as ByteArray, - - XML, and IExternalizable. It is available only in ActionScript 3.0 and with servers - - that use AMF3 encoding, such as Flex 2.

- - -

The ByteArray, FileStream, NetConnection, NetStream, SharedObject, - - Socket, and URLStream classes contain an objectEncoding property that is assigned - - a constant from the ObjectEncoding class. - - The behavior of the objectEncoding property differs depending - - on the object; each class's objectEncoding property - - description explains the behavior more thoroughly.

- - - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  dynamicPropertyWriter : IDynamicPropertyWriter -
[static] - - Allows greater control over the serialization of dynamic properties of dynamic objects.
-		ObjectEncoding
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  AMF0 : uint = 0
[static] - - Specifies that objects are serialized using the Action Message Format for ActionScript 1.0 and 2.0.
-		ObjectEncoding
  AMF3 : uint = 3
[static] - - Specifies that objects are serialized using the Action Message Format for ActionScript 3.0.
-		ObjectEncoding
  DEFAULT : uint = 3
[static] - - Specifies the default (latest) format for the current runtime (either Flash - - Player or AIR).
-		ObjectEncoding
-
- -
- -
Property detail
- - - - - -
dynamicPropertyWriterproperty
-
-dynamicPropertyWriter:IDynamicPropertyWriter  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Allows greater control over the serialization of dynamic properties of dynamic objects. - - When this property is set to null, - - the default value, dynamic properties are serialized using native code, which writes - - all dynamic properties excluding those whose value is a function. - -

This value is called only for properties of a dynamic object (objects declared - - within a dynamic class) or for objects declared using the - - new operator.

- - -

You can use this property to exclude properties of dynamic objects from - - serialization; to write values to properties of dynamic objects; or to - - create new properties for dynamic objects. To do so, set this property to an object that - - implements the IDynamicPropertyWriter interface. For more information, see the - - IDynamicPropertyWriter interface.

- - - Implementation -
-    public static function get dynamicPropertyWriter():IDynamicPropertyWriter -
-    public function set dynamicPropertyWriter(value:IDynamicPropertyWriter):void -
-

-See also -

-
-IDynamicPropertyWriter -
-
- -
Constant detail
- - - - - -
AMF0constant
-
-public static const AMF0:uint = 0 -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies that objects are serialized using the Action Message Format for ActionScript 1.0 and 2.0. - -

- - - - - -
AMF3constant 
-
-public static const AMF3:uint = 3 -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies that objects are serialized using the Action Message Format for ActionScript 3.0. - -

- - - - - -
DEFAULTconstant 
-
-public static const DEFAULT:uint = 3 -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies the default (latest) format for the current runtime (either Flash - - Player or AIR). Because object encoding control is only - - available in Flash Player 9 and later and Adobe AIR, the earliest format used will be - - the Action Message Format for ActionScript 3.0. - - -

For example, if an object has the objectEncoding property set to - - ObjectEncoding.DEFAULT, AMF3 encoding is used. - - If, in the future, a later version of Flash Player or Adobe AIR introduces a new AMF version - - and you republish your content, the application will use that new AMF version. - - You can use this constant only if you're not concerned at all about interoperability - - with previous versions.

- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/Responder.html b/html-docs/flash/net/Responder.html deleted file mode 100644 index c772e52..0000000 --- a/html-docs/flash/net/Responder.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - - - - -flash.net.Responder (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class Responder
InheritanceResponder Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The Responder class provides an object that is used - in NetConnection.call() to handle return - values from the server related to the success or failure of - specific operations. When working with NetConnection.call(), - you may encounter a network operation fault specific to the current operation - or a fault related to the current connection status. Operation errors target - the Responder object instead of the NetConnection object for easier error handling. - -

-

-See also -

-
-NetConnection.call() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Responder(result:Function, status:Function = null)
-
- Creates a new Responder object.
-		Responder
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
Responder()constructor
-
-public function Responder(result:Function, status:Function = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a new Responder object. You pass a Responder object to - NetConnection.call() to handle return values - from the server. You may pass null for either or - both parameters. - -

Parameters - - - - - - - - - - -
result:Function — The function invoked if the call to the server succeeds and returns a result. -
 
status:Function (default = null) — The function invoked if the server returns an error. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/SecureSocket.html b/html-docs/flash/net/SecureSocket.html deleted file mode 100644 index 4c7507e..0000000 --- a/html-docs/flash/net/SecureSocket.html +++ /dev/null @@ -1,1742 +0,0 @@ - - - - - - - - -flash.net.SecureSocket (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class SecureSocket
InheritanceSecureSocket Inheritance Socket Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 - -
-

-

- - The SecureSocket class enables code to make socket connections using the Secure Sockets Layer (SSL) - - and Transport Layer Security (TLS) protocols. - - - -

AIR profile support: This feature is supported - - on all desktop operating systems, but is not supported on all AIR for TV devices. - - On mobile devices, it is supported on Android and also supported on iOS starting from AIR 20. - - You can test for support at run time using the SecureSocket.isSupported property. See - - - - AIR Profile Support for more information regarding API support across multiple profiles.

- - - -

The SSL/TLS protocols provide a mechanism to handle both aspects of a secure socket connection:

- -
    - -
  1. Encryption of data communication over the socket
    2. - -
  2. Authentication of the host's identity via its certificate
    3. - -
- - -

The supported encryption protocols are SSL 3.1 and higher, and TLS 1.0 and higher. (TLS is the successor - - protocol for SSL. TLS 1.0 equals SSL 3.1, TLS 1.1 equals SSL 3.2, and so on.) SSL versions 3.0 or lower - - are not supported.

- - -

Validation of the server certificate is performed using the trust store and certificate validation - - support of the client platform. In addition you can add your own certificates programmatically with the - - addBinaryChainBuildingCertificate() method.This API isn't supported on iOS currently. Using this API - - on iOS would throw an exception - "ArgumentError: Error #2004"

- - - -

The SecureSocket class only connects to servers with valid, trusted certificates. You cannot choose - - to connect to a server in spite of a problem with its certificate. For example, there is no way to connect - - to a server with an expired certificate. The same is true for a certificate that doesn't chain to a trusted anchor certificate. - - The connection will not be made, even though the certificate would be valid otherwise.

- - -

The SecureSocket class is useful for performing encrypted communication to a trusted server. In other respects, - - a SecureSocket object behaves like a regular Socket object.

- - - -

To use the SecureSocket class, create a SecureSocket object (new SecureSocket()). - - Next, set up your listeners, and then run SecureSocket.connect(host, port). - - When you successfully connect to the server, the socket dispatches a connect event. A successful - - connection is one in which the server's security protocols are supported and its certificate is valid and trusted. - - If the certificate cannot be validated, the Socket dispatches an IOError event.

- - - -

Important: The Online Certificate Status Protocol (OCSP) is not supported by all operating systems. - - Users can also disable OCSP checking on individual computers. If OCSP is not supported or is disabled and - - a certificate does not contain the information necessary to check revocation using a Certificate Revocation - - List (CRL), then certificate revocation is not checked. The certificate is accepted if otherwise valid. - - This scenario could allow a server to use a revoked certificate.

- - - -

-

-View the examples. -

-

-See also -

-
-Socket class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedbytesAvailable : uint -
- - The number of bytes of data available for reading in the input buffer.
-		Socket
 InheritedbytesPending : uint -
- - Indicates the number of bytes remaining in the write buffer.
-		Socket
 Inheritedconnected : Boolean -
- - Indicates whether this Socket object is currently connected.
-		Socket
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedendian : String -
- - Indicates the byte order for the data.
-		Socket
  isSupported : Boolean -
[static][read-only] - - Indicates whether secure sockets are supported on the current system.
-		SecureSocket
 InheritedlocalAddress : String -
- - The IP address this socket is bound to on the local machine.
-		Socket
 InheritedlocalPort : int -
- - The port this socket is bound to on the local machine.
-		Socket
 InheritedobjectEncoding : uint -
- - Controls the version of AMF used when writing or reading an object.
-		Socket
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 InheritedremoteAddress : String -
- - The IP address of the remote machine to which this socket is connected.
-		Socket
 InheritedremotePort : int -
- - The port on the remote machine to which this socket is connected.
-		Socket
  serverCertificate : X509Certificate -
[read-only] - - Holds the X.509 certificate obtained from the server after a secure SSL/TLS connection is established.
-		SecureSocket
  serverCertificateStatus : String -
[read-only] - - Returns the status of the server's certificate.
-		SecureSocket
 InheritedtcpNoDelay : Boolean -
- - Whether to use the 'TCP_NODELAY' setting to avoid the use of Nagle's algorithm.
-		Socket
 Inheritedtimeout : uint -
- - Indicates the number of milliseconds to wait for a connection.
-		Socket
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SecureSocket()
-
- - Creates a new SecureSocket object.
-		SecureSocket
   -
-addBinaryChainBuildingCertificate(certificate:ByteArray, trusted:Boolean):void -
-
- - Adds an X.509 certificate to the local certificate chain that your system uses for validating the server certificate.
-		SecureSocket
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-close():void -
-
- - Closes the socket.
-		Socket
   -
-connect(host:String, port:int):void -
-
- - Connects the socket to the specified host and port using SSL or TLS.
-		SecureSocket
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-flush():void -
-
- - Flushes any accumulated data in the socket's output buffer.
-		Socket
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-readBoolean():Boolean -
-
- - Reads a Boolean value from the socket.
-		Socket
 Inherited -
-readByte():int -
-
- - Reads a signed byte from the socket.
-		Socket
 Inherited -
-readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- - Reads the number of data bytes specified by the length - - parameter from the socket.
-		Socket
 Inherited -
-readDouble():Number -
-
- - Reads an IEEE 754 double-precision floating-point number from the socket.
-		Socket
 Inherited -
-readFloat():Number -
-
- - Reads an IEEE 754 single-precision floating-point number from the socket.
-		Socket
 Inherited -
-readInt():int -
-
- - Reads a signed 32-bit integer from the socket.
-		Socket
 Inherited -
-readMultiByte(length:uint, charSet:String):String -
-
- - Reads a multibyte string from the byte stream, using the specified character set.
-		Socket
 Inherited -
-readObject():* -
-
- - Reads an object from the socket, encoded in AMF serialized format.
-		Socket
 Inherited -
-readShort():int -
-
- - Reads a signed 16-bit integer from the socket.
-		Socket
 Inherited -
-readUnsignedByte():uint -
-
- - Reads an unsigned byte from the socket.
-		Socket
 Inherited -
-readUnsignedInt():uint -
-
- - Reads an unsigned 32-bit integer from the socket.
-		Socket
 Inherited -
-readUnsignedShort():uint -
-
- - Reads an unsigned 16-bit integer from the socket.
-		Socket
 Inherited -
-readUTF():String -
-
- - Reads a UTF-8 string from the socket.
-		Socket
 Inherited -
-readUTFBytes(length:uint):String -
-
- - Reads the number of UTF-8 data bytes specified by the length - - parameter from the socket, and returns a string.
-		Socket
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
 Inherited -
-writeBoolean(value:Boolean):void -
-
- - Writes a Boolean value to the socket.
-		Socket
 Inherited -
-writeByte(value:int):void -
-
- - Writes a byte to the socket.
-		Socket
 Inherited -
-writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- - Writes a sequence of bytes from the specified byte array.
-		Socket
 Inherited -
-writeDouble(value:Number):void -
-
- - Writes an IEEE 754 double-precision floating-point number to the socket.
-		Socket
 Inherited -
-writeFloat(value:Number):void -
-
- - Writes an IEEE 754 single-precision floating-point number to the socket.
-		Socket
 Inherited -
-writeInt(value:int):void -
-
- - Writes a 32-bit signed integer to the socket.
-		Socket
 Inherited -
-writeMultiByte(value:String, charSet:String):void -
-
- - Writes a multibyte string from the byte stream, using the specified character set.
-		Socket
 Inherited -
-writeObject(object:*):void -
-
- - Write an object to the socket in AMF serialized format.
-		Socket
 Inherited -
-writeShort(value:int):void -
-
- - Writes a 16-bit integer to the socket.
-		Socket
 Inherited -
-writeUnsignedInt(value:uint):void -
-
- - Writes a 32-bit unsigned integer to the socket.
-		Socket
 Inherited -
-writeUTF(value:String):void -
-
- - Writes the following data to the socket: a 16-bit unsigned integer, which - - indicates the length of the specified UTF-8 string in bytes, followed by - - the string itself.
-		Socket
 Inherited -
-writeUTFBytes(value:String):void -
-
- - Writes a UTF-8 string to the socket.
-		Socket
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-certificateError -
-		 - - Dispatched if a call to SecureSocket.connect() - - attempts to connect to a server with an invalid certificate - - (for example, self-signed or untrusted, or with an invalid date).SecureSocket
   -
-close -
-		 - - Dispatched when the server closes the socket connection.SecureSocket
 Inherited -
-close -
-		 - - Dispatched when the server closes the socket connection.Socket
   -
-connect -
-		 - - Dispatched when a network connection has been established.SecureSocket
 Inherited -
-connect -
-		 - - Dispatched when a network connection has been established.Socket
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-ioError -
-		 - - Dispatched when an input or output error occurs that causes a send or receive operation to fail.SecureSocket
 Inherited -
-ioError -
-		 - - Dispatched when an input/output error occurs that causes a send or load operation to fail.Socket
 Inherited -
-outputProgress -
-		 - - Dispatched when a socket moves data from its write buffer to the networking transport layer - - Socket
   -
-securityError -
-		 - - Dispatched when a call to SecureSocket.connect() fails because of a security restriction.SecureSocket
 Inherited -
-securityError -
-		 - - Dispatched if a call to Socket.connect() attempts to connect to a server - - prohibited by the caller's security sandbox or to a port lower than 1024 and no socket policy file - - exists to permit such a connection.Socket
   -
-socketData -
-		 - - Dispatched when a socket has received data.SecureSocket
 Inherited -
-socketData -
-		 - - Dispatched when a socket has received data.Socket
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Indicates whether secure sockets are supported on the current system. - - - -

Secure sockets are not supported on all platforms. Check this property - - before attempting to create a SecureSocket instance.

- - - - Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
serverCertificateproperty 
-
-serverCertificate:X509Certificate  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Holds the X.509 certificate obtained from the server after a secure SSL/TLS connection is established. - - If a secure connection is not established, this property is set to null. Currently it is not - - supported on iOS, and hence it is set to null in case of iOS. - -

For more information on X.509 certificates, see RFC2459.

- - - - Implementation -
-    public function get serverCertificate():X509Certificate -
-
- - - - - -
serverCertificateStatusproperty 
-
-serverCertificateStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Returns the status of the server's certificate. - - - -

The status is CertificateStatus.UNKNOWN until the - - socket attempts to connect to a server. After validation, the status is one - - of the strings enumerated by the CertificateStatus class. The connection only - - succeeds when the certificate is valid and trusted. Thus, after a - - connect event, the value of serverCertificateStatus - - is always trusted.

- - - -

Note: Once the certificate has been validated or rejected, the status - - value is not updated until the next call to the connect() method. - - Calling close() does not reset the status value to "unknown".

- - - - Implementation -
-    public function get serverCertificateStatus():String -
-

-See also -

-
-CertificateStatus class -
-
- -
Constructor detail
- - - - - -
SecureSocket()constructor
-
-public function SecureSocket() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Creates a new SecureSocket object. - - - -

Check SecureSocket.isSupported before attempting to create a SecureSocket - - instance. If SSL 3.0 or TLS 1.0 sockets are not supported, the runtime will throw an IllegalOperationError.

- - -
-Throws - - - - - - - - - - -
Error — When SSL Version 3.0 (and higher) or TLS Version 1.0 (and higher) is not supported. - -
 
SecurityError — Local untrusted SWF files cannot communicate with the Internet. You can work around this problem by reclassifying this SWF file as local-with-networking or trusted. - - - -
-
- -
Method detail
- - - - - -
addBinaryChainBuildingCertificate()method
-
-public function addBinaryChainBuildingCertificate(certificate:ByteArray, trusted:Boolean):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Adds an X.509 certificate to the local certificate chain that your system uses for validating the server certificate. - - The certificate is temporary, and lasts for the duration of the session. - - -

Server certificate validation relies on your system's trust store for certificate chain building and validation. - - Use this method to programmatically add additional certification chains and trusted anchors.

- - -

- - On Mac OS, the System keychain is the default keychain used during the SSL/TLS handshake process. - - Any intermediate certificates in that keychain are included when building the certification chain. - -

- - -

- - The certificate you add with this API must be a DER-encoded X.509 certificate. - - If the trusted parameter is true, the certificate you add with - - this API is considered a trusted anchor. - -

- - -

For more information on X.509 certificates, see RFC2459.

- - - Parameters - - - - - - - - - - -
certificate:ByteArray — A ByteArray object containing a DER-encoded X.509 digital certificate. - -
 
trusted:Boolean — Set to true to designate this certificate as a trust anchor. - - -
-
-Throws - - - - -
ArgumentError — When the certificate cannot be added. - - - -
-
- - - - - -
connect()method 
-
-public override function connect(host:String, port:int):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 - -
-

- - Connects the socket to the specified host and port using SSL or TLS. - - - -

When you call the SecureSocket.connect() method, the socket attempts SSL/TLS - - handshaking with the server. - - If the handshake succeeds, the socket attempts to validate the server certificate. If the - - certificate is valid and trusted, then the secure socket connection is established, and - - the socket dispatches a connect event. If the handshake fails or the certificate cannot - - be validated, the socket dispatches an IOError event. You can check the certificate - - validation result by reading the serverCertificateStatus property after the - - IOError event is dispatched. (When a connect event is dispatched, the certificate - - status is always trusted.)

- - - -

If the socket was already connected, the existing connection is closed first.

- - - Parameters - - - - - - - - - - -
host:String — The name or IP address of the host to connect to. - - - -
 
port:int — The port number to connect to. - - -
-
-Events - - - - - - - - - - - - - - - - - - - - - - -
connect:Event — Dispatched when a network connection has been - - established.
 
ioError:IOErrorEvent — Dispatched if a host is specified and an - - input/output error occurs that causes the connection to fail. - - This includes SSL/TLS handshake errors and failure to - - successfully validate the host's server certificate.
 
securityError:SecurityErrorEvent — Dispatched if a call to - - Socket.connect() attempts to connect - - either to a server that doesn't serve a socket policy file, - - or to a server whose policy file doesn't grant the calling host access to the specified port. - - For more information on policy files, see "Website controls (policy files)" in - - the ActionScript 3.0 Developer's Guide and the Flash Player Developer Center Topic: - - Security.
 
certificateError:SecurityErrorEvent — Dispatched if a call to Socket.connect() - - is made to a server with an invalid certificate (for example, - - self-signed or otherwise untrusted, or out of date).
-
-Throws - - - - - - - - - - -
Error — When you don't specify a host and the connection fails. - - - -
 
SecurityError — When you specify a socket port less than - - zero or higher than 65535. - - -
-
-
Event detail
- - - - - -
certificateErrorevent 
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.CERTIFICATE_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Dispatched if a call to SecureSocket.connect() - - attempts to connect to a server with an invalid certificate - - (for example, self-signed or untrusted, or with an invalid date). - - If a listener is added, any operating system standard behaviour will - - be ignored, instead the default action will be to close down the - - connection. To allow the default connection, you can call the - - preventDefault() function on the error object. - - -

- - The SecurityErrorEvent.CERTIFICATE_ERROR constant is used when the runtime detects a problem with a server's security certificate. This event - - is then dispatched, giving the application the chance to handle this and determine whether to allow the connection or to block it (which is the default - - behaviour). To allow it, call preventDefault() on the error object. Note that not handling this error type will result in the default operating system - - behaviour - typically, a message will be displayed to the end user to allow them to choose the action. - - -

This event has the following properties:

- - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelabletrue; default behavior is to close the connection, use preventDefault() to allow it.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- - -
- - - - - -
closeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLOSE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Dispatched when the server closes the socket connection. - - - -

The close event is dispatched only when the server - - closes the connection; it is not dispatched when you call the Socket.close() - - method.

- - - -

- The Event.CLOSE constant defines the value of the type property of a close event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection has been closed.
- -
- - - - - -
connectevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CONNECT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Dispatched when a network connection has been established. - - - -

- The Event.CONNECT constant defines the value of the type property of a connect event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Socket or XMLSocket object that has established a network connection.
- -
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Dispatched when an input or output error occurs that causes a send or receive operation to fail. - - - -

When a server certificate cannot be validated, the error event dispatched is an IOError. In this case, - - you can check the serverCertificateStatus property to determine the cause of the problem.

- - - -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Dispatched when a call to SecureSocket.connect() fails because of a security restriction. - - - -

A security error event is dispatched when code running in Flash Player or in AIR outside the application - - security sandbox attempts to connect to a server in a different domain or to a port lower than 1024 and - - the server does not provide a policy file that allows the connection. Note that code running within the - - AIR application sandbox can connect to a server at any domain and on ports below 1024 without a policy file.

- - - -

- - The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - - - -

This event has the following properties:

- - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- - - -

-See also -

-
-SecureSocket.connect() -
-
- - - - - -
socketDataevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.SOCKET_DATA -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 - -
-

- - Dispatched when a socket has received data. - - - - Events of type socketData do not use the ProgressEvent.bytesTotal - - property. - - - -

- Defines the value of the type property of a socketData event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event.
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotal0; this property is not used by socketData event objects.
targetThe socket reporting progress.
- -
- -
Examples
-
examples\SecureSocketExample
-
The following example illustrates how to create and connect a - SecureSocket object. -
-
package
-{
-    import flash.display.Sprite;
-	import flash.errors.IOError;
-	import flash.events.Event;
-	import flash.events.IOErrorEvent;
-	import flash.net.SecureSocket;
-	
-	public class SecureSocketExample extends Sprite
-	{
-		private var secureSocket:SecureSocket = new SecureSocket();
-		
-		public function SecureSocketExample()
-		{
-			secureSocket.addEventListener( Event.CONNECT, onConnect )
-			secureSocket.addEventListener( IOErrorEvent.IO_ERROR, onError );
-			
-			try
-			{
-				secureSocket.connect( "208.77.188.166", 443 );
-			}
-			catch ( error:Error )
-			{
-				trace ( error.toString() );
-			}
-		}
-		
-		private function onConnect( event:Event ):void
-		{
-			trace("Connected.");
-		}
-		
-		private function onError( error:IOErrorEvent ):void
-		{
-			trace( error.text + ", " + secureSocket.serverCertificateStatus );
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Sat Jan 11 2025, 8:30 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/net/ServerSocket.html b/html-docs/flash/net/ServerSocket.html deleted file mode 100644 index 06e39cb..0000000 --- a/html-docs/flash/net/ServerSocket.html +++ /dev/null @@ -1,1017 +0,0 @@ - - - - - - - - -flash.net.ServerSocket (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class ServerSocket
InheritanceServerSocket Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The ServerSocket class allows code to act as a server for Transport Control Protocol (TCP) - connections. - -

AIR profile support: This feature is supported on all desktop - operating systems, on iOS (starting with AIR 3.8), and on Android (starting with AIR 3.8). - This feature is not supported on AIR for TV devices. You can test - for support at run time using the ServerSocket.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

A TCP server listens for incoming connections from remote clients. When a client attempts to - connect, the ServerSocket dispatches a connect event. The ServerSocketConnectEvent object - dispatched for the event provides a Socket object representing the TCP connection between - the server and the client. Use this Socket object for subsequent communication - with the connected client. You can get the client address and port from the Socket object, if needed.

- -

Note: Your application is responsible for maintaining a reference to - the client Socket object. If you don't, the object is eligible for garbage collection and may be - destroyed by the runtime without warning.

- -

To put a ServerSocket object into the listening state, call the listen() method. - In the listening state, the server socket object dispatches connect events - whenever a client using the TCP protocol attempts to connect to the bound address and port. The ServerSocket object - continues to listen for additional connections until you call the close() method.

- -

TCP connections are persistent — they exist until one side of the connection closes it (or a serious - network failure occurs). Any data sent over the connection is broken into transmittable packets and reassembled - on the other end. All packets are guaranteed to arrive (within reason) — any lost packets are retransmitted. - In general, the TCP protocol manages the available network bandwidth better than the UDP protocol. - Most AIR applications that require socket communications should use the ServerSocket and Socket - classes rather than the DatagramSocket class.

- -

The ServerSocket class can only be used in Adobe AIR - applications and only in the application security sandbox.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

-

-View the examples. -

-

-See also -

-
-ServerSocketConnectEvent class -
-Socket class -
-XMLSocket class -
-DatagramSocket class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bound : Boolean -
[read-only] - Indicates whether the socket is bound to a local address and port.
-		ServerSocket
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - Indicates whether or not ServerSocket features are supported in the run-time environment.
-		ServerSocket
  listening : Boolean -
[read-only] - Indicates whether the server socket is listening for incoming connections.
-		ServerSocket
  localAddress : String -
[read-only] - The IP address on which the socket is listening.
-		ServerSocket
  localPort : int -
[read-only] - The port on which the socket is listening.
-		ServerSocket
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ServerSocket()
-
- Creates a ServerSocket object.
-		ServerSocket
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-bind(localPort:int = 0, localAddress:String = "0.0.0.0"):void -
-
- Binds this socket to the specified local address and port.
-		ServerSocket
   -
-close():void -
-
- Closes the socket and stops listening for connections.
-		ServerSocket
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-listen(backlog:int = 0):void -
-
- Initiates listening for TCP connections on the bound IP address and port.
-		ServerSocket
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-close -
-		 - Dispatched when the operating system closes this socket.ServerSocket
   -
-connect -
-		 - Dispatched when a remote socket seeks to connect to this server socket.ServerSocket
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
boundproperty
-
-bound:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the socket is bound to a local address and port. - -

Implementation -
-    public function get bound():Boolean -
-

-See also -

-
-bind() -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether or not ServerSocket features are supported in the run-time environment. - - -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
listeningproperty 
-
-listening:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the server socket is listening for incoming connections. - -

Implementation -
-    public function get listening():Boolean -
-

-See also -

-
-listen() -
-
- - - - - -
localAddressproperty 
-
-localAddress:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The IP address on which the socket is listening. - -

Implementation -
-    public function get localAddress():String -
-

-See also -

-
-bind() -
-
- - - - - -
localPortproperty 
-
-localPort:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The port on which the socket is listening. - -

Implementation -
-    public function get localPort():int -
-

-See also -

-
-bind() -
-
- -
Constructor detail
- - - - - -
ServerSocket()constructor
-
-public function ServerSocket() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a ServerSocket object. - -


-Throws - - - - -
SecurityError — This error occurs ff the calling content is running outside - the AIR application security sandbox. - -
-
- -
Method detail
- - - - - -
bind()method
-
-public function bind(localPort:int = 0, localAddress:String = "0.0.0.0"):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Binds this socket to the specified local address and port. - -

Parameters - - - - - - - - - - -
localPort:int (default = 0) — The number of the port to bind to on the local computer. If localPort, - is set to 0 (the default), the next available system port is bound. Permission to connect to a port - number below 1024 is subject to the system security policy. On Mac and Linux systems, for example, - the application must be running with root privileges to connect to ports below 1024. - -
 
localAddress:String (default = "0.0.0.0") — The IP address on the local machine to bind to. This address can be an - IPv4 or IPv6 address. If localAddress is set to 0.0.0.0 (the default), - the socket listens on all available IPv4 addresses. - To listen on all available IPv6 addresses, you must specify "::" as the localAddress - argument. To use an IPv6 address, the computer and network must both be - configured to support IPv6. Furthermore, a socket bound to an IPv4 address - cannot connect to a socket with an IPv6 address. Likewise, a socket bound to an IPv6 - address cannot connect to a socket with an IPv4 address. The type of address must match. - -
-
-Throws - - - - - - - - - - - - - - - - -
RangeError — This error occurs when localPort is less than 0 or greater than 65535. -
 
ArgumentError — This error occurs when localAddress is not a syntactically well-formed IP address. - -
 
Error — when the socket cannot be bound, such as when: -
    -
  • the underlying network socket (IP and port) is already in bound by another object or process.
    • -
  • the application is running under a user account that does not - have the privileges necessary to bind to the port. Privilege issues typically - occur when attempting to bind to well known ports (localPort < 1024)
    • -
  • this ServerSocket object is already bound. (Call close() before binding to a different - socket.)
    • -
  • when localAddress is not a valid local address.
    • -
- -
-
- - - - - -
close()method 
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Closes the socket and stops listening for connections. - -

Closed sockets cannot be reopened. Create a new ServerSocket instance instead.

- -
-Throws - - - - -
Error — This error occurs if the socket could not be closed, or the socket was not open. - -
-
- - - - - -
listen()method 
-
-public function listen(backlog:int = 0):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Initiates listening for TCP connections on the bound IP address and port. -

The listen() method returns immediately. Once you call listen(), - the ServerSocket object dispatches a connect - event whenever a connection attempt is made. The socket property of the - ServerSocketConnectEvent event object references - a Socket object representing the server-client connection.

- -

The backlog parameter specifies how many pending connections are queued while the - connect events are processed by your application. If the queue is full, additional connections - are denied without a connect event being dispatched. If the default value of zero is - specified, then the system-maximum queue length is used. This length varies by platform and can be - configured per computer. If the specified value exceeds the system-maximum length, then the - system-maximum length is used instead. No means for discovering the actual backlog value is provided. - (The system-maximum value is determined by the SOMAXCONN setting of the TCP network subsystem on the - host computer.)

- - Parameters - - - - -
backlog:int (default = 0) — The maximum length of the queue of pending connections. If - backlog is 0, the queue length is set to the maximum system value. - -
-
-Throws - - - - - - - - - - -
Error — This error occurs if the socket is not open or bound. This error also - occurs if the call to listen() fails for any other reason. -
 
RangeError — This error occurs if the backlog parameter is less than zero. - -
-
-
Event detail
- - - - - -
closeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLOSE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when the operating system closes this socket. - -

The close event is not dispatched when the ServerSocket close() - method is called. If other objects in your application rely on the close event, - you can dispatch the event manually before calling the close() method.

- -

- The Event.CLOSE constant defines the value of the type property of a close event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection has been closed.
- -
- - - - - -
connectevent  
-
-Event object type: flash.events.ServerSocketConnectEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when a remote socket seeks to connect to this server socket. - -

- -
Examples
-
examples\ServerSocketExample
-
The following example creates a socket server. To use the server, bind the - socket to a local port and then connect to that port from another application. The server - only understands UTF-8 strings. -
-
-package
-{
-    import flash.display.Sprite;
-	import flash.events.Event;
-	import flash.events.MouseEvent;
-	import flash.events.ProgressEvent;
-	import flash.events.ServerSocketConnectEvent;
-	import flash.net.ServerSocket;
-	import flash.net.Socket;
-	import flash.text.TextField;
-	import flash.text.TextFieldType;
-	import flash.utils.ByteArray;
-		
-	public class ServerSocketExample extends Sprite
-	{
-		private var serverSocket:ServerSocket = new ServerSocket();
-		private var clientSocket:Socket;
-
-		private var localIP:TextField;
-		private var localPort:TextField;
-		private var logField:TextField;
-		private var message:TextField;
-
-		public function ServerSocketExample()
-		{
-			setupUI();
-		}
-		
-		private function onConnect( event:ServerSocketConnectEvent ):void
-		{
-			clientSocket = event.socket;
-			clientSocket.addEventListener( ProgressEvent.SOCKET_DATA, onClientSocketData );
-			log( "Connection from " + clientSocket.remoteAddress + ":" + clientSocket.remotePort );
-		}
-		
-		private function onClientSocketData( event:ProgressEvent ):void
-		{
-			var buffer:ByteArray = new ByteArray();
-			clientSocket.readBytes( buffer, 0, clientSocket.bytesAvailable );
-			log( "Received: " + buffer.toString() );
-		}
-
-		private function bind( event:Event ):void
-		{
-			if( serverSocket.bound ) 
-			{
-				serverSocket.close();
-				serverSocket = new ServerSocket();
-				
-			}
-			serverSocket.bind( parseInt( localPort.text ), localIP.text );
-			serverSocket.addEventListener( ServerSocketConnectEvent.CONNECT, onConnect );
-			serverSocket.listen();
-			log( "Bound to: " + serverSocket.localAddress + ":" + serverSocket.localPort );
-		}
-		
-		private function send( event:Event ):void
-		{
-			try
-			{
-				if( clientSocket != null && clientSocket.connected )
-				{
-					clientSocket.writeUTFBytes( message.text );
-					clientSocket.flush(); 
-					log( "Sent message to " + clientSocket.remoteAddress + ":" + clientSocket.remotePort );
-				}
-				else log("No socket connection.");
-			}
-			catch ( error:Error )
-			{
-				log( error.message );
-			}
-		}
-
-		private function log( text:String ):void
-		{
-			logField.appendText( text + "\n" );
-			logField.scrollV = logField.maxScrollV;
-			trace( text );
-		}
-
-		private function setupUI():void
-		{
-			localIP = createTextField( 10, 10, "Local IP", "0.0.0.0");
-			localPort = createTextField( 10, 35, "Local port", "0" );
-			createTextButton( 170, 60, "Bind", bind );
-			message = createTextField( 10, 85, "Message", "Lucy can't drink milk." );
-			createTextButton( 170, 110, "Send", send );
-			logField = createTextField( 10, 135, "Log", "", false, 200 )
-			
-			this.stage.nativeWindow.activate();
-		}
-		
-		private function createTextField( x:int, y:int, label:String, defaultValue:String = '', editable:Boolean = true, height:int = 20 ):TextField
-		{
-			var labelField:TextField = new TextField();
-			labelField.text = label;
-			labelField.type = TextFieldType.DYNAMIC;
-			labelField.width = 100;
-			labelField.x = x;
-			labelField.y = y;
-			
-			var input:TextField = new TextField();
-			input.text = defaultValue;
-			input.type = TextFieldType.INPUT;
-			input.border = editable;
-			input.selectable = editable;
-			input.width = 280;
-			input.height = height;
-			input.x = x + labelField.width;
-			input.y = y;
-			
-			this.addChild( labelField );
-			this.addChild( input );
-			
-			return input;
-		}
-		
-		private function createTextButton( x:int, y:int, label:String, clickHandler:Function ):TextField
-		{
-			var button:TextField = new TextField();
-			button.htmlText = "<u><b>" + label + "</b></u>";
-			button.type = TextFieldType.DYNAMIC;
-			button.selectable = false;
-			button.width = 180;
-			button.x = x;
-			button.y = y;
-			button.addEventListener( MouseEvent.CLICK, clickHandler );
-			
-			this.addChild( button );
-			return button;
-		}		
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/SharedObject.html b/html-docs/flash/net/SharedObject.html deleted file mode 100644 index 44c5339..0000000 --- a/html-docs/flash/net/SharedObject.html +++ /dev/null @@ -1,2044 +0,0 @@ - - - - - - - - -flash.net.SharedObject (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class SharedObject
InheritanceSharedObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The SharedObject class is used to read and store limited amounts of data on a user's computer - or on a server. - Shared objects offer real-time data sharing between multiple client SWF files and objects - that are persistent on the local computer or remote server. Local shared objects are similar - to browser cookies and remote shared objects are similar to real-time data transfer devices. - To use remote shared objects, you need Adobe Flash Media Server. - -

Use shared objects to do the following:

- -
    - -
  • Maintain local persistence. - This is the simplest way to use a shared object, and does not require Flash Media Server. - For example, you can call SharedObject.getLocal() to create a shared object in an - application, such as a calculator with memory. When the user closes the calculator, - Flash Player saves the last value in a shared object on the user's computer. - The next time the calculator is run, it contains the values it had previously. - Alternatively, if you set the shared object's properties to null before the - calculator application is closed, the next time the - application runs, it opens without any values. - - Another example of maintaining local persistence is tracking user preferences or - other data for a complex website, such as a record of which - articles a user read on a news site. Tracking this information allows you to display - articles that have already been read differently from new, unread articles. - Storing this information on the user's computer reduces server load.
    • - -
  • Store and share data on Flash Media Server. - A shared object can store data on the server for other clients to retrieve. - For example, call SharedObject.getRemote() to create a remote shared object, - such as a phone list, that is persistent on the server. Whenever a client makes changes - to the shared object, the revised data is available to all clients currently - connected to the object or who later connect to it. If the object is also persistent locally, - and a client changes data while not connected to the server, the data is copied to the remote shared - object the next time the client connects to the object.
    • - -
  • Share data in real time. - A shared object can share data among multiple clients in real time. - For example, you can open a remote shared object that stores - a list of users connected to a chat room that is visible to all clients - connected to the object. When a user enters or leaves the chat room, the object - is updated and all clients that are connected to the object see the revised list - of chat room users.
    • - -
- -

To create a local shared object, call SharedObject.getLocal(). To create - a remote shared object, call SharedObject.getRemote().

-

When an application closes, shared objects are flushed, or written to a disk. - You can also call the flush() method to explicitly write data to a disk.

-

Local disk space considerations. Local shared objects have some limitations - that are important to consider as you design your application. - Sometimes SWF files may not be allowed to write local shared objects, and sometimes the data - stored in local shared objects can be deleted without your knowledge. Flash Player users - can manage the disk space that is available to individual domains or - to all domains. When users decrease the amount of disk space available, some local shared - objects may be deleted. Flash Player users also have privacy controls that can prevent - third-party domains (domains other than the domain in the current browser address bar) from - reading or writing local shared objects. Also note that on Mac OS, starting with AIR 3.3, the location - for local shared objects changed, so if you upgrade to the 3.3 namespace, it may appear as if - the objects were lost.

-

Note: SWF files that are stored and run on a local computer, not from a remote server, - can always write third-party shared objects to disk. - For more information about third-party shared objects, see the - Global Storage Settings panel in Flash Player Help.

- -

It's a good idea to check for failures related to the amount of disk space and to - user privacy controls. Perform these checks when you call getLocal() and - flush(): - -

    -
  • SharedObject.getLocal() — Flash Player throws an exception when - a call to this method fails, such as when the user has disabled - third-party shared objects and the domain of your SWF file does not match the domain in the browser - address bar.
    • - -
  • SharedObject.flush() — Flash Player throws an exception - when a call to this method fails. It returns SharedObjectFlushStatus.FLUSHED when it succeeds. - It returns SharedObjectFlushStatus.PENDING - when additional storage space is needed. Flash Player prompts the user to allow an increase - in storage space for locally saved information. Thereafter, the netStatus event - is dispatched with an information object indicating whether the flush failed or succeeded.
    • -

- -

If your SWF file attempts to create or modify local shared objects, make sure - that your SWF file is at least 215 pixels wide and at least 138 pixels high (the - minimum dimensions for displaying the dialog box that prompts users to increase their - local shared object storage limit). If your SWF file is smaller than these dimensions and an - increase in the storage limit is required, SharedObject.flush() fails, - returning SharedObjectFlushedStatus.PENDING and dispatching the netStatus event.

- -

- Remote shared objects. - With Flash Media Server, you can create and use remote shared objects, - that are shared in real-time by all clients connected to your application. - When one client changes a property of a remote shared object, the property - is changed for all connected clients. - You can use remote shared objects to synchronize clients, for example, users - in a multi-player game. -

- -

- Each remote shared object has a data property which is an Object with properties - that store data. Call setProperty() - to change an property of the data object. - The server updates the properties, dispatches a sync event, and - sends the properties back to the connected clients. -

- -

- You can choose to make remote shared objects persistent on the client, the server, - or both. By default, Flash Player saves locally persistent remote shared objects up to 100K in size. - When you try to save a larger object, Flash Player displays the Local Storage dialog box, - which lets the user allow or deny local storage for the shared object. - Make sure your Stage size is at least 215 by 138 pixels; this is the minimum size Flash - requires to display the dialog box. -

-

- If the user selects Allow, the server saves the shared object and - dispatches a netStatus event with a code property of - SharedObject.Flush.Success. - If the user select Deny, the server does not save the shared object and dispatches - a netStatus event - with a code property of SharedObject.Flush.Failed. -

- -

-

-View the examples. -

-

-See also -

-
-flush() -
-getLocal() -
-netStatus -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  client : Object -
- Indicates the object on which - callback methods are invoked.
-		SharedObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  data : Object -
[read-only] - The collection of attributes assigned to the data property of the object; these attributes can - be shared and stored.
-		SharedObject
  defaultObjectEncoding : uint -
[static] - The default object encoding (AMF version) for all local shared objects created in the SWF file.
-		SharedObject
  fps : Number -
[write-only] - Specifies the number of times per second that a client's changes to a - shared object are sent to the server.
-		SharedObject
  objectEncoding : uint -
- The object encoding (AMF version) for this shared object.
-		SharedObject
  preventBackup : Boolean -
[static] - Specifies whether or not local shared objects will be backed up on the iOS cloud backup service.
-		SharedObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  size : uint -
[read-only] - The current size of the shared object, in bytes.
-		SharedObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-clear():void -
-
- For local shared objects, purges all of the data and deletes the shared object from the disk.
-		SharedObject
   -
-close():void -
-
- Closes the connection between a remote shared object and the server.
-		SharedObject
   -
-connect(myConnection:NetConnection, params:String = null):void -
-
- Connects to a remote shared object on a server through a specified NetConnection object.
-		SharedObject
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-flush(minDiskSpace:int = 0):String -
-
- Immediately writes a locally persistent shared object to a local file.
-		SharedObject
   -
-getLocal(name:String, localPath:String = null, secure:Boolean = false):SharedObject -
-
[static] - Returns a reference to a locally persistent shared object that is only available to the current client.
-		SharedObject
   -
-getRemote(name:String, remotePath:String = null, persistence:Object = false, secure:Boolean = false):SharedObject -
-
[static] - Returns a reference to a shared object on Flash Media Server that multiple - clients can access.
-		SharedObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-send(... arguments):void -
-
- Broadcasts a message to all clients connected to a remote shared object, - including the client that sent the message.
-		SharedObject
   -
-setDirty(propertyName:String):void -
-
- Indicates to the server that the value of a property - in the shared object has changed.
-		SharedObject
   -
-setProperty(propertyName:String, value:Object = null):void -
-
- Updates the value of a property in a shared object and indicates to the server - that the value of the property has changed.
-		SharedObject
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-asyncError -
-		 - Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code.SharedObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-netStatus -
-		 - Dispatched when a SharedObject instance is reporting its status or error condition.SharedObject
   -
-sync -
-		 - Dispatched when a remote shared object has been updated by the server.SharedObject
-
- -
- -
Property detail
- - - - - -
clientproperty
-
-client:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the object on which - callback methods are invoked. The default object is this. - You can set the client property to another object, and callback methods will be - invoked on that other object. - -

Implementation -
-    public function get client():Object -
-    public function set client(value:Object):void -
-
-Throws -
- - - - -
TypeError — The client property must be set to a non-null object. -
-
- - - - - -
dataproperty 
-
-data:Object  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The collection of attributes assigned to the data property of the object; these attributes can - be shared and stored. Each attribute can be an object of any ActionScript or JavaScript - type — Array, Number, Boolean, ByteArray, XML, and so on. For example, the following lines assign values to various aspects - of a shared object: - 

-     var items_array:Array = new Array(101, 346, 483);
-     var currentUserIsAdmin:Boolean = true;
-     var currentUserName:String = "Ramona";
-     
-     var my_so:SharedObject = SharedObject.getLocal("superfoo");
-     my_so.data.itemNumbers = items_array;
-     my_so.data.adminPrivileges = currentUserIsAdmin;
-     my_so.data.userName = currentUserName;
-     
-     for (var prop in my_so.data) {
-       trace(prop+": "+my_so.data[prop]);
-     }
-
- 
-     var items_array = new Array(101, 346, 483);
-     var currentUserIsAdmin = true;
-     var currentUserName = "Ramona";
-     
-     var my_so = air.SharedObject.getLocal("superfoo");
-     my_so.data.itemNumbers = items_array;
-     my_so.data.adminPrivileges = currentUserIsAdmin;
-     my_so.data.userName = currentUserName;
-     
-     for (var prop in my_so.data) {
-       trace(prop+": "+my_so.data[prop]);
-     }
-
-

All attributes of a shared object's data property are saved if the object is persistent, and - the shared object contains the following information:

- 
-     userName: Ramona
-     adminPrivileges: true
-     itemNumbers: 101,346,483
-
-

Note: Do not assign values directly to the data property of a shared - object, as in so.data = someValue; Flash Player ignores these assignments.

-

To delete attributes for local shared objects, use code such as - delete so.data.attributeName; setting an attribute to - null or undefined for a local shared object does not - delete the attribute.

-

To create private values for a shared object — values that are available only to the client - instance while the object is in use and are not stored with the object when it is closed — create properties - that are not named data to store them, as shown in the following example:

- 
-     var my_so:SharedObject = SharedObject.getLocal("superfoo");
-     my_so.favoriteColor = "blue";
-     my_so.favoriteNightClub = "The Bluenote Tavern";
-     my_so.favoriteSong = "My World is Blue";
-     
-     for (var prop in my_so) {
-       trace(prop+": "+my_so[prop]);
-     }
-
- 
-     var my_so = air.SharedObject.getLocal("superfoo");
-     my_so.favoriteColor = "blue";
-     my_so.favoriteNightClub = "The Bluenote Tavern";
-     my_so.favoriteSong = "My World is Blue";
-     
-     for (var prop in my_so) {
-       trace(prop+": "+my_so[prop]);
-     }
-
-

The shared object contains the following data:

- 
-     favoriteSong: My World is Blue
-     favoriteNightClub: The Bluenote Tavern
-     favoriteColor: blue
-     data: [object Object]
-
- -

- For remote shared objects used with a server, all attributes of the data - property are available to all clients connected to the shared object, and all attributes - are saved if the object is persistent. - If one client changes the value of an attribute, all clients now see the new value. -

- Implementation -
-    public function get data():Object -
-

-See also -

-
-getLocal() -
-
- - - - - -
defaultObjectEncodingproperty 
-
-defaultObjectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The default object encoding (AMF version) for all local shared objects created in the SWF file. - When local shared objects are written to disk, the - SharedObject.defaultObjectEncoding property - indicates which Action Message Format version should be used: the ActionScript 3.0 format (AMF3) or the ActionScript 1.0 or 2.0 format (AMF0). - -

For more information about object encoding, including the difference between - encoding in local and remote shared objects, see the description of the - objectEncoding property.

-

The default value of SharedObject.defaultObjectEncoding is set to use the - ActionScript 3.0 format, AMF3. - If you need to write local shared objects that ActionScript 2.0 or 1.0 SWF files can read, - set SharedObject.defaultObjectEncoding to use the - ActionScript 1.0 or ActionScript 2.0 format, flash.net.ObjectEncoding.AMF0, - at the beginning of your script, before you create any local shared objects. - All local shared objects - created thereafter will use AMF0 encoding and can interact with older content. - You cannot change the objectEncoding value of existing local shared objects - by setting SharedObject.defaultObjectEncoding after the local shared - objects have been created.

-

To set the object encoding on a per-object basis, rather than for all shared objects - created by the SWF file, set the objectEncoding property of the local shared object instead.

- - Implementation -
-    public static function get defaultObjectEncoding():uint -
-    public function set defaultObjectEncoding(value:uint):void -
-

-See also -

-
-objectEncoding property -
-ObjectEncoding class -
-
- - - - - -
fpsproperty 
-
-fps:Number  [write-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies the number of times per second that a client's changes to a - shared object are sent to the server. -

Use this method when you want to control the amount of traffic between - the client and the server. For example, if the connection between the client - and server is relatively slow, you may want to set fps - to a relatively low value. Conversely, if the client is connected to a multiuser - application in which timing is important, you may want to set fps - to a relatively high value.

-

Setting fps will trigger a sync event and update all changes to the server. - If you only want to update the server manually, set fps to 0.

-

Changes are not sent to the server until the sync event has been dispatched. - That is, if the response time from the server is slow, updates may be sent to - the server less frequently than the value specified in this property.

- Implementation -
-    public function set fps(value:Number):void -
-
- - - - - -
objectEncodingproperty 
-
-objectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The object encoding (AMF version) for this shared object. When a local shared object is written to disk, - the objectEncoding property indicates which Action - Message Format version should be used: the ActionScript 3.0 format (AMF3) - or the ActionScript 1.0 or 2.0 format (AMF0). -

Object encoding is handled differently depending if the shared object - is local or remote.

-
    -
  • Local shared objects. You can get or set the value of the - objectEncoding property for local shared objects. - The value of objectEncoding - affects what formatting is used for writing this local shared object. - If this local shared object must be readable by - ActionScript 2.0 or 1.0 SWF files, set objectEncoding to - ObjectEncoding.AMF0. - Even if object encoding is set to write AMF3, Flash Player can still read AMF0 local shared objects. - That is, if you use the default value of this property, ObjectEncoding.AMF3, - your SWF file can still read shared objects created by ActionScript 2.0 or 1.0 SWF files. -
    • - -
  • Remote shared objects. When connected to the server, a remote shared object - inherits its objectEncoding setting from the associated NetConnection - instance (the instance used to connect to the remote shared object). When not connected - to the server, a remote shared object inherits the defaultObjectEncoding - setting from the associated NetConnection instance. - Because the value of a remote shared object's objectEncoding property is - determined by the NetConnection instance, this property is read-only for remote shared objects. -
    • -
- - Implementation -
-    public function get objectEncoding():uint -
-    public function set objectEncoding(value:uint):void -
-
-Throws -
- - - - -
ReferenceError — You attempted to set the value of the objectEncoding - property on a remote shared object. This property is read-only for remote shared objects because - its value is determined by the associated NetConnection instance. - -
-

-See also -

-
-defaultObjectEncoding -
-flash.net.ObjectEncoding -
-
- - - - - -
preventBackupproperty 
-
-preventBackup:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Specifies whether or not local shared objects will be backed up on the iOS cloud backup service. -

Specify true or false:

-
    -
  • true - Prevents all local shared objects from being backed up on the iOS backup cloud service.
    • -
  • false (the default) - Local shared objects wil be backed up on the iOS backup cloud service.
    • -
-

This property applies only to local shared objects and is for iOS only.

- Implementation -
-    public static function get preventBackup():Boolean -
-    public function set preventBackup(value:Boolean):void -
-
- - - - - -
sizeproperty 
-
-size:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The current size of the shared object, in bytes. - -

Flash calculates the size of a shared object by stepping through all of its data - properties; the more data properties the object has, the longer it takes to estimate its size. - Estimating object size can take significant processing time, so you - may want to avoid using this method unless you have a specific need for it.

- Implementation -
-    public function get size():uint -
-
-Example -
The following code creates a SharedObject object using an id "thehobbit". - A property named username is added to the data property of the SharedObject object. - The size property is then traced, which returns the value indicated. -
-
-
-import flash.net.SharedObject;
-
-// if these get copied or not
-var mySo:SharedObject = SharedObject.getLocal("thehobbit");
-mySo.data.username = "bilbobaggins";
-trace(mySo.size); // 55
-
-

-
- -
Method detail
- - - - - -
clear()method
-
-public function clear():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- For local shared objects, purges all of the data and deletes the shared object from the disk. - The reference to the shared object is still active, but its data properties are deleted. -

- For remote shared objects used with Flash Media Server, - clear() disconnects the object and purges - all of the data. If the shared object is locally persistent, this method also deletes the shared object - from the disk. The reference to the shared object is still active, but its data properties - are deleted. -

- -
-Example -
The following code creates (and on subsequent executions, retrieves) a SharedObject - object using an id with the value of hostName. A property named username - is added to the data property of the SharedObject object. - The clear() method is finally called, which wipes out all information that was added - to the data object (in this case was a single property named username). -
-
-
-package {
-    import flash.net.SharedObject;
-
-	public class SharedObject_clear {
-		private var hostName:String = "yourDomain";
-		private var username:String = "yourUsername";
-
-		public function SharedObject_clear() {
-			var mySo:SharedObject = SharedObject.getLocal(hostName);
-			if(mySo.data.username == null) {
-				mySo.data.username = username;
-				trace("set: " + mySo.data.username); // yourUsername
-			}
-			else {
-				mySo.clear();
-				trace("cleared: " + mySo.data.username); // undefined
-			}
-		}
-	}
-}
-
-

-
- - - - - -
close()method 
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Closes the connection between a remote shared object and the server. - If a remote shared object is locally persistent, the user can make changes - to the local copy of the object after this method is called. Any changes made - to the local object are sent to the server the next time the user connects - to the remote shared object. -

- - - - - -
connect()method 
-
-public function connect(myConnection:NetConnection, params:String = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Connects to a remote shared object on a server through a specified NetConnection object. - Use this method after calling getRemote(). - When a connection is successful, the sync event is dispatched. -

Before attempting to work with a remote shared object, - first check for any errors using a try..catch..finally statement. - Then, listen for and handle the sync event before - you make changes to the shared object. Any changes made - locally — before the sync event is dispatched — might be lost. -

-

- Call the connect() method - to connect to a remote shared object, for example: -

- - 
-     var myRemoteSO:SharedObject = SharedObject.getRemote("mo", myNC.uri, false);
-     myRemoteSO.connect(myNC);
-
- - 
-     var myRemoteSO = air.SharedObject.getRemote("mo", myNC.uri, false);
-     myRemoteSO.connect(myNC);
-
- - Parameters - - - - - - - - - - -
myConnection:NetConnection — A NetConnection object that uses the Real-Time Messaging Protocol (RTMP), - such as a NetConnection object used to communicate with Flash Media Server. - -
 
params:String (default = null) — A string defining a message to pass to the remote shared object on the server. - Cannot be used with Flash Media Server. - -
-
-Throws - - - - -
Error — Flash Player could not connect to the specified remote shared object. - Verify that the NetConnection instance is valid and connected and that the - remote shared object was successfully created on the server. - -
-

-See also -

-
-getRemote() -
-sync -
-try..catch..finally -
-NetConnection -
-
- - - - - -
flush()method 
-
-public function flush(minDiskSpace:int = 0):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Immediately writes a locally persistent shared object to a local file. If you don't use this - method, Flash Player writes the shared object to a file when the shared object session ends — - that is, when the SWF file is closed, when the shared object is garbage-collected - because it no longer has any references to it, or when you call SharedObject.clear() - or SharedObject.close(). - -

If this method returns SharedObjectFlushStatus.PENDING, - Flash Player displays a dialog box asking - the user to increase the amount of disk space available to objects from this domain. To allow - space for the shared object to grow when it is saved in the future, which avoids return values - of PENDING, pass a value for minDiskSpace. When Flash Player - tries to write the file, it looks for the number of bytes passed to - minDiskSpace, instead of looking for enough space to save the shared - object at its current size.

-

For example, if you expect a shared object to grow to a maximum size of 500 bytes, even - though it might start out much smaller, pass 500 for minDiskSpace. If - Flash asks the user to allot disk space for the shared object, it asks for 500 bytes. After - the user allots the requested amount of space, Flash won't have to ask for more space on future - attempts to flush the object (as long as its size doesn't exceed 500 bytes).

- -

After the user responds to the dialog box, this method is called again. A - netStatus event is dispatched with a code property of - SharedObject.Flush.Success or SharedObject.Flush.Failed. -

- Parameters - - - - -
minDiskSpace:int (default = 0) — The minimum disk space, in bytes, - that must be allotted for this object. -
-

-Returns - - - - -
String — - Either of the following values: -
    -
  • SharedObjectFlushStatus.PENDING: The user has permitted local information - storage for objects from this domain, but the - amount of space allotted is not sufficient to store the object. Flash Player prompts - the user to allow more space. - To allow space for the shared object to grow when it is saved, thus avoiding - a SharedObjectFlushStatus.PENDING return value, pass a value - for minDiskSpace. -
    • - -
  • SharedObjectFlushStatus.FLUSHED: The shared object has been - successfully written to a file on the local disk.
    • -
- - - -
-
-Throws - - - - -
Error — Flash Player cannot write the shared object to disk. This error might - occur if the user has permanently disallowed local information storage for - objects from this domain. - -

Note: Local content can always write shared objects - from third-party domains (domains other than the domain in the current browser address bar) - to disk, even if writing of third-party shared objects to disk is disallowed.

- -
-

-See also -

-
-clear() -
-
-Example -
The following code creates (and on subsequent executions, retrieves) a SharedObject - object using an id with the value of hostName. A property named username - is added to the data property of the SharedObject object. The flush() method is - then called, followed by a check to see if the string pending, or a boolean value - of true or false was returned. - - One should be aware that all open SharedObject instances will automatically be flushed whenever the - current instance of the Flash Player is closed. -
-
-package {
-    import flash.net.SharedObject;
-
-	public class SharedObject_flush {
-		private var hostName:String = "yourDomain";
-		private var username:String = "yourUsername";
-
-		public function SharedObject_flush() {
-			var mySo:SharedObject = SharedObject.getLocal(hostName);
-			mySo.data.username = username;
-			var flushResult:Object = mySo.flush();
-			trace("flushResult: " + flushResult);
-			trace(mySo.data.username); // yourUsername
-		}
-	}
-}
-
-

-
- - - - - -
getLocal()method 
-
-public static function getLocal(name:String, localPath:String = null, secure:Boolean = false):SharedObject -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a reference to a locally persistent shared object that is only available to the current client. - If the shared object does not already exist, this method creates one. If any values - passed to getLocal() are invalid or if the call fails, Flash Player throws an exception. - -

The following code shows how you assign the returned shared object reference to a variable:

-

var so:SharedObject = SharedObject.getLocal("savedData");

- -

Note: If the user has chosen to never allow local storage for this domain, - the object is not saved locally, even if a value for localPath is specified. The - exception to this rule is local content. Local content can always write shared objects - from third-party domains (domains other than the domain in the current browser address bar) - to disk, even if writing of third-party shared objects to disk is disallowed. -

- -

To avoid name conflicts, Flash looks at the location of the SWF file creating the - shared object. For example, if a SWF file at www.myCompany.com/apps/stockwatcher.swf creates a - shared object named portfolio, that shared object does not conflict with another - object named portfolio that was created by a SWF file at - www.yourCompany.com/photoshoot.swf because the SWF files originate from different directories.

- -

Although the localPath parameter is optional, you should give some - thought to its use, especially if other SWF files need to access the shared object. If the - data in the shared object is specific to one SWF file that will not be moved to another location, - then use of the default value makes sense. If other SWF files need access to the shared object, or - if the SWF file that creates the shared object will later be moved, then the value of this parameter - affects how accessible the shared object will be. For example, if you create a shared object with - localPath set to the default value of the full path to the SWF file, no other SWF - file can access that shared object. If you later move the original SWF file to another location, - not even that SWF file can access the data already stored in the shared object.

- -

To avoid inadvertently restricting access to a shared object, use - the localpath parameter. The most permissive approach is to set - localPath to / (slash), which makes the shared object available to all SWF files - in the domain, but increases the likelihood of name conflicts with other shared objects in - the domain. A more restrictive approach is to append localPath with folder names that are in - the full path to the SWF file. For example, for a portfolio shared object created by the SWF - file at www.myCompany.com/apps/stockwatcher.swf, you could set the localPath parameter to - /, /apps, or /apps/stockwatcher.swf. You must determine which - approach provides optimal flexibility for your application.

- -

When using this method, consider the following security model: - -

    - -
  • You cannot access shared objects across sandbox boundaries.
    • -
  • Users can restrict shared object access by using the Flash Player Settings dialog box - or the Settings Manager. By default, an application can create shared objects of up 100 KB of data per domain. - Administrators and users can also place restrictions on the ability to write to the file system.
    • -

- -

Suppose you publish SWF file content to be played back as local files (either locally installed SWF files or - EXE files), and you need to access a specific shared object from more than one local SWF file. In this situation, - be aware that for local files, two different locations might be used to store shared objects. The domain that is - used depends on the security permissions granted to the local file that created the shared object. Local files - can have three different levels of permissions: -

    -
  1. Access to the local filesystem only.
    2. -
  2. Access to the network only.
    3. -
  3. Access to both the network and the local filesystem.
    4. -

- -

Local files with access to the local filesystem (level 1 or 3) store their shared objects in one location. - Local files without access to the local filesystem (level 2) store their shared objects in another location.

- -

You can prevent a SWF file from using this method by setting the - allowNetworking parameter of the the object and embed - tags in the HTML page that contains the SWF content.

- -

For more information, see the Flash Player Developer Center Topic: - Security.

- Parameters - - - - - - - - - - - - - - - - -
name:String — The name of the object. The name can include forward slashes (/); for example, - work/addresses is a legal name. Spaces are not allowed in a shared - object name, nor are the following characters: - 
-  ~ % & \ ; : " ' , < > ? # 
-
- -
 
localPath:String (default = null) — The full or partial path to the SWF file that created the shared object, and that - determines where the shared object will be stored locally. If you do not specify this parameter, the - full path is used. - -
 
secure:Boolean (default = false) — Determines whether access to this shared object - is restricted to SWF files that are delivered over an HTTPS connection. - If your SWF file is delivered over HTTPS, this parameter's value has the following effects: -
    -
  • If this parameter is set to true, Flash Player creates a new secure shared object or - gets a reference to an existing secure shared object. This secure shared object - can be read from or written to only by SWF files delivered over HTTPS that call - SharedObject.getLocal() with the secure parameter set to - true.
    • -
  • If this parameter is set to false, Flash Player creates a new shared object or - gets a reference to an existing shared object that can be read from - or written to by SWF files delivered over non-HTTPS connections.
    • -
-

If your SWF file is delivered over a non-HTTPS connection and you try to set this parameter - to true, the creation of a new shared object (or the access of a previously - created secure shared object) fails and null is returned. Regardless of the - value of this parameter, the created shared objects count toward the total amount - of disk space allowed for a domain.

- -

The following diagram shows the use of the secure parameter:

-

secure shared object diagram

- -
-

-Returns - - - - -
SharedObject — - A reference to a shared object that is persistent locally and is available only to the - current client. If Flash Player can't create or find the shared object (for example, if - localPath was - specified but no such directory exists), this method throws an exception. - - - -
-
-Throws - - - - -
Error — Flash Player cannot create the shared object for whatever reason. - This error might occur is if persistent shared object creation - and storage by third-party Flash content is prohibited (does not apply to local content). - Users can prohibit third-party persistent shared objects on the Global Storage Settings panel of the - Settings Manager, located at - http://www.adobe.com/support/documentation/en/flashplayer/help/settings_manager03.html. -
-
- - - - - -
getRemote()method 
-
-public static function getRemote(name:String, remotePath:String = null, persistence:Object = false, secure:Boolean = false):SharedObject -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns a reference to a shared object on Flash Media Server that multiple - clients can access. - If the remote shared object does not already exist, this method creates one. -

- To create a remote shared object, call getRemote() the call - connect() to connect the remote shared object to the server, as in - the following:

- - 
-     var nc:NetConnection = new NetConnection();
-     nc.connect("rtmp://somedomain.com/applicationName");
-     var myRemoteSO:SharedObject = SharedObject.getRemote("mo", nc.uri, false);
-     myRemoteSO.connect(nc);
-
- 
-     var nc = new air.NetConnection();
-     nc.connect("rtmp://somedomain.com/applicationName");
-     var myRemoteSO:SharedObject = SharedObject.getRemote("mo", nc.uri, false);
-     myRemoteSO.connect(nc);
-
-

- To confirm that the local and remote copies of the shared object are synchronized, - listen for and handle the sync event. - All clients that want to share this object must pass the same values for - the name and remotePath parameters. -

- -

To create a shared object that is available only to the current client, - use SharedObject.getLocal(). -

- - Parameters - - - - - - - - - - - - - - - - - - - - - - -
name:String — The name of the remote shared object. The name can include forward slashes (/); - for example, work/addresses is a legal name. Spaces are not allowed in a shared object name, - nor are the following characters: - 
    ~ % & \ ; :  " ' , > ? ? #
- -
 
remotePath:String (default = null) — The URI of the server on which the shared object will be stored. - This URI must be identical to the URI of the NetConnection object passed to the - connect() method. - -
 
persistence:Object (default = false) — Specifies whether the attributes of the shared - object's data property are persistent locally, remotely, or both. This parameter can also specify - where the shared object will be stored locally. Acceptable values are as follows: -
  • A value of false specifies that the shared object is not persistent - on the client or server.
    • -
  • A value of true specifies that the shared object is persistent only on the server.
    • -
  • A full or partial local path to the shared object indicates that the shared - object is persistent on the client and the server. On the client, it is stored in the - specified path; on the server, it is stored in a subdirectory within the application - directory.
    • -
-

Note: If the user has chosen to never allow local storage - for this domain, the object will not be saved locally, even if a local path is - specified for persistence. For more information, see the class description.

- -
 
secure:Boolean (default = false) — Determines whether access to this shared object is restricted to SWF - files that are delivered over an HTTPS connection. For more information, see the - description of the secure parameter in the - getLocal method entry. - -
-

-Returns - - - - -
SharedObject — - A reference to an object that can be shared across multiple clients. - - - -
-
-Throws - - - - -
Error — Flash Player can't create or find the shared object. This might occur if nonexistent paths were - specified for the remotePath and persistence parameters. -
-

-See also -

-
-connect() -
-getLocal() -
-
- - - - - -
send()method 
-
-public function send(... arguments):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Broadcasts a message to all clients connected to a remote shared object, - including the client that sent the message. To process and respond to the message, - create a callback function attached to the shared object. - -

Parameters - - - - -
... arguments — One or more arguments: A string that identifies the message, - the name of one or more handler functions to attach to the shared object, - and optional parameters of any type. - The handler name can be only one level deep (that is, it can't be of the - form parent/child) and is relative to the shared object. - The arguments are serialized and sent over the connection, and the - receiving handler receives them in the same order. If a parameter is a - circular object (for example, a linked list that is circular), the - serializer handles the references correctly. - -

Note: Do not use a reserved term for the function names. - For example, myRemoteSO.send("close") will fail.

- -
-
- - - - - -
setDirty()method 
-
-public function setDirty(propertyName:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates to the server that the value of a property - in the shared object has changed. - This method marks properties as dirty, which means changed. - -

- Call the SharedObject.setProperty() to create properties for a shared object. -

- -

- The SharedObject.setProperty() method implements setDirty(). - In most cases, such as when the value of a property is a primitive type like String or Number, - you can call setProperty() instead of calling setDirty(). - However, when the value of a property is an object that contains its own properties, - call setDirty() to indicate when a value within the object has changed. -

- - Parameters - - - - -
propertyName:String — The name of the property that has changed. - -
-

-See also -

-
-SharedObject.data (client-side property) -
-setProperty() -
-
- - - - - -
setProperty()method 
-
-public function setProperty(propertyName:String, value:Object = null):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Updates the value of a property in a shared object and indicates to the server - that the value of the property has changed. The setProperty() method - explicitly marks properties as changed, or dirty. -

For more information about remote shared objects see the - - Flash Media Server documentation.

-

Note: The SharedObject.setProperty() method implements the setDirty() method. - In most cases, such as when the value of a property is a primitive type like String or Number, - you would use setProperty() instead of setDirty. - However, when the value of a property is an object that contains its own properties, - use setDirty() to indicate when a value within the object has changed. - In general, it is a good idea to call setProperty() rather than setDirty(), because - setProperty() updates a property value only when that value has changed, whereas setDirty() - forces synchronization on all subscribed clients.

- Parameters - - - - - - - - - - -
propertyName:String — The name of the property in the shared object. -
 
value:Object (default = null) — The value of the property (an ActionScript object), or null to delete the property. -
-

-See also -

-
-SharedObject.data (client-side property) -
-
-
Event detail
- - - - - -
asyncErrorevent 
-
-Event object type: flash.events.AsyncErrorEvent -
-AsyncErrorEvent.type property = flash.events.AsyncErrorEvent.ASYNC_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when an exception is thrown asynchronously — that is, - from native asynchronous code. - -

- The AsyncErrorEvent.ASYNC_ERROR constant defines the value of the - type property of an asyncError event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse - This property applies to ActionScript 3.0 display objects (in SWF files).
cancelablefalse; there is no default - behavior to cancel. This property applies to display objects - in SWF content, which use the ActionScript 3.0 display architecture.
currentTargetThe object that is actively processing the - Event object with an event listener. This property applies to display - objects in SWF content, which use the ActionScript 3.0 display architecture.
target The object dispatching the event.
errorThe error that triggered the event.
- -
- - - - - -
netStatusevent  
-
-Event object type: flash.events.NetStatusEvent -
-NetStatusEvent.type property = flash.events.NetStatusEvent.NET_STATUS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when a SharedObject instance is reporting its status or error condition. - The netStatus event contains an info property, - which is an information object - that contains specific information about the event, such as whether a connection - attempt succeeded or whether the shared object was successfully written to the local disk. -

- Defines the value of the type property of a netStatus event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
infoAn object with properties that describe the object's status or error condition.
targetThe NetConnection or NetStream object reporting its status.
-

-See also -

-
-flash.events.NetStatusEvent.info -
-
- - - - - -
syncevent  
-
-Event object type: flash.events.SyncEvent -
-SyncEvent.type property = flash.events.SyncEvent.SYNC -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when a remote shared object has been updated by the server. -

- Defines the value of the type property of a sync event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
changeListAn array with properties that describe the array's status.
targetThe SharedObject instance that has been updated by the server.
- -

-See also -

-
-getRemote() -
-
- -
Examples
-
examples\SharedObjectExample
-
The following code creates (and on subsequent executions, retrieves) a shared object - object using the ID "application-name". When the Save button is clicked, the - saveValue() method attempts to save a property named savedValue - to the data property of the SharedObject object. If Flash Player must ask for permission to save - the data, when the user grants or denies permission the onFlushStatus() method is - called. When the Clear button is clicked, the clearValue() method deletes the value - saved in savedValue; the next time the SWF file is loaded, the value that is retrieved - is undefined. - -
-
-package {
-    import flash.display.Sprite;
-    import flash.events.MouseEvent;
-    import flash.events.NetStatusEvent;
-    import flash.net.SharedObject;
-    import flash.net.SharedObjectFlushStatus;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.text.TextFieldType;
-    
-	public class SharedObjectExample extends Sprite {
-		
-		private var mySo:SharedObject;
-		
-		public function SharedObjectExample() {
-			buildUI();
-			saveBtn.addEventListener(MouseEvent.CLICK, saveValue);
-			clearBtn.addEventListener(MouseEvent.CLICK, clearValue);
-			
-			mySo = SharedObject.getLocal("application-name");
-			output.appendText("SharedObject loaded...\n");
-			output.appendText("loaded value: " + mySo.data.savedValue + "\n\n");
-		}
-
- 		private function saveValue(event:MouseEvent):void {
-			output.appendText("saving value...\n");
-			mySo.data.savedValue = input.text;
-			
-			var flushStatus:String = null;
-			try {
-				flushStatus = mySo.flush(10000);
-			} catch (error:Error) {
-				output.appendText("Error...Could not write SharedObject to disk\n");
-			}
-			if (flushStatus != null) {
-				switch (flushStatus) {
-					case SharedObjectFlushStatus.PENDING:
-						output.appendText("Requesting permission to save object...\n");
-						mySo.addEventListener(NetStatusEvent.NET_STATUS, onFlushStatus);
-						break;
-					case SharedObjectFlushStatus.FLUSHED:
-						output.appendText("Value flushed to disk.\n");
-						break;
-				}
-			}
-			output.appendText("\n");
-		}
-		
-		private function clearValue(event:MouseEvent):void {
-			output.appendText("Cleared saved value...Reload SWF and the value should be \"undefined\".\n\n");
-			delete mySo.data.savedValue;
-		}
-		
-		private function onFlushStatus(event:NetStatusEvent):void {
-			output.appendText("User closed permission dialog...\n");
-			switch (event.info.code) {
-				case "SharedObject.Flush.Success":
-					output.appendText("User granted permission -- value saved.\n");
-					break;
-				case "SharedObject.Flush.Failed":
-					output.appendText("User denied permission -- value not saved.\n");
-					break;
-			}
-			output.appendText("\n");
-
-			mySo.removeEventListener(NetStatusEvent.NET_STATUS, onFlushStatus);
-		}
-		
-		// UI elements
-		private var inputLbl:TextField;
-		private var input:TextField;
-		private var output:TextField;
-		private var saveBtn:Sprite;
-		private var clearBtn:Sprite;
-	
-		private function buildUI():void {
-			// input label
-			inputLbl = new TextField();
-			addChild(inputLbl);
-			inputLbl.x = 10;
-			inputLbl.y = 10;
-			inputLbl.text = "Value to save:";
-			
-			// input TextField
-			input = new TextField();
-			addChild(input);
-			input.x = 80;
-			input.y = 10;
-			input.width = 100;
-			input.height = 20;
-			input.border = true;
-			input.background = true;
-			input.type = TextFieldType.INPUT;
-			
-			// output TextField
-			output = new TextField();
-			addChild(output);
-			output.x = 10;
-			output.y = 35;
-			output.width = 250;
-			output.height = 250;
-			output.multiline = true;
-			output.wordWrap = true;
-			output.border = true;
-			output.background = true;
-			
-			// Save button
-			saveBtn = new Sprite();
-			addChild(saveBtn);
-			saveBtn.x = 190;
-			saveBtn.y = 10;
-			saveBtn.useHandCursor = true;
-			saveBtn.graphics.lineStyle(1);
-			saveBtn.graphics.beginFill(0xcccccc);
-			saveBtn.graphics.drawRoundRect(0, 0, 30, 20, 5, 5);
-			var saveLbl:TextField = new TextField();
-			saveBtn.addChild(saveLbl);
-			saveLbl.text = "Save";
-			saveLbl.selectable = false;
-			
-			// Clear button
-			clearBtn = new Sprite();
-			addChild(clearBtn);
-			clearBtn.x = 230;
-			clearBtn.y = 10;
-			clearBtn.useHandCursor = true;
-			clearBtn.graphics.lineStyle(1);
-			clearBtn.graphics.beginFill(0xcccccc);
-			clearBtn.graphics.drawRoundRect(0, 0, 30, 20, 5, 5);
-			var clearLbl:TextField = new TextField();
-			clearBtn.addChild(clearLbl);
-			clearLbl.text = "Clear";
-			clearLbl.selectable = false;
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/SharedObjectFlushStatus.html b/html-docs/flash/net/SharedObjectFlushStatus.html deleted file mode 100644 index 76c1017..0000000 --- a/html-docs/flash/net/SharedObjectFlushStatus.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - - - -flash.net.SharedObjectFlushStatus (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class SharedObjectFlushStatus
InheritanceSharedObjectFlushStatus Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The SharedObjectFlushStatus class provides values for the code returned from a call to the SharedObject.flush() method. - -

-

-See also -

-
-SharedObject.flush() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  FLUSHED : String = "flushed"
[static] - Indicates that the flush completed successfully.
-		SharedObjectFlushStatus
  PENDING : String = "pending"
[static] - Indicates that the user is being prompted to increase disk space for the shared object - before the flush can occur.
-		SharedObjectFlushStatus
-
- -
- -
Constant detail
- - - - - -
FLUSHEDconstant
-
-public static const FLUSHED:String = "flushed" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates that the flush completed successfully. -

-See also -

-
-SharedObject.flush() -
-
- - - - - -
PENDINGconstant 
-
-public static const PENDING:String = "pending" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates that the user is being prompted to increase disk space for the shared object - before the flush can occur. -

-See also -

-
-SharedObject.flush() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/Socket.html b/html-docs/flash/net/Socket.html deleted file mode 100644 index 2d7de0a..0000000 --- a/html-docs/flash/net/Socket.html +++ /dev/null @@ -1,3023 +0,0 @@ - - - - - - - - -flash.net.Socket (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - -
Packageflash.net
Classpublic class Socket
InheritanceSocket Inheritance EventDispatcher Inheritance Object
ImplementsIDataInput, IDataOutput
SubclassesSecureSocket
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The Socket class enables code to establish Transport Control Protocol (TCP) socket - connections for sending and receiving binary data. -

The Socket class is useful for working with servers that use binary protocols.

-

To use the methods of the Socket class, first use the constructor, new Socket, - to create a Socket object.

- -

A socket transmits and receives data asynchronously.

- -

On some operating systems, flush() is called automatically between execution frames, but on other operating systems, such - as Windows, the data is never sent unless you call flush() explicitly. To ensure your application behaves reliably - across all operating systems, it is a good practice to call the flush() method after writing each message - (or related group of data) to the socket.

- -

In Adobe AIR, Socket objects are also created when a listening ServerSocket receives a connection from an external process. - The Socket representing the connection is dispatched in a ServerSocketConnectEvent. Your application is responsible for - maintaining a reference to this Socket object. If you don't, the Socket object is eligible for garbage collection and may be - destroyed by the runtime without warning.

-

SWF content running in the local-with-filesystem security sandbox cannot use sockets.

-

Socket policy files on the target host specify the hosts from which SWF files - can make socket connections, and the ports to which those connections can be made. - The security requirements with regard to socket policy files have become more stringent - in the last several releases of Flash Player. - In all versions of Flash Player, Adobe recommends the use of a socket policy file; - in some circumstances, a socket policy file is required. Therefore, if you - are using Socket objects, make sure that the target host provides a socket policy file - if necessary.

-

The following list summarizes the requirements for socket policy files - in different versions of Flash Player:

-
    -
  • In Flash Player 9.0.124.0 and later, a socket policy file is required for any socket connection. - That is, a socket policy file on the target host is required no matter what port - you are connecting to, and is required even if you are connecting - to a port on the same host that is serving the SWF file.
    • -
  • In Flash Player versions 9.0.115.0 and earlier, if you want to connect to a port number below 1024, - or if you want to connect to a host other than the one serving the SWF file, - a socket policy file on the target host is required.
    • -
  • In Flash Player 9.0.115.0, even if a socket policy file isn't required, - a warning is displayed when using the Flash Debug Player if the target host - doesn't serve a socket policy file.
    • -
  • In AIR, a socket policy file is not required for content running in the application - security sandbox. Socket policy files are required for any socket connection established - by content running outside the AIR application security sandbox.
    • -
-

For more information related to security, see the Flash Player Developer Center Topic: - Security -

-

-

-View the examples. -

-

-See also -

-
-ServerSocket -
-DatagramSocket -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bytesAvailable : uint -
[read-only] - The number of bytes of data available for reading in the input buffer.
-		Socket
  bytesPending : uint -
[read-only] - Indicates the number of bytes remaining in the write buffer.
-		Socket
  connected : Boolean -
[read-only] - Indicates whether this Socket object is currently connected.
-		Socket
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  endian : String -
- Indicates the byte order for the data.
-		Socket
  localAddress : String -
[read-only] - The IP address this socket is bound to on the local machine.
-		Socket
  localPort : int -
[read-only] - The port this socket is bound to on the local machine.
-		Socket
  objectEncoding : uint -
- Controls the version of AMF used when writing or reading an object.
-		Socket
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  remoteAddress : String -
[read-only] - The IP address of the remote machine to which this socket is connected.
-		Socket
  remotePort : int -
[read-only] - The port on the remote machine to which this socket is connected.
-		Socket
  tcpNoDelay : Boolean -
- Whether to use the 'TCP_NODELAY' setting to avoid the use of Nagle's algorithm.
-		Socket
  timeout : uint -
- Indicates the number of milliseconds to wait for a connection.
-		Socket
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Socket(host:String = null, port:int = 0)
-
- Creates a new Socket object.
-		Socket
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-close():void -
-
- Closes the socket.
-		Socket
   -
-connect(host:String, port:int):void -
-
- Connects the socket to the specified host and port.
-		Socket
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-flush():void -
-
- Flushes any accumulated data in the socket's output buffer.
-		Socket
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-readBoolean():Boolean -
-
- Reads a Boolean value from the socket.
-		Socket
   -
-readByte():int -
-
- Reads a signed byte from the socket.
-		Socket
   -
-readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- Reads the number of data bytes specified by the length - parameter from the socket.
-		Socket
   -
-readDouble():Number -
-
- Reads an IEEE 754 double-precision floating-point number from the socket.
-		Socket
   -
-readFloat():Number -
-
- Reads an IEEE 754 single-precision floating-point number from the socket.
-		Socket
   -
-readInt():int -
-
- Reads a signed 32-bit integer from the socket.
-		Socket
   -
-readMultiByte(length:uint, charSet:String):String -
-
- Reads a multibyte string from the byte stream, using the specified character set.
-		Socket
   -
-readObject():* -
-
- Reads an object from the socket, encoded in AMF serialized format.
-		Socket
   -
-readShort():int -
-
- Reads a signed 16-bit integer from the socket.
-		Socket
   -
-readUnsignedByte():uint -
-
- Reads an unsigned byte from the socket.
-		Socket
   -
-readUnsignedInt():uint -
-
- Reads an unsigned 32-bit integer from the socket.
-		Socket
   -
-readUnsignedShort():uint -
-
- Reads an unsigned 16-bit integer from the socket.
-		Socket
   -
-readUTF():String -
-
- Reads a UTF-8 string from the socket.
-		Socket
   -
-readUTFBytes(length:uint):String -
-
- Reads the number of UTF-8 data bytes specified by the length - parameter from the socket, and returns a string.
-		Socket
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
   -
-writeBoolean(value:Boolean):void -
-
- Writes a Boolean value to the socket.
-		Socket
   -
-writeByte(value:int):void -
-
- Writes a byte to the socket.
-		Socket
   -
-writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- Writes a sequence of bytes from the specified byte array.
-		Socket
   -
-writeDouble(value:Number):void -
-
- Writes an IEEE 754 double-precision floating-point number to the socket.
-		Socket
   -
-writeFloat(value:Number):void -
-
- Writes an IEEE 754 single-precision floating-point number to the socket.
-		Socket
   -
-writeInt(value:int):void -
-
- Writes a 32-bit signed integer to the socket.
-		Socket
   -
-writeMultiByte(value:String, charSet:String):void -
-
- Writes a multibyte string from the byte stream, using the specified character set.
-		Socket
   -
-writeObject(object:*):void -
-
- Write an object to the socket in AMF serialized format.
-		Socket
   -
-writeShort(value:int):void -
-
- Writes a 16-bit integer to the socket.
-		Socket
   -
-writeUnsignedInt(value:uint):void -
-
- Writes a 32-bit unsigned integer to the socket.
-		Socket
   -
-writeUTF(value:String):void -
-
- Writes the following data to the socket: a 16-bit unsigned integer, which - indicates the length of the specified UTF-8 string in bytes, followed by - the string itself.
-		Socket
   -
-writeUTFBytes(value:String):void -
-
- Writes a UTF-8 string to the socket.
-		Socket
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-close -
-		 - Dispatched when the server closes the socket connection.Socket
   -
-connect -
-		 - Dispatched when a network connection has been established.Socket
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-ioError -
-		 - Dispatched when an input/output error occurs that causes a send or load operation to fail.Socket
   -
-outputProgress -
-		 - Dispatched when a socket moves data from its write buffer to the networking transport layer - Socket
   -
-securityError -
-		 - Dispatched if a call to Socket.connect() attempts to connect to a server - prohibited by the caller's security sandbox or to a port lower than 1024 and no socket policy file - exists to permit such a connection.Socket
   -
-socketData -
-		 - Dispatched when a socket has received data.Socket
-
- -
- -
Property detail
- - - - - -
bytesAvailableproperty
-
-bytesAvailable:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The number of bytes of data available for reading in the input buffer. -

Your code must access bytesAvailable to ensure - that sufficient data is available before trying to read - it with one of the read methods.

- Implementation -
-    public function get bytesAvailable():uint -
-
- - - - - -
bytesPendingproperty 
-
-bytesPending:uint  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Indicates the number of bytes remaining in the write buffer. -

- Use this property in combination with with the OutputProgressEvent. An OutputProgressEvent is thrown - whenever data is written from the write buffer to the network. - In the event handler, you can check bytesPending to see how much data is still - left in the buffer waiting to be written. When bytesPending returns 0, it means that all the data has been - transferred from the write buffer to the network, and it is safe to do things like remove event handlers, - null out socket references,start the next upload in a queue, etc. -

- Implementation -
-    public function get bytesPending():uint -
-

-See also -

-
-flash.events.OutputProgressEvent -
-
- - - - - -
connectedproperty 
-
-connected:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates whether this Socket object is currently connected. - A call to this property returns a value of true if the socket - is currently connected, or false otherwise. -

Implementation -
-    public function get connected():Boolean -
-
- - - - - -
endianproperty 
-
-endian:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates the byte order for the data. Possible values are - constants from the flash.utils.Endian class, - Endian.BIG_ENDIAN or Endian.LITTLE_ENDIAN. -

The default value is Endian.BIG_ENDIAN.

-Implementation -
-    public function get endian():String -
-    public function set endian(value:String):void -
-

-See also -

-
-flash.utils.Endian -
-
- - - - - -
localAddressproperty 
-
-localAddress:String  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

- The IP address this socket is bound to on the local machine. - - -

Implementation -
-    public function get localAddress():String -
-

-See also -

-
-ServerSocket.html#bind() -
-
- - - - - -
localPortproperty 
-
-localPort:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The port this socket is bound to on the local machine. -

Implementation -
-    public function get localPort():int -
-

-See also -

-
-ServerSocket.html#bind() -
-
- - - - - -
objectEncodingproperty 
-
-objectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Controls the version of AMF used when writing or reading an object. -

Implementation -
-    public function get objectEncoding():uint -
-    public function set objectEncoding(value:uint):void -
-

-See also -

-
-ObjectEncoding class -
-readObject() -
-writeObject() -
-
- - - - - -
remoteAddressproperty 
-
-remoteAddress:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The IP address of the remote machine to which this socket is connected. -

You can use this property to determine the IP address of a client socket - dispatched in a ServerSocketConnectEvent by a ServerSocket object. Use the DNSResolver class to - convert an IP address to a domain name, if desired.

- - Implementation -
-    public function get remoteAddress():String -
-

-See also -

-
-connect() -
-ServerSocket -
-ServerSocketConnectEvent -
-DNSResolver -
-
- - - - - -
remotePortproperty 
-
-remotePort:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The port on the remote machine to which this socket is connected. -

You can use this property to determine the port number of a client socket - dispatched in a ServerSocketConnectEvent by a ServerSocket object.

- - Implementation -
-    public function get remotePort():int -
-

-See also -

-
-connect() -
-ServerSocket -
-ServerSocketConnectEvent -
-
- - - - - -
tcpNoDelayproperty 
-
-tcpNoDelay:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51.0 -
-

- Whether to use the 'TCP_NODELAY' setting to avoid the use of Nagle's algorithm. -

- If this value is set, data will be sent as soon as it's ready, to reduce latency (good for situations where lots of - small data package are expected). If this is false then Nagle's algorithm will be applied to the socket - which means that data will be grouped together into more efficient data transfer packets, but in a way that can add - delays. -

- Implementation -
-    public function get tcpNoDelay():Boolean -
-    public function set tcpNoDelay(value:Boolean):void -
-
- - - - - -
timeoutproperty 
-
-timeout:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates the number of milliseconds to wait for a connection. -

If the connection doesn't succeed within the specified time, the connection fails. - The default value is 20,000 (twenty seconds).

- Implementation -
-    public function get timeout():uint -
-    public function set timeout(value:uint):void -
-
- -
Constructor detail
- - - - - -
Socket()constructor
-
-public function Socket(host:String = null, port:int = 0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new Socket object. If no parameters are specified, an initially disconnected socket - is created. If parameters are specified, a connection is attempted to the specified host and port. -

Note: It is strongly advised to use the constructor form without parameters, then - add any event listeners, then call the connect method with host - and port parameters. This sequence guarantees that all event listeners will work - properly.

- Parameters - - - - - - - - - - -
host:String (default = null) — A fully qualified DNS domain name or an IP address. IPv4 addresses are specified in - dot-decimal notation, such as 192.0.2.0. In Flash Player 9.0.115.0 and AIR 1.0 and later, - you can specify IPv6 addresses using hexadecimal-colon notation, such as 2001:db8:ccc3:ffff:0:444d:555e:666f. - You can also specify null to connect to the host server - on which the SWF file resides. If the SWF file issuing this call is running in a web browser, - host must be in the domain from which the SWF file originated. -
 
port:int (default = 0) — The TCP port number on the target host used to establish a connection. - In Flash Player 9.0.124.0 and later, the target host must serve a socket policy file - specifying that socket connections are permitted from the host serving the SWF file - to the specified port. In earlier versions of Flash Player, a socket policy file is required - only if you want to connect to a port number below 1024, - or if you want to connect to a host other than the one serving the SWF file. -
-
-Events - - - - - - - - - - - - - - - - -
connect:Event — Dispatched when a network connection has been established.
 
ioError:IOErrorEvent — Dispatched when an input/output error - occurs that causes the connection to fail.
 
securityError:SecurityErrorEvent — This error occurs in SWF content. - Dispatched if a call to Socket.connect() attempts - to connect either to a server that doesn't serve a socket policy file, - or to a server whose policy file doesn't grant the calling host access to the specified port. - For more information on policy files, see "Website controls (policy files)" in - the ActionScript 3.0 Developer's Guide and the Flash Player Developer Center Topic: - Security.
-
-Throws - - - - -
SecurityError — This error occurs in SWF content. - for the following reasons: -
    -
  • Local-with-filesystem files cannot communicate with the Internet. You can - work around this problem by reclassifying this SWF file as local-with-networking or trusted. - This limitation is not set for AIR application content in the application security sandbox.
    • -
  • You cannot specify a socket port higher than 65535.
    • -
-
-
- -
Method detail
- - - - - -
close()method
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Closes the socket. You cannot read or write any data after the close() method - has been called. -

The close event is dispatched only when the server - closes the connection; it is not dispatched when you call the close() method.

-

You can reuse the Socket object by calling the connect() method on it again.

-
-Throws - - - - -
Error — The socket could not be closed, or the socket was not open. - -
-
- - - - - -
connect()method 
-
-public function connect(host:String, port:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Connects the socket to the specified host and port. - -

If the connection fails immediately, either an event is dispatched - or an exception is thrown: an error event is dispatched if a host was - specified, and an exception is thrown if no host was specified. - Otherwise, the status of the connection is reported by an event. - If the socket is already connected, the existing connection is closed first.

- Parameters - - - - - - - - - - -
host:String — The name or IP address of the host to connect to. If no host is specified, - the host that is contacted is the host where the calling file - resides. If you do not specify a host, use an event listener to - determine whether the connection was successful. -
 
port:int — The port number to connect to. -
-
-Events - - - - - - - - - - - - - - - - -
connect:Event — Dispatched when a network connection has been - established.
 
ioError:IOErrorEvent — Dispatched if a host is specified and an - input/output error occurs that causes the connection to fail.
 
securityError:SecurityErrorEvent — Dispatched if a call to - Socket.connect() attempts to connect - either to a server that doesn't serve a socket policy file, - or to a server whose policy file doesn't grant the calling host access to the specified port. - For more information on policy files, see "Website controls (policy files)" in - the ActionScript 3.0 Developer's Guide and the Flash Player Developer Center Topic: - Security.
-
-Throws - - - - - - - - - - -
Error — No host was specified and the connection failed. -
 
SecurityError — This error occurs in SWF content. - for the following reasons: -
    -
  • Local untrusted SWF files may not communicate with - the Internet. You can work around this limitation by reclassifying the - file as local-with-networking or as trusted.
    • -
  • You cannot specify a socket port higher than 65535.
    • -
  • In the HTML page that contains the SWF content, the - allowNetworking parameter of the object - and embed tags is set to "none".
    • -
-
-
- - - - - -
flush()method 
-
-public function flush():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Flushes any accumulated data in the socket's output buffer. -

On some operating systems, flush() is called automatically between execution frames, but on other operating systems, such - as Windows, the data is never sent unless you call flush() explicitly. To ensure your application behaves reliably - across all operating systems, it is a good practice to call the flush() method after writing each message - (or related group of data) to the socket.

- -
-Throws - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readBoolean()method 
-
-public function readBoolean():Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a Boolean value from the socket. After reading a single byte, the - method returns true if the byte is nonzero, and - false otherwise. -

-Returns - - - - -
Boolean — - A value of true if the byte read is nonzero, - otherwise false. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readByte()method 
-
-public function readByte():int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a signed byte from the socket. -

-Returns - - - - -
int — - A value from -128 to 127. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readBytes()method 
-
-public function readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads the number of data bytes specified by the length - parameter from the socket. The bytes are read into the specified byte - array, starting at the position indicated by offset. -

Parameters - - - - - - - - - - - - - - - - -
bytes:ByteArray — The ByteArray object to read data into. -
 
offset:uint (default = 0) — The offset at which data reading should begin in the byte - array. -
 
length:uint (default = 0) — The number of bytes to read. The default value of 0 causes - all available data to be read. -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is - not open. - -
-
- - - - - -
readDouble()method 
-
-public function readDouble():Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an IEEE 754 double-precision floating-point number from the socket. -

-Returns - - - - -
Number — - An IEEE 754 double-precision floating-point number. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readFloat()method 
-
-public function readFloat():Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an IEEE 754 single-precision floating-point number from the socket. -

-Returns - - - - -
Number — - An IEEE 754 single-precision floating-point number. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readInt()method 
-
-public function readInt():int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a signed 32-bit integer from the socket. -

-Returns - - - - -
int — - A value from -2147483648 to 2147483647. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readMultiByte()method 
-
-public function readMultiByte(length:uint, charSet:String):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a multibyte string from the byte stream, using the specified character set. -

Parameters - - - - - - - - - - -
length:uint — The number of bytes from the byte stream to read. -
 
charSet:String — The string denoting the character set to use to interpret the bytes. - Possible character set strings include "shift_jis", "CN-GB", and - "iso-8859-1". - For a complete list, see Supported Character Sets. -

Note: If the value for the charSet parameter is not recognized - by the current system, then the application uses the system's default code page as the character set. - For example, a value for the charSet parameter, as in myTest.readMultiByte(22, "iso-8859-01") - that uses 01 instead of 1 might work on your development machine, but not on another machine. - On the other machine, the application will use the system's default code page.

-
-

-Returns - - - - -
String — - A UTF-8 encoded string. - - -
-
-Throws - - - - -
Error — There is insufficient data available to read. -
-
- - - - - -
readObject()method 
-
-public function readObject():* -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an object from the socket, encoded in AMF serialized format. -

-Returns - - - - -
* — The deserialized object -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-ObjectEncoding -
-flash.net.registerClassAlias() -
-
- - - - - -
readShort()method 
-
-public function readShort():int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a signed 16-bit integer from the socket. -

-Returns - - - - -
int — - A value from -32768 to 32767. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readUnsignedByte()method 
-
-public function readUnsignedByte():uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an unsigned byte from the socket. -

-Returns - - - - -
uint — - A value from 0 to 255. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readUnsignedInt()method 
-
-public function readUnsignedInt():uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an unsigned 32-bit integer from the socket. -

-Returns - - - - -
uint — - A value from 0 to 4294967295. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readUnsignedShort()method 
-
-public function readUnsignedShort():uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an unsigned 16-bit integer from the socket. -

-Returns - - - - -
uint — - A value from 0 to 65535. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readUTF()method 
-
-public function readUTF():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a UTF-8 string from the socket. The string is assumed to be prefixed - with an unsigned short integer that indicates the length in bytes. -

-Returns - - - - -
String — - A UTF-8 string. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
readUTFBytes()method 
-
-public function readUTFBytes(length:uint):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads the number of UTF-8 data bytes specified by the length - parameter from the socket, and returns a string. -

Parameters - - - - -
length:uint — The number of bytes to read. -
-

-Returns - - - - -
String — - A UTF-8 string. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available to read. -
 
Error — An I/O error occurred on the socket, or the socket is not open. - -
-
- - - - - -
writeBoolean()method 
-
-public function writeBoolean(value:Boolean):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes a Boolean value to the socket. This method writes a single byte, - with either a value of 1 (true) or 0 (false). -

Parameters - - - - -
value:Boolean — The value to write to the socket: 1 (true) or 0 (false). -
-
-Throws - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-flush() -
-
- - - - - -
writeByte()method 
-
-public function writeByte(value:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes a byte to the socket. -

Parameters - - - - -
value:int — The value to write to the socket. The low 8 bits of the - value are used; the high 24 bits are ignored. -
-
-Throws - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-flush() -
-
- - - - - -
writeBytes()method 
-
-public function writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes a sequence of bytes from the specified byte array. The write - operation starts at the position specified by offset. -

If you omit the length parameter the default - length of 0 causes the method to write the entire buffer starting at - offset.

-

If you also omit the offset parameter, the entire buffer is written.

- Parameters - - - - - - - - - - - - - - - - -
bytes:ByteArray — The ByteArray object to write data from. -
 
offset:uint (default = 0) — The zero-based offset into the bytes ByteArray - object at which data writing should begin. -
 
length:uint (default = 0) — The number of bytes to write. The default value of 0 causes - the entire buffer to be written, starting at the value specified by - the offset parameter. -
-
-Throws - - - - - - - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. -
 
RangeError — If offset is greater than the length of the ByteArray specified in - bytes or if the amount of data specified to be written by offset plus - length exceeds the data available. -
-

-See also -

-
-flush() -
-
- - - - - -
writeDouble()method 
-
-public function writeDouble(value:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes an IEEE 754 double-precision floating-point number to the socket. -

Parameters - - - - -
value:Number — The value to write to the socket. -
-
-Throws - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-flush() -
-
- - - - - -
writeFloat()method 
-
-public function writeFloat(value:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes an IEEE 754 single-precision floating-point number to the socket. -

Parameters - - - - -
value:Number — The value to write to the socket. -
-
-Throws - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-flush() -
-
- - - - - -
writeInt()method 
-
-public function writeInt(value:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes a 32-bit signed integer to the socket. -

Parameters - - - - -
value:int — The value to write to the socket. -
-
-Throws - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-flush() -
-
- - - - - -
writeMultiByte()method 
-
-public function writeMultiByte(value:String, charSet:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes a multibyte string from the byte stream, using the specified character set. -

Parameters - - - - - - - - - - -
value:String — The string value to be written. -
 
charSet:String — The string denoting the character set to use to interpret the bytes. - Possible character set strings include "shift_jis", "CN-GB", - and "iso-8859-1". For a complete list, see - Supported Character Sets. -
-

-See also -

-
-flush() -
-
- - - - - -
writeObject()method 
-
-public function writeObject(object:*):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Write an object to the socket in AMF serialized format. -

Parameters - - - - -
object:* — The object to be serialized. -
-
-Throws - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-flush() -
-ObjectEncoding -
-flash.net.registerClassAlias() -
-
- - - - - -
writeShort()method 
-
-public function writeShort(value:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes a 16-bit integer to the socket. The bytes written are as follows: - 

(v >> 8) & 0xff v & 0xff
-

The low 16 bits of the parameter are used; the high 16 bits - are ignored.

- Parameters - - - - -
value:int — The value to write to the socket. -
-
-Throws - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-flush() -
-
- - - - - -
writeUnsignedInt()method 
-
-public function writeUnsignedInt(value:uint):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes a 32-bit unsigned integer to the socket. -

Parameters - - - - -
value:uint — The value to write to the socket. -
-
-Throws - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-flush() -
-
- - - - - -
writeUTF()method 
-
-public function writeUTF(value:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes the following data to the socket: a 16-bit unsigned integer, which - indicates the length of the specified UTF-8 string in bytes, followed by - the string itself. -

Before writing the string, the method calculates the number of bytes - that are needed to represent all characters of the string.

- Parameters - - - - -
value:String — The string to write to the socket. -
-
-Throws - - - - - - - - - - -
RangeError — The length is larger than 65535. -
 
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-flush() -
-
- - - - - -
writeUTFBytes()method 
-
-public function writeUTFBytes(value:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Writes a UTF-8 string to the socket. -

Parameters - - - - -
value:String — The string to write to the socket. -
-
-Throws - - - - -
Error — An I/O error occurred on the socket, or the socket is not open. -
-

-See also -

-
-flush() -
-
-
Event detail
- - - - - -
closeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLOSE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when the server closes the socket connection. -

The close event is dispatched only when the server - closes the connection; it is not dispatched when you call the Socket.close() method.

-

- The Event.CLOSE constant defines the value of the type property of a close event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection has been closed.
- -
- - - - - -
connectevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CONNECT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when a network connection has been established. -

- The Event.CONNECT constant defines the value of the type property of a connect event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Socket or XMLSocket object that has established a network connection.
- -
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when an input/output error occurs that causes a send or load operation to fail. -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -
- - - - - -
outputProgressevent  
-
-Event object type: flash.events.OutputProgressEvent -
-

- Dispatched when a socket moves data from its write buffer to the networking transport layer -

- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched if a call to Socket.connect() attempts to connect to a server - prohibited by the caller's security sandbox or to a port lower than 1024 and no socket policy file - exists to permit such a connection. -

Note: In an AIR application, content running in the application security sandbox is permitted to - connect to any server and port number without a socket policy file.

-

- The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- -

-See also -

-
-Socket.connect() -
-
- - - - - -
socketDataevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.SOCKET_DATA -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when a socket has received data. -

The data received by the socket remains in the socket until it is read. You do not have to read - all the available data during the handler for this event.

- -

Events of type socketData do not use the ProgressEvent.bytesTotal - property.

-

- Defines the value of the type property of a socketData event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event.
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotal0; this property is not used by socketData event objects.
targetThe socket reporting progress.
- -
- -
Examples
-
examples\SocketExample
-
The following example reads from and writes to a socket and outputs information - transmitted during socket events. Highlights of the example follow: -
    -
  1. The constructor creates a CustomSocket instance named socket and passes the - host name localhost and port 80 as arguments. Since CustomSocket extends - Socket, a call to super() calls Socket's constructor.
    2. -
  2. The example then calls the configureListeners() method, which adds listeners for - Socket events.
    3. -
  3. Finally, the socket connect() method is called with localhost as the - host name and 80 as the port number.
    4. -
- -

Note: To run the example, you need a server running on the same domain - where the SWF resides (in the example, localhost) and listening on port 80.

-
-
-
-package {
-	import flash.display.Sprite;
-
-	public class SocketExample extends Sprite {
-		private var socket:CustomSocket;
-		
-		public function SocketExample() {
-			socket = new CustomSocket("localhost", 80);
-		}
-	}
-}
-
-import flash.errors.*;
-import flash.events.*;
-import flash.net.Socket;
-
-class CustomSocket extends Socket {
-	private var response:String;
-
-	public function CustomSocket(host:String = null, port:uint = 0) {
-		super();
-		configureListeners();
-		if (host && port)  {
-			super.connect(host, port);
-		}
-	}
-
-	private function configureListeners():void {
-		addEventListener(Event.CLOSE, closeHandler);
-		addEventListener(Event.CONNECT, connectHandler);
-		addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-		addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-		addEventListener(ProgressEvent.SOCKET_DATA, socketDataHandler);
-	}
-
-	private function writeln(str:String):void {
-		str += "\n";
-		try {
-			writeUTFBytes(str);
-		}
-		catch(e:IOError) {
-			trace(e);
-		}
-	}
-
-	private function sendRequest():void {
-		trace("sendRequest");
-		response = "";
-		writeln("GET /");
-		flush();
-	}
-
-	private function readResponse():void {
-		var str:String = readUTFBytes(bytesAvailable);
-		response += str;
-	}
-
-	private function closeHandler(event:Event):void {
-		trace("closeHandler: " + event);
-		trace(response.toString());
-	}
-
-	private function connectHandler(event:Event):void {
-		trace("connectHandler: " + event);
-		sendRequest();
-	}
-
-	private function ioErrorHandler(event:IOErrorEvent):void {
-		trace("ioErrorHandler: " + event);
-	}
-
-	private function securityErrorHandler(event:SecurityErrorEvent):void {
-		trace("securityErrorHandler: " + event);
-	}
-
-	private function socketDataHandler(event:ProgressEvent):void {
-		trace("socketDataHandler: " + event);
-		readResponse();
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/URLLoader.html b/html-docs/flash/net/URLLoader.html deleted file mode 100644 index c2a0ec0..0000000 --- a/html-docs/flash/net/URLLoader.html +++ /dev/null @@ -1,1575 +0,0 @@ - - - - - - - - -flash.net.URLLoader (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class URLLoader
InheritanceURLLoader Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The URLLoader class downloads data from a URL - as text, binary data, or URL-encoded variables. It is useful for downloading - text files, XML, or other information to be used in a - dynamic, data-driven application. -

A URLLoader object downloads all of the data from a URL before - making it available to code in the applications. It sends out - notifications about the progress of the download, which you can monitor - through the bytesLoaded and bytesTotal properties, - as well as through dispatched events.

-

When loading very large video files, such as FLV's, out-of-memory errors may occur. -

- -

When you use this class in Flash Player and in - AIR application content in security sandboxes other than then application security sandbox, - consider the following security model:

-
    -
  • A SWF file in the local-with-filesystem sandbox may not load data from, - or provide data to, a resource that is in the network sandbox.
    • -
  • By default, the calling SWF file and the URL you load must be in exactly the same domain. - For example, a SWF file at www.adobe.com can load data only from sources that are also at www.adobe.com. - To load data from a different domain, place a URL policy file on the server hosting the data.
    • -
-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

-

-View the examples. -

-

-See also -

-
-URLRequest -
-URLVariables -
-URLStream -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bytesLoaded : uint = 0
- Indicates the number of bytes that have been loaded thus far - during the load operation.
-		URLLoader
  bytesTotal : uint = 0
- Indicates the total number of bytes in the downloaded data.
-		URLLoader
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  data : * -
- The data received from the load operation.
-		URLLoader
  dataFormat : String = "text"
- Controls whether the downloaded data is received as - text (URLLoaderDataFormat.TEXT), raw binary data - (URLLoaderDataFormat.BINARY), or URL-encoded variables - (URLLoaderDataFormat.VARIABLES).
-		URLLoader
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-URLLoader(request:URLRequest = null)
-
- Creates a URLLoader object.
-		URLLoader
   -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		URLLoader
   -
-close():void -
-
- Closes the load operation in progress.
-		URLLoader
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-load(request:URLRequest):void -
-
- Sends and loads data from the specified URL.
-		URLLoader
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-certificateError -
-		 - Dispatched if a call to URLLoader.load() - attempts to load data from a server with an invalid certificate - (for example, self-signed or untrusted, or with an invalid date).URLLoader
   -
-complete -
-		 - Dispatched after all the received data is decoded and - placed in the data property of the URLLoader object.URLLoader
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-httpResponseStatus -
-		 - Dispatched if a call to the load() method attempts to access data over HTTP, - and Adobe AIR is able to detect and return the status code for the request.URLLoader
   -
-httpStatus -
-		 - Dispatched if a call to URLLoader.load() - attempts to access data over HTTP.URLLoader
   -
-ioError -
-		 - Dispatched if a call to URLLoader.load() - results in a fatal error that terminates the download.URLLoader
   -
-open -
-		 - Dispatched when the download operation commences following - a call to the URLLoader.load() method.URLLoader
   -
-progress -
-		 - Dispatched when data is received as the download operation progresses.URLLoader
   -
-securityError -
-		 - Dispatched if a call to URLLoader.load() - attempts to load data from a server outside the security sandbox.URLLoader
-
- -
- -
Property detail
- - - - - -
bytesLoadedproperty
-
-public var bytesLoaded:uint = 0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the number of bytes that have been loaded thus far - during the load operation. -

- - - - - -
bytesTotalproperty 
-
-public var bytesTotal:uint = 0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the total number of bytes in the downloaded data. - This property contains 0 while the load operation is in progress - and is populated when the operation is complete. - Also, a missing Content-Length header will result in bytesTotal being indeterminate. -

- - - - - -
dataproperty 
-
-public var data:* -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The data received from the load operation. This property - is populated only when the load operation is complete. - The format of the data depends on the setting of the - dataFormat property: -

If the dataFormat property is URLLoaderDataFormat.TEXT, - the received data is a string containing the text of the loaded file.

-

If the dataFormat property is URLLoaderDataFormat.BINARY, - the received data is a ByteArray object containing the raw binary data.

-

If the dataFormat property is URLLoaderDataFormat.VARIABLES, - the received data is a URLVariables object containing the URL-encoded variables.

-

-See also -

-
-URLLoaderDataFormat -
-URLLoader.dataFormat -
-
-Example -
The following example shows how you can load an external text file with URL encoded variables into an ActionScript 3.0 document using the URLLoader class and setting the dataFormat property to the URLLoaderDataFormat.VARIABLES constant ("variables"). - Example provided by - ActionScriptExamples.com. -
-
-//params.txt is a local file that includes: firstName=Tom&lastName=Jones
-var lbl:TextField = new TextField();
-var urlRequest:URLRequest = new URLRequest("params.txt");
-var urlLoader:URLLoader = new URLLoader();
-urlLoader.dataFormat = URLLoaderDataFormat.VARIABLES;
-urlLoader.addEventListener(Event.COMPLETE, urlLoader_complete);
-urlLoader.load(urlRequest);
- 
-function urlLoader_complete(evt:Event):void {
-    lbl.text = urlLoader.data.lastName + "," + urlLoader.data.firstName;
-    addChild(lbl);
-}
-
-

-
- - - - - -
dataFormatproperty 
-
-public var dataFormat:String = "text" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Controls whether the downloaded data is received as - text (URLLoaderDataFormat.TEXT), raw binary data - (URLLoaderDataFormat.BINARY), or URL-encoded variables - (URLLoaderDataFormat.VARIABLES). -

If the value of the dataFormat property is URLLoaderDataFormat.TEXT, - the received data is a string containing the text of the loaded file.

-

If the value of the dataFormat property is URLLoaderDataFormat.BINARY, - the received data is a ByteArray object containing the raw binary data.

-

If the value of the dataFormat property is URLLoaderDataFormat.VARIABLES, - the received data is a URLVariables object containing the URL-encoded variables.

-

The default value is URLLoaderDataFormat.TEXT.

-

-See also -

-
-URLLoaderDataFormat -
-
-Example -
The following example shows how you can load external text files. Use the URLRequest and URLLoader classes, and then listen for the complete event. - Example provided by - ActionScriptExamples.com. -
-
-var PATH:String = "lorem.txt";
-var urlRequest:URLRequest = new URLRequest(PATH);
-var urlLoader:URLLoader = new URLLoader();
-urlLoader.dataFormat = URLLoaderDataFormat.TEXT; // default
-urlLoader.addEventListener(Event.COMPLETE, urlLoader_complete);
-urlLoader.load(urlRequest);
- 
-function urlLoader_complete(evt:Event):void {
-    textArea.text = urlLoader.data;
-}
-
-

-
- -
Constructor detail
- - - - - -
URLLoader()constructor
-
-public function URLLoader(request:URLRequest = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a URLLoader object. -

Parameters - - - - -
request:URLRequest (default = null) — A URLRequest object specifying - the URL to download. If this parameter is omitted, - no load operation begins. If - specified, the load operation begins - immediately (see the load entry for more information). -
-

-See also -

-
-URLLoader.load() -
-
- -
Method detail
- - - - - -
addEventListener()method
-
-public override function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event. You can register event listeners on all nodes in the - display list for a specific type of event, phase, and priority. - -

JavaScript code in the AIR runtime uses this method to register - event listeners for events defined by the AIR APIs. For other JavaScript events (such as the onload - event of the DOM body object), you can use standard event handling techniques, as you would - for content running in the browser.

- -

After you successfully register an event listener, you cannot change its priority - through additional calls to addEventListener(). To change a listener's - priority, you must first call removeListener(). Then you can register the - listener again with the new priority level.

- -

Keep in mind that after the listener is registered, subsequent calls to - addEventListener() with a different type or - useCapture value result in the creation of a separate listener registration. - For example, if you first register a listener with useCapture set to - true, it listens only during the capture phase. If you call - addEventListener() again using the same listener object, but with - useCapture set to false, you have two separate listeners: one - that listens during the capture phase and another that listens during the target and - bubbling phases. -

- -

You cannot register an event listener for only the target phase or the bubbling - phase. Those phases are coupled during registration because bubbling - applies only to the ancestors of the target node.

- -

If you no longer need an event listener, remove it by calling - removeEventListener(), or memory problems could result. Event listeners are not automatically - removed from memory because the garbage - collector does not remove the listener as long as the dispatching object exists (unless the useWeakReference - parameter is set to true).

- -

Copying an EventDispatcher instance does not copy the event listeners attached to it. - (If your newly created node needs an event listener, you must attach the listener after - creating the node.) However, if you move an EventDispatcher instance, the event listeners - attached to it move along with it.

- - -

If the event listener is being registered on a node while an event is being processed - on this node, the event listener is not triggered during the current phase but can be - triggered during a later phase in the event flow, such as the bubbling phase.

- -

If an event listener is removed from a node while an event is being processed on the node, - it is still triggered by the current actions. After it is removed, the event listener is - never invoked again (unless registered again for future processing).

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener function that processes the event. This function must accept - an Event object as its only parameter and must return nothing, as this example shows: - . - - 
function(evt:Event):void
- -

The function can have any name.

- -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Determines whether the listener works in the capture phase or the - target and bubbling phases. If useCapture is set to true, - the listener processes the event only during the capture phase and not in the - target or bubbling phase. If useCapture is false, the - listener processes the event only during the target or bubbling phase. To listen for - the event in all three phases, call addEventListener twice, once with - useCapture set to true, then again with - useCapture set to false. - -
 
priority:int (default = 0) — The priority level of the event listener. The priority is designated by - a signed 32-bit integer. The higher the number, the higher the priority. All listeners - with priority n are processed before listeners of priority n-1. If two - or more listeners share the same priority, they are processed in the order in which they - were added. The default priority is 0. - -
 
useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or - weak. A strong reference (the default) prevents your listener from being garbage-collected. - A weak reference does not.

Class-level member functions are not subject to garbage - collection, so you can set useWeakReference to true for - class-level member functions without subjecting them to garbage collection. If you set - useWeakReference to true for a listener that is a nested inner - function, the function will be garbage-collected and no longer persistent. If you create - references to the inner function (save it in another variable) then it is not - garbage-collected and stays persistent.

-
-
- - - - - -
close()method 
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Closes the load operation in progress. Any load - operation in progress is immediately terminated. - If no URL is currently being streamed, an invalid stream error is thrown. -

- - - - - -
load()method 
-
-public function load(request:URLRequest):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sends and loads data from the specified URL. The data can be received as - text, raw binary data, or URL-encoded variables, depending on the - value you set for the dataFormat property. Note that - the default value of the dataFormat property is text. - If you want to send data to the specified URL, you can set the data - property in the URLRequest object. -

Note: If a file being loaded contains non-ASCII characters (as found - in many non-English languages), it is recommended that you save the - file with UTF-8 or UTF-16 encoding as opposed to a non-Unicode format - like ASCII.

-

A SWF file in the local-with-filesystem sandbox may not load data from, - or provide data to, a resource that is in the network sandbox.

-

By default, the calling SWF file and the URL you load must be in exactly the same domain. - For example, a SWF file at www.adobe.com can load data only from sources that are also at www.adobe.com. - To load data from a different domain, place a URL policy file on the server hosting the data.

-

You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.

-

In Flash Player 10 and later, if you use a multipart Content-Type (for example "multipart/form-data") - that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), - the POST operation is subject to the security rules applied to uploads:

-
    -
  • The POST operation must be performed in response to a user-initiated action, such as a mouse click or key press.
    • -
  • If the POST operation is cross-domain (the POST target is not on the same server as the SWF file - that is sending the POST request), - the target server must provide a URL policy file that permits cross-domain access.
    • -
-

Also, for any multipart Content-Type, the syntax must be valid (according to the RFC2046 standards). - If the syntax appears to be invalid, the POST operation is subject to the security rules applied to uploads.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- Parameters - - - - -
request:URLRequest — A URLRequest object specifying the URL to download. -
-
-Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
complete:Event — Dispatched after data has loaded successfully.
 
httpStatus:HTTPStatusEvent — If access is over HTTP, and the current - Flash Player environment supports obtaining status codes, you may - receive these events in addition to any complete - or error event.
 
ioError:IOErrorEvent — The load operation could not be - completed.
 
progress:ProgressEvent — Dispatched when data is received as the download - operation progresses.
 
securityError:SecurityErrorEvent — A load operation attempted - to retrieve data from a server outside the caller's security sandbox. - This may be worked around using a policy file on the server.
 
securityError:SecurityErrorEvent — A load operation attempted - to load a SWZ file (a Adobe platform component), but the certificate is invalid - or the digest does not match the component.
 
open:Event — Dispatched when a load operation commences.
 
httpResponseStatus:HTTPStatusEvent — Dispatched if a call to the load() - method attempts to access data over HTTP and Adobe AIR is able to detect and return the - status code for the request.
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — URLRequest.requestHeader objects may not - contain certain prohibited HTTP request headers. For more information, - see the URLRequestHeader class description. -
 
Error — This error can occur for the following reasons: - 1) Flash Player or AIR cannot - convert the URLRequest.data - parameter from UTF8 to MBCS. This error is applicable if the URLRequest object - passed to load() is set to perform a GET operation and - if System.useCodePage is set to true. - 2) Flash Player or AIR cannot - allocate memory for the POST data. This error is - - applicable if the URLRequest object passed to load is set - to perform a POST operation. -
 
SecurityError — Local untrusted files may not communicate with - the Internet. This may be worked around by reclassifying this file - as local-with-networking or trusted. -
 
SecurityError — You are trying to connect to a commonly reserved port. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide. -
 
TypeError — The value of the request parameter - or the URLRequest.url property of the URLRequest object passed are - null. -
-

-See also -

-
-URLRequestHeader -
-URLRequest.requestHeaders -
-URLRequest.data -
-URLRequest.digest -
-
-Example -
In the following example, an XML files is loaded and the content - of its elements' first arguments are displayed in a text field. - -

A URLRequest object is created to identify the location of the - XML file, which for this example is in the same directory as the SWF file. - The file is loaded in a try...catch block in order to catch any - error that may occur. (Here we catch the SecurityError errors.) - If an IO_ERROR event occurs, the errorHandler() method - is invoked, which writes an error message in the xmlTextField text field. - Once the XML file data is received and place in the data property of the loader - URLLoader object, the Event.COMPLETE event is dispatched and the - loaderCompleteHandler() method is invoked.

- -

In the loaderCompleteHandler() method, a try...catch - block is used to catch any parsing error that may occur while converting the loaded - data from the file into an XML object. The readNodes() method then - recursively goes through all the elements in the nodes of the XML document and - appends the xmlTextField text field with a list of the first attributes - of all the elements.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.Event;
-    import flash.net.URLLoader;
-    import flash.net.URLRequest;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.xml.*;
-    import flash.events.IOErrorEvent;
-  
-    public class URLLoader_loadExample extends Sprite {
-        private var xmlTextField:TextField = new TextField();
-        private var externalXML:XML;    
-        private var loader:URLLoader;
-
-        public function URLLoader_loadExample() {
-            var request:URLRequest = new URLRequest("xmlFile.xml");
-
-            loader = new URLLoader();
-            
-            try {
-                loader.load(request);
-            }
-            catch (error:SecurityError)
-            {
-                trace("A SecurityError has occurred.");
-            }
-
-             loader.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-            loader.addEventListener(Event.COMPLETE, loaderCompleteHandler);
-
-            xmlTextField.x = 10;
-            xmlTextField.y = 10;
-            xmlTextField.background = true;
-            xmlTextField.autoSize = TextFieldAutoSize.LEFT;
-
-            addChild(xmlTextField);
-        }
-
-        private function loaderCompleteHandler(event:Event):void {
-
-                try {
-                    externalXML = new XML(loader.data);
-                    readNodes(externalXML);    
-                } catch (e:TypeError) {
-                    trace("Could not parse the XML file.");
-                }
-        }
-
-        private function readNodes(node:XML):void {
-
-                for each (var element:XML in node.elements()) {
-                    xmlTextField.appendText(element.attributes()[0] + "\n");
-
-                    readNodes(element);
-                }    
-        }
-
-        private function errorHandler(e:IOErrorEvent):void {
-            xmlTextField.text = "Had problem loading the XML File.";
-        }
-    }
-}
-
-

-
-
Event detail
- - - - - -
certificateErrorevent 
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.CERTIFICATE_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51 -
-

- Dispatched if a call to URLLoader.load() - attempts to load data from a server with an invalid certificate - (for example, self-signed or untrusted, or with an invalid date). - If a listener is added, any operating system standard behaviour will - be ignored, instead the default action will be to close down the - connection. To allow the default connection, you can call the - preventDefault() function on the error object. -

- The SecurityErrorEvent.CERTIFICATE_ERROR constant is used when the runtime detects a problem with a server's security certificate. This event - is then dispatched, giving the application the chance to handle this and determine whether to allow the connection or to block it (which is the default - behaviour). To allow it, call preventDefault() on the error object. Note that not handling this error type will result in the default operating system - behaviour - typically, a message will be displayed to the end user to allow them to choose the action. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelabletrue; default behavior is to close the connection, use preventDefault() to allow it.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
-
- - - - - -
completeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched after all the received data is decoded and - placed in the data property of the URLLoader object. - The received data may be accessed once this event has been dispatched. -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -

-See also -

-
-URLLoader.load() -
-
- - - - - -
httpResponseStatusevent  
-
-Event object type: flash.events.HTTPStatusEvent -
-HTTPStatusEvent.type property = flash.events.HTTPStatusEvent.HTTP_RESPONSE_STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -AIR 1.0 -
-

- Dispatched if a call to the load() method attempts to access data over HTTP, - and Adobe AIR is able to detect and return the status code for the request. -

- Unlike the httpStatus event, the httpResponseStatus event is - delivered before any response data. Also, the httpResponseStatus event includes - values for the responseHeaders and responseURL properties (which are - undefined for an httpStatus event. Note that the httpResponseStatus event - (if any) will be sent before (and in addition to) any complete or error - event. - -

The HTTPStatusEvent.HTTP_RESPONSE_STATUS constant defines the value of the - type property of a httpResponseStatus event object.

- - -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
responseURLThe URL from which the response was returned.
responseHeadersThe response headers that the response returned, - as an array of URLRequestHeader objects.
statusThe HTTP status code returned by the server.
redirectedWhether the reponse is the result of a redierct.
targetThe network object receiving an HTTP status code.
- -

-See also -

-
-load() -
-
- - - - - -
httpStatusevent  
-
-Event object type: flash.events.HTTPStatusEvent -
-HTTPStatusEvent.type property = flash.events.HTTPStatusEvent.HTTP_STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched if a call to URLLoader.load() - attempts to access data over HTTP. For content running in - Flash Player, this event is only dispatched if the current Flash Player environment - is able to detect and return the status code for the request. (Some browser environments - may not be able to provide this information.) Note that the httpStatus event - (if any) is sent before (and in addition to) any complete - or error event. -

- The HTTPStatusEvent.HTTP_STATUS constant defines the value of the - type property of a httpStatus event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
statusThe HTTP status code returned by the server.
targetThe network object receiving an HTTP status code.
- -

-See also -

-
-URLLoader.load() -
-
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched if a call to URLLoader.load() - results in a fatal error that terminates the download. -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -

-See also -

-
-URLLoader.load() -
-
- - - - - -
openevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.OPEN -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when the download operation commences following - a call to the URLLoader.load() method. -

- The Event.OPEN constant defines the value of the type property of an open event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has opened a connection.
- -

-See also -

-
-URLLoader.load() -
-
- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when data is received as the download operation progresses. -

Note that with a URLLoader object, it is not possible to access the data until it has - been received completely. - So, the progress event only serves as a notification of how far the download has progressed. - To access the data before it's entirely downloaded, use a URLStream object.

-

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -

-See also -

-
-URLLoader.load() -
-
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched if a call to URLLoader.load() - attempts to load data from a server outside the security sandbox. - Also dispatched if a call to URLLoader.load() attempts - to load a SWZ file and the certificate is invalid or the digest string - does not match the component. -

- The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- -

-See also -

-
-URLLoader.load() -
-
- -
Examples
-
examples\URLLoaderExample
-
The following example loads and displays the - data found in a local text file. It also traces event handling information. - -

Note: To run this example, put a file named urlLoaderExample.txt - in the same directory as your SWF file. That file should only contain the following line of text:

- answer=42&question=unknown -

- -

The example code does the following:

-
    -
  1. The constructor function creates a URLLoader instance named loader and a URLRequest - instance named request, which contains the location and name of the file to be loaded.
    2. -
  2. The loader object is passed to the configureListeners() method, - which adds listeners for each of the supported URLLoader events.
    3. -
  3. The request object is then passed to loader.load(), which loads the text file.
    4. -
  4. When the URLLoader has finished loading the text file the Event.COMPLETE event fires, - triggering the completeHandler() method. The completeHandler() method creates a - URLVariables object from the text loaded from the file. The URLVariables object converts URL-encoded - name/value pairs into ActionScript properties to make it easier to manipulate the loaded data.
    5. -
-
-
-
-package {
-	import flash.display.Sprite;
-	import flash.events.*;
-	import flash.net.*;
-
-	public class URLLoaderExample extends Sprite {
-		
-		private loader:URLoader;
-	    public function URLLoaderExample() {
-	        loader = new URLLoader();
-	        configureListeners(loader);
-
-	        var request:URLRequest = new URLRequest("urlLoaderExample.txt");
-	        try {
-	            loader.load(request);
-	        } catch (error:Error) {
-	            trace("Unable to load requested document.");
-	        }
-	    }
-
-	    private function configureListeners(dispatcher:IEventDispatcher):void {
-	        dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-	        dispatcher.addEventListener(Event.OPEN, openHandler);
-	        dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-	        dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-	        dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
-	        dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-	    }
-
-	    private function completeHandler(event:Event):void {
-	        var loader:URLLoader = URLLoader(event.target);
-	        trace("completeHandler: " + loader.data);
-    
-	        var vars:URLVariables = new URLVariables(loader.data);
-	        trace("The answer is " + vars.answer);
-	    }
-
-	    private function openHandler(event:Event):void {
-	        trace("openHandler: " + event);
-	    }
-
-	    private function progressHandler(event:ProgressEvent):void {
-	        trace("progressHandler loaded:" + event.bytesLoaded + " total: " + event.bytesTotal);
-	    }
-
-	    private function securityErrorHandler(event:SecurityErrorEvent):void {
-	        trace("securityErrorHandler: " + event);
-	    }
-
-	    private function httpStatusHandler(event:HTTPStatusEvent):void {
-	        trace("httpStatusHandler: " + event);
-	    }
-
-	    private function ioErrorHandler(event:IOErrorEvent):void {
-	        trace("ioErrorHandler: " + event);
-	    }
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/URLLoaderDataFormat.html b/html-docs/flash/net/URLLoaderDataFormat.html deleted file mode 100644 index dd40b23..0000000 --- a/html-docs/flash/net/URLLoaderDataFormat.html +++ /dev/null @@ -1,414 +0,0 @@ - - - - - - - - -flash.net.URLLoaderDataFormat (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class URLLoaderDataFormat
InheritanceURLLoaderDataFormat Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The URLLoaderDataFormat class provides values that specify how downloaded data is received. - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  BINARY : String = "binary"
[static] - Specifies that downloaded data is received as raw binary data.
-		URLLoaderDataFormat
  TEXT : String = "text"
[static] - Specifies that downloaded data is received as text.
-		URLLoaderDataFormat
  VARIABLES : String = "variables"
[static] - Specifies that downloaded data is received as URL-encoded variables.
-		URLLoaderDataFormat
-
- -
- -
Constant detail
- - - - - -
BINARYconstant
-
-public static const BINARY:String = "binary" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies that downloaded data is received as raw binary data. -

- - - - - -
TEXTconstant 
-
-public static const TEXT:String = "text" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies that downloaded data is received as text. -

- - - - - -
VARIABLESconstant 
-
-public static const VARIABLES:String = "variables" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies that downloaded data is received as URL-encoded variables. -

- -
Examples
-
examples\URLLoaderDataFormatExample
-
The following example uses the URLLoaderDataFormatExample class to display - data format and status information for a file loaded at runtime. This is accomplished - using the following steps: -
    -
  1. The class constructor creates a URLLoader instance named loader and a URLRequest - instance named request, which is the location and name of the file to be loaded.
    2. -
  2. The loader object is passed to the configureListeners() method, which adds - listeners for each of the supported URLLoader events: -
      -
    • completeHandler(): listens for the complete event, which is dispatched - after TextFile.txt has successfully loaded.
      • -
    • openHandler(): listens for the open event, dispatched upon start of the - download (to the player) of TextFile.txt.
      • -
    • progressHandler(): listens for the progress events, dispatched when data - is received as the download operation progresses.
      • -
    • securityErrorHandler(): listens for securityError events, which would be - dispatched if the text file was accessed with the wrong local playback security setting.
      • -
    • httpStatusHandler(): listens for httpStatusHandler events, which will not be - dispatched in this case since TextFile.txt is local.
      • -
    • ioErrorHandler(): listens for ioError events, which would happen only - if there were a serious problem with the file, such as if it were missing.
      • -
    3. -
  3. The request object is then passed to the loader.load() method, which loads the text file - into memory using a DisplayObject object.
    4. -
- -

Notes: -

    -
  • You will need to compile the SWF file with "Local playback security" set to "Access local files only". -
    • -
  • This example requires that a file named TextFile.txt be placed in the same directory as your SWF file. - If you would like to see this example identify binary or URL-encoded data files, you will need to - provide the file in the proper data format and change TextFile.txt to the name and location of the new - file.
    • -
-

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.*;
-
-    public class URLLoaderDataFormatExample extends Sprite {
-        private var source:String = "TextFile.txt";
-        private var dataFormat:String = URLLoaderDataFormat.TEXT;
-        private var loader:URLLoader;
-    	
-        public function URLLoaderDataFormatExample () {
-            loader = new URLLoader();
-            loader.dataFormat = dataFormat;
-            configureListeners(loader);
-            var request:URLRequest = new URLRequest(source);
-            try {
-                loader.load(request);
-            } catch (error:Error) {
-                trace("Error loading requested document: " + source);
-            }
-        }
-
-        private function configureListeners(dispatcher:URLLoader):void {
-            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-            dispatcher.addEventListener(Event.OPEN, openHandler);
-            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
-            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-        }
-
-        private function completeHandler(event:Event):void {
-            var loader:URLLoader = URLLoader(event.target);
-            switch(loader.dataFormat) {
-                case URLLoaderDataFormat.TEXT :
-                    trace("completeHandler (text): " + loader.data);
-                    break;
-                case URLLoaderDataFormat.BINARY :
-                    trace("completeHandler (binary): " + loader.data);
-                    break;
-                case URLLoaderDataFormat.VARIABLES :
-                    trace("completeHandler (variables): " + loader.data);
-                    break;
-            }
-        }
-
-        private function httpStatusHandler(event:Event):void {
-            trace("httpStatusHandler: " + 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 loaded:" + event.bytesLoaded + " total: " + event.bytesTotal);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/URLRequest.html b/html-docs/flash/net/URLRequest.html deleted file mode 100644 index b64b5c7..0000000 --- a/html-docs/flash/net/URLRequest.html +++ /dev/null @@ -1,1451 +0,0 @@ - - - - - - - - -flash.net.URLRequest (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class URLRequest
InheritanceURLRequest Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The URLRequest class captures all of the information in a single HTTP request. URLRequest - objects are passed to the load() methods of the Loader, URLStream, - and URLLoader classes, and to other loading operations, to initiate URL downloads. - They are also passed to the upload() and download() methods - of the FileReference class. -

A SWF file in the local-with-filesystem sandbox may not load data from, - or provide data to, a resource that is in the network sandbox.

-

By default, the calling SWF file - and the URL you load must be in the same domain. For example, a SWF file - at www.adobe.com can load data only from sources that are also at www.adobe.com. - To load data from a different domain, place a URL policy file on the server - hosting the data.

-

However, in Adobe AIR, content in the application security sandbox (content - installed with the AIR application) is not restricted by these security limitations. - For content running in Adobe AIR, files in the application security sandbox - can access URLs using any of the following URL schemes:

- -

Files in the application security domain - — files installed with the AIR application — can access URLs using any of the - following URL schemes:

-
    -
  • http and https
    • -
  • file
    • -
  • app-storage
    • -
  • app
    • -
-

Content running in Adobe AIR that is not in the application security - sandbox observes the same restrictions as content running in the browser - (in Flash Player), and loading is - governed by the content's domain and any permissions granted in URL - policy files.

-

Note: App Transport Security was introduced by Apple in iOS9, which doesn’t allow unsecure connections between App and Web services. - Due to this change all the connections which are made to Unsecure web sites via Loader, URLLoader will discontinue and not work due to App Transport Security. - Please specify exceptions to the default behaviour by adding keys to the application descriptor of your app.

-

Please specify exceptions to the default behavior by adding keys to InfoAdditions tag of application descriptor of your app.

- 
-  <iPhone>
-  <InfoAdditions>
-                   <![CDATA[
-                          <key>NSAppTransportSecurity</key>
-                              <dict>
-                                        <key>NSExceptionDomains</key>
-                              <dict>
-                                       <key>www.example.com</key>
-                              <dict>
-                                     <!--Include to allow subdomains-->
-                                     <key>NSIncludesSubdomains</key>
-                                     <true/>
-                                     <!--Include to allow HTTP requests-->
-                                     <key>NSTemporaryExceptionAllowsInsecureHTTPLoads</key>
-                                     <true/>
-                                      <!--Include to specify minimum TLS version-->
-                                      <key>NSTemporaryExceptionMinimumTLSVersion</key>
-                                      <string>TLSv1.1</string>
-                              </dict>
-                              </dict>
-                              </dict>
-                  ]]>
-         </InfoAdditions>
-  </iPhone>
-
- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

-

-View the examples. -

-

-See also -

-
-FileReference -
-URLRequestHeader -
-URLRequestDefaults -
-URLLoader -
-URLStream -
-HTMLLoader class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  authenticate : Boolean -
- Specifies whether authentication requests should be handled (true - or not (false) for this request.
-		URLRequest
  cacheResponse : Boolean -
- Specifies whether successful response data should be cached for this request.
-		URLRequest
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  contentType : String -
- The MIME content type of the content in the the data property.
-		URLRequest
  data : Object -
- An object containing data to be transmitted with the URL request.
-		URLRequest
  digest : String -
- A string that uniquely identifies the signed Adobe platform component to be stored - to (or retrieved from) the Flash Player cache.
-		URLRequest
  followRedirects : Boolean -
- Specifies whether redirects are to be followed (true) - or not (false).
-		URLRequest
  idleTimeout : Number -
- Specifies the idle timeout value (in milliseconds) for this request.
-		URLRequest
  manageCookies : Boolean -
- Specifies whether the HTTP protocol stack should manage cookies for this - request.
-		URLRequest
  method : String -
- Controls the HTTP form submission method.
-		URLRequest
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  requestHeaders : Array -
- The array of HTTP request headers to be appended to the - HTTP request.
-		URLRequest
  url : String -
- The URL to be requested.
-		URLRequest
  useCache : Boolean -
- Specifies whether the local cache should be consulted before this URLRequest - fetches data.
-		URLRequest
  userAgent : String -
- Specifies the user-agent string to be used in the HTTP request.
-		URLRequest
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-URLRequest(url:String = null)
-
- Creates a URLRequest object.
-		URLRequest
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-useRedirectedURL(sourceRequest:URLRequest, wholeURL:Boolean = false, pattern:* = null, replace:String = null):void -
-
- - Allows substitution of a redirected URL from a source URLRequest for some portion of the URL - in a new URLRequest.
-		URLRequest
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
authenticateproperty
-
-authenticate:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether authentication requests should be handled (true - or not (false) for this request. If false, authentication - challenges return an HTTP error. -

The supported authentication methods are:

-
    -
  • Windows—HTTP Basic/Digest, Windows Integrated Authentication - (including NTLM and Kerberos), SSL Certificate Authentication.
    • -
  • Mac—HTTP Basic/Digest, NTLM, SSL Certificate Authentication.
    • -
-

Note:The FileReference.upload(), - FileReference.download(), and HTMLLoader.load() - methods do not support the URLRequest.authenticate property.

-

The default value is true.

-Implementation -
-    public function get authenticate():Boolean -
-    public function set authenticate(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. -
-

-See also -

-
-flash.net.URLRequestDefaults.authenticate -
-
- - - - - -
cacheResponseproperty 
-
-cacheResponse:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether successful response data should be cached for this request. - When set to true, the AIR application uses the operating system's - HTTP cache. -

Note:The HTMLLoader.load() method - does not support the URLRequest.cacheResponse property.

-

The default value is true.

-Implementation -
-    public function get cacheResponse():Boolean -
-    public function set cacheResponse(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. -
-

-See also -

-
-flash.net.URLRequestDefaults.cacheResponse -
-
- - - - - -
contentTypeproperty 
-
-contentType:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The MIME content type of the content in the the data property. -

The default value is application/x-www-form-urlencoded.

-

Note:The FileReference.upload(), - FileReference.download(), and HTMLLoader.load() methods do not - support the URLRequest.contentType property.

-

When sending a POST request, the values of the contentType - and data properties must correspond properly. The value of the contentType - property instructs servers on how to interpret the value of the data property.

-
    -
  • If the value of the data property is a URLVariables object, the value of - contentType must be application/x-www-form-urlencoded.
    • -
  • If the value of the data property is any other type, the value of contentType - should indicate the type of the POST data that will be sent (which is the binary or string data - contained in the value of the data property).
    • -
  • For FileReference.upload(), - the Content-Type of the request is set automatically to multipart/form-data, - and the value of the contentType property is ignored.
    • -
-

In Flash Player 10 and later, if you use a multipart Content-Type (for example "multipart/form-data") - that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), - the POST operation is subject to the security rules applied to uploads:

-
    -
  • The POST operation must be performed in response to a user-initiated action, such as a mouse click or key press.
    • -
  • If the POST operation is cross-domain (the POST target is not on the same server as the SWF file - that is sending the POST request), - the target server must provide a URL policy file that permits cross-domain access.
    • -
-

Also, for any multipart Content-Type, the syntax must be valid (according to the RFC2046 standards). - If the syntax appears to be invalid, the POST operation is subject to the security rules applied to uploads.

- Implementation -
-    public function get contentType():String -
-    public function set contentType(value:String):void -
-

-See also -

-
-data -
-
- - - - - -
dataproperty 
-
-data:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An object containing data to be transmitted with the URL request. -

This property is used in conjunction with the method property. - When the value of method is GET, - the value of data is appended to the value of URLRequest.url, - using HTTP query-string syntax. When the method value is POST - (or any value other than GET), the value - of data is transmitted in the body of the HTTP request.

-

The URLRequest API offers binary POST support and support for URL-encoded variables, - as well as support for strings. The data object can be a ByteArray, URLVariables, - or String object.

-

The way in which the data is used depends on the type of object used:

-
    -
  • If the object is a ByteArray object, the binary - data of the ByteArray object is used as POST data. For GET, data of ByteArray type - is not supported. Also, data of ByteArray type is not supported for - FileReference.upload() and FileReference.download().
    • -
  • If the object is a URLVariables object and the method is POST, - the variables are encoded using x-www-form-urlencoded format - and the resulting string is used as POST data. An exception is a call to - FileReference.upload(), in which the variables are sent as separate fields in - a multipart/form-data post.
    • -
  • If the object is a URLVariables object and the method is GET, - the URLVariables object defines variables to be sent with the URLRequest object.
    • -
  • Otherwise, the object is converted to a string, and the string - is used as the POST or GET data.
    • -
-

This data is not sent until a method, such as navigateToURL() - or FileReference.upload(), uses the URLRequest object.

-

Note: The value of contentType must correspond to the type of data - in the data property. See the note in the description of the - contentType property.

- Implementation -
-    public function get data():Object -
-    public function set data(value:Object):void -
-

-See also -

-
-URLRequest.method -
-URLRequestMethod -
-URLVariables -
-flash.utils.ByteArray -
-contentType -
-
-Example -
The following example opens the remote application hosted at - http://www.[yourDomain].com/application.jsp in a new browser window and passes - data about a user session, captured in a URLVariables object, to the application. - - -

Highlights of the example follow:

-
    -
  1. The constructor function creates a URLRequest - instance named request, taking the URL of the remote application as a parameter.
    2. -
  2. A URLVariables object is created and two of its properties are assigned values.
    3. -
  3. The URLVariables object is assigned to the data property of the URLRequest object.
    4. -
  4. The example calls navigateToURL, which opens a new browser window - to the remote application's URL.
    5. -
- -

Note: To run the example, the remote application URL in the example must be replaced - with a working URL. Additionally, you would need server code - to process the information captured by Flash Player in the URLVariables object.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.net.navigateToURL;
-    import flash.net.URLRequest;
-    import flash.net.URLVariables;
-
-    public class URLVariablesExample extends Sprite {
-
-        public function URLVariablesExample() {
-            var url:String = "http://www.[yourDomain].com/application.jsp";
-            var request:URLRequest = new URLRequest(url);
-            var variables:URLVariables = new URLVariables();
-            variables.exampleSessionId = new Date().getTime();
-            variables.exampleUserLabel = "guest";
-            request.data = variables;
-            navigateToURL(request);
-        }
-    }
-}
-
-

-
- - - - - -
digestproperty 
-
-digest:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A string that uniquely identifies the signed Adobe platform component to be stored - to (or retrieved from) the Flash Player cache. An Adobe - platform component is a signed file (a SWZ file) that contains SWF content that is cached - persistently on a user's machine. All SWZ files are signed by Adobe. A digest - corresponds to a single cached file; if you change the file in any way, its digest - will change in an unpredictable way. By using a digest, you can verify the cached file across - multiple domains. Two files with the same digest are the same file, and two files with different - digests are not the same file. A file cannot (practically) be created to "spoof" a digest and - pretend to be another digest. This property applies to - SWF content only; it does not apply to JavaScript code running in AIR. -

The digest is based on an SHA-256 message digest algorithm - (64 characters long in hexadecimal format).

-

For example, the Flex SDK includes a SWZ for the Flex framework (and it - provides the digest string for that SWZ file). You can post this SWZ on your web server and load it - in your SWF file (using the load() method of a URLLoader object). If the end user's - machine already has the matching SWZ file cached, the application uses the cached SWZ file. - (A SWZ file matches if its digest matches the one you provide.) Otherwise, the - application downloads the SWZ file from the URL you specify.

-

Only set the digest parameter in a URLRequest object - used in a call to the URLLoader.load() method to load a SWZ file. If the digest - property of a a URLRequest object is set when it is used in other methods, the application throws an - IOError exception.

-

Implementation -
-    public function get digest():String -
-    public function set digest(value:String):void -
-
-Throws -
- - - - -
ArgumentError — The digest provided does not match the digest of the file that is - extracted from the downloaded signed file or the signed file loaded out of the cache. The - application also throws this error if the provided digest is the wrong length or contains invalid - (nonhexadecimal) characters. -
-
-Example -
The following example loads a remote file into the cache. At the end of the load, the byte array - contains the actual file (not the signed file). The example completes the load operation by calling loadBytes(): -
-
- 
-var myURLReq:URLRequest = new URLRequest();
-myURLReq.url = "http://yourdomain/users/jdoe/test01/_rsc/Automated/AssetCaching_rsc/test01/rsl.swz";
-myURLReq.digest = "3B0AA28C7A990385E044D80F5637FB036317BB41E044D80F5637FB036317BB41";
-var myURLLoader:URLLoader = new URLLoader();
-myURLLoader.dataFormat = URLLoaderDataFormat.BINARY;
-myURLLoader.addEventListener("complete", onC);
-
-myURLLoad.load(myURLReq);
-
-function onC(e) {
-    var someLoader:Loader = new Loader();
-    addChild(someLoader);
-    someLoader.loadBytes((ByteArray)(myURLLoad.data)); 
-}
-
-

-
- - - - - -
followRedirectsproperty 
-
-followRedirects:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether redirects are to be followed (true) - or not (false). -

Note:The FileReference.upload(), - FileReference.download(), and HTMLLoader.load() methods do not - support the URLRequest.followRedirects property.

-

The default value is true.

-Implementation -
-    public function get followRedirects():Boolean -
-    public function set followRedirects(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. -
-

-See also -

-
-URLRequestDefaults.followRedirects -
-
- - - - - -
idleTimeoutproperty 
-
-idleTimeout:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the idle timeout value (in milliseconds) for this request. -

The idle timeout is the amount of time the client waits for a response from the server, after the connection is established, - before abandoning the request.

-

Note: The HTMLLoader.load() method - does not support the URLRequest.idleTimeout property. - The HTMLLoader class defines its own idleTimeout property.

-

The default value is initialized from the URLRequestDefaults.idleTimeout property.

-Implementation -
-    public function get idleTimeout():Number -
-    public function set idleTimeout(value:Number):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. -
-

-See also -

-
-URLRequestDefaults.idleTimeout -
-
- - - - - -
manageCookiesproperty 
-
-manageCookies:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether the HTTP protocol stack should manage cookies for this - request. When true, cookies are added to the request - and response cookies are remembered. If false, cookies are - not added to the request and response cookies are not - remembered, but users can manage cookies themselves by direct header - manipulation. - - Note: On Windows, you cannot add cookies to a URL request manually - when manageCookies is set to true. On other operating systems, - adding cookies to a request is permitted irrespective of whether manageCookies - is set to true or false. When permitted, you can add cookies - to a request manually by adding a URLRequestHeader object containing the - cookie data to the requestHeaders array. - -

On Mac OS, cookies are shared with Safari. To clear cookies on Mac OS:

-
    -
  1. Open Safari.
    2. -
  2. Select Safari > Preferences, and click the Security panel.
    3. -
  3. Click the Show Cookies button.
    4. -
  4. Click the Reomove All button.
    5. -
-

To clear cookies on Windows:

-
    -
  1. Open the Internet Properties control panel, and click the General tab.
    2. -
  2. Click the Delete Cookies button.
    3. -
-

The default value is true.

-Implementation -
-    public function get manageCookies():Boolean -
-    public function set manageCookies(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. -
-

-See also -

-
-flash.net.URLRequestDefaults.manageCookies -
-
- - - - - -
methodproperty 
-
-method:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Controls the HTTP form submission method. -

For SWF content running in Flash Player - (in the browser), this property is limited to GET or - POST operations, and valid values are URLRequestMethod.GET - or URLRequestMethod.POST.

-

For content running in Adobe AIR, you - You can use any string value - if the content is in the application security sandbox. Otherwise, - as with content running in Flash Player, - you are restricted to using GET or POST operations, and valid values are - URLRequestMethod.GET or URLRequestMethod.POST.

-

For content running in Adobe AIR, when When - using the navigateToURL() function, the runtime treats a URLRequest that uses the POST - method (one that has its method property set to URLRequestMethod.POST) - as using the GET method.

-

Note: - If running in Flash Player and the referenced form has no body, - Flash Player automatically uses a GET operation, even if the method is set to - URLRequestMethod.POST. For this reason, it is recommended to always include - a "dummy" body to ensure that the correct method is used.

-

The default value is URLRequestMethod.GET.

-Implementation -
-    public function get method():String -
-    public function set method(value:String):void -
-
-Throws -
- - - - -
ArgumentError — If the value parameter is not - URLRequestMethod.GET or URLRequestMethod.POST. -
-

-See also -

-
-URLRequestMethod class -
-
-Example -
The following example opens the remote application hosted at - http://www.[yourDomain].com/application.jsp in a new browser window and passes - data about a user session, captured in a URLVariables object, to the application. - It explicitly sets the value of the URLRequest.method property to - URLRequestMethod.POST. -

Highlights of the example follow:

-
    -
  1. The constructor function creates a URLRequest - instance named request, taking the URL of the remote application as a parameter.
    2. -
  2. A URLVariables object is created and two of its properties are assigned values.
    3. -
  3. The URLVariables object is assigned to the data property of the URLRequest object.
    4. -
  4. The value of the URLRequest.method property is set to - URLRequestMethod.POST.
    5. -
  5. The example calls navigateToURL, which opens a new browser window - to the remote application's URL.
    6. -
- -

Note: To run the example, the remote application URL in the example must be replaced - with a working URL. Additionally, you would need server code - to process the information captured by Flash Player in the URLVariables object.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.net.navigateToURL;
-    import flash.net.URLRequest;
-    import flash.net.URLRequestMethod;
-    import flash.net.URLVariables;
-
-    public class URLRequest_method extends Sprite {
-
-        public function URLRequest_method() {
-            var url:String = "http://www.[yourDomain].com/application.jsp";
-            var request:URLRequest = new URLRequest(url);
-            
-            var variables:URLVariables = new URLVariables();
-            variables.exampleSessionId = new Date().getTime();
-            variables.exampleUserLabel = "guest";
-            request.data = variables;
-            request.method = URLRequestMethod.POST;
-            
-            navigateToURL(request);
-        }
-    }
-}
-
-

-
- - - - - -
requestHeadersproperty 
-
-requestHeaders:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The array of HTTP request headers to be appended to the - HTTP request. The array is composed of URLRequestHeader objects. - Each object in the array must be a URLRequestHeader object that - contains a name string and a value string, as follows: - 

-     var rhArray:Array = new Array(new URLRequestHeader("Content-Type", "text/html"));
-
-

Flash Player and the AIR runtime impose - The AIR runtime imposes certain restrictions on request headers; - for more information, see the URLRequestHeader class description.

-

Not all methods that accept URLRequest parameters support the requestHeaders property, - consult the documentation for the method you are calling. For example, the FileReference.upload() - and FileReference.download() methods do not - support the URLRequest.requestHeaders property.

-

Due to browser limitations, custom HTTP request headers are only supported for POST requests, - not for GET requests.

- Implementation -
-    public function get requestHeaders():Array -
-    public function set requestHeaders(value:Array):void -
-

-See also -

-
-URLRequestHeader -
-
- - - - - -
urlproperty 
-
-url:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The URL to be requested. -

Be sure to encode any characters that are either described as unsafe in the Uniform Resource Locator - specification (see http://www.faqs.org/rfcs/rfc1738.html) or that are reserved in the - URL scheme of the URLRequest object (when not used for their reserved purpose). For example, - use "%25" for the percent (%) symbol and "%23" for the number sign (#), as in - "http://www.example.com/orderForm.cfm?item=%23B-3&discount=50%25".

-

By default, the URL must be in the same domain as the calling file, - unless the content is running in the Adobe AIR application - security sandbox. If you need to load data from a different domain, - put a URL policy file on the server that is hosting the data. For more information, - see the description of the URLRequest class.

-

For content running in Adobe AIR, files - Files in the application security sandobx - — files installed with the AIR application — can access URLs using any of the - following URL schemes:

-
    -
  • http and https
    • -
  • file
    • -
  • app-storage
    • -
  • app
    • -
-

Note: IPv6 (Internet Protocol version 6) is supported in - AIR and in Flash Player 9.0.115.0 and later. - IPv6 is a version of Internet Protocol that supports - 128-bit addresses (an improvement on the earlier IPv4 protocol that supports 32-bit - addresses). You might need to activate IPv6 on your networking interfaces. For more - information, see the Help for the operating system hosting the data. - If IPv6 is supported on the hosting system, you can specify numeric IPv6 literal addresses - in URLs enclosed in brackets ([]), as in the following.

- - 
-     rtmp://[2001:db8:ccc3:ffff:0:444d:555e:666f]:1935/test
-
- - Implementation -
-    public function get url():String -
-    public function set url(value:String):void -
-
-Example -
The following example shows how you can dynamically load an image using the Loader class in ActionScript 3.0. - Example provided by - ActionScriptExamples.com. -
-
-var url:String = "http://www.helpexamples.com/flash/images/image2.jpg";
-var urlRequest:URLRequest = new URLRequest(url);
-var loader:Loader = new Loader();
-loader.load(urlRequest);
-addChild(loader);
-
-

-
- - - - - -
useCacheproperty 
-
-useCache:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies whether the local cache should be consulted before this URLRequest - fetches data. -

Note:The HTMLLoader.load() method - does not support the URLRequest.useCache property.

-

The default value is true.

-Implementation -
-    public function get useCache():Boolean -
-    public function set useCache(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. -
-

-See also -

-
-flash.net.URLRequestDefaults.useCache -
-
- - - - - -
userAgentproperty 
-
-userAgent:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the user-agent string to be used in the HTTP request. -

The default value is the same user agent string that is used by - Flash Player, which is different on Mac, Linux, and Windows.

-

Note: This property does not affect the user agent string when - the URLRequest object is used with the load() method of an - HTMLLoader object. To set the user agent string for an HTMLLoader object, - set the userAgent property of the HTMLLoader object or set - the static URLRequestDefaults.userAgent property.

- Implementation -
-    public function get userAgent():String -
-    public function set userAgent(value:String):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. -
-

-See also -

-
-flash.net.URLRequestDefaults.userAgent -
-flash.html.HTMLLoader.userAgent -
-
- -
Constructor detail
- - - - - -
URLRequest()constructor
-
-public function URLRequest(url:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a URLRequest object. - If System.useCodePage is true, the request is encoded using the - system code page, rather than Unicode. - If System.useCodePage is false, the request is encoded using Unicode, rather than the - system code page. -

Parameters - - - - -
url:String (default = null) — The URL to be requested. You can set the URL later by using the url property. -
-

-See also -

-
-flash.system.System.useCodePage -
-
-Example -
The following example shows how you can open new browser windows from Flash Player using the navigateToURL() method. - Example provided by - ActionScriptExamples.com. -
-
-// Requires
-// - Button symbol on Stage (or a display object, such as a MovieClip) with instance name "buttonSymbol"
-//
-buttonSymbol.addEventListener(MouseEvent.CLICK, buttonSymbol_click);
- 
-function buttonSymbol_click(evt:MouseEvent):void {
-    var req:URLRequest = new URLRequest("http://www.adobe.com/");
-    navigateToURL(req, "_blank");
-}
-
-

-
- -
Method detail
- - - - - -
useRedirectedURL()method
-
-public function useRedirectedURL(sourceRequest:URLRequest, wholeURL:Boolean = false, pattern:* = null, replace:String = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- - Allows substitution of a redirected URL from a source URLRequest for some portion of the URL - in a new URLRequest. After an initial request has been redirected, this allows subsequent reqeusts to - be sent directly to the redirected server location. - -

Once the initial URLRequest has completed, if HTTPStatusEvent.redirected is true, - this method can be called using the inital request as the sourceRequest. By default, the domain - from the redirected URL will be used in place of the domain in this URLRequest's URL. URLRequest.url - must be set before calling this method. The method must be called before this URLRequest is loaded. - Optionally, if the wholeURL parameter is true, the entire url, minus the filename, from the source URLRequest - will be substituted for the entire URL minus the final filename in this URLRequest. Also, the caller can optionally supply - a string or regular expression in the pattern parameter. The pattern is searched for and replaced with the - string from the replace parameter. This search and replace happens after the URL substitution.

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
sourceRequest:URLRequest — An URLRequest object that has already been requested and was redirected. The redirected URL will be used to substitute for part of the URL of this URLRequest object. -
 
wholeURL:Boolean (default = false) — Whether to use just the domain of the sourceRequest final URL to substitute for the domain of this request's URL, or whether to use the entire URL minus the filename. The default is false. -
 
pattern:* (default = null) — A pattern to search for in the URL. Can be either a String or a RegExp object. The default is null. -
 
replace:String (default = null) — A string to use to replace for the pattern if found in the URL. The default is null. -
-

-See also -

-
-flash.events.HTTPStatusEvent.redirected -
-
- -
Examples
-
examples\URLRequestExample
-
The following example creates a new Loader object and passes it - a URLRequest object that contains the path to an XML file. If the loading operation is - successful, a complete event is dispatched and the data in the XML - file traces to the output. Additional event handlers capture other events, including error - events. - -

To run this example, place a file named XMLFile.xml in the same directory - as your SWF file.

-
-
-
-package {
-    import flash.display.Sprite;
-	import flash.events.*;
-	import flash.net.*;
-
-	public class URLRequestExample extends Sprite {
-		private var loader:URLLoader;
-		
-		public function URLRequestExample() {
-			loader = new URLLoader();
-			configureListeners(loader);
-
-			var request:URLRequest = new URLRequest("XMLFile.xml");
-            try {
-			    loader.load(request);
-            } catch (error:Error) {
-                trace("Unable to load requested document.");
-            }
-		}
-
-		private function configureListeners(dispatcher:IEventDispatcher):void {
-			dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-			dispatcher.addEventListener(Event.OPEN, openHandler);
-			dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-			dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-			dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
-			dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-		}
-
-		private function completeHandler(event:Event):void {
-			var loader:URLLoader = URLLoader(event.target);
-			trace("completeHandler: " + loader.data);
-		}
-
-		private function openHandler(event:Event):void {
-			trace("openHandler: " + event);
-		}
-
-		private function progressHandler(event:ProgressEvent):void {
-			trace("progressHandler loaded:" + event.bytesLoaded + " total: " + event.bytesTotal);
-		}
-
-		private function securityErrorHandler(event:SecurityErrorEvent):void {
-			trace("securityErrorHandler: " + event);
-		}
-
-		private function httpStatusHandler(event:HTTPStatusEvent):void {
-			trace("httpStatusHandler: " + event);
-		}
-
-		private function ioErrorHandler(event:IOErrorEvent):void {
-			trace("ioErrorHandler: " + event);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/URLRequestDefaults.html b/html-docs/flash/net/URLRequestDefaults.html deleted file mode 100644 index e3bdad5..0000000 --- a/html-docs/flash/net/URLRequestDefaults.html +++ /dev/null @@ -1,691 +0,0 @@ - - - - - - - - -flash.net.URLRequestDefaults (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class URLRequestDefaults
InheritanceURLRequestDefaults Inheritance Object
-

- - - - -
Runtime version: AIR 1.0 -
-

-

- The URLRequestDefaults class includes static properties that you can set to define - default values for the properties of the URLRequest class. It also includes a static - method, URLRequestDefaults.setLoginCredentialsForHost(), which lets you define - default authentication credentials for requests. The URLRequest class defines - the information to use in an HTTP request. - -

Any properties set in a URLRequest object override those static properties set for - the URLRequestDefaults class.

- -

URLRequestDefault settings only apply to content in the caller's application domain, - with one exception: settings made by calling URLRequestDefaults.setLoginCredentialsForHost() - apply to all application domains in the currently running application.

- -

Only Adobe® AIR® content running in the application security sandbox can - use the URLRequestDefaults class. Other content will result in a SecurityError being thrown when accessing the - members or properties of this class.

- -

-

-See also -

-
-URLRequest -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  authenticate : Boolean -
[static] - The default setting for the authenticate property of URLRequest objects.
-		URLRequestDefaults
  cacheResponse : Boolean -
[static] - The default setting for the cacheResponse property of URLRequest objects.
-		URLRequestDefaults
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  followRedirects : Boolean -
[static] - The default setting for the followRedirects property of URLRequest objects.
-		URLRequestDefaults
  idleTimeout : Number -
[static] - The default setting for the idleTimeout property of URLRequest objects and HTMLLoader objects.
-		URLRequestDefaults
  manageCookies : Boolean -
[static] - The default setting for the manageCookies property of URLRequest objects.
-		URLRequestDefaults
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  useCache : Boolean -
[static] - The default setting for the useCache property of URLRequest objects.
-		URLRequestDefaults
  userAgent : String -
[static] - The default setting for the userAgent property of URLRequest objects.
-		URLRequestDefaults
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-setLoginCredentialsForHost(hostname:String, user:String, password:String):* -
-
[static] - Sets default user and password credentials for a selected host.
-		URLRequestDefaults
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
authenticateproperty
-
-authenticate:Boolean  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The default setting for the authenticate property of URLRequest objects. - Setting the authenticate property in a URLRequest object overrides this default setting. -

Note: This setting does not apply to URLRequest objects used in file upload or - RTMP requests.

-

The default value is true.

-Implementation -
-    public static function get authenticate():Boolean -
-    public function set authenticate(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. - -
-

-See also -

-
-URLRequest.authenticate -
-
- - - - - -
cacheResponseproperty 
-
-cacheResponse:Boolean  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The default setting for the cacheResponse property of URLRequest objects. - Setting the cacheResponse property in a URLRequest object overrides this default setting. - When set to true, the default behavior for the AIR application is to use the operating system's - HTTP cache. This setting does not apply to URLRequest objects used in file upload or RTMP requests. -

The default value is true.

-Implementation -
-    public static function get cacheResponse():Boolean -
-    public function set cacheResponse(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. - -
-

-See also -

-
-URLRequest.cacheResponse -
-
- - - - - -
followRedirectsproperty 
-
-followRedirects:Boolean  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The default setting for the followRedirects property of URLRequest objects. - Setting the followRedirects property in a URLRequest object overrides this default setting. - This setting does not apply to URLRequest objects used in file upload or RTMP requests. - -

The default value is true.

-Implementation -
-    public static function get followRedirects():Boolean -
-    public function set followRedirects(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. - -
-

-See also -

-
-URLRequest.followRedirects -
-
- - - - - -
idleTimeoutproperty 
-
-idleTimeout:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The default setting for the idleTimeout property of URLRequest objects and HTMLLoader objects. - -

The idle timeout is the amount of time (in milliseconds) that the client waits for a response from the server, - after the connection is established, before abandoning the request.

- -

This defines the default idle timeout used by the URLRequest or HTMLLoader object. Setting the idleTimeout - property in a URLRequest object or an HTMLLoader object overrides this default setting.

-

When this property is set to 0 (the default), the runtime uses the default idle timeout value defined by the operating system. - The default idle timeout value varies between operating systems (such as Mac OS, Linux, or Windows) and between - operating system versions.

-

This setting does not apply to URLRequest objects used in file upload or RTMP requests.

-

The default value is 0.

-Implementation -
-    public static function get idleTimeout():Number -
-    public function set idleTimeout(value:Number):void -
-
-Throws -
- - - - - - - - - - -
SecurityError — The caller is not in the AIR application security sandbox. -
 
RangeError — The idleTimeout value is negative. - -
-

-See also -

-
-HTMLLoader.idleTimeout -
-URLRequest.idleTimeout -
-
- - - - - -
manageCookiesproperty 
-
-manageCookies:Boolean  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The default setting for the manageCookies property of URLRequest objects. - Setting the manageCookies property in a URLRequest object overrides this default setting. - -

Note: This setting does not apply to URLRequest objects used in file upload or - RTMP requests.

-

The default value is true.

-Implementation -
-    public static function get manageCookies():Boolean -
-    public function set manageCookies(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. - -
-

-See also -

-
-URLRequest.manageCookies -
-
- - - - - -
useCacheproperty 
-
-useCache:Boolean  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The default setting for the useCache property of URLRequest objects. - Setting the useCache property in a URLRequest object overrides this default setting. - This setting does not apply to URLRequest objects used in file upload or RTMP requests. -

The default value is true.

-Implementation -
-    public static function get useCache():Boolean -
-    public function set useCache(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. - -
-

-See also -

-
-URLRequest.useCache -
-
- - - - - -
userAgentproperty 
-
-userAgent:String  [read-write]

- - - - -
Runtime version: AIR 1.0 -
-

- The default setting for the userAgent property of URLRequest objects. - Setting the userAgent property in a URLRequest object overrides this - default setting. - -

This is also the default user agent string for all HTMLLoader objects (used - when you call the load() method of the HTMLLoader object). Setting - the userAgent property of the HTMLLoader object overrides the - URLRequestDefaults.userAgent setting.

- -

This default value varies depending on the runtime operating system (such as Mac OS, Linux or Windows), - the runtime language, and the runtime version, as in the following examples:

- -
    - -
  • "Mozilla/5.0 (Macintosh; U; PPC Mac OS X; en) AppleWebKit/526.9+ (KHTML, like Gecko) AdobeAIR/1.5"
    • -
  • "Mozilla/5.0 (Windows; U; en) AppleWebKit/526.9+ (KHTML, like Gecko) AdobeAIR/1.5"
    • -
  • "Mozilla/5.0 (X11; U; Linux i686; en-US) AppleWebKit/526.9+ (KHTML, like Gecko) AdobeAIR/1.5"
    • - -
- Implementation -
-    public static function get userAgent():String -
-    public function set userAgent(value:String):void -
-
-Throws -
- - - - -
SecurityError — The caller is not in the AIR application security sandbox. - -
-

-See also -

-
-flash.net.URLRequest.userAgent -
-flash.html.HTMLLoader.userAgent -
-
- -
Method detail
- - - - - -
setLoginCredentialsForHost()method
-
-public static function setLoginCredentialsForHost(hostname:String, user:String, password:String):* -

- - - - -
Runtime version: AIR 1.0 -
-

- Sets default user and password credentials for a selected host. These settings - apply for URLRequest objects in all application domains of the application, - not only those in the application domain of the object calling this method - (whereas the static properties of the URLRequest class apply to the caller's - application domain only). This allows content in the entire application - (regardless of the content's application domain) to be logged in when another - part of the application logs in. - -

Note for applications running on Mac OS: On Mac OS, when you call - this method, the application uses these credentials for the specified host - until the application is closed, even if you subsequently call - URLRequestDefaults.setLoginCredentialsForHost() for the same host. - However, if a server rejects the credentials specified by this method, - then a subsequent call to the URLRequestDefaults.setLoginCredentialsForHost() - method (for the same host) will be recognized.

- -

Note: This method does not apply to URLRequest objects used in file upload or - RTMP requests.

- Parameters - - - - - - - - - - - - - - - - -
hostname:String — The host name to which the user name and password are applied. This - can be a domain, such as "www.example.com" or a domain and a port number, - such as "www.example.com:80". Note that "example.com", - "www.example.com", and "sales.example.com" are each considered - unique hosts. - -
 
user:String — The default user name to use in request authentication for the specified host. - -
 
password:String — The default password to use in request authentication for the specified host. -
-

-Returns - - - - -
*
-
-Throws - - - - -
SecurityError — The caller is not in the AIR application security sandbox. - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/URLRequestHeader.html b/html-docs/flash/net/URLRequestHeader.html deleted file mode 100644 index cceafe6..0000000 --- a/html-docs/flash/net/URLRequestHeader.html +++ /dev/null @@ -1,456 +0,0 @@ - - - - - - - - -flash.net.URLRequestHeader (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class URLRequestHeader
InheritanceURLRequestHeader Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- A URLRequestHeader object encapsulates a single HTTP request header - and consists of a name/value pair. - - URLRequestHeader objects are used in the requestHeaders property of the URLRequest class. - -

In Adobe® AIR®, content in the application security sandbox (such as - content installed with the AIR application) can use any request headers, without error. However, for content - running in Adobe AIR that is in a different security sandbox, - or for content running in Flash® Player, - using following request headers cause a runtime error to be thrown, and the - restricted terms are not case-sensitive (for example, Get, get, and GET - are each not allowed):

-

In Flash Player and in Adobe AIR content outside of the application security sandbox, - the following request headers cannot be used, and the restricted terms are not case-sensitive - (for example, Get, get, and GET are all not allowed). Also, - hyphenated terms apply if an underscore character is used (for example, both Content-Length and - Content_Length are not allowed):

- -

Accept-Charset, Accept-Encoding, Accept-Ranges, Age, Allow, - Allowed, Authorization, Charge-To, Connect, - Connection, - Content-Length, Content-Location, Content-Range, Cookie, - Date, Delete, - ETag, Expect, Get, Head, Host, If-Modified-Since, - Keep-Alive, Last-Modified, Location, - Max-Forwards, Options, Origin, Post, - Proxy-Authenticate, Proxy-Authorization, Proxy-Connection, - Public, Put, - Range, Referer, Request-Range, Retry-After, Server, - TE, Trace, Trailer, Transfer-Encoding, - Upgrade, URI, User-Agent, Vary, Via, Warning, - WWW-Authenticate, x-flash-version.

- -

URLRequestHeader objects are restricted in length. If the cumulative length of a - URLRequestHeader object (the length of the name property plus the value - property) or an array of URLRequestHeader objects used in the URLRequest.requestHeaders - property exceeds the acceptable length, an exception is thrown.

- -

Content running in Adobe AIR sets the ACCEPT header to the following, unless you - specify a setting for the ACCEPT header in the requestHeaders - property of the URLRequest class:

- - text/xml, - application/xml, - application/xhtml+xml, - text/html;q=0.9, - text/plain;q=0.8, - image/png, - application/x-shockwave-flash, - video/mp4;q=0.9, - flv-application/octet-stream;q=0.8, - video/x-flv;q=0.7, - audio/mp4, - */*;q=0.5 -

Not all methods that accept URLRequest parameters support the requestHeaders property, - consult the documentation for the method you are calling. For example, the FileReference.upload() - and FileReference.download() methods do not - support the URLRequest.requestHeaders property.

-

Due to browser limitations, custom HTTP request headers are only supported for POST requests, - not for GET requests.

- -

-

-View the examples. -

-

-See also -

-
-URLRequest -
-URLLoader -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  name : String -
- An HTTP request header name (such as Content-Type or SOAPAction).
-		URLRequestHeader
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  value : String -
- The value associated with the name property (such as text/plain).
-		URLRequestHeader
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-URLRequestHeader(name:String = "", value:String = "")
-
- Creates a new URLRequestHeader object that encapsulates a single HTTP request header.
-		URLRequestHeader
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
nameproperty
-
-public var name:String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An HTTP request header name (such as Content-Type or SOAPAction). -

- - - - - -
valueproperty 
-
-public var value:String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The value associated with the name property (such as text/plain). -

- -
Constructor detail
- - - - - -
URLRequestHeader()constructor
-
-public function URLRequestHeader(name:String = "", value:String = "") -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a new URLRequestHeader object that encapsulates a single HTTP request header. - URLRequestHeader objects are used in the requestHeaders - property of the URLRequest class. -

Parameters - - - - - - - - - - -
name:String (default = "") — An HTTP request header name (such as Content-Type - or SOAPAction). -
 
value:String (default = "") — The value associated with the name property - (such as text/plain). -
-
- -
Examples
-
examples\URLRequestHeaderExample
-
The following example adds a single HTTP request header header to the array for the requestHeaders property. The header indicates that the application should forward the request to the origin server even if it has a cached copy of what is being requested. -
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.URLLoader;
-    import flash.net.URLRequest;
-    import flash.net.URLRequestHeader;
-    import flash.net.URLRequestMethod;
-    import flash.net.URLVariables;
-
-    public class URLRequestHeaderExample extends Sprite {
-    	private var loader:URLLoader;
-		
-        public function URLRequestHeaderExample() {
-            loader = new URLLoader();
-            configureListeners(loader);
-
-            var header:URLRequestHeader = new URLRequestHeader("pragma", "no-cache");
-            var request:URLRequest = new URLRequest("http://www.[yourdomain].com/greeting.cfm");
-            request.data = new URLVariables("name=John+Doe");
-            request.method = URLRequestMethod.POST;
-            request.requestHeaders.push(header);
-            try {
-                loader.load(request);
-            } catch (error:Error) {
-                trace("Unable to load requested document.");
-            }
-        }
-
-        private function configureListeners(dispatcher:IEventDispatcher):void {
-            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-            dispatcher.addEventListener(Event.OPEN, openHandler);
-            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
-            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-        }
-
-        private function completeHandler(event:Event):void {
-            var loader:URLLoader = URLLoader(event.target);
-            trace("completeHandler: " + loader.data);
-        }
-
-        private function openHandler(event:Event):void {
-            trace("openHandler: " + event);
-        }
-
-        private function progressHandler(event:ProgressEvent):void {
-            trace("progressHandler loaded:" + event.bytesLoaded + " total: " + event.bytesTotal);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-
-        private function httpStatusHandler(event:HTTPStatusEvent):void {
-            trace("httpStatusHandler: " + event);
-        }
-
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("ioErrorHandler: " + event);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/URLRequestMethod.html b/html-docs/flash/net/URLRequestMethod.html deleted file mode 100644 index 6a85f70..0000000 --- a/html-docs/flash/net/URLRequestMethod.html +++ /dev/null @@ -1,478 +0,0 @@ - - - - - - - - -flash.net.URLRequestMethod (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic final class URLRequestMethod
InheritanceURLRequestMethod Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The URLRequestMethod class provides values that specify whether the URLRequest object should - use the POST method or the GET method when sending data to a server. -

-

-View the examples. -

-

-See also -

-
-URLRequest -
-URLVariables -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  DELETE : String = "DELETE"
[static] - Specifies that the URLRequest object is a DELETE.
-		URLRequestMethod
  GET : String = "GET"
[static] - Specifies that the URLRequest object is a GET.
-		URLRequestMethod
  HEAD : String = "HEAD"
[static] - Specifies that the URLRequest object is a HEAD.
-		URLRequestMethod
  OPTIONS : String = "OPTIONS"
[static] - Specifies that the URLRequest object is OPTIONS.
-		URLRequestMethod
  POST : String = "POST"
[static] - Specifies that the URLRequest object is a POST.
-		URLRequestMethod
  PUT : String = "PUT"
[static] - Specifies that the URLRequest object is a PUT.
-		URLRequestMethod
-
- -
- -
Constant detail
- - - - - -
DELETEconstant
-
-public static const DELETE:String = "DELETE" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies that the URLRequest object is a DELETE. -

- - - - - -
GETconstant 
-
-public static const GET:String = "GET" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies that the URLRequest object is a GET. -

- - - - - -
HEADconstant 
-
-public static const HEAD:String = "HEAD" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies that the URLRequest object is a HEAD. -

- - - - - -
OPTIONSconstant 
-
-public static const OPTIONS:String = "OPTIONS" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies that the URLRequest object is OPTIONS. -

- - - - - -
POSTconstant 
-
-public static const POST:String = "POST" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies that the URLRequest object is a POST. -

Note: For content running in Adobe AIR, when - When using the navigateToURL() function, the runtime - treats a URLRequest that uses the POST method (one that has its method property set to - URLRequestMethod.POST) as using the GET method.

-
- - - - - -
PUTconstant 
-
-public static const PUT:String = "PUT" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies that the URLRequest object is a PUT. -

- -
Examples
-
examples\URLRequestMethodExample
-
The following example loads and displays the - data found in a local text file. It also traces event handling information. - -

Note:To run this example, put a file named example.txt - in the same directory as your SWF file. That file should be a simple text file containing - a few words or lines of text. -

- -

The example code does the following:

-
    -
  1. The constructor function creates a URLLoader instance named loader.
    2. -
  2. The loader object is passed to the configureListeners() method, - which adds listeners for each of the supported URLLoader events.
    3. -
  3. A URLRequest instance named request is created, which specifies name of the file to be loaded.
    4. -
  4. The method property of the request is set to URLRequestMethod.POST.
    5. -
  5. The request object is then passed to loader.load(), which loads the text file.
    6. -
  6. When the URLLoader has finished loading the text file the Event.COMPLETE event fires, - triggering the completeHandler() method. The completeHandler() method simply traces - the data property, the contents of the text file.
    7. -
-
-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.*;
-
-    public class URLRequestMethodExample extends Sprite {
-		private var loader:URLLoader;
-		
-        public function URLRequestMethodExample() {
-            loader = new URLLoader();
-            configureListeners(loader);
-
-            var request:URLRequest = new URLRequest("example.txt");
-            
-            request.method = URLRequestMethod.POST;
-            loader.load(request);
-        }
-
-        private function configureListeners(dispatcher:IEventDispatcher):void {
-            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-            dispatcher.addEventListener(Event.OPEN, openHandler);
-            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-            dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
-            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-        }
-
-        private function completeHandler(event:Event):void {
-            var loader:URLLoader = URLLoader(event.target);
-            trace("completeHandler: " + loader.data);
-        }
-
-        private function openHandler(event:Event):void {
-            trace("openHandler: " + event);
-        }
-
-        private function progressHandler(event:ProgressEvent):void {
-            trace("progressHandler loaded:" + event.bytesLoaded + " total: " + event.bytesTotal);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-
-        private function httpStatusHandler(event:HTTPStatusEvent):void {
-            trace("httpStatusHandler: " + event);
-        }
-
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("ioErrorHandler: " + event);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/URLStream.html b/html-docs/flash/net/URLStream.html deleted file mode 100644 index 0659d7d..0000000 --- a/html-docs/flash/net/URLStream.html +++ /dev/null @@ -1,2276 +0,0 @@ - - - - - - - - -flash.net.URLStream (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.net
Classpublic class URLStream
InheritanceURLStream Inheritance EventDispatcher Inheritance Object
ImplementsIDataInput
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- The URLStream class provides low-level access to - downloading URLs. Data is made available to application code - immediately as it is downloaded, instead of waiting until - the entire file is complete as with URLLoader. - The URLStream class also lets you close a stream - before it finishes downloading. - The contents of the downloaded file are made available as raw binary data. -

The read operations in URLStream are nonblocking. - This means that you must use the bytesAvailable property to determine - whether sufficient data is available before reading it. An - EOFError exception is thrown if insufficient - data is available.

-

All binary data is encoded by default in big-endian format, with the - most significant byte first.

-

The security rules that apply to URL downloading with the URLStream class are identical - to the rules applied to URLLoader objects. - Policy files may be downloaded as needed. Local file security rules are enforced, - and security warnings are raised as needed.

- - -

-

-View the examples. -

-

-See also -

-
-URLLoader -
-URLRequest -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bytesAvailable : uint -
[read-only] - Returns the number of bytes of data available for reading - in the input buffer.
-		URLStream
  connected : Boolean -
[read-only] - Indicates whether this URLStream object is - currently connected.
-		URLStream
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  endian : String -
- Indicates the byte order for the data.
-		URLStream
  objectEncoding : uint -
- Controls the version of Action Message Format (AMF) used when writing or reading an object.
-		URLStream
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-close():void -
-
- Immediately closes the stream and - cancels the download operation.
-		URLStream
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-load(request:URLRequest):void -
-
- Begins downloading the URL specified in the request parameter.
-		URLStream
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-readBoolean():Boolean -
-
- Reads a Boolean value from the stream.
-		URLStream
   -
-readByte():int -
-
- Reads a signed byte from the stream.
-		URLStream
   -
-readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- Reads length bytes of data from the stream.
-		URLStream
   -
-readDouble():Number -
-
- Reads an IEEE 754 double-precision floating-point number from the stream.
-		URLStream
   -
-readFloat():Number -
-
- Reads an IEEE 754 single-precision floating-point number from the stream.
-		URLStream
   -
-readInt():int -
-
- Reads a signed 32-bit integer from the stream.
-		URLStream
   -
-readMultiByte(length:uint, charSet:String):String -
-
- Reads a multibyte string of specified length from the byte stream using the - specified character set.
-		URLStream
   -
-readObject():* -
-
- Reads an object from the socket, encoded in Action Message Format (AMF).
-		URLStream
   -
-readShort():int -
-
- Reads a signed 16-bit integer from the stream.
-		URLStream
   -
-readUnsignedByte():uint -
-
- Reads an unsigned byte from the stream.
-		URLStream
   -
-readUnsignedInt():uint -
-
- Reads an unsigned 32-bit integer from the stream.
-		URLStream
   -
-readUnsignedShort():uint -
-
- Reads an unsigned 16-bit integer from the stream.
-		URLStream
   -
-readUTF():String -
-
- Reads a UTF-8 string from the stream.
-		URLStream
   -
-readUTFBytes(length:uint):String -
-
- Reads a sequence of length UTF-8 - bytes from the stream, and returns a string.
-		URLStream
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-certificateError -
-		 - Dispatched if a call to URLStream.load() - attempts to load data from a server with an invalid certificate - (for example, self-signed or untrusted, or with an invalid date).URLStream
   -
-complete -
-		 - Dispatched when data has loaded successfully.URLStream
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-httpResponseStatus -
-		 - Dispatched if a call to the URLStream.load() method attempts to access data over HTTP - and Adobe AIR is able to detect and return the status code for the request.URLStream
   -
-httpStatus -
-		 - Dispatched if a call to URLStream.load() - attempts to access data over HTTP, and Flash Player or Adobe AIR - is able to detect and return the status code for the request.URLStream
   -
-ioError -
-		 - Dispatched when an input/output error occurs that causes a load operation to fail.URLStream
   -
-open -
-		 - Dispatched when a load operation starts.URLStream
   -
-progress -
-		 - Dispatched when data is received as the download operation progresses.URLStream
   -
-securityError -
-		 - Dispatched if a call to URLStream.load() - attempts to load data from a server outside the security sandbox.URLStream
-
- -
- -
Property detail
- - - - - -
bytesAvailableproperty
-
-bytesAvailable:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Returns the number of bytes of data available for reading - in the input buffer. - Your code must call the bytesAvailable property to ensure - that sufficient data is available before you try to read - it with one of the read methods. - -

Implementation -
-    public function get bytesAvailable():uint -
-
- - - - - -
connectedproperty 
-
-connected:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates whether this URLStream object is - currently connected. A call to this property returns a value of true - if the URLStream object is connected, or false otherwise. -

Implementation -
-    public function get connected():Boolean -
-
- - - - - -
endianproperty 
-
-endian:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates the byte order for the data. Possible values are - Endian.BIG_ENDIAN or Endian.LITTLE_ENDIAN. -

The default value is Endian.BIG_ENDIAN.

-Implementation -
-    public function get endian():String -
-    public function set endian(value:String):void -
-

-See also -

-
-flash.utils.Endian -
-
- - - - - -
objectEncodingproperty 
-
-objectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Controls the version of Action Message Format (AMF) used when writing or reading an object. -

Implementation -
-    public function get objectEncoding():uint -
-    public function set objectEncoding(value:uint):void -
-

-See also -

-
-readObject() -
-ObjectEncoding class -
-
- -
Method detail
- - - - - -
close()method
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Immediately closes the stream and - cancels the download operation. - No data can be read from the stream after the close() method is called. - -


-Throws - - - - -
Error — The stream could not be closed, or the stream was not open. - -
-
- - - - - -
load()method 
-
-public function load(request:URLRequest):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Begins downloading the URL specified in the request parameter. -

Note: If a file being loaded contains non-ASCII characters - (as found in many non-English languages), it is recommended that you save the file - with UTF-8 or UTF-16 encoding, as opposed to a non-Unicode format like ASCII.

-

If the loading operation fails immediately, an IOError or SecurityError - (including the local file security error) exception is thrown describing the failure. - Otherwise, an open event is dispatched if the URL download - starts downloading successfully, or an error event is dispatched if an error occurs.

-

By default, the calling SWF file and the URL you load must be in exactly the same domain. - For example, a SWF file at www.adobe.com can load data only from sources that are also at www.adobe.com. - To load data from a different domain, place a URL policy file on the server hosting the data.

-

In Flash Player, you cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.

-

In Flash Player, you can prevent a SWF file from using this method by setting the - allowNetworking parameter of the the object and embed - tags in the HTML page that contains the SWF content.

-

In Flash Player 10 and later, and in AIR 1.5 and later, if you use a multipart - Content-Type (for example "multipart/form-data") - that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), - the POST operation is subject to the security rules applied to uploads:

-
    -
  • The POST operation must be performed in response to a user-initiated action, such as a mouse click or key press.
    • -
  • If the POST operation is cross-domain (the POST target is not on the same server as the SWF file - that is sending the POST request), - the target server must provide a URL policy file that permits cross-domain access.
    • -
-

Also, for any multipart Content-Type, the syntax must be valid (according to the RFC2046 standards). - If the syntax appears to be invalid, the POST operation is subject to the security rules applied to uploads.

-

These rules also apply to AIR content in non-application sandboxes. - However, in Adobe AIR, content in the application sandbox (content installed with the AIR application) - are not restricted by these security limitations.

- -

For more information related to security, see The Flash Player Developer Center Topic: - Security.

- -

In AIR, a URLRequest object can register for the httpResponse status event. - Unlike the httpStatus event, the httpResponseStatus event is - delivered before any response data. Also, the httpResponseStatus event includes - values for the responseHeaders and responseURL properties (which are - undefined for an httpStatus event. Note that the httpResponseStatus event - (if any) will be sent before (and in addition to) any complete or error - event. -

-

If there is an httpResponseStatus event listener, the body of the response - message is always sent; and HTTP status code responses always results in a complete event. - This is true in spite of whether the HTTP response status code indicates a success or an error.

- -

In AIR, ifIf there is - no httpResponseStatus event listener, the behavior differs - based on the SWFAIR version:

- -
    -
  • For SWF 9 contentIn an AIR file - in which the application descriptor specifies AIR 1.0 or 1.1 as the runtime version, the body of - the HTTP response message is sent only if the HTTP response status code indicates success. - Otherwise (if there is an error), no body is sent and the URLRequest object dispatches an IOError event.
    • -
  • For SWF 10 contentIn an AIR file - in which the application descriptor specifies AIR 1.5 as the runtime version, the body of - the HTTP response message is always sent. If there is an error, the URLRequest object dispatches - an IOError event.
    • -
- - Parameters - - - - -
request:URLRequest — A URLRequest object specifying the URL to download. If the value of - this parameter or the URLRequest.url property of the URLRequest object - passed are null, the application throws a null pointer error. -
-
-Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
complete:Event — Dispatched after data has loaded successfully. If there is a httpResponseStatus - event listener, the URLRequest object also dispatches a complete event whether the HTTP response status code - indicates a success or an error.
 
httpStatus:HTTPStatusEvent — If access is by HTTP and - the current environment supports obtaining status codes, you may - receive these events in addition to any complete - or error event.
 
httpResponseStatus:HTTPStatusEvent — Dispatched if a call to the load() method attempts - to access data over HTTP and Adobe AIR is able to detect and return the status code for the request.
 
ioError:IOErrorEvent — The load operation could not be - completed.
 
open:Event — Dispatched when a load operation starts.
 
securityError:SecurityErrorEvent — A load operation attempted - to retrieve data from a server outside the caller's security sandbox. - This may be worked around using a policy file on the server.
 
certificateError:SecurityErrorEvent — A load operation attempted - to retrieve data from a server with an invalid certificate (for example, - self-signed or otherwise untrusted, or out of date).
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — URLRequest.requestHeader objects may not contain - certain prohibited HTTP request headers. For more information, see the URLRequestHeader class - description. - -
 
Error — This error can occur for the following reasons: - -
    - -
  1. Flash Player or Adobe AIR cannot convert the URLRequest.data parameter from UTF8 to MBCS. This error is - applicable if the URLRequest object passed to load() is set to perform a GET operation - and if System.useCodePage is set to true.
    2. - -
  2. Flash Player or Adobe AIR cannot allocate memory for - the POST data. This error is applicable if the URLRequest object passed to load is set - to perform a POST operation.
-
 
SecurityError — Local untrusted SWF files may not communicate with - the Internet. This may be worked around by reclassifying this SWF file - as local-with-networking or trusted. -
 
SecurityError — You are trying to connect to a commonly reserved port. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide. -
-
- - - - - -
readBoolean()method 
-
-public function readBoolean():Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a Boolean value from the stream. A single byte is read, - and true is returned if the byte is nonzero, - false otherwise. - -

-Returns - - - - -
Boolean — - True is returned if the byte is nonzero, false otherwise. - - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
- - - - - -
readByte()method 
-
-public function readByte():int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a signed byte from the stream. -

The returned value is in the range -128...127.

- -

-Returns - - - - -
int — - Value in the range -128...127. - - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
- - - - - -
readBytes()method 
-
-public function readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads length bytes of data from the stream. - The bytes are read into the ByteArray object specified - by bytes, starting offset bytes into - the ByteArray object. - -

Parameters - - - - - - - - - - - - - - - - -
bytes:ByteArray — The ByteArray object to read - data into. -
 
offset:uint (default = 0) — The offset into bytes at which data - read should begin. Defaults to 0. -
 
length:uint (default = 0) — The number of bytes to read. The default value - of 0 will cause all available data to be read. - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, or the stream is not open. - -
-
- - - - - -
readDouble()method 
-
-public function readDouble():Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an IEEE 754 double-precision floating-point number from the stream. - -

-Returns - - - - -
Number — - An IEEE 754 double-precision floating-point number from the stream. - - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
- - - - - -
readFloat()method 
-
-public function readFloat():Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an IEEE 754 single-precision floating-point number from the stream. - -

-Returns - - - - -
Number — - An IEEE 754 single-precision floating-point number from the stream. - - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
- - - - - -
readInt()method 
-
-public function readInt():int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a signed 32-bit integer from the stream. -

The returned value is in the range -2147483648...2147483647.

- -

-Returns - - - - -
int — - Value in the range -2147483648...2147483647. - - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
- - - - - -
readMultiByte()method 
-
-public function readMultiByte(length:uint, charSet:String):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a multibyte string of specified length from the byte stream using the - specified character set. -

Parameters - - - - - - - - - - -
length:uint — The number of bytes from the byte stream to read. -
 
charSet:String — The string denoting the character set to use to interpret the bytes. - Possible character set strings include "shift_jis", "CN-GB", - "iso-8859-1", and others. - For a complete list, see Supported Character Sets. - -

Note: If the value for the charSet parameter is not recognized - by the current system, the application uses the system's default code page as the character set. - For example, a value for the charSet parameter, as in - myTest.readMultiByte(22, "iso-8859-01") that uses 01 instead of 1 - might work on your development machine, but not on another machine. On the other machine, - the application will use the system's default code page.

- -
-

-Returns - - - - -
String — - UTF-8 encoded string. - - -
-
-Throws - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
-
- - - - - -
readObject()method 
-
-public function readObject():* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Reads an object from the socket, encoded in Action Message Format (AMF). - -

-Returns - - - - -
* — The deserialized object. -
-
-Throws - - - - - - - - - - -
Error — There is insufficient data available - to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. -
 
Error — An I/O error occurred on the stream, - or the stream is not open. -
-

-See also -

-
-ObjectEncoding -
-
- - - - - -
readShort()method 
-
-public function readShort():int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a signed 16-bit integer from the stream. -

The returned value is in the range -32768...32767.

- -

-Returns - - - - -
int — - Value in the range -32768...32767. - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
- - - - - -
readUnsignedByte()method 
-
-public function readUnsignedByte():uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an unsigned byte from the stream. -

The returned value is in the range 0...255.

- -

-Returns - - - - -
uint — - Value in the range 0...255. - - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
- - - - - -
readUnsignedInt()method 
-
-public function readUnsignedInt():uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an unsigned 32-bit integer from the stream. -

The returned value is in the range 0...4294967295.

- -

-Returns - - - - -
uint — - Value in the range 0...4294967295. - - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
- - - - - -
readUnsignedShort()method 
-
-public function readUnsignedShort():uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads an unsigned 16-bit integer from the stream. -

The returned value is in the range 0...65535.

- -

-Returns - - - - -
uint — - Value in the range 0...65535. - - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
- - - - - -
readUTF()method 
-
-public function readUTF():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a UTF-8 string from the stream. The string - is assumed to be prefixed with an unsigned short indicating - the length in bytes. -

-Returns - - - - -
String — - A UTF-8 string. - - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
- - - - - -
readUTFBytes()method 
-
-public function readUTFBytes(length:uint):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Reads a sequence of length UTF-8 - bytes from the stream, and returns a string. - -

Parameters - - - - -
length:uint — A sequence of UTF-8 bytes. -
-

-Returns - - - - -
String — - A UTF-8 string produced by the byte representation of characters of specified length. - - - -
-
-Throws - - - - - - - - - - -
Error — There is insufficient - data available to read. If a local SWF file triggers a security warning, - Flash Player prevents the URLStream data from being available to ActionScript. - When this happens, the bytesAvailable property returns 0 even if data has been - received, and any of the read methods throws an EOFError exception. - This error applies to SWF content; it does not occur - in JavaScript code running in AIR. - -
 
Error — An I/O error occurred on the stream, - or the stream is not open. - -
-
-
Event detail
- - - - - -
certificateErrorevent 
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.CERTIFICATE_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51 -
-

- Dispatched if a call to URLStream.load() - attempts to load data from a server with an invalid certificate - (for example, self-signed or untrusted, or with an invalid date). - If a listener is added, any operating system standard behaviour will - be ignored, instead the default action will be to close down the - connection. To allow the default connection, you can call the - preventDefault() function on the error object. -

- The SecurityErrorEvent.CERTIFICATE_ERROR constant is used when the runtime detects a problem with a server's security certificate. This event - is then dispatched, giving the application the chance to handle this and determine whether to allow the connection or to block it (which is the default - behaviour). To allow it, call preventDefault() on the error object. Note that not handling this error type will result in the default operating system - behaviour - typically, a message will be displayed to the end user to allow them to choose the action. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelabletrue; default behavior is to close the connection, use preventDefault() to allow it.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
-
- - - - - -
completeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when data has loaded successfully. -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
- - - - - -
httpResponseStatusevent  
-
-Event object type: flash.events.HTTPStatusEvent -
-HTTPStatusEvent.type property = flash.events.HTTPStatusEvent.HTTP_RESPONSE_STATUS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -AIR 1.0 -
-

- Dispatched if a call to the URLStream.load() method attempts to access data over HTTP - and Adobe AIR is able to detect and return the status code for the request. - -

If a URLStream object registers for an httpStatusEvent event, error responses - are delivered as though they are content. So instead of dispatching an ioError - event, the URLStream dispatches progress and complete events as - the error data is loaded into the URLStream.

- -

- Unlike the httpStatus event, the httpResponseStatus event is - delivered before any response data. Also, the httpResponseStatus event includes - values for the responseHeaders and responseURL properties (which are - undefined for an httpStatus event. Note that the httpResponseStatus event - (if any) will be sent before (and in addition to) any complete or error - event. - -

The HTTPStatusEvent.HTTP_RESPONSE_STATUS constant defines the value of the - type property of a httpResponseStatus event object.

- - -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
responseURLThe URL from which the response was returned.
responseHeadersThe response headers that the response returned, - as an array of URLRequestHeader objects.
statusThe HTTP status code returned by the server.
redirectedWhether the reponse is the result of a redierct.
targetThe network object receiving an HTTP status code.
- -

-See also -

-
-URLStream.load() -
-
- - - - - -
httpStatusevent  
-
-Event object type: flash.events.HTTPStatusEvent -
-HTTPStatusEvent.type property = flash.events.HTTPStatusEvent.HTTP_STATUS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched if a call to URLStream.load() - attempts to access data over HTTP, and Flash Player or Adobe AIR - is able to detect and return the status code for the request. (Some browser environments - may not be able to provide this information.) Note that the httpStatus - (if any) will be sent before (and in addition to) any complete - or error event. - -

- The HTTPStatusEvent.HTTP_STATUS constant defines the value of the - type property of a httpStatus event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
statusThe HTTP status code returned by the server.
targetThe network object receiving an HTTP status code.
- -

-See also -

-
-URLStream.load() -
-
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when an input/output error occurs that causes a load operation to fail. -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -

-See also -

-
-URLStream.load() -
-
- - - - - -
openevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.OPEN -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when a load operation starts. -

- The Event.OPEN constant defines the value of the type property of an open event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has opened a connection.
- -

-See also -

-
-URLStream.load() -
-
- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when data is received as the download operation progresses. - Data that has been received can be read immediately using the methods of the URLStream class. -

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -

-See also -

-
-URLStream.load() -
-
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched if a call to URLStream.load() - attempts to load data from a server outside the security sandbox. - -

- The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- -

-See also -

-
-URLStream.load() -
-
- -
Examples
-
examples\URLStreamExample
-
The following example loads a SWF file and parses the beginning of its header to indicate - compression and version number information. - -

To run the example, place a file named URLStreamExample.swf in the same directory as your SWF file.

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.errors.*;
-    import flash.events.*;
-    import flash.net.URLRequest;
-    import flash.net.URLStream;
-
-    public class URLStreamExample extends Sprite {
-        private static const ZLIB_CODE:String = "CWS";
-        private var stream:URLStream;
-
-        public function URLStreamExample() {
-            stream = new URLStream();
-            var request:URLRequest = new URLRequest("URLStreamExample.swf");
-            configureListeners(stream);
-            try {
-                stream.load(request);
-            } catch (error:Error) {
-                trace("Unable to load requested URL.");
-            }
-        }
-
-        private function configureListeners(dispatcher:EventDispatcher):void {
-            dispatcher.addEventListener(Event.COMPLETE, completeHandler);
-            dispatcher.addEventListener(HTTPStatusEvent.HTTP_STATUS, httpStatusHandler);
-            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            dispatcher.addEventListener(Event.OPEN, openHandler);
-            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-        }
-
-        private function parseHeader():void {
-            trace("parseHeader");
-            trace("isCompressed: " + isCompressed());
-            trace("version: " + stream.readByte());
-        }
-
-        private function isCompressed():Boolean {
-            return (stream.readUTFBytes(3) == ZLIB_CODE);
-        }
-
-        private function completeHandler(event:Event):void {
-            trace("completeHandler: " + event);
-            parseHeader();
-        }
-
-        private function openHandler(event:Event):void {
-            trace("openHandler: " + event);
-        }
-
-        private function progressHandler(event:Event):void {
-            trace("progressHandler: " + event);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-
-        private function httpStatusHandler(event:HTTPStatusEvent):void {
-            trace("httpStatusHandler: " + event);
-        }
-
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("ioErrorHandler: " + event);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/URLVariables.html b/html-docs/flash/net/URLVariables.html deleted file mode 100644 index 88edf5d..0000000 --- a/html-docs/flash/net/URLVariables.html +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - - - -flash.net.URLVariables (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic dynamic class URLVariables
InheritanceURLVariables Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The URLVariables class allows you to transfer - variables between an application and a - server. - Use URLVariables objects with methods of the URLLoader - class, with the data property - of the URLRequest class, and with flash.net package - functions. - -

-

-View the examples. -

-

-See also -

-
-URLLoader -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-URLVariables(source:String = null)
-
- Creates a new URLVariables object.
-		URLVariables
   -
-decode(source:String):void -
-
- Converts the variable string to properties of the specified URLVariables object.
-		URLVariables
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string containing all enumerable variables, - in the MIME content encoding application/x-www-form-urlencoded.
-		URLVariables
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
URLVariables()constructor
-
-public function URLVariables(source:String = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a new URLVariables object. You pass URLVariables - objects to the data property of URLRequest objects. -

If you call the URLVariables constructor with a string, - the decode() method is automatically called - to convert the string to properties of the URLVariables object.

- Parameters - - - - -
source:String (default = null) — A URL-encoded string containing name/value pairs. -
-
- -
Method detail
- - - - - -
decode()method
-
-public function decode(source:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Converts the variable string to properties of the specified URLVariables object. -

This method is used internally by the URLVariables events. - Most users do not need to call this method directly.

- Parameters - - - - -
source:String — A URL-encoded query string containing name/value pairs. -
-
-Throws - - - - -
Error — The source parameter must be a URL-encoded query - string containing name/value pairs. -
-
-Example -
The following examples show how you can parse URL encoded strings. - Example provided by - ActionScriptExamples.com. -
-
-// The first method passes the string to be decoded to the URLVariables class constructor:
-var urlVariables:URLVariables = new URLVariables("firstName=Tom&lastName=Jones");
-lbl.text = urlVariables.lastName + "," + urlVariables.firstName;
-
-// The second method uses the decode() method to parse the URL encoded string:
-var urlVariables:URLVariables = new URLVariables();
-urlVariables.decode("firstName=Tom&lastName=Jones");
-lbl.text = urlVariables.lastName + "," + urlVariables.firstName;
-
-

-
- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string containing all enumerable variables, - in the MIME content encoding application/x-www-form-urlencoded. -

-Returns - - - - -
String — - A URL-encoded string containing name/value pairs. - - -
-
- -
Examples
-
examples\URLVariablesExample
-
The following example opens the remote application hosted at - http://www.[yourDomain].com/application.jsp in a new browser window and passes - data about a user session, captured in a URLVariables object, to the application. - - -

Highlights of the example follow:

-
    -
  1. The constructor function creates a URLRequest - instance named request, taking the URL of the remote application as a parameter.
    2. -
  2. A URLVariables object is created and two of its properties are assigned values.
    3. -
  3. The URLVariables object is assigned to the data property of the URLRequest object.
    4. -
  4. The example calls navigateToURL, which opens a new browser window - to the remote application's URL.
    5. -
- -

Note: To run the example, the remote application URL in the example must be replaced - with a working URL. Additionally, you would need server code - to process the information captured by Flash Player in the URLVariables object.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.net.navigateToURL;
-    import flash.net.URLRequest;
-    import flash.net.URLVariables;
-
-    public class URLVariablesExample extends Sprite {
-
-        public function URLVariablesExample() {
-            var url:String = "http://www.[yourDomain].com/application.jsp";
-            var request:URLRequest = new URLRequest(url);
-            var variables:URLVariables = new URLVariables();
-            variables.exampleSessionId = new Date().getTime();
-            variables.exampleUserLabel = "guest";
-            request.data = variables;
-            navigateToURL(request);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/XMLSocket.html b/html-docs/flash/net/XMLSocket.html deleted file mode 100644 index 27ed33e..0000000 --- a/html-docs/flash/net/XMLSocket.html +++ /dev/null @@ -1,1070 +0,0 @@ - - - - - - - - -flash.net.XMLSocket (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net
Classpublic class XMLSocket
InheritanceXMLSocket Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The XMLSocket class implements client sockets that let the - Flash Player or AIR application communicate - with a server computer identified by an IP address or domain name. The XMLSocket class is useful for - client-server applications that require low latency, such as real-time chat systems. A traditional - HTTP-based chat solution frequently polls the server and downloads new messages using an HTTP - request. In contrast, an XMLSocket chat solution maintains an open connection to the server, which - lets the server immediately send incoming messages without a request from the client. - To use the XMLSocket class, the server computer must run a daemon that understands the protocol used - by the XMLSocket class. The protocol is described in the following list: -
    -
  • XML messages are sent over a full-duplex TCP/IP stream socket connection.
    • -
  • Each XML message is a complete XML document, terminated by a zero (0) byte.
    • -
  • An unlimited number of XML messages can be sent and received over a single XMLSocket - connection.
    • -
- -

Setting up a server to communicate with the XMLSocket object can be challenging. If your application - does not require real-time interactivity, use the URLLoader class instead of the XMLSocket class.

-

To use the methods of the XMLSocket class, first use the constructor, new XMLSocket, - to create an XMLSocket object.

-

SWF files in the local-with-filesystem sandbox may not use sockets.

- -

Socket policy files on the target host specify the hosts from which SWF files - can make socket connections, and the ports to which those connections can be made. - The security requirements with regard to socket policy files have become more stringent - in the last several releases of Flash Player. - In all versions of Flash Player, Adobe recommends the use of a socket policy file; - in some circumstances, a socket policy file is required. Therefore, if you - are using XMLSocket objects, make sure that the target host provides a socket policy file - if necessary.

- -

The following list summarizes the requirements for socket policy files - in different versions of Flash Player:

-
    - -
  • In Flash Player 9.0.124.0 and later, a socket policy file is required for any XMLSocket connection. - That is, a socket policy file on the target host is required no matter what port - you are connecting to, and is required even if you are connecting - to a port on the same host that is serving the SWF file.
    • -
  • In Flash Player versions 9.0.115.0 and earlier, if you want to connect to a port number below 1024, - or if you want to connect to a host other than the one serving the SWF file, - a socket policy file on the target host is required.
    • -
  • In Flash Player 9.0.115.0, even if a socket policy file isn't required, - a warning is displayed when using the Flash Debug Player if the target host - doesn't serve a socket policy file.
    • -
- -

However, in Adobe AIR, content in the application security sandbox (content - installed with the AIR application) are not restricted by these security limitations.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

-

-View the examples. -

-

-See also -

-
-flash.net.URLLoader.load() -
-flash.net.URLLoader -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
  connected : Boolean -
[read-only] - Indicates whether this XMLSocket object is currently connected.
-		XMLSocket
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  timeout : int -
- Indicates the number of milliseconds to wait for a connection.
-		XMLSocket
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-XMLSocket(host:String = null, port:int = 0)
-
- Creates a new XMLSocket object.
-		XMLSocket
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-close():void -
-
- Closes the connection specified by the XMLSocket object.
-		XMLSocket
   -
-connect(host:String, port:int):void -
-
- Establishes a connection to the specified Internet host using the specified TCP port.
-		XMLSocket
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-send(object:*):void -
-
- Converts the XML object or data specified in the object parameter - to a string and transmits it to the server, followed by a zero (0) byte.
-		XMLSocket
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-close -
-		 - Dispatched when the server closes the socket connection.XMLSocket
   -
-connect -
-		 - Dispatched after a successful call to the XMLSocket.connect() method.XMLSocket
   -
-data -
-		 - Dispatched after raw data is sent or received.XMLSocket
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-ioError -
-		 - Dispatched when an input/output error occurs that causes a send or receive operation to fail.XMLSocket
   -
-securityError -
-		 - Dispatched if a call to the XMLSocket.connect() method - attempts to connect either to a server outside the caller's security sandbox or to a port lower than 1024.XMLSocket
-
- -
- -
Property detail
- - - - - -
connectedproperty
-
-connected:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether this XMLSocket object is currently connected. You can also check - whether the connection succeeded by registering for the connect - event and ioError event. - -

Implementation -
-    public function get connected():Boolean -
-

-See also -

-
-connect -
-ioError -
-
- - - - - -
timeoutproperty 
-
-timeout:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates the number of milliseconds to wait for a connection. -

If the connection doesn't succeed within the specified time, the connection fails. - The default value is 20,000 (twenty seconds).

- - Implementation -
-    public function get timeout():int -
-    public function set timeout(value:int):void -
-
- -
Constructor detail
- - - - - -
XMLSocket()constructor
-
-public function XMLSocket(host:String = null, port:int = 0) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a new XMLSocket object. If no parameters are specified, an initially disconnected socket - is created. If parameters are specified, a connection is attempted to the specified host and port. -

Note: It is strongly advised to use the constructor form without parameters, then - add any event listeners, then call the connect method with host - and port parameters. This sequence guarantees that all event listeners will work - properly.

- Parameters - - - - - - - - - - -
host:String (default = null) — A fully qualified DNS domain name or an IP address in the form - .222.333.444. In Flash Player 9.0.115.0 and AIR 1.0 and later, - you can specify IPv6 addresses, such as rtmp://[2001:db8:ccc3:ffff:0:444d:555e:666f]. - You can also specify null to connect to the host server - on which the SWF file resides. If the SWF file issuing this call is running in a web browser, - host must be in the same domain as the SWF file. - -
 
port:int (default = 0) — The TCP port number on the target host used to establish a connection. - In Flash Player 9.0.124.0 and later, the target host must serve a socket policy file - specifying that socket connections are permitted from the host serving the SWF file - to the specified port. In earlier versions of Flash Player, a socket policy file is required - only if you want to connect to a port number below 1024, - or if you want to connect to a host other than the one serving the SWF file. -
-

-See also -

-
-connect() -
-
- -
Method detail
- - - - - -
close()method
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Closes the connection specified by the XMLSocket object. - The close event is dispatched only when the server - closes the connection; it is not dispatched when you call the close() method. -

-See also -

-
-connect() -
-
- - - - - -
connect()method 
-
-public function connect(host:String, port:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Establishes a connection to the specified Internet host using the specified TCP port. -

If you specify null for the host parameter, the host - contacted is the one where the file calling XMLSocket.connect() resides. - For example, if the calling file was downloaded from www.adobe.com, specifying null - for the host parameter means you are connecting to www.adobe.com.

- - -

You can prevent a file from using this method by setting the - allowNetworking parameter of the the object and embed - tags in the HTML page that contains the SWF content.

- -

For more information, see the Flash Player Developer Center Topic: - Security.

- Parameters - - - - - - - - - - -
host:String — A fully qualified DNS domain name or an IP address in the form - 111.222.333.444. You can also specify null to connect to the host server - on which the SWF file resides. If the calling file is a SWF file running in a web browser, - host must be in the same domain as the file. - -
 
port:int — The TCP port number on the target host used to establish a connection. - In Flash Player 9.0.124.0 and later, the target host must serve a socket policy file - specifying that socket connections are permitted from the host serving the SWF file - to the specified port. In earlier versions of Flash Player, a socket policy file is required - only if you want to connect to a port number below 1024, - or if you want to connect to a host other than the one serving the SWF file. -
-
-Events - - - - - - - - - - - - - - - - -
securityError:SecurityErrorEvent — A connect operation attempted - to connect to a host outside the caller's security sandbox, or - to a port that requires a socket policy file. Work around either problem by using - a socket policy file on the target host.
 
data:DataEvent — Dispatched when raw data has been received.
 
connect:Event — Dispatched when network connection has been established.
-
-Throws - - - - - - - - - - -
SecurityError — Local untrusted files may not communicate with - the Internet. Work around this limitation by reclassifying the file - as local-with-networking or trusted. -
 
SecurityError — You may not specify a socket port higher than - 65535. -
-

-See also -

-
-flash.events.Event.CONNECT -
-
- - - - - -
send()method 
-
-public function send(object:*):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Converts the XML object or data specified in the object parameter - to a string and transmits it to the server, followed by a zero (0) byte. If object - is an XML object, the string is the XML textual representation of the XML object. The - send operation is asynchronous; it returns immediately, but the data may be transmitted at a - later time. The XMLSocket.send() method does not return a value indicating whether - the data was successfully transmitted. - -

If you do not connect the XMLSocket object to the server using - XMLSocket.connect()), the XMLSocket.send() - operation fails.

- Parameters - - - - -
object:* — An XML object or other data to transmit to the server. -
-
-Throws - - - - -
Error — The XMLSocket object is not connected to the server. - -
-

-See also -

-
-connect() -
-
-
Event detail
- - - - - -
closeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CLOSE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when the server closes the socket connection. - The close event is dispatched only when the server - closes the connection; it is not dispatched when you call the XMLSocket.close() method. -

- The Event.CLOSE constant defines the value of the type property of a close event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object whose connection has been closed.
- -
- - - - - -
connectevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CONNECT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched after a successful call to the XMLSocket.connect() method. -

- The Event.CONNECT constant defines the value of the type property of a connect event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Socket or XMLSocket object that has established a network connection.
- -
- - - - - -
dataevent  
-
-Event object type: flash.events.DataEvent -
-DataEvent.type property = flash.events.DataEvent.DATA -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched after raw data is sent or received. -

- Defines the value of the type property of a data event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
dataThe raw data loaded into Flash Player or Adobe AIR.
targetThe XMLSocket object receiving data.
- -
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched when an input/output error occurs that causes a send or receive operation to fail. -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched if a call to the XMLSocket.connect() method - attempts to connect either to a server outside the caller's security sandbox or to a port lower than 1024. -

- The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- -

-See also -

-
-XMLSocket.connect() -
-
- -
Examples
-
examples\XMLSocketExample
-
The following example uses the class XMLSocketExample class to send data using - an XMLSocket and print information during XMLSocket events. This is accomplished using - the following steps: -
    -
  1. The XMLSocketExample constructor creates a XMLSocket instance named socket and - passes socket to ConfigureListeners() (described below) and then calls the - connect() method of XMLSocket using the host name "localhost" and port - number of 8080.
    2. -
  2. The configureListeners() method is then called, which adds listeners for each of the - supported XMLSocket events: -
      -
    • closeHandler(): listens for the close event, which is dispatched - after the network connection has been closed.
      • -
    • connectHandler(): listens for the connect event, dispatched when the network - connection has been established.
      • -
    • dataHandler(): listens for the data events, dispatched every time - the XMLSocket receives new data.
      • -
    • progressHandler(): listens for the progress events, dispatched when a call to - send() has been made and while the send is ongoing.
      • -
    • securityErrorHandler(): listens for securityError events, which would be - dispatched if an attempt was made to access the XMLSocket with the wrong local playback security setting or - using a port lower than 1024.
      • -
    • ioErrorHandler(): listens for ioError events, which would happen only - if an operation to send or receive data failed.
      • -
    3. -
- -

Notes: -

    -
  • You need to compile the SWF file with "Local playback security" set to "Access network only".
    • - -
  • You need a server running on your domain using port 8080 for this example to work.
    • - -
  • If you are running Flash Player 9.0.124.0 or later, you need to place a socket policy file on your server - that permits socket connections from your domain to port 8080. For information on serving socket policy files, - see the Flash Player Developer Center Topic: - - Setting up a socket policy file server.
    • -
-

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.*;
-    import flash.net.XMLSocket;
-
-    public class XMLSocketExample extends Sprite {
-        private var hostName:String = "localhost";
-        private var port:uint = 8080;
-        private var socket:XMLSocket;
-
-        public function XMLSocketExample() {
-            socket = new XMLSocket();
-            configureListeners(socket);
-            if (hostName && port) {
-                socket.connect(hostName, port);
-            }
-        }
-
-        public function send(data:Object):void {
-            socket.send(data);
-        }
-
-        private function configureListeners(dispatcher:IEventDispatcher):void {
-            dispatcher.addEventListener(Event.CLOSE, closeHandler);
-            dispatcher.addEventListener(Event.CONNECT, connectHandler);
-            dispatcher.addEventListener(DataEvent.DATA, dataHandler);
-            dispatcher.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-            dispatcher.addEventListener(ProgressEvent.PROGRESS, progressHandler);
-            dispatcher.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
-        }
-
-        private function closeHandler(event:Event):void {
-            trace("closeHandler: " + event);
-        }
-
-        private function connectHandler(event:Event):void {
-            trace("connectHandler: " + event);
-        }
-
-        private function dataHandler(event:DataEvent):void {
-            trace("dataHandler: " + event);
-        }
-
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("ioErrorHandler: " + event);
-        }
-
-        private function progressHandler(event:ProgressEvent):void {
-            trace("progressHandler loaded:" + event.bytesLoaded + " total: " + event.bytesTotal);
-        }
-
-        private function securityErrorHandler(event:SecurityErrorEvent):void {
-            trace("securityErrorHandler: " + event);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/dns/AAAARecord.html b/html-docs/flash/net/dns/AAAARecord.html deleted file mode 100644 index 3b28931..0000000 --- a/html-docs/flash/net/dns/AAAARecord.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - - - -flash.net.dns.AAAARecord (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.dns
Classpublic class AAAARecord
InheritanceAAAARecord Inheritance ResourceRecord Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The AAAARecord class represents a Domain Name System (DNS) AAAA resource record containing an IPv6 address. - -

AAAA resource records are returned by a DNSResolver object as a result of a DNS lookup of a domain name.

- -

-

-See also -

-
-DNSResolver class -
-ARecord class -
-SRVRecord class -
-MXRecord class -
-PTRRecord class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  address : String -
- The IPv6 address.
-		AAAARecord
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedname : String -
- The query string used to look up this resource record.
-		ResourceRecord
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedttl : int -
- The resource time-to-live (ttl) value.
-		ResourceRecord
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-AAAARecord()
-
- Creates an AAAA resource record.
-		AAAARecord
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
addressproperty
-
-address:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The IPv6 address. - -

Implementation -
-    public function get address():String -
-    public function set address(value:String):void -
-
- -
Constructor detail
- - - - - -
AAAARecord()constructor
-
-public function AAAARecord() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates an AAAA resource record. - -

AAAA records are obtained from a DNS lookup using the DNSResolver class. Application code should not create - AAAARecord objects.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/dns/ARecord.html b/html-docs/flash/net/dns/ARecord.html deleted file mode 100644 index 81719e6..0000000 --- a/html-docs/flash/net/dns/ARecord.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - - - -flash.net.dns.ARecord (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.dns
Classpublic class ARecord
InheritanceARecord Inheritance ResourceRecord Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The ARecord class represents a Domain Name System (DNS) A resource record containing an IPv4 address. - -

A resource records are returned by a DNSResolver object as a result of a DNS lookup of a domain name.

- -

-

-See also -

-
-DNSResolver class -
-AAAARecord class -
-MXRecord class -
-PTRRecord class -
-SRVRecord class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  address : String -
- The IPv4 address.
-		ARecord
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedname : String -
- The query string used to look up this resource record.
-		ResourceRecord
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedttl : int -
- The resource time-to-live (ttl) value.
-		ResourceRecord
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ARecord()
-
- Creates an A resource record.
-		ARecord
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
addressproperty
-
-address:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The IPv4 address. - -

Implementation -
-    public function get address():String -
-    public function set address(value:String):void -
-
- -
Constructor detail
- - - - - -
ARecord()constructor
-
-public function ARecord() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates an A resource record. - -

A records are obtained from a DNS lookup using the DNSResolver class. Application code should not create - ARecord objects.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/dns/DNSResolver.html b/html-docs/flash/net/dns/DNSResolver.html deleted file mode 100644 index 2b9c298..0000000 --- a/html-docs/flash/net/dns/DNSResolver.html +++ /dev/null @@ -1,651 +0,0 @@ - - - - - - - - -flash.net.dns.DNSResolver (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.dns
Classpublic class DNSResolver
InheritanceDNSResolver Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 -
-

-

- The DNSResolver class lets you lookup Domain Name System (DNS) resource records. - -

AIR profile support: This feature is supported on - all desktop operating systems, but is not supported on mobile devices. It is partially supported - on AIR for TV devices. You can test for - support at run time using the DNSResolver.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

You can look up the following types of resource records:

-
    -
  • ARecord: IPv4 address for a host.
    • -
  • AAAARecord: IPv6 address for a host.
    • -
  • MXRecord: mail exchange record for a host.
    • -
  • PTRRecord: host name for an IP address.
    • -
  • SRVRecord: service record for a service
    • -
-

The following table indicates DNS lookup support on AIR for TV devices. - Unsupported requests result in the DNSResolver object dispatching an flash.events.ErrorEvent object.

- - - - - - - -
Record type specified in DNSResolver.lookup()Support
ARecordFull support
AAAARecordFull support
MXRecordNot supported
PTRRecordSupported only for IPv4 addresses, not for IPv6 addresses
SRVRecordNot supported
-

-

-View the examples. -

-

-See also -

-
-ARecord -
-AAAARecord -
-MXRecord -
-PTRRecord -
-SRVRecord -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - Indicates whether DNS lookups are supported on the client system.
-		DNSResolver
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DNSResolver()
-
- Creates a DNSResolver object.
-		DNSResolver
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-lookup(host:String, recordType:Class):void -
-
- Looks up a DNS resource record based on a query string.
-		DNSResolver
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-error -
-		 - Dispatched when an error occurred during a DNS lookup.DNSResolver
   -
-lookup -
-		 - Dispatched when a DNS look-up is complete.DNSResolver
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Runtime version: AIR 2 -
-

- Indicates whether DNS lookups are supported on the client system. - -

Implementation -
-    public static function get isSupported():Boolean -
-
- -
Constructor detail
- - - - - -
DNSResolver()constructor
-
-public function DNSResolver() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a DNSResolver object. - -

- -
Method detail
- - - - - -
lookup()method
-
-public function lookup(host:String, recordType:Class):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Looks up a DNS resource record based on a query string. - -

The lookup() method performs a DNS lookup asynchronously. - Listen for the lookup event to get the results of the lookup. Listen for - the error event to receive errors. Results are dispatched in a DNSResolverEvent - object.

- -

To specify the type of resource record to look up, pass the corresponding class - in the recordType parameter. (Pass the class name itself and not a string - containing the class name.)

- -

The content of the query string passed to the method depends on the type of - resource record being looked up. The following list illustrates the query string to use for - each record type.

- - - - - - - - -
Record typeQuery stringExample
ARecordhost name"example.com"
AAAARecordhost name"example.com"
MXRecordhost name"example.com"
PTRRecordIP address"208.77.188.166"
SRVRecord_service._protocol.host."_sip._tcp.example.com."
- - Parameters - - - - - - - - - - -
host:String — the query string, such as a host name, IP address, or service locator. -
 
recordType:Class — The class representing the type of DNS resource record to look up. - -
-
-Events - - - - - - - - - - -
lookup:DNSResolverEvent — dispatched when the lookup is completed successfully.
 
error:ErrorEvent — dispatched when the lookup fails (including when no records exist).
-
-Throws - - - - -
ArgumentError — The host parameter value is not an appropriate query string or the recordType class is not recognized. - -
-

-See also -

-
-DNSResolverEvent -
-
-
Event detail
- - - - - -
errorevent 
-
-Event object type: flash.events.ErrorEvent -
-ErrorEvent.type property = flash.events.ErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when an error occurred during a DNS lookup. - -

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -
- - - - - -
lookupevent  
-
-Event object type: flash.events.DNSResolverEvent -
-DNSResolverEvent.type property = flash.events.DNSResolverEvent.LOOKUP -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when a DNS look-up is complete. - -

- Defines the value of the type property of a lookup event object. - -

- -
Examples
-
examples\DNSResolverExample
-
The following example shows how to look up the supported types of DNS records: -
-
-package
-{
-    import flash.desktop.NativeApplication;
-	import flash.display.Sprite;
-	import flash.events.DNSResolverEvent;
-	import flash.events.ErrorEvent;
-	import flash.events.Event;
-	import flash.events.MouseEvent;
-	import flash.net.dns.AAAARecord;
-	import flash.net.dns.ARecord;
-	import flash.net.dns.DNSResolver;
-	import flash.net.dns.MXRecord;
-	import flash.net.dns.PTRRecord;
-	import flash.net.dns.SRVRecord;
-	import flash.utils.getQualifiedClassName;
-	
-	public class DNSResolverExample extends Sprite
-	{
-		private var resolver:DNSResolver = new DNSResolver();
-		
-		public function DNSResolverExample()
-		{
-			resolver.addEventListener( DNSResolverEvent.LOOKUP, lookupComplete );
-			resolver.addEventListener( ErrorEvent.ERROR, lookupError );
-			
-			//Look up records
-			resolver.lookup( "www.example.com", ARecord );
-			resolver.lookup( "example.com", AAAARecord );
-			resolver.lookup( "example.com", MXRecord );
-			resolver.lookup( "208.77.188.166", PTRRecord );
-			resolver.lookup( "127.0.0.1", PTRRecord );
-			resolver.lookup( "2001:1890:110b:1e19:f06b:72db:7026:3d7a", PTRRecord );
-			resolver.lookup( "_sip._tcp.example.com.", SRVRecord );
-			resolver.lookup( "www.example.com", ARecord );
-			
-			this.stage.nativeWindow.activate();
-		}
-		
-		private function lookupComplete( event:DNSResolverEvent ):void
-		{
-			trace( "Query string: " + event.host );
-			trace( "Record type: " +  flash.utils.getQualifiedClassName( event.resourceRecords[0] ) + 
-				", count: " + event.resourceRecords.length );
-			for each( var record in event.resourceRecords )
-			{
-				if( record is ARecord ) trace( record.name + " : " + record.address );
-				if( record is AAAARecord ) trace( record.name + " : " + record.address );
-				if( record is MXRecord ) trace( record.name + " : " + record.exchange + ", " + record.preference );
-				if( record is PTRRecord ) trace( record.name + " : " + record.ptrdName );
-				if( record is SRVRecord ) trace( record.name + " : " + record.target + ", " + record.port +
-					", " + record.priority + ", " + record.weight );
-			}			
-		}
-		
-		private function lookupError( error:ErrorEvent ):void
-		{
-			trace("Error: " + error.text );
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/dns/MXRecord.html b/html-docs/flash/net/dns/MXRecord.html deleted file mode 100644 index 8161ac0..0000000 --- a/html-docs/flash/net/dns/MXRecord.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - - - -flash.net.dns.MXRecord (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.dns
Classpublic class MXRecord
InheritanceMXRecord Inheritance ResourceRecord Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The MXRecord class represents a Domain Name System (DNS) MX resource record containing a mail exchange server address. - -

MX resource records are returned by a DNSResolver object as a result of a DNS lookup on a domain name. - More than one record can be returned by a single lookup if more than one mail exchange is available.

- -

-

-See also -

-
-DNSResolver class -
-ARecord class -
-AAAARecord class -
-PTRRecord class -
-SRVRecord class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  exchange : String -
- The host name of a mail exchange service.
-		MXRecord
 Inheritedname : String -
- The query string used to look up this resource record.
-		ResourceRecord
  preference : int -
- The priority of the mail exchange identified by this record.
-		MXRecord
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedttl : int -
- The resource time-to-live (ttl) value.
-		ResourceRecord
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-MXRecord()
-
- Creates an MX resource record.
-		MXRecord
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
exchangeproperty
-
-exchange:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The host name of a mail exchange service. - -

Implementation -
-    public function get exchange():String -
-    public function set exchange(value:String):void -
-
- - - - - -
preferenceproperty 
-
-preference:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The priority of the mail exchange identified by this record. - -

Lower values are higher priority.

- - Implementation -
-    public function get preference():int -
-    public function set preference(value:int):void -
-
- -
Constructor detail
- - - - - -
MXRecord()constructor
-
-public function MXRecord() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates an MX resource record. - -

MX records are obtained from a DNS lookup using the DNSResolver class. Application code should not create - MXRecord objects.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/dns/PTRRecord.html b/html-docs/flash/net/dns/PTRRecord.html deleted file mode 100644 index 126afc3..0000000 --- a/html-docs/flash/net/dns/PTRRecord.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - - - -flash.net.dns.PTRRecord (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.dns
Classpublic class PTRRecord
InheritancePTRRecord Inheritance ResourceRecord Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The PTRRecord class represents a Domain Name System (DNS) PTR resource record containing a canonical domain name. - -

PTR resource records are returned by a DNSResolver object as a result of a DNS lookup of an IP address.

- -

-

-See also -

-
-DNSResolver class -
-ARecord class -
-AAAARecord class -
-MXRecord class -
-SRVRecord class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedname : String -
- The query string used to look up this resource record.
-		ResourceRecord
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  ptrdName : String -
- The canonical domain name assigned to the query IP address.
-		PTRRecord
 Inheritedttl : int -
- The resource time-to-live (ttl) value.
-		ResourceRecord
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-PTRRecord()
-
- Creates a PTR resource record.
-		PTRRecord
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
ptrdNameproperty
-
-ptrdName:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The canonical domain name assigned to the query IP address. - -

Implementation -
-    public function get ptrdName():String -
-    public function set ptrdName(value:String):void -
-
- -
Constructor detail
- - - - - -
PTRRecord()constructor
-
-public function PTRRecord() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a PTR resource record. - -

PTR records are obtained from a DNS lookup using the DNSResolver class. Application code should not create - PTRRecord objects.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/dns/ResourceRecord.html b/html-docs/flash/net/dns/ResourceRecord.html deleted file mode 100644 index 9b3466c..0000000 --- a/html-docs/flash/net/dns/ResourceRecord.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - -flash.net.dns.ResourceRecord (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.net.dns
Classpublic class ResourceRecord
InheritanceResourceRecord Inheritance Object
SubclassesAAAARecord, ARecord, MXRecord, PTRRecord, SRVRecord
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The ResourceRecord class is the base class for Domain Name System (DNS) resource record classes. - -

DNS resource records are returned by a DNSResolver object as a result of a DNS lookup.

- -

-

-See also -

-
-DNSResolver class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  name : String -
- The query string used to look up this resource record.
-		ResourceRecord
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  ttl : int -
- The resource time-to-live (ttl) value.
-		ResourceRecord
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
nameproperty
-
-name:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The query string used to look up this resource record. - -

Implementation -
-    public function get name():String -
-    public function set name(value:String):void -
-
- - - - - -
ttlproperty 
-
-ttl:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The resource time-to-live (ttl) value. - -

The length of time (in seconds) that the resource record is valid. Records should not be cached - for longer than this value. A ttl of zero means the record is volatile and must not be cached. A ttl - less than zero means that the resource record is not valid.

- - Implementation -
-    public function get ttl():int -
-    public function set ttl(value:int):void -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/dns/SRVRecord.html b/html-docs/flash/net/dns/SRVRecord.html deleted file mode 100644 index 94518b1..0000000 --- a/html-docs/flash/net/dns/SRVRecord.html +++ /dev/null @@ -1,415 +0,0 @@ - - - - - - - - -flash.net.dns.SRVRecord (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.dns
Classpublic class SRVRecord
InheritanceSRVRecord Inheritance ResourceRecord Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

-

- The SRVRecord class represents a Domain Name System (DNS) SRV resource record containing a service host. - -

SRV resource records are returned by a DNSResolver object as a result of a DNS lookup on a service locator. - More than one record can be returned by a single lookup if more than one service host is available.

- -

-

-See also -

-
-DNSResolver class -
-ARecord class -
-AAAARecord class -
-MXRecord class -
-PTRRecord class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedname : String -
- The query string used to look up this resource record.
-		ResourceRecord
  port : int -
- The port the service is using on the server.
-		SRVRecord
  priority : int -
- The priority of the service host identified by this record.
-		SRVRecord
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  target : String -
- The canonical host name of the server providing the service.
-		SRVRecord
 Inheritedttl : int -
- The resource time-to-live (ttl) value.
-		ResourceRecord
  weight : int -
- The relative weight to use when selecting from service hosts that have the same priority.
-		SRVRecord
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SRVRecord()
-
- Creates an SRV resource record.
-		SRVRecord
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
portproperty
-
-port:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The port the service is using on the server. - -

Implementation -
-    public function get port():int -
-    public function set port(value:int):void -
-
- - - - - -
priorityproperty 
-
-priority:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The priority of the service host identified by this record. - -

Lower values are higher priority.

- - Implementation -
-    public function get priority():int -
-    public function set priority(value:int):void -
-
- - - - - -
targetproperty 
-
-target:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The canonical host name of the server providing the service. - -

Implementation -
-    public function get target():String -
-    public function set target(value:String):void -
-
- - - - - -
weightproperty 
-
-weight:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The relative weight to use when selecting from service hosts that have the same priority. - -

Implementation -
-    public function get weight():int -
-    public function set weight(value:int):void -
-
- -
Constructor detail
- - - - - -
SRVRecord()constructor
-
-public function SRVRecord() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates an SRV resource record. - -

SRV records are obtained from a DNS lookup using the DNSResolver class. Application code should not create - SRVRecord objects.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/dns/package-detail.html b/html-docs/flash/net/dns/package-detail.html deleted file mode 100644 index 66d120e..0000000 --- a/html-docs/flash/net/dns/package-detail.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - -flash.net.dns Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 AAAARecord - The AAAARecord class represents a Domain Name System (DNS) AAAA resource record containing an IPv6 address.
 ARecord - The ARecord class represents a Domain Name System (DNS) A resource record containing an IPv4 address.
 DNSResolver - The DNSResolver class lets you lookup Domain Name System (DNS) resource records.
 MXRecord - The MXRecord class represents a Domain Name System (DNS) MX resource record containing a mail exchange server address.
 PTRRecord - The PTRRecord class represents a Domain Name System (DNS) PTR resource record containing a canonical domain name.
 ResourceRecord - The ResourceRecord class is the base class for Domain Name System (DNS) resource record classes.
 SRVRecord - The SRVRecord class represents a Domain Name System (DNS) SRV resource record containing a service host.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/net/drm/AuthenticationMethod.html b/html-docs/flash/net/drm/AuthenticationMethod.html deleted file mode 100644 index e93fef7..0000000 --- a/html-docs/flash/net/drm/AuthenticationMethod.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - -flash.net.drm.AuthenticationMethod (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.drm
Classpublic final class AuthenticationMethod
InheritanceAuthenticationMethod Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The AuthenticationMethod class provides string constants enumerating the - different types of authentication used by the authenticationMethod - property of the DRMContentData class. - -

-

-See also -

-
-flash.net.drm.DRMContentData -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  ANONYMOUS : String = "anonymous"
[static] - Indicates that no authentication is required.
-		AuthenticationMethod
  USERNAME_AND_PASSWORD : String = "usernameAndPassword"
[static] - Indicates that a valid user name and password are required.
-		AuthenticationMethod
-
- -
- -
Constant detail
- - - - - -
ANONYMOUSconstant
-
-public static const ANONYMOUS:String = "anonymous" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that no authentication is required. - -

- - - - - -
USERNAME_AND_PASSWORDconstant 
-
-public static const USERNAME_AND_PASSWORD:String = "usernameAndPassword" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that a valid user name and password are required. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/drm/DRMContentData.html b/html-docs/flash/net/drm/DRMContentData.html deleted file mode 100644 index fabfb5a..0000000 --- a/html-docs/flash/net/drm/DRMContentData.html +++ /dev/null @@ -1,467 +0,0 @@ - - - - - - - - -flash.net.drm.DRMContentData (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.drm
Classpublic class DRMContentData
InheritanceDRMContentData Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The DRMContentData class provides the information required to - obtain the voucher necessary to view DRM-protected content. - -

(AIR only) A DRMContentData object can be obtained from a NetStream instance by calling - the NetStream preloadEmbeddedContent() method and providing an - onDRMContentData callback function on the NetStream client object. - Use the DRMContentData object passed to the callback function as a parameter - for the DRMManager loadVoucher() method.

-

When you package content with Flash Access, you have the option of saving the content's metadata - as a separate file. To create a new DRMContentData object, get this metadata with a URLLoader object - and pass it to the DRMContentData constructor.

- -

-

-See also -

-
-flash.net.NetStream -
-flash.net.drm.DRMManager -
-flash.net.drm.DRMVoucher -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  authenticationMethod : String -
[read-only] - The type of authentication required to obtain a voucher for the associated content.
-		DRMContentData
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  domain : String -
[read-only] - The content domain of the media rights server to which the user must be authenticated - to obtain the voucher for the associated content.
-		DRMContentData
  licenseID : String -
[read-only] - A unique id identifying the content associated with this metadata on - the media rights server.
-		DRMContentData
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  serverURL : String -
[read-only] - The URL of a media rights server that - provides the voucher that is required to view the associated content.
-		DRMContentData
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DRMContentData(rawData:ByteArray = null)
-
- Constructor.
-		DRMContentData
   -
-getVoucherAccessInfo():Vector.<VoucherAccessInfo>
-
- Retrieves an array of VoucherAccessInfo objects.
-		DRMContentData
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
authenticationMethodproperty
-
-authenticationMethod:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The type of authentication required to obtain a voucher for the associated content. - -

The supported types of authentication are:

-
    -
  • AuthenticationMethod.ANONYMOUS — anyone can obtain a voucher.
    • -
  • AuthenticationMethod.USERNAME_AND_PASSWORD — the user must supply a valid - username and password of an account that is authorized to view the associated content.
    • -
- -

The AuthenticationMethod class provides string constants to use with the - authenticationMethod property.

- - Implementation -
-    public function get authenticationMethod():String -
-
- - - - - -
domainproperty 
-
-domain:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The content domain of the media rights server to which the user must be authenticated - to obtain the voucher for the associated content. - - -

Note: The domain returned by this property has nothing to do with - network or Internet domain names. In this case, a domain is a group - of content or user accounts. For example, a single server could support several - domains, each with its own set of content channels and subscribers.

- - Implementation -
-    public function get domain():String -
-
- - - - - -
licenseIDproperty 
-
-licenseID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A unique id identifying the content associated with this metadata on - the media rights server. - -

Implementation -
-    public function get licenseID():String -
-
- - - - - -
serverURLproperty 
-
-serverURL:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The URL of a media rights server that - provides the voucher that is required to view the associated content. - -

Implementation -
-    public function get serverURL():String -
-
- -
Constructor detail
- - - - - -
DRMContentData()constructor
-
-public function DRMContentData(rawData:ByteArray = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Constructor. - -

Parameters - - - - -
rawData:ByteArray (default = null)
-
- -
Method detail
- - - - - -
getVoucherAccessInfo()method
-
-public function getVoucherAccessInfo():Vector.<VoucherAccessInfo> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Retrieves an array of VoucherAccessInfo objects. The array contains at least 1 - VoucherAccessInfo object, the default. -

Each VoucherAccessInfo object represents a policy, which contains - the requirements for retrieving a voucher from the media rights server. - For example, if the server requires the user to authenticate, the VoucherAccessInfo object - contains the authentication method. If the server requires the computer to be registered - with a Realm server, the object contains the URL to the Realm server.

- -

-Returns - - - - -
Vector.<VoucherAccessInfo>
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/drm/DRMDeviceGroup.html b/html-docs/flash/net/drm/DRMDeviceGroup.html deleted file mode 100644 index 2dfa0bb..0000000 --- a/html-docs/flash/net/drm/DRMDeviceGroup.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - - - -flash.net.drm.DRMDeviceGroup (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.drm
Classpublic final class DRMDeviceGroup
InheritanceDRMDeviceGroup Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

-

- A device group signifies a group of playback devices that shares protected-content playback rights. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  authenticationMethod : String -
[read-only] - The type of authentication required to register to this device group.
-		DRMDeviceGroup
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  domain : String -
[read-only] - The content domain of the device group registration server to which the user must be - authenticated before registering to this device group.
-		DRMDeviceGroup
  name : String -
- The domain name of this device group.
-		DRMDeviceGroup
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  serverURL : String -
[read-only] - The URL of the registration server for this device group.
-		DRMDeviceGroup
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
authenticationMethodproperty
-
-authenticationMethod:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- The type of authentication required to register to this device group. - -

The supported types of authentication are:

-
    -
  • AuthenticationMethod.ANONYMOUS — anyone can register.
    • -
  • AuthenticationMethod.USERNAME_AND_PASSWORD — the user must supply a valid - username and password of an account that is authorized to register to this device group.
    • -
- -

The AuthenticationMethod class provides string constants to use with the - authenticationMethod property.

- - Implementation -
-    public function get authenticationMethod():String -
-
- - - - - -
domainproperty 
-
-domain:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- The content domain of the device group registration server to which the user must be - authenticated before registering to this device group. - - -

Note: The domain returned by this property has nothing to do with - network or Internet domain names. In this case, a domain is a group - of content or user accounts. For example, a single server could support several - domains, each with its own set of content channels and subscribers.

- - Implementation -
-    public function get domain():String -
-
- - - - - -
nameproperty 
-
-name:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.9 -
-

- The domain name of this device group. This value is only set on the object - returned in the DRMDeviceGroupEvent dispatched from DRMManager.addToDeviceGroup - on success. - - -

Note: The domain returned by this property has nothing to do with - network or Internet domain names. In this case, a domain is the name of this - device group. -

- Implementation -
-    public function get name():String -
-    public function set name(value:String):void -
-
- - - - - -
serverURLproperty 
-
-serverURL:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- The URL of the registration server for this device group. - -

Implementation -
-    public function get serverURL():String -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/drm/DRMManager.html b/html-docs/flash/net/drm/DRMManager.html deleted file mode 100644 index 9c13f37..0000000 --- a/html-docs/flash/net/drm/DRMManager.html +++ /dev/null @@ -1,1135 +0,0 @@ - - - - - - - - -flash.net.drm.DRMManager (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.drm
Classpublic class DRMManager
InheritanceDRMManager Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The DRMManager manages the retrieval and storage of the vouchers needed to view - DRM-protected content. With the static DRMManager.getDRMManager() method, you can - access the existing DRMManager object to perform the following DRM-management tasks: -
    -
  • Preload vouchers from a media rights server, using a DRMContentData object.
    • -
  • Query the local cache for an individual voucher, using a DRMContentData object.
    • -
  • Reset all vouchers (AIR only)
    • -
- -

No method is provided for enumerating all the vouchers in the local cache.

- -

Do not create an instance of the DRMManager class. Use the static - DRMManager.getDRMManager() to access the existing DRMManager object.

-

AIR profile support: This feature is supported - on all desktop operating systems and AIR for TV devices, but it is not supported on mobile devices. You can test - for support at run time using the DRMManager.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

-

-See also -

-
-flash.net.NetStream -
-flash.net.drm.DRMVoucher -
-flash.net.drm.DRMContentData -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - The isSupported property is set to true if the - DRMManager class is supported on the current platform, otherwise it is - set to false.
-		DRMManager
  networkIdleTimeout : Number -
[static]
-		DRMManager
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-addToDeviceGroup(deviceGroup:DRMDeviceGroup, forceRefresh:Boolean = false):void -
-
- adds the currently running device to a device group.
-		DRMManager
   -
-authenticate(serverURL:String, domain:String, username:String, password:String):void -
-
- Authenticates a user.
-		DRMManager
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-getDRMManager():DRMManager -
-
[static] - Returns an instance of the singleton DRMManager object.
-		DRMManager
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-loadPreviewVoucher(contentData:DRMContentData):void -
-
- Gets a preview voucher from the license server, which you can use to let a user verify - that they can play content on particular computer.
-		DRMManager
   -
-loadVoucher(contentData:DRMContentData, setting:String):void -
-
- Loads a voucher from a media rights server or the local voucher cache.
-		DRMManager
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-removeFromDeviceGroup(deviceGroup:DRMDeviceGroup):void -
-
- Removes the currently running device from a device group.
-		DRMManager
   -
-resetDRMVouchers():void -
-
- In AIR applications this deletes all locally cached digital rights management (DRM) voucher data.
-		DRMManager
   -
-returnVoucher(inServerURL:String, immediateCommit:Boolean, licenseID:String, policyID:String):void -
-
- - Returns to the license server all vouchers that match all specified criteria.
-		DRMManager
   -
-setAuthenticationToken(serverUrl:String, domain:String, token:ByteArray):void -
-
- Sets the authentication token to use for communication with the specified server and domain.
-		DRMManager
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-storeVoucher(voucher:ByteArray):void -
-
- - -
-		DRMManager
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-authenticationComplete -
-		 - The DRMManager dispatches a DRMAuthenticationCompleteEvent object when the user is authenticated - by the media rights server after a call to the authenticate() method.DRMManager
   -
-authenticationError -
-		 - The DRMManager dispatches a DRMAuthenticationErrorEvent object when the user is not authenticated - by the media rights server after a call to the authenticate() method.DRMManager
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-drmError -
-		 - The DRMManager dispatches a DRMErrorEvent object when a requested voucher - cannot be obtained from the media rights server.DRMManager
   -
-drmStatus -
-		 - The DRMManager dispatches a DRMStatusEvent object when a requested voucher - is obtained from the media rights server.DRMManager
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The isSupported property is set to true if the - DRMManager class is supported on the current platform, otherwise it is - set to false. -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
networkIdleTimeoutproperty 
-
-networkIdleTimeout:Number  [read-write]Implementation -
-    public static function get networkIdleTimeout():Number -
-    public function set networkIdleTimeout(value:Number):void -
-
- -
Method detail
- - - - - -
addToDeviceGroup()method
-
-public function addToDeviceGroup(deviceGroup:DRMDeviceGroup, forceRefresh:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- adds the currently running device to a device group. - -

Parameters - - - - - - - - - - -
deviceGroup:DRMDeviceGroup
 
forceRefresh:Boolean (default = false)
-
- - - - - -
authenticate()method 
-
-public function authenticate(serverURL:String, domain:String, username:String, password:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Authenticates a user. - -

Listen for the authenticationComplete and authenticationError events to determine the - outcome of the authentication attempt. Multiple authenticate() calls are queued. The - AuthenticationCompleteEvent object dispatched for the authenticationComplete event - contains contains an authentication token that your application can save.

- -

You can use a saved authentication token, or a token downloaded by another means, - to establish an authenticated session with the media rights server in the future. To establish a - session using a token, call the DRMManager setAuthenticationToken() method. The properties - of the token, such as expiration date, are determined by the settings of the server that generates the - token.

- -

Important (AIR only): The authenticate() method will not succeed when a user's Internet connection passes - through a proxy server requiring authentication. Although such users are not able to preload a DRM voucher that requires - authentication, your application can obtain the voucher by beginning playback and using the NetStream - setAuthenticationCredentials() method to log the user into both the proxy and the media rights servers. - Once the voucher has been obtained, the user can view the content offline (as long as the license represented by the - voucher allows offline playback).

- - Parameters - - - - - - - - - - - - - - - - - - - - - - -
serverURL:String — The URL of a media rights server that can provide a voucher for viewing protected content -
 
domain:String — A domain on the server (not a network or Internet domain name) -
 
username:String — The user name -
 
password:String — The user password - -
-

-See also -

-
-flash.net.NetStream.setAuthenticationCredentials() -
-setAuthenticationToken() -
-
- - - - - -
getDRMManager()method 
-
-public static function getDRMManager():DRMManager -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns an instance of the singleton DRMManager object. - -

One DRMManager instance exists for each security domain.

- -

-Returns - - - - -
DRMManager
-

-See also -

-
-flash.system.SecurityDomain -
-
- - - - - -
loadPreviewVoucher()method 
-
-public function loadPreviewVoucher(contentData:DRMContentData):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Gets a preview voucher from the license server, which you can use to let a user verify - that they can play content on particular computer. This capability lets users - verify that they can play content on their computer before buying and downloading the content. It is - useful when the user's computer doesn't have the necessary output protection - capabilities or necessary software to play content. - -

Like loadVoucher(), this method is an asynchronous call - and issues a DRMStatusEvent on completion or a DRMErrorEvent in case of errors.

- Parameters - - - - -
contentData:DRMContentData
-
- - - - - -
loadVoucher()method 
-
-public function loadVoucher(contentData:DRMContentData, setting:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Loads a voucher from a media rights server or the local voucher cache. - -

The voucher is loaded according to the setting parameter:

-
    -
  • LoadVoucherSetting.FORCE_REFRESH: The voucher is always downloaded from the media rights server.
    • -
  • LoadVoucherSetting.LOCAL_ONLY: The voucher is only loaded from the local cache.
    • -
  • LoadVoucherSetting.ALLOW_SERVER: The voucher is loaded from the local cache, if possible, but - otherwise is downloaded from the server.
    • -
-

The LoadVoucherSetting class defines string constants to use as values for the setting - parameter.

- -

When the voucher is successfully loaded, the DRMManager dispatches a DRM status event. Your application can - begin playback as soon as the voucher is loaded. The loaded voucher is available in the voucher - property of the dispatched DRMStatusEvent object. You can use this voucher object to display the associated media - rights information to the user.

- -

If a voucher cannot be loaded from the media rights server, a DRM error event is dispatched. The errorID property - of the dispatched DRMErrorEvent object indicates the reason for the failure. Common causes of failure include - attempting to connect to the media rights server when the user is offline and attempting to load a - voucher when the user is not logged in. Your application can respond to these errors and take corrective action. - For example, if authentication credentials are required to download the voucher, you can prompt the user - for their account user name and password, call the DRMManager authenticate() method, and then attempt - to load the voucher again.

- -

If a voucher cannot be obtained from the local cache and the localOnly setting is used, a - DRMErrorEvent is not dispatched. Instead, a DRM status event is dispatched. The detail property of - this DRMStatusEvent object is still DRM.voucherObtained, but the voucher property - is null.

- - Parameters - - - - - - - - - - -
contentData:DRMContentData — The DRMContentData object from a DRM-protected media file -
 
setting:String — Determines whether the voucher is retrieved from the local cache or the media rights server - -
-
- - - - - -
removeFromDeviceGroup()method 
-
-public function removeFromDeviceGroup(deviceGroup:DRMDeviceGroup):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Removes the currently running device from a device group. - -

Parameters - - - - -
deviceGroup:DRMDeviceGroup
-
- - - - - -
resetDRMVouchers()method 
-
-public function resetDRMVouchers():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- In AIR applications this deletes all locally cached digital rights management (DRM) voucher data. - For browser based applications this is only available during 3322, 3346, 3323, 3326 errors, and behaves like the Protected Content Playback Settings panel. -

- The application must download the required vouchers again for the user to be able to access encrypted content. - Calling this function is equivalent to calling Netstream.resetDRMVouchers().

- -
-Throws - - - - -
Error — The voucher data cannot be deleted. -
-

-See also -

-
-flash.net.NetStream.resetDRMVouchers() -
-
- - - - - -
returnVoucher()method 
-
-public function returnVoucher(inServerURL:String, immediateCommit:Boolean, licenseID:String, policyID:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 - -
-

- - Returns to the license server all vouchers that match all specified criteria. When a voucher is returned, it is removed from on disk storage and from memory. - This will not interrupt Netstreams and AVStreams that are currently using the returned vouchers for video playback, but will prohibit future playback. - DRMManager will issue a DRMReturnVoucherCompleteEvent on success or a DRMReturnVoucherErrorEvent on error. Will throw an ArgumentError - if inServerURL is null or if licenseID and policyID are both null. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
inServerURL:String — The license server URLs from which the returned licenses were downloaded. -
 
immediateCommit:Boolean — Reserved. The only supported value is true. -
 
licenseID:String — (optional) Vouchers matching this licenseID will be returned. If null, policyID will be used instead. -
 
policyID:String — (optional) Vouchers matching this policyID will be returned. If null, licenseID will be used instead. If both licenseID and policyID are non-null, only a voucher that matches both licenseID and policyID will be returned. - - -
-
- - - - - -
setAuthenticationToken()method 
-
-public function setAuthenticationToken(serverUrl:String, domain:String, token:ByteArray):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Sets the authentication token to use for communication with the specified server and domain. - -

Authentication tokens are available from the token property of the - DRMAuthenticationCompleteEvent object dispatched after a successful call to the authenticate() - method. The token is cached automatically for the session, but you can use the - setAuthenticationToken() method to manage tokens directly.

- -

Setting a token overwrites any existing cached token for the server and domain. - Set the token parameter to null to clear the cached token.

- - Parameters - - - - - - - - - - - - - - - - -
serverUrl:String — The URL of the media rights server -
 
domain:String — The DRMContentData -
 
token:ByteArray — The authentication token - -
-
- - - - - -
storeVoucher()method 
-
-public function storeVoucher(voucher:ByteArray):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 - -
-

- - -

Parameters - - - - -
voucher:ByteArray
-
-
Event detail
- - - - - -
authenticationCompleteevent 
-
-Event object type: flash.events.DRMAuthenticationCompleteEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The DRMManager dispatches a DRMAuthenticationCompleteEvent object when the user is authenticated - by the media rights server after a call to the authenticate() method. - -

- - - - - -
authenticationErrorevent  
-
-Event object type: flash.events.DRMAuthenticationErrorEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The DRMManager dispatches a DRMAuthenticationErrorEvent object when the user is not authenticated - by the media rights server after a call to the authenticate() method. -

- - - - - -
drmErrorevent  
-
-Event object type: flash.events.DRMErrorEvent -
-DRMErrorEvent.type property = flash.events.DRMErrorEvent.DRM_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The DRMManager dispatches a DRMErrorEvent object when a requested voucher - cannot be obtained from the media rights server. - -

Note: When an attempt to load a voucher from the local voucher cache - (using the localOnly as the source parameter) fails, - a DRMErrorEvent object is not dispatched. Instead, a DRMStatusEvent object with a - voucher property set to null is dispatched.

- -

- The DRMErrorEvent.DRM_ERROR constant defines the value of the - type property of a drmError event object. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
errorIDA numerical error code assigned to the problem.
subErrorIDAn error code that indicates more detailed information about - the underlying problem.
targetThe NetStream object.
- -
- - - - - -
drmStatusevent  
-
-Event object type: flash.events.DRMStatusEvent -
-DRMStatusEvent.type property = flash.events.DRMStatusEvent.DRM_STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The DRMManager dispatches a DRMStatusEvent object when a requested voucher - is obtained from the media rights server. - -

- The DRMStatusEvent.DRM_STATUS constant defines the value of the - type property of a drmStatus event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
detailA string explaining the context of the status event.
isAnonymousIndicates whether the content protected with DRM - encryption is available without requiring a user to provide authentication credentials.
isAvailableOfflineIndicates whether the content protected with DRM - encryption is available offline.
offlineLeasePeriodThe remaining number of days that content can be - viewed offline.
policiesA custom object of the DRM status event.
targetThe NetStream object.
voucherEndDateThe absolute date on which the voucher expires - and the content can no longer be viewed by users
contentDataThe DRMContentData for the content
voucherThe DRMVoucher object for the content.
isLocalIndicates whether the content is stored on the local file system
- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/drm/DRMPlaybackTimeWindow.html b/html-docs/flash/net/drm/DRMPlaybackTimeWindow.html deleted file mode 100644 index 6b32f22..0000000 --- a/html-docs/flash/net/drm/DRMPlaybackTimeWindow.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - - - -flash.net.drm.DRMPlaybackTimeWindow (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.drm
Classpublic class DRMPlaybackTimeWindow
InheritanceDRMPlaybackTimeWindow Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The DRMPlaybackTimeWindow class represents the period of time during which a - DRM voucher is valid. - -

The startDate and endDate properties are - null until the first time that the user views the content.

- -

-

-See also -

-
-flash.net.drm.DRMVoucher -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  endDate : Date -
[read-only] - The end date for the period of time during which a DRM voucher is valid - (the playback window).
-		DRMPlaybackTimeWindow
  period : uint -
[read-only] - The period of time during which a DRM voucher is valid - (the playback window), in seconds.
-		DRMPlaybackTimeWindow
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  startDate : Date -
[read-only] - The start date for the period of time during which a DRM voucher is valid - (the playback window).
-		DRMPlaybackTimeWindow
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
endDateproperty
-
-endDate:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The end date for the period of time during which a DRM voucher is valid - (the playback window). - -

The endDate is null if the - playback window has not started.

- - Implementation -
-    public function get endDate():Date -
-
- - - - - -
periodproperty 
-
-period:uint  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The period of time during which a DRM voucher is valid - (the playback window), in seconds. - -

Implementation -
-    public function get period():uint -
-
- - - - - -
startDateproperty 
-
-startDate:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The start date for the period of time during which a DRM voucher is valid - (the playback window). - -

The startDate is null if the - playback window has not started.

- - Implementation -
-    public function get startDate():Date -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/drm/DRMVoucher.html b/html-docs/flash/net/drm/DRMVoucher.html deleted file mode 100644 index 5abb303..0000000 --- a/html-docs/flash/net/drm/DRMVoucher.html +++ /dev/null @@ -1,562 +0,0 @@ - - - - - - - - -flash.net.drm.DRMVoucher (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.drm
Classpublic class DRMVoucher
InheritanceDRMVoucher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The DRMVoucher class is a handle to the license token that allows a user to view DRM-protected content. - -

The DRMVoucher properties describe the viewing rights conferred by the voucher. You can get a voucher - using the loadVoucher() method of the DRMManager object. This method - requires a DRMContentData object, obtained with the preloadEmbeddedMetadata() - method of the NetStream class (AIR only) or by using the DRMContentData() constructor. - When using a media rights server such as Flash Access, you can get a DRMContentData object - from the metadata generated by the media packager tool.

- -

-

-See also -

-
-flash.net.drm.DRMContentData -
-flash.net.drm.DRMManager.loadVoucher() -
-flash.net.NetStream.preloadEmbeddedData() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  licenseID : String -
[read-only] - The unique license ID for this voucher.
-		DRMVoucher
  offlineLeaseEndDate : Date -
[read-only] - The date and time at which this voucher expires for offline playback.
-		DRMVoucher
  offlineLeaseStartDate : Date -
[read-only] - The date and time at which this voucher becomes valid for offline playback.
-		DRMVoucher
  playbackTimeWindow : DRMPlaybackTimeWindow -
[read-only] - The time period, after the first viewing, during which - the associated content can be viewed or reviewed.
-		DRMVoucher
  policies : Object -
[read-only] - The custom application-defined rights, if any, defined by the customer when packaging the content.
-		DRMVoucher
  policyID : String -
[read-only] - The unique policy ID for this voucher.
-		DRMVoucher
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  serverURL : String -
[read-only] - The url to the license server for this DRMVoucher.
-		DRMVoucher
  voucherEndDate : Date -
[read-only] - The date on which this voucher expires.
-		DRMVoucher
  voucherStartDate : Date -
[read-only] - The beginning of this voucher's validity period.
-		DRMVoucher
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-toByteArray():ByteArray -
-
-		DRMVoucher
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
licenseIDproperty
-
-licenseID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- The unique license ID for this voucher. - - -

Implementation -
-    public function get licenseID():String -
-
- - - - - -
offlineLeaseEndDateproperty 
-
-offlineLeaseEndDate:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The date and time at which this voucher expires for offline playback. - -

If a voucher is only valid for the current online session, - offlineLeaseStartDate is null.

- - Implementation -
-    public function get offlineLeaseEndDate():Date -
-
- - - - - -
offlineLeaseStartDateproperty 
-
-offlineLeaseStartDate:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The date and time at which this voucher becomes valid for offline playback. - -

If a voucher is only valid for the current online session, - offlineLeaseStartDate is null.

- - Implementation -
-    public function get offlineLeaseStartDate():Date -
-
- - - - - -
playbackTimeWindowproperty 
-
-playbackTimeWindow:DRMPlaybackTimeWindow  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The time period, after the first viewing, during which - the associated content can be viewed or reviewed. - -

The time period allotted for viewing begins when the user first views the content - and ends after the allotted amount of time has elapsed. If no time is allotted, - the value of the playbackTimeWindow property is null.

- - Implementation -
-    public function get playbackTimeWindow():DRMPlaybackTimeWindow -
-
- - - - - -
policiesproperty 
-
-policies:Object  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The custom application-defined rights, if any, defined by the customer when packaging the content. - -

If no custom rights have been defined, null will be returned.

- - Implementation -
-    public function get policies():Object -
-
- - - - - -
policyIDproperty 
-
-policyID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

- The unique policy ID for this voucher. - - -

Implementation -
-    public function get policyID():String -
-
- - - - - -
serverURLproperty 
-
-serverURL:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The url to the license server for this DRMVoucher. - -

Implementation -
-    public function get serverURL():String -
-
- - - - - -
voucherEndDateproperty 
-
-voucherEndDate:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The date on which this voucher expires. - -

Implementation -
-    public function get voucherEndDate():Date -
-
- - - - - -
voucherStartDateproperty 
-
-voucherStartDate:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The beginning of this voucher's validity period. - -

Implementation -
-    public function get voucherStartDate():Date -
-
- -
Method detail
- - - - - -
toByteArray()method
-
-public function toByteArray():ByteArray -

-Returns - - - - -
ByteArray
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/drm/LoadVoucherSetting.html b/html-docs/flash/net/drm/LoadVoucherSetting.html deleted file mode 100644 index e0bfa74..0000000 --- a/html-docs/flash/net/drm/LoadVoucherSetting.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - - - -flash.net.drm.LoadVoucherSetting (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.drm
Classpublic final class LoadVoucherSetting
InheritanceLoadVoucherSetting Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The LoadVoucherSetting class provides string constants for use - with the settings parameter of the DRMManager loadVoucher() method. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  ALLOW_SERVER : String = "allowServer"
[static] - Loads the voucher from the local cache, if possible; downloads the voucher from a media rights server - only if a locally cached copy does not exist.
-		LoadVoucherSetting
  FORCE_REFRESH : String = "forceRefresh"
[static] - Downloads the voucher from the media rights server only.
-		LoadVoucherSetting
  LOCAL_ONLY : String = "localOnly"
[static] - Loads the voucher from the local cache only.
-		LoadVoucherSetting
-
- -
- -
Constant detail
- - - - - -
ALLOW_SERVERconstant
-
-public static const ALLOW_SERVER:String = "allowServer" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Loads the voucher from the local cache, if possible; downloads the voucher from a media rights server - only if a locally cached copy does not exist. - -

- - - - - -
FORCE_REFRESHconstant 
-
-public static const FORCE_REFRESH:String = "forceRefresh" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Downloads the voucher from the media rights server only. Does not load the voucher from the local cache. - -

- - - - - -
LOCAL_ONLYconstant 
-
-public static const LOCAL_ONLY:String = "localOnly" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Loads the voucher from the local cache only. Does not download the voucher from a media rights server. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/drm/VoucherAccessInfo.html b/html-docs/flash/net/drm/VoucherAccessInfo.html deleted file mode 100644 index 7ad8b06..0000000 --- a/html-docs/flash/net/drm/VoucherAccessInfo.html +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - - -flash.net.drm.VoucherAccessInfo (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.net.drm
Classpublic final class VoucherAccessInfo
InheritanceVoucherAccessInfo Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- A VoucherAccessInfo object presents the information that is required - to successfully retrieve and consume a voucher, such as the type - of authentication and the content domain of the media rights server. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  authenticationMethod : String -
[read-only] - The type of authentication required to obtain a voucher for the associated content.
-		VoucherAccessInfo
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  deviceGroup : DRMDeviceGroup -
[read-only]
-		VoucherAccessInfo
  displayName : String -
[read-only] A user-friendly string that you can use to refer to the specified - VoucherAccessInfo object in the user interface.
-		VoucherAccessInfo
  domain : String -
[read-only] - The content domain of the media rights server to which the user must be authenticated - to obtain the voucher for the associated content.
-		VoucherAccessInfo
  policyID : String -
[read-only] A unique identifier for the policy that this VoucherAccessInfo represents.
-		VoucherAccessInfo
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
authenticationMethodproperty
-
-authenticationMethod:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The type of authentication required to obtain a voucher for the associated content. - -

The supported types of authentication are:

-
    -
  • AuthenticationMethod.ANONYMOUS — anyone can obtain a voucher.
    • -
  • AuthenticationMethod.USERNAME_AND_PASSWORD — the user must supply a valid - username and password of an account that is authorized to view the associated content.
    • -
- -

The AuthenticationMethod class provides string constants to use with the - authenticationMethod property.

- - Implementation -
-    public function get authenticationMethod():String -
-
- - - - - -
deviceGroupproperty 
-
-deviceGroup:DRMDeviceGroup  [read-only]Implementation -
-    public function get deviceGroup():DRMDeviceGroup -
-
- - - - - -
displayNameproperty 
-
-displayName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

A user-friendly string that you can use to refer to the specified - VoucherAccessInfo object in the user interface. -

If the metadata file for a piece of media content has multiple vouchers, - each with its own VoucherAccessInfo object, the user might need to decide - which voucher to authenticate to. For example, you might have - a subscription-level voucher with high privileges for viewing content, - as well as a basic-level voucher with lower privileges. To distinguish - between these two vouchers, use the descriptive string in the - displayName property. The string is set by the media - packager tool (the tool that packages and encrypts media in preparation - for distribution with a media rights server, such as Flash Access).

-

For applications that are localized, you can use this property as an identifier. - The application can detect the locale and localize the strings accordingly.

- - Implementation -
-    public function get displayName():String -
-
- - - - - -
domainproperty 
-
-domain:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The content domain of the media rights server to which the user must be authenticated - to obtain the voucher for the associated content. - -

If authentication is to the default domain or no authentication is required, - the value of domainName is null.

- -

Note: The domain returned by this property has nothing to do with - network or Internet domain names. In this case, a domain is a group - of content or user accounts. For example, a single server could support several - domains, each with its own set of content channels and subscribers.

- - Implementation -
-    public function get domain():String -
-
- - - - - -
policyIDproperty 
-
-policyID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.8 -
-

A unique identifier for the policy that this VoucherAccessInfo represents. -

If the metadata file for a piece of media content has multiple vouchers, - each with its own VoucherAccessInfo object, the user might need to decide - which voucher to authenticate to. For example, you might have - a subscription-level voucher with high privileges for viewing content, - as well as a basic-level voucher with lower privileges. The policyID of the - acquired DRMVoucher object will match the policyID of the VoucherAccessInfo - under which the voucher was issued.

- - Implementation -
-    public function get policyID():String -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/net/drm/package-detail.html b/html-docs/flash/net/drm/package-detail.html deleted file mode 100644 index c4b694e..0000000 --- a/html-docs/flash/net/drm/package-detail.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - -flash.net.drm Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 AuthenticationMethod - The AuthenticationMethod class provides string constants enumerating the - different types of authentication used by the authenticationMethod - property of the DRMContentData class.
 DRMContentData - The DRMContentData class provides the information required to - obtain the voucher necessary to view DRM-protected content.
 DRMDeviceGroup - A device group signifies a group of playback devices that shares protected-content playback rights.
 DRMManager - The DRMManager manages the retrieval and storage of the vouchers needed to view - DRM-protected content.
 DRMPlaybackTimeWindow - The DRMPlaybackTimeWindow class represents the period of time during which a - DRM voucher is valid.
 DRMVoucher - The DRMVoucher class is a handle to the license token that allows a user to view DRM-protected content.
 LoadVoucherSetting - The LoadVoucherSetting class provides string constants for use - with the settings parameter of the DRMManager loadVoucher() method.
 VoucherAccessInfo - A VoucherAccessInfo object presents the information that is required - to successfully retrieve and consume a voucher, such as the type - of authentication and the content domain of the media rights server.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/net/package-detail.html b/html-docs/flash/net/package-detail.html deleted file mode 100644 index 1837f10..0000000 --- a/html-docs/flash/net/package-detail.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - - -flash.net Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.net package contains classes for sending and receiving from the network, such as URL downloading and Flash Remoting.

-
-
- -
Functions
- - - - - - - - - - - - - - - - -
 FunctionDescription
 getClassByAlias - - Looks up a class that previously had an alias registered through a call to the registerClassAlias() - - method.
 navigateToURL - Opens or replaces a window in the application that contains the Flash Player container - (usually a browser).
 registerClassAlias - - Preserves the class (type) of an object when the object is encoded in Action Message Format (AMF).
 sendToURL - Sends a URL request to a server, but ignores any response.
- -
Interfaces
- - - - - - - - - - -
 InterfaceDescription
 IDynamicPropertyOutput - - This interface controls the serialization of dynamic properties of dynamic objects.
 IDynamicPropertyWriter - - This interface is used with the IDynamicPropertyOutput interface to control - - the serialization of dynamic properties of dynamic objects.
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 DatagramSocket - The DatagramSocket class enables code to send and receive - Universal Datagram Protocol (UDP) packets.
 FileFilter - The FileFilter class is used to indicate what files on the user's system are shown - in the file-browsing dialog box that is displayed when the FileReference.browse() - method, the FileReferenceList.browse() method is called or a - browse method of a File, FileReference, or FileReferenceList object is called.
 FileReference - The FileReference class provides a means to upload and - download files between a user's computer and a server.
 FileReferenceList - The FileReferenceList class provides a means to let users select one or more files for uploading.
 GroupSpecifier - The GroupSpecifier class is used to construct the opaque groupspec strings - that can be passed to NetStream and NetGroup constructors.
 InterfaceAddress - The InterfaceAddress class reports the properties of a network interface address.
 IPVersion - The IPVersion class defines constants representing the different families of IP addresses.
 LocalConnection - The LocalConnection class lets you create a LocalConnection object that can invoke a method in another - LocalConnection object.
 NetConnection - The NetConnection class creates a two-way connection between a client and a server.
 NetGroup -Instances of the NetGroup class represent membership in an RTMFP group.
 NetGroupInfo -The NetGroupInfo class specifies various Quality of Service (QoS) statistics -related to a NetGroup object's underlying RTMFP Peer-to-Peer data transport.
 NetGroupReceiveMode -The NetGroupReceiveMode class is an enumeration of constant values used for the receiveMode property -of the NetGroup class.
 NetGroupReplicationStrategy -The NetGroupReplicationStrategy class is an enumeration of constant values used in setting the replicationStrategy property -of the NetGroup class.
 NetGroupSendMode -The NetGroupSendMode class is an enumeration of constant values used for the sendMode parameter of the NetGroup.sendToNeighbor() -method.
 NetGroupSendResult -The NetGroupSendResult class is an enumeration of constant values used for the return value of the -Directed Routing methods associated with a NetGroup instance.
 NetMonitor - The NetMonitor class maintains a list of NetStream objects.
 NetStream - The NetStream class opens a one-way streaming channel over a NetConnection.
 NetStreamAppendBytesAction -The NetStreamAppendBytesAction class is an enumeration of the constants you can pass to the NetStream.appendBytesAction() method.
 NetStreamInfo - The NetStreamInfo class specifies the various Quality of Service (QOS) statistics and other information related to a NetStream object - and the underlying streaming buffer for audio, video, and data.
 NetStreamMulticastInfo -The NetStreamMulticastInfo class specifies various Quality of Service (QoS) statistics -related to a NetStream object's underlying RTMFP Peer-to-Peer and IP Multicast stream transport.
 NetStreamPlayOptions - The NetStreamPlayOptions class specifies the various options that can be passed - to the NetStream.play2() method.
 NetStreamPlayTransitions - The NetStreamPlayTransitions class specifies the valid strings that you can use with the - NetStreamPlayOptions.transition property.
 NetworkInfo - The NetworkInfo class provides information about the network - interfaces on a computer.
 NetworkInterface - The NetworkInterface class describes a network interface.
 ObjectEncoding - - The ObjectEncoding class is used in defining serialization settings in classes - - that serialize objects (such as FileStream, NetStream, NetConnection, SharedObject, - - and ByteArray) to work with prior versions of ActionScript.
 Responder - The Responder class provides an object that is used - in NetConnection.call() to handle return - values from the server related to the success or failure of - specific operations.
 SecureSocket - The SecureSocket class enables code to make socket connections using the Secure Sockets Layer (SSL) - and Transport Layer Security (TLS) protocols.
 ServerSocket - The ServerSocket class allows code to act as a server for Transport Control Protocol (TCP) - connections.
 SharedObject - The SharedObject class is used to read and store limited amounts of data on a user's computer - or on a server.
 SharedObjectFlushStatus - The SharedObjectFlushStatus class provides values for the code returned from a call to the SharedObject.flush() method.
 Socket - The Socket class enables code to establish Transport Control Protocol (TCP) socket - connections for sending and receiving binary data.
 URLLoader - The URLLoader class downloads data from a URL - as text, binary data, or URL-encoded variables.
 URLLoaderDataFormat - The URLLoaderDataFormat class provides values that specify how downloaded data is received.
 URLRequest - The URLRequest class captures all of the information in a single HTTP request.
 URLRequestDefaults - The URLRequestDefaults class includes static properties that you can set to define - default values for the properties of the URLRequest class.
 URLRequestHeader - A URLRequestHeader object encapsulates a single HTTP request header - and consists of a name/value pair.
 URLRequestMethod - The URLRequestMethod class provides values that specify whether the URLRequest object should - use the POST method or the GET method when sending data to a server.
 URLStream - The URLStream class provides low-level access to - downloading URLs.
 URLVariables - The URLVariables class allows you to transfer - variables between an application and a - server.
 XMLSocket - The XMLSocket class implements client sockets that let the - Flash Player or AIR application communicate - with a server computer identified by an IP address or domain name.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/net/package.html b/html-docs/flash/net/package.html deleted file mode 100644 index a75b327..0000000 --- a/html-docs/flash/net/package.html +++ /dev/null @@ -1,655 +0,0 @@ - - - - - - - -flash.net Details (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-The flash.net package contains package-level functions for opening a new browser window, sending a URL request to a server, and dealing with class aliases.
-
Public Functions
- - - - - - - - - - - - - - - - -
 FunctionDefined by
   -
-getClassByAlias(aliasName:String):Class -
-
- - Looks up a class that previously had an alias registered through a call to the registerClassAlias() - - method.
-		flash.net
   -
-navigateToURL(request:URLRequest, window:String = null):void -
-
- Opens or replaces a window in the application that contains the Flash Player container - (usually a browser).
-		flash.net
   -
-registerClassAlias(aliasName:String, classObject:Class):void -
-
- - Preserves the class (type) of an object when the object is encoded in Action Message Format (AMF).
-		flash.net
   -
-sendToURL(request:URLRequest):void -
-
- Sends a URL request to a server, but ignores any response.
-		flash.net
-
- -
Function detail
- - - - - -
getClassByAlias()function
-
-public function getClassByAlias(aliasName:String):Class -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Looks up a class that previously had an alias registered through a call to the registerClassAlias() - - method. - -

This method does not interact with the flash.utils.getDefinitionByName() - - method.

- - - Parameters - - - - -
aliasName:String — The alias to find. - - -
-

-Returns - - - - -
Class — - The class associated with the given alias. If not found, an exception will be thrown. - - - - -
-
-Throws - - - - -
ReferenceError — The alias was not registered. - - -
-

-See also -

-
-registerClassAlias() -
-
- - - - - -
navigateToURL()function 
-
-public function navigateToURL(request:URLRequest, window:String = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Opens or replaces a window in the application that contains the Flash Player container - (usually a browser). In Adobe AIR, the function opens a URL in the default system web browser - Opens a URL in the default system web browser. - -

Important Security Note

-

Developers often pass URL values to the navigateToURL() function that were obtained from external sources - such as FlashVars. Attackers may try to manipulate these external sources to perform attacks such as cross-site scripting. - Therefore, developers should validate all URLs before passing them to this function.

- -

Good data validation for URLs can mean different things depending on the usage of the URL within the overall application. - The most common data validation techniques include validating that the URL is of the appropriate scheme. - For instance, unintentionally allowing javascript: URLs may result in cross-site scripting. - Validating that the URL is a within your domain can ensure that the SWF file can't be used as an open-redirector - by people who conduct phishing attacks. For additional security, you may also choose to validate the path of the URL - and to validate that the URL conforms to the RFC guidelines

-

For example, the following code shows a simple example of performing data validation by denying any URL - that does not begin with http:// or https:// and validating that the URL is within your domain name. - This example may not be appropriate for all web applications and you should consider whether additional checks - against the URL are necessary.

- 
-     // AS3 Regular expression pattern match for URLs that start with http:// and https:// plus your domain name.
-     function checkProtocol (flashVarURL:String):Boolean {
-        // Get the domain name for the SWF if it is not known at compile time.
-        // If the domain is known at compile time, then the following two lines can be replaced with a hard coded string.
-        var my_lc:LocalConnection = new LocalConnection();
-        var domainName:String = my_lc.domain;
-        // Build the RegEx to test the URL.
-        // This RegEx assumes that there is at least one "/" after the
-        // domain. http://www.mysite.com will not match.
-        var pattern:RegExp = new RegExp("^http[s]?\:\\/\\/([^\\/]+)\\/");
-        var result:Object = pattern.exec(flashVarURL);
-        if (result == null || result[1] != domainName || flashVarURL.length >= 4096) {
-          return (false);
-        }
-        return (true);
-     }  
-     
-
-

For local content running in a browser, calls to the - navigateToURL() method that specify a "javascript:" pseudo-protocol - (via a URLRequest object passed as the first parameter) are only permitted if the SWF - file and the containing web page (if there is one) are in the local-trusted security sandbox. - Some browsers do not support using the javascript protocol with the navigateToURL() - method. Instead, consider using the call() method of the ExternalInterface - API to invoke JavaScript methods within the enclosing HTML page.

- -

In Flash Player, and in non-application sandboxes in Adobe AIR, - you cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.

-

In Flash Player 10 and later running in a browser, using this method programmatically to - open a pop-up window may not be successful. Various browsers (and browser configurations) may block pop-up windows - at any time; it is not possible to guarantee any pop-up window will appear. - However, for the best chance of success, use this method to open a pop-up window only in code that executes - as a direct result of a user action (for example, in an event handler for a mouse click or key-press event.)

-

In Flash Player 10 and later, if you use a multipart Content-Type (for example "multipart/form-data") - that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), - the POST operation is subject to the security rules applied to uploads:

-
    -
  • The POST operation must be performed in response to a user-initiated action, such as a mouse click or key press.
    • -
  • If the POST operation is cross-domain (the POST target is not on the same server as the SWF file - that is sending the POST request), - the target server must provide a URL policy file that permits cross-domain access.
    • -
-

Also, for any multipart Content-Type, the syntax must be valid (according to the RFC2046 standards). - If the syntax appears to be invalid, the POST operation is subject to the security rules applied to uploads.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

In AIR, on mobile platforms, the sms: and tel: URI schemes are supported. On Android, vipaccess:, connectpro:, and market: URI schemes are supported. - The URL syntax is subject to the platform conventions. For example, on Android, the URI scheme must be lower case. - When you navigate to a URL using one of these schemes, the runtime opens the URL in the default application for - handling the scheme. Thus, navigating to tel:+5555555555 opens the phone dialer with the specified - number already entered. A separate application or utility, such as a phone dialer must be available to process the URL.

- -

The following code shows how you can invoke the VIP Access and Connect Pro applications on Android:

- 
-       //Invoke the VIP Access Application.
-       navigateToURL(new URLRequest("vipaccess://com.verisign.mvip.main?action=securitycode"));
-     
-       //Invoke the Connect Pro Application.
-       navigateToURL(new URLRequest("connectpro://"));
-
- - Parameters - - - - - - - - - - -
request:URLRequest — A URLRequest object that specifies the URL to navigate to. - -

For content running in Adobe AIR, when When - using the navigateToURL() function, the runtime treats a URLRequest that uses the POST - method (one that has its method property set to URLRequestMethod.POST) - as using the GET method.

- -
 
window:String (default = null) — The browser window or HTML frame in which to display - the document indicated by the request parameter. - You can enter the name of a specific window or use one of the following values: -
    -
  • "_self" specifies the current frame in the current window.
    • -
  • "_blank" specifies a new window.
    • -
  • "_parent" specifies the parent of the current frame.
    • -
  • "_top" specifies the top-level frame in the current window.
    • -
-

If you do not specify a value for this parameter, a new empty window is created. - In the stand-alone player, you can either specify a new ("_blank") window - or a named window. The other values don't apply.

- -

Note: When code in a SWF file that is running in the - local-with-filesystem sandbox calls the navigateToURL() - function and specifies a custom window name for the window - parameter, the window name is transfered into a random name. The name is in - the form "_flashXXXXXXXX", where each X represents a random - hexadecimal digit. Within the same session (until you close the containing - browser window), if you call the function again and specify the same name for - the window parameter, the same random string is used.

- -
-
-Throws - - - - - - - - - - - - - - - - -
Error — The digest property of the request object is not - null. You should only set the digest property of a URLRequest object - for use calling the URLLoader.load() method when loading a SWZ file (an Adobe - platform component). -
 
SecurityError — In Flash Player (and in non-application sandbox content in Adobe AIR), - this error is thrown in the following situations: -
    -
  • Local untrusted SWF files may not communicate with - the Internet. You can avoid this situation by reclassifying this SWF file - as local-with-networking or trusted.
    • - -
  • A navigate operation attempted to evaluate a scripting - pseudo-URL, but the containing document (usually an HTML document in a - browser) is from a sandbox to which you do not have access. You can avoid this situation - by specifying allowScriptAccess="always" in the containing - document.
    • - -
  • You cannot navigate the special windows - "_self", "_top", or "_parent" - if your SWF file is contained by an HTML page - that has set the allowScriptAccess to - "none", or to "sameDomain" - when the domains of the HTML file and the SWF file do not match.
    • - -
  • You cannot navigate a window with a nondefault name - from within a SWF file that is in the local-with-filesystem sandbox.
    • -
  • You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.
    • -
- -
 
Error — If the method is not called in response to a user action, such as a mouse - event or keypress event. This requirement only applies to content in Flash Player and - to non-application sandbox content in Adobe AIR. - -
-

-See also -

-
-flash.external.ExternalInterface.call() -
-
-Example -
The following example opens the URL http://www.adobe.com in a new browser window and passes data about a - user session, captured in a URLVariables object, to the web server. -
-
-package {
-    import flash.display.Sprite;
-	import flash.net.navigateToURL;
-	import flash.net.URLRequest;
-	import flash.net.URLVariables;
-
-	public class NavigateToURLExample extends Sprite {
-
-		public function NavigateToURLExample() {
-			var url:String = "http://www.adobe.com";
-			var variables:URLVariables = new URLVariables();
-			variables.exampleSessionId = new Date().getTime();
-			variables.exampleUserLabel = "Your Name";
-			var request:URLRequest = new URLRequest(url);
-			request.data = variables;
-            try {            
-			    navigateToURL(request);
-            }
-            catch (e:Error) {
-                // handle error here
-            }
-		}
-	}
-}
-
-

The following example shows how you can open new browser windows from Flash Player using the navigateToURL() method. - Example provided by - ActionScriptExamples.com. -
-
-// Requires
-// - Button symbol on Stage (or a display object, such as a MovieClip) with instance name "buttonSymbol"
-//
-buttonSymbol.addEventListener(MouseEvent.CLICK, buttonSymbol_click);
- 
-function buttonSymbol_click(evt:MouseEvent):void {
-    var req:URLRequest = new URLRequest("http://www.adobe.com/");
-    navigateToURL(req, "_blank");
-}
-
-

The following example illustrates the syntax for launching the - device telephone dialer with a specified number. -
-
-var request:URLRequest = new URLRequest( "tel:+5555555555" );
-navigateToURL( request );
-
-

The following example illustrates the syntax for launching the - device text message application with a specified receipient. -
-
-var request:URLRequest = new URLRequest( "sms:+5555555555" );
-navigateToURL( request );
-
-

The following example illustrates the syntax for launching the - Android Market app. The search parameter is set to find the Flash Player app. -
-
-var request:URLRequest = new URLRequest( "market://search?q=pname:com.adobe.flashplayer" );
-navigateToURL( request );
-
-

-
- - - - - -
registerClassAlias()function 
-
-public function registerClassAlias(aliasName:String, classObject:Class):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Preserves the class (type) of an object when the object is encoded in Action Message Format (AMF). - - When you encode an object into AMF, this function saves the alias for its class, so that you can - - recover the class when decoding the object. - - If the encoding context did not register an alias for an object's class, the object - - is encoded as an anonymous object. Similarly, if the decoding context does not have the same - - alias registered, an anonymous object is created for the decoded data. - - -

LocalConnection, ByteArray, SharedObject, NetConnection and NetStream are all examples - - of classes that encode objects in AMF.

- - -

The encoding and decoding contexts do not need to use the same class for an alias; - - they can intentionally change classes, provided that the destination class contains all of the members - - that the source class serializes.

- - - Parameters - - - - - - - - - - -
aliasName:String — The alias to use. - -
 
classObject:Class — The class associated with the given alias. - - -
-
-Throws - - - - -
TypeError — If either parameter is null. - - -
-

-See also -

-
-ObjectEncoding class -
-
-Example -
This example uses the registerClassAlias() function to register - an alias (com.example.eg) for the class ExampleClass. Because - an alias is registered for the class, the object is able to be deserialized as an instance - of ExampleClass, and the code outputs true. If the registerClassAlias() - call were removed, the code would output false. -
-
-package {
-    import flash.display.Sprite;
-	import flash.net.registerClassAlias;
-	import flash.utils.ByteArray;
-
-	public class RegisterClassAliasExample extends Sprite {
-		public function RegisterClassAliasExample() {
-			registerClassAlias("com.example.eg", ExampleClass);
-			var eg1:ExampleClass = new ExampleClass();
-			var ba:ByteArray = new ByteArray();
-			ba.writeObject(eg1);
-			ba.position = 0;
-			var eg2:* = ba.readObject();
-			trace(eg2 is ExampleClass); // true
-		}
-	}
-}
-
-class ExampleClass {}
-
-

-
- - - - - -
sendToURL()function 
-
-public function sendToURL(request:URLRequest):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sends a URL request to a server, but ignores any response. -

To examine the server response, use the URLLoader.load() method instead.

- -

You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.

-

You can prevent a SWF file from using this method by setting the - allowNetworking parameter of the the object and embed - tags in the HTML page that contains the SWF content.

-

In Flash Player 10 and later, if you use a multipart Content-Type (for example "multipart/form-data") - that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), - the POST operation is subject to the security rules applied to uploads:

-
    -
  • The POST operation must be performed in response to a user-initiated action, such as a mouse click or key press.
    • -
  • If the POST operation is cross-domain (the POST target is not on the same server as the SWF file - that is sending the POST request), - the target server must provide a URL policy file that permits cross-domain access.
    • -
-

Also, for any multipart Content-Type, the syntax must be valid (according to the RFC2046 standards). - If the syntax appears to be invalid, the POST operation is subject to the security rules applied to uploads.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- Parameters - - - - -
request:URLRequest — A URLRequest object specifying the URL to send data to. -
-
-Throws - - - - - - - - - - -
SecurityError — Local untrusted SWF files cannot communicate with - the Internet. You can avoid this situation by reclassifying this SWF file - as local-with-networking or trusted. -
 
SecurityError — You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide. - - -
-
-Example -
The following example passes data about a - user session, captured in a URLVariables object, to the application at http://www.yourDomain.com/application.jsp. -
-
- package {
-    import flash.display.Sprite;
-	import flash.net.URLRequest;
-	import flash.net.URLVariables;
-	import flash.net.sendToURL;
-
-	public class SendToURLExample extends Sprite {
-
-		public function SendToURLExample() {
-			var url:String = "http://www.yourDomain.com/application.jsp";
-			var variables:URLVariables = new URLVariables();
-			variables.sessionId = new Date().getTime();
-			variables.userLabel = "Your Name";
-
-			var request:URLRequest = new URLRequest(url);
-			request.data = variables;
-			trace("sendToURL: " + request.url + "?" + request.data);
-			try {
-                sendToURL(request);
-            }
-            catch (e:Error) {
-                // handle error here
-            }
-		}
-	}
-}
-
-

-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/notifications/NotificationStyle.html b/html-docs/flash/notifications/NotificationStyle.html deleted file mode 100644 index 758bcf8..0000000 --- a/html-docs/flash/notifications/NotificationStyle.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - -flash.notifications.NotificationStyle (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.notifications
Classpublic final class NotificationStyle
InheritanceNotificationStyle Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

-

- The NotificationStyle class defines constants for the styles of notifications supported by RemoteNotifier class. -

Each of these constants represents a style of notification.

-

-

-See also -

-
-flash.notifications.RemoteNotifier -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  ALERT : String = "alert"
[static] - A notification style to display an alert box upon receiving a notification.
-		NotificationStyle
  BADGE : String = "badge"
[static] - A notification style that updates the icon of the application with a number/image - upon receiving a notification.
-		NotificationStyle
  SOUND : String = "sound"
[static] - A notification style to play sound upon receiving a notification.
-		NotificationStyle
-
- -
- -
Constant detail
- - - - - -
ALERTconstant
-
-public static const ALERT:String = "alert" -

- - - - -
Runtime version: AIR 3.4 -
-

- A notification style to display an alert box upon receiving a notification. -

- - - - - -
BADGEconstant 
-
-public static const BADGE:String = "badge" -

- - - - -
Runtime version: AIR 3.4 -
-

- A notification style that updates the icon of the application with a number/image - upon receiving a notification. -

- - - - - -
SOUNDconstant 
-
-public static const SOUND:String = "sound" -

- - - - -
Runtime version: AIR 3.4 -
-

- A notification style to play sound upon receiving a notification. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/notifications/RemoteNotifier.html b/html-docs/flash/notifications/RemoteNotifier.html deleted file mode 100644 index 884388b..0000000 --- a/html-docs/flash/notifications/RemoteNotifier.html +++ /dev/null @@ -1,561 +0,0 @@ - - - - - - - - -flash.notifications.RemoteNotifier (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.notifications
Classpublic class RemoteNotifier
InheritanceRemoteNotifier Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

-

- The RemoteNotifier class lets you subscribe to and unsubscribe from push notifications. - -

This class includes methods to query which RemoteNotificationStyles are supported on the target platform. - It dispatches RemoteNotificationEvent and StatusEvent. -

-

-

-See also -

-
-flash.notifications.NotificationStyle -
-flash.events.RemoteNotificationEvent -
-flash.events.StatusEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  supportedNotificationStyles : Vector.<String>
[static][read-only] - A vector list of all supported notification styles.
-		RemoteNotifier
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-RemoteNotifier()
-
- Creates a new RemoteNotifier object.
-		RemoteNotifier
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-subscribe(options:RemoteNotifierSubscribeOptions = null):void -
-
- Subscribes/registers the application to receive remote notifications from APNs.
-		RemoteNotifier
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-unsubscribe():void -
-
- Unsubscribes the application from receiving remote notifications via APNs.
-		RemoteNotifier
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-notification -
-		 - Dispatched in response to a new notification received by the application.RemoteNotifier
   -
-status -
-		 - Dispatched if an error is encountered during the subscription process.RemoteNotifier
   -
-token -
-		 - Dispatched when a notification token is available from the iOS - upon successful subscription for remote notifications.RemoteNotifier
-
- -
- -
Property detail
- - - - - -
supportedNotificationStylesproperty
-
-supportedNotificationStyles:Vector.<String>  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- A vector list of all supported notification styles. -

Implementation -
-    public static function get supportedNotificationStyles():Vector.<String> -
-

-See also -

-
-flash.notifications.NotificationStyle -
-
- -
Constructor detail
- - - - - -
RemoteNotifier()constructor
-
-public function RemoteNotifier() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Creates a new RemoteNotifier object. -

- -
Method detail
- - - - - -
subscribe()method
-
-public function subscribe(options:RemoteNotifierSubscribeOptions = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Subscribes/registers the application to receive remote notifications from APNs. - -

    -
  • RemoteNotificationEvent (TOKEN) is fired once the token is available. This token is to be used by remote notification providers to send - remote notifications to this application on the device via APNs.
    • -
  • RemoteNotificationEvent (NOTIFICATION) is fired when platform OS communicates the notification to the application.
    • -
  • StatusEvent (STATUS) is fired when an error occurs while subscribing for remote notifications.
    • -
-

Parameters - - - - -
options:RemoteNotifierSubscribeOptions (default = null) — options required for the subscription process on some platforms. -
-
- - - - - -
unsubscribe()method 
-
-public function unsubscribe():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Unsubscribes the application from receiving remote notifications via APNs. -

-
Event detail
- - - - - -
notificationevent 
-
-Event object type: flash.events.RemoteNotificationEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Dispatched in response to a new notification received by the application. - -

For iOS, this event is fired in the following scenarios:

-
  • The application was in the foreground when a new notification was received.
    • -
  • As display of a notification popup, the user taps the action button of the alert or taps (or clicks) the application icon. - In this case, no information about the notification - payload is available.
    • -
-
- - - - - -
statusevent  
-
-Event object type: flash.events.StatusEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Dispatched if an error is encountered during the subscription process. -

- - - - - -
tokenevent  
-
-Event object type: flash.events.RemoteNotificationEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Dispatched when a notification token is available from the iOS - upon successful subscription for remote notifications. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/notifications/RemoteNotifierSubscribeOptions.html b/html-docs/flash/notifications/RemoteNotifierSubscribeOptions.html deleted file mode 100644 index 54ef712..0000000 --- a/html-docs/flash/notifications/RemoteNotifierSubscribeOptions.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - - - - -flash.notifications.RemoteNotifierSubscribeOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.notifications
Classpublic final class RemoteNotifierSubscribeOptions
InheritanceRemoteNotifierSubscribeOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

-

- The RemoteNotifierSubscribeOptions class defines the initialization options that may be used - during the remote notification subscription process. - It can be used to specify the styles of notifications one intends to register for. -

-

-See also -

-
-flash.notifications.NotificationStyle -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  notificationStyles : Vector.<String>
- Specifies the vector string of all the notification styles you need to register at once.
-		RemoteNotifierSubscribeOptions
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-RemoteNotifierSubscribeOptions()
-
- Creates a new RemoteNotifierSubscribeOptions object.
-		RemoteNotifierSubscribeOptions
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
notificationStylesproperty
-
-notificationStyles:Vector.<String>  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Specifies the vector string of all the notification styles you need to register at once. -

Implementation -
-    public function get notificationStyles():Vector.<String> -
-    public function set notificationStyles(value:Vector.<String>):void -
-
- -
Constructor detail
- - - - - -
RemoteNotifierSubscribeOptions()constructor
-
-public function RemoteNotifierSubscribeOptions() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Creates a new RemoteNotifierSubscribeOptions object. -

The default values of the newly created object are:

-
    -
  • notificationStyle = null
    • -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/notifications/package-detail.html b/html-docs/flash/notifications/package-detail.html deleted file mode 100644 index 2e54b70..0000000 --- a/html-docs/flash/notifications/package-detail.html +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - -flash.notifications Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Classes
- - - - - - - - - - - - - -
 ClassDescription
 NotificationStyle - The NotificationStyle class defines constants for the styles of notifications supported by RemoteNotifier class.
 RemoteNotifier - The RemoteNotifier class lets you subscribe to and unsubscribe from push notifications.
 RemoteNotifierSubscribeOptions - The RemoteNotifierSubscribeOptions class defines the initialization options that may be used - during the remote notification subscription process.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/permissions/PermissionManager.html b/html-docs/flash/permissions/PermissionManager.html deleted file mode 100644 index d6aad54..0000000 --- a/html-docs/flash/permissions/PermissionManager.html +++ /dev/null @@ -1,459 +0,0 @@ - - - - - - - - -flash.permissions.PermissionManager (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.permissions
Classpublic final class PermissionManager
InheritancePermissionManager Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 -
-

-

- A PermissionManager object provides access to information about operating system permissions for a - restricted resource such as camera or microphone. Due to changes in OS security and privacy, this is - required to be tested/requested prior to the AIR runtime attempting to find out any information about - the resource in question; so relevant classes will provide a PermissionManager as a static class member - so that applications can use this without having to first create an instance of the class. - Whether permissions has been granted (or isn't needed), or denied, can be checked using the - permissionStatus property. If this is 'unknown' then use the requestPermission() method to trigger - an OS-specific request to the user. Once the user has responded, a PermissionEvent will be dispatched. -

-

-See also -

-
-flash.media.Camera.permissionManager -
-flash.media.Microphone.permissionManager -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  permissionStatus : String -
[read-only] - Determine whether the application has been granted the permission to use resource.
-		PermissionManager
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  resourceType : String -
[read-only] - Which resource this PermissionManager instance is responsible for -
-		PermissionManager
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-requestPermission():void -
-
- Requests permission for the application to use the resource.
-		PermissionManager
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-permissionStatus -
-		 - Dispatched when the application receives a change in permission from the OS.PermissionManager
-
- -
- -
Property detail
- - - - - -
permissionStatusproperty
-
-permissionStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Determine whether the application has been granted the permission to use resource. -

Implementation -
-    public function get permissionStatus():String -
-

-See also -

-
-flash.permissions.PermissionStatus -
-
- - - - - -
resourceTypeproperty 
-
-resourceType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Which resource this PermissionManager instance is responsible for -

Implementation -
-    public function get resourceType():String -
-
- -
Method detail
- - - - - -
requestPermission()method
-
-public function requestPermission():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Requests permission for the application to use the resource. - -


-Events - - - - -
PermissionStatus:PermissionEvent — dispatched when the requested permission is granted/denied by the user.
-
-
Event detail
- - - - - -
permissionStatusevent 
-
-Event object type: flash.events.PermissionEvent -
-

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 33.1 -
-

- Dispatched when the application receives a change in permission from the OS. - Check the value of status property to determine whether - the permission was granted or denied -

-See also -

-
-flash.permissions.PermissionStatus -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/permissions/PermissionStatus.html b/html-docs/flash/permissions/PermissionStatus.html deleted file mode 100644 index a21d790..0000000 --- a/html-docs/flash/permissions/PermissionStatus.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - -flash.permissions.PermissionStatus (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.permissions
Classpublic final class PermissionStatus
InheritancePermissionStatus Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24.0
-

-

-The PermissionStatus class is an enumeration of constant values that specify the -authorization status of a permission - -

-

-See also -

-
-flash.media.Camera.permissionStatus -
-flash.media.Microphone.permissionStatus -
-flash.media.CameraRoll.permissionStatus -
-flash.media.CameraUI.permissionStatus -
-flash.filesystem.File.permissionStatus -
-flash.sensors.Geolocation.permissionStatus -
-flash.net.NetworkInfo.permissionStatus -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  DENIED : String = "denied"
[static] - Specifies that the permission has been denied.
-		PermissionStatus
  GRANTED : String = "granted"
[static] - Specifies that the permission has been granted.
-		PermissionStatus
  ONLY_WHEN_IN_USE : String = "onlyWhenInUse"
[static] - Specifies that the permission has been granted only when App is in use.
-		PermissionStatus
  UNKNOWN : String -
[static] - - Specifies that the permission hasn't been requested yet.
-		PermissionStatus
-
- -
- -
Constant detail
- - - - - -
DENIEDconstant
-
-public static const DENIED:String = "denied" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Specifies that the permission has been denied. - -

- - - - - -
GRANTEDconstant 
-
-public static const GRANTED:String = "granted" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24.0 -
-

- Specifies that the permission has been granted. - -

- - - - - -
ONLY_WHEN_IN_USEconstant 
-
-public static const ONLY_WHEN_IN_USE:String = "onlyWhenInUse" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 29.0 -
-

- Specifies that the permission has been granted only when App is in use. - -

- - - - - -
UNKNOWNconstant 
-
-public static const UNKNOWN:String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24.0 -
-

- - Specifies that the permission hasn't been requested yet. - NOTE: On Android, permissionStatus will return UNKNOWN - if permission was denied with "Never ask again" option checked - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/permissions/package-detail.html b/html-docs/flash/permissions/package-detail.html deleted file mode 100644 index 7b54158..0000000 --- a/html-docs/flash/permissions/package-detail.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - -flash.permissions Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Classes
- - - - - - - - - - -
 ClassDescription
 PermissionManager - A PermissionManager object provides access to information about operating system permissions for a - restricted resource such as camera or microphone.
 PermissionStatus -The PermissionStatus class is an enumeration of constant values that specify the -authorization status of a permission - -
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/printing/PaperSize.html b/html-docs/flash/printing/PaperSize.html deleted file mode 100644 index 8542563..0000000 --- a/html-docs/flash/printing/PaperSize.html +++ /dev/null @@ -1,774 +0,0 @@ - - - - - - - - -flash.printing.PaperSize (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.printing
Classpublic final class PaperSize
InheritancePaperSize Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-This class provides the available values for the paperSize parameter of -the PrintJob.selectPaperSize() method. Each constant represents a paper size -that is used to print a page. - -

The following table shows the approximate size for each paper type. The size is approximate -because there is some variation among printer drivers. For example, the width of A4 paper -can be 595.0, 595.2, 595.22 or 595.28 points depending on the driver.

- - - - - - - - - - - - - - - - - - - - -
ValueSize in points
A4595 x 842
A5420 x 595
A6297 x 420
CHOUKEI3GOU340 x 666
CHOUKEI4GOU298 x 666
ENV_10297 x 684
ENV_B5499 x 709
ENV_C5459 x 649
ENV_DL312 x 624
ENV_MONARCH279 x 540
ENV_PERSONAL261 x 468
EXECUTIVE522 x 756
FOLIO612 x 936
JIS_B5516 x 729
LEGAL612 x 1008
LETTER612 x 792
STATEMENT396 x 612
- -

-

-See also -

-
-PrintJob.selectPaperSize() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  A4 : String = "a4"
[static] - A4 - -
-		PaperSize
  A5 : String = "a5"
[static] - A5 - -
-		PaperSize
  A6 : String = "a6"
[static] - A6 - -
-		PaperSize
  CHOUKEI3GOU : String = "choukei3gou"
[static] - Japanese choukei 3 gou (envelope) - -
-		PaperSize
  CHOUKEI4GOU : String = "choukei4gou"
[static] - Japanese choukei 4 gou (envelope) - -
-		PaperSize
  ENV_10 : String = "env_10"
[static] - Legal envelope - -
-		PaperSize
  ENV_B5 : String = "env_b5"
[static] - B5 envelope - -
-		PaperSize
  ENV_C5 : String = "env_c5"
[static] - C5 envelope - -
-		PaperSize
  ENV_DL : String = "env_dl"
[static] - DL envelope - -
-		PaperSize
  ENV_MONARCH : String = "env_monarch"
[static] - Monarch envelope - -
-		PaperSize
  ENV_PERSONAL : String = "env_personal"
[static] - Personal envelope - -
-		PaperSize
  EXECUTIVE : String = "executive"
[static] - Executive size - -
-		PaperSize
  FOLIO : String = "folio"
[static] - Folio size - -
-		PaperSize
  JIS_B5 : String = "jis_b5"
[static] - Japanese B5 - -
-		PaperSize
  LEGAL : String = "legal"
[static] - Traditional legal size - -
-		PaperSize
  LETTER : String = "letter"
[static] - Traditional letter size - -
-		PaperSize
  STATEMENT : String = "statement"
[static] - Statement size - -
-		PaperSize
-
- -
- -
Constant detail
- - - - - -
A4constant
-
-public static const A4:String = "a4" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A4 - -

- - - - - -
A5constant 
-
-public static const A5:String = "a5" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A5 - -

- - - - - -
A6constant 
-
-public static const A6:String = "a6" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A6 - -

- - - - - -
CHOUKEI3GOUconstant 
-
-public static const CHOUKEI3GOU:String = "choukei3gou" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Japanese choukei 3 gou (envelope) - -

- - - - - -
CHOUKEI4GOUconstant 
-
-public static const CHOUKEI4GOU:String = "choukei4gou" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Japanese choukei 4 gou (envelope) - -

- - - - - -
ENV_10constant 
-
-public static const ENV_10:String = "env_10" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Legal envelope - -

- - - - - -
ENV_B5constant 
-
-public static const ENV_B5:String = "env_b5" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- B5 envelope - -

- - - - - -
ENV_C5constant 
-
-public static const ENV_C5:String = "env_c5" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- C5 envelope - -

- - - - - -
ENV_DLconstant 
-
-public static const ENV_DL:String = "env_dl" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- DL envelope - -

- - - - - -
ENV_MONARCHconstant 
-
-public static const ENV_MONARCH:String = "env_monarch" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Monarch envelope - -

- - - - - -
ENV_PERSONALconstant 
-
-public static const ENV_PERSONAL:String = "env_personal" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Personal envelope - -

- - - - - -
EXECUTIVEconstant 
-
-public static const EXECUTIVE:String = "executive" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Executive size - -

- - - - - -
FOLIOconstant 
-
-public static const FOLIO:String = "folio" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Folio size - -

- - - - - -
JIS_B5constant 
-
-public static const JIS_B5:String = "jis_b5" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Japanese B5 - -

- - - - - -
LEGALconstant 
-
-public static const LEGAL:String = "legal" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Traditional legal size - -

- - - - - -
LETTERconstant 
-
-public static const LETTER:String = "letter" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Traditional letter size - -

- - - - - -
STATEMENTconstant 
-
-public static const STATEMENT:String = "statement" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Statement size - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/printing/PrintJob.html b/html-docs/flash/printing/PrintJob.html deleted file mode 100644 index 80695fb..0000000 --- a/html-docs/flash/printing/PrintJob.html +++ /dev/null @@ -1,2121 +0,0 @@ - - - - - - - - -flash.printing.PrintJob (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.printing
Classpublic class PrintJob
InheritancePrintJob Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The PrintJob class lets you create content and print it to one or - more pages. This class - lets you render content that is visible, dynamic or offscreen to the user, prompt users with a - single Print dialog box, and print an unscaled document with - proportions that map to the proportions of the content. This - capability is especially useful for rendering and printing dynamic - content, such as database content and dynamic text. -

Mobile Browser Support: This class is not supported in mobile browsers.

-

AIR profile support: This feature is supported - on all desktop operating systems, but it is not supported on mobile devices or AIR for TV devices. You can test - for support at run time using the PrintJob.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

Use the PrintJob() constructor to create a print job.

-

Additionally, with the PrintJob class's properties, you can read your user's - printer settings, such as page height, width, and image orientation, and - you can configure your document to dynamically format Flash content - that is appropriate for the printer settings.

- -

Note: ActionScript 3.0 does not restrict a PrintJob object - to a single frame (as did previous versions of ActionScript). However, since - the operating system displays print status information to the user after the - user has clicked the OK button in the Print dialog box, you should call - PrintJob.addPage() and PrintJob.send() as soon as - possible to send pages to the spooler. A delay reaching the frame containing - the PrintJob.send() call delays the printing process.

-

Additionally, a 15 second script timeout limit applies to the following intervals:

-
    -
  • PrintJob.start() and the first PrintJob.addPage()
    • -
  • PrintJob.addPage() and the next PrintJob.addPage()
    • -
  • The last PrintJob.addPage() and PrintJob.send()
    • -
- -

If any of the above intervals span more than 15 seconds, the next call to - PrintJob.start() on the PrintJob instance returns false, - and the next PrintJob.addPage() on the PrintJob instance causes - the Flash Player or Adobe AIR to throw a runtime exception.

- -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  active : Boolean -
[static][read-only] - Indicates whether a print job is currently active.
-		PrintJob
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  copies : int -
- The number of copies that the print system prints of any pages subsequently added to the - print job.
-		PrintJob
  firstPage : int -
[read-only] - The page number of the first page of the range entered by the user in the operating system's - Print dialog.
-		PrintJob
  isColor : Boolean -
[read-only] - Indicates whether the currently selected printer at the current print settings prints - using color (true) or grayscale (false).
-		PrintJob
  isSupported : Boolean -
[static][read-only] - Indicates whether the PrintJob class is supported on the current platform (true) - or not (false).
-		PrintJob
  jobName : String -
- The name or title of the print job.
-		PrintJob
  lastPage : int -
[read-only] - The page number of the last page of the range entered by the user in the operating system's - Print dialog.
-		PrintJob
  maxPixelsPerInch : Number -
[read-only] - The physical resolution of the selected printer, in pixels per inch.
-		PrintJob
  orientation : String -
- The image orientation for printing.
-		PrintJob
  pageHeight : int -
[read-only] - The height of the largest area which can be centered in the actual printable - area on the page, in points.
-		PrintJob
  pageWidth : int -
[read-only] - The width of the largest area which can be centered in the actual printable - area on the page, in points.
-		PrintJob
  paperArea : Rectangle -
[read-only] - The bounds of the printer media in points.
-		PrintJob
  paperHeight : int -
[read-only] - The overall paper height, in points.
-		PrintJob
  paperWidth : int -
[read-only] - The overall paper width, in points.
-		PrintJob
  printableArea : Rectangle -
[read-only] - The bounds of the printer media's printable area in points.
-		PrintJob
  printer : String -
- Gets or sets the printer to use for the current print job.
-		PrintJob
  printers : Vector.<String>
[static][read-only] - Provides a list of the available printers as String name values.
-		PrintJob
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  supportsPageSetupDialog : Boolean -
[static][read-only] - Indicates whether the Flash runtime environment supports a separate - Page Setup dialog.
-		PrintJob
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-PrintJob()
-
- Creates a PrintJob object that you can use to print one or more pages.
-		PrintJob
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-addPage(sprite:Sprite, printArea:Rectangle = null, options:PrintJobOptions = null, frameNum:int = 0):void -
-
- Sends the specified Sprite object as a single page to the print spooler.
-		PrintJob
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-selectPaperSize(paperSize:String):void -
-
- Set the paper size.
-		PrintJob
   -
-send():void -
-
- Sends spooled pages to the printer after successful calls to the start() or - start2() and addPage() methods.
-		PrintJob
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-showPageSetupDialog():Boolean -
-
- Displays the operating system's Page Setup dialog if the current environment - supports it.
-		PrintJob
   -
-start():Boolean -
-
- Displays the operating system's Print dialog box and starts spooling.
-		PrintJob
   -
-start2(uiOptions:PrintUIOptions = null, showPrintDialog:Boolean = true):Boolean -
-
- Optionally displays the operating system's Print dialog box, starts spooling, and - possibly modifies the PrintJob read-only property values.
-		PrintJob
   -
-terminate():void -
-
- Signals that the print job should be terminated without sending.
-		PrintJob
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
activeproperty
-
-active:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether a print job is currently active. A print job is active (the property - value is true) in either of two conditions: - -

    -
  • A Page Setup or Print dialog is being displayed.
    • -
  • The start() or start2() method has been called with - a true return value, and the send() or - terminate() method has not been called.
    • -
-

If this property is true and you call the showPageSetupDialog(), - start(), or start2() method, the runtime throws an exception.

- - Implementation -
-    public static function get active():Boolean -
-

-See also -

-
-PrintJob.start() -
-PrintJob.start2() -
-PrintJob.send() -
-PrintJob.terminate() -
-
- - - - - -
copiesproperty 
-
-copies:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The number of copies that the print system prints of any pages subsequently added to the - print job. This value is the number of copies entered by the user in the operating system's - Print dialog. If the the number of copies was not displayed in the - Print dialog, or the dialog was not presented to the user, the value is 1 (unless it has - been changed by application code). - -

Implementation -
-    public function get copies():int -
-    public function set copies(value:int):void -
-
- - - - - -
firstPageproperty 
-
-firstPage:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The page number of the first page of the range entered by the user in the operating system's - Print dialog. This property is zero if the user requests that all pages be printed, or - if the page range was not displayed in the Print dialog, or if the Print dialog - has not been presented to the user. - -

Implementation -
-    public function get firstPage():int -
-
- - - - - -
isColorproperty 
-
-isColor:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the currently selected printer at the current print settings prints - using color (true) or grayscale (false). - -

If a color-or-grayscale value can't be determined, the value is true.

- - Implementation -
-    public function get isColor():Boolean -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the PrintJob class is supported on the current platform (true) - or not (false). -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
jobNameproperty 
-
-jobName:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The name or title of the print job. The job name is typically used by - the operating system as the title of the job in the print queue, or - as the default name of a job that is printed to a file. -

If you have not called start() or start2() and you haven't - set a value for the property, this property's value is null.

-

For each print job you execute with a PrintJob instance, set this property before - calling the start() or start2() method.

- -

The default value is <code>null</code>.

-Implementation -
-    public function get jobName():String -
-    public function set jobName(value:String):void -
-
-Throws -
- - - - -
Error — if code attempts to set the property while the active - property is true. - -
-
- - - - - -
lastPageproperty 
-
-lastPage:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The page number of the last page of the range entered by the user in the operating system's - Print dialog. This property is zero if the user requests that all pages be printed, or - if the page range was not displayed in the Print dialog, or if the Print dialog - has not been presented to the user. - -

Implementation -
-    public function get lastPage():int -
-
- - - - - -
maxPixelsPerInchproperty 
-
-maxPixelsPerInch:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The physical resolution of the selected printer, in pixels per inch. The value - is calculated according to the current print settings as reported by the operating system. -

If the resolution cannot be determined, the value is a standard default value. - The default value is 600 ppi on Linux and 360 ppi on Mac OS. On Windows, - the printer resolution is always available, so no default value is necessary.

- - Implementation -
-    public function get maxPixelsPerInch():Number -
-
- - - - - -
orientationproperty 
-
-orientation:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0AIR 2
-

- The image orientation for printing. The acceptable values are defined as constants - in the PrintJobOrientation class. - -

Note: For AIR 2 or later, set this property before - starting a print job to set the default orientation in the Page Setup and Print dialogs. - Set the property while a print job is in progress (after calling start() or - start2() to set the orientation for a range of pages within the job.

- Implementation -
-    public function get orientation():String -
-    public function set orientation(value:String):void -
-

-See also -

-
-PrintJobOrientation class -
-
- - - - - -
pageHeightproperty 
-
-pageHeight:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The height of the largest area which can be centered in the actual printable - area on the page, in points. - Any user-set margins are ignored. This property is available only - after a call to the PrintJob.start() method has been made. -

Note: For AIR 2 or later, this property is deprecated. Use - printableArea instead, which measures - the printable area in fractional points and describes off-center printable areas - accurately.

- Implementation -
-    public function get pageHeight():int -
-

-See also -

-
-PrintJob.printableArea -
-
- - - - - -
pageWidthproperty 
-
-pageWidth:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The width of the largest area which can be centered in the actual printable - area on the page, in points. - Any user-set margins are ignored. This property is available only - after a call to the PrintJob.start() method has been made. -

Note: For AIR 2 or later, this property is deprecated. Use - printableArea instead, which measures - the printable area in fractional points and describes off-center printable areas - accurately.

- Implementation -
-    public function get pageWidth():int -
-

-See also -

-
-PrintJob.printableArea -
-
- - - - - -
paperAreaproperty 
-
-paperArea:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The bounds of the printer media in points. This value uses the same coordinate system - that is used for subsequent addPage() calls. - -

Implementation -
-    public function get paperArea():Rectangle -
-
- - - - - -
paperHeightproperty 
-
-paperHeight:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The overall paper height, in points. This property is available only - after a call to the PrintJob.start() method has been made. -

Note: For AIR 2 or later, this property is deprecated. Use - paperArea instead, which measures the - paper dimensions in fractional points.

- Implementation -
-    public function get paperHeight():int -
-

-See also -

-
-PrintJob.paperArea -
-
- - - - - -
paperWidthproperty 
-
-paperWidth:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The overall paper width, in points. This property is available only - after a call to the PrintJob.start() method has been made. -

Note: For AIR 2 or later, this property is deprecated. Use - paperArea instead, which measures the - paper dimensions in fractional points.

- Implementation -
-    public function get paperWidth():int -
-

-See also -

-
-PrintJob.paperArea -
-
- - - - - -
printableAreaproperty 
-
-printableArea:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The bounds of the printer media's printable area in points. This value uses the same - coordinate system that is used for subsequent addPage() calls. - -

Implementation -
-    public function get printableArea():Rectangle -
-
- - - - - -
printerproperty 
-
-printer:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Gets or sets the printer to use for the current print job. The String passed - to the setter and returned by the getter should match one of the strings in the - Array returned by the printers() method. To indicate that the default - printer should be used, set the value to null. On operating systems - where the default printer cannot be determined, this property's value is null. - - 

-	 import flash.printing.PrintJob;
-	 
-	 var myPrintJob:PrintJob = new PrintJob();
-	 myPrintJob.printer = "HP_LaserJet_1";
-	 myPrintJob.start();
-
-

Setting the value of this property attempts to select the printer immediately. - If the printer selection fails, this property's value resets to the previous value. - You can determine if setting the printer value succeeds by reading the - value after attempting to set it, and confirming that it matches the value - that was set.

-

The printer property of an active print job cannot be changed. - Attempting to change it after calling the start() or start2() - method successfully and before calling send() or terminate() fails.

- - Implementation -
-    public function get printer():String -
-    public function set printer(value:String):void -
-
- - - - - -
printersproperty 
-
-printers:Vector.<String>  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Provides a list of the available printers as String name values. - The list is not precalculated; it is generated when the function is called. If - no printers are available or if the system does not support printing, the - value is null. If the system supports printing but is not capable of returning - a list of printers, the value is a Vector with a single element (its length - property is 1). In that case, the single element is the actual printer name - or a default name if the current printer name cannot be determined. - -

Implementation -
-    public static function get printers():Vector.<String> -
-
- - - - - -
supportsPageSetupDialogproperty 
-
-supportsPageSetupDialog:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the Flash runtime environment supports a separate - Page Setup dialog. If this property is true, you can call - the showPageSetupDialog() method to display the operating - system's page setup dialog box. - -

Implementation -
-    public static function get supportsPageSetupDialog():Boolean -
-

-See also -

-
-PrintJob.showPageSetupDialog() -
-
- -
Constructor detail
- - - - - -
PrintJob()constructor
-
-public function PrintJob() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a PrintJob object that you can use to print one or more pages. - After you create a PrintJob object, you need to use (in the following sequence) the - PrintJob.start(), PrintJob.addPage(), and then - PrintJob.send() methods to send the print job to the printer. -

For example, you can replace the [params] placeholder text for the - myPrintJob.addPage() method calls with custom parameters as shown in the - following code:

- 
- // create PrintJob object
- var myPrintJob:PrintJob = new PrintJob();
-  
- // display Print dialog box, but only initiate the print job
- // if start returns successfully.
- if (myPrintJob.start()) {
-  
-    // add specified page to print job
-    // repeat once for each page to be printed
-    try {
-      myPrintJob.addPage([params]);
-    }
-    catch(e:Error) {
-      // handle error 
-    }
-    try {
-      myPrintJob.addPage([params]);
-    }
-    catch(e:Error) {
-      // handle error 
-    }
- 
-    // send pages from the spooler to the printer, but only if one or more
-    // calls to addPage() was successful. You should always check for successful 
-    // calls to start() and addPage() before calling send().
-    myPrintJob.send();
- }
-
-

In AIR 2 or later, you can create and use multiple PrintJob instances. Properties set on - the PrintJob instance are retained after printing completes. This allows you to re-use a PrintJob - instance and maintain a user's selected printing preferences, while offering different printing - preferences for other content in your application. For content in Flash Player and in AIR prior to version 2, you cannot create a - second PrintJob object while the first one is still active. - If you create a second PrintJob object (by calling new PrintJob()) - while the first PrintJob object is still active, the second PrintJob object - will not be created. So, you may check for the myPrintJob value before - creating a second PrintJob.

-
-Throws - - - - -
Error — In Flash Player and AIR prior to AIR 2, throws an exception if another PrintJob object is still active. -
-

-See also -

-
-PrintJob.addPage() -
-PrintJob.send() -
-PrintJob.start() -
-
- -
Method detail
- - - - - -
addPage()method
-
-public function addPage(sprite:Sprite, printArea:Rectangle = null, options:PrintJobOptions = null, frameNum:int = 0):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sends the specified Sprite object as a single page to the print spooler. Before using this - method, you must create a PrintJob object and then use start() or - start2(). Then, - after calling addPage() one or more times for a print job, use - send() to send the spooled pages to the printer. In other words, after you create - a PrintJob object, use (in the following sequence) start() or - start2(), addPage(), and then send() to send - the print job to the printer. You can call addPage() multiple times after a - single call to start() to print several pages in a print job. -

If addPage() causes Flash Player to throw an exception (for example, - if you haven't called start() or the user cancels the print job), any - subsequent calls to addPage() fail. However, if previous calls to - addPage() are successful, the concluding send() command sends - the successfully spooled pages to the printer.

- -

If the print job takes more than 15 seconds to complete an addPage() - operation, Flash Player throws an exception on the next addPage() call.

- -

If you pass a value for the printArea parameter, the - x and y coordinates of the - printArea Rectangle map to the upper-left corner (0, 0 coordinates) of the - printable area on the page. The read-only properties - pageHeight and pageWidth describe the printable area set by - start(). Because the printout aligns with the upper-left corner - of the printable area on the page, when the area defined in printArea - is bigger than the printable area on the page, the printout is cropped to the right - or bottom (or both) of the area defined by printArea. - In Flash Professional, if you don't pass a value for printArea and the - Stage is larger than the printable area, the same type of clipping - occurs. In Flex or Flash Builder, if you don't pass a value for - printArea and the screen is larger than the printable area, the - same type of clipping takes place.

- -

If you want to scale a Sprite object before you print it, set scale - properties (see flash.display.DisplayObject.scaleX and - flash.display.DisplayObject.scaleY) before calling this method, - and set them back to their original values after printing. The scale of a Sprite - object has no relation to printArea. That is, if you specify a print - area that is 50 x 50 pixels, 2500 pixels are printed. If you scale the Sprite object, - the same 2500 pixels are printed, but the Sprite object is printed at the scaled size.

- -

The Flash Player printing feature supports PostScript and non-PostScript printers. - Non-PostScript printers convert vectors to bitmaps.

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
sprite:Sprite — The Sprite containing the content to print. -
 
printArea:Rectangle (default = null) — A Rectangle object that specifies the area to print. -

A rectangle's width and height are pixel values. A printer uses points as print units - of measurement. Points are a fixed physical size (1/72 inch), but the size of a pixel, - onscreen, depends on the resolution of the particular screen. So, the conversion rate - between pixels and points depends on the printer settings and whether the sprite is - scaled. An unscaled sprite that is 72 pixels wide prints out one inch wide, with - one point equal to one pixel, independent of screen resolution.

- -

You can use the following equivalencies to convert inches - or centimeters to twips or points (a twip is 1/20 of a point):

-
    -
  • 1 point = 1/72 inch = 20 twips
    • -
  • 1 inch = 72 points = 1440 twips
    • -
  • 1 cm = 567 twips
    • -
-

If you omit the printArea parameter, or if it is passed incorrectly, - the full area of the sprite parameter is printed.

-

If you don't want to specify a value for printArea but want to specify a value for options - or frameNum, pass null for printArea.

-
 
options:PrintJobOptions (default = null) — An optional parameter that specifies whether to print as vector or bitmap. - The default value is null, which represents a request for vector printing. - To print sprite as a - bitmap, set the printAsBitmap property of the PrintJobOptions object - to true. Remember the following suggestions when determining whether to - set printAsBitmap to true: -
    -
  • If the content you're printing includes a bitmap image, set - printAsBitmap to true to include any alpha transparency - and color effects.
    • -
  • If the content does not include bitmap images, omit this parameter - to print the content in higher quality vector format.
    • -
- -

If options is omitted or is passed incorrectly, vector printing is used. - If you don't want to specify a value for - options but want to specify a value for frameNumber, - pass null for options.

-
 
frameNum:int (default = 0) — An optional number that lets you specify which frame - of a MovieClip object to print. Passing a frameNum does not invoke - ActionScript on that frame. If you omit this parameter and the - sprite parameter is a MovieClip object, the current - frame in sprite is printed. -
-
-Throws - - - - -
Error — Throws an exception if you haven't called start() or the - user cancels the print job -
-

-See also -

-
-PrintJob.send() -
-PrintJob.start() -
-DisplayObject class -
-
- - - - - -
selectPaperSize()method 
-
-public function selectPaperSize(paperSize:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Set the paper size. The acceptable values for the paperSize parameter - are constants in the PaperSize class. Calling this method affects print - settings as if the user chooses a paper size in the Page Setup or Print dialogs. -

You can call this method at any time. Call this method before starting - a print job to set the default paper size in the Page Setup and Print dialogs. Call - this method while a print job is in progress to set the paper size for - a range of pages within the job.

- 
-     import flash.printing.PrintJob;
-     import flash.printing.PaperSize;
-	 
-     var myPrintJob:PrintJob = new PrintJob();
-     myPrintJob.selectPaperSize(PaperSize.ENV_10);
-
- - Parameters - - - - -
paperSize:String — The paper size to use for subsequent pages in the print job - -
-
-Throws - - - - -
ArgumentError — if the paperSize parameter is not one of the - acceptable values defined in the PaperSize class. -
-

-See also -

-
-PaperSize -
-PrintJob.send() -
-
- - - - - -
send()method 
-
-public function send():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sends spooled pages to the printer after successful calls to the start() or - start2() and addPage() methods. - -

This method does not succeed if the call to the start() or start2() method fails, or - if a call to the addPage() method throws an exception. To avoid an error, - check that the start() or start2() method returns - true and catch any addPage() exceptions before calling - this method. The following example demonstrates how to properly check for errors - before calling this method:

- - 
-     var myPrintJob:PrintJob = new PrintJob();
-     if (myPrintJob.start()) {
-       try {
-         myPrintJob.addPage([params]);
-       }
-       catch(e:Error) {
-          // handle error 
-       }
-            myPrintJob.send();
-     }
-
-

-See also -

-
-PrintJob.addPage() -
-PrintJob.start() -
-PrintJob.start2() -
-
- - - - - -
showPageSetupDialog()method 
-
-public function showPageSetupDialog():Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Displays the operating system's Page Setup dialog if the current environment - supports it. Use the supportsPageSetupDialog property to determine if Page Setup - is supported. - - 

-	 import flash.printing.PrintJob;
-	 
-	 var myPrintJob:PrintJob = new PrintJob();
-	 if (myPrintJob.supportsPageSetupDialog)
-	 {
-	     myPrintJob.showPageSetupDialog();
-	 }
-
-

-Returns - - - - -
Boolean — - true if the user chooses "OK" in the Page Setup dialog. This - indicates that some PrintJob properties may have changed. Returns false - if the user chooses "Cancel" in the Page Setup dialog. - - -
-
-Throws - - - - - - - - - - -
Error — if the system does not support Page Setup. Use the - supportsPageSetupDialog property to determine if Page Setup is supported. -
 
Error — if any print job (including the current one) is active. - -
-

-See also -

-
-PrintJob.supportsPageSetupDialog -
-
- - - - - -
start()method 
-
-public function start():Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Displays the operating system's Print dialog box and starts spooling. The Print dialog box lets the user change print settings. When the - PrintJob.start() method returns successfully (the user clicks OK in the Print dialog - box), the following properties are populated, representing the user's chosen print settings: - - - - - - - -
Property Type Units Notes
PrintJob.paperHeight Number Points Overall paper height.
PrintJob.paperWidth Number Points Overall paper width.
PrintJob.pageHeight Number Points Height of actual printable area on the page; any user-set margins are ignored.
PrintJob.pageWidth Number Points Width of actual printable area on the page; any user-set margins are ignored.
PrintJob.orientation String "portrait" (flash.printing.PrintJobOrientation.PORTRAIT) or "landscape" (flash.printing.PrintJobOrientation.LANDSCAPE).
- -

Note: If the user cancels the Print dialog box, the properties are not populated.

-

After the user clicks OK in the Print dialog box, the player begins spooling a print job to the operating system. - Because the operating system then begins displaying information to the user about the printing progress, - you should call the PrintJob.addPage() and PrintJob.send() calls as soon as possible to send - pages to the spooler. You can use the read-only height, width, and orientation properties this method populates to - format the printout.

-

Test to see if this method returns true (when the user clicks OK in the operating system's Print - dialog box) before any subsequent calls to PrintJob.addPage() and PrintJob.send():

- 
-     var myPrintJob:PrintJob = new PrintJob();
-        if(myPrintJob.start()) {
-          // addPage() and send() statements here
-        }
-
-

For the given print job instance, if any of the following intervals last more than - 15 seconds the next call to PrintJob.start() will return false:

-
    -
  • PrintJob.start() and the first PrintJob.addPage()
    • -
  • One PrintJob.addPage() and the next PrintJob.addPage()
    • -
  • The last PrintJob.addPage() and PrintJob.send()
    • -
-

-Returns - - - - -
Boolean — - A value of true if the user clicks OK when the Print dialog box appears; false if the user clicks Cancel or if an error occurs. - - -
-
-Throws - - - - -
Error — in AIR 2 or later, if another PrintJob is currently active - -
-

-See also -

-
-PrintJob.addPage() -
-PrintJob.send() -
-
- - - - - -
start2()method 
-
-public function start2(uiOptions:PrintUIOptions = null, showPrintDialog:Boolean = true):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Optionally displays the operating system's Print dialog box, starts spooling, and - possibly modifies the PrintJob read-only property values. -

The uiOptions parameter allows the caller to control which options are displayed in - the Print dialog. See the PrintUIOptions class. This parameter is ignored if - showPrintDialog is false.

-

Even when showPrintDialog is true, this method's behavior - can differ from the start() method. On some operating systems, - start() shows the Page Setup dialog followed by the Print dialog. - In contrast, start2() never shows the Page Setup dialog.

- -

In the following example, the min and max page settings in the Print dialog are set - before the dialog is displayed to the user:

- 
-     import flash.printing.PrintJob;
-     import flash.printing.PrintUIOptions;
-	 
-     var myPrintJob:PrintJob = new PrintJob();
-     var uiOpt:PrintUIOptions = new PrintUIOptions();
-     uiOpt.minPage = 1;
-     uiOpt.maxPage = 3;
-     var accepted:Boolean = myPrintJob.start2(uiOpt);
-
- - Parameters - - - - - - - - - - -
uiOptions:PrintUIOptions (default = null) — An object designating which options are displayed in the Print dialog that - is shown to the user. If the showPrintDialog parameter is false, - this value is ignored. - -
 
showPrintDialog:Boolean (default = true) — Whether or not the Print dialog is shown to the user before starting - the print job -
-

-Returns - - - - -
Boolean — - A value of true if the user clicks OK when the Print dialog box appears, - or if the Print dialog is not shown and there is no error; - false if the user clicks Cancel or if an error occurs. - - -
-
-Throws - - - - -
Error — If the Page Setup dialog is being displayed, or if - another print job is currently active - -
-

-See also -

-
-PrintJob.addPage() -
-PrintJob.send() -
-
- - - - - -
terminate()method 
-
-public function terminate():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Signals that the print job should be terminated without sending. Use this method - when a print job has already been initiated by a call to start() or - start2(), but when it is not appropriate to send any pages to the printer. - Typically, terminate() is only used to recover from errors. -

After calling this method, the PrintJob instance can be reused. Wherever possible, - the job's print settings are retained for subsequent use.

- -
- -
Examples
-
examples\PrintJobExample_Simple
-
The following example show the basics of printing. A new PrintJob is created, - and if started successfully, the addPage() method adds the sprite as a single page. - The send() method spools the page to the printer. - -
-
-package 
-{ 
-    import flash.printing.PrintJob; 
-    import flash.display.Sprite; 
- 
-    public class BasicPrintExample extends Sprite 
-    { 
-        var myPrintJob:PrintJob = new PrintJob(); 
-        var mySprite:Sprite = new Sprite();
-        mySprite.graphics.beginFill(0x336699);
-    mySprite.graphics.drawCircle(100, 100, 50);
- 
-        public function BasicPrintExample() 
-        { 
-            if (myPrintJob.start()) {
-	        try {
-	            myPrintJob.addPage(mySprite);
-	        }
-	        catch(e:Error) {
-	            // handle error 
-	        }
-	        myPrintJob.send();
-        } 
-    } 
-}
-
-
-
examples\PrintJobExample
-
The following example uses the class PrintJobExample to create a small document and - then send the document to the printer. This is accomplished using the following steps: -
    -
  1. Declare two variables of type Sprite named sheet1 and sheet2.
    2. -
  2. Call init(), which assigns a new Sprite instance to both sheet1 and - sheet2 and then calls createSheet() using different arguments.
    3. -
  3. createSheet() does the following: -
      -
    1. The Sprite object passed in is used to draw a rectangle with a light-gray background, a - one-pixel black border, and that is 100 pixels wide by 200 pixels high at x = 0, y = 0.
      2. -
    2. A new TextField object is created named txt with the same dimensions as - the Sprite, the wordWrap property set to true, and the text property set to - the String passed as an argument to createSheet().
      3. -
    3. If the Object argument passed is not null, create a new Sprite instance named - img that is used to draw a white rectangle using the coordinate and dimension properties - of the Object passed. The white rectangle is added to the display list of the Sprite object using - addChild().
      4. -
    4. The txt TextField is added to the display list of the Sprite object using - addChild().
      5. -
    4. -
  4. Back in the constructor, the print method that is enabled (not commented out) is called. Since the - methods are very similar, printOnePerPage() is described below.
    5. -
  5. printOnePerPage() does the following: -
      -
    1. Declare a new PrintJob object named pj and pagesToPrint as a uint.
      2. -
    2. Open the operating system's native print dialog box and wait for user to click OK.
      3. -
    3. Check the orientation and if Landscape is selected, throw an error and exit.
      4. -
    4. Set up the page height and width for sheet1 and sheet2.
      5. -
    5. Send sheet1 and sheet2 to the print spooler using addPage().
      6. -
    6. If the number of pages to print is > 0, print all spooled pages.
      7. -
    6. -
  6. The draw() method is called, which re-sizes the two Sprite properties to fit on the stage - and re-positions sheet2 such that it is just right of sheet1.
    7. -
- -

Note: the constructor is set up such that one of three printing methods (one sheet per - page, two sheets per page, or printing on the top half of the page) can be selected, based on preference. - This example will not work correctly unless exactly two of the print methods are disabled using code - comments. The example is set up such that printOnePerPage() will be called.

-
-
-package {
-    import flash.printing.PrintJob;
-    import flash.printing.PrintJobOrientation;
-    import flash.display.Stage;
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.geom.Rectangle;
-       
-    public class PrintJobExample extends Sprite {
-        private var sheet1:Sprite;
-        private var sheet2:Sprite;
-           
-        public function PrintJobExample() {
-            init();
-            printOnePerPage();
-//            printTwoPerPage();
-//            printTopHalf();
-            draw();
-        }
-        
-        private function init():void {
-            sheet1 = new Sprite();
-            createSheet(sheet1, "Once upon a time...", {x:10, y:50, width:80, height:130});
-
-            sheet2 = new Sprite();
-            createSheet(sheet2, "There was a great story to tell, and it ended quickly.\n\nThe end.", null);
-        }
-        
-        private function createSheet(sheet:Sprite, str:String, imgValue:Object):void {
-            sheet.graphics.beginFill(0xEEEEEE);
-            sheet.graphics.lineStyle(1, 0x000000);
-            sheet.graphics.drawRect(0, 0, 100, 200);
-            sheet.graphics.endFill();
-            
-            var txt:TextField = new TextField();
-            txt.height = 200;
-            txt.width = 100;
-            txt.wordWrap = true;
-            txt.text = str;
-            
-            if(imgValue != null) {
-                var img:Sprite = new Sprite();
-                img.graphics.beginFill(0xFFFFFF);
-                img.graphics.drawRect(imgValue.x, imgValue.y, imgValue.width, imgValue.height);
-                img.graphics.endFill();
-                sheet.addChild(img);
-            }
-            sheet.addChild(txt);
-        }
-        
-        private function printOnePerPage():void {
-            var pj:PrintJob = new PrintJob();
-            var pagesToPrint:uint = 0;
-            if(pj.start()) {                
-                if(pj.orientation == PrintJobOrientation.LANDSCAPE) {    
-                    throw new Error("Without embedding fonts you must print one sheet per page with an orientation of portrait.");
-                }
-                
-                sheet1.height = pj.pageHeight;
-                sheet1.width = pj.pageWidth;
-                sheet2.height = pj.pageHeight;
-                sheet2.width = pj.pageWidth;
-
-                try {
-                    pj.addPage(sheet1);
-                    pagesToPrint++;
-                }
-                catch(e:Error) {
-                    // do nothing
-                }
-
-                try {
-                    pj.addPage(sheet2);
-                    pagesToPrint++;
-                }
-                catch(e:Error) {
-                    // do nothing
-                }
-
-                if(pagesToPrint > 0) {
-                    pj.send();
-                }
-            }
-        }
-        
-        private function printTwoPerPage():void {
-            var pj:PrintJob = new PrintJob();
-            var pagesToPrint:uint = 0;
-            if(pj.start()) {                
-                if(pj.orientation == PrintJobOrientation.PORTRAIT) {
-                    throw new Error("Without embedding fonts you must print two sheets per page with an orientation of landscape.");
-                }
-                
-                sheet1.height = pj.pageHeight;
-                sheet1.width = pj.pageWidth/2;
-                sheet2.height = pj.pageHeight;
-                sheet2.width = pj.pageWidth/2;
-
-                var sheets:Sprite = new Sprite();
-                sheets.addChild(sheet1);
-                sheets.addChild(sheet2);
-                sheets.getChildAt(1).x = sheets.getChildAt(0).width;
-                try {
-                    pj.addPage(sheets);
-                    pagesToPrint++;
-                }
-                catch(e:Error) {
-                    // do nothing
-                }
-
-                if(pagesToPrint > 0) {
-                    pj.send();
-                }
-            }
-        }
-
-        private function printTopHalf():void {
-            var pj:PrintJob = new PrintJob();
-            var pagesToPrint:uint = 0;
-            if(pj.start()) {                
-                if(pj.orientation == PrintJobOrientation.PORTRAIT) {
-                    throw new Error("Without embedding fonts you must print the top half with an orientation of landscape.");
-                }
-                
-                sheet1.height = pj.pageHeight;
-                sheet1.width = pj.pageWidth/2;
-                sheet2.height = pj.pageHeight;
-                sheet2.width = pj.pageWidth/2;
-
-                var sheets:Sprite = new Sprite();
-                sheets.addChild(sheet1);
-                sheets.addChild(sheet2);
-                sheets.getChildAt(1).x = sheets.getChildAt(0).width;
-                try {
-                    pj.addPage(sheets, new Rectangle(0, 0, sheets.width, sheets.height/2));
-                    pagesToPrint++;
-                }
-                catch(e:Error) {
-                    // do nothing
-                }
-
-                if(pagesToPrint > 0) {
-                    pj.send();
-                }
-            }
-        }
-
-
-        private function draw():void {
-            var sheetWidth:Number = this.stage.stageWidth/2;
-            var sheetHeight:Number = this.stage.stageHeight;
-            
-            addChild(sheet1);
-            sheet1.width = sheetWidth;
-            sheet1.height = sheetHeight;
-            
-            addChild(sheet2);
-            sheet2.width = sheetWidth;
-            sheet2.height = sheetHeight;
-            sheet2.x = sheet1.width;
-        }        
-    }
-}
-
-
-
examples\PrintJobExample.2
-
The following example demonstrates additional printing features. - The example initializes the PrintJob settings for number of copies, - paper size (legal), and page orientation (landscape). It forces the - Page Setup dialog to be displayed first, then starts the print job - by displaying the Print dialog. -
-
 
-package 
- { 
-     import flash.display.Sprite; 
- 	import flash.display.Stage; 
- 	import flash.geom.Rectangle; 
- 	import flash.printing.PaperSize; 
- 	import flash.printing.PrintJob; 
-	import flash.printing.PrintJobOrientation; 
-	import flash.printing.PrintUIOptions; 
-	import flash.text.TextField; 
- 	 
- 	public class PrintJobExample extends Sprite 
- 	{ 
- 		private var bg:Sprite; 
- 		private var txt:TextField; 
-		private var pj:PrintJob; 
-		private var uiOpt:PrintUIOptions; 
-  
- 		public function PrintJobExample():void 
- 		{ 
-			var pj = new PrintJob(); 
-			uiOpt = new PrintUIOptions(); 
-			initPrintJob(); 
- 			initContent(); 
- 			draw(); 
- 			printPage(); 
- 		} 
- 		 
- 		private function printPage():void 
- 		{ 
-			if (pj.supportsPageSetupDialog) 
-			{ 
-				pj.showPageSetupDialog(); 
-			}
-			
- 			if (pj.start2(uiOpt, true)) 
- 			{ 
-   				try 
- 				{ 
- 					pj.addPage(this, new Rectangle(0, 0, 100, 100)); 
- 				} 
- 				catch (error:Error) 
- 				{ 
- 					// Do nothing. 
- 				} 
- 				pj.send(); 
- 			} 
- 			else 
- 			{ 
- 				txt.text = "Print job terminated"; 
-				pj.terminate(); 
- 			} 
- 		} 
-		 
- 		private function initContent():void 
- 		{ 
- 			bg = new Sprite(); 
- 			bg.graphics.beginFill(0x00FF00); 
- 			bg.graphics.drawRect(0, 0, 100, 200); 
- 			bg.graphics.endFill(); 
- 			 
- 			txt = new TextField(); 
- 			txt.border = true; 
- 			txt.text = "Hello World"; 
- 		} 
- 		 
-		private function initPrintJob():void 
-		{ 
-			pj.setPaperSize(PaperSize.LEGAL); 
-			pj.orientation = PrintJobOrientation.LANDSCAPE; 
-			pj.copies = 2; 
-			pj.jobName = "Flash test print";
-		} 
-		 
- 		private function draw():void 
- 		{ 
- 			addChild(bg); 
- 			addChild(txt); 
- 			txt.x = 50; 
- 			txt.y = 50; 
- 		} 
- 	} 
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/printing/PrintJobOptions.html b/html-docs/flash/printing/PrintJobOptions.html deleted file mode 100644 index 4e7c226..0000000 --- a/html-docs/flash/printing/PrintJobOptions.html +++ /dev/null @@ -1,464 +0,0 @@ - - - - - - - - -flash.printing.PrintJobOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.printing
Classpublic class PrintJobOptions
InheritancePrintJobOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The PrintJobOptions class contains properties to use with the - options parameter of the PrintJob.addPage() method. - For more information about addPage(), see the PrintJob class. -

-

-See also -

-
-PrintJob -
-PrintJob.addPage() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  pixelsPerInch : Number = NaN
- Specifies the resolution to use for bitmaps, in pixels per inch.
-		PrintJobOptions
  printAsBitmap : Boolean = false
- Specifies whether the content in the print job is printed as a bitmap or as a vector.
-		PrintJobOptions
  printMethod : String -
-		PrintJobOptions
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-PrintJobOptions(printAsBitmap:Boolean = false)
-
- Creates a new PrintJobOptions object.
-		PrintJobOptions
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
pixelsPerInchproperty
-
-public var pixelsPerInch:Number = NaN -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the resolution to use for bitmaps, in pixels per inch. - The default value is Number.NaN, indicating that the native - printer resolution is used. -

The resolution setting is for both bitmap and vector printing. For bitmap printing, - resolution controls how the entire page is rasterized. For vector printing, resolution - controls how specific content, such as bitmaps and gradients, is rasterized.

-
- - - - - -
printAsBitmapproperty 
-
-public var printAsBitmap:Boolean = false -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether the content in the print job is printed as a bitmap or as a vector. - The default value is false, for vector printing. -

If the content that you're printing includes a bitmap image, - set printAsBitmap to true to include any - alpha transparency and color effects. - If the content does not include bitmap images, print - the content in higher quality vector format (the default option).

-

For example, to print your content as a bitmap, use the following syntax:

- 
-		 var options:PrintJobOptions = new PrintJobOptions();
-		 options.printAsBitmap = true;
-		 myPrintJob.addPage(mySprite, null, options);
-
-

Note:Adobe AIR does not support vector printing on Mac OS.

-

-See also -

-
-PrintJobOptions.printMethod -
-
-Example -
The following example first loads a picture and puts it in a rectangle frame, then print the picture as a bitmap. - -
    -
  1. The constructor loads the picture (image.jpg) using the Loader and URLRequest objects. - It also checks if an error occurred during loading. Here the file is assumed to be in the same directory as the SWF file. - The SWF file needs to be compiled with Local Playback Secuirty set to Access Local Files Only.
    2. -
  2. When the picture is loaded (the event is complete), the completeHandler() method is called.
    3. -
  3. The completeHandler() method, creates a BitmapData object, and loads the picture (bitmap) in it. - A rectangle is drawn in the Sprite object (frame) and the beginBitmapFill() method is used - to fill the rectangle with the picture (a BitmapData object). A Matrix object also is used to scale the - image to fit the rectangle. (Note that this will distort the image. It is used in this example to make sure the image fits.) - Once the image is filled, the printPage() method is called.
    4. -
  4. The printPage() method creates a new instance of the print job and starts the printing process, which invokes the - print dialog box for the user, and populates the properties of the print job. The addPage() method contains the - details about the print job. Here, the frame with the picture (a Sprite object) is set to print as a bitmap and not - as a vector. options is an instance of PrintJobOptions class and its property printAsBitmap - is set to true in order to print as a bitmap (default setting is false).
    5. -
-

Note: There is very limited error handling defined for this example.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.display.Loader;
-    import flash.display.Bitmap;
-    import flash.display.BitmapData;    
-    import flash.printing.PrintJob;
-    import flash.printing.PrintJobOptions;
-    import flash.events.Event;
-    import flash.events.IOErrorEvent;
-    import flash.net.URLRequest;
-    import flash.geom.Matrix;
-
-    public class printAsBitmapExample extends Sprite {
-
-        private var frame:Sprite = new Sprite();
-        private var url:String = "image.jpg";
-        private var loader:Loader = new Loader();
-
-        public function printAsBitmapExample() {
-
-           var request:URLRequest = new URLRequest(url);
-  
-           loader.load(request);
-           loader.contentLoaderInfo.addEventListener(Event.COMPLETE, completeHandler);
-           loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR, ioErrorHandler);
-        }
-
-        private function completeHandler(event:Event):void {
-        
-            var picture:Bitmap = Bitmap(loader.content);
-            var bitmap:BitmapData = picture.bitmapData;
-
-            var matrix:Matrix = new Matrix();
-
-            matrix.scale((200 / bitmap.width), (200 / bitmap.height));
-            
-            frame.graphics.lineStyle(10);
-            frame.graphics.beginBitmapFill(bitmap, matrix, true);
-            frame.graphics.drawRect(0, 0, 200, 200);
-            frame.graphics.endFill();
-
-            addChild(frame);
-             
-            printPage();    
-        }
-
-        private function ioErrorHandler(event:IOErrorEvent):void {
-            trace("Unable to load the image: " + url);
-        }
-
-        private function printPage ():void {
-            var myPrintJob:PrintJob = new PrintJob();
-            var options:PrintJobOptions = new PrintJobOptions();
-            options.printAsBitmap = true;
-            
-            myPrintJob.start();
-  
-            try {
-                myPrintJob.addPage(frame, null, options);
-            }
-            catch(e:Error) {
-                trace ("Had problem adding the page to print job: " + e);
-            }
- 
-            try {
-            myPrintJob.send();
-            }
-            catch (e:Error) {
-                trace ("Had problem printing: " + e);    
-            }
-        }
-    }
-}
-
-

-
- - - - - -
printMethodproperty 
-
-printMethod:String  [read-write]Implementation -
-    public function get printMethod():String -
-    public function set printMethod(value:String):void -
-
- -
Constructor detail
- - - - - -
PrintJobOptions()constructor
-
-public function PrintJobOptions(printAsBitmap:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new PrintJobOptions object. Pass this object - to the options parameter of the PrintJob.addPage() method. -

Parameters - - - - -
printAsBitmap:Boolean (default = false) — If true, this object is printed as a bitmap. - If false, this object is printed as a vector. -

If the content that you're printing includes a bitmap image, - set the printAsBitmap property to true to include any - alpha transparency and color effects. - If the content does not include bitmap images, omit this parameter to print - the content in higher quality vector format (the default option).

-

Note:Adobe AIR does not support vector printing on Mac OS.

-
-

-See also -

-
-PrintJob.addPage() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/printing/PrintJobOrientation.html b/html-docs/flash/printing/PrintJobOrientation.html deleted file mode 100644 index 82e15c7..0000000 --- a/html-docs/flash/printing/PrintJobOrientation.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - - - -flash.printing.PrintJobOrientation (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.printing
Classpublic final class PrintJobOrientation
InheritancePrintJobOrientation Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-This class provides values that are used by the PrintJob.orientation property for the image position of a printed page. -

-

-See also -

-
-PrintJob.orientation -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  LANDSCAPE : String = "landscape"
[static] - The landscape (horizontal) image orientation for printing.
-		PrintJobOrientation
  PORTRAIT : String = "portrait"
[static] - The portrait (vertical) image orientation for printing.
-		PrintJobOrientation
-
- -
- -
Constant detail
- - - - - -
LANDSCAPEconstant
-
-public static const LANDSCAPE:String = "landscape" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The landscape (horizontal) image orientation for printing. - This constant is used with the PrintJob.orientation property. - Use the syntax PrintJobOrientation.LANDSCAPE. -

-See also -

-
-PrintJob.orientation -
-PORTRAIT -
-
- - - - - -
PORTRAITconstant 
-
-public static const PORTRAIT:String = "portrait" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The portrait (vertical) image orientation for printing. - This constant is used with the PrintJob.orientation property. - Use the syntax PrintJobOrientation.PORTRAIT. -

-See also -

-
-PrintJob.orientation -
-LANDSCAPE -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/printing/PrintMethod.html b/html-docs/flash/printing/PrintMethod.html deleted file mode 100644 index 22b6cd2..0000000 --- a/html-docs/flash/printing/PrintMethod.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - - - -flash.printing.PrintMethod (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.printing
Classpublic final class PrintMethod
InheritancePrintMethod Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-This class provides values for the PrintJobOptions.printMethod property -to specify the method of printing a page. -

-

-See also -

-
-PrintJobOptions.printMethod -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  AUTO : String = "auto"
[static] - Automatic selection of the best method of printing.
-		PrintMethod
  BITMAP : String = "bitmap"
[static] - The bitmap method of printing.
-		PrintMethod
  VECTOR : String = "vector"
[static] - The vector method of printing.
-		PrintMethod
-
- -
- -
Constant detail
- - - - - -
AUTOconstant
-
-public static const AUTO:String = "auto" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Automatic selection of the best method of printing. This value indicates - that vector or bitmap printing is chosen automatically, based on - the content to print. Vector printing is used whenever the content - can be faithfully reproduced by that method. If transparency or certain - other effects are present, bitmap printing is used instead. -

This constant is used with the PrintJobOptions.printMethod property. - Use the syntax PrintMethod.AUTO.

-

-See also -

-
-PrintJobOptions.printMethod -
-VECTOR -
-BITMAP -
-
- - - - - -
BITMAPconstant 
-
-public static const BITMAP:String = "bitmap" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The bitmap method of printing. -

This constant is used with the PrintJobOptions.printMethod property. - Use the syntax PrintMethod.BITMAP.

-

-See also -

-
-PrintJobOptions.printMethod -
-VECTOR -
-AUTO -
-
- - - - - -
VECTORconstant 
-
-public static const VECTOR:String = "vector" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The vector method of printing. -

This constant is used with the PrintJobOptions.printMethod property. - Use the syntax PrintMethod.VECTOR.

-

-See also -

-
-PrintJobOptions.printMethod -
-BITMAP -
-AUTO -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/printing/PrintUIOptions.html b/html-docs/flash/printing/PrintUIOptions.html deleted file mode 100644 index 7ce933b..0000000 --- a/html-docs/flash/printing/PrintUIOptions.html +++ /dev/null @@ -1,373 +0,0 @@ - - - - - - - - -flash.printing.PrintUIOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.printing
Classpublic final class PrintUIOptions
InheritancePrintUIOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The PrintUIOptions class is used to specify options for print dialogs that are displayed to the - user. Create a PrintUIOptions instance, set its properties, and pass it as the - uiOptions parameter of the PrintJob.showPageSetupDialog() - or PrintJob.start2() method. - -

For example, the following code uses a PrintUIOptions instance to specify the - min and max page numbers when the Page Setup dialog is displayed:

- - 
import flash.printing.PrintJob;
- 
- var myPrintJob:PrintJob = new PrintJob();
- if (myPrintJob.supportsPageSetupDialog)
- {
-     var uiOpt:PrintUIOptions = new PrintUIOptions();
-     uiOpt.minPage = 1;
-     uiOpt.maxPage = 3;
-     myPrintJob.showPageSetupDialog(uiOpt);
- }
- -

-

-See also -

-
-PrintJob -
-PrintJob.showPageSetupDialog() -
-PrintJob.start2() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  disablePageRange : Boolean = false
- Specifies whether the page range in the print dialog is disabled (true) or - the user can edit it (false).
-		PrintUIOptions
  maxPage : uint = 0
- The maxiumum page number the user can enter - in the print dialog.
-		PrintUIOptions
  minPage : uint = 0
- The minimum page number a user can enter - in the print dialog.
-		PrintUIOptions
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-PrintUIOptions()
-
- Creates a new PrintUIOptions object.
-		PrintUIOptions
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
disablePageRangeproperty
-
-public var disablePageRange:Boolean = false -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies whether the page range in the print dialog is disabled (true) or - the user can edit it (false). The default value is false, - indicating that there is no restriction on editing the page range. - -

The default value is false.

-
- - - - - -
maxPageproperty 
-
-public var maxPage:uint = 0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The maxiumum page number the user can enter - in the print dialog. The default value is 0, indicating that there is - no restriction on the maximum page number. -

The default value is 0.

-
- - - - - -
minPageproperty 
-
-public var minPage:uint = 0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The minimum page number a user can enter - in the print dialog. The default value is 0, indicating that there is - no restriction on the minimum page number. -

The default value is 0.

-
- -
Constructor detail
- - - - - -
PrintUIOptions()constructor
-
-public function PrintUIOptions() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Creates a new PrintUIOptions object. You pass this object to the - uiOptions parameter of the PrintJob.showPageSetupDialog() - or PrintJob.start2() method. -

-See also -

-
-PrintJob.showPageSetupDialog() -
-PrintJob.start2() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/printing/package-detail.html b/html-docs/flash/printing/package-detail.html deleted file mode 100644 index 2fa4f1e..0000000 --- a/html-docs/flash/printing/package-detail.html +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - -flash.printing Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.printing package contains classes for printing Flash-based content.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 PaperSize -This class provides the available values for the paperSize parameter of -the PrintJob.selectPaperSize() method.
 PrintJob - The PrintJob class lets you create content and print it to one or - more pages.
 PrintJobOptions - The PrintJobOptions class contains properties to use with the - options parameter of the PrintJob.addPage() method.
 PrintJobOrientation -This class provides values that are used by the PrintJob.orientation property for the image position of a printed page.
 PrintMethod -This class provides values for the PrintJobOptions.printMethod property -to specify the method of printing a page.
 PrintUIOptions - The PrintUIOptions class is used to specify options for print dialogs that are displayed to the - user.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/profiler/Telemetry.html b/html-docs/flash/profiler/Telemetry.html deleted file mode 100644 index a833c34..0000000 --- a/html-docs/flash/profiler/Telemetry.html +++ /dev/null @@ -1,504 +0,0 @@ - - - - - - - - -flash.profiler.Telemetry (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.profiler
Classpublic final class Telemetry
InheritanceTelemetry Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

-

- The Telemetry class lets an application profile ActionScript code and register handlers for commands -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
  connected : Boolean -
[static][read-only] - Indicates whether Telemetry is connected to a server -
-		Telemetry
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  spanMarker : Number -
[static][read-only] - Returns a marker for use with Telemetry.sendSpanMetric -
-		Telemetry
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-registerCommandHandler(commandName:String, handler:Function):Boolean -
-
[static] - Register a function that can be called by issuing a command over a socket -

Returns true if the registration is successful.

-		Telemetry
   -
-sendMetric(metric:String, value:*):void -
-
[static] - Requests a custom metric from Telemetry.
-		Telemetry
   -
-sendSpanMetric(metric:String, startSpanMarker:Number, value:* = null):void -
-
[static] - Requests a custom span metric from Telemetry -

Use Telemetry.spanMarker to get a marker at the start of function to be profiled and call Telemetry.sendSpanMetric at the end of function - with the marker.

-		Telemetry
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-unregisterCommandHandler(commandName:String):Boolean -
-
[static]
-		Telemetry
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
connectedproperty
-
-connected:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Indicates whether Telemetry is connected to a server -

Implementation -
-    public static function get connected():Boolean -
-
- - - - - -
spanMarkerproperty 
-
-spanMarker:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Returns a marker for use with Telemetry.sendSpanMetric -

Implementation -
-    public static function get spanMarker():Number -
-

-See also -

-
-sendSpanMetric() -
-
- -
Method detail
- - - - - -
registerCommandHandler()method
-
-public static function registerCommandHandler(commandName:String, handler:Function):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Register a function that can be called by issuing a command over a socket -

Returns true if the registration is successful. If registration fails, there is already a handler registered for the command - used (or the command name starts with '.', which is reserved for player internal use) - Already registered handlers may be unregistered using unregisterCommandHandler before registering another handler.

-

The handler function's return value is sent as the result of the command (tlm-response.result). - The handler function can throw Error, if it wants to send an error response. In this case, Error.message and Error.id are sent as - tlm-response.tlm-error.message and tlm-response.tlm-error.code, respectively. (tlm-response.result and - tlm-response.tlm-error.data are sent as null)

- Parameters - - - - - - - - - - -
commandName:String — String specifying a unique name (The command over the socket should specify this string as the method name). - The guideline is to follow reverse DNS notation, which helps to avoid namespace collisions. Additionally, - and names starting with . are reserved for native use. -
 
handler:Function — Function to be called when a command is received by Telemetry over the socket with the method name, as specified in functionId argument. - The handler should accept only one argument of type Array (as defined by tlm-method.params in Telemetry Protocol), which has to be sent by Telemetry server along with method name. -
-

-Returns - - - - -
Boolean
-
- - - - - -
sendMetric()method 
-
-public static function sendMetric(metric:String, value:*):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Requests a custom metric from Telemetry. The metric name and object are sent as per the - Telemetry protocol format. -

The guideline for custom metric namespaces is to follow reverse DNS notation, which helps to avoid namespace collisions.

- Parameters - - - - - - - - - - -
metric:String — Metric name -
 
value:* — Any primitive value/object containing the metric details -
-
-Throws - - - - -
ArgumentError — If metric uses reserved namespaces like flash native namespace (for example, if the metric name starts with '.') -
-
- - - - - -
sendSpanMetric()method 
-
-public static function sendSpanMetric(metric:String, startSpanMarker:Number, value:* = null):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Requests a custom span metric from Telemetry -

Use Telemetry.spanMarker to get a marker at the start of function to be profiled and call Telemetry.sendSpanMetric at the end of function - with the marker. Telemetry sends the name, starting marker, and duration of the function plus the optional value as per the Telemetry protocol.

-

The guideline for custom metric namespaces is to follow reverse DNS notation, which helps to avoid namespace collisions.

-

Span metrics for durations less than a specified threshold, which could be controlled from the Telemetry Server using Telemetry Protocol, would - be ignored by Telemetry (will not be sent to Telemetry Server).

- Parameters - - - - - - - - - - - - - - - - -
metric:String — Metric name -
 
startSpanMarker:Number — Start marker. -
 
value:* (default = null) — Optional parameter. Any primitive value/object to be sent along with name, marker and duration -
-
-Throws - - - - -
ArgumentError — If metric uses reserved namespaces like flash native namespace (i.e. if metric name starts with '.') -
-

-See also -

-
-spanMarker -
-sendSpanMetric() -
-
- - - - - -
unregisterCommandHandler()method 
-
-public static function unregisterCommandHandler(commandName:String):BooleanParameters - - - - -
commandName:String
-

-Returns - - - - -
Boolean
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/profiler/package-detail.html b/html-docs/flash/profiler/package-detail.html deleted file mode 100644 index bbc6d7a..0000000 --- a/html-docs/flash/profiler/package-detail.html +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - -flash.profiler Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.profiler package contains functions used for debugging and profiling ActionScript code.

-
-
- -
Functions
- - - - - - - -
 FunctionDescription
 showRedrawRegions - Shows or hides redraw regions.
- -
Classes
- - - - - - - -
 ClassDescription
 Telemetry - The Telemetry class lets an application profile ActionScript code and register handlers for commands -
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/profiler/package.html b/html-docs/flash/profiler/package.html deleted file mode 100644 index da311c5..0000000 --- a/html-docs/flash/profiler/package.html +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - -flash.profiler Details (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-These functions can be used for debugging and profiling ActionScript code.
-
Public Functions
- - - - - - - -
 FunctionDefined by
   -
-showRedrawRegions(on:Boolean, color:uint = 0xFF0000):void -
-
- Shows or hides redraw regions.
-		flash.profiler
-
- -
Function detail
- - - - - -
showRedrawRegions()function
-
-public function showRedrawRegions(on:Boolean, color:uint = 0xFF0000):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Shows or hides redraw regions. Enables the debugger version of Flash® Player to outline - the regions of the screen that are being redrawn (that is regions that are being - updated). -

Parameters - - - - - - - - - - -
on:Boolean — Specifies whether to show or hide - redraw regions. When set to true, the redraw rectangles are - shown. When set to false, the redraw rectangles are hidden. -
 
color:uint (default = 0xFF0000) — Sets the color of the rectangles. If you do not specify this parameter, - 0xFF0000 is used. -
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/security/CertificateStatus.html b/html-docs/flash/security/CertificateStatus.html deleted file mode 100644 index a29bb5f..0000000 --- a/html-docs/flash/security/CertificateStatus.html +++ /dev/null @@ -1,525 +0,0 @@ - - - - - - - - -flash.security.CertificateStatus (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.security
Classpublic final class CertificateStatus
InheritanceCertificateStatus Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The CertificateStatus class defines constants used to report the - results of certificate validation processing by a SecureSocket object. - -

-

-See also -

-
-SecureSocket.serverCertificateStatus -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  EXPIRED : String = "expired"
[static] - The certificate is outside its valid period.
-		CertificateStatus
  INVALID : String = "invalid"
[static] - An invalid certificate.
-		CertificateStatus
  INVALID_CHAIN : String = "invalidChain"
[static] - A root or intermediate certificate in this certificate's chain is invalid.
-		CertificateStatus
  NOT_YET_VALID : String = "notYetValid"
[static] - The certificate is not yet valid.
-		CertificateStatus
  PRINCIPAL_MISMATCH : String = "principalMismatch"
[static] - The certificate common name does not match the expected host name.
-		CertificateStatus
  REVOKED : String = "revoked"
[static] - The certificate has been revoked.
-		CertificateStatus
  TRUSTED : String = "trusted"
[static] - A valid, trusted certificate.
-		CertificateStatus
  UNKNOWN : String -
[static] - The validity of the certificate is not known.
-		CertificateStatus
  UNTRUSTED_SIGNERS : String = "untrustedSigners"
[static] - The certificate does not chain to a trusted root certificate.
-		CertificateStatus
-
- -
- -
Constant detail
- - - - - -
EXPIREDconstant
-
-public static const EXPIRED:String = "expired" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The certificate is outside its valid period. - -

Indicates that certificate validation processing - was attempted, but failed because the validity period of the certificate is either before or - after the current date. On some operating systems, the notYetValid status is reported - when the current date is before the validity period of the cerificate. On other operating systems, - the expired status is reported in both cases.

- -
- - - - - -
INVALIDconstant 
-
-public static const INVALID:String = "invalid" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- An invalid certificate. - -

Indicates that certificate validation processing - was attempted, but failed. This is the generic faliure status that - is reported when a more specific certificate status cannot be - determined.

- -
- - - - - -
INVALID_CHAINconstant 
-
-public static const INVALID_CHAIN:String = "invalidChain" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A root or intermediate certificate in this certificate's chain is invalid. - -

Indicates that certificate validation processing - was attempted, but failed because the certificate's trust chain was - invalid.

- -
- - - - - -
NOT_YET_VALIDconstant 
-
-public static const NOT_YET_VALID:String = "notYetValid" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The certificate is not yet valid. - -

Indicates that a certificate is not yet valid. - The current date is before the notBefore date/time of the certificate

- -
- - - - - -
PRINCIPAL_MISMATCHconstant 
-
-public static const PRINCIPAL_MISMATCH:String = "principalMismatch" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The certificate common name does not match the expected host name. - -

Indicates that certificate validation - processing was attempted, but failed because the certificate's - common name does not match the fully qualified domain name of the host.

- -
- - - - - -
REVOKEDconstant 
-
-public static const REVOKED:String = "revoked" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The certificate has been revoked. - -

Indicates that certificate validation processing - was attempted, but failed because the certificate has been revoked. On - some operating systems, the revoked status is also reported - when the certificate (or its root certificate) has been added to the - list of untrusted certificates on the client computer.

- -
- - - - - -
TRUSTEDconstant 
-
-public static const TRUSTED:String = "trusted" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A valid, trusted certificate. - -

Indicates that a certificate has not expired, has not - failed a revocation check, and chains to a trusted root certificate.

- -
- - - - - -
UNKNOWNconstant 
-
-public static const UNKNOWN:String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The validity of the certificate is not known. - -

Indicates that certificate validation processing - has not been performed yet on a certificate.

- -
- - - - - -
UNTRUSTED_SIGNERSconstant 
-
-public static const UNTRUSTED_SIGNERS:String = "untrustedSigners" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The certificate does not chain to a trusted root certificate. - -

Indicates that certificate validation - processing was attempted, but that the certificate does not chain - to any of the root certificates in the client trust store. On - some operating systems, the untrustedSigners is also - reported if the certificate is in the list of untrusted certificates - on the client computer.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/security/IURIDereferencer.html b/html-docs/flash/security/IURIDereferencer.html deleted file mode 100644 index d64b2fa..0000000 --- a/html-docs/flash/security/IURIDereferencer.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - - -flash.security.IURIDereferencer (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - -
Packageflash.security
Interfacepublic interface IURIDereferencer
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- IURIDereferencer defines an interface for objects that resolve - URIs in an XML signature. - -

The IURIDereferencer implementation is responsible for resolving the - URIs specified in the SignedInfo elements of an XML signature file and - returning the referenced data in an object, such as a ByteArray, that implements - the IDataInput interface. In order to use the - IURIDereferencer interface, you must create an ActionScript class that implements - the interface. In JavaScript, you can use a script tag to load - a SWF file that contains that ActionScript class.

- -

The interface has one method: dereference(). - A typical implementation might also require a method for passing - the XML signature object containing the URIs to be resolved to - the dereferencer.

- -

The IURIDereferencer interface is used with the - XMLSignatureValidator class.

- -

-

-See also -

-
-XMLSignatureValidator -
-XMLSignatureValidator.uriDereferencer -
-
-
-
- -
-
Public Methods
- - - - - - - -
 MethodDefined by
   -
-dereference(uri:String):IDataInput -
-
- Resolves and dereferences the specified URI.
-		IURIDereferencer
-
- -
- -
Method detail
- - - - - -
dereference()method
-
-public function dereference(uri:String):IDataInput -

- - - - -
Runtime version: AIR 1.0 -
-

- Resolves and dereferences the specified URI. - -

Parameters - - - - -
uri:String — The URI to dereference. -
-

-Returns - - - - -
IDataInput — - The data referenced by the URI. - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/security/ReferencesValidationSetting.html b/html-docs/flash/security/ReferencesValidationSetting.html deleted file mode 100644 index c51558d..0000000 --- a/html-docs/flash/security/ReferencesValidationSetting.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - -flash.security.ReferencesValidationSetting (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.security
Classpublic final class ReferencesValidationSetting
InheritanceReferencesValidationSetting Inheritance Object
-

- - - - -
Runtime version: AIR 1.5 -
-

-

- The ReferencesValidationSetting class defines constants used by the referencesValidationSetting - property of an XMLSignatureValidator object. - -

-

-See also -

-
-XMLSignatureValidator.ReferencesValidationSetting -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  NEVER : String = "never"
[static] - Never check references.
-		ReferencesValidationSetting
  VALID_IDENTITY : String = "validIdentity"
[static] - Only check references if the signing certificate is valid and trusted.
-		ReferencesValidationSetting
  VALID_OR_UNKNOWN_IDENTITY : String = "validOrUnknownIdentity"
[static] - Check references even if the signing certificate is untrusted (does not chain to a known trusted root).
-		ReferencesValidationSetting
-
- -
- -
Constant detail
- - - - - -
NEVERconstant
-
-public static const NEVER:String = "never" -

- - - - -
Runtime version: AIR 1.5 -
-

- Never check references. - -

- - - - - -
VALID_IDENTITYconstant 
-
-public static const VALID_IDENTITY:String = "validIdentity" -

- - - - -
Runtime version: AIR 1.5 -
-

- Only check references if the signing certificate is valid and trusted. - -

- - - - - -
VALID_OR_UNKNOWN_IDENTITYconstant 
-
-public static const VALID_OR_UNKNOWN_IDENTITY:String = "validOrUnknownIdentity" -

- - - - -
Runtime version: AIR 1.5 -
-

- Check references even if the signing certificate is untrusted (does not chain to a known trusted root). - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/security/RevocationCheckSettings.html b/html-docs/flash/security/RevocationCheckSettings.html deleted file mode 100644 index 4276aed..0000000 --- a/html-docs/flash/security/RevocationCheckSettings.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - - - -flash.security.RevocationCheckSettings (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.security
Classpublic final class RevocationCheckSettings
InheritanceRevocationCheckSettings Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The RevocationCheckSettings class defines constants used by the - revocationCheckSetting property of an XMLSignatureValidator object. - -

-

-See also -

-
-XMLSignatureValidator.revocationCheckSetting -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  ALWAYS_REQUIRED : String = "alwaysRequired"
[static] - Always check certificate revocation.
-		RevocationCheckSettings
  BEST_EFFORT : String = "bestEffort"
[static] - Check certificate revocation, if revocation information is available and the revocation status - can be obtained.
-		RevocationCheckSettings
  NEVER : String = "never"
[static] - Do not check certificate revocation.
-		RevocationCheckSettings
  REQUIRED_IF_AVAILABLE : String = "requiredIfInfoAvailable"
[static] - Check certificate revocation if the certificate includes revocation information.
-		RevocationCheckSettings
-
- -
- -
Constant detail
- - - - - -
ALWAYS_REQUIREDconstant
-
-public static const ALWAYS_REQUIRED:String = "alwaysRequired" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Always check certificate revocation. Certificates without revocation information are rejected. - -

- - - - - -
BEST_EFFORTconstant 
-
-public static const BEST_EFFORT:String = "bestEffort" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Check certificate revocation, if revocation information is available and the revocation status - can be obtained. If revocation status cannot be positively determined, the certificate is not rejected. -

- - - - - -
NEVERconstant 
-
-public static const NEVER:String = "never" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Do not check certificate revocation. - -

- - - - - -
REQUIRED_IF_AVAILABLEconstant 
-
-public static const REQUIRED_IF_AVAILABLE:String = "requiredIfInfoAvailable" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Check certificate revocation if the certificate includes revocation information. If the information - is available, but revocation status cannot be positively determined, the certificate is rejected. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/security/SignatureStatus.html b/html-docs/flash/security/SignatureStatus.html deleted file mode 100644 index 2a2c53d..0000000 --- a/html-docs/flash/security/SignatureStatus.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - - - -flash.security.SignatureStatus (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.security
Classpublic final class SignatureStatus
InheritanceSignatureStatus Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The SignatureStatus class defines constants used by the validityStatus - property of an XMLSignatureValidator object. - -

-

-See also -

-
-XMLSignatureValidator.validityStatus -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  INVALID : String = "invalid"
[static] - Invalid status.
-		SignatureStatus
  UNKNOWN : String -
[static] - Unknown status.
-		SignatureStatus
  VALID : String = "valid"
[static] - Valid status.
-		SignatureStatus
-
- -
- -
Constant detail
- - - - - -
INVALIDconstant
-
-public static const INVALID:String = "invalid" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Invalid status. - -

- - - - - -
UNKNOWNconstant 
-
-public static const UNKNOWN:String -

- - - - -
Runtime version: AIR 1.0 -
-

- Unknown status. - -

- - - - - -
VALIDconstant 
-
-public static const VALID:String = "valid" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Valid status. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/security/SignerTrustSettings.html b/html-docs/flash/security/SignerTrustSettings.html deleted file mode 100644 index 2c6c83b..0000000 --- a/html-docs/flash/security/SignerTrustSettings.html +++ /dev/null @@ -1,313 +0,0 @@ - - - - - - - - -flash.security.SignerTrustSettings (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.security
Classpublic final class SignerTrustSettings
InheritanceSignerTrustSettings Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The SignerTrustSettings class defines constants used with the - signerTrustSettings property of an XMLSignatureValidator object. - -

-

-See also -

-
-XMLSignatureValidator.signerTrustSettings -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  CODE_SIGNING : String = "codeSigning"
[static] - The certificate is trusted for code signing.
-		SignerTrustSettings
  PLAYLIST_SIGNING : String = "playlistSigning"
[static] - The certificate is trusted for signing playlists.
-		SignerTrustSettings
  SIGNING : String = "signing"
[static] - The certificate is trusted for signing in general.
-		SignerTrustSettings
-
- -
- -
Constant detail
- - - - - -
CODE_SIGNINGconstant
-
-public static const CODE_SIGNING:String = "codeSigning" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The certificate is trusted for code signing. This implies that - the certificate chains to a trusted root, the root is trusted for - code signing, and the signing certificate has the CodeSigning - OID in its Extended Key Usage extension. - -

- - - - - -
PLAYLIST_SIGNINGconstant 
-
-public static const PLAYLIST_SIGNING:String = "playlistSigning" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The certificate is trusted for signing playlists. This implies that - the certificate chains to a trusted root and has the - playlist signing OID in its Extended Key Usage extension. -

- - - - - -
SIGNINGconstant 
-
-public static const SIGNING:String = "signing" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The certificate is trusted for signing in general. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/security/X500DistinguishedName.html b/html-docs/flash/security/X500DistinguishedName.html deleted file mode 100644 index d85912f..0000000 --- a/html-docs/flash/security/X500DistinguishedName.html +++ /dev/null @@ -1,453 +0,0 @@ - - - - - - - - -flash.security.X500DistinguishedName (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.security
Classpublic class X500DistinguishedName
InheritanceX500DistinguishedName Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The X500DistinguishedName class defines Distinguished Name (DN) properties for use in the - X509Certificate class. The Distinguished Name protocol is specified in - RFC1779. -

This class is useful for any code that needs to examine a server - certificate's Subject and Issuer DN after a secure socket connection has been established. - Subject and Issuer DN data is accessible in the X509Certificate class's subject - and issuer properties. These properties are populated with X500DistinguishedName - objects after SecureSocket.connect() establishes a connection with the server.

-

This class stores DN attributes as string properties. You can use the toString() - method to get all of the individual DN properties in one string. Properties with no DN value are set to null.

-

Note: The X500DistinguishedName properties store only the first occurrence of each DN attribute, - although the DN protocol allows for multiple attributes of the same type.

- -

-

-See also -

-
-SecureSocket class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  commonName : String -
[read-only] - Returns the DN CommonName attribute.
-		X500DistinguishedName
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  countryName : String -
[read-only] - Returns the DN CountryName attribute.
-		X500DistinguishedName
  localityName : String -
[read-only] - Returns the DN LocalityName attribute.
-		X500DistinguishedName
  organizationalUnitName : String -
[read-only] - Returns the DN OrganizationalUnitName attribute.
-		X500DistinguishedName
  organizationName : String -
[read-only] - Returns the DN OrganizationName attribute.
-		X500DistinguishedName
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  stateOrProvinceName : String -
[read-only] - Returns the DN StateOrProvinceName attribute.
-		X500DistinguishedName
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns all DN properties in one string.
-		X500DistinguishedName
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
commonNameproperty
-
-commonName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Returns the DN CommonName attribute. - -

Implementation -
-    public function get commonName():String -
-
- - - - - -
countryNameproperty 
-
-countryName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Returns the DN CountryName attribute. - -

Implementation -
-    public function get countryName():String -
-
- - - - - -
localityNameproperty 
-
-localityName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Returns the DN LocalityName attribute. - -

Implementation -
-    public function get localityName():String -
-
- - - - - -
organizationalUnitNameproperty 
-
-organizationalUnitName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Returns the DN OrganizationalUnitName attribute. - -

Implementation -
-    public function get organizationalUnitName():String -
-
- - - - - -
organizationNameproperty 
-
-organizationName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Returns the DN OrganizationName attribute. - -

Implementation -
-    public function get organizationName():String -
-
- - - - - -
stateOrProvinceNameproperty 
-
-stateOrProvinceName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Returns the DN StateOrProvinceName attribute. - -

Implementation -
-    public function get stateOrProvinceName():String -
-
- -
Method detail
- - - - - -
toString()method
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Returns all DN properties in one string. - -

-Returns - - - - -
String
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/security/X509Certificate.html b/html-docs/flash/security/X509Certificate.html deleted file mode 100644 index 6be325f..0000000 --- a/html-docs/flash/security/X509Certificate.html +++ /dev/null @@ -1,679 +0,0 @@ - - - - - - - - -flash.security.X509Certificate (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.security
Classpublic class X509Certificate
InheritanceX509Certificate Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

- The X509Certificate class represents an X.509 certificate. This class defines X.509 properties - specified in RFC2459. - After you make a successful call to SecureSocket.connect(), the server's certificate - data is stored as an X509Certificate instance in the SecureSocket.serverCertificate - property. -

- Use this class to examine a server certificate after establishing a secure socket connection. - The properties in this class provide access to the most used attributes of an X.509 certificate. - If you must access other parts of a server certificate (for example, its extensions), - the complete certificate is available in the encoded property. The certificate - stored in the encoded property is DER-encoded. -

- -

-

-See also -

-
-SecureSocket class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  encoded : ByteArray -
[read-only] - Provides the whole certificate in encoded form.
-		X509Certificate
  issuer : X500DistinguishedName -
[read-only] - Provides the issuer's Distinguished Name (DN).
-		X509Certificate
  issuerUniqueID : String -
[read-only] - Provides the issuer's unique identifier.
-		X509Certificate
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  serialNumber : String -
[read-only] - Provides the serial number of the certificate as a hexadecimal string.
-		X509Certificate
  signatureAlgorithmOID : String -
[read-only] - Provides the signature algorithm Object Identifier (OID).
-		X509Certificate
  signatureAlgorithmParams : ByteArray -
[read-only] - Provides the signature algorithm's parameters.
-		X509Certificate
  subject : X500DistinguishedName -
[read-only] - Provides the subject's Distinguished Name (DN).
-		X509Certificate
  subjectPublicKey : String -
[read-only] - Provides the subject's public key.
-		X509Certificate
  subjectPublicKeyAlgorithmOID : String -
[read-only] - Provides the algorithm OID for the subject's public key.
-		X509Certificate
  subjectUniqueID : String -
[read-only] - Provides the subject's unique identifier.
-		X509Certificate
  validNotAfter : Date -
[read-only] - Indicates the date on which the certificate's validity period ends.
-		X509Certificate
  validNotBefore : Date -
[read-only] - Indicates the date on which the certificate's validity period begins.
-		X509Certificate
  version : uint -
[read-only] - Provides the version number of the certificate format.
-		X509Certificate
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
encodedproperty
-
-encoded:ByteArray  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the whole certificate in encoded form. Client code can decode this value - to process certificate extensions. X.509 certificate extensions are not represented - in the other properties in this class. Decoding the encoded property - is the only way to access a certificate's extensions. - -

Implementation -
-    public function get encoded():ByteArray -
-
- - - - - -
issuerproperty 
-
-issuer:X500DistinguishedName  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the issuer's Distinguished Name (DN). - -

Implementation -
-    public function get issuer():X500DistinguishedName -
-

-See also -

-
-X500DistinguishedName class -
-
- - - - - -
issuerUniqueIDproperty 
-
-issuerUniqueID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the issuer's unique identifier. - -

Implementation -
-    public function get issuerUniqueID():String -
-
- - - - - -
serialNumberproperty 
-
-serialNumber:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the serial number of the certificate as a hexadecimal string. The issuer assigns this number, - and the number is unique within the issuer's list of issued certificates. - -

Implementation -
-    public function get serialNumber():String -
-
- - - - - -
signatureAlgorithmOIDproperty 
-
-signatureAlgorithmOID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the signature algorithm Object Identifier (OID). - -

Implementation -
-    public function get signatureAlgorithmOID():String -
-
- - - - - -
signatureAlgorithmParamsproperty 
-
-signatureAlgorithmParams:ByteArray  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the signature algorithm's parameters. If there are - no signature algorithm parameters, this value is set to null. -

Implementation -
-    public function get signatureAlgorithmParams():ByteArray -
-
- - - - - -
subjectproperty 
-
-subject:X500DistinguishedName  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the subject's Distinguished Name (DN). -

Implementation -
-    public function get subject():X500DistinguishedName -
-

-See also -

-
-X500DistinguishedName class -
-
- - - - - -
subjectPublicKeyproperty 
-
-subjectPublicKey:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the subject's public key. - -

Implementation -
-    public function get subjectPublicKey():String -
-
- - - - - -
subjectPublicKeyAlgorithmOIDproperty 
-
-subjectPublicKeyAlgorithmOID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the algorithm OID for the subject's public key. - -

Implementation -
-    public function get subjectPublicKeyAlgorithmOID():String -
-
- - - - - -
subjectUniqueIDproperty 
-
-subjectUniqueID:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the subject's unique identifier. - -

Implementation -
-    public function get subjectUniqueID():String -
-
- - - - - -
validNotAfterproperty 
-
-validNotAfter:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Indicates the date on which the certificate's validity period ends. - -

Implementation -
-    public function get validNotAfter():Date -
-
- - - - - -
validNotBeforeproperty 
-
-validNotBefore:Date  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Indicates the date on which the certificate's validity period begins. - -

Implementation -
-    public function get validNotBefore():Date -
-
- - - - - -
versionproperty 
-
-version:uint  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Provides the version number of the certificate format. This property indicates whether the - certificate has extensions, a unique identifier, or only the basic fields. -

    -
  • - version = 2: Indicates X.509 Version 3 - Extensions are present -
    • -
  • - version = 1: Indicates X.509 Version 2 - Extensions are not present, but a unique - identifier is present. -
    • -
  • - version = null: Indicates X.509 Version 1 - Only the basic certificate fields are present -
    • -
-

Implementation -
-    public function get version():uint -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/security/XMLSignatureValidator.html b/html-docs/flash/security/XMLSignatureValidator.html deleted file mode 100644 index 26e1368..0000000 --- a/html-docs/flash/security/XMLSignatureValidator.html +++ /dev/null @@ -1,1705 +0,0 @@ - - - - - - - - -flash.security.XMLSignatureValidator (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.security
Classpublic class XMLSignatureValidator
InheritanceXMLSignatureValidator Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

-

- The XMLSignatureValidator class validates whether an XML - signature file is well formed, unmodified, and, optionally, whether - it is signed using a key linked to a trusted digital certificate. - -

AIR profile support: This feature is supported - on all desktop operating systems and AIR for TV devices, but it is not supported on mobile devices. You can test - for support at run time using the XMLSignatureValidator.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

XMLSignatureValidator implements a subset of the - W3C Recommendation for XML-Signature Syntax and Processing and - should not be considered a conforming implementation. - The supported subset of the recommendation includes:

-
    -
  • All of the core signature syntax except KeyInfo element.
    • -
  • The KeyInfo element only supports the X509Data element.
    • -
  • The X509Data element only supports the X509Certificate element.
    • -
  • The SHA256 digest method algorithm.
    • -
  • The PKCS1 signing algorithm.
    • -
  • The "Canonical XML without comments" Canonicalization Method and Transform algorithm.
    • -
  • The Manifest element in additional signature syntax.
    • -
- -

You must provide an IURIDereferencer implementation in order to verify an XML signature. This - implementation class is responsible for resolving the URIs specified in the SignedInfo - elements of the signature file and returning the referenced data in an object, such - as a ByteArray, that implements the IDataInput interface.

- -

In order to verify that the signing certificate chains to a trusted certificate, either - the XML signature must contain the certificates required to build the chain in X509Certificate - elements, or you must supply the certificates required to build the chain using the - addCertificate() method.

- -

To verify an XMLSignature:

-
    -
  1. Create an instance of the XMLSignatureValidator class.
    2. -
  2. Set the uriDereferencer property of the instance to an instance of your - IURIDereferencer implementation class.
    3. -
  3. Supply DER-encoded certificates for building the certificate trust chain, if desired, - using the addCertificate() method.
    4. -
  4. Call the XMLSignatureValidator verify method, passing in the signature to - be verified.
    5. -
  5. Check the validityStatus property after the XMLSignatureValidator object - dispatches a complete event.
    6. -
- -

About signature status:

-

The validity of an XML signature can be valid, invalid, or unknown. The overall - status depends on the verification status of the individual components of the signature file:

-
    -
  • digestStatus — The validity of the cryptographic of the signature computed over - the SignedInfo element. Can be valid, invalid, or unknown.
    • -
  • identityStatus — The validity of the signing certificate. If the certificate has - expired, has been revoked, or altered, the status is invalid. If the certificate cannot be chained - to a trusted root certificate, the status is unknown. The certificate is not checked if the - digest is invalid. If not checked, the status will be reported as unknown.
    • -
  • referencesStatus — The validity of the data addressed by the references in the - SignedInfo element of the signature file. Can be valid, invalid, or - unknown. The references are not checked if the digest or certificate is invalid. - Reference checking can also be skipped based on the setting of the referencesValidationSetting property. - If not checked, the status will be reported as unknown.
    • -
-

The signature validity reported by the validityStatus property can be:

-
    -
  • valid — If referencesStatus, digestStatus, and - identityStatus are all valid.
    • -
  • invalid — If any individual status is invalid.
    • -
  • unknown — If referencesStatus, digestStatus, or - identityStatus is unknown.
    • -
- -

Canonicalization limitations:

-

The XML engine in AIR does not always produce the expected XML string when canonicalizing an XML document. - For this reason, it is recommended that you avoid putting inter-element whitespace in enveloped or detached signature - documents and do not redefine namespaces inside a signature document. In both cases, AIR may not recreate the document - with the same character sequence as the original and, therefore, validation will fail.

- -

-

-View the examples. -

-

-See also -

-
-IURIDereferencer -
-XML-Signature Syntax and Processing -
-Canonical XML -
-PKCS #1 -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  digestStatus : String -
[read-only] - The validity status of the cryptographic signature computed over the - signature SignedInfo element.
-		XMLSignatureValidator
  identityStatus : String -
[read-only] - The validity status of the signing certificate.
-		XMLSignatureValidator
  isSupported : Boolean -
[static][read-only] - The isSupported property is set to true if the - XMLSignatureValidator class is supported on the current platform, otherwise it is - set to false.
-		XMLSignatureValidator
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  referencesStatus : String -
[read-only] - The validity status of the data in the references in the signature SignedInfo - element.
-		XMLSignatureValidator
  referencesValidationSetting : String -
- Specifies the conditions under which references are checked.
-		XMLSignatureValidator
  revocationCheckSetting : String -
- Specifies how certificate revocation is checked.
-		XMLSignatureValidator
  signerCN : String -
[read-only] - The Common Name field of the signing certificate.
-		XMLSignatureValidator
  signerDN : String -
[read-only] - The Distinguished Name field of the signing certificate.
-		XMLSignatureValidator
  signerExtendedKeyUsages : Array -
[read-only] - An array containing the Extended Key Usages OIDs listed in the signing certificate.
-		XMLSignatureValidator
  signerTrustSettings : Array -
[read-only] - An array containing the trust settings of the signing certificate.
-		XMLSignatureValidator
  uriDereferencer : IURIDereferencer -
- The IURIDereferencer implementation.
-		XMLSignatureValidator
  useSystemTrustStore : Boolean -
- Specifies that certificates in the system trust store are used for chain building.
-		XMLSignatureValidator
  validityStatus : String -
[read-only] - The validity status of a verified XML signature.
-		XMLSignatureValidator
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-XMLSignatureValidator()
-
- Creates an XMLSignatureValidator object.
-		XMLSignatureValidator
   -
-addCertificate(cert:ByteArray, trusted:Boolean):* -
-
- Adds an x509 certificate for chain building.
-		XMLSignatureValidator
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
   -
-verify(signature:XML):void -
-
- Verifies the specified signature.
-		XMLSignatureValidator
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-complete -
-		 - Dispatched when verification is complete.XMLSignatureValidator
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-error -
-		 - Dispatched if verification cannot complete because of errors.XMLSignatureValidator
-
- -
- -
Property detail
- - - - - -
digestStatusproperty
-
-digestStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The validity status of the cryptographic signature computed over the - signature SignedInfo element. - -

The status is:

-
    -
  • valid — If signature is cryptographically valid.
    • -
  • invalid — If the digest has been altered after signing.
    • -
  • unknown — If the verify() method has not - been called.
    • -
- -

Note: If the digestStatus is invalid, the identityStatus - and referencesStatus are not checked and will be reported as unknown.

- - Implementation -
-    public function get digestStatus():String -
-
-Throws -
- - - - -
Error — If accessed while a signature is being validated. - -
-
- - - - - -
identityStatusproperty 
-
-identityStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The validity status of the signing certificate. - -

The status can be:

-
    -
  • valid — The certificate has not expired, has not failed a revocation check and chains - to a trusted root certificate.
    • -
  • unknown — The certificate has not expired and has not failed a revocation check, - but does not chain to a trusted root certificate. A status of unknown will also - be reported when the status has not been verified, either because the verify() method has not - been called or because the cryptographic signature of the SignedInfo element (digestStatus) - is invalid.
    • -
  • invalid — The certificate has expired or fails a revocation check.
    • -
-

The certificates added using the addCertificate() method - and the settings of the revocationCheckSetting and the useSystemTrustStore - properties can change whether a certificate is considered valid.

- -

Note: If the identityStatus is invalid, the referencesStatus is not checked - and will be reported as unknown. In addition, references are not checked when the identityStatus - is unknown unless the referencesValidationSetting is validOrUnknownIdentity

- - Implementation -
-    public function get identityStatus():String -
-
-Throws -
- - - - -
Error — If accessed while a signature is being validated. -
-

-See also -

-
-addCertificate() -
-revocationCheckSetting -
-useSystemTrustStore -
-referencesValidationSetting -
-
-Example -
The following example gets the result of validating the signing certificate - (after a signature has been validated): -
-
- import flash.security.XMLSignatureValidator;
- 
- 
- var verifier:XMLSignatureValidator = new XMLSignatureValidator();
- //validate a signature...
-  
- var identityResult:String = verifier.identityStatus;
-
-

-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The isSupported property is set to true if the - XMLSignatureValidator class is supported on the current platform, otherwise it is - set to false. -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
referencesStatusproperty 
-
-referencesStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The validity status of the data in the references in the signature SignedInfo - element. - -

The status can be:

-
    -
  • valid — If all references are valid.
    • -
  • invalid — If any reference is invalid.
    • -
  • unknown — If not verified. - References can remain unverified in the following circumstances: -
      -
    • the verify() method has not been called
      • -
    • the cryptographic signature of the SignedInfo element (digestStatus) is invalid.
      • -
    • the signing certificate (identityStatus) is invalid
      • -
    • referencesValidationSetting is validIdentity (which is the default setting) and - the identityStatus of the signing certificate is unknown.
      • -
    • the referencesValidationSetting is never.
      • -
    -
    • -
- -

Important: External resources are not validated unless they are referenced directly - in a SignedInfo element within the signature document. External resources referred to by a secondary - reference are not validated. For example, if an XML signature signs a manifest element, only - the integrity of the manifest element itself is verified. The files listed in the manifest are not - checked.

- - Implementation -
-    public function get referencesStatus():String -
-
-Throws -
- - - - -
Error — If accessed while a signature is being validated. -
-

-See also -

-
-referencesValidationSetting -
-
-Example -
The following example gets the result of validating the references in the signature - (after a signature has been validated): -
-
- import flash.security.XMLSignatureValidator;
- 
- var verifier:XMLSignatureValidator = new XMLSignatureValidator();
- //validate a signature...
-  
- var dataResult:String = verifier.referencesStatus;
-
-

-
- - - - - -
referencesValidationSettingproperty 
-
-referencesValidationSetting:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the conditions under which references are checked. - -

Use constants defined in the ReferencesValidationSetting class to set this property. The - settings include:

-
    -
  • ReferencesValidationSetting.VALID_IDENTITY — Check references only - if the signing certificate is valid and chains to a trusted root. This is the default setting.
    • -
  • ReferencesValidationSetting.VALID_OR_UNKNOWN_IDENTITY — Check references - if the signing certificate is valid, even if it does not chain to a trusted root.
    • -
  • ReferencesValidationSetting.NEVER — Never check references.
    • -
- -

- Use the default, validIdentity, setting with signatures signed with a commercial certificate or when you - supply your own certificate as a trust anchor with the addCertificate() method. This - setting avoids the overhead of checking reference validity when the signed document will be rejected anyway. -

-

- Use the validOrUnknownIdentity setting with signatures signed with self-signed certificates. This setting allows you to - validate that the signed data has not been altered, but does not provide any assurances about the identity - of the signer. -

-

- Use the never setting to avoid the overhead of validating references when such validation is not important in the - context of your application. -

- Implementation -
-    public function get referencesValidationSetting():String -
-    public function set referencesValidationSetting(value:String):void -
-
-Throws -
- - - - - - - - - - -
Error — If set while a signature is being validated. -
 
ArgumentError — if the setting parameter contains a value not defined in the ReferencesValidationSetting class. - -
-

-See also -

-
-ReferencesValidationSetting -
-
-Example -
The following example sets the XMLSignatureValidator object to check references only - if the signing certificate chains to a trust anchor: -
-
- import flash.security.ReferencesValidationSetting;
- 
- var verifier:XMLSignatureValidator = new XMLSignatureValidator(); 
- verifier.referencesValidationSetting = ReferencesValidationSetting.VALID_OR_UNKNOWN_IDENTITY;
-
-

-
- - - - - -
revocationCheckSettingproperty 
-
-revocationCheckSetting:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies how certificate revocation is checked. - -

Use constants defined in the RevocationSettings class to set this property. The - settings include:

-
    -
  • RevocationCheckSettings.NEVER — Do not check certificate revocation.
    • -
  • RevocationCheckSettings.BEST_EFFORT — Check certificate revocation, - if revocation information is available and the revocation status can be obtained. - If revocation status cannot be positively determined, the certificate is not rejected.
    • -
  • RevocationCheckSettings.REQUIRED_IF_AVAILABLE — If the certificate includes - revocation information, the revocation status must be positively determined to validate - the certificate.
    • -
  • RevocationCheckSettings.ALWAYS_REQUIRED — Always check certificate revocation. - Certificates without revocation information are rejected.
    • -
- - Implementation -
-    public function get revocationCheckSetting():String -
-    public function set revocationCheckSetting(value:String):void -
-
-Throws -
- - - - -
Error — If set while a signature is being validated. -
-

-See also -

-
-RevocationCheckSettings -
-
- - - - - -
signerCNproperty 
-
-signerCN:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Common Name field of the signing certificate. - -

Implementation -
-    public function get signerCN():String -
-
-Example -
The following example reads the common name of the signing certificate - (after a signature has been validated): -
-
- 
- var verifier:XMLSignatureValidator = new XMLSignatureValidator();
- //validate a signature...
-  
- var commonName:String = verifier.signerCN;
-
-

-
- - - - - -
signerDNproperty 
-
-signerDN:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The Distinguished Name field of the signing certificate. - -

Implementation -
-    public function get signerDN():String -
-
-Example -
The following example reads the distinguished name of the signing certificate - (after a signature has been validated): -
-
- 
- var verifier:XMLSignatureValidator = new XMLSignatureValidator();
- //validate a signature...
-  
- var distinguishedName:String = verifier.signerDN;
-
-

-
- - - - - -
signerExtendedKeyUsagesproperty 
-
-signerExtendedKeyUsages:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An array containing the Extended Key Usages OIDs listed in the signing certificate. - -

Each extended key usage is reported in numeric OID form.

- - Implementation -
-    public function get signerExtendedKeyUsages():Array -
-
-Throws -
- - - - -
Error — If accessed while a signature is being validated. - -
-
-Example -
The following example reads the extended key OIDs of the signing certificate - (after a signature has been validated): -
-
- import flash.security.XMLSignatureValidator;
- 
- var verifier:XMLSignatureValidator = new XMLSignatureValidator();
- //validate a signature...
-  
- var extendedKeyOIDs:Array = verifier.signerExtendedKeyUsages;
-
-

-
- - - - - -
signerTrustSettingsproperty 
-
-signerTrustSettings:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- An array containing the trust settings of the signing certificate. - -

Trust settings are derived from the system and the key usage OIDs embedded in - the certificate. Constants for the strings representing the recognized trust settings - are defined in the SignerTrustSettings class.

- -

The signerTrustSettings array of an unknown or - invalid certificate is empty.

- -

Modifying the array does not change the certificate trust settings.

- - Implementation -
-    public function get signerTrustSettings():Array -
-
-Throws -
- - - - -
Error — If accessed while a signature is being validated. - -
-

-See also -

-
-SignerTrustSettings -
-
-Example -
The following example reads the trust settings of the signing certificate - (after a signature has been validated): -
-
- import flash.security.XMLSignatureValidator;
- 
- var verifier:XMLSignatureValidator = new XMLSignatureValidator();
- //validate a signature...
-  
- var certificateTrustedFor:Array = verifier.signerTrustSettings;
-
-

-
- - - - - -
uriDereferencerproperty 
-
-uriDereferencer:IURIDereferencer  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The IURIDereferencer implementation. - -

An IURIDereferencer implementation must be provided before attempting to - verify a signature.

- - Implementation -
-    public function get uriDereferencer():IURIDereferencer -
-    public function set uriDereferencer(value:IURIDereferencer):void -
-
-Throws -
- - - - -
Error — If set while a signature is being validated. -
-

-See also -

-
-IURIDereferencer -
-
-Example -
The following example creates an instance of SignedMessageDereferencer, which implements - the IURIDereferencer interface, and sets it as the dereferencer to use for signature validation: -
-
- import com.example.SignedMessageDereferencer; //A custom class implementing IURIDereferencer
- 
- var verifier:XMLSignatureValidator = new XMLSignatureValidator(); 
- verifier.uriDereferencer = new SignedMessageDereferencer();
-
-

-
- - - - - -
useSystemTrustStoreproperty 
-
-useSystemTrustStore:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies that certificates in the system trust store are used for chain building. - -

If true, then the trust anchors in the system trust store - are used as trusted roots. The system trust store is not used by default.

- - Implementation -
-    public function get useSystemTrustStore():Boolean -
-    public function set useSystemTrustStore(value:Boolean):void -
-
-Throws -
- - - - -
Error — If set while a signature is being validated. - -
-
-Example -
The following example creates an XMLSignatureValidator instance and sets it to use the - system repository of trusted certificates when validating an XML signature: -
-
- var verifier:XMLSignatureValidator = new XMLSignatureValidator(); 
- verifier.useSystemTrustStore = true;
-
-

-
- - - - - -
validityStatusproperty 
-
-validityStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The validity status of a verified XML signature. - -

The XML signature is verified by validating the the cryptographic signature of the SignedInfo element, - the signing certificate, and the data addressed by the references in the SignedInfo element. - The validity of each of these elements is reported individually by the digestStatus, - identityStatus(), and referencesStatus properties, respectively.

-

The validity of an XML signature can be valid, invalid, or unknown. The overall - status depends on the verification status of the individual components of the signature file:

-
    -
  • digestStatus — The validity of the cryptographic signature computed over - the SignedInfo element.
    • -
  • identityStatus — The validity of the signing certificate.
    • -
  • referencesStatus — The validity of the digest of the references in the - signature SignedInfo element.
    • -
-

The signature validity reported by the validityStatus property can be:

-
    -
  • valid — If referencesStatus, digestStatus, and - identityStatus are all valid.
    • -
  • invalid — If any individual status is invalid.
    • -
  • unknown — If any individual status is unknown.
    • -
- - Implementation -
-    public function get validityStatus():String -
-
-Throws -
- - - - -
Error — If accessed while a signature is being validated. - -
-

-See also -

-
-digestStatus -
-identityStatus -
-referencesStatus -
-SignatureStatus -
-
-Example -
The following example gets the result of validating the XML signature -
-
- import flash.security.XMLSignatureValidator;
- 
- var verifier:XMLSignatureValidator = new XMLSignatureValidator();
- //validate the signature...
-  
- var validationResult:String = verifier.validityStatus;
-
-

-
- -
Constructor detail
- - - - - -
XMLSignatureValidator()constructor
-
-public function XMLSignatureValidator() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Creates an XMLSignatureValidator object. - -

You must set the uriDereferencer property before calling the verify() - method of the new object.

- -

-See also -

-
-uriDereferencer -
-
-Example -
The following example creates and sets up a new XMLSignatureValidator object: -
-
 
-import com.example.EnvelopedDereferencer; //Your custom IURIDereferencer implementation
-
-//Create the object
-var verifier:XMLSignatureValidator = new XMLSignatureValidator();
-
-//Provide the IURIDerferencer
-verifier.uriDereferencer = new EnvelopedDereferencer(xmlDoc);
-
-//Set validation options
-verifier.referencesValidationSetting = ReferencesValidationSetting.VALID_OR_UNKNOWN_IDENTITY;
-verifier.revocationCheckSetting = RevocationCheckSettings.NEVER;
-verifier.useSystemTrustStore = true;
-
-//Add listeners to handle results
-verifier.addEventListener(Event.COMPLETE, verificationComplete);
-verifier.addEventListener(ErrorEvent.ERROR, verificationError);
-
-

-
- -
Method detail
- - - - - -
addCertificate()method
-
-public function addCertificate(cert:ByteArray, trusted:Boolean):* -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Adds an x509 certificate for chain building. - -

The certificate added must be a DER-encoded x509 certificate.

- -

If the trusted parameter is true, the - certificate is considered a trust anchor.

-

Note: An XML signature may include certificates for building - the signer's certificate chain. The XMLSignatureValidator class uses - these certificates for chain building, but not as trusted roots (by default).

- - Parameters - - - - - - - - - - -
cert:ByteArray — A ByteArray object containing a DER-encoded x509 digital certificate. -
 
trusted:Boolean — Set to true to designate this certificate as a trust anchor. -
-

-Returns - - - - -
*
-
-Throws - - - - -
Error — If called while a signature is being validated. - -
-
-Example -
The following example loads a certificate from the file system - and adds it as a trusted anchor. -
-
- import flash.utils.ByteArray;
- 
- var verifier:XMLSignatureValidator = new XMLSignatureValidator();
- var certificate:ByteArray = new ByteArray();
- 
- var certFile:File = new File("certificate.cer");
- var certFileStream:FileStream = new FileStream();
- certFileStream.open(certFile, FileMode.READ);
- certFileStream.readBytes(certificate, 0, certFileStream.bytesAvailable);
-
- verifier.addCertificate(certificate, true);
-
-

-
- - - - - -
verify()method 
-
-public function verify(signature:XML):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Verifies the specified signature. - -

Verification is asynchronous. The XMLSignatureValidator object dispatches - a complete event when verification completes successfully or - an error event if verification cannot complete because of errors.

- -

The verification process cannot be cancelled. While a verification process is under way, - subsequent calls to the verify() method fail. After the current verification - check is complete, you can call the verify() method again.

- -

Note: Because the XMLSignatureValidator only implements a subset of the - W3C recommendation for XML Signature Syntax and Processing, not all valid - XML signatures can be verified.

- - - Parameters - - - - -
signature:XML — The XML signature to verify. -
-
-Events - - - - - - - - - - -
complete:Event — Dispatched when verification completes successfully.
 
error:ErrorEvent — Dispatched if the verification of references encounters an error.
-
-Throws - - - - - - - - - - -
Error — If called while a signature is being validated. -
 
Error — If other errors are encountered, such as non-well-formed XML or - unsupported elements in the signature file. -
-
-Example -
The following example reads a file containing an XML signature and validates it by - calling the verify() method. - (The example assumes that the IURIDereferencer implementation is appropriate for the signature.) -
-
-import flash.filesystem.File;
-import flash.filesystem.FileStream;
-import com.example.SignedMessageDereferencer; //Your IURIDereferencer implementation
- 
-const xmlSignatureNS:Namespace = new Namespace( "http://www.w3.org/2000/09/xmldsig#" );
-
-var verifier:XMLSignatureValidator = new XMLSignatureValidator();
-verifier.uriDereferencer = new SignedMessageDereferencer();
-
-var signatureFile:File = new File( "path/to/XMLSignatureDocument.xml" );
-var sigFileStream:FileStream = new FileStream();
-sigFileStream.open( signatureFile, FileMode.READ );
-
-var xmlDoc:XML = XML( sigFileStream.readUTFBytes(sigFileStream.bytesAvailable) );
-var xmlSig:XML = XML( xmlDoc..xmlSignatureNS::Signature );
-
-verifier.verify( xmlSig );
-
-

-
-
Event detail
- - - - - -
completeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched when verification is complete. - -

A complete event does not imply that the - signature is valid. Check the validityStatus property of - the XMLSignatureValidator object to - determine the outcome of the signature verification.

- -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
-Example -
The following example listens for the complete event dispatched by an XMLSignatureValidator - object and traces the validation results: -
-
-private function verificationComplete(event:Event):void{
-    var validator:XMLSignatureValidator = event.target as XMLSignatureValidator;
-	trace("Digest status: " + validator.digestStatus);
-	trace("Identity status: " + validator.identityStatus);
-	trace("Reference status: " + validator.referencesStatus);
-	trace("Signature status: " + validator.validityStatus);	
-}
-
-

-

-See also -

-
-validityStatus -
-
- - - - - -
errorevent  
-
-Event object type: flash.events.ErrorEvent -
-ErrorEvent.type property = flash.events.ErrorEvent.ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Dispatched if verification cannot complete because of errors. - -

- Defines the value of the type property of an error event object. -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object experiencing a network operation failure.
textText to be displayed as an error message.
- -
-Example -
The following example listens for the error event dispatched by an XMLSignatureValidator - object and traces the error message: -
-
-private function verificationError(event:ErrorEvent):void{
-    trace("Verification error: " + event.text);				
-}
-
-

-
- -
Examples
-
examples\XMLSignatureValidatorExample
-
The following example loads and verifies a file containing an XML signature. - - To use this example, you must implement an IURIDereferencer appropriate for the signatures - to be validated (replacing the SignedMessageDereferencer class used in the example). - Run the example by calling SignatureValidatorExample.validateSignature( signatureFile ), - passing in the file referencing the XML signature document to validate. - -
-
-import flash.events.Event;
-import flash.filesystem.File;
-import flash.filesystem.FileStream;
-import flash.security.ReferencesValidationSetting;
-import flash.security.XMLSignatureValidator; 
-
-import com.example.SignedMessageDereferencer; //A custom class implementing IURIDereferencer
-
-public class SignatureValidatorExample{ 
-    private var xmlSig:XML;
-	private const signatureNS:Namespace = new Namespace( "http://www.w3.org/2000/09/xmldsig#" );
-	
-	public static function validateSignature( signatureFile:File ):void{
-		try{
-			//Set up the XMLSignatureValidator
-			var verifier:XMLSignatureValidator = new XMLSignatureValidator();
-			verifier.addEventListener( Event.COMPLETE, verificationComplete );
-			verifier.uriDereferencer = new SignedMessageDereferencer();
-			verifier.referencesValidationSetting = ReferencesValidationSetting.VALID_OR_UNKNOWN_IDENTITY;
-	
-			//Load the signed document
-			var sigFileStream:FileStream = new FileStream();
-			sigFileStream.open( signatureFile, FileMode.READ );
-			var xmlDoc:XML = XML( sigFileStream.readUTFBytes(sigFileStream.bytesAvailable) );
-			
-			//Get the last Signature element in the document
-			if( xmlDoc.name().localName != "Signature" ){
-				var signatureList:XMLList = xmlDoc..signatureNS::Signature;
-				xmlSig = XML( signatureList[ signatureList.length()-1 ] );
-			} else{
-				xmlSig = xmlDoc;
-			}
-	
-			//Validate the signature
-			verifier.verify( xmlSig );
-			
-		}catch (e:Error){
-			statusDisplay.text = "Verification error.\n" + e;
-		}
-	}
-	
-	private static function verificationComplete(event:Event):void{
-		trace( "Signature Validity: " + verifier.validityStatus );
-		trace( "Digest validity: " + verifier.digestStatus );
-		trace( "Certificate validity: " + verifier.identityStatus );
-		trace( "Data validity: " + verifier.referencesStatus );
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/security/package-detail.html b/html-docs/flash/security/package-detail.html deleted file mode 100644 index 54f1950..0000000 --- a/html-docs/flash/security/package-detail.html +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - -flash.security Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

This package includes classes for validating XML signatures. This package is only available to content running in the AIR runtime.

-
-
- -
Interfaces
- - - - - - - -
 InterfaceDescription
 IURIDereferencer - IURIDereferencer defines an interface for objects that resolve - URIs in an XML signature.
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 CertificateStatus - The CertificateStatus class defines constants used to report the - results of certificate validation processing by a SecureSocket object.
 ReferencesValidationSetting - The ReferencesValidationSetting class defines constants used by the referencesValidationSetting - property of an XMLSignatureValidator object.
 RevocationCheckSettings - The RevocationCheckSettings class defines constants used by the - revocationCheckSetting property of an XMLSignatureValidator object.
 SignatureStatus - The SignatureStatus class defines constants used by the validityStatus - property of an XMLSignatureValidator object.
 SignerTrustSettings - The SignerTrustSettings class defines constants used with the - signerTrustSettings property of an XMLSignatureValidator object.
 X500DistinguishedName - The X500DistinguishedName class defines Distinguished Name (DN) properties for use in the - X509Certificate class.
 X509Certificate - The X509Certificate class represents an X.509 certificate.
 XMLSignatureValidator - The XMLSignatureValidator class validates whether an XML - signature file is well formed, unmodified, and, optionally, whether - it is signed using a key linked to a trusted digital certificate.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/sensors/Accelerometer.html b/html-docs/flash/sensors/Accelerometer.html deleted file mode 100644 index e5fd2f7..0000000 --- a/html-docs/flash/sensors/Accelerometer.html +++ /dev/null @@ -1,723 +0,0 @@ - - - - - - - - -flash.sensors.Accelerometer (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.sensors
Classpublic class Accelerometer
InheritanceAccelerometer Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The Accelerometer class dispatches events based on activity detected by the device's motion sensor. - This data represents the device's location or - movement along a 3-dimensional axis. When the device moves, the sensor detects this movement and - returns acceleration data. The Accelerometer class provides methods to query whether or not - accelerometer is supported, and also to set the rate at which acceleration events are dispatched. -

Note: Use the Accelerometer.isSupported property to test the runtime environment for the ability - to use this feature. While the Accelerometer class and its members are accessible to the Runtime Versions listed for - each API entry, the current environment for the runtime determines the availability of this feature. For example, you can - compile code using the Accelerometer class properties for Flash Player 10.1, but you need to use the Accelerometer.isSupported - property to test for the availability of the Accelerometer feature in the current deployment environment for the Flash Player runtime. If - Accelerometer.isSupported is true at runtime, then Accelerometer support currently exists.

-

AIR profile support: This feature is supported - only on mobile devices. It is not supported on desktop or AIR for TV devices. See - - AIR Profile Support for more information regarding API support across multiple profiles. -

-

-

-View the examples. -

-

-See also -

-
-isSupported -
-flash.events.AccelerometerEvent -
-Michael Chaize: AIR and the Accelerometer -
-Michael Chaize: Become an AIR Pilot -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - The isSupported property is set to true if the accelerometer sensor is - available on the device, otherwise it is set to false.
-		Accelerometer
  muted : Boolean -
[read-only] - Specifies whether the user has denied access to the accelerometer (true) - or allowed access (false).
-		Accelerometer
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Accelerometer()
-
- Creates a new Accelerometer instance.
-		Accelerometer
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setRequestedUpdateInterval(interval:Number):void -
-
- The setRequestedUpdateInterval method is used to set the desired time interval - for updates.
-		Accelerometer
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-status -
-		 - Dispatched when an accelerometer changes its status.Accelerometer
   -
-update -
-		 - The update event is dispatched in response to updates from the accelerometer sensor.Accelerometer
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The isSupported property is set to true if the accelerometer sensor is - available on the device, otherwise it is set to false. -

Implementation -
-    public static function get isSupported():Boolean -
-
-Example -
The following example uses the Accelerometer.isSupported property to test for Accelerometer support at runtime. - If the current environment supports the Accelerometer feature, then an event listener is added to the Accelerometer object, and the associated handler - populates the text field with the timestamp and acceleration values. Otherwise, the text field indicates that the feature is not supported in the current - environment. -
-
-var myTextField:TextField = new TextField();
-myTextField.width = 200;
-addChild(myTextField);
-var acc1:Accelerometer = new Accelerometer();
-var isSupported:Boolean = Accelerometer.isSupported;
-checksupport();
-
-function checksupport():void {
-    if (isSupported) {
-		myTextField.text = "Accelerometer feature supported";
-		acc1.addEventListener(AccelerometerEvent.UPDATE, updateHandler);
-	} else {
-		myTextField.text = "Accelerometer feature not supported";
-	}
-}
-
-function updateHandler(evt:AccelerometerEvent):void {
-	myTextField.text = String("at: " + evt.timestamp + "\n" + "acceleration X: " + evt.accelerationX + "\n" + "acceleration Y: " + evt.accelerationY + "\n" + "acceleration Z: " + evt.accelerationZ);
-
-}
-
-

-
- - - - - -
mutedproperty 
-
-muted:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

- Specifies whether the user has denied access to the accelerometer (true) - or allowed access (false). When this value changes, - a status event is dispatched. -

Implementation -
-    public function get muted():Boolean -
-

-See also -

-
-status -
-
- -
Constructor detail
- - - - - -
Accelerometer()constructor
-
-public function Accelerometer() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates a new Accelerometer instance. -

- -
Method detail
- - - - - -
setRequestedUpdateInterval()method
-
-public function setRequestedUpdateInterval(interval:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The setRequestedUpdateInterval method is used to set the desired time interval - for updates. The time interval is measured in milliseconds. The update interval is only used as a - hint to conserve the battery power. The actual time between acceleration updates may be greater - or lesser than this value. Any change in the update interval affects all registered listeners. - You can use the Accelerometer class without calling the setRequestedUpdateInterval() - method. In this case, the application receives updates based on the device's default interval. -

Parameters - - - - -
interval:Number — The requested update interval. If interval is set to 0, then the minimum supported update interval is used. -
-
-Throws - - - - -
ArgumentError — The specified interval is less than zero. - -
-
-
Event detail
- - - - - -
statusevent 
-
-Event object type: flash.events.StatusEvent -
-StatusEvent.type property = flash.events.StatusEvent.STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when an accelerometer changes its status. - -

Note: On some devices, the accelerometer is always available. - On such devices, an Accelerometer object never dispatches a status - event.

-

- Defines the value of the type property of a status event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
codeA description of the object's status.
currentTargetThe object that is actively processing the Event - object with an event listener.
levelThe category of the message, such as "status", "warning" or "error".
targetThe object reporting its status.
- -
- - - - - -
updateevent  
-
-Event object type: flash.events.AccelerometerEvent -
-AccelerometerEvent.type property = flash.events.AccelerometerEvent.UPDATE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The update event is dispatched in response to updates from the accelerometer sensor. - The event is dispatched in the following circumstances: -

  • When a new listener function is attached through addEventListener(), this event is - delivered once to all the registered listeners for providing the current value of the accelerometer.
    • -
  • Whenever accelerometer updates are obtained from the platform at device determined intervals.
    • -
  • Whenever the application misses a change in the accelerometer (for example, the runtime - is resuming after being idle).

-

- Defines the value of the type property of a AccelerometerEvent event object. -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
timestampThe timestamp of the Accelerometer update.
accelerationXThe acceleration value in Gs (9.8m/sec/sec) along the x-axis.
accelerationYThe acceleration value in Gs (9.8m/sec/sec) along the y-axis.
accelerationZThe acceleration value in Gs (9.8m/sec/sec) along the z-axis.
-
- -
Examples
-
examples\AccelerometerExample
-
In the following example, the application moves a Sprite - based on accelerometer update events. The accelerometer - update events indicate movement of the device. -
-
-package 
-{
-    import flash.display.Sprite;
-	import flash.display.StageAlign;
-	import flash.display.StageScaleMode;
-	import flash.events.Event;
-	import flash.events.AccelerometerEvent;
-	import flash.sensors.Accelerometer;
-
-	public class AccelerometerTest extends Sprite
-	{
-		private var ball:Sprite;
-		private var accelerometer:Accelerometer;		
-		private var xSpeed:Number = 0;
-		private var ySpeed:Number = 0;
-		private const RADIUS = 20;
-		
-		public final function AccelerometerTest()
-		{
-			stage.scaleMode = StageScaleMode.NO_SCALE;
-			stage.align = StageAlign.TOP_LEFT;
-			
-			createBall();
-									
-			if (Accelerometer.isSupported)
-			{
-				accelerometer = new Accelerometer();
-				accelerometer.addEventListener(AccelerometerEvent.UPDATE, accUpdateHandler);
-				stage.addEventListener(Event.ENTER_FRAME, enterFrameHandler);
-			}
-		}
-		
-		private final function createBall():void
-		{
-			 ball = new Sprite();
-			 ball.graphics.beginFill(0xFF0000);
-			 ball.graphics.drawCircle(0, 0, RADIUS);
-			 ball.cacheAsBitmap = true;
-			 ball.x = stage.stageWidth / 2;
-			 ball.y = stage.stageHeight / 2;
-			 addChild(ball);
-		}
-
-		private final function enterFrameHandler(event:Event):void
-		{
-			event.stopPropagation();
-			moveBall();
-		}
-		private final function moveBall():void
-		{
-			var newX:Number = ball.x + xSpeed;
-			var newY:Number = ball.y + ySpeed;
-			if (newX < 20)
-			{
-				ball.x = RADIUS;
-				xSpeed = 0;
-			}
-			else if (newX > stage.stageWidth - RADIUS)
-			{
-				ball.x = stage.stageWidth - RADIUS;
-				xSpeed = 0;
-			}
-			else
-			{
-				ball.x += xSpeed;
-			}
-			
-			if (newY < RADIUS)
-			{
-				ball.y = RADIUS;
-				ySpeed = 0;
-			}
-			else if (newY > stage.stageHeight - RADIUS)
-			{
-				ball.y = stage.stageHeight - RADIUS;
-				ySpeed = 0;
-			}
-			else
-			{
-				ball.y += ySpeed;
-			}
-		}
-
-		private final function accUpdateHandler(event:AccelerometerEvent):void
-		{
-			xSpeed -= event.accelerationX * 2;
-			ySpeed += event.accelerationY * 2;
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/sensors/DeviceRotation.html b/html-docs/flash/sensors/DeviceRotation.html deleted file mode 100644 index 89bd59e..0000000 --- a/html-docs/flash/sensors/DeviceRotation.html +++ /dev/null @@ -1,616 +0,0 @@ - - - - - - - - -flash.sensors.DeviceRotation (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.sensors
Classpublic class DeviceRotation
InheritanceDeviceRotation Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 26.0 -
-

-

- The DeviceRotation class dispatches events based on activity detected by the device's acceletometer, - gyroscope sensors. - This data represents the device's roll, pitch, yaw and quaternions. When the device rotates, the sensors detect this rotation and - return this data. The DeviceRotation class provides methods to query whether or not - Device rotation event handling is supported, and also to set the rate at which device rotation events are dispatched. -

Note: Use the DeviceRotation.isSupported property to test the runtime environment for the ability - to use this feature. While the Device rotation class and its members are accessible for multiple runtime platforms and devices, - this does not imply that the handler is always supported at the runtime. There are a few cases such as Android version etc where this handler is - not supported, so you must check the support of this handler by using DeviceRotation.isSupported property. If - DeviceRotation.isSupported is true at runtime, then DeviceRotation support currently exists.

-

AIR profile support: This feature is supported - only on mobile devices. It is not supported on desktop or AIR for TV devices. See - - AIR Profile Support for more information regarding API support across multiple profiles. -

-

-

-See also -

-
-isSupported -
-flash.events.DeviceRotationEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - The isSupported property is set to true if the accelerometer and gyroscope sensors - are available on the device, otherwise it is set to false.
-		DeviceRotation
  muted : Boolean -
[read-only] - Specifies whether the user has denied access to the Device Rotation data (true) - or allowed access (false).
-		DeviceRotation
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-DeviceRotation()
-
- Creates a new DeviceRotation instance.
-		DeviceRotation
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setRequestedUpdateInterval(interval:Number):void -
-
- The setRequestedUpdateInterval method is used to set the desired time interval - for updates.
-		DeviceRotation
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-status -
-		 - Dispatched when device rotation changes its status.DeviceRotation
   -
-update -
-		 - The update event is dispatched when the device is rotated in response to updates from the combined readings - from accelerometer and gyroscope sensors.DeviceRotation
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- The isSupported property is set to true if the accelerometer and gyroscope sensors - are available on the device, otherwise it is set to false. -

Implementation -
-    public static function get isSupported():Boolean -
-
-Example -
In the following example, the DeviceRotation.isSupported property - is used to test for DeviceRotation support at runtime. If the current environment - supports the DeviceRotation feature, then an event listener is added to the - DeviceRotation object, and the associated handler populates the text field - with the timestamp and roll,yaw and pitch values. Otherwise, the text field - indicates that the feature is not supported in the current environment. -
-
-var myTextField:TextField = new TextField();
-myTextField.width = 200;
-addChild(myTextField);
-var deviceRotation = new DeviceRotation();
-var isSupported:Boolean = DeviceRotation.isSupported;
-checksupport();
-
-function checksupport():void {
-    if (isSupported) {
-        myTextField.text = "DeviceRotation feature supported";
-        deviceRotation.addEventListener(DeviceRotationEvent.UPDATE,deviceRotUpdateHandler);
-    } else {
-        myTextField.text = "DeviceRotation feature not supported";
-    }
-}
-
-function deviceRotUpdateHandler(evt:DeviceRotationEvent):void {
-    myTextField.text = String("at: " + evt.timestamp + "\n" + "Roll: " + evt.roll + "\n" + "Yaw: " + evt.yaw + "\n" + "Pitch: " + evt.pitch);
-
-}
-
-

-
- - - - - -
mutedproperty 
-
-muted:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 26.0
-

- Specifies whether the user has denied access to the Device Rotation data (true) - or allowed access (false). When this value changes, - a status event is dispatched. -

Implementation -
-    public function get muted():Boolean -
-

-See also -

-
-status -
-
- -
Constructor detail
- - - - - -
DeviceRotation()constructor
-
-public function DeviceRotation() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- Creates a new DeviceRotation instance. -

- -
Method detail
- - - - - -
setRequestedUpdateInterval()method
-
-public function setRequestedUpdateInterval(interval:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 26.0 -
-

- The setRequestedUpdateInterval method is used to set the desired time interval - for updates. The time interval is measured in milliseconds. The update interval is only used as a - hint to conserve the battery power. The actual time between device rotation vector updates may be greater - or lesser than this value. Any change in the update interval affects all registered listeners. - You can use the DeviceRotation class without calling the setRequestedUpdateInterval() - method. In this case, the application receives updates based on the device's default interval. -

Parameters - - - - -
interval:Number — The requested update interval. If interval is set to 0, then the minimum supported update interval is used. -
-
-Throws - - - - -
ArgumentError — The specified interval is less than zero. - -
-
-
Event detail
- - - - - -
statusevent 
-
-Event object type: flash.events.StatusEvent -
-StatusEvent.type property = flash.events.StatusEvent.STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 26.0 -
-

- Dispatched when device rotation changes its status. - -

- Defines the value of the type property of a status event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
codeA description of the object's status.
currentTargetThe object that is actively processing the Event - object with an event listener.
levelThe category of the message, such as "status", "warning" or "error".
targetThe object reporting its status.
- -
- - - - - -
updateevent  
-
-Event object type: flash.events.DeviceRotationEvent -
-DeviceRotationEvent.type property = flash.events.DeviceRotationEvent.UPDATE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 26.0 -
-

- The update event is dispatched when the device is rotated in response to updates from the combined readings - from accelerometer and gyroscope sensors. - The event is dispatched in the following circumstances: -

  • When a new listener function is attached through addEventListener(), this event is - delivered once to all the registered listeners for providing the current value of the device rotation vector in terms of roll pitch and quaternions.
    • -
  • Whenever device rotation updates are obtained from the platform at device determined intervals.
    • -
  • Whenever the application misses a change in the device rotation (for example, the runtime - is resuming after being idle).

-

- Defines the value of the type property of a DeviceRotationEvent event object. -

This event has the following properties:

- - - - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
timestampThe timestamp of the DeviceRotation update.
rollThe roll value in degrees.
pitchThe pitch value in degrees.
yawThe yaw value in degrees.
quaternion The quaternion data in [w, x, y, z] format
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/sensors/Geolocation.html b/html-docs/flash/sensors/Geolocation.html deleted file mode 100644 index 990bb3b..0000000 --- a/html-docs/flash/sensors/Geolocation.html +++ /dev/null @@ -1,1083 +0,0 @@ - - - - - - - - -flash.sensors.Geolocation (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.sensors
Classpublic class Geolocation
InheritanceGeolocation Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The Geolocation class dispatches events in response to the device's location sensor. -

If a device supports geolocation, you can use this class to obtain the current geographical - location of the device. The geographical location is displayed on the device in the form of latitudinal - and longitudinal coordinates (in WGS-84 standard format). When the location of the device changes, - you can receive updates about the changes. If the device supports this feature, you will be able to obtain - information about the altitude, accuracy, heading, speed, and timestamp of the latest change in the location.

-

AIR profile support: This feature is supported - only on mobile devices. It is not supported on desktop or AIR for TV devices. You can test - for support at run time using the Geolocation.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles. -

-

Note: To enable Geolocation in iOS, ensure that you add a key-value pair to the - infoAdditions element in the application xml file.See - - iOS Settings for more information on the infoAdditions element. -

-

-

-View the examples. -

-

-See also -

-
-Cristophe Coenraets: Mulit-user Google Maps Collaboration -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  desiredAccuracy : String -
- This property determines the accuracy of the geolocation data on iOS.
-		Geolocation
  isSupported : Boolean -
[static][read-only] - Whether a location sensor is available on the device (true); otherwise false.
-		Geolocation
  locationAlwaysUsePermission : Boolean -
- This property determines the access permission type usage of geolocation.
-		Geolocation
  muted : Boolean -
[read-only] - Specifies whether the user has denied access to the geolocation (true) - or allowed access (false).
-		Geolocation
  pausesLocationUpdatesAutomatically : Boolean -
- This property determines whether the geolocation services should pause due to app inactivity - when application goes into background (on iOS).
-		Geolocation
  permissionStatus : String -
[static][read-only] - Determine whether the application has been granted the permission to use geolocation services.
-		Geolocation
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Geolocation()
-
- Creates a new Geolocation instance.
-		Geolocation
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-requestPermission():void -
-
- Requests geolocation permission for the application.
-		Geolocation
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setRequestedUpdateInterval(interval:Number):void -
-
- Used to set the time interval for updates, in milliseconds.
-		Geolocation
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-status -
-		 - The Geolocation object dispatches status events when the user changes access - to the location sensor.Geolocation
   -
-update -
-		 - The update event is dispatched in response to updates from the location sensor.Geolocation
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  LOCATION_ACCURACY_BEST : String = "locationAccuracyBest"
[static] -

The best level of accuracy available.

- -
-		Geolocation
  LOCATION_ACCURACY_BEST_FOR_NAVIGATION : String = "locationAccuracyBestForNavigation"
[static] -

The highest possible accuracy that uses additional sensor data to facilitate navigation apps.

- -
-		Geolocation
  LOCATION_ACCURACY_HUNDRED_METERS : String = "locationAccuracyHundredMeters"
[static] -

Accurate to within one hundred meters.

- -
-		Geolocation
  LOCATION_ACCURACY_KILOMETER : String = "locationAccuracyKilometer"
[static] -

Accurate to the nearest kilometer.

- -
-		Geolocation
  LOCATION_ACCURACY_NEAREST_TEN_METERS : String = "locationAccuracyNearestTenMeters"
[static] -

Accurate to within ten meters of the desired target.

- -
-		Geolocation
  LOCATION_ACCURACY_THREE_KILOMETERS : String = "locationAccuracyThreeKilometers"
[static] -

Accurate to the nearest three kilometers.

- -
-		Geolocation
-
- -
- -
Property detail
- - - - - -
desiredAccuracyproperty
-
-desiredAccuracy:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 32 -
-

- This property determines the accuracy of the geolocation data on iOS. - Setting pausesLocationUpdatesAutomatically to false - can cause battery drain as it keeps fetching geolocation data. - Accuracy can be set to LOCATION_ACCURACY_BEST_FOR_NAVIGATION, LOCATION_ACCURACY_BEST, - LOCATION_ACCURACY_NEAREST_TEN_METERS, LOCATION_ACCURACY_HUNDRED_METERS, LOCATION_ACCURACY_KILOMETER - or LOCATION_ACCURACY_THREE_KILOMETERS based on the app's usage scenario. - Set the property after calling requestPermission() and enabling location services in background. - The default value of the property is LOCATION_ACCURACY_BEST which is the best level of accuracy available. - -

Implementation -
-    public function get desiredAccuracy():String -
-    public function set desiredAccuracy(value:String):void -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Whether a location sensor is available on the device (true); otherwise false. -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
locationAlwaysUsePermissionproperty 
-
-locationAlwaysUsePermission:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 29 -
-

- This property determines the access permission type usage of geolocation. - The permission type can be Always or When In Use. If the property is set to false, - it requests When In Use permission else it requests Always use permission. - Set the property before calling requestPermission(). - The default value of the property is false. - -

Implementation -
-    public function get locationAlwaysUsePermission():Boolean -
-    public function set locationAlwaysUsePermission(value:Boolean):void -
-
- - - - - -
mutedproperty 
-
-muted:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

- Specifies whether the user has denied access to the geolocation (true) - or allowed access (false). When this value changes, - a status event is dispatched. -

Implementation -
-    public function get muted():Boolean -
-

-See also -

-
-status -
-
- - - - - -
pausesLocationUpdatesAutomaticallyproperty 
-
-pausesLocationUpdatesAutomatically:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 32 -
-

- This property determines whether the geolocation services should pause due to app inactivity - when application goes into background (on iOS). - The value can be true or false. If the property is set to false, - it ensures continous updates of geolocation services. - Set the property after calling requestPermission() and enabling location services in background. - The default value of the property is true. - -

Implementation -
-    public function get pausesLocationUpdatesAutomatically():Boolean -
-    public function set pausesLocationUpdatesAutomatically(value:Boolean):void -
-
- - - - - -
permissionStatusproperty 
-
-permissionStatus:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Determine whether the application has been granted the permission to use geolocation services. -

Implementation -
-    public static function get permissionStatus():String -
-

-See also -

-
-flash.permissions.PermissionStatus -
-
- -
Constructor detail
- - - - - -
Geolocation()constructor
-
-public function Geolocation() -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates a new Geolocation instance. -

- -
Method detail
- - - - - -
requestPermission()method
-
-public function requestPermission():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 24.0 -
-

- Requests geolocation permission for the application. -


-Events - - - - -
PermissionStatus:PermissionEvent — dispatched when the requested permission is granted/denied by the user.
-
- - - - - -
setRequestedUpdateInterval()method 
-
-public function setRequestedUpdateInterval(interval:Number):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Used to set the time interval for updates, in milliseconds. The update interval is only used as a - hint to conserve the battery power. The actual time between location updates may be greater or - lesser than this value.Any change in the update interval using this method - affects all registered update event listeners. The Geolocation class - can be used without calling the setRequestedUpdateInterval method. - In this case, the platform will return updates based on its default interval. -

Note: First-generation iPhones, which do not include a GPS unit, dispatch - update events only occasionally. On these devices, a Geolocation object initially - dispatches one or two update events. It then dispatches update events - when information changes noticeably.

- Parameters - - - - -
interval:Number — requested update interval. If interval <= 0, then any call to this method - has no effect. -
-
-Throws - - - - -
ArgumentError — The specified interval is less than zero. - -
-
-
Event detail
- - - - - -
statusevent  
-
-Event object type: flash.events.StatusEvent -
-StatusEvent.type property = flash.events.StatusEvent.STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The Geolocation object dispatches status events when the user changes access - to the location sensor. For example, if, in response to a device prompt, the user prevents the - application from accessing location data, the Geolcation object dispatches a status - event. When the status changes to a state where the location sensor is not available, the - muted property of the Geolocation instance is true. -

- Defines the value of the type property of a status event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
codeA description of the object's status.
currentTargetThe object that is actively processing the Event - object with an event listener.
levelThe category of the message, such as "status", "warning" or "error".
targetThe object reporting its status.
- -

-See also -

-
-muted -
-
- - - - - -
updateevent  
-
-Event object type: flash.events.GeolocationEvent -
-GeolocationEvent.type property = flash.events.GeolocationEvent.UPDATE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The update event is dispatched in response to updates from the location sensor. The event - is dispatched under the following circumstances: -

  • When a new listener function is attached through addEventListener(), this event is - delivered once to all the registered listeners to provide the current value of the location. Note: - AIR dispatches the first event immediately if the device has a last known location; your code must - be aware that the initially dispatched event may not contain the current location.
    • -
  • Whenever location updates are obtained from the platform at device determined intervals.
    • -
  • Whenever the application misses a change in the location (for example, the application is waking up - after being asleep).

-

Note: First-generation iPhones, which do not include a GPS unit, dispatch - update events only occasionally. On these devices, a Geolocation object initially - dispatches one or two update events. It then dispatches update events - when information changes noticeably.

-

- Defines the value of the type property of a GeolocationEvent event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event - object with an event listener.
targetThe Geolocation object receiving data.
- -
- -
Constant detail
- - - - - -
LOCATION_ACCURACY_BESTconstant
-
-public static const LOCATION_ACCURACY_BEST:String = "locationAccuracyBest" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 32 -
-

-

The best level of accuracy available.

- -
- - - - - -
LOCATION_ACCURACY_BEST_FOR_NAVIGATIONconstant 
-
-public static const LOCATION_ACCURACY_BEST_FOR_NAVIGATION:String = "locationAccuracyBestForNavigation" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 32 -
-

-

The highest possible accuracy that uses additional sensor data to facilitate navigation apps.

- -
- - - - - -
LOCATION_ACCURACY_HUNDRED_METERSconstant 
-
-public static const LOCATION_ACCURACY_HUNDRED_METERS:String = "locationAccuracyHundredMeters" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 32 -
-

-

Accurate to within one hundred meters.

- -
- - - - - -
LOCATION_ACCURACY_KILOMETERconstant 
-
-public static const LOCATION_ACCURACY_KILOMETER:String = "locationAccuracyKilometer" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 32 -
-

-

Accurate to the nearest kilometer.

- -
- - - - - -
LOCATION_ACCURACY_NEAREST_TEN_METERSconstant 
-
-public static const LOCATION_ACCURACY_NEAREST_TEN_METERS:String = "locationAccuracyNearestTenMeters" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 32 -
-

-

Accurate to within ten meters of the desired target.

- -
- - - - - -
LOCATION_ACCURACY_THREE_KILOMETERSconstant 
-
-public static const LOCATION_ACCURACY_THREE_KILOMETERS:String = "locationAccuracyThreeKilometers" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 32 -
-

-

Accurate to the nearest three kilometers.

- -
- -
Examples
-
examples\GeolocationExample
-
In the following example, the application displays the latitude, - longitude, and horizontal accuracy of geolocation update events - as they are received. -
-
-package
-{
-    import flash.display.Sprite;
-	import flash.display.StageAlign;
-	import flash.display.StageScaleMode;
-	import flash.events.GeolocationEvent;
-	import flash.events.MouseEvent;
-	import flash.events.StatusEvent;
-	import flash.sensors.Geolocation;
-	import flash.text.TextField;
-	import flash.text.TextFormat;
-	
-	public class GeolocationTest extends Sprite
-	{
-		
-		private var geo:Geolocation; 
-		private var log:TextField;
-		
-		public function GeolocationTest()
-		{			
-			super();
-			stage.align = StageAlign.TOP_LEFT;
-			stage.scaleMode = StageScaleMode.NO_SCALE;
-			setUpTextField();
-			
-			if (Geolocation.isSupported) 
-			{ 
-				geo = new Geolocation(); 
-				if (!geo.muted) 
-				{ 
-					geo.addEventListener(GeolocationEvent.UPDATE, geoUpdateHandler); 
-				} 
-				geo.addEventListener(StatusEvent.STATUS, geoStatusHandler);
-			} 
-			else 
-			{ 
-				log.text = "Geolocation not supported"; 
-			} 
-		}
-		
-		public function geoUpdateHandler(event:GeolocationEvent):void 
-		{ 
-			log.text = "latitude : " + event.latitude.toString() + "\n"; 
-			log.appendText("longitude : " + event.longitude.toString() + "\n");
-		} 
-		
-		public function geoStatusHandler(event:StatusEvent):void 
-		{ 
-			if (geo.muted)
-				geo.removeEventListener(GeolocationEvent.UPDATE, geoUpdateHandler);
-			else
-				geo.addEventListener(GeolocationEvent.UPDATE, geoUpdateHandler);
-		}
-		
-		private function setUpTextField():void
-		{
-			log = new TextField();
-			var format:TextFormat = new TextFormat("_sans", 24);
-			log.defaultTextFormat = format;
-			log.border = true;
-			log.wordWrap = true;
-			log.multiline = true;
-			log.x = 10;
-			log.y = 10;
-			log.height = stage.stageHeight - 20;
-			log.width = stage.stageWidth - 20;
-			log.addEventListener(MouseEvent.CLICK, clearLog);
-			addChild(log);
-		}
-		private function clearLog(event:MouseEvent):void
-		{
-			log.text = "";
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/sensors/package-detail.html b/html-docs/flash/sensors/package-detail.html deleted file mode 100644 index 02b66d0..0000000 --- a/html-docs/flash/sensors/package-detail.html +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - -flash.sensors Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Classes
- - - - - - - - - - - - - -
 ClassDescription
 Accelerometer - The Accelerometer class dispatches events based on activity detected by the device's motion sensor.
 DeviceRotation - The DeviceRotation class dispatches events based on activity detected by the device's acceletometer, - gyroscope sensors.
 Geolocation - The Geolocation class dispatches events in response to the device's location sensor.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/system/ApplicationDomain.html b/html-docs/flash/system/ApplicationDomain.html deleted file mode 100644 index 5bfdc35..0000000 --- a/html-docs/flash/system/ApplicationDomain.html +++ /dev/null @@ -1,880 +0,0 @@ - - - - - - - - -flash.system.ApplicationDomain (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class ApplicationDomain
InheritanceApplicationDomain Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The ApplicationDomain class is a container for discrete groups of class definitions. - Application domains are used to partition classes that are in the same security domain. - They allow multiple definitions of the same class to exist and allow children to reuse parent - definitions. -

Application domains are used when an external SWF file is loaded through the Loader class. - All ActionScript 3.0 definitions in the loaded SWF file are stored in the application - domain, which is specified by the applicationDomain property of the LoaderContext - object that you pass as a context parameter of the Loader object's load() or - loadBytes() method. The LoaderInfo object also contains an - applicationDomain property, which is read-only.

-

All code in a SWF file is defined to exist in an application domain. The current application - domain is where your main application runs. The system domain contains all application domains, - including the current domain, which means that it contains all Flash Player classes.

-

Every application domain, except the system domain, has an associated parent domain. - The parent domain of your main application's application domain is the system domain. - Loaded classes are defined only when their parent doesn't already define them. - You cannot override a loaded class definition with a newer definition.

-

For usage examples of application domains, see the ActionScript 3.0 Developer's Guide.

-

The ApplicationDomain() constructor function allows you to create an ApplicationDomain object.

-

-

-View the examples. -

-

-See also -

-
-flash.display.Loader.load() -
-flash.display.Loader.loadBytes() -
-flash.display.LoaderInfo -
-flash.net.URLRequest -
-flash.system.LoaderContext -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentDomain : ApplicationDomain -
[static][read-only] - Gets the current application domain in which your code is executing.
-		ApplicationDomain
  domainMemory : ByteArray -
- Gets and sets the object on which domain-global memory operations will operate within this ApplicationDomain.
-		ApplicationDomain
  MIN_DOMAIN_MEMORY_LENGTH : uint -
[static][read-only] - Gets the minimum memory object length required to be used as - ApplicationDomain.domainMemory.
-		ApplicationDomain
  parentDomain : ApplicationDomain -
[read-only] - Gets the parent domain of this application domain.
-		ApplicationDomain
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ApplicationDomain(parentDomain:ApplicationDomain = null)
-
- Creates a new application domain.
-		ApplicationDomain
   -
-getDefinition(name:String):Object -
-
- Gets a public definition from the specified application domain.
-		ApplicationDomain
   -
-getQualifiedDefinitionNames():Vector.<String>
-
- Gets all fully-qualified names of public definitions from the specified application domain.
-		ApplicationDomain
   -
-hasDefinition(name:String):Boolean -
-
- Checks to see if a public definition exists within the specified application domain.
-		ApplicationDomain
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
currentDomainproperty
-
-currentDomain:ApplicationDomain  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Gets the current application domain in which your code is executing. -

Implementation -
-    public static function get currentDomain():ApplicationDomain -
-
- - - - - -
domainMemoryproperty 
-
-domainMemory:ByteArray  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Gets and sets the object on which domain-global memory operations will operate within this ApplicationDomain. - -

Implementation -
-    public function get domainMemory():ByteArray -
-    public function set domainMemory(value:ByteArray):void -
-
- - - - - -
MIN_DOMAIN_MEMORY_LENGTHproperty 
-
-MIN_DOMAIN_MEMORY_LENGTH:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Gets the minimum memory object length required to be used as - ApplicationDomain.domainMemory. -

Implementation -
-    public static function get MIN_DOMAIN_MEMORY_LENGTH():uint -
-
- - - - - -
parentDomainproperty 
-
-parentDomain:ApplicationDomain  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Gets the parent domain of this application domain. -

Implementation -
-    public function get parentDomain():ApplicationDomain -
-
- -
Constructor detail
- - - - - -
ApplicationDomain()constructor
-
-public function ApplicationDomain(parentDomain:ApplicationDomain = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a new application domain. -

Parameters - - - - -
parentDomain:ApplicationDomain (default = null) — If no parent domain is passed in, this application domain takes the system domain as its parent. -
-
- -
Method detail
- - - - - -
getDefinition()method
-
-public function getDefinition(name:String):Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Gets a public definition from the specified application domain. - The definition can be that of a class, a namespace, or a function. -

Parameters - - - - -
name:String — The name of the definition. -
-

-Returns - - - - -
Object — - The object associated with the definition. - - -
-
-Throws - - - - -
ReferenceError — No public definition exists with the - specified name. -
-
- - - - - -
getQualifiedDefinitionNames()method 
-
-public function getQualifiedDefinitionNames():Vector.<String> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.3 -
-

- Gets all fully-qualified names of public definitions from the specified application domain. - The definition can be that of a class, a namespace, or a function. - The names returned from this method can be passed to the getDefinition() method - to get the object of the actual definition. -

The returned Vector is of type String, where each String is in the form: - package.path::definitionName

-

If definitionName is in the top-level package, then - package.path:: is omitted.

-

For example, for the following class definition:

- 
-     package my.Example
-     {
-       public class SampleClass extends Sprite
-       { }
-     }
-

This method returns "my.Example::SampleClass".

-

-Returns - - - - -
Vector.<String> — An unsorted Vector of Strings which are the names of the definitions. If there is - no definition, an empty Vector.<String> is returned. -
-
-Throws - - - - -
SecurityError — The definition belongs to a domain to which - the calling code does not have access. -
-
- - - - - -
hasDefinition()method 
-
-public function hasDefinition(name:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Checks to see if a public definition exists within the specified application domain. - The definition can be that of a class, a namespace, or a function. -

Parameters - - - - -
name:String — The name of the definition. -
-

-Returns - - - - -
Boolean — - A value of true if the specified definition exists; otherwise, false. - - -
-
- -
Examples
-
examples\ApplicationDomainExample
-
The following example demonstrates runtime class loading as well as how to call public methods of a class that reside in another SWF. - -

Notes:

-
    -
  • Since the ClassLoader class loads a SWF file, local security needs to be at the file system level.
    • -
  • To run this example, you must have a swf file called RuntimeClasses.swf existing in the same folder - as the ApplicationDomainExample.swf file.
    • -
- -

Begin by creating the RuntimeClasses.swf file from the following code:

- 
-  package {
-    import flash.display.Sprite;
- 
-    public class RuntimeClasses extends Sprite
-    {
-      public function RuntimeClasses()
-      {}
-       
-      public function greet():String {
-        return("Hello World");
-      }
-    }
-  }
-
- -

Then implement the following code:

-
-
-
-package {
-    import flash.display.DisplayObject;
-    import flash.display.Sprite;
-    import flash.errors.IllegalOperationError;
-    import flash.events.Event;
-    import flash.text.TextField;
-
-    public class ApplicationDomainExample extends Sprite {
-        private var loader:ClassLoader;
-        private var tf:TextField = new TextField();
-
-        public function ApplicationDomainExample() {
-            addChild(tf);
-
-            loader = new ClassLoader();
-            loader.addEventListener(ClassLoader.LOAD_ERROR,loadErrorHandler);
-            loader.addEventListener(ClassLoader.CLASS_LOADED,classLoadedHandler);
-            loader.load("RuntimeClasses.swf");
-        }
-
-        private function loadErrorHandler(e:Event):void {
-            tf.text = "Load failed";
-            throw new IllegalOperationError("Cannot load the specified file.");
-        }
-
-        private function classLoadedHandler(e:Event):void {
-            var runtimeClassRef:Class = loader.getClass("RuntimeClasses");
-            var greeter:Object = new runtimeClassRef();
-
-            tf.text = greeter.greet();
-        }
-    }
-}
-
-import flash.display.Loader;
-import flash.errors.IllegalOperationError;
-import flash.events.Event;
-import flash.events.EventDispatcher;
-import flash.events.IOErrorEvent;
-import flash.events.SecurityErrorEvent;
-import flash.net.URLRequest;
-import flash.system.ApplicationDomain;
-import flash.system.LoaderContext;
-
-class ClassLoader extends EventDispatcher {
-    public static var CLASS_LOADED:String = "classLoaded";
-    public static var LOAD_ERROR:String = "loadError";
-    private var loader:Loader;
-    private var swfLib:String;
-    private var request:URLRequest;
-    private var loadedClass:Class;
-
-    public function ClassLoader() {
-
-        loader = new Loader();
-        loader.contentLoaderInfo.addEventListener(Event.COMPLETE,completeHandler);
-        loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR,ioErrorHandler);
-        loader.contentLoaderInfo.addEventListener(SecurityErrorEvent.SECURITY_ERROR,securityErrorHandler);
-    }
-
-    public function load(lib:String):void {
-        swfLib = lib;
-        request = new URLRequest(swfLib);
-        var context:LoaderContext = new LoaderContext();
-        context.applicationDomain=ApplicationDomain.currentDomain;
-        loader.load(request,context);
-    }
-
-    public function getClass(className:String):Class {
-        try {
-            return loader.contentLoaderInfo.applicationDomain.getDefinition(className)  as  Class;
-        } catch (e:Error) {
-            throw new IllegalOperationError(className + " definition not found in " + swfLib);
-        }
-        return null;
-    }
-
-    private function completeHandler(e:Event):void {
-        dispatchEvent(new Event(ClassLoader.CLASS_LOADED));
-    }
-
-    private function ioErrorHandler(e:Event):void {
-        dispatchEvent(new Event(ClassLoader.LOAD_ERROR));
-    }
-
-    private function securityErrorHandler(e:Event):void {
-        dispatchEvent(new Event(ClassLoader.LOAD_ERROR));
-    }
-}
-
-
-
examples\ApplicationDomainExample.2
-
If multiple SWF files contain compiled classes with the same name but provide different implementation, you can partition the classes of externally loaded SWF files separate from the classes of each other following this example. - Previously, the child SWF was instructed to use ApplicationDomain.currentDomain. In this case, a new ApplicationDomain is created, - so that then the properties and methods of the Greeter class of whichever SWF loads second will not replace the properties and methods of the first Greeter class. - You can test this by modifying the context.applicationDomain property in the load method of ClassLoader. - -

Notes:

-
    -
  • Since the ClassLoader class loads a SWF file, local security needs to be at the file system level.
    • -
  • To run this example, you must have two SWF files called Greeter.swf existing in an "en" and "es" folder respectively.
    • -
- -

Create a Greeter.as file in the "en" directory with the following code:

- 
-  package {
-     import flash.display.Sprite;
- 
- 	public class Greeter extends Sprite
- 	{
- 		public function Greeter()
- 		{
- 		}
- 		
- 		public function greet():String {
- 			return("Good Morning");
- 		}
- 	}
-  }
-
- -

Then create a very similar Greeter.as file in the "es" directory:

- - 
-  package {
- 	import flash.display.Sprite;
- 
- 	public class Greeter extends Sprite
- 	{
- 		public function Greeter()
- 		{
- 		}
- 		
- 		public function greet():String {
- 			return("Buenos Dias");
- 		}
- 	}
- }
- 
-
- -

Compile SWF files for both and then implement the following code:

-
-
-package {
-	import flash.display.DisplayObject;
-	import flash.display.Sprite;
-	import flash.errors.IllegalOperationError;
-	import flash.events.Event;
-	import flash.text.TextField;
-	import flash.text.TextFieldAutoSize;
-
-	public class ApplicationDomainExample2 extends Sprite {
-		private var spanishGreeterLoader:ClassLoader;
-		private var englishGreeterLoader:ClassLoader;
-		private var tf:TextField = new TextField();
-		private var greetersLoaded:uint = 0;
-
-		public function ApplicationDomainExample2() {
-			tf.autoSize = TextFieldAutoSize.LEFT;
-			addChild(tf);
-
-			spanishGreeterLoader = new ClassLoader();
-			spanishGreeterLoader.addEventListener(ClassLoader.LOAD_ERROR,loadErrorHandler);
-			spanishGreeterLoader.addEventListener(ClassLoader.CLASS_LOADED,classLoadedHandler);
-			spanishGreeterLoader.load("es/Greeter.swf");
-			
-			englishGreeterLoader = new ClassLoader();
-			englishGreeterLoader.addEventListener(ClassLoader.LOAD_ERROR,loadErrorHandler);
-			englishGreeterLoader.addEventListener(ClassLoader.CLASS_LOADED,classLoadedHandler);
-			englishGreeterLoader.load("en/Greeter.swf");
-		}
-
-		private function loadErrorHandler(e:Event):void {
-			tf.text = "Load failed";
-			throw new IllegalOperationError("Cannot load the specified file.");
-		}
-
-		private function classLoadedHandler(e:Event):void {
-			greetersLoaded++;
-			if(greetersLoaded == 2) {
-				greet();	
-			}
-		}
-		
-		private function greet():void {
-			var spanishGreeter:Class = spanishGreeterLoader.getClass("Greeter");
-			var englishGreeter:Class = englishGreeterLoader.getClass("Greeter");
-			var greeter1 = new spanishGreeter();
-			var greeter2 = new englishGreeter();
-			
-			tf.text = greeter1.greet() + "\n" + greeter2.greet();
-		}
-	}
-}
-
-import flash.display.Loader;
-import flash.errors.IllegalOperationError;
-import flash.events.Event;
-import flash.events.EventDispatcher;
-import flash.events.IOErrorEvent;
-import flash.events.SecurityErrorEvent;
-import flash.net.URLRequest;
-import flash.system.ApplicationDomain;
-import flash.system.LoaderContext;
-
-class ClassLoader extends EventDispatcher {
-	public static var CLASS_LOADED:String = "classLoaded";
-	public static var LOAD_ERROR:String = "loadError";
-	private var loader:Loader;
-	private var swfLib:String;
-	private var request:URLRequest;
-	private var loadedClass:Class;
-
-	public function ClassLoader() {
-
-		loader = new Loader();
-		loader.contentLoaderInfo.addEventListener(Event.COMPLETE,completeHandler);
-		loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR,ioErrorHandler);
-		loader.contentLoaderInfo.addEventListener(SecurityErrorEvent.SECURITY_ERROR,securityErrorHandler);
-	}
-
-	public function load(lib:String):void {
-		swfLib = lib;
-		request = new URLRequest(swfLib);
-		var context:LoaderContext = new LoaderContext();
-//		context.applicationDomain = ApplicationDomain.currentDomain;
-		context.applicationDomain = new ApplicationDomain();
-		loader.load(request,context);
-	}
-
-	public function getClass(className:String):Class {
-		try {
-			return loader.contentLoaderInfo.applicationDomain.getDefinition(className)  as  Class;
-		} catch (e:Error) {
-			throw new IllegalOperationError(className + " definition not found in " + swfLib);
-		}
-		return null;
-	}
-
-	private function completeHandler(e:Event):void {
-		dispatchEvent(new Event(ClassLoader.CLASS_LOADED));
-	}
-
-	private function ioErrorHandler(e:Event):void {
-		dispatchEvent(new Event(ClassLoader.LOAD_ERROR));
-	}
-
-	private function securityErrorHandler(e:Event):void {
-		dispatchEvent(new Event(ClassLoader.LOAD_ERROR));
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/Capabilities.html b/html-docs/flash/system/Capabilities.html deleted file mode 100644 index 3fc2530..0000000 --- a/html-docs/flash/system/Capabilities.html +++ /dev/null @@ -1,2251 +0,0 @@ - - - - - - - - -flash.system.Capabilities (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class Capabilities
InheritanceCapabilities Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

-

- The Capabilities class provides properties that - describe the system and runtime that are hosting the application. - For example, a mobile phone's screen might be 100 square - pixels, black and white, whereas a PC screen might be 1000 square pixels, color. - By using the Capabilities class to determine what capabilities the client has, - you can provide appropriate content to as many users as possible. When you know - the device's capabilities, you can tell the server to send the appropriate SWF - files or tell the SWF file to alter its presentation. - The Capabilities class provides properties that describe - the system and runtime that are hosting HTML (and SWF) content. - By using the Capabilities class to determine what capabilities the client has, - you can provide appropriate content to as many users as possible. When you know - the device's capabilities, you can load appropriate content or use code to - alter its presentation. -

However, some capabilities of Adobe AIR are not listed as properties in the - Capabilities class. They are properties of other classes:

- - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
NativeApplication.supportsDockIconWhether the operating system supports application doc icons.
NativeApplication.supportsMenuWhether the operating system supports a global application menu bar.
NativeApplication.supportsSystemTrayIconWhether the operating system supports system tray icons.
NativeWindow.supportsMenuWhether the operating system supports window menus.
NativeWindow.supportsTransparencyWhether the operating system supports transparent windows.
-

Do not use Capabilities.os or Capabilities.manufacturer to - determine a capability based on the operating system. Basing a capability on the operating system - is a bad idea, since it can lead to problems if an application does not consider all potential - target operating systems. Instead, use the property corresponding to the capability for which you - are testing.

-

You can send capabilities information, which is stored in the - Capabilities.serverString property as a URL-encoded string, using the - GET or POST HTTP method. The following example shows a server - string for a computer that has MP3 support and 1600 x 1200 pixel resolution, that is - running Windows XP with an input method editor (IME) installed, and does not have - support for multichannel audio:

- 
A=t&SA=t&SV=t&EV=t&MP3=t&AE=t&VE=t&ACC=f&PR=t&SP=t&
-     SB=f&DEB=t&V=WIN%209%2C0%2C0%2C0&M=Adobe%20Windows&
-     R=1600x1200&DP=72&COL=color&AR=1.0&OS=Windows%20XP&
-     L=en&PT=External&AVD=f&LFD=f&WD=f&IME=t&DD=f&
-     DDP=f&DTS=f&DTE=f&DTH=f&DTM=f
-

The following table lists the properties of the Capabilities class and corresponding server strings. - It also lists the server strings for the multichannel audio types. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Capabilities class propertyServer string
avHardwareDisableAVD
hasAccessibilityACC
hasAudioA
hasAudioEncoderAE
hasEmbeddedVideoEV
hasIMEIME
hasMP3MP3
hasPrintingPR
hasScreenBroadcastSB
hasScreenPlaybackSP
hasStreamingAudioSA
hasStreamingVideoSV
hasTLSTLS
hasVideoEncoderVE
isDebuggerDEB
languageL
localFileReadDisableLFD
manufacturerM
maxLevelIDCML
osOS
pixelAspectRatioAR
playerTypePT
screenColorCOL
screenDPIDP
screenResolutionXR
screenResolutionYR
versionV
supports Dolby Digital audioDD
supports Dolby Digital Plus audioDDP
supports DTS audioDTS
supports DTS Express audioDTE
supports DTS-HD High Resolution AudioDTH
supports DTS-HD Master AudioDTM
-

- -

There is also a WD server string that specifies whether windowless mode is disabled. Windowless mode - can be disabled in Flash Player due to incompatibility with the web browser or to a user setting in the mms.cfg file. - There is no corresponding Capabilities property.

- -

All properties of the Capabilities class are read-only.

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  avHardwareDisable : Boolean -
[static][read-only] - Specifies whether access to the user's camera and microphone has - been administratively prohibited (true) or allowed (false).
-		Capabilities
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  cpuAddressSize : Number -
[static][read-only] - Specifies whether the Flash Player or AIR application running on the system is 32-bit or 64-bit.
-		Capabilities
  cpuArchitecture : String -
[static][read-only] - Specifies the current CPU architecture.
-		Capabilities
  hasAccessibility : Boolean -
[static][read-only] - Specifies whether the system supports - (true) or does not support (false) communication - with accessibility aids.
-		Capabilities
  hasAudio : Boolean -
[static][read-only] - Specifies whether the system has audio - capabilities.
-		Capabilities
  hasAudioEncoder : Boolean -
[static][read-only] - Specifies whether the system can (true) or cannot (false) - encode an audio stream, such as that coming from a microphone.
-		Capabilities
  hasEmbeddedVideo : Boolean -
[static][read-only] - Specifies whether the system supports - (true) or does not support (false) - embedded video.
-		Capabilities
  hasIME : Boolean -
[static][read-only] - Specifies whether the system does (true) - or does not (false) have an input method editor (IME) installed.
-		Capabilities
  hasMP3 : Boolean -
[static][read-only] - Specifies whether the system does (true) - or does not (false) have an MP3 decoder.
-		Capabilities
  hasPrinting : Boolean -
[static][read-only] - Specifies whether the system does (true) - or does not (false) support printing.
-		Capabilities
  hasScreenBroadcast : Boolean -
[static][read-only] - Specifies whether the system does (true) or does not (false) - support the development of screen broadcast applications to be run through Flash Media - Server.
-		Capabilities
  hasScreenPlayback : Boolean -
[static][read-only] - Specifies whether the system does (true) or does not - (false) support the playback of screen broadcast applications - that are being run through Flash Media Server.
-		Capabilities
  hasStreamingAudio : Boolean -
[static][read-only] - Specifies whether the system can (true) or cannot (false) - play streaming audio.
-		Capabilities
  hasStreamingVideo : Boolean -
[static][read-only] - Specifies whether the system can (true) or cannot - (false) play streaming video.
-		Capabilities
  hasTLS : Boolean -
[static][read-only] - Specifies whether the system supports native SSL sockets through NetConnection - (true) or does not (false).
-		Capabilities
  hasVideoEncoder : Boolean -
[static][read-only] - Specifies whether the system can (true) or cannot - (false) encode a video stream, such as that coming - from a web camera.
-		Capabilities
  isDebugger : Boolean -
[static][read-only] - Specifies whether the system is a special debugging version - (true) or an officially released version (false).
-		Capabilities
  isEmbeddedInAcrobat : Boolean -
[static][read-only] - Specifies whether the Flash runtime is embedded in a PDF file that is open in Acrobat 9.0 or higher - (true) or not (false).
-		Capabilities
  language : String -
[static][read-only] - Specifies the language code of the system on which the content is running.
-		Capabilities
  languages : Array -
[static][read-only] - An array of strings that contain information about the user's preferred user interface languages, as set - through the operating system.
-		Capabilities
  localFileReadDisable : Boolean -
[static][read-only] - Specifies whether read access to the user's hard disk has been - administratively prohibited (true) or allowed - (false).
-		Capabilities
  manufacturer : String -
[static][read-only] - Specifies the manufacturer of the running version of - Flash Player or the AIR runtime, in the format "Adobe - OSName".
-		Capabilities
  maxLevelIDC : String -
[static][read-only] - Retrieves the highest H.264 Level IDC that the client hardware supports.
-		Capabilities
  os : String -
[static][read-only] - Specifies the current operating system.
-		Capabilities
  pixelAspectRatio : Number -
[static][read-only] - Specifies the pixel aspect ratio of the screen.
-		Capabilities
  playerType : String -
[static][read-only] - Specifies the type of runtime environment.
-		Capabilities
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  screenColor : String -
[static][read-only] - Specifies the screen color.
-		Capabilities
  screenDPI : Number -
[static][read-only] - Specifies the dots-per-inch (dpi) resolution of the screen, in pixels.
-		Capabilities
  screenResolutionX : Number -
[static][read-only] - Specifies the maximum horizontal resolution of the screen.
-		Capabilities
  screenResolutionY : Number -
[static][read-only] - Specifies the maximum vertical resolution of the screen.
-		Capabilities
  serverString : String -
[static][read-only] - A URL-encoded string that specifies values for each Capabilities - property.
-		Capabilities
  supports32BitProcesses : Boolean -
[static][read-only] - Specifies whether the system supports running 32-bit processes.
-		Capabilities
  supports64BitProcesses : Boolean -
[static][read-only] - Specifies whether the system supports running 64-bit processes.
-		Capabilities
  touchscreenType : String -
[static][read-only] - Specifies the type of touchscreen supported, if any.
-		Capabilities
  version : String -
[static][read-only] - Specifies the Flash Player or Adobe® AIR® - platform and version information.
-		Capabilities
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-hasMultiChannelAudio(type:String):Boolean -
-
[static] - Specifies whether the system supports multichannel audio of a specific - type.
-		Capabilities
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
avHardwareDisableproperty
-
-avHardwareDisable:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether access to the user's camera and microphone has - been administratively prohibited (true) or allowed (false). - The server string is AVD. -

For content in Adobe AIR™, this property applies only to content in security - sandboxes other than the application security sandbox. Content in the application - security sandbox can always access the user's camera and microphone.

- Implementation -
-    public static function get avHardwareDisable():Boolean -
-

-See also -

-
-flash.media.Camera.getCamera() -
-flash.media.Microphone.getMicrophone() -
-Security.showSettings() -
-
- - - - - -
cpuAddressSizeproperty 
-
-cpuAddressSize:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 32 -
-

- Specifies whether the Flash Player or AIR application running on the system is 32-bit or 64-bit. - Returns 32 and 64 for 32-bit and 64-bit code respectively. -

Implementation -
-    public static function get cpuAddressSize():Number -
-
- - - - - -
cpuArchitectureproperty 
-
-cpuArchitecture:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5.1
-

- Specifies the current CPU architecture. The cpuArchitecture property - can return the following strings: "PowerPC", "x86", - "SPARC", and "ARM". - The server string is ARCH. -

Implementation -
-    public static function get cpuArchitecture():String -
-
- - - - - -
hasAccessibilityproperty 
-
-hasAccessibility:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system supports - (true) or does not support (false) communication - with accessibility aids. - The server string is ACC. -

Implementation -
-    public static function get hasAccessibility():Boolean -
-

-See also -

-
-flash.accessibility.Accessibility.active -
-flash.accessibility.Accessibility.updateProperties() -
-
- - - - - -
hasAudioproperty 
-
-hasAudio:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system has audio - capabilities. This property is always true. The server - string is A. -

Implementation -
-    public static function get hasAudio():Boolean -
-
- - - - - -
hasAudioEncoderproperty 
-
-hasAudioEncoder:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system can (true) or cannot (false) - encode an audio stream, such as that coming from a microphone. - The server string is AE. -

Implementation -
-    public static function get hasAudioEncoder():Boolean -
-
- - - - - -
hasEmbeddedVideoproperty 
-
-hasEmbeddedVideo:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system supports - (true) or does not support (false) - embedded video. The server string is EV. -

Implementation -
-    public static function get hasEmbeddedVideo():Boolean -
-
- - - - - -
hasIMEproperty 
-
-hasIME:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system does (true) - or does not (false) have an input method editor (IME) installed. - The server string is IME. -

Implementation -
-    public static function get hasIME():Boolean -
-

-See also -

-
-flash.system.IME -
-flash.system.System.ime -
-
- - - - - -
hasMP3property 
-
-hasMP3:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system does (true) - or does not (false) have an MP3 decoder. - The server string is MP3. - -

Implementation -
-    public static function get hasMP3():Boolean -
-
- - - - - -
hasPrintingproperty 
-
-hasPrinting:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system does (true) - or does not (false) support printing. - The server string is PR. -

Implementation -
-    public static function get hasPrinting():Boolean -
-
- - - - - -
hasScreenBroadcastproperty 
-
-hasScreenBroadcast:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system does (true) or does not (false) - support the development of screen broadcast applications to be run through Flash Media - Server. - The server string is SB. -

Implementation -
-    public static function get hasScreenBroadcast():Boolean -
-
- - - - - -
hasScreenPlaybackproperty 
-
-hasScreenPlayback:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system does (true) or does not - (false) support the playback of screen broadcast applications - that are being run through Flash Media Server. - The server string is SP. -

Implementation -
-    public static function get hasScreenPlayback():Boolean -
-
- - - - - -
hasStreamingAudioproperty 
-
-hasStreamingAudio:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system can (true) or cannot (false) - play streaming audio. - The server string is SA. -

Implementation -
-    public static function get hasStreamingAudio():Boolean -
-
- - - - - -
hasStreamingVideoproperty 
-
-hasStreamingVideo:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system can (true) or cannot - (false) play streaming video. - The server string is SV. -

Implementation -
-    public static function get hasStreamingVideo():Boolean -
-
- - - - - -
hasTLSproperty 
-
-hasTLS:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system supports native SSL sockets through NetConnection - (true) or does not (false). - The server string is TLS. -

Implementation -
-    public static function get hasTLS():Boolean -
-

-See also -

-
-flash.net.NetConnection.connectedProxyType -
-flash.net.NetConnection.proxyType -
-flash.net.NetConnection.usingTLS -
-
- - - - - -
hasVideoEncoderproperty 
-
-hasVideoEncoder:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system can (true) or cannot - (false) encode a video stream, such as that coming - from a web camera. - The server string is VE. -

Implementation -
-    public static function get hasVideoEncoder():Boolean -
-
- - - - - -
isDebuggerproperty 
-
-isDebugger:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether the system is a special debugging version - (true) or an officially released version (false). - The server string is DEB. This property is set to true - when running in the debug version of Flash Player or - the AIR Debug Launcher (ADL). -

Implementation -
-    public static function get isDebugger():Boolean -
-
- - - - - -
isEmbeddedInAcrobatproperty 
-
-isEmbeddedInAcrobat:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.1 -
-

- Specifies whether the Flash runtime is embedded in a PDF file that is open in Acrobat 9.0 or higher - (true) or not (false). -

Implementation -
-    public static function get isEmbeddedInAcrobat():Boolean -
-
- - - - - -
languageproperty 
-
-language:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies the language code of the system on which the content is running. The language is - specified as a lowercase two-letter language code from ISO 639-1. For Chinese, an additional - uppercase two-letter country code from ISO 3166 distinguishes between Simplified and - Traditional Chinese. The languages codes are based on the English names of the language: for example, - hu specifies Hungarian. -

On English systems, this property returns only the language code (en), not - the country code. On Microsoft Windows systems, this property returns the user interface (UI) - language, which refers to the language used for all menus, dialog boxes, error messages, and help - files. The following table lists the possible values: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
LanguageValue
Czechcs
Danishda
Dutchnl
Englishen
Finnishfi
Frenchfr
Germande
Hungarianhu
Italianit
Japaneseja
Koreanko
Norwegiannb
Other/unknownxu
Polishpl
Portuguesept
Russianru
Simplified Chinesezh-CN
Spanishes
Swedishsv
Traditional Chinesezh-TW
Turkishtr
-

-

Note: The value of Capabilities.language property is limited - to the possible values on this list. Because of this limitation, Adobe AIR applications - should use the first element in the Capabilities.languages - array to determine the primary user interface language for the system.

-

The server string is L.

- Implementation -
-    public static function get language():String -
-

-See also -

-
-languages -
-
-Example -
In the following example, the content that is displayed depends on the language of the user's operating - system. - -

The Capabilities.language property returns the ISO 639-1 language code - (for example, "en" for English). The switch statement checks for the language code and sets - the content of the myTextField text field to a greeting specific to the - language. If the language code is not supported by the example, the default error string - is returned.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.system.Capabilities;
-
-    public class Capabilities_languageExample extends Sprite {
-
-        public function Capabilities_languageExample()  {
-            var myTextField:TextField = new TextField();         
-            myTextField.x = 10;
-            myTextField.y = 10;
-            myTextField.background = true;
-            myTextField.autoSize = TextFieldAutoSize.LEFT;
-            
-            var greetingEnglish:String = "Hello World";
-            var greetingGerman:String = "Hallo Welt";
-            var greetingFrench:String = "Bonjour Monde";
-            var greetingSpanish:String = "Hola Mundo";
-
-            var lang:String = Capabilities.language;
-                         
-            switch (lang) {
-                case "en":
-                    myTextField.text = greetingEnglish;
-                    break;
-                case "de":
-                    myTextField.text = greetingGerman;
-                    break;
-                case "fr":
-                    myTextField.text = greetingFrench;
-                    break;
-                case "es":
-                    myTextField.text = greetingSpanish;
-                    break;
-                default:
-                    myTextField.text = "Sorry your system's language is not supported at this time.";               
-            }
-             
-            this.addChild(myTextField);
-        }
-    }
-}
-
-

-
- - - - - -
languagesproperty 
-
-languages:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.1 -
-

- An array of strings that contain information about the user's preferred user interface languages, as set - through the operating system. The strings will contain language tags (and script and region information, - where applicable) defined by RFC4646 - (http://www.ietf.org/rfc/rfc4646.txt) - and will use dashes as a delimiter (for example, "en-US" or "ja-JP"). - Languages are listed in the array in the order of preference, as determined by the operating system - settings. - -

Operating systems differ in region information returned in locale strings. One operating system - may return "en-us", whereas another may return "en".

- -

The first entry in the returned array generally has the same primary language ID - as the Capabilities.language property. For example, if Capabilities.languages[0] - is set to "en-US", then the language property is set to "en". - However, if the Capabilities.language property is set to "xu" (specifying - an unknown language), the first element in this array will be different. For this reason, - Capabilities.languages[0] can be more accurate than Capabilities.language.

- -

The server string is LS.

- Implementation -
-    public static function get languages():Array -
-
- - - - - -
localFileReadDisableproperty 
-
-localFileReadDisable:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies whether read access to the user's hard disk has been - administratively prohibited (true) or allowed - (false). For content in Adobe AIR, this property - applies only to content in security sandboxes other - than the application security sandbox. (Content in the application - security sandbox can always read from the file system.) - If this property is true, - Flash Player cannot read files (including the first file that - Flash Player launches with) from the user's hard disk. - If this property is true, AIR content outside of the - application security sandbox cannot read files from the user's - hard disk. For example, attempts to read a file on the user's - hard disk using load methods will fail if this property - is set to true. - -

Reading runtime shared libraries is also blocked - if this property is set to true, but reading local shared objects - is allowed without regard to the value of this property.

- -

The server string is LFD.

- Implementation -
-    public static function get localFileReadDisable():Boolean -
-

-See also -

-
-flash.display.Loader -
-
- - - - - -
manufacturerproperty 
-
-manufacturer:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies the manufacturer of the running version of - Flash Player or the AIR runtime, in the format "Adobe - OSName". The value for OSName - could be "Windows", "Macintosh", - "Linux", or another operating system name. The server string is M. -

Do not use Capabilities.manufacturer to determine a capability based on - the operating system if a more specific capability property exists. Basing a capability on the operating - system is a bad idea, since it can lead to problems if an application does not consider all potential - target operating systems. Instead, use the property corresponding to the capability for which you - are testing. For more information, see the Capabilities class description.

- Implementation -
-    public static function get manufacturer():String -
-
- - - - - -
maxLevelIDCproperty 
-
-maxLevelIDC:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Retrieves the highest H.264 Level IDC that the client hardware supports. - Media run at this level are guaranteed to run; however, media run at - the highest level might not run with the highest quality. - This property is useful for servers trying to target a client's capabilities. - Using this property, a server can determine the level of video to send to the client. - -

The server string is ML.

- Implementation -
-    public static function get maxLevelIDC():String -
-
- - - - - -
osproperty 
-
-os:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies the current operating system. The os property - can return the following strings: - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Operating systemValue
Windows 10"Windows 10"
Windows 8"Windows 8"
Windows 7"Windows 7"
Windows Vista"Windows Vista"
Windows Server 2012"Windows Server 2012"
Windows Server 2008 R2"Windows Server 2008 R2"
Windows Server 2008"Windows Server 2008"
Windows Home Server"Windows Home Server"
Windows Server 2003 R2"Windows Server 2003 R2"
Windows Server 2003"Windows Server 2003"
Windows XP 64"Windows Server XP 64"
Windows XP"Windows XP"
Windows 98"Windows 98"
Windows 95"Windows 95"
Windows NT"Windows NT"
Windows 2000"Windows 2000"
Windows ME"Windows ME"
Windows CE"Windows CE"
Windows SmartPhone"Windows SmartPhone"
Windows PocketPC"Windows PocketPC"
Windows CEPC"Windows CEPC"
Windows Mobile"Windows Mobile"
Mac OS"Mac OS X.Y.Z" (where X.Y.Z is the version number, for example: - "Mac OS 10.5.2")
Linux"Linux" (Flash Player attaches the Linux version, such as "Linux 2.6.15-1.2054_FC5smp"
iPhone OS 4.1"iPhone3,1"
-

The server string is OS.

-

Do not use Capabilities.os to determine a capability based on - the operating system if a more specific capability property exists. Basing a capability on the operating - system is a bad idea, since it can lead to problems if an application does not consider all potential - target operating systems. Instead, use the property corresponding to the capability for which you - are testing. For more information, see the Capabilities class description.

- Implementation -
-    public static function get os():String -
-
- - - - - -
pixelAspectRatioproperty 
-
-pixelAspectRatio:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies the pixel aspect ratio of the screen. The server string - is AR. - -

Implementation -
-    public static function get pixelAspectRatio():Number -
-
- - - - - -
playerTypeproperty 
-
-playerType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies the type of runtime environment. This property can have one of the following - values: - -

    -
  • "ActiveX" for the Flash Player ActiveX control used by Microsoft Internet Explorer
    • -
  • "Desktop" for the Adobe AIR runtime (except for SWF content loaded by an HTML page, which - has Capabilities.playerType set to "PlugIn")
    • -
  • "External" for the external Flash Player or in test mode
    • -
  • "PlugIn" for the Flash Player browser plug-in (and for SWF content loaded by - an HTML page in an AIR application)
    • -
  • "StandAlone" for the stand-alone Flash Player
    • -
-

The server string is PT.

- Implementation -
-    public static function get playerType():String -
-
- - - - - -
screenColorproperty 
-
-screenColor:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies the screen color. This property can have the value - "color", "gray" (for grayscale), or - "bw" (for black and white). - The server string is COL. -

Implementation -
-    public static function get screenColor():String -
-
- - - - - -
screenDPIproperty 
-
-screenDPI:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies the dots-per-inch (dpi) resolution of the screen, in pixels. - The server string is DP. -

Implementation -
-    public static function get screenDPI():Number -
-
- - - - - -
screenResolutionXproperty 
-
-screenResolutionX:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies the maximum horizontal resolution of the screen. - The server string is R (which returns both the width and height of the screen). - This property does not update with a user's screen resolution and instead only indicates the resolution - at the time Flash Player or an Adobe AIR application started. - Also, the value only specifies the primary screen. -

Implementation -
-    public static function get screenResolutionX():Number -
-
- - - - - -
screenResolutionYproperty 
-
-screenResolutionY:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- Specifies the maximum vertical resolution of the screen. - The server string is R (which returns both the width and height of the screen). - This property does not update with a user's screen resolution and instead only indicates the resolution - at the time Flash Player or an Adobe AIR application started. - Also, the value only specifies the primary screen. -

Implementation -
-    public static function get screenResolutionY():Number -
-
-Example -
The following example is a simple test that indicates the current screen resolution and operating system version. - When testing this example, click the text field to see the property values: -
-
-import flash.events.*;
-import flash.display.*;
-import flash.system.Capabilities;
-import flash.text.TextField;
-
-var screenInfoTxt:TextField = new TextField();
-screenInfoTxt.x = 30;
-screenInfoTxt.y = 50;
-screenInfoTxt.width = 300;
-screenInfoTxt.height = 100;
-screenInfoTxt.border = true;
-
-addChild(screenInfoTxt);
-
-addEventListener(MouseEvent.CLICK, getScreenNVersion);
-
-function getScreenNVersion(e:MouseEvent):void{
-    screenInfoTxt.text= "flash.system.Capabilities.screenResolutionX is : " + String(flash.system.Capabilities.screenResolutionX) + "\n" +
-	"flash.system.Capabilities.screenResolutionY is : " + String(flash.system.Capabilities.screenResolutionY) + "\n" +
-	"flash.system.Capabilities.version is : " + flash.system.Capabilities.version;
-}
-
-

-
- - - - - -
serverStringproperty 
-
-serverString:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- A URL-encoded string that specifies values for each Capabilities - property. - -

The following example shows a URL-encoded string: - 

A=t&SA=t&SV=t&EV=t&MP3=t&AE=t&VE=t&ACC=f&PR=t&SP=t&
-	 SB=f&DEB=t&V=WIN%208%2C5%2C0%2C208&M=Adobe%20Windows&
-	 R=1600x1200&DP=72&COL=color&AR=1.0&OS=Windows%20XP&
-	 L=en&PT=External&AVD=f&LFD=f&WD=f

- - Implementation -
-    public static function get serverString():String -
-
- - - - - -
supports32BitProcessesproperty 
-
-supports32BitProcesses:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5.2 -
-

- Specifies whether the system supports running 32-bit processes. - The server string is PR32. -

Implementation -
-    public static function get supports32BitProcesses():Boolean -
-
- - - - - -
supports64BitProcessesproperty 
-
-supports64BitProcesses:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5.2 -
-

- Specifies whether the system supports running 64-bit processes. - The server string is PR64. -

Implementation -
-    public static function get supports64BitProcesses():Boolean -
-
- - - - - -
touchscreenTypeproperty 
-
-touchscreenType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the type of touchscreen supported, if any. Values are defined in the flash.system.TouchscreenType class. - -

Implementation -
-    public static function get touchscreenType():String -
-

-See also -

-
-TouchscreenType class -
-flash.ui.Mouse.supportsCursor -
-
-Example -
The following example is a simple test that indicates the current type of touch screen. - When testing this example, click a text field to see the property values: -
-
-import flash.events.~~;
-import flash.display.~~;
-import flash.system.Capabilities;
-import flash.text.TextField;
-
-var capabilitiesTouchScreenTypeTxt:TextField = new TextField();
-capabilitiesTouchScreenTypeTxt.width = 300;
-capabilitiesTouchScreenTypeTxt.border = true;
-
-addChild(capabilitiesTouchScreenTypeTxt);
-
-addEventListener(MouseEvent.CLICK, getScreenKeyboardType);
-
-function getScreenKeyboardType(e:MouseEvent):void{
-    capabilitiesTouchScreenTypeTxt.text= "flash.system.Capabilities.touchscreenType is : " + flash.system.Capabilities.touchscreenType;
-}
-
-

-
- - - - - -
versionproperty 
-
-version:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- Specifies the Flash Player or Adobe® AIR® - platform and version information. The format of the version number is: - platform majorVersion,minorVersion,buildNumber,internalBuildNumber. - Possible values for platform are "WIN", ` - "MAC", "LNX", and "AND". Here are some - examples of version information: - - 

-	 WIN 9,0,0,0  // Flash Player 9 for Windows
-	 MAC 7,0,25,0   // Flash Player 7 for Macintosh
-	 LNX 9,0,115,0  // Flash Player 9 for Linux
-	 AND 10,2,150,0 // Flash Player 10 for Android
-
- -

Do not use Capabilities.version to determine a capability based on - the operating system if a more specific capability property exists. Basing a capability on the operating - system is a bad idea, since it can lead to problems if an application does not consider all potential - target operating systems. Instead, use the property corresponding to the capability for which you - are testing. For more information, see the Capabilities class description.

-

The server string is V.

- Implementation -
-    public static function get version():String -
-
-Example -
The following example is a simple test that indicates the current screen resolution and operating system version. - When testing this example, click the text field to see the property values: -
-
-import flash.events.*;
-import flash.display.*;
-import flash.system.Capabilities;
-import flash.text.TextField;
-
-var screenInfoTxt:TextField = new TextField();
-screenInfoTxt.x = 30;
-screenInfoTxt.y = 50;
-screenInfoTxt.width = 300;
-screenInfoTxt.height = 100;
-screenInfoTxt.border = true;
-
-addChild(screenInfoTxt);
-
-addEventListener(MouseEvent.CLICK, getScreenNVersion);
-
-function getScreenNVersion(e:MouseEvent):void{
-    screenInfoTxt.text= "flash.system.Capabilities.screenResolutionX is : " + String(flash.system.Capabilities.screenResolutionX) + "\n" +
-	"flash.system.Capabilities.screenResolutionY is : " + String(flash.system.Capabilities.screenResolutionY) + "\n" +
-	"flash.system.Capabilities.version is : " + flash.system.Capabilities.version;
-}
-
-

-
- -
Method detail
- - - - - -
hasMultiChannelAudio()method
-
-public static function hasMultiChannelAudio(type:String):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Specifies whether the system supports multichannel audio of a specific - type. The class flash.media.AudioDecoder enumerates the possible types. -

AIR profile support: Multichannel audio is supported - only on AIR for TV devices. On all other devices, this method always returns false. - See - - AIR Profile Support for more information regarding API support across multiple profiles.

- -

Note: When using one of the DTS audio codecs, scenarios exist in which - hasMultiChannelAudio() returns true but the DTS audio is not played. - For example, consider a Blu-ray player with an S/PDIF output, connected to an old amplifier. - The old amplifier does not support DTS, but S/PDIF has no protocol to notify the Blu-ray player. - If the Blu-ray player sends the DTS stream to the old amplifier, the user hears nothing. - Therefore, as a best practice when using DTS, provide a user interface so that the user can - indicate if no sound is playing. Then, your application can revert to a different codec. -

-

The following table shows the server string for each multichannel audio type: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Multichannel audio typeServer string
AudioDecoder.DOLBY_DIGITALDD
AudioDecoder.DOLBY_DIGITAL_PLUSDDP
AudioDecoder.DTSDTS
AudioDecoder.DTS_EXPRESSDTE
AudioDecoder.DTS_HD_HIGH_RESOLUTION_AUDIODTH
AudioDecoder.DTS_HD_MASTER_AUDIODTM
-

- Parameters - - - - -
type:String — A String value representing a multichannel audio type. - The valid values are the constants defined in flash.media.AudioDecoder. -
-

-Returns - - - - -
Boolean — - The Boolean value true if the system - supports the multichannel audio type passed in the type parameter. - Otherwise, the return value is false. - - - -
-

-See also -

-
-flash.media.AudioDecoder -
-
-Example -

-
- -
Examples
-
examples\CapabilitiesExample
-
The following example outputs the values found in the - flash.system.Capabilities object. First, it outputs the values into a text field. - Then, it outputs the values using several calls to trace(). -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.system.Capabilities;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-
-    public class CapabilitiesExample extends Sprite {
-        
-        public function CapabilitiesExample() {
-            showCapabilities();
-        }
-        
-        private function showCapabilities():void {
-            var tf:TextField = new TextField();
-            tf.height = 600;
-            tf.width = 400;
-            tf.autoSize = TextFieldAutoSize.LEFT;
-            tf.wordWrap = true;
-            
-            tf.text = "avHardwareDisable: " + Capabilities.avHardwareDisable +
-                
-                "\nhasAccessibility: " + Capabilities.hasAccessibility +
-                "\nhasAudio: " + Capabilities.hasAudio +
-                "\nhasAudioEncoder: " + Capabilities.hasAudioEncoder +
-                "\nhasEmbeddedVideo: " + Capabilities.hasEmbeddedVideo +
-                "\nhasIME: " + Capabilities.hasIME +
-                "\nhasMP3: " + Capabilities.hasMP3 +
-                "\nhasPrinting: " + Capabilities.hasPrinting +
-                "\nhasScreenBroadcast: " + Capabilities.hasScreenBroadcast +
-                "\nhasScreenPlayback: " + Capabilities.hasScreenPlayback +
-                "\nhasStreamingAudio: " + Capabilities.hasStreamingAudio +
-                "\nhasStreamingVideo: " + Capabilities.hasStreamingVideo +
-                "\nhasTLS: " + Capabilities.hasTLS +
-                "\nhasVideoEncoder: " + Capabilities.hasVideoEncoder +
-                "\nisDebugger: " + Capabilities.isDebugger +
-                "\nisEmbeddedInAcrobat: " + Capabilities.isEmbeddedInAcrobat +
-                "\nlanguage: " + Capabilities.language +
-                "\nlocalFileReadDisable: " + Capabilities.localFileReadDisable +
-                "\nmanufacturer: " + Capabilities.manufacturer +
-                "\nmaxLevelIDC: " + Capabilities.maxLevelIDC +
-                "\nos: " + Capabilities.os +
-                "\npixelAspectRatio: " + Capabilities.pixelAspectRatio +
-                "\nplayerType: " + Capabilities.playerType +
-                "\nscreenColor: " + Capabilities.screenColor +
-                "\nscreenDPI: " + Capabilities.screenDPI +
-                "\nscreenResolutionX: " + Capabilities.screenResolutionX +
-                "\nscreenResolutionY: " + Capabilities.screenResolutionY +
-                "\nserverString: " + Capabilities.serverString +
-                "\ntouchscreenType: " + Capabilities.touchscreenType +
-                
-                // The following capabilities are supported only when publishing for AIR.
-                // If you are publishing for AIR, uncomment the following lines.
-                //"\nlanguages: " + Capabilities.languages +
-                //"\ncpuArchitecture: " + Capabilities.cpuArchitecture +
-                //"\nsupports32BitProcesses: " + Capabilities.supports32BitProcesses +
-                //"\nsupports64BitProcesses: " + Capabilities.supports64BitProcesses +    
-                                
-                "\nversion: " + Capabilities.version;
-                
-            addChild(tf);   
-                
-            trace("avHardwareDisable: " + Capabilities.avHardwareDisable);
-            trace("hasAccessibility: " + Capabilities.hasAccessibility);
-            trace("hasAudio: " + Capabilities.hasAudio);
-            trace("hasAudioEncoder: " + Capabilities.hasAudioEncoder);
-            trace("hasEmbeddedVideo: " + Capabilities.hasEmbeddedVideo);
-            trace("hasIME: " + Capabilities.hasIME);
-            trace("hasMP3: " + Capabilities.hasMP3);
-            trace("hasPrinting: " + Capabilities.hasPrinting);
-            trace("hasScreenBroadcast: " + Capabilities.hasScreenBroadcast);
-            trace("hasScreenPlayback: " + Capabilities.hasScreenPlayback);
-            trace("hasStreamingAudio: " + Capabilities.hasStreamingAudio);
-            trace("hasStreamingVideo: " + Capabilities.hasStreamingVideo);
-            trace("hasTLS: " + Capabilities.hasTLS);
-            trace("hasVideoEncoder: " + Capabilities.hasVideoEncoder);
-            trace("isDebugger: " + Capabilities.isDebugger);
-            trace("isEmbeddedInAcrobat: " + Capabilities.isEmbeddedInAcrobat);
-            trace("language: " + Capabilities.language);
-            trace("localFileReadDisable: " + Capabilities.localFileReadDisable);
-            trace("manufacturer: " + Capabilities.manufacturer);
-            trace("maxLevelIDC: " + Capabilities.maxLevelIDC);
-            trace("os: " + Capabilities.os);
-            trace("pixelAspectRatio: " + Capabilities.pixelAspectRatio);
-            trace("playerType: " + Capabilities.playerType);
-            trace("screenColor: " + Capabilities.screenColor);
-            trace("screenDPI: " + Capabilities.screenDPI);
-            trace("screenResolutionX: " + Capabilities.screenResolutionX);
-            trace("screenResolutionY: " + Capabilities.screenResolutionY);
-            trace("serverString: " + Capabilities.serverString);
-            trace("touchscreenType: " + Capabilities.touchscreenType);
-            
-            // The following capabilities are supported only when publishing for AIR.
-            // If you are publishing for AIR, uncomment the following lines.       
-            //trace("cpuArchitecture: " + Capabilities.cpuArchitecture);
-            //trace("languages: " + Capabilities.languages);
-            //trace("supports32BitProcesses: " + Capabilities.supports32BitProcesses);
-            //trace("supports64BitProcesses: " + Capabilities.supports64BitProcesses);        
-                        
-            trace("version: " + Capabilities.version);
-       
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/IME.html b/html-docs/flash/system/IME.html deleted file mode 100644 index 37f6602..0000000 --- a/html-docs/flash/system/IME.html +++ /dev/null @@ -1,747 +0,0 @@ - - - - - - - - -flash.system.IME (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class IME
InheritanceIME Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The IME class lets you directly manipulate the operating system's input method - editor (IME) in the Flash runtime application that is running on a client computer. You can - determine whether an IME is installed, whether or not the IME is currently enabled, and which IME is - enabled. You can disable or enable the IME in the application, and you can perform other limited - functions, depending on the operating system. -

AIR profile support: This feature is supported - on desktop operating systems, but it is not supported on all mobile devices. It is also not supported on - AIR for TV devices. You can test for support at run time using the IME.isSupported property. See - - AIR Profile Support for more information regarding API support across multiple profiles.

-

IMEs let users type non-ASCII text characters in multibyte languages - such as Chinese, Japanese, and Korean. For more information on working with IMEs, see the - documentation for the operating system for which you are developing applications. - For additional resources, see the following websites: -

-

-

If an IME is not active on the user's computer, calls to IME methods or properties, - other than Capabilities.hasIME, will fail. Once you manually activate an IME, subsequent ActionScript - calls to IME methods and properties will work as expected. For example, if you are using a - Japanese IME, it must be activated before any IME method or property is called.

- -

The following table shows the platform coverage of this class:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CapabilityWindowsMac OSXLinux
Determine whether the IME is installed: Capabilities.hasIMEYesYesYes
Set IME on or off: IME.enabledYesYesYes
Find out whether IME is on or off: IME.enabledYesYesYes
Get or set IME conversion mode: IME.conversionModeYesYes **No
Send IME the string to be converted: IME.setCompositionString()Yes *NoNo
Get from IME the original string before conversion: System.ime.addEventListener()Yes *NoNo
Send request to convert to IME: IME.doConversion()Yes *NoNo
-

* Not all Windows IMEs support all of these operations. The only IME - that supports them all is the Japanese IME.

- -

** On the Macintosh, only the Japanese IME supports these methods, and third-party IMEs do not support them.

-

The ActionScript 3.0 version of this class does not support Macintosh Classic.

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  conversionMode : String -
[static] - The conversion mode of the current IME.
-		IME
  enabled : Boolean -
[static] - Indicates whether the system IME is enabled (true) or disabled (false).
-		IME
  isSupported : Boolean -
[static][read-only] - The isSupported property is set to true if the IME class is - available on the current platform, otherwise it is set to false.
-		IME
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-compositionAbandoned():void -
-
[static] - Causes the runtime to abandon any composition that is in progress.
-		IME
   -
-compositionSelectionChanged(start:int, end:int):void -
-
[static] - Call this method when the selection within the composition has been updated, either interactively or - programmatically.
-		IME
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-doConversion():void -
-
[static] - Instructs the IME to select the first candidate for the current composition string.
-		IME
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-setCompositionString(composition:String):void -
-
[static] - Sets the IME composition string.
-		IME
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-imeComposition -
-		 - Dispatched when a user has completed an - input method editor (IME) composition - and the reading string is available.IME
-
- -
- -
Property detail
- - - - - -
conversionModeproperty
-
-conversionMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The conversion mode of the current IME. - Possible values are IME mode string constants that indicate the conversion mode: -

    -
  • ALPHANUMERIC_FULL
    • -
  • ALPHANUMERIC_HALF
    • -
  • CHINESE
    • -
  • JAPANESE_HIRAGANA
    • -
  • JAPANESE_KATAKANA_FULL
    • -
  • JAPANESE_KATAKANA_HALF
    • -
  • KOREAN
    • -
  • UNKNOWN (read-only value; this value cannot be set)
    • -
-

Implementation -
-    public static function get conversionMode():String -
-    public function set conversionMode(value:String):void -
-
-Throws -
- - - - -
Error — A set attempt was not successful. -
-

-See also -

-
-flash.system.IMEConversionMode.ALPHANUMERIC_FULL -
-flash.system.IMEConversionMode.ALPHANUMERIC_HALF -
-flash.system.IMEConversionMode.CHINESE -
-flash.system.IMEConversionMode.JAPANESE_HIRAGANA -
-flash.system.IMEConversionMode.JAPANESE_KATAKANA_FULL -
-flash.system.IMEConversionMode.JAPANESE_KATAKANA_HALF -
-flash.system.IMEConversionMode.KOREAN -
-flash.system.IMEConversionMode.UNKNOWN -
-
- - - - - -
enabledproperty 
-
-enabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether the system IME is enabled (true) or disabled (false). - An enabled IME performs multibyte input; a disabled IME performs alphanumeric input. -

Implementation -
-    public static function get enabled():Boolean -
-    public function set enabled(value:Boolean):void -
-
-Throws -
- - - - -
Error — A set attempt was not successful. -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The isSupported property is set to true if the IME class is - available on the current platform, otherwise it is set to false. -

Implementation -
-    public static function get isSupported():Boolean -
-
- -
Method detail
- - - - - -
compositionAbandoned()method
-
-public static function compositionAbandoned():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Causes the runtime to abandon any composition that is in progress. Call this method when the user clicks - outside of the composition area or when the interactive object that has focus is being destroyed or reset. - The runtime confirms the composition by calling confirmComposition() in the client. The - runtime also resets the IME to inform the operating system that the composition has been abandoned. - -

- - - - - -
compositionSelectionChanged()method 
-
-public static function compositionSelectionChanged(start:int, end:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Call this method when the selection within the composition has been updated, either interactively or - programmatically. -

Parameters - - - - - - - - - - -
start:int — Specifies the offset in bytes of the start of the selection. -
 
end:int — Specifies the offset in bytes of the end of the selection. - -
-
- - - - - -
doConversion()method 
-
-public static function doConversion():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Instructs the IME to select the first candidate for the current composition string. -


-Throws - - - - -
Error — The call was not successful. -
-
- - - - - -
setCompositionString()method 
-
-public static function setCompositionString(composition:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sets the IME composition string. When this string is set, the user - can select IME candidates before committing the result to the text - field that currently has focus. -

If no text field has focus, this method fails and throws an error.

- Parameters - - - - -
composition:String — The string to send to the IME. -
-
-Throws - - - - -
Error — The call is not successful. -
-
-
Event detail
- - - - - -
imeCompositionevent 
-
-Event object type: flash.events.IMEEvent -
-IMEEvent.type property = flash.events.IMEEvent.IME_COMPOSITION -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a user has completed an - input method editor (IME) composition - and the reading string is available. - IMEs are generally used to enter text from languages that have ideographs instead - of letters, such as Japanese, Chinese and Korean. -

- To handle IME text input, the receiver must set the imeClient field of the event to an object - that implements the IIMEClient interface. If imeClient is unset, the runtime uses out-of-line - IME composition instead, and sends the final composition as a TEXT_INPUT event. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe IME object.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/IMEConversionMode.html b/html-docs/flash/system/IMEConversionMode.html deleted file mode 100644 index 285a164..0000000 --- a/html-docs/flash/system/IMEConversionMode.html +++ /dev/null @@ -1,523 +0,0 @@ - - - - - - - - -flash.system.IMEConversionMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class IMEConversionMode
InheritanceIMEConversionMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- This class contains constants for use with the IME.conversionMode - property. Setting conversionMode to either - ALPHANUMERIC_FULL or JAPANESE_KATAKANA_FULL causes the - player to use a full width font, whereas using ALPHANUMERIC_HALF or - JAPANESE_KATAKANA_HALF uses a half width font. -

-

-See also -

-
-flash.system.IME.conversionMode -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ALPHANUMERIC_FULL : String = "ALPHANUMERIC_FULL"
[static] - The string "ALPHANUMERIC_FULL", for use with the - IME.conversionMode property.
-		IMEConversionMode
  ALPHANUMERIC_HALF : String = "ALPHANUMERIC_HALF"
[static] - The string "ALPHANUMERIC_HALF", for use with the - IME.conversionMode property.
-		IMEConversionMode
  CHINESE : String = "CHINESE"
[static] - The string "CHINESE", for use with the - IME.conversionMode property.
-		IMEConversionMode
  JAPANESE_HIRAGANA : String = "JAPANESE_HIRAGANA"
[static] - The string "JAPANESE_HIRAGANA", for use with the - IME.conversionMode property.
-		IMEConversionMode
  JAPANESE_KATAKANA_FULL : String = "JAPANESE_KATAKANA_FULL"
[static] - The string "JAPANESE_KATAKANA_FULL", for use with the - IME.conversionMode property.
-		IMEConversionMode
  JAPANESE_KATAKANA_HALF : String = "JAPANESE_KATAKANA_HALF"
[static] - The string "JAPANESE_KATAKANA_HALF", for use with the - IME.conversionMode property.
-		IMEConversionMode
  KOREAN : String = "KOREAN"
[static] - The string "KOREAN", for use with the - IME.conversionMode property.
-		IMEConversionMode
  UNKNOWN : String = "UNKNOWN"
[static] - The string "UNKNOWN", which can be returned by a call to - the IME.conversionMode property.
-		IMEConversionMode
-
- -
- -
Constant detail
- - - - - -
ALPHANUMERIC_FULLconstant
-
-public static const ALPHANUMERIC_FULL:String = "ALPHANUMERIC_FULL" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The string "ALPHANUMERIC_FULL", for use with the - IME.conversionMode property. - This constant is used with all IMEs. - Use the syntax IMEConversionMode.ALPHANUMERIC_FULL. -

-See also -

-
-flash.system.IME.conversionMode -
-
- - - - - -
ALPHANUMERIC_HALFconstant 
-
-public static const ALPHANUMERIC_HALF:String = "ALPHANUMERIC_HALF" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The string "ALPHANUMERIC_HALF", for use with the - IME.conversionMode property. - This constant is used with all IMEs. - Use the syntax IMEConversionMode.ALPHANUMERIC_HALF. - -

-See also -

-
-flash.system.IME.conversionMode -
-
- - - - - -
CHINESEconstant 
-
-public static const CHINESE:String = "CHINESE" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The string "CHINESE", for use with the - IME.conversionMode property. - This constant is used with simplified and traditional Chinese IMEs. - Use the syntax IMEConversionMode.CHINESE. -

-See also -

-
-flash.system.IME.conversionMode -
-
- - - - - -
JAPANESE_HIRAGANAconstant 
-
-public static const JAPANESE_HIRAGANA:String = "JAPANESE_HIRAGANA" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The string "JAPANESE_HIRAGANA", for use with the - IME.conversionMode property. - This constant is used with Japanese IMEs. - Use the syntax IMEConversionMode.JAPANESE_HIRAGANA. - -

-See also -

-
-flash.system.IME.conversionMode -
-
- - - - - -
JAPANESE_KATAKANA_FULLconstant 
-
-public static const JAPANESE_KATAKANA_FULL:String = "JAPANESE_KATAKANA_FULL" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The string "JAPANESE_KATAKANA_FULL", for use with the - IME.conversionMode property. - This constant is used with Japanese IMEs. - Use the syntax IMEConversionMode.JAPANESE_KATAKANA_FULL. - -

-See also -

-
-flash.system.IME.conversionMode -
-
- - - - - -
JAPANESE_KATAKANA_HALFconstant 
-
-public static const JAPANESE_KATAKANA_HALF:String = "JAPANESE_KATAKANA_HALF" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The string "JAPANESE_KATAKANA_HALF", for use with the - IME.conversionMode property. - This constant is used with Japanese IMEs. - Use the syntax IMEConversionMode.JAPANESE_KATAKANA_HALF. -

-See also -

-
-flash.system.IME.conversionMode -
-
- - - - - -
KOREANconstant 
-
-public static const KOREAN:String = "KOREAN" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The string "KOREAN", for use with the - IME.conversionMode property. - This constant is used with Korean IMEs. - Use the syntax IMEConversionMode.KOREAN. -

-See also -

-
-flash.system.IME.conversionMode -
-
- - - - - -
UNKNOWNconstant 
-
-public static const UNKNOWN:String = "UNKNOWN" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The string "UNKNOWN", which can be returned by a call to - the IME.conversionMode property. This value cannot be set, - and is returned only if the player is unable to identify the currently - active IME. - Use the syntax IMEConversionMode.UNKNOWN. -

-See also -

-
-flash.system.IME.conversionMode -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/ImageDecodingPolicy.html b/html-docs/flash/system/ImageDecodingPolicy.html deleted file mode 100644 index ffb0d23..0000000 --- a/html-docs/flash/system/ImageDecodingPolicy.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - -flash.system.ImageDecodingPolicy (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class ImageDecodingPolicy
InheritanceImageDecodingPolicy Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

-

- The ImageDecodingPolicy class provides values for imageDecodingPolicy in the LoaderContext class. - - -

-

-See also -

-
-flash.system.LoaderContext -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  ON_DEMAND : String = "onDemand"
[static] - Constant; specifies that the image being loaded will be decoded when needed and that the decoded data may be flushed at will by the system.
-		ImageDecodingPolicy
  ON_LOAD : String = "onLoad"
[static] - Constant; specifies that the image being loaded will be decoded on load, prior to the complete event being sent.
-		ImageDecodingPolicy
-
- -
- -
Constant detail
- - - - - -
ON_DEMANDconstant
-
-public static const ON_DEMAND:String = "onDemand" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- Constant; specifies that the image being loaded will be decoded when needed and that the decoded data may be flushed at will by the system. If flushed, it will be re-decoded as needed. - Use the syntax ImageDecodingPolicy.ON_DEMAND. -

-See also -

-
-flash.system.LoaderContext.imageDecodingPolicy -
-
- - - - - -
ON_LOADconstant 
-
-public static const ON_LOAD:String = "onLoad" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- Constant; specifies that the image being loaded will be decoded on load, prior to the complete event being sent. The decoded image data is cached, and may be flushed at will by the system. If flushed, it will be re-decoded as needed. - Use the syntax ImageDecodingPolicy.ON_LOAD. -

-See also -

-
-flash.system.LoaderContext.imageDecodingPolicy -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/JPEGLoaderContext.html b/html-docs/flash/system/JPEGLoaderContext.html deleted file mode 100644 index 8a4ea3b..0000000 --- a/html-docs/flash/system/JPEGLoaderContext.html +++ /dev/null @@ -1,382 +0,0 @@ - - - - - - - - -flash.system.JPEGLoaderContext (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic class JPEGLoaderContext
InheritanceJPEGLoaderContext Inheritance LoaderContext Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The JPEGLoaderContext class includes a property for enabling a deblocking filter when loading a JPEG image. - The deblocking filter improves an image's quality at higher compression settings by smoothing neighboring pixels. - To apply deblocking when loading a JPEG image, create a JPEGLoaderContext object, and set its - deblockingFilter property. Then use the JPEGLoaderContext object name as the value of the - context parameter of the load() method of the Loader object used to load the image. -

The JPEGLoaderContext class extends the LoaderContext class. Set the checkPolicyFile - property to true if you need programmatic access to the pixels of the loaded image - (for example, if you're using the BitmapData.draw() method). Setting the checkPolicyFile - property is not necessary for AIR content running in the application sandbox.

-

-

-See also -

-
-flash.display.Loader.load() -
-flash.display.BitmapData.draw() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedallowCodeImport : Boolean -
- Specifies whether you can use a Loader object to import content with executable code, - such as a SWF file, into the caller's security sandbox.
-		LoaderContext
 InheritedallowLoadBytesCodeExecution : Boolean -
- Legacy property, replaced by allowCodeImport, but still supported for compatibility.
-		LoaderContext
 InheritedapplicationDomain : ApplicationDomain = null
- Specifies the application domain to use for the Loader.load() or - Loader.loadBytes() method.
-		LoaderContext
 InheritedcheckPolicyFile : Boolean = false
- Specifies whether the application should attempt to download a URL policy file from the - loaded object's server before beginning to load the object itself.
-		LoaderContext
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  deblockingFilter : Number = 0.0
- Specifies the strength of the deblocking filter.
-		JPEGLoaderContext
 InheritedimageDecodingPolicy : String -
- Specifies whether to decode bitmap image data when it is used or when it is loaded.
-		LoaderContext
 Inheritedparameters : Object -
- An Object containing the parameters to pass to the LoaderInfo object of the content.
-		LoaderContext
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 InheritedrequestedContentParent : DisplayObjectContainer -
- The parent to which the Loader will attempt to add the loaded content.
-		LoaderContext
 InheritedsecurityDomain : SecurityDomain = null
- Specifies the security domain to use for a Loader.load() operation.
-		LoaderContext
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-JPEGLoaderContext(deblockingFilter:Number = 0.0, checkPolicyFile:Boolean = false, applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null)
-
- Creates a new JPEGLoaderContext object with the specified settings.
-		JPEGLoaderContext
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
deblockingFilterproperty
-
-public var deblockingFilter:Number = 0.0 -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the strength of the deblocking filter. A value of 1.0 - applies a full strength deblocking filter, a value of 0.0 disables the deblocking filter. - -

- -
Constructor detail
- - - - - -
JPEGLoaderContext()constructor
-
-public function JPEGLoaderContext(deblockingFilter:Number = 0.0, checkPolicyFile:Boolean = false, applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new JPEGLoaderContext object with the specified settings. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
deblockingFilter:Number (default = 0.0) — Specifies the strength of the deblocking filter. A value of 1.0 - applies a full strength deblocking filter, a value of 0.0 disables the deblocking filter. -
 
checkPolicyFile:Boolean (default = false) — Specifies whether Flash Player should check for the existence - of a URL policy file before loading the object. Does not apply for AIR content running in the application sandbox. - -
 
applicationDomain:ApplicationDomain (default = null) — Specifies the ApplicationDomain object to use for a Loader object. - -
 
securityDomain:SecurityDomain (default = null) — Specifies the SecurityDomain object to use for a Loader object. -
-

-See also -

-
-flash.system.LoaderContext -
-flash.display.Loader.load() -
-flash.display.Loader.loadBytes() -
-flash.system.ApplicationDomain -
-flash.system.SecurityDomain -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/LoaderContext.html b/html-docs/flash/system/LoaderContext.html deleted file mode 100644 index d9ba23b..0000000 --- a/html-docs/flash/system/LoaderContext.html +++ /dev/null @@ -1,853 +0,0 @@ - - - - - - - - -flash.system.LoaderContext (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.system
Classpublic class LoaderContext
InheritanceLoaderContext Inheritance Object
SubclassesJPEGLoaderContext
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The LoaderContext class provides options for loading SWF files and other media by using the Loader class. - The LoaderContext class is used as the context parameter in the load() and - loadBytes() methods of the Loader class. -

When loading SWF files with the Loader.load() method, you have two decisions to make: - into which security domain the loaded SWF file should be placed, and into which application domain - within that security domain? For more details on these choices, see the - applicationDomain and securityDomain properties.

-

When loading a SWF file with the Loader.loadBytes() method, you have the same - application domain choice to make as for Loader.load(), but it's not - necessary to specify a security domain, because Loader.loadBytes() always - places its loaded SWF file into the security domain of the loading SWF file.

- -

When loading images (JPEG, GIF, or PNG) instead of SWF files, there is no need to - specify a SecurityDomain or an application domain, because those concepts are - meaningful only for SWF files. Instead, you have only one decision to make: do you need - programmatic access to the pixels of the loaded image? If so, see the - checkPolicyFile property. If you want to apply deblocking when loading - an image, use the JPEGLoaderContext class instead of the LoaderContext class.

-

-

-See also -

-
-flash.display.Loader.load() -
-flash.display.Loader.loadBytes() -
-flash.system.ApplicationDomain -
-flash.system.JPEGLoaderContext -
-flash.system.LoaderContext.applicationDomain -
-flash.system.LoaderContext.checkPolicyFile -
-flash.system.LoaderContext.securityDomain -
-flash.system.SecurityDomain -
-flash.system.ImageDecodingPolicy -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  allowCodeImport : Boolean -
- Specifies whether you can use a Loader object to import content with executable code, - such as a SWF file, into the caller's security sandbox.
-		LoaderContext
  allowLoadBytesCodeExecution : Boolean -
- Legacy property, replaced by allowCodeImport, but still supported for compatibility.
-		LoaderContext
  applicationDomain : ApplicationDomain = null
- Specifies the application domain to use for the Loader.load() or - Loader.loadBytes() method.
-		LoaderContext
  checkPolicyFile : Boolean = false
- Specifies whether the application should attempt to download a URL policy file from the - loaded object's server before beginning to load the object itself.
-		LoaderContext
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  imageDecodingPolicy : String -
- Specifies whether to decode bitmap image data when it is used or when it is loaded.
-		LoaderContext
  parameters : Object -
- An Object containing the parameters to pass to the LoaderInfo object of the content.
-		LoaderContext
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  requestedContentParent : DisplayObjectContainer -
- The parent to which the Loader will attempt to add the loaded content.
-		LoaderContext
  securityDomain : SecurityDomain = null
- Specifies the security domain to use for a Loader.load() operation.
-		LoaderContext
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-LoaderContext(checkPolicyFile:Boolean = false, applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null)
-
- Creates a new LoaderContext object, with the specified settings.
-		LoaderContext
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
allowCodeImportproperty
-
-public var allowCodeImport:Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.0 -
-

- Specifies whether you can use a Loader object to import content with executable code, - such as a SWF file, into the caller's security sandbox. There are two affected importing operations: - the Loader.loadBytes() method, and the Loader.load() method with - LoaderContext.securityDomain = SecurityDomain.currentDomain. (The latter operation is not - supported in the AIR application sandbox.) With the allowCodeImport property set to - false, these importing operations are restricted to safe operations, such as loading - images. Normal, non-importing SWF file loading with the Loader.load() method is not - affected by the value of this property. -

This property is useful when you want to import image content into your sandbox - for example, when you - want to replicate or process an image from a different domain - but you don't want to take the security risk - of receiving a SWF file when you expected only an image file. Since SWF files may contain ActionScript code, - importing a SWF file is a much riskier operation than importing an image file.

-

In AIR content in the application sandbox, the default value is false. In non-application - content (which includes all content in Flash Player), the default value is true.

-

The allowCodeImport property was added in Flash Player 10.1 and AIR 2.0. - However, this property is made available to SWF files and AIR applications of all versions when the - Flash Runtime supports it.

-

-See also -

-
-flash.display.Loader.loadBytes() -
-flash.display.Loader.load() -
-securityDomain -
-
- - - - - -
allowLoadBytesCodeExecutionproperty 
-
-allowLoadBytesCodeExecution:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Legacy property, replaced by allowCodeImport, but still supported for compatibility. - Previously, the only operation affected by allowLoadBytesCodeExecution was the - Loader.loadBytes() method, but as of Flash Player 10.1 and AIR 2.0, the import-loading - operation of Loader.load() with LoaderContext.securityDomain = SecurityDomain.currentDomain - is affected as well. (The latter operation is not supported in the AIR application sandbox.) - This dual effect made the property name allowLoadBytesCodeExecution overly specific, - so now allowCodeImport is the preferred property name. Setting either of - allowCodeImport or allowLoadBytesCodeExecution will affect the value of both. -

Specifies whether you can use a Loader object to import content with executable code, - such as a SWF file, into the caller's security sandbox. With this property set to false, - these importing operations are restricted to safe operations, such as loading images.

-

In AIR content in the application sandbox, the default value is false. In non-application content, the - default value is true.

- Implementation -
-    public function get allowLoadBytesCodeExecution():Boolean -
-    public function set allowLoadBytesCodeExecution(value:Boolean):void -
-

-See also -

-
-flash.display.Loader.loadBytes() -
-
- - - - - -
applicationDomainproperty 
-
-public var applicationDomain:ApplicationDomain = null -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies the application domain to use for the Loader.load() or - Loader.loadBytes() method. Use this property only when loading a SWF file - written in ActionScript 3.0 (not an image or a SWF file written in ActionScript 1.0 or ActionScript 2.0). -

Every security domain is divided into one or more application domains, represented - by ApplicationDomain objects. Application domains are not for security - purposes; they are for managing cooperating units of ActionScript code. If you are - loading a SWF file from another domain, and allowing it to be placed in a separate - security domain, then you cannot control the choice of application domain into which the - loaded SWF file is placed; and if you have specified a choice of application domain, it - will be ignored. However, if you are loading a SWF file into your own security domain — - either because the SWF file comes from your own domain, or because you are importing it into - your security domain — then you can control the choice of application domain for the - loaded SWF file.

-

You can pass an application domain only from your own security domain in - LoaderContext.applicationDomain. Attempting to pass an application domain - from any other security domain results in a SecurityError exception.

- -

You have four choices for what kind of ApplicationDomain property to use:

-
    -
  • Child of loader's ApplicationDomain. The default. You can - explicitly represent this choice with the syntax - new ApplicationDomain(ApplicationDomain.currentDomain). This allows the - loaded SWF file to use the parent's classes directly, for example by writing - new MyClassDefinedInParent(). The parent, however, cannot use this syntax; - if the parent wishes to use the child's classes, it must call - ApplicationDomain.getDefinition() to retrieve them. The advantage of - this choice is that, if the child defines a class with the same name as a class already - defined by the parent, no error results; the child simply inherits the parent's - definition of that class, and the child's conflicting definition goes unused unless - either child or parent calls the ApplicationDomain.getDefinition() method to retrieve - it.
    • -
  • Loader's own ApplicationDomain. You use this application domain when using - ApplicationDomain.currentDomain. When the load is complete, parent and - child can use each other's classes directly. If the child attempts to define a class with the same name - as a class already defined by the parent, the parent class is used and the child class is ignored.
    • -
  • Child of the system ApplicationDomain. You use this application domain when using - new ApplicationDomain(null). This separates loader and loadee entirely, - allowing them to define separate versions of classes with the same name without conflict - or overshadowing. The only way either side sees the other's classes is by calling the - ApplicationDomain.getDefinition() method.
    • -
  • Child of some other ApplicationDomain. Occasionally you may have - a more complex ApplicationDomain hierarchy. You can load a SWF file into any - ApplicationDomain from your own SecurityDomain. For example, - new ApplicationDomain(ApplicationDomain.currentDomain.parentDomain.parentDomain) - loads a SWF file into a new child of the current domain's parent's parent.
    • -
-

When a load is complete, either side (loading or loaded) may need to find its own - ApplicationDomain, or the other side's ApplicationDomain, for the purpose of calling - ApplicationDomain.getDefinition(). Either side can retrieve a reference to - its own application domain by using ApplicationDomain.currentDomain. The loading - SWF file can retrieve a reference to the loaded SWF file's ApplicationDomain via - Loader.contentLoaderInfo.applicationDomain. If the loaded SWF file knows how it - was loaded, it can find its way to the loading SWF file's ApplicationDomain object. For example, if - the child was loaded in the default way, it can find the loading SWF file's application domain - by using ApplicationDomain.currentDomain.parentDomain.

-

For more information, see the "ApplicationDomain class" section of the "Client System - Environment" chapter of the ActionScript 3.0 Developer's Guide.

- -

-See also -

-
-flash.display.Loader.load() -
-flash.display.Loader.loadBytes() -
-flash.system.ApplicationDomain -
-
- - - - - -
checkPolicyFileproperty 
-
-public var checkPolicyFile:Boolean = false -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies whether the application should attempt to download a URL policy file from the - loaded object's server before beginning to load the object itself. This flag is applicable to - the Loader.load() method, but not to the Loader.loadBytes() method. -

Set this flag to true when you are loading an image (JPEG, GIF, or PNG) from outside the calling - SWF file's own domain, and you expect to need access to the content of that image from ActionScript. - Examples of accessing image content include referencing the Loader.content property - to obtain a Bitmap object, and calling the BitmapData.draw() method to obtain a - copy of the loaded image's pixels. If you attempt one of these operations without having - specified checkPolicyFile at loading time, you may get a SecurityError - exception because the needed policy file has not been downloaded yet.

-

When you call the Loader.load() method with LoaderContext.checkPolicyFile set to - true, the application does not begin downloading the specified object in URLRequest.url - until it has either successfully downloaded a relevant URL policy file or discovered - that no such policy file exists. Flash Player or AIR first considers policy files that have already - been downloaded, then attempts to download any pending policy files specified in calls to - the Security.loadPolicyFile() method, then attempts to download a policy file from the default - location that corresponds to URLRequest.url, which is /crossdomain.xml - on the same server as URLRequest.url. In all cases, the given policy file is required to exist - at URLRequest.url by virtue of the policy file's location, and the file must permit access - by virtue of one or more <allow-access-from> - tags.

-

If you set checkPolicyFile to true, the main download that specified in the - Loader.load() method does not load until the policy file has been completely processed. - Therefore, as long as the - policy file that you need exists, as soon as you have received any ProgressEvent.PROGRESS or - Event.COMPLETE events from the contentLoaderInfo property of your Loader object, - the policy file download is complete, and you can safely begin performing operations that require - the policy file.

-

If you set checkPolicyFile to true, and no relevant policy file is found, - you will not receive any error indication until you attempt an operation that throws a - SecurityError exception. However, once the LoaderInfo object dispatches a - ProgressEvent.PROGRESS or Event.COMPLETE event, you can test whether a relevant - policy file was found by checking the value of the LoaderInfo.childAllowsParent property.

-

If you will not need pixel-level access to the image that you are loading, you should not set the - checkPolicyFile property to true. Checking for a policy file in this case is - wasteful, because it may delay the start of your download, and it may consume network bandwidth unnecessarily.

-

Also try to avoid setting checkPolicyFile to true if you are using the - Loader.load() method to download a SWF file. This is because SWF-to-SWF permissions are not - controlled by policy files, but rather by the Security.allowDomain() method, and thus - checkPolicyFile has no effect when you load a SWF file. Checking for a policy file in - this case is wasteful, because it may delay the download of the SWF file, and it may consume - network bandwidth unnecessarily. (Flash Player or AIR cannot tell whether your main download will be a - SWF file or an image, because the policy file download occurs before the main download.)

-

Be careful with checkPolicyFile if you are downloading an object from a URL that - may use server-side HTTP redirects. Policy files are always retrieved from the corresponding initial - URL that you specify in URLRequest.url. If the final - object comes from a different URL because of HTTP redirects, then the initially downloaded policy - files might not be applicable to the object's final URL, which is the URL that matters in - security decisions. If you find yourself in this situation, you can examine the value of - LoaderInfo.url after you have received a ProgressEvent.PROGRESS - or Event.COMPLETE event, which tells you the object's final URL. Then call the - Security.loadPolicyFile() method with a policy file URL based on the object's final - URL. Then poll the value of LoaderInfo.childAllowsParent until it becomes true.

-

You do not need to set this property for AIR content running in the application sandbox. Content - in the AIR application sandbox can call the BitmapData.draw() method using any loaded image - content as the source.

-

-See also -

-
-flash.display.BitmapData.draw() -
-flash.display.Loader.content -
-flash.display.Loader.load() -
-flash.display.LoaderInfo.childAllowsParent -
-flash.display.LoaderInfo.url -
-flash.system.Security.allowDomain() -
-flash.system.Security.loadPolicyFile() -
-
- - - - - -
imageDecodingPolicyproperty 
-
-public var imageDecodingPolicy:String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.6 -
-

- Specifies whether to decode bitmap image data when it is used or when it is loaded. - -

Under the default policy, ImageDecodingPolicy.ON_DEMAND, the runtime decodes the image data - when the data is needed (for display or some other purpose). This policy maintains the decoding behavior used - by previous versions of the runtime.

-

Under the ImageDecodingPolicy.ON_LOAD policy, the runtime decodes the image immediately after - it is loaded and before dispatching the complete event. Decoding images on load rather than on demand can - improve animation and user interface performance. You can see improvements when several loaded images are displayed in quick succession. - Some examples of a rapid display of images are scrolling lists, or cover flow control. - On the other hand, using the onLoad policy indiscriminately can increase - the peak memory usage of your application. More decoded image data could be in memory at one time than would - be the case under the onDemand policy.

- -

Under both policies, the runtime uses the same cache and flush behavior after the image is decoded. - The runtime can flush the decoded data at any time and decode the image again the next time - it is required.

-

To set the image decoding policy (for example, to ON_LOAD): - 

-     var loaderContext:LoaderContext = new LoaderContext(); 
-     loaderContext.imageDecodingPolicy = ImageDecodingPolicy.ON_LOAD 
-     var loader:Loader = new Loader(); 
-     loader.load(new URLRequest("http://www.adobe.com/myimage.png"), loaderContext);
-
-

-

-See also -

-
-flash.system.ImageDecodingPolicy -
-
- - - - - -
parametersproperty 
-
-public var parameters:Object -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- An Object containing the parameters to pass to the LoaderInfo object of the content. - -

Normally, the value of the contentLoaderInfo.parameters property is obtained by parsing the requesting URL. - If the parameters var is set, the contentLoaderInfo.parameters gets its value from the LoaderContext object, instead of from - the requesting URL. The parameters var accepts only objects containing name-value string pairs, similar to URL parameters. If the object does - not contain name-value string pairs, an IllegalOperationError is thrown.

-

The intent of this API is to enable the loading SWF file to forward its parameters to a loaded SWF file. - This functionality is especially helpful when you use the loadBytes() method, since LoadBytes does not provide a - means of passing parameters through the URL. Parameters can be forwarded successfully only to another AS3 SWF file; an AS1 or AS2 SWF file cannot receive the parameters in an - accessible form, although the AVM1Movie's AS3 loaderInfo.parameters object will be the forwarded object.

-

For example, consider the following URL:

-

http://yourdomain/users/jdoe/test01/child.swf?foo=bar;

-

The following code uses the LoaderContext.parameters property to replicate a parameter passed to this URL:

- 
-      import flash.system.LoaderContext; 
-      import flash.display.Loader; 
-      var l:Loader = new Loader(); 
-      var lc:LoaderContext = new LoaderContext; 
-      lc.parameters = { "foo": "bar" }; 
-      l.load(new URLRequest("child.swf"), lc);
-
-

To verify that the parameter passed properly, use the following trace statement after you run this code:

-

trace(loaderInfo.parameters.foo);

-

If the content loaded successfully, this trace prints "bar".

-
- - - - - -
requestedContentParentproperty 
-
-public var requestedContentParent:DisplayObjectContainer -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- The parent to which the Loader will attempt to add the loaded content. - -

When content is completely loaded, the Loader object normally becomes the parent of the content. - If requestedContentParent is set, the object that it specifies becomes the parent, unless a runtime error prevents the assignment. - This reparenting can also be done after the complete event without use of this property. However, specifying the - parent with LoaderContext.requestedContentParent eliminates extra events.

-

LoaderContext.requestedContentParent sets the desired parent before frame one scripts in - the loaded content execute, but after the constructor has run. If requestedContentParent is null (the default), - the Loader object becomes the content's parent.

-

If the loaded content is an AVM1Movie object, or if an - error is thrown when addChild() is called on the requestedContentParent object, then the following actions occur: -

  • The Loader object becomes the parent of the loaded content.
    • -
  • The runtime dispatches an AsyncErrorEvent.

-

If the requested parent and the loaded content are in different security sandboxes, and if the requested parent does not have access - to the loaded content, then the following actions occur: -

  • The Loader becomes the parent of the loaded content.
    • -
  • The runtime dispatches a SecurityErrorEvent.

-

The following code uses requestedContentParent to place the loaded content into a Sprite object:

- 
-      import flash.system.LoaderContext; 
-      import flash.display.Loader; 
-      import flash.display.Sprite; 
-           var lc:LoaderContext = new LoaderContext(); 
-      var l:Loader = new Loader(); 
-      var s:Sprite = new Sprite(); 
-      lc.requestedContentParent = s; 
-      addChild(s); 
-      l.load(new URLRequest("child.swf"), lc);
-
- -

When this code runs, the child SWF file appears on stage. This fact confirms that the Sprite object you added to the stage is the - parent of the loaded child.swf file.

-
- - - - - -
securityDomainproperty 
-
-public var securityDomain:SecurityDomain = null -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 -
-

- Specifies the security domain to use for a Loader.load() operation. Use this property - only when loading a SWF file (not an image). -

The choice of security domain is meaningful only if you are loading a SWF file that might - come from a different domain (a different server) than the loading SWF file. When you load a - SWF file from your own domain, it is always placed into your security domain. But when you - load a SWF file from a different domain, you have two options. You can allow the loaded SWF file to - be placed in its "natural" security domain, which is different from that of the - loading SWF file; this is the default. The other option is to specify that you want to place the - loaded SWF file placed into the same security domain as the loading SWF file, by setting - myLoaderContext.securityDomain to be equal to SecurityDomain.currentDomain. This is - called import loading, and it is equivalent, for security purposes, to copying the - loaded SWF file to your own server and loading it from there. In order for import loading to - succeed, the loaded SWF file's server must have a policy file trusting the domain of the - loading SWF file.

-

You can pass your own security domain only in LoaderContext.securityDomain. - Attempting to pass any other security domain results in a SecurityError exception.

- -

Content in the AIR application security sandbox cannot load content from - other sandboxes into its SecurityDomain.

-

For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide.

-

-See also -

-
-flash.display.Loader.load() -
-flash.system.SecurityDomain -
-
- -
Constructor detail
- - - - - -
LoaderContext()constructor
-
-public function LoaderContext(checkPolicyFile:Boolean = false, applicationDomain:ApplicationDomain = null, securityDomain:SecurityDomain = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a new LoaderContext object, with the specified settings. For complete - details on these settings, see the descriptions of the properties of this class. - -

Parameters - - - - - - - - - - - - - - - - -
checkPolicyFile:Boolean (default = false) — Specifies whether a check should be made for the existence - of a URL policy file before loading the object. - -
 
applicationDomain:ApplicationDomain (default = null) — Specifies the ApplicationDomain object to use for a Loader object. - -
 
securityDomain:SecurityDomain (default = null) — Specifies the SecurityDomain object to use for a Loader object. -

Note: Content in the air application security sandbox cannot load content from - other sandboxes into its SecurityDomain.

-
-

-See also -

-
-flash.display.Loader.load() -
-flash.display.Loader.loadBytes() -
-flash.system.ApplicationDomain -
-flash.system.SecurityDomain -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/MessageChannel.html b/html-docs/flash/system/MessageChannel.html deleted file mode 100644 index 6348e97..0000000 --- a/html-docs/flash/system/MessageChannel.html +++ /dev/null @@ -1,1389 +0,0 @@ - - - - - - - - -flash.system.MessageChannel (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class MessageChannel
InheritanceMessageChannel Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

-

- - The MessageChannel class provides a mechanism for a worker to communicate - - with another worker. A message channel is a one-way - - communication channel. The message channel's sending worker uses the - - message channel to send objects to the receiving worker. A MessageChannel - - object is the only way to send a message between workers that dispatches - - an event indicating to the receiver that the message is available. Other - - mechanisms for sharing data allow a value to be set but do not provide an - - event to notify you of the changed data. - - -

Each MessageChannel object contains a queue of message objects sent - - from the sending worker to the receiving worker. Each call to - - send() adds an object to the queue. Each call to - - receive() retrieves the oldest message object from the queue.

- - -

You do not create MessageChannel instances directly by calling the - - MessageChannel() constructor. To create a MessageChannel - - instance, call the createMessageChannel() method of the - - Worker object that will send messages on the channel, passing the - - receiving Worker object as an argument.

- - -

The typical workflow for sending messages with a MessageChannel object - - is as follows:

- -
    - -

  1. Call the sending worker's createMessageChannel() - - method to create the message channel

    - - 
    -
-    // In the sending worker swf
-
-    var sendChannel:MessageChannel;
-
-    sendChannel = Worker.current.createMessageChannel(receivingWorker);
    - -
    2. - - - -

  2. Pass the message channel to the other worker, either by calling - - Worker.setSharedProperty() or by sending it through an existing message channel

    - - 
    -
-    receivingWorker.setSharedProperty("incomingChannel", sendChannel);
    - -
    3. - - - -

  3. Code in the receiving worker registers a listener with the - - MessageChannel object for the channelMessage event

    - - 
    -
-    // In the receiving worker swf
-
-    var incomingChannel:MessageChannel;
-
-    incomingChannel = Worker.current.getSharedProperty("incomingChannel");
-
-    incomingChannel.addEventListener(Event.CHANNEL_MESSAGE, handleIncomingMessage);
    - -
    4. - - - -

  4. Code in the sending worker sends a message by calling the - - send() method

    - - 
    -
-    // In the sending worker swf
-
-    sendChannel.send("This is a message");
    - -
    5. - - - -

  5. The runtime calls the event handler in the receiving worker code, - - indicating that a message has been sent

    - - 
    -
-    // In the receiving worker swf
-
-    // This method is called when the message channel gets a message
-
-    private function handleIncomingMessage(event:Event):void
-
-    {
-
-        // Do something with the message, as shown in the next code listing
-
-    }
    - -
    6. - - - -

  6. Code in the receiving worker calls the receive() - - method to get the message. The object returned by the - - receive() method has the same data type as the object - - passed to the send() method.

    - - 
    -
-    var message:String = incomingChannel.receive() as String;
    - -
    7. - -
- - -

In addition to the asynchronous workflow outlined above, you can use - - an alternative workflow with the receive() method to pause - - the code in the receiving worker and wait until a message is sent. See - - the receive() method description for more information.

- - -

The MessageChannel class is one of the special object types that are shared - - between workers rather than copied between them. When you pass a message channel - - from one worker to another worker either by calling the Worker object's - - setSharedProperty() method or by using a MessageChannel object, - - both workers have a reference to the same MessageChannel object in the runtime's memory.

- - -

-

-See also -

-
-Worker class -
-Worker.createMessageChannel() method -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  messageAvailable : Boolean -
[read-only] - - Indicates whether the MessageChannel has one or more messages from - - the sending worker in its internal message queue.
-		MessageChannel
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  state : String -
[read-only] - - Indicates the current state of the MessageChannel object (open, - - closing, or closed).
-		MessageChannel
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		MessageChannel
   -
-close():void -
-
- - Instructs the current MessageChannel to close once all messages have - - been received.
-		MessageChannel
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-receive(blockUntilReceived:Boolean = false):* -
-
- - Retrieves a single message object from the queue of messages sent - - through this message channel.
-		MessageChannel
   -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		MessageChannel
   -
-send(arg:*, queueLimit:int = -1):void -
-
- - Sends an object from the sending worker, adding it to the message - - queue for the receiving worker.
-		MessageChannel
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Returns the string representation of the specified object.
-		MessageChannel
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-channelMessage -
-		 - - Dispatched each time the sending worker calls this MessageChannel - - object's send() method, indicating that a new message object - - is available in the MessageChannel instance's queue.MessageChannel
   -
-channelState -
-		 - - Dispatched when the value of the message channel's state - - property changes.MessageChannel
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
messageAvailableproperty
-
-messageAvailable:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Indicates whether the MessageChannel has one or more messages from - - the sending worker in its internal message queue. - - -

Implementation -
-    public function get messageAvailable():Boolean -
-
- - - - - -
stateproperty 
-
-state:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Indicates the current state of the MessageChannel object (open, - - closing, or closed). The possible values for this property are - - defined as constants in the MessageChannelState class. - - - -

Implementation -
-    public function get state():String -
-

-See also -

-
-MessageChannelState class -
-
- -
Method detail
- - - - - -
addEventListener()method
-
-public override function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event. You can register event listeners on all nodes in the - display list for a specific type of event, phase, and priority. - -

JavaScript code in the AIR runtime uses this method to register - event listeners for events defined by the AIR APIs. For other JavaScript events (such as the onload - event of the DOM body object), you can use standard event handling techniques, as you would - for content running in the browser.

- -

After you successfully register an event listener, you cannot change its priority - through additional calls to addEventListener(). To change a listener's - priority, you must first call removeListener(). Then you can register the - listener again with the new priority level.

- -

Keep in mind that after the listener is registered, subsequent calls to - addEventListener() with a different type or - useCapture value result in the creation of a separate listener registration. - For example, if you first register a listener with useCapture set to - true, it listens only during the capture phase. If you call - addEventListener() again using the same listener object, but with - useCapture set to false, you have two separate listeners: one - that listens during the capture phase and another that listens during the target and - bubbling phases. -

- -

You cannot register an event listener for only the target phase or the bubbling - phase. Those phases are coupled during registration because bubbling - applies only to the ancestors of the target node.

- -

If you no longer need an event listener, remove it by calling - removeEventListener(), or memory problems could result. Event listeners are not automatically - removed from memory because the garbage - collector does not remove the listener as long as the dispatching object exists (unless the useWeakReference - parameter is set to true).

- -

Copying an EventDispatcher instance does not copy the event listeners attached to it. - (If your newly created node needs an event listener, you must attach the listener after - creating the node.) However, if you move an EventDispatcher instance, the event listeners - attached to it move along with it.

- - -

If the event listener is being registered on a node while an event is being processed - on this node, the event listener is not triggered during the current phase but can be - triggered during a later phase in the event flow, such as the bubbling phase.

- -

If an event listener is removed from a node while an event is being processed on the node, - it is still triggered by the current actions. After it is removed, the event listener is - never invoked again (unless registered again for future processing).

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener function that processes the event. This function must accept - an Event object as its only parameter and must return nothing, as this example shows: - . - - 
function(evt:Event):void
- -

The function can have any name.

- -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Determines whether the listener works in the capture phase or the - target and bubbling phases. If useCapture is set to true, - the listener processes the event only during the capture phase and not in the - target or bubbling phase. If useCapture is false, the - listener processes the event only during the target or bubbling phase. To listen for - the event in all three phases, call addEventListener twice, once with - useCapture set to true, then again with - useCapture set to false. - -
 
priority:int (default = 0) — The priority level of the event listener. The priority is designated by - a signed 32-bit integer. The higher the number, the higher the priority. All listeners - with priority n are processed before listeners of priority n-1. If two - or more listeners share the same priority, they are processed in the order in which they - were added. The default priority is 0. - -
 
useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or - weak. A strong reference (the default) prevents your listener from being garbage-collected. - A weak reference does not.

Class-level member functions are not subject to garbage - collection, so you can set useWeakReference to true for - class-level member functions without subjecting them to garbage collection. If you set - useWeakReference to true for a listener that is a nested inner - function, the function will be garbage-collected and no longer persistent. If you create - references to the inner function (save it in another variable) then it is not - garbage-collected and stays persistent.

-
-
- - - - - -
close()method 
-
-public function close():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Instructs the current MessageChannel to close once all messages have - - been received. - - -

Once you call this method, you can no longer call the - - send() method to add messages to the queue. The - - send() call will fail and return false.

- - - -

You can also only call the receive() method to - - receive messages that are already waiting in the queue. If the queue - - is empty, the receive() call will return null.

- - -
-Events - - - - -
channelState — dispatched when the - - close() method is called (which sets the - - state property is to MessageChannelState.CLOSING). - - Dispatched again when all the messages have been received and - - the state property is set to - - MessageChannelState.CLOSED.
-
- - - - - -
receive()method 
-
-public function receive(blockUntilReceived:Boolean = false):* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Retrieves a single message object from the queue of messages sent - - through this message channel. - - -

Each time the sending worker's code calls the MessageChannel - - object's send() method, a single object is added to the - - message channel's internal message queue. These objects stack up in - - the queue until they are removed one at a time by the receiving - - worker calling the receive() method. The message objects - - are received in the order they are sent.

- - -

To check if the queue contains a message object to receive, use - - the messageAvailable property.

- - - -

In the standard case, the object passed into send() - - is serialized in AMF3 format. When it is removed from the queue by - - the receive() call, it is deserialized into an - - ActionScript object (a copy of the original object) in the receiving - - worker and the worker receives a reference to that copy. Certain - - types of objects are shared between workers rather than copied. In - - that case the object that the receiving worker gets is a reference - - to the shared object itself rather than a new copy of the object. - - For more information about this case see the send() - - method description.

- - -

The method's behavior changes if the message queue is empty and - - you pass true for the blockUntilReceived - - parameter. In that case the worker pauses its execution thread at - - the receive() call and does not execute more code. Once - - the sending worker calls send(), the - - receive() call completes by receiving the message. The - - worker then resumes code execution at the next line of code following - - the receive call.

- - - Parameters - - - - -
blockUntilReceived:Boolean (default = false) — indicates whether the worker's execution - - thread should receive a message object and then continue - - execution (false), or if it should pause at the - - receive() call and wait for a message to be sent - - if the queue is empty (true) - - -
-

-Returns - - - - -
* — a copy of the object passed into the send() - - method by the sending worker. If the object is one of the - - special types that are shared between workers, the return - - value is a reference to the shared object rather than to a - - copy of it. If no message is available on the queue, the - - method returns null. - - - -
-
-Throws - - - - - - - - - - - - - - - - -
Error — if the channel is closed at the time the - - method is called or if the blockUntilReceived argument - - results in the execution being paused and the channel is then - - closed by another worker. - - -
 
ArgumentError — if the calling code is not in the receiving worker - - -
 
ScriptTimeoutError — if the method is called from - - code in the primordial worker in Flash Player and the - - blockUntilReceived argument causes the worker to pause - - longer than the script timeout limit (15 seconds by default) - - -
-

-See also -

-
-send() method -
-messageAvailable property -
-
- - - - - -
removeEventListener()method 
-
-public override function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect. - -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener object to remove. - -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Specifies whether the listener was registered for the capture phase or the - target and bubbling phases. If the listener was registered for both the capture phase and the - target and bubbling phases, two calls to removeEventListener() are required - to remove both, one call with useCapture() set to true, and another - call with useCapture() set to false. - -
-
- - - - - -
send()method 
-
-public function send(arg:*, queueLimit:int = -1):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Sends an object from the sending worker, adding it to the message - - queue for the receiving worker. - - -

The object passed to the arg parameter can be almost any - - object. Other than the exceptions noted below, any object that is passed - - to the arg parameter is not passed by reference. Any changes made to the - - object in one worker after send() is called are - - not carried over to the other worker. The object is copied by - - serializing it to AMF3 format and deserializing it into a new object - - in the receiving worker when receive() is called. - - For this reason, any object that can't be serialized in AMF3 format, - - including display objects, can't be passed to the arg parameter. - - In order for a custom class to be passed properly, the class definition - - must be registered using the flash.net.registerClassAlias() - - function or [RemoteClass] metadata. With either technique - - the same alias must be used for both worker's versions of the class.

- - - -

There are five types of objects that are an exception to the rule - - that objects aren't shared between workers:

- - -
    - -
  • Worker
    • - -
  • MessageChannel
    • - -
  • shareable ByteArray (a ByteArray object with its - - shareable property set to true)
    • - -
  • Mutex
    • - -
  • Condition
    • - -
- - - -

If you pass an instance of these objects to the arg - - parameter, each worker has a reference to the same underlying object. - - Changes made to an instance in one worker are immediately available - - in other workers. In addition, if you pass the same instance of these - - objects more than once using send(), the runtime doesn't - - create a new copy of the object in the receiving worker. Instead, the - - same reference is re-used, reducing system memory use.

- - -

By default, this method adds the object to the queue and immediately - - returns, continuing execution with the next line of code. If you want - - to prevent the queue from growing beyond a certain size, you can use - - the queueLimit parameter to specify the maximum number - - of items to allow in the queue. If at the time you call - - send() the number of items in the queue is greater than - - the limit you specify, the worker pauses the execution thread at the - - send() call. Once the receiving worker calls - - receive() enough times that the queue size is less than - - the specified queue limit, the send() call completes. The worker then - - continues execution at the next line of code.

- - - Parameters - - - - - - - - - - -
arg:* — the object to add to the message queue - - -
 
queueLimit:int (default = -1) — the maximum number of message objects that the - - message queue can contain. If the queue contains more objects - - than the limit, the sending worker pauses execution until - - messages are received and the queue size drops below the limit. - - - -
-
-Events - - - - -
channelMessage — dispatched to notify the - - receiving worker that a message object is available in the queue
-
-Throws - - - - - - - - - - - - - - - - -
Error — if the channel is closed at the time the - - method is called or if the queueLimit argument - - results in the execution being paused and the channel is then - - closed by another worker. - - -
 
ArgumentError — if the calling code is not in the sending worker - - -
 
ScriptTimeoutError — if the method is called from - - code in the primordial worker in Flash Player and the - - queueLimit argument causes the worker to pause - - longer than the script timeout limit (15 seconds by default) - - - -
-

-See also -

-
-receive() method -
-Worker class -
-ByteArray.shareable property -
-Mutex class -
-Condition class -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Returns the string representation of the specified object. - - -

Note: Methods of the Object class are dynamically created on Object's prototype. To redefine this method in a subclass of Object, do not use the override keyword. For example, a subclass of Object implements function toString():String instead of using an override of the base class.

- - -

-Returns - - - - -
String — - A string representation of the object. - - - - -
-
-
Event detail
- - - - - -
channelMessageevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CHANNEL_MESSAGE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Dispatched each time the sending worker calls this MessageChannel - - object's send() method, indicating that a new message object - - is available in the MessageChannel instance's queue. - - - -

- The Event.CHANNEL_MESSAGE constant defines the value of the type property of a channelMessage event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that dispatched this event.
-
- - - - - -
channelStateevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CHANNEL_STATE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Dispatched when the value of the message channel's state - - property changes. - - - -

- The Event.CHANNEL_STATE constant defines the value of the type property of a channelState event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that dispatched this event.
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/system/MessageChannelState.html b/html-docs/flash/system/MessageChannelState.html deleted file mode 100644 index 0ff657b..0000000 --- a/html-docs/flash/system/MessageChannelState.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - -flash.system.MessageChannelState (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class MessageChannelState
InheritanceMessageChannelState Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

-

- This class defines constants that represent the possible values for the - MessageChannel class's state property. These values are the - states in a MessageChannel object's lifecycle. -

-

-See also -

-
-MessageChannel class -
-MessageChannel.state property -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  CLOSED : String = "closed"
[static] - This state indicates that the message channel has been closed and - doesn't have any more messages to deliver.
-		MessageChannelState
  CLOSING : String = "closing"
[static] - This state indicates that the message channel has been instructed to - close and is in the process of delivering the remaining messages on - the channel.
-		MessageChannelState
  OPEN : String = "open"
[static] - This state indicates that the message channel is open and available for use.
-		MessageChannelState
-
- -
- -
Constant detail
- - - - - -
CLOSEDconstant
-
-public static const CLOSED:String = "closed" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- This state indicates that the message channel has been closed and - doesn't have any more messages to deliver. -

-See also -

-
-MessageChannel.state property -
-
- - - - - -
CLOSINGconstant 
-
-public static const CLOSING:String = "closing" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- This state indicates that the message channel has been instructed to - close and is in the process of delivering the remaining messages on - the channel. -

-See also -

-
-MessageChannel.state property -
-
- - - - - -
OPENconstant 
-
-public static const OPEN:String = "open" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- This state indicates that the message channel is open and available for use. -

-See also -

-
-MessageChannel.state property -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/Security.html b/html-docs/flash/system/Security.html deleted file mode 100644 index 3ac531f..0000000 --- a/html-docs/flash/system/Security.html +++ /dev/null @@ -1,1274 +0,0 @@ - - - - - - - - -flash.system.Security (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class Security
InheritanceSecurity Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The Security class lets you specify how content in different domains can communicate with - each other. - -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  exactSettings : Boolean -
[static] - Determines how Flash Player or AIR chooses the domain to use for certain - content settings, including settings for camera and microphone - permissions, storage quotas, and storage of persistent shared objects.
-		Security
  pageDomain : String -
[static][read-only] - The domain portion of the HTML page containing the swf.
-		Security
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  sandboxType : String -
[static][read-only] - Indicates the type of security sandbox in which the calling file is operating.
-		Security
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-allowDomain(... domains):void -
-
[static] - Lets SWF files in the identified domains access objects and variables - in the SWF file that contains the allowDomain() call.
-		Security
   -
-allowInsecureDomain(... domains):void -
-
[static] - Lets SWF files and HTML files in the identified domains access objects - and variables in the calling SWF file, which is hosted by means of the HTTPS protocol.
-		Security
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-loadPolicyFile(url:String):void -
-
[static] - Looks for a policy file at the location specified by the url - parameter.
-		Security
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-showSettings(panel:String = "default"):void -
-
[static] - Displays the Security Settings panel in Flash Player.
-		Security
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  APPLICATION : String = "application"
[static] - The file is running in an AIR application, and it was installed with the package (the AIR file) for that - application.
-		Security
  LOCAL_TRUSTED : String = "localTrusted"
[static] - The file is a local file and has been trusted by the user, - using either the Flash Player Settings Manager or a FlashPlayerTrust configuration - file.
-		Security
  LOCAL_WITH_FILE : String = "localWithFile"
[static] - The file is a local file, has not been trusted by the user, - and it is not a SWF file that was published with a networking designation.
-		Security
  LOCAL_WITH_NETWORK : String = "localWithNetwork"
[static] - The file is a local file, has not been trusted by the user, and it is a SWF - file that was published with a networking designation.
-		Security
  REMOTE : String = "remote"
[static] - The file is from an Internet URL and operates under domain-based sandbox rules.
-		Security
-
- -
- -
Property detail
- - - - - -
exactSettingsproperty
-
-exactSettings:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Determines how Flash Player or AIR chooses the domain to use for certain - content settings, including settings for camera and microphone - permissions, storage quotas, and storage of persistent shared objects. - To have the SWF file use the same settings that were used in Flash Player 6, - set exactSettings to false. -

This property is to be used in SWF content, not in - JavaScript code in AIR applications.

-

In Flash Player 6, the domain used for these player settings was based on - the trailing portion of the domain of the SWF file. If the domain of a SWF file - includes more than two segments, such as www.example.com, the first segment - of the domain ("www") is removed, and the remaining portion of the domain is used: - example.com. So, in Flash Player 6, www.example.com and store.example.com both - use example.com as the domain for these settings. Similarly, www.example.co.uk and - store.example.co.uk both use example.co.uk as the domain for these settings. - In Flash Player 7 and later, player settings are chosen by default - according to a SWF file's exact domain; for example, a SWF file from www.example.com - would use the player settings for www.example.com, and a SWF file from - store.example.com would use the separate player settings for - store.example.com.

-

When Security.exactSettings is set to true, Flash Player - or AIR uses exact domains for player settings. The default value for exactSettings is true. - If you change exactSettings from its default value, do so before any events - occur that require Flash Player or AIR to choose player settings — for example, - using a camera or microphone, or retrieving a persistent shared object.

-

If you previously published a version 6 SWF file and - created persistent shared objects from it, and you now need to - retrieve those persistent shared objects from that SWF file - after porting it to version 7 or later, or from a different SWF file of - version 7 or later, set Security.exactSettings to false - before calling SharedObject.getLocal().

-

Implementation -
-    public static function get exactSettings():Boolean -
-    public function set exactSettings(value:Boolean):void -
-
-Throws -
- - - - -
SecurityError — A Flash Player or AIR application already used the value of exactSettings - at least once in a decision about player settings. -
-
- - - - - -
pageDomainproperty 
-
-pageDomain:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- The domain portion of the HTML page containing the swf. - -

For security reasons, the method does not return the full URL, only the page - domain, such as http://www.example.com. If this SWF is not contained in an HTML page, - or cannot access the page domain for security reasons, this property returns the string, - undefined.

- Implementation -
-    public static function get pageDomain():String -
-
- - - - - -
sandboxTypeproperty 
-
-sandboxType:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates the type of security sandbox in which the calling file is operating. -

Security.sandboxType has one of the following values:

- -
    -
  • remote (Security.REMOTE)—This file is from an Internet URL and operates under domain-based sandbox - rules.
    • -
  • localWithFile (Security.LOCAL_WITH_FILE)—This file is a local file, has not been trusted by the user, and - it is not a SWF file that was published with a networking designation. The file may read from local data sources but may - not communicate with the Internet.
    • -
  • localWithNetwork (Security.LOCAL_WITH_NETWORK)—This SWF file is a local file, has not been trusted by the user, and - was published with a networking designation. The SWF file can communicate with the Internet but cannot - read from local data sources.
    • -
  • localTrusted (Security.LOCAL_TRUSTED)—This file is a local file and has been trusted by - the user, using either the Flash Player Settings Manager or a FlashPlayerTrust configuration file. The file can read from local data - sources and communicate with the Internet.
    • -
  • application (Security.APPLICATION)—This file is - running in an AIR application, and it was installed with the package (AIR file) for that - application. By default, files in the AIR application sandbox can cross-script any file from any domain - (although files outside the AIR application sandbox may not be permitted to cross-script the AIR file). - By default, files in the AIR application sandbox can load content and data from any domain.
    • - -
-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- - Implementation -
-    public static function get sandboxType():String -
-

-See also -

-
-REMOTE -
-LOCAL_WITH_FILE -
-LOCAL_WITH_NETWORK -
-LOCAL_TRUSTED -
-APPLICATION -
-
- -
Method detail
- - - - - -
allowDomain()method
-
-public static function allowDomain(... domains):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Lets SWF files in the identified domains access objects and variables - in the SWF file that contains the allowDomain() call. - -

This method applies to cross-scripting of ActionScript 3.0 code - (in SWF content). It does not apply to JavaScript code running in HTML-based AIR applications.

- -

Note: Calling this method from code in the AIR application sandbox - throws a SecurityError exception. Content outside of the application security domain cannot directly - cross-script content in the application sandbox. However, content outside of the application sandbox can - communicate with content in the application security sandbox using a sandbox bridge.

- -

If two SWF files are served from the same domain — for example, http://mysite.com/swfA.swf and - http://mysite.com/swfB.swf — then swfA.swf can examine and modify variables, objects, properties, - methods, and so on in swfB.swf, and swfB.swf can do the same for swfA.swf. This is called cross-movie - scripting or cross-scripting.

-

If two SWF files are served from different domains — for example, http://siteA.com/swfA.swf and - http://siteB.com/siteB.swf — then, by default, Flash Player does not allow swfA.swf to script - swfB.swf, nor swfB.swf to script swfA.swf. A SWF file gives permission to SWF files from other domains - by calling Security.allowDomain(). This is - called cross-domain scripting. By calling Security.allowDomain("siteA.com"), siteB.swf - gives siteA.swf permission to script it.

-

In any cross-domain situation, it is important to be clear about the two parties involved. - For the purposes of this discussion, the side performing the cross-scripting - is called the accessing party (usually the accessing SWF), and the other side is called the party being accessed - (usually the SWF file being accessed). When siteA.swf scripts siteB.swf, - siteA.swf is the accessing party, and siteB.swf is the party being accessed.

- -

Cross-domain diagram

-

Cross-domain permissions that are established with allowDomain() are asymmetrical. - In the previous example, siteA.swf can script siteB.swf, but siteB.swf cannot script siteA.swf, - because siteA.swf has not called allowDomain() to give SWF files at siteB.com permission - to script it. You can set up symmetrical permissions by having both SWF files call - allowDomain().

-

In addition to protecting SWF files from cross-domain scripting originated by other SWF files, Flash Player - protects SWF files from cross-domain scripting originated by HTML files. HTML-to-SWF scripting can - occur with older browser functions such as SetVariable or callbacks - established through ExternalInterface.addCallback(). When HTML-to-SWF scripting crosses - domains, the SWF file being accessed must call allowDomain(), - just as when the accessing party is a SWF file, or the operation will fail.

-

Specifying an IP address as a parameter to allowDomain() - does not permit access by all parties that originate at the specified IP address. - Instead, it permits access only by a party that contains the specified IP address it its URL, - rather than a domain name that maps to that IP address.

-

Version-specific differences

-

Flash Player's cross-domain security rules have evolved from version to version. - The following table summarizes the differences.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Latest SWF version involved in cross-scriptingallowDomain() needed?allowInsecureDomain() needed?Which SWF file must call allowDomain() or allowInsecureDomain()?What can be specified in allowDomain() or allowInsecureDomain()?
5 or earlierNoNoN/AN/A
6Yes, if superdomains don't matchNoThe SWF file being accessed, or any SWF file with the same superdomain as the SWF file being accessed
    -
  • Text-based domain (mysite.com)
    • -
  • IP address (192.168.1.1)
    • -
7Yes, if domains don't match exactlyYes, if performing HTTP-to-HTTPS access (even if domains match exactly)The SWF file being accessed, or any SWF file with exactly the same domain as the SWF file being accessed
    -
  • Text-based domain (mysite.com)
    • -
  • IP address (192.168.1.1)
    • -
8 or laterYes, if domains don't match exactlyYes, if performing HTTP-to-HTTPS access (even if domains match exactly)SWF file being accessed
    -
  • Text-based domain (mysite.com)
    • -
  • IP address (192.168.1.1)
    • -
  • Wildcard (*)
    • -
- -

The versions that control the behavior of Flash Player are SWF versions - (the published version of a SWF file), not the version of Flash Player itself. - For example, when Flash Player 8 is playing a SWF file published for version 7, it - applies behavior that is consistent with version 7. This practice ensures that player upgrades do not - change the behavior of Security.allowDomain() in deployed SWF files.

-

The version column in the previous table shows the latest SWF version involved in a cross-scripting - operation. Flash Player determines its behavior according to either the accessing SWF file's - version or the version of the SWF file that is being accessed, whichever is later.

-

The following paragraphs provide more detail about Flash Player security changes involving - Security.allowDomain().

-

Version 5. There are no cross-domain scripting restrictions.

-

Version 6. Cross-domain scripting security is introduced. By default, Flash Player forbids - cross-domain scripting; Security.allowDomain() can permit it. To determine whether two files are - in the same domain, Flash Player uses each file's superdomain, which is the exact host name from the - file's URL, minus the first segment, down to a minimum of two segments. For example, the superdomain of - www.mysite.com is mysite.com. SWF files from www.mysite.com and - store.mysite.com to script each other without a call to Security.allowDomain().

-

Version 7. Superdomain matching is changed to exact domain matching. Two files are - permitted to script each other only if the host names in their URLs are identical; otherwise, a call to - Security.allowDomain() is required. By default, files loaded from non-HTTPS URLs are no longer - permitted to script files loaded from HTTPS URLs, even if the files are loaded from exactly the same - domain. This restriction helps protect HTTPS files, because a non-HTTPS file is vulnerable to - modification during download, and a maliciously modified non-HTTPS file could corrupt an HTTPS file, - which is otherwise immune to such tampering. Security.allowInsecureDomain() is introduced to - allow HTTPS SWF files that are being accessed to voluntarily disable this restriction, but the use of - Security.allowInsecureDomain() is discouraged.

-

Version 8. There are two major areas of change:

- -
    -
  • Calling Security.allowDomain() now permits cross-scripting operations - only if the SWF file being accessed is the SWF file that called Security.allowDomain(). - In other words, a SWF file that calls Security.allowDomain() now permits access only to itself. - In previous versions, calling Security.allowDomain() permitted cross-scripting operations - where the SWF file being accessed could be any SWF file in the same domain as the SWF file that called - Security.allowDomain(). Calling Security.allowDomain() previously opened up - the entire domain of the calling SWF file.
    • - -
  • Support has been added for wildcard values with Security.allowDomain("*") and - Security.allowInsecureDomain("*"). - The wildcard (*) value permits cross-scripting operations where the accessing file is any file at all, - loaded from anywhere. Think of the wildcard as a global permission. Wildcard permissions - are required to enable certain kinds of operations - under the local file security rules. Specifically, - for a local SWF file with network-access permissions to script a SWF file on the - Internet, the Internet SWF file being accessed must call Security.allowDomain("*"), - reflecting that the origin of a local SWF file is unknown. (If the Internet SWF file is loaded from an - HTTPS URL, the Internet SWF file must instead call Security.allowInsecureDomain("*").)
    • -
- -

Occasionally, you may encounter the following situation: You load a child SWF file - from a different domain and want to allow the child SWF file to script the parent SWF file, - but you don't know the final domain of the child SWF file. This can happen, for - example, when you use load-balancing redirects or third-party servers.

-

In this situation, you can use the url property of the URLRequest object - that you pass to Loader.load(). For example, if you load a child SWF file - into a parent SWF, you can access the contentLoaderInfo property of the Loader - object for the parent SWF:

- 
Security.allowDomain(loader.contentLoaderInfo.url)
-

Make sure that you wait until the child SWF file begins loading to get the correct - value of the url property. To determine when the child SWF has begun loading, - use the progress event.

- -

The opposite situation can also occur; that is, you might create a child SWF file - that wants to allow its parent to script it, but doesn't know what the domain of its parent - will be. In this situation, you can access the loaderInfo property - of the display object that is the SWF's root object. In the child SWF, call - Security.allowDomain( this.root.loaderInfo.loaderURL). - You don't have to wait for the parent SWF file to load; the parent will already be - loaded by the time the child loads.

-

If you are publishing for Flash Player 8 or later, you can also handle these situations by calling - Security.allowDomain("*"). However, this can sometimes be a dangerous shortcut, - because it allows the calling SWF file to be accessed by any other SWF file from any domain. - It is usually safer to use the _url property.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- -

Parameters - - - - -
... domains — One or more strings or URLRequest objects that name the domains from which - you want to allow access. You can specify the special domain "*" to - allow access from all domains. - -

In Flash Professional, specifying "*" is the only - way to allow access to nonlocal SWF files from local SWF files that have been - published using Access Network Only for the Local Playback - Security option in the Flash authoring tool.

-

Note: - The wildcard value does not work for subdomains. For example, you cannot use *.foo.com for - the domains parameter. While you can specify a subdomain with a wild card value for a cross domain policy file - (as in *.foo.com), you can't use a wildcard value that way for the allowDomain() method.

- -
-
-Throws - - - - -
SecurityError — Calling this method from code in the AIR application security sandbox - throws a SecurityError exception. Content outside of the application security sandbox cannot cross-script - content in the application security sandbox. -
-

-See also -

-
-ExternalInterface.addCallback() -
-flash.events.Event.COMPLETE -
-flash.display.DisplayObject.parent -
-flash.net.URLRequest.url -
-allowInsecureDomain() -
-
- - - - - -
allowInsecureDomain()method 
-
-public static function allowInsecureDomain(... domains):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Lets SWF files and HTML files in the identified domains access objects - and variables in the calling SWF file, which is hosted by means of the HTTPS protocol. - -

This method applies to cross-scripting of ActionScript 3.0 code - (in SWF content). It does not apply to JavaScript code running in HTML-based AIR applications.

-

Flash Player provides allowInsecureDomain() to maximize flexibility, - but calling this method is not recommended. Serving a file over HTTPS provides several protections - for you and your users, and calling allowInsecureDomain weakens one of those - protections.

- -

Note: Calling this method from code in the AIR application sandbox - throws a SecurityError exception. Content outside of the application security domain cannot directly - cross-script content in the application sandbox. However, content outside of the application sandbox can - communicate with content in the application security sandbox using a sandbox bridge.

- -

This method works in the same way as Security.allowDomain(), but it also - permits operations in which the accessing party is loaded with a non-HTTPS protocol, and the - party being accessed is loaded with HTTPS. In Flash Player 7 and later, - non-HTTPS files are not allowed to script HTTPS files. The allowInsecureDomain() method lifts this - restriction when the HTTPS SWF file being accessed uses it.

- -

Use allowInsecureDomain() only to enable scripting from non-HTTPS files - to HTTPS files. Use it to enable scripting when the accessing non-HTTPS file and - the HTTPS file being accessed are served from the same domain, for example, if a SWF file at - http://mysite.com wants to script a SWF file at https://mysite.com. Do not use this method to enable - scripting between non-HTTPS files, between HTTPS files, or from HTTPS files to non-HTTPS - files. For those situations, use allowDomain() instead.

- - The following scenario illustrates how allowInsecureDomain() can compromise security, if it is not used - with careful consideration. - -

Note that the following information is only one possible scenario, designed to - help you understand allowInsecureDomain() through a real-world example - of cross-scripting. - It does not cover all issues with security architecture and should be used for background - information only. The Flash Player Developer Center contains extensive information on Flash Player - and security. For more information, see - the Flash Player Developer Center Topic Security.

- -

Suppose you are building an e-commerce site that consists of two components: - a catalog, which does not need to be secure, because it contains only public information; - and a shopping cart/checkout component, which must be secure to protect users' financial and - personal information. Suppose you are considering serving the catalog from - http://mysite.com/catalog.swf and the cart from https://mysite.com/cart.swf. One - requirement for your site is that a third party should not be able to steal your - users' credit card numbers by taking advantage of a weakness in your security architecture.

- -

Suppose that a middle-party attacker intervenes between your server and your users, attempting - to steal the credit card numbers that your users enter into your shopping cart application. - A middle party might, for example, be an unscrupulous ISP used by some of your users, or a - malicious administrator at a user's workplace — anyone who has the ability to view or alter - network packets transmitted over the public Internet between your users and your servers. - This situation is not uncommon.

- -

If cart.swf uses HTTPS to transmit credit card information to your servers, then the - middle-party attacker can't directly steal this information from network packets, because the - HTTPS transmission is encrypted. However, the attacker can use a different technique: altering the - contents of one of your SWF files as it is delivered to the user, replacing your SWF file with an - altered version that transmits the user's information to a different server, owned by the attacker.

- -

The HTTPS protocol, among other things, prevents this "modification" attack from working, - because, in addition to being encrypted, HTTPS transmissions are tamper-resistant. - If a middle-party attacker alters a packet, the receiving side detects the alteration - and discards the packet. So the attacker in this situation can't alter cart.swf, because it - is delivered over HTTPS.

- -

However, suppose that you want to allow buttons in catalog.swf, served over HTTP, - to add items to the shopping cart in cart.swf, served over HTTPS. To accomplish this, - cart.swf calls allowInsecureDomain(), which allows catalog.swf to script cart.swf. - This action has an unintended consequence: Now the attacker can alter - catalog.swf as it is initially being downloaded by - the user, because catalog.swf is delivered with HTTP and is not tamper-resistant. - The attacker's altered catalog.swf can now script cart.swf, because cart.swf contains - a call to allowInsecureDomain(). The altered catalog.swf file can use ActionScript to access - the variables in cart.swf, thus reading the user's credit card information and other - sensitive data. The altered catalog.swf can then send this data to an attacker's server.

- -

Obviously, this implementation is not desired, but you still want to allow - cross-scripting between the two SWF files on your site. Here are two possible ways to redesign - this hypothetical e-commerce site to avoid allowInsecureDomain():

- -
    -
  • Serve all SWF files in the application over HTTPS. This is by far the simplest and most - reliable solution. In the scenario described, you would serve both catalog.swf and cart.swf - over HTTPS. You might experience slightly higher bandwidth consumption and server CPU load - when switching a file such as catalog.swf from HTTP to HTTPS, and your users might experience - slightly longer application load times. You need to experiment with real servers to - determine the severity of these effects; usually they are no worse than 10-20% each, and - sometimes they are not present at all. You can usually improve results by using HTTPS-accelerating - hardware or software on your servers. A major benefit of serving all - cooperating SWF files over HTTPS is that you can use an HTTPS URL as the main URL - in the user's browser without generating any mixed-content warnings from the browser. - Also, the browser's padlock icon becomes visible, providing your users with - a common and trusted indicator of security.
    • - -
  • Use HTTPS-to-HTTP scripting, rather than HTTP-to-HTTPS scripting. In the scenario described, you - could store the contents of the user's shopping cart in catalog.swf, and have cart.swf manage - only the checkout process. At checkout time, cart.swf could retrieve the cart contents from - ActionScript variables in catalog.swf. The restriction on HTTP-to-HTTPS scripting is asymmetrical; - although an HTTP-delivered catalog.swf file cannot safely be allowed to script an HTTPS-delivered cart.swf file, - an HTTPS cart.swf file can script the HTTP catalog.swf file. - This approach is more delicate than the all-HTTPS approach; you must be careful not to trust any - SWF file delivered over HTTP, because of its vulnerability to tampering. For example, when cart.swf - retrieves the ActionScript variable that describes the cart contents, the ActionScript code - in cart.swf cannot trust that the value of this variable is in the format that you expect. - You must verify that the cart contents do not contain invalid data that might - lead cart.swf to take an undesired action. You must also accept the risk that a middle party, - by altering catalog.swf, could supply valid but inaccurate data to cart.swf; for example, by placing - items in the user's cart. The usual checkout process mitigates - this risk somewhat by displaying the cart contents and total cost for final approval by the user, - but the risk remains present.
    • -
- -

Web browsers have enforced separation between HTTPS and non-HTTPS files for years, - and the scenario described illustrates one good reason for this restriction. - Flash Player gives you the ability to work around this security restriction when you - absolutely must, but be sure to consider the consequences carefully before doing so.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- -

Parameters - - - - -
... domains — One or more strings or URLRequest objects that name the domains from which - you want to allow access. You can specify the special domain "*" to - allow access from all domains. - -

Specifying "*" is the only - way to allow access to nonlocal SWF files from local SWF files that have been - published using the Access Network Only option for the Local Playback - Security setting (File > Publish Settings > Flash tab) in the Flash authoring tool.

- -

Note: - The wildcard value does not work for subdomains. For example, you cannot use *.foo.com for - the domains parameter. While you can specify a subdomain with a wild card value for a cross domain policy file - (as in *.foo.com), you can't use a wildcard value that way for the allowInsecureDomain() method.

-
-
-Throws - - - - -
SecurityError — Calling this method from code in the AIR application security sandbox causes a - SecurityError exception to be thrown. Content outside of the application security sandbox cannot cross-script - content in the application security sandbox. - -
-

-See also -

-
-allowDomain() -
-
- - - - - -
loadPolicyFile()method 
-
-public static function loadPolicyFile(url:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Looks for a policy file at the location specified by the url - parameter. Adobe AIR and Flash Player use policy files to determine - whether to permit applications to load data from servers other than their own. - Note that even though the method name is loadPolicyFile(), - the file isn't actually loaded until a network request that requires a policy file is made. - -

With Security.loadPolicyFile(), Flash Player or AIR can - load policy files from arbitrary locations, as shown in the following example:

- - 
-     Security.loadPolicyFile("http://www.example.com/sub/dir/pf.xml");
-
- - 
-     air.Security.loadPolicyFile("http://www.example.com/sub/dir/pf.xml");
-
- -

This causes Flash Player or AIR to attempt to retrieve a policy file from the specified URL. Any permissions - granted by the policy file at that location will apply to all content at the same level or lower in - the virtual directory hierarchy of the server.

- -

For example, following the previous code, these lines do not throw an exception:

- - 
 import flash.net.*;
-     var request:URLRequest = new URLRequest("http://www.example.com/sub/dir/vars.txt");
-     var loader:URLLoader = new URLLoader();
-     loader.load(request);
-     
-     var loader2:URLLoader = new URLLoader();
-     var request2:URLRequest = new URLRequest("http://www.example.com/sub/dir/deep/vars2.txt");
-     loader2.load(request2);
-
- -

However, the following code does throw a security exception:

- - 
 import flash.net.*;
-     var request3:URLRequest = new URLRequest("http://www.example.com/elsewhere/vars3.txt");
-     var loader3:URLLoader = new URLLoader();
-     loader3.load(request3);
-
- -

You can use loadPolicyFile() to load any number of policy files. When considering a - request that requires a policy file, Flash Player or AIR always waits for the completion of any policy - file downloads before denying a request. As a final fallback, if no policy file specified with - loadPolicyFile() authorizes a request, Flash Player or AIR consults the original default - locations.

- -

When checking for a master policy file, Flash Player waits three seconds for a server response. - If a response isn't received, Flash Player assumes that no master policy file exists. - However, there is no default timeout value for calls to loadPolicyFile(); - Flash Player assumes that the file being called exists, and waits as long as necessary to load it. - Therefore, if you want to make sure that a master policy file is loaded, use loadPolicyFile() - to call it explicitly.

-

You cannot connect to commonly reserved ports. - For a complete list of blocked ports, see "Restricting Networking APIs" in the - ActionScript 3.0 Developer's Guide.

-

Using the xmlsocket protocol along with a specific port number lets you retrieve - policy files directly from an XMLSocket server, as shown in the following example. Socket - connections are not subject to the reserved port restriction described above.

- - 
-     Security.loadPolicyFile("xmlsocket://foo.com:414");
-
- - 
-     air.Security.loadPolicyFile("xmlsocket://foo.com:414");
-
- -

This causes Flash Player or AIR to attempt to retrieve a policy file from the specified host and port. - Upon establishing a connection with the - specified port, Flash Player or AIR transmits <policy-file-request />, terminated by a - null byte. The server must send a null byte to terminate a policy file, and may thereafter close the connection; - if the server does not close the connection, Flash Player or AIR does so upon receiving the terminating - null byte.

- -

You can prevent a SWF file from using this method by setting the - allowNetworking parameter of the object and embed - tags in the HTML page that contains the SWF content.

- -

For more information related to security, see the Flash Player Developer Center Topic: - Security.

- - Parameters - - - - -
url:String — The URL location of the policy file to be loaded. -
-
- - - - - -
showSettings()method 
-
-public static function showSettings(panel:String = "default"):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Displays the Security Settings panel in Flash Player. This method does not apply to content in - Adobe AIR; calling it in an AIR application has no effect. -

Parameters - - - - -
panel:String (default = "default") — A value from the SecurityPanel class that specifies which Security Settings - panel you want to display. If you omit this parameter, SecurityPanel.DEFAULT is used. -
-

-See also -

-
-SecurityPanel -
-
- -
Constant detail
- - - - - -
APPLICATIONconstant
-
-public static const APPLICATION:String = "application" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The file is running in an AIR application, and it was installed with the package (the AIR file) for that - application. This content is included in the AIR application resource directory (where the application - content is installed). -

-See also -

-
-sandboxType -
-REMOTE -
-LOCAL_WITH_FILE -
-LOCAL_WITH_NETWORK -
-LOCAL_TRUSTED -
-
- - - - - -
LOCAL_TRUSTEDconstant 
-
-public static const LOCAL_TRUSTED:String = "localTrusted" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The file is a local file and has been trusted by the user, - using either the Flash Player Settings Manager or a FlashPlayerTrust configuration - file. The file can read from local data sources and communicate - with the Internet. -

-See also -

-
-sandboxType -
-REMOTE -
-LOCAL_WITH_FILE -
-LOCAL_WITH_NETWORK -
-APPLICATION -
-
- - - - - -
LOCAL_WITH_FILEconstant 
-
-public static const LOCAL_WITH_FILE:String = "localWithFile" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The file is a local file, has not been trusted by the user, - and it is not a SWF file that was published with a networking designation. In Adobe AIR, - the local file is not in the application resource directory; such files are - put in the application security sandbox. The file may - read from local data sources but may not communicate with the Internet. -

-See also -

-
-sandboxType -
-REMOTE -
-LOCAL_WITH_NETWORK -
-LOCAL_TRUSTED -
-APPLICATION -
-
- - - - - -
LOCAL_WITH_NETWORKconstant 
-
-public static const LOCAL_WITH_NETWORK:String = "localWithNetwork" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The file is a local file, has not been trusted by the user, and it is a SWF - file that was published with a networking designation. The file can - communicate with the Internet but cannot read from local data sources. -

-See also -

-
-sandboxType -
-REMOTE -
-LOCAL_WITH_FILE -
-LOCAL_TRUSTED -
-APPLICATION -
-
- - - - - -
REMOTEconstant 
-
-public static const REMOTE:String = "remote" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The file is from an Internet URL and operates under domain-based sandbox rules. -

-See also -

-
-sandboxType -
-LOCAL_WITH_FILE -
-LOCAL_WITH_NETWORK -
-LOCAL_TRUSTED -
-APPLICATION -
-
- -
Examples
-
examples\SecurityExample
-
The following example shows how a click event on a Sprite object can be - used to show the Local Storage Settings panel of the Flash Player Settings. An orange box is added to the - stage using draw(). In draw(), a click event listener is - added named clickHandler(), which responds to click events by directing - Flash Player to open its Local Storage Settings panel. -
-
-package {
-    import flash.display.Sprite;
-	import flash.text.TextField;
-	import flash.events.*;
-	import flash.system.Security;
-	import flash.system.SecurityPanel;
-
-	public class SecurityExample extends Sprite {
-		private var bgColor:uint = 0xFFCC00;
-		private var size:uint = 100;
-
-		public function SecurityExample() {
-			draw();
-		}
-
-		private function draw():void {
-			var child:Sprite = new Sprite();
-			child.graphics.beginFill(bgColor);
-			child.graphics.drawRect(0, 0, size, size);
-			child.graphics.endFill();
-			child.buttonMode = true;
-
-			var label:TextField = new TextField();
-			label.text = "settings";
-			label.selectable = false;
-			label.mouseEnabled = false;
-			child.addChild(label);
-
-			child.addEventListener(MouseEvent.CLICK, clickHandler);
-			addChild(child);
-		}
-
-		private function clickHandler(event:MouseEvent):void {
-			Security.showSettings(SecurityPanel.LOCAL_STORAGE);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/SecurityDomain.html b/html-docs/flash/system/SecurityDomain.html deleted file mode 100644 index 8520c42..0000000 --- a/html-docs/flash/system/SecurityDomain.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - - - - -flash.system.SecurityDomain (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic class SecurityDomain
InheritanceSecurityDomain Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The SecurityDomain class represents the current security "sandbox," also known as a security domain. - By passing an instance of this class to Loader.load(), you can request that loaded media be placed in - a particular sandbox. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentDomain : SecurityDomain -
[static][read-only] - Gets the current security domain.
-		SecurityDomain
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
currentDomainproperty
-
-currentDomain:SecurityDomain  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Gets the current security domain. - -

Implementation -
-    public static function get currentDomain():SecurityDomain -
-

-See also -

-
-flash.display.Loader.load() -
-flash.display.Loader.loadBytes() -
-flash.system.LoaderContext -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/SecurityPanel.html b/html-docs/flash/system/SecurityPanel.html deleted file mode 100644 index 803e5b2..0000000 --- a/html-docs/flash/system/SecurityPanel.html +++ /dev/null @@ -1,516 +0,0 @@ - - - - - - - - -flash.system.SecurityPanel (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class SecurityPanel
InheritanceSecurityPanel Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The SecurityPanel class provides values for specifying - which Security Settings panel you want to display. -

This class contains static constants that are used with the - Security.showSettings() method. You cannot create new instances - of the SecurityPanel class.

-

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  CAMERA : String = "camera"
[static] - When passed to Security.showSettings(), displays the - Camera panel in Flash Player Settings.
-		SecurityPanel
  DEFAULT : String = "default"
[static] - When passed to Security.showSettings(), displays the panel - that was open the last time the user closed the Flash Player Settings.
-		SecurityPanel
  DISPLAY : String = "display"
[static] - When passed to Security.showSettings(), displays the - Display panel in Flash Player Settings.
-		SecurityPanel
  LOCAL_STORAGE : String = "localStorage"
[static] - When passed to Security.showSettings(), displays the - Local Storage Settings panel in Flash Player Settings.
-		SecurityPanel
  MICROPHONE : String = "microphone"
[static] - When passed to Security.showSettings(), displays the - Microphone panel in Flash Player Settings.
-		SecurityPanel
  PRIVACY : String = "privacy"
[static] - When passed to Security.showSettings(), displays the - Privacy Settings panel in Flash Player Settings.
-		SecurityPanel
  SETTINGS_MANAGER : String = "settingsManager"
[static] - When passed to Security.showSettings(), displays the - Settings Manager (in a separate browser window).
-		SecurityPanel
-
- -
- -
Constant detail
- - - - - -
CAMERAconstant
-
-public static const CAMERA:String = "camera" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- When passed to Security.showSettings(), displays the - Camera panel in Flash Player Settings. -

-See also -

-
-Security.showSettings() -
-
- - - - - -
DEFAULTconstant 
-
-public static const DEFAULT:String = "default" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- When passed to Security.showSettings(), displays the panel - that was open the last time the user closed the Flash Player Settings. -

-See also -

-
-Security.showSettings() -
-
- - - - - -
DISPLAYconstant 
-
-public static const DISPLAY:String = "display" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- When passed to Security.showSettings(), displays the - Display panel in Flash Player Settings. -

-See also -

-
-Security.showSettings() -
-
- - - - - -
LOCAL_STORAGEconstant 
-
-public static const LOCAL_STORAGE:String = "localStorage" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- When passed to Security.showSettings(), displays the - Local Storage Settings panel in Flash Player Settings. -

-See also -

-
-Security.showSettings() -
-
- - - - - -
MICROPHONEconstant 
-
-public static const MICROPHONE:String = "microphone" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- When passed to Security.showSettings(), displays the - Microphone panel in Flash Player Settings. -

-See also -

-
-Security.showSettings() -
-
- - - - - -
PRIVACYconstant 
-
-public static const PRIVACY:String = "privacy" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- When passed to Security.showSettings(), displays the - Privacy Settings panel in Flash Player Settings. -

-See also -

-
-Security.showSettings() -
-
- - - - - -
SETTINGS_MANAGERconstant 
-
-public static const SETTINGS_MANAGER:String = "settingsManager" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- When passed to Security.showSettings(), displays the - Settings Manager (in a separate browser window). -

-See also -

-
-Security.showSettings() -
-
- -
Examples
-
examples\SecurityExample
-
The following example shows how a click event on a Sprite object can be - used to show the Local Storage Settings panel of the Flash Player Settings. An orange box is added to the - stage using draw(). In draw(), a click event listener is - added named clickHandler(), which responds to click events by directing - Flash Player to open its Local Storage Settings panel. -
-
-package {
-    import flash.display.Sprite;
-	import flash.text.TextField;
-	import flash.events.*;
-	import flash.system.Security;
-	import flash.system.SecurityPanel;
-
-	public class SecurityExample extends Sprite {
-		private var bgColor:uint = 0xFFCC00;
-		private var size:uint = 100;
-
-		public function SecurityExample() {
-			draw();
-		}
-
-		private function draw():void {
-			var child:Sprite = new Sprite();
-			child.graphics.beginFill(bgColor);
-			child.graphics.drawRect(0, 0, size, size);
-			child.graphics.endFill();
-			child.buttonMode = true;
-
-			var label:TextField = new TextField();
-			label.text = "settings";
-			label.selectable = false;
-			label.mouseEnabled = false;
-			child.addChild(label);
-
-			child.addEventListener(MouseEvent.CLICK, clickHandler);
-			addChild(child);
-		}
-
-		private function clickHandler(event:MouseEvent):void {
-			Security.showSettings(SecurityPanel.LOCAL_STORAGE);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/System.html b/html-docs/flash/system/System.html deleted file mode 100644 index 482af3c..0000000 --- a/html-docs/flash/system/System.html +++ /dev/null @@ -1,1419 +0,0 @@ - - - - - - - - -flash.system.System (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class System
InheritanceSystem Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - The System class contains properties related to local settings and operations. Among these are - - settings for camers and microphones, operations with shared objects and the use of the Clipboard. - - - -

Additional properties and methods are in other classes within the flash.system package: - - the Capabilities class, the IME class, and the - - Security class.

- - -

This class contains only static methods and properties. You cannot - - create new instances of the System class.

- - - -

-

-View the examples. -

-

-See also -

-
-flash.system.Security -
-flash.events.IMEEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  containsDebugInfo : Boolean -
[static][read-only] - - Property to check whether any loaded SWF has contained debug information.
-		System
  freeMemory : Number -
[static][read-only] - - The amount of memory (in bytes) that is allocated to - - Adobe® Flash® Player or - - Adobe® AIR® and that is not in use.
-		System
  ime : IME -
[static][read-only] - - The currently installed system IME.
-		System
  poisonStrings : Boolean -
[static][write-only] - - Sets a flag to poison the memory used by any String object when it is garbage collected.
-		System
  privateMemory : Number -
[static][read-only] - - The entire amount of memory (in bytes) used by an application.
-		System
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  totalMemory : uint -
[static][read-only] - - The amount of memory (in bytes) currently in use that has been directly allocated by - - Flash Player or AIR.
-		System
  totalMemoryNumber : Number -
[static][read-only] - - The amount of memory (in bytes) currently in use that has been directly allocated by - - Flash Player or AIR.
-		System
  useCodePage : Boolean -
[static] - - A Boolean value that determines which code page to use to interpret external text files.
-		System
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-decryptBlob(data:Class, key:String = null):ByteArray -
-
[static] - - Decrypts a built-in BinaryData blob into a byte array object.
-		System
   -
-disposeXML(node:XML):void -
-
[static] - - Makes the specified XML object immediately available for garbage collection.
-		System
   -
-error(errString:String):void -
-
[static] - - Output a string to the console via 'stderr'.
-		System
   -
-exit(code:uint):void -
-
[static] - - Closes Flash Player.
-		System
   -
-gc():void -
-
[static] - - Forces the garbage collection process.
-		System
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-input():String -
-
[static] - - Request a string input from the user via the console.
-		System
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-output(outString:String):void -
-
[static] - - Output a string to the console via 'stdout'.
-		System
   -
-pause():void -
-
[static] - - Pauses Flash Player or the AIR Debug Launcher (ADL).
-		System
   -
-pauseForGCIfCollectionImminent(imminence:Number = 0.75):void -
-
[static] - - Advise the garbage collector that if the collector's imminence exceeds the function's imminence parameter then the - - collector should finish the incremental collection cycle.
-		System
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-resume():void -
-
[static] - - Resumes the application after calling System.pause().
-		System
   -
-setClipboard(string:String):void -
-
[static] - - Replaces the contents of the Clipboard with a specified text string.
-		System
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
containsDebugInfoproperty
-
-containsDebugInfo:Boolean  [read-only]

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Property to check whether any loaded SWF has contained debug information. - -

This works by checking for the presence of a debugfile ActionScript instruction.

- - - Implementation -
-    public static function get containsDebugInfo():Boolean -
-
- - - - - -
freeMemoryproperty 
-
-freeMemory:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 - -
-

- - The amount of memory (in bytes) that is allocated to - - Adobe® Flash® Player or - - Adobe® AIR® and that is not in use. This unused portion of - - allocated memory (System.totalMemory) fluctuates as garbage collection takes place. - - Use this property to monitor garbage collection. - - - -

Implementation -
-    public static function get freeMemory():Number -
-

-See also -

-
-privateMemory -
-totalMemory -
-totalMemoryNumber -
-
- - - - - -
imeproperty 
-
-ime:IME  [read-only]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - The currently installed system IME. - - To register for imeComposition events, call - - addEventListener() on this instance. - -

Implementation -
-    public static function get ime():IME -
-

-See also -

-
-IMEConversionMode -
-
- - - - - -
poisonStringsproperty 
-
-poisonStrings:Boolean  [write-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 - -
-

- - Sets a flag to poison the memory used by any String object when it is garbage collected. - -

This can be used to protect passwords from being viewed via a memory dump of the AIR process.

- -

Any string that is created whilst the flag is set to true will then have its - - contents set to 0xDD immediately upon its garbage collection (which should ideally be handled - - by reference counting). The value of this setting at the time of the String creation is - - retained so this setting can be turned off once a password has been entered, even if the string is - - not yet garbage collected.

- - - Implementation -
-    public function set poisonStrings(value:Boolean):void -
-
- - - - - -
privateMemoryproperty 
-
-privateMemory:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 - -
-

- - The entire amount of memory (in bytes) used by an application. This is the amount of resident private memory for the entire process. - - -

AIR developers should use this property to determine the entire memory consumption of an application.

- - -

For Flash Player, this includes the memory used by the container application, - - such as the web browser.

- - - Implementation -
-    public static function get privateMemory():Number -
-

-See also -

-
-freeMemory -
-totalMemory -
-totalMemoryNumber -
-
- - - - - -
totalMemoryproperty 
-
-totalMemory:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The amount of memory (in bytes) currently in use that has been directly allocated by - - Flash Player or AIR. - - -

This property does not return all memory used by an Adobe AIR application or by - - the application (such as a browser) containing Flash Player content. The browser or - - operating system may consume other memory. The System.privateMemory property reflects all memory used by - - an application.

- - -

If the amount of memory allocated is greater than the maximum value for a uint object (uint.MAX_VALUE, - - or 4,294,967,295), then this property is set to 0. The System.totalMemoryNumber property allows - - larger values.

- - - Implementation -
-    public static function get totalMemory():uint -
-

-See also -

-
-freeMemory -
-privateMemory -
-totalMemoryNumber -
-
- - - - - -
totalMemoryNumberproperty 
-
-totalMemoryNumber:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 - -
-

- - The amount of memory (in bytes) currently in use that has been directly allocated by - - Flash Player or AIR. - - -

This property is expressed as a Number, which allows higher values than the - - System.totalMemory property, which is of type int.

- - -

This property does not return all memory used by an Adobe AIR application or by - - the application (such as a browser) containing Flash Player content. The browser or - - operating system may consume other memory. The System.privateMemory property reflects all memory used by - - an application.

- - - Implementation -
-    public static function get totalMemoryNumber():Number -
-

-See also -

-
-freeMemory -
-privateMemory -
-totalMemory -
-
- - - - - -
useCodePageproperty 
-
-useCodePage:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - A Boolean value that determines which code page to use to interpret external text files. - - When the property is set to false, external text files are interpretted as Unicode. - - (These files must be encoded as Unicode when you save them.) When the property is set to - - true, external text files are interpretted using the traditional code page of the - - operating system running the application. The default value of useCodePage is false. - - - -

Text that you load as an external file (using Loader.load(), the URLLoader class or - - URLStream) must have been saved as Unicode in order for the application to recognize it - - as Unicode. To encode external files as Unicode, save the files in an application that - - supports Unicode, such as Notepad on Windows.

- - - -

If you load external text files that are not Unicode-encoded, set useCodePage to true. - - Add the following as the first line of code of the file that - - is loading the data (for Flash Professional, add it to the first frame):

- - - - 
System.useCodePage = true;
- - - -

When this code is present, the application interprets external text - - using the traditional code page of the operating system. - - For example, this is generally CP1252 for an English Windows operating - - system and Shift-JIS for a Japanese operating system.

- - - -

If you set useCodePage to true, - - Flash Player 6 and later treat text as Flash Player 5 does. (Flash Player 5 - - treated all text as if it were in the traditional code page of the operating - - system running the player.)

- - - -

If you set useCodePage to true, remember that the - - traditional code page of the operating system running the application must include - - the characters used in your external text file in order to display your text. - - For example, if you load an external text file that contains Chinese characters, - - those characters cannot display on a system that uses the CP1252 code page because - - that code page does not include Chinese characters.

- - -

To ensure that users on all platforms can view external text files used in your - - application, you should encode all external text files as Unicode and leave - - useCodePage set to false. This way, the application - - (Flash Player 6 and later, or AIR) interprets the text as Unicode.

- - - Implementation -
-    public static function get useCodePage():Boolean -
-    public function set useCodePage(value:Boolean):void -
-

-See also -

-
-flash.display.Loader.load() -
-
- -
Method detail
- - - - - -
decryptBlob()method
-
-public static function decryptBlob(data:Class, key:String = null):ByteArray -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Decrypts a built-in BinaryData blob into a byte array object. - -

AIR 51.0 introduces an optional key parameter so that developers can decrypt - - content that had been set up using a custom key. This key would have either been provided - - within the source code (via the AS3 compiler 'Embed' tag) or via the compiler command line. - - If no custom key had been provided, a key is generated and embedded into the data stream, but - - please note this is not a secure method and has been reverse engineered. It it strongly - - recommended to use a custom key when compiling the SWF, and to obtain this key securely from - - a remote server at run-time, or similar, in order to provide it here for asset decryption.

- - -

Once the data has been used, it is recommended to wipe the resulting ByteArray object - - using the ByteArray.writeRandomBytes() method.

- - - Parameters - - - - - - - - - - -
data:Class — Class definition for the embedded data with encryption - -
 
key:String (default = null) — Custom key to use when decrypting - -
-

-Returns - - - - -
ByteArray — - ByteArray containing the decrypted data - - - - -
-
- - - - - -
disposeXML()method 
-
-public static function disposeXML(node:XML):void -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5.2 - -
-

- - Makes the specified XML object immediately available for garbage collection. - - This method will remove parent and child connections between all the nodes - - for the specified XML node. - - -

Parameters - - - - -
node:XML — XML reference that should be made available for garbage collection. - -
-
- - - - - -
error()method 
-
-public static function error(errString:String):void -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 - -
-

- - Output a string to the console via 'stderr'. This method is intended for use - - by command-line AIR applications to display error messages to the user. - - -

Parameters - - - - -
errString:String — String to be displayed to the user via the stderr stream. - -
-
- - - - - -
exit()method 
-
-public static function exit(code:uint):void -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Closes Flash Player. - - - -

For the standalone Flash Player debugger version only.

- - - -

AIR applications should call the NativeApplication.exit() method to exit the application.

- - - - Parameters - - - - -
code:uint — A value to pass to the operating system. Typically, if - - the process exits normally, the value is 0. - - - -
-

-See also -

-
-flash.desktop.NativeApplication.exit() -
-
- - - - - -
gc()method 
-
-public static function gc():void -

- - - - -
Language version: ActionScript ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Forces the garbage collection process. - - - -

For the Flash Player debugger version and AIR applications only. - - In an AIR application, the System.gc() method is only enabled in content running in the AIR Debug Launcher - - (ADL) or, in an installed applcation, in content in the application security sandbox.

- - - -
- - - - - -
input()method 
-
-public static function input():String -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 - -
-

- - Request a string input from the user via the console. This method is intended for use - - by command-line AIR applications to request input from the user. - - Note that there is a 1024-character limit to the input string buffer. - - -

-Returns - - - - -
String — - String that the user entered via the console (stdin). - - - -
-
- - - - - -
output()method 
-
-public static function output(outString:String):void -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: AIR 33.1 - -
-

- - Output a string to the console via 'stdout'. This method is intended for use - - by command-line AIR applications to display normal messages to the user. - - -

Parameters - - - - -
outString:String — String to be displayed to the user via the stdout stream. - -
-
- - - - - -
pause()method 
-
-public static function pause():void -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Pauses Flash Player or the AIR Debug Launcher (ADL). - - After calling this method, nothing in the application continues except the delivery of Socket events. - - - -

For the Flash Player debugger version or the AIR Debug Launcher (ADL) only.

- - -

-See also -

-
-resume() -
-
- - - - - -
pauseForGCIfCollectionImminent()method 
-
-public static function pauseForGCIfCollectionImminent(imminence:Number = 0.75):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 3 - -
-

- - Advise the garbage collector that if the collector's imminence exceeds the function's imminence parameter then the - - collector should finish the incremental collection cycle. - - - -

The Flash Runtime garbage collector algorithm runs incrementally while marking memory in use. It pauses application execution - - when collecting unused portions of memory. The pause that occurs as the incremental collection cycle finishes can be longer - - than desired and can be observable or audible in some programs. This function allows the application to advise the runtime - - that it is a good time to both complete the marking and perform collection. Scheduling potential pauses for times when the user - - won't notice them makes for a better user experience. For example, a game might call this function upon the completion - - of a level in a game, thus reducing the chances of a pause occurring during gameplay.

- - - -

Imminence is defined as how far through marking the collector believes it is, and therefore how close it is to triggering - - a collection pause. The imminence argument to this function is a threshold: the garbage collector will be invoked only if - - the actual imminence exceeds the threshold value. Otherwise, this call returns immediately without taking action.

- - - -

By calling this function with a low imminence value, the application indicates that it is willing to accept that a relatively - - large amount of marking must be completed. A high imminence value, on the other hand, indicates that the application should be paused - - only if marking is nearly complete.  Typically, pauses are longer in the former case than in the latter.

- - - -

The amount of memory being freed does not depend on the imminence parameter. It only depends on the number of freeable objects. If - - the application has recently released references to large data structures or to a large number of objects, a low imminence - - parameter will tend to trigger a collection that will free those objects immediately.

- - - - Parameters - - - - -
imminence:Number (default = 0.75) — A number between 0 and 1, where 0 means less imminent and 1 means most imminent. Values less than 0 default to 0.25. Values greater than 1.0 default to 1.0. NaN defaults to 0.75 - - - -
-
- - - - - -
resume()method 
-
-public static function resume():void -

- - - - -
Language version: ActionScript ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Resumes the application after calling System.pause(). - - - -

For the Flash Player debugger version or the AIR Debug Launcher (ADL) only.

- - -

-See also -

-
-pause() -
-
- - - - - -
setClipboard()method 
-
-public static function setClipboard(string:String):void -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Replaces the contents of the Clipboard with a specified text string. This method works from any security - - context when called as a result of a user event (such as a keyboard or input device event handler). - - -

This method is provided for SWF content running in Flash Player 9. It allows only adding - - String content to the Clipboard.

- - - -

Flash Player 10 content and content in the application security sandbox in an AIR application can call - - the Clipboard.setData() method.

- - - Parameters - - - - -
string:String — A plain-text string of characters to put on the system Clipboard, replacing its current contents (if any). - - - -
-

-See also -

-
-flash.desktop.Clipboard -
-
- -
Examples
-
examples\SystemExample
-
The following example shows how to copy information about your system's total memory to the - system Clipboard using a call to System.totalMemory within a call to the - System.setClipboard() method. -
-
-package {
-    import flash.display.Sprite;
-	import flash.system.System;
-
-	public class SystemExample extends Sprite {
-		public function SystemExample() {
-			System.setClipboard("System.totalMemory: " + System.totalMemory);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/SystemUpdater.html b/html-docs/flash/system/SystemUpdater.html deleted file mode 100644 index 30cf7f1..0000000 --- a/html-docs/flash/system/SystemUpdater.html +++ /dev/null @@ -1,779 +0,0 @@ - - - - - - - - -flash.system.SystemUpdater (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic class SystemUpdater
InheritanceSystemUpdater Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The SystemUpdater class allows you to update modules of the Flash Player, - such as the DRM module for Adobe Access, as well as the Flash Player itself. - Available modules are listed in the SystemUpdaterType class. - -

Flash Player identifies the need for a Adobe-Access-module update by dispatching a NetStatusEvent event. - The event has a code property with a value of "DRM.UpdateNeeded". For updates to the Adobe Access - module, user consent is not required. Listen for the event and initiate the update by calling - update("DRM").

-

Flash Player identifies the need for a player update by dispatching a StatusEvent event, with several - possible code property values (see the status event). For updates to the player, - user consent is required. Listen for the event and present the user with the option to update. The user must agree to the actual - update and initiate the update by, for example, clicking a button in the user interface. You can then - initiate the player update directly in ActionScript by calling update("SYSTEM").

-

Note: The SystemUpdater API is supported on all desktop platforms.

- -

-

-See also -

-
-flash.system.SystemUpdaterType -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SystemUpdater()
-
- Constructor.
-		SystemUpdater
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-cancel():void -
-
- Cancels an active update.
-		SystemUpdater
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-update(type:String):void -
-
- Begins an update of a given type.
-		SystemUpdater
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-cancel -
-		 - Dispatched when an update of the player itself is cancelled by the user.SystemUpdater
   -
-complete -
-		 - Dispatched when the update completes.SystemUpdater
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-ioError -
-		 - Dispatched when an I/O error occurs.SystemUpdater
   -
-open -
-		 - Dispatched when an update begins.SystemUpdater
   -
-progress -
-		 - Dispatched to indicate download progress.SystemUpdater
   -
-securityError -
-		 - Dispatched upon encountering a security error.SystemUpdater
   -
-status -
-		 - Dispatched when the update fails.SystemUpdater
-
- -
- -
Constructor detail
- - - - - -
SystemUpdater()constructor
-
-public function SystemUpdater() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Constructor. -

- -
Method detail
- - - - - -
cancel()method
-
-public function cancel():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Cancels an active update. -

- - - - - -
update()method 
-
-public function update(type:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Begins an update of a given type. Update types are one of the string constants defined - in the SystemUpdaterType class. - Only one update is allowed at a time across all browsers. -

After the update begins, listen for the events defined in this class. The following events - events indicate the end of an update and allow a new update or update attempt to proceed, - as does calling the update() function:

-

    -
  • complete
    • -
  • cancel
    • -
  • securityError
    • -
  • ioError
    • -
  • status
    • -

- - Parameters - - - - -
type:String
-

-See also -

-
-flash.system.SystemUpdaterType -
-
-
Event detail
- - - - - -
cancelevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CANCEL -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when an update of the player itself is cancelled by the user. - This event is dispatched only when an update of type SystemUpdaterType.SYSTEM - is requested and the user cancels the update. -

- The Event.CANCEL constant defines the value of the type property of a cancel event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetA reference to the object on which the operation is canceled.
-
- - - - - -
completeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when the update completes. -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
- - - - - -
ioErrorevent  
-
-Event object type: flash.events.IOErrorEvent -
-IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when an I/O error occurs. - For example, one error that can cause this event is a loss of Internet connectivity. -

- Defines the value of the type property of an ioError event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
- -
- - - - - -
openevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.OPEN -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when an update begins. The update is complete when a 'complete' event is sent, - or when an IOErrorEvent, SecurityErrorEvent, or StatusEvent is sent. -

- The Event.OPEN constant defines the value of the type property of an open event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has opened a connection.
- -
- - - - - -
progressevent  
-
-Event object type: flash.events.ProgressEvent -
-ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched to indicate download progress. This event is like the - progress event in the Loader and URLLoader classes. -

- Defines the value of the type property of a progress event object. - -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object reporting progress.
- -
- - - - - -
securityErrorevent  
-
-Event object type: flash.events.SecurityErrorEvent -
-SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched upon encountering a security error. - For example, a security error that can cause this event is if the player - tries to perform an update when an update is not permitted by security policy. -

- The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object reporting the security error.
textText to be displayed as an error message.
- -
- - - - - -
statusevent  
-
-Event object type: flash.events.StatusEvent -
-StatusEvent.type property = flash.events.StatusEvent.STATUS -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when the update fails. An update can fail for one of the following reasons: -

    -
  • The caller is running on an unsupported platform or architecture. In this case, - the value of the code property is "DRM.UpdateFailedNotSupported" and the value of the - level property is "error".
    • -
  • The requested update package cannot be located on the server. In this case, - the value of the code property is "DRM.UpdateFailedNotCurrentlyAvailable" and the - value of the level property is "error".
    • -
  • The Adobe Access module is not installed. This error is similar to the "DRM.UpdateNeeded" code, - which is dispatched by NetStatusEvent. - However, in this case, a more recent version of Flash Player must be downloaded first. In this case, - the value of the code property is "DRM.UpdateNeededButIncompatible" and the value of the - level property is "error". To perform an update - of Flash Player, call SystemUpdater.update(SystemUpdaterType.SYSTEM).
    • -
  • The new DRM module could not be downloaded. In this case, - the value of the code property is "DRM.UpdateFailed" and the value of the - level property is "error".
    • -

-

- Defines the value of the type property of a status event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
codeA description of the object's status.
currentTargetThe object that is actively processing the Event - object with an event listener.
levelThe category of the message, such as "status", "warning" or "error".
targetThe object reporting its status.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/SystemUpdaterType.html b/html-docs/flash/system/SystemUpdaterType.html deleted file mode 100644 index 4c9bf6d..0000000 --- a/html-docs/flash/system/SystemUpdaterType.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - - - - -flash.system.SystemUpdaterType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic class SystemUpdaterType
InheritanceSystemUpdaterType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The SystemUpdaterType class provides constants for a system update. These constants - are used in the SystemUpdater.update() function. -

Note: The SystemUpdater API is supported on desktop platforms.

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  DRM : String = "drm"
[static] - Updates the DRM module.
-		SystemUpdaterType
  SYSTEM : String = "system"
[static] - Updates the player runtime itself.
-		SystemUpdaterType
-
- -
- -
Constant detail
- - - - - -
DRMconstant
-
-public static const DRM:String = "drm" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Updates the DRM module. -

- - - - - -
SYSTEMconstant 
-
-public static const SYSTEM:String = "system" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Updates the player runtime itself. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/TouchscreenType.html b/html-docs/flash/system/TouchscreenType.html deleted file mode 100644 index 160ddad..0000000 --- a/html-docs/flash/system/TouchscreenType.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - - -flash.system.TouchscreenType (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class TouchscreenType
InheritanceTouchscreenType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The TouchscreenType class is an enumeration class that provides values for the different types of touch screens. - -

Use the values defined by the TouchscreenType class with the Capabilities.touchscreenType - property.

- -

-

-View the examples. -

-

-See also -

-
-Capabilities.touchscreenType -
-flash.ui.Mouse.supportsCursor -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  FINGER : String = "finger"
[static] - A touchscreen designed to respond to finger touches.
-		TouchscreenType
  NONE : String = "none"
[static] - The computer or device does not have a supported touchscreen.
-		TouchscreenType
  STYLUS : String = "stylus"
[static] - A touchscreen designed for use with a stylus.
-		TouchscreenType
-
- -
- -
Constant detail
- - - - - -
FINGERconstant
-
-public static const FINGER:String = "finger" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A touchscreen designed to respond to finger touches. - -

- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The computer or device does not have a supported touchscreen. - -

- - - - - -
STYLUSconstant 
-
-public static const STYLUS:String = "stylus" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A touchscreen designed for use with a stylus. - -

- -
Examples
-
examples\KeyboardType
-
The following example is a simple test that indicates the current state of the "Num Lock" and "Caps Lock" keys - as well as the type of keyboard and touch screen type in the running environment. When testing this example, click the - text field to see the property values: -
-
-import flash.events.~~;
-import flash.display.~~;
-import flash.ui.Keyboard;
-import flash.system.Capabilities;
-import flash.text.TextField;
-
-
-var keyboardInfoTxt:TextField = new TextField();
-keyboardInfoTxt.x = 30;
-keyboardInfoTxt.y = 50;
-keyboardInfoTxt.width = 300;
-keyboardInfoTxt.height = 100;
-keyboardInfoTxt.border = true;
-
-addChild(keyboardInfoTxt);
-
-addEventListener (MouseEvent.CLICK, getScreenKeyboardType);
-
-function getScreenKeyboardType(e:MouseEvent):void{
-    keyboardInfoTxt.text= "Caps Lock is : " + String(flash.ui.Keyboard.capsLock)+ "\n" + 
-	"Num Lock is : " + String(flash.ui.Keyboard.numLock) +"\n" + 
-	"Has Virtual Keyboard : " + String(flash.ui.Keyboard.hasVirtualKeyboard) + "\n" + 
-	"Physical Keyboard Type : " + flash.ui.Keyboard.physicalKeyboardType + "\n" + 
-	"flash.system.Capabilities.touchscreenType is : " + flash.system.Capabilities.touchscreenType;
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/system/Worker.html b/html-docs/flash/system/Worker.html deleted file mode 100644 index 02f0feb..0000000 --- a/html-docs/flash/system/Worker.html +++ /dev/null @@ -1,1675 +0,0 @@ - - - - - - - - -flash.system.Worker (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class Worker
InheritanceWorker Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

-

- A Worker object represents a worker, which is a virtual instance of the - Flash runtime. Each Worker instance controls and provides access to the lifecycle - and shared data of a single worker. -

A worker allows you to execute code "in the background" at the same time - that other operations are running in another worker (including the main - swf's worker). In a non-worker context some operations, for example - processing a large set of data in a loop, take so long to execute that they - prevent the main application thread from updating the screen quickly enough. - This can cause stuttering or freezing the screen.

-

Using a worker allows you to perform a long-running or slow operation in - the background. Each worker runs its code in a separate thread of - execution from other workers. Long-running code in one worker does not - block code in another worker from executing. Instead, the two sets of code - run in parallel. Consequently, a worker can be used to execute code in the - background while the main application thread stays free to continue - updating the screen.

-

This capability of simultaneously executing multiple sets of code - instructions is known as concurrency.

-

Note: The use of workers for concurrency is supported in - both Flash Player and AIR on desktop platforms. For mobile platforms, concurrency - is supported in AIR on both Android and iOS. You can use the static isSupported - property to check whether concurrency is supported before attempting to use it. -

-

You do not create Worker instances directly by calling the - Worker() constructor. In contexts where the use of workers for - concurrency is supported, at startup the runtime automatically creates the - Worker associated with the main SWF, known as the primordial worker.

-

Each additional worker is created from a separate swf. To create a new - instance of the Worker class, pass a ByteArray with the bytes of the - background worker's swf as an argument to the WorkerDomain class's - createWorker()method. There are three common ways to access the - bytes of a swf for this purpose:

-
    -

  • Use the [Embed] metatag to embed the .swf file in the - application as a ByteArray:

    - 
    - // Embed the SWF file
- [Embed(source="../swfs/BgWorker.swf", mimeType="application/octet-stream")]
- private static var BgWorker_ByteClass:Class;
- 
- private function createWorker():void
- {
-   // create the background worker
-   var workerBytes:ByteArray = new BgWorker_ByteClass();
-   var bgWorker:Worker = WorkerDomain.current.createWorker(workerBytes);
-   
-   // listen for worker state changes to know when the worker is running
-   bgWorker.addEventListener(Event.WORKER_STATE, workerStateHandler);
-   
-   // set up communication between workers using 
-   // setSharedProperty(), createMessageChannel(), etc.
-   // ... (not shown)
-   
-   bgWorker.start();
- }
    -
    • - -

  • Load an external SWF file using a URLLoader:

    - 
    - // load the SWF file
- var workerLoader:URLLoader = new URLLoader();
- workerLoader.dataFormat = URLLoaderDataFormat.BINARY;
- workerLoader.addEventListener(Event.COMPLETE, loadComplete);
- workerLoader.load(new URLRequest("BgWorker.swf"));
- 
- private function loadComplete(event:Event):void
- {
-   // create the background worker
-   var workerBytes:ByteArray = event.target.data as ByteArray;
-   var bgWorker:Worker = WorkerDomain.current.createWorker(workerBytes);
-   
-   // listen for worker state changes to know when the worker is running
-   bgWorker.addEventListener(Event.WORKER_STATE, workerStateHandler);
-   
-   // set up communication between workers using 
-   // setSharedProperty(), createMessageChannel(), etc.
-   // ... (not shown)
-   
-   bgWorker.start();
- }
    -
    • - -

  • Use a single swf as both the primordial worker and the - background worker:

    - 
    - // The primordial worker's main class constructor
- public function PrimordialWorkerClass()
- {
-   init();
- }
- 
- private function init():void
- {
-   var swfBytes:ByteArray = this.loaderInfo.bytes;
-   
-   // Check to see if this is the primordial worker
-   if (Worker.current.isPrimordial)    
-   {
-     // create a background worker
-     var bgWorker:Worker = WorkerDomain.current.createWorker(swfBytes);
-     
-     // listen for worker state changes to know when the worker is running
-     bgWorker.addEventListener(Event.WORKER_STATE, workerStateHandler);
-     
-     // set up communication between workers using 
-     // setSharedProperty(), createMessageChannel(), etc.
-     // ... (not shown)
-     
-     bgWorker.start();
-   }
-   else // entry point for the background worker
-   {
-     // set up communication between workers using getSharedProperty()
-     // ... (not shown)
-     
-     // start the background work
-   }
- }
    -
    • -
-

Workers execute in isolation from each other and do not have access to - the same memory, variables, and code. However, there are three mechanisms - available for passing messages and data between Worker instances:

- -
    -
  • Shared properties: Each worker has an internal set of named values - that can be set and read both from within the worker itself as well as from - other workers. You can set a value using the setSharedProperty() - method and read a value using the getSharedProperty() method.
    • -
  • MessageChannel: A MessageChannel object allows you to send one-way - messages and data from one worker to another. Code in the receiving - worker can listen for an event to be notified when a message arrives. - To create a MessageChannel object, use the createMessageChannel() - method.
    • -
  • Shareable ByteArray: If a ByteArray object's shareable - property is true, the same underlying memory is used for - instances of that ByteArray in all workers. Because code in multiple - workers can access the shared memory at the same time, your code should - use the mechanisms described in the ByteArray.shareable - property description to avoid problems from unexpected data changes.
    • -
-

Several runtime APIs are not available in code running in a background - worker. These primarily consist of APIs related to user input and output - mechanisms, or operating system elements like windows and dragging. As a - rule, for any API that isn't supported in all contexts, use the - isSupported, available, and similar properties to - check whether the API is available in the background worker context before - attempting to use the API.

-

Note: Native Extensions are not supported for background and secondary workers.

-

Workers are useful because they decrease the chances of the frame rate - dropping due to the main rendering thread being blocked by other code. - However, workers require additional system memory and CPU use, which can - be costly to overall application performance. Because each worker uses - its own instance of the runtime virtual machine, even the overhead of a - trivial worker can be large. When using workers, test your code across - all your target platforms to ensure that the demands on the system are - not too large. Adobe recommends that you do not use more than one or two - background workers in a typical scenario.

-

-

-View the examples. -

-

-See also -

-
-WorkerDomain class -
-WorkerDomain.createWorker() method -
-MessageChannel class -
-Using ActionScript Workers by Lee Brimelow -
-Intro to AS3 Workers: Image Processing by Shawn Blais -
-Multithreaded Physics: Using AS3 Workers for a physics engine by Shawn Blais -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  current : Worker -
[static][read-only] - Provides access to the worker that contains the current code -
-		Worker
  isPrimordial : Boolean -
[read-only] - Indicates whether this worker is the primordial worker.
-		Worker
  isSupported : Boolean -
[static][read-only] - Indicates whether the current runtime context supports the use of Worker - objects for concurrent code execution.
-		Worker
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  state : String -
[read-only] - The current state of the worker in its lifecycle.
-		Worker
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		Worker
   -
-createMessageChannel(receiver:Worker):MessageChannel -
-
- Creates a new MessageChannel instance to send messages from the worker on - which the method is called to another receiver worker.
-		Worker
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-getSharedProperty(key:String):* -
-
- Retrieves a value stored in this worker with a named key.
-		Worker
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		Worker
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setSharedProperty(key:String, value:*):void -
-
- Provides a named value that is available to code running in the worker's swf.
-		Worker
   -
-start():void -
-
- Starts the execution of the worker.
-		Worker
   -
-terminate():Boolean -
-
- Stops this worker's code execution.
-		Worker
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-workerState -
-		 -Dispatched when the value of the worker's state property changes.Worker
-
- -
- -
Property detail
- - - - - -
currentproperty
-
-current:Worker  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Provides access to the worker that contains the current code -

Implementation -
-    public static function get current():Worker -
-
- - - - - -
isPrimordialproperty 
-
-isPrimordial:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Indicates whether this worker is the primordial worker. - -

The primordial worker is the worker in which the initial swf is - running. This worker controls the rendering to the screen.

-

This property can be used to architect an application where the primordial - worker and the background worker are two instances of the same swf file. - The alternative is to structure your code so that the background worker - uses different code compiled to a different swf from the primorial worker.

- Implementation -
-    public function get isPrimordial():Boolean -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Indicates whether the current runtime context supports the use of Worker - objects for concurrent code execution. -

If concurrency is available, this property's value is true.

- Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
stateproperty 
-
-state:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- The current state of the worker in its lifecycle. The possible values for - this property are defined in the WorkerState class. -

Implementation -
-    public function get state():String -
-

-See also -

-
-flash.system.WorkerState -
-
- -
Method detail
- - - - - -
addEventListener()method
-
-public override function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event. You can register event listeners on all nodes in the - display list for a specific type of event, phase, and priority. - -

JavaScript code in the AIR runtime uses this method to register - event listeners for events defined by the AIR APIs. For other JavaScript events (such as the onload - event of the DOM body object), you can use standard event handling techniques, as you would - for content running in the browser.

- -

After you successfully register an event listener, you cannot change its priority - through additional calls to addEventListener(). To change a listener's - priority, you must first call removeListener(). Then you can register the - listener again with the new priority level.

- -

Keep in mind that after the listener is registered, subsequent calls to - addEventListener() with a different type or - useCapture value result in the creation of a separate listener registration. - For example, if you first register a listener with useCapture set to - true, it listens only during the capture phase. If you call - addEventListener() again using the same listener object, but with - useCapture set to false, you have two separate listeners: one - that listens during the capture phase and another that listens during the target and - bubbling phases. -

- -

You cannot register an event listener for only the target phase or the bubbling - phase. Those phases are coupled during registration because bubbling - applies only to the ancestors of the target node.

- -

If you no longer need an event listener, remove it by calling - removeEventListener(), or memory problems could result. Event listeners are not automatically - removed from memory because the garbage - collector does not remove the listener as long as the dispatching object exists (unless the useWeakReference - parameter is set to true).

- -

Copying an EventDispatcher instance does not copy the event listeners attached to it. - (If your newly created node needs an event listener, you must attach the listener after - creating the node.) However, if you move an EventDispatcher instance, the event listeners - attached to it move along with it.

- - -

If the event listener is being registered on a node while an event is being processed - on this node, the event listener is not triggered during the current phase but can be - triggered during a later phase in the event flow, such as the bubbling phase.

- -

If an event listener is removed from a node while an event is being processed on the node, - it is still triggered by the current actions. After it is removed, the event listener is - never invoked again (unless registered again for future processing).

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener function that processes the event. This function must accept - an Event object as its only parameter and must return nothing, as this example shows: - . - - 
function(evt:Event):void
- -

The function can have any name.

- -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Determines whether the listener works in the capture phase or the - target and bubbling phases. If useCapture is set to true, - the listener processes the event only during the capture phase and not in the - target or bubbling phase. If useCapture is false, the - listener processes the event only during the target or bubbling phase. To listen for - the event in all three phases, call addEventListener twice, once with - useCapture set to true, then again with - useCapture set to false. - -
 
priority:int (default = 0) — The priority level of the event listener. The priority is designated by - a signed 32-bit integer. The higher the number, the higher the priority. All listeners - with priority n are processed before listeners of priority n-1. If two - or more listeners share the same priority, they are processed in the order in which they - were added. The default priority is 0. - -
 
useWeakReference:Boolean (default = false) — Determines whether the reference to the listener is strong or - weak. A strong reference (the default) prevents your listener from being garbage-collected. - A weak reference does not.

Class-level member functions are not subject to garbage - collection, so you can set useWeakReference to true for - class-level member functions without subjecting them to garbage collection. If you set - useWeakReference to true for a listener that is a nested inner - function, the function will be garbage-collected and no longer persistent. If you create - references to the inner function (save it in another variable) then it is not - garbage-collected and stays persistent.

-
-
- - - - - -
createMessageChannel()method 
-
-public function createMessageChannel(receiver:Worker):MessageChannel -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Creates a new MessageChannel instance to send messages from the worker on - which the method is called to another receiver worker. Code in the - worker that creates the MessageChannel object can use it - to send one-way messages to the Worker object specified as - the receiver argument. -

Although a MessageChannel instance can be used to send messages and - data from one Worker instance to another, at least one MessageChannel - instance needs to be passed to a child Worker as a shared property by - calling the Worker object's setSharedProperty() method.

- 
-    outgoingChannel = Worker.current.createMessageChannel(bgWorker);
-    incomingChannel = bgWorker.createMessageChannel(Worker.current);
-    
-    bgWorker.setSharedProperty("incoming", outgoingChannel);
-    bgWorker.setSharedProperty("outgoing", incomingChannel);
-    
-    // listen for messages from the receiving MessageChannel
-    // This event is triggered when the background sends a message to this worker
-    incomingChannel.addEventListener(Event.CHANNEL_MESSAGE, incomingMessageHandler);
- - Parameters - - - - -
receiver:Worker — The worker that will receive messages transmitted via - the created message channel -
-

-Returns - - - - -
MessageChannel — - The MessageChannel object created by the operation - - -
-
- - - - - -
getSharedProperty()method 
-
-public function getSharedProperty(key:String):* -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Retrieves a value stored in this worker with a named key. -

Code in a child worker can call this method to retrieve a value as - early as in the constructor of the worker swf's main class.

- Parameters - - - - -
key:String — The name of the shared property to retrieve -
-

-Returns - - - - -
* — The shared property value stored with the specified key, or - null if no value is stored for the specified key -
-
- - - - - -
removeEventListener()method 
-
-public override function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect. - -

Parameters - - - - - - - - - - - - - - - - -
type:String — The type of event. - -
 
listener:Function — The listener object to remove. - -
 
useCapture:Boolean (default = false) — This parameter applies to display objects in the - ActionScript 3.0 display list architecture, used by SWF content. - - Specifies whether the listener was registered for the capture phase or the - target and bubbling phases. If the listener was registered for both the capture phase and the - target and bubbling phases, two calls to removeEventListener() are required - to remove both, one call with useCapture() set to true, and another - call with useCapture() set to false. - -
-
- - - - - -
setSharedProperty()method 
-
-public function setSharedProperty(key:String, value:*):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Provides a named value that is available to code running in the worker's swf. -

You can call this method before calling the worker's start() - method. In that case the shared property is available to code in the - worker's swf at construction time.

-

The value passed to the value parameter can be almost any - object. Other than the exceptions noted below, any object that is passed - to the value parameter is not passed by reference. Any changes made to the - object in one worker after setSharedProperty() is called are - not carried over to the other worker. The object is copied by - serializing it to AMF3 format and deserializing it into a new object in the receiving worker. - For this reason, any object that can't be serialized in AMF3 format, - including display objects, can't be passed to the value parameter. - In order for a custom class to be passed properly, the class definition - must be registered using the flash.net.registerClassAlias() - function or [RemoteClass] metadata. With either technique - the same alias must be used for both worker's versions of the class.

- -

There are five types of objects that are an exception to the rule that - objects aren't shared between workers:

-
    -
  • Worker
    • -
  • MessageChannel
    • -
  • shareable ByteArray (a ByteArray object with its shareable property set to true
    • -
  • Mutex
    • -
  • Condition
    • -
-

If you pass an instance of these objects to the value parameter, each worker has a reference to the same underlying object. Changes made to an instance in one worker are immediately available in other workers. In addition, if you pass the same instance of these objects more than once using setSharedProperty(), the runtime doesn't create a new copy of the object in the receiving worker. Instead, the same reference is re-used, reducing system memory use.

-

Calling this method with null or undefined - for the value argument clears any previously-set value for - the specified key argument. Cleaning up a value in this way - removes the reference to it, allowing it to be garbage collected.

-

You can use any String value in the key argument. These shared - properties are available to any code that has access to a worker. To - avoid unintentionally overwriting a value, consider using a prefix, - suffix, or similar mechanism to attempt to make your key names unique.

- - Parameters - - - - - - - - - - -
key:String — The name under which the shared property is stored. -
 
value:* — The value of the shared property. - -
-

-See also -

-
-MessageChannel class -
-ByteArray.shareable property -
-Mutex class -
-Condition class -
-
- - - - - -
start()method 
-
-public function start():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Starts the execution of the worker. The runtime creates the worker thread - and calls the constructor of the worker swf's main class. -

This operation is asynchronous. Once the worker startup is complete, it - changes its state property to WorkerState.RUNNING - and dispatches a workerState event.

- -
- - - - - -
terminate()method 
-
-public function terminate():Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Stops this worker's code execution. Calling this method aborts any current - ActionScript in the worker's swf. - -

-Returns - - - - -
Boolean — - true if code in the worker was running and - interrupted, or false if the worker was never started - - -
-
-
Event detail
- - - - - -
workerStateevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.WORKER_STATE -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4
-

-Dispatched when the value of the worker's state property changes. - -

- The Event.WORKER_STATE constant defines the value of the type property of a workerState event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that dispatched this event.
-
- -
Examples
-
examples\WorkerExample
-
The following example demonstrates using a Worker object to - perform a task in the background. It also shows communication between the - parent worker and the background worker, including passing a custom class - object between the workers. - -

This example consists of three ActionScript classes: WorkerExample is the - main class and the parent worker. BackgroundWorker is the class that does the - background work. It's compiled as the main class of the background worker swf. - CountResult is a custom class that's used to pass data between the two workers - as a single object rather than as multiple values.

- -

In this example, the background worker counts in a loop up to a number - specified by the parent worker. As it makes progress in its work it sends - progress messages to the parent worker. Finally, when the count is finished - the background worker sends a message to the parent worker notifying it that it - finished and how long it took to count.

- -

The WorkerExample class is the main class of the swf, so it is the main - class of the primordial worker. In the initialize() method, the - code creates the background worker object using the bytes of the - BackgroundWorker class, which are embedded using an [Embed] tag.

- -

After creating the background worker by calling WorkerDomain.createWorker(), - the code sets up communication between the workers. First the code creates a - set of MessageChannel objects. It passes them to the background worker by - calling its setSharedProperty() method. Finally it registers for - the background Worker object's workerState event and starts up - the worker by calling its start() method.

- -

As the background worker does its work, it sends progress (and eventually - result) messages to the parent worker. The parent worker uses this information - to update the progress bar and the text indicator.

-
-
-package
-{
-    import com.adobe.example.vo.CountResult;
-    
-    import flash.display.Shape;
-    import flash.display.Sprite;
-    import flash.display.StageAlign;
-    import flash.display.StageScaleMode;
-    import flash.events.Event;
-    import flash.net.registerClassAlias;
-    import flash.system.MessageChannel;
-    import flash.system.Worker;
-    import flash.system.WorkerDomain;
-    import flash.system.WorkerState;
-    import flash.text.TextField;
-    import flash.text.TextFormat;
-    import flash.text.TextFormatAlign;
-    import flash.utils.ByteArray;
-    
-    public class WorkerExample extends Sprite
-    {
-        // ------- Embed the background worker swf as a ByteArray -------
-        [Embed(source="../workerswfs/BackgroundWorker.swf", mimeType="application/octet-stream")]
-        private static var BackgroundWorker_ByteClass:Class;
-        public static function get BackgroundWorker():ByteArray
-        {
-            return new BackgroundWorker_ByteClass();
-        }
-        
-        
-        private var bgWorker:Worker;
-        private var bgWorkerCommandChannel:MessageChannel;
-        private var progressChannel:MessageChannel;
-        private var resultChannel:MessageChannel;
-        
-        
-        public function WorkerExample()
-        {
-            initialize();
-        }
-        
-        
-        private function initialize():void
-        {
-            // create the user interface
-            setupStage();
-            createStatusText();
-            createProgressBar();
-            
-            // Register the alias so we can pass CountResult objects between workers
-            registerClassAlias("com.adobe.test.vo.CountResult", CountResult);
-            
-            // Create the background worker
-            bgWorker = WorkerDomain.current.createWorker(BackgroundWorker);
-            
-            // Set up the MessageChannels for communication between workers
-            bgWorkerCommandChannel = Worker.current.createMessageChannel(bgWorker);
-            bgWorker.setSharedProperty("incomingCommandChannel", bgWorkerCommandChannel);
-            
-            progressChannel = bgWorker.createMessageChannel(Worker.current);
-            progressChannel.addEventListener(Event.CHANNEL_MESSAGE, handleProgressMessage)
-            bgWorker.setSharedProperty("progressChannel", progressChannel);
-            
-            resultChannel = bgWorker.createMessageChannel(Worker.current);
-            resultChannel.addEventListener(Event.CHANNEL_MESSAGE, handleResultMessage);
-            bgWorker.setSharedProperty("resultChannel", resultChannel);
-            
-            // Start the worker
-            bgWorker.addEventListener(Event.WORKER_STATE, handleBGWorkerStateChange);
-            bgWorker.start();
-        }
-        
-        
-        private function handleBGWorkerStateChange(event:Event):void
-        {
-            if (bgWorker.state == WorkerState.RUNNING) 
-            {
-                _statusText.text = "Background worker started";
-                bgWorkerCommandChannel.send(["startCount", 100000000]);
-            }
-        }
-        
-        
-        private function handleProgressMessage(event:Event):void
-        {
-            var percentComplete:Number = progressChannel.receive();
-            setPercentComplete(percentComplete);
-            _statusText.text = Math.round(percentComplete).toString() + "% complete";
-        }
-        
-        
-        private function handleResultMessage(event:Event):void
-        {
-            var result:CountResult = resultChannel.receive() as CountResult;
-            setPercentComplete(100);
-            _statusText.text = "Counted to " + result.countTarget + " in " + (Math.round(result.countDurationSeconds * 10) / 10) + " seconds";
-        }
-        
-        
-        // ------- Create UI -------
-        
-        private var _currentPercentComplete:int = 0;
-        private var _needsValidation:Boolean = false;
-        private var _statusText:TextField;
-        private var _progressBarRect:Shape;
-        private var _progressBar:Shape;
-        
-        private function setupStage():void
-        {
-            stage.align = StageAlign.TOP_LEFT;
-            stage.scaleMode = StageScaleMode.NO_SCALE;
-            stage.stageWidth = 800;
-            stage.stageHeight = 600;
-            stage.color = 0xffffff;
-        }
-        
-        
-        private function createStatusText():void
-        {
-            _statusText = new TextField();
-            _statusText.width = 400;
-            _statusText.height = 25;
-            _statusText.x = (stage.stageWidth - _statusText.width) / 2;
-            _statusText.y = 150;
-            
-            var statusTextFormat:TextFormat = new TextFormat();
-            statusTextFormat.color = 0xeeeeee;
-            statusTextFormat.font = "Verdana";
-            statusTextFormat.align = TextFormatAlign.CENTER;
-            statusTextFormat.size = 16;
-            _statusText.defaultTextFormat = statusTextFormat;
-            _statusText.wordWrap = false;
-            _statusText.opaqueBackground = 0x999999;
-            _statusText.selectable = false;
-            
-            _statusText.text = "Initializing...";
-            
-            addChild(_statusText);
-        }
-        
-        
-        private function createProgressBar():void
-        {
-            _progressBarRect = new Shape();
-            _progressBarRect.graphics.beginFill(0x000000, 0);
-            _progressBarRect.graphics.lineStyle(2, 0x000000);
-            _progressBarRect.graphics.drawRect(0, 0, 400, 30);
-            _progressBarRect.graphics.endFill();
-            
-            _progressBarRect.x = (stage.stageWidth - _progressBarRect.width) / 2;
-            _progressBarRect.y = 100;
-            
-            addChild(_progressBarRect);
-            
-            _progressBar = new Shape();
-            _progressBar.graphics.beginFill(0x0000ee);
-            _progressBar.graphics.drawRect(0, 0, 391, 21);
-            _progressBar.x = _progressBarRect.x + 4;
-            _progressBar.y = _progressBarRect.y + 4;
-            
-            addChild(_progressBar);
-            
-            _progressBar.scaleX = 0;
-        }
-        
-        private function setPercentComplete(percentComplete:int):void
-        {
-            if (_currentPercentComplete == percentComplete)
-                return;
-            
-            _currentPercentComplete = percentComplete;
-            invalidateValue();
-        }
-        
-        
-        private function invalidateValue():void
-        {
-            if (_needsValidation)
-                return;
-            
-            _needsValidation = true;
-            addEventListener(Event.EXIT_FRAME, validate);
-        }
-        
-        private function validate(event:Event):void
-        {
-            removeEventListener(Event.EXIT_FRAME, validate);
-            _needsValidation = false;
-            
-            _redrawProgressBar();
-        }
-        
-        private function _redrawProgressBar():void
-        {
-            _progressBar.scaleX = _currentPercentComplete / 100;
-        }
-    }
-}
-
-
-
examples\WorkerExample.BackgroundWorker
-
This class contains the code for the background worker. This - class is compiled into its own swf file. That swf file is then embedded in the - main swf. - -

In the initialize() method, it receives the MessageChannel - objects that the parent worker passed in. They are used for communication - between the two workers.

- -

The parent worker calls the send() method on the - commandChannel message channel to send a message. Inside the - background worker, the runtime then dispatches the channelMessage - event by calling the handleCommandMessage() method.

- -

The background worker's actual work takes place in the - count() method. As the background worker proceeds with its count, - it sends progress messages to the parent worker by calling the send() - method on the progressChannel MessageChannel object. When it - finishes counting, it calls the send() method on the - resultChannel MessageChannel object.

-
-
-package com.adobe.example.workers
-{
-    import com.adobe.example.vo.CountResult;
-    
-    import flash.display.Sprite;
-    import flash.events.Event;
-    import flash.net.registerClassAlias;
-    import flash.system.MessageChannel;
-    import flash.system.Worker;
-    import flash.utils.getTimer;
-    
-    public class BackgroundWorker extends Sprite
-    {
-        private var commandChannel:MessageChannel;
-        private var progressChannel:MessageChannel;
-        private var resultChannel:MessageChannel;
-        
-        
-        public function BackgroundWorker()
-        {
-            initialize();
-        }
-        
-        
-        private function initialize():void
-        {
-            registerClassAlias("com.adobe.test.vo.CountResult", CountResult);
-            
-            // Get the MessageChannel objects to use for communicating between workers
-            // This one is for receiving messages from the parent worker
-            commandChannel = Worker.current.getSharedProperty("incomingCommandChannel") as MessageChannel;
-            commandChannel.addEventListener(Event.CHANNEL_MESSAGE, handleCommandMessage);
-            // These are for sending messages to the parent worker
-            progressChannel = Worker.current.getSharedProperty("progressChannel") as MessageChannel;
-            resultChannel = Worker.current.getSharedProperty("resultChannel") as MessageChannel;
-        }        
-        
-        
-        private function handleCommandMessage(event:Event):void
-        {
-            if (!commandChannel.messageAvailable)
-                return;
-            
-            var message:Array = commandChannel.receive() as Array;
-            
-            if (message != null && message[0] == "startCount")
-            {
-                count(uint(message[1]));
-            }
-        }
-        
-        
-        private function count(targetValue:uint):void
-        {
-            var startTime:int = getTimer();
-            var onePercent:uint = uint(Math.ceil(targetValue / 100));
-            var oneHalfPercent:Number = onePercent / 2;
-            
-            var i:uint = 0;
-            while (i < targetValue)
-            {
-                i++;
-                // only send progress messages every one-half-percent milestone
-                // to avoid flooding the message channel
-                if (i % oneHalfPercent == 0)
-                {
-                    progressChannel.send(i / onePercent);
-                }
-            }
-            
-            var elapsedTime:int = getTimer() - startTime;
-            var result:CountResult = new CountResult(targetValue, elapsedTime / 1000);
-            resultChannel.send(result);
-            
-            trace("counted to", targetValue.toString(), "in", elapsedTime, "milliseconds");
-        }
-    }
-}
-
-
-
examples\WorkerExample.CountResult
-
This class defines the CountResult value object. This is a - custom class that is passed between the two workers. In order to pass a custom - class between the workers, each worker calls the registerClassAlias() - method, using the same alias name. -
-
-package com.adobe.example.vo
-{
-    public class CountResult
-    {
-        public function CountResult(countTarget:uint=0, countTime:Number=0)
-        {
-            this.countTarget = countTarget;
-            this.countDurationSeconds = countTime;
-        }
-        
-        public var countTarget:uint;
-        public var countDurationSeconds:Number;
-    }
-}
-
-
-
examples\IOSWorkerExample
-
Concurrency support for iOS has been added from AIR Version 19 and onwards. - Everything remains coherent to Flash/AIR Android, except for differences in loading of SWF - and passing byte array to worker. - -

1. As dynamically loading a remote SWF that contains ActionScript code doesn't work, - the remote SWF has to be passed to worker as a stripped SWF. - 2. Embedding SWFs(having ABC code) using [Embed] tag will not work on iOS. - Each additional worker is created from a separate SWF. To create a new instance of the Worker class, - pass a ByteArray with the bytes of the background worker's SWF as an argument to the - WorkerDomain class's createWorker() method.

- -

There are two common ways to access the bytes of a SWF for this purpose on iOS: - The first way is using Loader to load an external SWF file - and the second is using URLLoader to load SWF file.

- -

The following example uses Loader API to load the SWF file.

-
-
-package
-{
-    import flash.display.Loader;
-	import flash.display.Sprite;
-	import flash.display.StageAlign;
-	import flash.display.StageScaleMode;
-	import flash.events.Event;
-	import flash.events.IOErrorEvent;
-	import flash.net.URLRequest;
-	import flash.system.ApplicationDomain;
-	import flash.system.LoaderContext;
-	import flash.system.MessageChannel;
-	import flash.system.Worker;
-	import flash.system.WorkerDomain;
-	import flash.text.TextField;
-	import flash.text.TextFormat;
-
-	
-	public class IOSWorkerExample extends Sprite
-	{
-		public var worker:Worker;
-		public var bm:MessageChannel;
-		public var mb:MessageChannel;
-		public var tf:TextField;
-		public var tfrmt:TextFormat;
-		
-		public function IOSWorkerExample()
-		{
-			super();
-			
-			
-			stage.align = StageAlign.TOP_LEFT;
-			stage.scaleMode = StageScaleMode.NO_SCALE;
-			
-			tf=new TextField();
-			tfrmt= new TextFormat()
-			tfrmt.size=80;
-			tf.textColor = 0xFFFFF; 
-			tf.defaultTextFormat=tfrmt;
-		
-			addChild(tf);		
-			//creating the urlRequest object that references the background worker.
-			var _urlRequest:URLRequest = new URLRequest("IOSBackWorker.swf");
-			var _loader:Loader = new Loader();
-			var _lc:LoaderContext = new LoaderContext(false, ApplicationDomain.currentDomain, null);
-			
-			_loader.contentLoaderInfo.addEventListener(Event.COMPLETE,completeHandler);
-			_loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR,errorHandler);
-			_loader.load(_urlRequest, _lc);
-			
-		}
-		// This function is called once the swf loading is completed
-		public function completeHandler(e:Event):void
-		{ 
-			
-			worker = WorkerDomain.current.createWorker(e.target.bytes);
-			bm = worker.createMessageChannel(Worker.current);
-			mb = Worker.current.createMessageChannel(worker);
-			
-			worker.setSharedProperty("btm", bm);
-			worker.setSharedProperty("mtb", mb);
-			//adding event handler on message receive from background
-			bm.addEventListener(Event.CHANNEL_MESSAGE, onBackToMain);
-			
-			worker.start();  
-			bm.receive(true);
-			
-		}
-		
-		public function errorHandler(e:IOErrorEvent):void
-		{
-			
-			trace("In IO ErrorEvent Handler  "+e.text);
-		}
-		
-		//This function is called when the main thread receives the message from the background worker.
-		public function onBackToMain(event:Event):void
-		{
-			
-			if(bm.messageAvailable)
-			{
-				// displaying the percentages based on the message received from the background.
-				var progress:Number = bm.receive();
-				trace("progress   "+progress);
-				
-				tf.text= progress.toString();
-			}
-		}
-		
-	}
-}
-
-
-
examples\IOSBackWorker
-
As the code is being executed while load function of - Loader is called, we need to put isPrimordial - property check in background worker as shown in this example. -
-
-package
-{
-    import flash.display.Sprite;
-	import flash.system.MessageChannel;
-	import flash.system.Worker;
-	import flash.utils.ByteArray;
-	import flash.utils.getTimer;
-	
-	public class IOSBackWorker extends Sprite
-	{
-		private var memory:ByteArray = new ByteArray();
-		private var bm:MessageChannel;
-		private var mb:MessageChannel;
-		
-		public function IOSBackWorker()
-		{
-			if(!Worker.current.isPrimordial)
-			{
-				memory.shareable = true;
-				// creating objects of message channels
-				bm = Worker.current.getSharedProperty("btm");
-				mb = Worker.current.getSharedProperty("mtb");
-				
-				// calculating the percentage
-				trace("message came");
-				var j:Number =1;
-				while (j<1000)
-				{
-					for(var i=0;i<100;i++){}
-					var startTime=getTimer();
-					// adding delay
-					while (getTimer()-startTime <100);
-					
-					trace(j, (100*j)/1000);
-					var progress:Number=(100*j)/1000;
-					// sending the percentage to the main thread
-					bm.send(progress);				
-					
-					j++;
-				}			
-			}
-		}		
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/WorkerDomain.html b/html-docs/flash/system/WorkerDomain.html deleted file mode 100644 index 9fb0854..0000000 --- a/html-docs/flash/system/WorkerDomain.html +++ /dev/null @@ -1,519 +0,0 @@ - - - - - - - - -flash.system.WorkerDomain (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class WorkerDomain
InheritanceWorkerDomain Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

-

- The WorkerDomain class provides a way to create Worker objects and access - them. A WorkerDomain represents the runtime's mechanism for managing the set - of workers within a security domain. -

Note: The use of workers for concurrency is supported in - both Flash Player and AIR on desktop platforms. For mobile platforms, - concurrency is supported in AIR on Android but not in AIR on iOS. You can use - the static isSupported property to check whether concurrency is supported - before attempting to use it.

-

You do not create WorkerDomain instances directly by calling the - WorkerDomain() constructor. There is one single WorkerDomain - instance for an application. In contexts where the use of workers for - concurrency is supported, the runtime automatically creates the WorkerDomain - at startup. You access that instance using the static current - property.

-

To create a new instance of the Worker class, use the - createWorker() method. To access the set of Worker objects that - are currently running, use the listWorkers() method.

-

-

-See also -

-
-flash.system.Worker -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  current : WorkerDomain -
[static][read-only] - The WorkerDomain instance in which the code is currently running.
-		WorkerDomain
  isSupported : Boolean -
[static][read-only] - Indicates whether the current runtime context supports the WorkerDomain - and Worker objects for concurrent code execution.
-		WorkerDomain
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-createWorker(swf:ByteArray, giveAppPrivileges:Boolean = false):Worker -
-
- Creates a new Worker instance from the bytes of a swf.
-		WorkerDomain
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-listWorkers():Vector.<Worker>
-
- Provides access to the set of workers in the WorkerDomain that are - currently running (the Worker instance's state property is - WorkerState.RUNNING).
-		WorkerDomain
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
currentproperty
-
-current:WorkerDomain  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- The WorkerDomain instance in which the code is currently running. This is - the only WorkerDomain in the application. -

Implementation -
-    public static function get current():WorkerDomain -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Indicates whether the current runtime context supports the WorkerDomain - and Worker objects for concurrent code execution. -

If concurrency is available, this property's value is true.

- Implementation -
-    public static function get isSupported():Boolean -
-
- -
Method detail
- - - - - -
createWorker()method
-
-public function createWorker(swf:ByteArray, giveAppPrivileges:Boolean = false):Worker -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Creates a new Worker instance from the bytes of a swf. -

Each worker is created from and executes as an isolated swf - application. To create a Worker instance, you obtain the bytes of the SWF - file as a ByteArray instance and pass it to this method. There are three - common ways to access the bytes of a swf for this purpose:

-
    -

  • Use the [Embed] metatag to embed the .swf file in the - application as a ByteArray:

    - 
    -    // Embed the SWF file
-    [Embed(source="../swfs/BgWorker.swf", mimeType="application/octet-stream")]
-    private static var BgWorker_ByteClass:Class;
-    
-    private function createWorker():void
-    {
-      // create the background worker
-      var workerBytes:ByteArray = new BgWorker_ByteClass();
-      var bgWorker:Worker = WorkerDomain.current.createWorker(workerBytes);
-      
-      // listen for worker state changes to know when the worker is running
-      bgWorker.addEventListener(Event.WORKER_STATE, workerStateHandler);
-      
-      // set up communication between workers using 
-      // setSharedProperty(), createMessageChannel(), etc.
-      // ... (not shown)
-      
-      bgWorker.start();
-    }
    -
    • - -

  • Load an external SWF file using a URLLoader:

    - 
    -    // load the SWF file
-    var workerLoader:URLLoader = new URLLoader();
-    workerLoader.dataFormat = URLLoaderDataFormat.BINARY;
-    workerLoader.addEventListener(Event.COMPLETE, loadComplete);
-    workerLoader.load(new URLRequest("BgWorker.swf"));
-    
-    private function loadComplete(event:Event):void
-    {
-      // create the background worker
-      var workerBytes:ByteArray = event.target.data as ByteArray;
-      var bgWorker:Worker = WorkerDomain.current.createWorker(workerBytes);
-      
-      // listen for worker state changes to know when the worker is running
-      bgWorker.addEventListener(Event.WORKER_STATE, workerStateHandler);
-      
-      // set up communication between workers using 
-      // setSharedProperty(), createMessageChannel(), etc.
-      // ... (not shown)
-      
-      bgWorker.start();
-    }
    -
    • - -

  • Use a single swf as both the primordial worker and the - background worker:

    - 
    -    // The primordial worker's main class constructor
-    public function PrimordialWorkerClass()
-    {
-      init();
-    }
-    
-    private function init():void
-    {
-      var swfBytes:ByteArray = this.loaderInfo.bytes;
-      
-      // Check to see if this is the primordial worker
-      if (Worker.current.isPrimordial)    
-      {
-        // create a background worker
-        var bgWorker:Worker = WorkerDomain.current.createWorker(swfBytes);
-        
-        // listen for worker state changes to know when the worker is running
-        bgWorker.addEventListener(Event.WORKER_STATE, workerStateHandler);
-        
-        // set up communication between workers using 
-        // setSharedProperty(), createMessageChannel(), etc.
-        // ... (not shown)
-        
-        bgWorker.start();
-      }
-      else // entry point for the background worker
-      {
-        // set up communication between workers using getSharedProperty()
-        // ... (not shown)
-        
-        // start the background work
-      }
    -
    • -
-

Creating a Worker object using createWorker() does not - start execution of the worker. To start a worker's code execution, call - the Worker object's start() method.

-

Workers are useful because they decrease the chances of the frame rate - dropping due to the main rendering thread being blocked by other code. - However, workers require additional system memory and CPU use, which can - be costly to overall application performance. Because each worker uses - its own instance of the runtime virtual machine, even the overhead of a - trivial worker can be large. When using workers, test your code across - all your target platforms to ensure that the demands on the system are - not too large. Adobe recommends that you do not use more than one or two - background workers in a typical scenario.

- Parameters - - - - - - - - - - -
swf:ByteArray — A ByteArray containing the bytes of a valid swf -
 
giveAppPrivileges:Boolean (default = false) — indicates whether the worker should be given - application sandbox privileges in AIR. This parameter - is ignored in Flash Player -
-

-Returns - - - - -
Worker — - the newly created Worker if creation succeeds. A return value - of null indicates that a worker could not be - created either because the current context doesn't support concurrency - or because creating a new worker would exceed implementation limits. - - -
-
-Throws - - - - -
SecurityError — if the swf whose bytes are passed to the - swf parameter is from a different - security domain than the swf in which this method - is called - -
-
- - - - - -
listWorkers()method 
-
-public function listWorkers():Vector.<Worker> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

- Provides access to the set of workers in the WorkerDomain that are - currently running (the Worker instance's state property is - WorkerState.RUNNING). -

-Returns - - - - -
Vector.<Worker> — A Vector of Worker instances containing the workers that are - currently running. - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/WorkerState.html b/html-docs/flash/system/WorkerState.html deleted file mode 100644 index c938475..0000000 --- a/html-docs/flash/system/WorkerState.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - -flash.system.WorkerState (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.system
Classpublic final class WorkerState
InheritanceWorkerState Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4 -
-

-

- This class defines constants that represent the possible values of the - Worker class's state property. These values are the states - in a Worker object's lifecycle. - -

-

-See also -

-
-Worker class -
-Worker.state property -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  NEW : String = "new"
[static] - This state indicates that an object that represents the new worker has - been created, but the worker is not executing code.
-		WorkerState
  RUNNING : String = "running"
[static] - This state indicates that the worker has begun executing application code - and it has not been instructed to stop execution.
-		WorkerState
  TERMINATED : String = "terminated"
[static] - This state indicates that the worker has been stopped by code in another - worker calling this Worker object's terminate() method.
-		WorkerState
-
- -
- -
Constant detail
- - - - - -
NEWconstant
-
-public static const NEW:String = "new" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4
-

- This state indicates that an object that represents the new worker has - been created, but the worker is not executing code. -

-See also -

-
-Worker.state property -
-
- - - - - -
RUNNINGconstant 
-
-public static const RUNNING:String = "running" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4
-

- This state indicates that the worker has begun executing application code - and it has not been instructed to stop execution. -

-See also -

-
-Worker.state property -
-
- - - - - -
TERMINATEDconstant 
-
-public static const TERMINATED:String = "terminated" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.4
-

- This state indicates that the worker has been stopped by code in another - worker calling this Worker object's terminate() method. -

-See also -

-
-Worker.state property -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/system/package-detail.html b/html-docs/flash/system/package-detail.html deleted file mode 100644 index 37ccecb..0000000 --- a/html-docs/flash/system/package-detail.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - -flash.system Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.system package contains classes for accessing system-level functionality, such as security, garbage collection, etc.

-
-
- -
Functions
- - - - - - - -
 FunctionDescription
 fscommand - Lets the SWF file communicate with either Flash Player or the program hosting Flash Player, - such as a web browser.
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 ApplicationDomain - The ApplicationDomain class is a container for discrete groups of class definitions.
 Capabilities - The Capabilities class provides properties that - describe the system and runtime that are hosting the application.
 ImageDecodingPolicy - The ImageDecodingPolicy class provides values for imageDecodingPolicy in the LoaderContext class.
 IME - The IME class lets you directly manipulate the operating system's input method - editor (IME) in the Flash runtime application that is running on a client computer.
 IMEConversionMode - This class contains constants for use with the IME.conversionMode - property.
 JPEGLoaderContext - The JPEGLoaderContext class includes a property for enabling a deblocking filter when loading a JPEG image.
 LoaderContext - The LoaderContext class provides options for loading SWF files and other media by using the Loader class.
 MessageChannel - The MessageChannel class provides a mechanism for a worker to communicate - with another worker.
 MessageChannelState - This class defines constants that represent the possible values for the - MessageChannel class's state property.
 Security - The Security class lets you specify how content in different domains can communicate with - each other.
 SecurityDomain - The SecurityDomain class represents the current security "sandbox," also known as a security domain.
 SecurityPanel - The SecurityPanel class provides values for specifying - which Security Settings panel you want to display.
 System - The System class contains properties related to local settings and operations.
 SystemUpdater - The SystemUpdater class allows you to update modules of the Flash Player, - such as the DRM module for Adobe Access, as well as the Flash Player itself.
 SystemUpdaterType - The SystemUpdaterType class provides constants for a system update.
 TouchscreenType - The TouchscreenType class is an enumeration class that provides values for the different types of touch screens.
 Worker - A Worker object represents a worker, which is a virtual instance of the - Flash runtime.
 WorkerDomain - The WorkerDomain class provides a way to create Worker objects and access - them.
 WorkerState - This class defines constants that represent the possible values of the - Worker class's state property.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/system/package.html b/html-docs/flash/system/package.html deleted file mode 100644 index 31abd67..0000000 --- a/html-docs/flash/system/package.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - -flash.system Details (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-The flash.system package contains one package-level function, fscommand(), which facilitates communication between a SWF file and its container.
-
Public Functions
- - - - - - - -
 FunctionDefined by
   -
-fscommand(command:String, args:String = ""):void -
-
- Lets the SWF file communicate with either Flash Player or the program hosting Flash Player, - such as a web browser.
-		flash.system
-
- -
Function detail
- - - - - -
fscommand()function
-
-public function fscommand(command:String, args:String = ""):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Lets the SWF file communicate with either Flash Player or the program hosting Flash Player, - such as a web browser. You can also use the fscommand() function to pass messages to - Director or to Visual Basic, Visual C++, and other programs that can host ActiveX controls. - -

The fscommand() function lets a SWF file communicate with a script in a web page. - However, script access is controlled by the web page's allowScriptAccess setting. - (You set this attribute in the HTML code that embeds the SWF file—for - example, in the PARAM tag for Internet Explorer or the EMBED tag for Netscape.)

-
    - -
  • When allowScriptAccess is set to "sameDomain" (the default), - scripting is allowed only from SWF files that are in the same domain as the web page.
    • -
  • When allowScriptAccess is set to "always", - the SWF file can communicate with the HTML page in which it is embedded - even when the SWF file is from a different domain than the HTML page.
    • -
  • When allowScriptAccess is set to "never", - the SWF file cannot communicate with any HTML page. Note that using this value is deprecated and not recommended, - and shouldn't be necessary if you don't serve untrusted SWF files from your own domain. - If you do need to serve untrusted SWF files, Adobe recommends that you create a distinct subdomain - and place all untrusted content there.
    • -
- -

You can prevent a SWF file from using this method by setting the - allowNetworking parameter of the the object and embed - tags in the HTML page that contains the SWF content.

- -

The fscommand() function is not allowed if the calling SWF file is in - the local-with-file-system or local-with-network sandbox and the containing HTML page is in - an untrusted sandbox.

-

For more information related to security, see the Flash Player Developer Center Topic: - Security.

-

Usage 1: To use fscommand() to send a message to Flash Player, you must use predefined commands and parameters. The - following table shows the values that you can specify for the fscommand() function's command and - args parameters. These values control SWF files that are playing in Flash Player, including projectors. (A - projector is a SWF file saved in a format that can run as a stand-alone application—that is, without Flash Player.)

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CommandParameter (args)Purpose
quitNoneCloses the projector.
fullscreentrue or falseSpecifying true sets Flash Player to full-screen mode. Specifying - false returns the player to normal menu view.
allowscaletrue or falseSpecifying false sets the player so that the SWF file is always drawn - at its original size and never scaled. Specifying true forces the SWF file to scale to 100% of the - player.
showmenutrue or falseSpecifying true enables the full set of context menu items. Specifying - false hides all of the context menu items except About Flash Player and Settings.
execPath to application Executes an application from within the projector.
trapallkeystrue or falseSpecifying true sends all key events, including accelerator keys, to - the onClipEvent(keyDown/keyUp) handler in Flash Player.
-

Not all of the commands listed in the table are available in all applications: -

    -
  • None of the commands are available in web players.
    • -
  • All of the commands are available in stand-alone projector applications.
    • -
  • AIR applications should use the flash.desktop.NativeApplication class for similar functions, such as - NativeApplication.nativeApplication.exit() instead of fscommand("quit").
    • -
  • Only allowscale and exec are available in test-movie players.
    • -
-

-

The exec command can contain only the characters A-Z, a-z, 0-9, period (.), and underscore (_). The exec - command runs in the subdirectory fscommand only. In other words, if you use the exec command to call an application, the - application must reside in a subdirectory named fscommand. The exec command works only from within a Flash projector - file.

-

Usage 2: To use fscommand() to send a message to a scripting language such as JavaScript in a web browser, you can - pass any two parameters in the command and args parameters. These parameters can be strings or - expressions, and they are used in a JavaScript function that handles, or catches, the fscommand() function.

-

In a web browser, fscommand() calls the JavaScript function moviename_DoFScommand, which resides in the - web page that contains the SWF file. For moviename, supply the name of the Flash object that you used for the - NAME attribute of the EMBED tag or the ID property of the OBJECT tag. If you assign the SWF file - the name "myMovie", the JavaScript function myMovie_DoFScommand is called.

- -

In the web page that contains the SWF file, set the allowScriptAccess attribute to allow or deny the SWF file's - ability to access the web page, as described above. (You set this attribute in the HTML code that embeds the SWF file—for example, in the - PARAM tag for Internet Explorer or the EMBED tag for Netscape.)

-

In Flash Player 10 and later running in a browser, using this method programmatically to - open a pop-up window may not be successful. Various browsers (and browser configurations) may block pop-up windows - at any time; it is not possible to guarantee any pop-up window will appear. - However, for the best chance of success, use this method to open a pop-up window only in code that executes - as a direct result of a user action (for example, in an event handler for a mouse click or key-press event.)

-

Usage 3: The fscommand() function can send messages to Director (Macromedia Director from Adobe). - These messages are interpreted by Lingo (the Director scripting language) as strings, events, or executable Lingo - code. If a message is a string or an event, you must write the Lingo code to receive the message from the - fscommand() function and carry out an action in Director. For more information, see the Director Support - Center at www.adobe.com/support/director/.

-

Usage 4: In VisualBasic, Visual C++, and other programs that can host ActiveX controls, fscommand() sends a VB event - with two strings that can be handled in the environment's programming language. For more information, use the keywords "Flash method" - to search the Flash Support Center at www.adobe.com/support/flash/.

-

Note: The ExternalInterface class provides better functionality - for communication between JavaScript and ActionScript (Usage 2) and between ActionScript and VisualBasic, Visual C++, or other - programs that can host ActiveX controls (Usage 4). You should continue to use fscommand() for sending messages to Flash - Player (Usage 1) and Director (Usage 3).

- - Parameters - - - - - - - - - - -
command:String — A string passed to the host application for any use, or a command passed to Flash Player. -
 
args:String (default = "") — A string passed to the host application for any use, or a value passed to Flash Player. - -
-
-Throws - - - - -
Error — If the function is not called in response to a user action, such as a mouse - event or keypress event. - -
-

-See also -

-
-flash.desktop.NativeApplication -
-
-Example -
The following example shows how fscommand() can be used to direct - Flash Player to go into full screen mode and not allow scaling. An orange box is then - added to the stage using draw(). In draw(), a click - event listener is added named clickHandler(), which responds to click - events by directing Flash Player to exit using another call to fscommand(). - -

Note: this example should be executed in the standalone Flash Player and - not within a web browser.

-
-
-package {
-    import flash.display.Sprite;
-	import flash.text.TextField;
-	import flash.system.fscommand;
-	import flash.events.MouseEvent;
-
-	public class FSCommandExample extends Sprite {
-		private var bgColor:uint = 0xFFCC00;
-		private var size:uint = 100;
-
-		public function FSCommandExample() {
-			fscommand("fullscreen", "true");
-			fscommand("allowscale", "false");
-			draw();
-		}
-
-		private function clickHandler(event:MouseEvent):void {
-			fscommand("quit");
-			trace("clickHandler");
-		}
-
-		private function draw():void {
-			var child:Sprite = new Sprite();
-			child.graphics.beginFill(bgColor);
-			child.graphics.drawRect(0, 0, size, size);
-			child.graphics.endFill();
-			child.buttonMode = true;
-			addEventListener(MouseEvent.CLICK, clickHandler);
-
-			var label:TextField = new TextField();
-			label.text = "quit";
-			label.selectable = false;
-			label.mouseEnabled = false;
-			child.addChild(label);
-
-			addChild(child);
-		}
-	}
-}
-
-

-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/text/AntiAliasType.html b/html-docs/flash/text/AntiAliasType.html deleted file mode 100644 index 81e76b0..0000000 --- a/html-docs/flash/text/AntiAliasType.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - -flash.text.AntiAliasType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class AntiAliasType
InheritanceAntiAliasType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The AntiAliasType class provides values for anti-aliasing in the flash.text.TextField class. -

-

-See also -

-
-flash.text.TextField -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  ADVANCED : String = "advanced"
[static] - Sets anti-aliasing to advanced anti-aliasing.
-		AntiAliasType
  NORMAL : String = "normal"
[static] - Sets anti-aliasing to the anti-aliasing that is used in Flash Player 7 and earlier.
-		AntiAliasType
-
- -
- -
Constant detail
- - - - - -
ADVANCEDconstant
-
-public static const ADVANCED:String = "advanced" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sets anti-aliasing to advanced anti-aliasing. Advanced anti-aliasing - allows font faces to be rendered at very high quality at small sizes. It is best used - with applications that have a lot of small text. Advanced anti-aliasing is not recommended - for very large fonts (larger than 48 points). - This constant is used for the antiAliasType property in the TextField - class. - Use the syntax AntiAliasType.ADVANCED. - -

-See also -

-
-flash.text.TextField.antiAliasType -
-
- - - - - -
NORMALconstant 
-
-public static const NORMAL:String = "normal" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sets anti-aliasing to the anti-aliasing that is used in Flash Player 7 and earlier. - This setting is recommended for applications that do not have a lot of text. - This constant is used for the antiAliasType property in the TextField - class. - Use the syntax AntiAliasType.NORMAL. -

-See also -

-
-flash.text.TextField.antiAliasType -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/AutoCapitalize.html b/html-docs/flash/text/AutoCapitalize.html deleted file mode 100644 index d421113..0000000 --- a/html-docs/flash/text/AutoCapitalize.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - -flash.text.AutoCapitalize (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class AutoCapitalize
InheritanceAutoCapitalize Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3
-

-

-The AutoCapitalize class defines constants for the -autoCapitalize property of the StageText class. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  ALL : String = "all"
[static] - Capitalize every character.
-		AutoCapitalize
  NONE : String = "none"
[static] - No automatic capitalization.
-		AutoCapitalize
  SENTENCE : String = "sentence"
[static] - Capitalize the first word of every sentence.
-		AutoCapitalize
  WORD : String = "word"
[static] - Capitalize every word.
-		AutoCapitalize
-
- -
- -
Constant detail
- - - - - -
ALLconstant
-
-public static const ALL:String = "all" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Capitalize every character. - -

- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- No automatic capitalization. - -

- - - - - -
SENTENCEconstant 
-
-public static const SENTENCE:String = "sentence" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Capitalize the first word of every sentence. - -

- - - - - -
WORDconstant 
-
-public static const WORD:String = "word" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Capitalize every word. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/CSMSettings.html b/html-docs/flash/text/CSMSettings.html deleted file mode 100644 index 92565b4..0000000 --- a/html-docs/flash/text/CSMSettings.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - - - - -flash.text.CSMSettings (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class CSMSettings
InheritanceCSMSettings Inheritance Object
-

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The CSMSettings class contains properties for use with the - TextRenderer.setAdvancedAntiAliasingTable() method - to provide continuous stroke modulation (CSM). CSM is the continuous - modulation of both stroke weight and edge sharpness. -

-

-See also -

-
-TextRenderer.setAdvancedAntiAliasingTable() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fontSize : Number -
- The size, in pixels, for which the settings apply.
-		CSMSettings
  insideCutoff : Number -
- The inside cutoff value, above which densities are set to a maximum density - value (such as 255).
-		CSMSettings
  outsideCutoff : Number -
- The outside cutoff value, below which densities are set to zero.
-		CSMSettings
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-CSMSettings(fontSize:Number, insideCutoff:Number, outsideCutoff:Number)
-
- Creates a new CSMSettings object which stores stroke values for custom anti-aliasing settings.
-		CSMSettings
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
fontSizeproperty
-
-public var fontSize:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The size, in pixels, for which the settings apply. -

The advancedAntiAliasingTable array passed to the - setAdvancedAntiAliasingTable() method can contain multiple - entries that specify CSM settings for different font sizes. Using this - property, you can specify the font size to which the other settings apply. -

-

-See also -

-
-TextRenderer.setAdvancedAntiAliasingTable() -
-
- - - - - -
insideCutoffproperty 
-
-public var insideCutoff:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The inside cutoff value, above which densities are set to a maximum density - value (such as 255). -

-See also -

-
-TextRenderer.setAdvancedAntiAliasingTable() -
-
- - - - - -
outsideCutoffproperty 
-
-public var outsideCutoff:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The outside cutoff value, below which densities are set to zero. - -

-See also -

-
-TextRenderer.setAdvancedAntiAliasingTable() -
-
- -
Constructor detail
- - - - - -
CSMSettings()constructor
-
-public function CSMSettings(fontSize:Number, insideCutoff:Number, outsideCutoff:Number) -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new CSMSettings object which stores stroke values for custom anti-aliasing settings. -

Parameters - - - - - - - - - - - - - - - - -
fontSize:Number — The size, in pixels, for which the settings apply. -
 
insideCutoff:Number — The inside cutoff value, above which densities are set to a maximum density - value (such as 255). -
 
outsideCutoff:Number — The outside cutoff value, below which densities are set to zero. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/Font.html b/html-docs/flash/text/Font.html deleted file mode 100644 index 1bf5dd7..0000000 --- a/html-docs/flash/text/Font.html +++ /dev/null @@ -1,554 +0,0 @@ - - - - - - - - -flash.text.Font (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic class Font
InheritanceFont Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The Font class is used to manage embedded fonts in SWF files. Embedded fonts - are represented as a subclass of the Font class. The Font class is currently useful only to - find out information about embedded fonts; you cannot alter a font by - using this class. - - You cannot use the Font class to load external fonts, or to create an instance - of a Font object by itself. Use the Font class as an abstract base class. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fontName : String -
[read-only] - The name of an embedded font.
-		Font
  fontStyle : String -
[read-only] - The style of the font.
-		Font
  fontType : String -
[read-only] - The type of the font.
-		Font
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-enumerateFonts(enumerateDeviceFonts:Boolean = false):Array -
-
[static] - Specifies whether to provide a list of the currently available embedded fonts.
-		Font
   -
-hasGlyphs(str:String):Boolean -
-
- Specifies whether a provided string can be displayed using the currently assigned font.
-		Font
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-registerFont(font:Class):void -
-
[static] - Registers a font class in the global font list.
-		Font
   -
-registerFontFromByteArray(fontData:ByteArray):void -
-
[static] - Registers a font class in the global font list, using dynamic data.
-		Font
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
fontNameproperty
-
-fontName:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The name of an embedded font. - -

Implementation -
-    public function get fontName():String -
-
-Example -
The following example shows how you can use an embedded font with the Flash Professional ActionScript 3.0 CheckBox control by setting the textFormat and embedFonts styles. - Example provided by - ActionScriptExamples.com. -
-
-// Requires:
-// - A CheckBox control UI component in Flash library.
-// - An embedded font in Flash library with linkage class "MyFont" and Export for ActionScript checked.
-//
-import fl.controls.CheckBox;
- 
-var embeddedFont:Font = new MyFont();
- 
-var textFormat:TextFormat = new TextFormat();
-textFormat.font = embeddedFont.fontName;
-textFormat.size = 24;
- 
-var checkBox:CheckBox = new CheckBox();
-checkBox.setStyle("textFormat", textFormat);
-checkBox.setStyle("embedFonts", true);
-checkBox.label = "The quick brown fox jumps over the lazy dog.";
-checkBox.textField.autoSize = TextFieldAutoSize.LEFT;
-checkBox.move(10, 10);
-checkBox.validateNow();
-addChild(checkBox);
-
-

-
- - - - - -
fontStyleproperty 
-
-fontStyle:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The style of the font. This value can be any of the values defined in the FontStyle class. - -

Implementation -
-    public function get fontStyle():String -
-

-See also -

-
-flash.text.FontStyle -
-
- - - - - -
fontTypeproperty 
-
-fontType:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The type of the font. This value can be any of the constants defined in the FontType class. - - -

Implementation -
-    public function get fontType():String -
-

-See also -

-
-flash.text.FontType -
-
- -
Method detail
- - - - - -
enumerateFonts()method
-
-public static function enumerateFonts(enumerateDeviceFonts:Boolean = false):Array -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies whether to provide a list of the currently available embedded fonts. -

Parameters - - - - -
enumerateDeviceFonts:Boolean (default = false) — Indicates whether you want to limit the list to only the currently available embedded fonts. - If this is set to true then a list of all fonts, both device fonts and embedded fonts, is returned. - If this is set to false then only a list of embedded fonts is returned. -
-

-Returns - - - - -
Array — - A list of available fonts as an array of Font objects. - - -
-
-Example -
This example first calls the static method Font.enumerateFonts() - to get a list of all device and embedded fonts. Then it sorts the resulting Array of Font objects - by the fontName property. - -

Next the example shows how to call the Font.enumerateFonts() method with the - enumerateDeviceFonts parameter set to false. The resulting Array only includes - embedded Font objects. (If you run this code within an application that does not contain - any embedded fonts, the embeddedFonts array will be empty.)

-
-
- 
-import flash.text.Font;
-
-var allFonts:Array = Font.enumerateFonts(true);
-allFonts.sortOn("fontName", Array.CASEINSENSITIVE);
-
-var embeddedFonts:Array = Font.enumerateFonts(false);
-embeddedFonts.sortOn("fontName", Array.CASEINSENSITIVE);
-
-

-
- - - - - -
hasGlyphs()method 
-
-public function hasGlyphs(str:String):Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies whether a provided string can be displayed using the currently assigned font. -

Parameters - - - - -
str:String — The string to test against the current font. -
-

-Returns - - - - -
Boolean — - A value of true if the specified string can be fully displayed using this font. - - -
-
- - - - - -
registerFont()method 
-
-public static function registerFont(font:Class):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Registers a font class in the global font list. -

Parameters - - - - -
font:Class — The class you want to add to the global font list. -
-
- - - - - -
registerFontFromByteArray()method 
-
-public static function registerFontFromByteArray(fontData:ByteArray):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 51 -
-

- Registers a font class in the global font list, using dynamic data. -

Parameters - - - - -
fontData:ByteArray — A byte array containing the font data you want to add to the global font list. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/FontStyle.html b/html-docs/flash/text/FontStyle.html deleted file mode 100644 index 813570b..0000000 --- a/html-docs/flash/text/FontStyle.html +++ /dev/null @@ -1,352 +0,0 @@ - - - - - - - - -flash.text.FontStyle (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class FontStyle
InheritanceFontStyle Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The FontStyle class provides values for the TextRenderer class. - -

-

-See also -

-
-flash.text.TextRenderer -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  BOLD : String = "bold"
[static] - Defines the bold style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method.
-		FontStyle
  BOLD_ITALIC : String = "boldItalic"
[static] - Defines the combined bold and italic style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method.
-		FontStyle
  ITALIC : String = "italic"
[static] - Defines the italic style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method.
-		FontStyle
  REGULAR : String = "regular"
[static] - Defines the plain style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method.
-		FontStyle
-
- -
- -
Constant detail
- - - - - -
BOLDconstant
-
-public static const BOLD:String = "bold" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the bold style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method. Use the syntax FontStyle.BOLD. -

-See also -

-
-flash.text.TextRenderer.setAdvancedAntiAliasingTable() -
-
- - - - - -
BOLD_ITALICconstant 
-
-public static const BOLD_ITALIC:String = "boldItalic" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the combined bold and italic style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method. Use the syntax FontStyle.BOLD_ITALIC. -

-See also -

-
-flash.text.TextRenderer.setAdvancedAntiAliasingTable() -
-
- - - - - -
ITALICconstant 
-
-public static const ITALIC:String = "italic" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the italic style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method. Use the syntax FontStyle.ITALIC. -

-See also -

-
-flash.text.TextRenderer.setAdvancedAntiAliasingTable() -
-
- - - - - -
REGULARconstant 
-
-public static const REGULAR:String = "regular" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Defines the plain style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method. Use the syntax FontStyle.REGULAR. -

-See also -

-
-flash.text.TextRenderer.setAdvancedAntiAliasingTable() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/FontType.html b/html-docs/flash/text/FontType.html deleted file mode 100644 index ba9fd3f..0000000 --- a/html-docs/flash/text/FontType.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - -flash.text.FontType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class FontType
InheritanceFontType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The FontType class contains the enumerated constants "embedded" - and "device" for the fontType property of the Font class. - -

-

-See also -

-
-flash.text.Font.fontType -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  DEVICE : String = "device"
[static] - Indicates that this is a device font.
-		FontType
  EMBEDDED : String = "embedded"
[static] - Indicates that this is an embedded font.
-		FontType
  EMBEDDED_CFF : String = "embeddedCFF"
[static] - Indicates that this is an embedded CFF font.
-		FontType
-
- -
- -
Constant detail
- - - - - -
DEVICEconstant
-
-public static const DEVICE:String = "device" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates that this is a device font. - The SWF file renders fonts with those installed on the system. -

Using device fonts results in a smaller movie size, because font data - is not included in the file. Device fonts are often a good choice for - displaying text at small point sizes, because anti-aliased text can be blurry - at small sizes. Device fonts are also a good choice for large blocks of text, - such as scrolling text.

-

Text fields that use device fonts may not be displayed the same across different - systems and platforms, because they are rendered with fonts installed on the system. - For the same reason, device fonts are not anti-aliased and may appear jagged at - large point sizes.

-

-See also -

-
-TextField.embedFonts -
-flash.text.engine.FontDescription.fontLookup -
-
- - - - - -
EMBEDDEDconstant 
-
-public static const EMBEDDED:String = "embedded" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates that this is an embedded font. - Font outlines are embedded in the published SWF file. -

Text fields that use embedded fonts are always displayed - in the chosen font, whether or not that font is installed - on the playback system. Also, text fields that use embedded fonts - are always anti-aliased (smoothed). You - can select the amount of anti-aliasing you want by using the - TextField.antiAliasType property.

-

One drawback to embedded fonts is that they increase the size of the SWF file.

-

Fonts of type EMBEDDED can only be used by TextField. - If flash.text.engine classes are directed to use such a font they will fall back to device fonts.

-

-See also -

-
-TextField.embedFonts -
-
- - - - - -
EMBEDDED_CFFconstant 
-
-public static const EMBEDDED_CFF:String = "embeddedCFF" -

- - - - -
Language version: ActionScript ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates that this is an embedded CFF font. - Font outlines and a subset of OpenType tables are embedded in the published SWF file. -

Text that uses embedded CFF fonts is always displayed - in the chosen font, whether or not that font is installed - on the playback system. Also, text that uses embedded CFF fonts - is always anti-aliased (smoothed) by Flash Player. You - can select the rendering mode and hinting for an embedded CFF font using the - flash.text.engine.FontDescription.renderingMode and - flash.text.engine.FontDescription.cffHinting properties.

-

One drawback to embedded CFF fonts is that they increase the size of the SWF file. - However, embedded CFF fonts are typically 20% to 30% smaller than regular embedded fonts.

-

Fonts of type EMBEDDED_CFF can only be used by the flash.text.engine classes. - A TextField directed to use such a font will fail to render.

-

-See also -

-
-flash.text.engine.FontDescription.fontLookup -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/GridFitType.html b/html-docs/flash/text/GridFitType.html deleted file mode 100644 index 9b277fe..0000000 --- a/html-docs/flash/text/GridFitType.html +++ /dev/null @@ -1,336 +0,0 @@ - - - - - - - - -flash.text.GridFitType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class GridFitType
InheritanceGridFitType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The GridFitType class defines values for grid fitting in the TextField class. - -

-

-See also -

-
-flash.text.TextField -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  NONE : String = "none"
[static] - Doesn't set grid fitting.
-		GridFitType
  PIXEL : String = "pixel"
[static] - Fits strong horizontal and vertical lines to the pixel grid.
-		GridFitType
  SUBPIXEL : String = "subpixel"
[static] - Fits strong horizontal and vertical lines to the sub-pixel - grid on LCD monitors.
-		GridFitType
-
- -
- -
Constant detail
- - - - - -
NONEconstant
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Doesn't set grid fitting. Horizontal and vertical lines - in the glyphs are not forced to the pixel grid. - This constant is used in setting the gridFitType property of the - TextField class. This is often a good setting for animation - or for large font sizes. - Use the syntax GridFitType.NONE. -

-See also -

-
-flash.text.TextField.gridFitType -
-
- - - - - -
PIXELconstant 
-
-public static const PIXEL:String = "pixel" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Fits strong horizontal and vertical lines to the pixel grid. - This constant is used in setting the gridFitType property of the - TextField class. This setting only works for left-justified text - fields and acts like the GridFitType.SUBPIXEL constant in static - text. This setting generally provides the best readability for left-aligned text. - Use the syntax GridFitType.PIXEL. -

-See also -

-
-flash.text.TextField.gridFitType -
-
- - - - - -
SUBPIXELconstant 
-
-public static const SUBPIXEL:String = "subpixel" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Fits strong horizontal and vertical lines to the sub-pixel - grid on LCD monitors. (Red, green, and blue are actual pixels on an LCD screen.) - This is often a good setting for right-aligned or center-aligned dynamic - text, and it is sometimes a useful tradeoff for animation vs. text quality. - This constant is used in setting the gridFitType property of the - TextField class. - Use the syntax GridFitType.SUBPIXEL. -

-See also -

-
-flash.text.TextField.gridFitType -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/ReturnKeyLabel.html b/html-docs/flash/text/ReturnKeyLabel.html deleted file mode 100644 index 31fea70..0000000 --- a/html-docs/flash/text/ReturnKeyLabel.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - -flash.text.ReturnKeyLabel (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class ReturnKeyLabel
InheritanceReturnKeyLabel Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3
-

-

-The ReturnKeyLabel class defines the values to use for - the returnKeyLabel property of the StageText class. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  DEFAULT : String = "default"
[static] - Use the default label.
-		ReturnKeyLabel
  DONE : String = "done"
[static] - Use the label, "Done".
-		ReturnKeyLabel
  GO : String = "go"
[static] - Use the label, "Go".
-		ReturnKeyLabel
  NEXT : String = "next"
[static] - Use the label, "Next".
-		ReturnKeyLabel
  SEARCH : String = "search"
[static] - Use the label, "Search".
-		ReturnKeyLabel
-
- -
- -
Constant detail
- - - - - -
DEFAULTconstant
-
-public static const DEFAULT:String = "default" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Use the default label. - -

- - - - - -
DONEconstant 
-
-public static const DONE:String = "done" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Use the label, "Done". - -

- - - - - -
GOconstant 
-
-public static const GO:String = "go" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Use the label, "Go". - -

- - - - - -
NEXTconstant 
-
-public static const NEXT:String = "next" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Use the label, "Next". - -

- - - - - -
SEARCHconstant 
-
-public static const SEARCH:String = "search" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Use the label, "Search". -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/SoftKeyboardType.html b/html-docs/flash/text/SoftKeyboardType.html deleted file mode 100644 index 55a7395..0000000 --- a/html-docs/flash/text/SoftKeyboardType.html +++ /dev/null @@ -1,455 +0,0 @@ - - - - - - - - -flash.text.SoftKeyboardType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class SoftKeyboardType
InheritanceSoftKeyboardType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

-

- The SoftKeyboardType class defines the types of soft keyboards for - mobile applications. You select the keyboard type with the softKeyboardType - property on the text input control. - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  CONTACT : String = "contact"
[static] -

A keypad designed for entering a person's name or phone number.

-		SoftKeyboardType
  DECIMAL : String = "decimalpad"
[static] -

A keyboard optimized for entering numbers along with a decimal.

- -
-		SoftKeyboardType
  DEFAULT : String = "default"
[static] -

Default keyboard for the current input method.

- -
-		SoftKeyboardType
  EMAIL : String = "email"
[static] -

A keyboard optimized for specifying email addresses.

-		SoftKeyboardType
  NUMBER : String = "number"
[static] -

A numeric keypad designed for PIN entry.

-		SoftKeyboardType
  PHONE : String = "phone"
[static] -

A keyboard optimized for entering phone numbers.

-		SoftKeyboardType
  PUNCTUATION : String = "punctuation"
[static] -

A keyboard optimized for entering punctuation.

- -
-		SoftKeyboardType
  URL : String = "url"
[static] -

A keyboard optimized for entering URLs.

-		SoftKeyboardType
-
- -
- -
Constant detail
- - - - - -
CONTACTconstant
-
-public static const CONTACT:String = "contact" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

A keypad designed for entering a person's name or phone number. This keyboard type does not support auto-capitalization.

- -
- - - - - -
DECIMALconstant 
-
-public static const DECIMAL:String = "decimalpad" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 29 -
-

-

A keyboard optimized for entering numbers along with a decimal.

- -
- - - - - -
DEFAULTconstant 
-
-public static const DEFAULT:String = "default" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

Default keyboard for the current input method.

- -
- - - - - -
EMAILconstant 
-
-public static const EMAIL:String = "email" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

A keyboard optimized for specifying email addresses. This type features the "&", "." and space characters prominently.

- -
- - - - - -
NUMBERconstant 
-
-public static const NUMBER:String = "number" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

A numeric keypad designed for PIN entry. This type features the numbers 0 through 9 prominently. This keyboard type does not support auto-capitalization.

- -
- - - - - -
PHONEconstant 
-
-public static const PHONE:String = "phone" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 29 -
-

-

A keyboard optimized for entering phone numbers. This type features the numbers along with "+"," and "#" characters prominently.

- -
- - - - - -
PUNCTUATIONconstant 
-
-public static const PUNCTUATION:String = "punctuation" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

A keyboard optimized for entering punctuation.

- -
- - - - - -
URLconstant 
-
-public static const URL:String = "url" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

-

A keyboard optimized for entering URLs. This type features ".", "/", and ".com" prominently.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/StageText.html b/html-docs/flash/text/StageText.html deleted file mode 100644 index b5849c4..0000000 --- a/html-docs/flash/text/StageText.html +++ /dev/null @@ -1,2841 +0,0 @@ - - - - - - - - -flash.text.StageText (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class StageText
InheritanceStageText Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

-

- - The StageText class is used to present the user with a native text input field. - - -

This class enables mobile applications to gather user input using native text - - input controls on mobile devices. Input controls on mobile devices often have extensive user - - interfaces and supporting behaviors that don't exist on the desktop. For example, many mobile - - devices support text input features like the following:

- - -
    - -
  • auto-complete
    • - -
  • auto-correct
    • - -
  • touch-based text selection
    • - -
  • customizable soft keyboards
    • - -
- - -

The underlying operating system (or a component library bundled with the - - operating system) draws native text input fields. Native text input fields - - provide an experience that is familiar to anyone who has used other applications - - on the same device. However, because the operating system draws the text input - - fields instead of the player, you cannot use embedded fonts.

- - -

AIR profile support: This feature is - - supported on iOS and Android platforms. StageText uses native text - - input fields on Android and iOS mobile devices. On other platforms, StageText - - uses the Flash Runtime TextField.

- - -

When native inputs are used, StageText objects are not display objects - - and you cannot add them to the Flash display list. Instead, you display a - - StageText object by attaching it directly to a stage using the stage - - property. The StageText instance attached to a stage is displayed on top of - - any Flash display objects. You control the size and position of the rendering - - area with the viewPort property. There is no way to control - - depth ordering of different StageText objects. Overlapping two instances - - is not recommended.

- - -

When a StageText object has focus, it has the first opportunity to handle - - keyboard input. The stage to which the StageText object is attached does not - - dispatch any keyboard input events.

- - -

Because the StageText class wraps a different native control on every platform, - - its features are supported to varying degrees by each platform. Where features are - - supported, they may behave differently between platforms. When you attempt to use a - - particular feature on a particular platform, it is best to test the behavior. Only on - - desktop platforms where native controls are not used is StageText behavior - - similar to Flash Runtime text behavior.

- - -

StageText on Apple TV takes focus by default. To manage focus between different - - objects in your application keep a note of below points:

- -
    - -
  • To override default focus from StageText, or to assign focus to any other - - display object use stage.focus
    • - -
  • To assign focus to StageText, use stageText.assignFocus()
    • - -
- -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  autoCapitalize : String -
- - Controls how a device applies auto capitalization to user input.
-		StageText
  autoCorrect : Boolean -
- - Indicates whether a device auto-corrects user input for spelling or - - punctuation mistakes.
-		StageText
  clearButtonMode : String -
[write-only] - - The mode of clearButton for the current StageText Object.
-		StageText
  color : uint -
- - Specifies text color.
-		StageText
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  contentType : String -
- - Provides a hint to the operating system as to the type of content for the text input field.
-		StageText
  displayAsPassword : Boolean -
- - Indicates whether the text field is a password text field.
-		StageText
  editable : Boolean -
- - Indicates whether the user can edit the text field.
-		StageText
  fontFamily : String -
- - Indicates the name of the current font family.
-		StageText
  fontPosture : String -
- - Specifies the font posture, using constants defined in the FontPosture class.
-		StageText
  fontSize : int -
- - The size in pixels for the current font family.
-		StageText
  fontWeight : String -
- - Specifies the font weight, using constants defined in the FontWeight class.
-		StageText
  locale : String -
- - Indicates the locale of the text.
-		StageText
  maxChars : int -
- - Indicates the maximum number of characters that a user can enter into the text field.
-		StageText
  multiline : Boolean -
[read-only] - - Indicates whether the StageText object can display more than one line of - - text.
-		StageText
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  restrict : String -
- - Restricts the set of characters that a user can enter into the text field.
-		StageText
  returnKeyLabel : String -
- - Indicates the label on the Return key for devices that feature a soft keyboard.
-		StageText
  selectionActiveIndex : int -
[read-only] - - The zero-based character index value of the last character in the current selection.
-		StageText
  selectionAnchorIndex : int -
[read-only] - - The zero-based character index value of the first character in the current selection.
-		StageText
  softKeyboardType : String -
- - Controls the appearance of the soft keyboard.
-		StageText
  stage : Stage -
- - The stage on which this StageText object is displayed.
-		StageText
  text : String -
- - The current text in the text field.
-		StageText
  textAlign : String -
- - Indicates the paragraph alignment.
-		StageText
  viewPort : Rectangle -
- - The area on the stage in which the StageText object is displayed.
-		StageText
  visible : Boolean -
- - Indicates whether the StageText object is visible.
-		StageText
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StageText(initOptions:StageTextInitOptions = null)
-
- - Creates a StageText object.
-		StageText
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-assignFocus():void -
-
- - Assigns focus to the StageText object.
-		StageText
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-dispose():void -
-
- - Disposes of the StageText object.
-		StageText
   -
-drawViewPortToBitmapData(bitmap:BitmapData):void -
-
- - Draws the StageText's view port to a bitmap.
-		StageText
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-selectRange(anchorIndex:int, activeIndex:int):void -
-
- - Selects the text specified by the index values of the first and last characters.
-		StageText
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-change -
-		 - - Dispatched after text content changes.StageText
   -
-complete -
-		 - - Dispatched after setting a non-null stage and non-empty viewPort.StageText
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-focusIn -
-		 - - Dispatched when the user is editing text, and the control has keyboard focus.StageText
   -
-focusOut -
-		 - - Dispatched when the user is no longer editing text, and the control no longer has - - keyboard focus.StageText
   -
-keyDown -
-		 - - Dispatched when the user presses a key.StageText
   -
-keyUp -
-		 - - Dispatched when the user releases a key.StageText
   -
-softKeyboardActivate -
-		 - - Dispatched after the soft keyboard is activated, as a result of the - - StageText object acquiring focus.StageText
   -
-softKeyboardActivating -
-		 - - Dispatched before soft keyboard activation, as a result of the - - StageText object acquiring focus.StageText
   -
-softKeyboardDeactivate -
-		 - - Dispatched after the soft keyboard is deactivated, as a result of the - - StageText object losing focus.StageText
-
- -
- -
Property detail
- - - - - -
autoCapitalizeproperty
-
-autoCapitalize:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Controls how a device applies auto capitalization to user input. Valid values are - - defined as constants in the AutoCapitalize class: - -

    - -
  • - - "none" - -
    • - -
  • - - "word" - -
    • - -
  • - - "sentence" - -
    • - -
  • - - "all" - -
    • - -
- - -

This property is only a hint to the underlying platform, because not all devices and operating systems support - - this functionality.

- - -

Note: If you enable autoCapitalize while text is being edited or otherwise in focus, - - the updated behavior isn't applied until focus is released and reestablished.

- - -

The default value is AutoCapitalize.NONE.

-Implementation -
-    public function get autoCapitalize():String -
-    public function set autoCapitalize(value:String):void -
-
-Throws -
- - - - -
ArgumentError — If set to any value which is not a member of AutoCapitalize - - -
-

-See also -

-
-flash.text.AutoCapitalize -
-
- - - - - -
autoCorrectproperty 
-
-autoCorrect:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Indicates whether a device auto-corrects user input for spelling or - - punctuation mistakes. - - -

This property is only a hint to the underlying platform, because not all devices and operating systems support - - this functionality.

- - -

Note: If you enable autoCorrect while text is being edited or otherwise in focus, - - the updated behavior isn't applied until focus is released and reestablished.

- - -

The default value is false.

-Implementation -
-    public function get autoCorrect():Boolean -
-    public function set autoCorrect(value:Boolean):void -
-
- - - - - -
clearButtonModeproperty 
-
-clearButtonMode:String  [write-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 23 - -
-

- - The mode of clearButton for the current StageText Object. - - There are four modes associated with this property: - -

    - -
  • - - To show clearButton while editing: StageTextClearButtonMode.WHILE_EDITING - -
    • - -
  • - - To never show clearButton: StageTextClearButtonMode.NEVER - -
    • - -
  • - - To always show clearButton: StageTextClearButtonMode.ALWAYS - -
    • - -
  • - - To show clearButton unless editing: StageTextClearButtonMode.UNLESS_EDITING - -
    • - -
- - - By default, clearButtonMode property is set as StageTextClearButtonMode.WHILE_EDITING. - -

Note: This property is supported for iOS only.

- - - - Implementation -
-    public function set clearButtonMode(value:String):void -
-
- - - - - -
colorproperty 
-
-color:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Specifies text color. You specify text color as a number containing three 8-bit RGB components. - - The first component represents red, the second represents green, and the third component represents blue. - - For example, 0xFF0000 specifies red, 0x00FF00 specifies green, and - - 0x0000FF specifies blue. The default text color is black (0x000000). - - -

The default value is 0x000000.

-Implementation -
-    public function get color():uint -
-    public function set color(value:uint):void -
-
- - - - - -
contentTypeproperty 
-
-contentType:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Provides a hint to the operating system as to the type of content for the text input field. - -

This can be used to adjust the behaviour or provide auto-completion hints, depending on the - - operating system. It can also result in the OS providing the option to insert a one-time-password - - that has just been received via SMS.

- -

The default is for no special behaviour to be set, which is represented by a null value.

- - - Implementation -
-    public function get contentType():String -
-    public function set contentType(value:String):void -
-

-See also -

-
-flash.text.StageTextContentType -
-
- - - - - -
displayAsPasswordproperty 
-
-displayAsPassword:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Indicates whether the text field is a password text field. If true, - - the text field hides input characters using a substitute character (for example, an - - asterisk). - - -

Note: If you enable displayAsPassword while text is being edited or otherwise in focus, - - the updated behavior isn't applied until focus is released and reestablished.

- - -

Important: On iOS, a multiline stage text object does not display substitute - - characters even when the value of this property is true.

- - -

The default value is false.

-Implementation -
-    public function get displayAsPassword():Boolean -
-    public function set displayAsPassword(value:Boolean):void -
-
- - - - - -
editableproperty 
-
-editable:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Indicates whether the user can edit the text field. - - -

The default value is true.

-Implementation -
-    public function get editable():Boolean -
-    public function set editable(value:Boolean):void -
-
- - - - - -
fontFamilyproperty 
-
-fontFamily:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Indicates the name of the current font family. A value of - - null indicates the system default. To enumerate the available - - fonts, use flash.text.Font.enumerateFonts(). If the - - font family is unknown, the default font family is used. - - -

The default value is null.

-Implementation -
-    public function get fontFamily():String -
-    public function set fontFamily(value:String):void -
-
- - - - - -
fontPostureproperty 
-
-fontPosture:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Specifies the font posture, using constants defined in the FontPosture class. - - -

The default value is FontPosture.NORMAL.

-Implementation -
-    public function get fontPosture():String -
-    public function set fontPosture(value:String):void -
-
-Throws -
- - - - -
ArgumentError — If set to any value which is not a member of FontPosture - - -
-

-See also -

-
-flash.text.engine.FontPosture -
-
- - - - - -
fontSizeproperty 
-
-fontSize:int  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - The size in pixels for the current font family. - - -

The default value is 12.

-Implementation -
-    public function get fontSize():int -
-    public function set fontSize(value:int):void -
-
- - - - - -
fontWeightproperty 
-
-fontWeight:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Specifies the font weight, using constants defined in the FontWeight class. - - -

The default value is FontWeight.NORMAL.

-Implementation -
-    public function get fontWeight():String -
-    public function set fontWeight(value:String):void -
-
-Throws -
- - - - -
ArgumentError — If set to any value which is not a member of FontWeight - - -
-

-See also -

-
-flash.text.engine.FontWeight -
-
- - - - - -
localeproperty 
-
-locale:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Indicates the locale of the text. StageText uses the standard locale identifiers. For - - example "en", "en_US" and "en-US" are all English; "ja" is Japanese. - - See iso639-2 code list - - for a list of locale codes. - - -

The default value is en.

-Implementation -
-    public function get locale():String -
-    public function set locale(value:String):void -
-
- - - - - -
maxCharsproperty 
-
-maxChars:int  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Indicates the maximum number of characters that a user can enter into the text field. - - A script can insert more text than maxChars allows. If maxChars - - equals zero, a user can enter an unlimited amount of text into the text field. - - -

The default value is 0.

-Implementation -
-    public function get maxChars():int -
-    public function set maxChars(value:int):void -
-
- - - - - -
multilineproperty 
-
-multiline:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Indicates whether the StageText object can display more than one line of - - text. Read-only. This value matches that of the multiline - - property in the StageTextInitOptions object used during construction. - - -

Implementation -
-    public function get multiline():Boolean -
-

-See also -

-
-flash.text.StageTextInitOptions -
-
- - - - - -
restrictproperty 
-
-restrict:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Restricts the set of characters that a user can enter into the text field. - - The system scans the restrict string from left to right. - - -

The value of restrict specifies the following text input restriction rules:

- -
    - -
  • If the value is null, a user can enter any character.
    • - -
  • If the value is an empty string, a user cannot enter any characters.
    • - -
  • If the value is a string of characters, a user can enter only the characters in the string.
    • - -
  • If the value includes a caret (^), a user cannot enter any characters that follow the caret.
    • - -
  • The value can specify a range of allowable input characters by using the hyphen (-) character.
    • - -
  • The value can use the \u escape sequence to construct a restrict string.
    • - -
- - -

Special Characters:

- -

Use a backslash to enter a caret (^) or dash (-) character verbatim. The accepted backslash sequences are \-, \^ and \\. - - The backslash must be an actual character in the string. When you specify a backslash in ActionScript, use a double backslash.

- - -

Examples of restrict property settings:

- -

The following example allows a user to enter only the dash (-) and caret (^) characters:

- - 
-
-         my_txt.restrict = "\\-\\^";
-
-
- -

The following example allows a user to enter only uppercase characters, spaces, and numbers:

- - 
-
-         my_txt.restrict = "A-Z 0-9";
-
-
- -

The following example excludes only lowercase letters:

- - 
-
-         my_txt.restrict = "^a-z";
-
-
- -

The following example allows a user to enter only uppercase letters, but excludes the uppercase letter Q:

- - 
-
-         my_txt.restrict = "A-Z^Q";
-
-
- -

The following example allows a user to enter only the characters from ASCII 32 (space) to ASCII 126 (tilde).

- - 
-
-         my_txt.restrict = "\u0020-\u007E";
-
-
- - -

Note: Restrictions apply only to user input; a script can insert any characters into the text field.

- - -

The default value is null.

-Implementation -
-    public function get restrict():String -
-    public function set restrict(value:String):void -
-
- - - - - -
returnKeyLabelproperty 
-
-returnKeyLabel:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Indicates the label on the Return key for devices that feature a soft keyboard. - - The available values are constants defined in the ReturnKeyLabel - - class: - -

    - -
  • - - "default" - -
    • - -
  • - - "done" - -
    • - -
  • - - "go" - -
    • - -
  • - - "next" - -
    • - -
  • - - "search" - -
    • - -
- -

- - This property is only a hint to the underlying platform, because not all devices and operating systems support - - these values. This property has no affect on devices that do not feature a soft keyboard. - -

- - -

The default value is ReturnKeyLabel.DEFAULT.

-Implementation -
-    public function get returnKeyLabel():String -
-    public function set returnKeyLabel(value:String):void -
-
-Throws -
- - - - -
ArgumentError — If set to any value which is not a member of ReturnKeyLabel - - -
-

-See also -

-
-flash.text.ReturnKeyLabel -
-
- - - - - -
selectionActiveIndexproperty 
-
-selectionActiveIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - The zero-based character index value of the last character in the current selection. - - For example, the first character is 0, the second character is 1, and so on. - -

If no text is selected, this method returns the insertion point. - - If the StageText instance does not have focus, this method returns -1. - -

- - -

On iOS, this property is not supported for for non-multiline StageText objects - - and returns -1.

- - - Implementation -
-    public function get selectionActiveIndex():int -
-

-See also -

-
-setSelection() -
-
- - - - - -
selectionAnchorIndexproperty 
-
-selectionAnchorIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - The zero-based character index value of the first character in the current selection. - - For example, the first character is 0, the second character is 1, and so on. - -

If no text is selected, this method returns the insertion point. - - If the StageText instance does not have focus, this method returns -1. - -

- - -

On iOS, this property is not supported for for non-multiline StageText objects - - and returns -1.

- - - Implementation -
-    public function get selectionAnchorIndex():int -
-

-See also -

-
-setSelection() -
-
- - - - - -
softKeyboardTypeproperty 
-
-softKeyboardType:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - - - -
-

- - Controls the appearance of the soft keyboard. - -

- - Devices with soft keyboards can customize the keyboard's buttons - - to match the type of input expected. For example, if numeric - - input is expected, a device can use SoftKeyboardType.NUMBER to - - display only numbers on the soft keyboard. - - Valid values are defined as constants in the SoftKeyboardType class: - -

- -
    - -
  • - - "default" - -
    • - -
  • - - "punctuation" - -
    • - -
  • - - "url" - -
    • - -
  • - - "number" - -
    • - -
  • - - "contact" - -
    • - -
  • - - "email" - -
    • - -
  • - - "phone" - -
    • - -
  • - - "decimalpad" - -
    • - -
- -

- - These values serve as hints, to help a device display the best keyboard for the current operation. - -

- - -

The default value is SoftKeyboardType.DEFAULT.

-Implementation -
-    public function get softKeyboardType():String -
-    public function set softKeyboardType(value:String):void -
-
-Throws -
- - - - -
ArgumentError — If set to any value which is not a member of SoftKeyboardType - - -
-

-See also -

-
-flash.text.SoftKeyboardType -
-
- - - - - -
stageproperty 
-
-stage:Stage  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - The stage on which this StageText object is displayed. - - -

Set stage to null to hide this StageText object.

- - -

The default value is null.

-Implementation -
-    public function get stage():Stage -
-    public function set stage(value:Stage):void -
-
- - - - - -
textproperty 
-
-text:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - The current text in the text field. The carriage return character - - ('\r', ASCII 13) separates lines of text. - - Text contained in this property is unformatted (it has no - - formatting tags). - - -

The default value is null.

-Implementation -
-    public function get text():String -
-    public function set text(value:String):void -
-
- - - - - -
textAlignproperty 
-
-textAlign:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Indicates the paragraph alignment. Valid values are defined as constants in - - the TextFormatAlign class: - -

    - -
  • - - "left" - -
    • - -
  • - - "center" - -
    • - -
  • - - "right" - -
    • - -
  • - - "justify" - -
    • - -
  • - - "start" - -
    • - -
  • - - "end" - -
    • - -
- - -

- - Not all platforms support every textAlign value. - - For unsupported textAlign values, platforms use - - the default value (TextFormatAlign.START). - -

- - -

The default value is TextFormatAlign.START.

-Implementation -
-    public function get textAlign():String -
-    public function set textAlign(value:String):void -
-
-Throws -
- - - - -
ArgumentError — If set to any value which is not a member of TextFormatAlign - - -
-

-See also -

-
-flash.text.TextFormatAlign -
-
- - - - - -
viewPortproperty 
-
-viewPort:Rectangle  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - The area on the stage in which the StageText object is displayed. The - - default is the zero rect. - - -

Implementation -
-    public function get viewPort():Rectangle -
-    public function set viewPort(value:Rectangle):void -
-
-Throws -
- - - - -
RangeError — The Rectangle value is not valid. - -
-
- - - - - -
visibleproperty 
-
-visible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Indicates whether the StageText object is visible. StageText objects that are not visible - - are disabled. - - - -

Implementation -
-    public function get visible():Boolean -
-    public function set visible(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
StageText()constructor
-
-public function StageText(initOptions:StageTextInitOptions = null) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Creates a StageText object. - - -

The StageText object is invisible until it is attached to a stage and until the viewPort - - property is set.

- - - Parameters - - - - -
initOptions:StageTextInitOptions (default = null)
-
- -
Method detail
- - - - - -
assignFocus()method
-
-public function assignFocus():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Assigns focus to the StageText object. For non-editable objects, - - assignFocus() does nothing. - - -

- - - - - -
dispose()method 
-
-public function dispose():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Disposes of the StageText object. - - -

Calling dispose() is optional. If you do not maintain a reference to this - - StageText instance, it is eligible for garbage collection. Calling dispose() - - can make garbage collection occur sooner, or occur at a more convenient time.

- - -
- - - - - -
drawViewPortToBitmapData()method 
-
-public function drawViewPortToBitmapData(bitmap:BitmapData):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3.0 - -
-

- - Draws the StageText's view port to a bitmap. - -

Capture the bitmap and set the stage to null to - - display the content above the StageText object.

- - -

The bitmap is typically the same width and height as the viewport. Starting with AIR 15.0, when the - - player is on HiDPI displays, the bitmap's width and height can optionally be - - contentsScaleFactor times the width and height of the viewport. For instance, on a Mac - - Retina Display, contentsScaleFactor is 2, because the pixel resolution of the stage is - - doubled, so the bitmap can correspondingly be twice the size of the viewport.

- - -

If you call this method before the Event.COMPLETE event, the method could draw the - - view port incorrectly.

- - - Parameters - - - - -
bitmap:BitmapData — The BitmapData object on which to draw the visible portion of the StageText's view port. - - -
-
-Throws - - - - - - - - - - -
ArgumentError — The bitmap's width or height is different from view port's width or height. - -
 
Error — The bitmap is null. - -
-
- - - - - -
selectRange()method 
-
-public function selectRange(anchorIndex:int, activeIndex:int):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Selects the text specified by the index values of the first and last characters. - - You specify the first and last characters of the selection in the - - anchorIndex and activeIndex parameters. If both parameter - - values are the same, this method sets the insertion point. - - -

On iOS, for non-multiline StageText objects, this function is not supported and always - - returns -1. If you call this method selecting the complete text string, the selection is visible. - - However, if you call this method selecting a subset of the text string, the selection is not visible. - -

- - -

For some devices or operating systems, the selection is only visible - - when the StageText object has focus.

- - - Parameters - - - - - - - - - - -
anchorIndex:int — The zero-based index value of the first character in the selection - - (the first character's index value is 0). - - -
 
activeIndex:int — The zero-based index value of the last character in the selection. - - -
-

-See also -

-
-selectionBeginIndex -
-selectionEndIndex -
-
-
Event detail
- - - - - -
changeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CHANGE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched after text content changes. This event can be dispatched on every change, or not - - until a set of changes is completed. - - -

- The Event.CHANGE constant defines the value of the type property of a change event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object that has had its value modified. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
- - - - - -
completeevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched after setting a non-null stage and non-empty viewPort. Indicates - - that the implementation has finished laying out the StageText object, and - - you can now call the drawViewPortToBitmapData method. - - Depending upon the platform, this event could be dispatched synchronously or - - asynchronously with the setting of the stage, viewPort, or both. - - -

- The Event.COMPLETE constant defines the value of the type property of a complete event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe network object that has completed loading. -
- -
- - - - - -
focusInevent  
-
-Event object type: flash.events.FocusEvent -
-FocusEvent.type property = flash.events.FocusEvent.FOCUS_IN -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched when the user is editing text, and the control has keyboard focus. - - -

- Defines the value of the type property of a focusIn event object. -

This event has the following properties:

- - - - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
keyCode0; applies only to keyFocusChange events.
relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
shiftKeyfalse; applies only to keyFocusChange events.
targetThe InteractiveObject instance that has just received focus. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event. -
directionThe direction from which focus was assigned. This property reports - the value of the direction parameter of the assignFocus() method of the stage. - If the focus changed through some other means, the value will always be FocusDirection.NONE. - Applies only to focusIn events. For all other focus events the value will be - FocusDirection.NONE.
- -
- - - - - -
focusOutevent  
-
-Event object type: flash.events.FocusEvent -
-FocusEvent.type property = flash.events.FocusEvent.FOCUS_OUT -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched when the user is no longer editing text, and the control no longer has - - keyboard focus. - - -

- Defines the value of the type property of a focusOut event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
keyCode0; applies only to keyFocusChange events.
relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
shiftKeyfalse; applies only to keyFocusChange events.
targetThe InteractiveObject instance that has just lost focus. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event. -
- -
- - - - - -
keyDownevent  
-
-Event object type: flash.events.KeyboardEvent -
-KeyboardEvent.type property = flash.events.KeyboardEvent.KEY_DOWN -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - 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 useful for - - entering characters that the standard QWERTY keyboard is ill-equipped - - to produce (for example, Chinese ideographs).

- - -

This event occurs before the keyUp event.

- - -

This event is not dispatched for all keys. The keys that cause this event to be dispatched - - vary by platform.

- - -

In AIR, canceling this event prevents the character from being entered into a text field.

- - -

- - The KeyboardEvent.KEY_DOWN constant defines the value of the type property of a keyDown event object. - - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblestrue
cancelabletrue in AIR, false in Flash Player; - - in AIR, canceling this event prevents the character from being entered into a text field.
charCodeThe character code value of the key pressed or released.
commandKeytrue on Mac if the Command key is active. Otherwise, false
controlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Control key is active. Otherwise, false
ctrlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
keyCodeThe key code value of the key pressed or released.
keyLocationThe location of the key on the keyboard.
shiftKeytrue if the Shift key is active; false if it is inactive.
functionKeytrue if the Function key is active (Mac only); false if it is inactive.
targetThe InteractiveObject instance with focus. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
keyUpevent  
-
-Event object type: flash.events.KeyboardEvent -
-KeyboardEvent.type property = flash.events.KeyboardEvent.KEY_UP -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - 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 that the standard QWERTY keyboard is ill-equipped to produce (for example, - - Chinese ideographs).

- - -

This event occurs after a keyDown event.

- - -

This event is not dispatched for all keys. The keys that cause this event to be dispatched - - vary by platform.

- - -

- - The KeyboardEvent.KEY_UP constant defines the value of the type property of a keyUp event object. - -

This event has the following properties:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
charCodeContains the character code value of the key pressed or released.
commandKeytrue on Mac if the Command key is active. Otherwise, false
controlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Control key is active. Otherwise, false
ctrlKeytrue on Windows if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event - - object with an event listener.
keyCodeThe key code value of the key pressed or released.
keyLocationThe location of the key on the keyboard.
shiftKeytrue if the Shift key is active; false if it is inactive.
functionKeytrue if the Function key is active (Mac only); false if it is inactive.
targetThe InteractiveObject instance with focus. - - The target is not always the object in the display list - - that registered the event listener. Use the currentTarget - - property to access the object in the display list that is currently processing the event.
- - - -
- - - - - -
softKeyboardActivateevent  
-
-Event object type: flash.events.SoftKeyboardEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched after the soft keyboard is activated, as a result of the - - StageText object acquiring focus. - - -

- - - - - -
softKeyboardActivatingevent  
-
-Event object type: flash.events.SoftKeyboardEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched before soft keyboard activation, as a result of the - - StageText object acquiring focus. - - -

- - - - - -
softKeyboardDeactivateevent  
-
-Event object type: flash.events.SoftKeyboardEvent -
-

-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3 - -
-

- - Dispatched after the soft keyboard is deactivated, as a result of the - - StageText object losing focus. - - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/StageTextClearButtonMode.html b/html-docs/flash/text/StageTextClearButtonMode.html deleted file mode 100644 index 2a22b32..0000000 --- a/html-docs/flash/text/StageTextClearButtonMode.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - -flash.text.StageTextClearButtonMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class StageTextClearButtonMode
InheritanceStageTextClearButtonMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 23 -
-

-

- This class defines an enumeration that provides option for clearButton. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  ALWAYS : String = "always"
[static] - StageText clearButton is always shown -
-		StageTextClearButtonMode
  NEVER : String = "never"
[static] - StageText clearButton is never shown -
-		StageTextClearButtonMode
  UNLESS_EDITING : String = "unlessEditing"
[static] - StageText clearButton is not shown while editing -
-		StageTextClearButtonMode
  WHILE_EDITING : String = "whileEditing"
[static] - StageText clearButton is visible while editing -
-		StageTextClearButtonMode
-
- -
- -
Constant detail
- - - - - -
ALWAYSconstant
-
-public static const ALWAYS:String = "always" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 23 -
-

- StageText clearButton is always shown -

- - - - - -
NEVERconstant 
-
-public static const NEVER:String = "never" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 23 -
-

- StageText clearButton is never shown -

- - - - - -
UNLESS_EDITINGconstant 
-
-public static const UNLESS_EDITING:String = "unlessEditing" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 23 -
-

- StageText clearButton is not shown while editing -

- - - - - -
WHILE_EDITINGconstant 
-
-public static const WHILE_EDITING:String = "whileEditing" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 23 -
-

- StageText clearButton is visible while editing -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/StageTextContentType.html b/html-docs/flash/text/StageTextContentType.html deleted file mode 100644 index 772c420..0000000 --- a/html-docs/flash/text/StageTextContentType.html +++ /dev/null @@ -1,506 +0,0 @@ - - - - - - - - -flash.text.StageTextContentType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class StageTextContentType
InheritanceStageTextContentType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

-

- - The StageTextContentType class defines the content type/hint that is provided to mobile - - operating systems when using a StageText text input control. The behaviour will be - - different on the different platforms - for example on Android this is primarily used as - - a hint to an auto-fill service, whereas on iPhoneOS this can change the type/behaviour of - - the keyboard. One of the key uses is the SMS_OTP value which can be used to - - bring a one-time password from a text message into the text field. - - - The appropriate value here should be set on the StageText.contentType property. - - - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ADDRESS : String = "address"
[static] - -

Content is an address

- - - -
-		StageTextContentType
  DOB : String = "date_of_birth"
[static] - -

Content is a date of birth

- - - -
-		StageTextContentType
  EMAIL_ADDRESS : String = "email_address"
[static] - -

Content is an email address

- - - -
-		StageTextContentType
  NAME : String = "name"
[static] - -

Content is a name

- - - -
-		StageTextContentType
  OTP_SMS : String = "otp_sms"
[static] - -

Content is a One-Time-Password from an SMS

- - - -
-		StageTextContentType
  PASSWORD : String = "password"
[static] - -

Content is a password

- - - -
-		StageTextContentType
  PHONE_NUMBER : String = "phone_number"
[static] - -

Content is a phone number

- - - -
-		StageTextContentType
-
- -
- -
Constant detail
- - - - - -
ADDRESSconstant
-
-public static const ADDRESS:String = "address" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- -

Content is an address

- - - -
- - - - - -
DOBconstant 
-
-public static const DOB:String = "date_of_birth" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- -

Content is a date of birth

- - - -
- - - - - -
EMAIL_ADDRESSconstant 
-
-public static const EMAIL_ADDRESS:String = "email_address" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- -

Content is an email address

- - - -
- - - - - -
NAMEconstant 
-
-public static const NAME:String = "name" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- -

Content is a name

- - - -
- - - - - -
OTP_SMSconstant 
-
-public static const OTP_SMS:String = "otp_sms" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- -

Content is a One-Time-Password from an SMS

- - - -
- - - - - -
PASSWORDconstant 
-
-public static const PASSWORD:String = "password" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- -

Content is a password

- - - -
- - - - - -
PHONE_NUMBERconstant 
-
-public static const PHONE_NUMBER:String = "phone_number" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- -

Content is a phone number

- - - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/StageTextInitOptions.html b/html-docs/flash/text/StageTextInitOptions.html deleted file mode 100644 index 994a7d8..0000000 --- a/html-docs/flash/text/StageTextInitOptions.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - - - - -flash.text.StageTextInitOptions (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic class StageTextInitOptions
InheritanceStageTextInitOptions Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

-

- The StageTextInitOptions class defines the options available for initializing - a StageText object. - -

-

-See also -

-
-StageText -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  multiline : Boolean -
- Specifies whether the StageText object displays multiple lines of text.
-		StageTextInitOptions
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StageTextInitOptions(multiline:Boolean = false)
-
- Creates a StageTextInitOptions object.
-		StageTextInitOptions
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
multilineproperty
-
-multiline:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Specifies whether the StageText object displays multiple lines of text. - -

Implementation -
-    public function get multiline():Boolean -
-    public function set multiline(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
StageTextInitOptions()constructor
-
-public function StageTextInitOptions(multiline:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.0 -
-

- Creates a StageTextInitOptions object. - -

Parameters - - - - -
multiline:Boolean (default = false) — set to true to create multiline StageText objects. - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/StaticText.html b/html-docs/flash/text/StaticText.html deleted file mode 100644 index 186b345..0000000 --- a/html-docs/flash/text/StaticText.html +++ /dev/null @@ -1,694 +0,0 @@ - - - - - - - - -flash.text.StaticText (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class StaticText
InheritanceStaticText Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- This class represents StaticText objects on the display list. - You cannot create a StaticText object using ActionScript. Only the authoring tool - can create a StaticText object. An attempt to create a new StaticText object generates - an ArgumentError. -

To create a reference to an existing static text field in ActionScript 3.0, - you can iterate over the items in the display list. For example, the following snippet checks - to see if the display list contains a static text field and assigns the field to - a variable:

- 
- var i:uint;
- for (i = 0; i < this.numChildren; i++) {
-     var displayitem:DisplayObject = this.getChildAt(i);
-     if (displayitem instanceof StaticText) {
-         trace("a static text field is item " + i + " on the display list");
-         var myFieldLabel:StaticText = StaticText(displayitem);
-         trace("and contains the text: " + myFieldLabel.text);
-     }
- }
-
-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
  text : String -
[read-only] - Returns the current text of the static text field.
-		StaticText
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
-
- -
- -
Property detail
- - - - - -
textproperty
-
-text:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the current text of the static text field. The authoring tool may export multiple text field - objects comprising the complete text. For example, for vertical text, the authoring tool will create - one text field per character. -

Implementation -
-    public function get text():String -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/StyleSheet.html b/html-docs/flash/text/StyleSheet.html deleted file mode 100644 index 049fc88..0000000 --- a/html-docs/flash/text/StyleSheet.html +++ /dev/null @@ -1,976 +0,0 @@ - - - - - - - - -flash.text.StyleSheet (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic dynamic class StyleSheet
InheritanceStyleSheet Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The StyleSheet class lets you create a StyleSheet object that contains text - formatting rules for font size, color, and other styles. You can then apply - styles defined by a style sheet to a TextField object that contains HTML- or - XML-formatted text. The text in the TextField object is automatically - formatted according to the tag styles defined by the StyleSheet object. - You can use text styles to define new formatting tags, redefine built-in HTML - tags, or create style classes that you can apply to certain HTML tags. - -

To apply styles to a TextField object, assign the StyleSheet - object to a TextField object's styleSheet property.

-

Note: A text field with a style sheet is not editable. In other words, a text field with the type property set to TextFieldType.INPUT applies the StyleSheet to the default text for the text field, but the content will no longer be editable by the user. Consider using the TextFormat class to assign styles to input text fields.

-

Flash Player supports a subset of properties in the original CSS1 specification - (www.w3.org/TR/REC-CSS1). - The following table shows the supported Cascading Style Sheet (CSS) properties and values, as well as their corresponding - ActionScript property names. (Each ActionScript property name is derived from the corresponding - CSS property name; if the name contains a hyphen, the hyphen is omitted and the subsequent character is capitalized.)

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CSS propertyActionScript propertyUsage and supported values
colorcolorOnly hexadecimal color values are supported. Named colors (such as blue) - are not supported. Colors are written in the following format: #FF0000.
displaydisplaySupported values are inline, block, and none.
font-familyfontFamilyA comma-separated list of fonts to use, in descending order of desirability. Any font - family name can be used. If you specify a generic font name, it is converted to an - appropriate device font. The following font conversions are available: mono is - converted to _typewriter, sans-serif is converted to - _sans, and serif is converted to _serif.
font-sizefontSize Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points - are equivalent.
font-stylefontStyleRecognized values are normal and italic.
font-weightfontWeightRecognized values are normal and bold.
kerningkerningRecognized values are true and false. - Kerning is supported for embedded fonts only. Certain fonts, such as Courier New, do not support kerning. - The kerning property is only supported in SWF files created in Windows, not in SWF files created on the - Macintosh. However, these SWF files can be played in non-Windows versions of Flash Player and the kerning - still applies.
leadingleadingThe amount of space that is uniformly distributed between lines. The value specifies the - number of pixels that are added after each line. A negative value condenses the space - between lines. Only the numeric part of the value is used. Units (px, pt) are not parsed; - pixels and points are equivalent.
letter-spacingletterSpacingThe amount of space that is uniformly distributed between characters. - The value specifies the number of pixels that are added after each - character. A negative value condenses the space between characters. Only the numeric part of the - value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
margin-leftmarginLeftOnly the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points - are equivalent.
margin-rightmarginRightOnly the numeric part of the value is used. Units (px, pt) are not parsed; pixels and - points are equivalent.
text-aligntextAlignRecognized values are left, center, right, and - justify.
text-decorationtextDecorationRecognized values are none and underline.
text-indenttextIndentOnly the numeric part of the value is used. Units (px, pt) are not parsed; pixels and - points are equivalent.
-

You can use the StyleSheet class to perform low-level text rendering. - However, in Flex, you typically use the Label, Text, TextArea, and TextInput controls to process text.

- - -

-

-View the examples. -

-

-See also -

-
-flash.text.TextField -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  styleNames : Array -
[read-only] - An array that contains the names (as strings) of all of the styles registered - in this style sheet.
-		StyleSheet
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-StyleSheet()
-
- Creates a new StyleSheet object.
-		StyleSheet
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-clear():void -
-
- Removes all styles from the style sheet object.
-		StyleSheet
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-getStyle(styleName:String):Object -
-
- Returns a copy of the style object associated with the style named styleName.
-		StyleSheet
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-parseCSS(CSSText:String):void -
-
- Parses the CSS in CSSText and loads the style sheet with it.
-		StyleSheet
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setStyle(styleName:String, styleObject:Object):void -
-
- Adds a new style with the specified name to the style sheet object.
-		StyleSheet
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-transform(formatObject:Object):TextFormat -
-
- Extends the CSS parsing capability.
-		StyleSheet
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
styleNamesproperty
-
-styleNames:Array  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array that contains the names (as strings) of all of the styles registered - in this style sheet. - -

Implementation -
-    public function get styleNames():Array -
-
- -
Constructor detail
- - - - - -
StyleSheet()constructor
-
-public function StyleSheet() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new StyleSheet object. - -

-See also -

-
-flash.text.StyleSheet.getStyle() -
-
- -
Method detail
- - - - - -
clear()method
-
-public function clear():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Removes all styles from the style sheet object. -

- - - - - -
getStyle()method 
-
-public function getStyle(styleName:String):Object -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a copy of the style object associated with the style named styleName. - If there is no style object associated with styleName, - null is returned. - -

Parameters - - - - -
styleName:String — A string that specifies the name of the style to retrieve. -
-

-Returns - - - - -
Object — - An object. - - -
-

-See also -

-
-flash.text.StyleSheet.setStyle() -
-
-Example -

-
- - - - - -
parseCSS()method 
-
-public function parseCSS(CSSText:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Parses the CSS in CSSText and loads the style sheet with it. If a style in - CSSText is already in styleSheet, the properties in - styleSheet are retained, and only the ones in CSSText - are added or changed in styleSheet. -

To extend the native CSS parsing capability, you can override this method by creating a subclass - of the StyleSheet class.

- Parameters - - - - -
CSSText:String — The CSS text to parse (a string). -
-
-Example -
In the following example, when a user clicks on the text file, - CSS styles, loaded from a file, are applied to the content. - -

In the constructor, a multiline text field is created and its content is - set to an HTML-formatted string. (The HTML heading and span tags are - not rendered before CSS style is applied.) A URLRequest - object is created to identify the location of the CSS file; for this example, the CSS file - is in the same directory as the SWF file. The file is loaded with a URLLoader - object. There are two event listeners added for the loader URLLoader object. - If an IO error occurs, the errorHandler() method is invoked, which displays - an error message in the text field. After all the data is received and placed in the data - property of the loader URLLoader object, the loaderCompleteHandler() - method is invoked. This method parses the CSS styles from the data loaded from the file and - fills the sheet StyleSheet object with the style definitions.

- -

When the user clicks on the text field, the clickHandler() method is called. - The if statement in the clickHandler() method checks to make sure the file loading - was finished before applying the style sheet to the text field. In order for the style sheet to - take effect, the htmlText property must be reassigned with the content after the - style sheet is assigned to the text field. The CSS font-family and the color - property values for the heading tag also are appended to the content of the text field. (The values - of these properties will be "undefined" if style sheet values are not in effect.)

- -

The following is an example of a content of the CSS file that can be used with this example. - Before running this example, create a text file, copy the following CSS content into it, - then save it with the file name test.css and place it in the same directory as the SWF file.

- - 
-    p {
-       font-family: Times New Roman, Times, _serif;
-       font-size: 14;
-        font-Style: italic;
- 	    margin-left: 10;  
-    }
-    h1 {
-       font-family: Arial, Helvetica, _sans;
-       font-size: 20;
-       font-weight: bold;
-    }
-    .bluetext {
-       color: #0000CC;
-    }
-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.net.URLLoader;
-    import flash.net.URLRequest;
-    import flash.text.StyleSheet;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.events.IOErrorEvent;
-    import flash.events.Event;
-    import flash.events.MouseEvent;
-
-    public class StyleSheet_parseCSSExample extends Sprite {
-        private var loader:URLLoader = new URLLoader();
-        private var field:TextField = new TextField();
-        private var exampleText:String = "<h1>This is a headline</h1>"
-                    + "<p>This is a line of text. <span class='bluetext'>" 
-                    + "This line of text is colored blue.</span></p>";
-        private var sheet:StyleSheet = new StyleSheet();
-        private var cssReady:Boolean = false;
-
-        public function StyleSheet_parseCSSExample() {
-            field.x = 10;
-            field.y = 10;
-            field.background = true;
-            field.multiline = true;
-            field.autoSize = TextFieldAutoSize.LEFT;
-            field.htmlText = exampleText;
-
-            field.addEventListener(MouseEvent.CLICK, clickHandler);
-            
-            addChild(field);
-            
-            var req:URLRequest = new URLRequest("test.css");
-            loader.load(req);
-
-            loader.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-            loader.addEventListener(Event.COMPLETE, loaderCompleteHandler);
-        }
-
-        public function errorHandler(e:IOErrorEvent):void {
-            field.htmlText = "Couldn't load the style sheet file.";
-        }
-
-        public function loaderCompleteHandler(event:Event):void {
-            sheet.parseCSS(loader.data);
-            cssReady = true;
-        }
-
-        public function clickHandler(e:MouseEvent):void {
-
-            if (cssReady) {
-                field.styleSheet = sheet;
-                field.htmlText = exampleText;
-                
-                var style:Object = sheet.getStyle("h1");
-                field.htmlText += "<p>Headline font-family is: " + style.fontFamily + "</p>";
-                field.htmlText += "<p>Headline color is: " + style.color + "</p>";  
-
-            } else {
-                field.htmlText = "Couldn't apply the CSS styles.";
-            }
-        }
-    }
-}
-
-

-
- - - - - -
setStyle()method 
-
-public function setStyle(styleName:String, styleObject:Object):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Adds a new style with the specified name to the style sheet object. - If the named style does not already exist in the style sheet, it is added. - If the named style already exists in the style sheet, it is replaced. - If the styleObject parameter is null, the named style is removed. - -

Flash Player creates a copy of the style object that you pass to this method.

-

For a list of supported styles, see the table in the description for the StyleSheet class.

- Parameters - - - - - - - - - - -
styleName:String — A string that specifies the name of the style to add to the style sheet. -
 
styleObject:Object — An object that describes the style, or null. -
-
- - - - - -
transform()method 
-
-public function transform(formatObject:Object):TextFormat -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Extends the CSS parsing capability. Advanced developers can override this method by extending the - StyleSheet class. - -

Parameters - - - - -
formatObject:Object — An object that describes the style, containing style rules as properties of the object, - or null. - -
-

-Returns - - - - -
TextFormat — - A TextFormat object containing the result of the mapping of CSS rules - to text format properties. - - - -
-

-See also -

-
-flash.text.TextFormat -
-
-Example -
This example uses the transform() method to apply a style - from a CSS file to a TextFormat object for a text field. - -

CSS styles are used usually to format HTML content. However, - by using transform() method of a StyleSheet object, specific - CSS styles can be assigned to a TextFormat object and then applied to any text field.

- -

The URLRequest and URLLoader objects are used to - load the CSS file. An event listener is added for the Event.COMPLETE - event, which occurs after all the data is received and placed in the data property of the - loader URLLoader object. The loaderCompleteHandler() method - then parses the CSS from the data loaded from the file and fills the sheet - StyleSheet object with the styles. The getStyle() method of the style sheet - retrieves the HTML paragraph styles, which are then assigned to the cssFormat - TextFormat object by using style sheet's transform() method. Finally, the default text - format of the inputField text field is set to the new cssFormat text format.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.net.URLLoader;
-    import flash.net.URLRequest;
-    import flash.text.StyleSheet;
-    import flash.text.TextField;
-    import flash.text.TextFormat;
-    import flash.text.TextFieldType;
-    import flash.events.IOErrorEvent;
-    import flash.events.Event;
-
-    public class StyleSheet_transformExample extends Sprite {
-        private var loader:URLLoader = new URLLoader();
-        private var inputField:TextField = new TextField();
-        private var sheet:StyleSheet = new StyleSheet();
-
-        public function StyleSheet_transformExample() {
-            inputField.x = 10;
-            inputField.y = 10;
-            inputField.background = true;
-            inputField.width = 300;
-            inputField.height = 200;
-            inputField.wordWrap = true;
-            inputField.multiline = true;    
-            inputField.type = TextFieldType.INPUT;
-
-            addChild(inputField);
-            
-            var req:URLRequest = new URLRequest("test.css");
-            loader.load(req);
-
-            loader.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-            loader.addEventListener(Event.COMPLETE, loaderCompleteHandler);
-        }
-
-        public function errorHandler(e:IOErrorEvent):void {
-            inputField.htmlText = "Couldn't load the style sheet file.";
-        }
-
-        public function loaderCompleteHandler(event:Event):void {
-            var cssFormat:TextFormat = new TextFormat();
-            sheet.parseCSS(loader.data);
-            var style:Object = sheet.getStyle("p");
-            cssFormat = sheet.transform(style);
-            inputField.defaultTextFormat = cssFormat;
-        }
-    }
-}
-
-

-
- -
Examples
-
examples\StyleSheetExample
-
The following example creates a new style sheet and assigns bold - and red font treatments to the heading style. -
-
- 
-package {
-    import flash.display.Sprite;
-    import flash.text.StyleSheet;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-
-    public class StyleSheetExample extends Sprite {
-
-        public function StyleSheetExample() {
-            var style:StyleSheet = new StyleSheet();
-
-            var heading:Object = new Object();
-            heading.fontWeight = "bold";
-            heading.color = "#FF0000";
-
-            var body:Object = new Object();
-            body.fontStyle = "italic";
-
-            style.setStyle(".heading", heading);
-            style.setStyle("body", body);
-
-            var label:TextField = new TextField();
-            label.styleSheet = style;
-            label.htmlText = "<body><span class='heading'>Hello </span>World...</body>";
-            addChild(label);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextColorType.html b/html-docs/flash/text/TextColorType.html deleted file mode 100644 index 90b8bd8..0000000 --- a/html-docs/flash/text/TextColorType.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - - - - -flash.text.TextColorType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class TextColorType
InheritanceTextColorType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The TextColorType class provides color values for the flash.text.TextRenderer class. - -

-

-See also -

-
-flash.text.TextRenderer -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  DARK_COLOR : String = "dark"
[static] - Used in the colorType parameter in the setAdvancedAntiAliasingTable() method.
-		TextColorType
  LIGHT_COLOR : String = "light"
[static] - Used in the colorType parameter in the setAdvancedAntiAliasingTable() method.
-		TextColorType
-
- -
- -
Constant detail
- - - - - -
DARK_COLORconstant
-
-public static const DARK_COLOR:String = "dark" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Used in the colorType parameter in the setAdvancedAntiAliasingTable() method. - Use the syntax TextColorType.DARK_COLOR. -

-See also -

-
-flash.text.TextRenderer.setAdvancedAntiAliasingTable() -
-
- - - - - -
LIGHT_COLORconstant 
-
-public static const LIGHT_COLOR:String = "light" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Used in the colorType parameter in the setAdvancedAntiAliasingTable() method. - Use the syntax TextColorType.LIGHT_COLOR. -

-See also -

-
-flash.text.TextRenderer.setAdvancedAntiAliasingTable() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextDisplayMode.html b/html-docs/flash/text/TextDisplayMode.html deleted file mode 100644 index 5c4745e..0000000 --- a/html-docs/flash/text/TextDisplayMode.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - - - - -flash.text.TextDisplayMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class TextDisplayMode
InheritanceTextDisplayMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The TextDisplayMode class contains values that control the subpixel anti-aliasing of the advanced anti-aliasing system. -

-

-See also -

-
-flash.text.TextRenderer.displayMode -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  CRT : String = "crt"
[static] - Forces Flash Player to display grayscale anti-aliasing.
-		TextDisplayMode
  DEFAULT : String = "default"
[static] - Allows Flash Player to choose LCD or CRT mode.
-		TextDisplayMode
  LCD : String = "lcd"
[static] - Forces Flash Player to use LCD subpixel anti-aliasing.
-		TextDisplayMode
-
- -
- -
Constant detail
- - - - - -
CRTconstant
-
-public static const CRT:String = "crt" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Forces Flash Player to display grayscale anti-aliasing. While this setting - avoids text coloring, some users may think it appears blurry. -

- - - - - -
DEFAULTconstant 
-
-public static const DEFAULT:String = "default" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Allows Flash Player to choose LCD or CRT mode. -

- - - - - -
LCDconstant 
-
-public static const LCD:String = "lcd" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Forces Flash Player to use LCD subpixel anti-aliasing. Depending on the font and - the hardware, this setting can result in much higher resolution text or text coloring. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextExtent.html b/html-docs/flash/text/TextExtent.html deleted file mode 100644 index 2e50aad..0000000 --- a/html-docs/flash/text/TextExtent.html +++ /dev/null @@ -1,338 +0,0 @@ - - - - - - - - -flash.text.TextExtent (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic class TextExtent
InheritanceTextExtent Inheritance Object
-

- - - - -
Runtime version: 
-

-

- The TextExtent class contains information about the extents of some - text in a text field. Objects of this class are returned by the - TextFormat.getTextExtent method. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  ascent : Number -
-		TextExtent
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  descent : Number -
-		TextExtent
  height : Number -
-		TextExtent
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  textFieldHeight : Number -
-		TextExtent
  textFieldWidth : Number -
-		TextExtent
  width : Number -
-		TextExtent
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TextExtent(width:Number, height:Number, textFieldWidth:Number, textFieldHeight:Number, ascent:Number, descent:Number)
-
-		TextExtent
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
ascentproperty
-
-public var ascent:Number -
- - - - - -
descentproperty 
-
-public var descent:Number -
- - - - - -
heightproperty 
-
-public var height:Number -
- - - - - -
textFieldHeightproperty 
-
-public var textFieldHeight:Number -
- - - - - -
textFieldWidthproperty 
-
-public var textFieldWidth:Number -
- - - - - -
widthproperty 
-
-public var width:Number -
- -
Constructor detail
- - - - - -
TextExtent()constructor
-
-public function TextExtent(width:Number, height:Number, textFieldWidth:Number, textFieldHeight:Number, ascent:Number, descent:Number)Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
width:Number
 
height:Number
 
textFieldWidth:Number
 
textFieldHeight:Number
 
ascent:Number
 
descent:Number
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextField.html b/html-docs/flash/text/TextField.html deleted file mode 100644 index 6d1bec1..0000000 --- a/html-docs/flash/text/TextField.html +++ /dev/null @@ -1,8972 +0,0 @@ - - - - - - - - -flash.text.TextField (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic class TextField
InheritanceTextField Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - The TextField class is used to create display objects for text display and input. - - You can use the TextField class to perform low-level text rendering. - - However, in Flex, you typically use the Label, Text, TextArea, and TextInput controls to process text. - - - You can give a text field an instance name in the Property inspector and - - use the methods and properties of the TextField class to manipulate it with ActionScript. - - TextField instance names are displayed in the Movie Explorer and in the Insert Target Path dialog box - - in the Actions panel. - - -

To create a text field dynamically, use the TextField() constructor.

- - -

The methods of the TextField class let you set, select, and manipulate text in a dynamic or input - - text field that you create during authoring or at runtime.

- - -

ActionScript provides several ways to - - format your text at runtime. The TextFormat class lets you set character and paragraph formatting - - for TextField objects. You can apply Cascading Style Sheets (CSS) styles - - to text fields by using the TextField.styleSheet property and the StyleSheet class. You can use CSS to - - style built-in HTML tags, define new formatting tags, or apply styles. - - You can assign HTML formatted text, which optionally uses CSS styles, directly to a text - - field. HTML text that you assign to a text field can contain embedded - - media (movie clips, SWF files, GIF files, PNG files, and JPEG files). The text wraps around the - - embedded media in the same way that a web browser wraps text around media embedded in an HTML document.

- - -

Flash Player supports a subset of HTML tags that you can use to format text. See the list of supported - - HTML tags in the description of the htmlText property.

- - -

-

-View the examples. -

-

-See also -

-
-flash.text.TextFormat -
-flash.text.StyleSheet -
-htmlText -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityImplementation : AccessibilityImplementation -
- - The current accessibility implementation (AccessibilityImplementation) - - for this InteractiveObject instance.
-		InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
  allowedDomains : Vector.<String>
- - Feature to allow applications to specify approved domains from which AIR will load images.
-		TextField
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
  alwaysShowSelection : Boolean -
- - When set to true and the text field is not in focus, Flash Player highlights the - - selection in the text field in gray.
-		TextField
  antiAliasType : String -
- - The type of anti-aliasing used for this text field.
-		TextField
  autoSize : String -
- - Controls automatic sizing and alignment of text fields.
-		TextField
  background : Boolean -
- - Specifies whether the text field has a background fill.
-		TextField
  backgroundColor : uint -
- - The color of the text field background.
-		TextField
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
  border : Boolean -
- - Specifies whether the text field has a border.
-		TextField
  borderColor : uint -
- - The color of the text field border.
-		TextField
  bottomScrollV : int -
[read-only] - - An integer (1-based index) that indicates the bottommost line that is currently visible in - - the specified text field.
-		TextField
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
  caretIndex : int -
[read-only] - - The index of the insertion point (caret) position.
-		TextField
  condenseWhite : Boolean -
- - A Boolean value that specifies whether extra white space (spaces, line breaks, and so on) - - in a text field with HTML text is removed.
-		TextField
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcontextMenu : NativeMenu -
- - Specifies the context menu associated with this object.
-		InteractiveObject
  defaultTextFormat : TextFormat -
- - Specifies the format applied to newly inserted text, such as text entered by a user or text inserted with the - - replaceSelectedText() method.
-		TextField
  displayAsPassword : Boolean -
- - Specifies whether the text field is a password text field.
-		TextField
 InheriteddoubleClickEnabled : Boolean -
- - Specifies whether the object receives doubleClick events.
-		InteractiveObject
  embedFonts : Boolean -
- - Specifies whether to render by using embedded font outlines.
-		TextField
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 InheritedfocusRect : Object -
- - Specifies whether this object displays a focus rectangle.
-		InteractiveObject
  gridFitType : String -
- - The type of grid fitting used for this text field.
-		TextField
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
  htmlParagraphBehavior : Boolean -
- - A Boolean value that determines whether <p> paragraph breaks should - - behave like HTML paragraphs.
-		TextField
  htmlText : String -
- - Contains the HTML representation of the text field contents.
-		TextField
  length : int -
[read-only] - - The number of characters in a text field.
-		TextField
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
  maxChars : int -
- - The maximum number of characters that the text field can contain, as entered by a user.
-		TextField
  maxScrollH : int -
[read-only] - - The maximum value of scrollH.
-		TextField
  maxScrollV : int -
[read-only] - - The maximum value of scrollV.
-		TextField
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
 InheritedmouseEnabled : Boolean -
- - Specifies whether this object receives mouse, or other user input, messages.
-		InteractiveObject
  mouseWheelEnabled : Boolean -
- - A Boolean value that indicates whether Flash Player automatically scrolls multiline - - text fields when the user clicks a text field and rolls the mouse wheel.
-		TextField
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
  multiline : Boolean -
- - Indicates whether field is a multiline text field.
-		TextField
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedneedsSoftKeyboard : Boolean -
- - Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - - when this InteractiveObject instance receives focus.
-		InteractiveObject
  numLines : int -
[read-only] - - Defines the number of text lines in a multiline text field.
-		TextField
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  restrict : String -
- - Indicates the set of characters that a user can enter into the text field.
-		TextField
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
  scrollH : int -
- - The current horizontal scrolling position.
-		TextField
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
  scrollV : int -
- - The vertical position of text in a text field.
-		TextField
  selectable : Boolean -
- - A Boolean value that indicates whether the text field is selectable.
-		TextField
  selectionBeginIndex : int -
[read-only] - - The zero-based character index value of the first character in the current selection.
-		TextField
  selectionEndIndex : int -
[read-only] - - The zero-based character index value of the last character in the current selection.
-		TextField
  sharpness : Number -
- - The sharpness of the glyph edges in this text field.
-		TextField
 InheritedsoftKeyboard : String -
- - Controls the appearance of the soft keyboard.
-		InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle -
- - Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
-		InteractiveObject
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
  styleSheet : StyleSheet -
- - Attaches a style sheet to the text field.
-		TextField
 InheritedtabEnabled : Boolean -
- - Specifies whether this object is in the tab order.
-		InteractiveObject
 InheritedtabIndex : int -
- - Specifies the tab ordering of objects in a SWF file.
-		InteractiveObject
  text : String -
- - A string that is the current text in the text field.
-		TextField
  textColor : uint -
- - The color of the text in a text field, in hexadecimal format.
-		TextField
  textHeight : Number -
[read-only] - - The height of the text in pixels.
-		TextField
  textInteractionMode : String -
[read-only] - - The interaction mode property, Default value is TextInteractionMode.NORMAL.
-		TextField
  textWidth : Number -
[read-only] - - The width of the text in pixels.
-		TextField
  thickness : Number -
- - The thickness of the glyph edges in this text field.
-		TextField
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
  type : String -
- - The type of the text field.
-		TextField
  useRichTextClipboard : Boolean -
- - Specifies whether to copy and paste the text formatting along with the text.
-		TextField
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
  wordWrap : Boolean -
- - A Boolean value that indicates whether the text field has word wrap.
-		TextField
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TextField()
-
- - Creates a new TextField instance.
-		TextField
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-appendText(newText:String):void -
-
- - Appends the string specified by the newText parameter to the end of the text - - of the text field.
-		TextField
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
   -
-getCharBoundaries(charIndex:int):Rectangle -
-
- - Returns a rectangle that is the bounding box of the character.
-		TextField
   -
-getCharIndexAtPoint(x:Number, y:Number):int -
-
- - Returns the zero-based index value of the character at the point specified by the x - - and y parameters.
-		TextField
   -
-getFirstCharInParagraph(charIndex:int):int -
-
- - Given a character index, returns the index of the first character in the same paragraph.
-		TextField
   -
-getImageReference(id:String):DisplayObject -
-
- - Returns a DisplayObject reference for the given id, for an image or SWF file - - that has been added to an HTML-formatted text field by using an <img> tag.
-		TextField
   -
-getLineIndexAtPoint(x:Number, y:Number):int -
-
- - Returns the zero-based index value of the line at the point specified by the x - - and y parameters.
-		TextField
   -
-getLineIndexOfChar(charIndex:int):int -
-
- - Returns the zero-based index value of the line containing the character specified - - by the charIndex parameter.
-		TextField
   -
-getLineLength(lineIndex:int):int -
-
- - Returns the number of characters in a specific text line.
-		TextField
   -
-getLineMetrics(lineIndex:int):TextLineMetrics -
-
- - Returns metrics information about a given text line.
-		TextField
   -
-getLineOffset(lineIndex:int):int -
-
- - Returns the character index of the first character in the line that - - the lineIndex parameter specifies.
-		TextField
   -
-getLineText(lineIndex:int):String -
-
- - Returns the text of the line specified by the lineIndex parameter.
-		TextField
   -
-getParagraphLength(charIndex:int):int -
-
- - Given a character index, returns the length of the paragraph containing the given character.
-		TextField
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
   -
-getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat -
-
- - Returns a TextFormat object that contains formatting information for the range of text that the - - beginIndex and endIndex parameters specify.
-		TextField
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
   -
-isFontCompatible(fontName:String, fontStyle:String):Boolean -
-
[static] - - Returns true if an embedded font is available with the specified fontName and fontStyle - - where Font.fontType is flash.text.FontType.EMBEDDED.
-		TextField
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-replaceSelectedText(value:String):void -
-
- - Replaces the current selection with the contents of the value parameter.
-		TextField
   -
-replaceText(beginIndex:int, endIndex:int, newText:String):void -
-
- - Replaces the range of characters that the beginIndex and - - endIndex parameters specify with the contents - - of the newText parameter.
-		TextField
 Inherited -
-requestSoftKeyboard():Boolean -
-
- - Raises a virtual keyboard.
-		InteractiveObject
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setSelection(beginIndex:int, endIndex:int):void -
-
- - Sets as selected the text designated by the index values of the - - first and last characters, which are specified with the beginIndex - - and endIndex parameters.
-		TextField
   -
-setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void -
-
- - Applies the text formatting that the format parameter specifies to the specified text in a text field.
-		TextField
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
   -
-change -
-		 - - Dispatched after a control value is modified, unlike - - the textInput event, which is dispatched before the value is modified.TextField
 Inherited -
-clear -
-		 - - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 Inherited -
-click -
-		 - - Dispatched when a user presses and releases the main button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-contextMenu -
-		 - - Dispatched when a user gesture triggers the context menu associated with this interactive - - object in an AIR application.InteractiveObject
 Inherited -
-copy -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - - or selects 'Copy' from the text context menu.InteractiveObject
 Inherited -
-cut -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - - or selects 'Cut' from the text context menu.InteractiveObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-doubleClick -
-		 - - Dispatched when a user presses and releases the main button of a pointing device twice in - - rapid succession over the same InteractiveObject when that object's - - doubleClickEnabled flag is set to true.InteractiveObject
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-focusIn -
-		 - - Dispatched after a display object gains focus.InteractiveObject
 Inherited -
-focusOut -
-		 - - Dispatched after a display object loses focus.InteractiveObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-gestureDirectionalTap -
-		 - - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - - Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 Inherited -
-gestureLongPress -
-		 - - Dispatched when the user presses two points of contact over the same InteractiveObject instance - - on a touch-enabled device (such as presses and releases two fingers over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gesturePan -
-		 - - Dispatched when the user moves a point of contact over the InteractiveObject instance - - on a touch-enabled device (such as moving a finger from left to right over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureRotate -
-		 - - Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers - - and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureSwipe -
-		 - - Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three - - fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureTap -
-		 - - Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps - - on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureZoom -
-		 - - Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two - - fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-imeStartComposition -
-		 - - This event is dispatched to any client app that supports inline input with an IME - - - - InteractiveObject
 Inherited -
-keyDown -
-		 - - Dispatched when the user presses a key.InteractiveObject
 Inherited -
-keyFocusChange -
-		 - - Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited -
-keyUp -
-		 - - Dispatched when the user releases a key.InteractiveObject
   -
-link -
-		 - - Dispatched when a user clicks a hyperlink in an - - HTML-enabled text field, where the URL begins with "event:".TextField
 Inherited -
-middleClick -
-		 - - Dispatched when a user presses and releases the middle button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-middleMouseDown -
-		 - - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-middleMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseFocusChange -
-		 - - Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 Inherited -
-mouseMove -
-		 - - Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited -
-mouseOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheel -
-		 - - Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheelHorizontal -
-		 - - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-nativeDragComplete -
-		 - - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited -
-nativeDragDrop -
-		 - - Dispatched by the target InteractiveObject when a dragged object is - - dropped on it and the drop has been accepted with a call to - - DragManager.acceptDragDrop().InteractiveObject
 Inherited -
-nativeDragEnter -
-		 - - Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited -
-nativeDragExit -
-		 - - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited -
-nativeDragOver -
-		 - - Dispatched by an InteractiveObject continually while a drag gesture remains within its - - boundary.InteractiveObject
 Inherited -
-nativeDragStart -
-		 - - Dispatched at the beginning of a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-nativeDragUpdate -
-		 - - Dispatched during a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-paste -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - - or selects 'Paste' from the text context menu.InteractiveObject
 Inherited -
-proximityBegin -
-		 - - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityEnd -
-		 - - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityMove -
-		 - - Dispatched when the user moves an active stylus over the screen while remaining within - - the proximity detection threshold.InteractiveObject
 Inherited -
-proximityOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - - the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityOver -
-		 - - Dispatched when the user moves an active stylus directly above this InteractiveObject - - while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject - - and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOver -
-		 - - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - - object's tree of descendents in the display list - - (while remaining within the proximity detection threshold of the screen).InteractiveObject
 Inherited -
-releaseOutside -
-		 - - Dispatched when a user releases the button on the pointing device after the - - user first pressed the button over an InteractiveObject instance - - and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 Inherited -
-rightClick -
-		 - - Dispatched when a user presses and releases the right button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-rightMouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-rightMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-rollOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject - - instance.InteractiveObject
 Inherited -
-rollOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
   -
-scroll -
-		 - - Dispatched by a TextField object after the user scrolls.TextField
 Inherited -
-selectAll -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a select all operation - - or selects 'Select All' from the text context menu.InteractiveObject
 Inherited -
-softKeyboardActivate -
-		 - - Dispatched immediately after the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardActivating -
-		 - - Dispatched immediately before the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardDeactivate -
-		 - - Dispatched immediately after the soft keyboard is lowered.InteractiveObject
 Inherited -
-tabChildrenChange -
-		 - - Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited -
-tabEnabledChange -
-		 - - Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited -
-tabIndexChange -
-		 - - Dispatched when the value of the object's tabIndex property changes.InteractiveObject
   -
-textInput -
-		 - - Flash Player dispatches the textInput event when a user enters one or more - - characters of text.TextField
 Inherited -
-textInput -
-		 - - Dispatched when a user enters one or more - - characters of text.InteractiveObject
   -
-textInteractionModeChange -
-		 - - Flash Player dispatches the textInteractionModeChange event when a user - - changes the interaction mode of a text field.TextField
 Inherited -
-touchBegin -
-		 - - Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchEnd -
-		 - - Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchMove -
-		 - - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 Inherited -
-touchOut -
-		 - - Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device - - (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOut -
-		 - - Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchTap -
-		 - - Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated - - on a touch-enabled device (such as presses and releases a finger from a single point over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
-
- -
- -
Property detail
- - - - - -
allowedDomainsproperty
-
-allowedDomains:Vector.<String>  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Feature to allow applications to specify approved domains from which AIR will load images. - - -

If the htmlText property of a TextField contains an img tag, - - AIR will refuse to load the image due to the standard internal security policy. However, if a domain - - is added to this list, images that are under one of the provided domains will be loaded.

- - -

To allow loading from within symbol assets (e.g. src="symbolLinkageName"), the root - - of the application can be added to this list (loaderInfo.url).

- - -

Note that this is a per-text field setting, but it is possible to share a vector between different - - TextField objects. The provided value is not copied, but a reference to the vector is used, - - so if this is changed after setting the value, the new changes will be taken every time the text field - - is rendered. To avoid this behaviour, use textField.allowedDomains = vectorList.concat(); to copy - - the elements from the existing vectorList into the allowedDomains vector.

- - - Implementation -
-    public function get allowedDomains():Vector.<String> -
-    public function set allowedDomains(value:Vector.<String>):void -
-
- - - - - -
alwaysShowSelectionproperty 
-
-alwaysShowSelection:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - When set to true and the text field is not in focus, Flash Player highlights the - - selection in the text field in gray. When set to false and the text field is not in - - focus, Flash Player does not highlight the selection in the text field. - - - -

The default value is false.

-Implementation -
-    public function get alwaysShowSelection():Boolean -
-    public function set alwaysShowSelection(value:Boolean):void -
-

-See also -

-
-flash.display.Stage.focus -
-
-Example -
Compile and run the following file. When you run the file, drag to select text - in each of the two text fields, and notice the difference in selection highlighting when you - select text in the two text fields (changing focus): -
-
-
-    package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldType;
-
-    public class TextField_alwaysShowSelection extends Sprite {
-        public function TextField_alwaysShowSelection() {
-            var label1:TextField = createCustomTextField(0, 20, 200, 20);
-            label1.text = "This text is selected.";
-            label1.setSelection(0, 9);
-            label1.alwaysShowSelection = true;
-
-            var label2:TextField = createCustomTextField(0, 50, 200, 20);
-            label2.text = "Drag to select some of this text.";
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x; result.y = y;
-            result.width = width; result.height = height;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
antiAliasTypeproperty 
-
-antiAliasType:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The type of anti-aliasing used for this text field. Use flash.text.AntiAliasType - - constants for this property. You can control this setting only if the font is - - embedded (with the embedFonts property set to true). - - The default setting is flash.text.AntiAliasType.NORMAL. - - -

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
flash.text.AntiAliasType.NORMALApplies the regular text anti-aliasing. This value matches the type of anti-aliasing that - - Flash Player 7 and earlier versions used.
flash.text.AntiAliasType.ADVANCEDApplies advanced anti-aliasing, which makes text more legible. (This feature became - - available in Flash Player 8.) Advanced anti-aliasing allows for high-quality rendering - - of font faces at small sizes. It is best used with applications - - with a lot of small text. Advanced anti-aliasing is not recommended for - - fonts that are larger than 48 points.
- - - Implementation -
-    public function get antiAliasType():String -
-    public function set antiAliasType(value:String):void -
-

-See also -

-
-flash.text.AntiAliasType -
-flash.text.TextField.embedFonts -
-
- - - - - -
autoSizeproperty 
-
-autoSize:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Controls automatic sizing and alignment of text fields. - - Acceptable values for the TextFieldAutoSize constants: TextFieldAutoSize.NONE (the default), - - TextFieldAutoSize.LEFT, TextFieldAutoSize.RIGHT, and TextFieldAutoSize.CENTER. - - -

If autoSize is set to TextFieldAutoSize.NONE (the default) no resizing occurs.

- - -

If autoSize is set to TextFieldAutoSize.LEFT, the text is - - treated as left-justified text, meaning that the left margin of the text field remains fixed and any - - resizing of a single line of the text field is on the right margin. If the text includes a line break - - (for example, "\n" or "\r"), the bottom is also resized to fit the next - - line of text. If wordWrap is also set to true, only the bottom - - of the text field is resized and the right side remains fixed.

- - -

If autoSize is set to TextFieldAutoSize.RIGHT, the text is treated as - - right-justified text, meaning that the right margin of the text field remains fixed and any resizing - - of a single line of the text field is on the left margin. If the text includes a line break - - (for example, "\n" or "\r"), the bottom is also resized to fit the next - - line of text. If wordWrap is also set to true, only the bottom - - of the text field is resized and the left side remains fixed.

- - -

If autoSize is set to TextFieldAutoSize.CENTER, the text is treated as - - center-justified text, meaning that any resizing of a single line of the text field is equally distributed - - to both the right and left margins. If the text includes a line break (for example, "\n" or - - "\r"), the bottom is also resized to fit the next line of text. If wordWrap is also - - set to true, only the bottom of the text field is resized and the left and - - right sides remain fixed.

- - - Implementation -
-    public function get autoSize():String -
-    public function set autoSize(value:String):void -
-
-Throws -
- - - - -
ArgumentError — The autoSize specified is not a member of flash.text.TextFieldAutoSize. - - -
-

-See also -

-
-flash.text.TextFieldAutoSize -
-flash.text.TextField.autoSize -
-flash.text.TextField.wordWrap -
-
- - - - - -
backgroundproperty 
-
-background:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies whether the text field has a background fill. If true, the text field has a - - background fill. If false, the text field has no background fill. - - Use the backgroundColor property to set the background color of a text field. - - -

The default value is false.

-Implementation -
-    public function get background():Boolean -
-    public function set background(value:Boolean):void -
-

-See also -

-
-flash.text.TextField.backgroundColor -
-
- - - - - -
backgroundColorproperty 
-
-backgroundColor:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The color of the text field background. The default value is 0xFFFFFF (white). - - This property can be retrieved or set, even if there currently is no background, but the - - color is visible only if the text field has the background property set to - - true. - - -

Implementation -
-    public function get backgroundColor():uint -
-    public function set backgroundColor(value:uint):void -
-

-See also -

-
-flash.text.TextField.background -
-
- - - - - -
borderproperty 
-
-border:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies whether the text field has a border. If true, the text field has a border. - - If false, the text field has no border. Use the borderColor property - - to set the border color. - - -

The default value is false.

-Implementation -
-    public function get border():Boolean -
-    public function set border(value:Boolean):void -
-

-See also -

-
-flash.text.TextField.borderColor -
-
- - - - - -
borderColorproperty 
-
-borderColor:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The color of the text field border. The default value is 0x000000 (black). - - This property can be retrieved or set, even if there currently is no border, but the - - color is visible only if the text field has the border property set to - - true. - - -

Implementation -
-    public function get borderColor():uint -
-    public function set borderColor(value:uint):void -
-

-See also -

-
-flash.text.TextField.border -
-
- - - - - -
bottomScrollVproperty 
-
-bottomScrollV:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - An integer (1-based index) that indicates the bottommost line that is currently visible in - - the specified text field. Think of the text field as a window onto a block of text. - - The scrollV property is the 1-based index of the topmost visible line - - in the window. - - -

All the text between the lines indicated by scrollV and bottomScrollV - - is currently visible in the text field.

- - - Implementation -
-    public function get bottomScrollV():int -
-

-See also -

-
-flash.text.TextField.scrollV -
-
- - - - - -
caretIndexproperty 
-
-caretIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The index of the insertion point (caret) position. If no insertion point is displayed, - - the value is the position the insertion point would be if you restored focus to the field (typically where the - - insertion point last was, or 0 if the field has not had focus). - - -

Selection span indexes are zero-based (for example, the first position is 0, - - the second position is 1, and so on).

- - - - - - Implementation -
-    public function get caretIndex():int -
-

-See also -

-
-selectable -
-selectionBeginIndex -
-selectionEndIndex -
-
-Example -
In this example, a TextField instance is created and populated with text. - An event listener is assigned so that when the user clicks on the TextField, the - printCursorPosition method is called. In that case, the values of the - caretIndex, selectionBeginIndex, and - selectionEndIndex properties are output. - -

Run this example and try clicking in the TextField to select text. Then click in the field without - selecting text. When you click in the text without making a selection, the - caretIndex property indicates where the insertion point occurs, and the selectionBeginIndex - and selectionEndIndex properties equal the caretIndex property value.

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.MouseEvent;
-    import flash.text.TextField;
-    import flash.text.TextFieldType;
-
-    public class TextField_caretIndex extends Sprite {
-        public function TextField_caretIndex() {
-            var tf:TextField = createCustomTextField(10, 10, 100, 100);
-            tf.wordWrap = true;
-            tf.type = TextFieldType.INPUT;
-            tf.text = "Click in this text field. Compare the difference between clicking without selecting versus clicking and selecting text.";
-            tf.addEventListener(MouseEvent.CLICK, printCursorPosition);
-        }
-
-        private function printCursorPosition(event:MouseEvent):void {
-            var tf:TextField = TextField(event.target);
-            trace("caretIndex:", tf.caretIndex);
-            trace("selectionBeginIndex:", tf.selectionBeginIndex);
-            trace("selectionEndIndex:", tf.selectionEndIndex);
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
condenseWhiteproperty 
-
-condenseWhite:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A Boolean value that specifies whether extra white space (spaces, line breaks, and so on) - - in a text field with HTML text is removed. The default value is false. - - The condenseWhite property only affects text set with - - the htmlText property, not the text property. If you set - - text with the text property, condenseWhite is ignored. - - -

If condenseWhite is set to true, use standard HTML commands such as - - <BR> and <P> to place line breaks in the text field.

- - -

Set the condenseWhite property before setting the htmlText property.

- - - - - - Implementation -
-    public function get condenseWhite():Boolean -
-    public function set condenseWhite(value:Boolean):void -
-

-See also -

-
-flash.text.TextField.htmlText -
-
-Example -
The following shows the difference between setting the condenseWhite - setting to false and setting it to true: -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-
-    public class TextField_condenseWhite extends Sprite {
-        public function TextField_condenseWhite() {
-            var tf1:TextField = createCustomTextField(0, 0, 200, 50);
-            tf1.condenseWhite = false;
-            tf1.htmlText = "keep    on\n\ttruckin'";
-            
-            var tf2:TextField = createCustomTextField(0, 120, 200, 50);
-            tf2.condenseWhite = true;
-            tf2.htmlText = "keep    on\n\ttruckin'";
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            result.border = true;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
defaultTextFormatproperty 
-
-defaultTextFormat:TextFormat  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies the format applied to newly inserted text, such as text entered by a user or text inserted with the - - replaceSelectedText() method. - - -

Note: When selecting characters to be replaced with setSelection() and - - replaceSelectedText(), the defaultTextFormat will be applied only if the - - text has been selected up to and including the last character. Here is an example:

- - 
-
-     var my_txt:TextField new TextField();
-
-     my_txt.text = "Flash Macintosh version";
-
-     var my_fmt:TextFormat = new TextFormat();
-
-     my_fmt.color = 0xFF0000;
-
-     my_txt.defaultTextFormat = my_fmt;
-
-     my_txt.setSelection(6,15); // partial text selected - defaultTextFormat not applied
-
-     my_txt.setSelection(6,23); // text selected to end - defaultTextFormat applied
-
-     my_txt.replaceSelectedText("Windows version");
-
-
- - -

When you access the defaultTextFormat property, the returned TextFormat object has all - - of its properties defined. No property is null.

- -

Note: You can't set this property if a style sheet is applied to the text field.

- - - Implementation -
-    public function get defaultTextFormat():TextFormat -
-    public function set defaultTextFormat(value:TextFormat):void -
-
-Throws -
- - - - -
Error — This method cannot be used on a text field with a style sheet. - - - -
-

-See also -

-
-flash.text.TextField.replaceSelectedText() -
-flash.text.TextField.getTextFormat() -
-flash.text.TextField.setTextFormat() -
-
- - - - - -
displayAsPasswordproperty 
-
-displayAsPassword:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies whether the text field is a password text field. If the value of this property is true, - - the text field is treated as a password text field and hides the input characters using asterisks instead of the - - actual characters. If false, the text field is not treated as a password text field. When password mode - - is enabled, the Cut and Copy commands and their corresponding keyboard shortcuts will - - not function. This security mechanism prevents an unscrupulous user from using the shortcuts to discover - - a password on an unattended computer. - - -

The default value is false.

-Implementation -
-    public function get displayAsPassword():Boolean -
-    public function set displayAsPassword(value:Boolean):void -
-
- - - - - -
embedFontsproperty 
-
-embedFonts:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies whether to render by using embedded font outlines. - - If false, Flash Player renders the text field by using - - device fonts. - - -

If you set the embedFonts property to true for a text field, - - you must specify a font for that text by using the font property of - - a TextFormat object applied to the text field. - - If the specified font is not embedded in the SWF file, the text is not displayed.

- - -

The default value is false.

-Implementation -
-    public function get embedFonts():Boolean -
-    public function set embedFonts(value:Boolean):void -
-

-See also -

-
-Font.enumerateFonts() -
-
- - - - - -
gridFitTypeproperty 
-
-gridFitType:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The type of grid fitting used for this text field. This property applies only if the - - flash.text.AntiAliasType property of the text field is set to flash.text.AntiAliasType.ADVANCED. - - -

The type of grid fitting used determines whether Flash Player forces strong horizontal and - - vertical lines to fit to a pixel or subpixel grid, or not at all.

- - - -

For the flash.text.GridFitType property, you can use the following string values:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
flash.text.GridFitType.NONESpecifies no grid fitting. Horizontal and vertical lines in the glyphs are not - - forced to the pixel grid. This setting is recommended for animation or - - for large font sizes.
flash.text.GridFitType.PIXELSpecifies that strong horizontal and vertical lines are fit to the - - pixel grid. This setting works only for left-aligned text fields. - - To use this setting, the flash.dispaly.AntiAliasType property of the text field - - must be set to flash.text.AntiAliasType.ADVANCED. - - This setting generally provides the best legibility for - - left-aligned text.
flash.text.GridFitType.SUBPIXELSpecifies that strong horizontal and vertical lines are fit to the subpixel grid on - - an LCD monitor. To use this setting, the - - flash.text.AntiAliasType property of the text field must be set to - - flash.text.AntiAliasType.ADVANCED. The flash.text.GridFitType.SUBPIXEL setting is often good - - for right-aligned or centered - - dynamic text, and it is sometimes a useful trade-off for animation versus text quality.
- - -

The default value is pixel.

-Implementation -
-    public function get gridFitType():String -
-    public function set gridFitType(value:String):void -
-

-See also -

-
-flash.text.GridFitType -
-flash.text.TextField.antiAliasType -
-flash.text.AntiAliasType -
-
-Example -
The following example shows three text fields with different - settings for the gridFitType property. When you use this example, - notice the difference in legibility for the first two lines. Also note the optimal use of - GridFitType.PIXEL for left-aligned text and GridFitType.SUBPIXEL - for right-aligned text. -
-
-
-package
-{
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFormat;
-    import flash.text.TextFieldAutoSize;
-    import flash.text.AntiAliasType;
-    import flash.text.GridFitType;
-
-    public class gridFitTypeExample extends Sprite
-    {
-        public function gridFitTypeExample()
-        {
-    var format1:TextFormat = new TextFormat();
-	format1.font="Arial";
-	format1.size=12;
-
-	var tf1:TextField = createCustomTextField(0,0,format1,"NONE",TextFieldAutoSize.LEFT,GridFitType.NONE);
-	
-	var tf2:TextField = createCustomTextField(0,30,format1,"PIXEL",TextFieldAutoSize.LEFT,GridFitType.PIXEL);
-
-	var tf3:TextField = createCustomTextField(300,60,format1,"SUBPIXEL",TextFieldAutoSize.RIGHT,GridFitType.SUBPIXEL);
-
-        }
-        private function createCustomTextField(x:Number,y:Number,fm:TextFormat,tl:String,tfs:String,gft:String):TextField 
-        {
-            var result:TextField = new TextField();
-            result.x=x;
-            result.y=y;
-            result.embedFonts=true;
-            result.antiAliasType=AntiAliasType.ADVANCED;
-            result.text="This text uses a gridFitType of " + tl;
-            result.autoSize=tfs;
-	    result.gridFitType=gft;
-            result.setTextFormat(fm);
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
htmlParagraphBehaviorproperty 
-
-htmlParagraphBehavior:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 50.0 - -
-

- - A Boolean value that determines whether <p> paragraph breaks should - - behave like HTML paragraphs. The default value is false which leaves the - - behaviour as it has been in AIR historically. Setting this to true will mean that any - - section of text marked as a paragraph, when embedded in a longer string, will be displayed - - with line breaks before and after it. However, line breaks will not be added if the start - - or end of a paragraph section coincides with the start or end of the text field. - - -

The htmlParagraphBehavior property only affects text set with - - the htmlText property, not the text property. If you set - - text with the text property, htmlParagraphBehavior is ignored.

- - -

Set the htmlParagraphBehavior property before setting the htmlText property.

- - - Implementation -
-    public function get htmlParagraphBehavior():Boolean -
-    public function set htmlParagraphBehavior(value:Boolean):void -
-

-See also -

-
-flash.text.TextField.htmlText -
-
- - - - - -
htmlTextproperty 
-
-htmlText:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Contains the HTML representation of the text field contents. - - - -

Flash Player supports the following HTML tags:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - Tag - - - - Description - -
- - Anchor tag - - - - The <a> tag creates a hypertext link and supports the following attributes: - -
    - - - -
  • - - target: Specifies the name of the target window where you load the page. - - Options include _self, _blank, _parent, and - - _top. The _self option specifies the current frame in the current window, - - _blank specifies a new window, _parent specifies the parent of the - - current frame, and _top specifies the top-level frame in the current window. - -
    • - - -
  • - - href: Specifies a URL or an ActionScript link event.The URL can - - be either absolute or relative to the location of the SWF file that - - is loading the page. An example of an absolute reference to a URL is - - http://www.adobe.com; an example of a relative reference is - - /index.html. Absolute URLs must be prefixed with - - http://; otherwise, Flash Player or AIR treats them as relative URLs. - - - -
    You can use the link event to cause the link to execute an ActionScript - - function in a SWF file instead of opening a URL. To specify a link event, use - - the event scheme instead of the http scheme in your href attribute. An example - - is href="event:myText" instead of href="http://myURL"; when the - - user clicks a hypertext link that contains the event scheme, the text field dispatches a - - link TextEvent with its text property set to "myText". You can then create an ActionScript - - function that executes whenever the link TextEvent is dispatched. - - -
    You can also define a:link, a:hover, and a:active - - styles for anchor tags by using style sheets. - -
    • - - - -
- - - -
- - Bold tag - - - - The <b> tag renders text as bold. A bold typeface must be available for the font used. - -
- - Break tag - - - - The <br> tag creates a line break in the text field. Set the text field to - - be a multiline text field to use this tag. - -
- - Font tag - - - - The <font> tag specifies a font or list of fonts to display the text.The font tag - - supports the following attributes: - -
    - - - -
  • - - color: Only hexadecimal color (#FFFFFF) values are supported. - -
    • - - - -
  • - - face: Specifies the name of the font to use. As shown in the following example, - - you can specify a list of comma-delimited font names, in which case Flash Player selects the first available - - font. If the specified font is not installed on the local computer system or isn't embedded in the SWF file, - - Flash Player selects a substitute font. - -
    • - - - -
  • - - size: Specifies the size of the font. You can use absolute pixel sizes, such as 16 or 18, - - or relative point sizes, such as +2 or -4. - -
    • - - - -
- - - -
- - Image tag - - - - The <img> tag lets you embed external image files (JPEG, GIF, PNG), SWF files, and - - movie clips inside text fields. Text automatically flows around images you embed in text fields. You - - must set the text field to be multiline to wrap text around an image. - - - -

The <img> tag supports the following attributes:

- - - -
    - - - -
  • - - src: Specifies the URL to an image or SWF file, or the linkage identifier for a movie clip - - symbol in the library. This attribute is required; all other attributes are optional. External files (JPEG, GIF, PNG, - - and SWF files) do not show until they are downloaded completely. - -
    • - - - -
  • - - width: The width of the image, SWF file, or movie clip being inserted, in pixels. - -
    • - - - -
  • - - height: The height of the image, SWF file, or movie clip being inserted, in pixels. - -
    • - - - -
  • - - align: Specifies the horizontal alignment of the embedded image within the text field. - - Valid values are left and right. The default value is left. - -
    • - - - -
  • - - hspace: Specifies the amount of horizontal space that surrounds the image where - - no text appears. The default value is 8. - -
    • - - - -
  • - - vspace: Specifies the amount of vertical space that surrounds the image where no - - text appears. The default value is 8. - -
    • - - - -
  • - - id: Specifies the name for the movie clip instance (created by Flash Player) that contains - - the embedded image file, SWF file, or movie clip. This approach is used to control the embedded content with - - ActionScript. - -
    • - - - -
  • - - checkPolicyFile: Specifies that Flash Player checks for a URL policy file - - on the server associated with the image domain. If a policy file exists, SWF files in the domains - - listed in the file can access the data of the loaded image, for example, by calling the - - BitmapData.draw() method with this image as the source parameter. - - For more information related to security, see the Flash Player Developer Center Topic: - - Security. - - -
    • - - - -
- -

Flash displays media embedded in a text field at full size. To specify the dimensions of the media - - you are embedding, use the <img> tag height and width - - attributes.

- - - -

In general, an image embedded in a text field appears on the line following the - - <img> tag. However, when the <img> tag - - is the first character in the text field, the image appears on the first line of the text field.

- - - -

For AIR content in the application security sandbox, AIR ignores img tags in - - HTML content in ActionScript TextField objects. This is to prevent possible phishing attacks,

- - - -
- - Italic tag - - - - The <i> tag displays the tagged text in italics. An italic typeface must be available - - for the font used. - -
- - List item tag - - - - The <li> tag places a bullet in front of the text that it encloses. - - Note: Because Flash Player and AIR do not recognize ordered and unordered list tags (<ol> - - and <ul>, they do not modify how your list is rendered. All lists are unordered and all - - list items use bullets. - -
- - Paragraph tag - - - - The <p> tag creates a new paragraph. The text field must be set to be a multiline - - text field to use this tag. - - - - The <p> tag supports the following attributes: - -
    - - - -
  • - - align: Specifies alignment of text within the paragraph; valid values are left, right, justify, and center. - -
    • - - - -
  • - - class: Specifies a CSS style class defined by a flash.text.StyleSheet object. - -
    • - - - -
- - - -
- - Span tag - - - - - - The <span> tag is available only for use with CSS text styles. It supports the - - following attribute: - - - -
    - - - -
  • - - class: Specifies a CSS style class defined by a flash.text.StyleSheet object. - -
    • - - - -
- - - -
- - Text format tag - - - -

The <textformat> tag lets you use a subset of paragraph formatting - - properties of the TextFormat class within text fields, including line leading, indentation, - - margins, and tab stops. You can combine <textformat> tags with the - - built-in HTML tags.

- - - -

The <textformat> tag has the following attributes:

- -
    - - - -
  • - - blockindent: Specifies the block indentation in points; corresponds to - - TextFormat.blockIndent. - -
    • - - - -
  • - - indent: Specifies the indentation from the left margin to the first character - - in the paragraph; corresponds to TextFormat.indent. Both positive and negative - - numbers are acceptable. - -
    • - - - -
  • - - leading: Specifies the amount of leading (vertical space) between lines; - - corresponds to TextFormat.leading. Both positive and negative numbers are acceptable. - -
    • - - - -
  • - - leftmargin: Specifies the left margin of the paragraph, in points; corresponds - - to TextFormat.leftMargin. - -
    • - - - -
  • - - rightmargin: Specifies the right margin of the paragraph, in points; corresponds - - to TextFormat.rightMargin. - -
    • - - - -
  • - - tabstops: Specifies custom tab stops as an array of non-negative integers; - - corresponds to TextFormat.tabStops. - -
    • - - - -
- - - -
- - Underline tag - - - - The <u> tag underlines the tagged text. - -
- - - -

Flash Player and AIR support the following HTML entities:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - Entity - - - - Description - -
- - - - &amp;lt; - - - - - - - - < (less than) - - - -
- - - - &amp;gt; - - - - - - - - > (greater than) - - - -
- - - - &amp;amp; - - - - - - - - & (ampersand) - - - -
- - &amp;quot; - - - - - - - - " (double quotes) - - - -
- - - - &amp;apos; - - - - - - - - ' (apostrophe, single quote) - - - -
- - -

Flash Player and AIR also support explicit character codes, such as - - &#38; (ASCII ampersand) and &#x20AC; (Unicode € symbol).

- - - Implementation -
-    public function get htmlText():String -
-    public function set htmlText(value:String):void -
-

-See also -

-
-flash.text.TextField.text -
-flash.text.StyleSheet -
-flash.events.TextEvent -
-
-Example -
The following example creates a TextField called tf1, and assigns an - HTML-formatted String to its text property. When its htmlText property - is traced, the output is the HTML-formatted String, with additional tags (such as <P> and - <FONT>) automatically added by Flash Player. When the value of the text - property is traced, the unformatted string without HTML tags is displayed. - -

By way of comparison, the same steps are performed on another TextField object named - tf2, with the addition that a StyleSheet object is assigned to tf2's - styleSheet property before its htmlText property is set. In that case, - when the htmlText property is traced, it only includes the exact HTML text that was - originally assigned to the htmlText property, showing that no additional tags were - added by Flash Player.

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.StyleSheet;
-    import flash.text.TextField;
-
-    public class TextField_text extends Sprite {
-        public function TextField_text() {
-            var tf1:TextField = createCustomTextField(10, 10, 400, 22);
-            tf1.htmlText = "<b>Lorem ipsum dolor sit amet.</b>";
-
-            // htmlText: <P ALIGN="LEFT"><FONT FACE="Times New Roman" SIZE="12" COLOR="#000000" LETTERSPACING="0" KERNING="0">&lt;b&gt;Lorem ipsum dolor sit amet.&lt;/b&gt;</FONT></P>
-            trace("htmlText: " + tf1.htmlText);
-            // text: Lorem ipsum dolor sit amet.
-            trace("text: " + tf1.text);
-            
-            var tf2:TextField = createCustomTextField(10, 50, 400, 22);
-            tf2.styleSheet = new StyleSheet();
-            tf2.htmlText = "<b>Lorem ipsum dolor sit amet.</b>";
-            // htmlText: <b>Lorem ipsum dolor sit amet.</b>
-            trace("htmlText: " + tf2.htmlText);
-            // text: Lorem ipsum dolor sit amet.
-            trace("text: " + tf2.text);
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
lengthproperty 
-
-length:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The number of characters in a text field. A character such as tab (\t) counts as one - - character. - - -

Implementation -
-    public function get length():int -
-
- - - - - -
maxCharsproperty 
-
-maxChars:int  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The maximum number of characters that the text field can contain, as entered by a user. - - A script can insert more text than maxChars allows; the maxChars property - - indicates only how much text a user can enter. If the value of this property is 0, - - a user can enter an unlimited amount of text. - - -

The default value is 0.

-Implementation -
-    public function get maxChars():int -
-    public function set maxChars(value:int):void -
-
- - - - - -
maxScrollHproperty 
-
-maxScrollH:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The maximum value of scrollH. - - -

Implementation -
-    public function get maxScrollH():int -
-

-See also -

-
-flash.text.TextField.scrollH -
-
- - - - - -
maxScrollVproperty 
-
-maxScrollV:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The maximum value of scrollV. - - -

Implementation -
-    public function get maxScrollV():int -
-

-See also -

-
-flash.text.TextField.scrollV -
-
- - - - - -
mouseWheelEnabledproperty 
-
-mouseWheelEnabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A Boolean value that indicates whether Flash Player automatically scrolls multiline - - text fields when the user clicks a text field and rolls the mouse wheel. - - By default, this value is true. This property is useful if you want to prevent - - mouse wheel scrolling of text fields, or implement your own text field scrolling. - - -

Implementation -
-    public function get mouseWheelEnabled():Boolean -
-    public function set mouseWheelEnabled(value:Boolean):void -
-
- - - - - -
multilineproperty 
-
-multiline:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Indicates whether field is a multiline text field. If the value is true, - - the text field is multiline; if the value is false, the text field is a single-line - - text field. In a field of type TextFieldType.INPUT, the multiline value - - determines whether the Enter key creates a new line (a value of false, - - and the Enter key is ignored). - - If you paste text into a TextField with a multiline value of false, - - newlines are stripped out of the text. - - - - -

The default value is false.

-Implementation -
-    public function get multiline():Boolean -
-    public function set multiline(value:Boolean):void -
-

-See also -

-
-numLines -
-
- - - - - -
numLinesproperty 
-
-numLines:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Defines the number of text lines in a multiline text field. - - If wordWrap property is set to true, - - the number of lines increases when text wraps. - - -

Implementation -
-    public function get numLines():int -
-

-See also -

-
-multiline -
-wordWrap -
-
- - - - - -
restrictproperty 
-
-restrict:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Indicates the set of characters that a user can enter into the text field. If the value of the - - restrict property is null, you can enter any character. If the value of - - the restrict property is an empty string, you cannot enter any character. If the value - - of the restrict property is a string of characters, you can enter only characters in - - the string into the text field. The string is scanned from left to right. You can specify a range by - - using the hyphen (-) character. Only user interaction is restricted; a script can put any text into the - - text field. This property does not synchronize with the Embed font options - - in the Property inspector. - - -

If the string begins with a caret (^) character, all characters are initially accepted and - - succeeding characters in the string are excluded from the set of accepted characters. If the string does - - not begin with a caret (^) character, no characters are initially accepted and succeeding characters in the - - string are included in the set of accepted characters.

- - -

The following example allows only uppercase characters, spaces, and numbers to be entered into - - a text field:

- - 
-
-     my_txt.restrict = "A-Z 0-9";
-
-
- -

The following example includes all characters, but excludes lowercase letters:

- - 
-
-     my_txt.restrict = "^a-z";
-
-
- -

You can use a backslash to enter a ^ or - verbatim. The accepted backslash sequences are \-, \^ or \\. - - The backslash must be an actual character in the string, so when specified in ActionScript, a double backslash - - must be used. For example, the following code includes only the dash (-) and caret (^):

- - 
-
-     my_txt.restrict = "\\-\\^";
-
-
- -

The ^ can be used anywhere in the string to toggle between including characters and excluding characters. - - The following code includes only uppercase letters, but excludes the uppercase letter Q:

- - 
-
-     my_txt.restrict = "A-Z^Q";
-
-
- -

You can use the \u escape sequence to construct restrict strings. - - The following code includes only the characters from ASCII 32 (space) to ASCII 126 (tilde).

- - 
-
-     my_txt.restrict = "\u0020-\u007E";
-
-
- - -

The default value is null.

-Implementation -
-    public function get restrict():String -
-    public function set restrict(value:String):void -
-
- - - - - -
scrollHproperty 
-
-scrollH:int  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The current horizontal scrolling position. If the scrollH property is 0, the text - - is not horizontally scrolled. This property value is an integer that represents the horizontal - - position in pixels. - - - -

The units of horizontal scrolling are pixels, whereas the units of vertical scrolling are lines. - - Horizontal scrolling is measured in pixels because most fonts you typically use are proportionally - - spaced; that is, the characters can have different widths. Flash Player performs vertical scrolling by - - line because users usually want to see a complete line of text rather than a - - partial line. Even if a line uses multiple fonts, the height of the line adjusts to fit - - the largest font in use.

- - - -

Note: The scrollH property is zero-based, not 1-based like - - the scrollV vertical scrolling property.

- - - Implementation -
-    public function get scrollH():int -
-    public function set scrollH(value:int):void -
-

-See also -

-
-flash.text.TextField.maxScrollH -
-flash.text.TextField.scrollV -
-
- - - - - -
scrollVproperty 
-
-scrollV:int  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The vertical position of text in a text field. The scrollV property is useful for - - directing users to a specific paragraph in a long passage, or creating scrolling text fields. - - -

The units of vertical scrolling are lines, whereas the units of horizontal scrolling are pixels. - - If the first line displayed is the first line in the text field, scrollV is set to 1 (not 0). - - Horizontal scrolling is measured in pixels because most fonts are proportionally - - spaced; that is, the characters can have different widths. Flash performs vertical scrolling by line - - because users usually want to see a complete line of text rather than a partial line. - - Even if there are multiple fonts on a line, the height of the line adjusts to fit the largest font in - - use.

- - - - Implementation -
-    public function get scrollV():int -
-    public function set scrollV(value:int):void -
-

-See also -

-
-flash.text.TextField.scrollH -
-flash.text.TextField.maxScrollV -
-
- - - - - -
selectableproperty 
-
-selectable:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A Boolean value that indicates whether the text field is selectable. The value true - - indicates that the text is selectable. The selectable property controls whether - - a text field is selectable, not whether a text field is editable. A dynamic text field can - - be selectable even if it is not editable. If a dynamic text field is not selectable, the user - - cannot select its text. - - -

If selectable is set to false, the text in the text field does not - - respond to selection commands from the mouse or keyboard, and the text cannot be copied with the - - Copy command. If selectable is set to true, the text in the text field - - can be selected with the mouse or keyboard, and the text can be copied with the Copy command. - - You can select text this way even if the text field is a dynamic text field instead of an input text field.

- - -

The default value is true.

-Implementation -
-    public function get selectable():Boolean -
-    public function set selectable(value:Boolean):void -
-

-See also -

-
-setSelection() -
-selectionBeginIndex -
-selectionEndIndex -
-setSelection() -
-caretIndex -
-
-Example -
The following example creates two dynamic text fields: one text field with the selectable - property set to true, and the other text field with the selectable property set to false. - When you use this example, try to select the text in these fields with the mouse or the keyboard. -
-
-
-package
-{
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-
-    public class selectableExample extends Sprite
-    {
-        public function selectableExample()
-        {
-    var tf1:TextField = createCustomTextField(10, 10);
-	tf1.text="This text can be selected";
-	tf1.selectable=true;
-
-	var tf2:TextField = createCustomTextField(10, 30);
-	tf2.text="This text cannot be selected";
-	tf2.selectable=false;
-        }
-
-        private function createCustomTextField(x:Number, y:Number):TextField 
-       {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.autoSize=TextFieldAutoSize.LEFT;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
selectionBeginIndexproperty 
-
-selectionBeginIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The zero-based character index value of the first character in the current selection. - - For example, the first character is 0, the second character is 1, and so on. If no - - text is selected, this property is the value of caretIndex. - - -

Implementation -
-    public function get selectionBeginIndex():int -
-

-See also -

-
-selectable -
-selectionEndIndex -
-setSelection() -
-caretIndex -
-
-Example -
In this example, a TextField instance is created and populated with text. - An event listener is assigned so that when the user clicks on the TextField, the - printCursorPosition method is called. In that case, the values of the - caretIndex, selectionBeginIndex, and - selectionEndIndex properties are output. - -

Run this example and try clicking in the TextField to select text. Then click in the field without - selecting text. When you click in the text without making a selection, the - caretIndex property indicates where the insertion point occurs, and the selectionBeginIndex - and selectionEndIndex properties equal the caretIndex property value.

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.MouseEvent;
-    import flash.text.TextField;
-    import flash.text.TextFieldType;
-
-    public class TextField_caretIndex extends Sprite {
-        public function TextField_caretIndex() {
-            var tf:TextField = createCustomTextField(10, 10, 100, 100);
-            tf.wordWrap = true;
-            tf.type = TextFieldType.INPUT;
-            tf.text = "Click in this text field. Compare the difference between clicking without selecting versus clicking and selecting text.";
-            tf.addEventListener(MouseEvent.CLICK, printCursorPosition);
-        }
-
-        private function printCursorPosition(event:MouseEvent):void {
-            var tf:TextField = TextField(event.target);
-            trace("caretIndex:", tf.caretIndex);
-            trace("selectionBeginIndex:", tf.selectionBeginIndex);
-            trace("selectionEndIndex:", tf.selectionEndIndex);
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
selectionEndIndexproperty 
-
-selectionEndIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The zero-based character index value of the last character in the current selection. - - For example, the first character is 0, the second character is 1, and so on. If no - - text is selected, this property is the value of caretIndex. - - -

Implementation -
-    public function get selectionEndIndex():int -
-

-See also -

-
-selectable -
-selectionBeginIndex -
-setSelection() -
-caretIndex -
-
-Example -
In this example, a TextField instance is created and populated with text. - An event listener is assigned so that when the user clicks on the TextField, the - printCursorPosition method is called. In that case, the values of the - caretIndex, selectionBeginIndex, and - selectionEndIndex properties are output. - -

Run this example and try clicking in the TextField to select text. Then click in the field without - selecting text. When you click in the text without making a selection, the - caretIndex property indicates where the insertion point occurs, and the selectionBeginIndex - and selectionEndIndex properties equal the caretIndex property value.

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.MouseEvent;
-    import flash.text.TextField;
-    import flash.text.TextFieldType;
-
-    public class TextField_caretIndex extends Sprite {
-        public function TextField_caretIndex() {
-            var tf:TextField = createCustomTextField(10, 10, 100, 100);
-            tf.wordWrap = true;
-            tf.type = TextFieldType.INPUT;
-            tf.text = "Click in this text field. Compare the difference between clicking without selecting versus clicking and selecting text.";
-            tf.addEventListener(MouseEvent.CLICK, printCursorPosition);
-        }
-
-        private function printCursorPosition(event:MouseEvent):void {
-            var tf:TextField = TextField(event.target);
-            trace("caretIndex:", tf.caretIndex);
-            trace("selectionBeginIndex:", tf.selectionBeginIndex);
-            trace("selectionEndIndex:", tf.selectionEndIndex);
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
sharpnessproperty 
-
-sharpness:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The sharpness of the glyph edges in this text field. This property applies - - only if the flash.text.AntiAliasType property of the text field is set to - - flash.text.AntiAliasType.ADVANCED. The range for - - sharpness is a number from -400 to 400. If you attempt to set - - sharpness to a value outside that range, Flash sets the property to - - the nearest value in the range (either -400 or 400). - - -

The default value is 0.

-Implementation -
-    public function get sharpness():Number -
-    public function set sharpness(value:Number):void -
-

-See also -

-
-flash.text.TextField.antiAliasType -
-flash.text.AntiAliasType -
-
-Example -
The following example shows the effect of changing the sharpness - property for a TextField object. You need to embed the font, and set the - antiAliasType property to ADVANCED. -
-
-
-package
-{
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.text.AntiAliasType;
-    import flash.text.GridFitType;
-    import flash.text.TextFormat;
-
-    public class sharpnessExample extends Sprite
-    {
-        public function sharpnessExample()
-        {
-    var format1:TextFormat = new TextFormat();
-	format1.font="Arial";
-	format1.size=24;
-	var lTxt:String = "The quick brown fox";
-
-	var tf1:TextField=createCustomTextField(0,lTxt,format1,-400);
-	var tf2:TextField=createCustomTextField(30,lTxt,format1,0);
-	var tf3:TextField=createCustomTextField(60,lTxt,format1,400);
-        }
-
-        private function createCustomTextField(y:Number,fldTxt:String,format:TextFormat,fldSharpness:Number):TextField 
-       {
-            var result:TextField = new TextField();
-            result.y=y;
-            result.text=fldTxt;
-            result.embedFonts=true;
-            result.autoSize=TextFieldAutoSize.LEFT;
-            result.antiAliasType=AntiAliasType.ADVANCED;
-            result.gridFitType=GridFitType.PIXEL;
-            result.sharpness=fldSharpness;
-            result..setTextFormat(format);
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
styleSheetproperty 
-
-styleSheet:StyleSheet  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Attaches a style sheet to the text field. For information on creating style sheets, see the StyleSheet class - - and the ActionScript 3.0 Developer's Guide. - - -

You can change the style sheet associated with a text field at any time. If you change - - the style sheet in use, the text field is redrawn with the new style sheet. - - You can set the style sheet to null or undefined - - to remove the style sheet. If the style sheet in use is removed, the text field is redrawn without a style sheet.

- -

Note: If the style sheet is removed, the contents of both TextField.text and - - TextField.htmlText change to incorporate the formatting previously applied by the style sheet. To preserve - - the original TextField.htmlText contents without the formatting, save the value in a variable before - - removing the style sheet.

- - - Implementation -
-    public function get styleSheet():StyleSheet -
-    public function set styleSheet(value:StyleSheet):void -
-

-See also -

-
-flash.text.StyleSheet -
-
-Example -
The following example defines a simple StyleSheet object - and assigns it to a text field with HTML content. Set the - stylesheet property before setting the content. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.StyleSheet;
-
-    public class TextStylesheetExample extends Sprite {
-        var myLabel:TextField = new TextField();
-        var labelText:String = "Hello world.";
-        var newStyle:StyleSheet = new StyleSheet();
-
-        public function TextStylesheetExample()
-       {
-            var styleObj:Object = new Object();
-            styleObj.fontWeight = "bold";
-            styleObj.color = "#660066";
-            newStyle.setStyle(".defStyle", styleObj);
-
-            myLabel.styleSheet=newStyle;
-            myLabel.htmlText=labelText;
-            addChild(myLabel);
-        }
-    }
-}
-
-

-
- - - - - -
textproperty 
-
-text:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A string that is the current text in the text field. Lines are separated by the carriage - - return character ('\r', ASCII 13). This property contains unformatted text in the text - - field, without HTML tags. - - -

To get the text in HTML form, use the htmlText property.

- - -

Note: If a style sheet is applied to the text field the content - - of the text property will be interpreted as HTML.

- - - Implementation -
-    public function get text():String -
-    public function set text(value:String):void -
-

-See also -

-
-flash.text.TextField.htmlText -
-
-Example -
The following example creates a TextField called tf1, and assigns an - HTML-formatted String to its text property. When its htmlText property - is traced, the output is the HTML-formatted String, with additional tags (such as <P> and - <FONT>) automatically added by Flash Player. When the value of the text - property is traced, the unformatted string without HTML tags is displayed. - -

By way of comparison, the same steps are performed on another TextField object named - tf2, with the addition that a StyleSheet object is assigned to tf2's - styleSheet property before its htmlText property is set. In that case, - when the htmlText property is traced, it only includes the exact HTML text that was - originally assigned to the htmlText property, showing that no additional tags were - added by Flash Player.

-
-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.StyleSheet;
-    import flash.text.TextField;
-
-    public class TextField_text extends Sprite {
-        public function TextField_text() {
-            var tf1:TextField = createCustomTextField(10, 10, 400, 22);
-            tf1.htmlText = "<b>Lorem ipsum dolor sit amet.</b>";
-
-            // htmlText: <P ALIGN="LEFT"><FONT FACE="Times New Roman" SIZE="12" COLOR="#000000" LETTERSPACING="0" KERNING="0">&lt;b&gt;Lorem ipsum dolor sit amet.&lt;/b&gt;</FONT></P>
-            trace("htmlText: " + tf1.htmlText);
-            // text: Lorem ipsum dolor sit amet.
-            trace("text: " + tf1.text);
-            
-            var tf2:TextField = createCustomTextField(10, 50, 400, 22);
-            tf2.styleSheet = new StyleSheet();
-            tf2.htmlText = "<b>Lorem ipsum dolor sit amet.</b>";
-            // htmlText: <b>Lorem ipsum dolor sit amet.</b>
-            trace("htmlText: " + tf2.htmlText);
-            // text: Lorem ipsum dolor sit amet.
-            trace("text: " + tf2.text);
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
textColorproperty 
-
-textColor:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The color of the text in a text field, in hexadecimal format. - - The hexadecimal color system uses six digits to represent - - color values. Each digit has 16 possible values or characters. The characters range from - - 0-9 and then A-F. For example, black is 0x000000; white is - - 0xFFFFFF. - - -

The default value is 0 (0x000000).

-Implementation -
-    public function get textColor():uint -
-    public function set textColor(value:uint):void -
-
-Example -
The following ActionScript creates a TextField object and changes its - textColor property to red (0xFF0000). -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-
-    public class TextField_textColor extends Sprite {
-        public function TextField_textColor() {
-            var tf:TextField = createCustomTextField(10, 10, 100, 300);
-            tf.text = "This will be red text";
-            tf.textColor = 0xFF0000;            
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
textHeightproperty 
-
-textHeight:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The height of the text in pixels. - - -

Implementation -
-    public function get textHeight():Number -
-

-See also -

-
-flash.text.TextField.textWidth -
-
-Example -
The following example creates a TextField object and assigns text to it. - The trace statements display the values of the textWidth and - textHeight properties. For comparison, the width and height - properties are also displayed. (Note that the values you see for textHeight and textWidth might - vary depending on the font that is used on your machine). -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-
-    public class TextField_textHeight extends Sprite {
-        public function TextField_textHeight() {
-            var tf:TextField = createCustomTextField(10, 10, 100, 150);
-            tf.text = "Sample text";
-            
-            trace("textWidth: " + tf.textWidth); // textWidth: 55.75
-            trace("textHeight: " + tf.textHeight); // textHeight: 13.450000000000001
-            trace("width: " + tf.width); // width: 100
-            trace("height: " + tf.height); // height: 150
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            result.border = true;
-            result.background = true;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
textInteractionModeproperty 
-
-textInteractionMode:String  [read-only]

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: 
-

- - The interaction mode property, Default value is TextInteractionMode.NORMAL. - - On mobile platforms, the normal mode implies that the text can be scrolled but not selected. - - One can switch to the selectable mode through the in-built context menu on the text field. - - On Desktop, the normal mode implies that the text is in scrollable as well as selection mode. - -

Implementation -
-    public function get textInteractionMode():String -
-
- - - - - -
textWidthproperty 
-
-textWidth:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The width of the text in pixels. - - -

Implementation -
-    public function get textWidth():Number -
-

-See also -

-
-flash.text.TextField.textHeight -
-
-Example -
The following example creates a TextField object and assigns text to it. - The trace statements display the values of the textWidth and - textHeight properties. For comparison, the width and height - properties are also displayed. (Note that the values you see for textHeight and textWidth might - vary depending on the font that is used on your machine). -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-
-    public class TextField_textHeight extends Sprite {
-        public function TextField_textHeight() {
-            var tf:TextField = createCustomTextField(10, 10, 100, 150);
-            tf.text = "Sample text";
-            
-            trace("textWidth: " + tf.textWidth); // textWidth: 55.75
-            trace("textHeight: " + tf.textHeight); // textHeight: 13.450000000000001
-            trace("width: " + tf.width); // width: 100
-            trace("height: " + tf.height); // height: 150
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            result.border = true;
-            result.background = true;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
thicknessproperty 
-
-thickness:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The thickness of the glyph edges in this text field. This property applies only - - when flash.text.AntiAliasType is set to flash.text.AntiAliasType.ADVANCED. - - -

The range for thickness is a number from -200 to 200. If you attempt to - - set thickness to a value outside that range, the property is set to the - - nearest value in the range (either -200 or 200).

- - -

The default value is 0.

-Implementation -
-    public function get thickness():Number -
-    public function set thickness(value:Number):void -
-

-See also -

-
-flash.text.TextField.antiAliasType -
-flash.text.AntiAliasType -
-
-Example -
The following example shows the effect of changing the thickness - property for a TextField object. You need to embed the font, and set the antiAliasType - property to ADVANCED. -
-
-
-package
-{
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.text.AntiAliasType;
-    import flash.text.GridFitType;
-    import flash.text.TextFormat;
-
-    public class thicknessExample extends Sprite
-    {
-        public function thicknessExample()
-        {
-    var format1:TextFormat = new TextFormat();
-	format1.font="Arial";
-	format1.size=24;
-	var lTxt:String = "The quick brown fox";
-
-	var tf1:TextField=createCustomTextField(0,lTxt,format1,-200);
-	var tf2:TextField=createCustomTextField(30,lTxt,format1,0);
-	var tf3:TextField=createCustomTextField(60,lTxt,format1,200);
-        }
-
-        private function createCustomTextField(y:Number,fldTxt:String,format:TextFormat,fldThickness:Number):TextField 
-       {
-            var result:TextField = new TextField();
-            result.y=y;
-            result.text=fldTxt;
-            result.embedFonts=true;
-            result.autoSize=TextFieldAutoSize.LEFT;
-            result.antiAliasType=AntiAliasType.ADVANCED;
-            result.gridFitType=GridFitType.PIXEL;
-            result.thickness=fldThickness;
-            result.setTextFormat(format);
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
typeproperty 
-
-type:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The type of the text field. - - Either one of the following TextFieldType constants: TextFieldType.DYNAMIC, - - which specifies a dynamic text field, which a user cannot edit, or TextFieldType.INPUT, - - which specifies an input text field, which a user can edit. - - -

The default value is dynamic.

-Implementation -
-    public function get type():String -
-    public function set type(value:String):void -
-
-Throws -
- - - - -
ArgumentError — The type specified is not a member of flash.text.TextFieldType. - - -
-

-See also -

-
-flash.text.TextFieldType -
-
-Example -
The following example creates two text fields: tfDynamic and - tfInput. Text is entered into both text fields. However, - tfDynamic has its type property set to - TextFieldType.DYNAMIC, and tfInput has its - type property set to TextFieldType.INPUT, so the user can - modify the text in tfInput but can only view the text in tfDynamic. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldType;
-
-    public class TextField_type extends Sprite {
-        public function TextField_type() {
-            var tfDynamic:TextField = createCustomTextField(10, 10, 100, 20);
-            tfDynamic.type = TextFieldType.DYNAMIC;
-            tfDynamic.text = "hello";
-
-            var tfInput:TextField = createCustomTextField(10, 45, 100, 20);
-            tfInput.type = TextFieldType.INPUT;
-            tfInput.text = "world";
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            result.background = true;
-            result.border = true;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
useRichTextClipboardproperty 
-
-useRichTextClipboard:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies whether to copy and paste the text formatting along with the text. When set to true, - - Flash Player copies and pastes formatting (such as alignment, bold, and italics) when you copy and paste between text fields. Both the origin and destination text fields for the copy and paste procedure must have - - useRichTextClipboard set to true. The default value - - is false. - - - -

Implementation -
-    public function get useRichTextClipboard():Boolean -
-    public function set useRichTextClipboard(value:Boolean):void -
-
-Example -
This example creates an input text field (tf1) and two dynamic - text fields (tf2 and tf3). - The code assigns each dynamic text field a TextFormat object (Courier Bold font). - The tf2 text field has useRichTextClipboard property set to - false. The tf3 text field has the - useRichTextClipboard property set to true. - When you copy the text from the tf2 text field - and paste it into the tf1 text field, the pasted text does not include - the formatting. When you copy the text from the tf3 text field (which has - useRichTextClipboard set to true) and paste it into the - tf1 text field, the pasted text includes the formatting. -
-
-
-package
-{
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldType;
-    import flash.text.TextFormat;
-
-    public class useRichTextClipboard extends Sprite
-    {
-        public function useRichTextClipboard()
-        {
-    var format1:TextFormat = new TextFormat();
-	format1.font="Courier";
-	format1.bold=true;
-
-	var tf1:TextField = createCustomTextField(10, 10, 200, 20);
-	tf1.type=TextFieldType.INPUT;
-	tf1.useRichTextClipboard=true;
-
-	var tf2:TextField = createCustomTextField(220, 10, 200, 20);
-	tf2.text="1.Text loses format";
-	tf2.setTextFormat(format1);
-	tf2.useRichTextClipboard=false;
-
-	var tf3:TextField = createCustomTextField(220, 50, 200, 20);
-	tf3.text="2.Text includes format";
-	tf3.setTextFormat(format1);
-	tf3.useRichTextClipboard=true;
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField 
-       {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            result.background = true;
-            result.border = true;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- - - - - -
wordWrapproperty 
-
-wordWrap:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A Boolean value that indicates whether the text field has word wrap. If the value of - - wordWrap is true, the text field has word wrap; - - if the value is false, the text field does not have word wrap. The default - - value is false. - - -

Implementation -
-    public function get wordWrap():Boolean -
-    public function set wordWrap(value:Boolean):void -
-
-Example -
This example demonstrates the difference between setting the wordWrap - property to true and setting it to false. Two TextField instances are - created whose contents are too large for their widths. The wordWrap property of - the first (named tfWrap) is set to true; it is set to false - for the second (tfNoWrap). -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-
-    public class TextField_wordWrap extends Sprite {
-        public function TextField_wordWrap() {
-            var tfWrap:TextField = createCustomTextField(10, 10, 100, 100);
-            tfWrap.wordWrap = true;
-            tfWrap.text = "(wordWrap = true):\nThis is very long text that will certainly extend beyond the width of this text field";
-
-            var tfNoWrap:TextField = createCustomTextField(10, 150, 100, 100);
-            tfNoWrap.wordWrap = false;
-            tfNoWrap.text = "(wordWrap = false):\nThis is very long text that will certainly extend beyond the width of this text field";
-        }
-
-        private function createCustomTextField(x:Number, y:Number, width:Number, height:Number):TextField {
-            var result:TextField = new TextField();
-            result.x = x;
-            result.y = y;
-            result.width = width;
-            result.height = height;
-            result.background = true;
-            result.border = true;
-            addChild(result);
-            return result;
-        }
-    }
-}
-
-

-
- -
Constructor detail
- - - - - -
TextField()constructor
-
-public function TextField() -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates a new TextField instance. After you create the TextField instance, call the - - addChild() or addChildAt() method of the parent - - DisplayObjectContainer object to add the TextField instance to the display list. - -

The default size for a text field is 100 x 100 pixels.

- - - - -
-Example -
The following example shows how you can dynamically create an input TextField object in ActionScript 3.0 by setting the text field object's type property to the TextFieldType.INPUT constant. - Example provided by - ActionScriptExamples.com. -
-
-var theTextField:TextField = new TextField();
-theTextField.type = TextFieldType.INPUT;
-theTextField.border = true;
-theTextField.x = 10;
-theTextField.y = 10;
-theTextField.multiline = true;
-theTextField.wordWrap = true;
-addChild(theTextField);
-
-

-
- -
Method detail
- - - - - -
appendText()method
-
-public function appendText(newText:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Appends the string specified by the newText parameter to the end of the text - - of the text field. This method is more efficient than an addition assignment (+=) on - - a text property (such as someTextField.text += moreText), - - particularly for a text field that contains a significant amount of content. - - -

Parameters - - - - -
newText:String — The string to append to the existing text. - - -
-
-Example -
The following example displays the time if it's not the weekend or the text, "It's the weekend," - if it is. It also counts the number of characters up to a certain position and the number of lines in the text field. - -

The outputText text field is set to automatically fit the text and to resize as a - left-justified text using autoSize property. The outputText.text property writes the first - line of the content and the method appendText() appends the rest of the content. (It is not - necessary to start with the text property. The appendText() method could also be - used to append text from the outset.) Setting the text property a second time will overwrite - the original text. Use += operator to append content with the text property.

- -

The if statement checks if the date is Saturday (6) or Sunday (0). If it's not, the - toLocaleTimeString() method returns the local time, which is appended to the text field's content.

- -

The text field's length property is used to read the number of characters until right - before the function is called, and the property numLines is used to count the number of lines - in the text field. Note that the empty lines are counted in the number of lines and the empty spaces and - line breaks (\n) are counted in determining the content length.

- -
-
-  package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
- 
-    public class TextField_appendTextExample extends Sprite {
-         
-        public function TextField_appendTextExample() {
-            var outputText:TextField = new TextField();
-            var today:Date = new Date();
-                
-            outputText.x = 10;
-            outputText.y = 10;
-            outputText.background = true;
-            outputText.autoSize = TextFieldAutoSize.LEFT;
- 
-            outputText.text = "WHAT TIME IS IT?" + "\n\n";
- 
-            if((today.day == 0) || (today.day == 6)) {
-                outputText.appendText("It's the weekend.");
-                outputText.appendText("\n\n");
-           
-            } else {
-                outputText.appendText("The time is: ");
-                outputText.appendText(today.toLocaleTimeString() + ".\n\n");  
-            }
-
-            outputText.appendText("Number of characters including line breaks and spaces so far: ");
-            outputText.appendText(outputText.length.toString() + "\n");
-            outputText.appendText("Number of lines in the outputText: ");
-            outputText.appendText(outputText.numLines.toString());   
-
-            this.addChild(outputText);
-        }
-    }
-}
-
-

-
- - - - - -
getCharBoundaries()method 
-
-public function getCharBoundaries(charIndex:int):Rectangle -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a rectangle that is the bounding box of the character. - - -

Parameters - - - - -
charIndex:int — The zero-based index value for the character (for example, the first - - position is 0, the second position is 1, and so on). - - -
-

-Returns - - - - -
Rectangle — - A rectangle with x and y minimum and maximum values - - defining the bounding box of the character. - - - - -
-

-See also -

-
-flash.geom.Rectangle -
-
-Example -
In the following example the getCharBoundaries() method is used to mark - (put a spotlight on) a character that is selected by the user. - -

The class defines the spotlight Shape object that will be used to draw a rectangle around - each character that is selected. When the user clicks on the myTextField text field, the - clickHandler() method is invoked.

- -

In the clickHandler() method, the getCharIndexAtPoint() method gets the clicked character's - index based on the localX and localY coordinates of the mouse click, which is relative - to the containing Sprite. The getCharIndexAtPoint() method returns -1 if - the point (mouse click) was not over any character. Since the text field could be larger than the text, the returned - integer (index) is checked to make sure the user has clicked on a character. The index integer - is also used by getCharBoundaries() to get a Rectangle object that holds the boundary - of the character. The clear() method clears any previously displayed spotlight Shape object. A - new rectangle the size of the character's width and height boundaries is produced at the location of the character - (offset from the (10, 10) coordinates) using the returned frame rectangle's x and y coordinates. - To put the spotlight on the character, the spotlight Shape object is filled with color yellow and the - opacity is set to 35 percent, so the character can be seen. Note that spaces are also considered a character.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.events.MouseEvent;
-    import flash.text.TextField;
-    import flash.geom.Rectangle;
-    import flash.events.MouseEvent;
-    import flash.text.TextFieldAutoSize;
-    import flash.display.Shape;
-
-    public class TextField_getCharBoundariesExample extends Sprite
-    {
-        private var myTextField:TextField = new TextField();    
-        private var spotlight:Shape = new Shape();
-        
-        public function TextField_getCharBoundariesExample() {
-            
-            myTextField.x = 10;
-            myTextField.y = 10; 
-            myTextField.border = true;
-            myTextField.selectable = false;
-            myTextField.autoSize = TextFieldAutoSize.LEFT;
-            
-            myTextField.text = "Selected a character from this text by clicking on it."
-
-            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-            
-            this.addChild(myTextField);    
-            this.addChild(spotlight);
-         }
-
-        private function clickHandler (e:MouseEvent):void {
-            var index:int = myTextField.getCharIndexAtPoint(e.localX, e.localY);
- 
-            if (index != -1) {
-                 var frame:Rectangle = myTextField.getCharBoundaries(index);
-
-                spotlight.graphics.clear();    
-                spotlight.graphics.beginFill(0xFFFF00, .35);
-                spotlight.graphics.drawRect((frame.x + 10), (frame.y + 10), frame.width, frame.height);            
-                spotlight.graphics.endFill();
-            }
-        } 
-    }
-}
-
-

-
- - - - - -
getCharIndexAtPoint()method 
-
-public function getCharIndexAtPoint(x:Number, y:Number):int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the zero-based index value of the character at the point specified by the x - - and y parameters. - - -

Parameters - - - - - - - - - - -
x:Number — The x coordinate of the character. - - -
 
y:Number — The y coordinate of the character. - - -
-

-Returns - - - - -
int — - The zero-based index value of the character (for example, the first position is 0, - - the second position is 1, and so on). Returns -1 if the point is not over any character. - - - - -
-
-Example -
In the following example, when a user clicked on a character, the character is echoed - in another text field above the text. - -

The first text field holds the text the user is going to select. In order to make sure the text - is clicked but not selected, selectable property is set to false. When the user clicks - on the firstTextField text field, the clickHandler() method is invoked.

- -

In the clickHandler() method, the getCharIndexAtPoint() method returns the character's - index based on the localX and localY coordinates of the mouse click. Since the text field - could be larger than the text, the return integer (index) is checked to make sure the user has clicked - on a character. (The getCharIndexAtPoint() method returns -1, if the point (mouse click) - was not over a character.) The mouse coordinates is used to set the coordinates of the new text field where the - echoed character will appear. The color of the character in the second text field is set to red. Finally - the text of the second field is set to the selected character, which is retrieved using the charAt() method. - Note that using the text property instead of the appendText() method will overwrite the character - in the second text field, instead of appending it.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.events.MouseEvent;
-    import flash.text.TextField;
-    import flash.geom.Rectangle;
-    import flash.events.MouseEvent;
-    import flash.text.TextFieldAutoSize;
-    
-    public class TextField_getCharIndexAtPointExample extends Sprite {
-        private var firstTextField:TextField = new TextField();    
-        private var secondTextField:TextField = new TextField();
-        
-        public function TextField_getCharIndexAtPointExample() {
-
-            firstTextField.x = 100;
-            firstTextField.y = 100; 
-            firstTextField.width = 260;
-            firstTextField.height = 20;
-            firstTextField.border = true;
-            firstTextField.background = true;
-            firstTextField.selectable = false;
-            
-            firstTextField.text = "Selected a character from this text by clicking on it."
-
-            firstTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-
-            this.addChild(firstTextField);    
-            this.addChild(secondTextField);
-         }
-
-        private function clickHandler (e:MouseEvent):void {
-            var index:int = firstTextField.getCharIndexAtPoint(e.localX, e.localY);
-
-            if (index != -1) {
-                secondTextField.x = mouseX;
-                secondTextField.y =  70;
-                secondTextField.border = true;
-                secondTextField.selectable = false;
-                secondTextField.background = true;
-                secondTextField.textColor = 0xFF0000;
-                secondTextField.autoSize = TextFieldAutoSize.LEFT;
-                secondTextField.text = firstTextField.text.charAt(index);    
-            }
-        } 
-    }
-}
-
-

-
- - - - - -
getFirstCharInParagraph()method 
-
-public function getFirstCharInParagraph(charIndex:int):int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Given a character index, returns the index of the first character in the same paragraph. - - -

Parameters - - - - -
charIndex:int — The zero-based index value of the character (for example, the first character is 0, - - the second character is 1, and so on). - - -
-

-Returns - - - - -
int — - The zero-based index value of the first character in the same paragraph. - - - - -
-
-Throws - - - - -
RangeError — The character index specified is out of range. - - -
-
-Example -
In the following example, paragraph formatting is applied to the text field content. - When the user clicks on a paragraph, the text of the paragraph will be aligned right and when the user - clicks on the paragraph again, it will return to the original (default) format (left-align). - -

In the constructor, the myTextField text field is set to text wrap. The getTextFormat - method returns the original format of the first character of the content of the text field, which is placed - in the originalFormat TextFormat object. A new TextFormat object (newFormat) is - also defined and its align property is assigned to right-justified. When the user clicks - on the text field, the clickHandler() method is invoked.

- -

In the clickHandler() method, the getCharIndexAtPoint() method returns the character's - index based on the localX and localY coordinates of the mouse click. The first if - statement checks to see if the use has clicked on a character. Using the clickIndex integer returned by the - getCharIndexAtPoint() method, the getFirstCharInParagraph() method returns the index of the - first character in the paragraph the user has clicked. The index of the last character in the paragraph is - determined by adding the length of the paragraph (using getParagraphLength() method) to the index of the first - character in the paragraph, minus the last character (\n). The second if statement - checks the format of the first character in the paragraph. If its alignment value is the same as the - original format (left-justified), the new format is applied to all the characters in the paragraph. - Otherwise, the format of the paragraph is set back to the original format. Alignment, along with formatting - like indent, bullet, tab stop, left and right margin are formats that are meant for paragraphs. - Note that once word wrap or line break is used, the formatting will only apply to the first line of the - paragraph if endIndex argument is not defined for the setTextFormat() method.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.events.MouseEvent;
-    import flash.text.TextFormat;
-    import flash.text.TextFormatAlign;
-
-    public class TextField_getFirstCharInParagraphExample extends Sprite
-    {
-        private var myTextField:TextField = new TextField();
-        private var originalFormat:TextFormat = new TextFormat();
-        private var newFormat:TextFormat = new TextFormat(); 
-        
-        public function TextField_getFirstCharInParagraphExample() {
-            myTextField.x = 10;
-            myTextField.y = 10; 
-            myTextField.border = true;
-            myTextField.wordWrap = true;
-            myTextField.width = 300;
-            myTextField.height = 300; 
-            myTextField.background = true;
-             
-            myTextField.appendText("The TextField class is used to create display objects for "
-                        + "text display and input. All dynamic and input text fields in a SWF file " 
-                        + "are instances of the TextField class. You can use the TextField class "
-                        + "to perform low-level text rendering. However, in Flex, you typically use "
-                        + "the Label, Text, TextArea, and TextInput controls to process text. "  
-                        + "You can give a text field an instance name in the Property inspector "
-                        + "and use the methods and properties of the TextField class to manipulate it with ActionScript. "
-                        + "TextField instance names are displayed in the Movie Explorer and in the Insert "
-                        + "Target Path dialog box in the Actions panel.\n\n"  
-                        + "To create a text field dynamically, use the TextField constructor.\n\n"
-                        + "The methods of the TextField class let you set, select, and manipulate "  
-                        + "text in a dynamic or input text field that you create during authoring or at runtime.\n\n");
-
-            originalFormat = myTextField.getTextFormat(0);
-
-            newFormat.align = TextFormatAlign.RIGHT;
-
-            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-  
-            this.addChild(myTextField);
-        }
-
-        private function clickHandler(e:MouseEvent):void {
-            var clickIndex:int = myTextField.getCharIndexAtPoint(e.localX, e.localY);
-                  
-            if(clickIndex != -1) {
-                var paragraphFirstIndex:int = myTextField.getFirstCharInParagraph(clickIndex);
-                var paragraphEndIndex:int = paragraphFirstIndex + ((myTextField.getParagraphLength(clickIndex) - 1));
-            
-                if (myTextField.getTextFormat(paragraphFirstIndex).align == originalFormat.align) {
-                     myTextField.setTextFormat(newFormat, paragraphFirstIndex, paragraphEndIndex);
-                }else {
-                     myTextField.setTextFormat(originalFormat, paragraphFirstIndex, paragraphEndIndex);
-                }
-            } 
-        }
-    }
-}
-
-

-
- - - - - -
getImageReference()method 
-
-public function getImageReference(id:String):DisplayObject -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a DisplayObject reference for the given id, for an image or SWF file - - that has been added to an HTML-formatted text field by using an <img> tag. - - The <img> tag is in the following format: - - - - 

   <img src = 'filename.jpg' id = 'instanceName' >

- - - - Parameters - - - - -
id:String — The id to match (in the id attribute of the - - <img> tag). - - - -
-

-Returns - - - - -
DisplayObject — - The display object corresponding to the image or SWF file with the matching id - - attribute in the <img> tag of the text field. For media loaded from an external source, - - this object is a Loader object, and, once loaded, the media object is a child of that Loader object. For media - - embedded in the SWF file, it is the loaded object. If no <img> tag with - - the matching id exists, the method returns null. - - - - - -
-

-See also -

-
-htmlText -
-
-Example -
In the following example, when the text field is clicked, the image in the field is set to 25 percent opacity and - it rotates 90 degrees from its original rotation. The image will continue to rotate with each subsequent click. - -

The image (image.jpg) is included via the HTML. (Here it is assumed that an image file is in the same - directory as the SWF file.) An id attribute needs to be defined for the img tag in order - to access the image using getImageReference() method. The htmlText property is used to include - HTML-formatted string content. When the user clicks on the myTextField text field, the clickHandler() - method is invoked.

- -

In the clickHandler() method, the getImageReference() method returns a reference to - the image as a DisplayObject. This reference can be used to manipulate the image, like any DisplayObject - object. Here, the alpha (transparency) and rotation properties are set. The transform - property can also be used to access the display object's matrix, color transform, and pixel bounds. Note also that - flash.display.DisplayObject needs to be imported.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.events.Event;
-    import flash.events.MouseEvent;
-    import flash.display.DisplayObject;
-    
-    import flash.text.TextFieldAutoSize;
-    
-    public class TextField_getImageReferenceExample extends Sprite
-    {
-        private var myTextField:TextField = new TextField();
-        
-        public function TextField_getImageReferenceExample()
-        {
-            var myText1:String = "<p>Here is an image we want to mainpulate: <img src='image.jpg' id='testimage'></p>";
-
-            myTextField.x = 10;
-            myTextField.y = 10;
-            myTextField.width = 250;
-            myTextField.height = 250;
-            myTextField.background = true;
-            myTextField.border = true;
-            myTextField.border = true;
-            myTextField.multiline = true;
-
-            myTextField.htmlText = myText1;
-            
-            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-            
-            this.addChild(myTextField);
-        }
- 
-        private function clickHandler(e:MouseEvent):void {
-            var imageRef:DisplayObject = myTextField.getImageReference("testimage");
- 
-            imageRef.rotation += 90;
-            imageRef.x = 125;
-            imageRef.y = 125;
-            imageRef.alpha = 0.25;      
-        }
-    }
-}
-
-

-
- - - - - -
getLineIndexAtPoint()method 
-
-public function getLineIndexAtPoint(x:Number, y:Number):int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the zero-based index value of the line at the point specified by the x - - and y parameters. - - -

Parameters - - - - - - - - - - -
x:Number — The x coordinate of the line. - - -
 
y:Number — The y coordinate of the line. - - -
-

-Returns - - - - -
int — - The zero-based index value of the line (for example, the first line is 0, the - - second line is 1, and so on). Returns -1 if the point is not over any line. - - - - -
-
-Example -
In the following example, when a user selects a line from the Shakespeare's sonnet, - it is copied (appended) into a new text field. - -

In the constructor, the poem text field is set not to wrap (since it's a poem). - The autoSize property also is used to set the text to automatically fit and to have - it resize as a left-justified text. The poemCopy text field is placed under the - poem text field. When a user clicks on some line of the poem, the clickHandler() - method is invoked.

- -

In clickHandler() method, the getLineIndexAtPoint() method returns - the line index of where the user has clicked based on the localX and localY - coordinates of the mouse click. (Since the original poem fits the size of the text field here, - it is not necessary to check for out of range error (RangeError) thrown by - getCharIndexAtPoint() method.) The line index is then used to get the content of - the line as a string with the getLineText() method, which is then appended to the - poemCopy text field content. The copying can go on continuously but after a point, - the text will be outside of the range of the viewable poemCopy text field.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.events.MouseEvent;
-    import flash.text.TextFormat;
-    import flash.text.TextFieldAutoSize;
-
-    public class TextField_getLineIndexAtPointExample extends Sprite {
-        private var poem:TextField = new TextField();
-        private var poemCopy:TextField = new TextField();
-        
-        public function TextField_getLineIndexAtPointExample() {
-            poem.border = true;
-            poem.autoSize = TextFieldAutoSize.LEFT;
-            poem.x = 10;
-            poem.wordWrap = false;
-
-            poemCopy.height = 250;
-            poemCopy.width = 270;
-            poemCopy.y = 230;
-            poemCopy.x = 10;
-            poemCopy.background = true;
-            poemCopy.border = true;
-            poemCopy.wordWrap = false;
-            
-            poem.appendText("Let me not to the marriage of true minds\n"
-                              + "Admit impediments. love is not love\n"
-                              + "Which alters when it alteration finds\n"
-                              + "Or bends with the remover to remove:\n"
-                              + "O no! it is an ever-fixed mark\n" 
-                              + "That looks on tempests and is never shaken;\n"
-                              + "It is the star to every wandering bark,\n"
-                              + "Whose worth's unknown, although his height be taken.\n"
-                              + "Love's not Time's fool, though rosy lips and cheeks\n"
-                              + "Within his bending sickle's compass come:\n"
-                              + "Love alters not with his brief hours and weeks,\n"
-                              + "But bears it out even to the edge of doom.\n"
-                              + "If this be error and upon me proved,\n"
-                              + "I never writ, nor no man ever loved.");
-
-           poem.addEventListener(MouseEvent.CLICK, clickHandler); 
-
-           this.addChild(poem); 
-           this.addChild(poemCopy);
-        }
-    
-        private function clickHandler(e:MouseEvent):void {
-                var index:int = poem.getLineIndexAtPoint(e.localX, e.localY);
-                var s:String;
-
-                s = poem.getLineText(index);
-                poemCopy.appendText(s + "\n");
-        }
-    }
-}
-
-

-
- - - - - -
getLineIndexOfChar()method 
-
-public function getLineIndexOfChar(charIndex:int):int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the zero-based index value of the line containing the character specified - - by the charIndex parameter. - - -

Parameters - - - - -
charIndex:int — The zero-based index value of the character (for example, the first character is 0, - - the second character is 1, and so on). - - -
-

-Returns - - - - -
int — - The zero-based index value of the line. - - - - -
-
-Throws - - - - -
RangeError — The character index specified is out of range. - - -
-
-Example -
In the following example, the getLineIndexOfChar() method returns - the line numbers for the 100th and 500th characters in the text field. - -

The myTextField text field is defined to wrap and resize as a left-justified text. - The getLineIndexOfChar() method returns the line index for the specified character - indexes (100 and 500). This information is then appended after the paragraph. Note that since - line index begins with 0, the line index (index) is increased by 1 to get the line number. - Also if the display is resized the line number may change but the information here will stay the same - since the method is only invoked once.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-
-    public class TextField_getLineIndexOfCharExample extends Sprite 
-    {
-        public function TextField_getLineIndexOfCharExample()
-        {
-            var myTextField:TextField = new TextField();
-            
-            myTextField.x = 10;
-            myTextField.y = 10;
-            myTextField.width = 200;
-            myTextField.background = true;  
-            myTextField.border = true;
-            myTextField.wordWrap = true;
-            myTextField.autoSize = TextFieldAutoSize.LEFT;
-
-            myTextField.appendText("The TextField class is used to create display objects for "
-                + "text display and input. All dynamic and input text fields in a SWF file" 
-                + "are instances of the TextField class. You can use the TextField class "
-                + "to perform low-level text rendering. However, in Flex, you typically use "
-                + "the Label, Text, TextArea, and TextInput controls to process text. "  
-                + "You can give a text field an instance name in the Property inspector "
-                + "and use the methods and properties of the TextField class to manipulate it with ActionScript. "
-                + "TextField instance names are displayed in the Movie Explorer and in the Insert "
-                + "Target Path dialog box in the Actions panel.\n\n");
-
-            var index:int = myTextField.getLineIndexOfChar(100);
-            myTextField.appendText("100th character is in line: " +  (index + 1) + "\n");
-            index = myTextField.getLineIndexOfChar(500);
-            myTextField.appendText("500th character is in line: " + (index + 1));
-
-            this.addChild(myTextField);
-        }
-    }
-}
-
-

-
- - - - - -
getLineLength()method 
-
-public function getLineLength(lineIndex:int):int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the number of characters in a specific text line. - - -

Parameters - - - - -
lineIndex:int — The line number for which you want the length. - -
-

-Returns - - - - -
int — - The number of characters in the line. - - - - -
-
-Throws - - - - -
RangeError — The line number specified is out of range. - - -
-
-Example -
In the following example, once the user selects a line, its line length (number of characters) is - displayed in a separate text field. - -

As an illustration, myTextField text field, which displays the text that will be counted, is set to - INPUT, meaning users can actually change the lines or add lines between the lines or at the end. - (There is an empty line created by using line break (\n) at the end of the last line.) The countLines - text field, where the result of counting the line length is displayed, is set below myTextField - text field and its text is not selectable. When the user clicks on a line in the myTextField text field, - the clickHandler() method is invoked.

- -

In the clickHandler() method, the getLineIndexAtPoint() method returns the line index of - where the user clicked, by using the localX and localY coordinates of the mouse click. - The if statement checks to see if the use has clicked on a character. If so, the - getLineLength() method, using the index of line, returns the number of characters in the line. - Note that the empty lines between the lines include the second line break (\n) and have - a count of 1 character, while the line after the last line has a 0 count. Spaces also count as one character. - The users can write a new line or changes a line and get the character count of the line by clicking on it. - If text wrap is used and the screen is resized, the line index could change.

-
-
- package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldType;
-    import flash.events.Event;
-    import flash.events.MouseEvent;
-
-    public class TextField_getLineLengthExample extends Sprite {
-        private var myTextField:TextField = new TextField();
-        private var countLines:TextField = new TextField();  
-
-        public function TextField_getLineLengthExample() {
-            myTextField.x = 10;
-            myTextField.y = 10;
-            myTextField.width = 350;
-            myTextField.height = 150;
-            myTextField.background = true;
-            myTextField.border = true;
-            myTextField.type = TextFieldType.INPUT;
-            
-            myTextField.appendText("Click on the lines to count its number of characters:\n\n");
-            myTextField.appendText("This is a short line.\n");
-            myTextField.appendText("This is a longer line than the last line.\n\n");
-            myTextField.appendText("This one is even longer than the one before. It has two sentences.\n");
-
-            this.addChild(myTextField);
-
-            countLines.border = true;
-            countLines.x = 10;
-            countLines.y = 180;
-            countLines.height = 30;
-            countLines.width = 200;
-            countLines.background = true;
-            countLines.selectable = false;
-
-           this.addChild(countLines);    
-
-            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-        }
-
-        private function clickHandler(e:MouseEvent):void {
-            var index:int = myTextField.getLineIndexAtPoint(e.localX, e.localY);
-        
-            if (index != -1) {
-            var lenght:int = myTextField.getLineLength(index);
-
-            countLines.text = "Number of characters in the line is: " + lenght.toString();
-            }
-        }
-    }
-}
-
-

-
- - - - - -
getLineMetrics()method 
-
-public function getLineMetrics(lineIndex:int):TextLineMetrics -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns metrics information about a given text line. - - -

Parameters - - - - -
lineIndex:int — The line number for which you want metrics information. - -
-

-Returns - - - - -
TextLineMetrics — - A TextLineMetrics object. - - - -
-
-Throws - - - - -
RangeError — The line number specified is out of range. - - -
-

-See also -

-
-flash.text.TextLineMetrics -
-flash.text.TextLineMetrics -
-
-Example -
The following example displays some line metrics values for two differently formatted lines of text. - -

The text appended is two lines from the Song of Myself by Walt Whitman. A new TextFormat object - (newFormat) is used to set the format of the second line. The first line holds the - default format. The getLineMetrics() method returns a TextLineMetrics - object for a specific line. (Line index begins with 0.) Using metrics1 and metrics2 - TextLineMetrics objects for the line one and two, respectively, the ascent, descent, height, and weight - value of the line are retrieved and displayed. The result numbers are converted to - string but not rounded. Note that this value is for the line and not a specific character. It - reflects the range of characters for a line. For example, if a line has different characters with - different height formats, the character with the highest height will determine the value. This also - means that if one of the character's format is changes, some of the metrics values could also change.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextLineMetrics;
-    import flash.text.TextFieldAutoSize;
-    import flash.text.AntiAliasType;
-    import flash.text.TextFormat;
- 
-    public class TextField_getLineMetricsExample extends Sprite {
-
-        public function TextField_getLineMetricsExample() {
-            var myTextField:TextField = new TextField();
-            var newFormat:TextFormat = new TextFormat(); 
-
-            myTextField.x = 10;
-            myTextField.y = 10;
-            myTextField.background = true;
-            myTextField.wordWrap = false;
-            myTextField.autoSize = TextFieldAutoSize.LEFT;
-            
-            myTextField.appendText("A child said What is the grass? fetching it to me with full hands;\n");
-            myTextField.appendText("How could I answer the child? I do not know what it is any more than he.\n\n");
-
-            newFormat.size = 14;
-            newFormat.font = "Arial";
-            newFormat.italic = true;
-            myTextField.setTextFormat(newFormat, 67, 139);
-               
-            var metrics1:TextLineMetrics = myTextField.getLineMetrics(0);
-             
-            myTextField.appendText("Metrics ascent for the line 1 is: " + metrics1.ascent.toString() + "\n");
-            myTextField.appendText("Metrics descent is: " + metrics1.descent.toString() + "\n");
-            myTextField.appendText("Metrics height is: " + metrics1.height.toString() + "\n"); 
-            myTextField.appendText("Metrics width is: " + metrics1.width.toString() + "\n\n");
-
-            var metrics2:TextLineMetrics = myTextField.getLineMetrics(1);
-             
-            myTextField.appendText("Metrics ascent for the line 2 is: " + metrics2.ascent.toString() + "\n");
-            myTextField.appendText("Metrics descent is: " + metrics2.descent.toString() + "\n");
-            myTextField.appendText("Metrics height is: " + metrics2.height.toString() + "\n"); 
-            myTextField.appendText("Metrics width is: " + metrics2.width.toString() + "\n");
-
-            addChild(myTextField);
-        }
-    }
-}
-
-

-
- - - - - -
getLineOffset()method 
-
-public function getLineOffset(lineIndex:int):int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the character index of the first character in the line that - - the lineIndex parameter specifies. - - -

Parameters - - - - -
lineIndex:int — The zero-based index value of the line (for example, the first line is 0, - - the second line is 1, and so on). - - -
-

-Returns - - - - -
int — - The zero-based index value of the first character in the line. - - - - -
-
-Throws - - - - -
RangeError — The line number specified is out of range. - - -
-
-Example -
The following example checks for the first character of the line 4, which - will change if the screen (and the text field) is resized. - -

The myTextField text field is set to word wrap. The countField - text field will display the first character of line 4. When the user clicks on the myTextField - text field, the clickHandler() method is invoked.

- -

In the clickHandler() method, the getLineOffset() method returns - the index of the first character in the line index 3, which is the fourth line of the text. - (First line has a 0 index.) The charAt() method is used to get the character - using the index of the first character of the fourth line. The countField text field - content is updated with this information using the text property of the - countField text field. Using the countField.text property means that - each time after the click the content of the countField text field will be overwritten. - If the user resizes the display, the content will wrap and the first character of the line 4 could - change. By clicking again on the myTextField field, the content of countField - text field is updated with the new first character for the fourth line.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.events.MouseEvent;
-
-    public class TextField_getLineOffsetExample extends Sprite {
-        private var myTextField:TextField = new TextField();
-        private var countField:TextField = new TextField();
-        
-        public function TextField_getLineOffsetExample() {
-            myTextField.x = 10;
-            myTextField.y = 10;
-            myTextField.width = 150;
-            myTextField.height = 300;
-            myTextField.background = true;
-            myTextField.border = true;
-            myTextField.wordWrap = true;
-
-            countField.height = 20;
-            countField.width = 200;
-            countField.x = 10;
-            countField.y = 320;
-            countField.selectable = false;
-            
-            myTextField.appendText("The TextField class is used to create display objects for "
-                        + "text display and input. All dynamic and input text fields in a SWF file " 
-                        + "are instances of the TextField class. You can use the TextField class "
-                        + "to perform low-level text rendering. However, in Flex, you typically use "
-                        + "the Label, Text, TextArea, and TextInput controls to process text. "  
-                        + "You can give a text field an instance name in the Property inspector "
-                        + "and use the methods and properties of the TextField class to manipulate it with ActionScript.");
-
-            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-        
-            this.addChild(myTextField);
-            this.addChild(countField);
-        }
-    
-            private function clickHandler(e:MouseEvent):void {
-                var c:String;
-                var index:int;
-                
-                index = myTextField.getLineOffset(3);
-                c = myTextField.text.charAt(index);
-                countField.text = "The first character of line 4 is: " + c;
-            }
-    }
-}
-
-

-
- - - - - -
getLineText()method 
-
-public function getLineText(lineIndex:int):String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the text of the line specified by the lineIndex parameter. - - -

Parameters - - - - -
lineIndex:int — The zero-based index value of the line (for example, the first line is 0, - - the second line is 1, and so on). - - -
-

-Returns - - - - -
String — - The text string contained in the specified line. - - - - -
-
-Throws - - - - -
RangeError — The line number specified is out of range. - - -
-
-Example -
In the following example, the line numbers of all the instances of the word "love" used in Shakespeare's - sonnet are found and displayed. - -

The poem text field is set to fit automatically the text and to resize as a left-justified text. - The wordWrap property is set to false, so the lines of the poem would not wrap, though - normally when using the autoSize property, this should not be a problem. The for loop iterates through the lines - of the sonnet using the property numLines of the text field. The getLineText() method - returns the content of the line as a string. (Note that the numLines property returns the number - of lines starting with line 1, while for the getLineText() method the line number begins with 0.) - Using the regular expression pattern (/love/i), the if statement looks for any substring - of the word in upper or lowercase. If the pattern is found, the search method returns the index of - the first matching substring, otherwise it returns -1 (if there is no match). The line number where - "love" was found ((i + 1)) is then placed in the string lineResult. The string method converts - the number argument ((i + 1)) to a string as long as there is another argument that is a string (" "). - The line result of the search will include lines with the words "loved" or "Love's." If the string "Love was found in lines:" - was appended before the for loop, the word "Love" in this line would also have been included.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.utils.Timer;
-    import flash.events.TimerEvent;
- 
-    public class TextField_getLineTextExample extends Sprite {
-           
-        public function TextField_getLineTextExample() {
-           var poem:TextField = new TextField();
-           var lineResult:String = ""; 
-           var pattern:RegExp = /love/i;
-
-            poem.x = 10;
-            poem.y = 10;
-            poem.background = true;
-            poem.wordWrap = false;
-            poem.autoSize = TextFieldAutoSize.LEFT;
-            
-            poem.text = "Let me not to the marriage of true minds\n"
-                              + "Admit impediments. love is not love\n"
-                              + "Which alters when it alteration finds\n"
-                              + "Or bends with the remover to remove:\n"
-                              + "O no! it is an ever-fixed mark\n" 
-                              + "That looks on tempests and is never shaken;\n"
-                              + "It is the star to every wandering bark,\n"
-                              + "Whose worth's unknown, although his height be taken.\n"
-                              + "Love's not Time's fool, though rosy lips and cheeks\n"
-                              + "Within his bending sickle's compass come:\n"
-                              + "Love alters not with his brief hours and weeks,\n"
-                              + "But bears it out even to the edge of doom.\n"
-                              + "If this be error and upon me proved,\n"
-                              + "I never writ, nor no man ever loved.\n\n";
-
-            for (var i:int = 0; i < poem.numLines; i++) {
-
-                var s:String = poem.getLineText(i);
-                        
-                if(s.search(pattern) != -1) {
-                    lineResult += (i + 1) + " ";
-                }
-            }
-
-            poem.appendText("Love was found in lines: " + lineResult);
-             
-            this.addChild(poem);                      
-        }
-    }
-}
-
-

-
- - - - - -
getParagraphLength()method 
-
-public function getParagraphLength(charIndex:int):int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Given a character index, returns the length of the paragraph containing the given character. - - The length is relative to the first character in the paragraph (as returned by - - getFirstCharInParagraph()), not to the character index passed in. - - -

Parameters - - - - -
charIndex:int — The zero-based index value of the character (for example, the first character is 0, - - the second character is 1, and so on). - - -
-

-Returns - - - - -
int — - Returns the number of characters in the paragraph. - - - - -
-
-Throws - - - - -
RangeError — The character index specified is out of range. - -
-

-See also -

-
-flash.text.TextField.getFirstCharInParagraph() -
-
-Example -
In the following example, when a user selects a paragraph, the paragraph's length and number - of "s" characters in the paragraph are displayed in a separate text field. - -

The myTextField text field displays the paragraphs that the user will select. - When the user click on the text field, the MouseEvent.CLICK event is dispatched, and - the clickHandler() method is called. The paragraph length and number of "s" characters - will appear in countField text field, which is placed below myTextField text field.

- -

In the clickHandler() method, the getCharIndexAtPoint() method returns the character's - index based on the localX and localY coordinates of the mouse click. The first if - statement checks to see if the use has clicked on a character. The getFirstCharInParagraph() method, - uses this index to return the index of the first character in the same paragraph. The paragraph length returned by - getParagraphLength() method is used with the index of the first character in the paragraph to determine the - index for the end of the paragraph. A for loop iterates through the paragraph looking for the number of "s" - characters.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.events.MouseEvent;
-
-    public class TextField_getParagraphLengthExample extends Sprite {
-        private var myTextField:TextField = new TextField();
-        private var countField:TextField = new TextField();
-
-        public function TextField_getParagraphLengthExample() {
-            myTextField.x = 10;
-            myTextField.y = 10;
-            myTextField.background = true;
-            myTextField.border = true;
-            myTextField.wordWrap = true;
-            myTextField.width = 300;
-            myTextField.height = 280;
-            
-            myTextField.appendText("The TextField class is used to create display objects for "
-                        + "text display and input. All dynamic and input text fields in a SWF file" 
-                        + "are instances of the TextField class. You can use the TextField class "
-                        + "to perform low-level text rendering. However, in Flex, you typically use "
-                        + "the Label, Text, TextArea, and TextInput controls to process text. "  
-                        + "You can give a text field an instance name in the Property inspector "
-                        + "and use the methods and properties of the TextField class to manipulate it with ActionScript. "
-                        + "TextField instance names are displayed in the Movie Explorer and in the Insert "
-                        + "Target Path dialog box in the Actions panel.\n\n"  
-                        + "To create a text field dynamically, use the TextField() constructor.\n\n"
-                        + "The methods of the TextField class let you set, select, and manipulate "  
-                        + "text in a dynamic or input text field that you create during authoring or at runtime.");
-
-            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-            
-            countField.x = 10;
-            countField.y = 300;
-            countField.height = 50;
-            countField.width = 250;
-            countField.background = true;
-            countField.selectable = false;
-
-            this.addChild(myTextField);
-            this.addChild(countField);
-        }
-
-        private function clickHandler(e:MouseEvent):void {
-            var index:int = myTextField.getCharIndexAtPoint(e.localX, e.localY);
-            
-            if(index != -1) {
-                var beginParag:int = myTextField.getFirstCharInParagraph(index);
-                var paragLength:int = myTextField.getParagraphLength(index);
-                var endParag:int = beginParag + paragLength;
-                var sCount:uint = 0;
-
-                for (var i:int = beginParag; i <= endParag; i++) {
-                    if ((myTextField.text.charAt(i) == "s") || (myTextField.text.charAt(i) == "S")) {
-                        sCount++; 
-                    }
-
-                countField.text = "Paragraph length is: " + paragLength.toString() + "\n" 
-                        + "Number of 's' characters in the paragraph: " + sCount.toString();
-                }
-            }
-        }
-    }
-}
-
-

-
- - - - - -
getTextFormat()method 
-
-public function getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns a TextFormat object that contains formatting information for the range of text that the - - beginIndex and endIndex parameters specify. Only properties - - that are common to the entire text specified are set in the resulting TextFormat object. - - Any property that is mixed, meaning that it has different values - - at different points in the text, has a value of null. - - -

If you do not specify - - values for these parameters, this method is applied to all the text in the text field.

- - -

The following table describes three possible usages:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
UsageDescription
my_textField.getTextFormat()Returns a TextFormat object containing formatting information for all text in a text field. - - Only properties that are common to all text in the text field are set in the resulting TextFormat - - object. Any property that is mixed, meaning that it has different values at different - - points in the text, has a value of null.
my_textField.getTextFormat(beginIndex:Number)Returns a TextFormat object containing a copy of the text format of the character at the - - beginIndex position.
my_textField.getTextFormat(beginIndex:Number,endIndex:Number)Returns a TextFormat object containing formatting information for the span of - - text from beginIndex to endIndex-1. Only properties that are common - - to all of the text in the specified range are set in the resulting TextFormat object. Any property - - that is mixed (that is, has different values at different points in the range) has its value set to null.
- - - Parameters - - - - - - - - - - -
beginIndex:int (default = -1) — Optional; an integer that specifies the starting location of a range of text within the text field. - - -
 
endIndex:int (default = -1) — Optional; an integer that specifies the position of the first character after the desired - - text span. As designed, if you specify beginIndex and endIndex values, - - the text from beginIndex to endIndex-1 is read. - - -
-

-Returns - - - - -
TextFormat — - The TextFormat object that represents the formatting properties for the specified text. - - - - -
-
-Throws - - - - -
RangeError — The beginIndex or endIndex specified is out of range. - - -
-

-See also -

-
-flash.text.TextFormat -
-flash.text.TextField.defaultTextFormat -
-flash.text.TextField.setTextFormat() -
-
-Example -

-
- - - - - -
isFontCompatible()method 
-
-public static function isFontCompatible(fontName:String, fontStyle:String):Boolean -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Returns true if an embedded font is available with the specified fontName and fontStyle - - where Font.fontType is flash.text.FontType.EMBEDDED. Starting with Flash Player 10, - - two kinds of embedded fonts can appear in a SWF file. Normal embedded fonts are only used with - - TextField objects. - - CFF embedded fonts are only used with the flash.text.engine classes. The two types are distinguished by the - - fontType property of the Font class, as returned by the enumerateFonts() function. - - -

TextField cannot use a font of type EMBEDDED_CFF. If embedFonts is set to true - - and the only font available at run time with the specified name and style is of type EMBEDDED_CFF, - - Flash Player fails to render the text, as if no embedded font were available with the specified name and style.

- - -

If both EMBEDDED and EMBEDDED_CFF fonts are available with the same name and style, the EMBEDDED - - font is selected and text renders with the EMBEDDED font.

- - - Parameters - - - - - - - - - - -
fontName:String — The name of the embedded font to check. - -
 
fontStyle:String — Specifies the font style to check. Use flash.text.FontStyle - -
-

-Returns - - - - -
Boolean — - true if a compatible embedded font is available, otherwise false. - - - - -
-
-Throws - - - - -
ArgumentError — The fontStyle specified is not a member of flash.text.FontStyle. - - - -
-

-See also -

-
-flash.text.engine.FontDescription.fontLookup -
-flash.text.engine.TextBlock.createTextLine() -
-flash.text.FontType.EMBEDDED_CFF -
-
- - - - - -
replaceSelectedText()method 
-
-public function replaceSelectedText(value:String):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Replaces the current selection with the contents of the value parameter. - - The text is inserted at the position of the current selection, using the current default character - - format and default paragraph format. The text is not treated as HTML. - - -

You can use the replaceSelectedText() method to insert and delete text without disrupting - - the character and paragraph formatting of the rest of the text.

- -

Note: This method does not work if a style sheet is applied to the text field.

- - - - Parameters - - - - -
value:String — The string to replace the currently selected text. - - -
-
-Throws - - - - -
Error — This method cannot be used on a text field with a style sheet. - - -
-

-See also -

-
-flash.display.Stage.focus -
-
-Example -
In the following example, the user erases some text from the first text field - by selecting it and replaces a selected text in the second text field with "NEW TEXT" string. - -

Two different TextField objects are created and event listeners are added for the - MouseEvent.MOUSE_UP events. Mouse up occurs when the user releases the mouse, - an event that normally happens after a selection of text is made. Note that the default - setting for a text field is for its text to be selected.

- -

In the mouseHandler1() method, when a user release a mouse in the - myTextField1 text field, the text is erased by replacing it with an empty - string. This can continue until all the text is erased. In the mouseHandler2() - method, when a user selects some text in myTextField2 text field, properties - selectionBeginIndex and selectionEndIndex are checked to see if - any character was selected. (The selectionBeginIndex and selectionEndIndex - properties don't have the same value if some text were selected.) The selected text is then replaced - with "NEW TEXT" string. This can continue until all the original text of the second text field is - replaced with the "NEW TEXT" string.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;    
-    import flash.events.MouseEvent;
-
-    public class TextField_replaceSelectedTextExample extends Sprite {
-        private var myTextField1:TextField = new TextField();
-        private var myTextField2:TextField = new TextField();
-        
-        public function TextField_replaceSelectedTextExample() {
-            myTextField1.x = 10;
-            myTextField1.width = 300;
-            myTextField1.height = 50; 
-            myTextField1.background = true; 
-            myTextField1.border = true;
-            myTextField1.text = "Select the text you want to remove from the line.";
-            
-            myTextField2.x = 10;
-            myTextField2.y = 60;
-            myTextField2.width = 300;
-            myTextField2.height = 50;
-            myTextField2.background = true;
-            myTextField2.border = true;
-            myTextField2.text = "Select the text you want to replace with NEW TEXT.";
-            
-            myTextField1.addEventListener(MouseEvent.MOUSE_UP, mouseHandler1);
-            myTextField2.addEventListener(MouseEvent.MOUSE_UP, mouseHandler2);
-            
-            this.addChild(myTextField1);
-            this.addChild(myTextField2);
-        }
-        
-        private function mouseHandler1(e:MouseEvent):void {
-            myTextField1.replaceSelectedText("");
-        }
-
-        private function mouseHandler2(e:MouseEvent):void {
-            if(myTextField2.selectionBeginIndex != myTextField2.selectionEndIndex) {
-                myTextField2.replaceSelectedText("NEW TEXT");    
-            }
-        }
-    }
-}
-
-

-
- - - - - -
replaceText()method 
-
-public function replaceText(beginIndex:int, endIndex:int, newText:String):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Replaces the range of characters that the beginIndex and - - endIndex parameters specify with the contents - - of the newText parameter. As designed, the text from - - beginIndex to endIndex-1 is replaced. - -

Note: This method does not work if a style sheet is applied to the text field.

- - - Parameters - - - - - - - - - - - - - - - - -
beginIndex:int — The zero-based index value for the start position of the replacement range. - -
 
endIndex:int — The zero-based index position of the first character after the desired - - text span. - -
 
newText:String — The text to use to replace the specified range of characters. - - -
-
-Throws - - - - -
Error — This method cannot be used on a text field with a style sheet. - - -
-
-Example -
The following example uses the replaceText() method to delete, replace and insert - some text into a text field. - -

The outputText text field is set to automatically fit the text and to resize as a left-justified text. - With the first replaceText() method call, the first line ("This is the wrong heading") - is replaced with "THIS IS THE HEADING FOR EVERYONE." With the second method call, the text "CORRECT" - is inserted between "THE" and "HEADING." With the third method call, the words "FOR EVERYONE" are deleted. - Note that with each call to the method appendText(), the current text's begin and end index - are changed. Here, only the final text (after the changes have been made) will display.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    
-    public class TextField_replaceTextExample extends Sprite {
-
-        public function TextField_replaceTextExample() {
-            var outputText:TextField = new TextField();
-
-            outputText.x = 10;
-            outputText.y = 10;
-            outputText.background = true;
-            outputText.autoSize = TextFieldAutoSize.LEFT;
-            
-            outputText.appendText("This is the wrong heading");
-            outputText.appendText("\n\n"); 
-            outputText.appendText("This is the body of the text.");
-
-            outputText.replaceText(0, 25, "THIS IS THE HEADING FOR EVERYONE");
-
-            outputText.replaceText(12, 12, "CORRECT ");
-            
-            outputText.replaceText(27, 40, "");
-            
-           this.addChild(outputText);
-         }
-    }
-}
-
-

-
- - - - - -
setSelection()method 
-
-public function setSelection(beginIndex:int, endIndex:int):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Sets as selected the text designated by the index values of the - - first and last characters, which are specified with the beginIndex - - and endIndex parameters. If the two parameter values are the same, - - this method sets the insertion point, as if you set the - - caretIndex property. - - -

Parameters - - - - - - - - - - -
beginIndex:int — The zero-based index value of the first character in the selection - - (for example, the first character is 0, the second character is 1, and so on). - - -
 
endIndex:int — The zero-based index value of the last character in the selection. - - -
-

-See also -

-
-selectable -
-selectionBeginIndex -
-selectionEndIndex -
-caretIndex -
-
-Example -
In the following example, when the user clicks anywhere in the text field a predefined range - of text will be selected (highlighting the words "TEXT IN ALL CAPS"). - -

Two event listeners for the myTextField text field respond to the user's mouse clicks or mouse up events. - Mouse up will occur when the user releases the mouse, an event that normally happens after a selection of text is made. - Note that the default setting for a text field is for its text to be selected. When some text is clicked, - clickHandler() method is invoked. When some text is selected and the mouse is released, - mouseUpHandler() method is invoked.

- -

In both clickHandler() and mouseUpHandler() methods, the setSelection() method - sets only the characters between indexes 54 and 70 (TEXT IN ALL CAPS) to be selected.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.events.MouseEvent;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    
-    public class TextField_setSelectionExample extends Sprite
-    {
-        private var myTextField:TextField = new TextField();
-
-        public function TextField_setSelectionExample() {
-            myTextField.autoSize = TextFieldAutoSize.LEFT;
-            myTextField.text = "No matter where you click on this text field only the TEXT IN ALL CAPS is selected.";
-
-            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-            myTextField.addEventListener(MouseEvent.MOUSE_UP, mouseUpHandler);
-
-            this.addChild(myTextField);
-        }
-
-        private function clickHandler(event:MouseEvent):void {
-            myTextField.setSelection(54, 70);
-        }
-
-        private function mouseUpHandler(event:MouseEvent):void {
-            myTextField.setSelection(54, 70);
-        }
-
-    }
-}
-
-

-
- - - - - -
setTextFormat()method 
-
-public function setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Applies the text formatting that the format parameter specifies to the specified text in a text field. - - The value of format must be a TextFormat object that specifies the - - desired text formatting changes. Only the non-null properties of format are applied - - to the text field. Any property of format that is set to null is not - - applied. By default, all of the properties of a newly created TextFormat object are set to null. - -

Note: This method does not work if a style sheet is applied to the text field.

- - -

The setTextFormat() method changes the text formatting applied to a range of - - characters or to the entire body of text in a text field. To apply the properties of format to all text in the text - - field, do not specify values for beginIndex and endIndex. To apply the - - properties of the format to a range of text, specify values for the beginIndex and - - the endIndex parameters. You can use the length property to determine - - the index values.

- - -

The two types of formatting information in a TextFormat object are - - character level formatting and paragraph level formatting. - - Each character in a text field can have its own character formatting - - settings, such as font name, font size, bold, and italic.

- - -

For paragraphs, the first character of the paragraph is examined for the paragraph formatting - - settings for the entire paragraph. Examples of paragraph formatting settings are left margin, - - right margin, and indentation.

- - -

Any text inserted manually by the user, or replaced by the - - replaceSelectedText() method, receives the default text field formatting for new text, - - and not the formatting specified for the text insertion point. To set the default - - formatting for new text, use defaultTextFormat.

- - - Parameters - - - - - - - - - - - - - - - - -
format:TextFormat — A TextFormat object that contains character and paragraph formatting information. - - - -
 
beginIndex:int (default = -1) — Optional; an integer that specifies the zero-based index position specifying the - - first character of the desired range of text. - - - -
 
endIndex:int (default = -1) — Optional; an integer that specifies the first character after the desired text span. - - As designed, if you specify beginIndex and endIndex values, - - the text from beginIndex to endIndex-1 is updated. - - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
UsageDescription
my_textField.setTextFormat(textFormat:TextFormat)Applies the properties of textFormat to all text in the text - - field.
my_textField.setTextFormat(textFormat:TextFormat, beginIndex:int)Applies the properties of textFormat to the text starting with the - - beginIndex position.
my_textField.setTextFormat(textFormat:TextFormat, beginIndex:int, - - endIndex:int)Applies the properties of the textFormat parameter to the span of - - text from the beginIndex position to the endIndex-1 position.
- -

- - - -

Notice that any text inserted manually by the user, or replaced by the - - replaceSelectedText() method, receives the default text field formatting for new - - text, and not the formatting specified for the text insertion point. To set a text field's - - default formatting for new text, use the defaultTextFormat property.

- - - -
-
-Throws - - - - - - - - - - -
Error — This method cannot be used on a text field with a style sheet. - -
 
RangeError — The beginIndex or endIndex specified is out of range. - - -
-

-See also -

-
-flash.text.TextFormat -
-flash.text.TextField.defaultTextFormat -
-
-Example -
In the following example, when the text is clicked, a defined range of text, "TEXT IN ALL CAPS," switches - format between the default text format and the new format. - -

An event listener for the myTextField text field is added to respond to the mouse clicks by invoking - the clickHandler() method. In the clickHandler() method, the getTextFormat() - method returns the current format of a character (index 55) from the intended range of the text, which is then placed - in the currentTextFormat TextFormat object. The if statement checks the currentTextFormat - text format to see if the character in the range is using the new format (font point is set to 18). If not, the new format changes - the size to 18 point, color to red, and applies underline and italics to the range of text between 54-70 (TEXT IN ALL CAPS). - If the character in the range is using the new format, the format of the range is set back to the default (original) - format of the text field.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFormat;  
-    import flash.text.TextFieldAutoSize;  
-    import flash.events.MouseEvent;
-
-    public class TextField_setTextFormatExample extends Sprite {
-        private var myTextField:TextField = new TextField();
-        private var newFormat:TextFormat = new TextFormat();
-        
-        public function TextField_setTextFormatExample() {
-            myTextField.autoSize = TextFieldAutoSize.LEFT;
-            myTextField.selectable = false;
-            myTextField.background = true;
-            myTextField.text = "No matter where you click on this text field only the TEXT IN ALL CAPS changes format.";
-
-            myTextField.addEventListener(MouseEvent.CLICK, clickHandler);
-
-            newFormat.color = 0xFF0000;
-            newFormat.size = 18;
-            newFormat.underline = true;
-            newFormat.italic = true;
-                
-            this.addChild(myTextField);
-        }
-
-        private function clickHandler(event:MouseEvent):void {
-            var currentTextFormat:TextFormat = myTextField.getTextFormat(55);
-            
-            if(currentTextFormat.size != 18) {
-                myTextField.setTextFormat(newFormat, 54, 70);
-            }
-            else {
-                myTextField.setTextFormat(myTextField.defaultTextFormat);
-            }    
-        }    
-    }
-}
-
-

-
-
Event detail
- - - - - -
changeevent 
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.CHANGE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Dispatched after a control value is modified, unlike - - the textInput event, which is dispatched before the value is modified. - - Unlike the W3C DOM Event Model version of the change event, which dispatches the - - event only after the control loses focus, the ActionScript 3.0 version of the - - change event is dispatched any time the control changes. For example, if a user - - types text into a text field, a change event is dispatched after every keystroke. - -

- The Event.CHANGE constant defines the value of the type property of a change event object. - -

This event has the following properties:

- - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe object that has had its value modified. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
-Example -
In the following example, the text that the user enters (user input) is immediately copied - (echoed) into another text field with a different text format. - -

Two text fields are created, one for the user input and the other - (headingTextField) for the copy of the user input. A TextFormat - object is also created and the default text format is assigned to the - headingTextField text field. When the content of the text field - is changed, the changeHandler() method is invoked, which assigns - the text in the inputTextField text field to the headingTextField - text field. (If the method was called for the TextEvent.TEXT_INPUT event - instead of the Event.CHANGE event, the content of the user input - is copied only after the user has entered more text.)

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldType;
-    import flash.text.TextFormat;
-    import flash.text.TextFormatAlign;
-    import flash.events.Event;
-    
-    import flash.events.TextEvent;
-
-    public class TextField_Event_changeExample extends Sprite {
-        private var inputTextField:TextField = new TextField(); 
-        private var headingTextField:TextField = new TextField(); 
-        private var newFormat:TextFormat = new TextFormat();
-         
-        public function TextField_Event_changeExample() {
-            headingTextField.x = 10;
-            headingTextField.y = 10;
-            headingTextField.height = 30;
-            headingTextField.width = 400;
-            headingTextField.background = true;
-            headingTextField.backgroundColor = 0xF5F5DC;
-            headingTextField.selectable = false;
- 
-            inputTextField.x = 10;
-            inputTextField.y = 70;
-            inputTextField.height = 20;
-            inputTextField.width = 230;
-            inputTextField.background = true;
-            inputTextField.border = true;
-            inputTextField.maxChars = 40;
-            inputTextField.wordWrap = true;
-            inputTextField.type = TextFieldType.INPUT;
-
-            inputTextField.addEventListener(Event.CHANGE, changeHandler);
-
-            newFormat.bold = true;
-            newFormat.size = 18;
-            newFormat.color = 0xFF0000;
-            newFormat.align = TextFormatAlign.CENTER;
-
-            headingTextField.defaultTextFormat = newFormat;
-
-            this.addChild(inputTextField);
-            this.addChild(headingTextField);
-        }
-
-        private function changeHandler(e:Event):void {
-            headingTextField.text = inputTextField.text;
-        }
-    }
-}
-
-

-
- - - - - -
linkevent  
-
-Event object type: flash.events.TextEvent -
-TextEvent.type property = flash.events.TextEvent.LINK -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched when a user clicks a hyperlink in an - - HTML-enabled text field, where the URL begins with "event:". The remainder of the URL after - - "event:" is placed in the text property of the LINK event. - -

Note: The default behavior, adding the text to the text field, - - occurs only when Flash Player generates the event, which in this case happens when - - a user attempts to input text. You cannot put text into a text field by sending it textInput - - events.

- -

- Defines the value of the type property of a link event object. - -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe text field containing the hyperlink that has been clicked. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
textThe remainder of the URL after "event:"
- -
-Example -
In the following example, the playMP3() function is defined. - A TextField object named list is created and populated with HTML text. - The text "Track 1" and "Track 2" are links inside the text field. - The playMP3() function is called when the user clicks either link. The name of the MP3 - file, which follows the string "event:" in the href attribute of the - HTML tag, is passed to the linkHandler() method as the text - property of the link event object. -
-
-
-package {
-    import flash.display.Sprite;
-	import flash.errors.IOError;
-	import flash.events.IOErrorEvent;
-	import flash.events.TextEvent;
-	import flash.media.Sound;
-	import flash.media.SoundChannel;
-	import flash.net.URLRequest;
-	import flash.text.TextField;
-	import flash.text.TextFieldAutoSize;
-
-	public class TextField_event_link extends Sprite
-	{
-		private var myMP3:Sound;
-		public function TextField_event_link() {
-			myMP3 = new Sound();
-			var list:TextField = new TextField();
-			list.autoSize = TextFieldAutoSize.LEFT;
-			list.multiline = true;
-			list.htmlText = "<a href=\"event:track1.mp3\">Track 1</a><br>";
-			list.htmlText += "<a href=\"event:track2.mp3\">Track 2</a><br>";
-			addEventListener(TextEvent.LINK, linkHandler);
-			addChild(list);
-		}
-		
-		private function playMP3(mp3:String):void {
-			try {	
-				myMP3.load(new URLRequest(mp3));
-				myMP3.play();
-			}
-			catch(err:Error) {
-				trace(err.message);
-			}
-			myMP3.addEventListener(IOErrorEvent.IO_ERROR, errorHandler);
-		}
-		
-		private function linkHandler(linkEvent:TextEvent):void {
-			playMP3(linkEvent.text);
-		}
-		
-		private function errorHandler(errorEvent:IOErrorEvent):void {
-			trace(errorEvent.text);
-		}
-	}
-}
-
-

-
- - - - - -
scrollevent  
-
-Event object type: flash.events.Event -
-Event.type property = flash.events.Event.SCROLL -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Dispatched by a TextField object after the user scrolls. - -

- The Event.SCROLL constant defines the value of the type property of a scroll event object. - -

This event has the following properties:

- - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe TextField object that has been scrolled. - The target property is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
-Example -
The following example defines two TextField objects. - The first TextField object has two associated event handlers. When you click the mouse - inside this first text field, the mouseDown event is dispatched, and the associated mouseDownScroll handler is called. The - mouseDownScroll() handler causes the field to scroll. Then, the - scroll event is dispatched, and the associated scrollHandler() - handler updates the second text field to display the current scroll position. -
-
-
-package
-{
-    import flash.display.Sprite;
-    import flash.text.*;
-    import flash.events.Event;
-    import flash.events.TextEvent;
-    import flash.events.MouseEvent;
-
-    public class TextScrollExample extends Sprite
-    {
-        private var myTextBox1:TextField = new TextField();
-        private var myTextBox2:TextField = new TextField();
-        private var myText:String = "Hello world and welcome to the show. It's really nice to meet you. Take your coat off and stay a while. OK, show is over. Hope you had fun. You can go home now. Don't forget to tip your waiter. There are mints in the bowl by the door. Thank you. Please come again.";
-
-        public function TextScrollExample()
-        {
-            myTextBox1.text = myText;
-            myTextBox1.width = 200;
-            myTextBox1.height = 50;
-            myTextBox1.multiline = true;
-            myTextBox1.wordWrap = true;
-            myTextBox1.background = true;
-            myTextBox1.border = true;
-            
-            myTextBox2.x=220;
-            myTextBox2.text="scrolled to line: " + myTextBox1.scrollV;
-
-            addChild(myTextBox1);
-            addChild(myTextBox2);
-            myTextBox1.addEventListener(MouseEvent.MOUSE_DOWN, mouseDownScroll);
-            myTextBox1.addEventListener(Event.SCROLL, scrollHandler);
-        }
-
-        public function mouseDownScroll(event:MouseEvent):void
-        {
-            myTextBox1.scrollV++;
-        }
-        public function scrollHandler(event:Event):void
-        {
-           myTextBox2.text="scrolled to line: " + myTextBox1.scrollV;
-        }
-    }
-}
-
-

-
- - - - - -
textInputevent  
-
-Event object type: flash.events.TextEvent -
-TextEvent.type property = flash.events.TextEvent.TEXT_INPUT -
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Flash Player dispatches the textInput event 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. - -

- Defines the value of the type property of a textInput event object. -

Note: This event is not dispatched for the Delete or Backspace keys.

-

This event has the following properties:

- - - - - - - -
PropertyValue
bubblestrue
cancelabletrue; call the preventDefault() method - to cancel default behavior.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe text field into which characters are being entered. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
textThe character or sequence of characters entered by the user.
- -
-Example -
The following example defines two TextField objects: - the first TextField object is an input text field, and the second TextField object - is a dynamic text field. As you enter text characters in - the first text field, the textInput event is dispatched, the textInputHandler() handler is called, and the characters display in the second - text field. When you paste a - block of text into the input field, the event handler copies the entire block - into the other field. -
-
-
-package
-{
-    import flash.display.Sprite;
-    import flash.text.*;
-    import flash.events.Event;
-    import flash.events.TextEvent;
-    import flash.events.MouseEvent;
-
-    public class TextInputExample extends Sprite
-    {
-        private var myTextBox1:TextField = new TextField();
-        private var myTextBox2:TextField = new TextField();
-
-        public function TextInputExample()
-        {
-            myTextBox1.type = TextFieldType.INPUT;
-            myTextBox1.width = 200;
-            myTextBox1.height = 20;
-            myTextBox1.background = true;
-            myTextBox1.border = true;
-            
-            myTextBox2.x=220;
-
-            addChild(myTextBox1);
-            addChild(myTextBox2);
-            myTextBox1.addEventListener(TextEvent.TEXT_INPUT,textInputHandler);
-        }
-
-        public function textInputHandler(event:TextEvent):void
-        {
-           myTextBox2.text=event.text;
-        }
-    }
-}
-
-

-
- - - - - -
textInteractionModeChangeevent  
-
-Event object type: flash.events.Event -
-

-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Flash Player dispatches the textInteractionModeChange event when a user - - changes the interaction mode of a text field. - - for example on Android, one can toggle from NORMAL mode to SELECTION mode using context menu - - options - -

- -
Examples
-
examples\TextFieldExample
-
The following example uses the TextFieldExample class to - display a text message. This is accomplished by using the following steps: -
    -
  1. A label property of type TextField is created.
    2. -
  2. The class constructor calls the configureLabel() function.
    3. -
  3. The configureLabel() method first creates a new TextField object and assigns it to - the label property, and then sets its parameters to the following: -
      -
    • Left-justify the text field.
      • -
    • Enable the background fill.
      • -
    • Enable the border.
      • -
    -
    4. -
  4. The configureLabel() method creates the format variable and assigns it to - a new TextFormat instance with its parameters set to the following: -
      -
    • Font type = Verdana
      • -
    • Font color = solid red
      • -
    • Font size = 10
      • -
    • Font underline = true
      • -
    -
    5. -
  5. The defaultTextFormat property of the label text field - is set to format, and the label instance is added to the display list, - which initially displays a text field with no text on the stage.
    6. - -
  6. The constructor sets the text of the label text field to - "Hello world and welcome to the show." by calling the - setLabel() method.
    7. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.text.TextFormat;
-
-
-    public class TextFieldExample extends Sprite {
-        private var label:TextField;
-        private var labelText:String = "Hello world and welcome to the show.";
-
-        public function TextFieldExample() {
-            configureLabel();
-            setLabel(labelText);
-        }
-
-        public function setLabel(str:String):void {
-            label.text = str;
-        }
-
-        private function configureLabel():void {
-            label = new TextField();
-            label.autoSize = TextFieldAutoSize.LEFT;
-            label.background = true;
-            label.border = true;
-
-            var format:TextFormat = new TextFormat();
-            format.font = "Verdana";
-            format.color = 0xFF0000;
-            format.size = 10;
-            format.underline = true;
-
-            label.defaultTextFormat = format;
-            addChild(label);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextFieldAutoSize.html b/html-docs/flash/text/TextFieldAutoSize.html deleted file mode 100644 index 39b27ae..0000000 --- a/html-docs/flash/text/TextFieldAutoSize.html +++ /dev/null @@ -1,355 +0,0 @@ - - - - - - - - -flash.text.TextFieldAutoSize (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class TextFieldAutoSize
InheritanceTextFieldAutoSize Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

-The TextFieldAutoSize class is an enumeration of constant values used in setting the autoSize -property of the TextField class. - -

-

-See also -

-
-flash.text.TextField.autoSize -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  CENTER : String = "center"
[static] - Specifies that the text is to be treated as center-justified text.
-		TextFieldAutoSize
  LEFT : String = "left"
[static] - Specifies that the text is to be treated as left-justified text, - meaning that the left side of the text field remains fixed and any - resizing of a single line is on the right side.
-		TextFieldAutoSize
  NONE : String = "none"
[static] - - Specifies that no resizing is to occur.
-		TextFieldAutoSize
  RIGHT : String = "right"
[static] - Specifies that the text is to be treated as right-justified text, - meaning that the right side of the text field remains fixed and any - resizing of a single line is on the left side.
-		TextFieldAutoSize
-
- -
- -
Constant detail
- - - - - -
CENTERconstant
-
-public static const CENTER:String = "center" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Specifies that the text is to be treated as center-justified text. - Any resizing of a single line of a text field is equally distributed - to both the right and left sides. - -

- - - - - -
LEFTconstant 
-
-public static const LEFT:String = "left" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Specifies that the text is to be treated as left-justified text, - meaning that the left side of the text field remains fixed and any - resizing of a single line is on the right side. - -

- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Specifies that no resizing is to occur. - -

- - - - - -
RIGHTconstant 
-
-public static const RIGHT:String = "right" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Specifies that the text is to be treated as right-justified text, - meaning that the right side of the text field remains fixed and any - resizing of a single line is on the left side. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextFieldType.html b/html-docs/flash/text/TextFieldType.html deleted file mode 100644 index aa313d3..0000000 --- a/html-docs/flash/text/TextFieldType.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - - - - -flash.text.TextFieldType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class TextFieldType
InheritanceTextFieldType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

-The TextFieldType class is an enumeration of constant values used in setting the type property -of the TextField class. - -

-

-See also -

-
-flash.text.TextField.type -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  DYNAMIC : String = "dynamic"
[static] - Used to specify a dynamic TextField.
-		TextFieldType
  INPUT : String = "input"
[static] - Used to specify an input TextField.
-		TextFieldType
-
- -
- -
Constant detail
- - - - - -
DYNAMICconstant
-
-public static const DYNAMIC:String = "dynamic" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Used to specify a dynamic TextField. - -

- - - - - -
INPUTconstant 
-
-public static const INPUT:String = "input" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Used to specify an input TextField. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextFormat.html b/html-docs/flash/text/TextFormat.html deleted file mode 100644 index e52512c..0000000 --- a/html-docs/flash/text/TextFormat.html +++ /dev/null @@ -1,1342 +0,0 @@ - - - - - - - - -flash.text.TextFormat (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic class TextFormat
InheritanceTextFormat Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The TextFormat class represents character formatting information. Use the TextFormat class - to create specific text formatting for text fields. You can apply text formatting - to both static and dynamic text fields. The properties of the TextFormat class apply to device and - embedded fonts. However, for embedded fonts, bold and italic text actually require specific fonts. If you - want to display bold or italic text with an embedded font, you need to embed the bold and italic variations - of that font. -

You must use the constructor new TextFormat() to create a TextFormat object - before setting its properties. - When you apply a TextFormat object to a text field using the TextField.defaultTextFormat property - or the TextField.setTextFormat() method, only its defined properties are applied. Use - the TextField.defaultTextFormat property to apply formatting BEFORE you add text to the TextField, - and the setTextFormat() method to add formatting AFTER you add text to the TextField. - The TextFormat properties are null by default - because if you don't provide values for the properties, Flash Player uses its own default formatting. - The default formatting that Flash Player uses for each property (if property's value is null) - is as follows:

- - - - - - - - - - - - - - - - - - - -
align = "left"
blockIndent = 0
bold = false
bullet = false
color = 0x000000
font = "Times New Roman" (default font is Times on Mac OS X)
indent = 0
italic = false
kerning = false
leading = 0
leftMargin = 0
letterSpacing = 0
rightMargin = 0
size = 12
tabStops = [] (empty array)
target = "" (empty string)
underline = false
url = "" (empty string)
- -

The default formatting for each property is also described in each property description.

-

-

-View the examples. -

-

-See also -

-
-flash.text.TextField.setTextFormat() -
-flash.text.TextField.defaultTextFormat -
-flash.text.TextField.getTextFormat() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  align : String -
- Indicates the alignment of the paragraph.
-		TextFormat
  blockIndent : Object -
- Indicates the block indentation in pixels.
-		TextFormat
  bold : Object -
- Specifies whether the text is boldface.
-		TextFormat
  bullet : Object -
- Indicates that the text is part of a bulleted list.
-		TextFormat
  color : Object -
- Indicates the color of the text.
-		TextFormat
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  font : String -
- The name of the font for text in this text format, as a string.
-		TextFormat
  indent : Object -
- Indicates the indentation from the left - margin to the first character in the paragraph.
-		TextFormat
  italic : Object -
- Indicates whether text in this text format is italicized.
-		TextFormat
  kerning : Object -
- A Boolean value that indicates whether kerning is enabled (true) - or disabled (false).
-		TextFormat
  leading : Object -
- An integer representing the amount of vertical space (called leading) - between lines.
-		TextFormat
  leftMargin : Object -
- The left margin of the paragraph, in pixels.
-		TextFormat
  letterSpacing : Object -
- A number representing the amount of space that is uniformly distributed between all characters.
-		TextFormat
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rightMargin : Object -
- The right margin of the paragraph, in pixels.
-		TextFormat
  size : Object -
- The size in pixels of text in this text format.
-		TextFormat
  tabStops : Array -
- Specifies custom tab stops as an array of non-negative integers.
-		TextFormat
  target : String -
- Indicates the target window where the hyperlink is displayed.
-		TextFormat
  underline : Object -
- Indicates whether the text that uses this text format is underlined (true) - or not (false).
-		TextFormat
  url : String -
- Indicates the target URL for the text in this text format.
-		TextFormat
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TextFormat(font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null)
-
- Creates a TextFormat object with the specified properties.
-		TextFormat
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alignproperty
-
-align:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the alignment of the paragraph. Valid values are TextFormatAlign constants. -

The default value is TextFormatAlign.LEFT.

-Implementation -
-    public function get align():String -
-    public function set align(value:String):void -
-
-Throws -
- - - - -
ArgumentError — The align specified is not a member of flash.text.TextFormatAlign. -
-

-See also -

-
-flash.text.TextFormatAlign -
-
-Example -

-
- - - - - -
blockIndentproperty 
-
-blockIndent:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the block indentation in pixels. Block indentation is applied to - an entire block of text; that is, to all lines of the text. In contrast, normal indentation - (TextFormat.indent) affects only the first line of each paragraph. - If this property is null, the TextFormat object does not specify block indentation - (block indentation is 0). -

Implementation -
-    public function get blockIndent():Object -
-    public function set blockIndent(value:Object):void -
-
-Example -

-
- - - - - -
boldproperty 
-
-bold:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies whether the text is boldface. The default value is null, - which means no boldface is used. - If the value is true, then - the text is boldface. -

Implementation -
-    public function get bold():Object -
-    public function set bold(value:Object):void -
-
-Example -

-
- - - - - -
bulletproperty 
-
-bullet:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates that the text is part of a bulleted list. In a bulleted - list, each paragraph of text is indented. To the left of the first line of each paragraph, a bullet - symbol is displayed. The default value is null, which means no bulleted list - is used. -

Implementation -
-    public function get bullet():Object -
-    public function set bullet(value:Object):void -
-
-Example -

-
- - - - - -
colorproperty 
-
-color:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the color of the text. A number containing three 8-bit RGB components; for example, - 0xFF0000 is red, and 0x00FF00 is green. The default value is null, - which means that Flash Player uses the color black (0x000000). -

Implementation -
-    public function get color():Object -
-    public function set color(value:Object):void -
-
-Example -

-
- - - - - -
fontproperty 
-
-font:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The name of the font for text in this text format, as a string. The default value is - null, which means that Flash Player uses Times New Roman font for the text. -

Implementation -
-    public function get font():String -
-    public function set font(value:String):void -
-
-Example -

-
- - - - - -
indentproperty 
-
-indent:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the indentation from the left - margin to the first character in the paragraph. The default value is null, which - indicates that no indentation is used. -

Implementation -
-    public function get indent():Object -
-    public function set indent(value:Object):void -
-

-See also -

-
-flash.text.TextFormat.blockIndent -
-
-Example -

-
- - - - - -
italicproperty 
-
-italic:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether text in this text format is italicized. The default - value is null, which means no italics are used. -

Implementation -
-    public function get italic():Object -
-    public function set italic(value:Object):void -
-
-Example -

-
- - - - - -
kerningproperty 
-
-kerning:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A Boolean value that indicates whether kerning is enabled (true) - or disabled (false). Kerning adjusts the pixels between certain character pairs to improve readability, and - should be used only when necessary, such as with headings in large fonts. Kerning is - supported for embedded fonts only. -

Certain fonts such as Verdana and monospaced fonts, - such as Courier New, do not support kerning.

-

The default value is null, which means that kerning is not enabled.

- Implementation -
-    public function get kerning():Object -
-    public function set kerning(value:Object):void -
-
- - - - - -
leadingproperty 
-
-leading:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An integer representing the amount of vertical space (called leading) - between lines. The default value is null, which indicates that the - amount of leading used is 0. -

Implementation -
-    public function get leading():Object -
-    public function set leading(value:Object):void -
-
-Example -

-
- - - - - -
leftMarginproperty 
-
-leftMargin:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The left margin of the paragraph, in pixels. The default value is null, which - indicates that the left margin is 0 pixels. -

Implementation -
-    public function get leftMargin():Object -
-    public function set leftMargin(value:Object):void -
-
-Example -

-
- - - - - -
letterSpacingproperty 
-
-letterSpacing:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- A number representing the amount of space that is uniformly distributed between all characters. - The value specifies the number of pixels that are added to the advance after each character. - The default value is null, which means that 0 pixels of letter spacing is used. - You can use decimal values such as 1.75. -

Implementation -
-    public function get letterSpacing():Object -
-    public function set letterSpacing(value:Object):void -
-
-Example -

-
- - - - - -
rightMarginproperty 
-
-rightMargin:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The right margin of the paragraph, in pixels. The default value is null, - which indicates that the right margin is 0 pixels. -

Implementation -
-    public function get rightMargin():Object -
-    public function set rightMargin(value:Object):void -
-
-Example -

-
- - - - - -
sizeproperty 
-
-size:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The size in pixels of text in this text format. The default value is null, which - means that a size of 12 is used. -

Implementation -
-    public function get size():Object -
-    public function set size(value:Object):void -
-
-Example -

-
- - - - - -
tabStopsproperty 
-
-tabStops:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies custom tab stops as an array of non-negative integers. Each tab stop is - specified in pixels. If custom tab stops are not specified (null), the default tab - stop is 4 (average character width). -

Implementation -
-    public function get tabStops():Array -
-    public function set tabStops(value:Array):void -
-
-Example -

-
- - - - - -
targetproperty 
-
-target:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the target window where the hyperlink is displayed. If the target window is an - empty string, the text is displayed in the default target window _self. You can choose - a custom name or one of the following four names: _self specifies the current frame in - the current window, _blank specifies a new window, _parent specifies the - parent of the current frame, and _top specifies the top-level frame in the current - window. If the TextFormat.url property is an empty string or null, - you can get or set this property, but the property will have no effect. -

Implementation -
-    public function get target():String -
-    public function set target(value:String):void -
-

-See also -

-
-flash.text.TextFormat.url -
-
-Example -

-
- - - - - -
underlineproperty 
-
-underline:Object  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether the text that uses this text format is underlined (true) - or not (false). This underlining is similar to that produced by the - <U> tag, but the latter is not true underlining, because it does not skip - descenders correctly. The default value is null, which indicates that underlining - is not used. -

Implementation -
-    public function get underline():Object -
-    public function set underline(value:Object):void -
-
-Example -

-
- - - - - -
urlproperty 
-
-url:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the target URL for the text in this text format. If the url - property is an empty string, the text does not have a hyperlink. The default value is null, - which indicates that the text does not have a hyperlink. -

Note: The text with the assigned text format must be set with the htmlText - property for the hyperlink to work.

- Implementation -
-    public function get url():String -
-    public function set url(value:String):void -
-

-See also -

-
-flash.text.TextField.htmlText -
-
-Example -

-
- -
Constructor detail
- - - - - -
TextFormat()constructor
-
-public function TextFormat(font:String = null, size:Object = null, color:Object = null, bold:Object = null, italic:Object = null, underline:Object = null, url:String = null, target:String = null, align:String = null, leftMargin:Object = null, rightMargin:Object = null, indent:Object = null, leading:Object = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a TextFormat object with the specified properties. You can then change the - properties of the TextFormat object to change the formatting of text fields. -

Any parameter may be set to null to indicate that it is not defined. All of the - parameters are optional; any omitted parameters are treated as null.

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
font:String (default = null) — The name of a font for text as a string. -
 
size:Object (default = null) — An integer that indicates the size in pixels. -
 
color:Object (default = null) — The color of text using this text format. A number containing three 8-bit RGB - components; for example, 0xFF0000 is red, and 0x00FF00 is green. -
 
bold:Object (default = null) — A Boolean value that indicates whether the text is boldface. -
 
italic:Object (default = null) — A Boolean value that indicates whether the text is italicized. -
 
underline:Object (default = null) — A Boolean value that indicates whether the text is underlined. -
 
url:String (default = null) — The URL to which the text in this text format hyperlinks. If url is - an empty string, the text does not have a hyperlink. -
 
target:String (default = null) — The target window where the hyperlink is displayed. If the target window is an empty - string, the text is displayed in the default target window _self. If the - url parameter is set to an empty string or to the value null, you can get or - set this property, but the property will have no effect. -
 
align:String (default = null) — The alignment of the paragraph, as a TextFormatAlign value. -
 
leftMargin:Object (default = null) — Indicates the left margin of the paragraph, in pixels. -
 
rightMargin:Object (default = null) — Indicates the right margin of the paragraph, in pixels. -
 
indent:Object (default = null) — An integer that indicates the indentation from the left margin to the first character - in the paragraph. -
 
leading:Object (default = null) — A number that indicates the amount of leading vertical space between lines. -
-
-Example -
In the following example, a user can select different text formatting - options from a list that is applied to the content of another text field. If the user - clicks on the text field's content, the formatting reverts to the default (original) format. - -

The formatTextField text field lists all the TextField class property options - (with the exception of kerning) in a separate line. When a user clicks a - line in the formatTextField text field, the formatTextFieldClickHandler() - method is triggered.

- -

The formatTextFieldClickHandler() method calls the TextField.getLineIndexAtPoint() - method to get the index of the line that was clicked, and then calls the TextField.getLineText() - method to get the content of the line. The switch statement checks the content of the line and sets - a property of the newformat TextFormat object accordingly. The setTextFormat() - method then sets the text format of the contentTextField text field to the new format. By clicking - different formatTextField lines, a user can apply a different formatting - to the contentTextField text field. (The tab setting is an array that defines - a separate tab stop for each tab in the line.) If the url or target line - is selected, the user must click the contentTextField text field to activate the link - and display the content of the target URL (Flex home page). The default value of the target - property is "_self", which means that the content is displayed in the current window if the user - selects the url line. For the target property to work, a URL must be - set already in the url property.

- -

If a user clicks the contentTextField text field, the contentTextFieldClickHandler() - method is triggered, which sets the field's format and the newFormat TextFormat - object to the default (original) format of the text field. This clears all the formatting changes - that the user made.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFormat;
-    import flash.text.TextFieldAutoSize;
-    import flash.events.MouseEvent;
-    import flash.text.TextFormatAlign;
-    
-    public class TextFormat_constructorExample extends Sprite {
-        private var contentTextField:TextField = new TextField();
-        private var formatTextField:TextField = new TextField();
-        private var newFormat:TextFormat = new TextFormat();
-        
-        public function TextFormat_constructorExample() {
-            contentTextField.x = 10;
-            contentTextField.y = 10;
-            contentTextField.background = true;
-            contentTextField.border = true;
-            contentTextField.multiline = true;
-            contentTextField.wordWrap = true;
-            contentTextField.selectable = false;
-            contentTextField.width = 250;
-            contentTextField.height = 120; 
-  
-            contentTextField.htmlText = "<p>The TextFormat class represents character formatting "
-                + "information. Use the TextFormat class to create specific text formatting "
-                + "for text fields." + 
-                " </p><br>" + "\tTab One" + "\tTab Two<br>";
-              
-            formatTextField.x = 10;
-            formatTextField.y = 140;
-            formatTextField.background = true;
-            formatTextField.border = true;
-            formatTextField.autoSize = TextFieldAutoSize.LEFT;
-            
-            formatTextField.text = "align: right\n" + "blockIndent: 10 pixels\n" + "bold:\n" + "bullet:\n" + "color: red\n"
-                                + "font: Arial\n" + "indent: 20 pixels\n" + "italic:\n" + "leading: 5 spaces\n" 
-                                + "leftMargin: 20 pixels\n" + "letterSpacing: 4 pixels\n" + "rightMargin: 20 pixels\n" 
-                                + "size: 16 point\n" + "target: new window\n" + "tabStops: 50 and 150 pixel\n" 
-                                + "underline:\n" + "url: Adobe Flex page\n";
-
-            formatTextField.addEventListener(MouseEvent.CLICK, formatTextFieldClickHandler);
-            
-            contentTextField.addEventListener(MouseEvent.CLICK, contentTextFieldClickHandler);
-            
-            this.addChild(contentTextField);
-            this.addChild(formatTextField);
-        }
-
-        private function formatTextFieldClickHandler(e:MouseEvent):void {
-                var value:String= "";
-                var i:uint = 0;
-                var index:int = formatTextField.getLineIndexAtPoint(e.localX, e.localY);
-                var line:String = formatTextField.getLineText(index);;
-
-                line = line.substr(0, (line.indexOf(":")));
-
-                switch(line) {
-                    case "align":
-                        newFormat.align = TextFormatAlign.RIGHT;
-                        break;
-                    case "blockIndent":
-                        newFormat.blockIndent = 10;
-                        break;
-                    case "bold":
-                        newFormat.bold = true;
-                        break;
-                    case "bullet":
-                        newFormat.bullet = true;
-                        break;
-                    case "color":
-                        newFormat.color = 0xFF0000;        
-                        break;
-                    case "font":
-                        newFormat.font = "Arial";
-                        break;
-                    case "indent":
-                        newFormat.indent = 20;
-                        break;
-                    case "italic":
-                        newFormat.italic = true;
-                        break;
-                    case "leading":
-                        newFormat.leading = 5;
-                        break;
-                    case "leftMargin":
-                        newFormat.leftMargin = 20;
-                        break;
-                    case "letterSpacing":
-                        newFormat.letterSpacing = 4;
-                        break;
-                    case "rightMargin":
-                        newFormat.rightMargin = 20;
-                        break;
-                    case "size":
-                        newFormat.size = 16;
-                        break;
-                    case "tabStops":                
-                        newFormat.tabStops = [50, 150];
-                        break;
-                    case "target":
-                        newFormat.url = "http://www.adobe.com/products/flex/";    
-                        newFormat.target = "_blank";
-                        break;    
-                    case "underline":
-                        newFormat.underline = true;
-                        break;
-                    case "url":
-                        newFormat.url = "http://www.adobe.com/products/flex/";    
-                        break;
-                }    
-
-                contentTextField.setTextFormat(newFormat);
-        }
-
-        private function contentTextFieldClickHandler(e:MouseEvent):void {
-            contentTextField.setTextFormat(contentTextField.defaultTextFormat);
-            newFormat = contentTextField.defaultTextFormat;
-        }
-    }
-}
-
-

-
- -
Examples
-
examples\TextFormatExample
-
The following example creates the TextFieldExample class to display a text message with - the default location (x = 0, y = 0). This is accomplished using the following steps: -
    -
  1. A property label of type TextField is created.
    2. -
  2. The class constructor calls the function configureLabel()
    3. -
  3. The configureLabel() function first creates a new TextField object and assigns it to - label then sets its parameters to -
      -
    • Left-justify the text field
      • -
    • Enable the background fill
      • -
    • Enable the border.
      • -
    -
    4. -
  4. Next, configureLabel() creates the local variable, format, and assigns it to - a new TextFormat instance with its parameters set to: -
      -
    • Font type = Verdana
      • -
    • Font Color = solid red
      • -
    • Font size = 10
      • -
    • Font underline = true.
      • -
    -
    5. -
  5. The label's defaultTextFormat property is set to format, and the - label instance is added to the display list, which initially displays a text field with - no text (as tiny box with a white background) on the stage.
    6. -
  6. Finally (back in the constructor), the label's text is then set to display "Hello - World and welcome to the show", at coordinates x = 0, y = 0 by calling setLabel().
    7. -
-
-
- package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldAutoSize;
-    import flash.text.TextFormat;
-
-
-    public class TextFormatExample extends Sprite {
-        private var label:TextField;
-
-        public function TextFormatExample() {
-            configureLabel();
-            setLabel("Hello World and welcome to the show");
-        }
-
-        public function setLabel(str:String):void {
-            label.text = str;
-        }
-
-        private function configureLabel():void {
-            label = new TextField();
-            label.autoSize = TextFieldAutoSize.LEFT;
-            label.background = true;
-            label.border = true;
-
-            var format:TextFormat = new TextFormat();
-            format.font = "Verdana";
-            format.color = 0xFF0000;
-            format.size = 10;
-            format.underline = true;
-
-            label.defaultTextFormat = format;
-            addChild(label);
-        }
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextFormatAlign.html b/html-docs/flash/text/TextFormatAlign.html deleted file mode 100644 index 61fb100..0000000 --- a/html-docs/flash/text/TextFormatAlign.html +++ /dev/null @@ -1,422 +0,0 @@ - - - - - - - - -flash.text.TextFormatAlign (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class TextFormatAlign
InheritanceTextFormatAlign Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The TextFormatAlign class provides values for text alignment in the TextFormat class. - - -

-

-See also -

-
-flash.text.TextFormat -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  CENTER : String = "center"
[static] - Constant; centers the text in the text field.
-		TextFormatAlign
  END : String = "end"
[static] - Constant; aligns text to the end edge of a line.
-		TextFormatAlign
  JUSTIFY : String = "justify"
[static] - Constant; justifies text within the text field.
-		TextFormatAlign
  LEFT : String = "left"
[static] - Constant; aligns text to the left within the text field.
-		TextFormatAlign
  RIGHT : String = "right"
[static] - Constant; aligns text to the right within the text field.
-		TextFormatAlign
  START : String = "start"
[static] - Constant; aligns text to the start edge of a line.
-		TextFormatAlign
-
- -
- -
Constant detail
- - - - - -
CENTERconstant
-
-public static const CENTER:String = "center" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Constant; centers the text in the text field. - Use the syntax TextFormatAlign.CENTER. -

-See also -

-
-flash.text.TextFormat.align -
-
- - - - - -
ENDconstant 
-
-public static const END:String = "end" -

- - - - -
Language version: ActionScript 3.0
-

- Constant; aligns text to the end edge of a line. Same as right for - left-to-right languages and same as left for right-to-left languages. -

The END constant may only be used with the StageText class.

-

-See also -

-
-flash.text.StageText.textAlign -
-flash.text.StageText.locale -
-
- - - - - -
JUSTIFYconstant 
-
-public static const JUSTIFY:String = "justify" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Constant; justifies text within the text field. - Use the syntax TextFormatAlign.JUSTIFY. - -

-See also -

-
-flash.text.TextFormat.align -
-
- - - - - -
LEFTconstant 
-
-public static const LEFT:String = "left" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Constant; aligns text to the left within the text field. - Use the syntax TextFormatAlign.LEFT. -

-See also -

-
-flash.text.TextFormat.align -
-
- - - - - -
RIGHTconstant 
-
-public static const RIGHT:String = "right" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Constant; aligns text to the right within the text field. - Use the syntax TextFormatAlign.RIGHT. -

-See also -

-
-flash.text.TextFormat.align -
-
- - - - - -
STARTconstant 
-
-public static const START:String = "start" -

- - - - -
Language version: ActionScript 3.0
-

- Constant; aligns text to the start edge of a line. Same as left for - left-to-right languages and same as right for right-to-left languages. -

The START constant may only be used with the StageText class.

-

-See also -

-
-flash.text.StageText.textAlign -
-flash.text.StageText.locale -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextInteractionMode.html b/html-docs/flash/text/TextInteractionMode.html deleted file mode 100644 index 893a721..0000000 --- a/html-docs/flash/text/TextInteractionMode.html +++ /dev/null @@ -1,276 +0,0 @@ - - - - - - - - -flash.text.TextInteractionMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class TextInteractionMode
InheritanceTextInteractionMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- A class that defines the Interactive mode of a text field object. - - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  NORMAL : String = "normal"
[static] - The text field's default interaction mode is NORMAL and it varies across platform.
-		TextInteractionMode
  SELECTION : String = "selection"
[static] - On mobile platforms like Android, the text field starts in normal mode(which implies scroll and non-selectable mode).
-		TextInteractionMode
-
- -
- -
Constant detail
- - - - - -
NORMALconstant
-
-public static const NORMAL:String = "normal" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The text field's default interaction mode is NORMAL and it varies across platform. - On Desktop, the normal mode implies that the text field is in scrollable + selection mode. - On Mobile platforms like Android, normal mode implies that the text field can only be scrolled but - the text can not be selected. - -

- - - - - -
SELECTIONconstant 
-
-public static const SELECTION:String = "selection" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- On mobile platforms like Android, the text field starts in normal mode(which implies scroll and non-selectable mode). - The user can switch to selection mode through the in-built context menu of the text field object. - - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextLineMetrics.html b/html-docs/flash/text/TextLineMetrics.html deleted file mode 100644 index 8c709ea..0000000 --- a/html-docs/flash/text/TextLineMetrics.html +++ /dev/null @@ -1,648 +0,0 @@ - - - - - - - - -flash.text.TextLineMetrics (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic class TextLineMetrics
InheritanceTextLineMetrics Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The TextLineMetrics class contains information about the text position and measurements of a - line of text within a text field. All measurements are in pixels. Objects of this class are returned by the - flash.text.TextField.getLineMetrics() method. -

For measurements related to the text field containing the line of text (for example, the "Text Field height" measurement in the diagram), see flash.text.TextField.

-

The following diagram indicates the points and measurements of a text field and the line of text the field contains:

-

- An image illustrating text metrics

- -

-

-View the examples. -

-

-See also -

-
-flash.text.TextField -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  ascent : Number -
- The ascent value of the text is the length from the baseline to the top of the line height in pixels.
-		TextLineMetrics
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  descent : Number -
- The descent value of the text is the length from the baseline to the bottom depth of the line in pixels.
-		TextLineMetrics
  height : Number -
- The height value of the text of the selected lines (not necessarily the complete text) in pixels.
-		TextLineMetrics
  leading : Number -
- The leading value is the measurement of the vertical distance between the lines of text.
-		TextLineMetrics
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  width : Number -
- The width value is the width of the text of the selected lines (not necessarily the complete text) in pixels.
-		TextLineMetrics
  x : Number -
- The x value is the left position of the first character in pixels.
-		TextLineMetrics
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TextLineMetrics(x:Number, width:Number, height:Number, ascent:Number, descent:Number, leading:Number)
-
- Creates a TextLineMetrics object.
-		TextLineMetrics
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
ascentproperty
-
-public var ascent:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The ascent value of the text is the length from the baseline to the top of the line height in pixels. See the - "Ascent" measurement in the overview diagram for this class. -

-See also -

-
-TextLineMetrics class overview -
-
- - - - - -
descentproperty 
-
-public var descent:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The descent value of the text is the length from the baseline to the bottom depth of the line in pixels. - See the "Descent" measurement in the overview diagram for this class. -

-See also -

-
-TextLineMetrics class overview -
-
- - - - - -
heightproperty 
-
-public var height:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The height value of the text of the selected lines (not necessarily the complete text) in pixels. The height of the - text line does not include the gutter height. See the "Line height" measurement in the overview diagram - for this class. -

-See also -

-
-TextLineMetrics class overview -
-
- - - - - -
leadingproperty 
-
-public var leading:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The leading value is the measurement of the vertical distance between the lines of text. - See the "Leading" measurement in the overview diagram for this class. - -

-See also -

-
-TextLineMetrics class overview -
-
- - - - - -
widthproperty 
-
-public var width:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The width value is the width of the text of the selected lines (not necessarily the complete text) in pixels. The width of the - text line is not the same as the width of the text field. The width of the text line is relative to the - text field width, minus the gutter width of 4 pixels (2 pixels on each side). See the "Text Line width" - measurement in the overview diagram for this class. -

-See also -

-
-TextLineMetrics class overview -
-
- - - - - -
xproperty 
-
-public var x:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The x value is the left position of the first character in pixels. This value includes the margin, - indent (if any), and gutter widths. See the "Text Line x-position" in the overview diagram for this class. -

-See also -

-
-TextLineMetrics class overview -
-
- -
Constructor detail
- - - - - -
TextLineMetrics()constructor
-
-public function TextLineMetrics(x:Number, width:Number, height:Number, ascent:Number, descent:Number, leading:Number) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a TextLineMetrics object. The TextLineMetrics object contains information about - the text metrics of a line of text in a text field. Objects of this class are returned by the - flash.text.TextField.getLineMetrics() method. -

See the diagram in the overview for this class for the properties in context.

- - Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
x:Number — The left position of the first character in pixels. -
 
width:Number — The width of the text of the selected lines (not necessarily the complete text) in pixels. -
 
height:Number — The height of the text of the selected lines (not necessarily the complete text) in pixels. -
 
ascent:Number — The length from the baseline to the top of the line height in pixels. -
 
descent:Number — The length from the baseline to the bottom depth of the line in pixels. -
 
leading:Number — The measurement of the vertical distance between the lines of text. -
-

-See also -

-
-TextLineMetrics class overview -
-flash.text.TextField.getLineMetrics() -
-
- -
Examples
-
examples\TextLineMetricsExample
-
The following example creates the classes TextLineMetricsExample and - LineMetricsReader to print out a message in the Flash Player via an XML object. This - is accomplished using the following steps: -
    -
  1. Create a property called label of type TextField.
    2. -
  2. The constructor calls configureAssets(), which does the following: -
      -
    • Sets the stage's alignment to top-left and no scale.
      • -
    • Creates a new TextField object named label.
      • -
    • Enables label's background and sets the color to white.
      • -
    • Allows label's text to span multiple lines with automatic word wrapping.
      • -
    • Assigns the result of a call to getLabelText() to the text property - of label. The getLabelText() method creates a variable of type XML and assigns - it to an XML node named body, which is populated with a long sentence.
      • -
    • Adds label to the display list using addChild().
      • -
    -
    3. -
  3. A method that listens for resize events performed on the stage is then added called - resizeHandler(). Every time the Flash Player window size is changed, a RESIZE - event is dispatched and the following happens: -
      -
    • draw() is called to ensure that label appears in the center of the - stage and surrounded by a 10-pixel buffer.
      • -
    • setTimeout() then executes showMetrics() after a short delay. The - delay is added because the line metrics are not updated until after the RESIZE event has - completed and the stage has fully re-drawn.
      • -
    • showMetrics() assigns a TextLineMetrics variable named metrics to - the result of a call to getLineMetrics() and this variable is then passed to - a new instance of a LineMetricsReader instance named reader. The two - variables are then used within calls to trace() to print out the first (and only) - line of label and information provided by the LineMetricsReader instance through its - toString() method.
      • -
    -
    4. -
  4. The constructor forces a single dispatch of the resize event to force - label to be drawn correctly when the SWF file is first loaded.
    5. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.display.StageAlign;
-    import flash.display.StageScaleMode;
-    import flash.events.*;
-    import flash.text.TextField;
-    import flash.text.TextLineMetrics;
-    import flash.utils.setTimeout;
-
-    public class TextLineMetricsExample extends Sprite {
-        private var gutter:int = 10;
-        private var label:TextField;
-
-        public function TextLineMetricsExample() {
-            configureAssets();
-            configureListeners();
-            resizeHandler(new Event(Event.RESIZE));
-        }
-
-        private function showMetrics():void {
-            var metrics:TextLineMetrics = label.getLineMetrics(0);
-            var reader:LineMetricsReader = new LineMetricsReader(metrics);
-            trace("lineText: " + label.getLineText(0));
-            trace("metrics: " + reader);
-        }
-
-        private function configureAssets():void {
-            stage.align = StageAlign.TOP_LEFT;
-            stage.scaleMode = StageScaleMode.NO_SCALE;
-
-            label = new TextField();
-            label.background = true;
-            label.backgroundColor = 0xFFFFFF;
-            label.multiline = true;
-            label.wordWrap = true;
-            label.text = getLabelText();
-            addChild(label);
-        }
-
-        private function configureListeners():void {
-            stage.addEventListener(Event.RESIZE, resizeHandler);
-        }
-
-        private function resizeHandler(event:Event):void {
-            draw();
-            setTimeout(showMetrics, 100);
-        }
-
-        private function draw():void {
-            label.x = gutter;
-            label.y = gutter;
-            label.width = stage.stageWidth - (gutter * 2);
-            label.height = stage.stageHeight - (gutter * 2);
-        }
-
-        private function getLabelText():String {
-            var text:XML = <body>The Flex product line enables developers to build rich Internet applications that blend the responsiveness of desktop software, the cross-platform reach of the web, and the expressiveness of the Flash Platform.</body>
-            return text.toString();
-        }
-    }
-}
-
-import flash.text.TextLineMetrics;
-
-class LineMetricsReader {
-    private var metrics:TextLineMetrics;
-
-    public function LineMetricsReader(metrics:TextLineMetrics) {
-        this.metrics = metrics;
-    }
-
-    public function toString():String {
-        return "[TextLineMetrics ascent:" + metrics.ascent
-            + ", descent:" + metrics.descent
-            + ", leading:" + metrics.leading
-            + ", width:" + metrics.width
-            + ", height:" + metrics.height
-            + ", x:" + metrics.x
-            + "]";
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextRenderer.html b/html-docs/flash/text/TextRenderer.html deleted file mode 100644 index 1bc5178..0000000 --- a/html-docs/flash/text/TextRenderer.html +++ /dev/null @@ -1,505 +0,0 @@ - - - - - - - - -flash.text.TextRenderer (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic final class TextRenderer
InheritanceTextRenderer Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The TextRenderer class provides functionality for the advanced anti-aliasing capability of - embedded fonts. Advanced anti-aliasing allows font faces to render at very high quality at - small sizes. Use advanced anti-aliasing with applications that have a lot of small text. Adobe does not recommend using advanced - anti-aliasing for very large fonts (larger than 48 points). - Advanced anti-aliasing is available in Flash Player 8 and later only. - -

To set advanced anti-aliasing on a text field, set the antiAliasType property of - the TextField instance.

- -

Advanced anti-aliasing provides continuous stroke modulation (CSM), which is continuous - modulation of both stroke weight and edge sharpness. As an advanced feature, you can - use the setAdvancedAntiAliasingTable() method to define settings for specific - typefaces and font sizes.

- -

-

-View the examples. -

-

-See also -

-
-flash.text.TextField.antiAliasType -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  displayMode : String -
[static] - Controls the rendering of advanced anti-aliased text.
-		TextRenderer
  maxLevel : int -
[static] - The adaptively sampled distance fields (ADFs) quality level for advanced anti-aliasing.
-		TextRenderer
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-setAdvancedAntiAliasingTable(fontName:String, fontStyle:String, colorType:String, advancedAntiAliasingTable:Array):void -
-
[static] - Sets a custom continuous stroke modulation (CSM) lookup table for a font.
-		TextRenderer
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
displayModeproperty
-
-displayMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Controls the rendering of advanced anti-aliased text. The visual quality of text is very subjective, and while - Flash Player tries to use the best settings for various conditions, designers may choose a different - look or feel for their text. Also, using displayMode allows a designer to override Flash - Player's subpixel choice and create visual consistency independent of the user's hardware. Use the values in the TextDisplayMode class to set this property. -

The default value is "default".

-Implementation -
-    public static function get displayMode():String -
-    public function set displayMode(value:String):void -
-

-See also -

-
-TextDisplayMode class -
-
- - - - - -
maxLevelproperty 
-
-maxLevel:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The adaptively sampled distance fields (ADFs) quality level for advanced anti-aliasing. The only acceptable values are - 3, 4, and 7. - -

Advanced anti-aliasing uses ADFs to - represent the outlines that determine a glyph. The higher the quality, the more - cache space is required for ADF structures. A value of 3 takes the least amount - of memory and provides the lowest quality. Larger fonts require more cache space; - at a font size of 64 pixels, the quality level increases from 3 to 4 or - from 4 to 7 unless, the level is already set to 7.

- -

The default value is 4.

-Implementation -
-    public static function get maxLevel():int -
-    public function set maxLevel(value:int):void -
-
- -
Method detail
- - - - - -
setAdvancedAntiAliasingTable()method
-
-public static function setAdvancedAntiAliasingTable(fontName:String, fontStyle:String, colorType:String, advancedAntiAliasingTable:Array):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Sets a custom continuous stroke modulation (CSM) lookup table for a font. - Flash Player attempts to detect the best CSM for your font. If you are not - satisfied with the CSM that the Flash Player provides, you can customize - your own CSM by using the setAdvancedAntiAliasingTable() method. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
fontName:String — The name of the font for which you are applying settings. -
 
fontStyle:String — The font style indicated by using one of the values from - the flash.text.FontStyle class. - -
 
colorType:String — This value determines whether the stroke is dark or whether it is light. - Use one of the values from the flash.text.TextColorType class. - -
 
advancedAntiAliasingTable:Array — An array of one or more CSMSettings objects - for the specified font. Each object contains the following properties: - -
    - -
  • fontSize
    • -
  • insideCutOff
    • -
  • outsideCutOff
    • -
- -

The advancedAntiAliasingTable array can contain multiple entries - that specify CSM settings for different font sizes.

- -

The fontSize is the size, in pixels, for which the settings apply.

- -

Advanced anti-aliasing uses adaptively sampled distance fields (ADFs) to - represent the outlines that determine a glyph. Flash Player uses an outside cutoff value - (outsideCutOff), - below which densities are set to zero, and an inside cutoff value (insideCutOff), - above which densities - are set to a maximum density value (such as 255). Between these two cutoff values, - the mapping function is a linear curve ranging from zero at the outside cutoff - to the maximum density at the inside cutoff.

-

Adjusting the outside and inside cutoff values affects stroke weight and - edge sharpness. The spacing between these two parameters is comparable to twice the - filter radius of classic anti-aliasing methods; a narrow spacing provides a sharper edge, - while a wider spacing provides a softer, more filtered edge. When - the spacing is zero, the resulting density image is a bi-level bitmap. When the - spacing is very wide, the resulting density image has a watercolor-like edge.

- -

Typically, users prefer sharp, high-contrast edges at small point sizes, and - softer edges for animated text and larger point sizes.

- -

The outside cutoff typically has a negative value, and the inside cutoff typically - has a positive value, and their midpoint typically lies near zero. Adjusting these - parameters to shift the midpoint toward negative infinity increases the stroke - weight; shifting the midpoint toward positive infinity decreases the stroke weight. - Make sure that the outside cutoff value is always less than or equal to the inside cutoff value.

- - -
-

-See also -

-
-flash.text.FontStyle -
-flash.text.TextColorType -
-CSMSettings -
-
- -
Examples
-
examples\TextRendererExample2
-
The following example creates the TextRendererExample class - to demonstrate visual examples of advanced anti-aliasing settings with small - and large font sizes. Before testing this example, you will need to embed a - font. - - If you are using Flex, embed a font in the following manner: -
    -
  1. Place the Georgia font, named georgia.ttf in the same directory as this AS file.
    2. -
  2. Add the following lines directly underneath the class definition:
    3. -
  3. [Embed(source="georgia.ttf", fontFamily="Georgia")]
    4. -
  4. private var embeddedFont:String;
    5. -
- - If you are using Flash, embed a font in the following manner: -
    -
  1. Place a text field on the stage and select it.
    2. -
  2. In the Property Inspector, set that text field's font to Georgia
    3. -
  3. In the Property Inspector, press "Embed..." and select "All"
    4. -
- -

Notes: -

    -
  • You will need to compile the SWF file with "Local playback security" set to "Access local files only".
    • -
-

-
-
-package {
-	import flash.display.DisplayObject;
-	import flash.display.Sprite;
-	import flash.events.*;
-	import flash.text.*;
-	
-	public class TextRendererExample2 extends Sprite {
-
-		private var gutter:int = 10;
-
-		public function TextRendererExample2() {
-			createTextField(8,AntiAliasType.NORMAL);
-			createTextField(8,AntiAliasType.ADVANCED);
-			createTextField(24,AntiAliasType.NORMAL);
-			createTextField(24,AntiAliasType.ADVANCED);
-		}
-			
-		private function createTextField(fontSize:Number,antiAliasType:String):TextField {
-			var tf:TextField = new TextField();
-		    tf.embedFonts = true;
-			tf.autoSize = TextFieldAutoSize.LEFT;
-			tf.antiAliasType = antiAliasType;
-		    tf.defaultTextFormat = getTextFormat(fontSize);
-		    tf.selectable = false;
-		    tf.mouseEnabled = true;
-			tf.text = "The quick brown fox jumped over the lazy dog.";
-        	if(numChildren > 0) {
-        		var sibling:DisplayObject = getChildAt(numChildren - 1);
-        		tf.y = sibling.y + sibling.height + gutter;
-	        }
-	        addChild(tf);
-		    return tf;
-		}
-		
-		private function getTextFormat(fontSize:Number):TextFormat {
-		    var format:TextFormat = new TextFormat();
-		    format.size = fontSize;
-		    format.font = "Georgia";
-		    return format;
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/TextSnapshot.html b/html-docs/flash/text/TextSnapshot.html deleted file mode 100644 index 0b387bd..0000000 --- a/html-docs/flash/text/TextSnapshot.html +++ /dev/null @@ -1,930 +0,0 @@ - - - - - - - - -flash.text.TextSnapshot (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text
Classpublic class TextSnapshot
InheritanceTextSnapshot Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- TextSnapshot objects let you work with static text in a movie clip. You can use them, for example, - to lay out text with greater precision than that allowed by dynamic text, but still access the text - in a read-only way. - -

You don't use a constructor to create a TextSnapshot object; it is returned by - flash.display.DisplayObjectContainer.textSnapshot property.

- -

-

-See also -

-
-flash.display.DisplayObjectContainer.textSnapshot -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - -
 PropertyDefined by
  charCount : int -
[read-only] - The number of characters in a TextSnapshot object.
-		TextSnapshot
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int -
-
- Searches the specified TextSnapshot object and returns the position of the first - occurrence of textToFind found at or after beginIndex.
-		TextSnapshot
   -
-getSelected(beginIndex:int, endIndex:int):Boolean -
-
- Returns a Boolean value that specifies whether a TextSnapshot object contains selected text in - the specified range.
-		TextSnapshot
   -
-getSelectedText(includeLineEndings:Boolean = false):String -
-
- Returns a string that contains all the characters specified by the corresponding - setSelected() method.
-		TextSnapshot
   -
-getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String -
-
- Returns a string that contains all the characters specified by the beginIndex - and endIndex parameters.
-		TextSnapshot
   -
-getTextRunInfo(beginIndex:int, endIndex:int):Array -
-
- Returns an array of objects that contains information about a run of text.
-		TextSnapshot
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number -
-
- Lets you determine which character within a TextSnapshot object is on or near the specified - x, y coordinates of the movie clip containing the text in the TextSnapshot object.
-		TextSnapshot
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-setSelectColor(hexColor:uint = 0xFFFF00):void -
-
- Specifies the color to use when highlighting characters that have been selected with the - setSelected() method.
-		TextSnapshot
   -
-setSelected(beginIndex:int, endIndex:int, select:Boolean):void -
-
- Specifies a range of characters in a TextSnapshot object to be selected or deselected.
-		TextSnapshot
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
charCountproperty
-
-charCount:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The number of characters in a TextSnapshot object. -

Implementation -
-    public function get charCount():int -
-

-See also -

-
-flash.text.TextSnapshot.getText() -
-
- -
Method detail
- - - - - -
findText()method
-
-public function findText(beginIndex:int, textToFind:String, caseSensitive:Boolean):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Searches the specified TextSnapshot object and returns the position of the first - occurrence of textToFind found at or after beginIndex. If - textToFind is not found, the method returns -1. -

Parameters - - - - - - - - - - - - - - - - -
beginIndex:int — Specifies the starting point to search for the specified text. - -
 
textToFind:String — Specifies the text to search for. If you specify a string literal instead of a - variable of type String, enclose the string in quotation marks. - -
 
caseSensitive:Boolean — Specifies whether the text must match the case of the string in - textToFind. -
-

-Returns - - - - -
int — - The zero-based index position of the first occurrence of the specified text, or -1. - - -
-

-See also -

-
-flash.text.TextSnapshot.getText() -
-
- - - - - -
getSelected()method 
-
-public function getSelected(beginIndex:int, endIndex:int):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a Boolean value that specifies whether a TextSnapshot object contains selected text in - the specified range. - -

To search all characters, pass a value of 0 for start, and - charCount (or any very large number) for end. - To search a single character, pass the end parameter a value that is one greater - than the start parameter.

- Parameters - - - - - - - - - - -
beginIndex:int — Indicates the position of the first character to be examined. - Valid values for beginIndex are 0 through - TextSnapshot.charCount - 1. If beginIndex is a negative value, - 0 is used. -
 
endIndex:int — A value that is one greater than the index of the last character to be examined. Valid values - for endIndex are 0 through charCount. - The character indexed by the endIndex parameter is not included in the extracted - string. If this parameter is omitted, charCount is used. If this value is less than - or equal to the value of beginIndex, beginIndex + 1 is used. -
-

-Returns - - - - -
Boolean — - A Boolean value that indicates whether at least one character in the given range has been - selected by the corresponding setSelected() method (true); otherwise, - false. - - -
-

-See also -

-
-flash.text.TextSnapshot.charCount -
-flash.text.TextSnapshot.getText() -
-flash.text.TextSnapshot.getSelectedText() -
-flash.text.TextSnapshot.setSelected() -
-
- - - - - -
getSelectedText()method 
-
-public function getSelectedText(includeLineEndings:Boolean = false):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string that contains all the characters specified by the corresponding - setSelected() method. If no characters are specified (by the - setSelected() method), an empty string is returned. - -

If you pass true for includeLineEndings, - newline characters are inserted in the return string, and - the return string might be longer than the input range. If - includeLineEndings is false or omitted, the method returns - the selected text without adding any characters.

- Parameters - - - - -
includeLineEndings:Boolean (default = false) — An optional Boolean value that specifies - whether newline characters are inserted into the returned string where - appropriate. The default value is false. - -
-

-Returns - - - - -
String — - A string that contains all the characters specified by the - corresponding setSelected() command. - - - -
-

-See also -

-
-flash.text.TextSnapshot.getSelected() -
-flash.text.TextSnapshot.setSelected() -
-
- - - - - -
getText()method 
-
-public function getText(beginIndex:int, endIndex:int, includeLineEndings:Boolean = false):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string that contains all the characters specified by the beginIndex - and endIndex parameters. If no characters are selected, an empty string is - returned. - -

To return all characters, pass a value of 0 for beginIndex and - charCount (or any very large number) for endIndex. - To return a single character, pass a value of beginIndex + 1 for endIndex.

- -

If you pass a value of true for includeLineEndings, - newline characters are inserted in the string returned where deemed appropriate. In this case, - the return string might be longer than the input range. If includeLineEndings - is false or omitted, the selected text is returned without any characters added.

- Parameters - - - - - - - - - - - - - - - - -
beginIndex:int — Indicates the position of the first character to be included in the - returned string. Valid values for beginIndex are0 through - charCount - 1. If beginIndex is a negative value, - 0 is used. -
 
endIndex:int — A value that is one greater than the index of the last character to be examined. Valid values - for endIndex are 0 through charCount. The character - indexed by the endIndex parameter is not included in the extracted string. If this - parameter is omitted, charCount is used. If this value is less than or - equal to the value of beginIndex, beginIndex + 1 is used. -
 
includeLineEndings:Boolean (default = false) — An optional Boolean value that specifies whether newline characters - are inserted (true) or are not inserted (false) into the returned string. - The default value is false. -
-

-Returns - - - - -
String — - A string containing the characters in the specified range, or an empty string if no - characters are found in the specified range. - - -
-

-See also -

-
-flash.text.TextSnapshot.charCount -
-flash.text.TextSnapshot.getSelectedText() -
-
- - - - - -
getTextRunInfo()method 
-
-public function getTextRunInfo(beginIndex:int, endIndex:int):Array -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- Returns an array of objects that contains information about a run of text. Each object corresponds - to one character in the range of characters specified by the two method parameters. - -

Note: Using the getTextRunInfo() method for a large range of text can - return a large object. Adobe recommends limiting the text range defined by the - beginIndex and endIndex parameters.

- - Parameters - - - - - - - - - - -
beginIndex:int — The index value of the first character in a range of characters in a TextSnapshot - object. - -
 
endIndex:int — The index value of the last character in a range of characters in a TextSnapshot - object. -
-

-Returns - - - - -
Array — - An array of objects in which each object contains information about a specific character - in the range of characters specified by the beginIndex and endIndex parameters. - Each object contains the following eleven properties: -
    - -
  • indexInRun—A zero-based integer index of the character - (relative to the entire string rather than the selected run of text).
    • - -
  • selected—A Boolean value that indicates whether the character is selected - true; false otherwise.
    • - -
  • font—The name of the character's font.
    • - -
  • color—The combined alpha and color value of the character. - The first two hexadecimal digits represent the alpha value, and the remaining digits - represent the color value.
    • - -
  • height—The height of the character, in pixels.
    • - -
  • matrix_a, matrix_b, matrix_c, - matrix_d, matrix_tx, and matrix_ty— - The values of a matrix that define the geometric transformation on the character. - Normal, upright text always has a matrix of the form - [1 0 0 1 x y], where x and y - are the position of the character within the parent movie clip, regardless of the height of - the text. The matrix is in the parent movie clip coordinate system, and - does not include any transformations that may be on that movie clip itself (or its parent).
    • - -
  • corner0x, corner0y, corner1x, corner1y, - corner2x, corner2y, corner3x, - and corner3y—The corners of the bounding box of - the character, based on the coordinate system of the parent movie clip. - These values are only available if the font used by the character is embedded in the - SWF file.
    • -
- - - -
-

-See also -

-
-Matrix class -
-
- - - - - -
hitTestTextNearPos()method 
-
-public function hitTestTextNearPos(x:Number, y:Number, maxDistance:Number = 0):Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Lets you determine which character within a TextSnapshot object is on or near the specified - x, y coordinates of the movie clip containing the text in the TextSnapshot object. - -

If you omit or pass a value of 0 for maxDistance, the location specified - by the x, y coordinates must lie inside the bounding box of the TextSnapshot object. -

- -

This method works correctly only with fonts that include character metric information; however, - by default, the Flash authoring tool does not include this information for static text fields. - Therefore, - the method might return -1 instead of an index value. To ensure that an index - value is returned, you can force the Flash authoring tool to include the character metric - information for a font. To do this, add a dynamic text field that uses that font, select - Character Options for that dynamic text field, and then specify that font outlines should be - embedded for at least one character. (It doesn't matter which characters you specify, nor - whether they are the characters used in the static text fields.)

- Parameters - - - - - - - - - - - - - - - - -
x:Number — A number that represents the x coordinate of the movie clip containing the - text. -
 
y:Number — A number that represents the y coordinate of the movie clip containing the - text. -
 
maxDistance:Number (default = 0) — An optional number that represents the maximum distance from - x, y that can be searched for - text. The distance is measured from the center point of each character. The - default value is 0. -
-

-Returns - - - - -
Number — - A number representing the index value of the character that is nearest to the specified - x, y coordinate. Returns - -1 if no character is found, or if the font doesn't contain character metric information. - - -
-

-See also -

-
-flash.display.DisplayObject.x -
-flash.display.DisplayObject.y -
-
- - - - - -
setSelectColor()method 
-
-public function setSelectColor(hexColor:uint = 0xFFFF00):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies the color to use when highlighting characters that have been selected with the - setSelected() method. The color is always opaque; you can't specify a - transparency value. - -

This method works correctly only with fonts that include character metric information; however, - by default, the Flash authoring tool does not include this information for static text fields. - Therefore, the method might return -1 instead of an index value. To - ensure that an index value is returned, you can force the Flash authoring tool to include the - character metric information for a font. To do this, add a dynamic text field that uses that - font, select Character Options for that dynamic text field, and then specify that font outlines - should be embedded for at least one character. (It doesn't matter which characters you - specify, nor if they are the characters used in the static text fields.)

Parameters - - - - -
hexColor:uint (default = 0xFFFF00) — The color used for the border placed around characters that have been selected by the - corresponding setSelected() command, expressed in hexadecimal - format (0xRRGGBB). -
-

-See also -

-
-flash.text.TextSnapshot.setSelected() -
-
- - - - - -
setSelected()method 
-
-public function setSelected(beginIndex:int, endIndex:int, select:Boolean):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies a range of characters in a TextSnapshot object to be selected or deselected. - Characters that are selected are drawn with a colored rectangle behind them, matching the - bounding box of the character. The color of the bounding box is defined by - setSelectColor(). - -

To select or deselect all characters, pass a value of 0 for beginIndex and - charCount (or any very large number) for endIndex. To - specify a single character, pass a value of start + 1 for endIndex.

- -

Because characters are individually marked as selected, you can call this method multiple - times to select multiple characters; that is, using this method does not deselect other - characters that have been set by this method.

- -

The colored rectangle that indicates a selection is displayed only for fonts that include - character metric information; by default, Flash does not include this information for static - text fields. In some cases, this behavior means that text that is selected won't appear to be - selected onscreen. To ensure that all selected text appears to be - selected, you can force the Flash authoring tool to include the character metric information - for a font. To do this, add a dynamic text field that uses that font, select Character Options - for that dynamic text field, and then specify that font outlines should be embedded for at least - one character. It doesn't matter which characters you specify, nor even if they are the - characters used in the static text fields in question.

- Parameters - - - - - - - - - - - - - - - - -
beginIndex:int — Indicates the position of the first character to select. - Valid values for beginIndex are 0 through charCount - 1. - If beginIndex is a negative value, 0 is used. -
 
endIndex:int — An integer that is 1+ the index of the last character to be - examined. Valid values for end are 0 through charCount. - The character indexed by the end parameter is not included in the extracted - string. If you omit this parameter, TextSnapshot.charCount is used. If the - value of beginIndex is less than or equal to the value of endIndex, - beginIndex + 1 is used. -
 
select:Boolean — A Boolean value that specifies whether the text should be selected (true) - or deselected (false). -
-

-See also -

-
-flash.text.TextSnapshot.charCount -
-flash.text.TextSnapshot.setSelectColor() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/BreakOpportunity.html b/html-docs/flash/text/engine/BreakOpportunity.html deleted file mode 100644 index 1ad85aa..0000000 --- a/html-docs/flash/text/engine/BreakOpportunity.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - -flash.text.engine.BreakOpportunity (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class BreakOpportunity
InheritanceBreakOpportunity Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The BreakOpportunity class is an enumeration of constant values that you can use to set the breakOpportunity property -of the ElementFormat class. -This property determines which characters can be used for breaking when wrapping text is broken into multiple lines. - -

-

-See also -

-
-ElementFormat.breakOpportunity -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  ALL : String = "all"
[static] - Treats all characters in the ContentElement object as line break opportunities, meaning that a line break will occur - afer each character.
-		BreakOpportunity
  ANY : String = "any"
[static] - Treats any character in the ContentElement object as a line break opportunity.
-		BreakOpportunity
  AUTO : String = "auto"
[static] - Bases line break opportunities on Unicode character properties.
-		BreakOpportunity
  NONE : String = "none"
[static] - Treats no characters in the ContentElement object as line break opportunities.
-		BreakOpportunity
-
- -
- -
Constant detail
- - - - - -
ALLconstant
-
-public static const ALL:String = "all" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Treats all characters in the ContentElement object as line break opportunities, meaning that a line break will occur - afer each character. You can use this option to generate the shortest possible lines, - which you can use to create text on a line or similar effects. - -

- - - - - -
ANYconstant 
-
-public static const ANY:String = "any" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Treats any character in the ContentElement object as a line break opportunity. - This value is typically used when Roman text is embedded in Asian text and it is desirable for breaks to happen - in the middle of words. - -

- - - - - -
AUTOconstant 
-
-public static const AUTO:String = "auto" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Bases line break opportunities on Unicode character properties. This setting implements - the Unicode line breaking properties defined by the Unicode Standard Annex #14. -

-See also -

-
-Article on Unicode line breaking properties. -
-
- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Treats no characters in the ContentElement object as line break opportunities. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/CFFHinting.html b/html-docs/flash/text/engine/CFFHinting.html deleted file mode 100644 index 8727ec6..0000000 --- a/html-docs/flash/text/engine/CFFHinting.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - -flash.text.engine.CFFHinting (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class CFFHinting
InheritanceCFFHinting Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The CFFHinting class defines values for cff hinting in the FontDescription class. -

Hinting adjusts the display of an outline font so it lines up with the pixel grid. -At small screen sizes, hinting produces a clear, legible text for human readers. -

- -

-

-See also -

-
-flash.text.engine.FontDescription -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  HORIZONTAL_STEM : String = "horizontalStem"
[static] - Fits strong horizontal stems to the pixel grid for improved readability.
-		CFFHinting
  NONE : String = "none"
[static] - No hinting is applied.
-		CFFHinting
-
- -
- -
Constant detail
- - - - - -
HORIZONTAL_STEMconstant
-
-public static const HORIZONTAL_STEM:String = "horizontalStem" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Fits strong horizontal stems to the pixel grid for improved readability. - This constant is used in setting the cffHinting property of the - FontDescription class. Use the syntax CFFHinting.HORIZONTAL_STEM. -

Note: Not recommended for animation.

-

-See also -

-
-flash.text.engine.FontDescription.cffHinting -
-
- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- No hinting is applied. Horizontal stems in the glyphs are not forced to the pixel grid. - This constant is used in setting the cffHinting property of the - FontDescription class. Recommended setting for animation or for large font sizes. - Use the syntax CFFHinting.NONE. -

-See also -

-
-flash.text.engine.FontDescription.cffHinting -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/ContentElement.html b/html-docs/flash/text/engine/ContentElement.html deleted file mode 100644 index 14b05ea..0000000 --- a/html-docs/flash/text/engine/ContentElement.html +++ /dev/null @@ -1,787 +0,0 @@ - - - - - - - - -flash.text.engine.ContentElement (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.text.engine
Classpublic class ContentElement
InheritanceContentElement Inheritance Object
SubclassesGraphicElement, GroupElement, TextElement
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The ContentElement class serves as a base class for the element types that can appear in a GroupElement, namely a GraphicElement, - another GroupElement, or a TextElement. -

ContentElement is an abstract base class; therefore, you cannot instantiate ContentElement directly. - Invoking new ContentElement() throws an ArgumentError exception.

-

You can assign a ContentElement element to exactly one GroupElement or to the content property of exactly one text - block.

- -

-

-See also -

-
-ElementFormat -
-GraphicElement -
-GroupElement -
-TextBlock.content -
-TextElement -
-TextLineMirrorRegion -
-TextRotation -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  elementFormat : ElementFormat -
- The ElementFormat object used for the element.
-		ContentElement
  eventMirror : EventDispatcher -
- The EventDispatcher object that receives copies of every - event dispatched to valid text lines based on this content element.
-		ContentElement
  groupElement : GroupElement -
[read-only] - The GroupElement object that contains this element, or - null if it is not in a group.
-		ContentElement
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rawText : String -
[read-only] - A copy of the text in the element, including any U+FDEF characters.
-		ContentElement
  text : String -
[read-only] - A copy of the text in the element, not including any U+FDEF characters, which represent graphic elements in the String.
-		ContentElement
  textBlock : TextBlock -
[read-only] - The TextBlock to which this element belongs.
-		ContentElement
  textBlockBeginIndex : int -
[read-only] - The index in the text block of the first character of this element.
-		ContentElement
  textRotation : String -
- The rotation to apply to the element as a unit.
-		ContentElement
  userData : * -
- Provides a way for an application to associate arbitrary data with the element.
-		ContentElement
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ContentElement(elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
-
- Calling the new ContentElement() constructor throws an - ArgumentError exception.
-		ContentElement
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - -
 ConstantDefined by
  GRAPHIC_ELEMENT : uint = 0xFDEF
[static] - Indicates the presence of a graphic element in the text.
-		ContentElement
-
- -
- -
Property detail
- - - - - -
elementFormatproperty
-
-elementFormat:ElementFormat  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The ElementFormat object used for the element. -

The default value is null.

-

When the elementFormat property is set, the ElementFormat object provided is locked: its locked - property is set to true. A locked ElementFormat cannot be modified.

- Implementation -
-    public function get elementFormat():ElementFormat -
-    public function set elementFormat(value:ElementFormat):void -
-

-See also -

-
-ElementFormat -
-TextBlock -
-TextElement -
-
- - - - - -
eventMirrorproperty 
-
-eventMirror:EventDispatcher  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The EventDispatcher object that receives copies of every - event dispatched to valid text lines based on this content element. - The specified object can be used to set up listeners for a text link or other - interactive piece of text, as it can be difficult to determine at runtime which parts - of lines have resulted from particular content elements. - You can also use listeners to apply decorations such as underlines, the metrics of which - you cannot determine until after the text is laid out. - The default value is null, which means no mirrored events are dispatched. -

Event mirrors manifest themselves in text lines as instances of the TextLineMirrorRegion - class. Depending on bidirectional processing and line breaking, one or more mirror regions can be produced.

-

The default value is null.

- Implementation -
-    public function get eventMirror():EventDispatcher -
-    public function set eventMirror(value:EventDispatcher):void -
-

-See also -

-
-flash.events.EventDispatcher -
-TextLineMirrorRegion -
-
- - - - - -
groupElementproperty 
-
-groupElement:GroupElement  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The GroupElement object that contains this element, or - null if it is not in a group. -

The default value is null.

- - Implementation -
-    public function get groupElement():GroupElement -
-

-See also -

-
-GroupElement -
-
- - - - - -
rawTextproperty 
-
-rawText:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- A copy of the text in the element, including any U+FDEF characters. The Unicode character, U+FDEF, marks the location of - a graphic element in the String. -

Implementation -
-    public function get rawText():String -
-
- - - - - -
textproperty 
-
-text:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- A copy of the text in the element, not including any U+FDEF characters, which represent graphic elements in the String. -

Implementation -
-    public function get text():String -
-

-See also -

-
-TextElement.text -
-
- - - - - -
textBlockproperty 
-
-textBlock:TextBlock  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The TextBlock to which this element belongs. -

The default value is null.

- - Implementation -
-    public function get textBlock():TextBlock -
-

-See also -

-
-TextBlock -
-
- - - - - -
textBlockBeginIndexproperty 
-
-textBlockBeginIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The index in the text block of the first character of this element. - This value is not cached; it is calculated whenever this method is called. -

The default value is -1.

- - Implementation -
-    public function get textBlockBeginIndex():int -
-
- - - - - -
textRotationproperty 
-
-textRotation:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The rotation to apply to the element as a unit. Use TextRotation - constants for this property. -

The default value is TextRotation.ROTATE_0.

-

The final rotation of any glyph is the sum of ElementFormat.textRotation, ContentElement.textRotation, and TextBlock.lineRotation.

-

ContentElement.textRotation is used to create a short run of text whose - rotation differs from the containing line. TCY runs in Japanese text are an example. TCY stands for Tate-Chu-Yoko - and refers to a little horizontal run of text (usually a number) in some vertical Japanese text. - To create a Paragraph of vertical Japanese text containing a TCY run, do the following:

-
    -
  1. Set TextBlock.lineRotation=TextRotation.ROTATE_90
    2. -
  2. Set TextBlock.content to a GroupElement, consisting of three TextElement objects. - The first of these elements is the Japanese text before the TCY run, the second is the Latin text of the TCY run, and the third is - the Japanese text after the TCY run.
    3. -
  3. Set the textRotation property of the TCY TextElement to TextRotation.ROTATE_270. - The TCY text element rotates as a unit. It starts with a 90 degree rotation inherited - from the line. Adding another 270 degrees takes it around to horizontal.
    4. -
-

Rotated content elements cannot be nested. In any hierarchy of content elements, no matter how complex, - only one content element can have its textRotation property set. The following methods and property setters throw an - argument error if nested rotations are detected:

-
    -
  1. ContentElement.textRotation
    2. -
  2. GroupElement.setElements
    3. -
  3. GroupElement.replaceElements
    4. -
-

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
TextRotation.ROTATE_0Element is not rotated.
TextRotation.ROTATE_90Element is rotated 90 degrees clockwise.
TextRotation.ROTATE_180Element is rotated 180 degrees.
TextRotation.ROTATE_270Element is rotated 270 degrees clockwise.
TextRotation.AUTONot supported.
- Implementation -
-    public function get textRotation():String -
-    public function set textRotation(value:String):void -
-
-Throws -
- - - - - - - - - - - - - - - - -
ArgumentError — If set to any value that is not a member of TextRotation. -
 
ArgumentError — If set to TextRotation.AUTO. -
 
ArgumentError — If the operation would result in nested rotations within a GroupElement. - -
-

-See also -

-
-TextRotation -
-ElementFormat.textRotation -
-TextBlock.lineRotation -
-
- - - - - -
userDataproperty 
-
-public var userData:* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Provides a way for an application to associate arbitrary data with the element. -

The default value is null.

-
- -
Constructor detail
- - - - - -
ContentElement()constructor
-
-public function ContentElement(elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Calling the new ContentElement() constructor throws an - ArgumentError exception. You can, however, call constructors for - the following subclasses of ContentElement: - -

    - -
  • new GraphicElement()
    • -
  • new GroupElement()
    • -
  • new TextElement()
    • - -
- -

Parameters - - - - - - - - - - - - - - - - -
elementFormat:ElementFormat (default = null) — The element format for the text in the element. The default value is null. -
 
eventMirror:EventDispatcher (default = null) — The EventDispatcher object that receives copies of every - event dispatched to valid text lines created based on this content element. The default value is null. -
 
textRotation:String (default = "rotate0") — The rotation applied the element as a unit. Use TextRotation - constants for this property. The default value is TextRotation.ROTATE_0. -
-
- -
Constant detail
- - - - - -
GRAPHIC_ELEMENTconstant
-
-public static const GRAPHIC_ELEMENT:uint = 0xFDEF -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates the presence of a graphic element in the text. - -

-See also -

-
-rawText -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/DigitCase.html b/html-docs/flash/text/engine/DigitCase.html deleted file mode 100644 index 929c646..0000000 --- a/html-docs/flash/text/engine/DigitCase.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - - - -flash.text.engine.DigitCase (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class DigitCase
InheritanceDigitCase Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The DigitCase class is an enumeration of constant values used in setting the digitCase property -of the ElementFormat class. - -

-

-See also -

-
-flash.text.engine.ElementFormat.digitCase -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  DEFAULT : String = "default"
[static] - Used to specify default digit case.
-		DigitCase
  LINING : String = "lining"
[static] - Used to specify lining digit case.
-		DigitCase
  OLD_STYLE : String = "oldStyle"
[static] - Used to specify old style digit case.
-		DigitCase
-
- -
- -
Constant detail
- - - - - -
DEFAULTconstant
-
-public static const DEFAULT:String = "default" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify default digit case. The results are font-dependent; characters use the settings specified by the font designer - without any features applied. - -

- - - - - -
LININGconstant 
-
-public static const LINING:String = "lining" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify lining digit case. - -

- - - - - -
OLD_STYLEconstant 
-
-public static const OLD_STYLE:String = "oldStyle" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify old style digit case. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/DigitWidth.html b/html-docs/flash/text/engine/DigitWidth.html deleted file mode 100644 index f614d21..0000000 --- a/html-docs/flash/text/engine/DigitWidth.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - - - -flash.text.engine.DigitWidth (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class DigitWidth
InheritanceDigitWidth Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The DigitWidth class is an enumeration of constant values used in setting the digitWidth property -of the ElementFormat class. - -

-

-See also -

-
-flash.text.engine.ElementFormat.digitWidth -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  DEFAULT : String = "default"
[static] - Used to specify default digit width.
-		DigitWidth
  PROPORTIONAL : String = "proportional"
[static] - Used to specify proportional digit width.
-		DigitWidth
  TABULAR : String = "tabular"
[static] - Used to specify tabular digit width.
-		DigitWidth
-
- -
- -
Constant detail
- - - - - -
DEFAULTconstant
-
-public static const DEFAULT:String = "default" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify default digit width. The results are font-dependent; characters use the settings specified by the font designer - without any features applied. - -

- - - - - -
PROPORTIONALconstant 
-
-public static const PROPORTIONAL:String = "proportional" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify proportional digit width. - -

- - - - - -
TABULARconstant 
-
-public static const TABULAR:String = "tabular" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify tabular digit width. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/EastAsianJustifier.html b/html-docs/flash/text/engine/EastAsianJustifier.html deleted file mode 100644 index eb51836..0000000 --- a/html-docs/flash/text/engine/EastAsianJustifier.html +++ /dev/null @@ -1,550 +0,0 @@ - - - - - - - - -flash.text.engine.EastAsianJustifier (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class EastAsianJustifier
InheritanceEastAsianJustifier Inheritance TextJustifier Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

-

- The EastAsianJustifier class has properties to control the justification options for text lines whose - content is primarily East Asian text. -

Use the constructor new EastAsianJustifier() to create an EastAsianJustifier object - before setting its properties. Setting the properties of an EastAsianJustifier object after it has been applied to a TextBlock does - not invalidate the TextBlock.

-

-

-View the examples. -

-

-See also -

-
-JustificationStyle -
-LineJustification -
-TextBlock.textJustifier -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  composeTrailingIdeographicSpaces : Boolean -
- Specifies whether ideographic spaces at the ends of lines should be composed or dropped during justification.
-		EastAsianJustifier
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  justificationStyle : String -
- Specifies the justification style for the text in a text block.
-		EastAsianJustifier
 InheritedlineJustification : String -
- Specifies the line justification for the text in a text block.
-		TextJustifier
 Inheritedlocale : String -
- Specifies the locale to determine the justification rules for the text in a text block.
-		TextJustifier
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-EastAsianJustifier(locale:String = "ja", lineJustification:String = "allButLast", justificationStyle:String = "pushInKinsoku")
-
- Creates an EastAsianJustifier object.
-		EastAsianJustifier
   -
-clone():TextJustifier -
-
- Constructs a cloned copy of the EastAsianJustifier.
-		EastAsianJustifier
 Inherited -
-getJustifierForLocale(locale:String):TextJustifier -
-
[static] - Constructs a default TextJustifier subclass appropriate to the specified locale.
-		TextJustifier
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
composeTrailingIdeographicSpacesproperty
-
-composeTrailingIdeographicSpaces:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.7 -
-

- Specifies whether ideographic spaces at the ends of lines should be composed or dropped during justification. -

The default value is false

- Implementation -
-    public function get composeTrailingIdeographicSpaces():Boolean -
-    public function set composeTrailingIdeographicSpaces(value:Boolean):void -
-
- - - - - -
justificationStyleproperty 
-
-justificationStyle:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the justification style for the text in a text block. -

The default value is JustificationStyle.PUSH_IN_KINSOKU.

-

Use one of the constants in the JustificationStyle class to set the value for this - property. The following table lists the possible values:

- - - - - - - - - - - - - - - - - -
String valueDescription
JustificationStyle.PUSH_IN_KINSOKUSpecifies push in justification.
JustificationStyle.PUSH_OUT_ONLYSpecifies push out justification.
JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENTSpecifies justification wherein the least adjustment is prioritized.
- Implementation -
-    public function get justificationStyle():String -
-    public function set justificationStyle(value:String):void -
-

-See also -

-
-JustificationStyle -
-
- -
Constructor detail
- - - - - -
EastAsianJustifier()constructor
-
-public function EastAsianJustifier(locale:String = "ja", lineJustification:String = "allButLast", justificationStyle:String = "pushInKinsoku") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates an EastAsianJustifier object. -

Parameters - - - - - - - - - - - - - - - - -
locale:String (default = "ja") — The locale to determine the justification rules. - The default value is "ja". -
 
lineJustification:String (default = "allButLast") — The type of line justification for the paragraph. - Use LineJustification constants for this property. - The default value is LineJustification.ALL_BUT_LAST. -
 
justificationStyle:String (default = "pushInKinsoku") — The justification style for the text in a text block using an East Asian justifier. - Use JustificationStyle constants for this property. - The default value is JustificationStyle.PUSH_IN_KINSOKU. -
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — The locale specified is null or too short to represent a valid locale. -
 
ArgumentError — The lineJustification specified is not a member of LineJustification. -
 
ArgumentError — The justificationStyle specified is not a member of JustificationStyle. - -
-

-See also -

-
-JustificationStyle -
-LineJustification -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():TextJustifier -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Constructs a cloned copy of the EastAsianJustifier. -

-Returns - - - - -
TextJustifier — - A copy of the EastAsianJustifier object. - - - -
-
- -
Examples
-
examples\EastAsianJustifierExample
-
This example displays a block of Japanese text vertically, - using EastAsianJustifier properties to justify the text. -
-
- 
-package {
-    import flash.text.engine.TextBlock;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.TextBaseline;
-	import flash.text.engine.EastAsianJustifier;
-	import flash.text.engine.LineJustification;
-	import flash.text.engine.TextRotation;
-	import flash.text.engine.FontDescription;
-	import flash.text.engine.ElementFormat;
-	import flash.display.Stage;
-	import flash.display.Sprite;
-	import flash.system.Capabilities;
-	
-	public class EastAsianJustifierExample extends Sprite {
-		
-		public function EastAsianJustifierExample():void {
-			
-			var Japanese_txt:String = String.fromCharCode(
-				0x5185, 0x95A3, 0x5E9C, 0x304C, 0x300C, 0x653F, 0x5E9C, 0x30A4,
-				0x30F3, 0x30BF, 0x30FC, 0x30CD, 0x30C3, 0x30C8, 0x30C6, 0x30EC, 
-				0x30D3, 0x300D, 0x306E, 0x52D5, 0x753B, 0x914D, 0x4FE1, 0x5411, 
-				0x3051, 0x306B, 0x30A2, 0x30C9, 0x30D3, 0x30B7, 0x30B9, 0x30C6, 
-				0x30E0, 0x30BA, 0x793E, 0x306E
-			) +
-			"FMS 2" +
-			String.fromCharCode(0x3092, 0x63A1, 0x7528, 0x3059, 0x308B, 0x3068, 
-				0x767a, 0x8868, 0x3057, 0x307e, 0x3057, 0x305F, 0x3002);
-			
-			var textBlock:TextBlock = new TextBlock();
-			var font:FontDescription = new FontDescription();
-			var format:ElementFormat = new ElementFormat();
-			format.fontSize = 12;
-			format.locale = "ja";
-			format.color = 0xCC0000;
-			textBlock.baselineZero = TextBaseline.IDEOGRAPHIC_CENTER;
-			textBlock.textJustifier = new EastAsianJustifier("ja", LineJustification.ALL_INCLUDING_LAST);
-			textBlock.lineRotation = TextRotation.ROTATE_90;
-			var linePosition:Number = this.stage.stageWidth - 75;
-			if (Capabilities.os.search("Mac OS") > -1) 
-				// set fontName: Kozuka Mincho Pro R
-				font.fontName = String.fromCharCode(0x5C0F, 0x585A, 0x660E, 0x671D) + " Pro R"; 					
-			else 
-				font.fontName = "Kozuka Mincho Pro R";
-			textBlock.content = new TextElement(Japanese_txt, format);
-			var previousLine:TextLine = null;
-				
-			while (true) 
-			{
-				var textLine:TextLine = textBlock.createTextLine(previousLine, 320);
-				if (textLine == null) 
-					break;
-				textLine.y = 20;
-				textLine.x = linePosition;
-				linePosition -= 25;
-				addChild(textLine);				
-				previousLine = textLine;
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/ElementFormat.html b/html-docs/flash/text/engine/ElementFormat.html deleted file mode 100644 index 557ee6b..0000000 --- a/html-docs/flash/text/engine/ElementFormat.html +++ /dev/null @@ -1,2301 +0,0 @@ - - - - - - - - -flash.text.engine.ElementFormat (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class ElementFormat
InheritanceElementFormat Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

-

- The ElementFormat class represents formatting information which can be applied to a ContentElement. Use the ElementFormat class - to create specific text formatting for the various subclasses of ContentElement. The properties of the ElementFormat class apply to device and - embedded fonts. -

An ElementFormat object that is applied to a ContentElement in a TextBlock does not invalidate the TextBlock. - Once an ElementFormat has been - applied to a ContentElement, its locked property is set to true. - The properties of a locked ElementFormat object cannot be changed. Instead, use the clone() - method to create an unlocked copy of the object, which can be modified and assigned to the ContentElement.

-

-

-View the examples. -

-

-See also -

-
-ContentElement.elementFormat -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  alignmentBaseline : String -
- Specifies the type of baseline in the containing element to which to align the dominant baselines of elements having - this format.
-		ElementFormat
  alpha : Number -
- Specifies the transparency of the line elements affected by this obect.
-		ElementFormat
  baselineShift : Number -
- Indicates the baseline shift for the element in pixels.
-		ElementFormat
  breakOpportunity : String -
- The line break opportunity applied to this text.
-		ElementFormat
  color : uint -
- Indicates the color of the text.
-		ElementFormat
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  digitCase : String -
- The digit case used for this text.
-		ElementFormat
  digitWidth : String -
- The digit width used for this text.
-		ElementFormat
  dominantBaseline : String -
- Specifies the type of baseline to use as the dominant baseline.
-		ElementFormat
  fontDescription : FontDescription -
- An object whose properties describe a font.
-		ElementFormat
  fontSize : Number -
- The size of text in pixels.
-		ElementFormat
  kerning : String -
- Kerning adjusts the pixels between certain character pairs to improve readability.
-		ElementFormat
  ligatureLevel : String -
- The ligature level used for this text.
-		ElementFormat
  locale : String -
- The locale of the text.
-		ElementFormat
  locked : Boolean -
- Indicates whether the ElementFormat is locked.
-		ElementFormat
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  textRotation : String -
- Sets the rotation applied to individual glyphs.
-		ElementFormat
  trackingLeft : Number -
- The tracking or manual kerning applied to the left of each glyph in pixels.
-		ElementFormat
  trackingRight : Number -
- The tracking or manual kerning applied to the right of each glyph in pixels.
-		ElementFormat
  typographicCase : String -
- The typographic case used for this text.
-		ElementFormat
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ElementFormat(fontDescription:FontDescription = null, fontSize:Number = 12.0, color:uint = 0x000000, alpha:Number = 1.0, textRotation:String = "auto", dominantBaseline:String = "roman", alignmentBaseline:String = "useDominantBaseline", baselineShift:Number = 0.0, kerning:String = "on", trackingRight:Number = 0.0, trackingLeft:Number = 0.0, locale:String = "en", breakOpportunity:String = "auto", digitCase:String = "default", digitWidth:String = "default", ligatureLevel:String = "common", typographicCase:String = "default")
-
- Creates an ElementFormat object.
-		ElementFormat
   -
-clone():ElementFormat -
-
- Constructs an unlocked, cloned copy of the ElementFormat.
-		ElementFormat
   -
-getFontMetrics():FontMetrics -
-
-

Returns a FontMetrics object with properties which describe the emBox, strikethrough position, - strikethrough thickness, underline position, and underline thickness for the font specified by - fontDescription and fontSize.

-
-		ElementFormat
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alignmentBaselineproperty
-
-alignmentBaseline:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the type of baseline in the containing element to which to align the dominant baselines of elements having - this format. Use TextBaseline constants for this property. -

The largest vertical element in the line determines the alignment of baselines unless - TextBlock.baselineFontDescription and TextBlock.baselineFontSize are set to override that logic.

-

The default value is TextBaseline.USE_DOMINANT_BASELINE.

-

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
TextBaseline.ROMANThe dominantBaseline aligns with the roman baseline of the line.
TextBaseline.ASCENTThe dominantBaseline aligns with the ascent baseline of the line.
TextBaseline.DESCENTThe dominantBaseline aligns with the descent baseline of the line.
TextBaseline.IDEOGRAPHIC_TOPThe dominantBaseline aligns with the ideographic top baseline of the line.
TextBaseline.IDEOGRAPHIC_CENTERThe dominantBaseline aligns with the ideographic center baseline of the line.
TextBaseline.IDEOGRAPHIC_BOTTOMThe dominantBaseline aligns with the ideographic bottom baseline of the line.
TextBaseline.USE_DOMINANT_BASELINEThe dominantBaseline aligns with the same baseline of the line.
-

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementSets the alignment baseline of the line to which the dominantBaseline of the graphic element aligns.
GroupElementHas no effect.
TextElementSets the alignment baseline of the line to which the dominantBaseline of the text element aligns.
- Implementation -
-    public function get alignmentBaseline():String -
-    public function set alignmentBaseline(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of TextBaseline. -
 
Error — If set after the ElementFormat object is locked (locked is true). - -
-

-See also -

-
-TextBaseline -
-ElementFormat.dominantBaseline -
-
- - - - - -
alphaproperty 
-
-alpha:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the transparency of the line elements affected by this obect. Valid values range from 0 (fully transparent) - to 1 (fully opaque). Display objects with alpha set to 0 are active, even though they are invisible. -

The default value is 1.

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementApplies the specified alpha to the graphic element. Combines - multiplicatively with any alpha set on the graphic DisplayObject - itself or on the TextLine.
GroupElementHas no effect.
TextElementApplies the specified alpha to the text element. Combines - multiplicatively with any alpha set on the TextLine.
- Implementation -
-    public function get alpha():Number -
-    public function set alpha(value:Number):void -
-
-Throws -
- - - - -
Error — If set after the ElementFormat object is locked (locked is true). - -
-

-See also -

-
-DisplayObject.alpha -
-
- - - - - -
baselineShiftproperty 
-
-baselineShift:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates the baseline shift for the element in pixels. -

The element is shifted away from the dominantBaseline by this amount. - The offset is added to the y position of the members of the element, so in non-rotated - text, a positive baseline shift moves the element down and a negative baseline shift - moves the element up.

-

The default value is 0.0, indicating no shift.

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementShifts the graphic away from the baseline.
GroupElementHas no effect.
TextElementShifts the text away from the baseline.
- Implementation -
-    public function get baselineShift():Number -
-    public function set baselineShift(value:Number):void -
-
-Throws -
- - - - -
Error — If set after the ElementFormat object is locked (locked is true). - -
-
- - - - - -
breakOpportunityproperty 
-
-breakOpportunity:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The line break opportunity applied to this text. - This property determines which characters can be used for breaking when wrapping text is broken into multiple lines. - Use BreakOpportunity - constants for this property. -

The default value is BreakOpportunity.AUTO.

-

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - - - - - -
String valueDescription
BreakOpportunity.AUTOLine breaking opportunities are based on standard Unicode character properties, such as breaking between words and on hyphens.
BreakOpportunity.ANYAny character in the ContentElement object is treated as a line break opportunity. This value is typically used when Roman text is embedded in Asian text and it is desirable for breaks to happen in the middle of words.
BreakOpportunity.NONENo characters in the range are treated as line break opportunities.
BreakOpportunity.ALLAll characters in the range are treated as line break opportunities, meaning that a line break will occur - after each character. Useful for creating effects like text on a path.
-

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementDetermines the break opportunity between adjacent text elements in the group. - If the elementFormat of the group is null, the format of the first - of the adjacent elements is used.
TextElementDetermines the break opportunity between the characters in the text element.
- Implementation -
-    public function get breakOpportunity():String -
-    public function set breakOpportunity(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to a value not a member of BreakOpportunity. -
 
Error — If set after the ElementFormat object is locked (locked is true). - -
-

-See also -

-
-BreakOpportunity -
-
- - - - - -
colorproperty 
-
-color:uint  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates the color of the text. An integer containing three 8-bit RGB components; for example, - 0xFF0000 is red and 0x00FF00 is green. -

The default value is 0x000000, which is black.

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementHas no effect.
TextElementSets the color of the text.
- Implementation -
-    public function get color():uint -
-    public function set color(value:uint):void -
-
-Throws -
- - - - -
Error — If set after the ElementFormat object is locked (locked is true). - -
-
- - - - - -
digitCaseproperty 
-
-digitCase:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The digit case used for this text. - Digit case affects the style and positioning of groups of numeric characters. - Use DigitCase - constants for this property. -

The default value is DigitCase.DEFAULT.

-

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - -
String valueDescription
DigitCase.DEFAULTApplies default digit case to the text.
DigitCase.LININGApplies lining digit case to the text.
DigitCase.OLD_STYLEApplies old style digit case to the text.
-

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementHas no effect.
TextElementDetermines the digit case used for the text in the element.
- Implementation -
-    public function get digitCase():String -
-    public function set digitCase(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of DigitCase. -
 
Error — If set after the ElementFormat object is locked (locked is true). - -
-

-See also -

-
-DigitCase -
-
- - - - - -
digitWidthproperty 
-
-digitWidth:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The digit width used for this text. Use DigitWidth - constants for this property. -

The default value is DigitWidth.DEFAULT.

-

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - -
String valueDescription
DigitWidth.DEFAULTApplies default digit width to the text.
DigitWidth.PROPORTIONALApplies proportional digit width to the text.
DigitWidth.TABULARApplies tabular digit width to the text.
-

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementHas no effect.
TextElementDetermines the digit width used for the text in the element.
- Implementation -
-    public function get digitWidth():String -
-    public function set digitWidth(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of DigitWidth. -
 
Error — If set after the ElementFormat object is locked (locked is true). - -
-

-See also -

-
-DigitWidth -
-
- - - - - -
dominantBaselineproperty 
-
-dominantBaseline:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the type of baseline to use as the dominant baseline. The dominant baseline is aligned - with the alignment baseline to determine the vertical position of the element on the line. - Use TextBaseline constants for this property. -

The content of the element determines the baselines. - In the case of a TextElement, the font and the point size determine the baselines. - In the case of a GraphicElement, the height of the element determines the baselines.

-

The default value is TextBaseline.ROMAN.

-

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
TextBaseline.ROMANThe roman baseline of the element aligns with the alignmentBaseline.
TextBaseline.ASCENTThe ascent baseline of the element aligns with the alignmentBaseline.
TextBaseline.DESCENTThe descent baseline of the element aligns with the alignmentBaseline.
TextBaseline.IDEOGRAPHIC_TOPThe ideographic top baseline of the element aligns with the alignmentBaseline.
TextBaseline.IDEOGRAPHIC_CENTERThe ideographic center baseline of the element aligns with the alignmentBaseline.
TextBaseline.IDEOGRAPHIC_BOTTOMThe ideographic bottom baseline of the element aligns with the alignmentBaseline.
-

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementDetermines which of the baselines of the graphic element aligns with the alignmentBaseline.
GroupElementHas no effect.
TextElementDetermines which of the baselines of the text element aligns with the alignmentBaseline.
- Implementation -
-    public function get dominantBaseline():String -
-    public function set dominantBaseline(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of TextBaseline. -
 
Error — If set after the ElementFormat object is locked (locked is true). - -
-

-See also -

-
-TextBaseline -
-ElementFormat.alignmentBaseline -
-
- - - - - -
fontDescriptionproperty 
-
-fontDescription:FontDescription  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- An object whose properties describe a font. -

The default value is a default-constructed FontDescription object.

-

When the fontDescription property is set, the FontDescription object provided is locked: its locked - property is set to true. A locked FontDescription cannot be modified.

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementHas no effect.
TextElementDetermines the font used for the text in the element.
- Implementation -
-    public function get fontDescription():FontDescription -
-    public function set fontDescription(value:FontDescription):void -
-
-Throws -
- - - - -
Error — If set after the ElementFormat object is locked (locked is true). - -
-

-See also -

-
-FontDescription -
-
- - - - - -
fontSizeproperty 
-
-fontSize:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The size of text in pixels. -

The default value is 12.0.

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementHas no effect.
TextElementDetermines the size in pixels for the text in the element.
- Implementation -
-    public function get fontSize():Number -
-    public function set fontSize(value:Number):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to a value less than zero. -
 
Error — If set after the ElementFormat object is locked (locked is true). - -
-
- - - - - -
kerningproperty 
-
-kerning:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Kerning adjusts the pixels between certain character pairs to improve readability. - Kerning is supported for all fonts which have kerning tables. -

The default value is Kerning.ON.

-

To set values for this property, use the following constants in the Kerning class:

- - - - - - - - - - - - - - - - - -
String valueDescription
Kerning.ONKerning is enabled.
Kerning.OFFKerning is disabled.
Kerning.AUTOKerning is enabled except where inappropriate in Asian typography. Kerning is applied between two - characters if neither is Kanji, Hiragana, or Katakana.
-

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementDetermines whether kerning is applied between adjacent text elements in the group. - If the elementFormat of the group is null, the format of the first - of the adjacent elements is used.
TextElementDetermines whether kerning is applied between the characters in the text element.
- Implementation -
-    public function get kerning():String -
-    public function set kerning(value:String):void -
-
-Throws -
- - - - -
Error — If set after the ElementFormat object is locked (locked is true). -
-

-See also -

-
-Kerning -
-
- - - - - -
ligatureLevelproperty 
-
-ligatureLevel:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The ligature level used for this text. - A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures - usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. - They are used with both Latin and non-Latin character sets. Use LigatureLevel - constants for this property. -

The default value is LigatureLevel.COMMON.

-

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
LigatureLevel.NONENo ligatures are created.
LigatureLevel.MINIMUMMinimal ligatures are created.
LigatureLevel.COMMONCommon ligatures are created.
LigatureLevel.UNCOMMONUncommon ligatures are created.
LigatureLevel.EXOTICExotic ligatures are created.
-

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementDetermines the ligature level between adjacent text elements in the group. - If the elementFormat of the group is null, the format of the first - of the adjacent elements is used.
TextElementDetermines the ligature level between the characters in the text element.
- Implementation -
-    public function get ligatureLevel():String -
-    public function set ligatureLevel(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of LigatureLevel. -
 
Error — If set after the ElementFormat object is locked (locked is true). - -
-

-See also -

-
-LigatureLevel -
-
- - - - - -
localeproperty 
-
-locale:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The locale of the text. Controls case transformations and shaping. - Standard locale identifiers are used. For example "en", "en_US" and "en-US" are all - English, "ja" is Japanese. See iso639-2 code list - for a list of locale codes. -

The default value is "en".

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementHas no effect.
TextElementDetermines transformations and shaping for the text in the element.
- Implementation -
-    public function get locale():String -
-    public function set locale(value:String):void -
-
-Throws -
- - - - -
Error — If set after the ElementFormat object is locked (locked is true). - -
-
- - - - - -
lockedproperty 
-
-locked:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5. -
-

- Indicates whether the ElementFormat is locked. If true the ElementFormat cannot be modified. - Call ElementFormat.clone() to get an unlocked copy of the ElementFormat object. -

Implementation -
-    public function get locked():Boolean -
-    public function set locked(value:Boolean):void -
-
-Throws -
- - - - -
Error — If set after the ElementFormat object is locked (locked is true). - -
-
- - - - - -
textRotationproperty 
-
-textRotation:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Sets the rotation applied to individual glyphs. Use constants defined in the TextRotation class - for this property. -

The default value is TextRotation.AUTO.

-

The final rotation of any glyph is the sum of ElementFormat.textRotation, ContentElement.textRotation, and TextBlock.lineRotation.

-

You typically use this property for Asian text where characters must be rotated to display properly in vertical layout. - Use TextRotation.AUTO in combination with TextBlock.lineRotation = TextRotation.ROTATE_90 - to accomplish this.

-

Setting this property on fonts which do not contain vertical layout information can give undesirable results. - Fonts that contain a vmtx or VORG table, such as the Japanese font, "MS Mincho", work correctly because the - tables supply the data that the layout engine requires for correct layout. Fonts such as Verdana, which do not contain the necessary information, - do not.

-

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
TextRotation.ROTATE_0Glyphs are not rotated.
TextRotation.ROTATE_90Glyphs are rotated 90 degrees clockwise.
TextRotation.ROTATE_180Glyphs are rotated 180 degrees.
TextRotation.ROTATE_270Glyphs are rotated 270 degrees clockwise.
TextRotation.AUTOSpecifies a 90 degree counter clockwise rotation for full width and wide glyphs only, - as determined by the Unicode properties of the glyph. - This value is typically used with Asian text to rotate - only those glyphs that require rotation. - This rotation is applied only in vertical text to return full width and wide - characters to a vertical orientation without affecting other characters.
-

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementHas no effect.
TextElementDetermines the rotation of the glyphs in the text element.
- Implementation -
-    public function get textRotation():String -
-    public function set textRotation(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of TextRotation. -
 
Error — If set after the ElementFormat object is locked (locked is true). - -
-

-See also -

-
-TextRotation -
-ContentElement.textRotation -
-TextBlock.lineRotation -
-
- - - - - -
trackingLeftproperty 
-
-trackingLeft:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5. -
-

- The tracking or manual kerning applied to the left of each glyph in pixels. - If kerning is enabled, the trackingLeft value is added to the values in the - kerning table for the font. If kerning is disabled, the trackingLeft value - is used as a manual kerning value. Supports both positive and negative values. -

Typically, the desired tracking value is split between trackingRight and trackingLeft. - Otherwise, in mixed directionality text, there is twice the tracking at one bidi boundary and none at the other.

-

The default value is 0.0.

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementDetermines the tracking applied to the left side of the graphic.
GroupElementHas no effect.
TextElementDetermines the tracking applied to the left side of characters in the text element.
-

Example:

- 
-	      //positive tracking added to kerning
-	      var ef1:ElementFormat = new ElementFormat();
-	      ef1.kerning = flash.text.engine.Kerning.ON;
-	      ef1.trackingLeft = 0.5;
-	 	      //negative manual kerning
-	      var ef2:ElementFormat = new ElementFormat();
-	      ef2.kerning = flash.text.engine.Kerning.OFF;
-	      ef2.trackingLeft = -1.0;
-
- Implementation -
-    public function get trackingLeft():Number -
-    public function set trackingLeft(value:Number):void -
-
-Throws -
- - - - -
Error — If set after the ElementFormat object is locked (locked is true). - -
-
- - - - - -
trackingRightproperty 
-
-trackingRight:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5. -
-

- The tracking or manual kerning applied to the right of each glyph in pixels. - If kerning is enabled, the trackingRight value is added to the values in the - kerning table for the font. If kerning is disabled, the trackingRight value - is used as a manual kerning value. Supports both positive and negative values. -

Typically, the desired tracking value is split between trackingRight and trackingLeft. - Otherwise, in mixed directionality text, there is twice the tracking at one bidi boundary and none at the other.

-

The default value is 0.0.

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementDetermines the tracking applied to the right side of the graphic.
GroupElementHas no effect.
TextElementDetermines the tracking applied to the right side of characters in the text element.
-

Example:

- 
-	      //positive tracking added to kerning
-	      var ef1:ElementFormat = new ElementFormat();
-	      ef1.kerning = flash.text.engine.Kerning.ON;
-	      ef1.trackingRight = 0.5;
-	 	      //negative manual kerning
-	      var ef2:ElementFormat = new ElementFormat();
-	      ef2.kerning = flash.text.engine.Kerning.OFF;
-	      ef2.trackingRight = -1.0;
-
- Implementation -
-    public function get trackingRight():Number -
-    public function set trackingRight(value:Number):void -
-
-Throws -
- - - - -
Error — If set after the ElementFormat object is locked (locked is true). - -
-
- - - - - -
typographicCaseproperty 
-
-typographicCase:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The typographic case used for this text. Use constants defined in the TypographicCase class for this property. -

The default value is TypographicCase.DEFAULT.

-

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
TypographicCase.DEFAULTSpecifies that normal case is used for all characters.
TypographicCase.TITLESpecifies that uppercase characters use title glyphs on output.
TypographicCase.CAPSSpecifies that spacing is adjusted for uppercase characters on output.
TypographicCase.SMALL_CAPSSpecifies that uppercase characters use small caps glyphs on output.
TypographicCase.UPPERCASESpecifies that all characters use uppercase glyphs on output.
TypographicCase.LOWERCASESpecifies that all characters use lowercase glyphs on output.
TypographicCase.CAPS_AND_SMALL_CAPSSpecifies that all lowercase characters use small caps glyphs on output.
-

- - - - - - - - - - - - - - - - - -
SubclassEffect of setting property
GraphicElementHas no effect.
GroupElementHas no effect.
TextElementDetermines the typographic case used for the text in the element.
- Implementation -
-    public function get typographicCase():String -
-    public function set typographicCase(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to a value not a member of TypographicCase. -
 
Error — If set after the ElementFormat object is locked (locked is true). - -
-

-See also -

-
-TypographicCase -
-
- -
Constructor detail
- - - - - -
ElementFormat()constructor
-
-public function ElementFormat(fontDescription:FontDescription = null, fontSize:Number = 12.0, color:uint = 0x000000, alpha:Number = 1.0, textRotation:String = "auto", dominantBaseline:String = "roman", alignmentBaseline:String = "useDominantBaseline", baselineShift:Number = 0.0, kerning:String = "on", trackingRight:Number = 0.0, trackingLeft:Number = 0.0, locale:String = "en", breakOpportunity:String = "auto", digitCase:String = "default", digitWidth:String = "default", ligatureLevel:String = "common", typographicCase:String = "default") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates an ElementFormat object. -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
fontDescription:FontDescription (default = null) — The FontDescription object which identifies the font used with this element format. - The default value is null. If no font description is provided, a default font description is constructed. -
 
fontSize:Number (default = 12.0) — The size of text in pixels. -
 
color:uint (default = 0x000000) — The color of text. A hexadecimal number containing three 8-bit RGB - components; for example, 0xFF0000 is red and 0x00FF00 is green. -
 
alpha:Number (default = 1.0) — The alpha property applied to all line atoms based on the element format. -
 
textRotation:String (default = "auto") — the rotation applied to individual glyphs. Use TextRotation - constants for this property. -
 
dominantBaseline:String (default = "roman") — The baseline to which the glyphs in the text snap. - Use TextBaseline constants for this property. -
 
alignmentBaseline:String (default = "useDominantBaseline") — The baseline on the containing line to which the dominant baseline snaps. - Use TextBaseline constants for this property. -
 
baselineShift:Number (default = 0.0) — The baseline shift for the text in pixels em. -
 
kerning:String (default = "on") — The kerning used for this text. Use constants defined in the Kerning class. -
 
trackingRight:Number (default = 0.0) — The tracking or manual kerning applied to the right of each glyph in pixels. -
 
trackingLeft:Number (default = 0.0) — The tracking or manual kerning applied to the left of each glyph in pixels. -
 
locale:String (default = "en") — The locale of the text. -
 
breakOpportunity:String (default = "auto") — The line break opportunity applied to this text. Use BreakOpportunity - constants for this property. -
 
digitCase:String (default = "default") — The digit case used for this text. Use DigitCase - constants for this property. -
 
digitWidth:String (default = "default") — The digit width used for this text. Use DigitWidth - constants for this property. -
 
ligatureLevel:String (default = "common") — The ligature level used for this text. Use LigatureLevel - constants for this property. -
 
typographicCase:String (default = "default") — The typographic case used for this text. Use TypographicCase - constants for this property. -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — The fontSize specified is less than 0. -
 
ArgumentError — The textRotation specified is not a member of TextRotation. -
 
ArgumentError — The dominantBaseline specified is not a member of TextBaseline. -
 
ArgumentError — The alignmentBaseline specified is not a member of TextBaseline. -
 
ArgumentError — The kerning specified is not a member of Kerning. -
 
ArgumentError — The breakOpportunity specified is not a member of BreakOpportunity. -
 
ArgumentError — The digitCase specified is not a member of DigitCase. -
 
ArgumentError — The digitWidth specified is not a member of DigitWidth. -
 
ArgumentError — The ligatureLevel specified is not a member of LigatureLevel. -
 
ArgumentError — The typographicCase specified is not a member of TypographicCase. - -
-
- -
Method detail
- - - - - -
clone()method
-
-public function clone():ElementFormat -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Constructs an unlocked, cloned copy of the ElementFormat. -

-Returns - - - - -
ElementFormat — - An unlocked copy of the ElementFormat object. - - - -
-
-Example -
-
-
* @exampleText <p>This example creates an <code>ElementFormat</code> object and sets a <code>FontSize</code>.
-* A new <code>TextElement</code> is created, using the <code>ElementFormat</code> (and therefore locking it), and
-* the <code>TextElement</code> is used as content for a <code>TextBlock</code>. A
-* line of text is created from the <code>TextBlock</code>.</p>
-* <p>To modify the <code>ElementFormat</code> object, first check its
-* <code>locked</code> property. If true, use the <code>clone()</code> method to
-* create an unlocked copy of the <code>ElementFormat</code>, change its properties,
-* then re-link the new <code>ElementFormat</code> to the <code>TextBlock</code>. 
-* When the lines are re-broken, the new lines will have the new font settings.</p>
-*/
-
-package {
-
-    import flash.display.Sprite;
-	import flash.text.engine.*;
-
-	
-	public class ElementFormat_cloneExample extends Sprite {
-		private var ef1:ElementFormat;
-		private var ef2:ElementFormat;
-		
-		public function ElementFormat_cloneExample():void {
-			var fd:FontDescription = new FontDescription();
-			fd.fontLookup = flash.text.engine.FontLookup.DEVICE;
-			fd.fontName = "Palatino";
-
-			var ef1:ElementFormat = new ElementFormat(fd);
-			ef1.fontSize=20;
-			
-			var str:String = "This is flash text 0123456789";
-			var tb:TextBlock = new TextBlock();
-			var te1:TextElement = new TextElement(str, ef1);
-			tb.content = te1;
-			var line1:TextLine = tb.createTextLine(null, 600);
-			addChild(line1);
-			
-			ef2 = (ef1.locked) ? ef1.clone() : ef1;	
-			ef2.fontSize = 32;
-
-			tb.content.elementFormat=ef2;
-			var line2:TextLine = tb.createTextLine(null, 600);
-			addChild(line2);
-			
-		}
-	}	
-}
-
-

-
- - - - - -
getFontMetrics()method 
-
-public function getFontMetrics():FontMetrics -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

Returns a FontMetrics object with properties which describe the emBox, strikethrough position, - strikethrough thickness, underline position, and underline thickness for the font specified by - fontDescription and fontSize.

-

-Returns - - - - -
FontMetrics — - A FontMetrics object describing properties of the font specified by fontDescription. - - - -
-

-See also -

-
-FontDescription -
-FontMetrics -
-
-Example -
This example creates an ElementFormat object with an assigned - FontDescription and uses the getFontMetrics method to - display metrics for the chosen font at 24 points. -
-
-
-package {
-
-    import flash.display.Sprite;
-	import flash.text.engine.*;
-
-	
-	public class FontMetricsExample extends Sprite {
-		
-		public function FontMetricsExample():void {
-			var fd:FontDescription = new FontDescription();
-			fd.fontName = "Garamond";
-			fd.fontWeight = flash.text.engine.FontWeight.BOLD;
-
-			var ef1:ElementFormat = new ElementFormat(fd);
-			ef1.fontSize = 24;			
-			var fm1:FontMetrics = ef1.getFontMetrics();
-
-			trace(fm1.emBox);
-			trace(fm1.strikethroughOffset);
-			trace(fm1.strikethroughThickness);
-			trace(fm1.subscriptScale);
-			trace(fm1.subscriptOffset);
-			trace(fm1.superscriptScale);
-			trace(fm1.superscriptOffset);
-			trace(fm1.underlineOffset);
-			trace(fm1.underlineThickness);
-			
-			
-		}
-	}	
-}
-
-

-
- -
Examples
-
examples\ElementFormatExample
-

This example creates two ElementFormat objects and sets several of - their properties. It then assigns the new ElementFormats to a TextElement object, - which has been assigned as the content of a TextBlock. Note that changing the - ElementFormat of a TextElement does not affect TextLines that - have been previously created by the parent TextBlock.

-
-
-
-package {
-
-    import flash.display.Sprite;
-	import flash.text.engine.*;
-
-	
-	public class ElementFormatExample extends Sprite {
-		
-		public function ElementFormatExample():void {
-			var fd:FontDescription = new FontDescription();
-			fd.fontName = "Garamond";
-			fd.fontWeight = flash.text.engine.FontWeight.BOLD;
-
-			var ef1:ElementFormat = new ElementFormat(fd);
-			ef1.fontSize = 30;
-			ef1.color = 0xFF0000;
-			ef1.alpha = 100;
-			ef1.kerning = flash.text.engine.Kerning.ON;
-			ef1.trackingRight = 2;
-			ef1.typographicCase = flash.text.engine.TypographicCase.UPPERCASE;
-			ef1.alignmentBaseline = flash.text.engine.TextBaseline.DESCENT;
-			ef1.ligatureLevel = flash.text.engine.LigatureLevel.EXOTIC;
-			
-			var ef2:ElementFormat = new ElementFormat(fd);
-			ef2.fontSize = 30;
-			ef2.color = 0xFF0000;
-			ef2.alpha = 0.3;
-			ef2.kerning = flash.text.engine.Kerning.OFF;
-			ef2.typographicCase = flash.text.engine.TypographicCase.LOWERCASE;
-			ef2.digitCase = flash.text.engine.DigitCase.OLD_STYLE;
-			ef2.textRotation = flash.text.engine.TextRotation.ROTATE_180;
-			
-			var str:String = "This is flash text 0123456789";
-			var tb:TextBlock = new TextBlock();
-			var te1:TextElement = new TextElement(str, ef1);
-			tb.content = te1;
-			var line1:TextLine = tb.createTextLine(null, 600);
-			addChild(line1);
-			line1.x = 15;
-			line1.y = 30;
-
-			tb.content.elementFormat = ef2;
-			var line2:TextLine = tb.createTextLine(null, 600);
-			addChild(line2);
-			line2.x = 15;
-			line2.y = 60;
-			
-		}
-	}	
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/FontDescription.html b/html-docs/flash/text/engine/FontDescription.html deleted file mode 100644 index c5ad23f..0000000 --- a/html-docs/flash/text/engine/FontDescription.html +++ /dev/null @@ -1,1563 +0,0 @@ - - - - - - - - -flash.text.engine.FontDescription (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class FontDescription
InheritanceFontDescription Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.5 - -
-

-

- - The FontDescription class represents the information necessary to describe a font. - - -

A FontDescription object is applied to an ElementFormat, - - which is in turn applied to a ContentElement in a TextBlock. Once a FontDescription has been - - applied to an ElementFormat, its locked property is set to true. - - The properties of a locked FontDescription object cannot be changed. Instead, use the clone() - - method to create an unlocked copy of the object, which can be modified and assigned to the ElementFormat.

- - -

Note: FTE (Flash Text Engine) does not support Type 1 fonts or bitmap fonts such as Type 3, - - ATC, sfnt-wrapped CID, or Naked CID.

- - -

-

-View the examples. -

-

-See also -

-
-ElementFormat.fontDescription -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  cffHinting : String -
- - The type of CFF hinting used for this text.
-		FontDescription
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  fontLookup : String -
- - Specifies how the font should be looked up.
-		FontDescription
  fontName : String -
- - The name of the font to use, or a comma-separated list of font names.
-		FontDescription
  fontPosture : String -
- - Specifies the font posture.
-		FontDescription
  fontWeight : String -
- - Specifies the font weight.
-		FontDescription
  locked : Boolean -
- - Indicates whether or not the FontDescription is locked.
-		FontDescription
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  renderingMode : String -
- - The rendering mode used for this text.
-		FontDescription
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-FontDescription(fontName:String = "_serif", fontWeight:String = "normal", fontPosture:String = "normal", fontLookup:String = "device", renderingMode:String = "cff", cffHinting:String = "horizontalStem")
-
- - Creates a FontDescription object.
-		FontDescription
   -
-clone():FontDescription -
-
- - Constructs an unlocked, cloned copy of the FontDescription.
-		FontDescription
   -
-createFromByteArray(fontName:String, fontData:ByteArray, fontWeight:String = "normal", fontPosture:String = "normal"):FontDescription -
-
[static] - - Creates a FontDescription object using font data loaded dynamically from a file.
-		FontDescription
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-isDeviceFontCompatible(fontName:String, fontWeight:String, fontPosture:String):Boolean -
-
[static] - - Returns true if a usable device font is available with the specified fontName, fontWeight, and fontPosture.
-		FontDescription
   -
-isFontCompatible(fontName:String, fontWeight:String, fontPosture:String):Boolean -
-
[static] - - Returns true if an embedded font is available with the specified fontName, fontWeight, and fontPosture - - where Font.fontType is flash.text.FontType.EMBEDDED_CFF.
-		FontDescription
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
cffHintingproperty
-
-cffHinting:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The type of CFF hinting used for this text. Use CFFHinting - - constants for this property. This property applies only if the - - RenderingMode property of the text is set to RenderingMode.CFF. - - -

The type of CFF (Compact Font Format) hinting used determines whether the Flash runtime forces strong horizontal - - stems to fit to a sub-pixel grid or not.

- - -

Applies only to embedded fonts.

- - -

The default value is CFFHinting.HORIZONTAL_STEM.

- - - -

For the CFFHinting property, you can use the following constants from the CFFHinting class:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
CFFHinting.NONESpecifies no CFF hinting. Horizontal stems in the glyphs are not - - forced to the sub-pixel grid. This setting is appropriate for animation or - - for large font sizes.
CFFHinting.HORIZONTAL_STEMSpecifies CFF hinting. Strong horizontal stems are fit to the sub-pixel grid on - - a screen. To use this setting, the - - RenderingMode property must be set to RenderingMode.CFF.
- - - Implementation -
-    public function get cffHinting():String -
-    public function set cffHinting(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of CFFHinting. - -
 
Error — If set after the FontDescription object is locked (locked is true). - - - -
-

-See also -

-
-CFFHinting -
-FontDescription.renderingMode -
-RenderingMode -
-
- - - - - -
fontLookupproperty 
-
-fontLookup:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Specifies how the font should be looked up. - - -

The default value is FontLookup.DEVICE.

- - -

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
FontLookup.DEVICEThe runtime looks up a device font with the specified name - - on the local system with which to render the text.
FontLookup.EMBEDDED_CFFThe runtime looks up an embedded CFF font with the specified name - - with which to render the text. Only fonts of type flash.text.Font.fontType.EMBEDDED_CFF - - are considered. - - If the specified CFF font is not embedded in the application, the runtime attempts - - to use a fallback device font for each glyph. This method is less efficient - - than selecting a device font in the first place.
- - - Implementation -
-    public function get fontLookup():String -
-    public function set fontLookup(value:String):void -
-
-Throws -
- - - - -
Error — If set after the FontDescription object is locked (locked is true). - - -
-

-See also -

-
-CFFHinting -
-FontLookup -
-
- - - - - -
fontNameproperty 
-
-fontName:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The name of the font to use, or a comma-separated list of font names. The runtime renders - - the element with the first available font in the list. For example "Arial, Helvetica, _sans" - - causes the player to search for Arial, then Helvetica, if Arial is not found, then _sans, if neither is found. - - -

Flash runtimes support three generic device font names: _sans (for sans serif fonts), _serif (for serif fonts), - - and _typewriter (for mono-space fonts). These are mapped to specific device fonts depending on the platform.

- - -

The default value is "_serif".

- - -

Flash runtimes provide font fallback for glyphs which are not found in the selected font. - - Whether the font in use is embedded or device, if the glyph is not found in the font, - - the runtime attempts to render it using another device font likely to contain the glyph.

- - - Implementation -
-    public function get fontName():String -
-    public function set fontName(value:String):void -
-
-Throws -
- - - - -
Error — If set after the FontDescription object is locked (locked is true). - - -
-

-See also -

-
-FontLookup -
-
- - - - - -
fontPostureproperty 
-
-fontPosture:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Specifies the font posture. - - - -

The default value is FontPosture.NORMAL.

- - -

To set values for this property, use the following constants from the FontPosture class:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ValueDescription
FontPosture.NORMALNormal font posture.
FontPosture.ITALICItalic font posture.
- - - Implementation -
-    public function get fontPosture():String -
-    public function set fontPosture(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of FontPosture. - -
 
Error — If set after the FontDescription object is locked (locked is true). - - - -
-

-See also -

-
-FontPosture -
-
- - - - - -
fontWeightproperty 
-
-fontWeight:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Specifies the font weight. - - - -

The default value is FontWeight.NORMAL.

- - -

To set values for this property, use the following constants from the FontWeight class:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
FontWeight.NORMALNormal font weight.
FontWeight.BOLDBold font weight.
- - - Implementation -
-    public function get fontWeight():String -
-    public function set fontWeight(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of FontWeight. - -
 
Error — If set after the FontDescription object is locked (locked is true). - - - -
-

-See also -

-
-FontWeight -
-
- - - - - -
lockedproperty 
-
-locked:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5. - -
-

- - Indicates whether or not the FontDescription is locked. If true the FontDescription cannot be modified. - - Call FontDescription.clone() to get an unlocked copy of the FontDescription object. - - -

Implementation -
-    public function get locked():Boolean -
-    public function set locked(value:Boolean):void -
-
-Throws -
- - - - -
Error — If set after the FontDescription object is locked (locked is true). - - - -
-
- - - - - -
renderingModeproperty 
-
-renderingMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - The rendering mode used for this text. Use RenderingMode - - constants for this property. - - -

Applies only to embedded fonts.

- - -

The default value is RenderingMode.CFF.

- - -

To set values for this property, use the following constants from the RenderingMode class:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
RenderingMode.NORMALApplies the regular text rendering, which matches the type of rendering that - - Flash Player 7 and earlier versions used.
RenderingMode.CFFApplies CFF (Compact Font Format) rendering, which makes text more legible. (This feature became - - available in Flash Player 10.) CFF rendering allows for high-quality rendering - - of font faces at small sizes.
- - - Implementation -
-    public function get renderingMode():String -
-    public function set renderingMode(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of RenderingMode. - -
 
Error — If set after the FontDescription object is locked (locked is true). - - - -
-

-See also -

-
-RenderingMode -
-
- -
Constructor detail
- - - - - -
FontDescription()constructor
-
-public function FontDescription(fontName:String = "_serif", fontWeight:String = "normal", fontPosture:String = "normal", fontLookup:String = "device", renderingMode:String = "cff", cffHinting:String = "horizontalStem") -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Creates a FontDescription object. - - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
fontName:String (default = "_serif") — The name of the font to use, or a comma-separated list of font names. - -
 
fontWeight:String (default = "normal") — Specifies the font weight. - -
 
fontPosture:String (default = "normal") — Specifies the font posture. - -
 
fontLookup:String (default = "device") — Specifies how to look up the font. - -
 
renderingMode:String (default = "cff") — The rendering mode used for this text. Use RenderingMode - - constants for this property. - -
 
cffHinting:String (default = "horizontalStem") — The type of CFF (Compact Font Format) hinting used for this text. Use CFFHinting - - constants for this property. - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — The fontWeight specified is not a member of FontWeight. - -
 
ArgumentError — The fontPosture specified is not a member of FontPosture. - -
 
ArgumentError — The fontLookup specified is not a member of FontLookup. - -
 
ArgumentError — The renderingMode specified is not a member of RenderingMode. - -
 
ArgumentError — The cffHinting specified is not a member of CFFHinting. - - - -
-
- -
Method detail
- - - - - -
clone()method
-
-public function clone():FontDescription -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Constructs an unlocked, cloned copy of the FontDescription. - - -

-Returns - - - - -
FontDescription — - An unlocked copy of the FontDescription object. - - - - - -
-
-Example -

This example creates a FontDescription object, assigns - a device font to it, sets various font properties, - and assigns the new object (and therefore locking it) to an ElementFormat object. - A new TextElement is created, using the ElementFormat, and - the TextElement is used as content for a TextBlock. A - line of text is created from the TextBlock.

-

To modify the FontDescription object, first check its - locked property. If true, use the clone() method to - create an unlocked copy of the FontDescription, change its properties, - and assign it to a new ElementFormat object. Then re-link - the new ElementFormat to the TextBlock. - When the lines are re-broken, the new lines will have the new font settings.

-
-
-
-package {
-
-    import flash.display.Sprite;
-	import flash.text.engine.*;
-
-	
-	public class FontDescription_cloneExample extends Sprite {
-		private var fd:FontDescription;
-		private var fd2:FontDescription;
-		
-		public function FontDescription_cloneExample():void {
-			fd = new FontDescription();
-			fd.fontLookup = flash.text.engine.FontLookup.DEVICE;
-			fd.fontName = "Palatino";
-			fd.fontWeight = flash.text.engine.FontWeight.BOLD;
-			fd.fontPosture = flash.text.engine.FontPosture.ITALIC;
-
-			var ef1:ElementFormat = new ElementFormat(fd);
-			
-			var str:String = "This is flash text 0123456789";
-			var tb:TextBlock = new TextBlock();
-			var te1:TextElement = new TextElement(str, ef1);
-			tb.content = te1;
-			var line1:TextLine = tb.createTextLine(null, 600);
-			addChild(line1);
-			
-			fd2 = (fd.locked) ? fd.clone() : fd;	
-			fd2.fontWeight = flash.text.engine.FontWeight.NORMAL;
-			var ef2:ElementFormat = new ElementFormat(fd2);
-
-			tb.content.elementFormat=ef2;
-			var line2:TextLine = tb.createTextLine(null, 600);
-			addChild(line2);
-			
-		}
-	}	
-}
-
-

-
- - - - - -
createFromByteArray()method 
-
-public static function createFromByteArray(fontName:String, fontData:ByteArray, fontWeight:String = "normal", fontPosture:String = "normal"):FontDescription -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Creates a FontDescription object using font data loaded dynamically from a file. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
fontName:String — A string that can be used to identify the font when creating future FontDescription objects - -
 
fontData:ByteArray — A byte array containing the font data you want to use. This should be in OpenType format with CFF outlines. - -
 
fontWeight:String (default = "normal") — Whether the font is bold or not (use FontWeight). Defaults to normal. - -
 
fontPosture:String (default = "normal") — Whether the font is italic or not (use FontPosture). Defaults to normal. - -
-

-Returns - - - - -
FontDescription — - The new FontDescription created from the provided font. - - - - -
-
-Throws - - - - - - - - - - - - - - - - -
ArgumentError — The fontData specified is not in the correct OpenType/CFF format. - -
 
ArgumentError — The fontWeight specified is not a member of FontWeight. - -
 
ArgumentError — The fontPosture specified is not a member of FontPosture. - - -
-
- - - - - -
isDeviceFontCompatible()method 
-
-public static function isDeviceFontCompatible(fontName:String, fontWeight:String, fontPosture:String):Boolean -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 2 - -
-

- - Returns true if a usable device font is available with the specified fontName, fontWeight, and fontPosture. - - -

The flash.text.engine classes can only use OpenType and TrueType device fonts. If a font based on an older font technology is used, - - the runtime falls back to known good device fonts on a glyph-by-glyph basis to render the text

- - - Parameters - - - - - - - - - - - - - - - - -
fontName:String — The name of the device font to check. - -
 
fontWeight:String — Specifies the font weight. Use FontWeight. - -
 
fontPosture:String — Specifies the font posture. Use FontPosture. - -
-

-Returns - - - - -
Boolean — - true if a compatible device font is available, otherwise false. - - - - -
-
-Throws - - - - - - - - - - -
ArgumentError — The fontWeight specified is not a member of FontWeight. - -
 
ArgumentError — The fontPosture specified is not a member of FontPosture. - - - -
-

-See also -

-
-fontLookup -
-TextBlock.createTextLine() -
-FontPosture -
-FontWeight -
-
- - - - - -
isFontCompatible()method 
-
-public static function isFontCompatible(fontName:String, fontWeight:String, fontPosture:String):Boolean -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Returns true if an embedded font is available with the specified fontName, fontWeight, and fontPosture - - where Font.fontType is flash.text.FontType.EMBEDDED_CFF. Starting with Flash Player 10, - - two kinds of embedded fonts can appear in application content. Normal embedded fonts are only used by TextField. - - CFF embedded fonts are only used by the flash.text.engine classes. The two types are distinguised by the - - fontType property of the Font class, as returned by the enumerateFonts() function. - - -

The flash.text.engine classes cannot use a font of type EMBEDDED. If fontLookup is set - - to FontLookup.EMBEDDED_CFF and the only font available at run time with the specified name, weight, and posture is of type - - EMBEDDED, the runtime falls back to device fonts on a glyph-by-glyph basis to render the text, - - as if no embedded font were available with the specified name and style.

- - -

If both EMBEDDED and EMBEDDED_CFF fonts are available with the same name, weight, and posture, the EMBEDDED_CFF - - font is selected and text renders with the EMBEDDED_CFF font.

- - - Parameters - - - - - - - - - - - - - - - - -
fontName:String — The name of the embedded font to check. - -
 
fontWeight:String — Specifies the font weight. Use FontWeight. - -
 
fontPosture:String — Specifies the font posture. Use FontPosture. - -
-

-Returns - - - - -
Boolean — - true if a compatible embedded font is available, otherwise false. - - - - -
-
-Throws - - - - - - - - - - -
ArgumentError — The fontWeight specified is not a member of FontWeight. - -
 
ArgumentError — The fontPosture specified is not a member of FontPosture. - - - -
-

-See also -

-
-fontLookup -
-TextBlock.createTextLine() -
-FontType.EMBEDDED_CFF -
-FontPosture -
-FontWeight -
-
- -
Examples
-
examples\FontDescriptionExample
-

This example creates a FontDescription object, assigns - a device font to it, sets various font properties, - and assigns the new object to an ElementFormat object. - Additional font formatting is done within ElementFormat. A new - TextElement is created, using the ElementFormat, and - the TextElement is used as content for a TextBlock. A - line of text is created from the TextBlock.

-
-
-
-package {
-
-    import flash.display.Sprite;
-	import flash.text.engine.*;
-
-	
-	public class FontDescriptionExample extends Sprite {
-		
-		public function FontDescriptionExample():void {
-			var fd:FontDescription = new FontDescription();
-			fd.fontLookup = flash.text.engine.FontLookup.DEVICE;
-			fd.fontName = "Palatino";
-			fd.fontWeight = flash.text.engine.FontWeight.BOLD;
-			fd.fontPosture = flash.text.engine.FontPosture.ITALIC;
-
-			var ef1:ElementFormat = new ElementFormat(fd);
-			ef1.fontSize = 30;
-			ef1.color = 0xFF0000;
-			
-			var str:String = "This is flash text 0123456789";
-			var tb:TextBlock = new TextBlock();
-			var te1:TextElement = new TextElement(str, ef1);
-			tb.content = te1;
-			var line1:TextLine = tb.createTextLine(null, 600);
-			addChild(line1);
-			
-		}
-	}	
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Mar 21 2024, 10:06 AM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/FontLookup.html b/html-docs/flash/text/engine/FontLookup.html deleted file mode 100644 index 958150f..0000000 --- a/html-docs/flash/text/engine/FontLookup.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - -flash.text.engine.FontLookup (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class FontLookup
InheritanceFontLookup Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The FontLookup class is an enumeration of constant values used with FontDescription.fontLookup. -

-

-See also -

-
-FontDescription.fontLookup -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  DEVICE : String = "device"
[static] - Used to indicate device font lookup.
-		FontLookup
  EMBEDDED_CFF : String = "embeddedCFF"
[static] - Used to indicate embedded CFF (Compact Font Format) font lookup.
-		FontLookup
-
- -
- -
Constant detail
- - - - - -
DEVICEconstant
-
-public static const DEVICE:String = "device" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to indicate device font lookup. - The Flash runtime uses the fonts installed on the system that is running application. -

Using device fonts results in a smaller movie size, because font data - is not included in the file.

-

Text rendered with device fonts is not always displayed the same across different - systems and platforms, because the Flash runtime uses the fonts that are installed on the system.

- -
- - - - - -
EMBEDDED_CFFconstant 
-
-public static const EMBEDDED_CFF:String = "embeddedCFF" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to indicate embedded CFF (Compact Font Format) font lookup. - The Flash runtime uses font outlines embedded in the published application. -

Text rendered with embedded fonts is always displayed - in the chosen font, whether that font is installed - on the playback system or not.

-

One drawback to embedded fonts is that they increase the size of the application.

- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/FontMetrics.html b/html-docs/flash/text/engine/FontMetrics.html deleted file mode 100644 index 47e7c43..0000000 --- a/html-docs/flash/text/engine/FontMetrics.html +++ /dev/null @@ -1,692 +0,0 @@ - - - - - - - - -flash.text.engine.FontMetrics (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class FontMetrics
InheritanceFontMetrics Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

-

- The FontMetrics class contains measurement and offset information about a font. - The ElementFormat.getFontMetrics() method returns objects of this class. -

-

-See also -

-
-ElementFormat.getFontMetrics() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  emBox : Rectangle -
- The emBox value represents the design space of the font and is used to place Chinese, - Korean, or Japanese glyphs relative to the Roman baseline.
-		FontMetrics
  lineGap : Number -
- The lineGap value is the suggested gap between lines.
-		FontMetrics
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  strikethroughOffset : Number -
- The strikethroughOffset value is the suggested vertical offset from the Roman baseline for a strikethrough.
-		FontMetrics
  strikethroughThickness : Number -
- The strikethroughThickness value is the suggested thickness for a strikethrough.
-		FontMetrics
  subscriptOffset : Number -
- The subscriptOffset value is the suggested vertical offset from the Roman baseline for a subscript.
-		FontMetrics
  subscriptScale : Number -
- The subscriptScale value is the suggested scale factor to apply to the point size for a subscript.
-		FontMetrics
  superscriptOffset : Number -
- The superscriptOffset value is the suggested vertical offset from the Roman baseline for a superscript.
-		FontMetrics
  superscriptScale : Number -
- The superscriptScale value is the suggested scale factor to apply to the point size for a superscript.
-		FontMetrics
  underlineOffset : Number -
- The underlineOffset value is the suggested vertical offset from the Roman baseline for an underline.
-		FontMetrics
  underlineThickness : Number -
- The underlineThickness value is the suggested thickness for an underline.
-		FontMetrics
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-FontMetrics(emBox:Rectangle, strikethroughOffset:Number, strikethroughThickness:Number, underlineOffset:Number, underlineThickness:Number, subscriptOffset:Number, subscriptScale:Number, superscriptOffset:Number, superscriptScale:Number, lineGap:Number = 0.0)
-
- Creates a FontMetrics object.
-		FontMetrics
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
emBoxproperty
-
-public var emBox:Rectangle -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The emBox value represents the design space of the font and is used to place Chinese, - Korean, or Japanese glyphs relative to the Roman baseline. - Typically a square, sized to the point size of the font. The origin (coordinate 0,0) - of the emBox is set to the left edge and Roman baseline of the rect. - For example, for a 10-point font, the emBox can be a rect [L,T,R,B] of [0, -8.8, 10, 1.2]. -

- - - - - -
lineGapproperty 
-
-public var lineGap:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- The lineGap value is the suggested gap between lines. -

This value is set by the font designer, and can vary widely from font to font. - In a multi-script font, different line gaps may be suitable for different scripts; - no single value may suffice. Furthermore, different kinds of text usage for a - particular script (for example, whether Japanese text is annotated with ruby or not) - may require different line gaps.

-
- - - - - -
strikethroughOffsetproperty 
-
-public var strikethroughOffset:Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The strikethroughOffset value is the suggested vertical offset from the Roman baseline for a strikethrough. -

Note that depending on the rotation of the line, this value is either added or subtracted from the - position of the line to find the position for the strikethrough. In a line with TextRotation.ROTATE_0, - strikethrough.y = line.y + strikethroughOffset. In a line - with TextRotation.ROTATE_90, strikethrough.x = line.x - strikethroughOffset.

-

When applying decorations such as strikethroughs to a TextLine, the recommended procedure is to specify - an eventMirror on the ContentElement which is to receive the decoration. - In response to the Event.ADDED event, the bounds of the - TextLineMirrorRegion can be used in conjunction - with the strikethroughOffset to place the strikethrough.

-

-See also -

-
-ContentElement.eventMirror -
-TextLineMirrorRegion -
-
- - - - - -
strikethroughThicknessproperty 
-
-public var strikethroughThickness:Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- The strikethroughThickness value is the suggested thickness for a strikethrough. -

- - - - - -
subscriptOffsetproperty 
-
-public var subscriptOffset:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The subscriptOffset value is the suggested vertical offset from the Roman baseline for a subscript. -

The subscriptOffset value is used with ElementFormat.baselineShift to position the subscript.

-

-See also -

-
-ElementFormat.baselineShift -
-
- - - - - -
subscriptScaleproperty 
-
-public var subscriptScale:Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- The subscriptScale value is the suggested scale factor to apply to the point size for a subscript. - A scale factor of 1.0 means no scaling. -

- - - - - -
superscriptOffsetproperty 
-
-public var superscriptOffset:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The superscriptOffset value is the suggested vertical offset from the Roman baseline for a superscript. -

The superscriptOffset value is used with ElementFormat.baselineShift to position the superscript.

-

-See also -

-
-ElementFormat.baselineShift -
-
- - - - - -
superscriptScaleproperty 
-
-public var superscriptScale:Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- The superscriptScale value is the suggested scale factor to apply to the point size for a superscript. - A scale factor of 1.0 means no scaling. -

- - - - - -
underlineOffsetproperty 
-
-public var underlineOffset:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The underlineOffset value is the suggested vertical offset from the Roman baseline for an underline. -

Note that depending on the rotation of the line, this value is either added or subtracted from the - position of the line to find the position for the underline. In a line with TextRotation.ROTATE_0, - underline.y = line.y + underlineOffset. In a line - with TextRotation.ROTATE_90, underline.x = line.x - underlineOffset.

-

When applying decorations such as underlines to a TextLine, the recommended procedure is to specify - an eventMirror on the ContentElement which is to receive the decoration. - In response to the Event.ADDED event, the bounds of the - TextLineMirrorRegion can be used in conjunction - with the underlineOffset to place the underline.

-

-See also -

-
-ContentElement.eventMirror -
-Event -
-TextLineMirrorRegion -
-TextRotation -
-
- - - - - -
underlineThicknessproperty 
-
-public var underlineThickness:Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- The underlineThickness value is the suggested thickness for an underline. -

- -
Constructor detail
- - - - - -
FontMetrics()constructor
-
-public function FontMetrics(emBox:Rectangle, strikethroughOffset:Number, strikethroughThickness:Number, underlineOffset:Number, underlineThickness:Number, subscriptOffset:Number, subscriptScale:Number, superscriptOffset:Number, superscriptScale:Number, lineGap:Number = 0.0) -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a FontMetrics object. The FontMetrics object contains information about - the metrics of a font in an element format. - The flash.text.engine.ElementFormat.getFontMetrics() method returns objects of this class. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
emBox:Rectangle — The emBox of the font in pixels. -
 
strikethroughOffset:Number — The offset for a strikethrough in pixels. -
 
strikethroughThickness:Number — The thickness for a strikethrough in pixels. -
 
underlineOffset:Number — The offset for an underline in pixels. -
 
underlineThickness:Number — The thickness for an underline in pixels. -
 
subscriptOffset:Number — The offset for a subscript in pixels. -
 
subscriptScale:Number — The scale to apply to the point size of a subscript. -
 
superscriptOffset:Number — The offset for a superscript in pixels. -
 
superscriptScale:Number — The scale to apply to the point size of a superscript. -
 
lineGap:Number (default = 0.0)
-

-See also -

-
-ElementFormat.getFontMetrics() -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/FontPosture.html b/html-docs/flash/text/engine/FontPosture.html deleted file mode 100644 index 7e05d30..0000000 --- a/html-docs/flash/text/engine/FontPosture.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - - - - -flash.text.engine.FontPosture (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class FontPosture
InheritanceFontPosture Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The FontPosture class is an enumeration of constant values used with FontDescription.fontPosture to -set text to italic or normal. -

-

-See also -

-
-FontDescription.fontPosture -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  ITALIC : String = "italic"
[static] - Used to indicate italic font posture.
-		FontPosture
  NORMAL : String = "normal"
[static] - Used to indicate normal font posture.
-		FontPosture
-
- -
- -
Constant detail
- - - - - -
ITALICconstant
-
-public static const ITALIC:String = "italic" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to indicate italic font posture. - -

- - - - - -
NORMALconstant 
-
-public static const NORMAL:String = "normal" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to indicate normal font posture. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/FontWeight.html b/html-docs/flash/text/engine/FontWeight.html deleted file mode 100644 index 1237f69..0000000 --- a/html-docs/flash/text/engine/FontWeight.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - - - - -flash.text.engine.FontWeight (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class FontWeight
InheritanceFontWeight Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The FontWeight class is an enumeration of constant values used with FontDescription.fontWeight. -

-

-See also -

-
-flash.text.engine.FontDescription.fontWeight -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  BOLD : String = "bold"
[static] - Used to indicate bold font weight.
-		FontWeight
  NORMAL : String = "normal"
[static] - Used to indicate normal font weight.
-		FontWeight
-
- -
- -
Constant detail
- - - - - -
BOLDconstant
-
-public static const BOLD:String = "bold" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to indicate bold font weight. - -

- - - - - -
NORMALconstant 
-
-public static const NORMAL:String = "normal" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to indicate normal font weight. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/GraphicElement.html b/html-docs/flash/text/engine/GraphicElement.html deleted file mode 100644 index 38061ff..0000000 --- a/html-docs/flash/text/engine/GraphicElement.html +++ /dev/null @@ -1,551 +0,0 @@ - - - - - - - - -flash.text.engine.GraphicElement (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class GraphicElement
InheritanceGraphicElement Inheritance ContentElement Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The GraphicElement class represents a graphic element in a TextBlock or GroupElement object. Assign a GraphicElement object to the - content property of a TextBlock object to display a graphic or an image with TextBlock.createTextLine(). - Assign it to a GroupElement object to combine it with other graphic and text elements. -

-

-View the examples. -

-

-See also -

-
-ContentElement -
-GroupElement -
-TextBlock -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedelementFormat : ElementFormat -
- The ElementFormat object used for the element.
-		ContentElement
  elementHeight : Number -
- The height in pixels to reserve for the graphic in the line.
-		GraphicElement
  elementWidth : Number -
- The width in pixels to reserve for the graphic in the line.
-		GraphicElement
 InheritedeventMirror : EventDispatcher -
- The EventDispatcher object that receives copies of every - event dispatched to valid text lines based on this content element.
-		ContentElement
  graphic : DisplayObject -
- The DisplayObject to be used as a graphic for the GraphicElement.
-		GraphicElement
 InheritedgroupElement : GroupElement -
- The GroupElement object that contains this element, or - null if it is not in a group.
-		ContentElement
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 InheritedrawText : String -
- A copy of the text in the element, including any U+FDEF characters.
-		ContentElement
 Inheritedtext : String -
- A copy of the text in the element, not including any U+FDEF characters, which represent graphic elements in the String.
-		ContentElement
 InheritedtextBlock : TextBlock -
- The TextBlock to which this element belongs.
-		ContentElement
 InheritedtextBlockBeginIndex : int -
- The index in the text block of the first character of this element.
-		ContentElement
 InheritedtextRotation : String -
- The rotation to apply to the element as a unit.
-		ContentElement
 InheriteduserData : * -
- Provides a way for an application to associate arbitrary data with the element.
-		ContentElement
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GraphicElement(graphic:DisplayObject = null, elementWidth:Number = 15.0, elementHeight:Number = 15.0, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
-
- Creates a new GraphicElement instance.
-		GraphicElement
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - -
 ConstantDefined by
 InheritedGRAPHIC_ELEMENT : uint = 0xFDEF
[static] - Indicates the presence of a graphic element in the text.
-		ContentElement
-
- -
- -
Property detail
- - - - - -
elementHeightproperty
-
-elementHeight:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The height in pixels to reserve for the graphic in the line. - It is the responsibility of the caller to scale the graphic. -

The default value is 15.0.

- Implementation -
-    public function get elementHeight():Number -
-    public function set elementHeight(value:Number):void -
-
- - - - - -
elementWidthproperty 
-
-elementWidth:Number  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The width in pixels to reserve for the graphic in the line. - It is the responsibility of the caller to scale the graphic. -

The default value is 15.0.

- Implementation -
-    public function get elementWidth():Number -
-    public function set elementWidth(value:Number):void -
-
- - - - - -
graphicproperty 
-
-graphic:DisplayObject  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The DisplayObject to be used as a graphic for the GraphicElement. -

The default value is null.

-

When the GraphicElement becomes part of a text line, the graphic - is added as a child of the line. Setting the graphic removes - the old graphic from the line and adds the new one.

- - Implementation -
-    public function get graphic():DisplayObject -
-    public function set graphic(value:DisplayObject):void -
-
- -
Constructor detail
- - - - - -
GraphicElement()constructor
-
-public function GraphicElement(graphic:DisplayObject = null, elementWidth:Number = 15.0, elementHeight:Number = 15.0, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new GraphicElement instance. -

The registration point of the graphic aligns with the upper-left corner - of the region defined by elementHeight, elementWidth - and elementFormat.baselineShift. The graphic is not scaled to match the size of the region. - If the GraphicElement has an eventMirror, the elementWidth and elementHeight - properties, and not the graphic, determine the size and position of the resulting mirror region. If a loader - is used, the graphic might not be loaded at the time the text line and the mirror regions are created.

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
graphic:DisplayObject (default = null) — The DisplayObject to populate the GraphicElement. The default value is null. -
 
elementWidth:Number (default = 15.0) — The width of the area reserved for the element in pixels. The default value is 15. -
 
elementHeight:Number (default = 15.0) — The height of the area reserved for the element in pixels. The default value is 15. -
 
elementFormat:ElementFormat (default = null) — The element format for the element. The default value is null. -
 
eventMirror:EventDispatcher (default = null) — The EventDispatcher object that receives copies of every - event dispatched to text lines created based on this content element. The default value is null. -
 
textRotation:String (default = "rotate0") — The rotation applied to the element as a unit. Use flash.text.engine.TextRotation - constants for this property. The default value is flash.text.engine.TextRotation.ROTATE_0. -
-

-See also -

-
-GroupElement -
-
- -
Examples
-
examples\GraphicElementExample
-
The following example creates a TextBlock with a GraphicElement (a red box) and - displays it, adding a second TextBlock beneath it that contains a caption. -
-
-
-package {
-
-    import flash.display.Sprite;
-	import flash.display.MovieClip;
-	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.GraphicElement;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.ElementFormat;
-	import flash.text.engine.FontDescription;
-	
-	public class GraphicElementExample extends Sprite {
-		
-		public function GraphicElementExample():void {
-			
-			var format:ElementFormat = new ElementFormat();
-			format.fontSize = 14;
-			var redBox:MovieClip = new MovieClip();
-			redBox.graphics.beginFill(0xCC0000, 1.0);
-			redBox.graphics.drawRect(0,0, 200, 200);
-			redBox.graphics.endFill();   
-			var graphicElement:GraphicElement = new GraphicElement(redBox,redBox.width,redBox.height, format);
-			var textBlock:TextBlock = new TextBlock();
-			textBlock.content = graphicElement;
-			var textLine1:TextLine = textBlock.createTextLine(null,redBox.width);
-			addChild(textLine1);
-			textLine1.x = 15
-			textLine1.y = 215
-			var str:String = "Your picture here ...";
-			var textElement:TextElement = new TextElement(str, format);
-			textBlock = new TextBlock();
-			textBlock.content = textElement;
-			var textLine2 = textBlock.createTextLine(null, 300);
-			addChild(textLine2);
-			textLine2.x = textLine1.x;
-			textLine2.y += textLine1.y + format.fontSize;		
-		}
-	}	
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/GroupElement.html b/html-docs/flash/text/engine/GroupElement.html deleted file mode 100644 index aadee54..0000000 --- a/html-docs/flash/text/engine/GroupElement.html +++ /dev/null @@ -1,1189 +0,0 @@ - - - - - - - - -flash.text.engine.GroupElement (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class GroupElement
InheritanceGroupElement Inheritance ContentElement Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- A GroupElement object groups a collection of TextElement, GraphicElement, or other GroupElement objects - that you can assign as a unit to the content property of a TextBlock object. A GroupElement - object can also simply share common formatting within another GroupElement object. - -

When a GroupElement contains another GroupElement, the inner GroupElement retains its own formatting (ElementFormat settings). It does - not inherit the formatting of the outer GroupElement.

-

On a GroupElement, most of the format properties have no impact. For this reason, it is legal to create a text line for a GroupElement object - that has a null elementFormat parameter. A few format properties such as kerning and ligature - do affect formatting where intersections occur between members of the group. If the group has a null format, the format of the preceding - element determines the formatting where intersections occur between members of the group.

- -

-

-View the examples. -

-

-See also -

-
-ContentElement -
-GraphicElement -
-TextBlock -
-TextElement -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  elementCount : int -
[read-only] - The number of elements in the group.
-		GroupElement
 InheritedelementFormat : ElementFormat -
- The ElementFormat object used for the element.
-		ContentElement
 InheritedeventMirror : EventDispatcher -
- The EventDispatcher object that receives copies of every - event dispatched to valid text lines based on this content element.
-		ContentElement
 InheritedgroupElement : GroupElement -
- The GroupElement object that contains this element, or - null if it is not in a group.
-		ContentElement
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 InheritedrawText : String -
- A copy of the text in the element, including any U+FDEF characters.
-		ContentElement
 Inheritedtext : String -
- A copy of the text in the element, not including any U+FDEF characters, which represent graphic elements in the String.
-		ContentElement
 InheritedtextBlock : TextBlock -
- The TextBlock to which this element belongs.
-		ContentElement
 InheritedtextBlockBeginIndex : int -
- The index in the text block of the first character of this element.
-		ContentElement
 InheritedtextRotation : String -
- The rotation to apply to the element as a unit.
-		ContentElement
 InheriteduserData : * -
- Provides a way for an application to associate arbitrary data with the element.
-		ContentElement
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
-
- Creates a new GroupElement instance.
-		GroupElement
   -
-getElementAt(index:int):ContentElement -
-
- Retrieves an element from within the group.
-		GroupElement
   -
-getElementAtCharIndex(charIndex:int):ContentElement -
-
- Returns the element containing the character specified by the charIndex parameter.
-		GroupElement
   -
-getElementIndex(element:ContentElement):int -
-
- Returns the index of the element specified by the element parameter.
-		GroupElement
   -
-groupElements(beginIndex:int, endIndex:int):GroupElement -
-
- Replaces the range of elements that the beginIndex and endIndex - parameters specify with a new GroupElement containing those elements.
-		GroupElement
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-mergeTextElements(beginIndex:int, endIndex:int):TextElement -
-
- Merges the text from the range of elements that the beginIndex and endIndex - parameters specify into the element specified by beginIndex without affecting the format of that element.
-		GroupElement
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement>
-
- Replaces the range of elements that the beginIndex and - endIndex parameters specify with the contents - of the newElements parameter.
-		GroupElement
   -
-setElements(value:Vector.<ContentElement>):void -
-
- Sets the elements in the group to the contents of the Vector.
-		GroupElement
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-splitTextElement(elementIndex:int, splitIndex:int):TextElement -
-
- Splits a TextElement into two, creating a new TextElement at the specified position.
-		GroupElement
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-ungroupElements(groupIndex:int):void -
-
- Ungroups the elements in a nested GroupElement that groupIndex specifies within an outer - GroupElement object.
-		GroupElement
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - -
 ConstantDefined by
 InheritedGRAPHIC_ELEMENT : uint = 0xFDEF
[static] - Indicates the presence of a graphic element in the text.
-		ContentElement
-
- -
- -
Property detail
- - - - - -
elementCountproperty
-
-elementCount:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The number of elements in the group. -

Implementation -
-    public function get elementCount():int -
-
- -
Constructor detail
- - - - - -
GroupElement()constructor
-
-public function GroupElement(elements:Vector.<ContentElement> = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new GroupElement instance. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
elements:Vector.<ContentElement> (default = null) — A Vector of ContentElement objects to be contained in the GroupElement. - The Vector can be empty. The default value is null. -
 
elementFormat:ElementFormat (default = null) — The element format for the group. The default value is null. - This format applies to the intersections between elements in the group; those elements do not inherit the format. -
 
eventMirror:EventDispatcher (default = null) — The EventDispatcher object that receives copies of every - event dispatched to text lines created based on this content element. The default value is null. -
 
textRotation:String (default = "rotate0") — The rotation applied to the element as a unit. Use TextRotation constants for - this property. The default value is TextRotation.ROTATE_0. -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — The specified element contains null elements. -
 
ArgumentError — The specified element contains an element that is not a known subclass of ContentElement. -
 
ArgumentError — The specified element contains elements that are specified as the content of a TextBlock. -
 
ArgumentError — The specified element contains elements that are already members of a group, or appear more than once in - the elements. -
-

-See also -

-
-ContentElement -
-ElementFormat -
-flash.events.EventDispatcher -
-TextLineMirrorRegion -
-TextRotation -
-
- -
Method detail
- - - - - -
getElementAt()method
-
-public function getElementAt(index:int):ContentElement -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Retrieves an element from within the group. - -

Parameters - - - - -
index:int — The index of the element to retrieve. -
-

-Returns - - - - -
ContentElement
-
-Throws - - - - -
RangeError — If index is out of range. - -
-
- - - - - -
getElementAtCharIndex()method 
-
-public function getElementAtCharIndex(charIndex:int):ContentElement -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the element containing the character specified by the charIndex parameter. -

Parameters - - - - -
charIndex:int — The zero-based index value for the character whose element you want to find. - A value of 0 corresponds to the first character in the group, not the first character in the TextBlock. -
-

-Returns - - - - -
ContentElement — - The element containing the character at charIndex. - - -
-
-Throws - - - - -
RangeError — If charIndex is not in the range of 0 - rawText.length. - -
-
- - - - - -
getElementIndex()method 
-
-public function getElementIndex(element:ContentElement):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the index of the element specified by the element parameter. -

Parameters - - - - -
element:ContentElement — The element in the group whose index you want to retrieve. -
-

-Returns - - - - -
int — - The index of the element specified by element, or -1 if the element is not in the group. - - - -
-
- - - - - -
groupElements()method 
-
-public function groupElements(beginIndex:int, endIndex:int):GroupElement -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Replaces the range of elements that the beginIndex and endIndex - parameters specify with a new GroupElement containing those elements. - As designed, the elements from beginIndex to endIndex-1 are replaced. -

Parameters - - - - - - - - - - -
beginIndex:int — The zero-based index value for the start position of the range to group. -
 
endIndex:int — The zero-based index value following the end position of the range to group. -
-

-Returns - - - - -
GroupElement — - The new group. - - -
-
-Throws - - - - -
RangeError — If beginIndex or endIndex is out of range. - -
-
- - - - - -
mergeTextElements()method 
-
-public function mergeTextElements(beginIndex:int, endIndex:int):TextElement -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Merges the text from the range of elements that the beginIndex and endIndex - parameters specify into the element specified by beginIndex without affecting the format of that element. - As designed, the text from elements from beginIndex to endIndex-1 are merged. - After their text has been merged, elements from beginIndex+1 to endIndex-1 are removed from the group and orphaned, - with null group properties. -

Parameters - - - - - - - - - - -
beginIndex:int — The zero-based index value for the start position of the range to merge. -
 
endIndex:int — The zero-based index value following the end position of the range to merge. -
-

-Returns - - - - -
TextElement — - The first text element in the range, now containing all the text in the range. - - -
-
-Throws - - - - - - - - - - -
RangeError — If beginIndex or endIndex is out of range. -
 
ArgumentError — If any of the elements in the specified range is not TextElement. -
-

-See also -

-
-TextElement -
-
- - - - - -
replaceElements()method 
-
-public function replaceElements(beginIndex:int, endIndex:int, newElements:Vector.<ContentElement>):Vector.<ContentElement> -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Replaces the range of elements that the beginIndex and - endIndex parameters specify with the contents - of the newElements parameter. - The elements from beginIndex to endIndex-1 are replaced. -

To delete elements, pass null for newElements. - To insert an element, pass the same value for beginIndex and endIndex. - The new element is inserted before the specified index. - To append an element, pass elementCount for beginIndex and endIndex.

-

After the operation, the replaced elements are orphaned, with null group properties and returned.

- Parameters - - - - - - - - - - - - - - - - -
beginIndex:int — The zero-based index value for the start position of the replacement range. -
 
endIndex:int — The zero-based index value following the end position of the replacement range. -
 
newElements:Vector.<ContentElement> — The elements to use to replace the specified range of elements. -
-

-Returns - - - - -
Vector.<ContentElement> — A Vector containing the elements that were replaced. - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
RangeError — The beginIndex or endIndex specified is out of range. -
 
ArgumentError — The newElements specified contain null elements. -
 
ArgumentError — The newElements specified contain this. -
 
ArgumentError — The newElements specified contain elements that are not a known subclass of ContentElement . -
 
ArgumentError — The newElements specified contain elements that are specified as the content of a TextBlock. -
 
ArgumentError — The newElements specified contain elements that are already members of a group or appear - more than once in the elements. -
 
ArgumentError — If the operation would result in nested rotations within the GroupElement. -
-
- - - - - -
setElements()method 
-
-public function setElements(value:Vector.<ContentElement>):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Sets the elements in the group to the contents of the Vector. - -

Parameters - - - - -
value:Vector.<ContentElement>
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — The value specified contains null elements. -
 
ArgumentError — The value specified contains this. -
 
ArgumentError — The value specified contains elements that are not a known subclass of ContentElement . -
 
ArgumentError — The value specified contains elements that are specified as the content of a TextBlock. -
 
ArgumentError — The value specified contains elements that are already members of a group, or appear more than once - in the value. -
 
ArgumentError — If the operation would result in nested rotations within the GroupElement. - -
-
- - - - - -
splitTextElement()method 
-
-public function splitTextElement(elementIndex:int, splitIndex:int):TextElement -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Splits a TextElement into two, creating a new TextElement at the specified position. -

Parameters - - - - - - - - - - -
elementIndex:int — The zero-based index value for the position of the element in the group. -
 
splitIndex:int — The zero-based index value for the character in the TextElement where the split is to occur. - The specified character is the first character in the new TextElement. -
-

-Returns - - - - -
TextElement — - The new text element containing the latter portion of the original text element. - - -
-
-Throws - - - - - - - - - - -
RangeError — If elementIndex or charIndex is out of range. -
 
ArgumentError — If the element at elementIndex is not a TextElement. -
-

-See also -

-
-TextElement -
-
- - - - - -
ungroupElements()method 
-
-public function ungroupElements(groupIndex:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Ungroups the elements in a nested GroupElement that groupIndex specifies within an outer - GroupElement object. After the operation, the ungrouped elements replace the nested GroupElement, which becomes an orphan - with a null group property. -

Parameters - - - - -
groupIndex:int — The zero-based index value for the position of the group to be split. -
-
-Throws - - - - - - - - - - -
RangeError — If groupIndex is out of range. -
 
ArgumentError — If the element at groupIndex is not a GroupElement. - -
-
- -
Examples
-
examples\GroupElementExample
-
This example creates a red box as a GraphicElement object and combines - it with two TextElement objects to create a GroupElement object. It assigns the GroupElement - object to the content property of a TextBlock, from which it creates three lines. -
-
-
-package {
-
-    import flash.display.Sprite;
-	import flash.display.MovieClip;
-	import flash.text.engine.ContentElement;
-	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.GraphicElement;
-	import flash.text.engine.GroupElement;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.ElementFormat;
-	import flash.text.engine.FontDescription;
-	
-	public class GroupElementExample extends Sprite {
-		
-		public function GroupElementExample():void {
-			
-			var redBox:MovieClip = new MovieClip();
-			redBox.graphics.beginFill(0xCC0000, 1.0);
-			redBox.graphics.drawRect(0, 0, 20, 20);
-			redBox.graphics.endFill(); 
-			
-			var format:ElementFormat = new ElementFormat();
-			var fontDescription:FontDescription = new FontDescription("Arial");
-			format.fontSize = 16;
-			format.fontDescription = fontDescription;
-			
-			var str1:String = "This red box is a GraphicElement ";
-			var str2:String = " in the middle of two TextElements, " +
-			" which together make " +
-			"up a GroupElement in a TextBlock that is broken into three lines.";
-			
-			var textElement1:TextElement = new TextElement(str1,format);
-			var graphicElement:GraphicElement = new GraphicElement(redBox,redBox.width,redBox.height, format);
-			var textElement2:TextElement = new TextElement(str2, format);
-			var groupVector:Vector.<ContentElement> = new Vector.<ContentElement>();
-			groupVector.push(textElement1, graphicElement, textElement2);
-			var groupElement = new GroupElement(groupVector);
-			var textBlock:TextBlock = new TextBlock();
-			textBlock.content = groupElement;
-			createTextLines(textBlock);
-		}
-		
-		private function createTextLines(textBlock:TextBlock):void 
-		{
-		
-			var yPos = 20;
-            var line_length:Number = 450;
-            var textLine:TextLine = textBlock.createTextLine (null, line_length);
- 
-            while (textLine)
-            {
-                addChild(textLine);
-                textLine.x = 15;
-                yPos += textLine.height+8;
-                textLine.y = yPos;
-                textLine = textBlock.createTextLine(textLine, line_length);
-            }
-		}
-	}	
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/JustificationStyle.html b/html-docs/flash/text/engine/JustificationStyle.html deleted file mode 100644 index d95626c..0000000 --- a/html-docs/flash/text/engine/JustificationStyle.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - - - - -flash.text.engine.JustificationStyle (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class JustificationStyle
InheritanceJustificationStyle Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The JustificationStyle class is an enumeration of constant values for setting the justificationStyle property -of the EastAsianJustifier class. These constants specify options for handling kinsoku characters, which are Japanese characters that cannot -appear at either the beginning or end of a line. - -

-

-See also -

-
-EastAsianJustifier.justificationStyle -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  PRIORITIZE_LEAST_ADJUSTMENT : String = "prioritizeLeastAdjustment"
[static] - Bases justification on either expanding or compressing - the line, whichever gives a result closest to the desired width.
-		JustificationStyle
  PUSH_IN_KINSOKU : String = "pushInKinsoku"
[static] - Bases justification on compressing kinsoku at the end of the line, - or expanding it if no kinsoku occurs or if that space is insufficient.
-		JustificationStyle
  PUSH_OUT_ONLY : String = "pushOutOnly"
[static] - Bases justification on expanding the line.
-		JustificationStyle
-
- -
- -
Constant detail
- - - - - -
PRIORITIZE_LEAST_ADJUSTMENTconstant
-
-public static const PRIORITIZE_LEAST_ADJUSTMENT:String = "prioritizeLeastAdjustment" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Bases justification on either expanding or compressing - the line, whichever gives a result closest to the desired width. - -

- - - - - -
PUSH_IN_KINSOKUconstant 
-
-public static const PUSH_IN_KINSOKU:String = "pushInKinsoku" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Bases justification on compressing kinsoku at the end of the line, - or expanding it if no kinsoku occurs or if that space is insufficient. - -

- - - - - -
PUSH_OUT_ONLYconstant 
-
-public static const PUSH_OUT_ONLY:String = "pushOutOnly" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Bases justification on expanding the line. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/Kerning.html b/html-docs/flash/text/engine/Kerning.html deleted file mode 100644 index 461b65d..0000000 --- a/html-docs/flash/text/engine/Kerning.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - - - -flash.text.engine.Kerning (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class Kerning
InheritanceKerning Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-

-The Kerning class is an enumeration of constant values used with ElementFormat.kerning. - -

-

-See also -

-
-ElementFormat.kerning -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  AUTO : String = "auto"
[static] - Used to indicate that kerning is enabled except where inappropriate in Asian typography.
-		Kerning
  OFF : String = "off"
[static] - Used to indicate kerning is disabled.
-		Kerning
  ON : String = "on"
[static] - Used to indicate kerning is enabled.
-		Kerning
-
- -
- -
Constant detail
- - - - - -
AUTOconstant
-
-public static const AUTO:String = "auto" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to indicate that kerning is enabled except where inappropriate in Asian typography. Kerning is - applied between two characters if neither is Kanji, Hiragana, or Katakana. - -

- - - - - -
OFFconstant 
-
-public static const OFF:String = "off" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to indicate kerning is disabled. - -

- - - - - -
ONconstant 
-
-public static const ON:String = "on" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to indicate kerning is enabled. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/LigatureLevel.html b/html-docs/flash/text/engine/LigatureLevel.html deleted file mode 100644 index a002d1d..0000000 --- a/html-docs/flash/text/engine/LigatureLevel.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - - - -flash.text.engine.LigatureLevel (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class LigatureLevel
InheritanceLigatureLevel Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The LigatureLevel class is an enumeration of constant values used in setting the ligatureLevel property -of the ElementFormat class. A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures -usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. -They are used with both Latin and Non-Latin character sets. -

Note: When working with Arabic or Syriac fonts, ligatureLevel must be set to MINIMUM or above.

- -

-

-See also -

-
-ElementFormat.ligatureLevel -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  COMMON : String = "common"
[static] - Used to specify common ligatures.
-		LigatureLevel
  EXOTIC : String = "exotic"
[static] - Used to specify exotic ligatures.
-		LigatureLevel
  MINIMUM : String = "minimum"
[static] - Used to specify minimum ligatures.
-		LigatureLevel
  NONE : String = "none"
[static] - Used to specify no ligatures.
-		LigatureLevel
  UNCOMMON : String = "uncommon"
[static] - Used to specify uncommon ligatures.
-		LigatureLevel
-
- -
- -
Constant detail
- - - - - -
COMMONconstant
-
-public static const COMMON:String = "common" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify common ligatures. - -

- - - - - -
EXOTICconstant 
-
-public static const EXOTIC:String = "exotic" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify exotic ligatures. - -

- - - - - -
MINIMUMconstant 
-
-public static const MINIMUM:String = "minimum" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify minimum ligatures. - -

- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify no ligatures. - -

- - - - - -
UNCOMMONconstant 
-
-public static const UNCOMMON:String = "uncommon" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify uncommon ligatures. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/LineJustification.html b/html-docs/flash/text/engine/LineJustification.html deleted file mode 100644 index 4b0e2c1..0000000 --- a/html-docs/flash/text/engine/LineJustification.html +++ /dev/null @@ -1,342 +0,0 @@ - - - - - - - - -flash.text.engine.LineJustification (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class LineJustification
InheritanceLineJustification Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The LineJustification class is an enumeration of constant values used in setting the lineJustfication property -of the TextJustifier subclasses. -

-

-See also -

-
-TextJustifier.lineJustification -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  ALL_BUT_LAST : String = "allButLast"
[static] - Justify all but the last line.
-		LineJustification
  ALL_BUT_MANDATORY_BREAK : String = "allButMandatoryBreak"
[static] - Justify all but the last line and lines ending in mandatory breaks.
-		LineJustification
  ALL_INCLUDING_LAST : String = "allIncludingLast"
[static] - Justify all lines.
-		LineJustification
  UNJUSTIFIED : String = "unjustified"
[static] - Do not justify lines.
-		LineJustification
-
- -
- -
Constant detail
- - - - - -
ALL_BUT_LASTconstant
-
-public static const ALL_BUT_LAST:String = "allButLast" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Justify all but the last line. - -

- - - - - -
ALL_BUT_MANDATORY_BREAKconstant 
-
-public static const ALL_BUT_MANDATORY_BREAK:String = "allButMandatoryBreak" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Justify all but the last line and lines ending in mandatory breaks. - -

- - - - - -
ALL_INCLUDING_LASTconstant 
-
-public static const ALL_INCLUDING_LAST:String = "allIncludingLast" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Justify all lines. - -

- - - - - -
UNJUSTIFIEDconstant 
-
-public static const UNJUSTIFIED:String = "unjustified" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Do not justify lines. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/RenderingMode.html b/html-docs/flash/text/engine/RenderingMode.html deleted file mode 100644 index 04eae27..0000000 --- a/html-docs/flash/text/engine/RenderingMode.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - - - -flash.text.engine.RenderingMode (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class RenderingMode
InheritanceRenderingMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The RenderingMode class provides values for rendering mode in the FontDescription class. -

-

-See also -

-
-FontDescription -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  CFF : String = "cff"
[static] - Sets rendering mode to CFF (Compact Font Format).
-		RenderingMode
  NORMAL : String = "normal"
[static] - Sets rendering mode to the rendering mode that is used in Flash Player 7 and earlier.
-		RenderingMode
-
- -
- -
Constant detail
- - - - - -
CFFconstant
-
-public static const CFF:String = "cff" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Sets rendering mode to CFF (Compact Font Format). CFF rendering improves readability of text on a display. - This setting is recommended for applications that have a lot of small text. - This constant is used for the renderingMode property in the FontDescription - class. - Use the syntax RenderingMode.CFF. - -

-See also -

-
-flash.text.engine.FontDescription.renderingMode -
-
- - - - - -
NORMALconstant 
-
-public static const NORMAL:String = "normal" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Sets rendering mode to the rendering mode that is used in Flash Player 7 and earlier. - This setting is recommended for animated text. - This constant is used for the renderingMode property in the FontDescription - class. - Use the syntax RenderingMode.NORMAL. -

-See also -

-
-flash.text.engine.FontDescription.renderingMode -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/SpaceJustifier.html b/html-docs/flash/text/engine/SpaceJustifier.html deleted file mode 100644 index 3582067..0000000 --- a/html-docs/flash/text/engine/SpaceJustifier.html +++ /dev/null @@ -1,601 +0,0 @@ - - - - - - - - -flash.text.engine.SpaceJustifier (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class SpaceJustifier
InheritanceSpaceJustifier Inheritance TextJustifier Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

-

- The SpaceJustifier class represents properties that control the justification options for text lines in a text block. -

Use the constructor new SpaceJustifier() to create a SpaceJustifier object before setting its properties. - Setting the properties of a SpaceJustifier object after you apply it to a TextBlock does not invalidate the TextBlock.

-

-

-View the examples. -

-

-See also -

-
-LineJustification -
-TextBlock.textJustifier -
-TextJustifier -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  letterSpacing : Boolean -
- Specifies whether to use letter spacing during justification.
-		SpaceJustifier
 InheritedlineJustification : String -
- Specifies the line justification for the text in a text block.
-		TextJustifier
 Inheritedlocale : String -
- Specifies the locale to determine the justification rules for the text in a text block.
-		TextJustifier
  maximumSpacing : Number -
- Specifies the maximum spacing (as a multiplier of the width of a normal space) between words to use during justification.
-		SpaceJustifier
  minimumSpacing : Number -
- Specifies the minimum spacing (as a multiplier of the width of a normal space) between words to use during justification.
-		SpaceJustifier
  optimumSpacing : Number -
- Specifies the optimum spacing (as a multiplier of the width of a normal space) between words to use during justification.
-		SpaceJustifier
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-SpaceJustifier(locale:String = "en", lineJustification:String = "unjustified", letterSpacing:Boolean = false)
-
- Creates a SpaceJustifier object.
-		SpaceJustifier
   -
-clone():TextJustifier -
-
- Constructs a cloned copy of the SpaceJustifier.
-		SpaceJustifier
 Inherited -
-getJustifierForLocale(locale:String):TextJustifier -
-
[static] - Constructs a default TextJustifier subclass appropriate to the specified locale.
-		TextJustifier
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
letterSpacingproperty
-
-letterSpacing:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies whether to use letter spacing during justification. -

The default value is false

- Implementation -
-    public function get letterSpacing():Boolean -
-    public function set letterSpacing(value:Boolean):void -
-
- - - - - -
maximumSpacingproperty 
-
-maximumSpacing:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the maximum spacing (as a multiplier of the width of a normal space) between words to use during justification. - If letterSpacing is true, letter spacing will be used after the spaces between words reach the maximum. - If letterSpacing is false, the spaces between words will be expanded beyond the maximum. -

The default value is 1.5

- Implementation -
-    public function get maximumSpacing():Number -
-    public function set maximumSpacing(value:Number):void -
-
-Throws -
- - - - -
ArgumentError — The value specified is less than optimumSpacing. - -
-
- - - - - -
minimumSpacingproperty 
-
-minimumSpacing:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the minimum spacing (as a multiplier of the width of a normal space) between words to use during justification. -

The default value is 0.5

- Implementation -
-    public function get minimumSpacing():Number -
-    public function set minimumSpacing(value:Number):void -
-
-Throws -
- - - - -
ArgumentError — The value specified is less than zero or greater than optimumSpacing. - -
-
- - - - - -
optimumSpacingproperty 
-
-optimumSpacing:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies the optimum spacing (as a multiplier of the width of a normal space) between words to use during justification. -

The default value is 1.0

- Implementation -
-    public function get optimumSpacing():Number -
-    public function set optimumSpacing(value:Number):void -
-
-Throws -
- - - - -
ArgumentError — The value specified is less than minimumSpacing or greater than maximumSpacing. - -
-
- -
Constructor detail
- - - - - -
SpaceJustifier()constructor
-
-public function SpaceJustifier(locale:String = "en", lineJustification:String = "unjustified", letterSpacing:Boolean = false) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a SpaceJustifier object. The LineJustification class contains constants for specifying the types of - line justification that you can apply. -

Parameters - - - - - - - - - - - - - - - - -
locale:String (default = "en") — The locale to determine the justification rules. - The default value is "en". -
 
lineJustification:String (default = "unjustified") — The type of line justification for the paragraph. - Use LineJustification constants for this property. - The default value is LineJustification.UNJUSTIFIED. -
 
letterSpacing:Boolean (default = false) — Specifies whether to use letter spacing during justification. - The default value is false. -
-
-Throws - - - - - - - - - - -
ArgumentError — The locale specified is null or too short to represent a valid locale. -
 
ArgumentError — The lineJustification specified is not a member of LineJustification. - -
-

-See also -

-
-LineJustification -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():TextJustifier -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Constructs a cloned copy of the SpaceJustifier. - -

-Returns - - - - -
TextJustifier — - A copy of the SpaceJustifier object. - - - -
-
- -
Examples
-
examples\SpaceJustifierExample
-
The following example uses letter spacing and justifies all of a block of text - except for the last line. -
-
-
-package {
-    import flash.display.Sprite;
-	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.ElementFormat;
-	import flash.text.engine.SpaceJustifier;
-	import flash.text.engine.LineJustification;
-	
-	public class SpaceJustifierExample extends Sprite {
-		
-		public function SpaceJustifierExample():void {
-			var str:String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, " +
-			"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut " +
-			"enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut " +
-			"aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit " +
-			"in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur " +
-			"sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt " +
-			"mollit anim id est laborum.";
-			
-			var format:ElementFormat = new ElementFormat(null, 12, 0xCC0000);
-			var textElement:TextElement = new TextElement(str, format);
-			var spaceJustifier:SpaceJustifier = new SpaceJustifier("en", LineJustification.ALL_BUT_LAST);
-			spaceJustifier.letterSpacing = true;
-			var textBlock:TextBlock = new TextBlock();
-			textBlock.content = textElement;
-			textBlock.textJustifier = spaceJustifier;
-			createLines(textBlock);
-		}
-		
-		private function createLines(textBlock:TextBlock):void {
-        
-            var yPos = 20;
-            var textLine:TextLine = textBlock.createTextLine (null, 150);
- 
-            while (textLine)
-            {
-                addChild(textLine);
-                textLine.x = 15;
-                yPos += textLine.textHeight+2;
-                textLine.y = yPos;
-                textLine = textBlock.createTextLine(textLine, 150);
-            }        
-        }
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TabAlignment.html b/html-docs/flash/text/engine/TabAlignment.html deleted file mode 100644 index d0e00ca..0000000 --- a/html-docs/flash/text/engine/TabAlignment.html +++ /dev/null @@ -1,352 +0,0 @@ - - - - - - - - -flash.text.engine.TabAlignment (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TabAlignment
InheritanceTabAlignment Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The TabAlignment class is an enumeration of constant values that you can use to set the tabAlignment property -of the TabStop class. - -

-

-See also -

-
-TabStop.alignment -
-TextBlock.tabStops -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  CENTER : String = "center"
[static] - Positions the center of the tabbed text at the tab stop.
-		TabAlignment
  DECIMAL : String = "decimal"
[static] - Positions the alignment token of the tabbed text at the tab stop.
-		TabAlignment
  END : String = "end"
[static] - Positions the end of the tabbed text at the tab stop.
-		TabAlignment
  START : String = "start"
[static] - Positions the start of the tabbed text at the tab stop.
-		TabAlignment
-
- -
- -
Constant detail
- - - - - -
CENTERconstant
-
-public static const CENTER:String = "center" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Positions the center of the tabbed text at the tab stop. - -

- - - - - -
DECIMALconstant 
-
-public static const DECIMAL:String = "decimal" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Positions the alignment token of the tabbed text at the tab stop. - -

-See also -

-
-TabStop.decimalAlignmentToken -
-
- - - - - -
ENDconstant 
-
-public static const END:String = "end" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Positions the end of the tabbed text at the tab stop. - -

- - - - - -
STARTconstant 
-
-public static const START:String = "start" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Positions the start of the tabbed text at the tab stop. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TabStop.html b/html-docs/flash/text/engine/TabStop.html deleted file mode 100644 index b9b8c81..0000000 --- a/html-docs/flash/text/engine/TabStop.html +++ /dev/null @@ -1,519 +0,0 @@ - - - - - - - - -flash.text.engine.TabStop (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TabStop
InheritanceTabStop Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

-

- The TabStop class represents the properties of a tab stop in a text block. You assign tab stops as a Vector of TabStop objects - to the TextBlock.tabStops property. -

Setting the properties of a TabStop object after you apply it to a TextBlock does not invalidate the TextBlock.

-

-

-View the examples. -

-

-See also -

-
-TextBlock.tabStops -
-TabAlignment -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  alignment : String -
- Specifies the tab alignment for this tab stop.
-		TabStop
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  decimalAlignmentToken : String -
- Specifies the alignment token to use when you set the alignment property to TabAlignment.DECIMAL.
-		TabStop
  position : Number -
- The position of the tab stop, in pixels, relative to the start of the text line.
-		TabStop
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TabStop(alignment:String = "start", position:Number = 0.0, decimalAlignmentToken:String = "")
-
- Creates a new TabStop.
-		TabStop
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
alignmentproperty
-
-alignment:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the tab alignment for this tab stop. Use the constants in the TabAlignment class to - set this property. -

The default value is TabAlignment.START.

-

Use the lineOffset argument to TextBlock.createTextLine() - to adjust the tabs if the origin of the line does not align with other lines that - share the same tab stops.

-

Use the following constants from the TabAlignment class to set the value for this property:

- - - - - - - - - - - - - - - - - - - - - -
String valueDescription
TabAlignment.STARTThe position property specifies the number of pixels that the start of the tabbed text is from the start of the text line.
TabAlignment.CENTERThe position property specifies the number of pixels that the center of the tabbed text is from the start of the text line.
TabAlignment.ENDThe position property specifies the number of pixels that the end of the tabbed text is from the start of the text line.
TabAlignment.DECIMALThe position property specifies the number of pixels that the alignment token is from the start of the text line.
- Implementation -
-    public function get alignment():String -
-    public function set alignment(value:String):void -
-
-Throws -
- - - - -
ArgumentError — If set to any value that is not a member of TabAlignment. - -
-

-See also -

-
-TabAlignment -
-TextBlock.createTextLine() -
-
- - - - - -
decimalAlignmentTokenproperty 
-
-decimalAlignmentToken:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the alignment token to use when you set the alignment property to TabAlignment.DECIMAL. The value - is a String that occurs in the text line. -

The default value is "".

- Implementation -
-    public function get decimalAlignmentToken():String -
-    public function set decimalAlignmentToken(value:String):void -
-

-See also -

-
-TabAlignment.DECIMAL -
-
- - - - - -
positionproperty 
-
-position:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The position of the tab stop, in pixels, relative to the start of the text line. -

The default value is 0.0.

- Implementation -
-    public function get position():Number -
-    public function set position(value:Number):void -
-
-Throws -
- - - - -
ArgumentError — If set to a value less than 0.0. - -
-
- -
Constructor detail
- - - - - -
TabStop()constructor
-
-public function TabStop(alignment:String = "start", position:Number = 0.0, decimalAlignmentToken:String = "") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new TabStop. -

Parameters - - - - - - - - - - - - - - - - -
alignment:String (default = "start") — The tab alignment type of this tab stop. - Valid values for this property are found in the members of the TabAlignment class. - The default value is TabAlignment.START. -
 
position:Number (default = 0.0) — The position of the tab stop, in pixels. - The default value is 0.0. -
 
decimalAlignmentToken:String (default = "") — The alignment token to be used if the alignment is TabAlignment.DECIMAL, - The default value is "". -
-
-Throws - - - - -
ArgumentError — The alignment specified is not a member of TabAlignment. - -
-

-See also -

-
-TabAlignment -
-
- -
Examples
-
examples\TabStopExample
-
This example illustrates the effects of the four tab stop alignment settings - START, - CENTER, DECIMAL, and END. -
-
-package {
-    
-	import flash.text.engine.*;
-	import flash.display.Sprite;
-	
-	public class TabStopExample extends Sprite {
-		
-		public function TabStopExample():void {
-			var container:Sprite = new Sprite(); 
-			
-			var english:ElementFormat = new ElementFormat(); 
-			english.fontDescription = new FontDescription("Arial"); 
-			english.fontSize = 16;
-			english.locale = "en"; 
-			
-			var tabStops:Vector.<TabStop> = new Vector.<TabStop>();	
-			tabStops.push(
-				new TabStop(TabAlignment.START, 20),
-				new TabStop(TabAlignment.CENTER, 120),
-				new TabStop(TabAlignment.DECIMAL, 220, "."),
-				new TabStop(TabAlignment.END, 320)
-			); 
-	
-			var textBlock:TextBlock = new TextBlock();
-			textBlock.content = new TextElement(
-				"\tstart\tcenter\tdeci.mal\tend\n" +		
-				"\tl\tl\t3.4\tl\n" +
-				"\tlm\tlm\t234.56\tlm\n" +
-				"\tlmn\tlmn\t12345678.34567\tlmn\n"
-				, english); 
-			textBlock.tabStops = tabStops;
-			var y:Number = 60;
-			var previousTextLine:TextLine = null; 
-			var textLine:TextLine;
-			var i:int;
-			var tabOrigin:Number = 100;
-			for (i = 0; i < 4; i++) {
-				textLine = textBlock.createTextLine(previousTextLine, 1000, 0); 
-				textLine.x = 20;
-				textLine.y = y; 
-				
-				container.addChild(textLine); 	
-				
-				y += 25; 
-				previousTextLine = textLine; 
-			}
-			addChild(container);		
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TextBaseline.html b/html-docs/flash/text/engine/TextBaseline.html deleted file mode 100644 index f137b94..0000000 --- a/html-docs/flash/text/engine/TextBaseline.html +++ /dev/null @@ -1,531 +0,0 @@ - - - - - - - - -flash.text.engine.TextBaseline (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TextBaseline
InheritanceTextBaseline Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The TextBaseline class is an enumeration of constant values to use in setting the dominantBaseline and -alignmentBaseline properties of the ElementFormat class. You can also use it in the -baselineZero property of the TextBlock class. -Consider this situation: -

Text baseline alignment

-

The line consists of four TextElement objects, containing 'a', 'b', 'cccccccc', and 'X' respectively. -The element containing 'X' determines the line baselines because it is the largest element in the line. -The roman baseline of the 'X' element is aligned with the roman baseline of the line. -The ideographic top of the 'a' element is aligned with the ideographic top of the line. -The ideographic bottom of the 'b' element is aligned with the ideographic bottom of the line. -The ideographic center of the 'cccccccc' element is aligned with the ideographic center of the line.

- -

-

-See also -

-
-ElementFormat.dominantBaseline -
-ElementFormat.alignmentBaseline -
-TextBlock.baselineZero -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ASCENT : String = "ascent"
[static] - Specifies an ascent baseline.
-		TextBaseline
  DESCENT : String = "descent"
[static] - Specifies a descent baseline.
-		TextBaseline
  IDEOGRAPHIC_BOTTOM : String = "ideographicBottom"
[static] - Specifies an ideographic bottom baseline.
-		TextBaseline
  IDEOGRAPHIC_CENTER : String = "ideographicCenter"
[static] - Specifies an ideographic center baseline.
-		TextBaseline
  IDEOGRAPHIC_TOP : String = "ideographicTop"
[static] - Specifies an ideographic top baseline.
-		TextBaseline
  ROMAN : String = "roman"
[static] - Specifies a roman baseline.
-		TextBaseline
  USE_DOMINANT_BASELINE : String = "useDominantBaseline"
[static] - Specifies that the alignmentBaseline is the same as the dominantBaseline.
-		TextBaseline
-
- -
- -
Constant detail
- - - - - -
ASCENTconstant
-
-public static const ASCENT:String = "ascent" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies an ascent baseline. - For a text element, the font and point size of the text determine this value. - For a graphic element, the text engine uses the geometric top of the element. - -

-See also -

-
-ElementFormat.dominantBaseline -
-ElementFormat.alignmentBaseline -
-TextBlock.baselineZero -
-
- - - - - -
DESCENTconstant 
-
-public static const DESCENT:String = "descent" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a descent baseline. - For a text element, the font and point size of the text determine this value. - For a graphic element, the text element uses the geometric bottom of the element. - -

-See also -

-
-ElementFormat.dominantBaseline -
-ElementFormat.alignmentBaseline -
-TextBlock.baselineZero -
-
- - - - - -
IDEOGRAPHIC_BOTTOMconstant 
-
-public static const IDEOGRAPHIC_BOTTOM:String = "ideographicBottom" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies an ideographic bottom baseline. - For a text element, the font and point size of the text determine this value. - For a graphic element, the text engine uses the geometric bottom of the element. - -

-See also -

-
-ElementFormat.dominantBaseline -
-ElementFormat.alignmentBaseline -
-TextBlock.baselineZero -
-
- - - - - -
IDEOGRAPHIC_CENTERconstant 
-
-public static const IDEOGRAPHIC_CENTER:String = "ideographicCenter" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies an ideographic center baseline. - For a text element, the font and point size of the text determine this value. - For a graphic element, the text engine uses the geometric center of the element. - -

-See also -

-
-ElementFormat.dominantBaseline -
-ElementFormat.alignmentBaseline -
-TextBlock.baselineZero -
-
- - - - - -
IDEOGRAPHIC_TOPconstant 
-
-public static const IDEOGRAPHIC_TOP:String = "ideographicTop" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies an ideographic top baseline. - For a text element, the font and point size of the text determine this value. - For a graphic element, the text engine uses the geometric top of the element. - -

-See also -

-
-ElementFormat.dominantBaseline -
-ElementFormat.alignmentBaseline -
-TextBlock.baselineZero -
-
- - - - - -
ROMANconstant 
-
-public static const ROMAN:String = "roman" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a roman baseline. - For a text element, the font and point size of the text determine this value. - For a graphic element, the text engine uses the geometric bottom of the element. - -

-See also -

-
-ElementFormat.dominantBaseline -
-ElementFormat.alignmentBaseline -
-TextBlock.baselineZero -
-
- - - - - -
USE_DOMINANT_BASELINEconstant 
-
-public static const USE_DOMINANT_BASELINE:String = "useDominantBaseline" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that the alignmentBaseline is the same as the dominantBaseline. - Use this value only to set ElementFormat.alignmentBaseline. - -

-See also -

-
-ElementFormat.alignmentBaseline -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TextBlock.html b/html-docs/flash/text/engine/TextBlock.html deleted file mode 100644 index 57fa45d..0000000 --- a/html-docs/flash/text/engine/TextBlock.html +++ /dev/null @@ -1,2415 +0,0 @@ - - - - - - - - -flash.text.engine.TextBlock (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TextBlock
InheritanceTextBlock Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The TextBlock class is a factory for the creation of TextLine objects, which you can - render by placing them on the display list. -

The TextBlock class is intended to contain a single paragraph because the Unicode - bidirectional and line-break algorithms operate on one paragraph at a time. For applications - that compose multiple paragraphs of text, use a markup language, or text analysis to - divide the text into paragraphs and create one TextBlock per paragraph.

-

The TextBlock object stores its content in the content property, which is an - instance of the ContentElement class. Because you can't create an instance of the ContentElement - class, set content to an instance of one of its subclasses: TextElement, - GraphicElement, or GroupElement. Use TextElement for purely text content, GraphicElement for - an image or graphic content, and GroupElement for content that contains a combination of TextElement, - GraphicElement, and other GroupElement objects. See the ContentElement class and - its subclasses for details on managing formatted runs of text, embedded sub-runs, and graphic elements.

-

After you create the TextBlock instance and set the content property, call the - createTextLine() method to create lines of text, which are instances of the TextLine class.

-

-

-View the examples. -

-

-See also -

-
-ContentElement -
-GraphicElement -
-GroupElement -
-TextBaseline -
-TextElement -
-TextJustifier -
-TextLine -
-TextRotation -
-TabStop -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  applyNonLinearFontScaling : Boolean -
- Specifies that you want to enhance screen appearance at the expense of what-you-see-is-what-you-get (WYSIWYG) print fidelity.
-		TextBlock
  baselineFontDescription : FontDescription -
- The font used to determine the baselines for all the lines created from the block, independent of their content.
-		TextBlock
  baselineFontSize : Number -
- The font size used to calculate the baselines for the lines created from the block.
-		TextBlock
  baselineZero : String -
- Specifies which baseline is at y=0 for lines created from this block.
-		TextBlock
  bidiLevel : int -
- Specifies the bidirectional paragraph embedding level of the text block.
-		TextBlock
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  content : ContentElement -
- Holds the contents of the text block.
-		TextBlock
  firstInvalidLine : TextLine -
[read-only] - Identifies the first line in the text block in which TextLine.validity is not equal to - TextLineValidity.VALID.
-		TextBlock
  firstLine : TextLine -
[read-only] - The first TextLine in the TextBlock, if any.
-		TextBlock
  lastLine : TextLine -
[read-only] - The last TextLine in the TextBlock, if any.
-		TextBlock
  lineRotation : String -
- Rotates the text lines in the text block as a unit.
-		TextBlock
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  tabStops : Vector.<TabStop>
- Specifies the tab stops for the text in the text block, - in the form of a Vector of TabStop objects.
-		TextBlock
  textJustifier : TextJustifier -
- Specifies the TextJustifier to use during line creation.
-		TextBlock
  textLineCreationResult : String -
[read-only] - Indicates the result of a createTextLine() operation.
-		TextBlock
  userData : * -
- Provides a way for the application to associate arbitrary data with the text block.
-		TextBlock
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TextBlock(content:ContentElement = null, tabStops:Vector.<TabStop> = null, textJustifier:TextJustifier = null, lineRotation:String = "rotate0", baselineZero:String = "roman", bidiLevel:int = 0, applyNonLinearFontScaling:Boolean = true, baselineFontDescription:FontDescription = null, baselineFontSize:Number = 12.0)
-
- Creates a TextBlock object -
-		TextBlock
   -
-createTextLine(previousLine:TextLine = null, width:Number = 1000000, lineOffset:Number = 0.0, fitSomething:Boolean = false):TextLine -
-
- Instructs the text block to create a line of text from its content, beginning at the point - specified by the previousLine parameter and breaking at the point specified by the - width parameter.
-		TextBlock
   -
-dump():String -
-
- Dumps the underlying contents of the TextBlock as an XML string.
-		TextBlock
   -
-findNextAtomBoundary(afterCharIndex:int):int -
-
- Finds the index of the next atom boundary from the specified character index, not including the character at the specified index.
-		TextBlock
   -
-findNextWordBoundary(afterCharIndex:int):int -
-
- Finds the index of the next word boundary from the specified character index, not including the character at the specified index.
-		TextBlock
   -
-findPreviousAtomBoundary(beforeCharIndex:int):int -
-
- Finds the index of the previous atom boundary to the specified character index, not including the character at the specified index.
-		TextBlock
   -
-findPreviousWordBoundary(beforeCharIndex:int):int -
-
- Finds the index of the previous word boundary to the specified character index, not including the character at the specified index.
-		TextBlock
   -
-getTextLineAtCharIndex(charIndex:int):TextLine -
-
- Returns the TextLine containing the character specified by the charIndex parameter.
-		TextBlock
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-recreateTextLine(textLine:TextLine, previousLine:TextLine = null, width:Number = 1000000, lineOffset:Number = 0.0, fitSomething:Boolean = false):TextLine -
-
- Instructs the text block to re-use an existing text line to create a line of text from its content, beginning at the point - specified by the previousLine parameter and breaking at the point specified by the - width parameter.
-		TextBlock
   -
-releaseLineCreationData():void -
-
- Instructs the text block to release all the temporary data associated with the creation of text lines.
-		TextBlock
   -
-releaseLines(firstLine:TextLine, lastLine:TextLine):void -
-
- Removes a range of text lines from the list of lines maintained by the TextBlock.
-		TextBlock
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
applyNonLinearFontScalingproperty
-
-applyNonLinearFontScaling:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that you want to enhance screen appearance at the expense of what-you-see-is-what-you-get (WYSIWYG) print fidelity. - For platforms and fonts that do not support sub pixel glyph positioning during device font rendering, but - do support non-linear scaling, setting this property to true enables the use of those metrics at some cost to - WYSIWYG print fidelity, particularly for small point sizes. Non linear font scaling works by selectivly scaling the width - of individual glyphs to conceal unsightly gaps caused by pixel snapping. - -

On platforms which do support sub-pixel glyph positioning, this flag is ignored.

-

This flag has no effect on embedded font rendering

-

The default value is true.

- Implementation -
-    public function get applyNonLinearFontScaling():Boolean -
-    public function set applyNonLinearFontScaling(value:Boolean):void -
-
- - - - - -
baselineFontDescriptionproperty 
-
-baselineFontDescription:FontDescription  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The font used to determine the baselines for all the lines created from the block, independent of their content. Baselines depend on font and font size. -

The default value is null. When the baseline font is null, the baseline font size is ignored and - the baseline for any given line is based on the font and size of the largest text in the line. When you specify both - baselineFontDescription and baselineFontSize, they determine the baselines for all the lines - in the text block, independent of their content. This combination is most often useful in Asian typography.

- Implementation -
-    public function get baselineFontDescription():FontDescription -
-    public function set baselineFontDescription(value:FontDescription):void -
-

-See also -

-
-baselineFontSize -
-FontDescription -
-
- - - - - -
baselineFontSizeproperty 
-
-baselineFontSize:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The font size used to calculate the baselines for the lines created from the block. Baselines depend on font and font size. -

The default value is 12. When the baseline font is null, the baseline font size is ignored and - the baseline for any given line is based on the font and size of the largest text in the line.

- Implementation -
-    public function get baselineFontSize():Number -
-    public function set baselineFontSize(value:Number):void -
-
-Throws -
- - - - -
ArgumentError — The baselineFontSize specified is less than 0. - -
-

-See also -

-
-baselineFontDescription -
-FontDescription -
-
- - - - - -
baselineZeroproperty 
-
-baselineZero:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies which baseline is at y=0 for lines created from this block. - Valid values for this property are found in the members of the - TextBaseline class. -

The default value is TextBaseline.ROMAN.

-

To set values for this property, use the following string values:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
TextBaseline.ROMANThe roman baseline of the lines is at y=0.
TextBaseline.ASCENTThe ascent baseline of the lines is at y=0.
TextBaseline.DESCENTThe descent baseline of the lines is at y=0.
TextBaseline.IDEOGRAPHIC_TOPThe ideographic top baseline of the lines is at y=0.
TextBaseline.IDEOGRAPHIC_CENTERThe ideographic center baseline of the lines is at y=0.
TextBaseline.IDEOGRAPHIC_BOTTOMThe ideographic bottom baseline of the lines is at y=0.
- Implementation -
-    public function get baselineZero():String -
-    public function set baselineZero(value:String):void -
-
-Throws -
- - - - -
ArgumentError — If set to any value which is not a member of TextBaseline. -
-

-See also -

-
-TextBaseline -
-
- - - - - -
bidiLevelproperty 
-
-bidiLevel:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the bidirectional paragraph embedding level of the text block. In general, - use 0 for LTR paragraphs (English, Japanese, etc) and 1 for RTL paragraphs (Arabic, Hebrew, etc). - The use of values other than 0 or 1 is reserved for special cases - see UAX#9, - "Unicode Bidirectional Algorithm" (http://www.unicode.org/reports/tr9/) for details. -

The default value is 0.

-

Modifying bidiLevel changes the validity of all previously broken lines to TextLineValidity.INVALID. After - changing bidiLevel, the firstInvalidLine property equals the firstLine property, and you must - rebreak all the lines in the TextBlock.

- Implementation -
-    public function get bidiLevel():int -
-    public function set bidiLevel(value:int):void -
-
-Throws -
- - - - -
ArgumentError — If set to a value which is less than 0. -
-

-See also -

-
-createTextLine() -
-
-Example -
This example shows the same text string (logical order: a, b, c, alef, bet, gimel) - rendered first with bidiLevel even and second with bidiLevel odd. -
-
-
-package {
-    
-	import flash.display.Sprite;
-	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.ElementFormat;
-	import flash.text.engine.FontDescription;
-	
-	public class TextBlock_bidiLevelExample extends Sprite {
-		
-		public function TextBlock_bidiLevelExample():void {			 
-			var fontSize:Number = 36;
-
-			var format:ElementFormat = new ElementFormat();        
-			format.fontDescription = new FontDescription("Adobe Hebrew");
-			format.fontSize = fontSize;
-			var y:Number = 0;
-			var leading:Number = fontSize * 0.2;
-			var text:String = "abc" + String.fromCharCode(0x05D0, 0x05D1, 0x05D2);
-
-			var textBlock:TextBlock = new TextBlock();
-			textBlock.content = new TextElement(text, format);
-						
-			// bidiLevel even
-			textBlock.bidiLevel = 0;
-			var textLine = textBlock.createTextLine(null, 400);
-			y += leading + textLine.ascent;
-			textLine.y = y;
-			y += textLine.descent;
-			addChild(textLine);      
-			
-			// bidiLevel odd
-			textBlock.content = new TextElement(text, format);
-			textBlock.bidiLevel = 1;
-			textLine = textBlock.createTextLine(null, 400);
-			y += leading + textLine.ascent;          
-			textLine.y = y;
-			addChild(textLine);   
-		}
-	}
-}
-
-

-
- - - - - -
contentproperty 
-
-content:ContentElement  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Holds the contents of the text block. Because ContentElement is a base class, assign content - an instance of a ContentElement subclass: TextElement, GraphicElement, or GroupElement. A TextElement object - contains a String, a GraphicElement object contains a DisplayObject, and a GroupElement contains a Vector object that - contains one or more TextElement, GraphicElement, or other GroupElement objects. Use a TextElement for a - paragraph of homogenous text, a GraphicElement for a graphic, and a GroupElement for a combination of text and graphic - elements or multiples instances of these elements, as well as other GroupElement objects. - -

The default value is null.

-

Modifying the content property changes the validity of all previously created lines to - TextLineValidity.INVALID. After changing content, the firstInvalidLine property - equals the firstLine property and you must rebreak all lines in the TextBlock.

- Implementation -
-    public function get content():ContentElement -
-    public function set content(value:ContentElement):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to a value which is not a known subclass of ContentElement. -
 
ArgumentError — The value specified is already a member of a group. - -
-

-See also -

-
-ContentElement -
-GraphicElement -
-GroupElement -
-TextElement -
-createTextLine() -
-
- - - - - -
firstInvalidLineproperty 
-
-firstInvalidLine:TextLine  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Identifies the first line in the text block in which TextLine.validity is not equal to - TextLineValidity.VALID. -

The default value is null.

- - - Implementation -
-    public function get firstInvalidLine():TextLine -
-

-See also -

-
-TextLine.validity -
-TextLineValidity -
-
- - - - - -
firstLineproperty 
-
-firstLine:TextLine  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The first TextLine in the TextBlock, if any. -

The default value is null.

- Implementation -
-    public function get firstLine():TextLine -
-

-See also -

-
-TextLine -
-
- - - - - -
lastLineproperty 
-
-lastLine:TextLine  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The last TextLine in the TextBlock, if any. -

The default value is null.

- Implementation -
-    public function get lastLine():TextLine -
-

-See also -

-
-TextLine -
-
- - - - - -
lineRotationproperty 
-
-lineRotation:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Rotates the text lines in the text block as a unit. Call the createTextLine() method after - setting lineRotation for it to take effect. The default value is TextRotation.ROTATE_0. -

The final rotation of any glyph depends on the values of - ElementFormat.textRotation, ContentElement.textRotation, and TextBlock.lineRotation.

-

TextBlock.lineRotation is typically used for Asian text. - To create a paragraph of vertical Japanese text, do the following:

-
    -
  1. Set the TextBlock.lineRotation property to TextRotation.ROTATE_90.
    2. -
  2. Leave the ElementFormat.textRotation property of the content as the default, TextRotation.AUTO.
    3. -
-

Use the following constants, which are defined in the TextRotation class, to set the - value for this property:

- - - - - - - - - - - - - - - - - - - - - - - - - -
String valueDescription
TextRotation.ROTATE_0Lines are not rotated.
TextRotation.ROTATE_90Lines are rotated 90 degrees clockwise.
TextRotation.ROTATE_180Lines are rotated 180 degrees.
TextRotation.ROTATE_270Lines are rotated 270 degrees clockwise.
TextRotation.AUTONot supported.
- Implementation -
-    public function get lineRotation():String -
-    public function set lineRotation(value:String):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — If set to any value which is not a member of TextRotation. -
 
ArgumentError — If set to TextRotation.AUTO. -
-

-See also -

-
-ContentElement.textRotation -
-ElementFormat.textRotation -
-TextLine -
-TextRotation -
-
-Example -
This example adds Japanese text to a TextBlock and sets the - lineRotation property to TextRotation.ROTATE_90 to display the line - vertically. -
-
-
-package {
-    import flash.display.Sprite;
-	import flash.text.engine.FontDescription;
-	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.TextRotation;
-	import flash.text.engine.ElementFormat;
-	
-	public class TextBlock_lineRotationExample extends Sprite {
-		
-		public function TextBlock_lineRotationExample():void {
-			var Japanese:String = String.fromCharCode(
-				0x5185, 0x95A3, 0x5E9C, 0x304C, 0x300C, 0x653F, 0x5E9C, 0x30A4,
-				0x30F3, 0x30BF, 0x30FC, 0x30CD, 0x30C3, 0x30C8, 0x30C6, 0x30EC, 
-				0x30D3, 0x300D, 0x306E, 0x52D5, 0x753B, 0x914D, 0x4FE1, 0x5411, 
-				0x3051, 0x306B, 0x30A2, 0x30C9, 0x30D3, 0x30B7, 0x30B9, 0x30C6, 
-				0x30E0, 0x30BA, 0x793E, 0x306E
-			) +
-			"FMS 2" +
-			String.fromCharCode(0x3092, 0x63A1, 0x7528, 0x3059, 0x308B, 0x3068, 
-				0x767a, 0x8868, 0x3057, 0x307e, 0x3057, 0x305F, 0x3002);
-
-			var fontDescription:FontDescription = new FontDescription("MS Mincho");
-			var format:ElementFormat = new ElementFormat();
-			format.fontSize = 15;
-			format.fontDescription = fontDescription;
-						
-			var textElement:TextElement = new TextElement(Japanese, format); 
-			var textBlock:TextBlock = new TextBlock();
-			textBlock.content = textElement;
-			textBlock.lineRotation = TextRotation.ROTATE_90;
-
-			var linePosition:Number = this.stage.stageWidth - 120;
-			var previousLine:TextLine = null;
-		
-			while (true) {
-				var textLine:TextLine = textBlock.createTextLine(
-					previousLine, 
-					300);
-				if (textLine == null) 
-					break;
-				textLine.y = 30;	
-				textLine.x = linePosition;
-				linePosition -= 24;
-				addChild(textLine);				
-				previousLine = textLine;
-			}		
-		}
-	}
-}
-
-

-
- - - - - -
tabStopsproperty 
-
-tabStops:Vector.<TabStop>  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the tab stops for the text in the text block, - in the form of a Vector of TabStop objects. -

The default value is null, which means no tab stops are specified. When no tab stops are specified (or the insertion point is beyond the last specified tab stop) - the runtime creates half-inch tabs by default.

-

When the tabStops property is set, the TextBlock makes a copy of the Vector for internal use. - Modifying the original Vector or its contents does not affect the TextBlock. When the tabStops property is queried, a copy - of the internal Vector is returned. Again, modifying this returned vector or its contents does not affect the TextBlock.

- Implementation -
-    public function get tabStops():Vector.<TabStop> -
-    public function set tabStops(value:Vector.<TabStop>):void -
-
-Throws -
- - - - - - - - - - -
ArgumentError — The tabStops specified contain null elements. -
 
ArgumentError — The tabStops specified are not sorted by increasing position. - -
-

-See also -

-
-TabStop -
-
- - - - - -
textJustifierproperty 
-
-textJustifier:TextJustifier  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the TextJustifier to use during line creation. -

The default value is a constructed default TextJustifier object.

-

When the textJustifier property is set, the TextBlock makes a copy of the object for internal use. - Modifying the original object does not affect the TextBlock. When the textJustifier property is queried, a copy - of the internal object is returned. Again, modifying this returned object does not affect the TextBlock.

- Implementation -
-    public function get textJustifier():TextJustifier -
-    public function set textJustifier(value:TextJustifier):void -
-
-Throws -
- - - - -
ArgumentError — If set to a value which is not a known subclass of TextJustifier. -
-

-See also -

-
-EastAsianJustifier -
-SpaceJustifier -
-TextJustifier -
-
- - - - - -
textLineCreationResultproperty 
-
-textLineCreationResult:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates the result of a createTextLine() operation. - Changing the content of the block invalidates previously broken lines and resets - this property to null. -

The default value is null.

-

Values for this property are found in TextLineCreationResult

- - - - - - - - - - - - - - - - - -
String valueDescription
TextLineCreationResult.SUCCESSThe line was successfully broken.
TextLineCreationResult.COMPLETEEither the new line created aligned perfectly with following lines which - have transitioned from POSSIBLY_INVALID to VALID, or - no line was created because all text in the block had already been broken.
TextLineCreationResult.INSUFFICIENT_WIDTHNo line was created because no text could fit in the specified width.
- Implementation -
-    public function get textLineCreationResult():String -
-

-See also -

-
-TextLineCreationResult -
-
- - - - - -
userDataproperty 
-
-public var userData:* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Provides a way for the application to associate arbitrary data with the text block. The data could be information that refers to the content, - such as a revision date or the name of the author, or it could be cached data that you use during processing. -

- -
Constructor detail
- - - - - -
TextBlock()constructor
-
-public function TextBlock(content:ContentElement = null, tabStops:Vector.<TabStop> = null, textJustifier:TextJustifier = null, lineRotation:String = "rotate0", baselineZero:String = "roman", bidiLevel:int = 0, applyNonLinearFontScaling:Boolean = true, baselineFontDescription:FontDescription = null, baselineFontSize:Number = 12.0) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a TextBlock object -

Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
content:ContentElement (default = null) — The contents of the text block. -
 
tabStops:Vector.<TabStop> (default = null) — The tab stops for the text in the text block. -
 
textJustifier:TextJustifier (default = null) — The TextJustifier object to use during line creation for this block. - If no justifier is provided, a default justifier is constructed based on an English locale. -
 
lineRotation:String (default = "rotate0") — The rotation applied to the text lines generated from the text block as units. -
 
baselineZero:String (default = "roman") — Specifies which baseline is at y=0 for all lines in the block. -
 
bidiLevel:int (default = 0) — The default bidirectional embedding level of the text in the text block. -
 
applyNonLinearFontScaling:Boolean (default = true) — Specifies that you want to enhance screen appearance at the expense of WYSIWYG print fidelity. -
 
baselineFontDescription:FontDescription (default = null) — Specifies a font description from which to derive line baselines for all lines in the block. -
 
baselineFontSize:Number (default = 12.0) — Specifies the size to use with the baselineFontDescription. - This parameter is ignored if baselineFontDescription is null. -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — The content specified is not a known subclass of ContentElement. -
 
ArgumentError — The content specified is already a member of a group. -
 
ArgumentError — The lineRotation specified is not a member of TextRotation. -
 
ArgumentError — The baselineZero specified is not a member of TextBaseline. -
 
ArgumentError — The bidiLevel specified is less than 0. -
 
ArgumentError — The tabStops specified contain null elements. -
 
ArgumentError — The tabStops specified are not sorted by increasing position. -
 
ArgumentError — The baselineFontSize specified is less than 0. - -
-

-See also -

-
-applyNonLinearFontScaling -
-baselineFontDescription -
-baselineFontSize -
-baselineZero -
-bidiLevel -
-lineRotation -
-tabStops -
-TextJustifier -
-
- -
Method detail
- - - - - -
createTextLine()method
-
-public function createTextLine(previousLine:TextLine = null, width:Number = 1000000, lineOffset:Number = 0.0, fitSomething:Boolean = false):TextLine -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Instructs the text block to create a line of text from its content, beginning at the point - specified by the previousLine parameter and breaking at the point specified by the - width parameter. The text line is a TextLine object, which you can add - to the display list. -

Breaking lines over a range of a text block that has already been broken can change the validity - of lines in and beyond the area where breaking takes place. The status of lines can change from VALID to INVALID or - POSSIBLY_INVALID. If a newly broken line aligns perfectly with a previously broken line which has a status - of POSSIBLY_INVALID, that previously broken line and all following POSSIBLY_INVALID lines change back - to a status of VALID. The validity of lines that have been set to values that are not members of - TextLineValidity do not change to VALID, but could change to INVALID. - Check the firstInvalidLine property after any change to the text block - to see where to begin or continue rebreaking text lines.

-

You can create artificial word breaks by including the Unicode Zero Width Space (ZWSP) character in the text. - This can be useful for languages such as Thai, which require a dictionary for correct line breaking. - The Flash runtime does not include such a dictionary.

-

In order to reduce memory overhead, when all the desired lines have been created, unless it is expected that the - lines will need to be repeatedly rebroken due to, for example, the resizing of the container, the user should call - the releaseLineCreationData() method allowing the text block to dispose of the temporary data associated with line breaking.

- Parameters - - - - - - - - - - - - - - - - - - - - - - -
previousLine:TextLine (default = null) — Specifies the previously broken line after which breaking is to commence. Can be null - when breaking the first line. -
 
width:Number (default = 1000000) — Specifies the desired width of the line in pixels. The actual width may be less. -
 
lineOffset:Number (default = 0.0) — An optional parameter which specifies the difference in pixels between the origin of the line and the origin of the tab stops. - This can be used when lines are not aligned, but it is desirable for their tabs to be so. - The default value for this parameter is 0.0. -
 
fitSomething:Boolean (default = false) — An optional parameter which instructs Flash Player to fit at least one character into the text line, no matter what - width has been specified (even if width is zero or negative, which would otherwise result in an exception being thrown). -
-

-Returns - - - - -
TextLine — - A text line, or null if the text block is empty or the width specified is less than the width of the next element. - To distinguish between these cases, check the textLineCreationResult property of the text block. - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — If the TextLine specified by previousLine is not valid. -
 
ArgumentError — If the TextLine specified by previousLine is owned by a different TextBlock. -
 
ArgumentError — If width is less than zero, unless fitSomething is true. -
 
ArgumentError — If width is greater than TextLine.MAX_LINE_WIDTH. -
 
Error — If one or more elements in the content of the text block has a null ElementFormat. -
-

-See also -

-
-TextLine -
-TextLine.validity -
-TextLineValidity -
-TextBlock.releaseLineCreationData() -
-
-Example -
This example calls the createTextLine() method to create - lines of text in a text block. It accomplishes this by performing the following tasks: -
    -
  • Creating a TextElement from a String and giving it a font size of 20
    • -
  • Creating a TextBlock and assigning the TextElement to it
    • -
  • Calling createTextLine() to create lines 300 pixels wide from the text block
    • -
  • Placing each line on Stage (addChild()) and setting its position (x and y)
    • -
-
-
-
-package {
-	import flash.display.Sprite;
-	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.ElementFormat;
-	import flash.text.engine.FontDescription;
-	
-	public class TextBlock_createTextLineExample extends Sprite {
-		
-		public function TextBlock_createTextLineExample():void {
-			
-			var str:String = "I am a TextElement, created from a String and assigned " +
-			"to the content property of a TextBlock. The createTextLine() method " +
-			"then created these lines, 300 pixels wide, for display." ;
-			
-			var fontDescription:FontDescription = new FontDescription("Arial");
-			var format:ElementFormat = new ElementFormat(fontDescription);
-			format.fontSize = 16;
-			var textElement:TextElement = new TextElement(str, format); 
-			var textBlock:TextBlock = new TextBlock();
-			textBlock.content = textElement; 
-			createLines(textBlock); 
-		}
-		
-		private function createLines(textBlock:TextBlock):void 
-		{			
-			var lineWidth:Number = 300;
-			var xPos:Number = 15.0;
-			var yPos:Number = 20.0;
-			
-			var textLine:TextLine = textBlock.createTextLine (null, lineWidth);
-			while (textLine)
-			{
-				textLine.x = xPos;
-				textLine.y = yPos;
-				yPos += textLine.height + 2;
-				addChild (textLine);
-				textLine = textBlock.createTextLine (textLine, lineWidth);
-			}
-		}
-	}
-}
-
-

-
- - - - - -
dump()method 
-
-public function dump():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Dumps the underlying contents of the TextBlock as an XML string. - This can be useful in automated testing, and includes text, formatting, and layout information. -

The following describes the output:

- 
-	 >block<
-	 	[0-N LINE]
-	 >/block<
-
-

For a description of the output for each line, see the TextLine.dump() method.

-

Note: The content and format of the output may change in the future. Adobe does not guarantee backward compatibility - of this method.

-

-Returns - - - - -
String
-

-See also -

-
-TextLine.dump() -
-
- - - - - -
findNextAtomBoundary()method 
-
-public function findNextAtomBoundary(afterCharIndex:int):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Finds the index of the next atom boundary from the specified character index, not including the character at the specified index. - The characters between atom boundaries combine to form one atom in a TextLine, such as an 'e' and a combining acute accent. -

Parameters - - - - -
afterCharIndex:int — Specifies the index of the character from which to search for the next atom boundary. -
-

-Returns - - - - -
int — - The index of the next atom boundary from the specified character index. - - -
-
-Throws - - - - - - - - - - -
RangeError — The index specified is out of range. -
 
Error — The TextLine to which the indexed character belongs is not valid. -
-

-See also -

-
-TextLine.atomCount -
-
- - - - - -
findNextWordBoundary()method 
-
-public function findNextWordBoundary(afterCharIndex:int):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Finds the index of the next word boundary from the specified character index, not including the character at the specified index. - Word boundaries are determined based on the Unicode properties of the characters. -

Parameters - - - - -
afterCharIndex:int — Specifies the index of the character from which to search for the next word boundary. -
-

-Returns - - - - -
int — - The index of the next word boundary from the specified character index. - - -
-
-Throws - - - - - - - - - - -
RangeError — The index specified is out of range. -
 
Error — The TextLine to which the indexed character belongs is not valid. - -
-
- - - - - -
findPreviousAtomBoundary()method 
-
-public function findPreviousAtomBoundary(beforeCharIndex:int):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Finds the index of the previous atom boundary to the specified character index, not including the character at the specified index. - The characters between atom boundaries combine to form one atom in a TextLine, such as an 'e' and a combining acute accent. -

Parameters - - - - -
beforeCharIndex:int — Specifies the index of the character from which to search for the previous atom boundary. -
-

-Returns - - - - -
int — - The index of the previous atom boundary to the specified character index. - - -
-
-Throws - - - - - - - - - - -
RangeError — The index specified is out of range. -
 
Error — The TextLine to which the indexed character belongs is not valid. -
-

-See also -

-
-TextLine.atomCount -
-
- - - - - -
findPreviousWordBoundary()method 
-
-public function findPreviousWordBoundary(beforeCharIndex:int):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Finds the index of the previous word boundary to the specified character index, not including the character at the specified index. - Word boundaries are determined based on the Unicode properties of the characters. -

Parameters - - - - -
beforeCharIndex:int — Specifies the index of the character from which to search for the previous word boundary. -
-

-Returns - - - - -
int — - The index of the previous word boundary to the specified character index. - - -
-
-Throws - - - - - - - - - - -
RangeError — The index specified is out of range. -
 
Error — The TextLine to which the indexed character belongs is not valid. - -
-
- - - - - -
getTextLineAtCharIndex()method 
-
-public function getTextLineAtCharIndex(charIndex:int):TextLine -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the TextLine containing the character specified by the charIndex parameter. -

Parameters - - - - -
charIndex:int — The zero-based index value of the character (for example, the first character is 0, - the second character is 1, and so on). -
-

-Returns - - - - -
TextLine — - The TextLine containing the character at charIndex. - - -
-
-Throws - - - - -
RangeError — The character index specified is out of range. - -
-
- - - - - -
recreateTextLine()method 
-
-public function recreateTextLine(textLine:TextLine, previousLine:TextLine = null, width:Number = 1000000, lineOffset:Number = 0.0, fitSomething:Boolean = false):TextLine -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Instructs the text block to re-use an existing text line to create a line of text from its content, beginning at the point - specified by the previousLine parameter and breaking at the point specified by the - width parameter. The text line is a TextLine object, which you can add - to the display list. By re-using an existing text line, performance is enhanced due to reduced object creation. -

The textLine being recreated is released from whatever text block it is in, if any. - In addition, all properties, including inherited properties from DisplayObjectContainer, - InteractiveObject, and DisplayObject are reset to their default values. - Finally, all children of the line are removed including graphic elements and other decorations, and all event - listeners on the line are removed. To improve performance, the only exception to this complete reset is that - the line itself is not removed from its parent.

-

Breaking lines over a range of a text block that has already been broken can change the validity - of lines in and beyond the area where breaking takes place. The status of lines can change from VALID to INVALID or - POSSIBLY_INVALID. If a newly broken line aligns perfectly with a previously broken line which has a status - of POSSIBLY_INVALID, that previously broken line and all following POSSIBLY_INVALID lines change back - to a status of VALID. The validity of lines that have been set to values that are not members of - TextLineValidity do not change to VALID, but could change to INVALID. - Check the firstInvalidLine property after any change to the text block - to see where to begin or continue rebreaking text lines.

-

You can create artificial word breaks by including the Unicode Zero Width Space (ZWSP) character in the text. - This can be useful for languages such as Thai, which require a dictionary for correct line breaking. - The Flash runtime does not include such a dictionary.

-

In order to reduce memory overhead, when all the desired lines have been created, unless it is expected that the - lines will need to be repeatedly rebroken due to, for example, the resizing of the container, the user should call - the releaseLineCreationData() method allowing the text block to dispose of the temporary data associated with line breaking.

- Parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
textLine:TextLine — Specifies a previously created TextLine to be re-used. -
 
previousLine:TextLine (default = null) — Specifies the previously broken line after which breaking is to commence. Can be null - when breaking the first line. -
 
width:Number (default = 1000000) — Specifies the desired width of the line in pixels. The actual width may be less. -
 
lineOffset:Number (default = 0.0) — An optional parameter which specifies the difference in pixels between the origin of the line and the origin of the tab stops. - This can be used when lines are not aligned, but it is desirable for their tabs to be so. - The default value for this parameter is 0.0. -
 
fitSomething:Boolean (default = false) — An optional parameter which instructs Flash Player to fit at least one character into the text line, no matter what - width has been specified (even if width is zero or negative, which would otherwise result in an exception being thrown). -
-

-Returns - - - - -
TextLine — - A text line, or null if the text block is empty or the width specified is less than the width of the next element. - To distinguish between these cases, check the textLineCreationResult property of the text block. - - -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — If textLine is null. -
 
ArgumentError — If the TextLine specified by previousLine is not valid. -
 
ArgumentError — If the TextLine specified by previousLine is owned by a different TextBlock. -
 
ArgumentError — If the TextLine specified by previousLine is also specified by textLine. -
 
ArgumentError — If width is less than zero, unless fitSomething is true. -
 
ArgumentError — If width is greater than TextLine.MAX_LINE_WIDTH. -
 
Error — If one or more elements in the content of the text block has a null ElementFormat. -
-

-See also -

-
-TextBaseline -
-TextLine -
-TextLine.validity -
-TextLineValidity -
-TextBlock.releaseLineCreationData() -
-
-Example -
This example re-uses the TextLine object textLine: -
-
-var elementFormat:ElementFormat = new ElementFormat();
-elementFormat.fontDescription = new FontDescription("Arial");
-elementFormat.fontSize = 48;
-
-var textElement:TextElement = new TextElement("Text you'll never see", elementFormat)
-var textBlock:TextBlock = new TextBlock(textElement);
-var textLine:TextLine = textBlock.createTextLine();
-textLine.x = 50;
-textLine.y = 50;
-addChild(textLine);
-
-// Reuse the element format to preserve the text formatting
-var elementTwo:TextElement = new TextElement("Text you see", elementFormat);  
-textBlock.content = elementTwo;
-textBlock.recreateTextLine(textLine);
-
-// Set the position (and any other display object properties like alpha, children, etc.)
-// otherwise, they're all set to default properties.
-textLine.x = 50;  
-textLine.y = 50;
-
-

-
- - - - - -
releaseLineCreationData()method 
-
-public function releaseLineCreationData():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Instructs the text block to release all the temporary data associated with the creation of text lines. - To minimize an application's memory foot print, you should call the releaseLineCreationData() method when you are - done creating text lines from a text block. However, to maximize performance for rebreaking the lines - (for example when the container is resized) the releaseLineCreationData() method should not be called. - It is up to the application to balance memory vs. performance. -

The recommended process for text that is not expected to change is: initialize a text block, - call the createTextLine() method as often as necessary to create the desired output, and then call - the releaseLineCreationData() method.

-

-See also -

-
-TextBlock.createTextLine() -
-
- - - - - -
releaseLines()method 
-
-public function releaseLines(firstLine:TextLine, lastLine:TextLine):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Removes a range of text lines from the list of lines maintained by the TextBlock. - This allows the lines to be garbage-collected if no other references exist. - -

Sets the textBlock, nextLine, and previousLine - members of the removed lines to null. - Sets the validity of the removed lines and of all lines which follow - the removed lines in the TextBlock to TextLineValidity.INVALID.

- Parameters - - - - - - - - - - -
firstLine:TextLine — Specifies the first line to release. -
 
lastLine:TextLine — Specifies the last line to release. -
-
-Throws - - - - -
ArgumentError — If the TextLine specified by firstLine or lastLine is not - in the list of text lines maintained by the text block. -
-

-See also -

-
-TextLine -
-
- -
Examples
-
examples\TextBlockExample
-
This example displays three TextBlock paragraphs of Japanese and English - text. The Japanese text is converted to Strings from Unicode character codes. - When you click on the button, the example rotates the text from horizontal to - vertical or from veritcal to horizontal. -
-
-package { 
-    import fl.controls.Button;
- 	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.ElementFormat;
-	import flash.text.engine.TextRotation;
-	import flash.text.engine.TextBaseline;
-	import flash.text.engine.LineJustification;
-	import flash.text.engine.FontDescription;
-	import flash.text.engine.EastAsianJustifier; 
-	import flash.display.Loader;
-	import flash.display.Sprite;
-	import flash.display.Stage;
-	import flash.events.MouseEvent;
-	import flash.system.Capabilities;
-	
-	public class TextBlockExample extends Sprite {
-		
-		var vertical:Boolean;	
-		var container:Sprite;
-		var textBlocks:Vector.<TextBlock>;
-		var loader:Loader = new Loader();
-		var directionButton:Button = new Button();
-		
-		public function TextBlockExample():void {
-			addChild(directionButton);
-			directionButton.width = 30;
-			directionButton.move(50, 350);
-			directionButton.addEventListener(MouseEvent.CLICK, clickHandler);
-			createContent();
-			createLines();
-		}
-
-		private function createEmptyBlock():TextBlock {
-		
-			var textBlock:TextBlock = new TextBlock();
-			textBlock.baselineZero = TextBaseline.IDEOGRAPHIC_CENTER;
-			textBlock.textJustifier = new EastAsianJustifier("ja", LineJustification.ALL_BUT_LAST);
-			textBlock.lineRotation = vertical? TextRotation.ROTATE_90: TextRotation.ROTATE_0;
-			return textBlock;	
-		}
-		
-		private function paragraph1(format:ElementFormat):TextBlock {
-		
-			var textBlock:TextBlock = createEmptyBlock();
-			textBlock.content = new TextElement(
-			String.fromCharCode(
-				0x5185, 0x95A3, 0x5E9C, 0x304C, 0x300C, 0x653F, 0x5E9C, 0x30A4,
-				0x30F3, 0x30BF, 0x30FC, 0x30CD, 0x30C3, 0x30C8, 0x30C6, 0x30EC, 
-				0x30D3, 0x300D, 0x306E, 0x52D5, 0x753B, 0x914D, 0x4FE1, 0x5411, 
-				0x3051, 0x306B, 0x30A2, 0x30C9, 0x30D3, 0x30B7, 0x30B9, 0x30C6, 
-				0x30E0, 0x30BA, 0x793E, 0x306E
-			) +
-			"FMS 2" +
-			String.fromCharCode(0x3092, 0x63A1, 0x7528, 0x3059, 0x308B, 0x3068, 
-				0x767a, 0x8868, 0x3057, 0x307e, 0x3057, 0x305F, 0x3002), format);
-			return textBlock;
-		}
-
-		private function paragraph2(format:ElementFormat):TextBlock {
-			
-			var textBlock:TextBlock = createEmptyBlock();
-			textBlock.content = new TextElement(
-			String.fromCharCode(
-				0x30AF, 0x30ED, 0x30B9, 0x30D7, 0x30E9, 0x30C3, 0x30C8, 0x30D5, 
-				0x30A9, 0x30FC, 0x30E0, 0x4E0A, 0x3067, 0x518D, 0x751F, 0x53EF, 
-				0x80FD, 0x306A
-			) + 
-			"Flash Video" +
-			String.fromCharCode(
-				0x3092, 0x914D, 0x4FE1, 0x3001, 0x653F, 0x5E9C, 0x6700, 0x65B0, 
-				0x60C5, 0x5831, 0x3092, 0x3088, 0x308A, 0x591A, 0x304F, 0x306E, 
-				0x56FD, 0x6C11, 0x306B, 0x9AD8, 0x54C1, 0x8CEA, 0x306A, 0x753B, 
-				0x50CF, 0x3067, 0x7C21, 0x5358, 0x304B, 0x3064, 0x30EA, 0x30A2, 
-				0x30EB, 0x30BF, 0x30A4, 0x30E0, 0x306B, 0x63D0, 0x4F9B, 0x3059, 
-				0x308B, 0x3053, 0x3068, 0x304C, 0x53EF, 0x80FD, 0x306B, 0x306A, 
-				0x308A, 0x307e, 0x3057, 0x305F, 0x3002), format);
-			return textBlock;	
-		}
-
-		private function paragraph3(format:ElementFormat):TextBlock {
-			
-			var textBlock:TextBlock = createEmptyBlock();
-			textBlock.content = new TextElement(
-			String.fromCharCode(0x3010) +
-			"2007" +
-			String.fromCharCode(0x5E74) + "2" + String.fromCharCode(0x6708) +
-			"21" +
-			String.fromCharCode(0x65E5, 0x3011),
-			format);
-			return textBlock;	
-		}
-
-		private function createContent():void {
-			
-			var font:FontDescription = new FontDescription();
-			if (Capabilities.os.search("Mac OS") > -1) 
-				font.fontName = String.fromCharCode(0x5C0F, 0x585A, 0x660E, 0x671D) + " Pro R"; // "Kozuka Mincho Pro R"					koFont.fontName = "Adobe " + String.fromCharCode(0xBA85, 0xC870) + " Std M"; // "Adobe Myungjo Std M"
-			else 
-				font.fontName = "Kozuka Mincho Pro R";		
-			var format:ElementFormat = new ElementFormat();
-			format.fontDescription = font;
-			format.fontSize = 12;
-			format.locale = "ja";
-			format.color = 0x000000;
-			if (!vertical) 
-				format.textRotation = TextRotation.ROTATE_0; 
-			textBlocks = new Vector.<TextBlock>();
-			textBlocks.push(
-				paragraph1(format),
-				paragraph2(format),
-				paragraph3(format)//,
-			);
-		}
-
-		private function createLines():void {	
-		
-			if (container != null) {
-				removeChild(container);
-			}			
-			container = new Sprite();
-			container.y = 45;
-			container.x = 40;
-			addChild(container);
-			var linePosition:Number = vertical? this.stage.stageWidth - 120: 12;
-		
-			for (var i:uint = 0; i < textBlocks.length; i++) {
-				var textBlock:TextBlock = textBlocks[i];
-				var previousLine:TextLine = null;
-		
-				while (true) {
-					var textLine:TextLine = textBlock.createTextLine(
-						previousLine, 
-						300);
-					if (textLine == null) 
-						break;
-					if (vertical) 
-					{
-						textLine.x = linePosition;
-						linePosition -= 24;
-						directionButton.label = " -- ";
-					}
-					else 
-					{
-						textLine.y = linePosition+50;
-						linePosition += 24;
-						directionButton.label = " | ";
-					}
-					container.addChild(textLine);				
-					previousLine = textLine;
-				}
-				if (vertical) 
-					linePosition -= 16;
-				else 
-					linePosition += 16; 
-			}
-		}
-
-		private function clickHandler(event:MouseEvent):void {
-			
-			vertical = !vertical;
-			createContent();
-			createLines();
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TextElement.html b/html-docs/flash/text/engine/TextElement.html deleted file mode 100644 index 0d1e035..0000000 --- a/html-docs/flash/text/engine/TextElement.html +++ /dev/null @@ -1,567 +0,0 @@ - - - - - - - - -flash.text.engine.TextElement (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TextElement
InheritanceTextElement Inheritance ContentElement Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The TextElement class represents a string of formatted text. Assign a TextElement object to the content - property of a TextBlock object to create a block of text. Assign it to a GroupElement object to combine it with other text - and graphic elements as a unit. Use the ElementFormat class to format the text. -

-

-See also -

-
-ContentElement -
-ElementFormat -
-TextBlock -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedelementFormat : ElementFormat -
- The ElementFormat object used for the element.
-		ContentElement
 InheritedeventMirror : EventDispatcher -
- The EventDispatcher object that receives copies of every - event dispatched to valid text lines based on this content element.
-		ContentElement
 InheritedgroupElement : GroupElement -
- The GroupElement object that contains this element, or - null if it is not in a group.
-		ContentElement
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
 InheritedrawText : String -
- A copy of the text in the element, including any U+FDEF characters.
-		ContentElement
  text : String -
[write-only] - Receives the text that is the content of the element.
-		TextElement
 InheritedtextBlock : TextBlock -
- The TextBlock to which this element belongs.
-		ContentElement
 InheritedtextBlockBeginIndex : int -
- The index in the text block of the first character of this element.
-		ContentElement
 InheritedtextRotation : String -
- The rotation to apply to the element as a unit.
-		ContentElement
 InheriteduserData : * -
- Provides a way for an application to associate arbitrary data with the element.
-		ContentElement
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TextElement(text:String = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0")
-
- Creates a new TextElement instance.
-		TextElement
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-replaceText(beginIndex:int, endIndex:int, newText:String):void -
-
- Replaces the range of characters that the beginIndex and - endIndex parameters specify with the contents - of the newText parameter.
-		TextElement
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
-
- - -
- - - - - - - -
 ConstantDefined by
 InheritedGRAPHIC_ELEMENT : uint = 0xFDEF
[static] - Indicates the presence of a graphic element in the text.
-		ContentElement
-
- -
- -
Property detail
- - - - - -
textproperty
-
-text:String  [write-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Receives the text that is the content of the element. -

The default value is null.

- Implementation -
-    public function set text(value:String):void -
-
- -
Constructor detail
- - - - - -
TextElement()constructor
-
-public function TextElement(text:String = null, elementFormat:ElementFormat = null, eventMirror:EventDispatcher = null, textRotation:String = "rotate0") -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new TextElement instance. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
text:String (default = null) — The text for the element. The default value is null. -
 
elementFormat:ElementFormat (default = null) — The element format for the text in the element. The default value is null. -
 
eventMirror:EventDispatcher (default = null) — The EventDispatcher object that receives copies of every - event dispatched to text lines based on this content element. The default value is null. -
 
textRotation:String (default = "rotate0") — The rotation applied the element as a unit. Use TextRotation - constants for this property. The default value is TextRotation.ROTATE_0. -
-
-Example -
The following example creates a TextElement object from a string of text, formats - it using a font size of 12 and the color red (0xCC0000), and assigns it to the - content property of a TextBlock. It calls the createLines() function to break the - block of text into lines of 150 pixels each. -
-
-
-package {
-    import flash.display.Sprite;
-	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.ElementFormat;
-	
-	public class TextElementExample extends Sprite {
-		
-		public function TextElementExample():void {
-			
-			var str:String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, " +
-			"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut " +
-			"enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut " +
-			"aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit " +
-			"in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur " +
-			"sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt " +
-			"mollit anim id est laborum.";
-			
-			var format:ElementFormat = new ElementFormat(null, 12, 0xCC0000);
-			var textElement:TextElement = new TextElement(str, format); 
-			var textBlock:TextBlock = new TextBlock();
-			textBlock.content = textElement; 
-			createLines(textBlock);
-		}
-		
-		private function createLines(textBlock:TextBlock):void {
-        
-            var yPos = 20;
-            var textLine:TextLine = textBlock.createTextLine (null, 150);
- 
-            while (textLine)
-            {
-                addChild(textLine);
-                textLine.x = 15;
-                yPos += textLine.textHeight+2;
-                textLine.y = yPos;
-                textLine = textBlock.createTextLine(textLine, 150);
-            }        
-        }
-	}
-}
-
-

-
- -
Method detail
- - - - - -
replaceText()method
-
-public function replaceText(beginIndex:int, endIndex:int, newText:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Replaces the range of characters that the beginIndex and - endIndex parameters specify with the contents - of the newText parameter. The beginIndex and - endIndex values refer to the current contents of text. -

To delete text, pass null for newText.

-

To insert text, pass the same value for beginIndex and endIndex. - The new text is inserted before the specified index.

-

To append text, pass text.length for beginIndex and endIndex.

-

To set all the text, pass 0 for beginIndex and text.length for endIndex.

- - Parameters - - - - - - - - - - - - - - - - -
beginIndex:int — The zero-based index value for the start position of the replacement range. -
 
endIndex:int — The zero-based index value following the end position of the replacement range. -
 
newText:String — The text to use to replace the specified range of characters. - -
-
-Throws - - - - -
RangeError — The beginIndex or endIndex specified is out of range. -
-
-Example -
This example calls replaceText() several times to do the following: -
    -
  • insert a string at the beginning of text
    • -
  • append a string to the end of text
    • -
  • insert a string in the middle of text
    • -
  • replace text entirely with new text
    • -
-
-
-
-package {
-	import flash.display.Sprite;
-	import flash.text.engine.FontDescription;
-	import flash.text.engine.ElementFormat;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextLine;
-	
-	
-	public class TextElement_replaceTextExample extends Sprite {
-		public function TextElement_replaceTextExample():void {
-			
-			var str:String = "0123456";
-			var fontDescription:FontDescription = new FontDescription("Arial");
-			var format:ElementFormat = new ElementFormat(fontDescription);
-			format.fontSize = 14;
-			var textElement:TextElement = new TextElement(str, format);
-			var textBlock:TextBlock = new TextBlock();
-			textBlock.content = textElement;
-			textElement.replaceText(0, 0, "abc");  
-			createLine(textBlock, 20);   		//"abc0123456"
-			textElement.replaceText(10, 10, "abc");   
-			createLine(textBlock, 40);			// "abc0123456abc"
-			textElement.replaceText(5, 8, "abc");
-			createLine(textBlock, 60); 		// "abc01abc56abc"
-			textElement.replaceText(0, 13, "abc");
-			createLine(textBlock, 80);			// "abc"
-			textElement.replaceText(0, 3, "That's all she wrote!");
-			createLine(textBlock, 100);		// "That's all she wrote" */
-		}
-			
-		private function createLine(textBlock:TextBlock, y:Number):void {
-			var textLine:TextLine = textBlock.createTextLine(null, 150);
-			textLine.x = 10;
-			textLine.y = y;
-			addChild(textLine);
-		}
-	}
-}
-
-

-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TextJustifier.html b/html-docs/flash/text/engine/TextJustifier.html deleted file mode 100644 index b83bc25..0000000 --- a/html-docs/flash/text/engine/TextJustifier.html +++ /dev/null @@ -1,525 +0,0 @@ - - - - - - - - -flash.text.engine.TextJustifier (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.text.engine
Classpublic class TextJustifier
InheritanceTextJustifier Inheritance Object
SubclassesEastAsianJustifier, SpaceJustifier
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

-

- The TextJustifier class is an abstract base class for the justifier types that you can apply to a TextBlock, specifically the - EastAsianJustifier and SpaceJustifier classes. -

You cannot instantiate the TextJustifier class directly. Invoking new TextJustifier() throws an ArgumentError - exception. Setting the properties of an EastAsianJustifier or SpaceJustifier object after you apply it to a TextBlock does not - invalidate the TextBlock.

-

-

-See also -

-
-EastAsianJustifier -
-SpaceJustifier -
-TextBlock.textJustifier -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  lineJustification : String -
- Specifies the line justification for the text in a text block.
-		TextJustifier
  locale : String -
[read-only] - Specifies the locale to determine the justification rules for the text in a text block.
-		TextJustifier
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-TextJustifier(locale:String, lineJustification:String)
-
- Calling the new TextJustifier() constructor throws an - ArgumentError exception.
-		TextJustifier
   -
-clone():TextJustifier -
-
- Constructs a cloned copy of the TextJustifier.
-		TextJustifier
   -
-getJustifierForLocale(locale:String):TextJustifier -
-
[static] - Constructs a default TextJustifier subclass appropriate to the specified locale.
-		TextJustifier
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
lineJustificationproperty
-
-lineJustification:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the line justification for the text in a text block. -

Use the following constants defined by the LineJustification as valid values for this property:

- - - - - - - - - - - - - - - - - - - - - -
String valueDescription
LineJustification.UNJUSTIFIEDGenerates unjustified lines.
LineJustification.ALL_BUT_LASTGenerates all lines justified except for the last one.
LineJustification.ALL_INCLUDING_LASTGenerates all lines justified.
LineJustification.ALL_BUT_MANDATORY_BREAKGenerates all lines justified except for the last line and lines ending in mandatory breaks.
- Implementation -
-    public function get lineJustification():String -
-    public function set lineJustification(value:String):void -
-

-See also -

-
-LineJustification -
-
- - - - - -
localeproperty 
-
-locale:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the locale to determine the justification rules for the text in a text block. - Standard locale identifiers are used. For example "en", "en_US" and "en-US" are all - English, "ja" is Japanese. -

Implementation -
-    public function get locale():String -
-
-Throws -
- - - - -
ArgumentError — The locale specified is null or too short to represent a valid locale. - -
-
- -
Constructor detail
- - - - - -
TextJustifier()constructor
-
-public function TextJustifier(locale:String, lineJustification:String) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Calling the new TextJustifier() constructor throws an - ArgumentError exception. You can, however, call constructors for - the following subclasses of TextJustifier: - -

    - -
  • new SpaceJustifier()
    • -
  • new EastAsianJustifier()
    • - -
-

Parameters - - - - - - - - - - -
locale:String — The locale to determine the justification rules. -
 
lineJustification:String — The type of line justification for the paragraph. - Use LineJustification constants for this property. -
-
-Throws - - - - - - - - - - -
ArgumentError — The locale specified is null or too short to represent a valid locale. -
 
ArgumentError — The lineJustification specified is not a member of LineJustification. - -
-

-See also -

-
-EastAsianJustifier -
-LineJustification -
-SpaceJustifier -
-
- -
Method detail
- - - - - -
clone()method
-
-public function clone():TextJustifier -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Constructs a cloned copy of the TextJustifier. -

Subclasses of TextJustifier must override this method.

-

-Returns - - - - -
TextJustifier — - A copy of the TextJustifier object. - - - -
-
- - - - - -
getJustifierForLocale()method 
-
-public static function getJustifierForLocale(locale:String):TextJustifier -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Constructs a default TextJustifier subclass appropriate to the specified locale. -

If the locale is Chinese, Korean, or Japanese, the method constructs a default EastAsianJustifier object. - Otherwise the text engine constructs a default SpaceJustifier object.

- Parameters - - - - -
locale:String — The locale to determine the justifier constructed. -
-

-Returns - - - - -
TextJustifier — - A reference to a TextJustifier object. - - -
-
-Throws - - - - -
ArgumentError — The locale specified is null or too short to represent a valid locale. - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TextLine.html b/html-docs/flash/text/engine/TextLine.html deleted file mode 100644 index 35fa7e7..0000000 --- a/html-docs/flash/text/engine/TextLine.html +++ /dev/null @@ -1,3599 +0,0 @@ - - - - - - - - -flash.text.engine.TextLine (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TextLine
InheritanceTextLine Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The TextLine class is used to display text on the display list. -

You cannot create a TextLine object directly from ActionScript code. - If you call new TextLine(), an exception is thrown. - To create a TextLine object, call the createTextLine() method of a TextBlock.

-

The TextLine encapsulates the minimum information necessary to render its contents - and to provide interactivity through some methods that describe the properties - of the atoms of the line. The term atom refers to both graphic elements and characters (including groups of combining characters), - the indivisible entities that make up a text line.

-

After normal event-dispatching for a text line finishes, if the line is valid, events are mirrored to the event dispatchers that are - specified in the eventMirror properties of the content element objects that contributed to the text line. These objects are recorded in the - TextLine.mirrorRegions property. The events are not mirrored if event propagation failed or was stopped, or if the text line is not valid.

-

Mirroring of mouse events is a special case. Because mirror regions aren't actually display objects, mouseOver and mouseOut - events are simulated for them. rollOver and rollOut events are not simulated. All naturally occurring - mouseOver, mouseOut, rollOver and rollOut events (whether targeted at the - text line or at children of the text line) are ignored - they are not mirrored.

-

The origin of a text line object is the beginning of the baseline. If you don't set the vertical position (y property) - of a line that contains Latin text on a Roman baseline, only the descenders of the text appear below the top of the Sprite to which - you add the text line. See the following diagram:

-

Text baselines

-

The TextLine class has several ancestor classes — DisplayObjectContainer, InteractiveObject, - DisplayObject, and EventDispatcher — from which it inherits properties and methods. - The following inherited properties are inapplicable to TextLine objects:

-
    -
  • contextMenu
    • -
  • focusRect
    • -
  • tabChildren
    • -
  • tabEnabled
    • -
  • tabIndex
    • -
- -

If you try to set these properties, the text engine throws the error: IllegalOperationError. You can read these properties, but they - always contain default values.

-

-

-View the examples. -

-

-See also -

-
-ContentElement.eventMirror -
-TextBlock.createTextLine() -
-TextLineValidity -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 InheritedaccessibilityImplementation : AccessibilityImplementation -
- - The current accessibility implementation (AccessibilityImplementation) - - for this InteractiveObject instance.
-		InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties -
- The current accessibility options for this display object.
-		DisplayObject
 Inheritedalpha : Number -
- Indicates the alpha transparency value of the object specified.
-		DisplayObject
  ascent : Number -
[read-only] - Specifies the number of pixels from the baseline to the top of the tallest characters in the line.
-		TextLine
  atomCount : int -
[read-only] - The number of atoms in the line, which is the number of indivisible elements, including spaces and graphic - elements.
-		TextLine
 InheritedblendMode : String -
- A value from the BlendMode class that specifies which blend mode to use.
-		DisplayObject
 InheritedblendShader : Shader -
- Sets a shader that is used for blending the foreground and background.
-		DisplayObject
 InheritedcacheAsBitmap : Boolean -
- If set to true, Flash runtimes cache an internal bitmap representation of the - display object.
-		DisplayObject
 InheritedcacheAsBitmapMatrix : Matrix -
- If non-null, this Matrix object defines how a display object is rendered when - cacheAsBitmap is set to true.
-		DisplayObject
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 InheritedcontextMenu : NativeMenu -
- - Specifies the context menu associated with this object.
-		InteractiveObject
  descent : Number -
[read-only] - Specifies the number of pixels from the baseline to the bottom of the lowest-descending characters in the line.
-		TextLine
 InheriteddoubleClickEnabled : Boolean -
- - Specifies whether the object receives doubleClick events.
-		InteractiveObject
 Inheritedfilters : Array -
- An indexed array that contains each filter object currently associated with the display object.
-		DisplayObject
 InheritedfocusRect : Object -
- - Specifies whether this object displays a focus rectangle.
-		InteractiveObject
  hasGraphicElement : Boolean -
[read-only] - Indicates whether the text line contains any graphic elements.
-		TextLine
  hasTabs : Boolean -
[read-only] - Indicates whether the text line contains any tabs.
-		TextLine
 Inheritedheight : Number -
- Indicates the height of the display object, in pixels.
-		DisplayObject
 InheritedloaderInfo : LoaderInfo -
- Returns a LoaderInfo object containing information about loading the file - to which this display object belongs.
-		DisplayObject
 Inheritedmask : DisplayObject -
- The calling display object is masked by the specified mask object.
-		DisplayObject
 InheritedmetaData : Object -
- Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the - the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
-		DisplayObject
  mirrorRegions : Vector.<TextLineMirrorRegion>
[read-only] - A Vector containing the TextLineMirrorRegion objects associated with the line, or null if none exist.
-		TextLine
 InheritedmouseChildren : Boolean -
- Determines whether or not the children of the object are mouse, or user input device, enabled.
-		DisplayObjectContainer
 InheritedmouseEnabled : Boolean -
- - Specifies whether this object receives mouse, or other user input, messages.
-		InteractiveObject
 InheritedmouseX : Number -
- Indicates the x coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 InheritedmouseY : Number -
- Indicates the y coordinate of the mouse or user input device position, in pixels.
-		DisplayObject
 Inheritedname : String -
- Indicates the instance name of the DisplayObject.
-		DisplayObject
 InheritedneedsSoftKeyboard : Boolean -
- - Specifies whether a virtual keyboard (an on-screen, software keyboard) should display - - when this InteractiveObject instance receives focus.
-		InteractiveObject
  nextLine : TextLine -
[read-only] - The next TextLine in the TextBlock, or null if the current line is the last line in the block - or the validity of the line is TextLineValidity.STATIC.
-		TextLine
 InheritednumChildren : int -
- Returns the number of children of this object.
-		DisplayObjectContainer
 InheritedopaqueBackground : Object -
- Specifies whether the display object is opaque with a certain background color.
-		DisplayObject
 Inheritedparent : DisplayObjectContainer -
- Indicates the DisplayObjectContainer object that contains this display object.
-		DisplayObject
  previousLine : TextLine -
[read-only] - The previous TextLine in the TextBlock, or null if the line is the first line in the block - or the validity of the line is TextLineValidity.STATIC.
-		TextLine
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rawTextLength : int -
[read-only] - The length of the raw text in the text block that became the line, - including the U+FDEF characters representing graphic elements - and any trailing spaces, which are part of the line but not are displayed.
-		TextLine
 Inheritedroot : DisplayObject -
- For a display object in a loaded SWF file, the root property is the - top-most display object in the portion of the display list's tree structure represented by that SWF file.
-		DisplayObject
 Inheritedrotation : Number -
- Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
-		DisplayObject
 InheritedrotationX : Number -
- Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationY : Number -
- Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 InheritedrotationZ : Number -
- Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
-		DisplayObject
 Inheritedscale9Grid : Rectangle -
- The current scaling grid that is in effect.
-		DisplayObject
 InheritedscaleX : Number -
- Indicates the horizontal scale (percentage) of the object as applied from the registration point.
-		DisplayObject
 InheritedscaleY : Number -
- Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscaleZ : Number -
- Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
-		DisplayObject
 InheritedscrollRect : Rectangle -
- The scroll rectangle bounds of the display object.
-		DisplayObject
 InheritedsoftKeyboard : String -
- - Controls the appearance of the soft keyboard.
-		InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle -
- - Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
-		InteractiveObject
  specifiedWidth : Number -
[read-only] - The width that was specified to the TextBlock.createTextLine() method when it created the line.
-		TextLine
 Inheritedstage : Stage -
- The Stage of the display object.
-		DisplayObject
 InheritedtabChildren : Boolean -
- Determines whether the children of the object are tab enabled.
-		DisplayObjectContainer
 InheritedtabEnabled : Boolean -
- - Specifies whether this object is in the tab order.
-		InteractiveObject
 InheritedtabIndex : int -
- - Specifies the tab ordering of objects in a SWF file.
-		InteractiveObject
  textBlock : TextBlock -
[read-only] - The TextBlock containing this text line, or null if the validity of the line is TextLineValidity.STATIC, - meaning that the connection between the line and the TextBlock has been severed.
-		TextLine
  textBlockBeginIndex : int -
[read-only] - The index of the first character of the line in the raw text of the text block.
-		TextLine
  textHeight : Number -
[read-only] - The logical height of the text line, which is equal to ascent + descent.
-		TextLine
 InheritedtextSnapshot : TextSnapshot -
- Returns a TextSnapshot object for this DisplayObjectContainer instance.
-		DisplayObjectContainer
  textWidth : Number -
[read-only] - The logical width of the text line, which is the width that the text engine uses to lay out the line.
-		TextLine
  totalAscent : Number -
[read-only] - Specifies the number of pixels from the baseline to the top of the tallest character or graphic in the line.
-		TextLine
  totalDescent : Number -
[read-only] - Specifies the number of pixels from the baseline to the bottom of the lowest-descending character or graphic in the line.
-		TextLine
  totalHeight : Number -
[read-only] - The total logical height of the text line, which is equal to totalAscent + totalDescent.
-		TextLine
 Inheritedtransform : Transform -
- An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
-		DisplayObject
  unjustifiedTextWidth : Number -
[read-only] - The width of the line if it was not justified.
-		TextLine
  userData : * -
- Provides a way for the application to associate arbitrary data with the text line.
-		TextLine
  validity : String -
- Specifies the current validity of the text line.
-		TextLine
 Inheritedvisible : Boolean -
- Whether or not the display object is visible.
-		DisplayObject
 Inheritedwidth : Number -
- Indicates the width of the display object, in pixels.
-		DisplayObject
 Inheritedx : Number -
- Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedy : Number -
- Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of - the parent DisplayObjectContainer.
-		DisplayObject
 Inheritedz : Number -
- Indicates the z coordinate position along the z-axis of the DisplayObject - instance relative to the 3D parent container.
-		DisplayObject
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addChild(child:DisplayObject):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-addChildAt(child:DisplayObject, index:int):DisplayObject -
-
- Adds a child DisplayObject instance to this DisplayObjectContainer - instance.
-		DisplayObjectContainer
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-areInaccessibleObjectsUnderPoint(point:Point):Boolean -
-
- Indicates whether the security restrictions - would cause any display objects to be omitted from the list returned by calling - the DisplayObjectContainer.getObjectsUnderPoint() method - with the specified point point.
-		DisplayObjectContainer
 Inherited -
-contains(child:DisplayObject):Boolean -
-
- Determines whether the specified display object is a child of the DisplayObjectContainer instance or - the instance itself.
-		DisplayObjectContainer
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-dump():String -
-
- Dumps the underlying contents of the TextLine as an XML string.
-		TextLine
   -
-getAtomBidiLevel(atomIndex:int):int -
-
- Gets the bidirectional level of the atom at the specified index.
-		TextLine
   -
-getAtomBounds(atomIndex:int):Rectangle -
-
- Gets the bounds of the atom at the specified index relative to the text line.
-		TextLine
   -
-getAtomCenter(atomIndex:int):Number -
-
- Gets the center of the atom as measured along the baseline at the specified index.
-		TextLine
   -
-getAtomGraphic(atomIndex:int):DisplayObject -
-
- Gets the graphic of the atom at the specified index, or null if the atom is a character.
-		TextLine
   -
-getAtomIndexAtCharIndex(charIndex:int):int -
-
- Returns the index of the atom containing the character specified by the charIndex parameter, - or -1 if the character does not contribute to any atom in the line.
-		TextLine
   -
-getAtomIndexAtPoint(stageX:Number, stageY:Number):int -
-
- Returns the index of the atom at the point specified by the x - and y parameters, or -1 if no atom exists at that point.
-		TextLine
   -
-getAtomTextBlockBeginIndex(atomIndex:int):int -
-
- Gets the text block begin index of the atom at the specified index.
-		TextLine
   -
-getAtomTextBlockEndIndex(atomIndex:int):int -
-
- Gets the text block end index of the atom at the specified index.
-		TextLine
   -
-getAtomTextRotation(atomIndex:int):String -
-
- Gets the rotation of the atom at the specified index.
-		TextLine
   -
-getAtomWordBoundaryOnLeft(atomIndex:int):Boolean -
-
- Indicates whether a word boundary occurs to the left of the atom at the specified index.
-		TextLine
   -
-getBaselinePosition(baseline:String):Number -
-
- Gets the position of the specified baseline, relative to TextBlock.baselineZero.
-		TextLine
 Inherited -
-getBounds(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the area of the display object relative to the coordinate system - of the targetCoordinateSpace object.
-		DisplayObject
 Inherited -
-getChildAt(index:int):DisplayObject -
-
- Returns the child display object instance that exists at the specified index.
-		DisplayObjectContainer
 Inherited -
-getChildByName(name:String):DisplayObject -
-
- Returns the child display object that exists with the specified name.
-		DisplayObjectContainer
 Inherited -
-getChildIndex(child:DisplayObject):int -
-
- Returns the index position of a child DisplayObject instance.
-		DisplayObjectContainer
   -
-getMirrorRegion(mirror:EventDispatcher):TextLineMirrorRegion -
-
- Returns the first TextLineMirrorRegion on the line whose mirror property matches - that specified by the mirror parameter, or null if no match exists.
-		TextLine
 Inherited -
-getObjectsUnderPoint(point:Point):Array -
-
- Returns an array of objects that lie under the specified point and are children - (or grandchildren, and so on) of this DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-getRect(targetCoordinateSpace:DisplayObject):Rectangle -
-
- Returns a rectangle that defines the boundary of the display object, - based on the coordinate system defined by the targetCoordinateSpace - parameter, excluding any strokes on shapes.
-		DisplayObject
 Inherited -
-globalToLocal(point:Point):Point -
-
- Converts the point object from the Stage (global) coordinates - to the display object's (local) coordinates.
-		DisplayObject
 Inherited -
-globalToLocal3D(point:Point):Vector3D -
-
- Converts a two-dimensional point from the Stage (global) coordinates to a - three-dimensional display object's (local) coordinates.
-		DisplayObject
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-hitTestObject(obj:DisplayObject):Boolean -
-
- Evaluates the bounding box of the display object to see if it overlaps or intersects with the - bounding box of the obj display object.
-		DisplayObject
 Inherited -
-hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean -
-
- Evaluates the display object to see if it overlaps or intersects with the - point specified by the x and y parameters.
-		DisplayObject
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-local3DToGlobal(point3d:Vector3D):Point -
-
- Converts a three-dimensional point of the three-dimensional display - object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
-		DisplayObject
 Inherited -
-localToGlobal(point:Point):Point -
-
- Converts the point object from the display object's (local) coordinates to the - Stage (global) coordinates.
-		DisplayObject
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeChild(child:DisplayObject):DisplayObject -
-
- Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeChildAt(index:int):DisplayObject -
-
- Removes a child DisplayObject from the specified index position in the child list of - the DisplayObjectContainer.
-		DisplayObjectContainer
 Inherited -
-removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void -
-
- Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
-		DisplayObjectContainer
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-requestSoftKeyboard():Boolean -
-
- - Raises a virtual keyboard.
-		InteractiveObject
 Inherited -
-setChildIndex(child:DisplayObject, index:int):void -
-
- Changes the position of an existing child in the display object container.
-		DisplayObjectContainer
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-stopAllMovieClips():void -
-
- Recursively stops the timeline execution of all MovieClips rooted at this object.
-		DisplayObjectContainer
 Inherited -
-swapChildren(child1:DisplayObject, child2:DisplayObject):void -
-
- Swaps the z-order (front-to-back order) of the two specified child objects.
-		DisplayObjectContainer
 Inherited -
-swapChildrenAt(index1:int, index2:int):void -
-
- Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the - child list.
-		DisplayObjectContainer
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-added -
-		 - Dispatched when a display object is added to the display list.DisplayObject
 Inherited -
-addedToStage -
-		 - Dispatched when a display object is added to the on stage display list, - either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-clear -
-		 - - Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 Inherited -
-click -
-		 - - Dispatched when a user presses and releases the main button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-contextMenu -
-		 - - Dispatched when a user gesture triggers the context menu associated with this interactive - - object in an AIR application.InteractiveObject
 Inherited -
-copy -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a copy operation - - or selects 'Copy' from the text context menu.InteractiveObject
 Inherited -
-cut -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a cut operation - - or selects 'Cut' from the text context menu.InteractiveObject
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-doubleClick -
-		 - - Dispatched when a user presses and releases the main button of a pointing device twice in - - rapid succession over the same InteractiveObject when that object's - - doubleClickEnabled flag is set to true.InteractiveObject
 Inherited -
-enterFrame -
-		 - [broadcast event] Dispatched when the playhead is entering a new - frame.DisplayObject
 Inherited -
-exitFrame -
-		 - [broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 Inherited -
-focusIn -
-		 - - Dispatched after a display object gains focus.InteractiveObject
 Inherited -
-focusOut -
-		 - - Dispatched after a display object loses focus.InteractiveObject
 Inherited -
-frameConstructed -
-		 - [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 Inherited -
-gestureDirectionalTap -
-		 - - Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, - - (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) - - Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 Inherited -
-gestureLongPress -
-		 - - Dispatched when the user presses two points of contact over the same InteractiveObject instance - - on a touch-enabled device (such as presses and releases two fingers over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gesturePan -
-		 - - Dispatched when the user moves a point of contact over the InteractiveObject instance - - on a touch-enabled device (such as moving a finger from left to right over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureRotate -
-		 - - Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers - - and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureSwipe -
-		 - - Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three - - fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureTap -
-		 - - Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps - - on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item - - on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-gestureZoom -
-		 - - Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two - - fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-imeStartComposition -
-		 - - This event is dispatched to any client app that supports inline input with an IME - - - - InteractiveObject
 Inherited -
-keyDown -
-		 - - Dispatched when the user presses a key.InteractiveObject
 Inherited -
-keyFocusChange -
-		 - - Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited -
-keyUp -
-		 - - Dispatched when the user releases a key.InteractiveObject
 Inherited -
-middleClick -
-		 - - Dispatched when a user presses and releases the middle button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-middleMouseDown -
-		 - - Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-middleMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseFocusChange -
-		 - - Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 Inherited -
-mouseMove -
-		 - - Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 Inherited -
-mouseOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheel -
-		 - - Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-mouseWheelHorizontal -
-		 - - Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 Inherited -
-nativeDragComplete -
-		 - - Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 Inherited -
-nativeDragDrop -
-		 - - Dispatched by the target InteractiveObject when a dragged object is - - dropped on it and the drop has been accepted with a call to - - DragManager.acceptDragDrop().InteractiveObject
 Inherited -
-nativeDragEnter -
-		 - - Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 Inherited -
-nativeDragExit -
-		 - - Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 Inherited -
-nativeDragOver -
-		 - - Dispatched by an InteractiveObject continually while a drag gesture remains within its - - boundary.InteractiveObject
 Inherited -
-nativeDragStart -
-		 - - Dispatched at the beginning of a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-nativeDragUpdate -
-		 - - Dispatched during a drag operation by the InteractiveObject that is - - specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 Inherited -
-paste -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a paste operation - - or selects 'Paste' from the text context menu.InteractiveObject
 Inherited -
-proximityBegin -
-		 - - Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityEnd -
-		 - - Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityMove -
-		 - - Dispatched when the user moves an active stylus over the screen while remaining within - - the proximity detection threshold.InteractiveObject
 Inherited -
-proximityOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within - - the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityOver -
-		 - - Dispatched when the user moves an active stylus directly above this InteractiveObject - - while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOut -
-		 - - Dispatched when the user moves an active stylus away from this InteractiveObject - - and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 Inherited -
-proximityRollOver -
-		 - - Dispatched when the user moves an active stylus over this InteractiveObject from outside the - - object's tree of descendents in the display list - - (while remaining within the proximity detection threshold of the screen).InteractiveObject
 Inherited -
-releaseOutside -
-		 - - Dispatched when a user releases the button on the pointing device after the - - user first pressed the button over an InteractiveObject instance - - and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 Inherited -
-removed -
-		 - Dispatched when a display object is about to be removed from the display list.DisplayObject
 Inherited -
-removedFromStage -
-		 - Dispatched when a display object is about to be removed from the display list, - either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited -
-render -
-		 - [broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 Inherited -
-rightClick -
-		 - - Dispatched when a user presses and releases the right button of the user's - - pointing device over the same InteractiveObject.InteractiveObject
 Inherited -
-rightMouseDown -
-		 - - Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited -
-rightMouseUp -
-		 - - Dispatched when a user releases the pointing device button over an - - InteractiveObject instance.InteractiveObject
 Inherited -
-rollOut -
-		 - - Dispatched when the user moves a pointing device away from an InteractiveObject - - instance.InteractiveObject
 Inherited -
-rollOver -
-		 - - Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 Inherited -
-selectAll -
-		 - - Dispatched when the user activates the platform-specific accelerator key combination for a select all operation - - or selects 'Select All' from the text context menu.InteractiveObject
 Inherited -
-softKeyboardActivate -
-		 - - Dispatched immediately after the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardActivating -
-		 - - Dispatched immediately before the soft keyboard is raised.InteractiveObject
 Inherited -
-softKeyboardDeactivate -
-		 - - Dispatched immediately after the soft keyboard is lowered.InteractiveObject
 Inherited -
-tabChildrenChange -
-		 - - Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
 Inherited -
-tabEnabledChange -
-		 - - Dispatched when the object's tabEnabled flag changes.InteractiveObject
 Inherited -
-tabIndexChange -
-		 - - Dispatched when the value of the object's tabIndex property changes.InteractiveObject
 Inherited -
-textInput -
-		 - - Dispatched when a user enters one or more - - characters of text.InteractiveObject
 Inherited -
-touchBegin -
-		 - - Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchEnd -
-		 - - Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchMove -
-		 - - Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 Inherited -
-touchOut -
-		 - - Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device - - (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOut -
-		 - - Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchRollOver -
-		 - - Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device - - (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 Inherited -
-touchTap -
-		 - - Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated - - on a touch-enabled device (such as presses and releases a finger from a single point over a display object - - on a mobile phone or tablet with a touch screen).InteractiveObject
-
- -
-
Public Constants
- - - - - - - -
 ConstantDefined by
  MAX_LINE_WIDTH : int = 1000000
[static] - The maximum requested width of a text line, in pixels.
-		TextLine
-
- -
- -
Property detail
- - - - - -
ascentproperty
-
-ascent:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the number of pixels from the baseline to the top of the tallest characters in the line. For a TextLine that contains only a - graphic element, ascent is set to 0. -

Implementation -
-    public function get ascent():Number -
-
- - - - - -
atomCountproperty 
-
-atomCount:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The number of atoms in the line, which is the number of indivisible elements, including spaces and graphic - elements. -

Implementation -
-    public function get atomCount():int -
-
-Throws -
- - - - -
Error — The validity of the line is TextLineValidity.STATIC. - -
-
- - - - - -
descentproperty 
-
-descent:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the number of pixels from the baseline to the bottom of the lowest-descending characters in the line. For a TextLine that - contains only a graphic element, descent is set to 0. -

Implementation -
-    public function get descent():Number -
-
- - - - - -
hasGraphicElementproperty 
-
-hasGraphicElement:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates whether the text line contains any graphic elements. -

Implementation -
-    public function get hasGraphicElement():Boolean -
-

-See also -

-
-GraphicElement -
-
- - - - - -
hasTabsproperty 
-
-hasTabs:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates whether the text line contains any tabs. -

Implementation -
-    public function get hasTabs():Boolean -
-
- - - - - -
mirrorRegionsproperty 
-
-mirrorRegions:Vector.<TextLineMirrorRegion>  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- A Vector containing the TextLineMirrorRegion objects associated with the line, or null if none exist. -

Implementation -
-    public function get mirrorRegions():Vector.<TextLineMirrorRegion> -
-

-See also -

-
-ContentElement.eventMirror -
-TextLineMirrorRegion -
-
- - - - - -
nextLineproperty 
-
-nextLine:TextLine  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The next TextLine in the TextBlock, or null if the current line is the last line in the block - or the validity of the line is TextLineValidity.STATIC. -

Implementation -
-    public function get nextLine():TextLine -
-

-See also -

-
-previousLine -
-
- - - - - -
previousLineproperty 
-
-previousLine:TextLine  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The previous TextLine in the TextBlock, or null if the line is the first line in the block - or the validity of the line is TextLineValidity.STATIC. -

Implementation -
-    public function get previousLine():TextLine -
-

-See also -

-
-nextLine -
-
- - - - - -
rawTextLengthproperty 
-
-rawTextLength:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The length of the raw text in the text block that became the line, - including the U+FDEF characters representing graphic elements - and any trailing spaces, which are part of the line but not are displayed. -

Implementation -
-    public function get rawTextLength():int -
-

-See also -

-
-TextBlock -
-ContentElement.rawText -
-
- - - - - -
specifiedWidthproperty 
-
-specifiedWidth:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The width that was specified to the TextBlock.createTextLine() method when it created the line. - This value is useful when deciding if a change requires rebreaking the line. -

Implementation -
-    public function get specifiedWidth():Number -
-

-See also -

-
-TextBlock.createTextLine() -
-textWidth -
-unjustifiedTextWidth -
-
- - - - - -
textBlockproperty 
-
-textBlock:TextBlock  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The TextBlock containing this text line, or null if the validity of the line is TextLineValidity.STATIC, - meaning that the connection between the line and the TextBlock has been severed. -

Implementation -
-    public function get textBlock():TextBlock -
-

-See also -

-
-TextBlock -
-TextLineValidity -
-
- - - - - -
textBlockBeginIndexproperty 
-
-textBlockBeginIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The index of the first character of the line in the raw text of the text block. -

Implementation -
-    public function get textBlockBeginIndex():int -
-

-See also -

-
-TextBlock -
-
- - - - - -
textHeightproperty 
-
-textHeight:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The logical height of the text line, which is equal to ascent + descent. - To get the inked height, access the inherited height property. -

The value is calculated based on the difference between the baselines that bound the line, - either ideo top/bottom or ascent/descent depending on whether TextBlock.baselineZero is ideo or not. - Graphic elements are not considered when computing these baselines.

- Implementation -
-    public function get textHeight():Number -
-

-See also -

-
-DisplayObject.height -
-
- - - - - -
textWidthproperty 
-
-textWidth:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The logical width of the text line, which is the width that the text engine uses to lay out the line. Access the inherited - width property to get the actual width of the bounding box of all the drawn pixels. -

Implementation -
-    public function get textWidth():Number -
-

-See also -

-
-specifiedWidth -
-DisplayObject.width -
-
-Example -
This example displays a line once in normal posture and once in - italic, and traces the values of the specifiedWidth, textWidth - and width properties in each case. - The trace output is: -
    -
  • specifiedWidth is: 500
    • -
  • textWidth is: 268.9921875
    • -
  • width is: 269
    • -
  • specifiedWidth is: 500
    • -
  • textWidth is: 267.52734375
    • -
  • width is: 267.55
    • -
-
-
- 
-package {
-import flash.display.Sprite;
-import flash.text.engine.TextBlock;
-import flash.text.engine.TextElement;
-import flash.text.engine.TextLine;
-import flash.text.engine.FontDescription;
-import flash.text.engine.ElementFormat;
-import flash.text.engine.FontPosture;
-
-	public class TextLine_textWidthExample extends Sprite {
-		
-		public function TextLine_textWidthExample() {
-			
-			var str:String = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, ";
-			var yPos:Number = 20;
-			var fontDescription:FontDescription = new FontDescription();
-			var textBlock:TextBlock = new TextBlock();
-			fontDescription.fontPosture = FontPosture.NORMAL;
-			var format:ElementFormat = new ElementFormat(fontDescription, 12);
-			var textElement:TextElement = new TextElement(str, format);
-			textBlock.content = textElement;
-			createLine(textBlock, yPos);
-			var fontDescriptionItalic = fontDescription.clone();
-			fontDescriptionItalic.fontPosture = FontPosture.ITALIC;
-			var formatItalic = new ElementFormat(fontDescriptionItalic, 12);
-			textElement = new TextElement(str, formatItalic);
-			textBlock.content = textElement;
-			createLine(textBlock, yPos + 20);
-		}
-
-		private function createLine(textBlock:TextBlock, yPos:Number):void {
-			var textLine:TextLine = textBlock.createTextLine (null, 500);
-			trace("specifiedWidth is: " + textLine.specifiedWidth);
-			trace("textWidth is: " + textLine.textWidth);
-			trace("width is: " + textLine.width);
-			addChild(textLine);
-			textLine.x = 15;
-			textLine.y = yPos;     
-		}
-	}
-}
-
-

-
- - - - - -
totalAscentproperty 
-
-totalAscent:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies the number of pixels from the baseline to the top of the tallest character or graphic in the line. -

Implementation -
-    public function get totalAscent():Number -
-
- - - - - -
totalDescentproperty 
-
-totalDescent:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies the number of pixels from the baseline to the bottom of the lowest-descending character or graphic in the line. -

Implementation -
-    public function get totalDescent():Number -
-
- - - - - -
totalHeightproperty 
-
-totalHeight:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The total logical height of the text line, which is equal to totalAscent + totalDescent. -

Implementation -
-    public function get totalHeight():Number -
-
- - - - - -
unjustifiedTextWidthproperty 
-
-unjustifiedTextWidth:Number  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The width of the line if it was not justified. For unjustified text, this value is the same as textWidth. For - justified text, this value is what the length would have been without justification, and textWidth represents - the actual line width. For example, when the following String is justified and submitted to TextBlock.createTextLine() - with a width of 500, it has an actual width of 500 but an unjustified width of 268.9921875. -

Implementation -
-    public function get unjustifiedTextWidth():Number -
-

-See also -

-
-EastAsianJustifier -
-LineJustification -
-SpaceJustifier -
-specifiedWidth -
-textWidth -
-
-Example -

-
- - - - - -
userDataproperty 
-
-public var userData:* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Provides a way for the application to associate arbitrary data with the text line. -

- - - - - -
validityproperty 
-
-validity:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies the current validity of the text line. - Values for this property are found in the members of the - TextLineValidity class. - The rules for setting this property are as follows: -

A line is considered USER_INVALID if validity is set to any string which is not a member of TextLineValidity. - USER_INVALID is an abstraction used here to represent any such value.

-

When the contents of the TextBlock are modified, the Flash runtime marks affected text lines, the previous line, and all following lines as INVALID. - The previous line must be marked invalid when a change allows the previous line to absorb part of the content that was - originally on the first affected line.

-

Newly broken lines are always VALID. The Flash runtime may change lines that follow from VALID to POSSIBLY_INVALID or INVALID. - It may change POSSIBLY_INVALID lines to VALID if the line breaks match up, or to INVALID if they don't.

-

Application code can mark VALID lines as INVALID or USER_INVALID, and can mark USER_INVALID lines as VALID. Application code cannot mark lines POSSIBLY_INVALID.

-

Application code can mark any line STATIC. Doing so causes the block member to become null. - Any graphic elements in a STATIC text line are removed and reparented if they are part of a new text line broken - from the text block from which the STATIC text line originally derived.

- Implementation -
-    public function get validity():String -
-    public function set validity(value:String):void -
-
-Throws -
- - - - - - - - - - - - - - - - - - - - - - -
ArgumentError — If current value is TextLineValidity.STATIC. -
 
ArgumentError — If current value is TextLineValidity.INVALID and new value is anything other than - TextValidity.STATIC. -
 
ArgumentError — If current value is TextLineValidity.POSSIBLY_INVALID and new value is - TextLineValidity.VALID. -
 
ArgumentError — If new value is TextLineValidity.POSSIBLY_INVALID. -
-

-See also -

-
-TextBlock.firstInvalidLine -
-TextLineValidity -
-
- -
Method detail
- - - - - -
dump()method
-
-public function dump():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Dumps the underlying contents of the TextLine as an XML string. - This can be useful in automated testing, and includes text, formatting, and layout information. - -

The following describes the output:

- 
-	 [LINE]
-	 <line ascent=[Number] descent=[Number] rotation=[int]>
-	 	<elements>
-	 		[0-N ELEMENT]
-	 	</elements>
-	 	<clusters>
-	 		[0-N CLUSTER]
-	 	</clusters>
-	 </line>
-	 	 [ELEMENT]
-	 <glyph isEmbedded=[Boolean] fontName=[String] isBold=[Boolean] isItalic=[Boolean] gid=[int] pointSize=[Number] x=[Number] y=[Number] rotation=[int]/>
-	 or
-	 <graphic child=[int] x=[Number] y=[Number] rotation=[int]/>
-	 or
-	 <embeddedRun x=[Number] y=[Number]>
-	 	[LINE]
-	 </embeddedRun>
-	 	 [CLUSTER]
-	 <cluster xLeft=[Number] xCenter=[Number] xRight=[Number] cursorOnLeft=[Boolean] cursorOnRight=[Boolean] wordBoundaryOnLeft=[Boolean] wordBoundaryOnRight=[Boolean]/>
-
- -

Note: The content and format of the output from this method could change in the future. Adobe does not guarantee backward - compatibility for this method.

-

-Returns - - - - -
String
-

-See also -

-
-TextBlock.dump() -
-
- - - - - -
getAtomBidiLevel()method 
-
-public function getAtomBidiLevel(atomIndex:int):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Gets the bidirectional level of the atom at the specified index. Determined by a combination of - TextBlock.bidiLevel and the Unicode bidirectional properties of the characters that - form the line. -

For example, if you start a text block with some Hebrew text, you set TextBlock.bidiLevel to 1, establishing - a default of right to left. If within the text you have a quote in English (left to right), that text has an AtomBidiLevel of - 2. If within the English you have a bit of Arabic (right to left), AtomBidiLevel for that run goes to 3. If within the - Arabic a number (left to right) occurs, the AtomBidiLevel setting for the number is 4. It does not matter in which line the - atoms end up; the Hebrew atoms are AtomBidiLevel 1, the English atoms are AtomBidiLevel 2, Arabic atoms - are AtomBidiLevel 3, and the number atoms are AtomBidiLevel 4.

- Parameters - - - - -
atomIndex:int — The zero-based index value of the atom (for example, the first atom is 0, - the second atom is 1, and so on). -
-

-Returns - - - - -
int — - The bidirectional level of the atom at atomIndex. - - -
-
-Throws - - - - - - - - - - -
RangeError — The specified atom index is out of range. -
 
Error — The validity of the line is TextLineValidity.STATIC. - -
-

-See also -

-
-TextBlock.bidiLevel -
-
- - - - - -
getAtomBounds()method 
-
-public function getAtomBounds(atomIndex:int):Rectangle -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Gets the bounds of the atom at the specified index relative to the text line. The bounds of the specified atom consist of - its horizontal position (x) in the line, its vertical position in the line (y), its width (w), - and its height (h). All values are in pixels. -

Parameters - - - - -
atomIndex:int — The zero-based index value of the atom (for example, the first atom is 0, - the second atom is 1, and so on). -
-

-Returns - - - - -
Rectangle — - The bounds of the atom at atomIndex. - - -
-
-Throws - - - - - - - - - - -
RangeError — The atom index specified is out of range. -
 
Error — The validity of the line is TextLineValidity.STATIC. - -
-
- - - - - -
getAtomCenter()method 
-
-public function getAtomCenter(atomIndex:int):Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Gets the center of the atom as measured along the baseline at the specified index. -

Parameters - - - - -
atomIndex:int — The zero-based index value of the atom (for example, the first atom is 0, - the second atom is 1, and so on). -
-

-Returns - - - - -
Number — - The center of the atom at atomIndex. - - -
-
-Throws - - - - - - - - - - -
RangeError — The atom index specified is out of range. -
 
Error — The validity of the line is TextLineValidity.STATIC. - -
-
- - - - - -
getAtomGraphic()method 
-
-public function getAtomGraphic(atomIndex:int):DisplayObject -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Gets the graphic of the atom at the specified index, or null if the atom is a character. -

Parameters - - - - -
atomIndex:int — The zero-based index value of the atom (for example, the first atom is 0, - the second atom is 1, and so on). -
-

-Returns - - - - -
DisplayObject — - The graphic of the atom at atomIndex. - - -
-
-Throws - - - - - - - - - - -
RangeError — The atom index specified is out of range. -
 
Error — The validity of the line is TextLineValidity.STATIC. - -
-
- - - - - -
getAtomIndexAtCharIndex()method 
-
-public function getAtomIndexAtCharIndex(charIndex:int):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the index of the atom containing the character specified by the charIndex parameter, - or -1 if the character does not contribute to any atom in the line. - The charIndex is relative to the entire contents of the text block containing the line. -

Parameters - - - - -
charIndex:int — The zero-based index value of the character (for example, the first character is 0, - the second character is 1, and so on). -
-

-Returns - - - - -
int — - The index of the atom containing the character at charIndex. - Returns -1 if the character does not contribute to any atom in the line. - - -
-
-Throws - - - - -
Error — The validity of the line is TextLineValidity.STATIC. - -
-
- - - - - -
getAtomIndexAtPoint()method 
-
-public function getAtomIndexAtPoint(stageX:Number, stageY:Number):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the index of the atom at the point specified by the x - and y parameters, or -1 if no atom exists at that point. -

This method takes global coordinates so that you can easily use it with MouseEvent.stageX - and MouseEvent.stageY properties.

- Parameters - - - - - - - - - - -
stageX:Number — The global x coordinate of the point to test. -
 
stageY:Number — The global y coordinate of the point to test. -
-

-Returns - - - - -
int — - The index of the atom under the point. Returns -1 if the point is not over any atom. - - -
-
-Throws - - - - -
Error — The validity of the line is TextLineValidity.STATIC. - -
-
- - - - - -
getAtomTextBlockBeginIndex()method 
-
-public function getAtomTextBlockBeginIndex(atomIndex:int):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Gets the text block begin index of the atom at the specified index. -

Parameters - - - - -
atomIndex:int — The zero-based index value of the atom (for example, the first atom is 0, - the second atom is 1, and so on). -
-

-Returns - - - - -
int — - The text block begin index of the atom at atomIndex. - - -
-
-Throws - - - - - - - - - - -
RangeError — The atom index specified is out of range. -
 
Error — The validity of the line is TextLineValidity.STATIC. - -
-
- - - - - -
getAtomTextBlockEndIndex()method 
-
-public function getAtomTextBlockEndIndex(atomIndex:int):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Gets the text block end index of the atom at the specified index. -

Parameters - - - - -
atomIndex:int — The zero-based index value of the atom (for example, the first atom is 0, - the second atom is 1, and so on). -
-

-Returns - - - - -
int — - The text block end index of the atom at atomIndex. - - -
-
-Throws - - - - - - - - - - -
RangeError — The atom index specified is out of range. -
 
Error — The validity of the line is TextLineValidity.STATIC. - -
-
- - - - - -
getAtomTextRotation()method 
-
-public function getAtomTextRotation(atomIndex:int):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Gets the rotation of the atom at the specified index. TextRotation constants are used for this property. - The rotation of the atom is the cumulative rotations of the element and the line. Its primary use is for - setting the orientation of the caret (cursor) when interacting with a TextLine. -

Parameters - - - - -
atomIndex:int — The zero-based index value of the atom (for example, the first atom is 0, - the second atom is 1, and so on). -
-

-Returns - - - - -
String — - The rotation of the atom at atomIndex. - - -
-
-Throws - - - - - - - - - - -
RangeError — The specified atom index is out of range. -
 
Error — The validity of the line is TextLineValidity.STATIC. - -
-

-See also -

-
-ElementFormat.textRotation -
-
- - - - - -
getAtomWordBoundaryOnLeft()method 
-
-public function getAtomWordBoundaryOnLeft(atomIndex:int):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates whether a word boundary occurs to the left of the atom at the specified index. - Word boundaries are determined based on the Unicode properties of the characters which contributed to the line. - -

Parameters - - - - -
atomIndex:int — The zero-based index value of the atom (for example, the first atom is 0, - the second atom is 1, and so on). -
-

-Returns - - - - -
Boolean — - A Boolean value that indicates whether a word boundary occurs to the left of the atom at atomIndex. - - -
-
-Throws - - - - - - - - - - -
RangeError — The atom index specified is out of range. -
 
Error — The validity of the line is TextLineValidity.STATIC. - -
-
- - - - - -
getBaselinePosition()method 
-
-public function getBaselinePosition(baseline:String):Number -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Gets the position of the specified baseline, relative to TextBlock.baselineZero. -

Parameters - - - - -
baseline:String — The baseline for which to retrieve the position. Use TextBaseline values. -
-

-Returns - - - - -
Number — - The position of the specified baseline relative to TextBlock.baselineZero. - - -
-
-Throws - - - - -
ArgumentError — If the baseline specified is not a member of TextBaseline. - -
-

-See also -

-
-TextBlock.baselineZero -
-TextBaseline -
-
- - - - - -
getMirrorRegion()method 
-
-public function getMirrorRegion(mirror:EventDispatcher):TextLineMirrorRegion -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Returns the first TextLineMirrorRegion on the line whose mirror property matches - that specified by the mirror parameter, or null if no match exists. -

Even a single TextElement can produce multiple TextLineMirrorRegion - objects on one or more lines, depending on bidirectional level and line breaking. The nextRegion and - previousRegion properties link all the mirror regions generated from one text element.

- Parameters - - - - -
mirror:EventDispatcher — The EventDispatcher mirror object to search for. -
-

-Returns - - - - -
TextLineMirrorRegion — - The first TextLineMirrorRegion on the line whose mirror property matches - the specified value, or null if no match exists. - - - -
-

-See also -

-
-TextLineMirrorRegion -
-ContentElement.eventMirror -
-
- -
Constant detail
- - - - - -
MAX_LINE_WIDTHconstant
-
-public static const MAX_LINE_WIDTH:int = 1000000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The maximum requested width of a text line, in pixels. The TextBlock.createTextLine() method uses this constant - as the default value for the width parameter, if you do not specify a value. - -

-See also -

-
-TextBlock.createTextLine() -
-
- -
Examples
-
examples\TextLineExample
-
This example displays various text lines and steps through the atoms in a text - block, using getAtomBounds() to frame each one. - -
    -
  1. Add the NumericStepper component to the library.
    2. -
  2. Save this code as TextLineExample.as in the same directory as your FLA.
    3. -
  3. Set the Class in the Properties window of the FLA to TextLineExample.
    4. -
-
-
-package {
-	import flash.display.Sprite;
-	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.ElementFormat;
-	import flash.text.engine.FontDescription;
-	import flash.text.engine.FontPosture;
-	import flash.text.engine.FontWeight;
-	import fl.controls.NumericStepper;
-	import flash.events.Event;
-	import flash.geom.Rectangle;
-	
-	public class TextLineExample extends Sprite {
-		
-		private var atomStepper:NumericStepper = new NumericStepper();
-		private var atomDataContainer:Sprite;
-		private var fontDescriptionItalic:FontDescription = new FontDescription("Arial", FontWeight.NORMAL, FontPosture.ITALIC);
-		private var fontDescriptionNormal:FontDescription = new FontDescription("Arial", FontWeight.NORMAL , FontPosture.NORMAL);
-		private var textBlock:TextBlock = new TextBlock();
-		private var textLine:TextLine;
-		
-		public function TextLineExample():void {
-			
-			var myText:String = "I am a TextElement, created from a String and assigned " +
-			"to the content property of a TextBlock. From the text block, " +
-			"the createTextLine() method created these lines, 300 pixels wide, "  +
-			"for display." ;
-			
-			atomStepper.minimum = 0;
-			atomStepper.value = 0;
-			atomStepper.width = 50;
-			addChild(atomStepper);
-			atomStepper.x = 20;
-			atomStepper.y = 120;
-			atomStepper.addEventListener(Event.CHANGE, nsChange);
-			
-			var directions:String = "Click up / down arrows to frame atoms in text block above.";
-			
-			var formatItalic:ElementFormat = new ElementFormat(fontDescriptionItalic);
-			formatItalic.fontSize = 12;
-			var textElement1:TextElement = new TextElement(directions, formatItalic);
-			textBlock.content = textElement1;
-			createLines(textBlock, 15, 160, 400, this);
-			
-			var formatNormal:ElementFormat = new ElementFormat(fontDescriptionNormal);
-			formatNormal.fontSize = 16;
-			var textElement2:TextElement = new TextElement(myText, formatNormal);
-			textBlock.content = textElement2;
-			createLines(textBlock, 15.0, 20.0, 300, this);
-			textLine = textBlock.firstLine;
-			atomStepper.maximum = textLine.atomCount - 1;
-			showAtom(textLine, 0);
-		}
-			
-		private function nsChange(event:Event):void
-		{
-			removeAtom(textLine);
-			if (atomStepper.value == textLine.atomCount - 1)
-			{
-				if(textLine != textBlock.lastLine)
-				{
-					textLine = textLine.nextLine;
-					atomStepper.maximum = textLine.atomCount - 1;
-					atomStepper.value = 0;
-				}
-			}
-			showAtom(textLine, atomStepper.value);
-		}
-			
-		private function createLines(textBlock, startX, startY, width, container)
-		{
-			var textLine:TextLine = textBlock.createTextLine (null, width);
-			while (textLine)
-			{
-				textLine.x = startX;
-				textLine.y = startY;
-				startY += textLine.height + 2;
-				container.addChild(textLine);
-				textLine = textBlock.createTextLine (textLine, width);
-			}
-		}
-			
-		private function showAtom(textLine, i):void
-		{
-			var box:Sprite = new Sprite();
-			var mcGraphics = box.graphics;
-			var bounds:Rectangle = textLine.getAtomBounds(i);
-			mcGraphics.lineStyle(1, 0xFF0000, 1.0);
-			mcGraphics.drawRect(bounds.left, bounds.top, bounds.width, bounds.height);
-			textLine.userData = textLine.addChild(box);
-			displayAtomData(textLine,i);
-		}
-			
-		private function displayAtomData(textLine, i)
-		{
-			if(atomDataContainer != null)
-				removeChild(atomDataContainer);
-			atomDataContainer=new Sprite();
-			var format = new ElementFormat(fontDescriptionNormal);
-			format.color = 0x00000FF;
-			var n:int = 0;
-			var nxtY:Number = 0;
-			var atomInfo:String = "value of getAtomBidiLevel() is: " + textLine.getAtomBidiLevel(i)+"\n"
-			+"value of getAtomCenter() is: " + textLine.getAtomCenter(i)+"\n"
-			+"value of getAtomIndexAtCharIndex() is: " + textLine.getAtomIndexAtCharIndex(i)+"\n"
-			+"value of getAtomTextBlockBeginIndex() is: " + textLine.getAtomTextBlockBeginIndex(i)+"\n"
-			+"value of getAtomTextBlockEndIndex() is: " + textLine.getAtomTextBlockEndIndex(i)+"\n"
-			+"value of getAtomTextRotation() is: " + textLine.getAtomTextRotation(i)+"\n";
-			var atomtextBlock:TextBlock = new TextBlock();
-			var textElement3:TextElement = new TextElement(atomInfo, format);
-			atomtextBlock.content = textElement3;
-			createLines(atomtextBlock,20,200,500, atomDataContainer)
-			addChild(atomDataContainer);
-		}
-			
-		private function removeAtom(textLine):void
-		{
-			textLine.removeChild(textLine.userData);
-		}
-	}	
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TextLineCreationResult.html b/html-docs/flash/text/engine/TextLineCreationResult.html deleted file mode 100644 index 60c1366..0000000 --- a/html-docs/flash/text/engine/TextLineCreationResult.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - - - -flash.text.engine.TextLineCreationResult (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TextLineCreationResult
InheritanceTextLineCreationResult Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The TextLineCreationResult class is an enumeration of constant values used with TextBlock.textLineCreationResult. -

-

-See also -

-
-TextBlock.createTextLine() -
-TextBlock.textLineCreationResult -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  COMPLETE : String = "complete"
[static] - Indicates no line was created because all text in the block had already been broken.
-		TextLineCreationResult
  EMERGENCY : String = "emergency"
[static] - Indicates the line was created with an emergency break because no break opportunity - was available in the specified width.
-		TextLineCreationResult
  INSUFFICIENT_WIDTH : String = "insufficientWidth"
[static] - Indicates no line was created because no text could fit in the specified width - and fitSomething was not specified in the call to createTextLine().
-		TextLineCreationResult
  SUCCESS : String = "success"
[static] - Indicates the line was successfully broken.
-		TextLineCreationResult
-
- -
- -
Constant detail
- - - - - -
COMPLETEconstant
-
-public static const COMPLETE:String = "complete" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates no line was created because all text in the block had already been broken. - -

- - - - - -
EMERGENCYconstant 
-
-public static const EMERGENCY:String = "emergency" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates the line was created with an emergency break because no break opportunity - was available in the specified width. - -

- - - - - -
INSUFFICIENT_WIDTHconstant 
-
-public static const INSUFFICIENT_WIDTH:String = "insufficientWidth" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates no line was created because no text could fit in the specified width - and fitSomething was not specified in the call to createTextLine(). - -

- - - - - -
SUCCESSconstant 
-
-public static const SUCCESS:String = "success" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates the line was successfully broken. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TextLineMirrorRegion.html b/html-docs/flash/text/engine/TextLineMirrorRegion.html deleted file mode 100644 index fba471f..0000000 --- a/html-docs/flash/text/engine/TextLineMirrorRegion.html +++ /dev/null @@ -1,549 +0,0 @@ - - - - - - - - -flash.text.engine.TextLineMirrorRegion (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TextLineMirrorRegion
InheritanceTextLineMirrorRegion Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The TextLineMirrorRegion class represents a portion of a text line wherein events are mirrored to another event dispatcher. -

After normal event-dispatching for a text line finishes, if the line is valid and event propagation has not been stopped, - events are re dispatched to the mirror regions of the line.

-

Mirroring of mouse events is a special case. Because mirror regions aren't actually display objects, mouseOver and mouseOut - events are simulated for them. The rollOver and rollOut events are not simulated. All naturally occuring - mouseOver, mouseOut, rollOver and rollOut events (whether targetted at the - text line or at children of the text line) are ignored - they are not mirrored.

-

You cannot create a TextLineMirrorRegion object directly from ActionScript code. - If you call new TextLineMirrorRegion(), an exception is thrown. A TextLineMirrorRegion is created and associated with a text line when that - text line is created from a ContentElement object with an event mirror set.

-

The TextLineMirrorRegion class is final; it cannot be subclassed.

-

-

-View the examples. -

-

-See also -

-
-ContentElement.eventMirror -
-TextBlock.createTextLine() -
-TextLine.mirrorRegions -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bounds : Rectangle -
[read-only] - The bounds of the mirror region, relative to the text line.
-		TextLineMirrorRegion
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  element : ContentElement -
[read-only] - The ContentElement object from which the mirror region was derived.
-		TextLineMirrorRegion
  mirror : EventDispatcher -
[read-only] - The EventDispatcher object to which events affecting the mirror region are mirrored.
-		TextLineMirrorRegion
  nextRegion : TextLineMirrorRegion -
[read-only] - The next TextLineMirrorRegion in the set derived from the text element, or null if the current region is the last mirror region - in the set.
-		TextLineMirrorRegion
  previousRegion : TextLineMirrorRegion -
[read-only] - The previous TextLineMirrorRegion in the set derived from the text element, or null if the current region is the first mirror - region in the set.
-		TextLineMirrorRegion
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  textLine : TextLine -
[read-only] - The TextLine containing this mirror region.
-		TextLineMirrorRegion
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
boundsproperty
-
-bounds:Rectangle  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The bounds of the mirror region, relative to the text line. -

Implementation -
-    public function get bounds():Rectangle -
-
- - - - - -
elementproperty 
-
-element:ContentElement  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The ContentElement object from which the mirror region was derived. -

Implementation -
-    public function get element():ContentElement -
-
-Throws -
- - - - -
Error — The TextLine to which this element belongs is not valid. - -
-
- - - - - -
mirrorproperty 
-
-mirror:EventDispatcher  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The EventDispatcher object to which events affecting the mirror region are mirrored. - This includes mouse events that specifically occur in the mirror region, and all other events - that target the text line. -

Implementation -
-    public function get mirror():EventDispatcher -
-
- - - - - -
nextRegionproperty 
-
-nextRegion:TextLineMirrorRegion  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The next TextLineMirrorRegion in the set derived from the text element, or null if the current region is the last mirror region - in the set. May be on the same line or on another text line. -

Implementation -
-    public function get nextRegion():TextLineMirrorRegion -
-
- - - - - -
previousRegionproperty 
-
-previousRegion:TextLineMirrorRegion  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The previous TextLineMirrorRegion in the set derived from the text element, or null if the current region is the first mirror - region in the set. May be on the same line or on another text line. -

Implementation -
-    public function get previousRegion():TextLineMirrorRegion -
-
- - - - - -
textLineproperty 
-
-textLine:TextLine  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- The TextLine containing this mirror region. -

Implementation -
-    public function get textLine():TextLine -
-
- -
Examples
-
examples\TextLineMirrorRegionExample
-
This example displays a block of text with mirror regions that turn red when you click - them. -
-
-
-package {
-
-    import flash.display.Sprite;
-	import flash.text.engine.TextBlock;
-	import flash.text.engine.TextLine;
-	import flash.text.engine.TextElement;
-	import flash.text.engine.ElementFormat;
-	import flash.text.engine.FontDescription;
-	import flash.text.engine.ContentElement;
-	import flash.text.engine.GroupElement;
-	import flash.text.engine.TextLineMirrorRegion;
-	import flash.events.MouseEvent;
-	import flash.events.EventDispatcher;
-	import flash.ui.Mouse;
-
-	public class TextLineMirrorRegionExample extends Sprite {
-		
-		var myEvent:EventDispatcher = new EventDispatcher();
-		var fontDescription:FontDescription = new FontDescription();
-		var textBlock:TextBlock = new TextBlock();
-
-		public function TextLineMirrorRegionExample():void {
-			
-			fontDescription.fontWeight = "bold";
-			var blackFormat:ElementFormat = new ElementFormat();
-			blackFormat.fontSize = 18;
-			blackFormat.color = 0x000000;
-			blackFormat.fontDescription = fontDescription;
-			
-			var textElement1 = new TextElement("Click on different parts of me to find the ", blackFormat);
-			var textElement2 = new TextElement("mirror regions",blackFormat);
-			var textElement3 = new TextElement(". If I am a mirror region, I'll ",blackFormat);
-			var textElement4 = new TextElement("turn red",blackFormat);
-			var textElement5 = new TextElement(".",blackFormat);
-			
-			myEvent.addEventListener("click", clickHandler);
-			myEvent.addEventListener("mouseOut", mouseOutHandler);
-			myEvent.addEventListener("mouseOver", mouseOverHandler);
-			
-			var groupVector:Vector.<ContentElement> = new Vector.<ContentElement>;
-			groupVector.push(textElement1, textElement2, textElement3, textElement4, textElement5);
-			var groupElement:GroupElement = new GroupElement(groupVector);
-			
-			textElement2.eventMirror=myEvent;
-			textElement4.eventMirror=myEvent;
-			
-			textBlock.content = groupElement;
-			createLines(textBlock);
-		}
-	
-		private function clickHandler(event:MouseEvent):void
-		{
-			var redFormat:ElementFormat = new ElementFormat();
-			redFormat.color = 0xCC0000;
-			redFormat.fontSize = 18;
-			redFormat.fontDescription = fontDescription;
-			var line:TextLine = event.target as TextLine;
-			var region:TextLineMirrorRegion = line.getMirrorRegion(myEvent);
-			region.element.elementFormat = redFormat;
-			createLines(textBlock);
-		}
-		
-		private function mouseOverHandler(event:MouseEvent):void
-		{
-			Mouse.cursor = "button";
-		}
-		
-		private function mouseOutHandler(event:MouseEvent):void
-		{
-			Mouse.cursor = "arrow";
-		}
-			
-		private function createLines(textBlock:TextBlock):void 
-		{
-			var purgeLine:TextLine = textBlock.firstLine;
-				
-			while (purgeLine)
-			{
-				removeChild (purgeLine);
-				purgeLine = purgeLine.nextLine;
-			}
-			var lineWidth:Number = 150;
-			var xPos:Number = 15.0;
-			var yPos:Number = 20.0;
-			var textLine:TextLine = textBlock.createTextLine (null, lineWidth);
-				
-			while (textLine)
-			{
-				textLine.x = xPos;
-				textLine.y = yPos;
-				yPos += textLine.height + 2;
-				addChild (textLine);
-				textLine = textBlock.createTextLine (textLine, lineWidth);
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TextLineValidity.html b/html-docs/flash/text/engine/TextLineValidity.html deleted file mode 100644 index 4a8c785..0000000 --- a/html-docs/flash/text/engine/TextLineValidity.html +++ /dev/null @@ -1,348 +0,0 @@ - - - - - - - - -flash.text.engine.TextLineValidity (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TextLineValidity
InheritanceTextLineValidity Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The TextLineValidity class is an enumeration of constant values for setting the validity property -of the TextLine class. -

-

-See also -

-
-TextBlock.firstInvalidLine -
-TextLine.validity -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  INVALID : String = "invalid"
[static] - Specifies that the line is invalid.
-		TextLineValidity
  POSSIBLY_INVALID : String = "possiblyInvalid"
[static] - Specifies that the text line is possibly invalid.
-		TextLineValidity
  STATIC : String = "static"
[static] - Specifies that the line is static, and that the connection between the line and the text block has been severed.
-		TextLineValidity
  VALID : String = "valid"
[static] - Specifies that the text line is valid.
-		TextLineValidity
-
- -
- -
Constant detail
- - - - - -
INVALIDconstant
-
-public static const INVALID:String = "invalid" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that the line is invalid. - -

- - - - - -
POSSIBLY_INVALIDconstant 
-
-public static const POSSIBLY_INVALID:String = "possiblyInvalid" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that the text line is possibly invalid. The Flash runtime uses this validity during rebreaking of a previously broken text - block whose content has not changed. You cannot set this value. - -

- - - - - -
STATICconstant 
-
-public static const STATIC:String = "static" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that the line is static, and that the connection between the line and the text block has been severed. - -

- - - - - -
VALIDconstant 
-
-public static const VALID:String = "valid" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that the text line is valid. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TextRotation.html b/html-docs/flash/text/engine/TextRotation.html deleted file mode 100644 index a392082..0000000 --- a/html-docs/flash/text/engine/TextRotation.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - - - - -flash.text.engine.TextRotation (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TextRotation
InheritanceTextRotation Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The TextRotation class is an enumeration of constant values used with the following properties: -ElementFormat.textRotation, ContentElement.textRotation, -TextBlock.lineRotation, and TextLine.getAtomTextRotation(). -

The final rotation of any glyph is the sum of TextBlock.lineRotation, -ElementFormat.textRotation, and ContentElement.textRotation

-

-

-See also -

-
-ElementFormat.textRotation -
-ContentElement.textRotation -
-TextBlock.lineRotation -
-TextLine.getAtomTextRotation() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  AUTO : String = "auto"
[static] - Specifies a 90 degree counter clockwise rotation for full width and wide glyphs only, - as determined by the Unicode properties of the glyph.
-		TextRotation
  ROTATE_0 : String = "rotate0"
[static] - Specifies no rotation.
-		TextRotation
  ROTATE_180 : String = "rotate180"
[static] - Specifies a 180 degree rotation.
-		TextRotation
  ROTATE_270 : String = "rotate270"
[static] - Specifies a 270 degree clockwise rotation.
-		TextRotation
  ROTATE_90 : String = "rotate90"
[static] - Specifies a 90 degree clockwise rotation.
-		TextRotation
-
- -
- -
Constant detail
- - - - - -
AUTOconstant
-
-public static const AUTO:String = "auto" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a 90 degree counter clockwise rotation for full width and wide glyphs only, - as determined by the Unicode properties of the glyph. - This value is typically used with Asian text to rotate - only those glyphs that require rotation. - This rotation is applied only in vertical text to return full width and wide - characters to a vertical orientation without affecting other characters. - -

- - - - - -
ROTATE_0constant 
-
-public static const ROTATE_0:String = "rotate0" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies no rotation. - -

- - - - - -
ROTATE_180constant 
-
-public static const ROTATE_180:String = "rotate180" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a 180 degree rotation. - -

- - - - - -
ROTATE_270constant 
-
-public static const ROTATE_270:String = "rotate270" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a 270 degree clockwise rotation. - -

- - - - - -
ROTATE_90constant 
-
-public static const ROTATE_90:String = "rotate90" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies a 90 degree clockwise rotation. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/TypographicCase.html b/html-docs/flash/text/engine/TypographicCase.html deleted file mode 100644 index a21b744..0000000 --- a/html-docs/flash/text/engine/TypographicCase.html +++ /dev/null @@ -1,440 +0,0 @@ - - - - - - - - -flash.text.engine.TypographicCase (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.engine
Classpublic final class TypographicCase
InheritanceTypographicCase Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5
-

-

-The TypographicCase class is an enumeration of constant values for setting the typographicCase property -of the ElementFormat class. - -

-

-See also -

-
-ElementFormat.typographicCase -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  CAPS : String = "caps"
[static] - Specifies that spacing is adjusted for uppercase characters on output.
-		TypographicCase
  CAPS_AND_SMALL_CAPS : String = "capsAndSmallCaps"
[static] - Specifies that all lowercase characters use small-caps glyphs on output.
-		TypographicCase
  DEFAULT : String = "default"
[static] - Specifies default typographic case.
-		TypographicCase
  LOWERCASE : String = "lowercase"
[static] - Specifies that all characters use lowercase glyphs on output.
-		TypographicCase
  SMALL_CAPS : String = "smallCaps"
[static] - Specifies that uppercase characters use small-caps glyphs on output.
-		TypographicCase
  TITLE : String = "title"
[static] - Specifies that uppercase characters use title glyphs on output.
-		TypographicCase
  UPPERCASE : String = "uppercase"
[static] - Specifies that all characters use uppercase glyphs on output.
-		TypographicCase
-
- -
- -
Constant detail
- - - - - -
CAPSconstant
-
-public static const CAPS:String = "caps" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that spacing is adjusted for uppercase characters on output. - -

- - - - - -
CAPS_AND_SMALL_CAPSconstant 
-
-public static const CAPS_AND_SMALL_CAPS:String = "capsAndSmallCaps" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that all lowercase characters use small-caps glyphs on output. - -

- - - - - -
DEFAULTconstant 
-
-public static const DEFAULT:String = "default" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies default typographic case. The results are font-dependent; characters use the settings specified by the font designer - without any features applied. - -

- - - - - -
LOWERCASEconstant 
-
-public static const LOWERCASE:String = "lowercase" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that all characters use lowercase glyphs on output. - -

- - - - - -
SMALL_CAPSconstant 
-
-public static const SMALL_CAPS:String = "smallCaps" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that uppercase characters use small-caps glyphs on output. - -

- - - - - -
TITLEconstant 
-
-public static const TITLE:String = "title" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that uppercase characters use title glyphs on output. - -

- - - - - -
UPPERCASEconstant 
-
-public static const UPPERCASE:String = "uppercase" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies that all characters use uppercase glyphs on output. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/engine/package-detail.html b/html-docs/flash/text/engine/package-detail.html deleted file mode 100644 index 41ec863..0000000 --- a/html-docs/flash/text/engine/package-detail.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - - -flash.text.engine Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The FTE provides low-level support for sophisticated control of text metrics, formatting, and bi-directional text. While it can be used to create and manage simple text elements, the FTE is primarily designed as a foundation for developers to create text-handling components.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 BreakOpportunity -The BreakOpportunity class is an enumeration of constant values that you can use to set the breakOpportunity property -of the ElementFormat class.
 CFFHinting -The CFFHinting class defines values for cff hinting in the FontDescription class.
 ContentElement - The ContentElement class serves as a base class for the element types that can appear in a GroupElement, namely a GraphicElement, - another GroupElement, or a TextElement.
 DigitCase -The DigitCase class is an enumeration of constant values used in setting the digitCase property -of the ElementFormat class.
 DigitWidth -The DigitWidth class is an enumeration of constant values used in setting the digitWidth property -of the ElementFormat class.
 EastAsianJustifier - The EastAsianJustifier class has properties to control the justification options for text lines whose - content is primarily East Asian text.
 ElementFormat - The ElementFormat class represents formatting information which can be applied to a ContentElement.
 FontDescription - The FontDescription class represents the information necessary to describe a font.
 FontLookup -The FontLookup class is an enumeration of constant values used with FontDescription.fontLookup.
 FontMetrics - The FontMetrics class contains measurement and offset information about a font.
 FontPosture -The FontPosture class is an enumeration of constant values used with FontDescription.fontPosture to -set text to italic or normal.
 FontWeight -The FontWeight class is an enumeration of constant values used with FontDescription.fontWeight.
 GraphicElement - The GraphicElement class represents a graphic element in a TextBlock or GroupElement object.
 GroupElement - A GroupElement object groups a collection of TextElement, GraphicElement, or other GroupElement objects - that you can assign as a unit to the content property of a TextBlock object.
 JustificationStyle -The JustificationStyle class is an enumeration of constant values for setting the justificationStyle property -of the EastAsianJustifier class.
 Kerning -The Kerning class is an enumeration of constant values used with ElementFormat.kerning.
 LigatureLevel -The LigatureLevel class is an enumeration of constant values used in setting the ligatureLevel property -of the ElementFormat class.
 LineJustification -The LineJustification class is an enumeration of constant values used in setting the lineJustfication property -of the TextJustifier subclasses.
 RenderingMode -The RenderingMode class provides values for rendering mode in the FontDescription class.
 SpaceJustifier - The SpaceJustifier class represents properties that control the justification options for text lines in a text block.
 TabAlignment -The TabAlignment class is an enumeration of constant values that you can use to set the tabAlignment property -of the TabStop class.
 TabStop - The TabStop class represents the properties of a tab stop in a text block.
 TextBaseline -The TextBaseline class is an enumeration of constant values to use in setting the dominantBaseline and -alignmentBaseline properties of the ElementFormat class.
 TextBlock - The TextBlock class is a factory for the creation of TextLine objects, which you can - render by placing them on the display list.
 TextElement - The TextElement class represents a string of formatted text.
 TextJustifier - The TextJustifier class is an abstract base class for the justifier types that you can apply to a TextBlock, specifically the - EastAsianJustifier and SpaceJustifier classes.
 TextLine - The TextLine class is used to display text on the display list.
 TextLineCreationResult -The TextLineCreationResult class is an enumeration of constant values used with TextBlock.textLineCreationResult.
 TextLineMirrorRegion - The TextLineMirrorRegion class represents a portion of a text line wherein events are mirrored to another event dispatcher.
 TextLineValidity -The TextLineValidity class is an enumeration of constant values for setting the validity property -of the TextLine class.
 TextRotation -The TextRotation class is an enumeration of constant values used with the following properties: -ElementFormat.textRotation, ContentElement.textRotation, -TextBlock.lineRotation, and TextLine.getAtomTextRotation().
 TypographicCase -The TypographicCase class is an enumeration of constant values for setting the typographicCase property -of the ElementFormat class.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/text/ime/CompositionAttributeRange.html b/html-docs/flash/text/ime/CompositionAttributeRange.html deleted file mode 100644 index 5426a4b..0000000 --- a/html-docs/flash/text/ime/CompositionAttributeRange.html +++ /dev/null @@ -1,419 +0,0 @@ - - - - - - - - -flash.text.ime.CompositionAttributeRange (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.text.ime
Classpublic final class CompositionAttributeRange
InheritanceCompositionAttributeRange Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-The CompositionAttributeRange class represents a range of composition attributes for use with IME (input method editor) events. -For example, when editing text in the IME, the text is divided by the IME into composition ranges. -These composition ranges are flagged as selected (such as currently being lengthened, shortened, or edited), -and/or converted (meaning the range went through the IME dictionary lookup, already). -

By convention, the client should adorn these composition ranges with underlining or highlighting according to -the flags.

-

For example:

-
-     !converted              = thick gray underline (raw text)
-     !selected && converted  = thin black underline
-      selected && converted  = thick black underline
-
-

-

-See also -

-
-flash.text.ime.IIMEClient -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  converted : Boolean -
- A property defining the current clause has been processed by the IME - and the clause is waiting to be accepted or confirmed by the user.
-		CompositionAttributeRange
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  relativeEnd : int -
- The position of the end of the composition clause, relative to the beginning - of the inline edit session.
-		CompositionAttributeRange
  relativeStart : int -
- The relative start position from the beginning of the current inline editing session.
-		CompositionAttributeRange
  selected : Boolean -
- A property defining the current composition clause is active and - lengthened or shortened or edited with the IME while the neighboring - clauses are not changing.
-		CompositionAttributeRange
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-CompositionAttributeRange(relativeStart:int, relativeEnd:int, selected:Boolean, converted:Boolean)
-
- Creates a CompositionAttributeRange object.
-		CompositionAttributeRange
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
convertedproperty
-
-public var converted:Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- A property defining the current clause has been processed by the IME - and the clause is waiting to be accepted or confirmed by the user. - -

- - - - - -
relativeEndproperty 
-
-public var relativeEnd:int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The position of the end of the composition clause, relative to the beginning - of the inline edit session. - For example, 0 equals the start of the text the IME reads (however, text might exist - before that position in the edit field). - -

- - - - - -
relativeStartproperty 
-
-public var relativeStart:int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The relative start position from the beginning of the current inline editing session. - For example, 0 equals the start of the text the IME reads (however, text might exist - before that position in the edit field). - -

- - - - - -
selectedproperty 
-
-public var selected:Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- A property defining the current composition clause is active and - lengthened or shortened or edited with the IME while the neighboring - clauses are not changing. - -

- -
Constructor detail
- - - - - -
CompositionAttributeRange()constructor
-
-public function CompositionAttributeRange(relativeStart:int, relativeEnd:int, selected:Boolean, converted:Boolean) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Creates a CompositionAttributeRange object. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
relativeStart:int — The zero based index of the first character included in the character range. -
 
relativeEnd:int — The zero based index of the last character included in the character range. -
 
selected:Boolean — Defines the current composition clause as active or not. -
 
converted:Boolean — Defines the current clause as processed by the IME and waiting for user confirmation. -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/ime/IIMEClient.html b/html-docs/flash/text/ime/IIMEClient.html deleted file mode 100644 index da6600e..0000000 --- a/html-docs/flash/text/ime/IIMEClient.html +++ /dev/null @@ -1,668 +0,0 @@ - - - - - - - - -flash.text.ime.IIMEClient (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - -
Packageflash.text.ime
Interfacepublic interface IIMEClient
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2
-

-

-Interface for IME (input method editor) clients. Components based on the flash.text.engine package must implement -this interface to support editing text inline using an IME. This interface is not used with TextField objects. -TextLayoutFramework (TLF) uses this interface to support inline IME, so clients using TLF do not need to implement this -interface. -

To support inline IME, set the imeClient property of an ImeEvent.IME_START_COMPOSITION event to -an object which implements this interface.

-

The following terms are often used in the IME related API:

-
  • A conversation is the interchange between the IME and the application. During a conversation, a composition is -updated one or more times and then confirmed by the user.
    • -
  • A composition identifies the text entered by the user through the IME; including associated input state information -such as the selected range and the extent of any clauses.
    • -
  • A clause is a range of the composition possibly sharing semantic information, such as indicating whether the input is -in a selected or converted state. A composition contains zero or more clauses.
-

-

-See also -

-
-flash.text.ime.CompositionAttributeRange -
-flash.events.IMEEvent.imeClient -
-
-
-
- -
-
Public Properties
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  compositionEndIndex : int -
[read-only] - The zero-based character index value of the end of the current edit session text (such as - all text in the inline session that is not confirmed to the document).
-		IIMEClient
  compositionStartIndex : int -
[read-only] - The zero-based character index value of the start of the current edit session text (such as - all text in the inline session that is not confirmed to the document).
-		IIMEClient
  selectionActiveIndex : int -
[read-only] - The zero-based character index value of the last character in the current selection.
-		IIMEClient
  selectionAnchorIndex : int -
[read-only] - The zero-based character index value of the first character in the current selection.
-		IIMEClient
  verticalTextLayout : Boolean -
[read-only] - Indicates whether the text in the component is vertical or not.
-		IIMEClient
-
- -
-
Public Methods
- - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-confirmComposition(text:String = null, preserveSelection:Boolean = false):void -
-
- Use this callback to end the inline editing session and confirm the text.
-		IIMEClient
   -
-getTextBounds(startIndex:int, endIndex:int):Rectangle -
-
- The IME uses this method to query the bounding box of the text currently edited with the IME client.
-		IIMEClient
   -
-getTextInRange(startIndex:int, endIndex:int):String -
-
- Gets the specified range of text from the component.
-		IIMEClient
   -
-selectRange(anchorIndex:int, activeIndex:int):void -
-
- Sets the range of selected text in the component.
-		IIMEClient
   -
-updateComposition(text:String, attributes:Vector.<CompositionAttributeRange>, compositionStartIndex:int, compositionEndIndex:int):void -
-
- Callback for updating the contents of the inline editing session.
-		IIMEClient
-
- -
-
Events
- - - - - - - - - - -
 EventSummaryDefined by
   -
-imeStartComposition -
-		 - Dispatched when the user begins to use an IME (input method editor).IIMEClient
   -
-textInput -
-		 - Dispatched when the user enters text.IIMEClient
-
- -
- -
Property detail
- - - - - -
compositionEndIndexproperty
-
-compositionEndIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The zero-based character index value of the end of the current edit session text (such as - all text in the inline session that is not confirmed to the document). -

Implementation -
-    public function get compositionEndIndex():int -
-
- - - - - -
compositionStartIndexproperty 
-
-compositionStartIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The zero-based character index value of the start of the current edit session text (such as - all text in the inline session that is not confirmed to the document). -

Implementation -
-    public function get compositionStartIndex():int -
-
- - - - - -
selectionActiveIndexproperty 
-
-selectionActiveIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The zero-based character index value of the last character in the current selection. -

Implementation -
-    public function get selectionActiveIndex():int -
-
- - - - - -
selectionAnchorIndexproperty 
-
-selectionAnchorIndex:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The zero-based character index value of the first character in the current selection. -

Implementation -
-    public function get selectionAnchorIndex():int -
-
- - - - - -
verticalTextLayoutproperty 
-
-verticalTextLayout:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the text in the component is vertical or not. This property directs the positioning - of the candidate window (such as beside vertical text or below horizontal text). -

Implementation -
-    public function get verticalTextLayout():Boolean -
-
- -
Method detail
- - - - - -
confirmComposition()method
-
-public function confirmComposition(text:String = null, preserveSelection:Boolean = false):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Use this callback to end the inline editing session and confirm the text. - -

Parameters - - - - - - - - - - -
text:String (default = null) — the final state of the text in the inline session (the confirmed text). -
 
preserveSelection:Boolean (default = false) — when true, you should not reset the current selection to the end of the confirmed text. -
-
- - - - - -
getTextBounds()method 
-
-public function getTextBounds(startIndex:int, endIndex:int):Rectangle -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- The IME uses this method to query the bounding box of the text currently edited with the IME client. - Use this method to place the candidate window and set the mouse cursor in the IME client when the mouse is over the - text field or other component that supports IME. - -

Parameters - - - - - - - - - - -
startIndex:int — An integer that specifies the starting location of the range of text from the bounding box you are measuring. -
 
endIndex:int — Optional; an integer that specifies the ending location of the range of text from the bounding box you are measuring. -
-

-Returns - - - - -
Rectangle — - The bounding box of the specified range of text, or null if one or both of the indexes are invalid. - This method returns the same value if startIndex is greater or less than endIndex. The same value should be returned whether or not startIndex is greater or less than endIndex. - - -
-
- - - - - -
getTextInRange()method 
-
-public function getTextInRange(startIndex:int, endIndex:int):String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Gets the specified range of text from the component. This method is called during IME reconversion. - -

Parameters - - - - - - - - - - -
startIndex:int — an integer that specifies the starting location of the range of text to be retrieved. -
 
endIndex:int — an integer that specifies the ending location of the range of text to be retrieved. - -
-

-Returns - - - - -
String — - The requested text, or null if no text is available in the requested range - or if either or both of the indexes are invalid. The same value should be returned - independant of whether startIndex is greater or less than endIndex. - - - -
-
- - - - - -
selectRange()method 
-
-public function selectRange(anchorIndex:int, activeIndex:int):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Sets the range of selected text in the component. - If either of the arguments is out of bounds the selection should not be changed. - -

Parameters - - - - - - - - - - -
anchorIndex:int — The zero-based index value of the character at the anchor end of the selection -
 
activeIndex:int — The zero-based index value of the character at the active end of the selection. - -
-
- - - - - -
updateComposition()method 
-
-public function updateComposition(text:String, attributes:Vector.<CompositionAttributeRange>, compositionStartIndex:int, compositionEndIndex:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2 -
-

- Callback for updating the contents of the inline editing session. - This method is called whenever the text being edited with the IME has changed - and its contents are used by the client to redraw the entire inline editing session. - -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
text:String — Contains the text of the inline edit session from the IME. -
 
attributes:Vector.<CompositionAttributeRange> — Contains an array of composition clauses with adornment info. -
 
compositionStartIndex:int — Start of the inline session relative to the start of the text object. -
 
compositionEndIndex:int — End of the inline session relative to the start of the text object. -
-
-
Event detail
- - - - - -
imeStartCompositionevent 
-
-Event object type: flash.events.IMEEvent -
-IMEEvent.type property = flash.events.IMEEvent.IME_START_COMPOSITION -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when the user begins to use an IME (input method editor). -

- - - - - -
textInputevent  
-
-Event object type: flash.events.TextEvent -
-TextEvent.type property = flash.events.TextEvent.TEXT_INPUT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Dispatched when the user enters text. For IME (input method editor) clients, the receiver should - insert the string contained in the event object's text property at the current insertion point. -

- Defines the value of the type property of a textInput event object. -

Note: This event is not dispatched for the Delete or Backspace keys.

-

This event has the following properties:

- - - - - - - -
PropertyValue
bubblestrue
cancelabletrue; call the preventDefault() method - to cancel default behavior.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe text field into which characters are being entered. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
textThe character or sequence of characters entered by the user.
- -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/text/ime/package-detail.html b/html-docs/flash/text/ime/package-detail.html deleted file mode 100644 index 5fa38a5..0000000 --- a/html-docs/flash/text/ime/package-detail.html +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - -flash.text.ime Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Interfaces
- - - - - - - -
 InterfaceDescription
 IIMEClient -Interface for IME (input method editor) clients.
- -
Classes
- - - - - - - -
 ClassDescription
 CompositionAttributeRange -The CompositionAttributeRange class represents a range of composition attributes for use with IME (input method editor) events.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/text/package-detail.html b/html-docs/flash/text/package-detail.html deleted file mode 100644 index 543e62a..0000000 --- a/html-docs/flash/text/package-detail.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - -flash.text Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.text package contains classes for working with text fields, text formatting, text metrics, style sheets, and layout. Advanced anti-aliasing is available in Flash Player 8 and later through the flash.text.TextFormat and flash.text.TextRenderer classes.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 AntiAliasType -The AntiAliasType class provides values for anti-aliasing in the flash.text.TextField class.
 AutoCapitalize -The AutoCapitalize class defines constants for the -autoCapitalize property of the StageText class.
 CSMSettings - The CSMSettings class contains properties for use with the - TextRenderer.setAdvancedAntiAliasingTable() method - to provide continuous stroke modulation (CSM).
 Font - The Font class is used to manage embedded fonts in SWF files.
 FontStyle -The FontStyle class provides values for the TextRenderer class.
 FontType - The FontType class contains the enumerated constants "embedded" - and "device" for the fontType property of the Font class.
 GridFitType -The GridFitType class defines values for grid fitting in the TextField class.
 ReturnKeyLabel -The ReturnKeyLabel class defines the values to use for - the returnKeyLabel property of the StageText class.
 SoftKeyboardType - The SoftKeyboardType class defines the types of soft keyboards for - mobile applications.
 StageText - - The StageText class is used to present the user with a native text input field.
 StageTextClearButtonMode - This class defines an enumeration that provides option for clearButton.
 StageTextContentType - - The StageTextContentType class defines the content type/hint that is provided to mobile - - operating systems when using a StageText text input control.
 StageTextInitOptions - The StageTextInitOptions class defines the options available for initializing - a StageText object.
 StaticText - This class represents StaticText objects on the display list.
 StyleSheet - The StyleSheet class lets you create a StyleSheet object that contains text - formatting rules for font size, color, and other styles.
 TextColorType -The TextColorType class provides color values for the flash.text.TextRenderer class.
 TextDisplayMode - The TextDisplayMode class contains values that control the subpixel anti-aliasing of the advanced anti-aliasing system.
 TextExtent - The TextExtent class contains information about the extents of some - text in a text field.
 TextField - The TextField class is used to create display objects for text display and input.
 TextFieldAutoSize -The TextFieldAutoSize class is an enumeration of constant values used in setting the autoSize -property of the TextField class.
 TextFieldType -The TextFieldType class is an enumeration of constant values used in setting the type property -of the TextField class.
 TextFormat - The TextFormat class represents character formatting information.
 TextFormatAlign - The TextFormatAlign class provides values for text alignment in the TextFormat class.
 TextInteractionMode - A class that defines the Interactive mode of a text field object.
 TextLineMetrics - The TextLineMetrics class contains information about the text position and measurements of a - line of text within a text field.
 TextRenderer - The TextRenderer class provides functionality for the advanced anti-aliasing capability of - embedded fonts.
 TextSnapshot - TextSnapshot objects let you work with static text in a movie clip.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/ui/ContextMenu.html b/html-docs/flash/ui/ContextMenu.html deleted file mode 100644 index 9fc66ed..0000000 --- a/html-docs/flash/ui/ContextMenu.html +++ /dev/null @@ -1,1439 +0,0 @@ - - - - - - - - -flash.ui.ContextMenu (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class ContextMenu
InheritanceContextMenu Inheritance NativeMenu Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The ContextMenu class provides control over the items displayed in context menus. -

Mobile Browser Support: This class is not supported in mobile browsers.

-

AIR profile support: This feature is not supported - on mobile devices or AIR for TV devices. See - - AIR Profile Support for more information regarding API support across multiple profiles.

-

In Flash Player, users open the context menu by right-clicking (Windows or Linux) or Control-clicking - (Macintosh) Flash Player. You can use the methods and properties of the ContextMenu class to - add custom menu items, control the display of the built-in context menu items (for example, Zoom In, - and Print), or create copies of menus. In AIR, there are no built-in items and no standard context menu.

-

In Flash Professional, you can attach a ContextMenu object to a specific button, movie clip, or text - field object, or to an entire movie level. You use the contextMenu property of the InteractiveObject - class to do this.

-

In Flex or Flash Builder, only top-level components in the application can have context menus. - For example, if a DataGrid control is a child of a TabNavigator or VBox container, the DataGrid control - cannot have its own context menu.

-

To add new items to a ContextMenu object, you create a ContextMenuItem object, and then add that - object to the ContextMenu.customItems array. For more information about creating context - menu items, see the ContextMenuItem class entry.

- -

Flash Player has three types of context menus: the standard menu (which appears when you right-click - in Flash Player), the edit menu (which appears when you right-click a selectable or editable text - field), and an error menu (which appears when a SWF file has failed to load into Flash Player). Only the - standard and edit menus can be modified with the ContextMenu class. Only the edit menu appears in AIR.

- -

Custom menu items always appear at the top of the Flash Player context menu, above any visible - built-in menu items; a separator bar distinguishes built-in and custom menu items. You cannot remove the - Settings menu item from the context menu. - The Settings menu item is required in Flash so that users can access the settings that affect privacy and - storage on their computers. You also cannot remove the About menu item, which is - required so that users can find out what version of Flash Player they are using. (In AIR, the built-in - Settings and About menu items are not used.)

- -

You can add no more than 15 custom items to a context menu in Flash Player. In AIR, there is no explicit - limit imposed on the number of items in a context menu.

- -

You must use the ContextMenu() constructor to create a ContextMenu object before - calling its methods.

-

-

-View the examples. -

-

-See also -

-
-ContextMenuItem class -
-flash.display.InteractiveObject.contextMenu -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  builtInItems : ContextMenuBuiltInItems -
- An instance of the ContextMenuBuiltInItems class with the following properties: - forwardAndBack, loop, - play, print, quality, - rewind, save, and zoom.
-		ContextMenu
  clipboardItems : ContextMenuClipboardItems -
- An instance of the ContextMenuClipboardItems class with the following properties: - cut, copy, paste, delete, selectAll.
-		ContextMenu
  clipboardMenu : Boolean -
- Specifies whether or not the clipboard menu should be used.
-		ContextMenu
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  customItems : Array -
- An array of ContextMenuItem objects.
-		ContextMenu
  isSupported : Boolean -
[static][read-only] - The isSupported property is set to true if the - ContextMenu class is supported on the current platform, otherwise it is - set to false.
-		ContextMenu
  items : Array -
- The array of custom items in this menu.
-		ContextMenu
  link : URLRequest -
- The URLRequest of the link.
-		ContextMenu
  numItems : int -
[read-only] - The number of items in this menu.
-		ContextMenu
 Inheritedparent : NativeMenu -
- The parent menu.
-		NativeMenu
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ContextMenu()
-
- Creates a ContextMenu object.
-		ContextMenu
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-addItem(item:NativeMenuItem):NativeMenuItem -
-
- Adds a menu item at the bottom of the menu.
-		NativeMenu
   -
-addItemAt(item:NativeMenuItem, index:int):NativeMenuItem -
-
- Adds a menu item at the bottom of the menu.
-		ContextMenu
 Inherited -
-addSubmenu(submenu:NativeMenu, label:String):NativeMenuItem -
-
- Adds a submenu to the menu by inserting a new menu item.
-		NativeMenu
 Inherited -
-addSubmenuAt(submenu:NativeMenu, index:int, label:String):NativeMenuItem -
-
- Adds a submenu to the menu by inserting a new menu item at the - specified position.
-		NativeMenu
   -
-clone():NativeMenu -
-
- Creates a copy of the specified ContextMenu object.
-		ContextMenu
   -
-containsItem(item:NativeMenuItem):Boolean -
-
- Reports whether this menu contains the specified menu item.
-		ContextMenu
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-display(stage:Stage, stageX:Number, stageY:Number):void -
-
- Pops up this menu at the specified location.
-		ContextMenu
   -
-getItemAt(index:int):NativeMenuItem -
-
- Gets the menu item at the specified index.
-		ContextMenu
 Inherited -
-getItemByName(name:String):NativeMenuItem -
-
- Gets the menu item with the specified name.
-		NativeMenu
   -
-getItemIndex(item:NativeMenuItem):int -
-
- Gets the position of the specified item.
-		ContextMenu
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-hideBuiltInItems():void -
-
- Hides all built-in menu items (except Settings) in the specified ContextMenu object.
-		ContextMenu
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-removeAllItems():void -
-
- Removes all items from the menu.
-		ContextMenu
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-removeItem(item:NativeMenuItem):NativeMenuItem -
-
- Removes the specified menu item.
-		NativeMenu
   -
-removeItemAt(index:int):NativeMenuItem -
-
- Removes and returns the menu item at the specified index.
-		ContextMenu
 Inherited -
-setItemIndex(item:NativeMenuItem, index:int):void -
-
- Moves a menu item to the specified position.
-		NativeMenu
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-displaying -
-		 - Dispatched by this NativeMenu object immediately before the - menu is displayed.NativeMenu
   -
-menuSelect -
-		 - Dispatched when a user first generates a - context menu but before the contents of the context menu are displayed.ContextMenu
 Inherited -
-preparing -
-		 - Dispatched by the NativeMenu object when a key equivalent is pressed and immediately before the menu is displayed.NativeMenu
 Inherited -
-select -
-		 - Dispatched by this NativeMenu object when one of its menu items or an item - in one of its descendant submenus is selected.NativeMenu
-
- -
- -
Property detail
- - - - - -
builtInItemsproperty
-
-builtInItems:ContextMenuBuiltInItems  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An instance of the ContextMenuBuiltInItems class with the following properties: - forwardAndBack, loop, - play, print, quality, - rewind, save, and zoom. - Setting these properties to false removes the corresponding menu items from the - specified ContextMenu object. These properties are enumerable and are set to true by - default. -

Note: In AIR, context menus do not have built-in items.

- - Implementation -
-    public function get builtInItems():ContextMenuBuiltInItems -
-    public function set builtInItems(value:ContextMenuBuiltInItems):void -
-

-See also -

-
-ContextMenuBuiltInItems class -
-ContextMenu.hideBuiltInItems() -
-
- - - - - -
clipboardItemsproperty 
-
-clipboardItems:ContextMenuClipboardItems  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- An instance of the ContextMenuClipboardItems class with the following properties: - cut, copy, paste, delete, selectAll. - Setting one of these properties to false disables the corresponding item in the - clipboard menu. -

Implementation -
-    public function get clipboardItems():ContextMenuClipboardItems -
-    public function set clipboardItems(value:ContextMenuClipboardItems):void -
-

-See also -

-
-ContextMenuClipboardItems class -
-
-Example -
The following example demonstrates the use of the clipboardItems property - of the ContextMenu object. Create a ContextMenu, and set its - clipboardMenu property to true. Add an event handler for the - MENU_SELECT (generally, right-click) event, and assign the menu to a display object. - In this case, the copy and paste menus are enabled. -
-
-package {
-    import flash.ui.ContextMenu;
-    import flash.events.ContextMenuEvent;
-    import flash.display.Sprite;
-
-    public class ContextMenuClipboardItemsExample extends Sprite {
-        public function ContextMenuClipboardItemsExample() {
-            var myContextMenu:ContextMenu = new ContextMenu();
-            myContextMenu.clipboardMenu = true;
-            myContextMenu.addEventListener(ContextMenuEvent.MENU_SELECT, menuSelectHandler);
-            var rc:Sprite = new Sprite();
-            rc.graphics.beginFill(0xDDDDDD);
-            rc.graphics.drawRect(0,0,100,30);
-            addChild(rc);
-            rc.contextMenu = myContextMenu;
-        }
-        function menuSelectHandler(event:ContextMenuEvent):void {
-            event.contextMenuOwner.contextMenu.clipboardItems.copy = true;
-            event.contextMenuOwner.contextMenu.clipboardItems.paste = true;
-        }
-    }
-}
-
-

-
- - - - - -
clipboardMenuproperty 
-
-clipboardMenu:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Specifies whether or not the clipboard menu should be used. If this value is true, - the clipboardItems property determines which items are enabled or disabled on the clipboard menu. -

If the link property is non-null, this clipBoardMenu property is ignored.

- Implementation -
-    public function get clipboardMenu():Boolean -
-    public function set clipboardMenu(value:Boolean):void -
-
- - - - - -
customItemsproperty 
-
-customItems:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- An array of ContextMenuItem objects. Each object in the array represents a context menu item that you - have defined. Use this property to add, remove, or modify these custom menu items. -

To add new menu items, you create a ContextMenuItem object and then add it to the - customItems array (for example, by using Array.push()). For more information about creating - menu items, see the ContextMenuItem class entry.

- Implementation -
-    public function get customItems():Array -
-    public function set customItems(value:Array):void -
-

-See also -

-
-flash.display.InteractiveObject.contextMenu -
-
- - - - - -
isSupportedproperty 
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The isSupported property is set to true if the - ContextMenu class is supported on the current platform, otherwise it is - set to false. -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
itemsproperty 
-
-items:Array  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0
-

- The array of custom items in this menu. -

Using this property is equivalent to using the customItems property. - The array is sorted in display order.

- - Implementation -
-    public function get items():Array -
-    public function set items(value:Array):void -
-
- - - - - -
linkproperty 
-
-link:URLRequest  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The URLRequest of the link. If this property is null, a normal context menu is displayed. - If this property is not null, the link context menu is displayed, and operates on the url specified. -

If a link is specified, the clipboardMenu property is ignored.

-

The default value is null.

- Implementation -
-    public function get link():URLRequest -
-    public function set link(value:URLRequest):void -
-
- - - - - -
numItemsproperty 
-
-numItems:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- The number of items in this menu. -

Implementation -
-    public function get numItems():int -
-
- -
Constructor detail
- - - - - -
ContextMenu()constructor
-
-public function ContextMenu() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a ContextMenu object. - -

-See also -

-
-ContextMenu.customItems -
-ContextMenu.hideBuiltInItems() -
-
- -
Method detail
- - - - - -
addItemAt()method
-
-public override function addItemAt(item:NativeMenuItem, index:int):NativeMenuItem -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Adds a menu item at the bottom of the menu. -

When creating a context menu, you can add either NativeMenuItem or - ContextMenuItem objects. However, it is advisable to use only one type of object in a context - menu so that all items in the menu have the same properties.

- -

Parameters - - - - - - - - - - -
item:NativeMenuItem — The item to add at the bottom of the menu. -
 
index:int
-

-Returns - - - - -
NativeMenuItem
-
-Throws - - - - - - - - - - -
ArgumentError — If item is null. -
 
ArgumentError — If item is a member of another menu. - -
-
- - - - - -
clone()method 
-
-public override function clone():NativeMenu -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a copy of the specified ContextMenu object. The copy inherits all the properties of the - original menu object. -

-Returns - - - - -
NativeMenu — - A ContextMenu object with all the properties of the original menu object. - - -
-
- - - - - -
containsItem()method 
-
-public override function containsItem(item:NativeMenuItem):Boolean -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Reports whether this menu contains the specified menu item. -

Parameters - - - - -
item:NativeMenuItem — The item to look up. - -
-

-Returns - - - - -
Boolean — - true if item is in this menu. - - - -
-
- - - - - -
display()method 
-
-public override function display(stage:Stage, stageX:Number, stageY:Number):void -

- - - - -
Runtime version: AIR 1.0 -
-

- Pops up this menu at the specified location. - -

Note: In Flash Player, this method is not supported.

- - Parameters - - - - - - - - - - - - - - - - -
stage:Stage — The Stage object on which to display this menu. - -
 
stageX:Number — The number of horizontal pixels, relative to the origin - of stage, at which to display this menu. - -
 
stageY:Number — The number of vertical pixels, relative to the origin - of stage, at which to display this menu. - -
-
- - - - - -
getItemAt()method 
-
-public override function getItemAt(index:int):NativeMenuItem -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Gets the menu item at the specified index. -

Parameters - - - - -
index:int — The (zero-based) position of the item to return. - -
-

-Returns - - - - -
NativeMenuItem — - The item at the specified position in the menu. - - - -
-
-Throws - - - - -
RangeError — If index is outside the bounds of the menu's - items array. -
-
- - - - - -
getItemIndex()method 
-
-public override function getItemIndex(item:NativeMenuItem):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.0 -
-

- Gets the position of the specified item. -

Parameters - - - - -
item:NativeMenuItem — The NativeMenuItem object to look up. - -
-

-Returns - - - - -
int — - The (zero-based) position of the specified item in this menu - or -1, if the item is not in this menu. - - - -
-
- - - - - -
hideBuiltInItems()method 
-
-public function hideBuiltInItems():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Hides all built-in menu items (except Settings) in the specified ContextMenu object. If the debugger version of Flash - Player is running, the Debugging menu item appears, although it is dimmed for SWF files that - do not have remote debugging enabled. -

This method hides only menu items that appear in the standard context menu; it does not affect - items that appear in the edit and error menus.

-

This method works by setting all the Boolean members of my_cm.builtInItems to false. You can selectively make a built-in item visible by setting its - corresponding member in my_cm.builtInItems to true. -

-

Note: In AIR, context menus do not have built-in items. Calling this method will have no effect.

- -

-See also -

-
-ContextMenuBuiltInItems class -
-ContextMenu.builtInItems -
-
- - - - - -
removeAllItems()method 
-
-public override function removeAllItems():void -

- - - - -
Runtime version: AIR 1.0 -
-

- Removes all items from the menu. - - - -

- - - - - -
removeItemAt()method 
-
-public override function removeItemAt(index:int):NativeMenuItem -

- - - - -
Runtime version: AIR 1.0 -
-

- Removes and returns the menu item at the specified index. - -

Parameters - - - - -
index:int — The (zero-based) position of the item to remove. - -
-

-Returns - - - - -
NativeMenuItem — - The NativeMenuItem object removed. - - - -
-
-
Event detail
- - - - - -
menuSelectevent 
-
-Event object type: flash.events.ContextMenuEvent -
-ContextMenuEvent.type property = flash.events.ContextMenuEvent.MENU_SELECT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a user first generates a - context menu but before the contents of the context menu are displayed. This allows your - program to modify the set of context menu items before - displaying the menu. The user generates - the context menu by right-clicking the pointing device. -

- Defines the value of the type property of a menuSelect event object. -

This event has the following properties:

- - - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
contextMenuOwnerThe display list object to which the menu is attached.
currentTargetThe object that is actively processing the Event - object with an event listener.
mouseTargetThe display list object on which the user right-clicked to display the context menu.
targetThe ContextMenu object that is about to be displayed. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
- -
Examples
-
examples\ContextMenuExample
-
The following example uses the class ContextMenuExample - to remove the default context menu items from the Stage and add a new menu item, which, if - clicked, changes the color of a square on the Stage. This is accomplished with the following - steps: -
    -
  1. A property myContextMenu is declared and then assigned to a new ContextMenu - object and a property redRectangle of type Sprite is declared.
    2. -
  2. The method removeDefaultItems() is called, which removes all built-in context - menu items except Print.
    3. -
  3. The method addCustomMenuItems() is called, which places a menu item called - Red to Black menu selection into the defaultItems array by using the - push() method of Array. A menuItemSelect event listener is added to the - ContextMenuItem object and the associated method is called menuItemSelectHandler(). - This method prints out some statements using trace() whenever the - context menu is accessed and Red to Black is selected. Also the red square - is removed and replaced with a black one.
    4. -
  4. An event listener of type menuSelect is added, along with - the associated method menuSelectHandler, which simply prints out three statements using - trace() every time an item in the context menu is opened.
    5. -
  5. Then addChildren() draws a red square and adds it - to the display list, where it is immediately displayed.
    6. -
  6. Finally, myContextMenu is assigned to the context menu of the redRectangle sprite - so that the custom context menu is displayed only when the mouse pointer is over the square.
    7. -
-
-
-package {
-	import flash.ui.ContextMenu;
-	import flash.ui.ContextMenuItem;
-	import flash.ui.ContextMenuBuiltInItems;
-	import flash.events.ContextMenuEvent;
-	import flash.display.Sprite;
-	import flash.display.Shape;
-    import flash.text.TextField;
-
-	public class ContextMenuExample extends Sprite {
-		private var myContextMenu:ContextMenu;
-		private var menuLabel:String = "Reverse Colors";
-		private var textLabel:String = "Right Click";
-		private var redRectangle:Sprite;
-		private var label:TextField;
-		private var size:uint = 100;
-		private var black:uint = 0x000000;
-		private var red:uint = 0xFF0000;
-
-		public function ContextMenuExample() {
-			myContextMenu = new ContextMenu();
-			removeDefaultItems();
-			addCustomMenuItems();
-			myContextMenu.addEventListener(ContextMenuEvent.MENU_SELECT, menuSelectHandler);
-
-			addChildren();
-			redRectangle.contextMenu = myContextMenu;
-		}
-
-		private function addChildren():void {
-			redRectangle = new Sprite();
-			redRectangle.graphics.beginFill(red);
-			redRectangle.graphics.drawRect(0, 0, size, size);
-			addChild(redRectangle);
-			redRectangle.x = size;
-			redRectangle.y = size;
-			label = createLabel();
-			redRectangle.addChild(label);
-		}
-
-		private function removeDefaultItems():void {
-			myContextMenu.hideBuiltInItems();
-			var defaultItems:ContextMenuBuiltInItems = myContextMenu.builtInItems;
-			defaultItems.print = true;
-		}
-
-		private function addCustomMenuItems():void {
-			var item:ContextMenuItem = new ContextMenuItem(menuLabel);
-			myContextMenu.customItems.push(item);
-			item.addEventListener(ContextMenuEvent.MENU_ITEM_SELECT, menuItemSelectHandler);
-		}
-
-		private function menuSelectHandler(event:ContextMenuEvent):void {
-			trace("menuSelectHandler: " + event);
-		}
-
-		private function menuItemSelectHandler(event:ContextMenuEvent):void {
-			trace("menuItemSelectHandler: " + event);
-			var textColor:uint = (label.textColor == black) ? red : black;
-			var bgColor:uint = (label.textColor == black) ? black : red;
-			redRectangle.graphics.clear();
-			redRectangle.graphics.beginFill(bgColor);
-			redRectangle.graphics.drawRect(0, 0, size, size);
-			label.textColor = textColor;
-		}
-
-		private function createLabel():TextField {
-			var txtField:TextField = new TextField();
-			txtField.text = textLabel;
-			return txtField;
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/ContextMenuBuiltInItems.html b/html-docs/flash/ui/ContextMenuBuiltInItems.html deleted file mode 100644 index c5851a6..0000000 --- a/html-docs/flash/ui/ContextMenuBuiltInItems.html +++ /dev/null @@ -1,579 +0,0 @@ - - - - - - - - -flash.ui.ContextMenuBuiltInItems (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class ContextMenuBuiltInItems
InheritanceContextMenuBuiltInItems Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The ContextMenuBuiltInItems class describes the items that are built in to a context menu. -You can hide these items by using the ContextMenu.hideBuiltInItems() method. -

-

-View the examples. -

-

-See also -

-
-ContextMenu.hideBuiltInItems() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  forwardAndBack : Boolean -
-Lets the user move forward or backward one frame in a SWF file at run time (does not -appear for a single-frame SWF file).
-		ContextMenuBuiltInItems
  loop : Boolean -
-Lets the user set a SWF file to start over automatically when it reaches the final -frame (does not appear for a single-frame SWF file).
-		ContextMenuBuiltInItems
  play : Boolean -
-Lets the user start a paused SWF file (does not appear for a single-frame SWF file).
-		ContextMenuBuiltInItems
  print : Boolean -
-Lets the user send the displayed frame image to a printer.
-		ContextMenuBuiltInItems
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  quality : Boolean -
-Lets the user set the resolution of the SWF file at run time.
-		ContextMenuBuiltInItems
  rewind : Boolean -
-Lets the user set a SWF file to play from the first frame when selected, at any time (does not -appear for a single-frame SWF file).
-		ContextMenuBuiltInItems
  save : Boolean -
-Lets the user with Shockmachine installed save a SWF file.
-		ContextMenuBuiltInItems
  zoom : Boolean -
-Lets the user zoom in and out on a SWF file at run time.
-		ContextMenuBuiltInItems
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ContextMenuBuiltInItems()
-
-Creates a new ContextMenuBuiltInItems object so that you can set the properties for Flash Player to display or hide each menu item.
-		ContextMenuBuiltInItems
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
forwardAndBackproperty
-
-forwardAndBack:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Lets the user move forward or backward one frame in a SWF file at run time (does not -appear for a single-frame SWF file). -

Implementation -
-    public function get forwardAndBack():Boolean -
-    public function set forwardAndBack(value:Boolean):void -
-
- - - - - -
loopproperty 
-
-loop:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Lets the user set a SWF file to start over automatically when it reaches the final -frame (does not appear for a single-frame SWF file). -

Implementation -
-    public function get loop():Boolean -
-    public function set loop(value:Boolean):void -
-
- - - - - -
playproperty 
-
-play:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Lets the user start a paused SWF file (does not appear for a single-frame SWF file). -

Implementation -
-    public function get play():Boolean -
-    public function set play(value:Boolean):void -
-
- - - - - -
printproperty 
-
-print:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Lets the user send the displayed frame image to a printer. -

Implementation -
-    public function get print():Boolean -
-    public function set print(value:Boolean):void -
-
- - - - - -
qualityproperty 
-
-quality:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Lets the user set the resolution of the SWF file at run time. -

Implementation -
-    public function get quality():Boolean -
-    public function set quality(value:Boolean):void -
-
- - - - - -
rewindproperty 
-
-rewind:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Lets the user set a SWF file to play from the first frame when selected, at any time (does not -appear for a single-frame SWF file). -

Implementation -
-    public function get rewind():Boolean -
-    public function set rewind(value:Boolean):void -
-
- - - - - -
saveproperty 
-
-save:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Lets the user with Shockmachine installed save a SWF file. -

Implementation -
-    public function get save():Boolean -
-    public function set save(value:Boolean):void -
-
- - - - - -
zoomproperty 
-
-zoom:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Lets the user zoom in and out on a SWF file at run time. -

Implementation -
-    public function get zoom():Boolean -
-    public function set zoom(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
ContextMenuBuiltInItems()constructor
-
-public function ContextMenuBuiltInItems() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-Creates a new ContextMenuBuiltInItems object so that you can set the properties for Flash Player to display or hide each menu item. -

- -
Examples
-
examples\ContextMenuBuiltinItemsExample
-
The following example uses the class ContextMenuBuiltInItemsExample - to remove the normal context menu items from the stage and add a new menu item. This is - accomplished with the following steps: -
    -
  1. A property myContextMenu is declared and then assigned to a new ContextMenu - object.
    2. -
  2. The method removeDefaultItems() is called, which removes all built-in context - menu items except Print.
    3. -
  3. The method addCustomMenuItems() is called, which places a menu item called - Hello World into the customItems array using the - push() method of Array.
    4. -
  4. The Hello World menu item is then added to the Stage's context - menu item list.
    5. -
  5. A TextField object with the text "Right Click" is added to the center of the Stage - by using addChild() via createLabel().
    6. -
-
-
-package {
-	import flash.ui.ContextMenu;
-	import flash.ui.ContextMenuItem;
-	import flash.ui.ContextMenuBuiltInItems;
-	import flash.display.Sprite;
-	import flash.text.TextField;
-
-	public class ContextMenuBuiltInItemsExample extends Sprite {
-		private var myContextMenu:ContextMenu;
-
-		public function ContextMenuBuiltInItemsExample() {
-			myContextMenu = new ContextMenu();
-			removeDefaultItems();
-			addCustomMenuItems();
-			this.contextMenu = myContextMenu;
-			addChild(createLabel());
-		}
-
-		private function removeDefaultItems():void {
-			myContextMenu.hideBuiltInItems();
-
-			var defaultItems:ContextMenuBuiltInItems = myContextMenu.builtInItems;
-			defaultItems.print = true;
-		}
-
-		private function addCustomMenuItems():void {
-			var item:ContextMenuItem = new ContextMenuItem("Hello World");
-			myContextMenu.customItems.push(item);
-		}
-		
-		private function createLabel():TextField {
-			var txtField:TextField = new TextField();
-			txtField.text = "Right Click";
-			txtField.x = this.stage.stageWidth/2 - txtField.width/2;
-			txtField.y = this.stage.stageHeight/2 - txtField.height/2;
-			return txtField;
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/ContextMenuClipboardItems.html b/html-docs/flash/ui/ContextMenuClipboardItems.html deleted file mode 100644 index 22a5b22..0000000 --- a/html-docs/flash/ui/ContextMenuClipboardItems.html +++ /dev/null @@ -1,427 +0,0 @@ - - - - - - - - -flash.ui.ContextMenuClipboardItems (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class ContextMenuClipboardItems
InheritanceContextMenuClipboardItems Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

-

- The ContextMenuClipboardItems class lets you enable or disable the commands in the clipboard context menu. - -

Enable or disable the context menu clipboard commands using the clipboardItems property of - the ContextMenu object. The clipboardItems property is an instance of this ContextMenuClipboardItems - class. The clipboard context menu is shown in a context menu when the clipboardMenu property - of the context menu is true, unless the context menu is for a TextField object. TextField objects - control the display of the context menu and the state of its clipboard items automatically.

- -

-

-See also -

-
-ContextMenu.clipboardMenu -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  clear : Boolean -
- Enables or disables the 'Delete' or 'Clear' item on the clipboard menu.
-		ContextMenuClipboardItems
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  copy : Boolean -
- Enables or disables the 'Copy' item on the clipboard menu.
-		ContextMenuClipboardItems
  cut : Boolean -
- Enables or disables the 'Cut' item on the clipboard menu.
-		ContextMenuClipboardItems
  paste : Boolean -
- Enables or disables the 'Paste' item on the clipboard menu.
-		ContextMenuClipboardItems
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  selectAll : Boolean -
- Enables or disables the 'Select All' item on the clipboard menu.
-		ContextMenuClipboardItems
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ContextMenuClipboardItems()
-
- Creates a new ContextMenuClipboardItems object.
-		ContextMenuClipboardItems
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
clearproperty
-
-clear:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Enables or disables the 'Delete' or 'Clear' item on the clipboard menu. - This should be enabled only if an object that can be cleared is selected. -

Implementation -
-    public function get clear():Boolean -
-    public function set clear(value:Boolean):void -
-
- - - - - -
copyproperty 
-
-copy:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Enables or disables the 'Copy' item on the clipboard menu. - This should be enabled only if an object that can be copied is selected. -

Implementation -
-    public function get copy():Boolean -
-    public function set copy(value:Boolean):void -
-
- - - - - -
cutproperty 
-
-cut:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Enables or disables the 'Cut' item on the clipboard menu. - This should be enabled only if an object that can be cut is selected. -

Implementation -
-    public function get cut():Boolean -
-    public function set cut(value:Boolean):void -
-
- - - - - -
pasteproperty 
-
-paste:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Enables or disables the 'Paste' item on the clipboard menu. - This should be enabled only if pastable data is on the clipboard. -

Implementation -
-    public function get paste():Boolean -
-    public function set paste(value:Boolean):void -
-
- - - - - -
selectAllproperty 
-
-selectAll:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Enables or disables the 'Select All' item on the clipboard menu. - This should only be enabled in a context where a selection can be - expanded to include all similar items, such as in a list or a text editing control. -

Implementation -
-    public function get selectAll():Boolean -
-    public function set selectAll(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
ContextMenuClipboardItems()constructor
-
-public function ContextMenuClipboardItems() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new ContextMenuClipboardItems object. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/ContextMenuItem.html b/html-docs/flash/ui/ContextMenuItem.html deleted file mode 100644 index 95f4a72..0000000 --- a/html-docs/flash/ui/ContextMenuItem.html +++ /dev/null @@ -1,943 +0,0 @@ - - - - - - - - -flash.ui.ContextMenuItem (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class ContextMenuItem
InheritanceContextMenuItem Inheritance NativeMenuItem Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The ContextMenuItem class represents an item in the context - menu. Each ContextMenuItem object has a caption (text) that is displayed in the context menu. To add - a new item to a context menu, you add it to the customItems array of a - ContextMenu object. -

With the properties of the ContextMenuItem class you can enable or disable specific menu items, and you can make - items visible or invisible.

You write an event handler for the menuItemSelect event - to add functionality to the menu item when the user selects it. -

Custom menu items appear at the top of the context menu, above any built-in items. A separator bar - divides custom menu items from built-in items. In AIR, there are no built-in items and the - following restrictions do not apply to content in the AIR application sandbox.

-

Restrictions:

-
  • You can add no more than 15 custom items to a context menu.
    • -
  • Each caption must contain at least one visible character.
    • -
  • Control characters, newlines, and other white space characters are ignored.
    • -
  • No caption can be more than 100 characters long.
    • -
  • Captions that are identical to any built-in menu item, or to another custom item, are ignored, - whether the matching item is visible or not. Menu captions are compared to built-in captions or - existing custom captions without regard to case, punctuation, or white space.
    • -
  • The following captions are not allowed, but the words may be used in conjunction with other words - to form a custom caption (for example, although "Paste" is not allowed, "Paste tastes great" is allowed): - 
    - Save
- Zoom In
- Zoom Out
- 100%
- Show All
- Quality
- Play
- Loop
- Rewind
- Forward
- Back
- Movie not loaded
- About
- Print
- Show Redraw Regions
- Debugger
- Undo
- Cut
- Copy
- Paste
- Delete
- Select All
- Open
- Open in new window
- Copy link
-
    • -
  • None of the following words can appear in a custom caption on their own or in conjunction with other words: - 
    - Adobe
- Macromedia
- Flash Player
- Settings
-
-

Note: When the player is running on a non-English system, the caption strings are compared to both the English list and the localized equivalents.

-

-

-View the examples. -

-

-See also -

-
-ContextMenu class -
-ContextMenuBuiltInItems class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  caption : String -
- Specifies the menu item caption (text) displayed in the context menu.
-		ContextMenuItem
 Inheritedchecked : Boolean -
- - Controls whether this menu item displays a checkmark.
-		NativeMenuItem
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheriteddata : Object -
- - An arbitrary data object associated with this menu item.
-		NativeMenuItem
 Inheritedenabled : Boolean -
- - Controls whether this menu item is enabled.
-		NativeMenuItem
 InheritedisSeparator : Boolean -
- - Reports whether this item is a menu separator line.
-		NativeMenuItem
 InheritedkeyEquivalent : String -
- - The key equivalent for this menu item.
-		NativeMenuItem
 InheritedkeyEquivalentModifiers : Array -
- - The array of key codes for the key equivalent modifiers.
-		NativeMenuItem
 Inheritedlabel : String -
- - The display string of this menu item.
-		NativeMenuItem
 Inheritedmenu : NativeMenu -
- - The menu that contains this item.
-		NativeMenuItem
 InheritedmnemonicIndex : int -
- - The position of the mnemonic character in the menu item label.
-		NativeMenuItem
 Inheritedname : String -
- - The name of this menu item.
-		NativeMenuItem
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  separatorBefore : Boolean -
- Indicates whether a separator bar should appear above the specified menu item.
-		ContextMenuItem
 Inheritedsubmenu : NativeMenu -
- - The submenu associated with this menu item.
-		NativeMenuItem
  visible : Boolean -
- Indicates whether the specified menu item is visible when the Flash Player - context menu is displayed.
-		ContextMenuItem
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true)
-
- Creates a new ContextMenuItem object that can be added to the ContextMenu.customItems - array.
-		ContextMenuItem
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
   -
-clone():NativeMenuItem -
-
- - Creates a copy of the NativeMenuItem object.
-		ContextMenuItem
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-systemClearMenuItem():ContextMenuItem -
-
[static]
-		ContextMenuItem
   -
-systemCopyLinkMenuItem():ContextMenuItem -
-
[static]
-		ContextMenuItem
   -
-systemCopyMenuItem():ContextMenuItem -
-
[static]
-		ContextMenuItem
   -
-systemCutMenuItem():ContextMenuItem -
-
[static]
-		ContextMenuItem
   -
-systemOpenLinkMenuItem():ContextMenuItem -
-
[static]
-		ContextMenuItem
   -
-systemPasteMenuItem():ContextMenuItem -
-
[static]
-		ContextMenuItem
   -
-systemSelectAllMenuItem():ContextMenuItem -
-
[static]
-		ContextMenuItem
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns a string containing all the properties of the NativeMenuItem object.
-		NativeMenuItem
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
 Inherited -
-displaying -
-		 - - Dispatched by this NativeMenuItem object immediately before the - - menu containing the item is displayed.NativeMenuItem
   -
-menuItemSelect -
-		 - Dispatched when a user selects an item from a context menu.ContextMenuItem
 Inherited -
-preparing -
-		 - - Dispatched by this NativeMenuItem object when its key equivalent is pressed and immediately before the containing menu is displayed.NativeMenuItem
 Inherited -
-select -
-		 - - Dispatched whenever a menu item is selected by the user.NativeMenuItem
-
- -
- -
Property detail
- - - - - -
captionproperty
-
-caption:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Specifies the menu item caption (text) displayed in the context menu. - See the ContextMenuItem class overview for caption value restrictions. -

Implementation -
-    public function get caption():String -
-    public function set caption(value:String):void -
-
- - - - - -
separatorBeforeproperty 
-
-separatorBefore:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether a separator bar should appear above the specified menu item. - -

Note: A separator bar always appears between any custom menu items and the - built-in menu items.

-

The default value is false.

-Implementation -
-    public function get separatorBefore():Boolean -
-    public function set separatorBefore(value:Boolean):void -
-
- - - - - -
visibleproperty 
-
-visible:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates whether the specified menu item is visible when the Flash Player - context menu is displayed. -

The default value is true.

-Implementation -
-    public function get visible():Boolean -
-    public function set visible(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
ContextMenuItem()constructor
-
-public function ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new ContextMenuItem object that can be added to the ContextMenu.customItems - array. -

Parameters - - - - - - - - - - - - - - - - - - - - - - -
caption:String — Specifies the text associated with the menu item. - See the ContextMenuItem class overview for caption value restrictions. -
 
separatorBefore:Boolean (default = false) — Specifies whether a separator bar appears above the - menu item in the context menu. The default value is false. -
 
enabled:Boolean (default = true) — Specifies whether the menu item is enabled or disabled in the - context menu. The default value is true (enabled). This parameter is optional. -
 
visible:Boolean (default = true) — Specifies whether the menu item is visible or invisible. The - default value is true (visible). -
-
- -
Method detail
- - - - - -
clone()method
-
-public override function clone():NativeMenuItem

- - Creates a copy of the NativeMenuItem object. - - -

-Returns - - - - -
NativeMenuItem
-
- - - - - -
systemClearMenuItem()method 
-
-public static function systemClearMenuItem():ContextMenuItem -

-Returns - - - - -
ContextMenuItem
-
- - - - - -
systemCopyLinkMenuItem()method 
-
-public static function systemCopyLinkMenuItem():ContextMenuItem -

-Returns - - - - -
ContextMenuItem
-
- - - - - -
systemCopyMenuItem()method 
-
-public static function systemCopyMenuItem():ContextMenuItem -

-Returns - - - - -
ContextMenuItem
-
- - - - - -
systemCutMenuItem()method 
-
-public static function systemCutMenuItem():ContextMenuItem -

-Returns - - - - -
ContextMenuItem
-
- - - - - -
systemOpenLinkMenuItem()method 
-
-public static function systemOpenLinkMenuItem():ContextMenuItem -

-Returns - - - - -
ContextMenuItem
-
- - - - - -
systemPasteMenuItem()method 
-
-public static function systemPasteMenuItem():ContextMenuItem -

-Returns - - - - -
ContextMenuItem
-
- - - - - -
systemSelectAllMenuItem()method 
-
-public static function systemSelectAllMenuItem():ContextMenuItem -

-Returns - - - - -
ContextMenuItem
-
-
Event detail
- - - - - -
menuItemSelectevent 
-
-Event object type: flash.events.ContextMenuEvent -
-ContextMenuEvent.type property = flash.events.ContextMenuEvent.MENU_ITEM_SELECT -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Dispatched when a user selects an item from a context menu. - The user generates the context menu by clicking the secondary button of the user's pointing device. -

- Defines the value of the type property of a menuItemSelect event object. -

This event has the following properties:

- - - - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
contextMenuOwnerThe display list object to which the menu is attached.
currentTargetThe object that is actively processing the Event - object with an event listener.
mouseTargetThe display list object on which the user right-clicked to display the context menu.
targetThe ContextMenuItem object that has been selected. - The target is not always the object in the display list - that registered the event listener. Use the currentTarget - property to access the object in the display list that is currently processing the event.
- -
- -
Examples
-
examples\ContextMenuItemExample
-
The following example uses the class ContextMenuBuiltInItemsExample - to remove the default context menu items from the Stage and add a new menu item. This is - accomplished with the following steps: -
    -
  1. A property myContextMenu is declared and then assigned to a new ContextMenu - object.
    2. -
  2. The method removeDefaultItems() is called, which removes all built-in context - menu items except Print.
    3. -
  3. The method addCustomMenuItems() is called, which places a menu item called - Hello World into the customItems array by using the - push() method of Array.
    4. -
  4. The Hello World context menu item is added to the Stage's context - menu item list.
    5. -
  5. A TextField object with the text "Right Click Here" is added to the stage.
    6. -
-
-
-package {
-	import flash.ui.ContextMenu;
-	import flash.ui.ContextMenuItem;
-	import flash.ui.ContextMenuBuiltInItems;
-	import flash.display.Sprite;
-	import flash.text.TextField;
-
-	public class ContextMenuItemExample extends Sprite {
-		private var myContextMenu:ContextMenu;
-
-		public function ContextMenuItemExample() {
-			myContextMenu = new ContextMenu();
-			removeDefaultItems();
-			addCustomMenuItems();
-			this.contextMenu = myContextMenu;
-			addChild(createLabel());
-		}
-
-		private function removeDefaultItems():void {
-			myContextMenu.hideBuiltInItems();
-
-			var defaultItems:ContextMenuBuiltInItems = myContextMenu.builtInItems;
-			defaultItems.print = true;
-		}
-
-		private function addCustomMenuItems():void {
-			var item:ContextMenuItem = new ContextMenuItem("Hello World");
-			myContextMenu.customItems.push(item);
-		}
-		
-		private function createLabel():TextField {
-			var txtField:TextField = new TextField();
-			txtField.text = "Right Click Here";
-			return txtField;
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/GameInput.html b/html-docs/flash/ui/GameInput.html deleted file mode 100644 index 2536538..0000000 --- a/html-docs/flash/ui/GameInput.html +++ /dev/null @@ -1,569 +0,0 @@ - - - - - - - - -flash.ui.GameInput (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class GameInput
InheritanceGameInput Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

-

- The GameInput class is the entry point into the GameInput - API. You can use this API to manage the communications between an - application and game input devices (for example: joysticks, gamepads, and wands). - -

- The main purpose of this class is to provide access to the supported - input devices that are connected to your application platform. This - static class enumerates the connected input devices in a list. You - access a device from the list using the getDeviceAt(index:int) method. -

-

- The numDevices property provides the number of input - devices currently connected to your platform. Use this value to - determine the upper bound of the list of devices. -

-

- Use an instance of this class to listen for events that notify you about the addition - and removal of input devices. To listen these events, do the following: -

    -
  1. - Create an instance of the GameInput class. -
    2. -
  2. - Add event listeners for the GameInputEvent.DEVICE_ADDED - and GameInputEvent.DEVICE_REMOVED events. (Events can only be - registered on an instance of the class.) -
    3. -
-

-

- This class also features the isSupported flag, which - indicates whether the GameInput API is supported on your platform.

-

For more information, see the Adobe Air Developer Center article: - Game controllers on Adobe AIR. -

-

For Android, this feature supports a minimum Android OS version of 4.1 and - requires the minimum SWF version 20 and namespace 3.7. - For iOS, this feature supports a minimum iOS version of 9.0 and requires - the minimum SWF version 34 and namespace 23.0. -

-

How to Detect One Game Input Device From Among Identical - Devices

-

- A common requirement for two-or-more player games is detecting one device - from among identical devices. For example, applications sometimes must - determine which device represents "Player 1", "Player 2", ..., "Player N". -

-

- Solution: -

    -
  1. - Add event listeners to every control on all undetected input devices. These event - listeners listen for Event.CHANGE events, which are dispatched - whenever a control value changes. -
    2. -
  2. - The first time any control is activated (for example a button press or trigger pull) - the application labels that device. -
    3. -
  3. - Remove all of the event listeners from the remaining undetected input devices. -
    4. -
  4. - Repeat steps 1-3 as required to identify the rest of the undetected input devices. -
    5. -
-

-

-

-See also -

-
-flash.ui.GameInputDevice -
-flash.ui.GameInputControl -
-flash.events.GameInputEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  isSupported : Boolean -
[static][read-only] - Indicates whether the current platform supports the GameInput API.
-		GameInput
  numDevices : int -
[static][read-only] - Provides the number of connected input devices.
-		GameInput
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
   -
-getDeviceAt(index:int):GameInputDevice -
-
[static] - Gets the input device at the specified index location in the list - of connected input devices.
-		GameInput
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-deviceAdded -
-		 - Dispatched when a game input device is connected to your platform, - or when an already connected device is switched on.GameInput
   -
-deviceRemoved -
-		 - Dispatched when a game input device is removed from your platform, - or when a connected device is switched off.GameInput
   -
-deviceUnusable -
-		 - Dispatched when a game input device is connected but is not usable.GameInput
-
- -
- -
Property detail
- - - - - -
isSupportedproperty
-
-isSupported:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Indicates whether the current platform supports the GameInput API. - -

Implementation -
-    public static function get isSupported():Boolean -
-
- - - - - -
numDevicesproperty 
-
-numDevices:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Provides the number of connected input devices. When - a device is connected, the GameInputEvent.DEVICE_ADDED - event is fired. - -

Implementation -
-    public static function get numDevices():int -
-
- -
Method detail
- - - - - -
getDeviceAt()method
-
-public static function getDeviceAt(index:int):GameInputDevice -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Gets the input device at the specified index location in the list - of connected input devices. -

- The order of devices in the index may change whenever - a device is added or removed. You can check the name and - id properties on a GameInputDevice object to - match a specific input device. -

- Parameters - - - - -
index:int — The index position in the list of input devices. -
-

-Returns - - - - -
GameInputDevice — - The specified GameInputDevice. - - -
-
-Throws - - - - -
RangeError — When the provided index is less than zero or - greater than (numDevices - 1). -
-
-
Event detail
- - - - - -
deviceAddedevent 
-
-Event object type: flash.events.GameInputEvent -
-

- Dispatched when a game input device is connected to your platform, - or when an already connected device is switched on. -

- - - - - -
deviceRemovedevent  
-
-Event object type: flash.events.GameInputEvent -
-

- Dispatched when a game input device is removed from your platform, - or when a connected device is switched off. -

- - - - - -
deviceUnusableevent  
-
-Event object type: flash.events.GameInputEvent -
-

- Dispatched when a game input device is connected but is not usable. - This event is specific to Windows only. - For example, this happens in a Windows sandboxed browser when another - DirectInput based application is already using the device. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/GameInputControl.html b/html-docs/flash/ui/GameInputControl.html deleted file mode 100644 index a518aa9..0000000 --- a/html-docs/flash/ui/GameInputControl.html +++ /dev/null @@ -1,536 +0,0 @@ - - - - - - - - -flash.ui.GameInputControl (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic dynamic class GameInputControl
InheritanceGameInputControl Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

-

- The GameInputControl class represents a control on an input device. - The GameInput API maps the physical controls on a device to simple - logical controls. - -

Getting Control Values:

-

- The value property returns the current value of a - control. This method does not return the latest value directly from the - control. Instead it returns the value that was cached the last time the - control was sampled. -

-

- There are three ways to get control values from an individual control: -

    -
  1. - Polling: Call value whenever you want - to get the last known value for a control. -
    2. -
  2. - Change Events: Register a change event for a controller. The - Event.CHANGE event is dispatched whenever the value of - a control changes. Upon receiving the event, call - value to get the value for the control that - fired the event. -
    3. -
  3. - Caching Sample Values: Caching is done at the device level. See - the GameInputDevice class documentation for details on - caching and retrieving sampled control values. -
    4. -
-

-

- Attempting to read control values from a disabled device causes - value to throw an IOError. However, you can - access properties describing a control ( id, minValue and - maxValue) even if the device is not enabled. - This feature makes it possible to determine if a device fits the - needs of your application, without having to first enable the device. -

-

For more information, see the Adobe Air Developer Center article: - Game controllers on Adobe AIR. -

-

For Android, this feature supports a minimum Android OS version of 4.1 and - requires the minimum SWF version 20 and namespace 3.7. - For iOS, this feature supports a minimum iOS version of 9.0 and requires - the minimum SWF version 34 and namespace 23.0. -

-

-

-See also -

-
-flash.ui.GameInput -
-flash.ui.GameInputDevice -
-flash.events.GameInputEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  device : GameInputDevice -
[read-only] - Returns the GameInputDevice object that contains this control.
-		GameInputControl
  id : String -
[read-only] - Returns the id of this control.
-		GameInputControl
  maxValue : Number -
[read-only] - Returns the maximum value for this control.
-		GameInputControl
  minValue : Number -
[read-only] - Returns the minimum value for this control.
-		GameInputControl
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  value : Number -
[read-only] - Returns the value for this control.
-		GameInputControl
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
   -
-change -
-		 - Dispatched when a control value changes.GameInputControl
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
-
- -
- -
Property detail
- - - - - -
deviceproperty
-
-device:GameInputDevice  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Returns the GameInputDevice object that contains this control. -

Implementation -
-    public function get device():GameInputDevice -
-
- - - - - -
idproperty 
-
-id:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Returns the id of this control. -

Implementation -
-    public function get id():String -
-
- - - - - -
maxValueproperty 
-
-maxValue:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Returns the maximum value for this control. -

Implementation -
-    public function get maxValue():Number -
-
- - - - - -
minValueproperty 
-
-minValue:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Returns the minimum value for this control. -

Implementation -
-    public function get minValue():Number -
-
- - - - - -
valueproperty 
-
-value:Number  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Returns the value for this control. -

Implementation -
-    public function get value():Number -
-
-Throws -
- - - - -
Error — When value is called while the device is - disabled. -
-
-
Event detail
- - - - - -
changeevent 
-
-Event object type: flash.events.Event -
-

- Dispatched when a control value changes. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/GameInputDevice.html b/html-docs/flash/ui/GameInputDevice.html deleted file mode 100644 index cd98aa9..0000000 --- a/html-docs/flash/ui/GameInputDevice.html +++ /dev/null @@ -1,863 +0,0 @@ - - - - - - - - -flash.ui.GameInputDevice (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class GameInputDevice
InheritanceGameInputDevice Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

-

- The GameInputDevice class represents a single input device - commonly used for gaming. -

- This class includes methods and properties that you can use to: -

    -
  • - Enable or disable an input device. - Devices are initially disabled by default (enabled set to - false). You must explicitly enable a device, by setting - enabled to true, before you can get control - values from the device. -
    • -
  • - Get the name and ID of an input device. The name and - id properties together uniquely identify a device. - For Android devices, the device manufacturer supplies these values. - For iOS devices, the id may change each time you connect the device. -
    • -
  • - Enumerate the controls on an input device. Physical controls on a - device are mapped to logical GameInputControl objects and stored - in a list. You access a control in the list with the - getControlAt() method.
    • -
  • - Manage caching of sampled control values. Sampling a set of control - values directly from a device object is one of three ways to get - control values. (The other two ways use the - value method on the GameInputControl - class, and are described there.) Sample caching is useful when you need - to access control values at a faster rate than the frame rate of an - application. -
    • -
-

-

- Always set up a listener on this class for the GameInputEvent.DEVICE_REMOVED - event. This listener lets you handle the case of a device being unexpectedly disconnected or powered off. - When a device is disconnected, free its GameInputDevice - object, as the object is no longer valid after its associated device - is disconnected. -

-

- An Android device that is removed and then reconnected retains the ID it - had when it was first connected. You can logically reconnect to a device - by matching its ID. For iOS devices, the ID may change when you reconnect the device. -

-

- Note: You cannot rely on the order of devices in - the list. (The order can change when devices are added and - removed.) -

-

For more information, see the Adobe Air Developer Center article: - Game controllers on Adobe AIR. -

-

For Android, this feature supports a minimum Android OS version of 4.1 and - requires the minimum SWF version 20 and namespace 3.7. - For iOS, this feature supports a minimum iOS version of 9.0 and requires - the minimum SWF version 34 and namespace 23.0. -

-

-

-See also -

-
-flash.ui.GameInput -
-flash.ui.GameInputControl -
-flash.events.GameInputEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  enabled : Boolean -
- Enables or disables this device.
-		GameInputDevice
  id : String -
[read-only] - Returns the ID of this device.
-		GameInputDevice
  name : String -
[read-only] - Returns the name of this device.
-		GameInputDevice
  numControls : int -
[read-only] - Returns the number of controls on this device.
-		GameInputDevice
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  sampleInterval : int -
- Specifies the rate (in milliseconds) at which to retrieve control - values.
-		GameInputDevice
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-getCachedSamples(data:ByteArray, append:Boolean = false):int -
-
- Writes cached sample values to the ByteArray.
-		GameInputDevice
   -
-getControlAt(i:int):GameInputControl -
-
- Retrieves a specific control from a device.
-		GameInputDevice
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-startCachingSamples(numSamples:int, controls:Vector.<String>):void -
-
- Requests this device to start keeping a cache of sampled values.
-		GameInputDevice
   -
-stopCachingSamples():void -
-
- Stops sample caching.
-		GameInputDevice
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - -
 ConstantDefined by
  MAX_BUFFER_SIZE : int = 32000
[static] - Specifies the maximum size for the buffer used to cache sampled - control values.
-		GameInputDevice
-
- -
- -
Property detail
- - - - - -
enabledproperty
-
-enabled:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Enables or disables this device. Devices are disabled by default. - Enable a device to access or sample its control - values. Also, a device and its individual controls dispatch - events only when the device is enabled. -

- When a device is removed, it becomes disabled. You can still get - information about a disabled device, but you cannot access - control values or start caching. Also, you cannot enable the device if - it has been removed. If a device is removed, enabled - always returns false. -

- Implementation -
-    public function get enabled():Boolean -
-    public function set enabled(value:Boolean):void -
-
- - - - - -
idproperty 
-
-id:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Returns the ID of this device. You can differentiate devices - by their IDs. -

- Note: For Android devices, the device manufacturer provides device IDs. - For iOS devices, the ID may change when you reconnect the device. -

- Implementation -
-    public function get id():String -
-
- - - - - -
nameproperty 
-
-name:String  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Returns the name of this device. The name can help to identify the - type of device. -

Note: The device manufacturer provides the names of its devices.

- Implementation -
-    public function get name():String -
-
- - - - - -
numControlsproperty 
-
-numControls:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Returns the number of controls on this device. -

Implementation -
-    public function get numControls():int -
-
- - - - - -
sampleIntervalproperty 
-
-sampleInterval:int  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Specifies the rate (in milliseconds) at which to retrieve control - values. The default is 0, which means that values are updated - once per frame. Setting a higher sampleValue directs - GameInput to sample control values at a rate faster than the application's - frame rate. -

- Although values can be updated more frequently - than once per frame, only one event per control is dispatched. Therefore, if - two updates to a value occur in one frame, only one change event - is dispatched, and only the newest value can be retrieved. -

- -

- To retrieve more than just the newest value, you can cache sample - values by using the cache methods in this class. When you cache - sampled values, this property determines how frequently values are - written to the cache. -

- -

The default value is 0.

-Implementation -
-    public function get sampleInterval():int -
-    public function set sampleInterval(value:int):void -
-
-Throws -
- - - - - - - - - - -
Error — When the device is disabled while setting - this property. -
 
RangeError — When the sampleInterval is less than 0. -
-
- -
Method detail
- - - - - -
getCachedSamples()method
-
-public function getCachedSamples(data:ByteArray, append:Boolean = false):int -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Writes cached sample values to the ByteArray. - The cached sample values are written to the ByteArray in the order they - were retrieved (oldest values first, newest values last). -

- This method returns the number of cached sample values written to the - ByteArray (not the values themselves). If - the append parameter is false (the - default), then the ByteArray is cleared before the sample values - are written from the cache. If append is true, then the sample values are appended to - the ByteArray, preserving the older values. Append sample values if: -

    -
  • - You must keep a specific number of values available. -
    • -
  • - You must keep a history larger than the cache. -
    • -
- - Important: If append is true, it is the responsibility - of the application to clear the ByteArray. If - the ByteArray is not cleared, it continues to grow, - potentially crashing the application. -

-

- The cache is cleared after the sample values are written to the ByteArray. -

-

- An IOError is thrown if the device is disabled when - this method is called. -

- - Parameters - - - - - - - - - - -
data:ByteArray — The ByteArray that holds the retrieved data. It is - filled with sample values written as doubles. The ByteArray holds NaN - as the value of an control in case no change is detected in the control's position. -
 
append:Boolean (default = false) — A flag that determines how the data is written to - the ByteArray. If true, the sampled values are written to the end of the - array. If false, the contents of the ByteArray are removed and then - the data is written to the array. The default is false. -
-

-Returns - - - - -
int — - The number of samples (not values) written to the ByteArray. - - -
-
-Throws - - - - - - - - - - -
ArgumentError — When data is null. -
 
Error — When this method is called and the - device is disabled. -
-
- - - - - -
getControlAt()method 
-
-public function getControlAt(i:int):GameInputControl -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Retrieves a specific control from a device. -

- GameInputDevice stores the controls on a device in a list. You can access individual - controls on a device using the getControlAt() method.

-

- The order of control in the index may change whenever - a device is added or removed. You can check the id property - on a GameInputControl object to match a specific control. -

-

- You can get controls even if a device is not enabled. However you - cannot read control values from a disabled device. This feature - lets you read a control's properties before you enable the device - it belongs to. You can use this capability to determine whether a - device is appropriate for your application before you enable the device. -

- Parameters - - - - -
i:int — The index position of the GameInputControl in the list of GameInputControls. -
-

-Returns - - - - -
GameInputControl — - The GameInputControl object in the specified index position. - - -
-
-Throws - - - - -
RangeError — When the index is less than zero or greater than - (numControls - 1). -
-
- - - - - -
startCachingSamples()method 
-
-public function startCachingSamples(numSamples:int, controls:Vector.<String>):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Requests this device to start keeping a cache of sampled values. - The sampleInterval property determines the frequency of sampling. The numSamples - parameter specifies the number of samples to cache. The - controls parameter specifies the ID values of the - controls to sample. -

- Control values are cached in the order specified. You retrieve the sampled - values by calling the getCachingSamples() method. -

-

- If the memory required to cache sampled values is larger than the value - specified in the MAX_BUFFER_SIZE constant, this method - throws a MemoryError. An IOError is - thrown if the device hasn't been enabled before calling this method. -

- - Parameters - - - - - - - - - - -
numSamples:int — The number of samples to store in the cache. When - retrieving samples you always get less than or equal to - numSamples. -
 
controls:Vector.<String> — A vector of String. Each String - is an id of a control. The samples are written in the same order - provided in this vector. -
-
-Throws - - - - - - - - - - - - - - - - - - - - - - -
RangeError — When numSamples is less than or - equal to zero, or when an entry in controls is - less than zero or greater than (numControls - 1). -
 
ArgumentError — When controls is null or doesn't - contain at least one entry or contains invalid enteries. -
 
Error — When this method is called on a disabled - device. -
 
Error — When the cache size - (number of values * samples) is larger than - MAX_BUFFER_SIZE. -
-
- - - - - -
stopCachingSamples()method 
-
-public function stopCachingSamples():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Stops sample caching. Although change events on controls are - still dispatched, no more samples are saved in the cache. Values - are still retrieved at the frequency specified by - sampleInterval, however those values are not stored in - the cache. Therefore you can only retrieve the latest value. -


-Throws - - - - -
Error — When you call this method without first - enabling the device. -
-
- -
Constant detail
- - - - - -
MAX_BUFFER_SIZEconstant
-
-public static const MAX_BUFFER_SIZE:int = 32000 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3.7 -
-

- Specifies the maximum size for the buffer used to cache sampled - control values. If startCachingSamples returns samples that - require more memory than you specify, it throws a memory error. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/KeyLocation.html b/html-docs/flash/ui/KeyLocation.html deleted file mode 100644 index e92f514..0000000 --- a/html-docs/flash/ui/KeyLocation.html +++ /dev/null @@ -1,371 +0,0 @@ - - - - - - - - -flash.ui.KeyLocation (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class KeyLocation
InheritanceKeyLocation Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

-The KeyLocation class contains constants that indicate the location of a key pressed on -the keyboard or keyboard-like input device. -

The KeyLocation constants are used in the KeyboardEvent.keyLocation property.

- -

-

-See also -

-
-flash.events.KeyboardEvent.keyLocation -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  D_PAD : uint = 4
[static] - Indicates the key activation originated on a directional pad of input device.
-		KeyLocation
  LEFT : uint = 1
[static] - Indicates the key activated is in the left key location (there is more than one possible location for this - key).
-		KeyLocation
  NUM_PAD : uint = 3
[static] - Indicates the key activation originated on the numeric keypad or with a virtual key corresponding - to the numeric keypad.
-		KeyLocation
  RIGHT : uint = 2
[static] - Indicates the key activated is in the right key location (there is more than one possible location for this - key).
-		KeyLocation
  STANDARD : uint = 0
[static] - Indicates the key activation is not distinguished as the left or right version of the key, - and did not originate on the numeric keypad (or did not originate with a virtual - key corresponding to the numeric keypad).
-		KeyLocation
-
- -
- -
Constant detail
- - - - - -
D_PADconstant
-
-public static const D_PAD:uint = 4 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.5 -
-

- Indicates the key activation originated on a directional pad of input device. - Example: The trackball on a mobile device or the left arrow on a remote control. -

- - - - - -
LEFTconstant 
-
-public static const LEFT:uint = 1 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the key activated is in the left key location (there is more than one possible location for this - key). - Example: The left Shift key on a PC 101 Key US keyboard. -

- - - - - -
NUM_PADconstant 
-
-public static const NUM_PAD:uint = 3 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the key activation originated on the numeric keypad or with a virtual key corresponding - to the numeric keypad. Example: The 1 key on a PC 101 Key US keyboard located on the numeric pad. -

- - - - - -
RIGHTconstant 
-
-public static const RIGHT:uint = 2 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the key activated is in the right key location (there is more than one possible location for this - key). - Example: The right Shift key on a PC 101 Key US keyboard. -

- - - - - -
STANDARDconstant 
-
-public static const STANDARD:uint = 0 -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Indicates the key activation is not distinguished as the left or right version of the key, - and did not originate on the numeric keypad (or did not originate with a virtual - key corresponding to the numeric keypad). Example: The Q key on a PC 101 Key US keyboard. -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/Keyboard.html b/html-docs/flash/ui/Keyboard.html deleted file mode 100644 index 27b7360..0000000 --- a/html-docs/flash/ui/Keyboard.html +++ /dev/null @@ -1,10539 +0,0 @@ - - - - - - - - -flash.ui.Keyboard (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class Keyboard
InheritanceKeyboard Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The Keyboard class is used to build an interface that can be controlled by a user with a standard keyboard. - - You can use the methods and properties of the Keyboard class without using a constructor. - - The properties of the Keyboard class are constants representing the keys that are - - most commonly used to control games. - - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  capsLock : Boolean -
[static][read-only] - - Specifies whether the Caps Lock key is activated (true) or not (false).
-		Keyboard
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  hasVirtualKeyboard : Boolean -
[static][read-only] - - Indicates whether the computer or device provides a virtual keyboard.
-		Keyboard
  numLock : Boolean -
[static][read-only] - - Specifies whether the Num Lock key is activated (true) or not (false).
-		Keyboard
  physicalKeyboardType : String -
[static][read-only] - - Indicates the type of physical keyboard provided by the computer or device, if any.
-		Keyboard
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-isAccessible():Boolean -
-
[static] - - Specifies whether the last key pressed is accessible by other SWF files.
-		Keyboard
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  A : uint = 65
[static] - - Constant associated with the key code value for the A key (65).
-		Keyboard
  ALTERNATE : uint = 18
[static] - - Constant associated with the key code value for the Alternate (Option) key (18).
-		Keyboard
  AUDIO : uint = 0x01000017
[static] - - Constant associated with the key code value for the button for selecting the audio mode.
-		Keyboard
  B : uint = 66
[static] - - Constant associated with the key code value for the B key (66).
-		Keyboard
  BACK : uint = 0x01000016
[static] - - Constant associated with the key code value for the button for returning to the previous page in the application.
-		Keyboard
  BACKQUOTE : uint = 192
[static] - - Constant associated with the key code value for the ` key (192).
-		Keyboard
  BACKSLASH : uint = 220
[static] - - Constant associated with the key code value for the \ key (220).
-		Keyboard
  BACKSPACE : uint = 8
[static] - - Constant associated with the key code value for the Backspace key (8).
-		Keyboard
  BLUE : uint = 0x01000003
[static] - - Constant associated with the key code value for the blue function key button.
-		Keyboard
  C : uint = 67
[static] - - Constant associated with the key code value for the C key (67).
-		Keyboard
  CAPS_LOCK : uint = 20
[static] - - Constant associated with the key code value for the Caps Lock key (20).
-		Keyboard
  CHANNEL_DOWN : uint = 0x01000005
[static] - - Constant associated with the key code value for the channel down button.
-		Keyboard
  CHANNEL_UP : uint = 0x01000004
[static] - - Constant associated with the key code value for the channel up button.
-		Keyboard
  CharCodeStrings : Array -
[static] - - An array containing all the defined key name constants.
-		Keyboard
  COMMA : uint = 188
[static] - - Constant associated with the key code value for the , key (188).
-		Keyboard
  COMMAND : uint = 15
[static] - - Constant associated with the Mac command key (15).
-		Keyboard
  CONTROL : uint = 17
[static] - - Constant associated with the key code value for the Control key (17).
-		Keyboard
  D : uint = 68
[static] - - Constant associated with the key code value for the D key (68).
-		Keyboard
  DELETE : uint = 46
[static] - - Constant associated with the key code value for the Delete key (46).
-		Keyboard
  DOWN : uint = 40
[static] - - Constant associated with the key code value for the Down Arrow key (40).
-		Keyboard
  DVR : uint = 0x01000019
[static] - - Constant associated with the key code value for the button for engaging DVR application mode.
-		Keyboard
  E : uint = 69
[static] - - Constant associated with the key code value for the E key (69).
-		Keyboard
  END : uint = 35
[static] - - Constant associated with the key code value for the End key (35).
-		Keyboard
  ENTER : uint = 13
[static] - - Constant associated with the key code value for the Enter key (13).
-		Keyboard
  EQUAL : uint = 187
[static] - - Constant associated with the key code value for the = key (187).
-		Keyboard
  ESCAPE : uint = 27
[static] - - Constant associated with the key code value for the Escape key (27).
-		Keyboard
  EXIT : uint = 0x01000015
[static] - - Constant associated with the key code value for the button for exiting the current application mode.
-		Keyboard
  F : uint = 70
[static] - - Constant associated with the key code value for the F key (70).
-		Keyboard
  F1 : uint = 112
[static] - - Constant associated with the key code value for the F1 key (112).
-		Keyboard
  F10 : uint = 121
[static] - - Constant associated with the key code value for the F10 key (121).
-		Keyboard
  F11 : uint = 122
[static] - - Constant associated with the key code value for the F11 key (122).
-		Keyboard
  F12 : uint = 123
[static] - - Constant associated with the key code value for the F12 key (123).
-		Keyboard
  F13 : uint = 124
[static] - - Constant associated with the key code value for the F13 key (124).
-		Keyboard
  F14 : uint = 125
[static] - - Constant associated with the key code value for the F14 key (125).
-		Keyboard
  F15 : uint = 126
[static] - - Constant associated with the key code value for the F15 key (126).
-		Keyboard
  F2 : uint = 113
[static] - - Constant associated with the key code value for the F2 key (113).
-		Keyboard
  F24 : uint = 135
[static] - - Constant associated with the key code value for the F24 key (135).
-		Keyboard
  F3 : uint = 114
[static] - - Constant associated with the key code value for the F3 key (114).
-		Keyboard
  F4 : uint = 115
[static] - - Constant associated with the key code value for the F4 key (115).
-		Keyboard
  F5 : uint = 116
[static] - - Constant associated with the key code value for the F5 key (116).
-		Keyboard
  F6 : uint = 117
[static] - - Constant associated with the key code value for the F6 key (117).
-		Keyboard
  F7 : uint = 118
[static] - - Constant associated with the key code value for the F7 key (118).
-		Keyboard
  F8 : uint = 119
[static] - - Constant associated with the key code value for the F8 key (119).
-		Keyboard
  F9 : uint = 120
[static] - - Constant associated with the key code value for the F9 key (120).
-		Keyboard
  FAST_FORWARD : uint = 0x0100000A
[static] - - Constant associated with the key code value for the button for engaging fast-forward transport mode.
-		Keyboard
  FUNCTION : uint = 14
[static] - - Constant associated with the Mac function key (14).
-		Keyboard
  G : uint = 71
[static] - - Constant associated with the key code value for the G key (71).
-		Keyboard
  GREEN : uint = 0x01000001
[static] - - Constant associated with the key code value for the green function key button.
-		Keyboard
  GUIDE : uint = 0x01000014
[static] - - Constant associated with the key code value for the button for engaging the program guide.
-		Keyboard
  H : uint = 72
[static] - - Constant associated with the key code value for the H key (72).
-		Keyboard
  HELP : uint = 0x0100001D
[static] - - Constant associated with the key code value for the button for engaging the help application or context-sensitive help.
-		Keyboard
  HOME : uint = 36
[static] - - Constant associated with the key code value for the Home key (36).
-		Keyboard
  I : uint = 73
[static] - - Constant associated with the key code value for the I key (73).
-		Keyboard
  INFO : uint = 0x01000013
[static] - - Constant associated with the key code value for the info button.
-		Keyboard
  INPUT : uint = 0x0100001B
[static] - - Constant associated with the key code value for the button for cycling inputs.
-		Keyboard
  INSERT : uint = 45
[static] - - Constant associated with the key code value for the Insert key (45).
-		Keyboard
  J : uint = 74
[static] - - Constant associated with the key code value for the J key (74).
-		Keyboard
  K : uint = 75
[static] - - Constant associated with the key code value for the K key (75).
-		Keyboard
  KEYNAME_BEGIN : String = "Begin"
[static] - - The Begin key - -
-		Keyboard
  KEYNAME_BREAK : String = "Break"
[static] - - The Break key - -
-		Keyboard
  KEYNAME_CLEARDISPLAY : String = "ClrDsp"
[static] - - The Clear Display key - -
-		Keyboard
  KEYNAME_CLEARLINE : String = "ClrLn"
[static] - - The Clear Line key - -
-		Keyboard
  KEYNAME_DELETE : String = "Delete"
[static] - - The Delete key - -
-		Keyboard
  KEYNAME_DELETECHAR : String = "DelChr"
[static] - - The Delete Character key - -
-		Keyboard
  KEYNAME_DELETELINE : String = "DelLn"
[static] - - The Delete Line key - -
-		Keyboard
  KEYNAME_DOWNARROW : String = "Down"
[static] - - The down arrow - - - -
-		Keyboard
  KEYNAME_END : String = "End"
[static] - - The End key - -
-		Keyboard
  KEYNAME_EXECUTE : String = "Exec"
[static] - - The Execute key - -
-		Keyboard
  KEYNAME_F1 : String = "F1"
[static] - - The F1 key - -
-		Keyboard
  KEYNAME_F10 : String = "F10"
[static] - - The F10 key - -
-		Keyboard
  KEYNAME_F11 : String = "F11"
[static] - - The F11 key - -
-		Keyboard
  KEYNAME_F12 : String = "F12"
[static] - - The F12 key - -
-		Keyboard
  KEYNAME_F13 : String = "F13"
[static] - - The F13 key - -
-		Keyboard
  KEYNAME_F14 : String = "F14"
[static] - - The F14 key - -
-		Keyboard
  KEYNAME_F15 : String = "F15"
[static] - - The F15 key - -
-		Keyboard
  KEYNAME_F16 : String = "F16"
[static] - - The F16 key - -
-		Keyboard
  KEYNAME_F17 : String = "F17"
[static] - - The F17 key - -
-		Keyboard
  KEYNAME_F18 : String = "F18"
[static] - - The F18 key - -
-		Keyboard
  KEYNAME_F19 : String = "F19"
[static] - - The F19 key - -
-		Keyboard
  KEYNAME_F2 : String = "F2"
[static] - - The F2 key - -
-		Keyboard
  KEYNAME_F20 : String = "F20"
[static] - - The F20 key - -
-		Keyboard
  KEYNAME_F21 : String = "F21"
[static] - - The F21 key - -
-		Keyboard
  KEYNAME_F22 : String = "F22"
[static] - - The F22 key - -
-		Keyboard
  KEYNAME_F23 : String = "F23"
[static] - - The F23 key - -
-		Keyboard
  KEYNAME_F24 : String = "F24"
[static] - - The F24 key - -
-		Keyboard
  KEYNAME_F25 : String = "F25"
[static] - - The F25 key - -
-		Keyboard
  KEYNAME_F26 : String = "F26"
[static] - - The F26 key - -
-		Keyboard
  KEYNAME_F27 : String = "F27"
[static] - - The F27 key - -
-		Keyboard
  KEYNAME_F28 : String = "F28"
[static] - - The F28 key - -
-		Keyboard
  KEYNAME_F29 : String = "F29"
[static] - - The F29 key - -
-		Keyboard
  KEYNAME_F3 : String = "F3"
[static] - - The F3 key - -
-		Keyboard
  KEYNAME_F30 : String = "F30"
[static] - - -
-		Keyboard
  KEYNAME_F31 : String = "F31"
[static] - - The F31 key - -
-		Keyboard
  KEYNAME_F32 : String = "F32"
[static] - - The F32 key - -
-		Keyboard
  KEYNAME_F33 : String = "F33"
[static] - - The F33 key - -
-		Keyboard
  KEYNAME_F34 : String = "F34"
[static] - - The F34 key - -
-		Keyboard
  KEYNAME_F35 : String = "F35"
[static] - - The F35 key - -
-		Keyboard
  KEYNAME_F4 : String = "F4"
[static] - - The F4 key - -
-		Keyboard
  KEYNAME_F5 : String = "F5"
[static] - - The F5 key - -
-		Keyboard
  KEYNAME_F6 : String = "F6"
[static] - - The F6 key - -
-		Keyboard
  KEYNAME_F7 : String = "F7"
[static] - - The F7 key - -
-		Keyboard
  KEYNAME_F8 : String = "F8"
[static] - - The F8 key - -
-		Keyboard
  KEYNAME_F9 : String = "F9"
[static] - - The F9 key - -
-		Keyboard
  KEYNAME_FIND : String = "Find"
[static] - - The Find key - -
-		Keyboard
  KEYNAME_HELP : String = "Help"
[static] - - The Help key - -
-		Keyboard
  KEYNAME_HOME : String = "Home"
[static] - - The Home key - -
-		Keyboard
  KEYNAME_INSERT : String = "Insert"
[static] - - The Insert key - -
-		Keyboard
  KEYNAME_INSERTCHAR : String = "InsChr"
[static] - - The Insert Character key - -
-		Keyboard
  KEYNAME_INSERTLINE : String = "InsLn"
[static] - - The Insert Line key - -
-		Keyboard
  KEYNAME_LEFTARROW : String = "Left"
[static] - - The left arrow - - - -
-		Keyboard
  KEYNAME_MENU : String = "Menu"
[static] - - The Menu key - -
-		Keyboard
  KEYNAME_MODESWITCH : String = "ModeSw"
[static] - - The Mode Switch key - -
-		Keyboard
  KEYNAME_NEXT : String = "Next"
[static] - - The Next key - -
-		Keyboard
  KEYNAME_PAGEDOWN : String = "PgDn"
[static] - - The Page Down key - -
-		Keyboard
  KEYNAME_PAGEUP : String = "PgUp"
[static] - - The Page Up key - -
-		Keyboard
  KEYNAME_PAUSE : String = "Pause"
[static] - - The Pause key - -
-		Keyboard
  KEYNAME_PLAYPAUSE : String = "PlayPause"
[static] - - The Play_Pause key - -
-		Keyboard
  KEYNAME_PREV : String = "Prev"
[static] - - The Previous key - -
-		Keyboard
  KEYNAME_PRINT : String = "Print"
[static] - - The Print key - -
-		Keyboard
  KEYNAME_PRINTSCREEN : String = "PrntScrn"
[static] - - The Print Screen - -
-		Keyboard
  KEYNAME_REDO : String = "Redo"
[static] - - The Redo key - -
-		Keyboard
  KEYNAME_RESET : String = "Reset"
[static] - - The Reset key - -
-		Keyboard
  KEYNAME_RIGHTARROW : String = "Right"
[static] - - The right arrow - - - -
-		Keyboard
  KEYNAME_SCROLLLOCK : String = "ScrlLck"
[static] - - The Scroll Lock key - -
-		Keyboard
  KEYNAME_SELECT : String = "Select"
[static] - - The Select key - -
-		Keyboard
  KEYNAME_STOP : String = "Stop"
[static] - - The Stop key - -
-		Keyboard
  KEYNAME_SYSREQ : String = "SysReq"
[static] - - The System Request key - -
-		Keyboard
  KEYNAME_SYSTEM : String = "Sys"
[static] - - The System key - -
-		Keyboard
  KEYNAME_UNDO : String = "Undo"
[static] - - The Undo key - -
-		Keyboard
  KEYNAME_UPARROW : String = "Up"
[static] - - The up arrow - -
-		Keyboard
  KEYNAME_USER : String = "User"
[static] - - The User key - -
-		Keyboard
  L : uint = 76
[static] - - Constant associated with the key code value for the L key (76).
-		Keyboard
  LAST : uint = 0x01000011
[static] - - Constant associated with the key code value for the button for watching the last channel or show watched.
-		Keyboard
  LEFT : uint = 37
[static] - - Constant associated with the key code value for the Left Arrow key (37).
-		Keyboard
  LEFTBRACKET : uint = 219
[static] - - Constant associated with the key code value for the [ key (219).
-		Keyboard
  LIVE : uint = 0x01000010
[static] - - Constant associated with the key code value for the button for returning to live [position in broadcast].
-		Keyboard
  M : uint = 77
[static] - - Constant associated with the key code value for the M key (77).
-		Keyboard
  MASTER_SHELL : uint = 0x0100001E
[static] - - Constant associated with the key code value for the button for engaging the "Master Shell" (e.g.
-		Keyboard
  MENU : uint = 0x01000012
[static] - - Constant associated with the key code value for the button for engaging the menu.
-		Keyboard
  MINUS : uint = 189
[static] - - Constant associated with the key code value for the - key (189).
-		Keyboard
  N : uint = 78
[static] - - Constant associated with the key code value for the N key (78).
-		Keyboard
  NEXT : uint = 0x0100000E
[static] - - Constant associated with the key code value for the button for skipping to next track or chapter.
-		Keyboard
  NUMBER_0 : uint = 48
[static] - - Constant associated with the key code value for the 0 key (48).
-		Keyboard
  NUMBER_1 : uint = 49
[static] - - Constant associated with the key code value for the 1 key (49).
-		Keyboard
  NUMBER_2 : uint = 50
[static] - - Constant associated with the key code value for the 2 key (50).
-		Keyboard
  NUMBER_3 : uint = 51
[static] - - Constant associated with the key code value for the 3 key (51).
-		Keyboard
  NUMBER_4 : uint = 52
[static] - - Constant associated with the key code value for the 4 key (52).
-		Keyboard
  NUMBER_5 : uint = 53
[static] - - Constant associated with the key code value for the 5 key (53).
-		Keyboard
  NUMBER_6 : uint = 54
[static] - - Constant associated with the key code value for the 6 key (54).
-		Keyboard
  NUMBER_7 : uint = 55
[static] - - Constant associated with the key code value for the 7 key (55).
-		Keyboard
  NUMBER_8 : uint = 56
[static] - - Constant associated with the key code value for the 8 key (56).
-		Keyboard
  NUMBER_9 : uint = 57
[static] - - Constant associated with the key code value for the 9 key (57).
-		Keyboard
  NUMPAD : uint = 21
[static] - - Constant associated with the pseudo-key code for the the number pad (21).
-		Keyboard
  NUMPAD_0 : uint = 96
[static] - - Constant associated with the key code value for the number 0 key on the number pad (96).
-		Keyboard
  NUMPAD_1 : uint = 97
[static] - - Constant associated with the key code value for the number 1 key on the number pad (97).
-		Keyboard
  NUMPAD_2 : uint = 98
[static] - - Constant associated with the key code value for the number 2 key on the number pad (98).
-		Keyboard
  NUMPAD_3 : uint = 99
[static] - - Constant associated with the key code value for the number 3 key on the number pad (99).
-		Keyboard
  NUMPAD_4 : uint = 100
[static] - - Constant associated with the key code value for the number 4 key on the number pad (100).
-		Keyboard
  NUMPAD_5 : uint = 101
[static] - - Constant associated with the key code value for the number 5 key on the number pad (101).
-		Keyboard
  NUMPAD_6 : uint = 102
[static] - - Constant associated with the key code value for the number 6 key on the number pad (102).
-		Keyboard
  NUMPAD_7 : uint = 103
[static] - - Constant associated with the key code value for the number 7 key on the number pad (103).
-		Keyboard
  NUMPAD_8 : uint = 104
[static] - - Constant associated with the key code value for the number 8 key on the number pad (104).
-		Keyboard
  NUMPAD_9 : uint = 105
[static] - - Constant associated with the key code value for the number 9 key on the number pad (105).
-		Keyboard
  NUMPAD_ADD : uint = 107
[static] - - Constant associated with the key code value for the addition key on the number pad (107).
-		Keyboard
  NUMPAD_DECIMAL : uint = 110
[static] - - Constant associated with the key code value for the decimal key on the number pad (110).
-		Keyboard
  NUMPAD_DIVIDE : uint = 111
[static] - - Constant associated with the key code value for the division key on the number pad (111).
-		Keyboard
  NUMPAD_ENTER : uint = 108
[static] - - Constant associated with the key code value for the Enter key on the number pad (108).
-		Keyboard
  NUMPAD_MULTIPLY : uint = 106
[static] - - Constant associated with the key code value for the multiplication key on the number pad (106).
-		Keyboard
  NUMPAD_SUBTRACT : uint = 109
[static] - - Constant associated with the key code value for the subtraction key on the number pad (109).
-		Keyboard
  O : uint = 79
[static] - - Constant associated with the key code value for the O key (79).
-		Keyboard
  P : uint = 80
[static] - - Constant associated with the key code value for the P key (80).
-		Keyboard
  PAGE_DOWN : uint = 34
[static] - - Constant associated with the key code value for the Page Down key (34).
-		Keyboard
  PAGE_UP : uint = 33
[static] - - Constant associated with the key code value for the Page Up key (33).
-		Keyboard
  PAUSE : uint = 0x01000008
[static] - - Constant associated with the key code value for the button for pausing transport mode.
-		Keyboard
  PERIOD : uint = 190
[static] - - Constant associated with the key code value for the .
-		Keyboard
  PLAY : uint = 0x01000007
[static] - - Constant associated with the key code value for the button for engaging play transport mode.
-		Keyboard
  PLAY_PAUSE : uint = 0x01000020
[static] - - Constant associated with the key code value for the button for engaging play/pause transport mode.
-		Keyboard
  PREVIOUS : uint = 0x0100000F
[static] - - Constant associated with the key code value for the button for skipping to previous track or chapter.
-		Keyboard
  Q : uint = 81
[static] - - Constant associated with the key code value for the Q key (81).
-		Keyboard
  QUOTE : uint = 222
[static] - - Constant associated with the key code value for the ' key (222).
-		Keyboard
  R : uint = 82
[static] - - Constant associated with the key code value for the R key (82).
-		Keyboard
  RECORD : uint = 0x01000006
[static] - - Constant associated with the key code value for the button for recording or engaging record transport mode.
-		Keyboard
  RED : uint = 0x01000000
[static] - - Red function key button.
-		Keyboard
  REWIND : uint = 0x0100000B
[static] - - Constant associated with the key code value for the button for engaging rewind transport mode.
-		Keyboard
  RIGHT : uint = 39
[static] - - Constant associated with the key code value for the Right Arrow key (39).
-		Keyboard
  RIGHTBRACKET : uint = 221
[static] - - Constant associated with the key code value for the ] key (221).
-		Keyboard
  S : uint = 83
[static] - - Constant associated with the key code value for the S key (83).
-		Keyboard
  SEARCH : uint = 0x0100001F
[static] - - Constant associated with the key code value for the button for the search button.
-		Keyboard
  SEMICOLON : uint = 186
[static] - - Constant associated with the key code value for the ; key (186).
-		Keyboard
  SETUP : uint = 0x0100001C
[static] - - Constant associated with the key code value for the button for engaging the setup application or menu.
-		Keyboard
  SHIFT : uint = 16
[static] - - Constant associated with the key code value for the Shift key (16).
-		Keyboard
  SKIP_BACKWARD : uint = 0x0100000D
[static] - - Constant associated with the key code value for the button for engaging quick skip backward (usually 7-10 seconds).
-		Keyboard
  SKIP_FORWARD : uint = 0x0100000C
[static] - - Constant associated with the key code value for the button for engaging quick skip ahead (usually 30 seconds).
-		Keyboard
  SLASH : uint = 191
[static] - - Constant associated with the key code value for the / key (191).
-		Keyboard
  SPACE : uint = 32
[static] - - Constant associated with the key code value for the Spacebar (32).
-		Keyboard
  STOP : uint = 0x01000009
[static] - - Constant associated with the key code value for the button for stopping transport mode.
-		Keyboard
  STRING_BEGIN : String = "?"
[static] - - The OS X Unicode Begin constant - -
-		Keyboard
  STRING_BREAK : String = "?"
[static] - - The OS X Unicode Break constant - -
-		Keyboard
  STRING_CLEARDISPLAY : String = "?"
[static] - - The OS X Unicode Clear Display constant - -
-		Keyboard
  STRING_CLEARLINE : String = "?"
[static] - - The OS X Unicode Clear Line constant - -
-		Keyboard
  STRING_DELETE : String = "?"
[static] - - The OS X Unicode Delete constant - -
-		Keyboard
  STRING_DELETECHAR : String = "?"
[static] - - The OS X Unicode Delete Character constant - -
-		Keyboard
  STRING_DELETELINE : String = "?"
[static] - - The OS X Unicode Delete Line constant - -
-		Keyboard
  STRING_DOWNARROW : String = "?"
[static] - - The OS X Unicode down arrow constant - -
-		Keyboard
  STRING_END : String = "?"
[static] - - The OS X Unicode End constant - -
-		Keyboard
  STRING_EXECUTE : String = "?"
[static] - - The OS X Unicode Execute constant - -
-		Keyboard
  STRING_F1 : String = "?"
[static] - - The OS X Unicode F1 constant - -
-		Keyboard
  STRING_F10 : String = "?"
[static] - - The OS X Unicode F10 constant - -
-		Keyboard
  STRING_F11 : String = "?"
[static] - - The OS X Unicode F11 constant - -
-		Keyboard
  STRING_F12 : String = "?"
[static] - - The OS X Unicode F12 constant - -
-		Keyboard
  STRING_F13 : String = "?"
[static] - - The OS X Unicode F13 constant - -
-		Keyboard
  STRING_F14 : String = "?"
[static] - - The OS X Unicode F14 constant - -
-		Keyboard
  STRING_F15 : String = "?"
[static] - - The OS X Unicode F15 constant - -
-		Keyboard
  STRING_F16 : String = "?"
[static] - - The OS X Unicode F16 constant - -
-		Keyboard
  STRING_F17 : String = "?"
[static] - - The OS X Unicode F17 constant - -
-		Keyboard
  STRING_F18 : String = "?"
[static] - - The OS X Unicode F18 constant - -
-		Keyboard
  STRING_F19 : String = "?"
[static] - - The OS X Unicode F19 constant - -
-		Keyboard
  STRING_F2 : String = "?"
[static] - - The OS X Unicode F2 constant - -
-		Keyboard
  STRING_F20 : String = "?"
[static] - - The OS X Unicode F20 constant - -
-		Keyboard
  STRING_F21 : String = "?"
[static] - - The OS X Unicode F21 constant - -
-		Keyboard
  STRING_F22 : String = "?"
[static] - - The OS X Unicode F22 constant - -
-		Keyboard
  STRING_F23 : String = "?"
[static] - - The OS X Unicode F23 constant - -
-		Keyboard
  STRING_F24 : String = "?"
[static] - - The OS X Unicode F24 constant - -
-		Keyboard
  STRING_F25 : String = "?"
[static] - - The OS X Unicode F25 constant - -
-		Keyboard
  STRING_F26 : String = "?"
[static] - - The OS X Unicode F26 constant - -
-		Keyboard
  STRING_F27 : String = "?"
[static] - - The OS X Unicode F27 constant - -
-		Keyboard
  STRING_F28 : String = "?"
[static] - - The OS X Unicode F28 constant - -
-		Keyboard
  STRING_F29 : String = "?"
[static] - - The OS X Unicode F29 constant - -
-		Keyboard
  STRING_F3 : String = "?"
[static] - - The OS X Unicode F3 constant - -
-		Keyboard
  STRING_F30 : String = "?"
[static] - - The OS X Unicode F30 constant - -
-		Keyboard
  STRING_F31 : String = "?"
[static] - - The OS X Unicode F31 constant - -
-		Keyboard
  STRING_F32 : String = "?"
[static] - - The OS X Unicode F32 constant - -
-		Keyboard
  STRING_F33 : String = "?"
[static] - - The OS X Unicode F33 constant - -
-		Keyboard
  STRING_F34 : String = "?"
[static] - - The OS X Unicode F34 constant - -
-		Keyboard
  STRING_F35 : String = "?"
[static] - - The OS X Unicode F35 constant - -
-		Keyboard
  STRING_F4 : String = "?"
[static] - - The OS X Unicode F4 constant - -
-		Keyboard
  STRING_F5 : String = "?"
[static] - - The OS X Unicode F5 constant - -
-		Keyboard
  STRING_F6 : String = "?"
[static] - - The OS X Unicode F6 constant - -
-		Keyboard
  STRING_F7 : String = "?"
[static] - - The OS X Unicode F7 constant - -
-		Keyboard
  STRING_F8 : String = "?"
[static] - - The OS X Unicode F8 constant - -
-		Keyboard
  STRING_F9 : String = "?"
[static] - - The OS X Unicode F9 constant - -
-		Keyboard
  STRING_FIND : String = "?"
[static] - - The OS X Unicode Find constant - -
-		Keyboard
  STRING_HELP : String = "?"
[static] - - The OS X Unicode Help constant - -
-		Keyboard
  STRING_HOME : String = "?"
[static] - - The OS X Unicode Home constant - -
-		Keyboard
  STRING_INSERT : String = "?"
[static] - - The OS X Unicode Insert constant - -
-		Keyboard
  STRING_INSERTCHAR : String = "?"
[static] - - The OS X Unicode Insert Character constant - -
-		Keyboard
  STRING_INSERTLINE : String = "?"
[static] - - The OS X Unicode Insert Line constant - -
-		Keyboard
  STRING_LEFTARROW : String = "?"
[static] - - The OS X Unicode left arrow constant - -
-		Keyboard
  STRING_MENU : String = "?"
[static] - - The OS X Unicode Menu constant - -
-		Keyboard
  STRING_MODESWITCH : String = "?"
[static] - - The OS X Unicode Mode Switch constant - -
-		Keyboard
  STRING_NEXT : String = "?"
[static] - - The OS X Unicode Next constant - -
-		Keyboard
  STRING_PAGEDOWN : String = "?"
[static] - - The OS X Unicode Page Down constant - -
-		Keyboard
  STRING_PAGEUP : String = "?"
[static] - - The OS X Unicode Page Up constant - -
-		Keyboard
  STRING_PAUSE : String = "?"
[static] - - The OS X Unicode Pause constant - -
-		Keyboard
  STRING_PREV : String = "?"
[static] - - The OS X Unicode Previous constant - -
-		Keyboard
  STRING_PRINT : String = "?"
[static] - - The OS X Unicode Print constant - -
-		Keyboard
  STRING_PRINTSCREEN : String = "?"
[static] - - The OS X Unicode Print Screen constant - -
-		Keyboard
  STRING_REDO : String = "?"
[static] - - The OS X Unicode Redo constant - -
-		Keyboard
  STRING_RESET : String = "?"
[static] - - The OS X Unicode Reset constant - -
-		Keyboard
  STRING_RIGHTARROW : String = "?"
[static] - - The OS X Unicode right arrow constant - -
-		Keyboard
  STRING_SCROLLLOCK : String = "?"
[static] - - The OS X Unicode Scroll Lock constant - -
-		Keyboard
  STRING_SELECT : String = "?"
[static] - - The OS X Unicode Select constant - -
-		Keyboard
  STRING_STOP : String = "?"
[static] - - The OS X Unicode Stop constant - -
-		Keyboard
  STRING_SYSREQ : String = "?"
[static] - - The OS X Unicode System Request constant - -
-		Keyboard
  STRING_SYSTEM : String = "?"
[static] - - The OS X Unicode System constant - -
-		Keyboard
  STRING_UNDO : String = "?"
[static] - - The OS X Unicode Undo constant - -
-		Keyboard
  STRING_UPARROW : String = "?"
[static] - - The OS X Unicode up arrow constant - -
-		Keyboard
  STRING_USER : String = "?"
[static] - - The OS X Unicode User constant - -
-		Keyboard
  SUBTITLE : uint = 0x01000018
[static] - - Constant associated with the key code value for the button for toggling subtitles.
-		Keyboard
  T : uint = 84
[static] - - Constant associated with the key code value for the T key (84).
-		Keyboard
  TAB : uint = 9
[static] - - Constant associated with the key code value for the Tab key (9).
-		Keyboard
  U : uint = 85
[static] - - Constant associated with the key code value for the U key (85).
-		Keyboard
  UP : uint = 38
[static] - - Constant associated with the key code value for the Up Arrow key (38).
-		Keyboard
  V : uint = 86
[static] - - Constant associated with the key code value for the V key (86).
-		Keyboard
  VOD : uint = 0x0100001A
[static] - - Constant associated with the key code value for the button for engaging video-on-demand.
-		Keyboard
  W : uint = 87
[static] - - Constant associated with the key code value for the W key (87).
-		Keyboard
  X : uint = 88
[static] - - Constant associated with the key code value for the X key (88).
-		Keyboard
  Y : uint = 89
[static] - - Constant associated with the key code value for the Y key (89).
-		Keyboard
  YELLOW : uint = 0x01000002
[static] - - Constant associated with the key code value for the yellow function key button.
-		Keyboard
  Z : uint = 90
[static] - - Constant associated with the key code value for the Z key (90).
-		Keyboard
-
- -
- -
Property detail
- - - - - -
capsLockproperty
-
-capsLock:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Specifies whether the Caps Lock key is activated (true) or not (false). - -

Implementation -
-    public static function get capsLock():Boolean -
-
- - - - - -
hasVirtualKeyboardproperty 
-
-hasVirtualKeyboard:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 2 - -
-

- - Indicates whether the computer or device provides a virtual keyboard. - - If the current environment provides a virtual keyboard, this value is true. - - - -

Implementation -
-    public static function get hasVirtualKeyboard():Boolean -
-
-Example -
The following example is a simple test that indicates the current state of the "Num Lock" and "Caps Lock" keys - as well as the type of keyboard and touch screen type in the running environment. When testing this example, click the - text field to see the property values: -
-
-import flash.events.~~;
-import flash.display.~~;
-import flash.ui.Keyboard;
-import flash.system.Capabilities;
-import flash.text.TextField;
-
-
-var keyboardInfoTxt:TextField = new TextField();
-keyboardInfoTxt.x = 30;
-keyboardInfoTxt.y = 50;
-keyboardInfoTxt.width = 300;
-keyboardInfoTxt.height = 100;
-keyboardInfoTxt.border = true;
-
-addChild(keyboardInfoTxt);
-
-addEventListener (MouseEvent.CLICK, getScreenKeyboardType);
-
-function getScreenKeyboardType(e:MouseEvent):void{
-    keyboardInfoTxt.text= "Caps Lock is : " + String(flash.ui.Keyboard.capsLock)+ "\n" + 
-	"Num Lock is : " + String(flash.ui.Keyboard.numLock) +"\n" + 
-	"Has Virtual Keyboard : " + String(flash.ui.Keyboard.hasVirtualKeyboard) + "\n" + 
-	"Physical Keyboard Type : " + flash.ui.Keyboard.physicalKeyboardType + "\n" + 
-	"flash.system.Capabilities.touchscreenType is : " + flash.system.Capabilities.touchscreenType;
-}
-
-

-
- - - - - -
numLockproperty 
-
-numLock:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Specifies whether the Num Lock key is activated (true) or not (false). - -

Implementation -
-    public static function get numLock():Boolean -
-
- - - - - -
physicalKeyboardTypeproperty 
-
-physicalKeyboardType:String  [read-only]

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 2 - -
-

- - Indicates the type of physical keyboard provided by the computer or device, if any. - - - -

Use the constants defined in the KeyboardType class to test the values reported by this property.

- - - -

Note: If a computer or device has both an alphanumeric keyboard and a 12-button keypad, this - - property only reports the presence of the alphanumeric keyboard.

- - - - Implementation -
-    public static function get physicalKeyboardType():String -
-

-See also -

-
-KeyboardType class -
-
- -
Method detail
- - - - - -
isAccessible()method
-
-public static function isAccessible():Boolean -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Specifies whether the last key pressed is accessible by other SWF files. - - By default, security restrictions prevent code from a SWF file in one domain - - from accessing a keystroke generated from a SWF file in another domain. - - -

-Returns - - - - -
Boolean — - The value true if the last key pressed can be accessed. - - If access is not permitted, this method returns false. - - - -
-
- -
Constant detail
- - - - - -
Aconstant
-
-public static const A:uint = 65 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the A key (65). - - -

- - - - - -
ALTERNATEconstant 
-
-public static const ALTERNATE:uint = 18 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Alternate (Option) key (18). - - -

- - - - - -
AUDIOconstant 
-
-public static const AUDIO:uint = 0x01000017 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for selecting the audio mode. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
Bconstant 
-
-public static const B:uint = 66 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the B key (66). - - -

- - - - - -
BACKconstant 
-
-public static const BACK:uint = 0x01000016 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for returning to the previous page in the application. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
BACKQUOTEconstant 
-
-public static const BACKQUOTE:uint = 192 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the ` key (192). - - -

- - - - - -
BACKSLASHconstant 
-
-public static const BACKSLASH:uint = 220 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the \ key (220). - - -

- - - - - -
BACKSPACEconstant 
-
-public static const BACKSPACE:uint = 8 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0
-

- - Constant associated with the key code value for the Backspace key (8). - - -

- - - - - -
BLUEconstant 
-
-public static const BLUE:uint = 0x01000003 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the blue function key button. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
Cconstant 
-
-public static const C:uint = 67 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the C key (67). - - -

- - - - - -
CAPS_LOCKconstant 
-
-public static const CAPS_LOCK:uint = 20 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Caps Lock key (20). - - -

- - - - - -
CHANNEL_DOWNconstant 
-
-public static const CHANNEL_DOWN:uint = 0x01000005 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the channel down button. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
CHANNEL_UPconstant 
-
-public static const CHANNEL_UP:uint = 0x01000004 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the channel up button. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
CharCodeStringsconstant 
-
-public static const CharCodeStrings:Array -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - An array containing all the defined key name constants. - - - -

- - - - - -
COMMAconstant 
-
-public static const COMMA:uint = 188 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the , key (188). - - -

- - - - - -
COMMANDconstant 
-
-public static const COMMAND:uint = 15 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the Mac command key (15). This constant is currently only used for setting menu key equivalents. - - -

- - - - - -
CONTROLconstant 
-
-public static const CONTROL:uint = 17 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Control key (17). - - -

- - - - - -
Dconstant 
-
-public static const D:uint = 68 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the D key (68). - - -

- - - - - -
DELETEconstant 
-
-public static const DELETE:uint = 46 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Delete key (46). - - -

- - - - - -
DOWNconstant 
-
-public static const DOWN:uint = 40 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Down Arrow key (40). - - - -

- - - - - -
DVRconstant 
-
-public static const DVR:uint = 0x01000019 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging DVR application mode. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
Econstant 
-
-public static const E:uint = 69 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the E key (69). - - -

- - - - - -
ENDconstant 
-
-public static const END:uint = 35 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the End key (35). - - -

- - - - - -
ENTERconstant 
-
-public static const ENTER:uint = 13 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Enter key (13). - - -

- - - - - -
EQUALconstant 
-
-public static const EQUAL:uint = 187 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the = key (187). - - -

- - - - - -
ESCAPEconstant 
-
-public static const ESCAPE:uint = 27 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Escape key (27). - - -

- - - - - -
EXITconstant 
-
-public static const EXIT:uint = 0x01000015 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for exiting the current application mode. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
Fconstant 
-
-public static const F:uint = 70 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F key (70). - - -

- - - - - -
F1constant 
-
-public static const F1:uint = 112 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F1 key (112). - - -

- - - - - -
F10constant 
-
-public static const F10:uint = 121 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F10 key (121). - - -

- - - - - -
F11constant 
-
-public static const F11:uint = 122 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F11 key (122). - - -

- - - - - -
F12constant 
-
-public static const F12:uint = 123 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F12 key (123). - - -

- - - - - -
F13constant 
-
-public static const F13:uint = 124 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F13 key (124). - - -

- - - - - -
F14constant 
-
-public static const F14:uint = 125 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F14 key (125). - - -

- - - - - -
F15constant 
-
-public static const F15:uint = 126 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F15 key (126). - - -

- - - - - -
F2constant 
-
-public static const F2:uint = 113 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F2 key (113). - - -

- - - - - -
F24constant 
-
-public static const F24:uint = 135 -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 33.1 - -
-

- - Constant associated with the key code value for the F24 key (135). - - -

- - - - - -
F3constant 
-
-public static const F3:uint = 114 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F3 key (114). - - -

- - - - - -
F4constant 
-
-public static const F4:uint = 115 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F4 key (115). - - -

- - - - - -
F5constant 
-
-public static const F5:uint = 116 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F5 key (116). - - -

- - - - - -
F6constant 
-
-public static const F6:uint = 117 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F6 key (117). - - -

- - - - - -
F7constant 
-
-public static const F7:uint = 118 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F7 key (118). - - -

- - - - - -
F8constant 
-
-public static const F8:uint = 119 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F8 key (119). - - -

- - - - - -
F9constant 
-
-public static const F9:uint = 120 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the F9 key (120). - - -

- - - - - -
FAST_FORWARDconstant 
-
-public static const FAST_FORWARD:uint = 0x0100000A -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging fast-forward transport mode. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
FUNCTIONconstant 
-
-public static const FUNCTION:uint = 14 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50.0 - -
-

- - Constant associated with the Mac function key (14). This constant is currently only used for setting menu key equivalents. - - -

- - - - - -
Gconstant 
-
-public static const G:uint = 71 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the G key (71). - - -

- - - - - -
GREENconstant 
-
-public static const GREEN:uint = 0x01000001 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the green function key button. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
GUIDEconstant 
-
-public static const GUIDE:uint = 0x01000014 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging the program guide. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
Hconstant 
-
-public static const H:uint = 72 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the H key (72). - - -

- - - - - -
HELPconstant 
-
-public static const HELP:uint = 0x0100001D -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging the help application or context-sensitive help. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
HOMEconstant 
-
-public static const HOME:uint = 36 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Home key (36). - - -

- - - - - -
Iconstant 
-
-public static const I:uint = 73 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the I key (73). - - -

- - - - - -
INFOconstant 
-
-public static const INFO:uint = 0x01000013 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the info button. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
INPUTconstant 
-
-public static const INPUT:uint = 0x0100001B -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for cycling inputs. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
INSERTconstant 
-
-public static const INSERT:uint = 45 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Insert key (45). - - -

- - - - - -
Jconstant 
-
-public static const J:uint = 74 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the J key (74). - - -

- - - - - -
Kconstant 
-
-public static const K:uint = 75 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the K key (75). - - -

- - - - - -
KEYNAME_BEGINconstant 
-
-public static const KEYNAME_BEGIN:String = "Begin" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Begin key - -

- - - - - -
KEYNAME_BREAKconstant 
-
-public static const KEYNAME_BREAK:String = "Break" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Break key - -

- - - - - -
KEYNAME_CLEARDISPLAYconstant 
-
-public static const KEYNAME_CLEARDISPLAY:String = "ClrDsp" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Clear Display key - -

- - - - - -
KEYNAME_CLEARLINEconstant 
-
-public static const KEYNAME_CLEARLINE:String = "ClrLn" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Clear Line key - -

- - - - - -
KEYNAME_DELETEconstant 
-
-public static const KEYNAME_DELETE:String = "Delete" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Delete key - -

- - - - - -
KEYNAME_DELETECHARconstant 
-
-public static const KEYNAME_DELETECHAR:String = "DelChr" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Delete Character key - -

- - - - - -
KEYNAME_DELETELINEconstant 
-
-public static const KEYNAME_DELETELINE:String = "DelLn" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Delete Line key - -

- - - - - -
KEYNAME_DOWNARROWconstant 
-
-public static const KEYNAME_DOWNARROW:String = "Down" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The down arrow - - - -

- - - - - -
KEYNAME_ENDconstant 
-
-public static const KEYNAME_END:String = "End" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The End key - -

- - - - - -
KEYNAME_EXECUTEconstant 
-
-public static const KEYNAME_EXECUTE:String = "Exec" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Execute key - -

- - - - - -
KEYNAME_F1constant 
-
-public static const KEYNAME_F1:String = "F1" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F1 key - -

- - - - - -
KEYNAME_F10constant 
-
-public static const KEYNAME_F10:String = "F10" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F10 key - -

- - - - - -
KEYNAME_F11constant 
-
-public static const KEYNAME_F11:String = "F11" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F11 key - -

- - - - - -
KEYNAME_F12constant 
-
-public static const KEYNAME_F12:String = "F12" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F12 key - -

- - - - - -
KEYNAME_F13constant 
-
-public static const KEYNAME_F13:String = "F13" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F13 key - -

- - - - - -
KEYNAME_F14constant 
-
-public static const KEYNAME_F14:String = "F14" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F14 key - -

- - - - - -
KEYNAME_F15constant 
-
-public static const KEYNAME_F15:String = "F15" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F15 key - -

- - - - - -
KEYNAME_F16constant 
-
-public static const KEYNAME_F16:String = "F16" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F16 key - -

- - - - - -
KEYNAME_F17constant 
-
-public static const KEYNAME_F17:String = "F17" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F17 key - -

- - - - - -
KEYNAME_F18constant 
-
-public static const KEYNAME_F18:String = "F18" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F18 key - -

- - - - - -
KEYNAME_F19constant 
-
-public static const KEYNAME_F19:String = "F19" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F19 key - -

- - - - - -
KEYNAME_F2constant 
-
-public static const KEYNAME_F2:String = "F2" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F2 key - -

- - - - - -
KEYNAME_F20constant 
-
-public static const KEYNAME_F20:String = "F20" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F20 key - -

- - - - - -
KEYNAME_F21constant 
-
-public static const KEYNAME_F21:String = "F21" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F21 key - -

- - - - - -
KEYNAME_F22constant 
-
-public static const KEYNAME_F22:String = "F22" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F22 key - -

- - - - - -
KEYNAME_F23constant 
-
-public static const KEYNAME_F23:String = "F23" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F23 key - -

- - - - - -
KEYNAME_F24constant 
-
-public static const KEYNAME_F24:String = "F24" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F24 key - -

- - - - - -
KEYNAME_F25constant 
-
-public static const KEYNAME_F25:String = "F25" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F25 key - -

- - - - - -
KEYNAME_F26constant 
-
-public static const KEYNAME_F26:String = "F26" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F26 key - -

- - - - - -
KEYNAME_F27constant 
-
-public static const KEYNAME_F27:String = "F27" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F27 key - -

- - - - - -
KEYNAME_F28constant 
-
-public static const KEYNAME_F28:String = "F28" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F28 key - -

- - - - - -
KEYNAME_F29constant 
-
-public static const KEYNAME_F29:String = "F29" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F29 key - -

- - - - - -
KEYNAME_F3constant 
-
-public static const KEYNAME_F3:String = "F3" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F3 key - -

- - - - - -
KEYNAME_F30constant 
-
-public static const KEYNAME_F30:String = "F30" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - -

- - - - - -
KEYNAME_F31constant 
-
-public static const KEYNAME_F31:String = "F31" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F31 key - -

- - - - - -
KEYNAME_F32constant 
-
-public static const KEYNAME_F32:String = "F32" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F32 key - -

- - - - - -
KEYNAME_F33constant 
-
-public static const KEYNAME_F33:String = "F33" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F33 key - -

- - - - - -
KEYNAME_F34constant 
-
-public static const KEYNAME_F34:String = "F34" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F34 key - -

- - - - - -
KEYNAME_F35constant 
-
-public static const KEYNAME_F35:String = "F35" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F35 key - -

- - - - - -
KEYNAME_F4constant 
-
-public static const KEYNAME_F4:String = "F4" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F4 key - -

- - - - - -
KEYNAME_F5constant 
-
-public static const KEYNAME_F5:String = "F5" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F5 key - -

- - - - - -
KEYNAME_F6constant 
-
-public static const KEYNAME_F6:String = "F6" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F6 key - -

- - - - - -
KEYNAME_F7constant 
-
-public static const KEYNAME_F7:String = "F7" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F7 key - -

- - - - - -
KEYNAME_F8constant 
-
-public static const KEYNAME_F8:String = "F8" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F8 key - -

- - - - - -
KEYNAME_F9constant 
-
-public static const KEYNAME_F9:String = "F9" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The F9 key - -

- - - - - -
KEYNAME_FINDconstant 
-
-public static const KEYNAME_FIND:String = "Find" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Find key - -

- - - - - -
KEYNAME_HELPconstant 
-
-public static const KEYNAME_HELP:String = "Help" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Help key - -

- - - - - -
KEYNAME_HOMEconstant 
-
-public static const KEYNAME_HOME:String = "Home" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Home key - -

- - - - - -
KEYNAME_INSERTconstant 
-
-public static const KEYNAME_INSERT:String = "Insert" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Insert key - -

- - - - - -
KEYNAME_INSERTCHARconstant 
-
-public static const KEYNAME_INSERTCHAR:String = "InsChr" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Insert Character key - -

- - - - - -
KEYNAME_INSERTLINEconstant 
-
-public static const KEYNAME_INSERTLINE:String = "InsLn" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Insert Line key - -

- - - - - -
KEYNAME_LEFTARROWconstant 
-
-public static const KEYNAME_LEFTARROW:String = "Left" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The left arrow - - - -

- - - - - -
KEYNAME_MENUconstant 
-
-public static const KEYNAME_MENU:String = "Menu" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Menu key - -

- - - - - -
KEYNAME_MODESWITCHconstant 
-
-public static const KEYNAME_MODESWITCH:String = "ModeSw" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Mode Switch key - -

- - - - - -
KEYNAME_NEXTconstant 
-
-public static const KEYNAME_NEXT:String = "Next" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Next key - -

- - - - - -
KEYNAME_PAGEDOWNconstant 
-
-public static const KEYNAME_PAGEDOWN:String = "PgDn" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Page Down key - -

- - - - - -
KEYNAME_PAGEUPconstant 
-
-public static const KEYNAME_PAGEUP:String = "PgUp" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Page Up key - -

- - - - - -
KEYNAME_PAUSEconstant 
-
-public static const KEYNAME_PAUSE:String = "Pause" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Pause key - -

- - - - - -
KEYNAME_PLAYPAUSEconstant 
-
-public static const KEYNAME_PLAYPAUSE:String = "PlayPause" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24.0 - -
-

- - The Play_Pause key - -

- - - - - -
KEYNAME_PREVconstant 
-
-public static const KEYNAME_PREV:String = "Prev" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Previous key - -

- - - - - -
KEYNAME_PRINTconstant 
-
-public static const KEYNAME_PRINT:String = "Print" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Print key - -

- - - - - -
KEYNAME_PRINTSCREENconstant 
-
-public static const KEYNAME_PRINTSCREEN:String = "PrntScrn" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Print Screen - -

- - - - - -
KEYNAME_REDOconstant 
-
-public static const KEYNAME_REDO:String = "Redo" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Redo key - -

- - - - - -
KEYNAME_RESETconstant 
-
-public static const KEYNAME_RESET:String = "Reset" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Reset key - -

- - - - - -
KEYNAME_RIGHTARROWconstant 
-
-public static const KEYNAME_RIGHTARROW:String = "Right" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The right arrow - - - -

- - - - - -
KEYNAME_SCROLLLOCKconstant 
-
-public static const KEYNAME_SCROLLLOCK:String = "ScrlLck" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Scroll Lock key - -

- - - - - -
KEYNAME_SELECTconstant 
-
-public static const KEYNAME_SELECT:String = "Select" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Select key - -

- - - - - -
KEYNAME_STOPconstant 
-
-public static const KEYNAME_STOP:String = "Stop" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Stop key - -

- - - - - -
KEYNAME_SYSREQconstant 
-
-public static const KEYNAME_SYSREQ:String = "SysReq" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The System Request key - -

- - - - - -
KEYNAME_SYSTEMconstant 
-
-public static const KEYNAME_SYSTEM:String = "Sys" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The System key - -

- - - - - -
KEYNAME_UNDOconstant 
-
-public static const KEYNAME_UNDO:String = "Undo" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The Undo key - -

- - - - - -
KEYNAME_UPARROWconstant 
-
-public static const KEYNAME_UPARROW:String = "Up" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The up arrow - -

- - - - - -
KEYNAME_USERconstant 
-
-public static const KEYNAME_USER:String = "User" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The User key - -

- - - - - -
Lconstant 
-
-public static const L:uint = 76 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the L key (76). - - -

- - - - - -
LASTconstant 
-
-public static const LAST:uint = 0x01000011 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for watching the last channel or show watched. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
LEFTconstant 
-
-public static const LEFT:uint = 37 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Left Arrow key (37). - - -

- - - - - -
LEFTBRACKETconstant 
-
-public static const LEFTBRACKET:uint = 219 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the [ key (219). - - -

- - - - - -
LIVEconstant 
-
-public static const LIVE:uint = 0x01000010 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for returning to live [position in broadcast]. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
Mconstant 
-
-public static const M:uint = 77 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the M key (77). - - -

- - - - - -
MASTER_SHELLconstant 
-
-public static const MASTER_SHELL:uint = 0x0100001E -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging the "Master Shell" (e.g. TiVo or other vendor button). - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
MENUconstant 
-
-public static const MENU:uint = 0x01000012 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging the menu. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
MINUSconstant 
-
-public static const MINUS:uint = 189 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the - key (189). - - -

- - - - - -
Nconstant 
-
-public static const N:uint = 78 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the N key (78). - - -

- - - - - -
NEXTconstant 
-
-public static const NEXT:uint = 0x0100000E -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for skipping to next track or chapter. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
NUMBER_0constant 
-
-public static const NUMBER_0:uint = 48 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the 0 key (48). - - -

- - - - - -
NUMBER_1constant 
-
-public static const NUMBER_1:uint = 49 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the 1 key (49). - - -

- - - - - -
NUMBER_2constant 
-
-public static const NUMBER_2:uint = 50 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the 2 key (50). - - -

- - - - - -
NUMBER_3constant 
-
-public static const NUMBER_3:uint = 51 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the 3 key (51). - - -

- - - - - -
NUMBER_4constant 
-
-public static const NUMBER_4:uint = 52 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the 4 key (52). - - -

- - - - - -
NUMBER_5constant 
-
-public static const NUMBER_5:uint = 53 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the 5 key (53). - - -

- - - - - -
NUMBER_6constant 
-
-public static const NUMBER_6:uint = 54 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the 6 key (54). - - -

- - - - - -
NUMBER_7constant 
-
-public static const NUMBER_7:uint = 55 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the 7 key (55). - - -

- - - - - -
NUMBER_8constant 
-
-public static const NUMBER_8:uint = 56 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the 8 key (56). - - -

- - - - - -
NUMBER_9constant 
-
-public static const NUMBER_9:uint = 57 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the 9 key (57). - - -

- - - - - -
NUMPADconstant 
-
-public static const NUMPAD:uint = 21 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the pseudo-key code for the the number pad (21). Use to - - set numpad modifier on key equivalents - - -

- - - - - -
NUMPAD_0constant 
-
-public static const NUMPAD_0:uint = 96 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the number 0 key on the number pad (96). - - -

- - - - - -
NUMPAD_1constant 
-
-public static const NUMPAD_1:uint = 97 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the number 1 key on the number pad (97). - - -

- - - - - -
NUMPAD_2constant 
-
-public static const NUMPAD_2:uint = 98 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the number 2 key on the number pad (98). - - -

- - - - - -
NUMPAD_3constant 
-
-public static const NUMPAD_3:uint = 99 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the number 3 key on the number pad (99). - - -

- - - - - -
NUMPAD_4constant 
-
-public static const NUMPAD_4:uint = 100 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the number 4 key on the number pad (100). - - -

- - - - - -
NUMPAD_5constant 
-
-public static const NUMPAD_5:uint = 101 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the number 5 key on the number pad (101). - - -

- - - - - -
NUMPAD_6constant 
-
-public static const NUMPAD_6:uint = 102 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the number 6 key on the number pad (102). - - -

- - - - - -
NUMPAD_7constant 
-
-public static const NUMPAD_7:uint = 103 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the number 7 key on the number pad (103). - - -

- - - - - -
NUMPAD_8constant 
-
-public static const NUMPAD_8:uint = 104 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the number 8 key on the number pad (104). - - -

- - - - - -
NUMPAD_9constant 
-
-public static const NUMPAD_9:uint = 105 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the number 9 key on the number pad (105). - - -

- - - - - -
NUMPAD_ADDconstant 
-
-public static const NUMPAD_ADD:uint = 107 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the addition key on the number pad (107). - - -

- - - - - -
NUMPAD_DECIMALconstant 
-
-public static const NUMPAD_DECIMAL:uint = 110 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the decimal key on the number pad (110). - - -

- - - - - -
NUMPAD_DIVIDEconstant 
-
-public static const NUMPAD_DIVIDE:uint = 111 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the division key on the number pad (111). - - -

- - - - - -
NUMPAD_ENTERconstant 
-
-public static const NUMPAD_ENTER:uint = 108 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Enter key on the number pad (108). - - -

- - - - - -
NUMPAD_MULTIPLYconstant 
-
-public static const NUMPAD_MULTIPLY:uint = 106 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the multiplication key on the number pad (106). - - -

- - - - - -
NUMPAD_SUBTRACTconstant 
-
-public static const NUMPAD_SUBTRACT:uint = 109 -

- - - - -
Language version: ActionScript 3.0 - - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the subtraction key on the number pad (109). - - -

- - - - - -
Oconstant 
-
-public static const O:uint = 79 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the O key (79). - - -

- - - - - -
Pconstant 
-
-public static const P:uint = 80 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the P key (80). - - -

- - - - - -
PAGE_DOWNconstant 
-
-public static const PAGE_DOWN:uint = 34 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Page Down key (34). - - -

- - - - - -
PAGE_UPconstant 
-
-public static const PAGE_UP:uint = 33 -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Page Up key (33). - - -

- - - - - -
PAUSEconstant 
-
-public static const PAUSE:uint = 0x01000008 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for pausing transport mode. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
PERIODconstant 
-
-public static const PERIOD:uint = 190 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the . key (190). - - -

- - - - - -
PLAYconstant 
-
-public static const PLAY:uint = 0x01000007 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging play transport mode. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
PLAY_PAUSEconstant 
-
-public static const PLAY_PAUSE:uint = 0x01000020 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 24 - -
-

- - Constant associated with the key code value for the button for engaging play/pause transport mode. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - - -
- - - - - -
PREVIOUSconstant 
-
-public static const PREVIOUS:uint = 0x0100000F -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for skipping to previous track or chapter. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
Qconstant 
-
-public static const Q:uint = 81 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Q key (81). - - -

- - - - - -
QUOTEconstant 
-
-public static const QUOTE:uint = 222 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the ' key (222). - - -

- - - - - -
Rconstant 
-
-public static const R:uint = 82 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the R key (82). - - -

- - - - - -
RECORDconstant 
-
-public static const RECORD:uint = 0x01000006 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for recording or engaging record transport mode. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
REDconstant 
-
-public static const RED:uint = 0x01000000 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Red function key button. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
REWINDconstant 
-
-public static const REWIND:uint = 0x0100000B -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging rewind transport mode. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
RIGHTconstant 
-
-public static const RIGHT:uint = 39 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Right Arrow key (39). - - -

- - - - - -
RIGHTBRACKETconstant 
-
-public static const RIGHTBRACKET:uint = 221 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the ] key (221). - - -

- - - - - -
Sconstant 
-
-public static const S:uint = 83 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the S key (83). - - -

- - - - - -
SEARCHconstant 
-
-public static const SEARCH:uint = 0x0100001F -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for the search button. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
SEMICOLONconstant 
-
-public static const SEMICOLON:uint = 186 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the ; key (186). - - -

- - - - - -
SETUPconstant 
-
-public static const SETUP:uint = 0x0100001C -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging the setup application or menu. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
SHIFTconstant 
-
-public static const SHIFT:uint = 16 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Shift key (16). - - -

- - - - - -
SKIP_BACKWARDconstant 
-
-public static const SKIP_BACKWARD:uint = 0x0100000D -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging quick skip backward (usually 7-10 seconds). - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
SKIP_FORWARDconstant 
-
-public static const SKIP_FORWARD:uint = 0x0100000C -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging quick skip ahead (usually 30 seconds). - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
SLASHconstant 
-
-public static const SLASH:uint = 191 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the / key (191). - - -

- - - - - -
SPACEconstant 
-
-public static const SPACE:uint = 32 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Spacebar (32). - - -

- - - - - -
STOPconstant 
-
-public static const STOP:uint = 0x01000009 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for stopping transport mode. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
STRING_BEGINconstant 
-
-public static const STRING_BEGIN:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Begin constant - -

- - - - - -
STRING_BREAKconstant 
-
-public static const STRING_BREAK:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Break constant - -

- - - - - -
STRING_CLEARDISPLAYconstant 
-
-public static const STRING_CLEARDISPLAY:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Clear Display constant - -

- - - - - -
STRING_CLEARLINEconstant 
-
-public static const STRING_CLEARLINE:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Clear Line constant - -

- - - - - -
STRING_DELETEconstant 
-
-public static const STRING_DELETE:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Delete constant - -

- - - - - -
STRING_DELETECHARconstant 
-
-public static const STRING_DELETECHAR:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Delete Character constant - -

- - - - - -
STRING_DELETELINEconstant 
-
-public static const STRING_DELETELINE:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Delete Line constant - -

- - - - - -
STRING_DOWNARROWconstant 
-
-public static const STRING_DOWNARROW:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode down arrow constant - -

- - - - - -
STRING_ENDconstant 
-
-public static const STRING_END:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode End constant - -

- - - - - -
STRING_EXECUTEconstant 
-
-public static const STRING_EXECUTE:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Execute constant - -

- - - - - -
STRING_F1constant 
-
-public static const STRING_F1:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F1 constant - -

- - - - - -
STRING_F10constant 
-
-public static const STRING_F10:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F10 constant - -

- - - - - -
STRING_F11constant 
-
-public static const STRING_F11:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F11 constant - -

- - - - - -
STRING_F12constant 
-
-public static const STRING_F12:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F12 constant - -

- - - - - -
STRING_F13constant 
-
-public static const STRING_F13:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F13 constant - -

- - - - - -
STRING_F14constant 
-
-public static const STRING_F14:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F14 constant - -

- - - - - -
STRING_F15constant 
-
-public static const STRING_F15:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F15 constant - -

- - - - - -
STRING_F16constant 
-
-public static const STRING_F16:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F16 constant - -

- - - - - -
STRING_F17constant 
-
-public static const STRING_F17:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F17 constant - -

- - - - - -
STRING_F18constant 
-
-public static const STRING_F18:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F18 constant - -

- - - - - -
STRING_F19constant 
-
-public static const STRING_F19:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F19 constant - -

- - - - - -
STRING_F2constant 
-
-public static const STRING_F2:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F2 constant - -

- - - - - -
STRING_F20constant 
-
-public static const STRING_F20:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F20 constant - -

- - - - - -
STRING_F21constant 
-
-public static const STRING_F21:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F21 constant - -

- - - - - -
STRING_F22constant 
-
-public static const STRING_F22:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F22 constant - -

- - - - - -
STRING_F23constant 
-
-public static const STRING_F23:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F23 constant - -

- - - - - -
STRING_F24constant 
-
-public static const STRING_F24:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F24 constant - -

- - - - - -
STRING_F25constant 
-
-public static const STRING_F25:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F25 constant - -

- - - - - -
STRING_F26constant 
-
-public static const STRING_F26:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F26 constant - -

- - - - - -
STRING_F27constant 
-
-public static const STRING_F27:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F27 constant - -

- - - - - -
STRING_F28constant 
-
-public static const STRING_F28:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F28 constant - -

- - - - - -
STRING_F29constant 
-
-public static const STRING_F29:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F29 constant - -

- - - - - -
STRING_F3constant 
-
-public static const STRING_F3:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F3 constant - -

- - - - - -
STRING_F30constant 
-
-public static const STRING_F30:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F30 constant - -

- - - - - -
STRING_F31constant 
-
-public static const STRING_F31:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F31 constant - -

- - - - - -
STRING_F32constant 
-
-public static const STRING_F32:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F32 constant - -

- - - - - -
STRING_F33constant 
-
-public static const STRING_F33:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F33 constant - -

- - - - - -
STRING_F34constant 
-
-public static const STRING_F34:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F34 constant - -

- - - - - -
STRING_F35constant 
-
-public static const STRING_F35:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F35 constant - -

- - - - - -
STRING_F4constant 
-
-public static const STRING_F4:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F4 constant - -

- - - - - -
STRING_F5constant 
-
-public static const STRING_F5:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F5 constant - -

- - - - - -
STRING_F6constant 
-
-public static const STRING_F6:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F6 constant - -

- - - - - -
STRING_F7constant 
-
-public static const STRING_F7:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F7 constant - -

- - - - - -
STRING_F8constant 
-
-public static const STRING_F8:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F8 constant - -

- - - - - -
STRING_F9constant 
-
-public static const STRING_F9:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode F9 constant - -

- - - - - -
STRING_FINDconstant 
-
-public static const STRING_FIND:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Find constant - -

- - - - - -
STRING_HELPconstant 
-
-public static const STRING_HELP:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Help constant - -

- - - - - -
STRING_HOMEconstant 
-
-public static const STRING_HOME:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Home constant - -

- - - - - -
STRING_INSERTconstant 
-
-public static const STRING_INSERT:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Insert constant - -

- - - - - -
STRING_INSERTCHARconstant 
-
-public static const STRING_INSERTCHAR:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Insert Character constant - -

- - - - - -
STRING_INSERTLINEconstant 
-
-public static const STRING_INSERTLINE:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Insert Line constant - -

- - - - - -
STRING_LEFTARROWconstant 
-
-public static const STRING_LEFTARROW:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode left arrow constant - -

- - - - - -
STRING_MENUconstant 
-
-public static const STRING_MENU:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Menu constant - -

- - - - - -
STRING_MODESWITCHconstant 
-
-public static const STRING_MODESWITCH:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Mode Switch constant - -

- - - - - -
STRING_NEXTconstant 
-
-public static const STRING_NEXT:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Next constant - -

- - - - - -
STRING_PAGEDOWNconstant 
-
-public static const STRING_PAGEDOWN:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Page Down constant - -

- - - - - -
STRING_PAGEUPconstant 
-
-public static const STRING_PAGEUP:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Page Up constant - -

- - - - - -
STRING_PAUSEconstant 
-
-public static const STRING_PAUSE:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Pause constant - -

- - - - - -
STRING_PREVconstant 
-
-public static const STRING_PREV:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Previous constant - -

- - - - - -
STRING_PRINTconstant 
-
-public static const STRING_PRINT:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Print constant - -

- - - - - -
STRING_PRINTSCREENconstant 
-
-public static const STRING_PRINTSCREEN:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Print Screen constant - -

- - - - - -
STRING_REDOconstant 
-
-public static const STRING_REDO:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Redo constant - -

- - - - - -
STRING_RESETconstant 
-
-public static const STRING_RESET:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Reset constant - -

- - - - - -
STRING_RIGHTARROWconstant 
-
-public static const STRING_RIGHTARROW:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode right arrow constant - -

- - - - - -
STRING_SCROLLLOCKconstant 
-
-public static const STRING_SCROLLLOCK:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Scroll Lock constant - -

- - - - - -
STRING_SELECTconstant 
-
-public static const STRING_SELECT:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Select constant - -

- - - - - -
STRING_STOPconstant 
-
-public static const STRING_STOP:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Stop constant - -

- - - - - -
STRING_SYSREQconstant 
-
-public static const STRING_SYSREQ:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode System Request constant - -

- - - - - -
STRING_SYSTEMconstant 
-
-public static const STRING_SYSTEM:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode System constant - -

- - - - - -
STRING_UNDOconstant 
-
-public static const STRING_UNDO:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode Undo constant - -

- - - - - -
STRING_UPARROWconstant 
-
-public static const STRING_UPARROW:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode up arrow constant - -

- - - - - -
STRING_USERconstant 
-
-public static const STRING_USER:String = "?" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - The OS X Unicode User constant - -

- - - - - -
SUBTITLEconstant 
-
-public static const SUBTITLE:uint = 0x01000018 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for toggling subtitles. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
Tconstant 
-
-public static const T:uint = 84 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the T key (84). - - -

- - - - - -
TABconstant 
-
-public static const TAB:uint = 9 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Tab key (9). - - -

- - - - - -
Uconstant 
-
-public static const U:uint = 85 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the U key (85). - - -

- - - - - -
UPconstant 
-
-public static const UP:uint = 38 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Up Arrow key (38). - - -

- - - - - -
Vconstant 
-
-public static const V:uint = 86 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the V key (86). - - -

- - - - - -
VODconstant 
-
-public static const VOD:uint = 0x0100001A -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the button for engaging video-on-demand. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
Wconstant 
-
-public static const W:uint = 87 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the W key (87). - - -

- - - - - -
Xconstant 
-
-public static const X:uint = 88 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the X key (88). - - -

- - - - - -
Yconstant 
-
-public static const Y:uint = 89 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Y key (89). - - -

- - - - - -
YELLOWconstant 
-
-public static const YELLOW:uint = 0x01000002 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 2.5 - -
-

- - Constant associated with the key code value for the yellow function key button. - - - -

This constant is supported on AIR for TV. On other platforms, its value - - is undefined.

- - - -
- - - - - -
Zconstant 
-
-public static const Z:uint = 90 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Constant associated with the key code value for the Z key (90). - - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/ui/KeyboardType.html b/html-docs/flash/ui/KeyboardType.html deleted file mode 100644 index 3f41700..0000000 --- a/html-docs/flash/ui/KeyboardType.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - - - - -flash.ui.KeyboardType (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class KeyboardType
InheritanceKeyboardType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The KeyboardType class is an enumeration class that provides values for different categories of physical computer or device keyboards. - -

Use the values defined by the KeyboardType class with the Keyboard.physicalKeyboardType - property.

- -

-

-View the examples. -

-

-See also -

-
-Keyboard.physicalKeyboardType -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  ALPHANUMERIC : String = "alphanumeric"
[static] - A standard keyboard with a full set of numbers and letters.
-		KeyboardType
  KEYPAD : String = "keypad"
[static] - A phone-style 12-button keypad.
-		KeyboardType
  NONE : String = "none"
[static] - No physical keyboard is supported.
-		KeyboardType
-
- -
- -
Constant detail
- - - - - -
ALPHANUMERICconstant
-
-public static const ALPHANUMERIC:String = "alphanumeric" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A standard keyboard with a full set of numbers and letters. - -

Most desktop computers and some mobile devices provide an alphanumeric keyboard.

- -
- - - - - -
KEYPADconstant 
-
-public static const KEYPAD:String = "keypad" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A phone-style 12-button keypad. - -

Many mobile devices provide a keypad, although some provide an alphanumeric keyboard.

- -
- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- No physical keyboard is supported. - -

Typically, a virtual keyboard is provided in the absence of a physical keyboard.

- -

-See also -

-
-flash.ui.Keyboard.hasVirtualKeyboard -
-
- -
Examples
-
examples\KeyboardType
-
The following example is a simple test that indicates the current state of the "Num Lock" and "Caps Lock" keys - as well as the type of keyboard and touch screen type in the running environment. When testing this example, click the - text field to see the property values: -
-
-import flash.events.~~;
-import flash.display.~~;
-import flash.ui.Keyboard;
-import flash.system.Capabilities;
-import flash.text.TextField;
-
-
-var keyboardInfoTxt:TextField = new TextField();
-keyboardInfoTxt.x = 30;
-keyboardInfoTxt.y = 50;
-keyboardInfoTxt.width = 300;
-keyboardInfoTxt.height = 100;
-keyboardInfoTxt.border = true;
-
-addChild(keyboardInfoTxt);
-
-addEventListener (MouseEvent.CLICK, getScreenKeyboardType);
-
-function getScreenKeyboardType(e:MouseEvent):void{
-    keyboardInfoTxt.text= "Caps Lock is : " + String(flash.ui.Keyboard.capsLock)+ "\n" + 
-	"Num Lock is : " + String(flash.ui.Keyboard.numLock) +"\n" + 
-	"Has Virtual Keyboard : " + String(flash.ui.Keyboard.hasVirtualKeyboard) + "\n" + 
-	"Physical Keyboard Type : " + flash.ui.Keyboard.physicalKeyboardType + "\n" + 
-	"flash.system.Capabilities.touchscreenType is : " + flash.system.Capabilities.touchscreenType;
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Thu Feb 27 2025, 6:06 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/ui/Mouse.html b/html-docs/flash/ui/Mouse.html deleted file mode 100644 index 203f342..0000000 --- a/html-docs/flash/ui/Mouse.html +++ /dev/null @@ -1,695 +0,0 @@ - - - - - - - - -flash.ui.Mouse (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class Mouse
InheritanceMouse Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The methods of the Mouse class are used to hide and show the mouse pointer, - or to set the pointer to a specific style. - The Mouse class is a top-level class whose properties and methods - you can access without using a constructor. The pointer is visible by default, - but you can hide it and implement a custom pointer. - -

-

-View the examples. -

-

-See also -

-
-flash.events.MouseEvent -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  cursor : String -
[static] - The name of the native cursor.
-		Mouse
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  supportsCursor : Boolean -
[static][read-only] - Indicates whether the computer or device displays a persistent cursor.
-		Mouse
  supportsNativeCursor : Boolean -
[static][read-only] - Indicates whether the current configuration supports native cursors.
-		Mouse
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-hide():void -
-
[static] - Hides the pointer.
-		Mouse
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-registerCursor(name:String, cursor:MouseCursorData):void -
-
[static] - Registers a native cursor under the given name, with the given data.
-		Mouse
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-show():void -
-
[static] - Displays the pointer.
-		Mouse
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
   -
-unregisterCursor(name:String):void -
-
[static] - Unregisters the native cursor with the given name.
-		Mouse
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
cursorproperty
-
-cursor:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- The name of the native cursor. - -

Implementation -
-    public static function get cursor():String -
-    public function set cursor(value:String):void -
-
- - - - - -
supportsCursorproperty 
-
-supportsCursor:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the computer or device displays a persistent cursor. - -

The supportsCursor property is true on most desktop computers - and false on most mobile devices.

- -

Note: Mouse events can be dispatched whether or not this property is true. - However, mouse events may behave differently depending on the physical characteristics of the pointing device.

- - Implementation -
-    public static function get supportsCursor():Boolean -
-

-See also -

-
-flash.system.Capabilities.touchscreenType -
-
-Example -
The following example is a simple test that indicates current support for a persistent cursor, or not. When testing this example, click the - text field to see the property value: -
-
-import flash.events.~~;
-import flash.display.~~;
-import flash.ui.Mouse;
-import flash.text.TextField;
-
-var supportsCursorTxt:TextField = new TextField();
-supportsCursorTxt.width = 200;
-supportsCursorTxt.border = true;
-addChild(supportsCursorTxt);
-
-addEventListener (MouseEvent.CLICK, getScreenKeyboardType);
-
-function getScreenKeyboardType(e:MouseEvent):void{
-    supportsCursorTxt.text= "Supports Cursor is : " + String(flash.ui.Mouse.supportsCursor);
-
-}
-
-

The following example tests and responds to different user input environments. - This example assumes it is part of the code for a game that uses a cursor. First, the example tests - to see if the environment supports a cursor. If not, it then tests to see if the environment supports - interaction with a stylus. If so, then code can be inserted to customize the game for stylus use. - If the environment supports finger interaction, code can be inserted to customize the program for the specific - needs of finger touches. If no pointing device is supported at all, then the developer needs to create - alternative cursors or some means of interaction, such as key presses. -
-
-if(Mouse.supportsCursor) {
-    //Game acts as before
-} else {
-    if(Capabilities.touchscreenType == TouchscreenType.STYLUS ){
-        //The Game has to change so that the character is chasing the location of the stylus as 
-        //it's dragged around. Some of the animations will have to change
-    }else if(Capabilities.touchscreenType = TouchscreenType.FINGER){
-        //Same as above, except that the hit-area is larger for a finger.
-    }else{
-        //There's no pointing device at all. The developer designs some sort of custom cursor to 
-        //be controlled with key presses or similar input
-    }
-}
-
-

-
- - - - - -
supportsNativeCursorproperty 
-
-supportsNativeCursor:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Indicates whether the current configuration supports native cursors. - -

Implementation -
-    public static function get supportsNativeCursor():Boolean -
-
- -
Method detail
- - - - - -
hide()method
-
-public static function hide():void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Hides the pointer. The pointer is visible by default. -

Note: You need to call Mouse.hide() only once, regardless of - the number of previous calls to Mouse.show().

-

-See also -

-
-flash.display.DisplayObject.mouseX -
-flash.display.DisplayObject.mouseY -
-
- - - - - -
registerCursor()method 
-
-public static function registerCursor(name:String, cursor:MouseCursorData):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Registers a native cursor under the given name, with the given data. - -

Parameters - - - - - - - - - - -
name:String
 
cursor:MouseCursorData
-
- - - - - -
show()method 
-
-public static function show():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Displays the pointer. The pointer is visible by default. -

Note: You need to call Mouse.show() only once, regardless of - the number of previous calls to Mouse.hide().

-

-See also -

-
-flash.display.DisplayObject.mouseX -
-flash.display.DisplayObject.mouseY -
-
- - - - - -
unregisterCursor()method 
-
-public static function unregisterCursor(name:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Unregisters the native cursor with the given name. - -

Parameters - - - - -
name:String
-
- -
Examples
-
examples\MouseExample
-
The following example uses the MouseExample, SimpleButton, - ButtonDisplayState, and CustomCursor classes to place a simple button on the Stage. The button - has a custom pointer and the button changes when clicked. This is accomplished with the following steps: -
    -
  1. Declare the following instance properties: cursor of type CustomCursor, child of type - CustomButton, and gutter of type uint.
    2. -
  2. Assign child to a new CustomButton instance, set its x and - y coordinates to 10 pixels each, and then add the instance to the display list. - The CustomButton class overrides the downState, upState, - overState, and hitTestState properties in SimpleButton. Each of these - properties instantiates a ButtonDisplayState object, which draws a different square, depending - on the state of the child instance.
    3. -
  3. The child instance is then used to add a MOUSE_OVER event listener and - mouseOverHandler() listener method, along with a MOUSE_OUT event listener and associated - mouseOutHandler() method.
    4. -
  4. The event listeners work as follows: -
      -
    • mouseOverHandler: Hides the "normal" pointer and adds a MOUSE_MOVE - listener, which processes the mouse moves using mouseMoveHandler(), described - below.
      • -
    • mouseOutHandler: When the mouse moves outside the custom button, the - "normal" pointer is shown, the MOUSE_MOVE event listener is removed, and the custom cursor's - visibility is set to false.
      • -
    • mouseMoveHandler: Moves the custom cursor around wherever the pointer is - moved and sets the custom cursor's visibility to true.
      • -
    5. -
  5. Back in the MouseExample constructor, the cursor property is assigned to a new - CustomCursor object and then added to the display list using addChild(). - The CustomCursor class draws a small nearly black square in place of the "normal" pointer - whenever the mouse is over child.
    6. -
  6. A fourth event listener of type MOUSE_LEAVE is added, with the associated - mouseLeaveHandler() method. In this method (called if the mouse leaves the Stage), - mouseOutHandler() is passed a new mouseMove listener object, which essentially - removes the pointer so it is not left on the Stage.
    7. -
-
-
-package {
-    import flash.display.Sprite;
-    import flash.display.DisplayObject;
-    import flash.ui.Mouse;
-    import flash.events.*;
-
-    public class MouseExample extends Sprite {
-         private var cursor:CustomCursor;
-         private var child:CustomButton;
-         private var gutter:uint = 10;
-
-        public function MouseExample() {
-            child = new CustomButton();
-            child.x = gutter;
-            child.y = gutter;
-            addChild(child);
-
-            child.addEventListener(MouseEvent.MOUSE_OVER, mouseOverHandler);
-            child.addEventListener(MouseEvent.MOUSE_OUT, mouseOutHandler);
-
-            cursor = new CustomCursor();
-            addChild(cursor);
-
-            stage.addEventListener(Event.MOUSE_LEAVE, mouseLeaveHandler);
-        }
-
-        private function mouseOverHandler(event:MouseEvent):void {
-            trace("mouseOverHandler");
-            Mouse.hide();
-            child.addEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
-        }
-
-        private function mouseOutHandler(event:MouseEvent):void {
-            trace("mouseOutHandler");
-            Mouse.show();
-            child.removeEventListener(MouseEvent.MOUSE_MOVE, mouseMoveHandler);
-            cursor.visible = false;
-        }
-
-        private function mouseMoveHandler(event:MouseEvent):void {
-            trace("mouseMoveHandler");
-            cursor.x = event.localX;
-            cursor.y = event.localY;
-            event.updateAfterEvent();
-            cursor.visible = true;
-        }
-
-        private function mouseLeaveHandler(event:Event):void {
-            trace("mouseLeaveHandler");
-            mouseOutHandler(new MouseEvent(MouseEvent.MOUSE_MOVE));
-        }
-    }
-}
-
-import flash.display.Shape;
-import flash.display.SimpleButton;
-    
-class CustomButton extends SimpleButton {
-    var upColor:uint = 0xFFCC00;
-    var overColor:uint = 0xCCFF00;
-    var downColor:uint = 0x00CCFF;
-    var size:uint = 80;
-    
-    public function CustomButton() {
-        downState = new ButtonDisplayState(downColor, size+10);
-        overState = new ButtonDisplayState(overColor, size);
-        upState = new ButtonDisplayState(upColor, size);
-        hitTestState = new ButtonDisplayState(upColor, size);
-    }
-}
-
-class ButtonDisplayState extends Shape {
-    var bgColor:uint;
-    var size:uint;
-    
-    public function ButtonDisplayState(bgColor:uint, size:uint) {
-        this.bgColor = bgColor;
-        this.size = size;
-        draw();
-    }
-    
-    private function draw():void {
-        graphics.clear();
-        graphics.beginFill(bgColor);
-        graphics.drawRect(0, 0, size, size);
-        graphics.endFill();
-    }
-}
-    
-class CustomCursor extends Shape {
-    var bgColor:uint = 0x333333;
-    var size:uint = 10;
-    
-    public function CustomCursor() {
-        visible = false;
-        draw();
-    }
-    
-    private function draw():void {
-        graphics.clear();
-        graphics.beginFill(bgColor);
-        graphics.drawRect(0, 0, size, size);
-        graphics.endFill();
-    }
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/MouseCursor.html b/html-docs/flash/ui/MouseCursor.html deleted file mode 100644 index a8f0974..0000000 --- a/html-docs/flash/ui/MouseCursor.html +++ /dev/null @@ -1,371 +0,0 @@ - - - - - - - - -flash.ui.MouseCursor (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class MouseCursor
InheritanceMouseCursor Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5
-

-

-The MouseCursor class is an enumeration of constant values used in setting the cursor property -of the Mouse class. - -

-

-See also -

-
-flash.ui.Mouse.cursor -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  ARROW : String = "arrow"
[static] - Used to specify that the arrow cursor should be used.
-		MouseCursor
  AUTO : String = "auto"
[static] - Used to specify that the cursor should be selected automatically based on the object under the mouse.
-		MouseCursor
  BUTTON : String = "button"
[static] - Used to specify that the button pressing hand cursor should be used.
-		MouseCursor
  HAND : String = "hand"
[static] - Used to specify that the dragging hand cursor should be used.
-		MouseCursor
  IBEAM : String = "ibeam"
[static] - Used to specify that the I-beam cursor should be used.
-		MouseCursor
-
- -
- -
Constant detail
- - - - - -
ARROWconstant
-
-public static const ARROW:String = "arrow" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify that the arrow cursor should be used. - -

- - - - - -
AUTOconstant 
-
-public static const AUTO:String = "auto" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify that the cursor should be selected automatically based on the object under the mouse. - -

- - - - - -
BUTTONconstant 
-
-public static const BUTTON:String = "button" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify that the button pressing hand cursor should be used. - -

- - - - - -
HANDconstant 
-
-public static const HAND:String = "hand" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify that the dragging hand cursor should be used. - -

- - - - - -
IBEAMconstant 
-
-public static const IBEAM:String = "ibeam" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.5 -
-

- Used to specify that the I-beam cursor should be used. - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/MouseCursorData.html b/html-docs/flash/ui/MouseCursorData.html deleted file mode 100644 index c17dec4..0000000 --- a/html-docs/flash/ui/MouseCursorData.html +++ /dev/null @@ -1,447 +0,0 @@ - - - - - - - - -flash.ui.MouseCursorData (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class MouseCursorData
InheritanceMouseCursorData Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

-

- The MouseCursorData class lets you define the appearance of a "native" mouse cursor. - -

To display the cursor, use the Mouse.registerCursor() function. To return - control of the cursor image to the operating system, call Mouse.unregisterCursor(). - Call Mouse.supportsNativeCursor to test whether native cursors are supported on the - current computer.

-

The maximum cursor size is 32x32 pixels.Transparency is supported on most operating systems.

-

A native mouse cursor is implemented directly through the operating system cursor mechanism - and is a more efficient means for displaying a custom cursor image than using a display object. - You can animate the cursor by supplying more than one image in the data property - and setting the frame rate.

- -

The cursor is only displayed within the bounds of the stage. Outside the stage, control of the - cursor image returns to the operating system

- -

-

-View the examples. -

-

-See also -

-
-flash.ui.Mouse.cursor -
-AIR Cookbook: Native Mouse cursor for Flash Player 10.2+ -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  data : Vector.<BitmapData>
- A Vector of BitmapData objects containing the cursor image or images.
-		MouseCursorData
  frameRate : Number -
- The frame rate for animating the cursor.
-		MouseCursorData
  hotSpot : Point -
- The hot spot of the cursor in pixels.
-		MouseCursorData
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-MouseCursorData()
-
- Creates a MouseCursorData object.
-		MouseCursorData
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
dataproperty
-
-data:Vector.<BitmapData>  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- A Vector of BitmapData objects containing the cursor image or images. - -

Supply more than one image and set the framerate property to - animate the cursor.

-

The maximum cursor size is 32x32 pixels.

- Implementation -
-    public function get data():Vector.<BitmapData> -
-    public function set data(value:Vector.<BitmapData>):void -
-
- - - - - -
frameRateproperty 
-
-frameRate:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- The frame rate for animating the cursor. -

Suppy more than one image in the data property and set the - frame rate to a value greater than 0 to animate the cursor. The cursor frame rate - may differ from the current SWF frame rate.

- - Implementation -
-    public function get frameRate():Number -
-    public function set frameRate(value:Number):void -
-
- - - - - -
hotSpotproperty 
-
-hotSpot:Point  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- The hot spot of the cursor in pixels. - -

The hotspot is the point on the cursor under which mouse clicks are registered. - By default, the hot spot is the upper-left corner (0,0).

- Implementation -
-    public function get hotSpot():Point -
-    public function set hotSpot(value:Point):void -
-
- -
Constructor detail
- - - - - -
MouseCursorData()constructor
-
-public function MouseCursorData() -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2.6 -
-

- Creates a MouseCursorData object. -

To display the cursor, call the Mouse.registerCursor() function.

-

-See also -

-
-flash.ui.Mouse.registerCursor() -
-
- -
Examples
-
examples\MouseCursorDataExample
-
The following example creates and displays a spinning arrow for the mouse cursor. - -

The example uses the drawing commands available through the Graphics class to create - eight, rotated images of an arrow. These images are pushed into a vector and assigned to the data - property of the MouseCursorData object. (Note that you can also use prerendered bitmap images for your cursors.)

-
-
-package  {
-    
-	import flash.display.Sprite;
-	import flash.display.Shape;
-	import flash.display.BitmapData;
-	import flash.display.GraphicsPath;
-	import flash.ui.MouseCursorData;
-	import flash.ui.Mouse;
-	import flash.geom.Matrix;	
-	
-	public class MouseCursorDataExample extends Sprite {
-		//Graphics path data for an arrow
-		private var cursorPoints:Vector.<Number> = new <Number>[0,8, 16,8, 16,0, 24,12, 16,24, 16,16, 0,16, 0,8];
-		private var cursorDrawCommands:Vector.<int> = new <int>[1,2,2,2,2,2,2,2];
-		
-		public function MouseCursorDataExample() {
-			var mouseCursorData:MouseCursorData = new MouseCursorData();
-			mouseCursorData.data = makeCursorImages();
-			mouseCursorData.frameRate = 1;
-			
-			Mouse.registerCursor( "spinningArrow", mouseCursorData );
-			Mouse.cursor = "spinningArrow";
-		}
-		
-		//Returns a Vector containing 8 cursor images
-		private function makeCursorImages():Vector.<BitmapData>
-		{
-			var cursorData:Vector.<BitmapData> = new Vector.<BitmapData>();
-			
-			var cursorShape:Shape = new Shape();
-			cursorShape.graphics.beginFill( 0xff5555, .75 );
-			cursorShape.graphics.lineStyle( 1 );
-			cursorShape.graphics.drawPath( cursorDrawCommands, cursorPoints );
-			cursorShape.graphics.endFill();
-			var transformer:Matrix = new Matrix();
-			
-			//Rotate and draw the arrow shape to a BitmapData object for each of 8 frames 
-			for( var i:int = 0; i < 8; i++ )
-			{
-				var cursorFrame:BitmapData = new BitmapData( 32, 32, true, 0 );
-				cursorFrame.draw( cursorShape, transformer );
-				cursorData.push( cursorFrame );
-				
-				transformer.translate(-15,-15);
-				transformer.rotate( 0.785398163 );
-				transformer.translate(15,15);
-			}
-			return cursorData;
-		}
-	}
-	
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/Multitouch.html b/html-docs/flash/ui/Multitouch.html deleted file mode 100644 index 04c457c..0000000 --- a/html-docs/flash/ui/Multitouch.html +++ /dev/null @@ -1,621 +0,0 @@ - - - - - - - - -flash.ui.Multitouch (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class Multitouch
InheritanceMultitouch Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The Multitouch class manages and provides information about the current environment's support for handling - contact from user input devices, including contact that has two or more touch points (such as a user's fingers on a touch screen). - When a user interacts with a device such as a mobile phone or tablet with a touch screen, the user typically - touches the screen with his or her fingers or a pointing device. While there is a broad range of pointing devices, - such as a mouse or a stylus, many of these devices only have a single point of contact with an application. For pointing - devices with a single point of contact, - user interaction events can be handled as a mouse event, or using a basic set of touch events (called "touch point" events). - However, for pointing devices that have several - points of contact and perform complex movement, such as the human hand, Flash runtimes support an additional set of event handling API called gesture events. The API - for handling user interaction with these gesture events includes the following classes: -

  • flash.events.TouchEvent
    • -
  • flash.events.GestureEvent
    • -
  • flash.events.GesturePhase
    • -
  • flash.events.TransformGestureEvent
    • -
  • flash.events.PressAndTapGestureEvent

-

Use the listed classes to write code that handles touch events. Use the Multitouch class to determine the - current environment's support for touch interaction, and to manage the support of touch interaction if - the current environment supports touch input.

-

You cannot create a Multitouch object directly from ActionScript code. If you call new Multitouch(), an exception is thrown.

-

Note: The Multitouch feature is not supported for SWF files embedded in HTML running on Mac OS.

-

-

-View the examples. -

-

-See also -

-
-flash.events.TouchEvent -
-flash.events.GestureEvent -
-flash.events.TransformGestureEvent -
-flash.events.GesturePhase -
-flash.events.PressAndTapGestureEvent -
-flash.events.MouseEvent -
-flash.events.EventDispatcher.addEventListener() -
-Michael Chaize: Tetris, Touch API and Android -
-Christian Cantrell: Multitouch and gesture support on the Flash Platform -
-Lee Brimelow: Flash Player 10.1 multi-touch FAQ -
-Piotr Walczyszyn: Multitouch development in Flex -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  inputMode : String -
[static] - Identifies the multi-touch mode for touch and gesture event handling.
-		Multitouch
  mapTouchToMouse : Boolean -
[static] - Specifies whether the AIR runtime maps touch events to mouse events.
-		Multitouch
  maxTouchPoints : int -
[static][read-only] - The maximum number of concurrent touch points supported by the current environment.
-		Multitouch
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  supportedGestures : Vector.<String>
[static][read-only] - A Vector array (a typed array of string values) of multi-touch contact types supported in the current environment.
-		Multitouch
  supportsGestureEvents : Boolean -
[static][read-only] - Indicates whether the current environment supports gesture input, such as rotating two fingers - around a touch screen.
-		Multitouch
  supportsTouchEvents : Boolean -
[static][read-only] - Indicates whether the current environment supports basic touch input, such as a single finger tap.
-		Multitouch
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
inputModeproperty
-
-inputMode:String  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Identifies the multi-touch mode for touch and gesture event handling. Use this property to manage - whether or not events are dispatched as touch events with multiple points of contact and specific events - for different gestures (such as rotation and pan), or only a single point of contact (such as tap), or - none at all (contact is handled as a mouse event). To set this property, use values from the flash.ui.MultitouchInputMode class. -

The default value is gesture.

-Implementation -
-    public static function get inputMode():String -
-    public function set inputMode(value:String):void -
-

-See also -

-
-flash.ui.MultitouchInputMode -
-
-Example -
The following example displays a message when the - square drawn on mySprite is tapped on a touch-enabled screen: -
-
-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);
-}
-
-

-
- - - - - -
mapTouchToMouseproperty 
-
-mapTouchToMouse:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 3 -
-

- Specifies whether the AIR runtime maps touch events to mouse events. - -

When true, the default, the AIR runtime dispatches - a mouse event in addition to a touch event for touch inputs. When false, the - runtime does not dispatch an additional mouse event. Setting this property - to false can cause existing code, libraries, and frameworks - that rely on mouse events to function incorrectly on devices that support - touch input.

- - Implementation -
-    public static function get mapTouchToMouse():Boolean -
-    public function set mapTouchToMouse(value:Boolean):void -
-

-See also -

-
-TouchEvent -
-MouseEvent -
-
- - - - - -
maxTouchPointsproperty 
-
-maxTouchPoints:int  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- The maximum number of concurrent touch points supported by the current environment. -

Note: On Android, for the devices supporting more than two touch points, the return value is 2.

- Implementation -
-    public static function get maxTouchPoints():int -
-

-See also -

-
-flash.events.TouchEvent -
-flash.events.MouseEvent -
-flash.events.EventDispatcher.addEventListener() -
-flash.events.GestureEvent -
-flash.events.TransformGestureEvent -
-
- - - - - -
supportedGesturesproperty 
-
-supportedGestures:Vector.<String>  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- A Vector array (a typed array of string values) of multi-touch contact types supported in the current environment. The array of strings - can be used as event types to register event listeners. Possible values are constants from the GestureEvent, PressAndTapGestureEvent, and - TransformGestureEvent classes (such as GESTURE_PAN). -

If the Flash runtime is in an environment that does not support any multi-touch gestures, the value is null.

-

Note: For Mac OS 10.5.3 and later, Multitouch.supportedGestures returns - non-null values (possibly indicating incorrectly that gesture events are supported) even if the current hardware does not support gesture input.

-

Use this property to test for multi-touch gesture support. Then, use event handlers for the available multi-touch - gestures. For those gestures that are not supported in the current evironment, you'll need to create alternative - event handling.

- Implementation -
-    public static function get supportedGestures():Vector.<String> -
-

-See also -

-
-flash.events.TouchEvent -
-flash.events.MouseEvent -
-flash.events.EventDispatcher.addEventListener() -
-flash.events.GestureEvent -
-flash.events.PressAndTapGestureEvent -
-flash.events.TransformGestureEvent -
-
-Example -
The following example adds the appropriate event listeners for each individual supported gesture in the current - environment. The Multitouch.supportedGestures vector array contents change to include all - the gestures available to the current software and hardware environment for the Flash runtime. If the Multitouch.supportedGestures - vector array does not contain one of the TransformGestureEvent gestures, then no event listener is added for that gesture. - This example comes from Holly Schinsky. -
-
-Multitouch.inputMode = MultitouchInputMode.GESTURE;
-
-    for each (var item:String in Multitouch.supportedGestures) {
-		trace("gesture " + item);
-		if (item == TransformGestureEvent.GESTURE_PAN)
-			img.addEventListener(TransformGestureEvent.GESTURE_PAN, onPan);
-		else if (item == TransformGestureEvent.GESTURE_ROTATE)
-			img.addEventListener(TransformGestureEvent.GESTURE_ROTATE, onRotate);
-		else if (item == TransformGestureEvent.GESTURE_SWIPE)
-			img.addEventListener(TransformGestureEvent.GESTURE_SWIPE, onSwipe);
-		else if (item == TransformGestureEvent.GESTURE_ZOOM)
-			img.addEventListener(TransformGestureEvent.GESTURE_ZOOM, onZoom);
-	}
-
-

-
- - - - - -
supportsGestureEventsproperty 
-
-supportsGestureEvents:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the current environment supports gesture input, such as rotating two fingers - around a touch screen. Gesture events are listed in the TransformGestureEvent, PressAndTapGestureEvent, and GestureEvent classes. -

Note: For Mac OS 10.5.3 and later, this value is always true. Multitouch.supportsGestureEvent returns - true even if the hardware does not support gesture events.

- Implementation -
-    public static function get supportsGestureEvents():Boolean -
-

-See also -

-
-flash.events.TransformGestureEvent -
-flash.events.GestureEvent -
-flash.events.PressAndTapGestureEvent -
-
- - - - - -
supportsTouchEventsproperty 
-
-supportsTouchEvents:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Indicates whether the current environment supports basic touch input, such as a single finger tap. - Touch events are listed in the TouchEvent class. -

Implementation -
-    public static function get supportsTouchEvents():Boolean -
-

-See also -

-
-flash.events.TouchEvent -
-
- -
Examples
-
examples\MultitouchExample
-
The following example first checks to see if gesture events are supported - (if the machine doesn't support gesture events, the vector array Multitouch.supportedGestures - returns null and assigning null to the vector of strings causes a run-time error). - If gesture events are supported, the example displays the events from - the TransformGestureEvent class supported in the current environment: -
-
-package {
-    import flash.ui.Multitouch;
-	import flash.ui.MultitouchInputMode;
-	import flash.display.Sprite;
-	import flash.text.TextField;
-
-	public class MultitouchExample extends Sprite {
-
-		Multitouch.inputMode = MultitouchInputMode.GESTURE;
-
-		public function MultitouchExample() {
-
-			if(Multitouch.supportsGestureEvents){
-				var supportedGesturesVar:Vector.<String> = Multitouch.supportedGestures;
-				var deviceSupports:TextField = new TextField();
-				deviceSupports.width = 200;
-				deviceSupports.height = 200;
-				deviceSupports.wordWrap = true;
-
-				for (var i:int=0; i<supportedGesturesVar.length; ++i) {
-					deviceSupports.appendText(supportedGesturesVar[i] + ",  ");
-					addChild(deviceSupports);
-				}
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Sat Jan 11 2025, 8:30 AM GMT
Creative Commons License
-
- - diff --git a/html-docs/flash/ui/MultitouchInputMode.html b/html-docs/flash/ui/MultitouchInputMode.html deleted file mode 100644 index 2e85e9d..0000000 --- a/html-docs/flash/ui/MultitouchInputMode.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - - - - -flash.ui.MultitouchInputMode (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.ui
Classpublic final class MultitouchInputMode
InheritanceMultitouchInputMode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

-

- The MultitouchInputMode class provides values for the inputMode property in the flash.ui.Multitouch class. - These values set the type of touch events the Flash runtime dispatches when the user interacts with a touch-enabled device. - -

-

-View the examples. -

-

-See also -

-
-flash.ui.Multitouch.inputMode -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  GESTURE : String = "gesture"
[static] - Specifies that TransformGestureEvent, PressAndTapGestureEvent, and GestureEvent events are dispatched for the related user interaction supported by the current environment, - and other touch events (such as a simple tap) are interpreted as mouse events.
-		MultitouchInputMode
  NONE : String = "none"
[static] - Specifies that all user contact with a touch-enabled device is interpreted as a type of mouse event.
-		MultitouchInputMode
  TOUCH_POINT : String = "touchPoint"
[static] - Specifies that events are dispatched only for basic touch events, such as a single finger tap.
-		MultitouchInputMode
-
- -
- -
Constant detail
- - - - - -
GESTUREconstant
-
-public static const GESTURE:String = "gesture" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies that TransformGestureEvent, PressAndTapGestureEvent, and GestureEvent events are dispatched for the related user interaction supported by the current environment, - and other touch events (such as a simple tap) are interpreted as mouse events. - -

-See also -

-
-flash.ui.Multitouch.inputMode -
-flash.events.TransformGestureEvent -
-flash.events.GestureEvent -
-flash.events.PressAndTapGestureEvent -
-flash.events.TouchEvent -
-
- - - - - -
NONEconstant 
-
-public static const NONE:String = "none" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies that all user contact with a touch-enabled device is interpreted as a type of mouse event. - -

-See also -

-
-flash.ui.Multitouch.inputMode -
-flash.events.MouseEvent -
-
- - - - - -
TOUCH_POINTconstant 
-
-public static const TOUCH_POINT:String = "touchPoint" -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 2 -
-

- Specifies that events are dispatched only for basic touch events, such as a single finger tap. When you use this setting, - events listed in the TouchEvent class are dispatched; events listed in the TransformGestureEvent, PressAndTapGestureEvent, and GestureEvent classes are not dispatched. - -

-See also -

-
-flash.ui.Multitouch.inputMode -
-flash.events.TransformGestureEvent -
-flash.events.GestureEvent -
-flash.events.PressAndTapGestureEvent -
-flash.events.TouchEvent -
-
- -
Examples
-
examples\Multitouch_inputMode
-
The following example displays a message when the - square drawn on mySprite is tapped on a touch-enabled screen: -
-
-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);
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/ui/package-detail.html b/html-docs/flash/ui/package-detail.html deleted file mode 100644 index c8ff06d..0000000 --- a/html-docs/flash/ui/package-detail.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - -flash.ui Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.ui package contains user interface classes, such as classes for interacting with the mouse and keyboard.

-
-
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 ContextMenu - The ContextMenu class provides control over the items displayed in context menus.
 ContextMenuBuiltInItems -The ContextMenuBuiltInItems class describes the items that are built in to a context menu.
 ContextMenuClipboardItems - The ContextMenuClipboardItems class lets you enable or disable the commands in the clipboard context menu.
 ContextMenuItem - The ContextMenuItem class represents an item in the context - menu.
 GameInput - The GameInput class is the entry point into the GameInput - API.
 GameInputControl - The GameInputControl class represents a control on an input device.
 GameInputDevice - The GameInputDevice class represents a single input device - commonly used for gaming.
 Keyboard - - The Keyboard class is used to build an interface that can be controlled by a user with a standard keyboard.
 KeyboardType - The KeyboardType class is an enumeration class that provides values for different categories of physical computer or device keyboards.
 KeyLocation -The KeyLocation class contains constants that indicate the location of a key pressed on -the keyboard or keyboard-like input device.
 Mouse - The methods of the Mouse class are used to hide and show the mouse pointer, - or to set the pointer to a specific style.
 MouseCursor -The MouseCursor class is an enumeration of constant values used in setting the cursor property -of the Mouse class.
 MouseCursorData - The MouseCursorData class lets you define the appearance of a "native" mouse cursor.
 Multitouch - The Multitouch class manages and provides information about the current environment's support for handling - contact from user input devices, including contact that has two or more touch points (such as a user's fingers on a touch screen).
 MultitouchInputMode - The MultitouchInputMode class provides values for the inputMode property in the flash.ui.Multitouch class.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/utils/ByteArray.html b/html-docs/flash/utils/ByteArray.html deleted file mode 100644 index 198adb3..0000000 --- a/html-docs/flash/utils/ByteArray.html +++ /dev/null @@ -1,3450 +0,0 @@ - - - - - - - - -flash.utils.ByteArray (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.utils
Classpublic class ByteArray
InheritanceByteArray Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - The ByteArray class provides methods and properties to optimize reading, writing, - - and working with binary data. - - -

Note: The ByteArray class is for advanced developers who need to access - - data on the byte level.

- - -

In-memory data is a packed array (the most compact representation for the data type) - - of bytes, but an instance of the ByteArray - - class can be manipulated with the standard [] (array access) operators. - - It also can be read and written to as an in-memory file, using - - methods similar to those in the URLStream and Socket classes.

- - -

In addition, zlib and lzma compression and decompression are supported, as - - well as Action Message Format (AMF) object serialization.

- - -

Possible uses of the ByteArray class include the following: - - -

    - - -
  • Creating a custom protocol to connect to a server.
    • - - -
  • Writing your own URLEncoder/URLDecoder.
    • - - -
  • Writing your own AMF/Remoting packet.
    • - - -
  • Optimizing the size of your data by using data types.
    • - - -
  • Working with binary data loaded from a file in - - Adobe® AIR®.
    • - - -
- -

- - -

-

-View the examples. -

-

-See also -

-
-[] (array access) -
-Socket class -
-URLStream class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  bytesAvailable : uint -
[read-only] - - The number of bytes of data available for reading - - from the current position in the byte array to the - - end of the array.
-		ByteArray
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  defaultObjectEncoding : uint -
[static] - - Denotes the default object encoding for the ByteArray class to use for a new ByteArray instance.
-		ByteArray
  endian : String -
- - Changes or reads the byte order for the data; either Endian.BIG_ENDIAN or - - Endian.LITTLE_ENDIAN.
-		ByteArray
  length : uint -
- - The length of the ByteArray object, in bytes.
-		ByteArray
  objectEncoding : uint -
- - Used to determine whether the ActionScript 3.0, ActionScript 2.0, or ActionScript 1.0 format should be - - used when writing to, or reading from, a ByteArray instance.
-		ByteArray
  position : uint -
- - Moves, or returns the current position, in bytes, of the file - - pointer into the ByteArray object.
-		ByteArray
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  shareable : Boolean -
- - Every byte array can either be "non-shareable" or "shareable".
-		ByteArray
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-ByteArray()
-
- - Creates a ByteArray instance representing a packed array of bytes, so that you can use the methods and properties in this class to optimize your data storage and stream.
-		ByteArray
   -
-atomicCompareAndSwapIntAt(byteIndex:int, expectedValue:int, newValue:int):int -
-
- - Atomic compare and swap of integer values in adjacent bytes in this byte array.
-		ByteArray
   -
-atomicCompareAndSwapLength(expectedLength:int, newLength:int):int -
-
- - Atomic compare and change the length of this byte array.
-		ByteArray
   -
-clear():void -
-
- - Clears the contents of the byte array and resets the length - - and position properties to 0.
-		ByteArray
   -
-compress(algorithm:String):void -
-
- - Compresses the byte array.
-		ByteArray
   -
-createFromBase64(base64:String):ByteArray -
-
[static] - - Creates a new ByteArray object from a base64-encoded string.
-		ByteArray
   -
-createFromHexString(hex:String):ByteArray -
-
[static] - - Creates a new ByteArray object from a hex-encoded string.
-		ByteArray
   -
-deflate():void -
-
- - Compresses the byte array using the deflate compression algorithm.
-		ByteArray
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-inflate():void -
-
- - Decompresses the byte array using the deflate compression algorithm.
-		ByteArray
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-readBoolean():Boolean -
-
- - Reads a Boolean value from the byte stream.
-		ByteArray
   -
-readByte():int -
-
- - Reads a signed byte from the byte stream.
-		ByteArray
   -
-readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- - Reads the number of data bytes, specified by the length parameter, from the byte stream.
-		ByteArray
   -
-readDouble():Number -
-
- - Reads an IEEE 754 double-precision (64-bit) floating-point number from the byte stream.
-		ByteArray
   -
-readFloat():Number -
-
- - Reads an IEEE 754 single-precision (32-bit) floating-point number from the byte stream.
-		ByteArray
   -
-readInt():int -
-
- - Reads a signed 32-bit integer from the byte stream.
-		ByteArray
   -
-readMultiByte(length:uint, charSet:String):String -
-
- - Reads a multibyte string of specified length from the byte stream using the - - specified character set.
-		ByteArray
   -
-readObject():* -
-
- - Reads an object from the byte array, encoded in AMF - - serialized format.
-		ByteArray
   -
-readShort():int -
-
- - Reads a signed 16-bit integer from the byte stream.
-		ByteArray
   -
-readUnsignedByte():uint -
-
- - Reads an unsigned byte from the byte stream.
-		ByteArray
   -
-readUnsignedInt():uint -
-
- - Reads an unsigned 32-bit integer from the byte stream.
-		ByteArray
   -
-readUnsignedShort():uint -
-
- - Reads an unsigned 16-bit integer from the byte stream.
-		ByteArray
   -
-readUTF():String -
-
- - Reads a UTF-8 string from the byte stream.
-		ByteArray
   -
-readUTFBytes(length:uint):String -
-
- - Reads a sequence of UTF-8 bytes specified by the length - - parameter from the byte stream and returns a string.
-		ByteArray
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-toBase64():String -
-
- - Converts the byte array into a base64 string.
-		ByteArray
   -
-toHexString():String -
-
- - Converts the byte array into a hex string.
-		ByteArray
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- - Converts the byte array to a string.
-		ByteArray
   -
-uncompress(algorithm:String):void -
-
- - Decompresses the byte array.
-		ByteArray
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
   -
-writeBase64(base64:String):uint -
-
- - Writes data into the byte array from a base64 string.
-		ByteArray
   -
-writeBoolean(value:Boolean):void -
-
- - Writes a Boolean value.
-		ByteArray
   -
-writeByte(value:int):void -
-
- - Writes a byte to the byte stream.
-		ByteArray
   -
-writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- - Writes a sequence of length bytes from the - - specified byte array, bytes, - - starting offset(zero-based index) bytes - - into the byte stream.
-		ByteArray
   -
-writeDouble(value:Number):void -
-
- - Writes an IEEE 754 double-precision (64-bit) floating-point number to the byte stream.
-		ByteArray
   -
-writeFloat(value:Number):void -
-
- - Writes an IEEE 754 single-precision (32-bit) floating-point number to the byte stream.
-		ByteArray
   -
-writeHexString(hex:String):uint -
-
- - Writes data into the byte array from a hex string.
-		ByteArray
   -
-writeInt(value:int):void -
-
- - Writes a 32-bit signed integer to the byte stream.
-		ByteArray
   -
-writeMultiByte(value:String, charSet:String):void -
-
- - Writes a multibyte string to the byte stream using the specified character set.
-		ByteArray
   -
-writeObject(object:*):void -
-
- - Writes an object into the byte array in AMF - - serialized format.
-		ByteArray
   -
-writeRandomBytes():void -
-
- - Writes random data into the byte array.
-		ByteArray
   -
-writeShort(value:int):void -
-
- - Writes a 16-bit integer to the byte stream.
-		ByteArray
   -
-writeUnsignedInt(value:uint):void -
-
- - Writes a 32-bit unsigned integer to the byte stream.
-		ByteArray
   -
-writeUTF(value:String):void -
-
- - Writes a UTF-8 string to the byte stream.
-		ByteArray
   -
-writeUTFBytes(value:String):void -
-
- - Writes a UTF-8 string to the byte stream.
-		ByteArray
-
- -
- -
Property detail
- - - - - -
bytesAvailableproperty
-
-bytesAvailable:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The number of bytes of data available for reading - - from the current position in the byte array to the - - end of the array. - - -

Use the bytesAvailable property in conjunction - - with the read methods each time you access a ByteArray object - - to ensure that you are reading valid data.

- - - Implementation -
-    public function get bytesAvailable():uint -
-
- - - - - -
defaultObjectEncodingproperty 
-
-defaultObjectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Denotes the default object encoding for the ByteArray class to use for a new ByteArray instance. - - When you create a new ByteArray instance, the encoding on that instance starts - - with the value of defaultObjectEncoding. - - The defaultObjectEncoding property is initialized to ObjectEncoding.AMF3. - - - -

When an object is written to or read from binary data, the objectEncoding value - - is used to determine whether the ActionScript 3.0, ActionScript2.0, or ActionScript 1.0 format should be used. The value is a - - constant from the ObjectEncoding class.

- - - Implementation -
-    public static function get defaultObjectEncoding():uint -
-    public function set defaultObjectEncoding(value:uint):void -
-

-See also -

-
-ObjectEncoding class -
-flash.utils.ByteArray.objectEncoding -
-
- - - - - -
endianproperty 
-
-endian:String  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Changes or reads the byte order for the data; either Endian.BIG_ENDIAN or - - Endian.LITTLE_ENDIAN. The default value is Endian.BIG_ENDIAN. - - -

Implementation -
-    public function get endian():String -
-    public function set endian(value:String):void -
-

-See also -

-
-Endian class -
-
- - - - - -
lengthproperty 
-
-length:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - The length of the ByteArray object, in bytes. - - -

If the length is set to a value that is larger than the current length, - - the right side of the byte array is filled with zeros.

- - -

If the length is set to a value that is smaller than the - - current length, the byte array is truncated.

- - - Implementation -
-    public function get length():uint -
-    public function set length(value:uint):void -
-
- - - - - -
objectEncodingproperty 
-
-objectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Used to determine whether the ActionScript 3.0, ActionScript 2.0, or ActionScript 1.0 format should be - - used when writing to, or reading from, a ByteArray instance. The value is a - - constant from the ObjectEncoding class. - - -

Implementation -
-    public function get objectEncoding():uint -
-    public function set objectEncoding(value:uint):void -
-

-See also -

-
-ObjectEncoding class -
-flash.utils.ByteArray.defaultObjectEncoding -
-
- - - - - -
positionproperty 
-
-position:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Moves, or returns the current position, in bytes, of the file - - pointer into the ByteArray object. This is the - - point at which the next call to a read - - method starts reading or a write - - method starts writing. - - -

Implementation -
-    public function get position():uint -
-    public function set position(value:uint):void -
-
- - - - - -
shareableproperty 
-
-shareable:Boolean  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Every byte array can either be "non-shareable" or "shareable". - - This flag indicates which is the case for this byte array. - - The initial value is always 'false', indicating "non-shareable". - - - If this byte array is non-shareable, - - then passing it as an argument to MessageChannel.send to another worker - - or via Worker.setSharedProperty() - - will always create a complete byte array copy, - - including the backing storage for the byte array's contents. - - - If this byte array is shareable, - - then passing it as an argument to MessageChannel.send to another worker - - or via Worker.setSharedProperty() - - will result in a byte array object in the remote worker - - which uses the identical underlying storage buffer for it's contents. - - Then both the local and the remote byte array share their content. - - - Concurrent access to a shared byte array from multiple workers is subject to races. - - For concurrency control, you can use the compare-and-swap facility in this class - - and/or the dedicated mechanisms in package 'flash.concurrent'. - - -

Implementation -
-    public function get shareable():Boolean -
-    public function set shareable(value:Boolean):void -
-
- -
Constructor detail
- - - - - -
ByteArray()constructor
-
-public function ByteArray() -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates a ByteArray instance representing a packed array of bytes, so that you can use the methods and properties in this class to optimize your data storage and stream. - -

- -
Method detail
- - - - - -
atomicCompareAndSwapIntAt()method
-
-public function atomicCompareAndSwapIntAt(byteIndex:int, expectedValue:int, newValue:int):int

- - Atomic compare and swap of integer values in adjacent bytes in this byte array. - - - Compares an expected value with the actual value in the byte array location - - addressed by a start index measured in bytes. - - - If the specified values at the given location are the same, the value given - - by the newValue parameter is writen at the location specified by the byteIndex - - parameter and the previous value of that location is returned. - - - Otherwise, the actual value is returned. - - All of the above is performed in one atomic hardware transaction. - - byteIndex must be a multiple of 4. - - -

Parameters - - - - - - - - - - - - - - - - -
byteIndex:int — int containing the desired index at which the expectedValue - - parameter should be compared. - -
 
expectedValue:int — int containing the expected value of the integer to be - - replaced by the newValue parameter. - -
 
newValue:int — int containint the new value to put into the location specified - - by the byteIndex parameter. - -
-

-Returns - - - - -
int — - int containing the previous value at the specified location - - - -
-
-Throws - - - - -
ArgumentError — if byteIndex is not a multiple of 4 or negative - -
-
- - - - - -
atomicCompareAndSwapLength()method 
-
-public function atomicCompareAndSwapLength(expectedLength:int, newLength:int):int

- - Atomic compare and change the length of this byte array. - - - Compares an expected length with the actual length of this the byte array. - - If the expected length argument and current ByteArray.length property are equal, - - the length is changed to the value specified in the newLength parameter. - - - The compare of the parameter and the update of the length all occur in a single atomic - - transaction. - - -

Parameters - - - - - - - - - - -
expectedLength:int — int containint the expected value of the ByteArray's length. if this value is - - equal to the ByteArray.length property, the length will be changed to the value - - specified by the newLength argument. - -
 
newLength:int — int containing the the length the ByteArray should be after the - - operation succeeds. - -
-

-Returns - - - - -
int — - int containint the previous value of ByteArray.length - - - -
-
- - - - - -
clear()method 
-
-public function clear():void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Clears the contents of the byte array and resets the length - - and position properties to 0. Calling this method explicitly - - frees up the memory used by the ByteArray instance. - - -

- - - - - -
compress()method 
-
-public function compress(algorithm:String):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Compresses the byte array. The entire byte array is compressed. For content - - running in Adobe AIR, you can specify a compression algorithm by passing a - - value (defined in the CompressionAlgorithm class) as the algorithm - - parameter. Flash Player supports only the default - - algorithm, zlib. - - -

After the call, the length property of the ByteArray is set to the new length. - - The position property is set to the end of the byte array.

- - -

The zlib compressed data format is described at - - http://www.ietf.org/rfc/rfc1950.txt.

- - -

The deflate compression algorithm is described at - - http://www.ietf.org/rfc/rfc1951.txt.

- - -

The lzma compression algorithm is described at - - http://www.7-zip.org/7z.html.

- - -

The deflate compression algorithm is used in several compression - - formats, such as zlib, gzip, some zip implementations, and others. When data is - - compressed using one of those compression formats, in addition to storing - - the compressed version of the original data, the compression format data - - (for example, the .zip file) includes metadata information. Some examples of - - the types of metadata included in various file formats are file name, - - file modification date/time, original file size, optional comments, checksum - - data, and more.

- - -

For example, when a ByteArray is compressed using the zlib algorithm, - - the resulting ByteArray is structured in a specific format. Certain bytes contain - - metadata about the compressed data, while other bytes contain the actual compressed - - version of the original ByteArray data. As defined by the zlib compressed data - - format specification, those bytes (that is, the portion containing - - the compressed version of the original data) are compressed using the deflate - - algorithm. Consequently those bytes are identical to the result of calling - - compress(air.CompressionAlgorithm.DEFLATE) - - on the original ByteArray. However, the result from - - compress(air.CompressionAlgorithm.ZLIB) includes - - the extra metadata, while the compress(air.CompressionAlgorithm.DEFLATE) - - result includes only the compressed version of the original ByteArray data and nothing else.

- - -

In order to use the deflate format to compress a ByteArray instance's - - data in a specific format such as gzip or zip, you cannot simply call - - compress(air.CompressionAlgorithm.DEFLATE). - - You must create a ByteArray structured - - according to the compression format's specification, including the appropriate - - metadata as well as the compressed data obtained using the deflate format. - - Likewise, in order to decode data compressed in a format such - - as gzip or zip, you can't simply call uncompress(air.CompressionAlgorithm.DEFLATE) - - on that data. First, you must separate the metadata from the compressed data, and you can - - then use the deflate format to decompress the compressed data.

- - - Parameters - - - - -
algorithm:String — The compression algorithm to use when compressing. Valid values are defined as - - constants in the CompressionAlgorithm class. The default is to use zlib format. - - This parameter is only recognized for content running in Adobe AIR. - - Flash Player supports only the default algorithm, zlib, and throws an exception if you attempt to pass - - a value for this parameter. Calling compress(air.CompressionAlgorithm.DEFLATE) - - has the same effect as calling the deflate() method. - - -
-

-See also -

-
-uncompress() -
-flash.utils.CompressionAlgorithm -
-
- - - - - -
createFromBase64()method 
-
-public static function createFromBase64(base64:String):ByteArray -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Creates a new ByteArray object from a base64-encoded string. - - Utility method that is the equivalent of creating a new empty - - ByteArray and then calling writeBase64. - - -

Parameters - - - - -
base64:String — The base64-encoded string to write into the ByteArray. - -
-

-Returns - - - - -
ByteArray — - ByteArray The new ByteArray object representing the string. - - - -
-
-Throws - - - - -
ArgumentError — If the input string is not in the expected format. - - -
-
- - - - - -
createFromHexString()method 
-
-public static function createFromHexString(hex:String):ByteArray -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Creates a new ByteArray object from a hex-encoded string. - - Utility method that is the equivalent of creating a new empty - - ByteArray and then calling writeHexString. - - -

Parameters - - - - -
hex:String — The hex-encoded string to write into the ByteArray. - -
-

-Returns - - - - -
ByteArray — - ByteArray The new ByteArray object representing the string. - - - -
-
-Throws - - - - -
ArgumentError — If the input string is not in the expected format. - - -
-
- - - - - -
deflate()method 
-
-public function deflate():void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.5 - -
-

- - Compresses the byte array using the deflate compression algorithm. - - The entire byte array is compressed. - - -

After the call, the length property of the ByteArray is set to the new length. - - The position property is set to the end of the byte array.

- - -

The deflate compression algorithm is described at - - http://www.ietf.org/rfc/rfc1951.txt.

- - -

In order to use the deflate format to compress a ByteArray instance's - - data in a specific format such as gzip or zip, you cannot simply call - - deflate(). You must create a ByteArray structured - - according to the compression format's specification, including the appropriate - - metadata as well as the compressed data obtained using the deflate format. - - Likewise, in order to decode data compressed in a format such - - as gzip or zip, you can't simply call inflate() - - on that data. First, you must separate the metadata from the compressed data, and you can - - then use the deflate format to decompress the compressed data.

- - -

-See also -

-
-inflate() -
-
- - - - - -
inflate()method 
-
-public function inflate():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Decompresses the byte array using the deflate compression algorithm. - - The byte array must have been compressed using the same algorithm. - - -

After the call, the length property of the ByteArray is set to the new length. - - The position property is set to 0.

- - -

The deflate compression algorithm is described at - - http://www.ietf.org/rfc/rfc1951.txt.

- - -

In order to decode data compressed in a format that uses the deflate compression algorithm, - - such as data in gzip or zip format, it will not work to simply call inflate() on - - a ByteArray containing the compression formation data. First, you must separate the metadata that is - - included as part of the compressed data format from the actual compressed data. For more - - information, see the compress() method description.

- - -
-Throws - - - - -
Error — The data is not valid compressed data; it was not compressed with the - - same compression algorithm used to compress. - - -
-

-See also -

-
-deflate() -
-
- - - - - -
readBoolean()method 
-
-public function readBoolean():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads a Boolean value from the byte stream. A single byte is read, - - and true is returned if the byte is nonzero, - - false otherwise. - - -

-Returns - - - - -
Boolean — - Returns true if the byte is nonzero, false otherwise. - - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readByte()method 
-
-public function readByte():int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads a signed byte from the byte stream. - -

The returned value is in the range -128 to 127.

- -

-Returns - - - - -
int — - An integer between -128 and 127. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readBytes()method 
-
-public function readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads the number of data bytes, specified by the length parameter, from the byte stream. - - The bytes are read into the ByteArray object specified by the bytes parameter, - - and the bytes are written into the destination ByteArray starting at the position specified by offset. - - -

Parameters - - - - - - - - - - - - - - - - -
bytes:ByteArray — The ByteArray object to read data into. - -
 
offset:uint (default = 0) — The offset (position) in bytes at which the read data should be written. - -
 
length:uint (default = 0) — The number of bytes to read. The default value of 0 causes all available data to be read. - - -
-
-Throws - - - - - - - - - - -
Error — There is not sufficient data available - - to read. - -
 
RangeError — The value of the supplied offset and length, combined, is greater than the maximum for a uint. - -
-
- - - - - -
readDouble()method 
-
-public function readDouble():Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads an IEEE 754 double-precision (64-bit) floating-point number from the byte stream. - - -

-Returns - - - - -
Number — - A double-precision (64-bit) floating-point number. - - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readFloat()method 
-
-public function readFloat():Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads an IEEE 754 single-precision (32-bit) floating-point number from the byte stream. - - -

-Returns - - - - -
Number — - A single-precision (32-bit) floating-point number. - - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readInt()method 
-
-public function readInt():int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads a signed 32-bit integer from the byte stream. - - -

The returned value is in the range -2147483648 to 2147483647.

- - -

-Returns - - - - -
int — - A 32-bit signed integer between -2147483648 and 2147483647. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readMultiByte()method 
-
-public function readMultiByte(length:uint, charSet:String):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads a multibyte string of specified length from the byte stream using the - - specified character set. - - - -

Parameters - - - - - - - - - - -
length:uint — The number of bytes from the byte stream to read. - -
 
charSet:String — The string denoting the character set to use to interpret the bytes. - - Possible character set strings include "shift-jis", "cn-gb", - - "iso-8859-1", and others. - - For a complete list, see Supported Character Sets. - -

Note: If the value for the charSet parameter - - is not recognized by the current system, the application uses the system's default - - code page as the character set. For example, a value for the charSet parameter, - - as in myTest.readMultiByte(22, "iso-8859-01") that uses 01 instead of - - 1 might work on your development system, but not on another system. - - On the other system, the application will use the system's default code page.

- - -
-

-Returns - - - - -
String — - UTF-8 encoded string. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readObject()method 
-
-public function readObject():* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads an object from the byte array, encoded in AMF - - serialized format. - - -

-Returns - - - - -
* — The deserialized object. - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - - -
-

-See also -

-
-flash.net.registerClassAlias() -
-
- - - - - -
readShort()method 
-
-public function readShort():int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads a signed 16-bit integer from the byte stream. - - -

The returned value is in the range -32768 to 32767.

- - -

-Returns - - - - -
int — - A 16-bit signed integer between -32768 and 32767. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readUnsignedByte()method 
-
-public function readUnsignedByte():uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads an unsigned byte from the byte stream. - - -

The returned value is in the range 0 to 255.

- - -

-Returns - - - - -
uint — - A 32-bit unsigned integer between 0 and 255. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readUnsignedInt()method 
-
-public function readUnsignedInt():uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads an unsigned 32-bit integer from the byte stream. - - -

The returned value is in the range 0 to 4294967295.

- - -

-Returns - - - - -
uint — - A 32-bit unsigned integer between 0 and 4294967295. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readUnsignedShort()method 
-
-public function readUnsignedShort():uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads an unsigned 16-bit integer from the byte stream. - - -

The returned value is in the range 0 to 65535.

- -

-Returns - - - - -
uint — - A 16-bit unsigned integer between 0 and 65535. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readUTF()method 
-
-public function readUTF():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads a UTF-8 string from the byte stream. The string - - is assumed to be prefixed with an unsigned short indicating - - the length in bytes. - - - -

-Returns - - - - -
String — - UTF-8 encoded string. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-

-See also -

-
-flash.utils.IDataInput.readUTF() -
-
- - - - - -
readUTFBytes()method 
-
-public function readUTFBytes(length:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads a sequence of UTF-8 bytes specified by the length - - parameter from the byte stream and returns a string. - - -

Parameters - - - - -
length:uint — An unsigned short indicating the length of the UTF-8 bytes. - -
-

-Returns - - - - -
String — - A string composed of the UTF-8 bytes of the specified length. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
toBase64()method 
-
-public function toBase64():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Converts the byte array into a base64 string. The string will be - - encoded according to RFC 4648 section 4. - - -

-Returns - - - - -
String — - String A base64-encoded representation of this ByteArray object. - - - - -
-
- - - - - -
toHexString()method 
-
-public function toHexString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Converts the byte array into a hex string. The string will be encoded - - according to RFC 4648 section 8, i.e. a simple string having two hex - - characters representing each byte. - - -

-Returns - - - - -
String — - String A hex-encoded string respresentation of this ByteArray object. - - - - -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Converts the byte array to a string. - - If the data in the array begins with a Unicode byte order mark, the application will honor that mark - - when converting to a string. If System.useCodePage is set to true, the - - application will treat the data in the array as being in the current system code page when converting. - - -

-Returns - - - - -
String — - The string representation of the byte array. - - - - -
-
- - - - - -
uncompress()method 
-
-public function uncompress(algorithm:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Decompresses the byte array. For content running in Adobe AIR, you can specify - - a compression algorithm by passing a value (defined in the CompressionAlgorithm class) - - as the algorithm parameter. The byte array must have been compressed - - using the same algorithm. Flash Player supports only the - - default algorithm, zlib. - - -

After the call, the length property of the ByteArray is set to the new length. - - The position property is set to 0.

- - -

The zlib compressed data format is described at - - http://www.ietf.org/rfc/rfc1950.txt.

- - -

The deflate compression algorithm is described at - - http://www.ietf.org/rfc/rfc1951.txt.

- - -

In order to decode data compressed in a format that uses the deflate compression algorithm, - - such as data in gzip or zip format, it will not work to call - - uncompress(CompressionAlgorithm.DEFLATE) on - - a ByteArray containing the compression formation data. First, you must separate the metadata that is - - included as part of the compressed data format from the actual compressed data. For more - - information, see the compress() method description.

- - - Parameters - - - - -
algorithm:String — The compression algorithm to use when decompressing. This must be the - - same compression algorithm used to compress the data. Valid values are defined as - - constants in the CompressionAlgorithm class. The default is to use zlib format. This parameter - - is only recognized for content running in Adobe AIR. Flash Player - - supports only the default algorithm, zlib, and throws an exception if you attempt to pass - - a value for this parameter. - - -
-
-Throws - - - - -
Error — The data is not valid compressed data; it was not compressed with the - - same compression algorithm used to compress. - - -
-

-See also -

-
-compress() -
-flash.utils.CompressionAlgorithm -
-
- - - - - -
writeBase64()method 
-
-public function writeBase64(base64:String):uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Writes data into the byte array from a base64 string. The string should - - be encoded according to RFC 4648 section 4. - - -

Parameters - - - - -
base64:String — The base64-encoded string to write into the ByteArray. - -
-

-Returns - - - - -
uint — - uint The number of new bytes written from the string. - - - -
-
-Throws - - - - -
ArgumentError — If the input string is not in the expected format. - - -
-
- - - - - -
writeBoolean()method 
-
-public function writeBoolean(value:Boolean):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes a Boolean value. A single byte is written according to the value parameter, - - either 1 if true or 0 if false. - - -

Parameters - - - - -
value:Boolean — A Boolean value determining which byte is written. If the parameter is true, - - the method writes a 1; if false, the method writes a 0. - - -
-
- - - - - -
writeByte()method 
-
-public function writeByte(value:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes a byte to the byte stream. - -

The low 8 bits of the - - parameter are used. The high 24 bits are ignored.

- - - Parameters - - - - -
value:int — A 32-bit integer. The low 8 bits are written to the byte stream. - -
-
- - - - - -
writeBytes()method 
-
-public function writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes a sequence of length bytes from the - - specified byte array, bytes, - - starting offset(zero-based index) bytes - - into the byte stream. - - -

If the length parameter is omitted, the default - - length of 0 is used; the method writes the entire buffer starting at - - offset. - - If the offset parameter is also omitted, the entire buffer is - - written.

If offset or length - - is out of range, they are clamped to the beginning and end - - of the bytes array.

- - - Parameters - - - - - - - - - - - - - - - - -
bytes:ByteArray — The ByteArray object. - -
 
offset:uint (default = 0) — A zero-based index indicating the position into the array to begin writing. - -
 
length:uint (default = 0) — An unsigned integer indicating how far into the buffer to write. - -
-
- - - - - -
writeDouble()method 
-
-public function writeDouble(value:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes an IEEE 754 double-precision (64-bit) floating-point number to the byte stream. - - -

Parameters - - - - -
value:Number — A double-precision (64-bit) floating-point number. - -
-
- - - - - -
writeFloat()method 
-
-public function writeFloat(value:Number):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes an IEEE 754 single-precision (32-bit) floating-point number to the byte stream. - - -

Parameters - - - - -
value:Number — A single-precision (32-bit) floating-point number. - -
-
- - - - - -
writeHexString()method 
-
-public function writeHexString(hex:String):uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Writes data into the byte array from a hex string. - - Note the hex string should be encoded according to RFC 4648 section 8, - - i.e. a simple string having two hex characters representing each byte. - - For example 0A23EF would represent a three-byte array with - - values 10, 35, and 239. - - -

Parameters - - - - -
hex:String — The hex-encoded string to write into the ByteArray. - -
-

-Returns - - - - -
uint — - uint The number of new bytes written from the string. - - - -
-
-Throws - - - - -
ArgumentError — If the input string is not in the expected format. - - -
-
- - - - - -
writeInt()method 
-
-public function writeInt(value:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes a 32-bit signed integer to the byte stream. - - -

Parameters - - - - -
value:int — An integer to write to the byte stream. - -
-
- - - - - -
writeMultiByte()method 
-
-public function writeMultiByte(value:String, charSet:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes a multibyte string to the byte stream using the specified character set. - - -

Parameters - - - - - - - - - - -
value:String — The string value to be written. - -
 
charSet:String — The string denoting the character set to use. Possible character set strings - - include "shift-jis", "cn-gb", "iso-8859-1", and others. - - For a complete list, see Supported Character Sets. - -
-
- - - - - -
writeObject()method 
-
-public function writeObject(object:*):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes an object into the byte array in AMF - - serialized format. - - -

Parameters - - - - -
object:* — The object to serialize. - - -
-

-See also -

-
-flash.net.registerClassAlias() -
-
- - - - - -
writeRandomBytes()method 
-
-public function writeRandomBytes():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51 - -
-

- - Writes random data into the byte array. This is intended so that an existing byte array - - that contains sensitive data can be wiped so that it is no longer visible in any memory - - dumps that are created by a user. Data is written based on the current length of the - - byte array object: for security, please do not change the length of a byte array that - - contains sensitive data prior to using this function as new memory will then be allocated - - and the old memory that contains the sensitive information could remain intact for a while. - - -

- - - - - -
writeShort()method 
-
-public function writeShort(value:int):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes a 16-bit integer to the byte stream. The low 16 bits of the parameter are used. - - The high 16 bits are ignored. - - -

Parameters - - - - -
value:int — 32-bit integer, whose low 16 bits are written to the byte stream. - -
-
- - - - - -
writeUnsignedInt()method 
-
-public function writeUnsignedInt(value:uint):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes a 32-bit unsigned integer to the byte stream. - - -

Parameters - - - - -
value:uint — An unsigned integer to write to the byte stream. - -
-
- - - - - -
writeUTF()method 
-
-public function writeUTF(value:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes a UTF-8 string to the byte stream. The length of the UTF-8 string in bytes - - is written first, as a 16-bit integer, followed by the bytes representing the - - characters of the string. - - -

Parameters - - - - -
value:String — The string value to be written. - -
-
-Throws - - - - -
RangeError — If the length is larger than - - 65535. - - -
-
- - - - - -
writeUTFBytes()method 
-
-public function writeUTFBytes(value:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes a UTF-8 string to the byte stream. Similar to the writeUTF() method, - - but writeUTFBytes() does not prefix the string with a 16-bit length word. - - -

Parameters - - - - -
value:String — The string value to be written. - -
-
- -
Examples
-
examples\ByteArrayExample
-
The following example uses the class ByteArrayExample to write a Boolean - and the double-precision floating-point representation of pi to a byte array. This is accomplished - using the following steps: -
    -
  1. Declare a new ByteArray object instance byteArr.
    2. -
  2. Write the byte-equivalent value of the Boolean false and then check the length and - read it back.
    3. -
  3. Write the double-precision floating-point equivalent of the mathematical value of pi.
    4. -
  4. Read back each of the nine bytes written into the byte array.
    5. -
- -

Note: when trace() is called on a byte, it prints the decimal equivalent - of the bytes stored in the byte array.

- -

Notice how a code segment is added at the end to check for end of file errors to ensure that - the byte stream is not read past its end.

-
-
-package {
-	import flash.display.Sprite;
-	import flash.utils.ByteArray;
-	import flash.errors.EOFError;
-
-	public class ByteArrayExample extends Sprite {		
-		public function ByteArrayExample() {
-			var byteArr:ByteArray = new ByteArray();
-
-			byteArr.writeBoolean(false);
-			trace(byteArr.length);			// 1
-			trace(byteArr[0]);			// 0
-
-			byteArr.writeDouble(Math.PI);
-			trace(byteArr.length);			// 9
-			trace(byteArr[0]);			// 0
-			trace(byteArr[1]);			// 64
-			trace(byteArr[2]);			// 9
-			trace(byteArr[3]);			// 33
-			trace(byteArr[4]);			// 251
-			trace(byteArr[5]);			// 84
-			trace(byteArr[6]);			// 68
-			trace(byteArr[7]);			// 45
-			trace(byteArr[8]);			// 24
-			
-			byteArr.position = 0;
-
-            try {
-                trace(byteArr.readBoolean() == false); // true
-            } 
-            catch(e:EOFError) {
-                trace(e);           // EOFError: Error #2030: End of file was encountered.
-            }
-            
-            try {
-			    trace(byteArr.readDouble());		// 3.141592653589793
-			}
-            catch(e:EOFError) {
-                trace(e);           // EOFError: Error #2030: End of file was encountered.
-            }
-            
-			try {
-				trace(byteArr.readDouble());
-			} 
-			catch(e:EOFError) {
-				trace(e);			// EOFError: Error #2030: End of file was encountered.
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/utils/CompressionAlgorithm.html b/html-docs/flash/utils/CompressionAlgorithm.html deleted file mode 100644 index 3e904a9..0000000 --- a/html-docs/flash/utils/CompressionAlgorithm.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - - - -flash.utils.CompressionAlgorithm (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.utils
Classpublic final class CompressionAlgorithm
InheritanceCompressionAlgorithm Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0 - -
-

-

- - The CompressionAlgorithm class defines string constants for the names of compress and uncompress options. These constants - - are used as values of the algorithm parameter of the ByteArray.compress() - - and ByteArray.uncompress() methods. - - -

-

-See also -

-
-flash.utils.ByteArray.compress() -
-flash.utils.ByteArray.uncompress() -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - - - - -
 ConstantDefined by
  DEFLATE : String = "deflate"
[static] - - Defines the string to use for the deflate compression algorithm.
-		CompressionAlgorithm
  LZMA : String = "lzma"
[static] - - Defines the string to use for the lzma compression algorithm.
-		CompressionAlgorithm
  ZLIB : String = "zlib"
[static] - - Defines the string to use for the zlib compression algorithm.
-		CompressionAlgorithm
-
- -
- -
Constant detail
- - - - - -
DEFLATEconstant
-
-public static const DEFLATE:String = "deflate" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Defines the string to use for the deflate compression algorithm. - - -

- - - - - -
LZMAconstant 
-
-public static const LZMA:String = "lzma" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 3.4 - -
-

- - Defines the string to use for the lzma compression algorithm. - - -

- - - - - -
ZLIBconstant 
-
-public static const ZLIB:String = "zlib" -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Defines the string to use for the zlib compression algorithm. - - -

-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/utils/Dictionary.html b/html-docs/flash/utils/Dictionary.html deleted file mode 100644 index 8fb0e0f..0000000 --- a/html-docs/flash/utils/Dictionary.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - - - -flash.utils.Dictionary (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.utils
Classpublic dynamic class Dictionary
InheritanceDictionary Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- - The Dictionary class lets you create a dynamic collection of properties, which uses strict equality - - (===) for key comparison. When an object is used as a key, the object's - - identity is used to look up the object, and not the value returned from calling toString() on it. - -

The following statements show the relationship between a Dictionary object and a key object:

- - 
-
- var dict = new Dictionary();
-
- var obj = new Object();
-
- var key:Object = new Object();
-
- key.toString = function() { return "key" }
-
- 
- dict[key] = "Letters";
-
- obj["key"] = "Letters";
-
- 
- dict[key] == "Letters"; // true
-
- obj["key"] == "Letters"; // true
-
- obj[key] == "Letters"; // true because key == "key" is true b/c key.toString == "key"
-
- dict["key"] == "Letters"; // false because "key" === key is false
-
- delete dict[key]; //removes the key
-
-
- - -

-

-See also -

-
-=== (strict equality) -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Dictionary(weakKeys:Boolean = false)
-
- - Creates a new Dictionary object.
-		Dictionary
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Constructor detail
- - - - - -
Dictionary()constructor
-
-public function Dictionary(weakKeys:Boolean = false) -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates a new Dictionary object. To remove a key from a Dictionary object, use the delete operator. - - -

Parameters - - - - -
weakKeys:Boolean (default = false) — Instructs the Dictionary object to use "weak" references on object keys. - - If the only reference to an object is in the specified Dictionary object, the key is eligible for - - garbage collection and is removed from the table when the object is collected. - - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/utils/Endian.html b/html-docs/flash/utils/Endian.html deleted file mode 100644 index f5deefa..0000000 --- a/html-docs/flash/utils/Endian.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - - - -flash.utils.Endian (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.utils
Classpublic final class Endian
InheritanceEndian Inheritance Object
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The Endian class contains values that denote the byte order used to represent multibyte - numbers. The byte order is either bigEndian (most significant byte first) or littleEndian (least - significant byte first). - -

Content in Flash Player or Adobe® - AIR™ can interface with a server by using the binary protocol of that - server, directly. Some servers use the bigEndian byte order and some servers use the - littleEndian byte order. Most servers on the Internet use the bigEndian byte order - because "network byte order" is bigEndian. The littleEndian byte order is - popular because the Intel x86 architecture uses it. Use the endian byte order that - matches the protocol of the server that is sending or receiving data.

- -

-

-See also -

-
-flash.utils.ByteArray.endian -
-flash.filesystem.FileStream.endian -
-flash.utils.IDataInput.endian -
-flash.utils.IDataOutput.endian -
-flash.net.Socket.endian -
-flash.net.URLStream.endian -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  BIG_ENDIAN : String = "bigEndian"
[static] - Indicates the most significant byte of the multibyte number appears first in the sequence of bytes.
-		Endian
  LITTLE_ENDIAN : String = "littleEndian"
[static] - Indicates the least significant byte of the multibyte number appears first in the sequence of bytes.
-		Endian
-
- -
- -
Constant detail
- - - - - -
BIG_ENDIANconstant
-
-public static const BIG_ENDIAN:String = "bigEndian" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates the most significant byte of the multibyte number appears first in the sequence of bytes. -

The hexadecimal number 0x12345678 has 4 bytes (2 hexadecimal digits per byte). - The most significant byte is 0x12. The least significant byte is 0x78. (For the equivalent - decimal number, 305419896, the most significant digit is 3, and the least significant digit - is 6).

-

A stream using the bigEndian byte order (the most significant byte first) - writes:

- 
-	 12 34 56 78
-
-
- - - - - -
LITTLE_ENDIANconstant 
-
-public static const LITTLE_ENDIAN:String = "littleEndian" -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates the least significant byte of the multibyte number appears first in the sequence of bytes. -

The hexadecimal number 0x12345678 has 4 bytes (2 hexadecimal digits per byte). - The most significant byte is 0x12. The least significant byte is 0x78. (For the equivalent - decimal number, 305419896, the most significant digit is 3, and the least significant digit - is 6).

-

A stream using the littleEndian byte order (the least significant byte - first) writes:

- 
-	 78 56 34 12
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/utils/IDataInput.html b/html-docs/flash/utils/IDataInput.html deleted file mode 100644 index f1d9987..0000000 --- a/html-docs/flash/utils/IDataInput.html +++ /dev/null @@ -1,1295 +0,0 @@ - - - - - - - - -flash.utils.IDataInput (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.utils
Interfacepublic interface IDataInput
ImplementorsByteArray, FileStream, Socket, URLStream
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- -The IDataInput interface provides a set of methods for reading binary data. - -This interface is the I/O counterpart to the IDataOutput interface, which - -writes binary data. - -

All IDataInput and IDataOutput operations are "bigEndian" by default (the most significant - -byte in the sequence is stored at the lowest or first storage address), - -and are nonblocking. - -If insufficient data is available, an EOFError exception - -is thrown. Use the IDataInput.bytesAvailable property to determine - -how much data is available to read.

- - -

Sign extension matters only when you read data, not when you write it. Therefore you do not need separate - -write methods to work with IDataInput.readUnsignedByte() and - -IDataInput.readUnsignedShort(). In other words:

- -
  • Use IDataOutput.writeByte() with IDataInput.readUnsignedByte() and - -IDataInput.readByte().
    • - -
  • Use IDataOutput.writeShort() with IDataInput.readUnsignedShort() and - -IDataInput.readShort().
- - -

-

-View the examples. -

-

-See also -

-
-IDataOutput interface -
-endian -
-FileStream class -
-Socket class -
-URLStream class -
-ByteArray class -
EOFError class
-
-
-
- -
-
Public Properties
- - - - - - - - - - - - - -
 PropertyDefined by
  bytesAvailable : uint -
[read-only] - - Returns the number of bytes of data available for reading - - in the input buffer.
-		IDataInput
  endian : String -
- - The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN constant - - from the Endian class.
-		IDataInput
  objectEncoding : uint -
- - Used to determine whether the AMF3 or AMF0 format is used when writing or reading binary data using the - - readObject() method.
-		IDataInput
-
- -
-
Public Methods
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-readBoolean():Boolean -
-
- - Reads a Boolean value from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readByte():int -
-
- - Reads a signed byte from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- - Reads the number of data bytes, specified by the length parameter, - - from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readDouble():Number -
-
- - Reads an IEEE 754 double-precision floating point number from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readFloat():Number -
-
- - Reads an IEEE 754 single-precision floating point number from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readInt():int -
-
- - Reads a signed 32-bit integer from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readMultiByte(length:uint, charSet:String):String -
-
- - Reads a multibyte string of specified length from the file stream, byte stream, or byte array using the - - specified character set.
-		IDataInput
   -
-readObject():* -
-
- - Reads an object from the file stream, byte stream, or byte array, encoded in AMF - - serialized format.
-		IDataInput
   -
-readShort():int -
-
- - Reads a signed 16-bit integer from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readUnsignedByte():uint -
-
- - Reads an unsigned byte from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readUnsignedInt():uint -
-
- - Reads an unsigned 32-bit integer from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readUnsignedShort():uint -
-
- - Reads an unsigned 16-bit integer from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readUTF():String -
-
- - Reads a UTF-8 string from the file stream, byte stream, or byte array.
-		IDataInput
   -
-readUTFBytes(length:uint):String -
-
- - Reads a sequence of UTF-8 bytes from the byte stream or byte array and returns a string.
-		IDataInput
-
- -
- -
Property detail
- - - - - -
bytesAvailableproperty
-
-bytesAvailable:uint  [read-only]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the number of bytes of data available for reading - - in the input buffer. - - User code must call bytesAvailable to ensure - - that sufficient data is available before trying to read - - it with one of the read methods. - -

Implementation -
-    public function get bytesAvailable():uint -
-
- - - - - -
endianproperty 
-
-endian:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN constant - - from the Endian class. - - -

Implementation -
-    public function get endian():String -
-    public function set endian(value:String):void -
-

-See also -

-
-Endian class -
-
- - - - - -
objectEncodingproperty 
-
-objectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Used to determine whether the AMF3 or AMF0 format is used when writing or reading binary data using the - - readObject() method. The value is a constant from the ObjectEncoding class. - - -

Implementation -
-    public function get objectEncoding():uint -
-    public function set objectEncoding(value:uint):void -
-

-See also -

-
-readObject() -
-IDataOutput.writeObject() -
-ObjectEncoding class -
-
- -
Method detail
- - - - - -
readBoolean()method
-
-public function readBoolean():Boolean -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads a Boolean value from the file stream, byte stream, or byte array. A single byte is read - - and true is returned if the byte is nonzero, - - false otherwise. - -

-Returns - - - - -
Boolean — - A Boolean value, true if the byte is nonzero, - - false otherwise. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readByte()method 
-
-public function readByte():int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads a signed byte from the file stream, byte stream, or byte array. - -

-Returns - - - - -
int — - The returned value is in the range -128 to 127. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readBytes()method 
-
-public function readBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads the number of data bytes, specified by the length parameter, - - from the file stream, byte stream, or byte array. The bytes are read into the - - ByteArray objected specified by the bytes parameter, starting at - - the position specified by offset. - -

Parameters - - - - - - - - - - - - - - - - -
bytes:ByteArray — The ByteArray object to read - - data into. - -
 
offset:uint (default = 0) — The offset into the bytes parameter at which data - - read should begin. - -
 
length:uint (default = 0) — The number of bytes to read. The default value - - of 0 causes all available data to be read. - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readDouble()method 
-
-public function readDouble():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads an IEEE 754 double-precision floating point number from the file stream, byte stream, or byte array. - -

-Returns - - - - -
Number — - An IEEE 754 double-precision floating point number. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readFloat()method 
-
-public function readFloat():Number -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads an IEEE 754 single-precision floating point number from the file stream, byte stream, or byte array. - -

-Returns - - - - -
Number — - An IEEE 754 single-precision floating point number. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readInt()method 
-
-public function readInt():int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads a signed 32-bit integer from the file stream, byte stream, or byte array. - -

-Returns - - - - -
int — - The returned value is in the range -2147483648 to 2147483647. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readMultiByte()method 
-
-public function readMultiByte(length:uint, charSet:String):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Reads a multibyte string of specified length from the file stream, byte stream, or byte array using the - - specified character set. - - - -

Parameters - - - - - - - - - - -
length:uint — The number of bytes from the byte stream to read. - -
 
charSet:String — The string denoting the character set to use to interpret the bytes. - - Possible character set strings include "shift-jis", "cn-gb", - - "iso-8859-1", and others. - - For a complete list, see Supported Character Sets. - - -

Note: If the value for the charSet parameter is not recognized by the current - - system, then Adobe® Flash® Player or - - Adobe® AIR® uses the system's default - - code page as the character set. For example, a value for the charSet parameter, as in - - myTest.readMultiByte(22, "iso-8859-01"), that uses 01 instead of - - 1 might work on your development system, but not on another system. On the other - - system, Flash Player or the AIR runtime will use the system's - - default code page.

- - -
-

-Returns - - - - -
String — - UTF-8 encoded string. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readObject()method 
-
-public function readObject():* -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads an object from the file stream, byte stream, or byte array, encoded in AMF - - serialized format. - -

-Returns - - - - -
* — The deserialized object - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-

-See also -

-
-objectEncoding -
-flash.net.registerClassAlias() -
-
- - - - - -
readShort()method 
-
-public function readShort():int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads a signed 16-bit integer from the file stream, byte stream, or byte array. - -

-Returns - - - - -
int — - The returned value is in the range -32768 to 32767. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readUnsignedByte()method 
-
-public function readUnsignedByte():uint -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads an unsigned byte from the file stream, byte stream, or byte array. - -

-Returns - - - - -
uint — - The returned value is in the range 0 to 255. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readUnsignedInt()method 
-
-public function readUnsignedInt():uint -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads an unsigned 32-bit integer from the file stream, byte stream, or byte array. - -

-Returns - - - - -
uint — - The returned value is in the range 0 to 4294967295. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readUnsignedShort()method 
-
-public function readUnsignedShort():uint -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads an unsigned 16-bit integer from the file stream, byte stream, or byte array. - -

-Returns - - - - -
uint — - The returned value is in the range 0 to 65535. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readUTF()method 
-
-public function readUTF():String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads a UTF-8 string from the file stream, byte stream, or byte array. The string - - is assumed to be prefixed with an unsigned short indicating - - the length in bytes. - - -

This method is similar to the readUTF() - - method in the Java® IDataInput interface.

- -

-Returns - - - - -
String — - A UTF-8 string produced by the byte representation of characters. - - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- - - - - -
readUTFBytes()method 
-
-public function readUTFBytes(length:uint):String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Reads a sequence of UTF-8 bytes from the byte stream or byte array and returns a string. - -

Parameters - - - - -
length:uint — The number of bytes to read. - -
-

-Returns - - - - -
String — - A UTF-8 string produced by the byte representation of characters of the specified length. - - - -
-
-Throws - - - - -
Error — There is not sufficient data available - - to read. - -
-
- -
Examples
-
examples\DataInputExample
-
The following example uses the class DataInputExample to write a boolean - and the double-precision floating-point representation of pi to a byte array. This is accomplished - using the following steps: -
    -
  1. Declare a new ByteArray object instance byteArr.
    2. -
  2. Write the byte-equivalent value of the Boolean false and the double-precision - floating-point equivalent of the mathematical value of pi.
    3. -
  3. Read back the boolean and double-precision floating-point number.
    4. -
- -

Notice how a code segment is added at the end to check for end of file errors to ensure that - the byte stream is not read past its end.

-
-
-package {
-	import flash.display.Sprite;
-	import flash.utils.ByteArray;
-	import flash.errors.EOFError;
-
-	public class DataInputExample extends Sprite {		
-		public function DataInputExample() {
-			var byteArr:ByteArray = new ByteArray();
-
-			byteArr.writeBoolean(false);
-			byteArr.writeDouble(Math.PI);
-			
-			byteArr.position = 0;
-
-            try {
-                trace(byteArr.readBoolean()); // false
-            } 
-            catch(e:EOFError) {
-                trace(e);           // EOFError: Error #2030: End of file was encountered.
-            }
-            
-            try {
-			    trace(byteArr.readDouble());	// 3.141592653589793
-            } 
-            catch(e:EOFError) {
-                trace(e);           // EOFError: Error #2030: End of file was encountered.
-            }
-            
-			try {
-				trace(byteArr.readDouble());
-			} 
-			catch(e:EOFError) {
-				trace(e);		// EOFError: Error #2030: End of file was encountered.
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/utils/IDataOutput.html b/html-docs/flash/utils/IDataOutput.html deleted file mode 100644 index 8cc2c30..0000000 --- a/html-docs/flash/utils/IDataOutput.html +++ /dev/null @@ -1,963 +0,0 @@ - - - - - - - - -flash.utils.IDataOutput (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.utils
Interfacepublic interface IDataOutput
ImplementorsByteArray, Digest, FileStream, Socket
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- -The IDataOutput interface provides a set of methods for writing binary data. - -This interface is the I/O counterpart to the IDataInput interface, which - -reads binary data. The IDataOutput interface is implemented by the FileStream, Socket - -and ByteArray classes. - -

All IDataInput and IDataOutput operations are "bigEndian" by default (the most significant - -byte in the sequence is stored at the lowest or first storage address), - -and are nonblocking.

- -

Sign extension matters only when you read data, not when you write it. Therefore, you do not need separate - -write methods to work with IDataInput.readUnsignedByte() and - -IDataInput.readUnsignedShort(). In other words:

- -
    - -
  • Use IDataOutput.writeByte() with IDataInput.readUnsignedByte() and - - IDataInput.readByte().
    • - -
  • Use IDataOutput.writeShort() with IDataInput.readUnsignedShort() and - - IDataInput.readShort().
    • - -
- - -

-

-View the examples. -

-

-See also -

-
-IDataInput interface -
-endian -
-FileStream class -
-Socket class -
-URLStream class -
-ByteArray class -
-
-
-
- -
-
Public Properties
- - - - - - - - - - -
 PropertyDefined by
  endian : String -
- - The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN - - constant from the Endian class.
-		IDataOutput
  objectEncoding : uint -
- - Used to determine whether the AMF3 or AMF0 format is used when writing or reading binary data using the - - writeObject() method.
-		IDataOutput
-
- -
-
Public Methods
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-writeBoolean(value:Boolean):void -
-
- - Writes a Boolean value.
-		IDataOutput
   -
-writeByte(value:int):void -
-
- - Writes a byte.
-		IDataOutput
   -
-writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -
-
- - Writes a sequence of bytes from the - - specified byte array, bytes, - - starting at the byte specified by offset - - (using a zero-based index) - - with a length specified by length, - - into the file stream, byte stream, or byte array.
-		IDataOutput
   -
-writeDouble(value:Number):void -
-
- - Writes an IEEE 754 double-precision (64-bit) floating point number.
-		IDataOutput
   -
-writeFloat(value:Number):void -
-
- - Writes an IEEE 754 single-precision (32-bit) floating point number.
-		IDataOutput
   -
-writeInt(value:int):void -
-
- - Writes a 32-bit signed integer.
-		IDataOutput
   -
-writeMultiByte(value:String, charSet:String):void -
-
- - Writes a multibyte string to the file stream, byte stream, or byte array, using the specified character set.
-		IDataOutput
   -
-writeObject(object:*):void -
-
- - Writes an object to the file stream, byte stream, or byte array, in AMF serialized - - format.
-		IDataOutput
   -
-writeShort(value:int):void -
-
- - Writes a 16-bit integer.
-		IDataOutput
   -
-writeUnsignedInt(value:uint):void -
-
- - Writes a 32-bit unsigned integer.
-		IDataOutput
   -
-writeUTF(value:String):void -
-
- - Writes a UTF-8 string to the file stream, byte stream, or byte array.
-		IDataOutput
   -
-writeUTFBytes(value:String):void -
-
- - Writes a UTF-8 string.
-		IDataOutput
-
- -
- -
Property detail
- - - - - -
endianproperty
-
-endian:String  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN - - constant from the Endian class. - - -

Implementation -
-    public function get endian():String -
-    public function set endian(value:String):void -
-

-See also -

-
-Endian class -
-
- - - - - -
objectEncodingproperty 
-
-objectEncoding:uint  [read-write]

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Used to determine whether the AMF3 or AMF0 format is used when writing or reading binary data using the - - writeObject() method. The value is a constant from the ObjectEncoding class. - - -

Implementation -
-    public function get objectEncoding():uint -
-    public function set objectEncoding(value:uint):void -
-

-See also -

-
-IDataInput.readObject() -
-writeObject() -
-ObjectEncoding class -
-
- -
Method detail
- - - - - -
writeBoolean()method
-
-public function writeBoolean(value:Boolean):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes a Boolean value. A single byte is written according to the value parameter, - - either 1 if true or 0 if false. - - -

Parameters - - - - -
value:Boolean — A Boolean value determining which byte is written. If the parameter is true, - - 1 is written; if false, 0 is written. - - -
-
- - - - - -
writeByte()method 
-
-public function writeByte(value:int):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes a byte. - - The low 8 bits of the - - parameter are used; the high 24 bits are ignored. - -

Parameters - - - - -
value:int — A byte value as an integer. - - -
-
- - - - - -
writeBytes()method 
-
-public function writeBytes(bytes:ByteArray, offset:uint = 0, length:uint = 0):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes a sequence of bytes from the - - specified byte array, bytes, - - starting at the byte specified by offset - - (using a zero-based index) - - with a length specified by length, - - into the file stream, byte stream, or byte array. - - -

If the length parameter is omitted, the default - - length of 0 is used and the entire buffer starting at - - offset is written. - - If the offset parameter is also omitted, the entire buffer is - - written.

- - -

If the offset or length parameter - - is out of range, they are clamped to the beginning and end - - of the bytes array.

- - Parameters - - - - - - - - - - - - - - - - -
bytes:ByteArray — The byte array to write. - -
 
offset:uint (default = 0) — A zero-based index specifying the position into the array to begin writing. - -
 
length:uint (default = 0) — An unsigned integer specifying how far into the buffer to write. - - -
-
- - - - - -
writeDouble()method 
-
-public function writeDouble(value:Number):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes an IEEE 754 double-precision (64-bit) floating point number. - -

Parameters - - - - -
value:Number — A double-precision (64-bit) floating point number. - - -
-
- - - - - -
writeFloat()method 
-
-public function writeFloat(value:Number):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes an IEEE 754 single-precision (32-bit) floating point number. - -

Parameters - - - - -
value:Number — A single-precision (32-bit) floating point number. - - -
-
- - - - - -
writeInt()method 
-
-public function writeInt(value:int):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes a 32-bit signed integer. - -

Parameters - - - - -
value:int — A byte value as a signed integer. - - -
-
- - - - - -
writeMultiByte()method 
-
-public function writeMultiByte(value:String, charSet:String):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Writes a multibyte string to the file stream, byte stream, or byte array, using the specified character set. - - -

Parameters - - - - - - - - - - -
value:String — The string value to be written. - -
 
charSet:String — The string denoting the character set to use. Possible character set strings - - include "shift-jis", "cn-gb", "iso-8859-1", and others. - - For a complete list, see Supported Character Sets. - -
-
- - - - - -
writeObject()method 
-
-public function writeObject(object:*):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes an object to the file stream, byte stream, or byte array, in AMF serialized - - format. - -

Parameters - - - - -
object:* — The object to be serialized. - - -
-

-See also -

-
-objectEncoding -
-flash.net.registerClassAlias() -
-
- - - - - -
writeShort()method 
-
-public function writeShort(value:int):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes a 16-bit integer. The low 16 bits of the parameter are used; - - the high 16 bits are ignored. - -

Parameters - - - - -
value:int — A byte value as an integer. - - -
-
- - - - - -
writeUnsignedInt()method 
-
-public function writeUnsignedInt(value:uint):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes a 32-bit unsigned integer. - -

Parameters - - - - -
value:uint — A byte value as an unsigned integer. - - -
-
- - - - - -
writeUTF()method 
-
-public function writeUTF(value:String):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes a UTF-8 string to the file stream, byte stream, or byte array. The length of the UTF-8 string in bytes - - is written first, as a 16-bit integer, followed by the bytes representing the - - characters of the string. - -

Parameters - - - - -
value:String — The string value to be written. - - -
-
-Throws - - - - -
RangeError — If the length is larger than - - 65535. - - -
-
- - - - - -
writeUTFBytes()method 
-
-public function writeUTFBytes(value:String):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Writes a UTF-8 string. Similar to writeUTF(), - - but does not prefix the string with a 16-bit length word. - -

Parameters - - - - -
value:String — The string value to be written. - - -
-
- -
Examples
-
examples\DataOutputExample
-
The following example uses the class DataOutputExample to write a boolean - and the double-precision floating-point representation of pi to a byte array. This is accomplished - using the following steps: -
    -
  1. Declare a new ByteArray object instance byteArr.
    2. -
  2. Write the byte-equivalent value of the Boolean false and the double-precision - floating-point equivalent of the mathematical value of pi.
    3. -
  3. Read back the boolean and double-precision floating-point number.
    4. -
- -

Notice how a code segment is added at the end to check for end of file errors to ensure that - the byte stream is not read past its end.

-
-
-package {
-	import flash.display.Sprite;
-	import flash.utils.ByteArray;
-	import flash.errors.EOFError;
-
-	public class DataOutputExample extends Sprite {		
-		public function DataOutputExample() {
-			var byteArr:ByteArray = new ByteArray();
-
-			byteArr.writeBoolean(false);
-			byteArr.writeDouble(Math.PI);
-			
-			byteArr.position = 0;
-
-            try {
-                trace(byteArr.readBoolean()); // false
-            } 
-            catch(e:EOFError) {
-                trace(e);           // EOFError: Error #2030: End of file was encountered.
-            }
-                        
-            try {
-                trace(byteArr.readDouble());    // 3.141592653589793
-            } 
-            catch(e:EOFError) {
-                trace(e);           // EOFError: Error #2030: End of file was encountered.
-            }
-            
-			try {
-				trace(byteArr.readDouble());
-			} 
-			catch(e:EOFError) {
-				trace(e);		// EOFError: Error #2030: End of file was encountered.
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/utils/IExternalizable.html b/html-docs/flash/utils/IExternalizable.html deleted file mode 100644 index 02a5f5e..0000000 --- a/html-docs/flash/utils/IExternalizable.html +++ /dev/null @@ -1,406 +0,0 @@ - - - - - - - - -flash.utils.IExternalizable (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - -
Packageflash.utils
Interfacepublic interface IExternalizable
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - The IExternalizable interface provides control over serialization of a class as it is encoded - - into a data stream. The writeExternal() and - - readExternal() methods of the IExternalizable interface are implemented by a class to allow customization - - of the contents and format of the data stream (but not the classname or type) for an object and its supertypes. - - Each individual class must serialize and reconstruct the state of its instances. These methods must be symmetrical with - - the supertype to save its state. These methods supercede the native Action Message Format (AMF) serialization behavior. - -

If a class does not implement, nor inherits from a class which implements, the IExternalizable interface, then an instance - - of the class will be serialized using the default mechanism of public members only. As a result, private, internal, and - - protected members of a class will not be available.

- -

To serialize private members, a class must use the IExternalizable interface. - - For example, the following class will not serialize any of its members because they are private:

- - 
-
- class Example {
-
- 
-       private var one:int;
-
-       private var two:int;
-
- }
-
-
- -

However, if you implement the IExternalizable interface, you can write to, and read from, the data stream the private - - members of the class as follows:

- - 
-
- class Example implement IExternalizable {
-
- 
-       private var one:int;
-
-       private var two:int;
-
- 
-       public function writeExternal(output:IDataOutput) {
-
-            output.writeInt(one);
-
-            output.writeInt(two);
-
-       }
-
- 
-       public function readExternal(input:IDataInput) {
-
-            one = input.readInt();
-
-            two = input.readInt();
-
-       }
-
- }
-
-
- -

Note: If a class implements IExternalizable the default serialization no longer applies to instances - - of that class. If that class inherits public members from a super class, you must carefully manage those members as well.

- -

When a subclass of a class implementing IExternalizable has private members of its own, the subclass must override the - - methods of IExternalizable, as follows:

- - 
-
- public class Base implements IExternalizable {
-
- 
-      private var one:Boolean;
-
- 
-      public function writeExternal(output:IDataOutput):void {
-
-          output.writeBoolean(one);
-
-      }
-
- 
-      public function readExternal(input:IDataInput):void {
-
-          one = input.readBoolean();
-
-      }
-
- }
-
- 
- public class Example extends Base {
-
- 
-      private var one:String;
-
- 
- 
-      public override function writeExternal(output:IDataOutput):void {
-
-          super.writeExternal(output);
-
-          output.writeUTF(one);
-
-      }
-
- 
-      public override function readExternal(input:IDataInput):void {
-
-          super.readExternal(input);
-
-          one = input.readUTF();
-
-      }
-
- }
-
-
- -

The IExternalizable interface can also be used to compress data before writing it to a data stream. - - For example:

- - 
-
- class Example implements IExternalizable {
-
- 
-      public var one:Boolean;
-
-      public var two:Boolean;
-
-      public var three:Boolean;
-
-      public var four:Boolean;
-
-      public var five:Boolean;
-
-      public var six:Boolean;
-
-      public var seven:Boolean;
-
-      public var eight:Boolean;
-
- 
-      public function writeExternal(output:IDataOutput) {
-
-          var flag:int = 0;
-
- 
-          if (one) flag |= 1;
-
-          if (two) flag |= 2;
-
-          if (three) flag |= 4;
-
-          if (four) flag |= 8;
-
-          if (five) flag |= 16;
-
-          if (six) flag |= 32;
-
-          if (seven) flag |= 64;
-
-          if (eight) flag |= 128;
-
- 
-          output.writeByte(flag);
-
-      }
-
- 
-      public function readExternal(input:IDataInput) {
-
-          var flag:int = input.readByte();
-
- 
-          one = (flag & 1) != 0;
-
-          two = (flag & 2) != 0;
-
-          three = (flag & 4) != 0;
-
-          four = (flag & 8) != 0;
-
-          five = (flag & 16) != 0;
-
-          six = (flag & 32) != 0;
-
-          seven = (flag & 64) != 0;
-
-          eight = (flag & 128) != 0;
-
-      }
-
- }
-
-
- -

-

-See also -

-
-flash.net.ObjectEncoding -
-
-
-
- -
-
Public Methods
- - - - - - - - - - -
 MethodDefined by
   -
-readExternal(input:IDataInput):void -
-
- - A class implements this method to decode itself from a data stream by calling the methods of the IDataInput - - interface.
-		IExternalizable
   -
-writeExternal(output:IDataOutput):void -
-
- - A class implements this method to encode itself for a data stream by calling the methods of the IDataOutput - - interface.
-		IExternalizable
-
- -
- -
Method detail
- - - - - -
readExternal()method
-
-public function readExternal(input:IDataInput):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A class implements this method to decode itself from a data stream by calling the methods of the IDataInput - - interface. This method must read the values in the same sequence and with the same types as - - were written by the writeExternal() method. - -

Parameters - - - - -
input:IDataInput — The name of the class that implements the IDataInput interface. - -
-
- - - - - -
writeExternal()method 
-
-public function writeExternal(output:IDataOutput):void -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - A class implements this method to encode itself for a data stream by calling the methods of the IDataOutput - - interface. - -

Parameters - - - - -
output:IDataOutput — The name of the class that implements the IDataOutput interface. - -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/utils/Proxy.html b/html-docs/flash/utils/Proxy.html deleted file mode 100644 index 3dcfe03..0000000 --- a/html-docs/flash/utils/Proxy.html +++ /dev/null @@ -1,495 +0,0 @@ - - - - - - - - -flash.utils.Proxy (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.utils
Classpublic class Proxy
InheritanceProxy Inheritance Object
-

-

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Protected Methods
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-callProperty(name:*, ... rest):* -
-
-		Proxy
   -
-deleteProperty(name:*):Boolean -
-
-		Proxy
   -
-getDescendants(name:*):* -
-
-		Proxy
   -
-getProperty(name:*):* -
-
-		Proxy
   -
-hasProperty(name:*):Boolean -
-
-		Proxy
   -
-isAttribute(name:*):Boolean -
-
-		Proxy
   -
-nextName(index:int):String -
-
-		Proxy
   -
-nextNameIndex(index:int):int -
-
-		Proxy
   -
-nextValue(index:int):* -
-
-		Proxy
   -
-setProperty(name:*, value:*):void -
-
-		Proxy
-
- -
- -
Method detail
- - - - - -
callProperty()method
-
-flash_proxy function callProperty(name:*, ... rest):*Parameters - - - - - - - - - - -
name:*
 
... rest
-

-Returns - - - - -
*
-
- - - - - -
deleteProperty()method 
-
-flash_proxy function deleteProperty(name:*):BooleanParameters - - - - -
name:*
-

-Returns - - - - -
Boolean
-
- - - - - -
getDescendants()method 
-
-flash_proxy function getDescendants(name:*):*Parameters - - - - -
name:*
-

-Returns - - - - -
*
-
- - - - - -
getProperty()method 
-
-flash_proxy function getProperty(name:*):*Parameters - - - - -
name:*
-

-Returns - - - - -
*
-
- - - - - -
hasProperty()method 
-
-flash_proxy function hasProperty(name:*):BooleanParameters - - - - -
name:*
-

-Returns - - - - -
Boolean
-
- - - - - -
isAttribute()method 
-
-flash_proxy function isAttribute(name:*):BooleanParameters - - - - -
name:*
-

-Returns - - - - -
Boolean
-
- - - - - -
nextName()method 
-
-flash_proxy function nextName(index:int):StringParameters - - - - -
index:int
-

-Returns - - - - -
String
-
- - - - - -
nextNameIndex()method 
-
-flash_proxy function nextNameIndex(index:int):intParameters - - - - -
index:int
-

-Returns - - - - -
int
-
- - - - - -
nextValue()method 
-
-flash_proxy function nextValue(index:int):*Parameters - - - - -
index:int
-

-Returns - - - - -
*
-
- - - - - -
setProperty()method 
-
-flash_proxy function setProperty(name:*, value:*):voidParameters - - - - - - - - - - -
name:*
 
value:*
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/utils/Timer.html b/html-docs/flash/utils/Timer.html deleted file mode 100644 index 5f8b840..0000000 --- a/html-docs/flash/utils/Timer.html +++ /dev/null @@ -1,847 +0,0 @@ - - - - - - - - -flash.utils.Timer (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.utils
Classpublic class Timer
InheritanceTimer Inheritance EventDispatcher Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The Timer class is the interface to timers, which let you - run code on a specified time sequence. Use the start() method to start a timer. - Add an event listener for the timer event to set up code to be run on the timer interval. - -

You can create Timer objects to run once or repeat at specified intervals to execute code on a schedule. - - Depending on the SWF file's framerate or the runtime environment (available - memory and other factors), the runtime may dispatch events at slightly - offset intervals. For example, if a SWF file is set to play at 10 frames per second (fps), which is 100 millisecond - intervals, but your timer is set to fire an event at 80 milliseconds, the event will be dispatched close to the - 100 millisecond interval. - Applications may dispatch events at slightly - offset intervals based on the internal frame rate of the application. - Memory-intensive scripts may also offset the events.

- -

-

-View the examples. -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  currentCount : int -
[read-only] - The total number of times the timer has fired since it started - at zero.
-		Timer
  delay : Number -
- The delay, in milliseconds, between timer - events.
-		Timer
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  repeatCount : int -
- The total number of times the timer is set to run.
-		Timer
  running : Boolean -
[read-only] - The timer's current state; true if the timer is running, otherwise false.
-		Timer
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-Timer(delay:Number, repeatCount:int = 0)
-
- Constructs a new Timer object with the specified delay - and repeatCount states.
-		Timer
 Inherited -
-addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void -
-
- Registers an event listener object with an EventDispatcher object so that the listener - receives notification of an event.
-		EventDispatcher
 Inherited -
-dispatchEvent(event:Event):Boolean -
-
- Dispatches an event into the event flow.
-		EventDispatcher
 Inherited -
-hasEventListener(type:String):Boolean -
-
- Checks whether the EventDispatcher object has any listeners registered for a specific type - of event.
-		EventDispatcher
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void -
-
- Removes a listener from the EventDispatcher object.
-		EventDispatcher
   -
-reset():void -
-
- Stops the timer, if it is running, and sets the currentCount property back to 0, - like the reset button of a stopwatch.
-		Timer
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-start():void -
-
- Starts the timer, if it is not already running.
-		Timer
   -
-stop():void -
-
- Stops the timer.
-		Timer
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
 Inherited -
-willTrigger(type:String):Boolean -
-
- Checks whether an event listener is registered with this EventDispatcher object or any of - its ancestors for the specified event type.
-		EventDispatcher
-
- -
-
Events
-
- - -
- - - - - - - - - - - - - - - - -
 EventSummaryDefined by
 Inherited -
-activate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application gains - operating system focus and becomes active.EventDispatcher
 Inherited -
-deactivate -
-		 - [broadcast event] Dispatched when the Flash Player or AIR application operating - loses system focus and is becoming inactive.EventDispatcher
   -
-timer -
-		 - Dispatched whenever a Timer object reaches an interval specified according to the Timer.delay property.Timer
   -
-timerComplete -
-		 - Dispatched whenever it has completed the number of requests set by Timer.repeatCount.Timer
-
- -
- -
Property detail
- - - - - -
currentCountproperty
-
-currentCount:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The total number of times the timer has fired since it started - at zero. If the timer has been reset, only the fires since - the reset are counted. - -

Implementation -
-    public function get currentCount():int -
-
- - - - - -
delayproperty 
-
-delay:Number  [read-write]

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- The delay, in milliseconds, between timer - events. If you set the delay interval while - the timer is running, the timer will restart - at the same repeatCount iteration. -

Note: A delay lower than 20 milliseconds is not recommended. Timer frequency - is limited to 60 frames per second, meaning a delay lower than 16.6 milliseconds causes runtime problems.

- Implementation -
-    public function get delay():Number -
-    public function set delay(value:Number):void -
-
-Throws -
- - - - -
Error — Throws an exception if the delay specified is negative or not a finite number. - -
-
- - - - - -
repeatCountproperty 
-
-repeatCount:int  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The total number of times the timer is set to run. - If the repeat count is set to 0, the timer continues indefinitely, up to a maximum of 24.86 days, - or until the stop() method is invoked or the program stops. - If the repeat count is nonzero, the timer runs the specified number of times. - If repeatCount is set to a total that is the same or less then currentCount - the timer stops and will not fire again. - -

Implementation -
-    public function get repeatCount():int -
-    public function set repeatCount(value:int):void -
-
- - - - - -
runningproperty 
-
-running:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The timer's current state; true if the timer is running, otherwise false. - -

Implementation -
-    public function get running():Boolean -
-
- -
Constructor detail
- - - - - -
Timer()constructor
-
-public function Timer(delay:Number, repeatCount:int = 0) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Constructs a new Timer object with the specified delay - and repeatCount states. -

The timer does not start automatically; you must call the start() method - to start it.

- - Parameters - - - - - - - - - - -
delay:Number — The delay between timer events, in milliseconds. A delay lower than 20 milliseconds is not recommended. Timer frequency - is limited to 60 frames per second, meaning a delay lower than 16.6 milliseconds causes runtime problems. -
 
repeatCount:int (default = 0) — Specifies the number of repetitions. - If zero, the timer repeats indefinitely, up to a maximum of 24.86 days (int.MAX_VALUE + 1). - If nonzero, the timer runs the specified number of times and then stops. -
-
-Throws - - - - -
Error — if the delay specified is negative or not a finite number -
-
-Example -
In the following example, the user is given 90 seconds to enter - a response in an input text field. Also, every 30 seconds, a status - message lets the user know how many seconds are left. - -

A Timer object is created that starts in 30 seconds (delay is set to 30000 - milliseconds) and repeats three times, for a total of 90 seconds. (The timer - stops after the third time.)

- -

Two event listeners are added for the myTimer timer. The first is - triggered by the TimerEvent.TIMER event, which occurs every time - the timer is started. The timerHandler() method changes - the text for the statusTextField text field to reflect the seconds - remaining.

-

Note: The Timer class keeps track of the number of times it has to start - (repeats) by increasing the number in the currentCount property.)

- -

After the timer is called for the last time, the TimerEvent.TIMER_COMPLETE - event is dispatched and the completeHandler() method is called. - The completeHandler() method changes the type of the inputTextField text field - from INPUT to DYNAMIC, which means the user can no - longer enter or change text.

- -
-
-package {
-    import flash.display.Sprite;
-    import flash.text.TextField;
-    import flash.text.TextFieldType;
-    import flash.text.TextFieldAutoSize;
-    import flash.utils.Timer;
-    import flash.events.TimerEvent;
-    import flash.events.Event;
-
-    public class Timer_constructorExample extends Sprite {
-            private var statusTextField:TextField = new TextField();        
-            private var inputTextField:TextField = new TextField();
-            private var delay:uint = 30000;
-            private var repeat:uint = 3;
-            private var myTimer:Timer = new Timer(delay, repeat);
-            
-        public function Timer_constructorExample() {
-            inputTextField.x = 10;
-            inputTextField.y = 10;
-            inputTextField.border = true;
-            inputTextField.background = true;
-            inputTextField.height = 200;
-            inputTextField.width = 200;
-            inputTextField.multiline = true;
-            inputTextField.wordWrap = true;
-            inputTextField.type = TextFieldType.INPUT;
-
-            statusTextField.x = 10;
-            statusTextField.y = 220;
-            statusTextField.background = true;
-            statusTextField.autoSize = TextFieldAutoSize.LEFT;   
-
-            myTimer.start(); 
-            statusTextField.text = "You have " + ((delay * repeat) / 1000) 
-                                 + " seconds to enter your response.";
-
-            myTimer.addEventListener(TimerEvent.TIMER, timerHandler);
-            myTimer.addEventListener(TimerEvent.TIMER_COMPLETE, completeHandler);
-
-            addChild(inputTextField);
-            addChild(statusTextField);
-        }
-
-        private function timerHandler(e:TimerEvent):void{
-            repeat--;
-            statusTextField.text = ((delay * repeat) / 1000) + " seconds left.";
-        }
-
-        private function completeHandler(e:TimerEvent):void {
-            statusTextField.text = "Times Up.";
-            inputTextField.type = TextFieldType.DYNAMIC;    
-        }
-    }
-}
-
-

-
- -
Method detail
- - - - - -
reset()method
-
-public function reset():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Stops the timer, if it is running, and sets the currentCount property back to 0, - like the reset button of a stopwatch. Then, when start() is called, - the timer instance runs for the specified number of repetitions, - as set by the repeatCount value. - -

-See also -

-
-Timer.stop() -
-
- - - - - -
start()method 
-
-public function start():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Starts the timer, if it is not already running. - -

- - - - - -
stop()method 
-
-public function stop():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Stops the timer. When start() is called after stop(), the timer - instance runs for the remaining number of repetitions, as set by the repeatCount property. - -

-See also -

-
-Timer.reset() -
-
-
Event detail
- - - - - -
timerevent 
-
-Event object type: flash.events.TimerEvent -
-TimerEvent.type property = flash.events.TimerEvent.TIMER -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched whenever a Timer object reaches an interval specified according to the Timer.delay property. -

- Defines the value of the type property of a timer event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Timer object that has reached its interval.
-
- - - - - -
timerCompleteevent  
-
-Event object type: flash.events.TimerEvent -
-TimerEvent.type property = flash.events.TimerEvent.TIMER_COMPLETE -
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Dispatched whenever it has completed the number of requests set by Timer.repeatCount. -

- Defines the value of the type property of a timerComplete event object. -

This event has the following properties:

- - - - - - -
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event - object with an event listener.
targetThe Timer object that has completed its requests.
-
- -
Examples
-
examples\TimerExample
-
The following example uses the class TimerExample to show how a - listener method timerHandler() can be set to listen for a new TimerEvent - to be dispatched. The timer is started when start() is called, and after that point, - the timer events are dispatched. -
-
-package {
-    import flash.utils.Timer;
-	import flash.events.TimerEvent;
-	import flash.display.Sprite;
-
-	public class TimerExample extends Sprite {
-
-		public function TimerExample() {
-			var myTimer:Timer = new Timer(1000, 2);
-			myTimer.addEventListener("timer", timerHandler);
-			myTimer.start();
-		}
-
-		public function timerHandler(event:TimerEvent):void {
-			trace("timerHandler: " + event);
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/utils/package-detail.html b/html-docs/flash/utils/package-detail.html deleted file mode 100644 index 1fcc3da..0000000 --- a/html-docs/flash/utils/package-detail.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - - -flash.utils Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.utils package contains utility classes, such as data structures like ByteArray.

-
-
- -
Functions
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 FunctionDescription
 clearInterval - Cancels a specified setInterval() call.
 clearTimeout - Cancels a specified setTimeout() call.
 describeType - Produces an XML object that describes the ActionScript object named as the parameter of - the method.
 escapeMultiByte - Returns an escaped copy of the input string encoded as either UTF-8 or system code page, depending on the value of System.useCodePage.
 getDefinitionByName - Returns a reference to the class object of the class specified by the name parameter.
 getQualifiedClassName - Returns the fully qualified class name of an object.
 getQualifiedSuperclassName - Returns the fully qualified class name of the base class of the object specified by the value - parameter.
 getTimer - Used to compute relative time.
 setInterval - Runs a function at a specified interval (in milliseconds).
 setTimeout - Runs a specified function after a specified delay (in milliseconds).
 unescapeMultiByte - Returns an unescaped copy of the input string, which is decoded from either system code page page or UTF-8 depending on the value of System.useCodePage.
- -
Interfaces
- - - - - - - - - - - - - -
 InterfaceDescription
 IDataInput - -The IDataInput interface provides a set of methods for reading binary data.
 IDataOutput - -The IDataOutput interface provides a set of methods for writing binary data.
 IExternalizable - - The IExternalizable interface provides control over serialization of a class as it is encoded - - into a data stream.
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 ByteArray - - The ByteArray class provides methods and properties to optimize reading, writing, - - and working with binary data.
 CompressionAlgorithm - - The CompressionAlgorithm class defines string constants for the names of compress and uncompress options.
 Dictionary - - The Dictionary class lets you create a dynamic collection of properties, which uses strict equality - - (===) for key comparison.
 Endian - The Endian class contains values that denote the byte order used to represent multibyte - numbers.
 Proxy 
 Timer - The Timer class is the interface to timers, which let you - run code on a specified time sequence.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/flash/utils/package.html b/html-docs/flash/utils/package.html deleted file mode 100644 index 9d01adf..0000000 --- a/html-docs/flash/utils/package.html +++ /dev/null @@ -1,1023 +0,0 @@ - - - - - - - -flash.utils Details (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-The flash.utils package contains a variety of package-level functions for timing code execution, retrieving information about classes and objects, and converting escape characters.
-
Public Functions
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 FunctionDefined by
   -
-clearInterval(id:uint):void -
-
- Cancels a specified setInterval() call.
-		flash.utils
   -
-clearTimeout(id:uint):void -
-
- Cancels a specified setTimeout() call.
-		flash.utils
   -
-describeType(value:*):XML -
-
- Produces an XML object that describes the ActionScript object named as the parameter of - the method.
-		flash.utils
   -
-escapeMultiByte(value:String):String -
-
- Returns an escaped copy of the input string encoded as either UTF-8 or system code page, depending on the value of System.useCodePage.
-		flash.utils
   -
-getDefinitionByName(name:String):Object -
-
- Returns a reference to the class object of the class specified by the name parameter.
-		flash.utils
   -
-getQualifiedClassName(value:*):String -
-
- Returns the fully qualified class name of an object.
-		flash.utils
   -
-getQualifiedSuperclassName(value:*):String -
-
- Returns the fully qualified class name of the base class of the object specified by the value - parameter.
-		flash.utils
   -
-getTimer():int -
-
- Used to compute relative time.
-		flash.utils
   -
-setInterval(closure:Function, delay:Number, ... arguments):uint -
-
- Runs a function at a specified interval (in milliseconds).
-		flash.utils
   -
-setTimeout(closure:Function, delay:Number, ... arguments):uint -
-
- Runs a specified function after a specified delay (in milliseconds).
-		flash.utils
   -
-unescapeMultiByte(value:String):String -
-
- Returns an unescaped copy of the input string, which is decoded from either system code page page or UTF-8 depending on the value of System.useCodePage.
-		flash.utils
-
- -
Function detail
- - - - - -
clearInterval()function
-
-public function clearInterval(id:uint):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Cancels a specified setInterval() call. - -

Parameters - - - - -
id:uint — The ID of the setInterval() call, which you set to a variable, - as in the following: - -
-

-See also -

-
-setInterval() -
-
-Example -
The following example uses the setInterval() method to create a timed - interval, calling the myRepeatingFunction() method after regular intervals of one - second. - -

Each call of the myRepeatingFunction method increments the counter - property, and when it equals the stopCount property, the clearInterval() - method is called with the property intervalId which is a reference id to - the interval that was created earlier.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.utils.*;
-
-    public class ClearIntervalExample extends Sprite {
-		private var intervalDuration:Number = 1000; // duration between intervals, in milliseconds
-		private var intervalId:uint;
-		private var counter:uint 	= 0;
-		private var stopCount:uint 	= 3;
-		
-        public function ClearIntervalExample() {
-			intervalId = setInterval(myRepeatingFunction, intervalDuration, "Hello", "World");
-        }
-
-        public function myRepeatingFunction():void {
-            trace(arguments[0] + " " + arguments[1]);
-
-			counter++;
-			if(counter == stopCount) {
-				trace("Clearing Interval");
-				clearInterval(intervalId);	
-			}
-        }
-    }
-}
-
-

-
- - - - - -
clearTimeout()function 
-
-public function clearTimeout(id:uint):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Cancels a specified setTimeout() call. - -

Parameters - - - - -
id:uint — The ID of the setTimeout() call, which you set to a variable, - as in the following: -
-

-See also -

-
-setTimeout() -
-
-Example -
The following example uses the setTimeout() method to call another - method following a specified delay period. - -

A loop is created to count to one million. If the system can process this request faster - than a second can expire, clearTimeout() will remove the setTimeout() - request, and myDelayedFunction() will not be called.

-
-
-package {
-    import flash.display.Sprite;
-    import flash.utils.*;
-
-    public class ClearTimeoutExample extends Sprite {
-		private var delay:Number = 1000; // delay before calling myDelayedFunction
-		private var intervalId:uint;
-		private var count:uint = 1000000;
-		
-        public function ClearTimeoutExample() {
-			intervalId = setTimeout(myDelayedFunction, delay);
-			startCounting();
-        }
-
-		public function startCounting():void {
-			var i:uint = 0;
-			do {
-				if(i == count-1) {
-					clearTimeout(intervalId);
-					trace("Your computer can count to " + count + " in less than " + delay/1000 + " seconds.");	
-				}
-				i++;
-			} while(i < count)			
-		}
-		
-        public function myDelayedFunction():void {
-			trace("Time expired.");
-		}
-    }
-}
-
-

-
- - - - - -
describeType()function 
-
-public function describeType(value:*):XML -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Produces an XML object that describes the ActionScript object named as the parameter of - the method. This method implements the programming concept of reflection for the - ActionScript language. -

If the value parameter is an instance of a type, the returned XML object includes all the instance properties of that type, - but does not include any static properties. You can check for this condition when you parse the XML object by examining the value of the <type> tag's isStatic attribute, which is false when the value parameter is an instance of a type.

-

To obtain the static properties of a type, pass the type itself for the value parameter. The returned XML object includes not only the type's static properties, but also all of its instance properties. - The instance properties are nested inside a tag named <factory> to distinguish them from the static properties. - In this case, the isStatic attribute of the <type> tag is true.

-

Note: If you need only to traverse an object's inheritance hierarchy and do not need the other information provided by describeType(), - use the getQualifiedClassName() and getQualifiedSuperclassName() functions instead.

-

The following table describes some of the tags and attributes of the XML object generated by describeType() - (all class and interface names returned are in fully qualified format):

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TagAttributeDescription
<type> The root tag of the XML object.
 nameThe name of the ActionScript object's data type.
 baseThe immediate superclass of the ActionScript object's defining class. If the ActionScript object is a class object, the value is Class.
 isDynamictrue if the ActionScript object's defining class is dynamic; false otherwise. If the ActionScript object is a class object, the value is true because the Class class is dynamic.
 isFinaltrue if the ActionScript object's defining class is final; false otherwise.
 isStatictrue if the ActionScript object is a class object or constructor function; false otherwise. This attribute is named isStatic because if it is true, any tags that are not nested inside the factory tag are static.
<extendsClass> There is a separate extendsClass tag for each superclass of the ActionScript object's defining class.
 typeThe name of a superclass that the ActionScript object's defining class extends.
<implementsInterface> There is a separate implementsInterface tag for each interface implemented by the ActionScript object's defining class or any of its superclasses.
 typeThe name of an interface that the ActionScript object's defining class implements.
<accessor> An accessor is a property defined by getter and setter functions.
 nameThe name of the accessor.
 accessThe access rights of the property. Possible values include readonly, writeonly, and readwrite.
 typeThe data type of the property.
 declaredByThe class that contains the associated getter or setter functions.
<constant> A constant is a property defined with the const statement.
 nameThe name of the constant.
 typeThe data type of the constant.
<method> A method is a function declared as part of a class definition.
 nameThe name of the method.
 declaredByThe class that contains the method definition.
 returnTypeThe data type of the method's return value.
<parameter> There is a separate parameter tag for each parameter that a method defines. This tag is always nested inside a <method> tag.
 indexA number corresponding to the order in which the parameter appears in the method's parameter list. The first parameter has a value of 1.
 typeThe data type of the parameter.
 optionaltrue if the parameter is optional; false otherwise.
<variable> A variable is a property defined with the var statement.
 nameThe name of the variable.
 typeThe data type of the variable.
<factory> If the ActionScript object is a class object or constructor function, all instance properties and methods are nested inside this tag. If the isStatic attribute of the <type> tag is true, all properties and methods that are not nested within the <factory> tag are static. This tag appears only if the ActionScript object is a class object or constructor function.
- - Parameters - - - - -
value:* — The object for which a type description is desired. Any ActionScript value - may be passed to this method including all available ActionScript types, object - instances, primitive types such as uint, and class objects. - -
-

-Returns - - - - -
XML — - An XML object containing details about the object that was passed in as a parameter. - It provides the following information about the object: - -
    -
  • The class of the object
    • -
  • The attributes of the class
    • -
  • The inheritance tree from the class to its base classes
    • -
  • The interfaces implemented by the class
    • -
  • The declared instance properties of the class
    • -
  • The declared static properties of the class
    • -
  • The instance methods of the class
    • -
  • The static methods of the class
    • -
  • For each method of the class, the name, number of parameters, return type, - and parameter types
    • -
-

Note: describeType() only shows public properties and methods, and will not show - properties and methods that are private, package internal or in custom namespaces.

- - - -
-

-See also -

-
-getQualifiedClassName() -
-getQualifiedSuperclassName() -
-
-Example -
-
-
package {
-    import flash.display.Sprite;
-	import flash.utils.describeType;
-	
-	public class DescribeTypeExample extends Sprite {
-		public function DescribeTypeExample() {
-			var child:Sprite = new Sprite();
-			var description:XML = describeType(child);
-			trace(description..accessor.@name.toXMLString());
-		}
-	}
-}
-
-

-
- - - - - -
escapeMultiByte()function 
-
-public function escapeMultiByte(value:String):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns an escaped copy of the input string encoded as either UTF-8 or system code page, depending on the value of System.useCodePage. - Use of System.useCodePage allows legacy content encoded in local code pages to be accessed by the runtime, but only on systems using that legacy code page. - For example, Japanese data encoded as Shift-JIS will only be escaped and unescaped properly on an OS using a Japanese default code page. - -

Parameters - - - - -
value:String — The string to be escaped. - -
-

-Returns - - - - -
String — - An escaped copy of the input string. If System.useCodePage is true, the escaped string is encoded in the system code page. - If System.useCodePage is false, the escaped string is encoded in UTF-8. - For example, the input string "Crüe" will be escaped as "Cr%C3%BCe" on all systems if System.useCodePage is false. - If system.useCodePage is true, and the system uses a Latin code page, "Crüe" will be escaped as "Cr%FCe". - If the system uses a non Latin code page that does not contain the letter 'ü' the result will probably be "Cr?e". - Unescaping "Cr%C3%BCe" with System.useCodePage set to true will produce different undesired results on different systems, such as "Crüe" on a Latin system. - Similarly, unescaping "Cr%FCe" with System.useCodePage set to false could produce "Cre" or "Cr?e" or other variations depending on the code page of the system. - - - - -
-
- - - - - -
getDefinitionByName()function 
-
-public function getDefinitionByName(name:String):Object -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a reference to the class object of the class specified by the name parameter. -

Parameters - - - - -
name:String — The name of a class. -
-

-Returns - - - - -
Object — - Returns a reference to the class object of the class specified by the name parameter. - - -
-
-Throws - - - - -
ReferenceError — No public definition exists with the - specified name. - -
-
-Example -
The following example uses the class GetDefinitionByNameExample to - create an orange square on the stage. This is accomplished using the following steps: -
    -
  1. Variables for the background color of orange and size of 80 pixels are declared, - which will later be used in drawing the square.
    2. -
  2. Within the constructor, a variable ClassReference of type Class is - assigned to Sprite.
    3. -
  3. An instance of ClassReference called instance is instantiated.
    4. -
  4. Since instance is, by reference, a Sprite object, a square can be - drawn and added to the display list using the methods available to Sprite.
    5. -
-
-
-package {
-	import flash.display.DisplayObject;
-	import flash.display.Sprite;
-	import flash.utils.getDefinitionByName;
-
-	public class GetDefinitionByNameExample extends Sprite {
-		private var bgColor:uint = 0xFFCC00;
-		private var size:uint = 80;
-
-		public function GetDefinitionByNameExample() {
-			var ClassReference:Class = getDefinitionByName("flash.display.Sprite") as Class;
-			var instance:Object = new ClassReference();
-			instance.graphics.beginFill(bgColor);
-			instance.graphics.drawRect(0, 0, size, size);
-			instance.graphics.endFill();
-			addChild(DisplayObject(instance));
-		}
-	}
-}
-
-

-
- - - - - -
getQualifiedClassName()function 
-
-public function getQualifiedClassName(value:*):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the fully qualified class name of an object. - -

Parameters - - - - -
value:* — The object for which a fully qualified class name is desired. Any ActionScript value - may be passed to this method including all available ActionScript types, object - instances, primitive types such as uint, and class objects. - -
-

-Returns - - - - -
String — - A string containing the fully qualified class name. - - -
-

-See also -

-
-describeType() -
-getQualifiedSuperclassName() -
-
- - - - - -
getQualifiedSuperclassName()function 
-
-public function getQualifiedSuperclassName(value:*):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the fully qualified class name of the base class of the object specified by the value - parameter. This function provides a quicker way of retrieving the base class name than describeType(), but also - doesn't provide all the information describeType() does. -

After you retrieve the name of a class with this function, you can convert the class name to a class reference with the getDefinitionByName() function.

-

Note: This function restricts itself to instance hierarchies, whereas the describeType() function - uses class object hierarchies if the value parameter is a data type. Calling describeType() on a data type returns the - superclass based on the class object hierarchy, in which all class objects inherit from Class. The getQualifiedSuperclassName() - function, however, ignores the class object hierarchy and returns the superclass based on the more familiar instance hierarchy. - For example, calling getQualifiedSuperclassName(String) - returns Object although technically the String class object inherits from Class. In other words, the results are - the same whether you use an instance of a type or the type itself.

- Parameters - - - - -
value:* — Any value. -
-

-Returns - - - - -
String — - A fully qualified base class name, or null if none exists. - - -
-

-See also -

-
-describeType() -
-getDefinitionByName() -
-getQualifiedClassName() -
-
- - - - - -
getTimer()function 
-
-public function getTimer():int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Used to compute relative time. For a Flash runtime processing ActionScript 3.0, this method returns the number of milliseconds that have elapsed - since the Flash runtime virtual machine for ActionScript 3.0 (AVM2) started. For a Flash runtime processing ActionScript 2.0, this method returns - the number of milliseconds since the Flash runtime began initialization. Flash runtimes use two - virtual machines to process ActionScript. AVM1 is the ActionScript virtual machine used to run ActionScript 1.0 and 2.0. - AVM2 is the ActionScript virtual machine used to run ActionScript 3.0. The getTimer() method behavior for AVM1 is different than the - behavior for AVM2. -

For a calendar date (timestamp), see the Date object.

- -

-Returns - - - - -
int — - The number of milliseconds since the runtime was initialized (while processing ActionScript 2.0), or since the virtual machine started (while - processing ActionScript 3.0). If the runtime starts playing one - SWF file, and another SWF file is loaded later, the return value is relative to when the first SWF file was - loaded. - - -
-

-See also -

-
-flash.display.AVM1Movie -
-Date class -
-
-Example -
The following example uses the class GetTimerExample to get and print the - number of milliseconds since the runtime initialized. -
-
-package {
-    import flash.utils.getTimer;
-	import flash.display.Sprite;
-
-	public class GetTimerExample extends Sprite {
-		public function GetTimerExample() {
-			var duration:uint = getTimer();
-			trace("duration: " + duration);
-		}
-	}
-}
-
-

-
- - - - - -
setInterval()function 
-
-public function setInterval(closure:Function, delay:Number, ... arguments):uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Runs a function at a specified interval (in milliseconds). - -

Instead of using the setInterval() method, consider - creating a Timer object, with the specified interval, using 0 as the repeatCount - parameter (which sets the timer to repeat indefinitely).

- -

If you intend to use the clearInterval() method to cancel the - setInterval() call, be sure to assign the setInterval() call to a - variable (which the clearInterval() function will later reference). - If you do not call the clearInterval() function to cancel the - setInterval() call, the object containing the set timeout closure - function will not be garbage collected.

- - Parameters - - - - - - - - - - - - - - - - -
closure:Function — The name of the function to execute. Do not include quotation marks or - parentheses, and do not specify parameters of the function to call. For example, use - functionName, not functionName() or functionName(param). - -
 
delay:Number — The interval, in milliseconds. - -
 
... arguments — An optional list of arguments that are passed to the closure function. - -
-

-Returns - - - - -
uint — - Unique numeric identifier for the timed process. Use this identifier to cancel - the process, by calling the clearInterval() method. - - -
-

-See also -

-
-clearInterval() -
-
-Example -
The following example uses the setInterval() method to create a timed - interval, calling the myRepeatingFunction() method after regular intervals of one - second. -
-
-package {
-    import flash.display.Sprite;
-    import flash.utils.*;
-
-    public class SetIntervalExample extends Sprite {
-		private var intervalDuration:Number = 1000; // duration between intervals, in milliseconds
-		
-        public function SetIntervalExample() {
-			var intervalId:uint = setInterval(myRepeatingFunction, intervalDuration, "Hello", "World");
-        }
-
-        public function myRepeatingFunction():void {
-            trace(arguments[0] + " " + arguments[1]);
-        }
-    }
-}
-
-

-
- - - - - -
setTimeout()function 
-
-public function setTimeout(closure:Function, delay:Number, ... arguments):uint -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Runs a specified function after a specified delay (in milliseconds). - -

Instead of using this method, consider - creating a Timer object, with the specified interval, using 1 as the repeatCount - parameter (which sets the timer to run only once).

- -

If you intend to use the clearTimeout() method to cancel the - setTimeout() call, be sure to assign the setTimeout() call to a - variable (which the clearTimeout() function will later reference). - If you do not call the clearTimeout() function to cancel the - setTimeout() call, the object containing the set timeout closure - function will not be garbage collected.

- - Parameters - - - - - - - - - - - - - - - - -
closure:Function — The name of the function to execute. Do not include quotation marks or - parentheses, and do not specify parameters of the function to call. For example, use - functionName, not functionName() or functionName(param). - -
 
delay:Number — The delay, in milliseconds, until the function is executed. - -
 
... arguments — An optional list of arguments that are passed to the closure function. - -
-

-Returns - - - - -
uint — - Unique numeric identifier for the timed process. Use this identifier to cancel - the process, by calling the clearTimeout() method. - - -
-

-See also -

-
-clearTimeout() -
-
-Example -
The following example uses the setTimeout() method to call another - method following a specified delay period. -
-
-package {
-    import flash.display.Sprite;
-    import flash.utils.*;
-
-    public class SetTimeoutExample extends Sprite {
-		private var delay:Number = 1000; // delay before calling myDelayedFunction
-		
-        public function SetTimeoutExample() {
-			var intervalId:uint = setTimeout(myDelayedFunction, delay, "Hello", "World");
-        }
-
-        public function myDelayedFunction():void {
-            trace(arguments[0] + " " + arguments[1]);
-        }
-    }
-}
-
-

-
- - - - - -
unescapeMultiByte()function 
-
-public function unescapeMultiByte(value:String):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns an unescaped copy of the input string, which is decoded from either system code page page or UTF-8 depending on the value of System.useCodePage. - Use of System.useCodePage allows legacy content encoded in local code pages to be accessed by the runtime, but only on systems using that legacy code page. - For example, Japanese data encoded as Shift-JIS will only be escaped and unescaped properly on an OS using a Japanese default code page. - -

Parameters - - - - -
value:String — The escaped string to be unescaped. - -
-

-Returns - - - - -
String — - An unescaped copy of the input string. If System.useCodePage is true, the escaped string is decoded from the system code page. - If System.useCodePage is false, the escaped string is decoded from UTF-8. - For example, if the input string is "Crüe" and System.useCodePage is false, the result will be "Crüe" on all systems. - If System.useCodePage is true and the input string is "Cr%FCe", and the system uses a Latin code page, the result will also be "Crüe". - Unescaping "Cr%C3%BCe" with System.useCodePage set to true will produce different undesired results on different systems, such as "Crüe" on a Latin system. - Similarly, unescaping "Cr%FCe" with System.useCodePage set to false could produce "Cre" or "Cr?e" or other variations depending on the code page of the system. - - - - -
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/flash/xml/XMLDocument.html b/html-docs/flash/xml/XMLDocument.html deleted file mode 100644 index 90cad82..0000000 --- a/html-docs/flash/xml/XMLDocument.html +++ /dev/null @@ -1,882 +0,0 @@ - - - - - - - - -flash.xml.XMLDocument (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.xml
Classpublic class XMLDocument
InheritanceXMLDocument Inheritance XMLNode Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The XMLDocument class represents the legacy XML object - that was present in ActionScript 2.0. It was renamed in ActionScript 3.0 - to XMLDocument to avoid name conflicts with the new - XML class in ActionScript 3.0. In ActionScript 3.0, - it is recommended that you use the new - XML class and related classes, - which support E4X (ECMAScript for XML). -

The XMLDocument class, as well as XMLNode and XMLNodeType, are present for backward - compatibility. The functionality for loading XML documents can now be found in the - URLLoader class.

- -

-

-View the examples. -

-

-See also -

-
-flash.net.URLLoader -
-XML class -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
 Inheritedattributes : Object -
- An object containing all of the attributes of the specified XMLNode instance.
-		XMLNode
 InheritedchildNodes : Array -
- An array of the specified XMLNode object's children.
-		XMLNode
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  docTypeDecl : Object = null
- Specifies information about the XML document's DOCTYPE declaration.
-		XMLDocument
 InheritedfirstChild : XMLNode -
- Evaluates the specified XMLDocument object and references the first child in the parent node's child list.
-		XMLNode
  idMap : Object -
- An Object containing the nodes of the XML that have an id attribute assigned.
-		XMLDocument
  ignoreWhite : Boolean = false
- When set to true, text nodes that contain only white space are discarded during the parsing process.
-		XMLDocument
 InheritedlastChild : XMLNode -
- An XMLNode value that references the last child in the node's child list.
-		XMLNode
 InheritedlocalName : String -
- The local name portion of the XML node's name.
-		XMLNode
 InheritednamespaceURI : String -
- If the XML node has a prefix, namespaceURI is the value of the xmlns - declaration for that prefix (the URI), which is typically called the namespace URI.
-		XMLNode
 InheritednextSibling : XMLNode -
- An XMLNode value that references the next sibling in the parent node's child list.
-		XMLNode
 InheritednodeName : String -
- A string representing the node name of the XMLNode object.
-		XMLNode
 InheritednodeType : uint -
- A nodeType constant value, either XMLNodeType.ELEMENT_NODE for an XML element or - XMLNodeType.TEXT_NODE for a text node.
-		XMLNode
 InheritednodeValue : String -
- The node value of the XMLDocument object.
-		XMLNode
 InheritedparentNode : XMLNode -
- An XMLNode value that references the parent node of the specified XML object, or returns - null if the node has no parent.
-		XMLNode
 Inheritedprefix : String -
- The prefix portion of the XML node name.
-		XMLNode
 InheritedpreviousSibling : XMLNode -
- An XMLNode value that references the previous sibling in the parent node's child list.
-		XMLNode
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  xmlDecl : Object = null
- A string that specifies information about a document's XML declaration.
-		XMLDocument
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-XMLDocument(source:String = null)
-
- Creates a new XMLDocument object.
-		XMLDocument
 Inherited -
-appendChild(node:XMLNode):void -
-
- - Appends the specified node to the XML object's child list.
-		XMLNode
 Inherited -
-cloneNode(deep:Boolean):XMLNode -
-
- - Constructs and returns a new XML node of the same type, name, value, and attributes as the - specified XML object.
-		XMLNode
   -
-createElement(name:String):XMLNode -
-
- Creates a new XMLNode object with the name specified in the parameter.
-		XMLDocument
   -
-createTextNode(text:String):XMLNode -
-
- Creates a new XML text node with the specified text.
-		XMLDocument
 Inherited -
-getNamespaceForPrefix(prefix:String):String -
-
- Returns the namespace URI that is associated with the specified prefix for the node.
-		XMLNode
 Inherited -
-getPrefixForNamespace(ns:String):String -
-
- Returns the prefix that is associated with the specified namespace URI for the node.
-		XMLNode
 Inherited -
-hasChildNodes():Boolean -
-
- Indicates whether the specified XMLNode object has child nodes.
-		XMLNode
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-insertBefore(node:XMLNode, before:XMLNode):void -
-
- Inserts a new child node into the XML object's child list, before the - beforeNode node.
-		XMLNode
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
   -
-parseXML(source:String):void -
-
- Parses the XML text specified in the value parameter - and populates the specified XMLDocument object with the resulting XML tree.
-		XMLDocument
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-removeNode():void -
-
- Removes the specified XML object from its parent.
-		XMLNode
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Returns a string representation of the XML object.
-		XMLDocument
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
docTypeDeclproperty
-
-public var docTypeDecl:Object = null -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies information about the XML document's DOCTYPE declaration. - After the XML text has been parsed into an XMLDocument object, the - XMLDocument.docTypeDecl property of the XMLDocument object is set to the - text of the XML document's DOCTYPE declaration - (for example, <!DOCTYPE greeting SYSTEM "hello.dtd">). - This property is set using a string representation of the DOCTYPE declaration, - not an XMLNode object. -

The legacy ActionScript XML parser is not a validating parser. The DOCTYPE - declaration is read by the parser and stored in the XMLDocument.docTypeDecl property, - but no DTD validation is performed.

-

If no DOCTYPE declaration was encountered during a parse operation, - the XMLDocument.docTypeDecl property is set to null. - The XML.toString() method outputs the contents of XML.docTypeDecl - immediately after the XML declaration stored in XML.xmlDecl, and before any other - text in the XML object. If XMLDocument.docTypeDecl is null, no - DOCTYPE declaration is output.

-
- - - - - -
idMapproperty 
-
-public var idMap:Object -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An Object containing the nodes of the XML that have an id attribute assigned. - The names of the properties of the object (each containing a node) match the values of the - id attributes. - -

Consider the following XMLDocument object:

- - 
-	 <employee id='41'>
-	 	<name>
-	 		John Doe
-	 	</name>
-	 	<address>
-	 		601 Townsend St.
-	 	</address>
-	 </employee>
-	 
-	 <employee id='42'>
-	 	<name>
-	 		Jane Q. Public
-	 	</name>
-	 </employee>
-	 <department id="IT">
-	 	Information Technology
-	 </department>
-
- -

In this example, the idMap property for this XMLDocument object is an Object with - three properties: 41, 42, and IT. Each of these - properties is an XMLNode that has the matching id value. For example, - the IT property of the idMap object is this node:

- - 
-	 <department id="IT">
-	 	Information Technology
-	 </department>
-
- -

You must use the parseXML() method on the XMLDocument object for the - idMap property to be instantiated.

- -

If there is more than one XMLNode with the same id value, the matching property - of the idNode object is that of the last node parsed. For example:

- - 
-	 var x1:XML = new XMLDocument("<a id='1'><b id='2' /><c id='1' /></a>");
-	 x2 = new XMLDocument();
-	 x2.parseXML(x1);
-	 trace(x2.idMap['1']);
-
- - This will output the <c> node: - - 
-	 <c id='1' />
-
- -
- - - - - -
ignoreWhiteproperty 
-
-public var ignoreWhite:Boolean = false -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- When set to true, text nodes that contain only white space are discarded during the parsing process. Text nodes with leading or trailing white space are unaffected. The default setting is false. -

You can set the ignoreWhite property for individual XMLDocument objects, as the following code shows:

- 
-	 my_xml.ignoreWhite = true;
-
-
- - - - - -
xmlDeclproperty 
-
-public var xmlDecl:Object = null -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A string that specifies information about a document's XML declaration. - After the XML document is parsed into an XMLDocument object, this property is set - to the text of the document's XML declaration. This property is set using a string - representation of the XML declaration, not an XMLNode object. If no XML declaration - is encountered during a parse operation, the property is set to null. - The XMLDocument.toString() method outputs the contents of the - XML.xmlDecl property before any other text in the XML object. - If the XML.xmlDecl property contains null, - no XML declaration is output. -

- -
Constructor detail
- - - - - -
XMLDocument()constructor
-
-public function XMLDocument(source:String = null) -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new XMLDocument object. You must use the constructor to create an XMLDocument object before you call any of the methods of the XMLDocument class. -

Note: Use the createElement() and createTextNode() methods to add elements and text nodes to an XML document tree.

- Parameters - - - - -
source:String (default = null) — The XML text parsed to create the new XMLDocument object. -
-

-See also -

-
-XMLDocument.createElement() -
-XMLDocument.createTextNode() -
-
- -
Method detail
- - - - - -
createElement()method
-
-public function createElement(name:String):XMLNode -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new XMLNode object with the name specified in the parameter. - The new node initially has no parent, no children, and no siblings. - The method returns a reference to the newly created XMLNode object - that represents the element. This method and the XMLDocument.createTextNode() - method are the constructor methods for creating nodes for an XMLDocument object. -

Parameters - - - - -
name:String — The tag name of the XMLDocument element being created. -
-

-Returns - - - - -
XMLNode — - An XMLNode object. - - -
-

-See also -

-
-XMLDocument.createTextNode() -
-
- - - - - -
createTextNode()method 
-
-public function createTextNode(text:String):XMLNode -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Creates a new XML text node with the specified text. The new node initially has no parent, and text nodes cannot have children or siblings. This method returns a reference to the XMLDocument object that represents the new text node. This method and the XMLDocument.createElement() method are the constructor methods for creating nodes for an XMLDocument object. -

Parameters - - - - -
text:String — The text used to create the new text node. -
-

-Returns - - - - -
XMLNode — - An XMLNode object. - - -
-

-See also -

-
-XMLDocument.createElement() -
-
- - - - - -
parseXML()method 
-
-public function parseXML(source:String):void -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Parses the XML text specified in the value parameter - and populates the specified XMLDocument object with the resulting XML tree. Any existing trees in the XMLDocument object are discarded. -

Parameters - - - - -
source:String — The XML text to be parsed and passed to the specified XMLDocument object. -
-
- - - - - -
toString()method 
-
-public override function toString():String -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

- Returns a string representation of the XML object. -

-Returns - - - - -
String — - A string representation of the XML object. - - - -
-
- -
Examples
-
examples\XMLDocumentExample
-
The following example uses the XMLDocument and XMLNode classes - to parse and format an XML document. Rather than loading an external - XML file, the example uses the top-level XML class to create an XML document, - then parses it. -
-
-package {
-    import flash.display.Sprite;
-	import flash.xml.XMLDocument;
-	import flash.xml.XMLNode;
-	import flash.xml.XMLNodeType;
-
-	public class XMLDocumentExample extends Sprite {
-		public function XMLDocumentExample() {
-			var result:XMLDocument = new XMLDocument();
-			result.ignoreWhite = true;
-			result.parseXML(getXMLString());
-
-			var books:Array = parseBooks(result.firstChild);
-			trace("books: \n" + books);
-		}
-
-		private function parseBooks(node:XMLNode):Array {
-			var books:Array = new Array();
-
-			var kids:Array = node.childNodes;
-			for each(var item:XMLNode in kids) {
-				parseBook(item, books);
-			}
-
-			return books;
-		}
-
-		private function parseBook(node:XMLNode, books:Array):void {
-			var item:Book = new Book();
-			item.setPublisher(node.attributes.publisher);
-			item.setName(node.attributes.name);
-			books.push(item);
-		}
-
-		private function getXMLString():String {
-			var list:XML = <books>
-								<book publisher="Addison-Wesley" name="Design Patterns" />
-								<book publisher="Addison-Wesley" name="The Pragmatic Programmer" />
-								<book publisher="Addison-Wesley" name="Test Driven Development" />
-								<book publisher="Addison-Wesley" name="Refactoring to Patterns" />
-								<book publisher="O'Reilly Media" name="The Cathedral & the Bazaar" />
-								<book publisher="O'Reilly Media" name="Unit Test Frameworks" />
-							</books>;
-			return list.toXMLString();
-		}
-	}
-
-}
-class Book {
-	private var publisher:String;
-	private var name:String;
-
-	public function setPublisher(publisher:String):void {
-		this.publisher = publisher;
-	}
-
-	public function setName(name:String):void {
-		this.name = name;
-	}
-
-	public function toString():String {
-		return "[Book name: " + name + " publisher: " + publisher + "]\n";
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/xml/XMLNode.html b/html-docs/flash/xml/XMLNode.html deleted file mode 100644 index 959ec7f..0000000 --- a/html-docs/flash/xml/XMLNode.html +++ /dev/null @@ -1,1368 +0,0 @@ - - - - - - - - -flash.xml.XMLNode (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
Packageflash.xml
Classpublic class XMLNode
InheritanceXMLNode Inheritance Object
SubclassesXMLDocument
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The XMLNode class represents the legacy XML object - that was present in ActionScript 2.0 and that was renamed in ActionScript 3.0. - In ActionScript 3.0, consider using the new top-level XML - class and related classes instead, - which support E4X (ECMAScript for XML). - The XMLNode class is present for backward compatibility. - -

-

-View the examples. -

-

-See also -

-
-XML -
-flash.xml.XMLDocument -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  attributes : Object -
- An object containing all of the attributes of the specified XMLNode instance.
-		XMLNode
  childNodes : Array -
[read-only] - An array of the specified XMLNode object's children.
-		XMLNode
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  firstChild : XMLNode -
- Evaluates the specified XMLDocument object and references the first child in the parent node's child list.
-		XMLNode
  lastChild : XMLNode -
- An XMLNode value that references the last child in the node's child list.
-		XMLNode
  localName : String -
[read-only] - The local name portion of the XML node's name.
-		XMLNode
  namespaceURI : String -
[read-only] - If the XML node has a prefix, namespaceURI is the value of the xmlns - declaration for that prefix (the URI), which is typically called the namespace URI.
-		XMLNode
  nextSibling : XMLNode -
- An XMLNode value that references the next sibling in the parent node's child list.
-		XMLNode
  nodeName : String -
- A string representing the node name of the XMLNode object.
-		XMLNode
  nodeType : uint -
- A nodeType constant value, either XMLNodeType.ELEMENT_NODE for an XML element or - XMLNodeType.TEXT_NODE for a text node.
-		XMLNode
  nodeValue : String -
- The node value of the XMLDocument object.
-		XMLNode
  parentNode : XMLNode -
- An XMLNode value that references the parent node of the specified XML object, or returns - null if the node has no parent.
-		XMLNode
  prefix : String -
[read-only] - The prefix portion of the XML node name.
-		XMLNode
  previousSibling : XMLNode -
- An XMLNode value that references the previous sibling in the parent node's child list.
-		XMLNode
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-XMLNode(type:uint, value:String)
-
- Creates a new XMLNode object.
-		XMLNode
   -
-appendChild(node:XMLNode):void -
-
- - Appends the specified node to the XML object's child list.
-		XMLNode
   -
-cloneNode(deep:Boolean):XMLNode -
-
- - Constructs and returns a new XML node of the same type, name, value, and attributes as the - specified XML object.
-		XMLNode
   -
-getNamespaceForPrefix(prefix:String):String -
-
- Returns the namespace URI that is associated with the specified prefix for the node.
-		XMLNode
   -
-getPrefixForNamespace(ns:String):String -
-
- Returns the prefix that is associated with the specified namespace URI for the node.
-		XMLNode
   -
-hasChildNodes():Boolean -
-
- Indicates whether the specified XMLNode object has child nodes.
-		XMLNode
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
   -
-insertBefore(node:XMLNode, before:XMLNode):void -
-
- Inserts a new child node into the XML object's child list, before the - beforeNode node.
-		XMLNode
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
   -
-removeNode():void -
-
- Removes the specified XML object from its parent.
-		XMLNode
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toString():String -
-
- Evaluates the specified XMLNode object, constructs a textual representation of the XML structure, - including the node, children, and attributes, and returns the result as a string.
-		XMLNode
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
attributesproperty
-
-attributes:Object  [read-write]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An object containing all of the attributes of the specified XMLNode instance. The - XMLNode.attributes object contains one variable for each attribute of the XMLNode instance. - Because these variables are defined as part of the object, they are generally referred to as - properties of the object. The value of each attribute is stored in the corresponding property as a - string. For example, if you have an attribute named color, you would retrieve - that attribute's value - by specifying color as the property name, as the following code shows: - 

-	 var myColor:String = doc.firstChild.attributes.color
-
-

Implementation -
-    public function get attributes():Object -
-    public function set attributes(value:Object):void -
-
- - - - - -
childNodesproperty 
-
-childNodes:Array  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An array of the specified XMLNode object's children. Each element in the array is a reference - to an XMLNode object that represents a child node. This is a read-only property and cannot be - used to manipulate child nodes. Use the appendChild(), insertBefore(), - and removeNode() methods to manipulate child nodes. - -

This property is undefined for text nodes (nodeType == 3).

- Implementation -
-    public function get childNodes():Array -
-

-See also -

-
-XMLNode.nodeType -
-XMLNode.appendChild() -
-XMLNode.insertBefore() -
-XMLNode.removeNode() -
-
- - - - - -
firstChildproperty 
-
-public var firstChild:XMLNode -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Evaluates the specified XMLDocument object and references the first child in the parent node's child list. - This property is null if the node does not have children. This property is - undefined if the node is a text node. This is a read-only property and cannot be used - to manipulate child nodes; use the appendChild(), insertBefore(), and - removeNode() methods to manipulate child nodes. -

-See also -

-
-XMLNode.appendChild() -
-XMLNode.insertBefore() -
-XMLNode.removeNode() -
-
- - - - - -
lastChildproperty 
-
-public var lastChild:XMLNode -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An XMLNode value that references the last child in the node's child list. The - XMLNode.lastChild property is null if the node does not have children. - This property cannot be used to manipulate child nodes; use the appendChild(), - insertBefore(), and removeNode() methods to manipulate child nodes. -

-See also -

-
-XMLNode.appendChild() -
-XMLNode.insertBefore() -
-XMLNode.removeNode() -
-
- - - - - -
localNameproperty 
-
-localName:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The local name portion of the XML node's name. This is the element name without - the namespace prefix. For example, the node - <contact:mailbox/>bob@example.com</contact:mailbox> - has the local name "mailbox", and the prefix "contact", which comprise the full - element name "contact.mailbox". - -

You can access the namespace prefix through the prefix property of - the XML node object. The nodeName property returns the full name - (including the prefix and the local name).

- - Implementation -
-    public function get localName():String -
-
- - - - - -
namespaceURIproperty 
-
-namespaceURI:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- If the XML node has a prefix, namespaceURI is the value of the xmlns - declaration for that prefix (the URI), which is typically called the namespace URI. - The xmlns declaration is in the current node or in a node higher in the XML - hierarchy. -

If the XML node does not have a prefix, the value of the namespaceURI property - depends on whether there is a default namespace defined (as in - xmlns="http://www.example.com/"). If there is a default namespace, the value of - the namespaceURI property is the value of the default namespace. - If there is no default namespace, the namespaceURI property for - that node is an empty string ("").

- -

You can use the getNamespaceForPrefix() method to identify the namespace associated with a - specific prefix. The namespaceURI property returns the prefix associated with the node name.

- - Implementation -
-    public function get namespaceURI():String -
-

-See also -

-
-getNamespaceForPrefix() -
-getPrefixForNamespace() -
-
- - - - - -
nextSiblingproperty 
-
-public var nextSibling:XMLNode -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An XMLNode value that references the next sibling in the parent node's child list. This property is - null if the node does not have a next sibling node. This property cannot be used to - manipulate child nodes; use the appendChild(), insertBefore(), and - removeNode() methods to manipulate child nodes. -

-See also -

-
-XMLNode.firstChild -
-XMLNode.appendChild() -
-XMLNode.insertBefore() -
-XMLNode.removeNode() -
-
- - - - - -
nodeNameproperty 
-
-public var nodeName:String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A string representing the node name of the XMLNode object. If the XMLNode object is an XML - element (nodeType == 1), nodeName is the name of the tag that - represents the node in the XML file. For example, TITLE is the nodeName - of an HTML TITLE tag. If the XMLNode object is a text node - (nodeType == 3), nodeName is null. -

-See also -

-
-XMLNode.nodeType -
-
- - - - - -
nodeTypeproperty 
-
-public var nodeType:uint -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- A nodeType constant value, either XMLNodeType.ELEMENT_NODE for an XML element or - XMLNodeType.TEXT_NODE for a text node. -

The nodeType is a numeric value from the NodeType enumeration in the W3C DOM - Level 1 recommendation: - http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html. - The following table lists the values:

-

- - - - - -
Integer valueDefined - constant
1ELEMENT_NODE
2ATTRIBUTE_NODE
3TEXT_NODE
4CDATA_SECTION_NODE
5ENTITY_REFERENCE_NODE
6ENTITY_NODE
7PROCESSING_INSTRUCTION_NODE
8COMMENT_NODE
9DOCUMENT_NODE
10DOCUMENT_TYPE_NODE
11DOCUMENT_FRAGMENT_NODE
12NOTATION_NODE

-

In Flash Player, the built-in XMLNode class only supports XMLNodeType.ELEMENT_NODE and - XMLNodeType.TEXT_NODE.

-

-See also -

-
-XMLNodeType.TEXT_NODE -
-XMLNodeType.ELEMENT_NODE -
-
- - - - - -
nodeValueproperty 
-
-public var nodeValue:String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The node value of the XMLDocument object. If the XMLDocument object is a text node, the nodeType - is 3, and the nodeValue is the text of the node. If the XMLDocument object is an XML element - (nodeType is 1), nodeValue is null and read-only. -

-See also -

-
-XMLNode.nodeType -
-
- - - - - -
parentNodeproperty 
-
-public var parentNode:XMLNode -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An XMLNode value that references the parent node of the specified XML object, or returns - null if the node has no parent. This is a read-only property and cannot be used to - manipulate child nodes; use the appendChild(), insertBefore(), and - removeNode() methods to manipulate child nodes. -

-See also -

-
-XMLNode.appendChild() -
-XMLNode.insertBefore() -
-XMLNode.removeNode() -
-
- - - - - -
prefixproperty 
-
-prefix:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- The prefix portion of the XML node name. For example, the node - <contact:mailbox/>bob@example.com</contact:mailbox> prefix - "contact" and the local name "mailbox", which comprise the full element name "contact.mailbox". - -

The nodeName property of an XML node object returns the full name - (including the prefix and the local name). You can access the local name portion of the - element's name via the localName property.

- - - Implementation -
-    public function get prefix():String -
-
- - - - - -
previousSiblingproperty 
-
-public var previousSibling:XMLNode -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- An XMLNode value that references the previous sibling in the parent node's child list. - The property has a value of null if the node does not have a previous sibling node. This property - cannot be used to manipulate child nodes; use the appendChild(), - insertBefore(), and removeNode() methods to manipulate child nodes. -

-See also -

-
-XMLNode.lastChild -
-XMLNode.appendChild() -
-XMLNode.insertBefore() -
-XMLNode.removeNode() -
-
- -
Constructor detail
- - - - - -
XMLNode()constructor
-
-public function XMLNode(type:uint, value:String) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Creates a new XMLNode object. You must use the constructor to create an XMLNode object before you - call any of the methods of the XMLNode class. -

Note: Use the createElement() and createTextNode() - methods to add elements and text nodes to an XML document tree.

- Parameters - - - - - - - - - - -
type:uint — The node type: either 1 for an XML element or 3 for a text node. -
 
value:String — The XML text parsed to create the new XMLNode object. -
-

-See also -

-
-XMLDocument.createElement() -
-XMLDocument.createTextNode() -
-
- -
Method detail
- - - - - -
appendChild()method
-
-public function appendChild(node:XMLNode):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Appends the specified node to the XML object's child list. This method operates directly on the - node referenced by the childNode parameter; it does not append a copy of the - node. If the node to be appended already exists in another tree structure, appending the node to the - new location will remove it from its current location. If the childNode - parameter refers to a node that already exists in another XML tree structure, the appended child node - is placed in the new tree structure after it is removed from its existing parent node. -

Parameters - - - - -
node:XMLNode — An XMLNode that represents the node to be moved from its current location to the child - list of the my_xml object. -
-
- - - - - -
cloneNode()method 
-
-public function cloneNode(deep:Boolean):XMLNode -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- - Constructs and returns a new XML node of the same type, name, value, and attributes as the - specified XML object. If deep is set to true, all child nodes are - recursively cloned, resulting in an exact copy of the original object's document tree. -

The clone of the node that is returned is no longer associated with the tree of the cloned item. - Consequently, nextSibling, parentNode, and previousSibling - all have a value of null. If the deep parameter is set to - false, or the my_xml node has no child nodes, - firstChild and lastChild are also null.

- Parameters - - - - -
deep:Boolean — A Boolean value; if set to true, the children of the specified XML object will be recursively cloned. -
-

-Returns - - - - -
XMLNode — - An XMLNode Object. - - -
-
- - - - - -
getNamespaceForPrefix()method 
-
-public function getNamespaceForPrefix(prefix:String):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the namespace URI that is associated with the specified prefix for the node. To determine - the URI, getPrefixForNamespace() searches up the XML hierarchy from the node, as - necessary, and returns the namespace URI of the first xmlns declaration for the - given prefix. - -

If no namespace is defined for the specified prefix, the method returns null.

- -

If you specify an empty string ("") as the prefix and there is a - default namespace defined for the node (as in xmlns="http://www.example.com/"), - the method returns that default namespace URI. -

- - Parameters - - - - -
prefix:String — The prefix for which the method returns the associated namespace. - -
-

-Returns - - - - -
String — - The namespace that is associated with the specified prefix. - - - -
-

-See also -

-
-XMLNode.getPrefixForNamespace() -
-XMLNode.namespaceURI -
-
- - - - - -
getPrefixForNamespace()method 
-
-public function getPrefixForNamespace(ns:String):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Returns the prefix that is associated with the specified namespace URI for the node. To determine - the prefix, getPrefixForNamespace() searches up the XML hierarchy from the node, as - necessary, and returns the prefix of the first xmlns declaration with a namespace URI - that matches ns. - -

If there is no xmlns - assignment for the given URI, the method returns null. If there is an - xmlns assignment for the given URI but no prefix is associated with the assignment, - the method returns an empty string - (""). -

- - Parameters - - - - -
ns:String — The namespace URI for which the method returns the associated prefix. - -
-

-Returns - - - - -
String — - The prefix associated with the specified namespace. - - - -
-

-See also -

-
-XMLNode.getNamespaceForPrefix() -
-XMLNode.namespaceURI -
-
- - - - - -
hasChildNodes()method 
-
-public function hasChildNodes():Boolean -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Indicates whether the specified XMLNode object has child nodes. This property is true if the - specified XMLNode object has child nodes; otherwise, it is false. - -

-Returns - - - - -
Boolean — - Returns true if the - specified XMLNode object has child nodes; otherwise, false. - - - -
-
- - - - - -
insertBefore()method 
-
-public function insertBefore(node:XMLNode, before:XMLNode):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Inserts a new child node into the XML object's child list, before the - beforeNode node. If the beforeNode parameter is undefined - or null, the node is added using the appendChild() method. If beforeNode - is not a child of my_xml, the insertion fails. -

Parameters - - - - - - - - - - -
node:XMLNode — The XMLNode object to be inserted. -
 
before:XMLNode — The XMLNode object before the insertion point for the childNode. -
-

-See also -

-
-XMLNode.cloneNode() -
-
- - - - - -
removeNode()method 
-
-public function removeNode():void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Removes the specified XML object from its parent. Also deletes all descendants of the node. -

- - - - - -
toString()method 
-
-public function toString():String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Evaluates the specified XMLNode object, constructs a textual representation of the XML structure, - including the node, children, and attributes, and returns the result as a string. -

For top-level XMLDocument objects (those created with the constructor), - the XMLDocument.toString() method outputs the document's XML declaration - (stored in the XMLDocument.xmlDecl property), followed by the document's - DOCTYPE declaration (stored in the XMLDocument.docTypeDecl property), - followed by the text representation of all XML nodes in the object. The XML declaration is not - output if the XMLDocument.xmlDecl property is null. - The DOCTYPE declaration is not output if the - XMLDocument.docTypeDecl property is null.

-

-Returns - - - - -
String — - The string representing the XMLNode object. - - -
-

-See also -

-
-XMLDocument.docTypeDecl -
-XMLDocument.xmlDecl -
-
- -
Examples
-
examples\XMLDocumentExample
-
The following example uses the XMLDocument and XMLNode classes - to parse and format an XML document. Rather than loading an external - XML file, the example uses the top-level XML class to create an XML document, - then parses it. -
-
-package {
-    import flash.display.Sprite;
-	import flash.xml.XMLDocument;
-	import flash.xml.XMLNode;
-	import flash.xml.XMLNodeType;
-
-	public class XMLDocumentExample extends Sprite {
-		public function XMLDocumentExample() {
-			var result:XMLDocument = new XMLDocument();
-			result.ignoreWhite = true;
-			result.parseXML(getXMLString());
-
-			var books:Array = parseBooks(result.firstChild);
-			trace("books: \n" + books);
-		}
-
-		private function parseBooks(node:XMLNode):Array {
-			var books:Array = new Array();
-
-			var kids:Array = node.childNodes;
-			for each(var item:XMLNode in kids) {
-				parseBook(item, books);
-			}
-
-			return books;
-		}
-
-		private function parseBook(node:XMLNode, books:Array):void {
-			var item:Book = new Book();
-			item.setPublisher(node.attributes.publisher);
-			item.setName(node.attributes.name);
-			books.push(item);
-		}
-
-		private function getXMLString():String {
-			var list:XML = <books>
-								<book publisher="Addison-Wesley" name="Design Patterns" />
-								<book publisher="Addison-Wesley" name="The Pragmatic Programmer" />
-								<book publisher="Addison-Wesley" name="Test Driven Development" />
-								<book publisher="Addison-Wesley" name="Refactoring to Patterns" />
-								<book publisher="O'Reilly Media" name="The Cathedral & the Bazaar" />
-								<book publisher="O'Reilly Media" name="Unit Test Frameworks" />
-							</books>;
-			return list.toXMLString();
-		}
-	}
-
-}
-class Book {
-	private var publisher:String;
-	private var name:String;
-
-	public function setPublisher(publisher:String):void {
-		this.publisher = publisher;
-	}
-
-	public function setName(name:String):void {
-		this.name = name;
-	}
-
-	public function toString():String {
-		return "[Book name: " + name + " publisher: " + publisher + "]\n";
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/xml/XMLNodeType.html b/html-docs/flash/xml/XMLNodeType.html deleted file mode 100644 index cfd505e..0000000 --- a/html-docs/flash/xml/XMLNodeType.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - -flash.xml.XMLNodeType (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
Packageflash.xml
Classpublic final class XMLNodeType
InheritanceXMLNodeType Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

-

- The XMLNodeType class contains constants used with - XMLNode.nodeType. The values are defined - by the NodeType enumeration in the - W3C DOM Level 1 recommendation: - http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html -

-

-See also -

-
-XMLNode.nodeType -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  ELEMENT_NODE : uint = 1
[static] - Specifies that the node is an element.
-		XMLNodeType
  TEXT_NODE : uint = 3
[static] - Specifies that the node is a text node.
-		XMLNodeType
-
- -
- -
Constant detail
- - - - - -
ELEMENT_NODEconstant
-
-public static const ELEMENT_NODE:uint = 1 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies that the node is an element. - This constant is used with XMLNode.nodeType. - The value is defined by the NodeType enumeration in the - W3C DOM Level 1 recommendation: - http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html -

-See also -

-
-XMLNode.nodeType -
-
- - - - - -
TEXT_NODEconstant 
-
-public static const TEXT_NODE:uint = 3 -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: 
-

- Specifies that the node is a text node. - This constant is used with XMLNode.nodeType. - The value is defined by the NodeType enumeration in the - W3C DOM Level 1 recommendation: - http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html -

-See also -

-
-XMLNode.nodeType -
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/flash/xml/package-detail.html b/html-docs/flash/xml/package-detail.html deleted file mode 100644 index 6ac63d2..0000000 --- a/html-docs/flash/xml/package-detail.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - -flash.xml Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The flash.xml package contains Flash Player's legacy XML support, and other Flash Player-specific XML functionality.

-
-
- -
Classes
- - - - - - - - - - - - - -
 ClassDescription
 XMLDocument - The XMLDocument class represents the legacy XML object - that was present in ActionScript 2.0.
 XMLNode - The XMLNode class represents the legacy XML object - that was present in ActionScript 2.0 and that was renamed in ActionScript 3.0.
 XMLNodeType - The XMLNodeType class contains constants used with - XMLNode.nodeType.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/float.html b/html-docs/float.html deleted file mode 100644 index 17f4796..0000000 --- a/html-docs/float.html +++ /dev/null @@ -1,824 +0,0 @@ - - - - - - - - -float (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class float
Inheritancefloat Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 51.0 - -
-

-

- - A data type representing an IEEE-754 single-precision floating-point number. You can manipulate primitive numeric - - values by using the methods and properties associated with the float class, as well as normal arithmetic operators. - -

Float values are stored as 32-bit values and are supported in ActionScript Byte Code version 47.16 and above. - - To use single-precision floating point functionality, you will need to compile your application using the AIR compiler - - version 3.0.0 or above (provided with AIR SDK 51.0), and the target AIR runtime would need to be AIR 51.0 or above.

- - -

The properties of the float class are static, which means you do not need an object to use them, so you - - do not need to use the constructor.

- -

The float data type adheres to the single-precision IEEE-754 standard.

- -

The float data type is useful when you need to use floating-point values without needing the precision or using the - - memory associated with the double-precision Number type. This can be particularly useful when interacting - - with graphical systems such as the Stage3D APIs, where float-specific functions are now available for program - - constants and vertex buffers.

- - -

The default value of a variable typed as flat is NaN (Not a Number). To assign number values to a float - - variable, an 'f' character should be appended to the value - for example:

- -

var floatVal:float = 1.23f;

- - -

Note that when a float value is converted into a String, the internal functionality will - - promote the single-precision value into a double-precision value which will then be converted into a string. Some precision - - changes may occur during this promotion/conversion process.

- - -

-

-See also -

-
-int -
-uint -
-Number -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-float(num:Object)
-
- - Creates a float object with the specified value.
-		float
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-toExponential(fractionDigits:uint):String -
-
- - Returns a string representation of the float value in exponential notation.
-		float
   -
-toFixed(fractionDigits:uint):String -
-
- - Returns a string representation of the float value in fixed-point notation.
-		float
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toPrecision(precision:uint):String -
-
- - Returns a string representation of the float value either in exponential notation or in - - fixed-point notation.
-		float
   -
-toString(radix:* = 10):String -
-
- - Returns the string representation of the specified float object.
-		float
   -
-valueOf():float -
-
- - Returns the primitive value type of the specified float object.
-		float
-
- -
-
Public Constants
- - - - - - - - - - - - - - - - - - - -
 ConstantDefined by
  MAX_VALUE : float -
[static] - - The largest representable number (single-precision IEEE-754).
-		float
  MIN_VALUE : float -
[static] - - The smallest (closest to zero, not most negative) representable single-precision IEEE-754 number that does not compare equal to zero.
-		float
  NaN : float -
[static] - - The single-precision IEEE-754 value representing Not a Number (NaN).
-		float
  NEGATIVE_INFINITY : float -
[static] - - Specifies the single-precision IEEE-754 value representing negative infinity.
-		float
  POSITIVE_INFINITY : float -
[static] - - Specifies the single-prevision IEEE-754 value representing positive infinity.
-		float
-
- -
- -
Constructor detail
- - - - - -
float()constructor
-
-public function float(num:Object) -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Creates a float object with the specified value. This constructor has the same effect - - as the float() public native function that converts an object of a different type - - to a primitive numeric value. - - -

Parameters - - - - -
num:Object
-
- -
Method detail
- - - - - -
toExponential()method
-
-AS3 function toExponential(fractionDigits:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Returns a string representation of the float value in exponential notation. The string contains - - one digit before the decimal point and up to 20 digits after the decimal point, as - - specified by the fractionDigits parameter. - -

Parameters - - - - -
fractionDigits:uint — An integer between 0 and 20, inclusive, that represents the desired number of decimal places. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the fractionDigits argument is outside the range 0 to 20. - -
-
- - - - - -
toFixed()method 
-
-AS3 function toFixed(fractionDigits:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Returns a string representation of the float value in fixed-point notation. - - Fixed-point notation means that the string will contain a specific number of digits - - after the decimal point, as specified in the fractionDigits parameter. - - The valid range for the fractionDigits parameter is from 0 to 20. - - Specifying a value outside this range throws an exception. - - -

Parameters - - - - -
fractionDigits:uint — An integer between 0 and 20, inclusive, that represents the desired number of decimal places. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the fractionDigits argument is outside the range 0 to 20. - -
-
- - - - - -
toPrecision()method 
-
-AS3 function toPrecision(precision:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Returns a string representation of the float value either in exponential notation or in - - fixed-point notation. The string will contain the number of digits specified in the - - precision parameter. - -

Parameters - - - - -
precision:uint — An integer between 1 and 21, inclusive, that represents the desired number of digits to represent in the resulting string. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the precision argument is outside the range 1 to 21. - -
-
- - - - - -
toString()method 
-
-AS3 function toString(radix:* = 10):String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Returns the string representation of the specified float object. - -

If the value of the float object is a decimal number without a leading zero (such as .4), - - float.toString() adds a leading zero (0.4).

- -

Note that the conversion internally promotes the single-precision value into a double-precision - - value which is then converted to a string, hence the resulting precision may be higher than expected.

- - - Parameters - - - - -
radix:* (default = 10) — Specifies the numeric base (from 2 to 36) to use for the number-to-string - - conversion. If you do not specify the radix parameter, the default value - - is 10. - - -
-

-Returns - - - - -
String — - The numeric representation of the float object as a string. - - - -
-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():float -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Returns the primitive value type of the specified float object. - - -

-Returns - - - - -
float — - The primitive type value of the float object. - - - -
-
- -
Constant detail
- - - - - -
MAX_VALUEconstant
-
-public static const MAX_VALUE:float -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - The largest representable number (single-precision IEEE-754). This number is - - approximately 3.4e38. - - -

- - - - - -
MIN_VALUEconstant 
-
-public static const MIN_VALUE:float -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - The smallest (closest to zero, not most negative) representable single-precision IEEE-754 number that does not compare equal to zero. - - On most platforms this number is approximately 1.4e-45. - - -

Note: The absolute smallest representable number overall is -float.MAX_VALUE.

- - -
- - - - - -
NaNconstant 
-
-public static const NaN:float -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - The single-precision IEEE-754 value representing Not a Number (NaN). - - -

- - - - - -
NEGATIVE_INFINITYconstant 
-
-public static const NEGATIVE_INFINITY:float -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Specifies the single-precision IEEE-754 value representing negative infinity. - -

- - Negative infinity is a special numeric value that is returned when a mathematical - - operation or function returns a negative value larger than can be - - represented. - -

- - -
- - - - - -
POSITIVE_INFINITYconstant 
-
-public static const POSITIVE_INFINITY:float -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 51.0 - -
-

- - Specifies the single-prevision IEEE-754 value representing positive infinity. - -

- - Positive infinity is a special numeric value that is returned when a mathematical - - operation or function returns a value larger than can be represented. - -

- - -
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
- - - diff --git a/html-docs/index.html b/html-docs/index.html deleted file mode 100644 index adf20ac..0000000 --- a/html-docs/index.html +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - -ActionScript 3.0 Language Reference - - - - - - - - - - - - - - - - - - - - - - -<body> - -<h2>Frame Alert</h2> - -<p> - This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. - <br> - Link to <a href="package-summary.html">Non-frame version.</a> - -</p> - -</body> - - - - - - - diff --git a/html-docs/int.html b/html-docs/int.html deleted file mode 100644 index eb0e233..0000000 --- a/html-docs/int.html +++ /dev/null @@ -1,779 +0,0 @@ - - - - - - - - -int (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class int
Inheritanceint Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - The int class lets you work with the data type representing a 32-bit signed integer. - - The range of values represented by the int class is -2,147,483,648 (-2^31) to 2,147,483,647 (2^31-1). - -

The constant properties of the int class, MAX_VALUE and MIN_VALUE, are static, which means that you don't need an object to use them, so you don't need to use the constructor. The methods, however, are not static, which means that you do need an object to use them. You can create an int object by using the int class constructor or by declaring a variable of type int and assigning the variable a literal value.

- -

The int data type is useful for loop counters and other situations where a floating point number is not needed, and is similar to the int data type in Java and C++. The default value of a variable typed as int is 0

- -

If you are working with numbers that exceed int.MAX_VALUE, consider using Number.

- -

The following example calls the toString() method of the int class, which returns the string 1234:

- - 
-
- var myint:int = 1234;
-
- myint.toString();
-
-
- -

The following example assigns the value of the MIN_VALUE property to a variable declared without the use of the constructor:

- - 
-
- var smallest:int = int.MIN_VALUE;
-
-
- - -

-

-View the examples. -

-

-See also -

-
-uint -
-Number -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-int(num:Object)
-
- - Constructor; creates a new int object.
-		int
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-toExponential(fractionDigits:uint):String -
-
- - Returns a string representation of the number in exponential notation.
-		int
   -
-toFixed(fractionDigits:uint):String -
-
- - Returns a string representation of the number in fixed-point notation.
-		int
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toPrecision(precision:uint):String -
-
- - Returns a string representation of the number either in exponential notation or in - - fixed-point notation.
-		int
   -
-toString(radix:uint):String -
-
- - Returns the string representation of an int object.
-		int
   -
-valueOf():int -
-
- - Returns the primitive value of the specified int object.
-		int
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  MAX_VALUE : int = 2147483647
[static] - - The largest representable 32-bit signed integer, which is 2,147,483,647.
-		int
  MIN_VALUE : int = -2147483648
[static] - - The smallest representable 32-bit signed integer, which is -2,147,483,648.
-		int
-
- -
- -
Constructor detail
- - - - - -
int()constructor
-
-public function int(num:Object) -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Constructor; creates a new int object. You must use the int constructor when using int.toString() and int.valueOf(). You do not use a constructor when using the properties of an int object. The new int constructor is primarily used as a placeholder. An int object is not the same as the int() function that converts a parameter to a primitive value. - - -

Parameters - - - - -
num:Object — The numeric value of the int object being created or a value to be converted to a number. The default value is 0 if value is not provided. - - -
-

-See also -

-
-int.toString() -
-int.valueOf() -
-
-Example -

-
- -
Method detail
- - - - - -
toExponential()method
-
-AS3 function toExponential(fractionDigits:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a string representation of the number in exponential notation. The string contains - - one digit before the decimal point and up to 20 digits after the decimal point, as - - specified by the fractionDigits parameter. - -

Parameters - - - - -
fractionDigits:uint — An integer between 0 and 20, inclusive, that represents the desired number of decimal places. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the fractionDigits argument is outside the range 0 to 20. - -
-
-Example -
The following example shows how toExponential(2) returns a string in - exponential notation. -
-
-
-var num:Number = 315003;
-trace(num.toExponential(2)); // 3.15e+5
-
-

-
- - - - - -
toFixed()method 
-
-AS3 function toFixed(fractionDigits:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a string representation of the number in fixed-point notation. - - Fixed-point notation means that the string will contain a specific number of digits - - after the decimal point, as specified in the fractionDigits parameter. - - The valid range for the fractionDigits parameter is from 0 to 20. - - Specifying a value outside this range throws an exception. - - -

Parameters - - - - -
fractionDigits:uint — An integer between 0 and 20, inclusive, that represents the desired number of decimal places. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the fractionDigits argument is outside the range 0 to 20. - -
-
-Example -
The following example shows how toFixed(3) returns a string that rounds - to three decimal places. -
-
-
-var num:Number = 7.31343;
-trace(num.toFixed(3)); // 7.313
-
-

The following example shows how toFixed(2) returns a string that adds - trailing zeroes. -
-
-
-var num:Number = 4;
-trace(num.toFixed(2)); // 4.00
-
-

-
- - - - - -
toPrecision()method 
-
-AS3 function toPrecision(precision:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a string representation of the number either in exponential notation or in - - fixed-point notation. The string will contain the number of digits specified in the - - precision parameter. - -

Parameters - - - - -
precision:uint — An integer between 1 and 21, inclusive, that represents the desired number of digits to represent in the resulting string. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the precision argument is outside the range 1 to 21. - -
-
-Example -
The following example shows how toPrecision(3) returns a string with - only three digits. The string is in fixed-point notation because exponential notation is not required. -
-
-
-var num:Number = 31.570;
-trace(num.toPrecision(3)); // 31.6
-
-

The following example shows how toPrecision(3) returns a string with - only three digits. The string is in exponential notation because the resulting number does not - contain enough digits for fixed-point notation. -
-
-
-var num:Number = 4000;
-trace(num.toPrecision(3)); // 4.00e+3
-
-

-
- - - - - -
toString()method 
-
-AS3 function toString(radix:uint):String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the string representation of an int object. - - -

Parameters - - - - -
radix:uint — Specifies the numeric base (from 2 to 36) to use for the number-to-string conversion. If you do not specify the radix parameter, the default value is 10. - - -
-

-Returns - - - - -
String — - A string. - - - - -
-
-Example -

-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():int -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the primitive value of the specified int object. - - -

-Returns - - - - -
int — - An int value. - - - - -
-
-Example -

-
- -
Constant detail
- - - - - -
MAX_VALUEconstant
-
-public static const MAX_VALUE:int = 2147483647 -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - The largest representable 32-bit signed integer, which is 2,147,483,647. - - -


-Example -

-
- - - - - -
MIN_VALUEconstant 
-
-public static const MIN_VALUE:int = -2147483648 -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The smallest representable 32-bit signed integer, which is -2,147,483,648. - - -


-Example -

-
- -
Examples
-
examples\IntExample
-
The following example uses the IntExample class to show how - to work with and check the validity of int data types: -
    -
  1. Two int variables a and b are declared in the constructor.
    2. -
  2. The two ints are added using the method addIntegers().
    3. -
  3. A third int variable c is assigned the outcome of parseInteger(), - which checks the validity of the string passed to it to ensure that it is an integer value - in the acceptable range for int data types and returns an int equal to the integer value - of the string if it is valid.
    4. -
  4. The int variables a and c are added together using addIntegers().
    5. -
-
-
-package {
-	import flash.display.Sprite;
-
-	public class IntExample extends Sprite {	
-		public function IntExample() {
-			var a:int = 512;
-			var b:int = -128;
-			
-			trace(addIntegers(a, b)); // 384
-
-			var c:int = parseInteger("32");
-			
-			trace(addIntegers(a, c)); // 544
-		}
-			
-		public function addIntegers(a:int, b:int):int {
-			return a + b;
-		}
-		
-		public function parseInteger(str:String):int {
-			var num:Number = parseInt(str);
-			if(!isNaN(num) && num <= int.MAX_VALUE && num >= int.MIN_VALUE) {
-				return int(num);
-			}
-			
-			return 0;
-		}
-		
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/language-elements.html b/html-docs/language-elements.html deleted file mode 100644 index c730842..0000000 --- a/html-docs/language-elements.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - -Language Elements (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

This section provides syntax, usage information, and code samples for global functions and properties (those elements that do not belong to an ActionScript class); and for the constants, operators, statements, and keywords used in ActionScript and defined in the ECMAScript (ECMA-262) edition 4 draft language specification.

-
- - - - - - - - - - - - - - - - - - - -
 Language ElementDescription
 Global Constants 
 Global Functions 
 OperatorsSymbolic operators are characters that specify how to combine, compare, or modify the values of an expression.
 Statements, Keywords & DirectivesStatements are language elements that perform or specify an action at runtime.
 Special TypesThe three special types are the untyped specifier (*), - void, and Null.
-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:13 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/migration.html b/html-docs/migration.html deleted file mode 100644 index c22ab7e..0000000 --- a/html-docs/migration.html +++ /dev/null @@ -1,2443 +0,0 @@ - - - - - -ActionScript 2.0 Migration (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
-

The following table describes the differences between ActionScript 2.0 and 3.0.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ActionScript 2.0ActionScript 3.0Comments
 Compiler directives
 #endinitclip RemovedThe #endinitclip directive identifies the end of initialization code in ActionScript 2.0, but has no use in ActionScript 3.0.
 #include RemovedSee the include statement for similar functionality.
 #initclip RemovedThe #initclip directive identifies the beginning of initialization code in ActionScript 2.0, but has no use in ActionScript 3.0.
 
 Constants
 false falseThe value false, rather than undefined, is the default value of a Boolean object.
 NaN NaNThe value NaN, rather than undefined, is the default value of a Number object.
 newline RemovedUse the escape sequence composed of the backslash character followed by the character "n" (\n).
 null nullThe value null, rather than undefined, is the default value of the Object and String classes.
 undefined undefinedThe value undefined can be assigned only to untyped variables; it is not the default value of any typed object.
 
 Global functions
 asfunction flash.text.TextField dispatches event: linkReplaced by the new event handling model. You now get the same functionality by using the syntax Event: instead of asfunction:. When a user clicks the link, Flash Player dispatches a TextEvent object of type TextEvent.LINK, which your code can listen for with the addEventListener() method. Any text that you decide to include is stored in the event object's text property.
 call() RemovedThe call() function was deprecated. > Use the function statement for similar functionality.
 chr() RemovedUse String.fromCharCode() instead.
 clearInterval() flash.utils.clearInterval()Moved to flash.utils package.
 clearTimeout() flash.utils.clearTimeout()Moved to flash.utils package.
 duplicateMovieClip() flash.display.MovieClip.MovieClip()Replaced by new MovieClip class constructor function.
 eval() RemovedThere is no equivalent in ActionScript 3.0.
 fscommand() flash.system.fscommand()Moved to flash.system package. Also, see flash.external.ExternalInterface class for JavaScript/ActionScript communication.
 getProperty() RemovedTo directly access properties, use the dot (.) operator.
 getTimer() flash.utils.getTimer()Moved to flash.utils package.
 getURL() flash.net.navigateToURL()Replaced by the navigateToURL() function.
 getVersion() flash.system.Capabilities.versionMoved to Capabilities class and changed to accessor property.
 gotoAndPlay() flash.display.MovieClip.gotoAndPlay()This function is no longer a global function, but is still available as a method of the MovieClip class.
 gotoAndStop() flash.display.MovieClip.gotoAndStop()This function is no longer a global function, but it is still available as a method of the MovieClip class.
 ifFrameLoaded() flash.display.MovieClip.framesLoaded 
 int() int()int() Resurrected from deprecated status as a conversion function for the new int data type.
 length() String.lengthThis property is no longer a global property, but it is still available as a property of the String class.
 loadMovie() flash.display.LoaderUse the Loader class instead.
 loadMovieNum() flash.display.LoaderUse the Loader class instead.
 loadVariables() flash.net.URLLoaderUse the URLLoader class instead.
 loadVariablesNum() flash.net.URLLoaderUse the URLLoader class instead.
 mbchr() String.fromCharCode()Removed. Use the static String.fromCharCode() method instead.
 mblength() String.lengthRemoved. Use String.length instead.
 mbord() String.charCodeAt()Removed. Use String.charCodeAt() instead.
 mbsubstring() String.substr()Removed. Use String.substr() instead.
 nextFrame() flash.display.MovieClip.nextFrame()This function is no longer a global function, but it is still available as a method of the MovieClip class.
 nextScene() flash.display.MovieClip.nextScene()This function is no longer a global function, but it is still available as a method of the MovieClip class.
 on() flash.events.EventDispatcherRemoved. Use the new event handling system in the flash.events package instead.
 onClipEvent() flash.events.EventDispatcherRemoved. Use the new event handling system in the flash.events package instead.
 ord() StringRemoved. Use String class methods instead.
 parseInt() parseInt()A string with a leading 0 is interpreted as decimal rather than octal. For octal numbers, pass the number 8 for the radix parameter.
 play() flash.display.MovieClip.play()This function is no longer a global function, but it is still available as a method of the MovieClip class.
 prevFrame() flash.display.MovieClip.prevFrame()This function is no longer a global function, but it is still available as a method of the MovieClip class.
 prevScene() flash.display.MovieClip.prevScene()This function is no longer a global function, but it is still available as a method of the MovieClip class.
 print() flash.printing.PrintJobRemoved. Use the PrintJob class instead.
 printAsBitmap() flash.printing.PrintJobRemoved. Use the PrintJob class instead.
 printAsBitmapNum() flash.printing.PrintJobRemoved. Use the PrintJob class instead.
 printNum() flash.printing.PrintJobRemoved. Use the PrintJob class instead.
 random() Math.random()Removed. Use Math.random() instead.
 removeMovieClip() RemovedSet all references to a movie clip to null to make the movie clip eligible for garbage collection.
 setInterval() flash.utils.setInterval()Moved to flash.utils package. Consider using the Timer class instead.
 setProperty() RemovedTo set the value of a writable property, use the dot (.) operator.
 setTimeout() flash.utils.setTimeout()Moved to flash.utils package.
 showRedrawRegions() flash.profiler.showRedrawRegions()Moved to flash.profiler package.
 startDrag() flash.display.Sprite.startDrag()This is no longer a global function, but it is still available as a method of the Sprite class.
 stop() flash.display.MovieClip.stop()This is no longer a global function, but it is still available as a method of the MovieClip class.
 stopAllSounds() flash.media.SoundMixer.stopAll()This is no longer a global function, but it is still available as a method of the SoundMixer class, which provides global sound control.
 stopDrag() flash.display.Sprite.stopDrag()This is no longer a global function, but it is still available as a method of the Sprite class.
 substring() String.substring()This is no longer a global function, but it is still available as a method of the String class.
 targetPath() RemovedActionScript 3.0 identifies display objects directly; therefore, identifying a > display object by its path is no longer necessary.
 tellTarget() RemovedUse the dot (.) operator or the with statement instead.
 toggleHighQuality() flash.display.Stage.qualityRemoved as a global property. Use the Stage class version instead.
 trace() trace()The trace() method accepts a comma-delimited list of arguments.
 unloadMovie() flash.display.Loader.unload()Removed. Use Loader.unload() instead.
 unloadMovieNum() flash.display.Loader.unload()Removed. Use Loader.unload() instead.
 updateAfterEvent() flash.events.TimerEvent.updateAfterEvent()This is no longer a global function, but it is still available as a method of the TimerEvent, MouseEvent, and KeyboardEvent classes.
 
 Global properties
 _accProps flash.accessibility.AccessibilityPropertiesReplaced by the AccessibilityProperties class.
 _focusrect flash.display.InteractiveObject.focusRectReplaced by the focusRect property of the InteractiveObject class.
 _global RemovedUse a static member of a class instead.
 _highquality flash.display.Stage.qualityReplaced by the quality property of the Stage class.
 _level RemovedThe concept of levels does not exist in ActionScript 3.0, which instead provides direct access to the display list. See the flash.display package for details.
 maxscroll flash.text.TextFieldReplaced by the maxScrollH and maxScrollV properties of the TextField class.
 _parent flash.display.DisplayObject.parentReplaced by the parent property of the DisplayObject class.
 _quality flash.display.Stage.qualityReplaced by the quality property of the Stage class.
 _root flash.display.DisplayObject.stageRemoved. The closest equivalent is the Stage, which serves as the root of the ActionScript 3.0 display list.
 scroll flash.text.TextFieldRemoved. Replaced by the scrollH and scrollV properties of the TextField class.
 _soundbuftime flash.media.SoundMixer.bufferTimeReplaced by the bufferTime property of the SoundMixer class.
 this thisInstance methods are bound to the instance that implemented the method; therefore, the this reference inside the body of an instance method always refers to the instance that implemented the method.
 
 Operators
 add (concatenation (strings))RemovedUse the concatenation (+) operator instead.
 eq (equality (strings))RemovedUse the equality (==) operator instead.
 gt (greater than (strings))RemovedUse the greater than (>) operator instead.
 ge (greater than or equal to (strings))RemovedUse the greater than or equal to (>=) operator instead.
 <> (inequality)RemovedUse the inequality (!=) operator instead.
 instanceofisAlthough the instanceof operator is available, it only checks the prototype chain, which is not the primary inheritance mechanism in ActionScript 3.0. Use the is operator to check whether an object is a member of a specific data type.
 lt (less than (strings))RemovedUse the less than (<) operator instead.
 le (less than or equal to (strings))RemovedUse the less than or equal to (<=) operator instead.
 and (logical AND)RemovedUse the logical AND (&&) operator instead.
 not (logical NOT)RemovedUse the logical NOT (!) operator instead.
 or (logical OR)RemovedUse the logical OR (||) operator instead.
 ne (not equal (strings))RemovedUse the inequality (!=) operator instead.
 
 Statements
 deletedeleteThe delete operator works only on properties of objects, but not on variables that hold references to objects.
 importimportThe import statement is not optional. To use a class, you must import it, whether or not you use a fully qualified name.
 intrinsicRemovedActionScript 3.0 has a similar, but not identical, keyword named native. The native keyword is similar to intrinsic in that it directs the compiler not to expect a function body, but is dissimilar in that native has no effect on compile-time type checking.
 privateprivateThe ActionScript 3.0 private keyword specifies that an identifier is visible only within a class, and does not extend to subclasses. Moreover, in ActionScript 3.0 the private keyword is enforced at both compile time and run time.
 set variableRemovedUse the assignment (=) operator instead.
 supersuperIn ActionScript 3.0, the call to super() in a subclass constructor does not have to be the first statement in the constructor body.
 
 Accessibility classflash.accessibility.Accessibility 
 isActive() Method flash.accessibility.Accessibility.activeChanged from function to accessor property. Name changed from isActive to active.
 updateProperties() Method flash.accessibility.Accessibility.updateProperties() 
 
 arguments classarguments 
 caller Property RemovedYou can achieve the same functionality by passing arguments.callee from the caller function as an argument to the callee function. See the Examples section of arguments.callee for an example.
 
 Array class 
 CASEINSENSITIVE Constant Array.CASEINSENSITIVEData type changed to uint.
 DESCENDING Constant Array.DESCENDINGData type changed to uint.
 length Property Array.lengthData type changed to uint.
 NUMERIC Constant Array.NUMERICData type changed to uint.
 RETURNINDEXEDARRAY Constant Array.RETURNINDEXEDARRAYData type changed to uint.
 UNIQUESORT Constant Array.UNIQUESORTData type changed to uint.
 Array Constructor Array.Array()Parameter changed to use the ...(rest) parameter format.
 push() Method Array.push()Parameter changed to use the ...(rest) parameter format.
 sort() Method Array.sort()Data type of the options parameter changed to uint.
 sortOn() Method Array.sortOn()Data type of the options parameter changed to uint. The ActionScript 3.0 version also has added functionality; you can now sort on more than one field name by passing an array of objects for the fieldName parameter, and each sort field can have its own matching options parameter if you also pass in a matching array of options flags for the options parameter.
 splice() Method Array.splice()The parameters can have any data type, but the preferred data types are int and uint. The value parameter changed to the ...(rest) parameter format.
 unshift() Method Array.unshift()The value parameter changed to the ...(rest) format. Data type of the return value changed to uint.
 
 AsBroadcaster classflash.events.EventDispatcher 
 _listeners Property[read-only] flash.events.EventDispatcher.willTrigger()Not a direct equivalent. The willTrigger() method tells you whether any listeners are registered, but not how many.
 addListener() Method flash.events.EventDispatcher.addEventListener()Not a direct equivalent, because the ActionScript 3.0 event model lets you add event listeners to any object in the event flow, not just to the broadcasting object.
 broadcastMessage() Method flash.events.EventDispatcher.dispatchEvent()Not a direct equivalent, because the ActionScript 3.0 event model works differently. The dispatchEvent() method dispatches an event object into the event flow, while the broadcastMessage() method sends messages directly to each registered listener object.
 initialize() Method RemovedThere is no direct equivalent in ActionScript 3.0, but similar functionality is achieved by subclassing the EventDispatcher class. For example, the DisplayObject class extends EventDispatcher, so all instances of the DisplayObject and DisplayObject subclasses are capable of sending and receiving event objects.
 removeListener() Method flash.events.EventDispatcher.removeEventListener()Not a direct equivalent, because the ActionScript 3.0 event model lets you add event listeners to and remove them from any object in the event flow, not just the broadcasting object.
 
 BitmapData classflash.display.BitmapDataActionScript 3.0 uses the BitmapDataChannel class as an enumeration of constants that indicate which channel to use.
 height Property[read-only] flash.display.BitmapData.heightData type changed from Number to int.
 rectangle Property[read-only] flash.display.BitmapData.rectProperty renamed for consistency with other members of the API.
 width Property[read-only] flash.display.BitmapData.widthData type changed from Number to int.
 copyChannel() Method flash.display.BitmapData.copyChannel()The sourceChannel and destChannel parameters are now uint data types.
 draw() Method flash.display.BitmapData.draw()The source parameter is now IBitmapDrawable; DisplayObject and BitmapData both implement the IBitmapDrawable interface, so you can pass either a DisplayObject or a BitmapData object to the source parameter.
 fillRect() Method flash.display.BitmapData.fillRect()The color parameter is now a uint value.
 floodFill() Method flash.display.BitmapData.floodFill()Now accepts int values for the x and y parameters and a uint value for color.
 getColorBoundsRect() Method flash.display.BitmapData.getColorBoundsRect()Now accepts uint values for the mask and color parameters.
 getPixel() Method flash.display.BitmapData.getPixel()Now accepts int parameter values and returns a uint value.
 getPixel32() Method flash.display.BitmapData.getPixel32()Now accepts int parameter values and returns a uint value.
 hitTest() Method flash.display.BitmapData.hitTest()Now accepts uint values for the firstAlphaThreshold and secondAlphaThreshold parameters.
 loadBitmap() Method RemovedThis function is no longer needed because of the new bitmap support in ActionScript 3.0.
 merge() Method flash.display.BitmapData.merge()Now accepts uint values for the multiplier parameters.
 noise() Method flash.display.BitmapData.noise()Now accepts an int value for the randomSeed parameter and uint values for the low, high, and channelOptions parameters.
 perlinNoise() Method flash.display.BitmapData.perlinNoise()Now accepts an int value for the randomSeed parameter and uint values for the numOctaves and channelOptions parameters.
 pixelDissolve() Method flash.display.BitmapData.pixelDissolve()Now accepts an int value for the randomSeed and numPixels parameters and a uint value for the fillColor parameter. (The numPixels parameter is named numberOfPixels in ActionScript 2.0.)
 scroll() Method flash.display.BitmapData.scroll()Now accepts int values for the x and y parameters.
 setPixel() Method flash.display.BitmapData.setPixel()Now accepts int values for the x and y parameters and a uint value for color.
 setPixel32() Method flash.display.BitmapData.setPixel32()Now accepts int values for the x and y parameters and a unit value for color.
 threshold() Method flash.display.BitmapData.threshold()Now accepts uint values for the threshold, color, and mask parameters, and returns a uint value.
 
 BlurFilter class 
 quality Property flash.filters.BlurFilter.qualityThe quality property data type changed from a Number to uint.
 
 Button classflash.display.SimpleButton 
 _alpha Property flash.display.DisplayObject.alpha 
 blendMode Property flash.display.DisplayObject.blendMode 
 cacheAsBitmap Property flash.display.DisplayObject.cacheAsBitmap 
 enabled Property flash.display.SimpleButton.enabled 
 filters Property flash.display.DisplayObject.filtersIn ActionScript 3.0, the data type is Array.
 _focusrect Property flash.display.InteractiveObject.focusRect 
 _height Property flash.display.DisplayObject.height 
 _highquality Property RemovedSee Stage.quality.
 _name Property flash.display.DisplayObject.name 
 _parent Property flash.display.DisplayObject.parent 
 _quality Property RemovedYou can set rendering quality for all display objects by using flash.display.Stage.quality.
 _rotation Property flash.display.DisplayObject.rotation 
 scale9Grid Property flash.display.DisplayObject.scale9Grid 
 _soundbuftime Property flash.media.SoundMixer.bufferTimeMoved to the SoundMixer class, which is used for global sound control. Renamed without abbreviations. Removed the initial underscore from the name.
 tabEnabled Property flash.display.InteractiveObject.tabEnabled 
 tabIndex Property flash.display.InteractiveObject.tabIndex 
 _target Property[read-only] RemovedActionScript 3.0 identifies display objects directly; therefore, identifying a display object by its path is no longer necessary.
 trackAsMenu Property flash.display.SimpleButton.trackAsMenu 
 _url Property[read-only] RemovedSee DisplayObject.loaderInfo.url.
 useHandCursor Property flash.display.SimpleButton.useHandCursor 
 _visible Property flash.display.DisplayObject.visible 
 _width Property flash.display.DisplayObject.width 
 _x Property flash.display.DisplayObject.x 
 _xmouse Property[read-only] flash.display.DisplayObject.mouseX 
 _xscale Property flash.display.DisplayObject.scaleX 
 _y Property flash.display.DisplayObject.y 
 _ymouse Property[read-only] flash.display.DisplayObject.mouseY 
 _yscale Property flash.display.DisplayObject.scaleY 
 getDepth() Method flash.display.DisplayObjectContainer.getChildIndex()ActionScript 3.0 provides direct access to the display list, so depth is handled differently.
 onDragOut() EventHandler flash.display.InteractiveObject dispatches event: mouseOutReplaced in the new event model by a mouseOut event.
 onDragOver() EventHandler flash.display.InteractiveObject dispatches event: mouseOverReplaced in the new event model by a mouseOver event.
 onKeyDown() EventHandler flash.display.InteractiveObject dispatches event: keyDownReplaced in the new event model by a keyDown event.
 onKeyUp() EventHandler flash.display.InteractiveObject dispatches event: keyUpReplaced in the new event model by a keyUp event.
 onKillFocus() EventHandler flash.display.InteractiveObject dispatches event: focusOutReplaced in the new event model by a focusOut event.
 onPress() EventHandler flash.display.InteractiveObject dispatches event: mouseDownReplaced in the new event model by a mouseDown event.
 onRelease() EventHandler flash.display.InteractiveObject dispatches event: mouseUpReplaced in the new event model by a mouseUp event.
 onReleaseOutside() EventHandler flash.display.InteractiveObject dispatches event: mouseUpReplaced in the new event model by a mouseUp event.
 onRollOut() EventHandler flash.display.InteractiveObject dispatches event: mouseOutReplaced in the new event model by a mouseOut event.
 onRollOver() EventHandler flash.display.InteractiveObject dispatches event: mouseOverReplaced in the new event model by a mouseOver event.
 onSetFocus() EventHandler flash.display.InteractiveObject dispatches event: focusInReplaced in the new event model by a focusIn event.
 
 Camera classflash.media.Camera 
 activityLevel Property[read-only] flash.media.Camera.activityLevel 
 bandwidth Property[read-only] flash.media.Camera.bandwidth 
 currentFps Property[read-only] flash.media.Camera.currentFPSChange in capitalization of FPS.
 fps Property[read-only] flash.media.Camera.fps 
 height Property[read-only] flash.media.Camera.heightData type changed from Number to int.
 index Property[read-only] flash.media.Camera.indexData type changed from String to int.
 motionLevel Property[read-only] flash.media.Camera.motionLevelData type changed from Number to int.
 motionTimeOut Property[read-only] flash.media.Camera.motionTimeoutData type changed from Number to int.
 muted Property[read-only] flash.media.Camera.muted 
 name Property[read-only] flash.media.Camera.name 
 names Property[read-only] flash.media.Camera.names 
 quality Property[read-only] flash.media.Camera.qualityData type changed from Number to int.
 width Property[read-only] flash.media.Camera.widthData type changed from Number to int.
 get() Method flash.media.Camera.getCamera() 
 onActivity() EventHandler flash.events.ActivityEvent.ACTIVITY 
 onStatus() EventHandler flash.media.Camera dispatches event: statusReplaced in the new event model by a status StatusEvent object.
 setMode() Method flash.media.Camera.setMode()The width and height parameters changed to data type int.
 setMotionLevel() Method flash.media.Camera.setMotionLevel()Both parameters changed to data type int.
 setQuality() Method flash.media.Camera.setQuality()Both parameters changed to data type int.
 
 capabilities classflash.system.CapabilitiesThe class name changed from lowercase to initial capitalization.
 
 Color classflash.geom.ColorTransformThe Color class has been removed because all of its functionality can be achieved with the flash.geom.ColorTransform class. Color values can be assigned directly by using the ColorTransform class constructor or properties. ColorTransform objects can then be assigned to the colorTransform property of a Transform object, which in turn can be assigned to the transform property of a DisplayObject instance.
 Color Constructor flash.geom.ColorTransform.ColorTransform()Removed. You can specify color values by using the ColorTransform() constructor.
 getRGB() Method flash.geom.ColorTransform.colorThe RGB color value can be accessed by using the color accessor property of the ColorTransform class.
 getTransform() Method RemovedColor values can be assigned directly by using the ColorTransform() class constructor or properties.
 setRGB() Method flash.geom.ColorTransform.colorThe RGB color value can be set by using the color accessor property of the ColorTransform class.
 setTransform() Method RemovedColor values can be assigned directly by using the ColorTransform() class constructor or properties.
 
 ContextMenu classflash.ui.ContextMenuThe ContextMenu class is now part of the flash.ui package.
 builtInItems Property flash.ui.ContextMenu.builtInItems 
 customItems Property flash.ui.ContextMenu.customItems 
 ContextMenu Constructor flash.ui.ContextMenu.ContextMenu() 
 copy() Method flash.ui.ContextMenu.clone() 
 hideBuiltInItems() Method flash.ui.ContextMenu.hideBuiltInItems() 
 onSelect() EventHandler flash.ui.ContextMenu dispatches event: menuSelectInstead of invoking the onSelect() event handler, the ActionScript 3.0 class dispatches a menuSelect event.
 
 ContextMenuItem classflash.ui.ContextMenuItemThe ContextMenuItem class is now part of the flash.ui package.
 caption Property flash.ui.ContextMenuItem.caption 
 enabled Property flash.ui.ContextMenuItem.enabled 
 separatorBefore Property flash.ui.ContextMenuItem.separatorBefore 
 visible Property flash.ui.ContextMenuItem.visible 
 ContextMenuItem Constructor flash.ui.ContextMenuItem.ContextMenuItem() 
 copy() Method flash.ui.ContextMenuItem.clone() 
 onSelect() EventHandler flash.ui.ContextMenuItem dispatches event: menuItemSelectInstead of invoking the onSelect() event handler, the ActionScript 3.0 class dispatches a menuSelect event.
 
 ConvolutionFilter class 
 clone() Method flash.filters.ConvolutionFilter.clone()Now returns a BitmapFilter object.
 
 Date classDateActionScript 3.0 includes a new set of read accessors for all the methods that start with getxxx(). For example, in ActionScript 3.0, Date.getDate() and Date.date return the same value.
 getUTCYear() Method Date.getUTCFullYear()This method was removed because it is not part of ECMAScript. Use Date.getUTCFullYear() instead.
 getYear() Method Date.getFullYear()This method was removed because it is not part of ECMAScript. Use Date.getFullYear() instead.
 setYear() Method Date.setFullYear()This method was removed because it is not part of ECMAScript. Use Date.setFullYear() instead.
 
 DisplacementMapFilter classflash.filters.DisplacementMapFilterThe data type of several parameters changed from Number to uint.
 color Property flash.filters.DisplacementMapFilter.colorThe data type of this parameter is now uint.
 componentX Property flash.filters.DisplacementMapFilter.componentXThe data type of this parameter is now uint.
 componentY Property flash.filters.DisplacementMapFilter.componentYThe data type of this parameter is now uint.
 DisplacementMapFilter Constructor flash.filters.DisplacementMapFilter.DisplacementMapFilter()The data type of the componentX, componentY, and color parameters is now uint.
 clone() Method flash.filters.DisplacementMapFilter.clone()Now returns a BitmapFilter object.
 
 DropShadowFilter classflash.filters.DropShadowFilter 
 color Property flash.filters.DropShadowFilter.colorThe data type of this parameter changed from Number to uint.
 quality Property flash.filters.DropShadowFilter.qualityThe data type of this parameter changed from Number to uint.
 DropShadowFilter Constructor flash.filters.DropShadowFilter.DropShadowFilter()All parameters now have a default value, and some parameter types have changed.
 clone() Method flash.filters.DropShadowFilter.clone()Now returns a BitmapFilter object instead of a DropShadowFilter object.
 
 Error classErrorAdded a new getStackTrace() method to assist in debugging.
 
 ExternalInterface classflash.external.ExternalInterfaceParameters changed for two methods in this class.
 addCallback() Method flash.external.ExternalInterface.addCallback()The ActionScript 3.0 version of this method does not accept the instance parameter. The method parameter is replaced by a closure parameter, which can take a reference to a function, a class method, or a method of a particular class instance. In addition, if the calling code cannot access the closure reference for security reasons, a SecurityError exception is thrown.
 call() Method flash.external.ExternalInterface.call()If a problem occurs, the ActionScript 3.0 version of this method throws an Error or SecurityError exception, in addition to returning null.
 
 FileReference classflash.net.FileReferenceThe ActionScript 3.0 version inherits the addEventListener() and removeEventListener() methods from the EventDispatcher class. Dispatched events replace the event handler functions.
 postData Property flash.net.URLRequest.dataThe postData property is added to ActionScript 2.0 in Flash Player 9 to send POST data with the file upload or download. In ActionScript 3.0, use the data property of the URLRequest class to send either POST or GET data. See flash.net.URLRequest.data in this language reference for details.
 size Property[read-only] flash.net.FileReference.sizeReturns a uint data type instead of a Number data type.
 addListener() Method flash.events.EventDispatcher.addEventListener()In the new event model, there is no need to have a class-specific addListener() method, because the class inherits the addEventListener() method from the EventDispatcher class.
 browse() Method flash.net.FileReference.browse()In ActionScript 2.0, returns false when there is an error. In ActionScript 3.0, throws an IllegalOperationError or ArgumentError exception. However, the method still returns false if the parameters are invalid, the file-browsing dialog box does not open, or another browser session is in progress. Also, the typelist parameter changed. In ActionScript 2.0, you can pass the browse() method an array of strings to specify a file filter. In ActionScript 3.0, you pass an array of FileFilter objects.
 download() Method flash.net.FileReference.download()When an error occurs, throws exceptions instead of returning false. The data type for the first parameter has changed. In ActionScript 2.0, the first parameter you pass to download() is a string. In ActionScript 3.0, you pass a URLRequest object.
 removeListener() Method flash.events.EventDispatcher.removeEventListener()In the new event model, there is no need to have a class-specific removeListener() method, because the class inherits the removeEventListener() method from the EventDispatcher class.
 upload() Method flash.net.FileReference.upload()Various changes have occurred:
  • The data type for the first parameter has changed. In ActionScript 2.0, the first parameter you pass to upload() is a string. In ActionScript 3.0, you pass a URLRequest object.
  • In ActionScript 3.0, there is a new second parameter, uploadDataFieldName, which is the field name that precedes the file data in the upload POST operation.
  • In ActionScript 3.0, there is a new third parameter, testUpload, that lets you control whether Flash Player performs a test upload before uploading the file.
  • When an error occurs, browse() throws exceptions instead of returning false.
 onCancel Listener flash.net.FileReference dispatches event: cancelIn ActionScript 3.0, instead of invoking the onCancel() event handler, this class dispatches an event named cancel.
 onComplete Listener flash.net.FileReference dispatches event: completeIn ActionScript 3.0, instead of invoking the onComplete() event handler, this class dispatches an event named complete.
 onHTTPError Listener flash.net.FileReference dispatches event: httpStatusIn ActionScript 3.0, instead of invoking the onHTTPError() event handler, this class dispatches an event named httpStatus.
 onIOError Listener flash.net.FileReference dispatches event: ioErrorIn ActionScript 3.0, instead of invoking the onIOError() event handler, this class dispatches an event named ioError.
 onOpen Listener flash.net.FileReference dispatches event: openIn ActionScript 3.0, instead of invoking the onOpen() event handler, this class dispatches an event named open.
 onProgress Listener flash.net.FileReference dispatches event: progressIn ActionScript 3.0, instead of invoking the onProgress() event handler, this class dispatches an event named progress.
 onSecurityError Listener flash.net.FileReference dispatches event: securityErrorIn ActionScript 3.0, instead of invoking the onSecurityError() event handler, this class dispatches an event named securityError.
 onSelect Listener flash.net.FileReference dispatches event: selectIn ActionScript 3.0, instead of invoking the onSelect() event handler, this class dispatches an event named select.
 onUploadCompleteData flash.net.FileReference dispatches event: completeIn ActionScript 3.0, instead of invoking the onUploadCompleteData() event handler, this class dispatches an event named uploadCompleteData.
 
 FileReferenceList classflash.net.FileReferenceListThe ActionScript 3.0 class inherits the addEventListener() and removeEventListener() methods from the EventDispatcher class. Instead of the onCancel() and onSelect() event handlers, the ActionScript 3.0 class uses events named cancel and select.
 addListener() Method flash.events.EventDispatcher.addEventListener()In the new event model, there is no need to have a class-specific addListener() method, because the class inherits the addEventListener() method from the EventDispatcher class.
 browse() Method flash.net.FileReferenceList.browse()In ActionScript 3.0, instead of returning false when there is an error, this method throws an IllegalOperationError exception. Also, the typelist parameter changed. In ActionScript 2.0, you can pass the browse() method an array of strings to specify a file filter. In ActionScript 3.0, you pass an array of FileFilter objects.
 removeListener() Method flash.events.EventDispatcher.removeEventListener()In the new event model, there is no need to have a class-specific removeListener() method, because the class inherits the removeEventListener() method from the EventDispatcher class.
 onCancel Listener flash.net.FileReferenceList dispatches event: cancelIn ActionScript 3.0, instead of invoking the onCancel() event handler, this class dispatches an event named cancel.
 onSelect Listener flash.net.FileReferenceList dispatches event: selectIn ActionScript 3.0, instead of invoking the onSelect() event handler, this class dispatches an event named select.
 
 GlowFilter classflash.filters.GlowFilterThe data type of several properties changed from Number to unit.
 color Property flash.filters.GlowFilter.colorThe data type of this property changed from Number to unit.
 quality Property flash.filters.GlowFilter.qualityThe data type of this property changed from Number to unit.
 GlowFilter Constructor flash.filters.GlowFilter.GlowFilter()The color and quality parameters are now uint and int data types, respectively, instead of Number. All parameters are now assigned a default value.
 clone() Method flash.filters.GlowFilter.clone()Returns a BitmapFilter object instead of a GlowFilter object.
 
 GradientBevelFilter classflash.filters.GradientBevelFilter 
 quality Property flash.filters.GradientBevelFilter.qualityThe data type of this property changed from Number to int.
 clone() Method flash.filters.GradientBevelFilter.clone()Returns a BitmapFilter object instead of a GradientBevelFilter object.
 
 GradientGlowFilter classflash.filters.GradientGlowFilter 
 quality Property flash.filters.GradientGlowFilter.qualityThe data type of this property changed from Number to int.
 GradientGlowFilter Constructor flash.filters.GradientGlowFilter.GradientGlowFilter()Default values added to all parameters and the data type of the quality parameter changed from Number to int.
 clone() Method flash.filters.GradientGlowFilter.clone()Returns a BitmapFilter object instead of a GradientGlowFilter object.
 
 IME classflash.system.IMEThis class has been moved to the flash.system package.
 ALPHANUMERIC_FULL Constant flash.system.IMEConversionMode.ALPHANUMERIC_FULL 
 ALPHANUMERIC_HALF Constant flash.system.IMEConversionMode.ALPHANUMERIC_HALF 
 CHINESE Constant flash.system.IMEConversionMode.CHINESE 
 JAPANESE_HIRAGANA Constant flash.system.IMEConversionMode.JAPANESE_HIRAGANA 
 JAPANESE_KATAKANA_FULL Constant flash.system.IMEConversionMode.JAPANESE_KATAKANA_FULL 
 JAPANESE_KATAKANA_HALF Constant flash.system.IMEConversionMode.JAPANESE_KATAKANA_HALF 
 KOREAN Constant flash.system.IMEConversionMode.KOREAN 
 UNKNOWN Constant flash.system.IMEConversionMode.UNKNOWN 
 addListener() Method flash.events.EventDispatcher.addEventListener()In the new event model, there is no need to have a class-specific addListener() method, because the class inherits the addEventListener() method from the EventDispatcher class.
 getConversionMode() Method flash.system.IME.conversionModeChanged to an accessor property.
 getEnabled() Method flash.system.IME.enabledChanged to an accessor property.
 removeListener() Method flash.events.EventDispatcher.removeEventListener()In the new event model, there is no need to have a class-specific removeListener() method, because the class inherits the removeEventListener() method from the EventDispatcher class.
 setConversionMode() Method flash.system.IME.conversionModeChanged to an accessor property.
 setEnabled() Method flash.system.IME.enabledChanged to an accessor property.
 onIMEComposition Listener flash.system.IME dispatches event: imeCompositionIn ActionScript 3.0, instead of invoking the onIMEComposition() event handler, this class dispatches an event named imeComposition.
 
 Key classflash.ui.KeyboardThis class has a new name in ActionScript 3.0 to match other classes that pertain to the Keyboard class, such as KeyboardEvent.
 BACKSPACE Constant flash.ui.Keyboard.BACKSPACEDeclared as a constant in ActionScript 3.0 and data type changed to unit.
 CAPSLOCK Constant flash.ui.Keyboard.CAPS_LOCKDeclared as a constant in ActionScript 3.0, underscore added, and data type changed to uint.
 CONTROL Constant flash.ui.Keyboard.CONTROLDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 DELETEKEY Constant flash.ui.Keyboard.DELETEName changed to DELETE in ActionScript 3.0, declared as a constant, and data type changed to uint.
 DOWN Constant flash.ui.Keyboard.DOWNDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 END Constant flash.ui.Keyboard.ENDDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 ENTER Constant flash.ui.Keyboard.ENTERDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 ESCAPE Constant flash.ui.Keyboard.ESCAPEDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 HOME Constant flash.ui.Keyboard.HOMEDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 INSERT Constant flash.ui.Keyboard.INSERTDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 LEFT Constant flash.ui.Keyboard.LEFTDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 _listeners Property[read-only] flash.events.EventDispatcher.willTrigger()Not a direct equivalent. The willTrigger() method tells you whether any listeners are registered, but not how many.
 PGDN Constant flash.ui.Keyboard.PAGE_DOWNName changed to PAGE_DOWN in ActionScript 3.0, declared as a constant, and data type changed to uint.
 PGUP Constant flash.ui.Keyboard.PAGE_UPName changed to PAGE_UP in ActionScript 3.0, declared as a constant, and data type changed to uint.
 RIGHT Constant flash.ui.Keyboard.RIGHTDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 SHIFT Constant flash.ui.Keyboard.SHIFTDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 SPACE Constant flash.ui.Keyboard.SPACEDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 TAB Constant flash.ui.Keyboard.TABDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 UP Constant flash.ui.Keyboard.UPDeclared as a constant in ActionScript 3.0 and data type changed to uint.
 addListener() Method flash.events.EventDispatcher.addEventListener()In ActionScript 3.0, there is no need to have a class-specific addListener() method, because all display objects inherit the addEventListener() method from the EventDispatcher class.
 getAscii() Method flash.events.KeyboardEvent.charCode 
 getCode() Method flash.events.KeyboardEvent.keyCode 
 isAccessible() Method flash.ui.Keyboard.isAccessible() 
 isDown() Method RemovedRemoved for security reasons.
 isToggled() Method RemovedRemoved for security reasons.
 removeListener() Method flash.events.EventDispatcher.removeEventListener()In ActionScript 3.0, there is no need to have a class-specific removeListener() method, because all display objects inherit the removeEventListener() method from the EventDispatcher class.
 onKeyDown Listener flash.display.InteractiveObject dispatches event: keyDownIn ActionScript 3.0, instead of invoking the onKeyDown event handler, the InteractiveObject class dispatches a keyDown KeyboardEvent object.
 onKeyUp Listener flash.display.InteractiveObject dispatches event: keyUpIn ActionScript 3.0, instead of invoking the onKeyUp event handler, the InteractiveObject class dispatches a keyUp KeyboardEvent object.
 
 LoadVars classflash.net.URLLoaderThe LoadVars class functionality is replaced by the URLLoader, URLRequest, URLStream, and URLVariables classes.
 contentType Property flash.net.URLRequest.contentType 
 loaded Property RemovedThere is no corresponding Boolean property in ActionScript 3.0, but you can use flash.events.Event.COMPLETE to set up listeners that receive notification when data is loaded.
 LoadVars Constructor flash.net.URLLoader.URLLoader() 
 addRequestHeader() Method flash.net.URLRequestHeader 
 decode() Method flash.net.URLVariables.decode() 
 getBytesLoaded() Method flash.net.URLLoader.bytesLoadedClass changed to URLLoader; changed from function to property accessor; and name changed from getBytesLoaded to bytesLoaded.
 getBytesTotal() Method flash.net.URLLoader.bytesTotalClass changed to URLLoader; changed from function to property accessor; and name changed from getBytesTotal to bytesTotal.
 load() Method flash.net.URLLoader.load() 
 onData() EventHandler flash.net.URLLoader dispatches event: completeSee the URLLoader class. A complete event is dispatched when the download operation is complete but before any data is parsed.
 onHTTPStatus() EventHandler flash.net.URLLoader dispatches event: httpStatusIn ActionScript 3.0, instead of invoking the onHTTPStatus event handler, the URLLoader class dispatches an HTTPStatusEvent object named httpStatus.
 onLoad() EventHandler flash.net.URLLoader dispatches event: completeSee the URLLoader class. A complete event is dispatched when the download operation is complete.
 send() Method flash.net.sendToURL() 
 sendAndLoad() Method flash.net.sendToURL()The sendToURL() method sends a URL request to the server, but ignores the response. To receive the response, use flash.net.sendToURL().
 toString() Method RemovedThis method is no longer necessary in ActionScript 3.0.
 
 LocalConnection classflash.net.LocalConnectionThis class has been moved to the flash.net package.
 LocalConnection Constructor flash.net.LocalConnection.LocalConnection() 
 allowDomain() EventHandler flash.net.LocalConnection.allowDomain()Changed to a regular method in ActionScript 3.0, no longer an event handler. Parameter changed to use the ...(rest) parameter format. Return value changed to void.
 allowInsecureDomain() EventHandler flash.net.LocalConnection.allowInsecureDomain()Changed to a regular method in ActionScript 3.0, no longer an event handler. Parameter changed to use the ...(rest) parameter format. Return value changed to void.
 close() Method flash.net.LocalConnection.close() 
 connect() Method flash.net.LocalConnection.connect() 
 domain() Method flash.net.LocalConnection.domainChanged to a property accessor.
 onStatus() EventHandler flash.net.LocalConnection dispatches event: statusIn the new event model, callback functions are replaced by event objects.
 send() Method flash.net.LocalConnection.send()Third parameter changed to use the ...(rest) parameter format. Return type changed to void.
 
 Microphone classflash.media.MicrophoneThis class has been moved to the flash.media package.
 index Property[read-only] flash.media.Microphone.indexData type changed to uint.
 rate Property[read-only] flash.media.Microphone.rateData type changed to uint.
 silenceTimeOut Property[read-only] flash.media.Microphone.silenceTimeoutChange in capitalization to "Timeout." Data type changed to int.
 get() Method flash.media.Microphone.getMicrophone()Name changed from get() to getMicrophone(). Data type of parameter changed to uint.
 onActivity() EventHandler flash.media.Microphone dispatches event: activityIn ActionScript 3.0, instead of invoking the onActivity event handler, this class dispatches an activity event.
 onStatus() EventHandler flash.media.Microphone dispatches event: statusIn ActionScript 3.0, instead of invoking the onStatus event handler, this class dispatches a status event.
 setGain() Method flash.media.Microphone.gainCombined gain property and setGain() method into a get/set property accessor named gain. Data type changed to uint.
 setRate() Method flash.media.Microphone.rateCombined rate property and setRate() method into a get/set property accessor named rate. Data type changed to uint.
 setSilenceLevel() Method flash.media.Microphone.setSilenceLevel()Data type of timeOut parameter changed to int. Capitalization of the timeOut parameter changed to timeout.
 setUseEchoSuppression() Method flash.media.Microphone.setUseEchoSuppression() 
 
 Mouse classflash.ui.Mouse 
 addListener() Method flash.events.EventDispatcher.addEventListener()In the new ActionScript 3.0 event model, there is no need to have a class-specific addListener() method, because all display objects inherit the addEventListener() method from the EventDispatcher class.
 hide() Method flash.ui.Mouse.hide()Changed to return void.
 removeListener() Method flash.events.EventDispatcher.removeEventListener()In the new ActionScript 3.0 event model, there is no need to have a class-specific removeListener() method, because all display objects inherit the removeEventListener() method from the EventDispatcher class.
 show() Method flash.ui.Mouse.show()Changed to return void.
 onMouseDown Listener flash.display.InteractiveObject dispatches event: mouseDownReplaced in the new event model by a mouseDown event.
 onMouseMove Listener flash.display.InteractiveObject dispatches event: mouseMoveReplaced in the new event model by a mouseMove event.
 onMouseUp Listener flash.display.InteractiveObject dispatches event: mouseUpReplaced in the new event model by a mouseUp event.
 onMouseWheel Listener flash.display.InteractiveObject dispatches event: mouseWheelReplaced in the new event model by a mouseWheel event.
 
 MovieClip classflash.display.MovieClipMany of the MovieClip methods have been moved to other classes in ActionScript 3.0. All event handlers have been replaced by event objects in the new event model.
 _alpha Property flash.display.DisplayObject.alphaMoved to DisplayObject class and removed initial underscore from name.
 blendMode Property flash.display.DisplayObject.blendMode 
 cacheAsBitmap Property flash.display.DisplayObject.cacheAsBitmap 
 _currentframe Property[read-only] flash.display.MovieClip.currentFrameRemoved initial underscore from name.
 _droptarget Property[read-only] flash.display.Sprite.dropTargetMoved to Sprite class, removed initial underscore from name, and changed to mixed case.
 filters Property flash.display.DisplayObject.filters 
 focusEnabled Property RemovedIn ActionScript 3.0, all interactive objects are focus enabled; therefore, this property is no longer needed.
 _focusrect Property flash.display.InteractiveObject.focusRectMoved to InteractiveObject class, removed initial underscore from name, and changed to mixed case.
 _framesloaded Property[read-only] flash.display.MovieClip.framesLoadedRemoved initial underscore from name and changed to mixed case.
 _height Property flash.display.DisplayObject.heightMoved to DisplayObject class and removed initial underscore from name.
 _highquality Property RemovedSee Stage.quality.
 hitArea Property flash.display.Sprite.hitAreaMoved to Sprite class.
 _lockroot Property RemovedIn ActionScript 3.0, the root of a display object is set automatically; therefore, the _lockroot property is effectively always on. See flash.display.DisplayObject.root for details.
 menu Property RemovedSee InteractiveObject.contextMenu.
 _name Property flash.display.DisplayObject.nameMoved to DisplayObject class and removed initial underscore from name.
 opaqueBackground Property flash.display.DisplayObject.opaqueBackground 
 _parent Property flash.display.DisplayObject.parentMoved to DisplayObject class and removed initial underscore from name.
 _quality Property flash.display.Stage.quality 
 _rotation Property flash.display.DisplayObject.rotationMoved to DisplayObject class and removed initial underscore from name.
 scale9Grid Property flash.display.DisplayObject.scale9Grid 
 scrollRect Property flash.display.DisplayObject.scrollRectChanged to Rectangle data type.
 _soundbuftime Property flash.media.SoundMixer.bufferTimeMoved to SoundMixer class, which is used for global sound control, renamed without abbreviations, and removed initial underscore from name.
 tabChildren Property flash.display.DisplayObjectContainer.tabChildren 
 tabEnabled Property flash.display.InteractiveObject.tabEnabled 
 tabIndex Property flash.display.InteractiveObject.tabIndex 
 _target Property[read-only] RemovedActionScript 3.0 identifies display objects directly; therefore, identifying a display object by its path is no longer necessary.
 _totalframes Property[read-only] flash.display.MovieClip.totalFramesChanged to mixed case and removed initial underscore from name.
 trackAsMenu Property flash.display.MovieClip.trackAsMenu 
 transform Property flash.display.DisplayObject.transform 
 _url Property[read-only] flash.display.Loader.contentLoaderInfo 
 useHandCursor Property flash.display.Sprite.useHandCursor 
 _visible Property flash.display.DisplayObject.visibleMoved to DisplayObject class and removed initial underscore from name.
 _width Property flash.display.DisplayObject.widthMoved to DisplayObject class and removed initial underscore from name.
 _x Property flash.display.DisplayObject.xMoved to DisplayObject class and removed initial underscore from name.
 _xmouse Property[read-only] flash.display.DisplayObject.mouseXMoved to DisplayObject class, changed name to mouseX, and removed initial underscore from name.
 _xscale Property flash.display.DisplayObject.scaleXMoved to DisplayObject class, changed name to scaleX, and removed initial underscore from name.
 _y Property flash.display.DisplayObject.yMoved to DisplayObject class and removed initial underscore from name.
 _ymouse Property[read-only] flash.display.DisplayObject.mouseYMoved to DisplayObject class, changed name to mouseY, and removed initial underscore from name.
 _yscale Property flash.display.DisplayObject.scaleYMoved to DisplayObject class, changed name to scaleY, and removed initial underscore from name.
 attachAudio() Method RemovedIf the audio source is a Microphone object, use NetStream.attachAudio() or Microphone.setLoopBack().

If the audio source is an FLV file, use Video.attachNetStream() and a NetStream object.

 attachBitmap() Method RemovedIn ActionScript 3.0, use addChild() to add child display objects.
 attachMovie() Method RemovedIn ActionScript 3.0, use addChild() to add child display objects.
 beginBitmapFill() Method flash.display.Graphics.beginBitmapFill() 
 beginFill() Method flash.display.Graphics.beginFill()Moved to Graphics class and changed data type of the first parameter to uint.
 beginGradientFill() Method flash.display.Graphics.beginGradientFill() 
 clear() Method flash.display.Graphics.clear() 
 createEmptyMovieClip() Method RemovedIn ActionScript 3.0, use the new operator to create movie clips.
 createTextField() Method RemovedIn ActionScript 3.0, use the new operator to create text fields.
 curveTo() Method flash.display.Graphics.curveTo() 
 duplicateMovieClip() Method RemovedIn ActionScript 3.0, use the new operator to create a new instance.
 endFill() Method flash.display.Graphics.endFill() 
 getBounds() Method flash.display.DisplayObject.getBounds() 
 getBytesLoaded() Method flash.net.URLLoader.bytesLoadedMoved to URLLoader class and data type changed from Number to int.
 getBytesTotal() Method flash.net.URLLoader.bytesTotalMoved to URLLoader class and data type changed from Number to int.
 getDepth() Method flash.display.DisplayObjectContainer.getChildIndex()ActionScript 3.0 provides direct access to the display list, so depth is handled differently.
 getInstanceAtDepth() Method flash.display.DisplayObjectContainer.getChildAt()ActionScript 3.0 provides direct access to the display list, so depth is handled differently.
 getNextHighestDepth() Method flash.display.DisplayObjectContainer.addChild()Not a direct equivalent, but the addChild() method adds a child behind all other children of the DisplayObjectContainer instance, so there is no need for a method that determines the next available depth.
 getRect() Method flash.display.DisplayObject.getRect() 
 getSWFVersion() Method flash.display.LoaderInfo.swfVersionMoved to LoaderInfo class and changed data type to uint.
 getTextSnapshot() Method flash.display.DisplayObjectContainer.textSnapshot 
 getURL() Method flash.net.navigateToURL()Replaced by the flash.net.navigateToURL() and flash.net.sentToURL() methods. Also see URLLoader class.
 globalToLocal() Method flash.display.DisplayObject.globalToLocal() 
 gotoAndStop() Method flash.display.MovieClip.gotoAndStop() 
 hitTest() Method flash.display.DisplayObject.hitTestObject() 
 lineGradientStyle() Method flash.display.Graphics.lineGradientStyle() 
 lineStyle() Method flash.display.Graphics.lineStyle() 
 lineTo() Method flash.display.Graphics.lineTo() 
 loadMovie() Method flash.display.Loader.load()See Loader class.
 loadVariables() Method flash.net.URLLoaderRemoved. See URLLoader class.
 localToGlobal() Method flash.display.DisplayObject.localToGlobal() 
 moveTo() Method flash.display.Graphics.moveTo() 
 nextFrame() Method flash.display.MovieClip.nextFrame() 
 onData() EventHandler flash.display.LoaderInfo dispatches event: completeReplaced in the new event model by a complete event, which is dispatched when the download operation is complete but before any data is parsed.
 onDragOut() EventHandler flash.display.InteractiveObject dispatches event: mouseOutReplaced in the new event model by a mouseOut event.
 onDragOver() EventHandler flash.display.InteractiveObject dispatches event: mouseOverReplaced in the new event model by a mouseOver event.
 onEnterFrame() EventHandler flash.display.DisplayObject dispatches event: enterFrameReplaced in the new event model by an enterFrame event.
 onKeyDown() EventHandler flash.display.InteractiveObject dispatches event: keyDownReplaced in the new event model by a keyDown event.
 onKeyUp() EventHandler flash.display.InteractiveObject dispatches event: keyUpReplaced in the new event model by a keyUp event.
 onKillFocus() EventHandler flash.display.InteractiveObject dispatches event: focusOutReplaced in the new event model by a focusOut event.
 onLoad() EventHandler flash.display.LoaderInfo dispatches event: completeAlso see URLLoader class. A complete event is dispatched when the download operation is complete.
 onMouseDown() EventHandler flash.display.InteractiveObject dispatches event: mouseDownReplaced in the new event model by a mouseDown event.
 onMouseMove() EventHandler flash.display.InteractiveObject dispatches event: mouseMoveReplaced in the new event model by a mouseMove event.
 onMouseUp() EventHandler flash.display.InteractiveObject dispatches event: mouseUpReplaced in the new event model by a mouseUp event.
 onPress() EventHandler flash.display.InteractiveObject dispatches event: mouseDownReplaced in the new event model by a mouseDown event.
 onRelease() EventHandler flash.display.InteractiveObject dispatches event: mouseUpReplaced in the new event model by a mouseUp event.
 onReleaseOutside() EventHandler flash.display.InteractiveObject dispatches event: mouseUpReplaced in the new event model by a mouseUp event.
 onRollOut() EventHandler flash.display.InteractiveObject dispatches event: mouseOutReplaced in the new event model by a mouseOut event.
 onRollOver() EventHandler flash.display.InteractiveObject dispatches event: mouseOverReplaced in the new event model by a mouseOver event.
 onSetFocus() EventHandler flash.display.InteractiveObject dispatches event: focusInReplaced in the new event model by a focusIn event.
 onUnload() EventHandler flash.display.LoaderInfo dispatches event: unloadReplaced in the new event model by an unload event.
 play() Method flash.display.MovieClip.play() 
 prevFrame() Method flash.display.MovieClip.prevFrame() 
 removeMovieClip() Method flash.display.DisplayObjectContainer.removeChild()Removed. Call the removeChild() method of the parent display object container that contains the movie clip.
 setMask() Method flash.display.DisplayObject.mask 
 startDrag() Method flash.display.Sprite.startDrag() 
 stop() Method flash.display.MovieClip.stop() 
 stopDrag() Method flash.display.Sprite.stopDrag() 
 swapDepths() Method RemovedIn ActionScript 3.0, you can achieve similar functionality by using the methods of the DisplayObjectContainer class, such as the addChildAt(), setChildIndex(), swapChildren(), and swapChildrenAt() methods.
 unloadMovie() Method flash.display.Loader.unload() 
 
 MovieClipLoader classflash.display.LoaderReplaced by the flash.display.Loader class.
 MovieClipLoader Constructor flash.display.Loader.Loader() 
 addListener() Method flash.events.EventDispatcher.addEventListener()In the new event model, there is no need to have a class-specific addListener() method, because the class inherits the addEventListener() method from the EventDispatcher class.
 getProgress() Method flash.display.LoaderInfo dispatches event: progressReplaced in the new event model by a progress event. Event objects of progress type contain properties named bytesLoaded and bytesTotal.
 loadClip() Method flash.display.Loader.load()Replaced by the load() method of flash.display.Loader class.
 removeListener() Method flash.events.EventDispatcher.removeEventListener()In the new event model, there is no need to have a class-specific removeListener() method, because the class inherits the removeEventListener() method from the EventDispatcher class.
 unloadClip() Method flash.display.Loader.unload()Replaced by unload() method of flash.display.Loader class.
 onLoadComplete Listener flash.display.LoaderInfo dispatches event: completeReplaced in the new event model by a complete event.
 onLoadError Listener flash.display.LoaderInfo dispatches event: ioErrorReplaced in the new event model by an ioError event.
 onLoadInit Listener flash.display.LoaderInfo dispatches event: initReplaced in the new event model by an init event.
 onLoadProgress Listener flash.display.LoaderInfo dispatches event: progressReplaced in the new event model by a progress event.
 onLoadStart Listener flash.display.LoaderInfo dispatches event: openReplaced in the new event model by an open event.
 
 NetConnection classflash.net.NetConnectionThis class has been moved to the flash.net package.
 NetConnection Constructor flash.net.NetConnection.NetConnection() 
 connect() Constructor flash.net.NetConnection.connect()ActionScript 3.0 version adds a ...(rest) parameter.
 
 NetStream classflash.net.NetStreamThis class has been moved to the flash.net package.
 bytesLoaded Property[read-only] flash.net.NetStream.bytesLoadedData type changed to uint.
 bytesTotal Property[read-only] flash.net.NetStream.bytesTotalData type changed to uint.
 currentFps Property[read-only] flash.net.NetStream.currentFPSIn ActionScript 3.0, FPS is all uppercase.
 onStatus() EventHandler flash.net.NetStream dispatches event: netStatusReplaced in the new event model by a netStatus event.
 pause() Method flash.net.NetStream.pause()In ActionScript 3.0, the pause method does not take a parameter. Two new methods are available to achieve the same functionality: resume() and togglePause().
 play() Method flash.net.NetStream.play()The name, start, len, and reset parameters are no longer valid; ...arguments is used instead.
 setBufferTime() Method flash.net.NetStream.bufferTimeIn ActionScript 3.0, changed to read-write accessor property.
 
 Number classNumber 
 Number Constructor Number.Number()In ActionScript 3.0, the Number() constructor and the Number() global function have the same effect. Also, there is no difference between a Number object and a literal Number value.
 
 Object classObject 
 __proto__ Property RemovedIn ActionScript 3.0, direct manipulation of the prototype chain is not allowed. To create a subclass, use the extends statement in the subclass declaration. For information about an object's inheritance tree and data type, use the new reflection API flash.utils.describeType().
 __resolve Property flash.utils.ProxyUse the new Proxy class for similar functionality.
 addProperty() Method RemovedIn ActionScript 3.0, accessor properties can be created directly using the keywords get and set.
 registerClass() Method RemovedIn ActionScript 3.0, all classes are registered by default. If you are encoding an object using AMF, the class of the object is not preserved during the encoding process unless you use the flash.utils.registerClassAlias() function.
 unwatch() Method RemovedActionScript 3.0 does not have watchpoints; therefore, the unwatch() method is obsolete.
 watch() Method RemovedUse accessor properties (get/set functions) or the flash.utils.Proxy class for similar functionality.
 
 PrintJob classflash.printing.PrintJob 
 orientation Property[read-only] flash.printing.PrintJob.orientationThis property now has a value from the PrintJobOrientation class.
 pageHeight Property[read-only] flash.printing.PrintJob.pageHeightData type changed to int.
 pageWidth Property[read-only] flash.printing.PrintJob.pageWidthData type changed to int.
 paperHeight Property[read-only] flash.printing.PrintJob.paperHeightData type changed to int.
 paperWidth Property[read-only] flash.printing.PrintJob.paperWidthData type changed to int.
 PrintJob Constructor flash.printing.PrintJob.PrintJob() 
 addPage() Method flash.printing.PrintJob.addPage()In ActionScript 3.0, changed data types of parameters: First parameter target is a Sprite data type; second parameter printArea is a Rectangle data type; third parameter options is the new PrintJobOptions data type; and fourth parameter frameNum is an int data type.
 send() Method flash.printing.PrintJob.send() 
 start() Method flash.printing.PrintJob.start() 
 
 Rectangle class 
 containsRectangle() Method flash.geom.Rectangle.containsRect()Renamed for consistency.
 
 security classflash.system.SecurityThis class has been moved to the flash.system package.
 
 Selection classRemovedMethods of this class have been moved to other classes.
 addListener() Method flash.events.EventDispatcher.addEventListener()In the new event model, there is no need to have a class-specific addListener() method, because any display object inherits the addEventListener() method from the EventDispatcher class.
 getBeginIndex() Method flash.text.TextField.selectionBeginIndexChanged from method to accessor property and name changed to selectionBeginIndex.
 getCaretIndex() Method flash.text.TextField.caretIndexChanged from method to accessor property and name changed to caretIndex.
 getEndIndex() Method flash.text.TextField.selectionEndIndexChanged from method to accessor property and name changed to selectionEndIndex.
 getFocus() Method flash.display.Stage.focusChanged from method to property accessor and name changed to focus. In ActionScript 2.0 the data type of the return value is String, but in ActionScript 3.0 the property has the InteractiveObject data type.
 removeListener() Method flash.events.EventDispatcher.removeEventListener()In the new event model, there is no need to have a class-specific removeListener() method, because display objects inherit the removeEventListener() method from the EventDispatcher class.
 setFocus() Method flash.display.Stage.focusChanged from method to accessor property and name changed to focus. In ActionScript 2.0 the data type of the return value is String, but in ActionScript 3.0 the property has the InteractiveObject data type.
 setSelection() Method flash.text.TextField.setSelection()Both parameters changed from Number to uint data type.
 onSetFocus Listener flash.display.InteractiveObject dispatches event: focusInReplaced in the new event model by a focusIn event.
 
 SharedObject classflash.net.SharedObjectThis class has been moved to the flash.net package.
 flush() Method flash.net.SharedObject.flush()This method no longer returns a Boolean value. If the flush fails, Flash Player throws an exception; if the flush succeeds or is pending user interaction, Flash Player returns a string "flushed" or "pending". Also, the data type of the minDiskSpace parameter changed to int.
 getSize() Method flash.net.SharedObject.sizeChanged to accessor property. Data type changed to uint.
 onStatus() EventHandler flash.net.SharedObject dispatches event: netStatusReplaced in the new event model by a netStatus event.
 
 Sound classflash.media.SoundThis class has been moved to the flash.media package.
 checkPolicyFile flash.media.SoundChannel.stop()Replaced by the flash.media.SoundChannel.stop() method.
 duration Property[read-only] flash.media.Sound.length 
 id3 Property[read-only] flash.media.Sound.id3Data type changed from Object to ID3Info. ID3Info is a new class that contains the ID3 properties. Also, the spelling of the songname property changed to songName.
 position Property[read-only] flash.media.SoundChannel.positionMoved to the SoundChannel class.
 attachSound() Method RemovedCreate an instance of a Sound subclass that is associated with sound data; for example, by using new Sound() instead.
 getBytesLoaded() Method flash.media.Sound.bytesLoadedChanged to accessor property and data type changed to uint.
 getBytesTotal() Method flash.media.Sound.bytesTotalChanged to property accessor and data type changed to uint.
 getPan() Method flash.media.SoundTransform.panChanged to accessor property and moved to the SoundTransform class.
 getTransform() Method flash.media.SoundMixer.soundTransformChanged to accessor property and data type changed to SoundTransform.
 getVolume() Method flash.media.SoundTransform.volumeSet the flash.media.SoundTransform.volume property to control sound volume.
 loadSound() Method flash.media.Sound.load()The first parameter changed from a simple URL string to a URLRequest object. The second parameter changed from a Boolean value representing whether sound begins playing as soon as possible to a SoundLoaderContext object.
 onID3() EventHandler flash.media.Sound dispatches event: id3Replaced in the new event model by an id3 event.
 onLoad() EventHandler flash.media.Sound dispatches event: completeReplaced in the new event model by a complete event.
 onSoundComplete() EventHandler flash.media.SoundChannel dispatches event: soundCompleteReplaced in the new event model by a soundComplete event.
 setPan() Method flash.media.SoundTransform.panChanged to accessor property and moved to SoundTransform class.
 setTransform() Method flash.media.SoundMixer.soundTransformChanged to accessor property and data type changed to SoundTransform.
 setVolume() Method flash.media.SoundChannelRemoved. Use flash.media.SoundChannel.leftPeak and flash.media.SoundChannel.rightPeak to monitor the amplitude of a sound channel.
 start() Method flash.media.Sound.play()The loops parameter data type changed from Number to int. Added a third parameter, sndTransform, to specify the initial sound transform to be used by the sound channel.
 stop() Method flash.media.SoundChannel.stop() 
 
 Stage classflash.display.StageThis class has been moved to the flash.display package. In ActionScript 3.0, the Stage is no longer a global object. You access the Stage by using the new DisplayObject.stage property.
 align Property flash.display.Stage.align 
 height Property flash.display.Stage.stageHeightName changed from height to stageHeight so that it does not conflict with the flash.display.DisplayObject.height property.
 scaleMode Property flash.display.Stage.scaleMode 
 showMenu Property flash.display.Stage.showDefaultContextMenuName changed to better reflect which menu is shown.
 width Property flash.display.Stage.stageWidthName changed from width to stageWidth so that it does not conflict with the flash.display.DisplayObject.width property.
 addListener() Method flash.events.EventDispatcher.addEventListener()In the new event model, there is no need to have a class-specific addListener() method, because the class inherits the addEventListener() method from the EventDispatcher class.
 removeListener() Method flash.events.EventDispatcher.removeEventListener()In the new event model, there is no need to have a class-specific removeListener() method, because the class inherits the removeEventListener() method from the EventDispatcher class.
 onResize Listener flash.display.Stage dispatches event: resizeReplaced in the new event model by a resize event.
 
 String classStringAdds support for regular expressions with three new methods: match(), replace(), and search().
 concat() Method String.concat()Parameter changed to ...(rest) parameter format.
 
 StyleSheet classflash.text.StyleSheetThis class has been moved to the flash.text package. The load() and onLoad() members have been removed, and some private functions and variables have been added.
 StyleSheet Constructor flash.text.StyleSheet.StyleSheet() 
 clear() Method flash.text.StyleSheet.clear() 
 getStyle() Method flash.text.StyleSheet.getStyle()Parameter name changed to n.
 getStyleNames() Method flash.text.StyleSheet.styleNamesChanged to accessor property.
 load() Method flash.net.URLLoader.load()Use the new URLLoader and URLRequest classes for loading URLs.
 onLoad() EventHandler flash.net.URLLoader dispatches event: completeReplaced in the new event model by a complete event.
 parseCSS() Method flash.text.StyleSheet.parseCSS()In ActionScript 3.0, returns void instead of a Boolean value.
 setStyle() Method flash.text.StyleSheet.setStyle()Parameter name changed to n and style to s.
 transform() Method flash.text.StyleSheet.transform() 
 
 System classflash.system.System 
 exactSettings Property flash.system.Security.exactSettingsMoved to the flash.System.Security class.
 useCodepage Property flash.system.System.useCodePageIn ActionScript 3.0, the letter 'P' in useCodePage is uppercase.
 onStatus() EventHandler RemovedThis event hander is obsolete in the ActionScript 3.0 event model.
 setClipboard() Method flash.system.System.setClipboard() 
 showSettings() Method flash.system.Security.showSettings() 
 
 TextField classflash.text.TextFieldThis class has been moved to the flash.text package.
 _alpha Property flash.display.DisplayObject.alphaThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 antiAliasType Property flash.text.TextField.antiAliasType 
 autoSize Property flash.text.TextField.autoSize 
 background Property flash.text.TextField.background 
 backgroundColor Property flash.text.TextField.backgroundColor 
 border Property flash.text.TextField.border 
 borderColor Property flash.text.TextField.borderColorIn ActionScript 3.0, returns a uint instead of a Number.
 bottomScroll Property[read-only] flash.text.TextField.bottomScrollVIn ActionScript 3.0, returns a uint instead of a Number.
 condenseWhite Property flash.text.TextField.condenseWhite 
 embedFonts Property flash.text.TextField.embedFonts 
 filters Property flash.display.DisplayObject.filters 
 gridFitType Property flash.text.TextField.gridFitType 
 _height Property flash.display.DisplayObject.heightThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 _highquality Property flash.display.Stage.qualityRemoved. Replaced by the quality property of the Stage class.
 hscroll Property flash.text.TextField.scrollHData type changed from Number to uint. Name changed from hscroll to scrollH.
 html Property flash.text.TextField.htmlTextRemoved. In ActionScript 3.0, all text fields are treated as HTML text fields. Use the TextField.htmlText property to set HTML text.
 htmlText Property flash.text.TextField.htmlText 
 length Property[read-only] flash.text.TextField.lengthData type changed from Number to uint.
 maxChars Property flash.text.TextField.maxCharsData type changed from Number to uint.
 maxhscroll Property[read-only] flash.text.TextField.maxScrollHData type changed from Number to uint.
 maxscroll Property[read-only] flash.text.TextField.maxScrollVData type changed from Number to uint. Name changed to use uppercase S and to add the letter V to represent vertical scrolling.
 menu Property flash.display.InteractiveObject.contextMenuThis property is now inherited from the InteractiveObject class.
 mouseWheelEnabled Property flash.text.TextField.mouseWheelEnabled 
 multiline Property flash.text.TextField.multiline 
 _name Property flash.display.DisplayObject.nameThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 _parent Property flash.display.DisplayObject.parentThis property is now inherited from the DisplayObject class. Removed the initial underscore. Data type changed from MovieClip to DisplayObjectContainer.
 password Property flash.text.TextField.displayAsPasswordRenamed property for consistency.
 _quality Property flash.display.Stage.qualityMoved to Stage class.
 restrict Property flash.text.TextField.restrict 
 _rotation Property flash.display.DisplayObject.rotationThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 scroll Property flash.text.TextField.scrollVData type changed from Number to uint and name changed from scroll to scrollV.
 selectable Property flash.text.TextField.selectable 
 sharpness Property flash.text.TextField.sharpness 
 _soundbuftime Property flash.media.SoundMixer.bufferTimeProperties and methods for global sound control in a SWF file are now in the flash.media.SoundMixer class.
 styleSheet Property flash.text.TextField.styleSheet 
 tabEnabled Property flash.display.InteractiveObject.tabEnabledThis property is now inherited from the InteractiveObject class.
 tabIndex Property flash.display.InteractiveObject.tabIndexThis property is now inherited from the InteractiveObject class.
 _target Property[read-only] RemovedActionScript 3.0 identifies display objects directly; therefore, identifying the path is no longer necessary.
 text Property flash.text.TextField.text 
 textColor Property flash.text.TextField.textColorData type changed from Number to uint.
 textHeight Property flash.text.TextField.textHeight 
 textWidth Property flash.text.TextField.textWidth 
 thickness Property flash.text.TextField.thickness 
 type Property flash.text.TextField.type 
 _url Property[read-only] flash.display.LoaderInfo.url 
 variable Property RemovedThis variable is no longer necessary in ActionScript 3.0.
 _visible Property flash.display.DisplayObject.visibleThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 _width Property flash.display.DisplayObject.widthThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 wordWrap Property flash.text.TextField.wordWrap 
 _x Property flash.display.DisplayObject.xThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 _xmouse Property[read-only] flash.display.DisplayObject.mouseXThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 _xscale Property flash.display.DisplayObject.scaleXThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 _y Property flash.display.DisplayObject.yThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 _ymouse Property[read-only] flash.display.DisplayObject.mouseYThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 _yscale Property flash.display.DisplayObject.scaleYThis property is now inherited from the DisplayObject class. Removed the initial underscore.
 addListener() Method flash.events.EventDispatcher.addEventListener()In the new event model, there is no need to have a class-specific addListener() method, because the class inherits the addEventListener() method from the EventDispatcher class.
 getDepth() Method flash.display.DisplayObjectContainerRemoved. Use the methods of the DisplayObjectContainer class to ascertain text field depth.
 getFontList() Method flash.text.Font.enumerateFonts()Removed. Use Font.enumerateFonts() with the enumerateDeviceFonts parameter set to true.
 getNewTextFormat() Method flash.text.TextField.defaultTextFormatName changed from getNewTextFormat to defaultTextFormat. Changed from method to accessor property.
 getTextFormat() Method flash.text.TextField.getTextFormat()Data type of both parameters changed from Number to uint.
 onChanged() EventHandler flash.text.TextField dispatches event: changeReplaced in the new event model by a change event.
 onKillFocus() EventHandler flash.display.InteractiveObject dispatches event: focusOutReplaced in the new event model by a focusOut event.
 onScroller() EventHandler flash.text.TextField dispatches event: scrollReplaced in the new event model by a scroll event.
 onSetFocus() EventHandler flash.display.InteractiveObject dispatches event: focusInReplaced in the new event model by a focusIn event.
 removeListener() Method flash.events.EventDispatcher.removeEventListener()In the new event model, there is no need to have a class-specific removeListener() method, because the class inherits the removeEventListener() method from the EventDispatcher class.
 removeTextField() Method flash.display.DisplayObjectContainer.removeChild()Removed. Call the removeChild() method of the parent display object container that contains the text field.
 replaceSel() Method flash.text.TextField.replaceSelectedText()Name changed from replacesel() to replaceSelectedText(). Replaced the newText parameter with a string value.
 replaceText() Method flash.text.TextField.replaceText()Data types of first two parameters changed from Number to uint.
 setNewTextFormat() Method flash.text.TextField.defaultTextFormatName changed from setNewTextFormat to defaultTextFormat. Changed from method to accessor property.
 setTextFormat() Method flash.text.TextField.setTextFormat()Order of parameters changed. Index parameters data type changed from Number to int.
 
 TextFormat classflash.text.TextFormatThis class has been moved to the flash.text package.
 align Property flash.text.TextFormat.align 
 blockIndent Property flash.text.TextFormat.blockIndentIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Number data type in ActionScript 3.0.
 bold Property flash.text.TextFormat.boldIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Boolean data type in ActionScript 3.0.
 bullet Property flash.text.TextFormat.bulletIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Boolean data type in ActionScript 3.0.
 color Property flash.text.TextFormat.colorIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Number data type in ActionScript 3.0.
 font Property flash.text.TextFormat.font 
 indent Property flash.text.TextFormat.indentIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Number data type in ActionScript 3.0.
 italic Property flash.text.TextFormat.bulletIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Boolean data type in ActionScript 3.0.
 kerning Property flash.text.TextFormat.kerningIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Boolean data type in ActionScript 3.0.
 leading Property flash.text.TextFormat.leadingIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Number data type in ActionScript 3.0.
 leftMargin Property flash.text.TextFormat.leftMarginIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Number data type in ActionScript 3.0.
 letterSpacing Property flash.text.TextFormat.letterSpacingIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Number data type in ActionScript 3.0.
 rightMargin Property flash.text.TextFormat.rightMarginIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Number data type in ActionScript 3.0.
 size Property flash.text.TextFormat.sizeIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Number data type in ActionScript 3.0.
 underline Property flash.text.TextFormat.underlineIn ActionScript 3.0, data type changed to Object because one of the possible values is null, which is not a member of the Boolean data type in ActionScript 3.0.
 url Property flash.text.TextFormat.url 
 TextFormat Constructor flash.text.TextFormat.TextFormat()The size, color, bold, italic, underline, url, leftMargin, rightMargin, indent, and leading parameters have all been converted to objects.
 getTextExtent() Method RemovedUse the properties of flash.text.TextField for the measurements of a field containing a line of text, and use flash.text.TextLineMetrics for the measurements of the content within the text field.
 
 TextRenderer classflash.text.TextRendererLocation changed. Moved to flash.text package.
 maxLevel Property flash.text.TextRenderer.maxLevelDefined as a uint in ActionScript 3.0.
 setAdvancedAntialiasingTable() Method flash.text.TextRenderer.setAdvancedAntiAliasingTable()The fontStyle and colorType parameter values can now be set using the FontStyle and TextColorType constants, respectively. The advancedAntiAliasingTable parameter now takes an array of one or more CSMSettings objects.
 
 TextSnapshot classflash.text.TextSnapshotThis class has been moved to the flash.text package. Several parameters have changed, as well as some method names and some return types.
 findText() Method flash.text.TextSnapshot.findText()Name of the startIndex parameter changed to beginIndex. Data type of the startIndex parameter changed from Number to int.
 getCount() Method flash.text.TextSnapshot.charCountChanged from method to accessor property. Data return type changed from Number to uint.
 getSelected() Method flash.text.TextSnapshot.getSelected()Data type of parameters changed from Number to uint and names changed from start and end to beginIndex and EndIndex.
 getSelectedText() Method flash.text.TextSnapshot.getSelectedText()In ActionScript 3.0, the parameter has a default value of false.
 getText() Method flash.text.TextSnapshot.getText()Data type of start and end parameters changed from Number to uint and names changed from start and end to beginIndex and endIndex.
 getTextRunInfo() Method flash.text.TextSnapshot.getTextRunInfo()Data type of parameters changed from Number to uint.
 hitTestTextNearPos() Method flash.text.TextSnapshot.hitTestTextNearPos()Name of the closeDist parameter changed to maxDistance; now has a default value = 0.
 setSelectColor() Method flash.text.TextSnapshot.setSelectColor()Data type of parameter changed from Number to uint and has a default value = 0xFFFF00.
 setSelected() Method flash.text.TextSnapshot.setSelected()Data type of start and end parameters changed from Number to uint and names changed from start and end to beginIndex and endIndex.
 
 Video classflash.media.VideoThis class has been moved to the flash.media package. Video objects can now be created dynamically in ActionScript with the Video() constructor. Attach a video stream to the Video object by using attachCamera() or attachNetStream().
 _alpha Property flash.display.DisplayObject.alphaThis property is inherited from the DisplayObject class. Removed the initial underscore.
 deblocking Property flash.media.Video.deblockingData type changed from Number to int.
 _height Property flash.display.DisplayObject.heightThis property is inherited from the DisplayObject class Removed the initial underscore.
 height Property[read-only] flash.media.Video.videoHeightData type changed from Number to int.
 _name Property flash.display.DisplayObject.nameThis property is inherited from the DisplayObject class. Removed the initial underscore.
 _parent Property flash.display.DisplayObject.parentThis property is inherited from the DisplayObject class. Removed the initial underscore.
 _rotation Property flash.display.DisplayObject.rotationThis property is inherited from the DisplayObject class. Removed the initial underscore.
 smoothing Property flash.media.Video.smoothing 
 _visible Property flash.display.DisplayObject.visibleThis property is inherited from the DisplayObject class. Removed the initial underscore.
 _width Property flash.display.DisplayObject.widthThis property is inherited from the DisplayObject class. Removed the initial underscore.
 width Property[read-only] flash.media.Video.videoWidthData type changed from Number to int.
 _x Property flash.display.DisplayObject.xThis property is inherited from the DisplayObject class. Removed the initial underscore.
 _xmouse Property[read-only] flash.display.DisplayObject.mouseXThis property is inherited from the DisplayObject class. Removed the initial underscore.
 _xscale Property flash.display.DisplayObject.scaleXThis property is inherited from the DisplayObject class. Removed the initial underscore.
 _y Property flash.display.DisplayObject.yThis property is inherited from the DisplayObject class. Removed the initial underscore.
 _ymouse Property[read-only] flash.display.DisplayObject.mouseYThis property is inherited from the DisplayObject class. Removed the initial underscore.
 _yscale Property flash.display.DisplayObject.scaleYThis property is inherited from the DisplayObject class. Removed the initial underscore.
 attachVideo() Method flash.media.Video.attachNetStream()To specify a video stream from a camera object, use flash.media.Video.attachCamera().
 clear() Method flash.media.Video.clear() 
 
 XML classflash.xml.XMLDocumentThis class has been moved to the flash.xml package and its name has been changed to XMLDocument to avoid conflict with the new top-level XML class that implements ECMAScript for XML (E4X).
 contentType Property flash.net.URLRequest.contentType 
 docTypeDecl Property flash.xml.XMLDocument.docTypeDecl 
 idMap Property flash.xml.XMLDocument.idMap 
 ignoreWhite Property flash.xml.XMLDocument.ignoreWhite 
 loaded Property RemovedFile loading functionality was removed from the XMLDocument class. Use URLLoader instead.
 status Property RemovedParse failures are now reported by exceptions.
 xmlDecl Property flash.xml.XMLDocument.xmlDecl 
 XML Constructor flash.xml.XMLDocument.XMLDocument() 
 addRequestHeader() Method flash.net.URLRequest.requestHeaders 
 createElement() Method flash.xml.XMLDocument.createElement() 
 createTextNode() Method flash.xml.XMLDocument.createTextNode() 
 getBytesLoaded() Method flash.net.URLLoader.bytesLoadedFile loading functionality was removed from the XMLDocument class. Use URLLoader instead.
 getBytesTotal() Method flash.net.URLLoader.bytesTotalFile loading functionality was removed from the XMLDocument class. Use URLLoader instead.
 load() Method RemovedFile loading functionality was removed from the XMLDocument class (formerly the XML class in ActionScript 2.0). Use URLLoader instead.
 onData() EventHandler flash.net.URLLoader dispatches event: completeFile loading functionality was removed from the XMLDocument class. Use URLLoader instead. Replaced in the new event model by a complete event.
 onHTTPStatus() EventHandler flash.net.URLLoader dispatches event: httpStatusFile loading functionality was removed from the XMLDocument class. Use URLLoader instead. Replaced in the new event model by an httpStatus event.
 onLoad() EventHandler flash.net.URLLoader dispatches event: completeFile loading functionality was removed from the XMLDocument class. Use URLLoader instead. Replaced in the new event model by a complete event.
 parseXML() Method flash.xml.XMLDocument.parseXML() 
 send() Method RemovedSend functionality was removed from the XMLDocument class (formerly the XML class in ActionScript 2.0). Use the functions and classes of the flash.net package instead.
 sendAndLoad() Method RemovedSend and load functionality were removed from the XMLDocument class (formerly the XML class in ActionScript 2.0). Use URLRequest and URLLoader instead.
 
 XMLNode classflash.xml.XMLNodeLocation changed. This class has been moved to the flash.xml package.
 nodeType Property[read-only] flash.xml.XMLNode.nodeTypeData type changed from Number to uint.
 XMLNode Constructor flash.xml.XMLNode.XMLNode()Data type of the type parameter changed from Number to uint.
 
 XMLSocket classflash.net.XMLSocketThis class has been moved to the flash.net package.
 XMLSocket Constructor flash.net.XMLSocket.XMLSocket()Added two optional parameters to specify host and port.
 connect() Method flash.net.XMLSocket.connect()Data type of the port parameter changed to int.
 onClose() EventHandler flash.net.XMLSocket dispatches event: closeReplaced in the new event model by a close event.
 onConnect() EventHandler flash.net.XMLSocket dispatches event: connectReplaced in the new event model by a connect event.
 onData() EventHandler flash.net.XMLSocket dispatches event: dataReplaced in the new event model by a data event.
 onXML() EventHandler RemovedIn ActionScript 3.0, only the data event is dispatched, so that you can choose whether to use E4X or the legacy XML (XMLDocument class) parser. The old onXML event handler was called after XML was parsed, so it doesn't make sense in ActionScript 3.0 because you can now choose between the XML (E4X) class and the XMLDocument (legacy) class to parse the XML.
 
-

-
- -
-
- -
-

-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:13 PM GMT+01:00
Creative Commons License
-
-
- - - diff --git a/html-docs/operators.html b/html-docs/operators.html deleted file mode 100644 index dee5ea1..0000000 --- a/html-docs/operators.html +++ /dev/null @@ -1,5115 +0,0 @@ - - - - - - - -Operators (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

Symbolic operators are characters that specify how to combine, compare, or modify the values of an expression.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 Arithmetic
 +additionAdds numeric expressions.
 --decrementSubtracts 1 from the operand.
 /divisionDivides expression1 by expression2.
 ++incrementAdds 1 to an expression.
 %moduloCalculates the remainder of expression1 divided by expression2.
 *multiplicationMultiplies two numerical expressions.
 -subtractionUsed for negating or subtracting.
 Arithmetic compound assignment
 +=addition assignmentAssigns expression1 the value of expression1 + expression2.
 /=division assignmentAssigns expression1 the value of expression1 / expression2.
 %=modulo assignmentAssigns expression1 the value of expression1 % expression2.
 *=multiplication assignmentAssigns expression1 the value of expression1 * expression2.
 -=subtraction assignmentAssigns expression1 the value of expression1 - expression2.
 Assignment
 =assignmentAssigns the value of expression2 (the operand on the right) to the variable, array element, or property in expression1.
 Bitwise
 &bitwise ANDConverts expression1 and expression2 to 32-bit unsigned integers, and performs a Boolean AND operation on each bit of the integer parameters.
 <<bitwise left shiftConverts expression1 and shiftCount to 32-bit integers, and shifts all the bits in expression1 to the left by the number of places specified by the integer resulting from the conversion of shiftCount.
 ~bitwise NOTConverts expression to a 32-bit signed integer, and then applies a bitwise one's complement.
 |bitwise ORConverts expression1 and expression2 to 32-bit unsigned integers, and places a 1 in each bit position where the corresponding bits of either expression1 or expression2 are 1.
 >>bitwise right shiftConverts expression and shiftCount to 32-bit integers, and shifts all the bits in expression to the right by the number of places specified by the integer that results from the conversion of shiftCount.
 >>>bitwise unsigned right shiftThe same as the bitwise right shift (>>) operator except that it does not preserve the sign of the original expression because the bits on the left are always filled with 0.
 ^bitwise XORConverts expression1 and expression2 to 32-bit unsigned integers, and places a 1 in each bit position where the corresponding bits in expression1 or expression2, but not both, are 1.
 Bitwise compound assignment
 &=bitwise AND assignmentAssigns expression1 the value of expression1 & expression2.
 <<=bitwise left shift and assignmentPerforms a bitwise left shift (<<=) operation and stores the contents as a result in expression1.
 |=bitwise OR assignmentAssigns expression1 the value of expression1 | expression2.
 >>=bitwise right shift and assignmentPerforms a bitwise right-shift operation and stores the result in expression.
 >>>=bitwise unsigned right shift and assignmentPerforms an unsigned bitwise right-shift operation and stores the result in expression.
 ^=bitwise XOR assignmentAssigns expression1 the value of expression1 ^ expression2.
 Comment
 /*..*/block comment delimiterDelimits one or more lines of script comments.
 //line comment delimiterIndicates the beginning of a script comment.
 Comparison
 ==equalityTests two expressions for equality.
 >greater thanCompares two expressions and determines whether expression1 is greater than expression2; if it is, the result is true.
 >=greater than or equal toCompares two expressions and determines whether expression1 is greater than or equal to expression2 (true) or expression1 is less than expression2 (false).
 !=inequalityTests for the exact opposite of the equality (==) operator.
 <less thanCompares two expressions and determines whether expression1 is less than expression2; if so, the result is true.
 <=less than or equal toCompares two expressions and determines whether expression1 is less than or equal to expression2; if it is, the result is true.
 ===strict equalityTests two expressions for equality, but does not perform automatic data conversion.
 !==strict inequalityTests for the exact opposite of the strict equality (===) operator.
 Logical
 &&logical ANDReturns expression1 if it is false or can be converted to false, and expression2 otherwise.
 &&=logical AND assignmentAssigns expression1 the value of expression1 && expression2.
 !logical NOTInverts the Boolean value of a variable or expression.
 ||logical ORReturns expression1 if it is true or can be converted to true, and expression2 otherwise.
 ||=logical OR assignmentAssigns expression1 the value of expression1 || expression2.
 ??nullish coalescingReturns expression1 unless if it is null or undefined, and expression2 otherwise.
 Other
 []array accessInitializes a new array or multidimensional array with the specified elements (a0, and so on), or accesses elements in an array.
  asEvaluates whether an expression specified by the first operand is a member of the data type specified by the second operand.
 ,commaEvaluates expression1, then expression2, and so on.
 ?:conditionalEvaluates expression1, and if the value of expression1 is true, the result is the value of expression2; otherwise the result is the value of expression3.
  deleteDestroys the object property specified by reference; the result is true if the property does not exist after the operation completes, and false otherwise.
 .dotAccesses class variables and methods, gets and sets object properties, and delimits imported packages or classes.
  inEvaluates whether a property is part of a specific object.
  instanceofEvaluates whether an expression's prototype chain includes the prototype object for function.
  isEvaluates whether an object is compatible with a specific data type, class, or interface.
 ::name qualifierIdentifies the namespace of a property, a method, an XML property, or an XML attribute.
  newInstantiates a class instance.
 ?.null condition member accessAccesses class variables and methods, gets and sets object properties, with an inherent null-object check.
 {}object initializerCreates a new object and initializes it with the specified name and value property pairs.
 ()parenthesesPerforms a grouping operation on one or more parameters, performs sequential evaluation of expressions, or surrounds one or more parameters and passes them as arguments to a function that precedes the parentheses.
 /RegExp delimiterWhen used before and after characters, indicates that the characters have a literal value and are considered a regular expression (RegExp), not a variable, string, or other ActionScript element.
 :typeUsed for assigning a data type; this operator specifies the variable type, function return type, or function parameter type.
  typeofEvaluates expression and returns a string specifying the expression's data type.
  voidEvaluates an expression and then discards its value, returning undefined.
 String
 +concatenationConcatenates (combines) strings.
 +=concatenation assignmentAssigns expression1 the value of expression1 + expression2.
 "string delimiterWhen used before and after characters, indicates that the characters have a literal value and are considered a string, not a variable, numerical value, or other ActionScript element.
 XML
 @attribute identifierIdentifies attributes of an XML or XMLList object.
 { }braces (XML)Evaluates an expression that is used in an XML or XMLList initializer.
 [ ]brackets (XML)Accesses a property or attribute of an XML or XMLList object.
 +concatenation (XMLList)Concatenates (combines) XML or XMLList values into an XMLList object.
 +=concatenation assignment (XMLList)Assigns expression1, which is an XMLList object, the value of expression1 + expression2.
  delete (XML)Deletes the XML elements or attributes specified by reference.
 ..descendant accessorNavigates to descendant elements of an XML or XMLList object, or (combined with the @ operator) finds matching attributes of descendants.
 .dot (XML)Navigates to child elements of an XML or XMLList object, or (combined with the @ operator) returns attributes of an XML or XMLList object.
 ( )parentheses (XML)Evaluates an expression in an E4X XML construct.
 < >XML literal tag delimiterDefines an XML tag in an XML literal.
-
Operator detail
- - - - - -
+ additionoperator
-
-Usage - - - - -
expression1 + expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Adds numeric expressions. If both expressions are integers, the sum is an integer; if either or both expressions are floating-point numbers, the sum is a floating-point number. -

If one expression is a string, all other expressions are converted to strings and concatenated instead of summed. Otherwise, if an expression is not a number, Flash® Player converts it to a number.

-

-

-Operands - - - - - - - -
expression1:Number — - A value to be added. -
expression2:Number — - A value to be added. -
-

-Result - - - - -
Number — An integer or floating-point number.
-
-Example -

-

-See also -

-
-+ (concatenation) -
-
- - - - - -
+= addition assignmentoperator 
-
-Usage - - - - -
expression1 += expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 + expression2. For example, the following two statements have the same result: 

x += y; 
-x = x + y;
All the rules of the addition (+) operator apply to the addition assignment (+=) operator. -

-

-Operands - - - - - - - -
expression1:Number — - A number. -
expression2:Number — - A number. -
-

-Result - - - - -
Number — The result of the addition.
-
-Example -

-

-See also -

-
-+ (addition) -
-
- - - - - -
[] array accessoperator 
-
-Usage - - - - -
myArray = [a0, a1,...aN]
-myArray[i] = value 
-myObject[propertyName]
-

- - - - -
Runtime version: 
-

-

Initializes a new array or multidimensional array with the specified elements (a0, and so on), or accesses elements in an array. The array access operator lets you dynamically set and retrieve instance, variable, and object names. It also lets you access object properties. -

Usage 1: An array is an object whose properties are called elements, which are each identified by a number called an index. When you create an array, you surround the elements with the array access ([]) operator (or brackets). An array can contain elements of various types. For example, the following array, called employee, has three elements; the first is a number and the second two are strings (inside quotation marks):

- 
var employee:Array = [15, "Barbara", "Jay"];
- You can nest brackets to simulate multidimensional arrays. You can nest arrays up to 256 levels deep. The following code creates an array called ticTacToe with three elements; each element is also an array with three elements: 
var ticTacToe:Array = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]; 
-			
-/* Select Debug > List Variables in test mode 
-to see a list of the array elements.*/
-Usage 2: Surround the index of each element with brackets ([]) to access it directly; you can add a new element to an array, or you can change or retrieve the value of an existing element. The first index in an array is always 0, as shown in the following example: 
var my_array:Array = new Array(); 
-my_array[0] = 15; 
-my_array[1] = "Hello"; 
-my_array[2] = true;
-You can use brackets to add a fourth element, as shown in the following example: -
my_array[3] = "George";
-You can use brackets to access an element in a multidimensional array. The first set of brackets identifies the element in the original array, and the second set identifies the element in the nested array. The following trace() statement finds the third element (index 2) of the second array (index 1). -
var ticTacToe:Array = [[1, 2, 3], [4, 5, 6], [7, 8, 9]]; 
-trace(ticTacToe[1][2]); // 6
-Usage 3: You can use the array access operator to dynamically set and retrieve values for a property of an object: -
var obj:Object = new Object();
-obj.prop1 = "foo";
-trace(obj["prop" + 1]); // foo
-obj.prop2 = "bar";
-for (j in obj) {
-	trace(obj[j]);
-} 
-/* Output of for loop: 
-foo
-bar */
-
-

-

-Operands - - - - - - - - - - - - - - - - -
myArray:Object — - The name of an array. -
a0, a1,...aN:Object — - Elements in an array; any native type or object instance, including nested arrays. -
i:Number — - An integer index greater than or equal to 0. -
myObject:Object — - The name of an object. -
propertyName:String — - A string that names a property of the object. -
-

-Result - - - - -
Object —

Usage 1: A reference to an array.

Usage 2: A value from the array; either a native type or an object instance (including an Array instance).

Usage 3: A property from the object; either a native type or an object instance (including an Array instance).

-
-Example -

-

-See also -

-
-Array class -
-Object class -
-
- - - - - -
asoperator 
-
-Usage - - - - -
expression as datatype
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates whether an expression specified by the first operand is a member of the data type specified by the second operand. If the first operand is a member of the data type, the result is the first operand. Otherwise, the result is the value null. - -

The expression used for the second operand must evaluate to a data type.

-

-

-Operands - - - - - - - -
expression:* — - The value to check against the data type specified. -
datatype:Class — - The data type used to evaluate the expression operand. The special * type, which means untyped, cannot be used. -
-

-Result - - - - -
Object — The result is expression if expression is a member of the data type specified in datatype. Otherwise, the result is the value null.
-
-Example -

-

-See also -

-
-instanceof -
-is -
-
- - - - - -
= assignmentoperator 
-
-Usage - - - - -
expression1 = expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns the value of expression2 (the operand on the right) to the variable, array element, or property in expression1. Assignment can be either by value or by reference. Assignment by value copies the actual value of expression2 and stores it in expression1. Assignment by value is used when expression2 is a primitive value, which means that its data type is either Boolean, Number, int, uint, or String. Assignment by reference stores a reference to expression2 in expression1. Assignment by reference is commonly used with the new operator. The new operator creates an object in memory, and a reference to that location in memory is assigned to a variable. -

Note: In ActionScript 3.0 all values (including primitive values) are objects, and all assignment is done by reference, but primitive objects have special operators that allow them to behave as if they are assigned by value.

-

-Operands - - - - - - - -
expression1:* — - A variable, element of an array, or property of an object. -
expression2:* — - A value of any type. -
-

-Result - - - - -
Object — The assigned value, expression2.
-
-Example -

-

-See also -

-
-== (equality) -
-
- - - - - -
@ attribute identifieroperator 
-
-Usage - - - - -
 myXML.@attributeName
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Identifies attributes of an XML or XMLList object. For example, myXML.@id - identifies attributes named id for the myXML XML object. You can - also use the following syntax to access - attributes: myXML.attribute("id"), myXML["@id"], and - myXML.@["id"]. The syntax myXML.@id is - recommended. To return an XMLList object of all attribute names, use @*. - To return an attribute with a name that matches an ActionScript reserved word, - use the attribute() method instead of the @ operator. -

-

-Operands - - - - -
attributeName:* — - The name of the attribute. -
-
-Example -

-

-See also -

-
-XML class -
-XMLList class -
-XML.attribute() -
-XML.attributes() -
-
- - - - - -
& bitwise ANDoperator 
-
-Usage - - - - -
expression1 & expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- Converts expression1 and expression2 to 32-bit unsigned integers, - and performs a Boolean AND operation on each bit of the integer parameters. - Floating-point numbers are converted to integers by discarding any digits after the decimal point. - The result is a new 32-bit integer. -

A positive integer is converted to an unsigned hexadecimal value with a maximum value of 4294967295 or 0xFFFFFFFF; - a value larger than the maximum has its most significant digits discarded when it is converted so the value is still 32-bit. - A negative number is converted to an unsigned hexadecimal value using the two's complement notation, with a minimum value of -2147483648 or 0x800000000; - a number less than the minimum is converted to two's complement with greater precision before the most significant digits are discarded.

-

The result is interpreted as a 32-bit two's complement number, so the result is an integer in the range -2147483648 to 2147483647.

-

-

-Operands - - - - - - - -
expression1:Number — - A number or expression that evaluates to a number. -
expression2:Number — - A number or expression that evaluates to a number. -
-

-Result - - - - -
int — The result of the bitwise operation.
-
-Example -

-

-See also -

-
-&= (bitwise AND assignment) -
-~ (bitwise NOT) -
-| (bitwise OR) -
-|= (bitwise OR assignment) -
-^ (bitwise XOR) -
-^= (bitwise XOR assignment) -
-
- - - - - -
&= bitwise AND assignmentoperator 
-
-Usage - - - - -
expression1 &= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 & expression2. For example, the following two expressions are equivalent: -

x &= y; 
-x = x & y;
-

-

-Operands - - - - - - - -
expression1:Number — - A number or expression that evaluates to a number. -
expression2:Number — - A number or expression that evaluates to a number. -
-

-Result - - - - -
int — The value of expression1 & expression2.
-
-Example -

-

-See also -

-
-& (bitwise AND) -
-~ (bitwise NOT) -
-| (bitwise OR) -
-|= (bitwise OR assignment) -
-^ (bitwise XOR) -
-^= (bitwise XOR assignment) -
-
- - - - - -
<< bitwise left shiftoperator 
-
-Usage - - - - -
expression1 << shiftCount
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Converts expression1 and shiftCount to 32-bit integers, and shifts all the bits in expression1 to the left by the number of places specified by the integer resulting from the conversion of shiftCount. The bit positions that are emptied as a result of this operation are filled in with 0 and bits shifted off the left end are discarded. Shifting a value left by one position is the equivalent of multiplying it by 2. -

A floating-point number is converted to an integer by discarding any digits after the decimal point. - A positive integer is converted to an unsigned hexadecimal value with a maximum value of 4294967295 or 0xFFFFFFFF; - a value larger than the maximum has its most significant digits discarded when it is converted so the value is still 32-bit. - A negative number is converted to an unsigned hexadecimal value using the two's complement notation, with a minimum value of -2147483648 or 0x800000000; - a number less than the minimum is converted to two's complement with greater precision before the most significant digits are discarded.

-

The result is interpreted as a 32-bit two's complement number, so the result is an integer in the range -2147483648 to 2147483647.

-

If the result is a negative integer, a runtime error occurs if you attempt to assign the result to a variable of type uint. Although ActionScript has no "unsigned bitwise left shift" operator, you can achieve the same effect, and avoid the runtime error, by using uint(expression1 << shiftCount):

- 
-var num1:uint = 0xFF;
-var num2:uint = uint(num1 << 24); // uint() prevents runtime error
-

-

-Operands - - - - - - - -
expression1:Number — - A number or expression to be shifted left. -
shiftCount:Number — - A number or expression that converts to an integer from 0 to 31. -
-

-Result - - - - -
int — The result of the bitwise operation.
-
-Example -

-

-See also -

-
-<<= (bitwise left shift and assignment) -
->> (bitwise right shift) -
->>= (bitwise right shift and assignment) -
->>> (bitwise unsigned right shift) -
->>>= (bitwise unsigned right shift and assignment) -
-
- - - - - -
<<= bitwise left shift and assignmentoperator 
-
-Usage - - - - -
expression1 <<= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Performs a bitwise left shift (<<=) operation and stores the contents as a result in expression1. The following two expressions are equivalent: 

A <<= B
-A = (A << B)

-

-Operands - - - - - - - -
expression1:Number — - A number or expression to be shifted left. -
expression2:Number — - A number or expression that converts to an integer from 0 to 31. -
-

-Result - - - - -
int — The result of the bitwise operation.
-
-Example -

-

-See also -

-
-<< (bitwise left shift) -
->> (bitwise right shift) -
->>= (bitwise right shift and assignment) -
-
- - - - - -
~ bitwise NOToperator 
-
-Usage - - - - -
~expression
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Converts expression to a 32-bit signed integer, and then applies a bitwise one's complement. That is, every bit that is a 0 is set to 1 in the result, and every bit that is a 1 is set to 0 in the result. The result is a signed 32-bit integer. - This operator is also known as the one's complement operator or the bitwise complement operator.

For example, the hexadecimal value 0x7777 is represented as this binary number:

- 
0111011101110111
-

The bitwise negation of that hexadecimal value, ~0x7777, is this binary number:

- 
1000100010001000
-

In hexadecimal, this is 0x8888. Therefore, ~0x7777 is 0x8888.

-

The most common use of bitwise operators is for representing flag bits (Boolean values packed into 1 bit each).

-

A floating-point number is converted to an integer by discarding any digits after the decimal point. - A positive integer is converted to an unsigned hexadecimal value with a maximum value of 4294967295 or 0xFFFFFFFF; - a value larger than the maximum has its most significant digits discarded when it is converted so the value is still 32-bit. - A negative number is converted to an unsigned hexadecimal value using the two's complement notation, with a minimum value of -2147483648 or 0x800000000; - a number less than the minimum is converted to two's complement with greater precision before the most significant digits are discarded.

-

The result is interpreted as a 32-bit two's complement number, so the result is an integer in the range -2147483648 to 2147483647.

-

-

-Operands - - - - -
expression:Number — - A number to be converted. -
-

-Result - - - - -
int — The result of the bitwise operation.
-
-Example -

-

-See also -

-
-& (bitwise AND) -
-&= (bitwise AND assignment) -
-| (bitwise OR) -
-|= (bitwise OR assignment) -
-^ (bitwise XOR) -
-^= (bitwise XOR assignment) -
-
- - - - - -
| bitwise ORoperator 
-
-Usage - - - - -
expression1 | expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Converts expression1 and expression2 to 32-bit unsigned integers, and places a 1 in each bit position where the corresponding bits of either expression1 or expression2 are 1. -

A floating-point number is converted to an integer by discarding any digits after the decimal point. - A positive integer is converted to an unsigned hexadecimal value with a maximum value of 4294967295 or 0xFFFFFFFF; - a value larger than the maximum has its most significant digits discarded when it is converted so the value is still 32-bit. - A negative number is converted to an unsigned hexadecimal value using the two's complement notation, with a minimum value of -2147483648 or 0x800000000; - a number less than the minimum is converted to two's complement with greater precision before the most significant digits are discarded.

-

The result is interpreted as a 32-bit two's complement number, so the result is an integer in the range -2147483648 to 2147483647.

-

-

-Operands - - - - - - - -
expression1:Number — - A number. -
expression2:Number — - A number. -
-

-Result - - - - -
int — The result of the bitwise operation.
-
-Example -

-

-See also -

-
-& (bitwise AND) -
-&= (bitwise AND assignment) -
-~ (bitwise NOT) -
-|= (bitwise OR assignment) -
-^ (bitwise XOR) -
-^= (bitwise XOR assignment) -
-
- - - - - -
|= bitwise OR assignmentoperator 
-
-Usage - - - - -
expression1 |= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 | expression2. For example, the following two statements are equivalent: -

x |= y; 
-x = x | y;

-

-Operands - - - - - - - -
expression1:Number — - A number to be converted. -
expression2:Number — - A number to be converted. -
-

-Result - - - - -
int — The result of the bitwise operation.
-
-Example -

-

-See also -

-
-& (bitwise AND) -
-&= (bitwise AND assignment) -
-~ (bitwise NOT) -
-| (bitwise OR) -
-^ (bitwise XOR) -
-^= (bitwise XOR assignment) -
-
- - - - - -
>> bitwise right shiftoperator 
-
-Usage - - - - -
expression >> shiftCount
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Converts expression and shiftCount to 32-bit integers, and shifts all the bits in expression to the right by the number of places specified by the integer that results from the conversion of shiftCount. Bits that are shifted off the right end are discarded. To preserve the sign of the original expression, the bits on the left are filled in with 0 if the most significant bit (the bit farthest to the left) of expression is 0, and filled in with 1 if the most significant bit is 1. Shifting a value right by one position is the equivalent of dividing by 2 and discarding the remainder. -

A floating-point number is converted to an integer by discarding any digits after the decimal point. - A positive integer is converted to an unsigned hexadecimal value with a maximum value of 4294967295 or 0xFFFFFFFF; - a value larger than the maximum has its most significant digits discarded when it is converted so the value is still 32-bit. - A negative number is converted to an unsigned hexadecimal value using the two's complement notation, with a minimum value of -2147483648 or 0x800000000; - a number less than the minimum is converted to two's complement with greater precision before the most significant digits are discarded.

-

The result is interpreted as a 32-bit two's complement number, so the result is an integer in the range -2147483648 to 2147483647.

-

-

-Operands - - - - - - - -
expression:Number — - A number or expression to be shifted right. -
shiftCount:Number — - A number or expression that converts to an integer from 0 to 31. -
-

-Result - - - - -
int — The result of the bitwise operation.
-
-Example -

-

-See also -

-
->>= (bitwise right shift and assignment) -
-
- - - - - -
>>= bitwise right shift and assignmentoperator 
-
-Usage - - - - -
expression >>= shiftCount
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Performs a bitwise right-shift operation and stores the result in expression. -

The following two statements are equivalent:

- 
A >>= B; 
-A = (A >> B);

-

-Operands - - - - - - - -
expression:Number — - A number or expression to be shifted right. -
shiftCount:Number — - A number or expression that converts to an integer from 0 to 31. -
-

-Result - - - - -
int — The result of the bitwise operation.
-
-Example -

-

-See also -

-
->> (bitwise right shift) -
-
- - - - - -
>>> bitwise unsigned right shiftoperator 
-
-Usage - - - - -
expression >>> shiftCount
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

The same as the bitwise right shift (>>) operator except that it does not preserve the sign of the original expression because the bits on the left are always filled with 0. -

A floating-point number is converted to an integer by discarding any digits after the decimal point. - A positive integer is converted to an unsigned hexadecimal value with a maximum value of 4294967295 or 0xFFFFFFFF; - a value larger than the maximum has its most significant digits discarded when it is converted so the value is still 32-bit. - A negative number is converted to an unsigned hexadecimal value using the two's complement notation, with a minimum value of -2147483648 or 0x800000000; - a number less than the minimum is converted to two's complement with greater precision before the most significant digits are discarded.

-

The result is interpreted as a 32-bit unsigned integer, so the result is an integer in the range 0 to 4294967295.

-

Note: ActionScript has no complementary "bitwise unsigned left shift" operator, but you can achieve the same effect by using uint(expression << shiftCount).

-

-

-Operands - - - - - - - -
expression:Number — - A number or expression to be shifted right. -
shiftCount:Number — - A number or expression that converts to an integer between 0 and 31. -
-

-Result - - - - -
uint — The result of the bitwise operation.
-
-Example -

-

-See also -

-
->> (bitwise right shift) -
->>= (bitwise right shift and assignment) -
-
- - - - - -
>>>= bitwise unsigned right shift and assignmentoperator 
-
-Usage - - - - -
expression >>>= shiftCount
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Performs an unsigned bitwise right-shift operation and stores the result in expression. The following two statements are equivalent: - 

A >>>= B; 
-A = (A >>> B);

-

-Operands - - - - - - - -
expression:Number — - A number or expression to be shifted right. -
shiftCount:Number — - A number or expression that converts to an integer from 0 to 31. -
-

-Result - - - - -
uint — The result of the bitwise operation.
-
-Example -

-

-See also -

-
->>> (bitwise unsigned right shift) -
->>= (bitwise right shift and assignment) -
-
- - - - - -
^ bitwise XORoperator 
-
-Usage - - - - -
expression1 ^ expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Converts expression1 and expression2 to 32-bit unsigned integers, and places a 1 in each bit position where the corresponding bits in expression1 or expression2, but not both, are 1. -

A floating-point number is converted to an integer by discarding any digits after the decimal point. - A positive integer is converted to an unsigned hexadecimal value with a maximum value of 4294967295 or 0xFFFFFFFF; - a value larger than the maximum has its most significant digits discarded when it is converted so the value is still 32-bit. - A negative number is converted to an unsigned hexadecimal value using the two's complement notation, with a minimum value of -2147483648 or 0x800000000; - a number less than the minimum is converted to two's complement with greater precision before the most significant digits are discarded.

-

The result is interpreted as a 32-bit two's complement number, so the result is an integer in the range -2147483648 to 2147483647.

-

-

-Operands - - - - - - - -
expression1:Number — - A number or expression that evaluates to a number. -
expression2:Number — - A number or expression that evaluates to a number. -
-

-Result - - - - -
int — The result of the bitwise operation.
-
-Example -

-

-See also -

-
-& (bitwise AND) -
-&= (bitwise AND assignment) -
-~ (bitwise NOT) -
-| (bitwise OR) -
-|= (bitwise OR assignment) -
-^= (bitwise XOR assignment) -
-
- - - - - -
^= bitwise XOR assignmentoperator 
-
-Usage - - - - -
expression1 ^= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 ^ expression2. For example, the following two statements are equivalent: - 

x ^= y 
-x = x ^ y

-

-Operands - - - - - - - -
expression1:Number — - A number or expression that evaluates to a number. -
expression2:Number — - A number or expression that evaluates to a number. -
-

-Result - - - - -
int — The result of the bitwise operation.
-
-Example -

-

-See also -

-
-& (bitwise AND) -
-&= (bitwise AND assignment) -
-~ (bitwise NOT) -
-| (bitwise OR) -
-|= (bitwise OR assignment) -
-^ (bitwise XOR) -
-
- - - - - -
/*..*/ block comment delimiteroperator 
-
-Usage - - - - -
/* comment */
/* comment
   comment */
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Delimits one or more lines of script comments. Characters that appear between the opening delimiter (/*) and the closing delimiter (*/) are interpreted as a comment and ignored by the ActionScript compiler. - Use these delimiters to identify comments on multiple successive lines; for single-line comments, use the // delimiter. -

You will receive an error message if you omit the closing block comment delimiter (*/), or if you attempt to nest comments. - After an opening delimiter (/*) is used, the first closing delimiter (*/) ends the comment, regardless of the number of opening delimiters placed before it.

-

-Operands - - - - -
comment:* — - Any characters. -
-
-Example -

-

-See also -

-
-// (line comment delimiter) -
-
- - - - - -
{ } braces (XML)operator 
-
-Usage - - - - -
 myXML = <{tagName} {attributeName} = {attributeValue}>{content}</{tagName}>
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates an expression that is used in an XML or XMLList initializer. - An XML or XMLList initializer is a literal value that is assigned to a variable of type XML or XMLList. - An expression that is delimited by the XML { and } operators - can be used in an XML or XMLList initializer instead of literal names or values. - An expression can be used in place of tagName, attributeName, attributeValue, and content. - -

-

-Operands - - - - - - - - - - - - - - - - -
myXML:* — - An XML or XMLList object. -
tagName:* — - An expression that evaluates to the name of an XML tag. -
attributeName:* — - An expression that evaluates to the name of an XML attribute. -
attributeValue:* — - An expression that evaluates to the value of an XML attribute. -
content:* — - An expression that evaluates to the contents of an XML tag. -
-
-Example -

-

-See also -

-
-XML class -
-XMLList class -
-
- - - - - -
[ ] brackets (XML)operator 
-
-Usage - - - - -
 myXML[expression]
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Accesses a property or attribute of an XML or XMLList object. The brackets operator allows you to access property names that are not accessible with the dot (.) operator. - -

-

-Operands - - - - - - - -
myXML:* — - An XML or XMLList object. -
expression:* — - An expression that evaluates to the name of an XML tag or attribute. -
-
-Example -

-

-See also -

-
-XML class -
-XMLList class -
-
- - - - - -
, commaoperator 
-
-Usage - - - - -
(expression1, expression2[, expressionN... ])
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates expression1, then expression2, and so on. This operator is primarily used with the for loop statement and is often used with the parentheses () operator.

-

-Operands - - - - - - - - - - -
expression1:* — - An expression to be evaluated. -
expression2:* — - An expression to be evaluated. -
expressionN:* — - Any number of additional expressions to be evaluated. -
-

-Result - - - - -
Object — The values of the evaluated expressions.
-
-Example -

-

-See also -

-
-() (parentheses) -
-
- - - - - -
+ concatenationoperator 
-
-Usage - - - - -
expression1 + expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Concatenates (combines) strings. If one expression is a string, all other expressions are converted to strings and concatenated. -

If both expressions are numbers, this operator behaves as an addition operator.

-

-Operands - - - - - - - -
expression1:String — - A string to be concatenated. -
expression2:String — - A string to be concatenated. -
-

-Result - - - - -
String — The concatenated string.
-
-Example -

-

-See also -

-
-+ (addition) -
-
- - - - - -
+ concatenation (XMLList)operator 
-
-Usage - - - - -
expression1 + expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Concatenates (combines) XML or XMLList values into an XMLList object. - An XMLList object results only if both operands are XML or XMLList values. -

-

-Operands - - - - - - - -
expression1:* — - An XML or XMLList value. -
expression2:* — - An XML or XMLList value. -
-

-Result - - - - -
XMLList — The concatenated XMLList object.
-
-Example -

-

-See also -

-
-XMLList class -
-XMLList global function -
-
- - - - - -
+= concatenation assignmentoperator 
-
-Usage - - - - -
expression1 += expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 + expression2. For example, the following two statements have the same result: 

x += y; 
-x = x + y;
All the rules of the concatenation (+) operator apply to the concatenation assignment (+=) operator. Note that using concatenation assignment for the text property of a TextField (i.e. someTextField.text += moreText is much less efficient than TextField.appendText(), particularly with a TextField that contains a significant amount of content. -

-

-Operands - - - - - - - -
expression1:String — - A string. -
expression2:String — - A string. -
-

-Result - - - - -
Number — The result of the concatenation.
-
-Example -

-

-See also -

-
-+ (concatenation) -
-
- - - - - -
+= concatenation assignment (XMLList)operator 
-
-Usage - - - - -
expression1 += expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1, which is an XMLList object, the value of expression1 + expression2. - For example, the following two statements have the same result: -

x += y; 
-x = x + y;
All the rules of the XMLList concatenation (+) operator apply to the XMLList concatenation assignment (+=) operator. -

-

-Operands - - - - - - - -
expression1:XMLList — - The XMLList object to which you are adding a new value. -
expression2:* — - An XML or XMLList value. -
-
-Example -

-

-See also -

-
-XML class -
-XMLList class -
-XML() global function -
-XMLList() global function -
-
- - - - - -
?: conditionaloperator 
-
-Usage - - - - -
expression1 ? expression2 : expression3
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates expression1, and if the value of expression1 is true, the result is the value of expression2; otherwise the result is the value of expression3.

-

-Operands - - - - - - - - - - -
expression1:Boolean — - An expression that evaluates to a Boolean value; usually a comparison expression, such as x < 5. -
expression2:* — - A value of any type. -
expression3:* — - A value of any type. -
-

-Result - - - - -
* — The value of expression2 or expression3.
-
-Example -

-
- - - - - -
-- decrementoperator 
-
-Usage - - - - -
--expression
expression--
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Subtracts 1 from the operand. The operand can be a variable, element in an array, or property of an object. - The pre-decrement form of the operator (--expression) subtracts 1 from expression and returns the result. - The post-decrement form of the operator (expression--) subtracts 1 from expression and returns the initial value of expression (the value prior to the subtraction).

-

-Operands - - - - -
expression:Number — - A number or a variable that evaluates to a number. -
-

-Result - - - - -
Number — The result of the decremented value.
-
-Example -

-
- - - - - -
deleteoperator 
-
-Usage - - - - -
 delete reference
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Destroys the object property specified by reference; the result is true if the property does not exist after the operation completes, and false otherwise. - The delete operator returns true if it is called on a nonexistent property or a dynamic property not defined in a class. -

The delete operator can fail and return false if the reference parameter cannot be deleted. - You cannot delete fixed properties or variables that are declared with the var statement. - A fixed property is a variable or method defined in a class definition.

-

The delete operator cannot be used to destroy a property of a class, unless that class is a dynamic class added at runtime. Properties of sealed classes cannot be destroyed using delete. Set the property to null instead.

-

Note: You cannot delete an object, but you can make an object eligible for garbage collection by removing all references to the object. - The most common reference to an object is a variable that points to it. You can remove such a reference by setting the variable to null. - The garbage collector removes any object that has no references.

-

-

-Operands - - - - -
reference:* — - The name of the property to eliminate. -
-

-Result - - - - -
Boolean — The value true if the deletion succeeded and false if it failed.
-
-Example -

-

-See also -

-
-var -
-
- - - - - -
delete (XML)operator 
-
-Usage - - - - -
 delete reference
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Deletes the XML elements or attributes specified by reference.

-

-Operands - - - - -
reference:XMLList — - An XMLList object that specifies the XML elements or attributes to delete. -
-

-Result - - - - -
Boolean — Always returns a value of true. The result is always true because the XMLList operand always refers to a valid (though possibly empty) XMLList object.
-
-Example -

-
- - - - - -
.. descendant accessoroperator 
-
-Usage - - - - -
 myXML..childElement1..@attributeName
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Navigates to descendant elements of an XML or XMLList object, - or (combined with the @ operator) finds matching attributes of descendants. - The matching elements or attributes need not be direct children of the XML or XMLList object; - they can be lower in the tree (for example, grandchildren). The result is an XMLList object, - because more than one child element or attribute can match. - -

The order of nodes in the XMLList object returned is the result of a depth-first traversal. For example, consider the following:

- -
var myXML:XML = <a>
-			<b>one
-				<c> 
-					<b>two</b> 
-				</c> 
-			</b>
-			<b>three</b>
-		</a>;
-
-trace(myXML..b[0].toXMLString());
-trace("______________");
-trace(myXML..b[1].toXMLString());
-trace("______________");
-trace(myXML..b[2].toXMLString());
- -

The following output would result:

- -
<b>
-  one
-  <c>
-    <b>two</b>
-  </c>
-</b>
-______________
-<b>two</b>
-______________
-<b>three</b>
-
- -

To return descendants with names that match ActionScript reserved words, use the -XML.descendants() method instead of the descendant (..) operator, as the -following example shows:

- -
-var xml:XML = 
-<enrollees>
-	<student id="239">
-		<class name="Algebra" />
- 		<class name="Spanish 2"/>
-	</student>
-	<student id="206">
-		<class name="Trigonometry" />
- 		<class name="Spanish 2" />
-	</student>
- </enrollees>;
- trace(xml.descendants("class")); 
-
- -

-

-Operands - - - - - - - -
myXML:Object — - The XML or XMLList object. -
childElement1_or_attributeName — - The name of an XML property or the name of an attribute. -
-
-Example -

-

-See also -

-
-XML class -
-XMLList class -
-XML.descendants() -
-
- - - - - -
/ divisionoperator 
-
-Usage - - - - -
expression1 / expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Divides expression1 by expression2. The result of the division operation is a double-precision floating-point number.

-

-Operands - - - - -
expression:Number — - A number or a variable that evaluates to a number. -
-

-Result - - - - -
Number — The floating-point result of the operation.
-
-Example -

-

-See also -

-
-% (modulo) -
-
- - - - - -
/= division assignmentoperator 
-
-Usage - - - - -
expression1 /= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 / expression2. For example, the following two statements are equivalent: -

x /= y; 
-x = x / y;

-

-Operands - - - - - - - -
expression1:Number — - A number or a variable that evaluates to a number. -
expression2:Number — - A number or a variable that evaluates to a number. -
-

-Result - - - - -
Number — A number.
-
-Example -

-

-See also -

-
-/ (division) -
-
- - - - - -
. dotoperator 
-
-Usage - - - - -
object.property_or_method
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Accesses class variables and methods, gets and sets object properties, and delimits imported packages or classes.

-

-Operands - - - - - - - -
object:Object — - An instance of a class. The object can be an instance of any of the built-in ActionScript classes or a class you define. This operand is always to the left of the dot (.) operator. -
property_or_method:* — - The name of a property or method associated with an object. All the valid methods and properties for the built-in classes are listed in the method and property summary tables for that class. This operand is always to the right of the dot (.) operator. -
-

-Result - - - - -
* — The variable, method, or property named on the right side of the dot.
-
-Example -

-

-See also -

-
-dot (XML) operator -
-
- - - - - -
. dot (XML)operator 
-
-Usage - - - - -
myXML.childElement
-myXML.@attributeName
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Navigates to child elements - of an XML or XMLList object, or (combined with the @ operator) returns attributes - of an XML or XMLList object. The object returned is an XMLList, because more than - one child element or attribute can match. -

To return elements with names that match - ActionScript reserved words, use the XML.elements() method or the XML.descendants() method instead of the - XML dot (.) operator, as the following example shows:

- -
-var xml:XML = 
-	<student id="206">
-		<class name="Trigonometry" />
-		<class name="Spanish 2" />
-	</student>;
-trace(xml.elements("class"));
-trace(xml.descendants("class")); 
-
-

-

-Operands - - - - - - - - - - -
myXML:Object — - The XML or XMLList object. -
childElement:* — - The name of an XML property. -
attributeName:* — - The name of an attribute. -
-

-Result - - - - -
XMLList — The XMLList specified.
-
-Example -

-

-See also -

-
-XML class -
-XMLList class -
-XML.descendants() -
-XML.elements() -
-
- - - - - -
== equalityoperator 
-
-Usage - - - - -
expression1 == expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Tests two expressions for equality. The result is true if the expressions are equal. -

If the data types of the two operands match, the definition of equal depends on the data type of the operands:

-
    -
  • Values of type int, uint, and Boolean are considered equal if they have the same value.
    • -
  • Numbers with matching values are considered equal, unless they are both NaN.
    • -
  • If the value of both operands is null or undefined, they are considered equal.
    • -
  • String expressions are equal if they have the same number of characters and the characters are identical.
    • -
  • For XML objects: -
      -
    • If one operand is a text or attribute node and the other has simple content, both operands are converted to strings with the toString() method and are considered equal if the resulting strings match.
      • -
    • Otherwise, objects are considered equal only if the qualified name, attributes, and child properties for both objects match.
      • -
    -
    • -
  • XMLList objects are considered equal if they have the same number of properties and both the order and values of the properties match.
    • -
  • For Namespace objects, values are considered equal if the uri properties of both objects match.
    • -
  • For QName objects, values are considered equal if the uri properties of both objects match and the localName properties of both objects match.
    • -
  • Variables representing objects, arrays, and functions are compared by reference. Two such variables are equal if they refer to the same object, array, or function. Two separate arrays are never considered equal, even if they have the same number of elements.
    • -
- - - If the data types of the operands do not match, the result is false except in the following circumstances: -
    -
  • The operands' values are undefined and null, in which case the result is true.
    • -
  • Automatic data type conversion converts the data types of String, Boolean, int, uint, and Number values to compatible types and the converted values are equal, in which case operands are considered equal.
    • -
  • One operand is of type XML with simple content (hasSimpleContent() == true), and after both operands are converted to strings with the toString() method, the resulting strings match.
    • -
  • One operand is of type XMLList, and either of the following conditions is true: -
      -
    • The length property of the XMLList object is 0, and the other object is undefined.
      • -
    • The length property of the XMLList object is 1, and one element of the XMLList object matches the other operand.
      • -
    -
    • -
-

-

-Operands - - - - - - - -
expression1:Object — - A number, string, Boolean value, variable, object, array, or expression. -
expression2:Object — - A number, string, Boolean value, variable, object, array, or expression. -
-

-Result - - - - -
Boolean — A value of true if the expressions are equal, and false otherwise.
-
-Example -

-

-See also -

-
-!= (inequality) -
-&& (logical AND) -
-! (logical NOT) -
-|| (logical OR) -
-=== (strict equality) -
-!== (strict inequality) -
-
- - - - - -
> greater thanoperator 
-
-Usage - - - - -
expression1 > expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Compares two expressions and determines whether expression1 - is greater than expression2; if it is, the result is true. - If expression1 is less than or equal to expression2, the result is false. -

If both operands are of type String, the operands are compared using alphabetical - order; all capital letters come before lowercase letters. Otherwise, operands are first - converted to numbers, then compared.

-

-

-Operands - - - - - - - -
expression1:Object — - A string, integer, or floating-point number. -
expression2:Object — - A string, integer, or floating-point number. -
-

-Result - - - - -
Boolean — A value of true if expression1 is greater than expression2; false otherwise.
-
-Example -

-
- - - - - -
>= greater than or equal tooperator 
-
-Usage - - - - -
expression1 >= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Compares two expressions and determines whether expression1 is greater than or equal to expression2 (true) or expression1 is less than expression2 (false).

-

-Operands - - - - - - - -
expression1:Object — - A string, integer, or floating-point number. -
expression2:Object — - A string, integer, or floating-point number. -
-

-Result - - - - -
Boolean — A value of true if expression1 is greater than or equal to expression2; false otherwise.
-
-Example -

-

-See also -

-
-> (greater than) -
-
- - - - - -
inoperator 
-
-Usage - - - - -
expression1 in expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates whether a property is part of a specific object. - To use the in operator, specify a property name as the first operand - and an object as the second operand. If the object you specify contains such a - property, the result is true; otherwise the result is false. -

If the specified object is an Array object, you can use the in - operator to check whether a particular index number is valid. If you pass an - integer as the first operand, the result is true if the index is - within the valid range of index numbers, and false otherwise.

-

-

-Result - - - - -
Boolean — A value of true if expression1 is a property of the object represented by expression2, and false otherwise.
-
-Example -

-

-See also -

-
-instanceof -
-
- - - - - -
++ incrementoperator 
-
-Usage - - - - -
++expression
 expression++
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Adds 1 to an expression. - The expression can be a variable, an element in an array, or a property of an - object. The pre-increment form of the operator (++expression) adds 1 to - expression and returns the result. The post-increment form of the operator - (expression++) adds 1 to expression and returns the - initial value of expression (the value prior to the addition). - -

-

-Operands - - - - -
expression:Number — - A number or a variable that evaluates to a number. -
-

-Result - - - - -
Number — The result of the increment.
-
-Example -

-
- - - - - -
!= inequalityoperator 
-
-Usage - - - - -
expression1 != expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Tests for the exact opposite of the equality (==) operator. If expression1 is equal to expression2, the result is false. As with the equality (==) operator, the definition of equal depends on the data types being compared. -

If the data types of the two operands match, the definition of equal depends on the data type of the operands:

-
    -
  • Values of type int, uint, and Boolean are considered equal if they have the same value.
    • -
  • Numbers with matching values are considered equal, unless they are both NaN.
    • -
  • If the value of both operands is null or undefined, they are considered equal.
    • -
  • String expressions are equal if they have the same number of characters and the characters are identical.
    • -
  • For XML objects: -
      -
    • If one operand is a text or attribute node and the other has simple content, both operands are converted to strings with the toString() method and are considered equal if the resulting strings match.
      • -
    • Otherwise, objects are considered equal only if the qualified name, attributes, and child properties for both objects match.
      • -
    -
    • -
  • XMLList objects are considered equal if they have the same number of properties and both the order and values of the properties match.
    • -
  • For Namespace objects, values are considered equal if the uri properties of both objects match.
    • -
  • For QName objects, values are considered equal if the uri properties of both objects match and the localName properties of both objects match.
    • -
  • Variables representing objects, arrays, and functions are compared by reference. Two such variables are equal if they refer to the same object, array, or function. Two separate arrays are never considered equal, even if they have the same number of elements.
    • -
- - - If the data types of the operands do not match, the inequality operator (!=) returns true except in the following circumstances: -
    -
  • The operands' values are undefined and null, in which case the result is true.
    • -
  • Automatic data type conversion converts the data types of String, Boolean, int, uint, and Number values to compatible types and the converted values are equal, in which case operands are considered equal.
    • -
  • One operand is of type XML with simple content (hasSimpleContent() == true), and after both operands are converted to strings with the toString() method the resulting strings match.
    • -
  • One operand is of type XMLList, and either of the following conditions is true: -
      -
    • The length property of the XMLList object is 0, and the other object is undefined.
      • -
    • The length property of the XMLList object is 1, and one element of the XMLList object matches the other operand.
      • -
    -
    • -
- -

-

-Operands - - - - - - - -
expression1:Object — - A number, string, Boolean value, variable, object, array, or function. -
expression2:Object — - A number, string, Boolean value, variable, object, array, or function. -
-

-Result - - - - -
Boolean — A value of true if the expressions are not equal, and false otherwise.
-
-Example -

-

-See also -

-
-== (equality) -
-&& (logical AND) -
-! (logical NOT) -
-|| (logical OR) -
-=== (strict equality) -
-!== (strict inequality) -
-
- - - - - -
instanceofoperator 
-
-Usage - - - - -
expression instanceof function
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates whether an expression's prototype chain includes the prototype object for function. - The instanceof operator is included for backward compatibility with ECMAScript edition 3, - and may be useful for advanced programmers who choose to use prototype-based inheritance with constructor functions instead of classes. -

To check whether an object is a member of a specific data type, use the is operator.

-

When used with classes, the instanceof operator is similar to the is operator because a class's prototype chain includes all of its superclasses. - Interfaces, however, are not included on prototype chains, so the instanceof operator always results in false when used with interfaces, - whereas the is operator results in true if an object belongs to a class that implements the specified interface.

-

Note: The ActionScript is operator is the equivalent of the Java instanceof operator.

-

-Operands - - - - - - - -
expression:Object — - The object that contains the prototype chain to evaluate. -
function:Object — - A function object (or class). -
-

-Result - - - - -
Boolean — Returns true if the prototype chain of expression includes the prototype object for function, and false otherwise.
-
-Example -

-

-See also -

-
-is -
-prototype -
-
- - - - - -
isoperator 
-
-Usage - - - - -
expression1 is expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates whether an object is compatible with a specific data type, class, or interface. - Use the is operator instead of the instanceof operator for type comparisons. - You can also use the is operator to check whether an object implements an interface. -

-

-Result - - - - -
Boolean — A value of true if expression1 is compatible with the data type, class, or interface specified in expression2, and false otherwise.
-
-Example -

-

-See also -

-
-as -
-instanceof -
-
- - - - - -
< less thanoperator 
-
-Usage - - - - -
expression1 < expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Compares two expressions and determines whether expression1 - is less than expression2; if so, the result is true. - If expression1 is greater than or equal to expression2, the result is false. -

If both operands are of type String, the operands are compared using alphabetical order; - all capital letters come before lowercase letters. - Otherwise, operands are first converted to numbers, then compared.

-

-

-Operands - - - - - - - -
expression1:Object — - A string, integer, or floating-point number. -
expression2:Object — - A string, integer, or floating-point number. -
-

-Result - - - - -
Boolean — A value of true if expression1 is less than expression2; false otherwise.
-
-Example -

-
- - - - - -
<= less than or equal tooperator 
-
-Usage - - - - -
expression1 <= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Compares two expressions and determines whether expression1 is less than or equal to expression2; - if it is, the result is true. If expression1 is greater than expression2, the result is false. -

If both operands are of type String, the operands are compared using alphabetical order; all capital letters come before lowercase letters. Otherwise, operands are first converted to numbers, then compared.

-

-

-Operands - - - - - - - -
expression1:Object — - A string, integer, or floating-point number. -
expression2:Object — - A string, integer, or floating-point number. -
-

-Result - - - - -
Boolean — A value of true if expression1 is less than or equal to expression2; false otherwise.
-
-Example -

-
- - - - - -
// line comment delimiteroperator 
-
-Usage - - - - -
// comment
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Indicates the beginning of a script comment. Characters that appear between the comment delimiter (//) and the end-of-line character are interpreted as a comment and are ignored. - Use this delimiter for single-line comments; for comments on multiple successive lines, use the /* and */ delimiters. - -

-

-Operands - - - - -
comment:* — - Any characters. -
-
-Example -

-

-See also -

-
-/*..*/ (block comment delimiter) -
-
- - - - - -
&& logical ANDoperator 
-
-Usage - - - - -
expression1 && expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Returns expression1 if it is false or can be converted to false, and expression2 otherwise. - Examples of values that can be converted to false are 0, NaN, null, and undefined. - If you use a function call as expression2, the function is not called if expression1 evaluates to false. -

If both operands are of type Boolean, the result is true only if both operands are true, as - shown in the following table:

- - - - - - - - - - - - - - - - - - - - - -
Expression Evaluates
true && true true
true && false false
false && false false
false && true false
-

-

-Operands - - - - - - - -
expression1:* — - A value or expression of any type. -
expression2:* — - A value of expression of any type. -
-

-Result - - - - -
* — A Boolean value if both operands are of type Boolean. Otherwise, the result is the value of either expression.
-
-Example -

-

-See also -

-
-== (equality) -
-!= (inequality) -
-! (logical NOT) -
-|| (logical OR) -
-||= (logical OR assignment) -
-&&= (logical AND assignment) -
-=== (strict equality) -
-!== (strict inequality) -
-
- - - - - -
&&= logical AND assignmentoperator 
-
-Usage - - - - -
expression1 &&= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 && expression2. For example, the following two statements are equivalent: -

x &&= y; 
-x = x && y;
-

-

-Operands - - - - - - - -
expression1:* — - A value of any type. -
expression2:* — - A value of any type. -
-

-Result - - - - -
* — A Boolean value if both operands are members of the Boolean data type. Otherwise, the result will be the value of either of the two expressions.
-
-Example -

-

-See also -

-
-== (equality) -
-!= (inequality) -
-|| (logical OR) -
-||= (logical OR assignment) -
-&& (logical AND) -
-! (logical NOT) -
-=== (strict equality) -
-!== (strict inequality) -
-
- - - - - -
! logical NOToperator 
-
-Usage - - - - -
!expression
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Inverts the Boolean value of a variable or expression. If expression is a variable with the absolute or converted value true, the value of !expression is false. If the expression x && y evaluates to false, the expression !(x && y) evaluates to true. -

The following expressions illustrate the result of using the logical NOT (!) operator:

-
  • !true returns false.
    • -
  • !false returns true.

-

-Operands - - - - -
expression:Boolean — - An expression or a variable that evaluates to a Boolean value. -
-

-Result - - - - -
Boolean — The Boolean result of the logical operation.
-
-Example -

-

-See also -

-
-== (equality) -
-!= (inequality) -
-&& (logical AND) -
-|| (logical OR) -
-&&= (logical AND assignment) -
-||= (logical OR assignment) -
-=== (strict equality) -
-!== (strict inequality) -
-
- - - - - -
|| logical ORoperator 
-
-Usage - - - - -
expression1 || expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Returns expression1 if it is true or can be converted to true, and expression2 otherwise. - If you use a function call as expression2, the function is not called if expression1 evaluates to true. -

If both operands are of type Boolean, the result is true if either or both expressions are true; the result is false only if both expressions are false, as shown in the following table: -

- - - - - - - - - - - - - - - - - - - - - -
Expression Evaluates
true || true true
true || false true
false || false false
false || true true
- -

-

-Operands - - - - - - - -
expression1:* — - A value of any type. -
expression2:* — - A value of any type. -
-

-Result - - - - -
* — A Boolean value if both operands are members of the Boolean data type. Otherwise, the result will be the value of either of the two expressions.
-
-Example -

-

-See also -

-
-== (equality) -
-!= (inequality) -
-&& (logical AND) -
-&&= (logical AND assignment) -
-||= (logical OR assignment) -
-! (logical NOT) -
-=== (strict equality) -
-!== (strict inequality) -
-
- - - - - -
||= logical OR assignmentoperator 
-
-Usage - - - - -
expression1 ||= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 || expression2. For example, the following two statements are equivalent: -

x ||= y; 
-x = x || y;
-

-

-Operands - - - - - - - -
expression1:* — - A value of any type. -
expression2:* — - A value of any type. -
-

-Result - - - - -
* — A Boolean value if both operands are members of the Boolean data type. Otherwise, the result will be the value of either of the two expressions.
-
-Example -

-

-See also -

-
-== (equality) -
-!= (inequality) -
-|| (logical OR) -
-&& (logical AND) -
-&&= (logical AND assignment) -
-! (logical NOT) -
-=== (strict equality) -
-!== (strict inequality) -
-
- - - - - -
% modulooperator 
-
-Usage - - - - -
expression1 % expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Calculates the remainder of expression1 divided by expression2. If either operand is non-numeric, the modulo (%) operator attempts to convert it to a number. -

The sign of the modulo result matches the sign of the dividend (the first number). For example, -4 % 3 and -4 % -3 both evaluate to -1.

-

-Operands - - - - - - - -
expression1:Number — - A number or expression that evaluates to a number. A string that contains only numeric characters evaluates to a number. -
expression2:Number — - A number or expression that evaluates to a number. A string that contains only numeric characters evaluates to a number. -
-

-Result - - - - -
Number — The result of the arithmetic operation.
-
-Example -

-

-See also -

-
-/ (division) -
-Math.round() -
-
- - - - - -
%= modulo assignmentoperator 
-
-Usage - - - - -
expression1 %= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 % expression2. The following two statements are equivalent: - 

x %= y; 
-x = x % y;

-

-Operands - - - - - - - -
expression1:Number — - A number or expression that evaluates to a number. -
expression2:Number — - A number or expression that evaluates to a number. -
-

-Result - - - - -
Number — The result of the arithmetic operation.
-
-Example -

-

-See also -

-
-% (modulo) -
-
- - - - - -
* multiplicationoperator 
-
-Usage - - - - -
expression1 * expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Multiplies two numerical expressions. If both expressions are integers, the product is an integer. If either or both expressions are floating-point numbers, the product is a floating-point number.

-

-Operands - - - - - - - -
expression1:Number — - A number or expression that evaluates to a number. -
expression2:Number — - A number or expression that evaluates to a number. -
-

-Result - - - - -
Number — An integer or floating-point number.
-
-Example -

-
- - - - - -
*= multiplication assignmentoperator 
-
-Usage - - - - -
expression1 *= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 * expression2. For example, the following two expressions are equivalent: - 

x *= y 
-x = x * y

-

-Operands - - - - - - - -
expression1:Number — - A number or expression that evaluates to a number. -
expression2:Number — - A number or expression that evaluates to a number. -
-

-Result - - - - -
Number — The value of expression1 * expression2 . If an expression cannot be converted to a numeric value, it returns NaN (not a number).
-
-Example -

-

-See also -

-
-* (multiplication) -
-
- - - - - -
:: name qualifieroperator 
-
-Usage - - - - -
namespace::property
- 
namespace::method()
- 
namespace::xmlObject.property
- 
namespace::xmlObject.@attribute
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Identifies the namespace of a property, a method, an XML property, or an XML attribute.

-

-Operands - - - - - - - -
namespace:Object — - The identifying namespace. -
propertyName:Object — - The property, method, XML property, or XML attribute to identify. -
-
-Example -

-

-See also -

-
-Namespace class -
-XML class -
-
- - - - - -
newoperator 
-
-Usage - - - - -
new constructor(parameters)
-

- - - - -
Runtime version: 
-

-

Instantiates a class instance. The new operator can be used with a class or a variable of type Class to create an instance of a class. - The new operator is commonly used with a class object to create an instance of a class. For example, the statement new Sprite() creates an instance of the Sprite class. -

The new operator can also be used to associate a class with an embedded asset, which is an external object such as an image, sound, or font that is compiled into a SWF file. - Each embedded asset is represented by a unique embedded asset class. To access an embedded asset, you must use the new operator to instantiate its associated class. - Subsequently, you can call the appropriate methods and properties of the embedded asset class to manipulate the embedded asset.

-

If you prefer to define classes with Function objects instead of the class keyword, you can use the new operator to create objects based on constructor functions. - Do not confuse constructor functions with constructor methods of a class. A constructor function is a Function object that is defined with the function keyword, but that is not part of a class definition. - If you use constructor functions to create objects, you must use prototype inheritance instead of class inheritance.

- -

-

-Operands - - - - - - - -
constructor:* — - A class, a function, or a variable that holds a value of type Class. -
parameters:* — - One or more parameters, separated by commas. -
-
-Example -

-

-See also -

-
-[] (array access) -
-class statement -
-Object.constructor -
-Object.prototype -
-{} (object initializer) -
-
- - - - - -
?. null condition member accessoperator 
-
-Usage - - - - -
object?.property_or_method
-

- - - - -
Language version: ActionScript 3.1
- - - - -
Runtime version: AIR 50
-

-

Accesses class variables and methods, gets and sets object properties, with an inherent null-object check. If the object on which this operator is applied is null, - then rather than throwing a null reference error, the expression evaluates to null. -

For example sprite.stage.nativeWindow would return the native window on which the 'sprite' object is placed. But if the sprite was not on the stage, this would throw a - null reference error. Using the null condition member access, this becomes sprite.stage?.nativeWindow which would then result in a 'null' value if the sprite was not on the - stage, rather than throwing an errro.

-

-

-Operands - - - - - - - -
object:Object — - An instance of a class. The object can be an instance of any of the built-in ActionScript classes or a class you define. This operand is always to the left of the dot (.) operator. -
property_or_method:* — - The name of a property or method associated with an object. All the valid methods and properties for the built-in classes are listed in the method and property summary tables for that class. This operand is always to the right of the dot (.) operator. -
-

-Result - - - - -
* — If the object is null, this values to null. Otherwise it returns the variable, method, or property named on the right side of the dot.
-
-Example -

-

-See also -

-
-dot operator -
-
- - - - - -
?? nullish coalescingoperator 
-
-Usage - - - - -
expression1 ?? expression2
-

- - - - -
Language version: ActionScript 3.1
- - - - -
Runtime version: AIR 50
-

-

Returns expression1 unless it is null or undefined, and expression2 otherwise. - If you use a function call as expression2, the function is not called unless expression1 evaluates to null or undefined. -

This is essentially a short-hand way of writing "(expression1 == null || expression1 == undefined) ? expression2 : expression1". If expression1 is - a 'false' or zero value, this is a defined value and so would be returned (i.e. "(0 ?? 1)" would return 0, whereas "(null ?? 1)" would return - 1, as would "(0 || 1)"). -

-

-

-Operands - - - - - - - -
expression1:* — - A value of any type. -
expression2:* — - A value of any type. -
-

-Result - - - - -
* — The result will be the value of either of the two expressions.
-

-See also -

-
-== (equality) -
-|| (logical OR) -
-
- - - - - -
{} object initializeroperator 
-
-Usage - - - - -
object = {name1 : value1, name2 : value2,... nameN : valueN}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Creates a new object and initializes it with the specified name and value property pairs. Using this operator is the same as using the new Object syntax and populating the property pairs using the assignment operator. The prototype of the newly created object is generically named the Object object.

This operator is also used to mark blocks of contiguous code associated with flow control statements (for, while, if, else, switch) and functions.

-

-Operands - - - - - - - - - - -
object:Object — - The object to create. -
name1,2,...N:Object — - The names of the properties. -
value1,2,...N:Object — - The corresponding values for each name property. -
-

-Result - - - - -
Object — An Object object.
-
-Example -

-

-See also -

-
-braces (XML) -
-Object class -
-
- - - - - -
() parenthesesoperator 
-
-Usage - - - - -
(expression1[, expression2])
(expression1, expression2)
function(parameter1,..., parameterN)
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Performs a grouping operation on one or more parameters, performs sequential evaluation of expressions, or surrounds one or more parameters and passes them as arguments to a function that precedes the parentheses.

Usage 1: Controls the order in which the operators execute. Parentheses override the normal precedence order and cause the expressions within the parentheses to be evaluated first. When parentheses are nested, the contents of the innermost parentheses are evaluated before the contents of the outer ones.

Usage 2: Evaluates a series of expressions, separated by commas, in sequence, and returns the result of the final expression.

-

Usage 3: Surrounds one or more parameters and passes them to the function that precedes the parentheses.

-

-Operands - - - - - - - - - - - - - -
expression1:Object — - An expression, which can include numbers, strings, variables, or text. -
expression2:Object — - An expression, which can include numbers, strings, variables, or text. -
function:Function — - The function to be performed on the contents of the parentheses. -
parameter1...parameterN:Object — - A series of parameters to execute before the results are passed as arguments to the function outside the parentheses. -
-
-Example -

-

-See also -

-
-parentheses (XML) -
-with -
-
- - - - - -
( ) parentheses (XML)operator 
-
-Usage - - - - -
myXML.(expression)
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates an expression in an ECMAScript for XML (E4X) XML construct. For example, myXML.(lastName == "Smith") identifies XML elements with the name lastName and the value "Smith". The result is an XMLList object.

-

-Operands - - - - - - - -
myXML:* — - An XML or XMLList object. -
expression:* — - The expression defining the matching elements. -
-

-Result - - - - -
XMLList — The XMLList specified by the parentheses.
-
-Example -

-

-See also -

-
-XML class -
-XMLList class -
-
- - - - - -
/ RegExp delimiteroperator 
-
-Usage - - - - -
/pattern/flags
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

When used before and after characters, indicates that the characters have a literal value and are considered a regular expression (RegExp), not a variable, string, or other ActionScript element. Note, however, that two sequential forward slash characters (//) indicate the beginning of a comment.

-

-Operands - - - - - - - -
pattern:String — - A sequence of one or more characters, defining the pattern of the regular expression. -
flags:String — - A sequence of zero or more of the following characters: g (for the global flag), i (for the ignoreCase flag), s (for the dotall flag), x (for the extended flag). -
-
-Example -

-

-See also -

-
-RegExp class -
-
- - - - - -
=== strict equalityoperator 
-
-Usage - - - - -
expression1 === expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Tests two expressions for equality, but does not perform automatic data conversion. - The result is true if both expressions, including their data types, are equal. -

The strict equality (===) operator is the same as the equality (==) operator in three ways:

-
    -
  • Numbers and Boolean values are compared by value and are considered equal if they have the same value.
    • -
  • String expressions are equal if they have the same number of characters and the characters are identical.
    • -
  • Variables representing objects, arrays, and functions are compared by reference. Two such variables are equal if they refer to the same object, array, or function. Two separate arrays are never considered equal, even if they have the same number of elements.
    • -
- The strict equality (===) operator differs from the equality (==) operator in only two ways: -
    -
  • The strict equality operator performs automatic data conversion only for the number types (Number, int, and uint), - whereas the equality operator performs automatic data conversion for all primitive data types.
    • -
  • When comparing null and undefined, the strict equality operator returns false.
    • -
- The strict equality operator generates different results in ActionScript 3.0 than it did in ActionScript 2.0 in two situations involving primitive values (for example, var x:Number = 1) with primitive objects (for example, var x:Number = new Number(1)). - This is because ActionScript 3.0 removes the distinction between primitive values and primitive wrapper objects. -

First, comparisons between primitive values and primitive objects that contain the same value return true in ActionScript 3.0, but false in earlier versions. In earlier versions, the data type of a primitive value is either Boolean, Number, or String, whereas the data type of a primitive object is always Object rather than Boolean, Number or String. - The practical effect of this difference is that the following code results in false in previous versions of ActionScript because the data types of the operands do not match, but the result is true in ActionScript 3.0 because primitive values are typed as either Boolean, Number, int, uint, or String, whether they are wrapped in an object or not.

- 
-var num1:Number = 1;
-var num2:Number = new Number(1);
-trace(num1 === num2); // true in ActionScript 3.0, false in ActionScript 2.0
-
- Second, comparisons between two primitive objects that contain the same value result in true in ActionScript 3.0, but false in previous versions. - 
-var num1:Number = new Number(1);
-var num2:Number = new Number(1);
-trace(num1 == num2);  // true in ActionScript 3.0, false in ActionScript 2.0
-trace(num1 === num2); // true in ActionScript 3.0, false in ActionScript 2.0
- This is because in previous versions of ActionScript, both variables belong to the data type Object, so they are compared by reference and the result is false for both the equality and strict equality operations. - In ActionScript 3.0, however, both variables belong to the data type Number, so they are compared by value and the result is true for both the equality and strict equality operators. -

-

-Operands - - - - - - - -
expression1:Object — - A number, string, Boolean value, variable, object, array, or function. -
expression2:Object — - A number, string, Boolean value, variable, object, array, or function. -
-

-Result - - - - -
Boolean — The Boolean result of the comparison.
-
-Example -

-

-See also -

-
-== (equality) -
-!= (inequality) -
-&& (logical AND) -
-! (logical NOT) -
-|| (logical OR) -
-!== (strict inequality) -
-
- - - - - -
!== strict inequalityoperator 
-
-Usage - - - - -
expression1 !== expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Tests for the exact opposite of the strict equality (===) operator. - The strict inequality operator performs the same as the inequality operator except that only the int and uint data types are converted. -

If expression1 is equal to expression2, and their data types are equal, the result is false.

-

The strict inequality (!==) operator is the same as the inequality (!=) operator in three ways:

-
    -
  • Numbers and Boolean values are compared by value and are considered equal if they have the same value.
    • -
  • String expressions are equal if they have the same number of characters and the characters are identical.
    • -
  • Variables representing objects, arrays, and functions are compared by reference. Two such variables are equal if they refer to the same object, array, or function. Two separate arrays are never considered equal, even if they have the same number of elements.
    • -
- The strict inequality operator differs from the inequality (!=) operator in only two ways: -
    -
  • The strict inequality (!==) operator performs automatic data conversion only for the number types, Number, int, and uint, - whereas the inequality (!=) operator performs automatic data conversion for all primitive data types.
    • -
  • When comparing null and undefined, the strict inequality (!==) operator returns true.
    • -
-

-

-Operands - - - - - - - -
expression1:Object — - A number, string, Boolean value, variable, object, array, or function. -
expression2:Object — - A number, string, Boolean value, variable, object, array, or function. -
-

-Result - - - - -
Boolean — The Boolean result of the comparison.
-
-Example -

-

-See also -

-
-== (equality) -
-!= (inequality) -
-&& (logical AND) -
-! (logical NOT) -
-|| (logical OR) -
-=== (strict equality) -
-
- - - - - -
" string delimiteroperator 
-
-Usage - - - - -
 "text"
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

When used before and after characters, indicates that the characters have a literal value and are considered a string, not a variable, numerical value, or other ActionScript element.

-

-Operands - - - - -
text:String — - A sequence of zero or more characters. -
-
-Example -

-

-See also -

-
-String class -
-String() function -
-
- - - - - -
- subtractionoperator 
-
-Usage - - - - -
-expression
 expression1 - expression2
-

- - - - -
Runtime version: 
-

-

Used for negating or subtracting.

Usage 1: When used for negating, the operator reverses the sign of a numerical expression.

Usage 2: When used for subtracting, the operator performs an arithmetic subtraction on two numerical expressions, subtracting expression2 from expression1. When both expressions are integers, the difference is an integer. When either or both expressions are floating-point numbers, the difference is a floating-point number.

-

-Operands - - - - - - - -
expression1:Number — - A number or expression that evaluates to a number. -
expression2:Number — - A number or expression that evaluates to a number. -
-

-Result - - - - -
Number — An integer or floating-point number.
-
-Example -

-
- - - - - -
-= subtraction assignmentoperator 
-
-Usage - - - - -
expression1 -= expression2
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Assigns expression1 the value of expression1 - expression2. For example, the following two statements are equivalent: - 

x -= y ;
-x = x - y;
-

String expressions must be converted to numbers; otherwise, the result is NaN (not a number).

-

-Operands - - - - - - - -
expression1:Number — - A number or expression that evaluates to a number. -
expression2:Number — - A number or expression that evaluates to a number. -
-

-Result - - - - -
Number — The result of the arithmetic operation.
-
-Example -

-

-See also -

-
-- (subtraction) -
-
- - - - - -
: typeoperator 
-
-Usage - - - - -
[modifiers] var variableName:type
function functionName():type { ... }
function functionName(parameter1:type, ..., parameterN:type) [:type]{ ... }
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Used for assigning a data type; this operator specifies the variable type, function return type, or function parameter type. When used in a variable declaration or assignment, this operator specifies the variable's type; when used in a function declaration or definition, this operator specifies the function's return type; when used with a function parameter in a function definition, this operator specifies the variable type expected for that parameter. -

Type checking always occurs at run time. However, when the compiler is set to strict mode, all types are also checked at compile time, and errors are generated when there is a mismatch. Mismatches can occur during assignment operations, function calls, and class member dereferencing using the dot (.) operator.

-

Types that you can use include all native object types, classes and interfaces that you define, and void. The recognized native types are Boolean, Number, int, uint, and String. All built-in classes are also supported as native types.

-

If you do not assign a data type, the variable, function return value, or function parameter is considered untyped, which means that the value can be of any data type. - If you wish to make clear your intent to use an untyped value, you can use the asterisk (*) character as the type annotation. When used as a type annotation, the asterisk character is equivalent to leaving a variable, function return type, or function parameter untyped.

-

-

-Operands - - - - - - - - - - - - - -
variableName:* — - An identifier for a variable. -
type:* — - A native data type, class name that you have defined, or interface name. -
functionName:Function — - An identifier for a function. -
parameter:* — - An identifier for a function parameter. -
-
-Example -

-

-See also -

-
-function statement -
-var statement -
-
- - - - - -
typeofoperator 
-
-Usage - - - - -
typeof expression
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates expression and returns a string specifying the expression's data type. - The result is limited to six possible string values: boolean, function, number, object, string, and xml. - If you apply this operator to an instance of a user-defined class, the result is the string object. - The typeof operator is included for backward compatibility. Use the is operator to check type compatibility. -

-

-Operands - - - - -
expression:Object — - An object to evaluate. -
-

-Result - - - - -
String — A string representation of the type of expression. The following table shows the results of the typeof operator on each type of expression. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Expression TypeResult
- Array - - object -
- Boolean - - boolean -
- Function - - function -
- int - - number -
- Number - - number -
- Object - - object -
- String - - string -
- uint - - number -
- XML - - xml -
- XMLList - - xml -
- * - - undefined -

-
-Example -

-

-See also -

-
-as -
-instanceof -
-is -
-
- - - - - -
voidoperator 
-
-Usage - - - - -
void expression
-

- - - - -
Runtime version: 
-

-

Evaluates an expression and then discards its value, returning undefined. The void operator is often used in comparisons that use the == operator to test for undefined values.

-

-Operands - - - - -
expression:Object — - An expression to be evaluated. -
-

-Result - - - - -
* — The value undefined.
-
- - - - - -
< > XML literal tag delimiteroperator 
-
-Usage - - - - -
 myXML= <{tagName} {attributeName} = {attributeValue}>{content}</{tagName}>
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Defines an XML tag in an XML literal. Use the forward slash / to define the closing tag.

-

-Operands - - - - - - - - - - - - - - - - -
myXML:* — - An XML or XMLList object. -
tagName:* — - An expression that evaluates to the name of an XML tag. -
attributeName:* — - An expression that evaluates to the name of an XML attribute. -
attributeValue:* — - An expression that evaluates to the value of an XML attribute. -
content:* — - An expression that evaluates to the contents of an XML tag. -
-
-Example -

-

-See also -

-
-XML class -
-XMLList class -
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Jul 3 2024, 9:16 AM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/package-detail.html b/html-docs/package-detail.html deleted file mode 100644 index 032c85e..0000000 --- a/html-docs/package-detail.html +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - -Top Level Constants and Functions Summary (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
- -
Global Functions
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 FunctionDescription
 Array - - Creates a new array.
 Boolean - - Converts the expression parameter to a Boolean value and returns the value.
 decodeURI - - Decodes an encoded URI into a string.
 decodeURIComponent - - Decodes an encoded URI component into a string.
 encodeURI - - Encodes a string into a valid URI (Uniform Resource Identifier).
 encodeURIComponent - - Encodes a string into a valid URI component.
 escape - - Converts the parameter to a string and encodes it in a URL-encoded format, - - where most nonalphanumeric characters are replaced with % hexadecimal sequences.
 int - - Converts a given numeric value to an integer value.
 isFinite - - Returns true if the value is a finite number, - - or false if the value is Infinity or -Infinity.
 isNaN - - Returns true if the value is NaN(not a number).
 isXMLName - - Determines whether the specified string is a valid name for an XML element or attribute.
 Number - - Converts a given value to a Number value.
 Object - - Every value in ActionScript 3.0 is an object, which means that calling Object() on a value returns that value.
 parseFloat - - Converts a string to a floating-point number.
 parseInt - - Converts a string to an integer.
 String - - Returns a string representation of the specified parameter.
 trace - - Displays expressions, or writes to log files, while debugging.
 uint - - Converts a given numeric value to an unsigned integer value.
 unescape - - Evaluates the parameter str as a string, decodes the string from URL-encoded format - - (converting all hexadecimal sequences to ASCII characters), and returns the string.
 Vector - Creates a new Vector instance whose elements are instances of the specified data type.
 XML - - Converts an object to an XML object.
 XMLList - - Converts an object to an XMLList object.
- -
Global Constants
- - - - - - - - - - - - - - - - -
 ConstantDescription
 Infinity - - A special value representing positive Infinity.
 -Infinity - - A special value representing negative Infinity.
 NaN - - A special member of the Number data type that represents a value that is "not a number" (NaN).
 undefined - - A special value that applies to untyped variables that have not been initialized or dynamic object properties that are not initialized.
- -
Classes
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassDescription
 ArgumentError - - The ArgumentError class represents an error that occurs when the arguments - - supplied in a function do not match the arguments defined for - - that function.
 arguments - - An arguments object is used to store and access a function's arguments.
 Array - - The Array class lets you access and manipulate arrays.
 Boolean - -A Boolean object is a data type that can have one of two values, either true or false, - -used for logical operations.
 Class - - A Class object is created for each class definition in a program.
 Date - - The Date class represents date and time information.
 DefinitionError - - The DefinitionError class represents an error that occurs when user code - - attempts to define an identifier that is already defined.
 Error - - The Error class contains information about an error that occurred in a script.
 EvalError - - The EvalError class represents an error that occurs when user code - - calls the eval() function or attempts to use the new - - operator with the Function object.
 float - - A data type representing an IEEE-754 single-precision floating-point number.
 Function - - A function is the basic unit of code that can be invoked in ActionScript.
 int - - The int class lets you work with the data type representing a 32-bit signed integer.
 JSON - - The JSON class lets applications import and export data using JavaScript Object Notation (JSON) format.
 Math - - The Math class contains methods and constants that represent common mathematical - - functions and values.
 Namespace - - -The Namespace class contains methods and properties for defining and working with namespaces.
 Number - - A data type representing an IEEE-754 double-precision floating-point number.
 Object - - The Object class is at the root of the ActionScript - - runtime class hierarchy.
 QName - - -QName objects represent qualified names of XML elements and attributes.
 RangeError - - A RangeError exception is thrown when a numeric value is outside the acceptable range.
 ReferenceError - - A ReferenceError exception is thrown when a reference to an undefined property is - - attempted on a sealed (nondynamic) object.
 RegExp - - - The RegExp class lets you work with regular expressions, which are patterns that you can use - - to perform searches in strings and to replace text in strings.
 SecurityError - - The SecurityError exception is thrown when some type of security violation - - takes place.
 String - - The String class is a data type that represents a string of characters.
 SyntaxError - - A SyntaxError exception is thrown when a parsing error occurs, for one of the following reasons:.
 TimeZone - - The TimeZone class provides information about timezones that can be used in date calculations - - and to find out about different locations and their time zone offsets.
 TypeError - - A TypeError exception is thrown when the actual type of an operand is different - - from the expected type.
 uint - - The uint class provides methods for working with a data type representing a 32-bit unsigned integer.
 URIError - - A URIError exception is thrown when one of the global URI handling functions is used - - in a way that is incompatible with its definition.
 Vector - The Vector class lets you access and manipulate a vector — an array whose elements - all have the same data type.
 VerifyError - - The VerifyError class represents an error that occurs when a malformed - - or corrupted SWF file is encountered.
 XML - - The XML class contains methods and properties for working with XML objects.
 XMLList - - The XMLList class contains methods for working with one or more XML elements.
-

-
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
-
-
- - - diff --git a/html-docs/package-summary.html b/html-docs/package-summary.html deleted file mode 100644 index 126f210..0000000 --- a/html-docs/package-summary.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - -All Packages (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
-

The Flash Player API classes are in the flash.* packages. - The Flash Player API refers to all packages, classes, functions, properties, constants, events, - and errors that are in the flash package. They are unique to Flash Player, as opposed to the - top-level classes, such as Date, Math, and XML, or the language elements, which are based on - ECMAScript. The Flash Player API contains features that you expect to find in object-oriented - programming languages, such as the flash.geom package for geometry classes, as well as features - specific to the needs of rich Internet applications, such as the flash.filters package for - expressiveness and the flash.net package for handling data transmission to and from a server. -

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 PackageDescription
 Top Level 
 air.netThe air.net package contains classes for network detection. This package is only available to content running in the AIR runtime. It is included in the ServiceMonitor.swc file (for SWF-based application developers) and ServiceMonitor.swf file (for HTML-based AIR application developers).
 air.security 
 air.system 
 air.updateThe air.update package contains classes for updating AIR applications.
 air.update.eventsThe air.update.events package contains classes that define events used by the AIR application update framework.
 air.utils 
 avm2.intrinsics.iterationThe amv2.intrinsics.iteration package includes the low-level/intrinsic iteration APIs that are part of the ASC2 compiler.
 avm2.intrinsics.memoryThe amv2.intrinsics.memory package includes the low-level/intrinsic memory access APIs that are part of the ASC2 compiler.
 flash.accessibilityThe flash.accessibility package contains classes for supporting accessibility in Flash content and applications.
 flash.concurrent 
 flash.crypto 
 flash.dataThe flash.data package contains classes used for working with Adobe AIR local SQL databases.
 flash.desktopThe flash.desktop package contains classes used for copy-and-paste and drag-and-drop operations, as well as the Icon class, used to define system icons used by a file.
 flash.displayThe flash.display package contains the core classes that the Flash Player uses to build visual displays.
 flash.display3DThe flash.display3D package contains the classes that the Flash Player uses to render geometrically defined graphics.
 flash.display3D.texturesThe flash.display3D.textures package contains classes for textures.
 flash.errorsThe flash.errors package contains a set of commonly used error classes.
 flash.eventsThe flash.events package supports the new DOM event model and includes the EventDispatcher base class.
 flash.externalThe flash.external package contains the ExternalInterface class which can be used to communicate with the Flash Player's container.
 flash.filesystemThe flash.filesystem package contains classes used in accessing the filesystem. This package is only available to content running in the AIR runtime.
 flash.filtersThe flash.filters package contains classes for bitmap filter effects.
 flash.geomThe flash.geom package contains geometry classes, such as points, rectangles and transformation matrixes, to support the BitmapData class and the bitmap caching feature.
 flash.globalization 
 flash.htmlThe flash.html package contains classes used for including HTML content in an AIR application. This package is only available to content running in the AIR runtime.
 flash.mediaThe flash.media package contains classes for working with multimedia assets such as sound and video.
 flash.netThe flash.net package contains classes for sending and receiving from the network, such as URL downloading and Flash Remoting.
 flash.net.dns 
 flash.net.drm 
 flash.notifications 
 flash.permissions 
 flash.printingThe flash.printing package contains classes for printing Flash-based content.
 flash.profilerThe flash.profiler package contains functions used for debugging and profiling ActionScript code.
 flash.securityThe flash.security package includes classes for validating XML signatures. This package is only available to content running in the AIR runtime.
 flash.sensors 
 flash.systemThe flash.system package contains classes for accessing system-level functionality, such as security, multilanguage content, etc.
 flash.textThe flash.text package contains classes for working with text fields, text formatting, text metrics, style sheets, and layout.
 flash.text.engineThe FTE provides low-level support for sophisticated control of text metrics, formatting, and bi-directional text. While it can be used to create and manage simple text elements, the FTE is primarily designed as a foundation for developers to create text-handling components.
 flash.text.ime 
 flash.uiThe flash.ui package contains user interface classes, such as classes for interacting with the mouse and keyboard.
 flash.utilsThe flash.utils package contains utility classes, such as data structures like ByteArray.
 flash.xmlThe flash.xml package contains Flash Player's legacy XML support, and other Flash Player-specific XML functionality.
-

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:00 AM GMT+01:00
Creative Commons License
-
- - diff --git a/html-docs/package.html b/html-docs/package.html deleted file mode 100644 index 4e346fd..0000000 --- a/html-docs/package.html +++ /dev/null @@ -1,2774 +0,0 @@ - - - - - - - -Top Level Constants and Functions Details (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-
-
Global Functions
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 FunctionDefined by
   -
-Array(... args):Array -
-
- - Creates a new array.
-		Top Level
   -
-Boolean(expression:Object):Boolean -
-
- - Converts the expression parameter to a Boolean value and returns the value.
-		Top Level
   -
-decodeURI(uri:String):String -
-
- - Decodes an encoded URI into a string.
-		Top Level
   -
-decodeURIComponent(uri:String):String -
-
- - Decodes an encoded URI component into a string.
-		Top Level
   -
-encodeURI(uri:String):String -
-
- - Encodes a string into a valid URI (Uniform Resource Identifier).
-		Top Level
   -
-encodeURIComponent(uri:String):String -
-
- - Encodes a string into a valid URI component.
-		Top Level
   -
-escape(str:String):String -
-
- - Converts the parameter to a string and encodes it in a URL-encoded format, - - where most nonalphanumeric characters are replaced with % hexadecimal sequences.
-		Top Level
   -
-int(value:Number):int -
-
- - Converts a given numeric value to an integer value.
-		Top Level
   -
-isFinite(num:Number):Boolean -
-
- - Returns true if the value is a finite number, - - or false if the value is Infinity or -Infinity.
-		Top Level
   -
-isNaN(num:Number):Boolean -
-
- - Returns true if the value is NaN(not a number).
-		Top Level
   -
-isXMLName(str:String):Boolean -
-
- - Determines whether the specified string is a valid name for an XML element or attribute.
-		Top Level
   -
-Number(expression:Object):Number -
-
- - Converts a given value to a Number value.
-		Top Level
   -
-Object(value:Object):Object -
-
- - Every value in ActionScript 3.0 is an object, which means that calling Object() on a value returns that value.
-		Top Level
   -
-parseFloat(str:String):Number -
-
- - Converts a string to a floating-point number.
-		Top Level
   -
-parseInt(str:String, radix:uint = 0):Number -
-
- - Converts a string to an integer.
-		Top Level
   -
-String(expression:Object):String -
-
- - Returns a string representation of the specified parameter.
-		Top Level
   -
-trace(... arguments):void -
-
- - Displays expressions, or writes to log files, while debugging.
-		Top Level
   -
-uint(value:Number):uint -
-
- - Converts a given numeric value to an unsigned integer value.
-		Top Level
   -
-unescape(str:String):String -
-
- - Evaluates the parameter str as a string, decodes the string from URL-encoded format - - (converting all hexadecimal sequences to ASCII characters), and returns the string.
-		Top Level
   -
-Vector(sourceArray:Object):Vector.<T>
-
- Creates a new Vector instance whose elements are instances of the specified data type.
-		Top Level
   -
-XML(expression:Object):XML -
-
- - Converts an object to an XML object.
-		Top Level
   -
-XMLList(expression:Object):XMLList -
-
- - Converts an object to an XMLList object.
-		Top Level
-
-
-
-
-
Global Constants
- - - - - - - - - - - - - - - - -
 ConstantDefined by
  Infinity : Number -
- - A special value representing positive Infinity.
-		Top Level
  -Infinity : Number -
- - A special value representing negative Infinity.
-		Top Level
  NaN : Number -
- - A special member of the Number data type that represents a value that is "not a number" (NaN).
-		Top Level
  undefined : * -
- - A special value that applies to untyped variables that have not been initialized or dynamic object properties that are not initialized.
-		Top Level
-
- -
Function detail
- - - - - -
Array()function
-
-public function Array(... args):Array -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Creates a new array. The array can be of length zero or more, or an array populated by a single - - specified object. - -

    - -
  • Calling Array() with no arguments returns an empty array.
    • - -
  • Calling Array() with a single integer argument returns an array of the specified length, but whose elements have undefined values.
    • - -
  • Calling Array() with a specified object returns an array with one element of the specified object.
    • - -
- - Using the Array() function is similar to creating an array with the Array class constructor, but the Array() function only - - allows one, or no, parameter value. You cannot use the the Array() function to populate the new array with several values. - -

Note: If you try to use the Array() function to create a new array, and pass several values as parameters to populate - - the array, you'll get a compiler error. The the Array() function only allows one parameter. Use the Array class constructor, instead, to create and - - populate an array of several values.

- -

The Array() function does not cast the type of an object to an array. Use the as operator for explicit type conversion, or type casting, - - when the argument is not a primitive value. For more information, see the Example - - section of this entry. If you pass an object as a parameter to the Array() function, a new array is created containing the object as an element.

- - Parameters - - - - -
... args — You can pass no arguments for an empty array, a single integer argument for an array of a specific length, or a single object to create an array - - containing the one specified object. - -
-

-Returns - - - - -
Array — - An array of length zero or more. - - - -
-

-See also -

-
-Array class -
-as operator -
-
-Example -
The following example demonstrates the behavior of the Array() - function when an argument is not a primitive value. A common use case of casting to an array - is the conversion of an Object instance that stores its values in array format. - If Array() is called with an argument of type Object, - or any other non-primitive data type, a reference to the object is stored in an element - of the new array. In other words, if the only argument passed is an object, - a reference to that object becomes the first element of the new array. -
-
-var obj:Object = [ "a", "b", "c" ];
-      
-var newArray:Array = Array( obj );
-
-trace(newArray == obj);    // false
-trace(newArray[0] == obj); // true
-trace(newArray[0][0])      // a
-trace(newArray[0][1])      // b
-trace(newArray[0][2])      // c
-
-

To cast obj to an array, use the as operator, which returns an array reference - if obj is a valid array and null otherwise: -
-
-var obj:Object = [ "a", "b", "c" ];
-      
-var newArray:Array = obj as Array;
-
-trace(newArray == obj); // true
-trace(newArray[0]);     // a
-trace(newArray[1]);     // b
-trace(newArray[2]);     // c
-
-

-
- - - - - -
Boolean()function 
-
-public function Boolean(expression:Object):Boolean -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Converts the expression parameter to a Boolean value and returns the value. - -

The return value depends on the data type and value of the argument, as described in the following table:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input ValueExampleReturn Value
0Boolean(0)false
NaNBoolean(NaN)false
Number (not 0 or NaN)Boolean(4)true
Empty stringBoolean("")false
Non-empty stringBoolean("6")true
nullBoolean(null)false
undefinedBoolean(undefined)false
Instance of Object classBoolean(new Object())true
No argumentBoolean()false
- -

Unlike previous versions of ActionScript, the Boolean() function returns the same results as does the Boolean class constructor.

- - Parameters - - - - -
expression:Object — An expression or object to convert to Boolean. - -
-

-Returns - - - - -
Boolean — - The result of the conversion to Boolean. - - - -
-
- - - - - -
decodeURI()function 
-
-public function decodeURI(uri:String):String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Decodes an encoded URI into a string. Returns a string in which all characters previously encoded - - by the encodeURI function are restored to their unencoded representation. - -

The following table shows the set of escape sequences that are not decoded to characters by the decodeURI function. Use decodeURIComponent() to decode the escape sequences in this table.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Escape sequences not decodedCharacter equivalents
%23#
%24$
%26&
%2B+
%2C,
%2F/
%3A:
%3B;
%3D=
%3F?
%40@
- - - - Parameters - - - - -
uri:String — A string encoded with the encodeURI function. - -
-

-Returns - - - - -
String — - A string in which all characters previously escaped by the encodeURI function are - - restored to their unescaped representation. - - - -
-

-See also -

-
-decodeURIComponent() -
-encodeURI() -
-encodeURIComponent() -
-
-Example -
-
-
package {
-    import flash.display.Sprite;
-
-	public class DecodeURIExample extends Sprite {
-		public function DecodeURIExample() {
-			var uri:String = "http://www.example.com/application.jsp?user=<user name='some user'></user>";
-			var encoded:String = encodeURI(uri);
-			var decoded:String = decodeURI(encoded);
-			trace(uri);		// http://www.example.com/application.jsp?user=<user name='some user'></user>
-			trace(encoded);	// http://www.example.com/application.jsp?user=%3Cuser%20name='some%20user'%3E%3C/user%3E
-			trace(decoded);	// http://www.example.com/application.jsp?user=<user name='some user'></user>
-		}
-	}
-}
-
-

-
- - - - - -
decodeURIComponent()function 
-
-public function decodeURIComponent(uri:String):String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Decodes an encoded URI component into a string. Returns a string in which - - all characters previously escaped by the encodeURIComponent - - function are restored to their uncoded representation. - -

This function differs from the decodeURI() function in that it is intended for use only with a part of a URI string, called a URI component. - - A URI component is any text that appears between special characters called component separators - - (: / ; and ? ). - - Common examples of a URI component are "http" and "www.adobe.com".

- -

Another important difference between this function and decodeURI() is that because this function - - assumes that it is processing a URI component it treats the escape sequences that represent special separator characters (; / ? : @ & = + $ , #) as regular - - text that should be decoded.

- - Parameters - - - - -
uri:String — A string encoded with the encodeURIComponent function. - -
-

-Returns - - - - -
String — - A string in which all characters previously escaped by the encodeURIComponent function are - - restored to their unescaped representation. - - - -
-

-See also -

-
-decodeURI() -
-encodeURI() -
-encodeURIComponent() -
-
- - - - - -
encodeURI()function 
-
-public function encodeURI(uri:String):String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Encodes a string into a valid URI (Uniform Resource Identifier). - - Converts a complete URI into a string in which all characters are encoded - - as UTF-8 escape sequences unless a character belongs to a small group of basic characters. - -

The following table shows the entire set of basic characters that are not converted to UTF-8 escape sequences by the encodeURI function.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Characters not encoded
0 1 2 3 4 5 6 7 8 9
a b c d e f g h i j k l m n o p q r s t u v w x y z
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
; / ? : @ & = + $ , #
- _ . ! ~ * ' ( )
- - Parameters - - - - -
uri:String — A string representing a complete URI. - -
-

-Returns - - - - -
String — - A string with certain characters encoded as UTF-8 escape sequences. - - - -
-

-See also -

-
-decodeURI() -
-decodeURIComponent() -
-encodeURIComponent() -
-
-Example -
-
-
package {
-    import flash.display.Sprite;
-
-	public class EncodeURIExample extends Sprite {
-		public function EncodeURIExample() {
-			var uri:String = "http://www.example.com/application.jsp?user=<user name='some user'></user>";
-			var encoded:String = encodeURI(uri);
-			var decoded:String = decodeURI(encoded);
-			trace(uri);		// http://www.example.com/application.jsp?user=<user name='some user'></user>
-			trace(encoded);	// http://www.example.com/application.jsp?user=%3Cuser%20name='some%20user'%3E%3C/user%3E
-			trace(decoded);	// http://www.example.com/application.jsp?user=<user name='some user'></user>
-		}
-	}
-}
-
-

-
- - - - - -
encodeURIComponent()function 
-
-public function encodeURIComponent(uri:String):String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Encodes a string into a valid URI component. Converts a substring of a URI into a - - string in which all characters are encoded as UTF-8 escape sequences unless a character - - belongs to a very small group of basic characters. - -

The encodeURIComponent() function differs from the encodeURI() function in that it is intended for use only with a part of a URI string, called a URI component. - - A URI component is any text that appears between special characters called component separators - - (: / ; and ? ). - - Common examples of a URI component are "http" and "www.adobe.com".

- -

Another important difference between this function and encodeURI() is that because this function - - assumes that it is processing a URI component it treats the special separator characters (; / ? : @ & = + $ , #) as regular - - text that should be encoded.

- -

The following table shows all characters that are not converted to UTF-8 escape sequences by the encodeURIComponent function.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Characters not encoded
0 1 2 3 4 5 6 7 8 9
a b c d e f g h i j k l m n o p q r s t u v w x y z
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
- _ . ! ~ * ' ( )
- - Parameters - - - - -
uri:String
-

-Returns - - - - -
String
-

-See also -

-
-decodeURI() -
-decodeURIComponent() -
-encodeURI() -
-
- - - - - -
escape()function 
-
-public function escape(str:String):String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Converts the parameter to a string and encodes it in a URL-encoded format, - - where most nonalphanumeric characters are replaced with % hexadecimal sequences. - - When used in a URL-encoded string, the percentage symbol (%) is used to introduce - - escape characters, and is not equivalent to the modulo operator (%). - -

The following table shows all characters that are not converted to escape sequences by the escape() function.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Characters not encoded
0 1 2 3 4 5 6 7 8 9
a b c d e f g h i j k l m n o p q r s t u v w x y z
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
@ - _ . * + /
- -

Note: Use the encodeURIComponent() function, instead of the escape() function, to treat - - special separator characters (@ + /) as regular - - text to encode.

- - Parameters - - - - -
str:String — The expression to convert into a string and encode in a URL-encoded format. - -
-

-Returns - - - - -
String — - A URL-encoded string. - - - -
-

-See also -

-
-unescape() -
-encodeURIComponent() -
-
- - - - - -
int()function 
-
-public function int(value:Number):int -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Converts a given numeric value to an integer value. Decimal values are truncated at the decimal point. - -

Parameters - - - - -
value:Number — A value to be converted to an integer. - -
-

-Returns - - - - -
int — - The converted integer value. - - - -
-

-See also -

-
-uint() -
-
- - - - - -
isFinite()function 
-
-public function isFinite(num:Number):Boolean -

- - - - -
Language version: ActionScript 3.0. - - -
- - - - -
Runtime version: 
-

- - Returns true if the value is a finite number, - - or false if the value is Infinity or -Infinity. - - The presence of Infinity or -Infinity indicates a mathematical - - error condition such as division by 0. - -

Parameters - - - - -
num:Number — A number to evaluate as finite or infinite. - -
-

-Returns - - - - -
Boolean — - Returns true if it is a finite number - - or false if it is infinity or negative infinity - - - -
-
- - - - - -
isNaN()function 
-
-public function isNaN(num:Number):Boolean -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Returns true if the value is NaN(not a number). The isNaN() function is useful for checking whether a mathematical expression evaluates successfully to a number. - - The most common use of isNaN() is to check the value returned from the parseInt()and parseFloat() functions. The NaN value is a special member of the Number data type that represents a value that is "not a number." - -

Note: The NaN value is not a member of the int or uint data types.

- -

The following table describes the return value of isNaN() on various input types and - - values. (If your compiler warnings are set to Strict Mode, some of the following operations will generate - - compiler warnings.)

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input Type/ValueExampleReturn Value
0 divided by 0isNaN(0/0)true
Non-zero number divided by 0isNaN(5/0)false
Square root of a negative numberisNaN(Math.sqrt(-1))true
Arcsine of number greater than 1 or less than 0isNaN(Math.asin(2))true
String that can be converted to NumberisNaN("5")false
String that cannot be converted to NumberisNaN("5a")true
- - Parameters - - - - -
num:Number — A numeric value or mathematical expression to evaluate. - -
-

-Returns - - - - -
Boolean — - Returns true if the value is NaN(not a number) and false otherwise. - - - -
-
- - - - - -
isXMLName()function 
-
-public function isXMLName(str:String):Boolean -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Determines whether the specified string is a valid name for an XML element or attribute. - -

Parameters - - - - -
str:String — A string to evaluate. - -
-

-Returns - - - - -
Boolean — - Returns true if the str argument is a valid XML name; false otherwise. - - - -
-
- - - - - -
Number()function 
-
-public function Number(expression:Object):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Converts a given value to a Number value. The following table shows the result of various input types: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input Type/ValueExampleReturn Value
undefinedNumber(undefined)NaN
nullNumber(null)0
trueNumber(true)1
falseNumber(false)0
NaNNumber(NaN)NaN
Empty stringNumber("")0
String that converts to NumberNumber("5")The number (e.g. 5)
String that does not convert to NumberNumber("5a")NaN
- -

Parameters - - - - -
expression:Object — A value to be converted to a number. - -
-

-Returns - - - - -
Number — - The converted number value - - - -
-
- - - - - -
Object()function 
-
-public function Object(value:Object):Object -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Every value in ActionScript 3.0 is an object, which means that calling Object() on a value returns that value. - -

Parameters - - - - -
value:Object — An object or a number, string, or Boolean value to convert. - -
-

-Returns - - - - -
Object — - The value specified by the value parameter. - - - -
-
- - - - - -
parseFloat()function 
-
-public function parseFloat(str:String):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Converts a string to a floating-point number. The function reads, or parses, and returns the numbers in a string until it reaches a character that is not a part of the initial number. If the string does not begin with a number that can be parsed, parseFloat() returns NaN. White space preceding valid integers is ignored, as are trailing nonnumeric characters. - -

Parameters - - - - -
str:String — The string to read and convert to a floating-point number. - -
-

-Returns - - - - -
Number — - A number or NaN (not a number). - - - -
-
- - - - - -
parseInt()function 
-
-public function parseInt(str:String, radix:uint = 0):Number -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Converts a string to an integer. If the specified string in the parameters cannot be converted to a number, the function returns NaN. Strings beginning with 0x are interpreted as hexadecimal numbers. Unlike in previous versions of ActionScript, integers beginning with 0 are not interpreted as octal numbers. You must specify a radix of 8 for octal numbers. White space and zeroes preceding valid integers are ignored, as are trailing nonnumeric characters. - -

Parameters - - - - - - - - - - -
str:String — A string to convert to an integer. - -
 
radix:uint (default = 0) — An integer representing the radix (base) of the number to parse. Legal values are from 2 to 36. - -
-

-Returns - - - - -
Number — - A number or NaN (not a number). - - - -
-
- - - - - -
String()function 
-
-public function String(expression:Object):String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Returns a string representation of the specified parameter. - -

The following table shows the result of various input types:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input Type/ValueReturn Value
undefinedundefined
null"null"
true"true"
false"false"
NaN"NaN"
StringString
ObjectObject.toString()
NumberString representation of the number
- - Parameters - - - - -
expression:Object — An expression to convert to a string. - -
-

-Returns - - - - -
String — - A string representation of the value passed for the expression parameter. - - - -
-
- - - - - -
trace()function 
-
-public function trace(... arguments):void -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - Displays expressions, or writes to log files, while debugging. A single trace statement can support multiple arguments. If any argument - - in a trace statement includes a data type other than a String, the trace function invokes the associated toString() method - - for that data type. For example, if the argument is a Boolean value the trace function invokes Boolean.toString() and - - displays the return value. - -

Parameters - - - - -
... arguments — One or more (comma separated) expressions to evaluate. For multiple expressions, a space is inserted between each expression in the output. - -
-
-Example -
The following example uses the class TraceExample to - show how the trace() method can be used to print a simple string. Generally, - the message will be printed to a "Debug" console. -
-
-package {
-    import flash.display.Sprite;
-
-	public class TraceExample extends Sprite {
-
-		public function TraceExample() {
-			trace("Hello World");
-		}
-	}
-}
-
-

-
- - - - - -
uint()function 
-
-public function uint(value:Number):uint -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Converts a given numeric value to an unsigned integer value. Decimal values are truncated at the decimal point. - -

The following table describes the return value of uint() on various input types and values.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Input Type/ValueExampleReturn Value
undefineduint(undefined)0
nulluint(null)0
0uint(0)0
NaNuint(NaN)0
Positive floating-point numberuint(5.31)Truncated unsigned integer (e.g. 5)
Negative floating-point numberuint(-5.78)Truncates to integer then applies rule for negative integers
Negative integeruint(-5)Sum of uint.MAX_VALUE and the negative integer (for example, uint.MAX_VALUE + (-5))
trueuint(true)1
falseuint(false)0
Empty Stringuint("")0
String that converts to Numberuint("5")The number
String that does not convert to Numberuint("5a")0
- - - - Parameters - - - - -
value:Number — A value to be converted to an integer. - -
-

-Returns - - - - -
uint — - The converted integer value. - - - -
-

-See also -

-
-int() -
-
- - - - - -
unescape()function 
-
-public function unescape(str:String):String -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Evaluates the parameter str as a string, decodes the string from URL-encoded format - - (converting all hexadecimal sequences to ASCII characters), and returns the string. - -

Parameters - - - - -
str:String — A string with hexadecimal sequences to escape. - -
-

-Returns - - - - -
String — - A string decoded from a URL-encoded parameter. - - - -
-
- - - - - -
Vector()function 
-
-public function Vector(sourceArray:Object):Vector.<T> -

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: AIR 1.5 -
-

- Creates a new Vector instance whose elements are instances of the specified data type. - When calling this function, you specify the data type of the result Vector's elements - (the Vector's base type) using a type parameter. This function - uses the same syntax that's used when declaring a Vector instance or calling the - new Vector.<T>() constructor: - 

var v:Vector.<String> = Vector.<String>(["Hello", "World"]);
-

The resulting Vector is populated - with the values in the elements of the sourceArray argument. - If the sourceArray argument is already a Vector.<T> - instance where T is the base type, the function returns - that Vector. Otherwise, the result Vector - is populated with the elements of the sourceArray Array or Vector.

-

In either case, the data type of all the elements of the sourceArray - argument must match the base type T specified in the function call.

-

If the sourceArray argument has length 0, the function - returns an empty Vector.

-

If a Vector is passed as the sourceArray argument and its base type - is not T, or if an Array is passed and its elements are not all instances of - data type T, an attempt is made to convert the values to the base type. If - the values can be automatically converted, the result Vector contains the converted values. - If no conversion can be made, an error occurs.

-

Likewise, if an element in the sourceArray argument is an instance of - a subclass of the base type T, the call succeeds and the element is - added to the resulting Vector. This works even if the - sourceArray argument is a Vector whose base type is a subclass - of T. In fact, this is the only way to convert a Vector with base type - T to a Vector with a base type that's a superclass of T.

-

For example, the following code results in a compile error in strict mode, or a - TypeError at run time, because it attempts to assign a Vector.<Sprite> to a - Vector.<DisplayObject> variable (Sprite is a subclass of DisplayObject):

- 
-	 var v1:Vector.<Sprite> = new Vector.<Sprite>();
-	 v1[0] = new Sprite();
-	 var v2:Vector.<DisplayObject> = v1;
-
-

The following alternative version of the code successfully copies the elements of a - Vector.<Sprite> instance to a Vector.<DisplayObject> instance:

- 
-	 var v1:Vector.<Sprite> = new Vector.<Sprite>();
-	 v1[0] = new Sprite();
-	 var v2:Vector.<DisplayObject> = Vector.<DisplayObject>(v1);
-
- Parameters - - - - -
sourceArray:Object — An Array or Vector instance whose elements become the elements of the result - Vector. If the argument is a Vector instance whose associated data type is the same as the - specified data type, the argument is returned as the function result. -
-

-Returns - - - - -
Vector.<T> — A Vector instance populated with the elements of the sourceArray array. -
-
-Throws - - - - -
TypeError — If the sourceArray argument contains an element that can't be - converted to the specified data type. -
-

-See also -

-
-Vector class -
-
- - - - - -
XML()function 
-
-public function XML(expression:Object):XML -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Converts an object to an XML object. - -

The following table describes return values for various input types.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter TypeReturn Value
BooleanValue is first converted to a string, then converted to an XML object.
NullA runtime error occurs (TypeError exception).
NumberValue is first converted to a string, then converted to an XML object.
ObjectConverts to XML only if the value is a String, Number or Boolean value. Otherwise a runtime error occurs (TypeError exception).
StringValue is converted to XML.
UndefinedA runtime error occurs (TypeError exception).
XMLInput value is returned unchanged.
XMLListReturns an XML object only if the XMLList object contains only one property of type XML. Otherwise a runtime error occurs (TypeError exception).
- - Parameters - - - - -
expression:Object — Object to be converted to XML. - -
-

-Returns - - - - -
XML — - An XML object containing values held in the converted object. - - - -
-

-See also -

-
-XMLList() -
-
- - - - - -
XMLList()function 
-
-public function XMLList(expression:Object):XMLList -

- - - - -
Language version: ActionScript 3.0 - - -
- - - - -
Runtime version: 
-

- - Converts an object to an XMLList object. - -

The following table describes return values for various input types.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter TypeReturn Value
BooleanValue is first converted to a string, then converted to an XMLList object.
NullA runtime error occurs (TypeError exception).
NumberValue is first converted to a string, then converted to an XMLList object.
ObjectConverts to XMLList only if the value is a String, Number or Boolean value. Otherwise a runtime error occurs (TypeError exception).
StringValue is converted to an XMLList object.
UndefinedA runtime error occurs (TypeError exception).
XMLValue is converted to an XMLList object.
XMLListInput value is returned unchanged.
- - Parameters - - - - -
expression:Object — Object to be converted into an XMLList object. - -
-

-Returns - - - - -
XMLList — - An XMLList object containing values held in the converted object. - - - -
-

-See also -

-
-XML() -
-
- -
Constant detail
- - - - - -
Infinityconstant
-
-public const Infinity:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - A special value representing positive Infinity. The value of this constant is the same as Number.POSITIVE_INFINITY. - -

-See also -

-
-Number.POSITIVE_INFINITY -
-
-Example -
The result of division by 0 is Infinity, but only - when the divisor is a positive number. -
-
-
-trace(0 / 0);  // NaN
-trace(7 / 0);  // Infinity
-trace(-7 / 0); // -Infinity
-
-

-
- - - - - -
-Infinityconstant 
-
-public const -Infinity:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - A special value representing negative Infinity. The value of this constant is the same as Number.NEGATIVE_INFINITY. - -

-See also -

-
-Number.NEGATIVE_INFINITY -
-
-Example -
The result of division by 0 is -Infinity, but only - when the divisor is a negative number. -
-
-
-trace(0 / 0);  // NaN
-trace(7 / 0);  // Infinity
-trace(-7 / 0); // -Infinity
-
-

-
- - - - - -
NaNconstant 
-
-public const NaN:Number -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - A special member of the Number data type that represents a value that is "not a number" (NaN). - - When a mathematical expression results in a value that cannot be expressed as a number, the - - result is NaN. The following list describes common expressions that result in NaN. - -

    - -
  • Division by 0 results in NaN only if the divisor is also 0. If the divisor is greater than 0, - - division by 0 results in Infinity. If the divisor is less than 0, division by 0 results in -Infinity;
    • - -
  • Square root of a negative number;
    • - -
  • The arcsine of a number outside the valid range of 0 to 1;
    • - -
  • Infinity subtracted from Infinity;
    • - -
  • Infinity or -Infinity divided by Infinity or -Infinity;
    • - -
  • Infinity or -Infinity multiplied by 0;
    • - -
- -

The NaN value is not a member of the int or uint data types.

- -

The NaN value is not considered equal to any other value, including NaN, which makes it impossible - - to use the equality operator to test whether an expression is NaN. To determine whether a number is - - the NaN function, use isNaN().

- -

-See also -

-
-isNaN() -
-Number.NaN -
-
- - - - - -
undefinedconstant 
-
-public const undefined:* -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0 - -
-

- - A special value that applies to untyped variables that have not been initialized or dynamic object properties that are not initialized. - - In ActionScript 3.0, only variables that are untyped can hold the value undefined, which is not true in ActionScript 1.0 and ActionScript 2.0. - - For example, both of the following variables are undefined because they are untyped and unitialized: - -

    - -
  • var foo;
    • - -
  • var bar:*;
    • - -
- -

The undefined value also applies to uninitialized or undefined properties of dynamic objects. For example, if an object is an instance - - of the Object class, the value of any dynamically added property is undefined until a value is assigned to that property.

- - -

Results vary when undefined is used with various functions:

- -
    - -
  • The value returned by String(undefined) is "undefined" (undefined is converted to a string).
    • - -
  • The value returned by Number(undefined) is NaN.
    • - -
  • The value returned by int(undefined) and uint(undefined) is 0.
    • - -
  • The value returned by Object(undefined) is a new Object instance.
    • - -
  • When the value undefined is assigned to a typed variable, the value is converted to the default value of the data type.
    • - -
- -

Do not confuse undefined with null. When null and undefined are compared with - - the equality (==) operator, they compare as equal. However, when null and undefined are compared - - with the strict equality (===) operator, they compare as not equal.

- - -

-See also -

-
-null -
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
-
- - diff --git a/html-docs/runtimeErrors.html b/html-docs/runtimeErrors.html deleted file mode 100644 index 6bdb8fe..0000000 --- a/html-docs/runtimeErrors.html +++ /dev/null @@ -1,2892 +0,0 @@ - - - - - -Run-Time Errors (ActionScript 3.0) - - - - - - - - - - - - - - - - - -
-
-

The following errors can occur at run time. Run-time type checking occurs in ActionScript 3.0 whether - you compile in strict mode or warning mode.

-

-See also -

-
-Compiler Errors -
-Compiler Warnings -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 CodeMessageDescription
 1000The system is out of memory. - - Flash Player needs more memory to compile your code than your system has available. - Close some of the applications or processes running on your system. -
 1001The method _ is not implemented. 
 1002Number.toPrecision has a range of 1 to 21. Number.toFixed and Number.toExponential have a range of 0 to 20. Specified value is not within expected range. - - You specified a value that is not within the expected range of the precision argument. Number.toPrecision has a range of 1 to 21. Number.toFixed and Number.toExponential have a range of 0 to 20. -
 1003The radix argument must be between 2 and 36; got _. - - You passed a value less than 2 or greater than 36 for the radix argument of a method or property. - Pass a value between 2 and 36 as a radix argument. -
 1004Method _ was invoked on an incompatible object. - - You tried to call a method that is not available to the specified object. This error occurs when - you have copied a prototype function from one object to another, and then invoked it, but the - target object is not the same type as the original object. Ensure that the target object and - original object are the same type. See the ECMAScript Language Specification, 3rd Edition, Chapter 15 for more details. -
 1005Array index is not a positive integer (_). - - You tried to access a member of an array using an index value that is not a positive integer. Pass only positive integers as index values for arrays. -
 1006_ is not a function. - - This error occurs when you attempt to call a function that does not exist. - Make sure you are calling the correct function, and that the API has - not changed from ActionScript 2.0. Also, make sure you are using the correct - object. For example, you will see this error when you use the following code - (because the last line mistakenly calls the variable big instead - of blg): - - 
var blg:String = "foo";
-var big:Sprite = new Sprite();
-var error:int = big.length();
-
 1007Instantiation attempted on a non-constructor. 
 1008_ is ambiguous; Found more than one matching binding. 
 1009Cannot access a property or method of a null object reference. - - An object that evaluates to null can have no properties. This error can occur in some unexpected - (though valid) situations. For example, consider the following code, which creates a Sprite - object. Because this Sprite object is never added to the display list (through the - addChild() method of a DisplayObjectContainer object), its stage - property is set to null. Thus, the example generates this error because Sprite object's stage property - cannot have any properties: - - 
import flash.display.Sprite;
-var sprite1:Sprite = new Sprite();
-var q:String = sprite1.stage.quality;
-
 1010A term is undefined and has no properties. - - This error can occur if you try to access a property of an object that does not exist. For example: - 
var obj:Object = new Object();
-obj.a = "foo";
-trace(obj.b.prop);
- -

You can also see this error because of a misspelling, for example in the following, where - mc represents a MovieClip object in the display list, and the stage - property is misspelled with a capital S (it should be stage):

- - 
trace(mc.Stage.quality);
- - -
 1011Method _ contained illegal opcode _ at offset _. - - See the note at the bottom of this table.* -
 1012The last instruction exceeded code size. - - See the note at the bottom of this table.* -
 1013Cannot call OP_findproperty when scopeDepth is 0. - - See the note at the bottom of this table.* -
 1014Class _ could not be found. 
 1015Method _ cannot set default xml namespace - - See the note at the bottom of this table.* -
 1016Descendants operator (..) not supported on type _. 
 1017Scope stack overflow occurred. - - See the note at the bottom of this table.* -
 1018Scope stack underflow occurred. - - See the note at the bottom of this table.* -
 1019Getscopeobject _ is out of bounds. - - See the note at the bottom of this table.* -
 1020Code cannot fall off the end of a method. - - See the note at the bottom of this table.* -
 1021At least one branch target was not on a valid instruction in the method. - - See the note at the bottom of this table.* -
 1022Type void may only be used as a function return type. - - See the note at the bottom of this table.* -
 1023Stack overflow occurred. - - See the note at the bottom of this table.* -
 1024Stack underflow occurred. - - See the note at the bottom of this table.* -
 1025An invalid register _ was accessed. - - See the note at the bottom of this table.* -
 1026Slot _ exceeds slotCount=_ of _. - - See the note at the bottom of this table.* -
 1027Method_info _ exceeds method_count=_. - - See the note at the bottom of this table.* -
 1028Disp_id _ exceeds max_disp_id=_ of _. - - See the note at the bottom of this table.* -
 1029Disp_id _ is undefined on _. - - See the note at the bottom of this table.* -
 1030Stack depth is unbalanced. _ != _. - - See the note at the bottom of this table.* -
 1031Scope depth is unbalanced. _ != _. - - See the note at the bottom of this table.* -
 1032Cpool index _ is out of range _. - - See the note at the bottom of this table.* -
 1033Cpool entry _ is wrong type. - - See the note at the bottom of this table.* -
 1034Type Coercion failed: cannot convert _ to _. 
 1035Illegal super expression found in method _. - - See the note at the bottom of this table.* -
 1037Cannot assign to a method _ on _. - - See the note at the bottom of this table.* -
 1038_ is already defined. - - You cannot declare a variable or function with the same identifier name more than once - within the same scope. - In ActionScript 3.0, different code blocks (such as those used in two for loops - in the same function definition) are considered to be in the same scope. - See the note at the bottom of this table.* -
 1039Cannot verify method until it is referenced. - - See the note at the bottom of this table.* -
 1040The right-hand side of instanceof must be a class or function. - - The expression on the right side of the instanceof operator must be a class or function. -
 1041The right-hand side of operator must be a class. - - The expression on the right side of the is operator must be a class. -
 1042Not an ABC file. major_version=_ minor_version=_. - -You are attempting to use an invalid file with the player: the tool that generates the SWF may be out of date or the SWF itself may be corrupt. -
 1043Invalid code_length=_. - - See the note at the bottom of this table.* -
 1044MethodInfo-_ unsupported flags=_. - - See the note at the bottom of this table.* -
 1045Unsupported traits kind=_. - - See the note at the bottom of this table.* -
 1046MethodInfo-_ referenced before definition. - - See the note at the bottom of this table.* -
 1047No entry point was found. - - See the note at the bottom of this table.* -
 1049Prototype objects must be vanilla Objects. - - See the note at the bottom of this table.* -
 1050Cannot convert _ to primitive. - - See the note at the bottom of this table.* -
 1051Illegal early binding access to _. - - See the note at the bottom of this table.* -
 1052Invalid URI passed to _ function. - - See the note at the bottom of this table.* -
 1053Illegal override of _ in _. - - See the note at the bottom of this table.* -
 1054Illegal range or target offsets in exception handler. - - See the note at the bottom of this table.* -
 1056Cannot create property _ on _. - - You are trying to assign a value to a nonexistent property on an instance of a non-dynamic - class. This is only possible for instances of dynamic classes
 1057_ can only contain methods. - - See the note at the bottom of this table.* -
 1058Illegal operand type: _ must be _. - - See the note at the bottom of this table.* -
 1059ClassInfo-_ is referenced before definition. - - See the note at the bottom of this table.* -
 1060ClassInfo _ exceeds class_count=_. - - See the note at the bottom of this table.* -
 1061The value _ cannot be converted to _ without losing precision. - - - This error appears if you attempt to assign a decimal number to a property that has data type - int. - -

This error also appears for out-of-range assignments, such as the following:

- - 
var m0:int = 2147483648; // int.MAX_VALUE == 2147483647
-

You can also see this error when using the bitwise left shift operator (<<). - For example, consider the following code:

- - 
var m0:uint = 0xFF;
-var m1:uint = m0<<24;
- -

The result of left shift operator (<<) is interpreted as a 32-bit two's complement number - with sign. In the example, the result is a negative value, which causes the error when assigned - to the uint typed property. A workaround is the following:

- - 
var m0:uint = 0xFF;
-var m1:uint = uint(m0<<24);
- -
 1063Argument count mismatch on _. Expected _, got _. 
 1064Cannot call method _ as constructor. - - Extracted methods are permanently bound to the object they are extracted from. - Therefore, they can not later be called as a constructor. For example, the following - creates function f() in Class A: - 
class A {
-       function f() {}
-    }
- In the following code, extracting the function causes no error. However, creating - a new instance of the function causes an error. - 
var a = new A()
-    var m = a.f // extract f, don't call it
-    m() // same as a.f()
-    new m() // causes this error
- -
 1065Variable _ is not defined. - - You are using an undefined lexical reference. For example, in the following statements, the - statement trace(x) generates an error because x is undefined. However, the - statement trace(y) doesn't generate an error because y is defined: - 
trace("hello world")
-    trace(x) // x is undefined
-    var y
-    trace(y) // No error, y is defined.
-
 1066The form function('function body') is not supported. - - Unlike JavaScript, Flash does not compile code on-the-fly using eval() and - function(). Thus, calling these as a constructor in ActionScript 3.0 generates this error. -
 1067Native method _ has illegal method body. - - See the note at the bottom of this table.* -
 1068_ and _ cannot be reconciled. - - See the note at the bottom of this table.* -
 1069Property _ not found on _ and there is no default value. - - You are referencing an undefined property on a non-dynamic class instance. For example, the following generates this error when it references property - x, which is not defined and cannot be created dynamically: - 
class A {} // sealed class, not dynamic
-    trace(new A().x) // no property x defined on A, and A is not dynamic
-
 1070Method _ not found on _ - - You are using a super statement to call a function, but the function doesn't exist in the super class. - For example, the following code generates the error: 
class A() {}
-class B extends A {
-  function f() { trace(super.f()); } // error 1070, there is no f on A
-}
-
 1071Function _ has already been bound to _. 
 1072Disp_id 0 is illegal. - - See the note at the bottom of this table.* -
 1073Non-override method _ replaced because of duplicate disp_id _. - - See the note at the bottom of this table.* -
 1074Illegal write to read-only property _ on _. 
 1075Math is not a function. - - You are trying to call math() as a function, but the Math class is a class with static methods. -
 1076Math is not a constructor. - - You can not instantiate the Math class. -
 1077Illegal read of write-only property _ on _. 
 1078Illegal opcode/multiname combination: _<_>. - - See the note at the bottom of this table.* -
 1079Native methods are not allowed in loaded code. - - See the note at the bottom of this table.* -
 1080Illegal value for namespace. - - See the note at the bottom of this table.* -
 1081Property _ not found on _ and there is no default value. 
 1082No default namespace has been set. - - See the note at the bottom of this table.* -
 1083The prefix "_" for element "_" is not bound. - - An attribute name or element name has a prefix but no matching namespace was - found. This statement generates an error because there is no foo - namespace to match foo:x:
<foo:x xmlns:clowns='http://circuscenter.org'>
-
 1084Element or attribute ("_") does not match QName production: QName::=(NCName':')?NCName. - - You have foo: or :foo as an element or attribute name, but there is nothing - on the other side of the colon. -
 1085The element type "_" must be terminated by the matching end-tag "</_>". 
 1086The _ method only works on lists containing one item. - - The XMLList class propagates the XML-specific functions to one child if it has only one - item in its list. If more than one item is in the list, the routines fail with this - error. This happens for the following XMLList functions that mimic XML functions: -

addNamespace, appendChild, childIndex, - inScopeNamespaces, insertChildAfter, insertChildBefore, - name, namespace, localName, namespaceDeclarations, - nodeKind, prependChild, removeNamespace, replace, - setChildren, setLocalName, setName, and setNamespace. - -

 1087Assignment to indexed XML is not allowed. 
 1088The markup in the document following the root element must be well-formed. - - These are possible causes of this error: -
    -
  • Parsing an XMLList style object as XML
    • -
  • Misbalanced strings
    • -
-
 1089Assignment to lists with more than one item is not supported. 
 1090XML parser failure: element is malformed. - - An element name is malformed. This example of an element name is malformed because a - trailing right angle bracket > is missing: - - 
<a/><b></b
 1091XML parser failure: Unterminated CDATA section. 
 1092XML parser failure: Unterminated XML declaration. 
 1093XML parser failure: Unterminated DOCTYPE declaration. 
 1094XML parser failure: Unterminated comment. 
 1095XML parser failure: Unterminated attribute. 
 1096XML parser failure: Unterminated element. 
 1097XML parser failure: Unterminated processing instruction. 
 1098Illegal prefix _ for no namespace. - - The namespace constructor throws this error if you try to pass in an empty URI with a - non-empty prefix as in this example: - -
ns = new Namespace ("prefix", "");
-
 1100Cannot supply flags when constructing one RegExp from another. - - Creating a new regular expression from an existing one also copies its flags. To create a regular expression with - different flags, use the new operator and set the flags as desired. For example, this statement - creates a regular expression and specifies flag settings: - 
var re:RegExp = new RegExp("ali", /s)
- Alternatively, this statement creates a regular expression that has the same flags as re: - 
var re2:RegExp = new RegExp(re, ...)
 1101Cannot verify method _ with unknown scope. - - See the note at the bottom of this table.* -
 1102Illegal default value for type _. - - See the note at the bottom of this table.* -
 1103Class _ cannot extend final base class. - - See the note at the bottom of this table.* -
 1104Attribute "_" was already specified for element "_". 
 1107The ABC data is corrupt, attempt to read out of bounds. - - See the note at the bottom of this table.* -
 1108The OP_newclass opcode was used with the incorrect base class. - - See the note at the bottom of this table.* -
 1109Attempt to directly call unbound function _ from method _. - - See the note at the bottom of this table.* -
 1110_ cannot extend _. - - See the note at the bottom of this table.* -
 1111_ cannot implement _. - - See the note at the bottom of this table.* -
 1112Argument count mismatch on class coercion. Expected 1, got _. 
 1113OP_newactivation used in method without NEED_ACTIVATION flag. - - See the note at the bottom of this table.* -
 1114OP_getglobalslot or OP_setglobalslot used with no global scope. - - See the note at the bottom of this table.* -
 1115_ is not a constructor. 
 1116second argument to Function.prototype.apply must be an array. 
 1117Invalid XML name: _. 
 1118Illegal cyclical loop between nodes. 
 1119Delete operator is not supported with operand of type _. 
 1120Cannot delete property _ on _. 
 1121Method _ has a duplicate method body. 
 1122Interface method _ has illegal method body. 
 1123Filter operator not supported on type _. 
 1124OP_hasnext2 requires object and index to be distinct registers. 
 1125The index _ is out of range _. 
 1126Cannot change the length of a fixed Vector. 
 1127Type application attempted on a non-parameterized type. 
 1128Incorrect number of type parameters for _. Expected _, got _. 
 1129Cyclic structure cannot be converted to JSON string. 
 1131Replacer argument to JSON stringifier must be an array or a two parameter function. 
 1132Invalid JSON parse input. 
 1502A script has executed for longer than the default timeout period of 15 seconds. - - A script executed after the timeout period. (The default timeout period is 15 seconds.) After this error occurs, the - script can continue to execute for 15 seconds more, after which the script terminates and throws run-time error number 1503 (A script failed to exit after 30 seconds and was terminated.) -
 1503A script failed to exit after 30 seconds and was terminated. - - The script was still executing after 30 seconds. Flash Player first throws run-time error number 1502 (A script has executed for longer than the default timeout period of 15 seconds.) if the script executed more than 15 - seconds, which is the default timeout period. This error occurs 15 seconds after Error 1502 occurs. -
 1507Argument _ cannot be null. 
 1508The value specified for argument _ is invalid. - - You are possibly trying to pass the wrong data type. For example, the code - 
public function doSomething(const:int):void {
-    }
-    this ["doSomething"] ("str")
- generates an error at runtime because doSomething is cast as an int data type.
 1510When the callback argument is a method of a class, the optional this argument must be null. 
 1511Worker is already started. 
 1512Starting a worker that already failed is not supported. 
 1513Worker has terminated." 
 1514unlock() with no preceding matching lock(). 
 1515Invalid condition timeout value: _. 
 1516Condition cannot notify if associated mutex is not owned. 
 1517Condition cannot notifyAll if associated mutex is not owned. 
 1518Condition cannot wait if associated mutex is not owned. 
 1519Condition cannot be initialized. 
 1520Mutex cannot be initialized. 
 1521Only the worker's parent may call start. 
 2004One of the parameters is invalid. 
 2006The supplied index is out of bounds. 
 2007Parameter _ must be non-null. 
 2008Parameter _ must be one of the accepted values. 
 2012_ class cannot be instantiated. 
 2030End of file was encountered. 
 2058There was an error decompressing the data. 
 2085Parameter _ must be non-empty string. 
 2088The Proxy class does not implement getProperty. It must be overridden by a subclass. 
 2089The Proxy class does not implement setProperty. It must be overridden by a subclass. 
 2090The Proxy class does not implement callProperty. It must be overridden by a subclass. 
 2091The Proxy class does not implement hasProperty. It must be overridden by a subclass. 
 2092The Proxy class does not implement deleteProperty. It must be overridden by a subclass. 
 2093The Proxy class does not implement getDescendants. It must be overridden by a subclass. 
 2105The Proxy class does not implement nextNameIndex. It must be overridden by a subclass. 
 2106The Proxy class does not implement nextName. It must be overridden by a subclass. 
 2107The Proxy class does not implement nextValue. It must be overridden by a subclass. 
 2108The value _ is not a valid Array length. 
 2173Unable to read object in stream. The class _ does not implement flash.utils.IExternalizable but is aliased to an externalizable class. 
 3735This API cannot accept shared ByteArrays. 
 3806ByteArray.shareable is no longer supported. Learn more at https://www.adobe.com/go/fp-spectre 
 3807Worker.start has been disabled by the user. Learn more at https://www.adobe.com/go/fp-spectre 
 2000No active security context. 
 2001Too few arguments were specified; got _, _ expected. 
 2002Operation attempted on invalid socket. 
 2003Invalid socket port number specified. - - The valid range is 0 to 65535. For more information, see Socket Connections in this language reference. -
 2005Parameter _ is of the incorrect type. Should be type _. 
 2007Parameter _ must be non-null. - - Possible symbol clash in multiple SWFs; abcenv must be non-null. -
 2009This method cannot be used on a text field with a style sheet. 
 2010Local-with-filesystem SWF files are not permitted to use sockets. 
 2011Socket connection failed to _:_. - - There is a network problem. Possibly a DNS name is not resolving or a TCP socket is not connecting. -
 2013Feature can only be used in Flash Authoring. 
 2014Feature is not available at this time. - - The feature is not supported on this system. -
 2015Invalid BitmapData. 
 2017Only trusted local files may cause the Flash Player to exit. 
 2018System.exit is only available in the standalone Flash Player. 
 2019Depth specified is invalid. 
 2020MovieClips objects with different parents cannot be swapped. 
 2021Object creation failed. 
 2022Class _ must inherit from DisplayObject to link to a symbol. 
 2023Class _ must inherit from Sprite to link to the root. 
 2024An object cannot be added as a child of itself. 
 2025The supplied DisplayObject must be a child of the caller. 
 2026An error occurred navigating to the URL _. - - Possibly the URL does not exist, the network connection has a problem, or the URL is outside the security sandbox. -
 2027Parameter _ must be a non-negative number; got _. 
 2028Local-with-filesystem SWF file _ cannot access Internet URL _. 
 2029This URLStream object does not have a stream opened. 
 2031Socket Error. - - A socket error occurred. For more information, see Socket Connections in this language reference. -
 2032Stream Error. 
 2033Key Generation Failed. 
 2034An invalid digest was supplied. 
 2035URL Not Found. 
 2036Load Never Completed. 
 2037Functions called in incorrect sequence, or earlier call was unsuccessful. 
 2038File I/O Error. 
 2039Invalid remote URL protocol. The remote URL protocol must be HTTP or HTTPS. 
 2041Only one file browsing session may be performed at a time. 
 2042The digest property is not supported by this load operation. 
 2044Unhandled _:. 
 2046The loaded file did not have a valid signature. 
 2047Security sandbox violation: _: _ cannot access _. 
 2048Security sandbox violation: _ cannot load data from _. 
 2049Security sandbox violation: _ cannot upload data to _. 
 2051Security sandbox violation: _ cannot evaluate scripting URLs within _ (allowScriptAccess is _). Attempted URL was _. 
 2052Only String arguments are permitted for allowDomain and allowInsecureDomain. 
 2053Security sandbox violation: _ cannot clear an interval timer set by _. 
 2054The value of Security.exactSettings cannot be changed after it has been used. 
 2055The print job could not be started. 
 2056The print job could not be sent to the printer. 
 2057The page could not be added to the print job. - - The addPage() method is not used correctly. See the addPage() entry in this language reference. -
 2059Security sandbox violation: _ cannot overwrite an ExternalInterface callback added by _. 
 2060Security sandbox violation: ExternalInterface caller _ cannot access _. 
 2061No ExternalInterface callback _ registered. 
 2062Children of Event must override clone() {return new MyEventClass (...);}. 
 2063Error attempting to execute IME command. - - One of the IME services has failed. -
    -
  • If you are using the setConversionMode() or setEnabled() method, ActionScript 3.0 replaces these - methods with the access property.
    • -
  • If you are using the doConversion() or setComposition() - method, these methods are not supported for Macintosh OSX.
    • -
-
 2065The focus cannot be set for this target. 
 2066The Timer delay specified is out of range. 
 2067The ExternalInterface is not available in this container. ExternalInterface requires Internet Explorer ActiveX, Firefox, Mozilla 1.7.5 and greater, or other browsers that support NPRuntime. 
 2068Invalid sound. 
 2069The Loader class does not implement this method. 
 2070Security sandbox violation: caller _ cannot access Stage owned by _. 
 2071The Stage class does not implement this property or method. 
 2074The stage is too small to fit the download ui. 
 2075The downloaded file is invalid. - - Possibly the file decompression failed, the file format is invalid, or the signature validation failed. -
 2077This filter operation cannot be performed with the specified input parameters. 
 2078The name property of a Timeline-placed object cannot be modified. 
 2079Classes derived from Bitmap can only be associated with defineBits characters (bitmaps). 
 2082Connect failed because the object is already connected. 
 2083Close failed because the object is not connected. 
 2084The AMF encoding of the arguments cannot exceed 40K. 
 2086A setting in the mms.cfg file prohibits this FileReference request. 
 2087The FileReference.download() file name contains prohibited characters. - - The filename cannot contain spaces or any of the following characters: /, \, :, *, ?, ", <, >, |, %, or the ASCII control - characters 0 through 31 (0x00 through 0X1F). Also, filenames longer than 256 characters may fail on some browsers or servers. - -
 2094Event dispatch recursion overflow. - - The recursion exceeds the maximum recursion depth. (The default maximum is 256.) -
 2095_ was unable to invoke callback _. 
 2096The HTTP request header _ cannot be set via ActionScript. - - You are adding a disallowed HTTP header to an HTTP request. See the flash.net.URLRequestHeader class for a complete list of disallowed HTTP request headers. - -
 2097The FileFilter Array is not in the correct format. - - There are two valid formats: -
    -
  • A description with Windows file extensions only
    • -
  • A description with Windows file extensions and Macintosh file formats.
    • -
-

The two file formats and not interchangeable; you must use one or the other. - For more information, see the FileFilter class in this language reference.

- -
 2098The loading object is not a .swf file, you cannot request SWF properties from it. 
 2099The loading object is not sufficiently loaded to provide this information. 
 2100The ByteArray parameter in Loader.loadBytes() must have length greater than 0. 
 2101The String passed to URLVariables.decode() must be a URL-encoded query string containing name/value pairs. 
 2102The before XMLNode parameter must be a child of the caller. 
 2103XML recursion failure: new child would create infinite loop. - - Possibly you are trying to make objects child objects of each other. For example, the following code generates this error because a and b both try to add the other as a child object. - 
a.addChild(b);
-b.addChild(a);
-
 2108Scene _ was not found. 
 2109Frame label _ not found in scene _. 
 2110The value of Security.disableAVM1Loading cannot be set unless the caller can access the stage and is in an ActionScript 3.0 SWF file. 
 2111Security.disableAVM1Loading is true so the current load of the ActionScript 1.0/2.0 SWF file has been blocked. 
 2112Provided parameter LoaderContext.ApplicationDomain is from a disallowed domain. 
 2113Provided parameter LoaderContext.SecurityDomain is from a disallowed domain. 
 2114Parameter _ must be null. 
 2115Parameter _ must be false. 
 2116Parameter _ must be true. 
 2118The LoaderInfo class does not implement this method. 
 2119Security sandbox violation: caller _ cannot access LoaderInfo.applicationDomain owned by _. 
 2121Security sandbox violation: _: _ cannot access _. This may be worked around by calling Security.allowDomain. 
 2122Security sandbox violation: _: _ cannot access _. A policy file is required, but the checkPolicyFile flag was not set when this media was loaded. 
 2123Security sandbox violation: _: _ cannot access _. No policy files granted access. 
 2124Loaded file is an unknown type. 
 2125Security sandbox violation: _ cannot use Runtime Shared Library _ because crossing the boundary between ActionScript 3.0 and ActionScript 1.0/2.0 objects is not allowed. 
 2126NetConnection object must be connected. 
 2127FileReference POST data cannot be type ByteArray. 
 2128Certificate error in secure connection. 
 2129Connection to _ failed. 
 2130Unable to flush SharedObject. 
 2131Definition _ cannot be found. 
 2132NetConnection.connect cannot be called from a netStatus event handler. 
 2133Callback _ is not registered. 
 2134Cannot create SharedObject. 
 2136The SWF file _ contains invalid data. 
 2137Security sandbox violation: _ cannot navigate window _ within _ (allowScriptAccess is _). Attempted URL was _. 
 2138Rich text XML could not be parsed. 
 2139SharedObject could not connect. 
 2140Security sandbox violation: _ cannot load _. Local-with-filesystem and local-with-networking SWF files cannot load each other. 
 2141Only one PrintJob may be in use at a time. 
 2142Security sandbox violation: local SWF files cannot use the LoaderContext.securityDomain property. _ was attempting to load _. 
 2143AccessibilityImplementation.get_accRole() must be overridden from its default. 
 2144AccessibilityImplementation.get_accState() must be overridden from its default. 
 2145Cumulative length of requestHeaders must be less than 8192 characters. 
 2146Security sandbox violation: _ cannot call _ because the HTML/container parameter allowNetworking has the value _. 
 2147Forbidden protocol in URL _. 
 2148SWF file _ cannot access local resource _. Only local-with-filesystem and trusted local SWF files may access local resources. 
 2149Security sandbox violation: _ cannot make fscommand calls to _ (allowScriptAccess is _). 
 2150An object cannot be added as a child to one of it's children (or children's children, etc.). 
 2151You cannot enter full screen mode when the settings dialog is visible. 
 2152Full screen mode is not allowed. 
 2153The URLRequest.requestHeaders array must contain only non-NULL URLRequestHeader objects. 
 2154The NetStream Object is invalid. This may be due to a failed NetConnection. 
 2155The ExternalInterface.call functionName parameter is invalid. Only alphanumeric characters are supported. 
 2156Port _ may not be accessed using protocol _. Calling SWF was _. 
 2157Rejecting URL _ because the 'asfunction:' protocol may only be used for link targets, not for networking APIs. 
 2158The NetConnection Object is invalid. This may be due to a dropped NetConnection. 
 2159The SharedObject Object is invalid. 
 2160The TextLine is INVALID and cannot be used to access the current state of the TextBlock. 
 2161An internal error occured while laying out the text. 
 2162The Shader output type is not compatible for this operation. 
 2163The Shader input type _ is not compatible for this operation. 
 2164The Shader input _ is missing or an unsupported type. 
 2165The Shader input _ does not have enough data. 
 2166The Shader input _ lacks valid dimensions. 
 2167The Shader does not have the required number of inputs for this operation. 
 2168Static text lines have no atoms and no reference to a text block. 
 2169The method _ may not be used for browser scripting. The URL _ requested by _ is being ignored. If you intend to call browser script, use navigateToURL instead. 
 2170Security sandbox violation: _ cannot send HTTP headers to _. 
 2171The Shader object contains no byte code to execute. 
 2172The ShaderJob is already running or finished. 
 2174Only one download, upload, load or save operation can be active at a time on each FileReference. 
 2175One or more elements of the content of the TextBlock has a null ElementFormat. 
 2176Certain actions, such as those that display a pop-up window, may only be invoked upon user interaction, for example by a mouse click or button press. 
 2177The Shader input _ is too large. 
 2178The Clipboard.generalClipboard object must be used instead of creating a new Clipboard. 
 2179The Clipboard.generalClipboard object may only be read while processing a flash.events.Event.PASTE event. 
 2180It is illegal to move AVM1 content (AS1 or AS2) to a different part of the displayList when it has been loaded into AVM2 (AS3) content. 
 2181The TextLine class does not implement this property or method. 
 2182Invalid fieldOfView value. The value must be greater than 0 and less than 180. 
 2183Scale values must not be zero. 
 2184The ElementFormat object is locked and cannot be modified. 
 2185The FontDescription object is locked and cannot be modified. 
 2186Invalid focalLength _. 
 2187Invalid orientation style _. Value must be one of 'Orientation3D.EULER_ANGLES', 'Orientation3D.AXIS_ANGLE', or 'Orientation3D.QUATERNION'. 
 2188Invalid raw matrix. Matrix must be invertible. 
 2189A Matrix3D can not be assigned to more than one DisplayObject. 
 2190The attempted load of _ failed as it had a Content-Disposition of attachment set. 
 2191The Clipboard.generalClipboard object may only be written to as the result of user interaction, for example by a mouse click or button press. 
 2192An unpaired Unicode surrogate was encountered in the input. 
 2193Security sandbox violation: _: _ cannot access _.  
 2194Parameter _ cannot be a Loader.  
 2195Error thrown as Loader called _. 
 2196Parameter _ must be an Object with only String values.  
 2200The SystemUpdater class is not supported by this player. 
 2201The requested update type is not supported on this operating system. 
 2202Only one SystemUpdater action is allowed at a time. 
 2203The requested SystemUpdater action cannot be completed. 
 2204This operation cannot be canceled because it is waiting for user interaction. 
 2205Invalid update type _. 
 2500An error occurred decrypting the signed swf file. The swf will not be loaded. 
 2501This property can only be accessed during screen sharing. 
 2502This property can only be accessed if sharing the entire screen. 
 3000Illegal path name. 
 3001File or directory access denied. 
 3002File or directory exists. 
 3003File or directory does not exist. 
 3004Insufficient file space. 
 3005Insufficient system resources. 
 3006Not a file. 
 3007Not a directory. 
 3008Read-only or write-protected media. 
 3009Cannot move file or directory to a different device. 
 3010Directory is not empty. 
 3011Move or copy destination already exists. 
 3012Cannot delete file or directory. 
 3013File or directory is in use. 
 3014Cannot copy or move a file or directory to overwrite a containing directory. 
 3015Loader.loadBytes() is not permitted to load content with executable code. 
 3016No application was found that can open this file. 
 3100A SQLConnection cannot be closed while statements are still executing. 
 3101Database connection is already open. 
 3102Name argument specified was invalid. It must not be null or empty. 
 3103Operation cannot be performed while there is an open transaction on this connection. 
 3104A SQLConnection must be open to perform this operation. 
 3105Operation is only allowed if a connection has an open transaction. 
 3106Property cannot be changed while SQLStatement.executing is true. 
 3107_ may not be called unless SQLResult.complete is false. 
 3108Operation is not permitted when the SQLStatement.text property is not set. 
 3109Operation is not permitted when the SQLStatement.sqlConnection property is not set. 
 3110Operation cannot be performed while SQLStatement.executing is true. 
 3111 - An invalid schema type was specified. - - - Valid values are: -
    -
  • SQLIndexSchema
    • -
  • SQLTableSchema
    • -
  • SQLTriggerSchema
    • -
  • SQLViewSchema
    • -
- -
 3112 - An invalid transaction lock type was specified. - - - Valid values are: -
    -
  • SQLTransactionLockType.DEFERRED
    • -
  • SQLTransactionLockType.IMMEDIATE
    • -
  • SQLTransactionLockType.EXCLUSIVE
    • -
- -
 3113Reference specified is not of type File. 
 3114 - An invalid open mode was specified. - - - Valid values are: -
    -
  • SQLMode.READ
    • -
  • SQLMode.UPDATE
    • -
  • SQLMode.CREATE
    • -
- -
 3115SQL Error. 
 3116An internal logic error occurred. 
 3117Access permission denied. - - - Indicates that the operation failed because a SQL statement attempted to - perform an operation that it didn't have permission to perform, such as - specifying an INSERT operation to be performed on a view. - -
 3118Operation aborted. - - - Indicates that a SQL statement execution failed because execution was aborted. - This error occurs when code in a trigger cancels the operation using the SQL - RAISE() function, or if the SQLConnection.cancel() - or SQLStatement.cancel() methods are called when a statement is - executed using SQLStatement.execute() or SQLStatement.next() - with a prefetch argument specified, and not all of the results have - been returned. - -
 3119Database file is currently locked. 
 3120Table is locked. - - - Indicates that an operation could not be completed because another - AIR application was holding a lock on a table involved in the operation. This - can occur when a statement executing through a SQLConnection attempts to write to a table when another - SQLConnection (in the same application or a different application) has an open transaction and is writing to the table, or if a - SQLConnection attempts to read from or write to a table while another - SQLConnection has an exclusive-locked transaction. - -
 3121Out of memory. 
 3122Attempt to write a readonly database. - - - Indicates that an operation could not be completed because the database - is read only. This can occur if the database file is designated as read only - in the operating system, if the database is opened in read-only mode, - or if an older version of Adobe AIR accesses a database - file created with a newer version of the runtime. - -
 3123Database disk image is malformed. - - - Indicates that the operation failed because the specified file - is a database file whose data has become corrupted. - This can happen when the application is force - quit while in a transaction or any other time that a database file is left in - the state of having an open transaction that can't be rolled back when reopening - the file. - -
 3124Insertion failed because database is full. 
 3125Unable to open the database file. - - - Indicates that the connection could not be completed because the database file - could not be opened. This can happen if SQLConnection.open() - or SQLConnection.openAsync()is called with the openMode - parameter set to SQLMode.UPDATE - and the database file doesn't exist. It can also happen if the operating - system returns an error when the runtime attempts to access the database file. - -
 3126Database lock protocol error. 
 3127Database is empty. 
 3128Disk I/O error occurred. - - - Indicates that an operation could not be completed because of a disk - I/O error. This can happen if the runtime is attempting to delete a - temporary file and another program (such as a virus protection application) - is holding a lock on the file. This can also happen if the runtime is - attempting to write data to a file and the data can't be written. - -
 3129The database schema changed. - - - Indicates that the operation could not be completed because of a schema error. - This occurs when the schema of the database changes after a statement - is prepared but before it finishes executing, such as if two SQLConnection instances are - connected to the same database, and one instance changes the schema - while another one is reading it. - -
 3130Too much data for one row of a table. 
 3131Abort due to constraint violation. - - - Indicates that the operation could not be completed because the statement caused - a violation of one or more data integrity constraints. These are constraints - that are defined in the table structure when it is created. For more information, - see the CREATE TABLE - section in the appendix - SQL support in local databases. - -
 3132Data type mismatch. - - - Indicates that the operation could not be completed because of a data type - mismatch error. This occurs when the data type of a value doesn't match the - expected or required type. For more information, - see the Data type support - section in the appendix SQL support in - local databases. - -
 3133An internal error occurred. 
 3134Feature not supported on this operating system. 
 3135Authorization denied. 
 3136Auxiliary database format error. 
 3137An index specified for a parameter was out of range. - - - Indicates that the operation could not be completed because a parameter - index was not valid, such as if a parameter is specified with an index less than 0, - or if a parameter is specified with index 7 but the statement text only - includes five parameters. - -
 3138File opened is not a database file. 
 3139The page size specified was not valid for this operation. 
 3140The encryption key size specified was not valid for this operation. Keys must be exactly 16 bytes in length 
 3141The requested database configuration is not supported. 
 3143Unencrypted databases may not be reencrypted. 
 3200Cannot perform operation on closed window. 
 3201Adobe Reader cannot be found. 
 3202Adobe Reader 8.1 or later cannot be found. 
 3203Default Adobe Reader must be version 8.1 or later. 
 3204An error ocurred trying to load Adobe Reader. 
 3205Only application-sandbox content can access this feature. 
 3206Caller _ cannot set LoaderInfo property _. 
 3207Application-sandbox content cannot access this feature. 
 3208Attempt to access invalid clipboard. 
 3209Attempt to access dead clipboard. 
 3210The application attempted to reference a JavaScript object in a HTML page that is no longer loaded. 
 3211Drag and Drop File Promise error: _ 
 3212Cannot perform operation on a NativeProcess that is not running. 
 3213Cannot perform operation on a NativeProcess that is already running. 
 3214NativeProcessStartupInfo.executable does not specify a valid executable file. 
 3215NativeProcessStartupInfo.workingDirectory does not specify a valid directory. 
 3216Error while reading data from NativeProcess.standardOutput. 
 3217Error while reading data from NativeProcess.standardError. 
 3218Error while writing data to NativeProcess.standardInput. 
 3219The NativeProcess could not be started. '_' 
 3220Action '_' not allowed in current security context '_'. 
 3221Adobe Flash Player cannot be found. 
 3222The installed version of Adobe Flash Player is too old. 
 3223DNS lookup error: platform error _ 
 3224Socket message too long 
 3225Cannot send data to a location when connected. 
 3226Cannot import a SWF file when LoaderContext.allowCodeImport is false. 
 3227Cannot launch another application from background. 
 3228StageWebView encountered an error during the load operation. 
 3229The protocol is not supported.:  
 3230The browse operation is unsupported. 
 3300Voucher is invalid. - - Reacquire the voucher from the server. -
 3301User authentication failed. - - Ask user to re-enter credentials. -
 3302Flash Access server does not support SSL. - - SSL must be enabled on the license server when playing content packaged using Flash Media Right Management Server. -
 3303Content expired. - - Reacquire voucher from the server. -
 3304User authorization failed (for example, the user has not purchased the content). - - The current user is not authorized to view the content. -
 3305Can't connect to the server. - - Check the network connection. -
 3306Client update required (Flash Access server requires new client). - - Both the runtime (Flash Player or AIR) and the Flash Access module need to be updated. -
 3307Generic internal Flash Access failure. 
 3308Wrong voucher key. - - Reacquire the voucher from the server. -
 3309Video content is corrupted. - - Try downloading the content again. -
 3310The AIR application or Flash Player SWF does not match the one specified in the DRM policy. 
 3311The version of the application does not match the one specified in the DRM policy. 
 3312Verification of voucher failed. - - Reacquire the voucher from the server. -
 3313Write to the file system failed. 
 3314Verification of FLV/F4V header file failed. - - Try downloading the DRMContentData object again. If DRMContentData was extracted from FLV/F4V try downloading the content again. -
 3315 The current security context does not allow this operation. - - This error can occur when the remote SWF loaded by AIR isn't allowed access to Flash Access functionality. This error can also occur if a security error occurs during network access. - Other possible security errors include errors due to a crossdomain.xml file, which restricts client access based on domain, or if crossdomain.xml is not accessible. -
 3316The value of LocalConnection.isPerUser cannot be changed because it has already been locked by a call to LocalConnection.connect, .send, or .close. 
 3317 Failed to load Flash Access module. - - If this error occurs in AIR, reinstall AIR. - If this error occurs in Flash Player, download the Flash Access module again. -
 3318Incompatible version of Flash Access module found. - - If this error occurs in AIR, reinstall AIR. - If this error occurs in Flash Player, download the Flash Access module again. -
 3319Missing Flash Access module API entry point. - - If this error occurs in AIR, reinstall AIR. - If this error occurs in Flash Player, download the Flash Access module again. -
 3320Generic internal Flash Access failure. 
 3321Individualization failed. - - There was a problem with the Adobe server (e.g. could be busy). Retry the operation. -
 3322Device binding failed. - - Undo any device changes or reset the license (voucher) files. The Flash Access module will then reindividualize. - In AIR, voucher reset can be done by invoking the resetDRMVouchers() on DRMManager, whereas in Flash Player, the user needs to reset the license files in the Flash Player Settings Manager. -
 3323The internal stores are corrupted. - - Retry the operation. If the error persists, reset the license files in the Flash Player Settings Manager. The Flash Access module will then reindividualize. -
 3324Reset license files and the client will fetch a new machine token. - - Reset the license files in the Flash Player Settings Manager and the client will fetch a new machine token. -
 3325Internal stores are corrupt. - - Internal stores are corrupt and has been deleted. Retry the operation. -
 3326Call customer support. - - Tampering has been detected. Options are to call customer support, or reset the license files in the Flash Player Settings Manager. -
 3327 Clock tampering detected. - - Options are to reacquire the voucher or to fix the clock. -
 3328Server error; retry the request. - - This error is a server error. Retry the request. The sub error gives the error returned by the server. -
 3329Error in application-specific namespace. - - The server has returned an error in an application-specific namespace. Check the application for details. -
 3330Need to authenticate the user and reacquire the voucher. - - Try authenticating the user and acquiring the voucher again. -
 3331Content is not yet valid. - - The voucher is not yet valid. Try again at a later date. -
 3332Cached voucher has expired. Reacquire the voucher from the server. - - The voucher cached on the local computer has expired. Reacquire the voucher from the server. -
 3333The playback window for this policy has expired. - - The playback window for this policy has expired. The user can no longer play this content under this policy. -
 3334This platform is not allowed to play this content. - - This platform is not allowed to play this media. -
 3335Invalid version of Flash Access module. Upgrade AIR or Flash Access module for the Flash Player. - - In AIR, update to the latest version of AIR. In Flash Player, upgrade to the latest version - of the Flash Access module and try playing content again. -
 3336This platform is not allowed to play this content. - - This operating system is not allowed to play this media. -
 3337Upgrade Flash Player or AIR and retry playback. - - Upgrade to the latest version of AIR or Flash Player, and try playing content again. -
 3338Unknown connection type. - - Flash Player or AIR cannot detect the connection type. Try connecting the device to a different connection. -
 3339Can't play back on analog device. Connect to a digital device. - - Cannot play media on an analog device. Connect to a digital device and try again. -
 3340Can't play back because connected analog device doesn't have the correct capabilities. - - Cannot play media because the connected analog device doesn't have the correct capabilities - (for example, it doesn't have Macrovision or ACP). -
 3341Can't play back on digital device. - - The policy does not allow play back on digital devices. -
 3342The connected digital device doesn't have the correct capabilities. - - The connected digital device doesn't have the correct capabilities, for example, it doesn't support HDCP. -
 3343 Internal Error. - - If this error occurs in AIR, reinstall AIR. - If this error occurs in Flash Player, you may need to update the Adobe Access module by calling - SystemUpdater.update(flash.system.SystemUpdaterType.DRM) For more information, see the - SystemUpdater page. -
 3344Missing Flash Access module. - - If this error occurs in AIR, reinstall AIR. - If this error occurs in Flash Player, you may need to update the Adobe Access module by calling - SystemUpdater.update(flash.system.SystemUpdaterType.DRM) For more information, see the - SystemUpdater page. -
 3345This operation is not permitted with content protected using Flash Access. 
 3346 Failed migrating local DRM data, all locally cached DRM vouchers are lost.  
 3347 The device does not meet the Flash Access server's playback device constraints.  
 3348 This protected content is expired.  
 3349The Flash Access server is running at a version that's higher than the max supported by this runtime. 
 3350The Flash Access server is running at a version that's lower than the min supported by this runtime. 
 3351Device Group registration token is corrupted, please refresh the token by registering again to the DRMDeviceGroup.  
 3352The server is using a newer version of the registration token for this Device Group. Please refresh the token by registering again to the DRMDeviceGroup.  
 3353the server is using an older version of the registration token for this Device Group.  
 3354 Device Group registration is expired, please refresh the token by registering again to the DRMDeviceGroup.  
 3355 The server denied this Device Group registration request. 
 3356 The root voucher for this content's DRMVoucher was not found.  
 3357 The DRMContentData provides no valid embedded voucher and no Flash Access server url to acquire the voucher from.  
 3358ACP protection is not available on the device but required to playback the content.  
 3359CGMSA protection is not available on the device but required to playback the content.  
 3360Device Group registration is required before doing this operation.  
 3361The device is not registered to this Device Group.  
 3362Asynchronous operation took longer than maxOperationTimeout. 
 3363The M3U8 playlist passed in had unsupported content. 
 3364The framework requested the device ID, but the returned value was empty. 
 3365This browser/platform combination does not allow DRM protected playback when in incognito mode. 
 3366The host runtime called the Access library with a bad parameter. 
 3367M3U8 manifest signing failed. 
 3368The user cancelled the operation, or has entered settings that disallow access to the system. 
 3369A required browser interface is not available. 
 3370The user has disabled the "Allow identifiers for protected content" setting. 
 3400An error occured while executing JavaScript code. 
 3401Security sandbox violation: An object with this name has already been registered from another security domain. 
 3402Security sandbox violation: Bridge caller _ cannot access _. 
 3500The extension context does not have a method with the name _. 
 3501The extension context has already been disposed. 
 3502The extension returned an invalid value. 
 3503The extension was left in an invalid state. 
 3600No valid program set. 
 3601No valid index buffer set. 
 3602Sanity check on parameters failed, _ triangles and _ index offset. 
 3603Not enough indices in this buffer. _ triangles at offset _, but there are only _ indices in buffer. 
 3604Sampler _ binds a texture that is also bound for render to texture. 
 3605Sampler _ binds an invalid texture. 
 3606Sampler _ format does not match texture format. 
 3607Stream _ is set but not used by the current vertex program. 
 3608Stream _ is invalid. 
 3609Stream _ does not have enough vertices. 
 3610Stream _ vertex offset is out of bounds 
 3611Stream _ is read by the current vertex program but not set. 
 3612Programs must be in little endian format. 
 3613The native shader compilation failed. 
 3614The native shader compilation failed.\nOpenGL specific: _ 
 3615AGAL validation failed: Program size below minimum length for _ program. 
 3616AGAL validation failed: Not an AGAL program. Wrong magic byte for _ program. 
 3617AGAL validation failed: Bad AGAL version for _ program. Current version is _. 
 3618AGAL validation failed: Bad AGAL program type identifier for _ program. 
 3619AGAL validation failed: Shader type must be either fragment or vertex for _ program. 
 3620AGAL validation failed: Invalid opcode, value out of range: _ at token _ of _ program. 
 3621AGAL validation failed: Invalid opcode, _ is not implemented in this version at token _ of _ program. 
 3622AGAL validation failed: Opcode _ only allowed in fragment programs at token _ of _ program. 
 3623AGAL validation failed: Block nesting underflow - EIF without opening IF condition. At token _ of _ program. 
 3624AGAL validation failed: Block nesting overflow. Too many nested IF blocks. At token _ of _ program. 
 3625AGAL validation failed: Bad AGAL source operands. Both are constants (this must be precomputed) at token _ of _ program. 
 3626AGAL validation failed: Opcode _, both operands are indirect reads at token _ of _ program. 
 3627AGAL validation failed: Opcode _ destination operand must be all zero at token _ of _ program. 
 3628AGAL validation failed: The destination operand for the _ instruction must mask w (use .xyz or less) at token _ of _ program. 
 3629AGAL validation failed: Too many tokens (_) for _ program. 
 3630Fragment shader type is not fragment. 
 3631Vertex shader type is not vertex. 
 3632AGAL linkage: Varying _ is read in the fragment shader but not written to by the vertex shader. 
 3633AGAL linkage: Varying _ is only partially written to. Must write all four components. 
 3634AGAL linkage: Fragment output needs to write to all components. 
 3635AGAL linkage: Vertex output needs to write to all components. 
 3636AGAL validation failed: Unused operand is not set to zero for _ at token _ of _ program. 
 3637AGAL validation failed: Sampler registers only allowed in fragment programs for _ at token _ of _ program. 
 3638AGAL validation failed: Sampler register only allowed as second operand in texture instructions for _ at token _ of _ program. 
 3639AGAL validation failed: Indirect addressing only allowed in vertex programs for _ at token _ of _ program. 
 3640AGAL validation failed: Indirect addressing only allowed into constant registers for _ at token _ of _ program. 
 3641AGAL validation failed: Indirect addressing not allowed for this operand in this instruction for _ at token _ of _ program. 
 3642AGAL validation failed: Indirect source type must be attribute, constant or temporary for _ at token _ of _ program. 
 3643AGAL validation failed: Indirect addressing fields must be zero for direct addressing for _ at token _ of _ program. 
 3644AGAL validation failed: Varying registers can only be read in fragment programs for _ at token _ of _ program. 
 3645AGAL validation failed: Attribute registers can only be read in vertex programs for _ at token _ of _ program. 
 3646AGAL validation failed: Can not read from output register for _ at token _ of _ program. 
 3647AGAL validation failed: Temporary register read without being written to for _ at token _ of _ program. 
 3648AGAL validation failed: Temporary register component read without being written to for _ at token _ of _ program. 
 3649AGAL validation failed: Sampler registers can not be written to for _ at token _ of _ program. 
 3650AGAL validation failed: Varying registers can only be written in vertex programs for _ at token _ of _ program. 
 3651AGAL validation failed: Attribute registers can not be written to for _ at token _ of _ program. 
 3652AGAL validation failed: Constant registers can not be written to for _ at token _ of _ program. 
 3653AGAL validation failed: Destination writemask is zero for _ at token _ of _ program. 
 3654AGAL validation failed: Reserve bits should be zero for _ at token _ of _ program. 
 3655AGAL validation failed: Unknown register type for _ at token _ of _ program. 
 3656AGAL validation failed: Sampler register index out of bounds for _ at token _ of _ program. 
 3657AGAL validation failed: Varying register index out of bounds for _ at token _ of _ program. 
 3658AGAL validation failed: Attribute register index out of bounds for _ at token _ of _ program. 
 3659AGAL validation failed: Constant register index out of bounds for _ at token _ of _ program. 
 3660AGAL validation failed: Output register index out of bounds for _ at token _ of _ program. 
 3661AGAL validation failed: Temporary register index out of bounds for _ at token _ of _ program. 
 3662AGAL validation failed: Cube map samplers must set wrapping to clamp mode for _ at token _ of _ program. 
 3663Sampler _ binds an undefined texture. 
 3664AGAL validation failed: Unknown sampler dimension _ for _ at token _ of _ program. 
 3665AGAL validation failed: Unknown filter mode in sampler: _ for _ at token _ of _ program. 
 3666AGAL validation failed: Unknown mipmap mode in sampler: _ for _ at token _ of _ program. 
 3667AGAL validation failed: Unknown wrapping mode in sampler: _ for _ at token _ of _ program. 
 3668AGAL validation failed: Unknown special flag used in sampler: _ for _ at token _ of _ program. 
 3669Bad input size. 
 3670Buffer too big. 
 3671Buffer has zero size. 
 3672Buffer creation failed. Internal error. 
 3673Cube side must be [0..5]. 
 3674Miplevel too large. 
 3675Texture format mismatch. 
 3676Platform does not support desired texture format. 
 3677Texture decoding failed. Internal error. 
 3678Texture needs to be square. 
 3679Texture size does not match. 
 3680Depth texture not implemented yet. 
 3681Texture size is zero. 
 3682Texture size not a power of two. 
 3683Texture too big (max is _x_). 
 3684Texture creation failed. Internal error. 
 3685Could not create renderer. 
 3686'disabled' format only valid with a null vertex buffer. 
 3687Null vertex buffers require the 'disabled' format. 
 3688You must add an event listener for the context3DCreate event before requesting a new Context3D. 
 3689You can not swizzle second operand for _ at token _ of _ program. 
 3690Too many draw calls before calling present. 
 3691Resource limit for this resource type exceeded. 
 3692All buffers need to be cleared every frame before drawing. 
 3693AGAL validation failed: Sampler register must be used for second operand in texture instructions for _ at token _ of _ program. 
 3694The object was disposed by an earlier call of dispose() on it. 
 3695A texture can only be bound to multiple samplers if the samplers also have the exact same properties. Mismatch at samplers _ and _. 
 3696AGAL validation failed: Second use of sampler register needs to specify the exact same properties. At token _ of _ program. 
 3697A texture is bound on sampler _ but not used by the fragment program. 
 3698The back buffer is not configured. 
 3699Requested Operation failed to complete 
 3700A texture sampler binds an incomplete texture. Make sure to upload(). All miplevels are required when mipmapping is enabled. 
 3701The output color register can not use a write mask. All components must be written. 
 3702Context3D not available. 
 3703AGAL validation failed: Source swizzle must be scalar (one of: xxxx, yyyy, zzzz, wwww) for _ at token _ of _ program. 
 3704AGAL validation failed: Cube map samplers must enable mipmapping for _ at token _ of _ program. 
 3705Cubemap texture too big (max is 1024x1024). 
 3706Scissor rectangle is set but does not intersect the framebuffer. 
 3707Property can not be set in non full screen mode. 
 3708Feature not available on this platform. 
 3709The depthAndStencil flag in the application descriptor must match the enableDepthAndStencil Boolean passed to configureBackBuffer on the Context3D object. 
 3710Requested Stage3D Operation failed to complete. 
 3711The streaming levels is too large. 
 3712Rendering to streaming textures is not allowed. 
 3713Incomplete streaming texture (base level not uploaded) used with no mip sampling. 
 3714ApplicationDomain.domainMemory is not available. 
 3715Too many instructions used in native shader. Detected _ but can only support _ for _ program. 
 3716Too many ALU instructions in native shader. Detected _ but can only support _ for _ program. 
 3717Too many texture instructions in native shader. Detected _ but can only support _ for _ program. 
 3718Too many constants used in native shader. Detected _ but can only support _ for _ program. 
 3719Too many temporary registers used in native shader. Detected _ but can only support _ for _ program. 
 3720Too many varying registers used in native shader. Detected _ but can only support _ for _ program. 
 3721Too many indirect texture reads in native shader. Detected _ but can only support _ for _ program. 
 3722Event.FRAME_LABEL event can only be registered with FrameLabel object. 
 3723Invalid Context3D bounds. Context3D instance bounds must be contained within Stage bounds in constrained mode. Requested Context3D bounds were (_,_,_,_), stage bounds are (_,_,_,_). 
 3724This call requires a Context3D that is created with the extended profile. 
 3725The requested AGAL version (_) is not valid under the Context3D profile. For example AGAL version 2 requires extended profile. 
 3726AGAL validation failed: Opcode _ requires AGAL version to be at least 2, at token _ of _ program. 
 3727Failed to obtain authorization token. 
 3728When rendering to multiple textures slot 0 must be active. When rendering to the back buffer all render to texture slots must be disabled. 
 3729When rendering to multiple textures all textures must have the same dimension and render settings. 
 3730When rendering to multiple textures the same texture (or cube map face) may not be bound into multiple slots. 
 3731This feature is not available within this context. - - This error occurs if a background worker attempts to access an API that is not available to it. -
 3732Worker.terminate is only available for background workers. - - This error occurs if Worker.terminate() is invoked on the primoridial worker. -
 3735This API cannot accept shared ByteArrays. 
 3736MessageChannel is not a sender. 
 3737MessageChannel is not a receiver. 
 3738MessageChannel is closed. 
 3739AGAL validation failed: Open conditional block at end of _ program. 
 3740AGAL validation failed: Texture samplers used in the TED instruction can not specify a lod bias. At token _ of _ program. 
 3741AGAL validation failed: TEX instructions in an if block can not use computed texture coordinates. Either use interpolated texture coordinates or use the TED instruction instead. At token _ of _ program. 
 3742AGAL validation failed: DDX and DDY opcodes are not allowed inside conditional blocks. At token _ of _ program. 
 3743AGAL validation failed: The TED opcode must enable mip mapping. At token _ of _ program. 
 3744AGAL validation failed: Color output written to multiple times. At token _ of _ program. 
 3745Compressed texture size is too small. The minimum size for compressed textures is 4x4. 
 3746Rendering to compressed textures is not allowed. 
 3747Multiple application domains are not supported on this operating system. 
 3748AGAL validation failed: Empty conditional branch in AGAL of _ program. 
 3749AGAL validation failed: Depth output register index out of bounds for _ at token _ of _ program. 
 3750AGAL validation failed: Depth output register is only available in fragment programs. 
 3751AGAL validation failed: Output registers can not be written inside conditionals. 
 3752AGAL validation failed: Broken else chain. 
 3753Rectangle or cube textures require textures sampling to be set to clamp. 
 3754Texture sampler dimensions mismatch. The AGAL declaration has to match the texture used. 
 3755Rectangle textures have to disable mip mapping and can not have a lod bias set. 
 3756AGAL validation failed: Depth output must set only x as a write mask. At token _ of _ program. 
 3757AGAL validation failed: Vertex and fragment program need to have the same version. 
 3758AGAL validation failed: Conditional source are exactly the same, condition is constant. At token _ of _ program. 
 3759The selected texture format is not valid in this profile. 
 3760The color output index is out of range. 
 3761The bit depth of all textures used for render to texture must be exactly the same. 
 3762This texture format is not supported for rectangle textures. 
 3763Sampler _ binds a texture that that does not match the read mode specified in AGAL. Reading compressed or single/dual channel textures must be explicitly declared. 
 3764Reloading a SWF is not supported on this operating system. 
 3765This call requires a Context3D that is created with the baseline or baselineExtended profile. 
 3766RectangleTexture too big (max is the larger of _x_ or the size of the backbuffer). 
 3767The argument samples is too big. More than 1800 seconds of audio data is not permitted in a single call of loadPCMFromByteArray. 
 3768The Stage3D API may not be used during background execution on this operating system. 
 3769Security sandbox violation: Only simple headers can be used with navigateToUrl() or sendToUrl(). 
 3770ColorOutputIndex must be in the range [0..3]. 
 37712D textures need to have surfaceSelector = 0. 
 3772Cube textures need to have surfaceSelector [0..5]. 
 3773Rectangle textures need to have surfaceSelector = 0. 
 3774All the assigned render targets should match the outputs in the fragment program. 
 3775AGAL validation failed: Non-consecutive slots are not allowed. 
 3776Depth output in fragment program requires depthAndStencil = true. 
 3777Buffers need to be cleared before first draw. 
 3778Video textures have to disable mip mapping and can not have a LOD bias set. 
 3779This call requires a Context3D that is created with the standard profile or above 
 3780Requested width of backbuffer is not in allowed range _ to _. 
 3781Requested height of backbuffer is not in allowed range _ to _. 
 3782This call requires a Context3D that is created with the baseline profile or above. 
 3783A Stage object cannot be added as the child of another object. 
 3784The number of instances per element should be greater than 0. 
 3785Vertex buffer stream _ does not contain enough elements for number of instances. 
 3786AGAL validation failed: Instance id register can not be written to for _ at token _ of _ program. 
 3787This call requires a Context3D that is created with the standard extended profile or above. 
 3788Instance id register can only be read in the vertex shader. 
 3789AGAL validation failed: Instance id register is supported in Agal version 3 and above. 
 3790Texture upload failed. 
 3791Asynchronous upload is available for miplevel 0 only. 
 3792Vertex buffer stream _ for instances is improperly set at first index. 
 3800This call requires _ permission. 
 3801Another permission request is in progress. 
 3802Offset outside stage coordinate bound. 
 3803AGAL validation failed: Opcode _ only allowed in vertex programs at token _ of _ program. 
 3804AGAL validation failed: Anistropic Filter is not allowed in Vertex Texture Sampler. 
 3805AGAL validation failed: Vertex Texture Fetch is supported in Agal version 4 and above. 
-
-
-

-* Note: This error indicates that the ActionScript in the SWF is invalid. If you believe that the file has not been corrupted, please report the problem to Adobe.

-
-
-Compiler Errors | Compiler Warnings -
-
- -
-

-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Jun 30 2025, 11:01 AM GMT+01:00
Creative Commons License
-
-
- - diff --git a/html-docs/specialTypes.html b/html-docs/specialTypes.html deleted file mode 100644 index d47907d..0000000 --- a/html-docs/specialTypes.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - - -Special Types (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

The three special types are the untyped specifier (*), - void, and Null.

-
- - - - - - - - - - - - - -
 TypeDescription
 *Specifies that a property is untyped.
 voidSpecifies that a function cannot return any value.
 NullA special data type that represents the lack of a value.
-
Special Type detail
- - - - - -
*special type
-
-Usage -
    propertyName:*
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a property is untyped. Use of the asterisk symbol for a type annotation is equivalent to using no type annotation. - Expressions that read from untyped properties are considered untyped expressions. Use of untyped expressions or properties is recommended in the following circumstances: -

    -
  • When you want to defer type checking to runtime. You can use an untyped property or expression to circumvent compile-time type checking in strict mode. - Note, however, that runtime type checking of assignment statements occurs whether you use strict mode or not.
    • -
  • When you want to store the value undefined in a property. Unlike previous versions of ActionScript, the value undefined is not a member of the Object data type. You must use an untyped property to store the value undefined.
    • -
-

-

-See also -

-
-Object -
-
- - - - - -
voidspecial type 
-
-Usage -
    functionName():void {}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a function cannot return any value. The void type is a special type that contains exactly one value: undefined. - It is special in that its use is limited to the return type of a function. You cannot use void as a type annotation for a property.

-

-See also -

-
-undefined -
-
- - - - - -
Nullspecial type 
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

A special data type that represents the lack of a value. The Null data type includes only one value: null. The Null data type is special in that it is not associated with a class. This means that you cannot use the Null data type as a type annotation for a property.

-

-See also -

-
-null -
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:13 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/statements.html b/html-docs/statements.html deleted file mode 100644 index c1ce9aa..0000000 --- a/html-docs/statements.html +++ /dev/null @@ -1,2830 +0,0 @@ - - - - - - - -Statements, Keywords and Directives (ActionScript 3.0) - - - - - - - - - - - - - - - -
-
-

Statements are language elements that perform or specify an action at runtime. - For example, the return statement returns a result value for the function in which it executes. - The if statement evaluates a condition to determine the next action that should be taken. - The switch statement creates a branching structure for ActionScript statements. -

Attribute keywords alter the meaning of definitions, and can be applied to class, variable, function, and namespace definitions. - Definition keywords are used to define entities such as variables, functions, classes, and interfaces. - Primary expression keywords represent literal values. - For a list of reserved words, see Learning ActionScript 3.0.

-

Directives include statements and definitions and can - have an effect at compile time or runtime. Directives that are neither statements nor definitions are labeled as directives in the following table.

-

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 Statement summary
 breakAppears within a loop (for, for..in, for each..in, do..while, or while) or within a block of statements associated with a particular case within a switch statement.
 caseDefines a jump target for the switch statement.
 continueJumps past all remaining statements in the innermost loop and starts the next iteration of the loop as if control had passed through to the end of the loop normally.
 defaultDefines the default case for a switch statement.
 do..whileSimilar to a while loop, except that the statements are executed once before the initial evaluation of the condition.
 elseSpecifies the statements to run if the condition in the if statement returns false.
 forEvaluates the init (initialize) expression once and then starts a looping sequence.
 for..inIterates over the dynamic properties of an object or elements in an array and executes statement for each property or element.
 for each..inIterates over the items of a collection and executes statement for each item.
 ifEvaluates a condition to determine the next statement to execute.
 labelAssociates a statement with an identifier that can be referenced by break or continue.
 returnCauses execution to return immediately to the calling function.
 superInvokes the superclass or parent version of a method or constructor.
 switchCauses control to transfer to one of several statements, depending on the value of an expression.
 throwGenerates, or throws, an error that can be handled, or caught, by a catch code block.
 try..catch..finallyEncloses a block of code in which an error can occur, and then responds to the error.
 whileEvaluates a condition and if the condition evaluates to true, executes one or more statements before looping back to evaluate the condition again.
 withEstablishes a default object to be used for the execution of a statement or statements, potentially reducing the amount of code that needs to be written.
 Attribute keyword summary
 dynamicSpecifies that instances of a class may possess dynamic properties added at runtime.
 finalSpecifies that a method cannot be overridden or that a class cannot be extended.
 internalSpecifies that a class, variable, constant or function is available to any caller within the same package.
 nativeSpecifies that a function or method is implemented by Flash Player in native code.
 overrideSpecifies that a method replaces an inherited method.
 privateSpecifies that a variable, constant, method or namespace is available only to the class that defines it.
 protectedSpecifies that a variable, constant, method, or namespace is available only to the class that defines it and to any subclasses of that class.
 publicSpecifies that a class, variable, constant or method is available to any caller.
 staticSpecifies that a variable, constant, or method belongs to the class, rather than to instances of the class.
 Definition keyword summary
 ... (rest) parameterSpecifies that a function will accept any number of comma-delimited arguments.
 classDefines a class, which lets you instantiate objects that share methods and properties that you define.
 constSpecifies a constant, which is a variable that can be assigned a value only once.
 extendsDefines a class that is a subclass of another class.
 functionComprises a set of statements that you define to perform a certain task.
 getDefines a getter, which is a method that can be read like a property.
 implementsSpecifies that a class implements one or more interfaces.
 interfaceDefines an interface.
 namespaceAllows you to control the visibility of definitions.
 packageAllows you to organize your code into discrete groups that can be imported by other scripts.
 setDefines a setter, which is a method that appears in the public interface as a property.
 varSpecifies a variable.
 Directive summary
 default xml namespace - The default xml namespace directive sets the default namespace - to use for XML objects. -
 importMakes externally defined classes and packages available to your code.
 includeIncludes the contents of the specified file, as if the commands in the file are part of the calling script.
 use namespaceCauses the specified namespaces to be added to the set of open namespaces.
 Namespace summary
 AS3Defines methods and properties of the core ActionScript classes that are fixed properties instead of prototype properties.
 flash_proxyDefines methods of the Proxy class.
 object_proxyDefines methods of the ObjectProxy class.
 Primary expression keyword summary
 falseA Boolean value representing false.
 nullA special value that can be assigned to variables or returned by a function if no data was provided.
 thisA reference to a method's containing object.
 trueA Boolean value representing true.
-
Statement, Keyword & Directive detail
- - - - - -
... (rest) parameterdefinition keyword
-
-Usage - - - - -
function functionName(parameter0, parameter1, ...rest){ 
-	// statement(s) 
-}
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a function will accept any number of comma-delimited arguments. The list of arguments becomes an array that is available throughout the function body. The name of the array is specified after the ... characters in the parameter declaration. The parameter can have any name that is not a reserved word. -

If used with other parameters, the ... (rest) parameter declaration must be the last parameter specified. The ... (rest) parameter array is populated only if the number of arguments passed to the function exceeds the number of other parameters.

-

Each argument in the comma-delimited list of arguments is placed into an element of the array. If you pass an instance of the Array class, the entire array is placed into a single element of the ... (rest) parameter array.

-

Use of this parameter makes the arguments object unavailable. Although the ... (rest) parameter gives you the same functionality as the arguments array and arguments.length property, it does not provide functionality similar to that provided by arguments.callee. Make sure you do not need to use arguments.callee before using the ... (rest) parameter.

-

-Parameters - - - - -
rest:* — - An identifier that represents the name of the array of arguments passed in to the function. The parameter does not need to be called rest; it can have any name that is not a keyword. You can specify the data type of the ... (rest) parameter as Array, but this could cause confusion because the parameter accepts a comma-delimited list of values, which is not identical to an instance of the Array class. -
-
-Example -

-

-See also -

-
-arguments object -
-
- - - - - -
AS3namespace 
-
-

Defines methods and properties of the core ActionScript classes that are fixed properties instead of prototype properties. When you set the "-as3" compiler option to true (which is the default setting in Flex Builder 2), the AS3 namespace is automatically opened for all the core classes. This means that an instance of a core class will use fixed properties and methods instead of the versions of those same properties and methods that are attached to the class's prototype object. The use of fixed properties usually provides better performance, but at the cost of backward compatibility with the ECMAScript edition 3 language specification (ECMA-262).

-

-See also -

-
-Object class -
-
- - - - - -
breakstatement 
-
-Usage - - - - -

break [label]

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Appears within a loop (for, for..in, for each..in, do..while, or while) or within a block of statements associated with a particular case in a switch statement. When used in a loop, the break statement instructs Flash to skip the rest of the loop body, stop the looping action, and execute the statement following the loop statement. When used in a switch, the break statement instructs Flash to skip the rest of the statements in that case block and jump to the first statement that follows the enclosing switch statement. -

In nested loops, break only skips the rest of the immediate loop and does not break out of the entire series of nested loops. To break out of an entire series of nested loops, use label or try..catch..finally.

-

The break statement can have an optional label that must match an outer labeled statement. Use of a label that does not match the label of an outer statement is a syntax error. Labeled break statements can be used to break out of multiple levels of nested loop statements, switch statements, or block statements. For an example, see the entry for the label statement.

-

-

-Parameters - - - - -
label:* — - The name of a label associated with a statement. -
-
-Example -

-

-See also -

-
-do..while -
-for -
-for..in -
-for each..in -
-label -
-while -
-
- - - - - -
casestatement 
-
-Usage - - - - -
case jumpTarget: statements
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Defines a jump target for the switch statement. If the jumpTarget parameter equals the expression parameter of the switch statement using strict equality (===), Flash Player executes the statements in the statements parameter until it encounters a break statement or the end of the switch statement.

If you use the case statement outside a switch statement, it produces an error and the script doesn't compile.

-

Note: Always end the statements parameter with a break statement. If you omit the break statement from the statements parameter, it continues executing with the next case statement instead of exiting the switch statement.

-

-

-Parameters - - - - - - - -
jumpTarget:* — - Any expression. -
statements:* — - Statements to execute if jumpTarget matches the conditional expression in the switch statement. -
-
-Example -

-

-See also -

-
-break -
-switch -
-
- - - - - -
classdefinition keyword 
-
-Usage - - - - -
[dynamic] [public | internal] [final] class className [ extends superClass ] [ implements interfaceName[, interfaceName... ] ] { 
-	// class definition here
-}
 -
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Defines a class, which lets you instantiate objects that share methods and properties that you define. For example, if you are developing an invoice-tracking system, you could create an Invoice class that defines all the methods and properties that each invoice should have. You would then use the new Invoice() command to create Invoice objects. -

Each ActionScript source file can contain only one class that is visible to other source files or scripts. The externally visible class can be a public or internal class, and must be defined inside a package statement. - If you include other classes in the same file, the classes must be placed outside of the package statement and at the end of the file.

-

The name of the externally visible class must match the name of the ActionScript source file that contains the class. The name of the source file must be the name of the class with the file extension .as appended. For example, if you name a class Student, the file that defines the class must be named Student.as.

-

You cannot nest class definitions; that is, you cannot define additional classes within a class definition.

-

You can define a constructor method, which is a method that is executed whenever a new instance of the class is created. The name of the constructor method must match the name of the class. - If you do not define a constructor method, a default constructor is created for you.

-

To indicate that objects can add and access dynamic properties at runtime, precede the class statement with the dynamic keyword. To declare that a class implements an interface, use the implements keyword. To create subclasses of a class, use the extends keyword. (A class can extend only one class, but can implement several interfaces.) You can use implements and extends in a single statement. The following examples show typical uses of the implements and extends keywords:

-
class C implements Interface_i, Interface_j // OK 
-class C extends Class_d implements Interface_i, Interface_j // OK 
-class C extends Class_d, Class_e // not OK
- -

-

-Parameters - - - - -
className:Class — - The fully qualified name of the class. -
-
-Example -

-

-See also -

-
-dynamic -
-extends -
-final -
-internal -
-public -
-
- - - - - -
constdefinition keyword 
-
-Usage - - - - -
const identifier = value
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies a constant, which is a variable that can be assigned a value only once. -

You can strictly type a constant by appending a colon (:) character followed by the data type.

-

-

-Parameters - - - - -
identifier:* — - An identifier for the constant. -
-
-Example -

-

-See also -

-
-var -
-
- - - - - -
continuestatement 
-
-Usage - - - - -
continue [label]
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Jumps past all remaining statements in the innermost loop and starts the next iteration of the loop as if control had passed to the end of the loop normally. The continue statement has no effect outside a loop. - In nested loops, use the optional label parameter to skip more than just the innermost loop. -

The continue statement can have an optional label that must match an outer labeled statement. Use of a label that does not match the label of an outer statement is a syntax error. Labeled continue statements can be used to skip multiple levels of nested loop statements.

-

-
-Example -

-

-See also -

-
-do..while -
-for -
-for..in -
-for each..in -
-label -
-while -
-
- - - - - -
defaultstatement 
-
-Usage - - - - -
default: statements
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Defines the default case for a switch statement. The statements execute if the expression parameter of the switch statement doesn't equal (using the strict equality [===] operation) any of the expression parameters that follow the case keywords for a given switch statement. -

A switch statement does not require a default case statement. A default case statement does not have to be last in the list. If you use a default statement outside a switch statement, it produces an error and the script doesn't compile.

-

-Parameters - - - - -
statements:* — - Any statements. -
-
-Example -

-

-See also -

-
-switch -
-
- - - - - -
default xml namespacedirective 
-
-Usage - - - - -

default xml namespace = ns

-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

- The default xml namespace directive sets the default namespace - to use for XML objects. - -

If you do not set default xml namespace, the default namespace is - the unnamed namespace (with the URI set to an empty string). The scope of a - default xml namespace declaration is within a function block, like - the scope of a variable. -

- -

-
-Example -

-

-See also -

-
-namespace -
-Namespace Class -
-use namespace -
-XML -
-
- - - - - -
do..whilestatement 
-
-Usage - - - - -
do { statement(s) } while (condition)
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Similar to a while loop, except that the statements are executed once before the initial evaluation of the condition. Subsequently, the statements are executed only if the condition evaluates to true.

A do..while loop ensures that the code inside the loop executes at least once. Although you can also do this with a while loop by placing a copy of the statements to be executed before the while loop begins, many programmers believe that do..while loops are easier to read.

-

If the condition always evaluates to true, the do..while loop is infinite. If you enter an infinite loop, you encounter problems with Flash Player and eventually get a warning message or crash the player. Whenever possible, use a for loop if you know the number of times you want to loop. Although for loops are easy to read and debug, they cannot replace do..while loops in all circumstances.

-

-Parameters - - - - -
condition:Boolean — - The condition to evaluate. The statement(s) within the do block of code will execute as long as the condition parameter evaluates to true . -
-
-Example -

-

-See also -

-
-break -
-continue -
-while -
-
- - - - - -
dynamicattribute keyword 
-
-Usage - - - - -
dynamic class className { // class definition here }
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that instances of a class may possess dynamic properties added at runtime. If you use the dynamic attribute on a class, you can add properties to instances of that class at runtime. Classes that are not marked as dynamic are considered sealed, which means that properties cannot be added to instances of the class. -

If a class is sealed (not dynamic), attempts to get or set properties on class instances result in an error. If you have your compiler set to strict mode and you specify the data type when you create instances, attempts to add properties to sealed objects generate a compiler error; otherwise, a runtime error occurs.

-

The dynamic attribute is not inherited by subclasses. If you extend a dynamic class, the subclass is dynamic only if you declare the subclass with the dynamic attribute.

-

Note: This keyword is supported only when used in external script files, not in scripts written in the Actions panel.

 -

-
-Example -

-

-See also -

-
-class -
-
- - - - - -
elsestatement 
-
-Usage - - - - -
if (condition) { 
-	// statement(s)
-} 
-else {
-	// statement(s)
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies the statements to run if the condition in the if statement returns false. The curly braces ({}) that enclose the statements to be executed by the else statement are not necessary if only one statement will execute.

-

-Parameters - - - - -
condition:Boolean — - An expression that evaluates to true or false. -
-
-Example -

-

-See also -

-
-if -
-
- - - - - -
extendsdefinition keyword 
-
-Usage - - - - -
class className extends otherClassName {}
-interface interfaceName extends otherInterfaceName {}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Defines a class that is a subclass of another class. The subclass inherits all the methods, properties, functions, and so on that are defined in the superclass. Classes that are marked as final cannot be extended. -

You can also use the extends keyword to extend an interface. An interface that extends another interface includes all the original interface's method declarations.

-

Note: To use this keyword, you must specify ActionScript 2.0 and Flash Player 6 or later in the Flash tab of your FLA file's Publish Settings dialog box. This keyword is supported only when used in external script files, not in scripts written in the Actions panel.

 -

-

-Parameters - - - - -
className:Class — - The name of the class you are defining. -
-
-Example -

-

-See also -

-
-class -
-final -
-interface -
-
- - - - - -
falseprimary expression keyword 
-
-Usage - - - - -
false
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

A Boolean value representing false. A Boolean value is either true or false; the opposite of false is true. -

When automatic data typing converts false to a number, it becomes 0; when it converts false to a string, it becomes "false".

-

Note: The string "false" converts to the Boolean value true.

-

-
-Example -

-

-See also -

-
-Boolean class -
-true -
-
- - - - - -
finalattribute keyword 
-
-Usage - - - - -
-final function methodName() { 
-	// your statements here 
-}
-final class className {}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a method cannot be overridden or that a class cannot be extended. An attempt to override a method, or extend a class, marked as final results in an error.

-

-Parameters - - - - - - - -
methodName:Function — - The name of the method that cannot be overridden. -
className:Class — - The name of the class that cannot be extended. -
-

-See also -

-
-override -
-extends -
-
- - - - - -
flash_proxynamespace 
-
-

Defines methods of the Proxy class. The Proxy class methods are in their own namespace to avoid name conflicts in situations where your Proxy subclass contains instance method names that match any of the Proxy class method names.

-

-See also -

-
-Proxy class -
-
- - - - - -
forstatement 
-
-Usage - - - - -
for ([init]; [condition]; [next]) { 
-	// statement(s)
-}
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates the init (initialize) expression once and then starts a looping sequence. The looping sequence begins by evaluating the condition expression. If the condition expression evaluates to true, statement is executed and next is evaluated. The looping sequence then begins again with the evaluation of the condition expression. -

The curly braces ({}) that enclose the block of statements to be executed by the for statement are not necessary if only one statement will execute.

-

-Parameters - - - - - - - - - - -
init — - An optional expression to evaluate before beginning the looping sequence; usually an assignment expression. A var statement is also permitted for this parameter. -
condition — - An optional expression to evaluate before beginning the looping sequence; usually a comparison expression. If the expression evaluates to true, the statements associated with the for statement are executed. -
next — - An optional expression to evaluate after the looping sequence; usually an increment or decrement expression. -
-
-Example -

-

-See also -

-
-++ (increment) -
-
- - - - - -
for..instatement 
-
-Usage - - - - -
-
for (variableIterant:String in object){ 
-	// statement(s)
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Iterates over the dynamic properties of an object or elements in an array and executes statement for each property or element. Object properties are not kept in any particular order, so properties may appear in a seemingly random order. - Fixed properties, such as variables and methods defined in a class, are not enumerated by the for..in statement. - To get a list of fixed properties, use the describeType() function, which is in the flash.utils package. - - -

-

-Parameters - - - - -
variableIterant:String — - The name of a variable to act as the iterant, referencing each property of an object or element in an array. -
-
-Example -

-

-See also -

-
-describeType() -
-
- - - - - -
for each..instatement 
-
-Usage - - - - -
for each (variableIterant in object){ 
-	// statement(s)
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Iterates over the items of a collection and executes statement for each item. Introduced as a part of the E4X language extensions, the for each..in statement can be used not only for XML objects, but also for objects and arrays. - The for each..in statement iterates only through the dynamic properties of an object, not the fixed properties. A fixed property is a property that is defined as part of a class definition. To use the for each..in statement with an instance of a user-defined class, you must declare the class with the dynamic attribute. -

Unlike the for..in statement, the for each..in statement iterates over the values of an object's properties, rather than the property names.

-

-

-Parameters - - - - - - - -
variableIterant:* — - The name of a variable to act as the iterant, referencing the item in a collection. -
object:Object — - The name of a collection over which to iterate. The collection can be an XML object, a generic object, or an array. -
-
-Example -

-
- - - - - -
functiondefinition keyword 
-
-Usage - - - - -
function functionName([parameter0, parameter1,...parameterN]) : returnType{ 
-	// statement(s) 
-} 
-var functionName:Function = function ([parameter0, parameter1,...parameterN]) : returnType{ 
-	// statement(s) 
-}
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Comprises a set of statements that you define to perform a certain task. You can define a function in one location and invoke, or call, it from different scripts in a SWF file. When you define a function, you can also specify parameters for the function. Parameters are placeholders for values on which the function operates. You can pass different parameters to a function each time you call it so you can reuse the function in different situations. -

Use the return statement in a function's statement(s) block to cause a function to generate, or return, a value.

-

Usage 1: You can use the function keyword to define a function with the specified function name, parameters, and statements. When a script calls a function, the statements in the function's definition are executed. Forward referencing is permitted; within the same script, a function may be declared after it is called. A function definition replaces any prior definition of the same function. You can use this syntax wherever a statement is permitted.

-

Usage 2: You can also use function to create an anonymous function and return a reference to it. This syntax is used in expressions and is particularly useful for installing methods in objects.

-

For additional functionality, you can use the arguments object in your function definition. The arguments object is commonly used to create a function that accepts a variable number of parameters and to create a recursive anonymous function.

-

-Parameters - - - - - - - -
functionName:Function — - The name of the new function. -
returnType:* — - The data type of the return value. -
-
-Example -

-

-See also -

-
-arguments object -
-return -
-
- - - - - -
getdefinition keyword 
-
-Usage - - - - -
-function get property() : returnType{ 
-	// your statements here 
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Defines a getter, which is a method that can be read like a property. - A getter is a special function that returns the value of a property declared with the var or const keyword. - Unlike other methods, a getter is called without parentheses (()), which makes the getter appear to be a variable. -

Getters allow you to apply the principle of information hiding by letting you create a public interface for a private property. - The advantage of information hiding is that the public interface remains the same even if the underlying implementation of the private property changes.

-

Another advantage of getters is that they can be overridden in subclasses, whereas properties declared with var or const cannot.

-

A getter can be combined with a setter to create a read-write property. To create a read-only property, create a getter without a corresponding setter. To create a write-only property, create a setter without a corresponding getter.

-

Note: To use this keyword, you must specify ActionScript 2.0 and Flash Player 6 or later in the Flash tab of your FLA file's Publish Settings dialog box. This keyword is supported only when used in external script files, not in scripts written in the Actions panel.

 -

-

-Parameters - - - - - - - -
property:* — - The identifier for the property that get accesses; this value must be the same as the value used in the corresponding set command. -
returnType:* — - The data type of the return value. -
-
-Example -

-

-See also -

-
-set -
-
- - - - - -
ifstatement 
-
-Usage - - - - -
if (condition) {
-	// statement(s)
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates a condition to determine the next statement to execute. If the condition is - true, Flash Player runs the statements that follow the condition inside curly braces ({}). If the condition is false, Flash Player skips the statements inside the curly braces and runs the statements following the curly braces. Use the if statement along with the else statement to create branching logic in your scripts. -

The curly braces ({}) that enclose the statements to be executed by the if statement are not necessary if only one statement will execute.

-

-

-Parameters - - - - -
condition:Boolean — - An expression that evaluates to true or false. -
-

-See also -

-
-else -
-
- - - - - -
implementsdefinition keyword 
-
-Usage - - - - -
myClass implements interface01 [, interface02 , ...]
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a class implements one or more interfaces. When a class implements an interface, the class must define all the methods declared in the interface. - Any instance of a class that implements an interface is considered a member of the data type defined by the interface. As a result, the is operator returns true when the class instance is the first operand and the interface is the second; in addition, type coercions to and from the data type defined by the interface work. -

Note: To use this keyword, you must specify ActionScript 2.0 and Flash Player 6 or later in the Flash tab of your FLA file's Publish Settings dialog box. This keyword is supported only when used in external script files, not in scripts written in the Actions panel.

-

-

-See also -

-
-class -
-interface -
-
- - - - - -
importdirective 
-
-Usage - - - - -
-
import packageName.className 
-import packageName.*
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Makes externally defined classes and packages available to your code. - For example, if you want to use the flash.display.Sprite class in a script, you must import it. - This requirement is different from previous versions of ActionScript, in which the import directive was optional. -

After using the import directive, you can use the full class name, - which includes the package name, or just the name of the class.

-
 
-import flash.display.Sprite; 
-
-// name of class only
-var mySprite:Sprite = new Sprite();
-
-// full class name
-var mySprite:flash.display.Sprite = new flash.display.Sprite();
-
-

If there are several classes in the package that you want to access, you can import them all in a single statement, as shown in the following example:

-
import flash.display.*;
-

The import directive imports only the classes, functions, and variables that reside at the top level of the imported package. Nested packages must be explicitly imported.

-

If you import a class but do not use it in your script, the class is not exported as part of the SWF file. This means you can import large packages without being concerned about the size of the SWF file; the bytecode associated with a class is included in a SWF file only if that class is actually used. -One disadvantage of importing classes that you do not need is that you increase the likelihood of name collisions.

-

The import directive applies to the whole timeline in which it's -called. For example, suppose on Frame 1 of a Flash document you import all the classes in the adobe.example package. On that frame, or any subsequent frames in the timeline, you can reference classes in that package by their simple names:

-
-// On Frame 1 of a FLA: 
-import adobe.example.*; 
-var myFoo:foo = new foo();
- - -

-

-Parameters - - - - - - - -
packageName:* — - The name of a package you have defined in a separate class file. -
className:Class — - The name of a class you have defined in a separate class file. -
-
- - - - - -
includedirective 
-
-Usage - - - - -
include "[path]filename.as"
-

Includes the contents of the specified file, as if the commands in the file are part of the calling script. - The include directive is invoked at compile time. Therefore, if you make any changes to an included file, you must save the file and recompile any SWF files that use it. - -

-
- - - - - -
interfacedefinition keyword 
-
-Usage - - - - -
 interface InterfaceName [extends InterfaceName ] {}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Defines an interface. Interfaces are data types that define a set of methods; the methods must be defined by any class that implements the interface. -

An interface is similar to a class, with the following important differences:

-
    -
  • Interfaces contain only declarations of methods, not their implementation. That is, every class that implements an interface must provide an implementation for each method declared in the interface.
    • -
  • Interface method definitions cannot have any attribute such as public or private, but implemented methods must be marked as public in the definition of the class that implements the interface.
    • -
  • Multiple interfaces can be inherited by an interface by means of the extends statement, or by a class through the implements statement.
    • -
-

Unlike ActionScript 2.0, ActionScript 3.0 allows the use of getter and setter methods in interface definitions.

-

Note: To use this keyword, you must specify ActionScript 2.0 and Flash Player 6 or later in the Flash tab of your FLA file's Publish Settings dialog box. This keyword is supported only when used in external script files, not in scripts written in the Actions panel.

 - -

-

-See also -

-
-class -
-implements -
-
- - - - - -
internalattribute keyword 
-
-Usage - - - - -
-[internal] var varName
-[internal] const kName
-[internal] function functionName()  { 
-	// your statements here 
-}
-[internal] class className{
-	// your statements here 
-}
-[internal] namespace nsName
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a class, variable, constant, or function is available to any caller within the same package. Classes, properties, and methods belong to the internal namespace by default.

-

-Parameters - - - - - - - - - - - - - - - - -
className:Class — - The name of the class that you want to specify as internal. -
varName:* — - The name of the variable that you want to specify as internal. You can apply the internal attribute whether the variable is part of a class or not. -
kName:* — - The name of the constant that you want to specify as internal. You can apply the internal attribute whether the constant is part of a class or not. -
functionName:Function — - The name of the function or method that you want to specify as internal. You can apply the internal attribute whether the function is part of a class or not. -
nsName:Namespace — - The name of the namespace that you want to specify as internal. You can apply the internal attribute whether the namespace is part of a class or not. -
-

-See also -

-
-package -
-private -
-protected -
-public -
-
- - - - - -
labelstatement 
-
-Usage - - - - -
label: statement
-label: {
-    statements
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Associates a statement with an identifier that can be referenced by break or continue. - In nested loops, a break or continue statement - that does not reference a label can skip only the rest of the immediate - loop and does not skip the entire series of loops. - However, if the statement that defines the entire series of loops has an - associated label, a break or continue statement - can skip the entire series of loops by referring to that label. -

Labels also allow you to break out of a block statement. You cannot - place a break statement that does not reference a label - inside a block statement unless the block statement is part of a loop. - If the block statement has an associated label, you can place a - break statement that refers to that label inside the block statement.

-

-

-Parameters - - - - - - - -
label:* — - A valid identifier to associate with a statement. -
statements:* — - Statement to associate with the label. -
-
-Example -

-

-See also -

-
-break -
-continue -
-
- - - - - -
namespacedefinition keyword 
-
-Usage - - - - -
namespace name [= uri]
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Allows you to control the visibility of definitions. Predefined namespaces include public, private, protected, and internal. -

The following steps show how to create, apply, and reference a namespace:

-
    -
  • First, define the custom namespace using the namespace keyword. For example, the code namespace version1 creates a namespace called version1.
    • -
  • Second, apply the namespace to a property or method by using your custom namespace in the property or method declaration. For example, the code version1 myProperty:String creates a property named myProperty that belongs to the version1 namespace
    • -
  • Third, reference the namespace by using the use keyword or by prefixing an identifier with the namespace. For example, the code use namespace version1; references the version1 namespace for subsequent lines of code, and the code version1::myProperty references the version1 namespace for the myProperty property.
    • -
-

-

-Parameters - - - - - - - -
name:Namespace — - The name of the namespace, which can be any legal identifier. -
uri:String — - The Uniform Resource Identifier (URI) of the namespace. This is an optional parameter. -
-

-See also -

-
-class -
-internal -
-package -
-private -
-protected -
-public -
-
- - - - - -
nativeattribute keyword 
-
-Usage - - - - -
-native function functionName();
-class className { 
-	native function methodName();
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a function or method is implemented by Flash Player in native code. Flash Player uses the native keyword internally to declare functions and methods in the ActionScript application programming interface (API). This keyword cannot be used in your own code. -  

-
- - - - - -
nullprimary expression keyword 
-
-Usage - - - - -
null
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

A special value that can be assigned to variables or returned by a function if no data was provided. You can use null to represent values that are missing or that do not have a defined data type. -

The value null should not be confused with the special value undefined. When null and undefined are compared with the equality (==) operator, they compare as equal. However, when null and undefined are compared with the strict equality (===) operator, they compare as not equal.

-

-
-Example -

-

-See also -

-
-undefined -
-
- - - - - -
object_proxynamespace 
-
-

Defines methods of the ObjectProxy class. The ObjectProxy class methods are in their own namespace to avoid name conflicts in situations where a Proxy subclass contains instance method names that match any of the Proxy class method names.

-
- - - - - -
overrideattribute keyword 
-
-Usage - - - - -
-override function name() { 
-	// your statements here 
-}
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a method replaces an inherited method. To override an inherited method, you must use the override attribute and ensure that the name, class property attribute, number and type of parameters, and the return type match exactly. It is an error to attempt to override a method without using the override attribute. Likewise, it is an error to use the override attribute if the method does not have a matching inherited method. -

You cannot use the override attribute on any of the following:

-
    -
  • Variables
    • -
  • Constants
    • -
  • Static methods
    • -
  • Methods that are not inherited
    • -
  • Methods that implement an interface method
    • -
  • Inherited methods that are marked as final in the superclass
    • -
-

Although you cannot override a property declared with var or const, you can achieve similar functionality by making the base class property a getter-setter and overriding the methods defined with get and set.

-

-

-Parameters - - - - -
name:Function — - The name of the method to override. -
-

-See also -

-
-final -
-get -
-set -
-
- - - - - -
packagedefinition keyword 
-
-Usage - - - - -
-package packageName {
-    class someClassName { 
-    } 
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Allows you to organize your code into discrete groups that can be imported by other scripts. You must use the package keyword to indicate that a class is a member of a package.

-

-Parameters - - - - -
packageName:* — - The name of the package. -
-

-See also -

-
-internal -
-public -
-class -
-
- - - - - -
privateattribute keyword 
-
-Usage - - - - -
-class className{ 
-	private var varName;
-	private const kName;
-	private function methodName() { 
-		// your statements here 
-	}
-	private namespace nsName;
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a variable, constant, or method is available only to the class that declares or defines it. Unlike in ActionScript 2.0, in ActionScript 3.0 private no longer provides access to subclasses. Moreover, private restricts access at both compile time and runtime. By default, a variable or function is available to any caller in the same package. Use this keyword if you want to restrict access to a variable or function. -

You can use this keyword only in class definitions, not in interface definitions. You cannot apply private to a class or to any other package-level definitions.

-

-Parameters - - - - - - - - - - - - - -
varName:* — - The name of the variable that you want to specify as private. You can apply the private attribute only if the variable is inside a class. -
kName:* — - The name of the constant that you want to specify as private. You can apply the private attribute only if the constant is inside a class. -
methodName:Function — - The name of the method that you want to specify as private. You can apply the private attribute only if the method is inside a class. -
nsName:Namespace — - The name of the namespace that you want to specify as private. You can apply the private attribute only if the namespace is inside a class. -
-
-Example -

-

-See also -

-
-internal -
-protected -
-public -
-
- - - - - -
protectedattribute keyword 
-
-Usage - - - - -
-class className{ 
-	protected var varName;
-	protected const kName;
-	protected function methodName() { 
-		// your statements here 
-	}
-	protected namespace nsName;
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a variable, constant, method, or namespace is available only to the class that defines it and to any subclasses of that class. The definition of protected in ActionScript 3.0 is similar to the definition of the ActionScript 2.0 version of private, except that protected restricts access at both compile time and runtime. By default, a variable or function is available to any caller within the same package. Use this keyword if you want to restrict access to a variable or function. -

You can use this keyword only in class definitions, not in interface definitions. You cannot apply private to a class, or to any other package-level definitions.

-

The definition of protected in ActionScript 3.0 is more restrictive than that of protected in the Java programming language. In ActionScript 3.0 protected limits access strictly to subclasses, whereas in Java protected also allows access to any class in the same package. For example, if a class named Base contains a property marked as protected, in ActionScript 3.0 only classes that extend Base can access the protected property. In Java, any class in the same package as Base has access to the protected property even if the class is not a subclass of Base.

-

-

-Parameters - - - - - - - - - - - - - -
varName:* — - The name of the variable that you want to specify as protected. You can apply the protected attribute only if the variable is inside a class. -
kName:* — - The name of the constant that you want to specify as protected. You can apply the protected attribute only if the constant is inside a class. -
methodName:Function — - The name of the method that you want to specify as protected. You can apply the protected attribute only if the method is inside a class. -
nsName:Namespace — - The name of the namespace that you want to specify as protected. You can apply the protected attribute only if the namespace is inside a class. -
-
-Example -

-

-See also -

-
-internal -
-private -
-public -
-
- - - - - -
publicattribute keyword 
-
-Usage - - - - -
-public var varName
-public const kName
-public function functionName()  { 
-	// your statements here 
-}
-public class className {
-	// your statements here 
-}
-public namespace nsName
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a class, variable, constant, or method is available to any caller. Classes, variables, and methods are internal by default, which means that they are visible only within the current package. To make a class, variable, or method visible to all callers, you must use the public attribute.

-

-Parameters - - - - - - - - - - - - - - - - -
className:Class — - The name of the class that you want to specify as public. -
varName:* — - The name of the variable that you want to specify as public. You can apply the public attribute whether the variable is part of a class or not. -
kName:* — - The name of the constant that you want to specify as public. You can apply the public attribute whether the constant is part of a class or not. -
functionName:Function — - The name of the function or method that you want to specify as public. You can apply the public attribute whether the function is part of a class or not. -
nsName:Namespace — - The name of the namespace that you want to specify as public. You can apply the public attribute whether the namespace is part of a class or not. -
-
-Example -

-

-See also -

-
-class -
-internal -
-private -
-protected -
-
- - - - - -
returnstatement 
-
-Usage - - - - -
-function functionName () {
-	return [expression]
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Causes execution to return immediately to the calling function. If the return statement is followed by an expression, the expression is evaluated and the result is returned. -

If a function definition includes a return type, the return statement must be followed by an expression. If no return type is specified and the return statement is used alone, it returns undefined.

-

You cannot return multiple values. If you try to do so, only the last value is returned. In the following example, c is returned:

return a, b, c ;

If you need to return multiple values, use an array or object instead.

-

-Parameters - - - - -
expression:* — - An expression to evaluate and return as a value of the function. This parameter is optional. -
-

-Result - - - - -
* — The evaluated expression parameter, if provided.
-
-Example -

-

-See also -

-
-function -
-
- - - - - -
setdefinition keyword 
-
-Usage - - - - -
-function set property(newValue:*) : void{ 
-	// your statements here 
-}
-
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Defines a setter, which is a method that appears in the public interface as a property. - A setter is a special method that sets the value of a property declared with the var keyword. - Unlike other methods, a setter is called without parentheses (()), which makes the setter appear to be a variable. -

Setters allow you to apply the principle of information hiding by letting you create a public interface for a private property. - The advantage of information hiding is that the public interface remains the same even if the underlying implementation of the private property changes.

-

Another advantage of setters is that they can be overridden in subclasses, whereas properties declared with var cannot.

-

The return type of a setter must be either void or not specified.

-

A setter can be combined with a getter to create a read-write property. To create a read-only property, create a getter without a corresponding setter. To create a write-only property, create a setter without a corresponding getter.

-

Note: This keyword is supported only when used in external script files, not in scripts written in the Actions panel.

 -

-

-Parameters - - - - - - - -
property:* — - The identifier for the property that set modifies; this value must be the same as the value used in the corresponding get command. -
newValue:* — - The new value to assign. -
-
-Example -

-

-See also -

-
-get -
-
- - - - - -
staticattribute keyword 
-
-Usage - - - - -
-
class someClassName{ 
-	static var varName; 
-	static const kName;
-	static function methodName() { 
-		// your statements here
-	} 
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies that a variable, constant, or method belongs to the class, rather than to instances of the class. -

To access a static class member, use the name of the class instead of the name of an instance. For example, the Date class has a static method named parse(), which can only be called using the following syntax:

- 
Date.parse()
-

The parse() method cannot be called on an instance of the Date class. For example, the following code generates an error:

- 
var myDate:Date = new Date();
-			myDate.parse("Jan 01 00:00:00 2006"); // error
-

You can use static in class definitions only, not in interface definitions.

-

Static class members are not inherited. You cannot refer to a static class member using the name of a subclass, as you can in Java or C++. You can, however, refer to a static variable or method within a class or subclass, without using any qualifier. See the example below.

-

You cannot use the super statement or the this keyword inside a static method.

-

Note: This keyword is supported only when used in external script files, not in scripts written in the Actions panel.

 -

-

-Parameters - - - - - - - - - - -
varName:* — - The name of the variable that you want to specify as static. -
kName:* — - The name of the constant that you want to specify as static. -
methodName:Function — - The name of the method that you want to specify as static. -
-
-Example -

-
- - - - - -
superstatement 
-
-Usage - - - - -
super([arg1, ..., argN])
-super.method([arg1, ..., argN])
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Invokes the superclass or parent version of a method or constructor. When used within the body of a class constructor, the super() statement invokes the superclass version of the constructor. The call to the superclass constructor must have the correct number of arguments. Note that the superclass constructor is always called, whether or not you call it explicitly. If you do not explicitly call it, a call with no arguments is automatically inserted before the first statement in the subclass constructor body. This means that if you define a constructor function in a subclass, and the superclass constructor takes one or more arguments, you must explicitly call the superclass constructor with the correct number of arguments or an error will occur. The call to the superclass constructor, however, does not need to be the first statement in your subclass constructor, as was required in ActionScript 2.0. -

When used in the body of an instance method, super can be used with the dot (.) operator to invoke the superclass version of a method and can optionally pass arguments (arg1 ... argN) to the superclass method. This is useful for creating subclass methods that not only add additional behavior to superclass methods, but also invoke the superclass methods to perform their original behavior.

-

You cannot use the super statement in a static method.

-

-Parameters - - - - - - - -
method:Function — - The method to invoke in the superclass. -
argN:* — - Optional parameters that are passed to the superclass version of the method or to the constructor function of the superclass. -
-

-See also -

-
-class -
-extends -
-
- - - - - -
switchstatement 
-
-Usage - - - - -
-
-switch (expression) {
-	caseClause: 
-	[defaultClause:] 
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Causes control to transfer to one of several statements, depending on the value of an expression. All switch statements should include a default case that will execute if none of the case statements match the expression. Each case statement should end with a break statement, which prevents a fall-through error. When a case falls through, it executes the code in the next case statement, even though that case may not match the test expression.

-

-Parameters - - - - -
expression:* — - Any expression. -
-
-Example -

-

-See also -

-
-=== (strict equality) -
-case -
-default -
-
- - - - - -
thisprimary expression keyword 
-
-Usage - - - - -
this
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

A reference to a method's containing object. When a script executes, the this keyword references the object that contains the script. Inside a method body, the this keyword references the class instance that contains the called method.

-
-Example -

-
- - - - - -
throwstatement 
-
-Usage - - - - -
throw expression
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Generates, or throws, an error that can be handled, or caught, by a catch code block. If an exception is not caught by a catch block, the string representation of the thrown value is sent to the Output panel. If an exception is not caught by a catch or finally block, the string representation of the thrown value is sent to the log file.

Typically, you throw instances of the Error class or its subclasses (see the Example section).

-

-Parameters - - - - -
expression:* — - An ActionScript expression or object. -
-
-Example -

-

-See also -

-
-Error class -
-try..catch..finally -
-
- - - - - -
trueprimary expression keyword 
-
-Usage - - - - -
true
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

A Boolean value representing true. A Boolean value is either true or false; the opposite of true is false. When automatic data typing converts true to a number, it becomes 1; when it converts true to a string, it becomes "true". -

-
-Example -

-

-See also -

-
-Boolean class -
-false -
-
- - - - - -
try..catch..finallystatement 
-
-Usage - - - - -
try { 
-    // try block 
-} finally { 
-    // finally block  
-} 
-
-try { 
-    // try block 
-} catch(error[:ErrorType1]) {
-    // catch block 
-} [catch(error[:ErrorTypeN]) { 
-    // catch block 
-}] [finally {
-    // finally block 
-}]
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Encloses a block of code in which an error can occur, and then responds to the error. - Exception handling, which is implemented using the try..catch..finally statements, - is the primary mechanism for handling runtime error conditions in ActionScript 3.0. - When a runtime error occurs, Flash Player throws an exception, which means that Flash Player suspends normal execution - and creates a special object of type Error. - Flash Player then passes, or throws, the error object - to the first available catch block. If no catch blocks are available, the exception is - considered to be an uncaught exception. Uncaught exceptions cause the script to terminate. -

You can use the throw statement to explicitly throw exceptions in your code. You can throw any value, but - the best practice is to throw an object because it provides flexibility and matches the behavior of Flash Player.

-

To catch an exception, whether it is thrown by Flash Player or by your own code, place the code that may throw - the exception in a try block. If any code in the try block throws an exception, - control passes to the catch block, if one exists, and then to the finally block, if one exists. - The finally block always executes, regardless of whether an exception was thrown. - If code within the try block does not throw an exception (that is, if the try block completes normally), - the code in the catch block is ignored, but the code in the finally block is still executed. - The finally block executes even if the try block exits using a return statement.

-

A try block must be followed by a catch block, a finally block, or both. - A single try block can have multiple catch blocks but only one finally block. - You can nest try blocks as many levels deep as desired.

-

The error parameter specified in a catch handler must be a simple identifier - such as e or theException or x. The parameter can also be typed. - When used with multiple catch blocks, typed parameters let you catch multiple types of error objects thrown - from a single try block.

-

If the exception thrown is an object, the type will match if the thrown object is a subclass of the specified type. - If an error of a specific type is thrown, the catch block that handles the corresponding error is executed. - If an exception that is not of the specified type is thrown, the catch block does not execute and the exception - is automatically thrown out of the try block to a catch handler that matches it.

-

If an error is thrown within a function, and the function does not include a catch handler, - Flash Player exits that function, as well as any caller functions, until a catch block is found. - During this process, finally handlers are called at all levels.

-

Note: If in a try block, there is an event dispatcher that calls its event handler, - the catch block doesn't catch the error if thrown in event handler. Any error thrown - thereafter can be caught by listening to LoaderInfo.uncaughtErrorEvents.

-

-

-Parameters - - - - -
error:* — - The expression thrown from a throw statement, typically an instance of the Error class or one of its subclasses. -
-
-Example -

-

-See also -

-
-Error class -
-throw -
-
- - - - - -
use namespacedirective 
-
-Usage - - - - -
use namespace ns1[, ns2, ...nsN]
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Causes the specified namespaces to be added to the set of open namespaces. - The specified namespaces are removed from the set of open namespaces when the current code block is exited. - The use namespace directive can appear at the top level of a program, package definition, or class definition.

-

-Parameters - - - - -
nsN:Namespace — - One or more namespaces to add to the set of open namespaces. -
-

-See also -

-
-default xml namespace -
-namespace -
-XML class -
-
- - - - - -
vardefinition keyword 
-
-Usage - - - - -
var variableName [= value1][...,variableNameN[=valueN]]
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Specifies a variable. If you declare variables inside a function, the variables are local. They are defined for the function and expire at the end of the function call. -

If you declare variables outside a function, the variables are available throughout the timeline containing the statement.

-

You cannot declare a variable that is in the scope of another object as a local variable.

-
my_array.length = 25; // ok 
-var my_array.length = 25; // syntax error
-

You can assign a data type to a variable by appending a colon character followed by the data type.

-

You can declare multiple variables in one statement, separating the declarations with commas (although this syntax may reduce clarity in your code):

- 
var first:String = "Bart", middle:String = "J.", last:String = "Bartleby";
-

-

-Parameters - - - - -
variableName:* — - An identifier. -
-
-Example -

-

-See also -

-
-const -
-
- - - - - -
whilestatement 
-
-Usage - - - - -
while (condition) { 
-	// statement(s)
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Evaluates a condition and if the condition evaluates to true, executes one or more statements before looping back to evaluate the condition again. - After the condition evaluates to false, the statements are skipped and the loop ends. -

The while statement performs the following series of steps. Each repetition of steps 1 through 4 is called an iteration of the loop. - The condition is tested at the beginning of each iteration, as shown in the following steps:

-
    -
  1. The expression condition is evaluated.
    2. -
  2. If condition evaluates to true or a value that converts to the Boolean value true, such as a nonzero number, go to step 3. - Otherwise, the while statement is completed and execution resumes at the next statement after the while loop.
    3. -
  3. Run the statement block statement(s). - If a continue statement is encountered, skip the remaining statements and go to step 1. - If a break statement is encountered, the while statement is completed and execution resumes at the next statement after the while loop.
    4. -
  4. Go to step 1.
    5. -
-

Looping is commonly used to perform an action while a counter variable is less than a specified value. - At the end of each loop, the counter is incremented until the specified value is reached. - At that point, the condition is no longer true, and the loop ends.

-

The curly braces ({}) that enclose the statements to be executed by the while - statement are not necessary if only one statement will execute.

-

-

-Parameters - - - - -
condition:Boolean — - An expression that evaluates to true or false. -
-
-Example -

-

-See also -

-
-break -
-continue -
-do..while -
-
- - - - - -
withstatement 
-
-Usage - - - - -
with (object:Object) { 
-	// statement(s)
-}
-

- - - - -
Language version: ActionScript 3.0
- - - - -
Runtime version: 
-

-

Establishes a default object to be used for the execution of a statement or statements, potentially reducing the amount of code that needs to be written. -

The object parameter becomes the context in which the properties, variables, and functions in the statement(s) parameter are read. For example, if object is my_array, and two of the properties specified are length and concat, those properties are automatically read as my_array.length and my_array.concat. In another example, if object is state.california, any actions or statements inside the with statement are called from inside the california instance.

-

To find the value of an identifier in the statement(s) parameter, ActionScript starts at the beginning of the scope chain specified by object and searches for the identifier at each level of the scope chain, in a specific order.

-

The scope chain used by the with statement to resolve identifiers starts with the first item in the following list and continues to the last item:

-
    -
  • The object specified in the object parameter in the innermost with statement
    • -
  • The object specified in the object parameter in the outermost with statement
    • -
  • The Activation object (a temporary object that is automatically created when the script calls a function that holds the local variables called in the function)
    • -
  • The object that contains the currently executing script
    • -
  • The Global object (built-in objects such as Math and String)
    • -
-

To set a variable inside a with statement, you must have declared the variable outside the with statement, or you must enter the full path to the Timeline on which you want the variable to live. If you set a variable in a with statement without declaring it, the with statement will look for the value according to the scope chain. - If the variable doesn't already exist, the new value will be set on the Timeline from which the with statement was called.

-

-

-Parameters - - - - -
object:Object — - An instance of an ActionScript object or movie clip. -
-
-Example -

-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/uint.html b/html-docs/uint.html deleted file mode 100644 index 8b1447b..0000000 --- a/html-docs/uint.html +++ /dev/null @@ -1,773 +0,0 @@ - - - - - - - - -uint (ActionScript 3.0) - - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic final class uint
Inheritanceuint Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

-

- - The uint class provides methods for working with a data type representing a 32-bit unsigned integer. Because an unsigned integer can only be - - positive, its maximum value is twice that of the int class. - -

The range of values represented by the uint class is 0 to 4,294,967,295 (2^32-1).

- -

You can create a uint object by declaring a variable of type uint and assigning the variable a literal value. The default value of a variable of type uint is 0.

- -

The uint class is primarily useful for pixel color values (ARGB and RGBA) and other situations where - - the int data type does not work well. For example, the number 0xFFFFFFFF, which - - represents the color value white with an alpha value of 255, can't be represented - - using the int data type because it is not within the valid range of the int values.

- - -

The following example creates a uint object and calls the - - toString() method:

- - 
-
- var myuint:uint = 1234;
-
- trace(myuint.toString()); // 1234
-
-
- -

The following example assigns the value of the MIN_VALUE - - property to a variable without the use of the constructor:

- - 
-
- var smallest:uint = uint.MIN_VALUE;
-
- trace(smallest.toString()); // 0
-
-
- - -

-

-View the examples. -

-

-See also -

-
-int -
-Number -
-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - -
 PropertyDefined by
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-uint(num:Object)
-
- - Creates a new uint object.
-		uint
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
   -
-toExponential(fractionDigits:uint):String -
-
- - Returns a string representation of the number in exponential notation.
-		uint
   -
-toFixed(fractionDigits:uint):String -
-
- - Returns a string representation of the number in fixed-point notation.
-		uint
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
   -
-toPrecision(precision:uint):String -
-
- - Returns a string representation of the number either in exponential notation or in - - fixed-point notation.
-		uint
   -
-toString(radix:uint):String -
-
- - Returns the string representation of a uint object.
-		uint
   -
-valueOf():uint -
-
- - Returns the primitive uint type value of the specified - - uint object.
-		uint
-
- -
-
Public Constants
- - - - - - - - - - -
 ConstantDefined by
  MAX_VALUE : uint = 4294967295
[static] - - The largest representable 32-bit unsigned integer, which is 4,294,967,295.
-		uint
  MIN_VALUE : uint = 0
[static] - - The smallest representable unsigned integer, which is 0.
-		uint
-
- -
- -
Constructor detail
- - - - - -
uint()constructor
-
-public function uint(num:Object) -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Creates a new uint object. You can create a variable of uint type and assign it a literal value. The new uint() constructor is primarily used - - as a placeholder. A uint object is not the same as the - - uint() function, which converts a parameter to a primitive value. - - -

Parameters - - - - -
num:Object — The numeric value of the uint object being created, - - or a value to be converted to a number. If num is not provided, - - the default value is 0. - - -
-
-Example -

-
- -
Method detail
- - - - - -
toExponential()method
-
-AS3 function toExponential(fractionDigits:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a string representation of the number in exponential notation. The string contains - - one digit before the decimal point and up to 20 digits after the decimal point, as - - specified by the fractionDigits parameter. - -

Parameters - - - - -
fractionDigits:uint — An integer between 0 and 20, inclusive, that represents the desired number of decimal places. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the fractionDigits argument is outside the range 0 to 20. - -
-
-Example -
The following example shows how toExponential(2) returns a string in - exponential notation. -
-
-
-var num:Number = 315003;
-trace(num.toExponential(2)); // 3.15e+5
-
-

-
- - - - - -
toFixed()method 
-
-AS3 function toFixed(fractionDigits:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a string representation of the number in fixed-point notation. - - Fixed-point notation means that the string will contain a specific number of digits - - after the decimal point, as specified in the fractionDigits parameter. - - The valid range for the fractionDigits parameter is from 0 to 20. - - Specifying a value outside this range throws an exception. - - -

Parameters - - - - -
fractionDigits:uint — An integer between 0 and 20, inclusive, that represents the desired number of decimal places. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the fractionDigits argument is outside the range 0 to 20. - -
-
-Example -
The following example shows how toFixed(3) returns a string that rounds - to three decimal places. -
-
-
-var num:Number = 7.31343;
-trace(num.toFixed(3)); // 7.313
-
-

The following example shows how toFixed(2) returns a string that adds - trailing zeroes. -
-
-
-var num:Number = 4;
-trace(num.toFixed(2)); // 4.00
-
-

-
- - - - - -
toPrecision()method 
-
-AS3 function toPrecision(precision:uint):String -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 1.0
-

- - Returns a string representation of the number either in exponential notation or in - - fixed-point notation. The string will contain the number of digits specified in the - - precision parameter. - -

Parameters - - - - -
precision:uint — An integer between 1 and 21, inclusive, that represents the desired number of digits to represent in the resulting string. - -
-

-Returns - - - - -
String
-
-Throws - - - - -
RangeError — Throws an exception if the precision argument is outside the range 1 to 21. - -
-
-Example -
The following example shows how toPrecision(3) returns a string with - only three digits. The string is in fixed-point notation because exponential notation is not required. -
-
-
-var num:Number = 31.570;
-trace(num.toPrecision(3)); // 31.6
-
-

The following example shows how toPrecision(3) returns a string with - only three digits. The string is in exponential notation because the resulting number does not - contain enough digits for fixed-point notation. -
-
-
-var num:Number = 4000;
-trace(num.toPrecision(3)); // 4.00e+3
-
-

-
- - - - - -
toString()method 
-
-AS3 function toString(radix:uint):String -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the string representation of a uint object. - - -

Parameters - - - - -
radix:uint — Specifies the numeric base (from 2 to 36) to use for the - - number-to-string conversion. If you do not specify the radix - - parameter, the default value is 10. - - -
-

-Returns - - - - -
String — - The string representation of the uint object. - - - - -
-
-Example -

-
- - - - - -
valueOf()method 
-
-AS3 function valueOf():uint -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - Returns the primitive uint type value of the specified - - uint object. - - -

-Returns - - - - -
uint — - The primitive uint type value of this uint - - object. - - - - -
-
-Example -

-
- -
Constant detail
- - - - - -
MAX_VALUEconstant
-
-public static const MAX_VALUE:uint = 4294967295 -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The largest representable 32-bit unsigned integer, which is 4,294,967,295. - - -


-Example -

-
- - - - - -
MIN_VALUEconstant 
-
-public static const MIN_VALUE:uint = 0 -

- - - - -
Language version: ActionScript 3.0 - -
- - - - -
Runtime version: 
-

- - The smallest representable unsigned integer, which is 0. - - -


-Example -

-
- -
Examples
-
examples\UintExample
-
The following example declares a uint i within a for loop, - which prints out the digits 0 to 9 (since uint defaults to 0). -
-
-
-package {
-    import flash.display.Sprite;
-
-	public class UintExample extends Sprite {
-		public function UintExample() {
-			for(var i:uint; i < 10; i++) {
-				trace(i);
-			}
-		}
-	}
-}
-
-
-
-
-
-
-

- -
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - diff --git a/html-docs/whatsnew.html b/html-docs/whatsnew.html deleted file mode 100644 index 1ff533b..0000000 --- a/html-docs/whatsnew.html +++ /dev/null @@ -1,1352 +0,0 @@ - - - What's New - - - - - - - -
- - -
New classes and class elements added for Adobe® AIR® 51.0
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassChangeElement
 air.security.Encryption - - - - -
New Class - - -
 
-
-		 - - -
Encryption
-
 air.system.License - - - - -
New Class - - -
 
-
-		 - - -
License
-
 flash.text.StageTextContentType - - - - -
New Class - - -
 
-
-		 - - -
StageTextContentType
-
 air.net.WebSocket - - - - -
New Class - - -
 
-
-		 - - -
WebSocket
-
 flash.events.WebSocketEvent - - - - -
New Class - - -
 
-
-		 - - -
WebSocketEvent
-
 air.utils.ZipArchive - - - - -
New Class - - -
 
-
-		 - - -
ZipArchive
-
 air.utils.ZipEntry - - - - -
New Class - - -
 
-
-		 - - -
ZipEntry
-
 flash.display3D.Context3D - - - - -
New Method - - -
 
-
-		 - - -
setProgramConstantsFromFloatVector
-
 flash.events.DataEvent - - - - -
New Property - - -
 
-
-		 - - -
WEBVIEW_MESSAGE
-
 flash.net.DatagramSocket - - - - -
New Method - - -
 
-
-		 - - -
broadcast
-
 air.security.Digest - - - - -
New Property - - -
 
-
-		 - - -
SHA512
-
 flash.events.MouseEvent - - - - -
New Property - - -
 
-
-		 - - -
MOUSE_WHEEL_HORIZONTAL
-
 flash.events.SecurityErrorEvent - - - - -
New Property - - -
 
-
-		 - - -
CERTIFICATE_ERROR
-
 flash.net.Socket - - - - -
New Property - - -
 
-
-		 - - -
tcpNoDelay
-
 flash.text.StageText - - - - -
New Property - - -
 
-
-		 - - -
contentType
-
 flash.media.StageWebView - - - - - - - -
Updated Constructor - - -
 
-
New Method - - -
 
-
-		 - - - -
StageWebView
postMessage
-
 flash.system.System - - - - -
Updated Method - - -
 
-
-		 - - -
decryptBlob
-
 flash.text.TextField - - - - -
New Property - - -
 
-
-		 - - -
allowedDomains
-
 flash.display3D.VertexBuffer3D - - - - -
New Method - - -
 
-
-		 - - -
uploadFromFloatVector
-
 Array - - - - -
New Methods - - -
 
-
-		 - - - -
includes
isEmpty
-
 flash.utils.ByteArray - - - - -
New Methods - - -
 
-
-		 - - - - - - - - -
createFromBase64
createFromHexString
writeBase64
writeHexString
toBase64
toHexString
writeRandomBytes
-
 float - - - - -
New Class - - -
 
-
-		 - - -
float
-
 String - - - - -
New Methods - - -
 
-
-		 - - - -
endsWith
startsWith
-
 Vector - - - - -
New Methods - - -
 
-
-		 - - - -
includes
isEmpty
-
 Function - - - - -
New Property - - -
 
-
-		 - - -
declaration
-
 NetworkInfo - - - - -
New Property - - -
 
-
-		 - - -
disableNetworkChanges
-
 flash.display.BitmapData - - - - -
New Method - - -
 
-
-		 - - -
convertColorProfile
-
- - -
The operators documentation has also been updated, following new features in the AIR AS3 compiler that had been released with the AIR 50 SDK, for -nullish coalescing and null condition member access. -
- -
New classes and class elements added for Adobe® AIR® 50.0
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassChangeElement
 flash.display.BitmapData - - - - -
New Method - - -
 
-
-		 - - -
decode
-
 air.security.Digest - - - - -
New Class - - -
 
-
-		 - - -
Digest
-
 flash.external.ExtensionContext - - - - - - - -
New Methods - - - -
 
 
-
New Properties - - - -
 
 
-
-		 - - - - - -
loadExtension
getExtensionInfo
knownExtensions
functions
-
 flash.ui.Keyboard - - - - -
New Property - - -
 
-
-		 - - -
FUNCTION
-
 flash.events.KeyboardEvent - - - - - - - -
Updated Constructor - - -
 
-
New Property - - -
 
-
-		 - - - -
KeyboardEvent
functionKey
-
 flash.desktop.NativeApplication - - - - -
New Property - - -
 
-
-		 - - -
isActive
-
 flash.display.Screen - - - - -
New Properties - - - -
 
 
-
-		 - - - -
contentsScaleFactor
safeArea
-
 flash.display.NativeWindow - - - - -
New Method - - -
 
-
-		 - - -
resizeToScreen
-
 flash.system.System - - - - - - - -
New Method - - -
 
-
New Property - - -
 
-
-		 - - - -
decryptBlob
containsDebugInfo
-
 flash.display.Stage - - - - -
New Method - - -
 
-
-		 - - -
preloadComplete
-
 flash.text.TextField - - - - -
New Property - - -
 
-
-		 - - -
htmlParagraphBehavior
-
 TimeZone - - - - -
New Class - - -
 
-
-		 - - -
TimeZone
-
 flash.display3D.Context3D - - - - -
New Property - - -
 
-
-		 - - -
ignoreResourceLimits
-
 flash.filesystem.StorageVolumeInfo - - - - - - - -
New Property - - -
 
-
New Method - - -
 
-
-		 - - - -
currentVolumes
getStorageVolumesAsync
-
 flash.external.ExtensionInfo - - - - -
New Class - - -
 
-
-		 - - -
ExtensionInfo
-
- - -
New classes and class elements added for Adobe® AIR® 33.1
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 ClassChangeElement
 flash.geom.Matrix - - - - -
New Methods - - - -
 
 
-
-		 - - - -
deltaTransformPointToOutput
transformPointToOutput
-
 flash.geom.Matrix3D - - - - -
New Methods - - - - - -
 
 
 
 
-
-		 - - - - - -
decomposeToOutput
transformVectorToOutput
deltaTransformVectorToOutput
interpolateToOutput
-
 flash.geom.PerspectiveProjection - - - - -
New Method - - -
 
-
-		 - - -
toMatrix3DToOutput
-
 flash.geom.Point - - - - -
New Methods - - - - - -
 
 
 
 
-
-		 - - - - - -
interpolateToOutput
subtractToOutput
addToOutput
polarToOutput
-
 flash.geom.Rectangle - - - - -
New Methods - - - -
 
 
-
-		 - - - -
intersectionToOutput
unionToOutput
-
 flash.geom.Transform - - - - -
New Methods - - - - - - -
 
 
 
 
 
-
-		 - - - - - - -
copyConcatenatedMatrixToOutput
copyConcatenatedColorTransformToOutput
copyPixelBoundsToOutput
getRelativeMatrix3DToOutput
copyPerspectiveProjectionToOutput
-
 flash.geom.Utils3D - - - - -
New Methods - - - -
 
 
-
-		 - - - -
projectVectorToOutput
pointTowardsToOutput
-
 flash.geom.Vector3D - - - - -
New Methods - - - - -
 
 
 
-
-		 - - - - -
crossProductToOutput
addToOutput
subtractToOutput
-
 flash.system.System - - - - - - - -
New Methods - - - - -
 
 
 
-
New Property - - -
 
-
-		 - - - - - -
output
input
error
poisonStrings
-
 flash.permissions.PermissionManager - - - - -
New Class - - -
 
-
-		 - - -
PermissionManager
-
 flash.media.Camera - - - - -
New Property - - -
 
-
-		 - - -
permissionManager
-
 flash.media.Microphone - - - - -
New Property - - -
 
-
-		 - - -
permissionManager
-
 flash.filesystem.File - - - - -
New Properties - - - -
 
 
-
-		 - - - -
applicationRemovableStorageDirectory
workingDirectory
-
 flash.media.StageWebView - - - - -
New Method - - -
 
-
-		 - - -
drawViewPortAsync
-
 flash.events.WebViewDrawEvent - - - - -
New Class - - -
 
-
-		 - - -
WebViewDrawEvent
-
-

-
© 2022 HARMAN International Industries, Incorporated. All rights reserved.
Creative Commons License
-
- - diff --git a/llms.txt b/llms.txt new file mode 100644 index 0000000..b0c0b9d --- /dev/null +++ b/llms.txt @@ -0,0 +1,40 @@ +# ActionScript 3.0 Documentation + +Comprehensive ActionScript 3.0 and Adobe AIR documentation, manually synthesized into 41 high-density Markdown files optimized for LLM consumption. + +## Core Language & Types +- `docs/Object.md`, `docs/Array.md`, `docs/Vector.md`, `docs/String.md`, `docs/Boolean.md`: Standard types. +- `docs/NumericTypes.md`: Math, int, uint, float. +- `docs/Math.md`, `docs/Date.md`, `docs/Function.md`, `docs/RegExp.md`, `docs/JSON.md`, `docs/XML.md`: Core utilities. +- `docs/Errors.md`, `docs/SpecializedErrors.md`: Complete error hierarchy. +- `docs/SpecialTypes.md`: Class, Namespace, QName, TimeZone, arguments. + +## Display & Interactivity +- `docs/Display.md`: Sprite, Stage, Bitmap, Graphics. +- `docs/Geom.md`: Matrix, Point, Rectangle. +- `docs/Display3D.md`: Stage3D GPU rendering (AGAL). +- `docs/Text.md`: TextField, TextFormat, StyleSheet. +- `docs/Filters.md`: Blur, Glow, ColorMatrix, Convolution filters. +- `docs/Events.md`: Event flow, Keyboard/Mouse/Touch events. +- `docs/UI.md`: ContextMenu, Mouse Cursor, Multitouch, GameInput. + +## System & Networking +- `docs/Net.md`: URLLoader, Sockets, FileReference. +- `docs/Utils.md`: ByteArray, Timers, Reflection (describeType). +- `docs/System.md`: Security, Capabilities, ApplicationDomain. +- `docs/Concurrent.md`: Workers, Mutex, Condition variables. +- `docs/Bridge_Sensors.md`: ExternalInterface, Accelerometer, Geolocation. +- `docs/Globalization.md`: Locale-aware formatting and sorting. + +## Adobe AIR Services +- `docs/Filesystem.md`: Native File and FileStream IO. +- `docs/Desktop.md`: Clipboard, NativeProcess, Window management. +- `docs/Database.md`: Local SQLite and EncryptedLocalStore. +- `docs/HTML.md`: WebKit HTMLLoader. +- `docs/Updates.md`: Application Update framework. +- `docs/Notifications.md`: Push and local notifications. +- `docs/Permissions.md`: Mobile runtime permissions. +- `docs/Printing.md`, `docs/Profiler.md`, `docs/Accessibility.md`: Specialized APIs. + +## Usage +Refer to `/docs/*.md` for consolidated package summaries. These files exclude HTML noise and focus on API signatures, behavioral notes, and idiomatic examples. From 97cd249158cc89cf22ccf18bce7d4bf1ba88f25a Mon Sep 17 00:00:00 2001 From: BaoLT Date: Tue, 6 Jan 2026 13:22:10 +0700 Subject: [PATCH 2/3] Update README.md --- README.md | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/README.md b/README.md index e06ddb8..8fa33ea 100644 --- a/README.md +++ b/README.md @@ -31,15 +31,5 @@ Low-level access for [Sockets and Networking](docs/Net.md), [Workers and Concurr A comprehensive index and categorized list can be found in **[docs/README.md](docs/README.md)**. -## 🤖 Claude Skills for VSCode Copilot - -The `.claude/skills/` directory contains ActionScript 3.0 programming skills for AI assistants: - -1. **actionscript-basics.md** - Core language features. -2. **actionscript-collections.md** - Data structures. -3. **actionscript-display-graphics.md** - Visual engine. -4. **actionscript-events.md** - Async patterns. -5. **actionscript-api-reference.md** - Navigation guide. - --- *Based on the original Adobe/Harman documentation from airsdk.dev* From db0011722564619f6578e3a1d74f253c440212e8 Mon Sep 17 00:00:00 2001 From: luthebao Date: Tue, 6 Jan 2026 13:43:26 +0700 Subject: [PATCH 3/3] update: initial ActionScript 3.0 Coding skill and documentation index for claude code --- .claude/skills/actionscript3-coding/SKILL.md | 273 ++++++++++++++++++ .../references/docs-index.md | 133 +++++++++ actionscript3-docs.code-workspace | 8 + 3 files changed, 414 insertions(+) create mode 100644 .claude/skills/actionscript3-coding/SKILL.md create mode 100644 .claude/skills/actionscript3-coding/references/docs-index.md create mode 100644 actionscript3-docs.code-workspace diff --git a/.claude/skills/actionscript3-coding/SKILL.md b/.claude/skills/actionscript3-coding/SKILL.md new file mode 100644 index 0000000..34de5c5 --- /dev/null +++ b/.claude/skills/actionscript3-coding/SKILL.md @@ -0,0 +1,273 @@ +--- +name: ActionScript 3.0 Coding +description: This skill should be used when the user or agent asks to "edit .as files", "generate ActionScript code", "write AS3 code", "create ActionScript class", "fix AS3 syntax", "implement Flash code", "develop AIR application", or works with ActionScript 3.0 (.as) files. Also triggers on questions about AS3 syntax, ActionScript patterns, Flash/AIR development, or Adobe runtime APIs. +version: 1.0.0 +--- + +# ActionScript 3.0 Coding Guide + +This skill provides guidance for writing, editing, and generating ActionScript 3.0 code (.as files) using the comprehensive documentation available in this repository. + +## Documentation Reference + +This repository contains complete AS3 and Adobe AIR documentation in `/docs/`. Consult `references/docs-index.md` for a categorized index mapping topics to specific documentation files. + +## AS3 File Structure + +### Package and Class Declaration + +```as3 +package com.example.project { + + import flash.display.Sprite; + import flash.events.Event; + + /** + * Class description using ASDoc format. + */ + public class MyClass extends Sprite { + + // Constants (UPPER_SNAKE_CASE) + private static const MAX_COUNT:int = 100; + + // Instance variables (camelCase, prefixed with underscore for private) + private var _name:String; + protected var isActive:Boolean = false; + public var data:Object; + + /** + * Constructor + */ + public function MyClass() { + super(); + init(); + } + + private function init():void { + addEventListener(Event.ADDED_TO_STAGE, onAddedToStage); + } + + // Getters/Setters + public function get name():String { return _name; } + public function set name(value:String):void { _name = value; } + + // Event handlers (prefixed with "on") + private function onAddedToStage(e:Event):void { + removeEventListener(Event.ADDED_TO_STAGE, onAddedToStage); + } + } +} +``` + +### Interface Declaration + +```as3 +package com.example.interfaces { + + public interface IDisposable { + function dispose():void; + function get isDisposed():Boolean; + } +} +``` + +## Naming Conventions + +| Element | Convention | Example | +| ------- | ---------- | ------- | +| Package | lowercase, dot-separated | `com.example.utils` | +| Class | PascalCase | `PlayerController` | +| Interface | PascalCase with "I" prefix | `IEventDispatcher` | +| Method | camelCase | `calculateScore()` | +| Variable | camelCase | `playerHealth` | +| Private var | underscore prefix | `_internalState` | +| Constant | UPPER_SNAKE_CASE | `MAX_SPEED` | +| Event type | UPPER_SNAKE_CASE | `Event.COMPLETE` | + +## Type System + +### Primitive Types + +- `int` - 32-bit signed integer +- `uint` - 32-bit unsigned integer +- `Number` - 64-bit floating point (IEEE 754) +- `String` - immutable string +- `Boolean` - true/false +- `*` - untyped (any type) +- `void` - no return value + +### Type Annotations + +```as3 +// Variable typing +var count:int = 0; +var name:String = "Player"; +var data:* = anyValue; // Untyped + +// Function typing +function calculate(x:Number, y:Number):Number { + return x + y; +} + +// Vector (typed array) +var numbers:Vector. = new Vector.(); +var sprites:Vector. = new [sprite1, sprite2]; + +// Dictionary (object keys) +var map:Dictionary = new Dictionary(true); // weak keys +``` + +## Common Patterns + +### Event Handling + +```as3 +// Add listener +dispatcher.addEventListener(MouseEvent.CLICK, onClick); + +// Handler with weak reference (prevents memory leaks) +dispatcher.addEventListener(Event.COMPLETE, onComplete, false, 0, true); + +// Remove listener +dispatcher.removeEventListener(MouseEvent.CLICK, onClick); + +// Custom events +dispatchEvent(new Event("customEvent")); +dispatchEvent(new CustomEvent(CustomEvent.DATA_LOADED, data)); +``` + +### Display Object Management + +```as3 +// Add to display list +addChild(sprite); +addChildAt(sprite, 0); + +// Remove from display list +removeChild(sprite); +if (sprite.parent) sprite.parent.removeChild(sprite); + +// Iterate children +for (var i:int = numChildren - 1; i >= 0; i--) { + removeChildAt(i); +} +``` + +### Resource Cleanup Pattern + +```as3 +public function dispose():void { + // Remove event listeners + removeEventListener(Event.ENTER_FRAME, onEnterFrame); + + // Remove from display list + if (parent) parent.removeChild(this); + + // Clear references + _data = null; + + // Dispose children + while (numChildren > 0) { + var child:DisplayObject = removeChildAt(0); + if (child is IDisposable) { + IDisposable(child).dispose(); + } + } +} +``` + +### Singleton Pattern + +```as3 +public class GameManager { + private static var _instance:GameManager; + + public static function get instance():GameManager { + if (!_instance) _instance = new GameManager(new SingletonEnforcer()); + return _instance; + } + + public function GameManager(enforcer:SingletonEnforcer) { + if (!enforcer) throw new Error("Use GameManager.instance"); + } +} +internal class SingletonEnforcer {} +``` + +## Error Handling + +```as3 +try { + riskyOperation(); +} catch (e:TypeError) { + trace("Type error: " + e.message); +} catch (e:Error) { + trace("General error: " + e.message); +} finally { + cleanup(); +} + +// Throw errors +throw new Error("Something went wrong"); +throw new ArgumentError("Invalid parameter"); +``` + +## Metadata Tags + +```as3 +// Embed assets +[Embed(source="assets/image.png")] +private var ImageClass:Class; + +// SWF metadata +[SWF(width="800", height="600", backgroundColor="#FFFFFF", frameRate="60")] + +// Bindable (Flex) +[Bindable] +public var score:int; + +// Event metadata (documentation) +[Event(name="complete", type="flash.events.Event")] +``` + +## Best Practices + +### Memory Management + +- Always remove event listeners when objects are disposed +- Use weak references for listeners when appropriate +- Nullify references to allow garbage collection +- Dispose BitmapData, Sounds, and other native resources +- Avoid circular references + +### Performance + +- Use `Vector.` instead of `Array` for typed collections +- Cache frequently accessed properties in local variables +- Use object pooling for frequently created/destroyed objects +- Minimize display list operations +- Use `cacheAsBitmap` for static complex graphics + +### Code Organization + +- One class per file (filename matches class name) +- Group imports: flash.*, then third-party, then project +- Use interfaces for loose coupling +- Implement IDisposable pattern for cleanup +- Document public API with ASDoc comments + +## Additional Resources + +### Reference Files + +Consult `references/docs-index.md` for the complete documentation index mapping topics to files in `/docs/`. + +### Documentation Location + +All API documentation is in the `/docs/` directory: + +- Core language: Object, Array, Vector, String, etc. +- Display: Sprite, Stage, Bitmap, Graphics +- Events: Event system, keyboard, mouse, touch +- Networking: URLLoader, Socket, NetConnection +- AIR: File system, database, desktop features diff --git a/.claude/skills/actionscript3-coding/references/docs-index.md b/.claude/skills/actionscript3-coding/references/docs-index.md new file mode 100644 index 0000000..411a40b --- /dev/null +++ b/.claude/skills/actionscript3-coding/references/docs-index.md @@ -0,0 +1,133 @@ +# ActionScript 3.0 Documentation Index + +Quick reference for finding AS3 documentation in `/docs/`. Use this index to locate the appropriate documentation file for any topic. + +## Core Language + +| Topic | File | Key Classes | +| ----- | ---- | ----------- | +| Base object, prototype chain | `docs/Object.md` | `Object` | +| Indexed arrays | `docs/Array.md` | `Array` | +| Typed arrays (performance) | `docs/Vector.md` | `Vector.` | +| String manipulation | `docs/String.md` | `String` | +| Boolean logic | `docs/Boolean.md` | `Boolean` | +| Numbers (int, uint, Number) | `docs/NumericTypes.md` | `Number`, `int`, `uint` | +| Math functions | `docs/Math.md` | `Math` | +| Date/time handling | `docs/Date.md` | `Date` | +| Functions, closures | `docs/Function.md` | `Function` | +| Regular expressions | `docs/RegExp.md` | `RegExp` | +| JSON parsing/serialization | `docs/JSON.md` | `JSON` | +| E4X XML processing | `docs/XML.md` | `XML`, `XMLList` | +| Error handling | `docs/Errors.md` | `Error`, `ArgumentError`, `TypeError` | +| Special constructs | `docs/SpecialTypes.md` | `Class`, `Namespace`, `QName` | +| Domain-specific errors | `docs/SpecializedErrors.md` | `SQLError`, `DRMManagerError` | + +## Display & Graphics + +| Topic | File | Key Classes | +| ----- | ----- | ------------ | +| Display list, sprites, stage | `docs/Display.md` | `DisplayObject`, `Sprite`, `MovieClip`, `Stage`, `Bitmap`, `Graphics` | +| Geometry, transformations | `docs/Geom.md` | `Point`, `Rectangle`, `Matrix`, `Transform` | +| Visual filters/effects | `docs/Filters.md` | `BlurFilter`, `DropShadowFilter`, `GlowFilter`, `ColorMatrixFilter` | +| Stage3D (GPU 3D rendering) | `docs/Display3D.md` | `Context3D`, `VertexBuffer3D`, `Program3D` | + +## Events & User Input + +| Topic | File | Key Classes | +| ----- | ----- | ------------ | +| Event system | `docs/Events.md` | `Event`, `EventDispatcher`, `MouseEvent`, `KeyboardEvent` | +| Input devices | `docs/UI.md` | `Mouse`, `Keyboard`, `TouchEvent`, `GameInput` | + +## Media + +| Topic | File | Key Classes | +| ----- | ----- | ------------ | +| Audio/video playback | `docs/Media.md` | `Sound`, `SoundChannel`, `Video`, `Camera`, `Microphone` | + +## Networking + +| Topic | File | Key Classes | +| ----- | ----- | ------------ | +| HTTP, sockets, protocols | `docs/Net.md` | `URLLoader`, `URLRequest`, `Socket`, `XMLSocket`, `NetConnection` | + +## Data & Utilities + +| Topic | File | Key Classes | +| ----- | ----- | ------------ | +| Binary data, timers, reflection | `docs/Utils.md` | `ByteArray`, `Timer`, `Dictionary`, `Proxy`, `describeType` | +| SQLite databases (AIR) | `docs/Database.md` | `SQLConnection`, `SQLStatement`, `EncryptedLocalStore` | + +## System & Runtime + +| Topic | File | Key Classes | +| ----- | ----- | ------------ | +| Capabilities, security, domains | `docs/System.md` | `Capabilities`, `Security`, `ApplicationDomain`, `Worker` | +| Multithreading primitives | `docs/Concurrent.md` | `Mutex`, `Condition` | +| Performance profiling (AIR) | `docs/Profiler.md` | `Telemetry`, `Sample` | + +## Text & Internationalization + +| Topic | File | Key Classes | +| ----- | ----- | ------------ | +| Text fields, fonts, formatting | `docs/Text.md` | `TextField`, `TextFormat`, `Font`, `StyleSheet` | +| Locale-aware formatting | `docs/Globalization.md` | `DateTimeFormatter`, `NumberFormatter`, `Collator` | + +## Adobe AIR - Desktop + +| Topic | File | Key Classes | +| ----- | ----- | ------------ | +| Desktop integration | `docs/Desktop.md` | `NativeApplication`, `Clipboard`, `NativeProcess`, `NativeWindow` | +| File system access | `docs/Filesystem.md` | `File`, `FileStream`, `FileMode` | +| Print jobs | `docs/Printing.md` | `PrintJob`, `PrintJobOptions` | +| WebKit HTML | `docs/HTML.md` | `HTMLLoader`, `HTMLHost` | +| App updates | `docs/Updates.md` | `ApplicationUpdater`, `ApplicationUpdaterUI` | +| ZIP, encryption, WebSocket | `docs/AIRUtilities.md` | `ZipArchive`, `Encryption`, `Digest`, `WebSocket` | +| External interface, sensors | `docs/Bridge_Sensors.md` | `ExternalInterface`, `Geolocation`, `Accelerometer` | +| Screen readers | `docs/Accessibility.md` | `Accessibility`, `AccessibilityProperties` | + +## Adobe AIR - Mobile + +| Topic | File | Key Classes | +| ----- | ----- | ------------ | +| Push notifications | `docs/Notifications.md` | `RemoteNotifier`, `NotificationStyle` | +| Runtime permissions (Android) | `docs/Permissions.md` | `PermissionManager`, `PermissionStatus` | + +## Security + +| Topic | File | Key Classes | +| ----- | ----- | ------------ | +| XML signatures, certificates | `docs/AdvancedSecurity.md` | `XMLSignatureValidator`, `CertificateStatus` | + +## Search by Task + +### "I need to..." + +| Task | Documentation | +| ----- | --------------- | +| Load external data/assets | `docs/Net.md` (URLLoader, URLRequest) | +| Handle user clicks/keyboard | `docs/Events.md`, `docs/UI.md` | +| Draw shapes programmatically | `docs/Display.md` (Graphics class) | +| Work with images/bitmaps | `docs/Display.md` (Bitmap, BitmapData) | +| Play audio/video | `docs/Media.md` | +| Save/load local data | `docs/Database.md`, `docs/Filesystem.md` | +| Connect via sockets | `docs/Net.md` (Socket, XMLSocket) | +| Use timers/delays | `docs/Utils.md` (Timer) | +| Work with binary data | `docs/Utils.md` (ByteArray) | +| Create visual effects | `docs/Filters.md` | +| Handle text input | `docs/Text.md` (TextField) | +| Run native processes (AIR) | `docs/Desktop.md` (NativeProcess) | +| Access GPS/accelerometer | `docs/Bridge_Sensors.md` | +| Use threads/workers | `docs/System.md`, `docs/Concurrent.md` | +| Parse/generate JSON | `docs/JSON.md` | +| Process XML | `docs/XML.md` | + +## Documentation Format + +Each documentation file in `/docs/` contains: + +- Class overview and purpose +- Key properties and methods with signatures +- Behavioral notes and gotchas +- Idiomatic code examples + +Files are optimized for AI/LLM context windows with high-density information. diff --git a/actionscript3-docs.code-workspace b/actionscript3-docs.code-workspace new file mode 100644 index 0000000..876a149 --- /dev/null +++ b/actionscript3-docs.code-workspace @@ -0,0 +1,8 @@ +{ + "folders": [ + { + "path": "." + } + ], + "settings": {} +} \ No newline at end of file